]>
Commit | Line | Data |
---|---|---|
c609719b | 1 | # |
eca3aeb3 | 2 | # (C) Copyright 2000 - 2013 |
c609719b WD |
3 | # Wolfgang Denk, DENX Software Engineering, [email protected]. |
4 | # | |
eca3aeb3 | 5 | # SPDX-License-Identifier: GPL-2.0+ |
c609719b WD |
6 | # |
7 | ||
8 | Summary: | |
9 | ======== | |
10 | ||
24ee89b9 | 11 | This directory contains the source code for U-Boot, a boot loader for |
e86e5a07 WD |
12 | Embedded boards based on PowerPC, ARM, MIPS and several other |
13 | processors, which can be installed in a boot ROM and used to | |
14 | initialize and test the hardware or to download and run application | |
15 | code. | |
c609719b WD |
16 | |
17 | The development of U-Boot is closely related to Linux: some parts of | |
24ee89b9 WD |
18 | the source code originate in the Linux source tree, we have some |
19 | header files in common, and special provision has been made to | |
c609719b WD |
20 | support booting of Linux images. |
21 | ||
22 | Some attention has been paid to make this software easily | |
23 | configurable and extendable. For instance, all monitor commands are | |
24 | implemented with the same call interface, so that it's very easy to | |
25 | add new commands. Also, instead of permanently adding rarely used | |
26 | code (for instance hardware test utilities) to the monitor, you can | |
27 | load and run it dynamically. | |
28 | ||
29 | ||
30 | Status: | |
31 | ======= | |
32 | ||
33 | In general, all boards for which a configuration option exists in the | |
24ee89b9 | 34 | Makefile have been tested to some extent and can be considered |
c609719b WD |
35 | "working". In fact, many of them are used in production systems. |
36 | ||
7207b366 RD |
37 | In case of problems see the CHANGELOG file to find out who contributed |
38 | the specific port. In addition, there are various MAINTAINERS files | |
39 | scattered throughout the U-Boot source identifying the people or | |
40 | companies responsible for various boards and subsystems. | |
c609719b | 41 | |
7207b366 RD |
42 | Note: As of August, 2010, there is no longer a CHANGELOG file in the |
43 | actual U-Boot source tree; however, it can be created dynamically | |
44 | from the Git log using: | |
adb9d851 RD |
45 | |
46 | make CHANGELOG | |
47 | ||
c609719b WD |
48 | |
49 | Where to get help: | |
50 | ================== | |
51 | ||
24ee89b9 | 52 | In case you have questions about, problems with or contributions for |
7207b366 | 53 | U-Boot, you should send a message to the U-Boot mailing list at |
0c32565f PT |
54 | <[email protected]>. There is also an archive of previous traffic |
55 | on the mailing list - please search the archive before asking FAQ's. | |
56 | Please see http://lists.denx.de/pipermail/u-boot and | |
57 | http://dir.gmane.org/gmane.comp.boot-loaders.u-boot | |
c609719b WD |
58 | |
59 | ||
218ca724 WD |
60 | Where to get source code: |
61 | ========================= | |
62 | ||
7207b366 | 63 | The U-Boot source code is maintained in the Git repository at |
218ca724 WD |
64 | git://www.denx.de/git/u-boot.git ; you can browse it online at |
65 | http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary | |
66 | ||
67 | The "snapshot" links on this page allow you to download tarballs of | |
11ccc33f | 68 | any version you might be interested in. Official releases are also |
218ca724 WD |
69 | available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ |
70 | directory. | |
71 | ||
d4ee711d | 72 | Pre-built (and tested) images are available from |
218ca724 WD |
73 | ftp://ftp.denx.de/pub/u-boot/images/ |
74 | ||
75 | ||
c609719b WD |
76 | Where we come from: |
77 | =================== | |
78 | ||
79 | - start from 8xxrom sources | |
24ee89b9 | 80 | - create PPCBoot project (http://sourceforge.net/projects/ppcboot) |
c609719b WD |
81 | - clean up code |
82 | - make it easier to add custom boards | |
83 | - make it possible to add other [PowerPC] CPUs | |
84 | - extend functions, especially: | |
85 | * Provide extended interface to Linux boot loader | |
86 | * S-Record download | |
87 | * network boot | |
11ccc33f | 88 | * PCMCIA / CompactFlash / ATA disk / SCSI ... boot |
24ee89b9 | 89 | - create ARMBoot project (http://sourceforge.net/projects/armboot) |
c609719b | 90 | - add other CPU families (starting with ARM) |
24ee89b9 | 91 | - create U-Boot project (http://sourceforge.net/projects/u-boot) |
0d28f34b | 92 | - current project page: see http://www.denx.de/wiki/U-Boot |
24ee89b9 WD |
93 | |
94 | ||
95 | Names and Spelling: | |
96 | =================== | |
97 | ||
98 | The "official" name of this project is "Das U-Boot". The spelling | |
99 | "U-Boot" shall be used in all written text (documentation, comments | |
100 | in source files etc.). Example: | |
101 | ||
102 | This is the README file for the U-Boot project. | |
103 | ||
104 | File names etc. shall be based on the string "u-boot". Examples: | |
105 | ||
106 | include/asm-ppc/u-boot.h | |
107 | ||
108 | #include <asm/u-boot.h> | |
109 | ||
110 | Variable names, preprocessor constants etc. shall be either based on | |
111 | the string "u_boot" or on "U_BOOT". Example: | |
112 | ||
113 | U_BOOT_VERSION u_boot_logo | |
114 | IH_OS_U_BOOT u_boot_hush_start | |
c609719b WD |
115 | |
116 | ||
93f19cc0 WD |
117 | Versioning: |
118 | =========== | |
119 | ||
360d883a TW |
120 | Starting with the release in October 2008, the names of the releases |
121 | were changed from numerical release numbers without deeper meaning | |
122 | into a time stamp based numbering. Regular releases are identified by | |
123 | names consisting of the calendar year and month of the release date. | |
124 | Additional fields (if present) indicate release candidates or bug fix | |
125 | releases in "stable" maintenance trees. | |
126 | ||
127 | Examples: | |
c0f40859 | 128 | U-Boot v2009.11 - Release November 2009 |
360d883a | 129 | U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree |
0de21ecb | 130 | U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release |
93f19cc0 WD |
131 | |
132 | ||
c609719b WD |
133 | Directory Hierarchy: |
134 | ==================== | |
135 | ||
8d321b81 | 136 | /arch Architecture specific files |
6eae68e4 | 137 | /arc Files generic to ARC architecture |
8d321b81 | 138 | /arm Files generic to ARM architecture |
8d321b81 | 139 | /avr32 Files generic to AVR32 architecture |
8d321b81 | 140 | /blackfin Files generic to Analog Devices Blackfin architecture |
8d321b81 | 141 | /m68k Files generic to m68k architecture |
8d321b81 | 142 | /microblaze Files generic to microblaze architecture |
8d321b81 | 143 | /mips Files generic to MIPS architecture |
afc1ce82 | 144 | /nds32 Files generic to NDS32 architecture |
8d321b81 | 145 | /nios2 Files generic to Altera NIOS2 architecture |
33c7731b | 146 | /openrisc Files generic to OpenRISC architecture |
a47a12be | 147 | /powerpc Files generic to PowerPC architecture |
7207b366 | 148 | /sandbox Files generic to HW-independent "sandbox" |
8d321b81 | 149 | /sh Files generic to SH architecture |
8d321b81 | 150 | /sparc Files generic to SPARC architecture |
33c7731b | 151 | /x86 Files generic to x86 architecture |
8d321b81 PT |
152 | /api Machine/arch independent API for external apps |
153 | /board Board dependent files | |
740f7e5c | 154 | /cmd U-Boot commands functions |
8d321b81 | 155 | /common Misc architecture independent functions |
7207b366 | 156 | /configs Board default configuration files |
8d321b81 PT |
157 | /disk Code for disk drive partition handling |
158 | /doc Documentation (don't expect too much) | |
159 | /drivers Commonly used device drivers | |
33c7731b | 160 | /dts Contains Makefile for building internal U-Boot fdt. |
8d321b81 PT |
161 | /examples Example code for standalone applications, etc. |
162 | /fs Filesystem code (cramfs, ext2, jffs2, etc.) | |
163 | /include Header Files | |
7207b366 RD |
164 | /lib Library routines generic to all architectures |
165 | /Licenses Various license files | |
8d321b81 PT |
166 | /net Networking code |
167 | /post Power On Self Test | |
7207b366 RD |
168 | /scripts Various build scripts and Makefiles |
169 | /test Various unit test files | |
8d321b81 | 170 | /tools Tools to build S-Record or U-Boot images, etc. |
c609719b | 171 | |
c609719b WD |
172 | Software Configuration: |
173 | ======================= | |
174 | ||
175 | Configuration is usually done using C preprocessor defines; the | |
176 | rationale behind that is to avoid dead code whenever possible. | |
177 | ||
178 | There are two classes of configuration variables: | |
179 | ||
180 | * Configuration _OPTIONS_: | |
181 | These are selectable by the user and have names beginning with | |
182 | "CONFIG_". | |
183 | ||
184 | * Configuration _SETTINGS_: | |
185 | These depend on the hardware etc. and should not be meddled with if | |
186 | you don't know what you're doing; they have names beginning with | |
6d0f6bcf | 187 | "CONFIG_SYS_". |
c609719b | 188 | |
7207b366 RD |
189 | Previously, all configuration was done by hand, which involved creating |
190 | symbolic links and editing configuration files manually. More recently, | |
191 | U-Boot has added the Kbuild infrastructure used by the Linux kernel, | |
192 | allowing you to use the "make menuconfig" command to configure your | |
193 | build. | |
c609719b WD |
194 | |
195 | ||
196 | Selection of Processor Architecture and Board Type: | |
197 | --------------------------------------------------- | |
198 | ||
199 | For all supported boards there are ready-to-use default | |
ab584d67 | 200 | configurations available; just type "make <board_name>_defconfig". |
c609719b WD |
201 | |
202 | Example: For a TQM823L module type: | |
203 | ||
204 | cd u-boot | |
ab584d67 | 205 | make TQM823L_defconfig |
c609719b | 206 | |
7207b366 RD |
207 | Note: If you're looking for the default configuration file for a board |
208 | you're sure used to be there but is now missing, check the file | |
209 | doc/README.scrapyard for a list of no longer supported boards. | |
c609719b | 210 | |
75b3c3aa SG |
211 | Sandbox Environment: |
212 | -------------------- | |
213 | ||
214 | U-Boot can be built natively to run on a Linux host using the 'sandbox' | |
215 | board. This allows feature development which is not board- or architecture- | |
216 | specific to be undertaken on a native platform. The sandbox is also used to | |
217 | run some of U-Boot's tests. | |
218 | ||
6b1978f8 | 219 | See board/sandbox/README.sandbox for more details. |
75b3c3aa SG |
220 | |
221 | ||
db910353 SG |
222 | Board Initialisation Flow: |
223 | -------------------------- | |
224 | ||
225 | This is the intended start-up flow for boards. This should apply for both | |
7207b366 RD |
226 | SPL and U-Boot proper (i.e. they both follow the same rules). |
227 | ||
228 | Note: "SPL" stands for "Secondary Program Loader," which is explained in | |
229 | more detail later in this file. | |
230 | ||
231 | At present, SPL mostly uses a separate code path, but the function names | |
232 | and roles of each function are the same. Some boards or architectures | |
233 | may not conform to this. At least most ARM boards which use | |
234 | CONFIG_SPL_FRAMEWORK conform to this. | |
235 | ||
236 | Execution typically starts with an architecture-specific (and possibly | |
237 | CPU-specific) start.S file, such as: | |
238 | ||
239 | - arch/arm/cpu/armv7/start.S | |
240 | - arch/powerpc/cpu/mpc83xx/start.S | |
241 | - arch/mips/cpu/start.S | |
db910353 | 242 | |
7207b366 RD |
243 | and so on. From there, three functions are called; the purpose and |
244 | limitations of each of these functions are described below. | |
db910353 SG |
245 | |
246 | lowlevel_init(): | |
247 | - purpose: essential init to permit execution to reach board_init_f() | |
248 | - no global_data or BSS | |
249 | - there is no stack (ARMv7 may have one but it will soon be removed) | |
250 | - must not set up SDRAM or use console | |
251 | - must only do the bare minimum to allow execution to continue to | |
252 | board_init_f() | |
253 | - this is almost never needed | |
254 | - return normally from this function | |
255 | ||
256 | board_init_f(): | |
257 | - purpose: set up the machine ready for running board_init_r(): | |
258 | i.e. SDRAM and serial UART | |
259 | - global_data is available | |
260 | - stack is in SRAM | |
261 | - BSS is not available, so you cannot use global/static variables, | |
262 | only stack variables and global_data | |
263 | ||
264 | Non-SPL-specific notes: | |
265 | - dram_init() is called to set up DRAM. If already done in SPL this | |
266 | can do nothing | |
267 | ||
268 | SPL-specific notes: | |
269 | - you can override the entire board_init_f() function with your own | |
270 | version as needed. | |
271 | - preloader_console_init() can be called here in extremis | |
272 | - should set up SDRAM, and anything needed to make the UART work | |
273 | - these is no need to clear BSS, it will be done by crt0.S | |
274 | - must return normally from this function (don't call board_init_r() | |
275 | directly) | |
276 | ||
277 | Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at | |
278 | this point the stack and global_data are relocated to below | |
279 | CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of | |
280 | memory. | |
281 | ||
282 | board_init_r(): | |
283 | - purpose: main execution, common code | |
284 | - global_data is available | |
285 | - SDRAM is available | |
286 | - BSS is available, all static/global variables can be used | |
287 | - execution eventually continues to main_loop() | |
288 | ||
289 | Non-SPL-specific notes: | |
290 | - U-Boot is relocated to the top of memory and is now running from | |
291 | there. | |
292 | ||
293 | SPL-specific notes: | |
294 | - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and | |
295 | CONFIG_SPL_STACK_R_ADDR points into SDRAM | |
296 | - preloader_console_init() can be called here - typically this is | |
297 | done by defining CONFIG_SPL_BOARD_INIT and then supplying a | |
298 | spl_board_init() function containing this call | |
299 | - loads U-Boot or (in falcon mode) Linux | |
300 | ||
301 | ||
302 | ||
c609719b WD |
303 | Configuration Options: |
304 | ---------------------- | |
305 | ||
306 | Configuration depends on the combination of board and CPU type; all | |
307 | such information is kept in a configuration file | |
308 | "include/configs/<board_name>.h". | |
309 | ||
310 | Example: For a TQM823L module, all configuration settings are in | |
311 | "include/configs/TQM823L.h". | |
312 | ||
313 | ||
7f6c2cbc WD |
314 | Many of the options are named exactly as the corresponding Linux |
315 | kernel configuration options. The intention is to make it easier to | |
316 | build a config tool - later. | |
317 | ||
318 | ||
c609719b WD |
319 | The following options need to be configured: |
320 | ||
2628114e KP |
321 | - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. |
322 | ||
323 | - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. | |
6ccec449 WD |
324 | |
325 | - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) | |
09ea0de0 | 326 | Define exactly one, e.g. CONFIG_ATSTK1002 |
c609719b | 327 | |
cf946c6d LW |
328 | - Marvell Family Member |
329 | CONFIG_SYS_MVFS - define it if you want to enable | |
330 | multiple fs option at one time | |
331 | for marvell soc family | |
332 | ||
11ccc33f | 333 | - 8xx CPU Options: (if using an MPC8xx CPU) |
66ca92a5 WD |
334 | CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if |
335 | get_gclk_freq() cannot work | |
5da627a4 WD |
336 | e.g. if there is no 32KHz |
337 | reference PIT/RTC clock | |
66ca92a5 WD |
338 | CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK |
339 | or XTAL/EXTAL) | |
c609719b | 340 | |
66ca92a5 | 341 | - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): |
6d0f6bcf JCPV |
342 | CONFIG_SYS_8xx_CPUCLK_MIN |
343 | CONFIG_SYS_8xx_CPUCLK_MAX | |
66ca92a5 | 344 | CONFIG_8xx_CPUCLK_DEFAULT |
75d1ea7f WD |
345 | See doc/README.MPC866 |
346 | ||
6d0f6bcf | 347 | CONFIG_SYS_MEASURE_CPUCLK |
75d1ea7f | 348 | |
ba56f625 WD |
349 | Define this to measure the actual CPU clock instead |
350 | of relying on the correctness of the configured | |
351 | values. Mostly useful for board bringup to make sure | |
352 | the PLL is locked at the intended frequency. Note | |
353 | that this requires a (stable) reference clock (32 kHz | |
6d0f6bcf | 354 | RTC clock or CONFIG_SYS_8XX_XIN) |
75d1ea7f | 355 | |
506f3918 HS |
356 | CONFIG_SYS_DELAYED_ICACHE |
357 | ||
358 | Define this option if you want to enable the | |
359 | ICache only when Code runs from RAM. | |
360 | ||
66412c63 | 361 | - 85xx CPU Options: |
ffd06e02 YS |
362 | CONFIG_SYS_PPC64 |
363 | ||
364 | Specifies that the core is a 64-bit PowerPC implementation (implements | |
365 | the "64" category of the Power ISA). This is necessary for ePAPR | |
366 | compliance, among other possible reasons. | |
367 | ||
66412c63 KG |
368 | CONFIG_SYS_FSL_TBCLK_DIV |
369 | ||
370 | Defines the core time base clock divider ratio compared to the | |
371 | system clock. On most PQ3 devices this is 8, on newer QorIQ | |
372 | devices it can be 16 or 32. The ratio varies from SoC to Soc. | |
373 | ||
8f29084a KG |
374 | CONFIG_SYS_FSL_PCIE_COMPAT |
375 | ||
376 | Defines the string to utilize when trying to match PCIe device | |
377 | tree nodes for the given platform. | |
378 | ||
33eee330 SW |
379 | CONFIG_SYS_FSL_ERRATUM_A004510 |
380 | ||
381 | Enables a workaround for erratum A004510. If set, | |
382 | then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and | |
383 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. | |
384 | ||
385 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV | |
386 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) | |
387 | ||
388 | Defines one or two SoC revisions (low 8 bits of SVR) | |
389 | for which the A004510 workaround should be applied. | |
390 | ||
391 | The rest of SVR is either not relevant to the decision | |
392 | of whether the erratum is present (e.g. p2040 versus | |
393 | p2041) or is implied by the build target, which controls | |
394 | whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. | |
395 | ||
396 | See Freescale App Note 4493 for more information about | |
397 | this erratum. | |
398 | ||
74fa22ed PK |
399 | CONFIG_A003399_NOR_WORKAROUND |
400 | Enables a workaround for IFC erratum A003399. It is only | |
b445bbb4 | 401 | required during NOR boot. |
74fa22ed | 402 | |
9f074e67 PK |
403 | CONFIG_A008044_WORKAROUND |
404 | Enables a workaround for T1040/T1042 erratum A008044. It is only | |
b445bbb4 | 405 | required during NAND boot and valid for Rev 1.0 SoC revision |
9f074e67 | 406 | |
33eee330 SW |
407 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY |
408 | ||
409 | This is the value to write into CCSR offset 0x18600 | |
410 | according to the A004510 workaround. | |
411 | ||
64501c66 PJ |
412 | CONFIG_SYS_FSL_DSP_DDR_ADDR |
413 | This value denotes start offset of DDR memory which is | |
414 | connected exclusively to the DSP cores. | |
415 | ||
765b0bdb PJ |
416 | CONFIG_SYS_FSL_DSP_M2_RAM_ADDR |
417 | This value denotes start offset of M2 memory | |
418 | which is directly connected to the DSP core. | |
419 | ||
64501c66 PJ |
420 | CONFIG_SYS_FSL_DSP_M3_RAM_ADDR |
421 | This value denotes start offset of M3 memory which is directly | |
422 | connected to the DSP core. | |
423 | ||
765b0bdb PJ |
424 | CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT |
425 | This value denotes start offset of DSP CCSR space. | |
426 | ||
b135991a PJ |
427 | CONFIG_SYS_FSL_SINGLE_SOURCE_CLK |
428 | Single Source Clock is clocking mode present in some of FSL SoC's. | |
429 | In this mode, a single differential clock is used to supply | |
430 | clocks to the sysclock, ddrclock and usbclock. | |
431 | ||
fb4a2409 AB |
432 | CONFIG_SYS_CPC_REINIT_F |
433 | This CONFIG is defined when the CPC is configured as SRAM at the | |
a187559e | 434 | time of U-Boot entry and is required to be re-initialized. |
fb4a2409 | 435 | |
aade2004 | 436 | CONFIG_DEEP_SLEEP |
b445bbb4 | 437 | Indicates this SoC supports deep sleep feature. If deep sleep is |
aade2004 TY |
438 | supported, core will start to execute uboot when wakes up. |
439 | ||
6cb461b4 | 440 | - Generic CPU options: |
2a1680e3 YS |
441 | CONFIG_SYS_GENERIC_GLOBAL_DATA |
442 | Defines global data is initialized in generic board board_init_f(). | |
443 | If this macro is defined, global data is created and cleared in | |
444 | generic board board_init_f(). Without this macro, architecture/board | |
445 | should initialize global data before calling board_init_f(). | |
446 | ||
6cb461b4 DS |
447 | CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN |
448 | ||
449 | Defines the endianess of the CPU. Implementation of those | |
450 | values is arch specific. | |
451 | ||
5614e71b YS |
452 | CONFIG_SYS_FSL_DDR |
453 | Freescale DDR driver in use. This type of DDR controller is | |
454 | found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core | |
455 | SoCs. | |
456 | ||
457 | CONFIG_SYS_FSL_DDR_ADDR | |
458 | Freescale DDR memory-mapped register base. | |
459 | ||
460 | CONFIG_SYS_FSL_DDR_EMU | |
461 | Specify emulator support for DDR. Some DDR features such as | |
462 | deskew training are not available. | |
463 | ||
464 | CONFIG_SYS_FSL_DDRC_GEN1 | |
465 | Freescale DDR1 controller. | |
466 | ||
467 | CONFIG_SYS_FSL_DDRC_GEN2 | |
468 | Freescale DDR2 controller. | |
469 | ||
470 | CONFIG_SYS_FSL_DDRC_GEN3 | |
471 | Freescale DDR3 controller. | |
472 | ||
34e026f9 YS |
473 | CONFIG_SYS_FSL_DDRC_GEN4 |
474 | Freescale DDR4 controller. | |
475 | ||
9ac4ffbd YS |
476 | CONFIG_SYS_FSL_DDRC_ARM_GEN3 |
477 | Freescale DDR3 controller for ARM-based SoCs. | |
478 | ||
5614e71b YS |
479 | CONFIG_SYS_FSL_DDR1 |
480 | Board config to use DDR1. It can be enabled for SoCs with | |
481 | Freescale DDR1 or DDR2 controllers, depending on the board | |
482 | implemetation. | |
483 | ||
484 | CONFIG_SYS_FSL_DDR2 | |
62a3b7dd | 485 | Board config to use DDR2. It can be enabled for SoCs with |
5614e71b YS |
486 | Freescale DDR2 or DDR3 controllers, depending on the board |
487 | implementation. | |
488 | ||
489 | CONFIG_SYS_FSL_DDR3 | |
490 | Board config to use DDR3. It can be enabled for SoCs with | |
34e026f9 YS |
491 | Freescale DDR3 or DDR3L controllers. |
492 | ||
493 | CONFIG_SYS_FSL_DDR3L | |
494 | Board config to use DDR3L. It can be enabled for SoCs with | |
495 | DDR3L controllers. | |
496 | ||
497 | CONFIG_SYS_FSL_DDR4 | |
498 | Board config to use DDR4. It can be enabled for SoCs with | |
499 | DDR4 controllers. | |
5614e71b | 500 | |
1b4175d6 PK |
501 | CONFIG_SYS_FSL_IFC_BE |
502 | Defines the IFC controller register space as Big Endian | |
503 | ||
504 | CONFIG_SYS_FSL_IFC_LE | |
505 | Defines the IFC controller register space as Little Endian | |
506 | ||
1c40707e PK |
507 | CONFIG_SYS_FSL_IFC_CLK_DIV |
508 | Defines divider of platform clock(clock input to IFC controller). | |
509 | ||
add63f94 PK |
510 | CONFIG_SYS_FSL_LBC_CLK_DIV |
511 | Defines divider of platform clock(clock input to eLBC controller). | |
512 | ||
690e4258 PK |
513 | CONFIG_SYS_FSL_PBL_PBI |
514 | It enables addition of RCW (Power on reset configuration) in built image. | |
515 | Please refer doc/README.pblimage for more details | |
516 | ||
517 | CONFIG_SYS_FSL_PBL_RCW | |
518 | It adds PBI(pre-boot instructions) commands in u-boot build image. | |
519 | PBI commands can be used to configure SoC before it starts the execution. | |
520 | Please refer doc/README.pblimage for more details | |
521 | ||
89ad7be8 PK |
522 | CONFIG_SPL_FSL_PBL |
523 | It adds a target to create boot binary having SPL binary in PBI format | |
524 | concatenated with u-boot binary. | |
525 | ||
4e5b1bd0 YS |
526 | CONFIG_SYS_FSL_DDR_BE |
527 | Defines the DDR controller register space as Big Endian | |
528 | ||
529 | CONFIG_SYS_FSL_DDR_LE | |
530 | Defines the DDR controller register space as Little Endian | |
531 | ||
6b9e309a YS |
532 | CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY |
533 | Physical address from the view of DDR controllers. It is the | |
534 | same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But | |
535 | it could be different for ARM SoCs. | |
536 | ||
6b1e1254 YS |
537 | CONFIG_SYS_FSL_DDR_INTLV_256B |
538 | DDR controller interleaving on 256-byte. This is a special | |
539 | interleaving mode, handled by Dickens for Freescale layerscape | |
540 | SoCs with ARM core. | |
541 | ||
1d71efbb YS |
542 | CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS |
543 | Number of controllers used as main memory. | |
544 | ||
545 | CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS | |
546 | Number of controllers used for other than main memory. | |
547 | ||
44937214 PK |
548 | CONFIG_SYS_FSL_HAS_DP_DDR |
549 | Defines the SoC has DP-DDR used for DPAA. | |
550 | ||
028dbb8d RG |
551 | CONFIG_SYS_FSL_SEC_BE |
552 | Defines the SEC controller register space as Big Endian | |
553 | ||
554 | CONFIG_SYS_FSL_SEC_LE | |
555 | Defines the SEC controller register space as Little Endian | |
556 | ||
92bbd64e DS |
557 | - MIPS CPU options: |
558 | CONFIG_SYS_INIT_SP_OFFSET | |
559 | ||
560 | Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack | |
561 | pointer. This is needed for the temporary stack before | |
562 | relocation. | |
563 | ||
564 | CONFIG_SYS_MIPS_CACHE_MODE | |
565 | ||
566 | Cache operation mode for the MIPS CPU. | |
567 | See also arch/mips/include/asm/mipsregs.h. | |
568 | Possible values are: | |
569 | CONF_CM_CACHABLE_NO_WA | |
570 | CONF_CM_CACHABLE_WA | |
571 | CONF_CM_UNCACHED | |
572 | CONF_CM_CACHABLE_NONCOHERENT | |
573 | CONF_CM_CACHABLE_CE | |
574 | CONF_CM_CACHABLE_COW | |
575 | CONF_CM_CACHABLE_CUW | |
576 | CONF_CM_CACHABLE_ACCELERATED | |
577 | ||
578 | CONFIG_SYS_XWAY_EBU_BOOTCFG | |
579 | ||
580 | Special option for Lantiq XWAY SoCs for booting from NOR flash. | |
581 | See also arch/mips/cpu/mips32/start.S. | |
582 | ||
583 | CONFIG_XWAY_SWAP_BYTES | |
584 | ||
585 | Enable compilation of tools/xway-swap-bytes needed for Lantiq | |
586 | XWAY SoCs for booting from NOR flash. The U-Boot image needs to | |
587 | be swapped if a flash programmer is used. | |
588 | ||
b67d8816 CR |
589 | - ARM options: |
590 | CONFIG_SYS_EXCEPTION_VECTORS_HIGH | |
591 | ||
592 | Select high exception vectors of the ARM core, e.g., do not | |
593 | clear the V bit of the c1 register of CP15. | |
594 | ||
5356f545 A |
595 | CONFIG_SYS_THUMB_BUILD |
596 | ||
597 | Use this flag to build U-Boot using the Thumb instruction | |
598 | set for ARM architectures. Thumb instruction set provides | |
599 | better code density. For ARM architectures that support | |
600 | Thumb2 this flag will result in Thumb2 code generated by | |
601 | GCC. | |
602 | ||
c5d4752c | 603 | CONFIG_ARM_ERRATA_716044 |
0678587f SW |
604 | CONFIG_ARM_ERRATA_742230 |
605 | CONFIG_ARM_ERRATA_743622 | |
606 | CONFIG_ARM_ERRATA_751472 | |
b7588e3b | 607 | CONFIG_ARM_ERRATA_761320 |
e392b923 IC |
608 | CONFIG_ARM_ERRATA_773022 |
609 | CONFIG_ARM_ERRATA_774769 | |
610 | CONFIG_ARM_ERRATA_794072 | |
0678587f SW |
611 | |
612 | If set, the workarounds for these ARM errata are applied early | |
613 | during U-Boot startup. Note that these options force the | |
614 | workarounds to be applied; no CPU-type/version detection | |
615 | exists, unlike the similar options in the Linux kernel. Do not | |
616 | set these options unless they apply! | |
617 | ||
207774b2 YS |
618 | COUNTER_FREQUENCY |
619 | Generic timer clock source frequency. | |
620 | ||
621 | COUNTER_FREQUENCY_REAL | |
622 | Generic timer clock source frequency if the real clock is | |
623 | different from COUNTER_FREQUENCY, and can only be determined | |
624 | at run time. | |
625 | ||
c616a0df NM |
626 | NOTE: The following can be machine specific errata. These |
627 | do have ability to provide rudimentary version and machine | |
628 | specific checks, but expect no product checks. | |
5902f4ce | 629 | CONFIG_ARM_ERRATA_430973 |
b45c48a7 | 630 | CONFIG_ARM_ERRATA_454179 |
9b4d65f9 | 631 | CONFIG_ARM_ERRATA_621766 |
c616a0df | 632 | CONFIG_ARM_ERRATA_798870 |
a615d0be | 633 | CONFIG_ARM_ERRATA_801819 |
c616a0df | 634 | |
73c38934 SW |
635 | - Tegra SoC options: |
636 | CONFIG_TEGRA_SUPPORT_NON_SECURE | |
637 | ||
638 | Support executing U-Boot in non-secure (NS) mode. Certain | |
639 | impossible actions will be skipped if the CPU is in NS mode, | |
640 | such as ARM architectural timer initialization. | |
641 | ||
5da627a4 | 642 | - Linux Kernel Interface: |
c609719b WD |
643 | CONFIG_CLOCKS_IN_MHZ |
644 | ||
645 | U-Boot stores all clock information in Hz | |
646 | internally. For binary compatibility with older Linux | |
647 | kernels (which expect the clocks passed in the | |
648 | bd_info data to be in MHz) the environment variable | |
649 | "clocks_in_mhz" can be defined so that U-Boot | |
650 | converts clock data to MHZ before passing it to the | |
651 | Linux kernel. | |
c609719b | 652 | When CONFIG_CLOCKS_IN_MHZ is defined, a definition of |
218ca724 | 653 | "clocks_in_mhz=1" is automatically included in the |
c609719b WD |
654 | default environment. |
655 | ||
5da627a4 WD |
656 | CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] |
657 | ||
b445bbb4 | 658 | When transferring memsize parameter to Linux, some versions |
5da627a4 WD |
659 | expect it to be in bytes, others in MB. |
660 | Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. | |
661 | ||
fec6d9ee | 662 | CONFIG_OF_LIBFDT |
f57f70aa WD |
663 | |
664 | New kernel versions are expecting firmware settings to be | |
213bf8c8 GVB |
665 | passed using flattened device trees (based on open firmware |
666 | concepts). | |
667 | ||
668 | CONFIG_OF_LIBFDT | |
669 | * New libfdt-based support | |
670 | * Adds the "fdt" command | |
3bb342fc | 671 | * The bootm command automatically updates the fdt |
213bf8c8 | 672 | |
b55ae402 MZ |
673 | OF_CPU - The proper name of the cpus node (only required for |
674 | MPC512X and MPC5xxx based boards). | |
675 | OF_SOC - The proper name of the soc node (only required for | |
676 | MPC512X and MPC5xxx based boards). | |
f57f70aa | 677 | OF_TBCLK - The timebase frequency. |
c2871f03 | 678 | OF_STDOUT_PATH - The path to the console device |
f57f70aa | 679 | |
11ccc33f MZ |
680 | boards with QUICC Engines require OF_QE to set UCC MAC |
681 | addresses | |
3bb342fc | 682 | |
4e253137 KG |
683 | CONFIG_OF_BOARD_SETUP |
684 | ||
685 | Board code has addition modification that it wants to make | |
686 | to the flat device tree before handing it off to the kernel | |
f57f70aa | 687 | |
c654b517 SG |
688 | CONFIG_OF_SYSTEM_SETUP |
689 | ||
690 | Other code has addition modification that it wants to make | |
691 | to the flat device tree before handing it off to the kernel. | |
692 | This causes ft_system_setup() to be called before booting | |
693 | the kernel. | |
694 | ||
3887c3fb HS |
695 | CONFIG_OF_IDE_FIXUP |
696 | ||
697 | U-Boot can detect if an IDE device is present or not. | |
698 | If not, and this new config option is activated, U-Boot | |
699 | removes the ATA node from the DTS before booting Linux, | |
700 | so the Linux IDE driver does not probe the device and | |
701 | crash. This is needed for buggy hardware (uc101) where | |
702 | no pull down resistor is connected to the signal IDE5V_DD7. | |
703 | ||
7eb29398 IG |
704 | CONFIG_MACH_TYPE [relevant for ARM only][mandatory] |
705 | ||
706 | This setting is mandatory for all boards that have only one | |
707 | machine type and must be used to specify the machine type | |
708 | number as it appears in the ARM machine registry | |
709 | (see http://www.arm.linux.org.uk/developer/machines/). | |
710 | Only boards that have multiple machine types supported | |
711 | in a single configuration file and the machine type is | |
712 | runtime discoverable, do not have to use this setting. | |
713 | ||
0b2f4eca NG |
714 | - vxWorks boot parameters: |
715 | ||
716 | bootvx constructs a valid bootline using the following | |
9e98b7e3 BM |
717 | environments variables: bootdev, bootfile, ipaddr, netmask, |
718 | serverip, gatewayip, hostname, othbootargs. | |
0b2f4eca NG |
719 | It loads the vxWorks image pointed bootfile. |
720 | ||
0b2f4eca NG |
721 | Note: If a "bootargs" environment is defined, it will overwride |
722 | the defaults discussed just above. | |
723 | ||
2c451f78 A |
724 | - Cache Configuration: |
725 | CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot | |
726 | CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot | |
727 | CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot | |
728 | ||
93bc2193 A |
729 | - Cache Configuration for ARM: |
730 | CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache | |
731 | controller | |
732 | CONFIG_SYS_PL310_BASE - Physical base address of PL310 | |
733 | controller register space | |
734 | ||
6705d81e | 735 | - Serial Ports: |
48d0192f | 736 | CONFIG_PL010_SERIAL |
6705d81e WD |
737 | |
738 | Define this if you want support for Amba PrimeCell PL010 UARTs. | |
739 | ||
48d0192f | 740 | CONFIG_PL011_SERIAL |
6705d81e WD |
741 | |
742 | Define this if you want support for Amba PrimeCell PL011 UARTs. | |
743 | ||
744 | CONFIG_PL011_CLOCK | |
745 | ||
746 | If you have Amba PrimeCell PL011 UARTs, set this variable to | |
747 | the clock speed of the UARTs. | |
748 | ||
749 | CONFIG_PL01x_PORTS | |
750 | ||
751 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, | |
752 | define this to a list of base addresses for each (supported) | |
753 | port. See e.g. include/configs/versatile.h | |
754 | ||
d57dee57 KM |
755 | CONFIG_SERIAL_HW_FLOW_CONTROL |
756 | ||
757 | Define this variable to enable hw flow control in serial driver. | |
758 | Current user of this option is drivers/serial/nsl16550.c driver | |
6705d81e | 759 | |
c609719b | 760 | - Console Interface: |
43d9616c WD |
761 | Depending on board, define exactly one serial port |
762 | (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, | |
763 | CONFIG_8xx_CONS_SCC1, ...), or switch off the serial | |
764 | console by defining CONFIG_8xx_CONS_NONE | |
c609719b WD |
765 | |
766 | Note: if CONFIG_8xx_CONS_NONE is defined, the serial | |
767 | port routines must be defined elsewhere | |
768 | (i.e. serial_init(), serial_getc(), ...) | |
769 | ||
c609719b WD |
770 | - Console Baudrate: |
771 | CONFIG_BAUDRATE - in bps | |
772 | Select one of the baudrates listed in | |
6d0f6bcf JCPV |
773 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
774 | CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale | |
c609719b | 775 | |
c92fac91 HS |
776 | - Console Rx buffer length |
777 | With CONFIG_SYS_SMC_RXBUFLEN it is possible to define | |
778 | the maximum receive buffer length for the SMC. | |
2b3f12c2 | 779 | This option is actual only for 82xx and 8xx possible. |
c92fac91 HS |
780 | If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE |
781 | must be defined, to setup the maximum idle timeout for | |
782 | the SMC. | |
783 | ||
c609719b WD |
784 | - Autoboot Command: |
785 | CONFIG_BOOTCOMMAND | |
786 | Only needed when CONFIG_BOOTDELAY is enabled; | |
787 | define a command string that is automatically executed | |
788 | when no character is read on the console interface | |
789 | within "Boot Delay" after reset. | |
790 | ||
791 | CONFIG_BOOTARGS | |
43d9616c WD |
792 | This can be used to pass arguments to the bootm |
793 | command. The value of CONFIG_BOOTARGS goes into the | |
794 | environment value "bootargs". | |
c609719b WD |
795 | |
796 | CONFIG_RAMBOOT and CONFIG_NFSBOOT | |
43d9616c WD |
797 | The value of these goes into the environment as |
798 | "ramboot" and "nfsboot" respectively, and can be used | |
799 | as a convenience, when switching between booting from | |
11ccc33f | 800 | RAM and NFS. |
c609719b | 801 | |
eda0ba38 HS |
802 | - Bootcount: |
803 | CONFIG_BOOTCOUNT_LIMIT | |
804 | Implements a mechanism for detecting a repeating reboot | |
805 | cycle, see: | |
806 | http://www.denx.de/wiki/view/DULG/UBootBootCountLimit | |
807 | ||
808 | CONFIG_BOOTCOUNT_ENV | |
809 | If no softreset save registers are found on the hardware | |
810 | "bootcount" is stored in the environment. To prevent a | |
811 | saveenv on all reboots, the environment variable | |
812 | "upgrade_available" is used. If "upgrade_available" is | |
813 | 0, "bootcount" is always 0, if "upgrade_available" is | |
814 | 1 "bootcount" is incremented in the environment. | |
815 | So the Userspace Applikation must set the "upgrade_available" | |
816 | and "bootcount" variable to 0, if a boot was successfully. | |
817 | ||
c609719b WD |
818 | - Pre-Boot Commands: |
819 | CONFIG_PREBOOT | |
820 | ||
821 | When this option is #defined, the existence of the | |
822 | environment variable "preboot" will be checked | |
823 | immediately before starting the CONFIG_BOOTDELAY | |
824 | countdown and/or running the auto-boot command resp. | |
825 | entering interactive mode. | |
826 | ||
827 | This feature is especially useful when "preboot" is | |
828 | automatically generated or modified. For an example | |
829 | see the LWMON board specific code: here "preboot" is | |
830 | modified when the user holds down a certain | |
831 | combination of keys on the (special) keyboard when | |
832 | booting the systems | |
833 | ||
834 | - Serial Download Echo Mode: | |
835 | CONFIG_LOADS_ECHO | |
836 | If defined to 1, all characters received during a | |
837 | serial download (using the "loads" command) are | |
838 | echoed back. This might be needed by some terminal | |
839 | emulations (like "cu"), but may as well just take | |
840 | time on others. This setting #define's the initial | |
841 | value of the "loads_echo" environment variable. | |
842 | ||
602ad3b3 | 843 | - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) |
c609719b WD |
844 | CONFIG_KGDB_BAUDRATE |
845 | Select one of the baudrates listed in | |
6d0f6bcf | 846 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
c609719b WD |
847 | |
848 | - Monitor Functions: | |
602ad3b3 JL |
849 | Monitor commands can be included or excluded |
850 | from the build by using the #include files | |
c6c621bd | 851 | <config_cmd_all.h> and #undef'ing unwanted |
ef0f2f57 | 852 | commands, or adding #define's for wanted commands. |
602ad3b3 JL |
853 | |
854 | The default command configuration includes all commands | |
855 | except those marked below with a "*". | |
856 | ||
b401b73d | 857 | CONFIG_CMD_AES AES 128 CBC encrypt/decrypt |
602ad3b3 | 858 | CONFIG_CMD_ASKENV * ask for env variable |
602ad3b3 JL |
859 | CONFIG_CMD_BDI bdinfo |
860 | CONFIG_CMD_BEDBUG * Include BedBug Debugger | |
861 | CONFIG_CMD_BMP * BMP support | |
862 | CONFIG_CMD_BSP * Board specific commands | |
863 | CONFIG_CMD_BOOTD bootd | |
d2b2ffe3 | 864 | CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support |
602ad3b3 | 865 | CONFIG_CMD_CACHE * icache, dcache |
08d0d6f3 | 866 | CONFIG_CMD_CLK * clock command support |
602ad3b3 | 867 | CONFIG_CMD_CONSOLE coninfo |
710b9938 | 868 | CONFIG_CMD_CRC32 * crc32 |
602ad3b3 JL |
869 | CONFIG_CMD_DATE * support for RTC, date/time... |
870 | CONFIG_CMD_DHCP * DHCP support | |
871 | CONFIG_CMD_DIAG * Diagnostics | |
a7c93104 PT |
872 | CONFIG_CMD_DS4510 * ds4510 I2C gpio commands |
873 | CONFIG_CMD_DS4510_INFO * ds4510 I2C info command | |
874 | CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd | |
875 | CONFIG_CMD_DS4510_RST * ds4510 I2C rst command | |
602ad3b3 JL |
876 | CONFIG_CMD_DTT * Digital Therm and Thermostat |
877 | CONFIG_CMD_ECHO echo arguments | |
246c6922 | 878 | CONFIG_CMD_EDITENV edit env variable |
602ad3b3 | 879 | CONFIG_CMD_EEPROM * EEPROM read/write support |
aa9e6044 | 880 | CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands |
602ad3b3 | 881 | CONFIG_CMD_ELF * bootelf, bootvx |
5e2b3e0c | 882 | CONFIG_CMD_ENV_CALLBACK * display details about env callbacks |
fffad71b | 883 | CONFIG_CMD_ENV_FLAGS * display details about env flags |
88733e2c | 884 | CONFIG_CMD_ENV_EXISTS * check existence of env variable |
0c79cda0 | 885 | CONFIG_CMD_EXPORTENV * export the environment |
03e2ecf6 SW |
886 | CONFIG_CMD_EXT2 * ext2 command support |
887 | CONFIG_CMD_EXT4 * ext4 command support | |
16f4d933 SW |
888 | CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) |
889 | that work for multiple fs types | |
59e890ef | 890 | CONFIG_CMD_FS_UUID * Look up a filesystem UUID |
bdab39d3 | 891 | CONFIG_CMD_SAVEENV saveenv |
602ad3b3 | 892 | CONFIG_CMD_FDC * Floppy Disk Support |
03e2ecf6 | 893 | CONFIG_CMD_FAT * FAT command support |
602ad3b3 JL |
894 | CONFIG_CMD_FLASH flinfo, erase, protect |
895 | CONFIG_CMD_FPGA FPGA device initialization support | |
4d98b5c8 | 896 | CONFIG_CMD_FUSE * Device fuse support |
53fdc7ef | 897 | CONFIG_CMD_GETTIME * Get time since boot |
a641b979 | 898 | CONFIG_CMD_GO * the 'go' command (exec code) |
a000b795 | 899 | CONFIG_CMD_GREPENV * search environment |
bf36c5d5 | 900 | CONFIG_CMD_HASH * calculate hash / digest |
602ad3b3 JL |
901 | CONFIG_CMD_I2C * I2C serial bus support |
902 | CONFIG_CMD_IDE * IDE harddisk support | |
903 | CONFIG_CMD_IMI iminfo | |
8fdf1e0f | 904 | CONFIG_CMD_IMLS List all images found in NOR flash |
4d98b5c8 | 905 | CONFIG_CMD_IMLS_NAND * List all images found in NAND flash |
602ad3b3 | 906 | CONFIG_CMD_IMMAP * IMMR dump support |
aa53233a | 907 | CONFIG_CMD_IOTRACE * I/O tracing for debugging |
0c79cda0 | 908 | CONFIG_CMD_IMPORTENV * import an environment |
c167cc02 | 909 | CONFIG_CMD_INI * import data from an ini file into the env |
602ad3b3 JL |
910 | CONFIG_CMD_IRQ * irqinfo |
911 | CONFIG_CMD_ITEST Integer/string test of 2 values | |
912 | CONFIG_CMD_JFFS2 * JFFS2 Support | |
913 | CONFIG_CMD_KGDB * kgdb | |
4d98b5c8 | 914 | CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) |
d22c338e JH |
915 | CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration |
916 | (169.254.*.*) | |
602ad3b3 JL |
917 | CONFIG_CMD_LOADB loadb |
918 | CONFIG_CMD_LOADS loads | |
4d98b5c8 | 919 | CONFIG_CMD_MD5SUM * print md5 message digest |
02c9aa1d | 920 | (requires CONFIG_CMD_MEMORY and CONFIG_MD5) |
15a33e49 | 921 | CONFIG_CMD_MEMINFO * Display detailed memory information |
602ad3b3 | 922 | CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, |
a2681707 | 923 | loop, loopw |
4d98b5c8 | 924 | CONFIG_CMD_MEMTEST * mtest |
602ad3b3 JL |
925 | CONFIG_CMD_MISC Misc functions like sleep etc |
926 | CONFIG_CMD_MMC * MMC memory mapped support | |
927 | CONFIG_CMD_MII * MII utility commands | |
68d7d651 | 928 | CONFIG_CMD_MTDPARTS * MTD partition support |
602ad3b3 JL |
929 | CONFIG_CMD_NAND * NAND support |
930 | CONFIG_CMD_NET bootp, tftpboot, rarpboot | |
4d98b5c8 | 931 | CONFIG_CMD_NFS NFS support |
e92739d3 | 932 | CONFIG_CMD_PCA953X * PCA953x I2C gpio commands |
c0f40859 | 933 | CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command |
602ad3b3 JL |
934 | CONFIG_CMD_PCI * pciinfo |
935 | CONFIG_CMD_PCMCIA * PCMCIA support | |
936 | CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network | |
937 | host | |
938 | CONFIG_CMD_PORTIO * Port I/O | |
ff048ea9 | 939 | CONFIG_CMD_READ * Read raw data from partition |
602ad3b3 JL |
940 | CONFIG_CMD_REGINFO * Register dump |
941 | CONFIG_CMD_RUN run command in env variable | |
d304931f | 942 | CONFIG_CMD_SANDBOX * sb command to access sandbox features |
602ad3b3 | 943 | CONFIG_CMD_SAVES * save S record dump |
c649e3c9 | 944 | CONFIG_SCSI * SCSI Support |
602ad3b3 JL |
945 | CONFIG_CMD_SDRAM * print SDRAM configuration information |
946 | (requires CONFIG_CMD_I2C) | |
947 | CONFIG_CMD_SETGETDCR Support for DCR Register access | |
948 | (4xx only) | |
f61ec45e | 949 | CONFIG_CMD_SF * Read/write/erase SPI NOR flash |
4d98b5c8 | 950 | CONFIG_CMD_SHA1SUM * print sha1 memory digest |
02c9aa1d | 951 | (requires CONFIG_CMD_MEMORY) |
7d861d95 | 952 | CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x |
74de7aef | 953 | CONFIG_CMD_SOURCE "source" command Support |
602ad3b3 | 954 | CONFIG_CMD_SPI * SPI serial bus support |
7a83af07 | 955 | CONFIG_CMD_TFTPSRV * TFTP transfer in server mode |
1fb7cd49 | 956 | CONFIG_CMD_TFTPPUT * TFTP put command (upload) |
da83bcd7 JH |
957 | CONFIG_CMD_TIME * run command and report execution time (ARM specific) |
958 | CONFIG_CMD_TIMER * access to the system tick timer | |
602ad3b3 | 959 | CONFIG_CMD_USB * USB support |
602ad3b3 | 960 | CONFIG_CMD_CDP * Cisco Discover Protocol support |
c8339f51 | 961 | CONFIG_CMD_MFSL * Microblaze FSL support |
4d98b5c8 | 962 | CONFIG_CMD_XIMG Load part of Multi Image |
89c8230d | 963 | CONFIG_CMD_UUID * Generate random UUID or GUID string |
c609719b WD |
964 | |
965 | EXAMPLE: If you want all functions except of network | |
966 | support you can write: | |
967 | ||
602ad3b3 JL |
968 | #include "config_cmd_all.h" |
969 | #undef CONFIG_CMD_NET | |
c609719b | 970 | |
213bf8c8 GVB |
971 | Other Commands: |
972 | fdt (flattened device tree) command: CONFIG_OF_LIBFDT | |
c609719b WD |
973 | |
974 | Note: Don't enable the "icache" and "dcache" commands | |
602ad3b3 | 975 | (configuration option CONFIG_CMD_CACHE) unless you know |
43d9616c WD |
976 | what you (and your U-Boot users) are doing. Data |
977 | cache cannot be enabled on systems like the 8xx or | |
978 | 8260 (where accesses to the IMMR region must be | |
979 | uncached), and it cannot be disabled on all other | |
980 | systems where we (mis-) use the data cache to hold an | |
981 | initial stack and some data. | |
c609719b WD |
982 | |
983 | ||
984 | XXX - this list needs to get updated! | |
985 | ||
302a6487 SG |
986 | - Removal of commands |
987 | If no commands are needed to boot, you can disable | |
988 | CONFIG_CMDLINE to remove them. In this case, the command line | |
989 | will not be available, and when U-Boot wants to execute the | |
990 | boot command (on start-up) it will call board_run_command() | |
991 | instead. This can reduce image size significantly for very | |
992 | simple boot procedures. | |
993 | ||
a5ecbe62 WD |
994 | - Regular expression support: |
995 | CONFIG_REGEX | |
93e14596 WD |
996 | If this variable is defined, U-Boot is linked against |
997 | the SLRE (Super Light Regular Expression) library, | |
998 | which adds regex support to some commands, as for | |
999 | example "env grep" and "setexpr". | |
a5ecbe62 | 1000 | |
45ba8077 SG |
1001 | - Device tree: |
1002 | CONFIG_OF_CONTROL | |
1003 | If this variable is defined, U-Boot will use a device tree | |
1004 | to configure its devices, instead of relying on statically | |
1005 | compiled #defines in the board file. This option is | |
1006 | experimental and only available on a few boards. The device | |
1007 | tree is available in the global data as gd->fdt_blob. | |
1008 | ||
2c0f79e4 SG |
1009 | U-Boot needs to get its device tree from somewhere. This can |
1010 | be done using one of the two options below: | |
bbb0b128 SG |
1011 | |
1012 | CONFIG_OF_EMBED | |
1013 | If this variable is defined, U-Boot will embed a device tree | |
1014 | binary in its image. This device tree file should be in the | |
1015 | board directory and called <soc>-<board>.dts. The binary file | |
1016 | is then picked up in board_init_f() and made available through | |
1017 | the global data structure as gd->blob. | |
45ba8077 | 1018 | |
2c0f79e4 SG |
1019 | CONFIG_OF_SEPARATE |
1020 | If this variable is defined, U-Boot will build a device tree | |
1021 | binary. It will be called u-boot.dtb. Architecture-specific | |
1022 | code will locate it at run-time. Generally this works by: | |
1023 | ||
1024 | cat u-boot.bin u-boot.dtb >image.bin | |
1025 | ||
1026 | and in fact, U-Boot does this for you, creating a file called | |
1027 | u-boot-dtb.bin which is useful in the common case. You can | |
1028 | still use the individual files if you need something more | |
1029 | exotic. | |
1030 | ||
c609719b WD |
1031 | - Watchdog: |
1032 | CONFIG_WATCHDOG | |
1033 | If this variable is defined, it enables watchdog | |
6abe6fb6 DZ |
1034 | support for the SoC. There must be support in the SoC |
1035 | specific code for a watchdog. For the 8xx and 8260 | |
1036 | CPUs, the SIU Watchdog feature is enabled in the SYPCR | |
1037 | register. When supported for a specific SoC is | |
1038 | available, then no further board specific code should | |
1039 | be needed to use it. | |
1040 | ||
1041 | CONFIG_HW_WATCHDOG | |
1042 | When using a watchdog circuitry external to the used | |
1043 | SoC, then define this variable and provide board | |
1044 | specific code for the "hw_watchdog_reset" function. | |
c609719b | 1045 | |
7bae0d6f HS |
1046 | CONFIG_AT91_HW_WDT_TIMEOUT |
1047 | specify the timeout in seconds. default 2 seconds. | |
1048 | ||
c1551ea8 SR |
1049 | - U-Boot Version: |
1050 | CONFIG_VERSION_VARIABLE | |
1051 | If this variable is defined, an environment variable | |
1052 | named "ver" is created by U-Boot showing the U-Boot | |
1053 | version as printed by the "version" command. | |
a1ea8e51 BT |
1054 | Any change to this variable will be reverted at the |
1055 | next reset. | |
c1551ea8 | 1056 | |
c609719b WD |
1057 | - Real-Time Clock: |
1058 | ||
602ad3b3 | 1059 | When CONFIG_CMD_DATE is selected, the type of the RTC |
c609719b WD |
1060 | has to be selected, too. Define exactly one of the |
1061 | following options: | |
1062 | ||
1063 | CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx | |
1064 | CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC | |
4e8b7544 | 1065 | CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC |
c609719b | 1066 | CONFIG_RTC_MC146818 - use MC146818 RTC |
1cb8e980 | 1067 | CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC |
c609719b | 1068 | CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC |
7f70e853 | 1069 | CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC |
412921d2 | 1070 | CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC |
3bac3513 | 1071 | CONFIG_RTC_DS164x - use Dallas DS164x RTC |
9536dfcc | 1072 | CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC |
4c0d4c3b | 1073 | CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC |
6d0f6bcf | 1074 | CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 |
71d19f30 HS |
1075 | CONFIG_SYS_RV3029_TCR - enable trickle charger on |
1076 | RV3029 RTC. | |
c609719b | 1077 | |
b37c7e5e WD |
1078 | Note that if the RTC uses I2C, then the I2C interface |
1079 | must also be configured. See I2C Support, below. | |
1080 | ||
e92739d3 PT |
1081 | - GPIO Support: |
1082 | CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO | |
e92739d3 | 1083 | |
5dec49ca CP |
1084 | The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of |
1085 | chip-ngpio pairs that tell the PCA953X driver the number of | |
1086 | pins supported by a particular chip. | |
1087 | ||
e92739d3 PT |
1088 | Note that if the GPIO device uses I2C, then the I2C interface |
1089 | must also be configured. See I2C Support, below. | |
1090 | ||
aa53233a SG |
1091 | - I/O tracing: |
1092 | When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O | |
1093 | accesses and can checksum them or write a list of them out | |
1094 | to memory. See the 'iotrace' command for details. This is | |
1095 | useful for testing device drivers since it can confirm that | |
1096 | the driver behaves the same way before and after a code | |
1097 | change. Currently this is supported on sandbox and arm. To | |
1098 | add support for your architecture, add '#include <iotrace.h>' | |
1099 | to the bottom of arch/<arch>/include/asm/io.h and test. | |
1100 | ||
1101 | Example output from the 'iotrace stats' command is below. | |
1102 | Note that if the trace buffer is exhausted, the checksum will | |
1103 | still continue to operate. | |
1104 | ||
1105 | iotrace is enabled | |
1106 | Start: 10000000 (buffer start address) | |
1107 | Size: 00010000 (buffer size) | |
1108 | Offset: 00000120 (current buffer offset) | |
1109 | Output: 10000120 (start + offset) | |
1110 | Count: 00000018 (number of trace records) | |
1111 | CRC32: 9526fb66 (CRC32 of all trace records) | |
1112 | ||
c609719b WD |
1113 | - Timestamp Support: |
1114 | ||
43d9616c WD |
1115 | When CONFIG_TIMESTAMP is selected, the timestamp |
1116 | (date and time) of an image is printed by image | |
1117 | commands like bootm or iminfo. This option is | |
602ad3b3 | 1118 | automatically enabled when you select CONFIG_CMD_DATE . |
c609719b | 1119 | |
923c46f9 KP |
1120 | - Partition Labels (disklabels) Supported: |
1121 | Zero or more of the following: | |
1122 | CONFIG_MAC_PARTITION Apple's MacOS partition table. | |
1123 | CONFIG_DOS_PARTITION MS Dos partition table, traditional on the | |
1124 | Intel architecture, USB sticks, etc. | |
1125 | CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. | |
1126 | CONFIG_EFI_PARTITION GPT partition table, common when EFI is the | |
1127 | bootloader. Note 2TB partition limit; see | |
1128 | disk/part_efi.c | |
1129 | CONFIG_MTD_PARTITIONS Memory Technology Device partition table. | |
c609719b | 1130 | |
218ca724 | 1131 | If IDE or SCSI support is enabled (CONFIG_CMD_IDE or |
c649e3c9 | 1132 | CONFIG_SCSI) you must configure support for at |
923c46f9 | 1133 | least one non-MTD partition type as well. |
c609719b WD |
1134 | |
1135 | - IDE Reset method: | |
4d13cbad WD |
1136 | CONFIG_IDE_RESET_ROUTINE - this is defined in several |
1137 | board configurations files but used nowhere! | |
c609719b | 1138 | |
4d13cbad WD |
1139 | CONFIG_IDE_RESET - is this is defined, IDE Reset will |
1140 | be performed by calling the function | |
1141 | ide_set_reset(int reset) | |
1142 | which has to be defined in a board specific file | |
c609719b WD |
1143 | |
1144 | - ATAPI Support: | |
1145 | CONFIG_ATAPI | |
1146 | ||
1147 | Set this to enable ATAPI support. | |
1148 | ||
c40b2956 WD |
1149 | - LBA48 Support |
1150 | CONFIG_LBA48 | |
1151 | ||
1152 | Set this to enable support for disks larger than 137GB | |
4b142feb | 1153 | Also look at CONFIG_SYS_64BIT_LBA. |
c40b2956 WD |
1154 | Whithout these , LBA48 support uses 32bit variables and will 'only' |
1155 | support disks up to 2.1TB. | |
1156 | ||
6d0f6bcf | 1157 | CONFIG_SYS_64BIT_LBA: |
c40b2956 WD |
1158 | When enabled, makes the IDE subsystem use 64bit sector addresses. |
1159 | Default is 32bit. | |
1160 | ||
c609719b WD |
1161 | - SCSI Support: |
1162 | At the moment only there is only support for the | |
1163 | SYM53C8XX SCSI controller; define | |
1164 | CONFIG_SCSI_SYM53C8XX to enable it. | |
1165 | ||
6d0f6bcf JCPV |
1166 | CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and |
1167 | CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * | |
1168 | CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the | |
c609719b WD |
1169 | maximum numbers of LUNs, SCSI ID's and target |
1170 | devices. | |
6d0f6bcf | 1171 | CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) |
c609719b | 1172 | |
93e14596 WD |
1173 | The environment variable 'scsidevs' is set to the number of |
1174 | SCSI devices found during the last scan. | |
447c031b | 1175 | |
c609719b | 1176 | - NETWORK Support (PCI): |
682011ff | 1177 | CONFIG_E1000 |
ce5207e1 KM |
1178 | Support for Intel 8254x/8257x gigabit chips. |
1179 | ||
1180 | CONFIG_E1000_SPI | |
1181 | Utility code for direct access to the SPI bus on Intel 8257x. | |
1182 | This does not do anything useful unless you set at least one | |
1183 | of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. | |
1184 | ||
1185 | CONFIG_E1000_SPI_GENERIC | |
1186 | Allow generic access to the SPI bus on the Intel 8257x, for | |
1187 | example with the "sspi" command. | |
1188 | ||
1189 | CONFIG_CMD_E1000 | |
1190 | Management command for E1000 devices. When used on devices | |
1191 | with SPI support you can reprogram the EEPROM from U-Boot. | |
53cf9435 | 1192 | |
c609719b WD |
1193 | CONFIG_EEPRO100 |
1194 | Support for Intel 82557/82559/82559ER chips. | |
11ccc33f | 1195 | Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM |
c609719b WD |
1196 | write routine for first time initialisation. |
1197 | ||
1198 | CONFIG_TULIP | |
1199 | Support for Digital 2114x chips. | |
1200 | Optional CONFIG_TULIP_SELECT_MEDIA for board specific | |
1201 | modem chip initialisation (KS8761/QS6611). | |
1202 | ||
1203 | CONFIG_NATSEMI | |
1204 | Support for National dp83815 chips. | |
1205 | ||
1206 | CONFIG_NS8382X | |
1207 | Support for National dp8382[01] gigabit chips. | |
1208 | ||
45219c46 WD |
1209 | - NETWORK Support (other): |
1210 | ||
c041e9d2 JS |
1211 | CONFIG_DRIVER_AT91EMAC |
1212 | Support for AT91RM9200 EMAC. | |
1213 | ||
1214 | CONFIG_RMII | |
1215 | Define this to use reduced MII inteface | |
1216 | ||
1217 | CONFIG_DRIVER_AT91EMAC_QUIET | |
1218 | If this defined, the driver is quiet. | |
1219 | The driver doen't show link status messages. | |
1220 | ||
efdd7319 RH |
1221 | CONFIG_CALXEDA_XGMAC |
1222 | Support for the Calxeda XGMAC device | |
1223 | ||
3bb46d23 | 1224 | CONFIG_LAN91C96 |
45219c46 WD |
1225 | Support for SMSC's LAN91C96 chips. |
1226 | ||
45219c46 WD |
1227 | CONFIG_LAN91C96_USE_32_BIT |
1228 | Define this to enable 32 bit addressing | |
1229 | ||
3bb46d23 | 1230 | CONFIG_SMC91111 |
f39748ae WD |
1231 | Support for SMSC's LAN91C111 chip |
1232 | ||
1233 | CONFIG_SMC91111_BASE | |
1234 | Define this to hold the physical address | |
1235 | of the device (I/O space) | |
1236 | ||
1237 | CONFIG_SMC_USE_32_BIT | |
1238 | Define this if data bus is 32 bits | |
1239 | ||
1240 | CONFIG_SMC_USE_IOFUNCS | |
1241 | Define this to use i/o functions instead of macros | |
1242 | (some hardware wont work with macros) | |
1243 | ||
dc02bada HS |
1244 | CONFIG_DRIVER_TI_EMAC |
1245 | Support for davinci emac | |
1246 | ||
1247 | CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT | |
1248 | Define this if you have more then 3 PHYs. | |
1249 | ||
b3dbf4a5 ML |
1250 | CONFIG_FTGMAC100 |
1251 | Support for Faraday's FTGMAC100 Gigabit SoC Ethernet | |
1252 | ||
1253 | CONFIG_FTGMAC100_EGIGA | |
1254 | Define this to use GE link update with gigabit PHY. | |
1255 | Define this if FTGMAC100 is connected to gigabit PHY. | |
1256 | If your system has 10/100 PHY only, it might not occur | |
1257 | wrong behavior. Because PHY usually return timeout or | |
1258 | useless data when polling gigabit status and gigabit | |
1259 | control registers. This behavior won't affect the | |
1260 | correctnessof 10/100 link speed update. | |
1261 | ||
c2fff331 | 1262 | CONFIG_SMC911X |
557b377d JG |
1263 | Support for SMSC's LAN911x and LAN921x chips |
1264 | ||
c2fff331 | 1265 | CONFIG_SMC911X_BASE |
557b377d JG |
1266 | Define this to hold the physical address |
1267 | of the device (I/O space) | |
1268 | ||
c2fff331 | 1269 | CONFIG_SMC911X_32_BIT |
557b377d JG |
1270 | Define this if data bus is 32 bits |
1271 | ||
c2fff331 | 1272 | CONFIG_SMC911X_16_BIT |
557b377d JG |
1273 | Define this if data bus is 16 bits. If your processor |
1274 | automatically converts one 32 bit word to two 16 bit | |
c2fff331 | 1275 | words you may also try CONFIG_SMC911X_32_BIT. |
557b377d | 1276 | |
3d0075fa YS |
1277 | CONFIG_SH_ETHER |
1278 | Support for Renesas on-chip Ethernet controller | |
1279 | ||
1280 | CONFIG_SH_ETHER_USE_PORT | |
1281 | Define the number of ports to be used | |
1282 | ||
1283 | CONFIG_SH_ETHER_PHY_ADDR | |
1284 | Define the ETH PHY's address | |
1285 | ||
68260aab YS |
1286 | CONFIG_SH_ETHER_CACHE_WRITEBACK |
1287 | If this option is set, the driver enables cache flush. | |
1288 | ||
b2f97cf2 HS |
1289 | - PWM Support: |
1290 | CONFIG_PWM_IMX | |
5052e819 | 1291 | Support for PWM module on the imx6. |
b2f97cf2 | 1292 | |
5e124724 | 1293 | - TPM Support: |
90899cc0 CC |
1294 | CONFIG_TPM |
1295 | Support TPM devices. | |
1296 | ||
0766ad2f CR |
1297 | CONFIG_TPM_TIS_INFINEON |
1298 | Support for Infineon i2c bus TPM devices. Only one device | |
1b393db5 TWHT |
1299 | per system is supported at this time. |
1300 | ||
1b393db5 TWHT |
1301 | CONFIG_TPM_TIS_I2C_BURST_LIMITATION |
1302 | Define the burst count bytes upper limit | |
1303 | ||
3aa74088 CR |
1304 | CONFIG_TPM_ST33ZP24 |
1305 | Support for STMicroelectronics TPM devices. Requires DM_TPM support. | |
1306 | ||
1307 | CONFIG_TPM_ST33ZP24_I2C | |
1308 | Support for STMicroelectronics ST33ZP24 I2C devices. | |
1309 | Requires TPM_ST33ZP24 and I2C. | |
1310 | ||
b75fdc11 CR |
1311 | CONFIG_TPM_ST33ZP24_SPI |
1312 | Support for STMicroelectronics ST33ZP24 SPI devices. | |
1313 | Requires TPM_ST33ZP24 and SPI. | |
1314 | ||
c01939c7 DE |
1315 | CONFIG_TPM_ATMEL_TWI |
1316 | Support for Atmel TWI TPM device. Requires I2C support. | |
1317 | ||
90899cc0 | 1318 | CONFIG_TPM_TIS_LPC |
5e124724 VB |
1319 | Support for generic parallel port TPM devices. Only one device |
1320 | per system is supported at this time. | |
1321 | ||
1322 | CONFIG_TPM_TIS_BASE_ADDRESS | |
1323 | Base address where the generic TPM device is mapped | |
1324 | to. Contemporary x86 systems usually map it at | |
1325 | 0xfed40000. | |
1326 | ||
be6c1529 RP |
1327 | CONFIG_CMD_TPM |
1328 | Add tpm monitor functions. | |
1329 | Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also | |
1330 | provides monitor access to authorized functions. | |
1331 | ||
1332 | CONFIG_TPM | |
1333 | Define this to enable the TPM support library which provides | |
1334 | functional interfaces to some TPM commands. | |
1335 | Requires support for a TPM device. | |
1336 | ||
1337 | CONFIG_TPM_AUTH_SESSIONS | |
1338 | Define this to enable authorized functions in the TPM library. | |
1339 | Requires CONFIG_TPM and CONFIG_SHA1. | |
1340 | ||
c609719b WD |
1341 | - USB Support: |
1342 | At the moment only the UHCI host controller is | |
4d13cbad | 1343 | supported (PIP405, MIP405, MPC5200); define |
c609719b WD |
1344 | CONFIG_USB_UHCI to enable it. |
1345 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard | |
30d56fae | 1346 | and define CONFIG_USB_STORAGE to enable the USB |
c609719b WD |
1347 | storage devices. |
1348 | Note: | |
1349 | Supported are USB Keyboards and USB Floppy drives | |
1350 | (TEAC FD-05PUB). | |
4d13cbad WD |
1351 | MPC5200 USB requires additional defines: |
1352 | CONFIG_USB_CLOCK | |
1353 | for 528 MHz Clock: 0x0001bbbb | |
307ecb6d EM |
1354 | CONFIG_PSC3_USB |
1355 | for USB on PSC3 | |
4d13cbad WD |
1356 | CONFIG_USB_CONFIG |
1357 | for differential drivers: 0x00001000 | |
1358 | for single ended drivers: 0x00005000 | |
307ecb6d EM |
1359 | for differential drivers on PSC3: 0x00000100 |
1360 | for single ended drivers on PSC3: 0x00004100 | |
6d0f6bcf | 1361 | CONFIG_SYS_USB_EVENT_POLL |
fdcfaa1b ZW |
1362 | May be defined to allow interrupt polling |
1363 | instead of using asynchronous interrupts | |
4d13cbad | 1364 | |
9ab4ce22 SG |
1365 | CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the |
1366 | txfilltuning field in the EHCI controller on reset. | |
1367 | ||
6e9e0626 OT |
1368 | CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 |
1369 | HW module registers. | |
1370 | ||
16c8d5e7 WD |
1371 | - USB Device: |
1372 | Define the below if you wish to use the USB console. | |
1373 | Once firmware is rebuilt from a serial console issue the | |
1374 | command "setenv stdin usbtty; setenv stdout usbtty" and | |
11ccc33f | 1375 | attach your USB cable. The Unix command "dmesg" should print |
16c8d5e7 WD |
1376 | it has found a new device. The environment variable usbtty |
1377 | can be set to gserial or cdc_acm to enable your device to | |
386eda02 | 1378 | appear to a USB host as a Linux gserial device or a |
16c8d5e7 WD |
1379 | Common Device Class Abstract Control Model serial device. |
1380 | If you select usbtty = gserial you should be able to enumerate | |
1381 | a Linux host by | |
1382 | # modprobe usbserial vendor=0xVendorID product=0xProductID | |
1383 | else if using cdc_acm, simply setting the environment | |
1384 | variable usbtty to be cdc_acm should suffice. The following | |
1385 | might be defined in YourBoardName.h | |
386eda02 | 1386 | |
16c8d5e7 WD |
1387 | CONFIG_USB_DEVICE |
1388 | Define this to build a UDC device | |
1389 | ||
1390 | CONFIG_USB_TTY | |
1391 | Define this to have a tty type of device available to | |
1392 | talk to the UDC device | |
386eda02 | 1393 | |
f9da0f89 VK |
1394 | CONFIG_USBD_HS |
1395 | Define this to enable the high speed support for usb | |
1396 | device and usbtty. If this feature is enabled, a routine | |
1397 | int is_usbd_high_speed(void) | |
1398 | also needs to be defined by the driver to dynamically poll | |
1399 | whether the enumeration has succeded at high speed or full | |
1400 | speed. | |
1401 | ||
6d0f6bcf | 1402 | CONFIG_SYS_CONSOLE_IS_IN_ENV |
16c8d5e7 WD |
1403 | Define this if you want stdin, stdout &/or stderr to |
1404 | be set to usbtty. | |
1405 | ||
1406 | mpc8xx: | |
6d0f6bcf | 1407 | CONFIG_SYS_USB_EXTC_CLK 0xBLAH |
16c8d5e7 | 1408 | Derive USB clock from external clock "blah" |
6d0f6bcf | 1409 | - CONFIG_SYS_USB_EXTC_CLK 0x02 |
386eda02 | 1410 | |
386eda02 | 1411 | If you have a USB-IF assigned VendorID then you may wish to |
16c8d5e7 | 1412 | define your own vendor specific values either in BoardName.h |
386eda02 | 1413 | or directly in usbd_vendor_info.h. If you don't define |
16c8d5e7 WD |
1414 | CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, |
1415 | CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot | |
1416 | should pretend to be a Linux device to it's target host. | |
1417 | ||
1418 | CONFIG_USBD_MANUFACTURER | |
1419 | Define this string as the name of your company for | |
1420 | - CONFIG_USBD_MANUFACTURER "my company" | |
386eda02 | 1421 | |
16c8d5e7 WD |
1422 | CONFIG_USBD_PRODUCT_NAME |
1423 | Define this string as the name of your product | |
1424 | - CONFIG_USBD_PRODUCT_NAME "acme usb device" | |
1425 | ||
1426 | CONFIG_USBD_VENDORID | |
1427 | Define this as your assigned Vendor ID from the USB | |
1428 | Implementors Forum. This *must* be a genuine Vendor ID | |
1429 | to avoid polluting the USB namespace. | |
1430 | - CONFIG_USBD_VENDORID 0xFFFF | |
386eda02 | 1431 | |
16c8d5e7 WD |
1432 | CONFIG_USBD_PRODUCTID |
1433 | Define this as the unique Product ID | |
1434 | for your device | |
1435 | - CONFIG_USBD_PRODUCTID 0xFFFF | |
4d13cbad | 1436 | |
d70a560f IG |
1437 | - ULPI Layer Support: |
1438 | The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via | |
1439 | the generic ULPI layer. The generic layer accesses the ULPI PHY | |
1440 | via the platform viewport, so you need both the genric layer and | |
1441 | the viewport enabled. Currently only Chipidea/ARC based | |
1442 | viewport is supported. | |
1443 | To enable the ULPI layer support, define CONFIG_USB_ULPI and | |
1444 | CONFIG_USB_ULPI_VIEWPORT in your board configuration file. | |
6d365ea0 LS |
1445 | If your ULPI phy needs a different reference clock than the |
1446 | standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to | |
1447 | the appropriate value in Hz. | |
c609719b | 1448 | |
71f95118 | 1449 | - MMC Support: |
8bde7f77 WD |
1450 | The MMC controller on the Intel PXA is supported. To |
1451 | enable this define CONFIG_MMC. The MMC can be | |
1452 | accessed from the boot prompt by mapping the device | |
71f95118 | 1453 | to physical memory similar to flash. Command line is |
602ad3b3 JL |
1454 | enabled with CONFIG_CMD_MMC. The MMC driver also works with |
1455 | the FAT fs. This is enabled with CONFIG_CMD_FAT. | |
71f95118 | 1456 | |
afb35666 YS |
1457 | CONFIG_SH_MMCIF |
1458 | Support for Renesas on-chip MMCIF controller | |
1459 | ||
1460 | CONFIG_SH_MMCIF_ADDR | |
1461 | Define the base address of MMCIF registers | |
1462 | ||
1463 | CONFIG_SH_MMCIF_CLK | |
1464 | Define the clock frequency for MMCIF | |
1465 | ||
1fd93c6e PA |
1466 | CONFIG_SUPPORT_EMMC_BOOT |
1467 | Enable some additional features of the eMMC boot partitions. | |
1468 | ||
1469 | CONFIG_SUPPORT_EMMC_RPMB | |
1470 | Enable the commands for reading, writing and programming the | |
1471 | key for the Replay Protection Memory Block partition in eMMC. | |
1472 | ||
b3ba6e94 | 1473 | - USB Device Firmware Update (DFU) class support: |
01acd6ab | 1474 | CONFIG_USB_FUNCTION_DFU |
b3ba6e94 TR |
1475 | This enables the USB portion of the DFU USB class |
1476 | ||
1477 | CONFIG_CMD_DFU | |
1478 | This enables the command "dfu" which is used to have | |
1479 | U-Boot create a DFU class device via USB. This command | |
1480 | requires that the "dfu_alt_info" environment variable be | |
1481 | set and define the alt settings to expose to the host. | |
1482 | ||
1483 | CONFIG_DFU_MMC | |
1484 | This enables support for exposing (e)MMC devices via DFU. | |
1485 | ||
c6631764 PA |
1486 | CONFIG_DFU_NAND |
1487 | This enables support for exposing NAND devices via DFU. | |
1488 | ||
a9479f04 AM |
1489 | CONFIG_DFU_RAM |
1490 | This enables support for exposing RAM via DFU. | |
1491 | Note: DFU spec refer to non-volatile memory usage, but | |
1492 | allow usages beyond the scope of spec - here RAM usage, | |
1493 | one that would help mostly the developer. | |
1494 | ||
e7e75c70 HS |
1495 | CONFIG_SYS_DFU_DATA_BUF_SIZE |
1496 | Dfu transfer uses a buffer before writing data to the | |
1497 | raw storage device. Make the size (in bytes) of this buffer | |
1498 | configurable. The size of this buffer is also configurable | |
1499 | through the "dfu_bufsiz" environment variable. | |
1500 | ||
ea2453d5 PA |
1501 | CONFIG_SYS_DFU_MAX_FILE_SIZE |
1502 | When updating files rather than the raw storage device, | |
1503 | we use a static buffer to copy the file into and then write | |
1504 | the buffer once we've been given the whole file. Define | |
1505 | this to the maximum filesize (in bytes) for the buffer. | |
1506 | Default is 4 MiB if undefined. | |
1507 | ||
001a8319 HS |
1508 | DFU_DEFAULT_POLL_TIMEOUT |
1509 | Poll timeout [ms], is the timeout a device can send to the | |
1510 | host. The host must wait for this timeout before sending | |
1511 | a subsequent DFU_GET_STATUS request to the device. | |
1512 | ||
1513 | DFU_MANIFEST_POLL_TIMEOUT | |
1514 | Poll timeout [ms], which the device sends to the host when | |
1515 | entering dfuMANIFEST state. Host waits this timeout, before | |
1516 | sending again an USB request to the device. | |
1517 | ||
3aab70af | 1518 | - USB Device Android Fastboot support: |
17da3c0c PK |
1519 | CONFIG_USB_FUNCTION_FASTBOOT |
1520 | This enables the USB part of the fastboot gadget | |
1521 | ||
3aab70af SS |
1522 | CONFIG_CMD_FASTBOOT |
1523 | This enables the command "fastboot" which enables the Android | |
1524 | fastboot mode for the platform's USB device. Fastboot is a USB | |
1525 | protocol for downloading images, flashing and device control | |
1526 | used on Android devices. | |
1527 | See doc/README.android-fastboot for more information. | |
1528 | ||
1529 | CONFIG_ANDROID_BOOT_IMAGE | |
1530 | This enables support for booting images which use the Android | |
1531 | image format header. | |
1532 | ||
a588d99a | 1533 | CONFIG_FASTBOOT_BUF_ADDR |
3aab70af SS |
1534 | The fastboot protocol requires a large memory buffer for |
1535 | downloads. Define this to the starting RAM address to use for | |
1536 | downloaded images. | |
1537 | ||
a588d99a | 1538 | CONFIG_FASTBOOT_BUF_SIZE |
3aab70af SS |
1539 | The fastboot protocol requires a large memory buffer for |
1540 | downloads. This buffer should be as large as possible for a | |
1541 | platform. Define this to the size available RAM for fastboot. | |
d1b5ed07 SR |
1542 | |
1543 | CONFIG_FASTBOOT_FLASH | |
1544 | The fastboot protocol includes a "flash" command for writing | |
1545 | the downloaded image to a non-volatile storage device. Define | |
1546 | this to enable the "fastboot flash" command. | |
1547 | ||
1548 | CONFIG_FASTBOOT_FLASH_MMC_DEV | |
1549 | The fastboot "flash" command requires additional information | |
1550 | regarding the non-volatile storage device. Define this to | |
1551 | the eMMC device that fastboot should use to store the image. | |
3aab70af | 1552 | |
0ff7e585 SR |
1553 | CONFIG_FASTBOOT_GPT_NAME |
1554 | The fastboot "flash" command supports writing the downloaded | |
1555 | image to the Protective MBR and the Primary GUID Partition | |
1556 | Table. (Additionally, this downloaded image is post-processed | |
1557 | to generate and write the Backup GUID Partition Table.) | |
1558 | This occurs when the specified "partition name" on the | |
1559 | "fastboot flash" command line matches this value. | |
6f6c8630 | 1560 | The default is "gpt" if undefined. |
0ff7e585 | 1561 | |
b6dd69a4 PK |
1562 | CONFIG_FASTBOOT_MBR_NAME |
1563 | The fastboot "flash" command supports writing the downloaded | |
1564 | image to DOS MBR. | |
1565 | This occurs when the "partition name" specified on the | |
1566 | "fastboot flash" command line matches this value. | |
1567 | If not defined the default value "mbr" is used. | |
1568 | ||
6705d81e | 1569 | - Journaling Flash filesystem support: |
b2482dff | 1570 | CONFIG_JFFS2_NAND |
6705d81e WD |
1571 | Define these for a default partition on a NAND device |
1572 | ||
6d0f6bcf JCPV |
1573 | CONFIG_SYS_JFFS2_FIRST_SECTOR, |
1574 | CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS | |
6705d81e WD |
1575 | Define these for a default partition on a NOR device |
1576 | ||
c30a15e5 DK |
1577 | - FAT(File Allocation Table) filesystem write function support: |
1578 | CONFIG_FAT_WRITE | |
656f4c65 DK |
1579 | |
1580 | Define this to enable support for saving memory data as a | |
1581 | file in FAT formatted partition. | |
1582 | ||
1583 | This will also enable the command "fatwrite" enabling the | |
1584 | user to write files to FAT. | |
c30a15e5 | 1585 | |
edb42dba | 1586 | - CBFS (Coreboot Filesystem) support: |
84cd9327 GB |
1587 | CONFIG_CMD_CBFS |
1588 | ||
1589 | Define this to enable support for reading from a Coreboot | |
1590 | filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls | |
1591 | and cbfsload. | |
1592 | ||
4f0d1a2a SDPP |
1593 | - FAT(File Allocation Table) filesystem cluster size: |
1594 | CONFIG_FS_FAT_MAX_CLUSTSIZE | |
1595 | ||
1596 | Define the max cluster size for fat operations else | |
1597 | a default value of 65536 will be defined. | |
1598 | ||
c609719b | 1599 | - Keyboard Support: |
39f615ed SG |
1600 | See Kconfig help for available keyboard drivers. |
1601 | ||
1602 | CONFIG_KEYBOARD | |
1603 | ||
1604 | Define this to enable a custom keyboard support. | |
1605 | This simply calls drv_keyboard_init() which must be | |
1606 | defined in your board-specific files. This option is deprecated | |
1607 | and is only used by novena. For new boards, use driver model | |
1608 | instead. | |
c609719b WD |
1609 | |
1610 | - Video support: | |
7d3053fb | 1611 | CONFIG_FSL_DIU_FB |
04e5ae79 | 1612 | Enable the Freescale DIU video driver. Reference boards for |
7d3053fb TT |
1613 | SOCs that have a DIU should define this macro to enable DIU |
1614 | support, and should also define these other macros: | |
1615 | ||
1616 | CONFIG_SYS_DIU_ADDR | |
1617 | CONFIG_VIDEO | |
1618 | CONFIG_CMD_BMP | |
1619 | CONFIG_CFB_CONSOLE | |
1620 | CONFIG_VIDEO_SW_CURSOR | |
1621 | CONFIG_VGA_AS_SINGLE_DEVICE | |
1622 | CONFIG_VIDEO_LOGO | |
1623 | CONFIG_VIDEO_BMP_LOGO | |
1624 | ||
ba8e76bd TT |
1625 | The DIU driver will look for the 'video-mode' environment |
1626 | variable, and if defined, enable the DIU as a console during | |
8eca9439 | 1627 | boot. See the documentation file doc/README.video for a |
ba8e76bd | 1628 | description of this variable. |
7d3053fb | 1629 | |
c609719b WD |
1630 | - LCD Support: CONFIG_LCD |
1631 | ||
1632 | Define this to enable LCD support (for output to LCD | |
1633 | display); also select one of the supported displays | |
1634 | by defining one of these: | |
1635 | ||
39cf4804 SP |
1636 | CONFIG_ATMEL_LCD: |
1637 | ||
1638 | HITACHI TX09D70VM1CCA, 3.5", 240x320. | |
1639 | ||
fd3103bb | 1640 | CONFIG_NEC_NL6448AC33: |
c609719b | 1641 | |
fd3103bb | 1642 | NEC NL6448AC33-18. Active, color, single scan. |
c609719b | 1643 | |
fd3103bb | 1644 | CONFIG_NEC_NL6448BC20 |
c609719b | 1645 | |
fd3103bb WD |
1646 | NEC NL6448BC20-08. 6.5", 640x480. |
1647 | Active, color, single scan. | |
1648 | ||
1649 | CONFIG_NEC_NL6448BC33_54 | |
1650 | ||
1651 | NEC NL6448BC33-54. 10.4", 640x480. | |
c609719b WD |
1652 | Active, color, single scan. |
1653 | ||
1654 | CONFIG_SHARP_16x9 | |
1655 | ||
1656 | Sharp 320x240. Active, color, single scan. | |
1657 | It isn't 16x9, and I am not sure what it is. | |
1658 | ||
1659 | CONFIG_SHARP_LQ64D341 | |
1660 | ||
1661 | Sharp LQ64D341 display, 640x480. | |
1662 | Active, color, single scan. | |
1663 | ||
1664 | CONFIG_HLD1045 | |
1665 | ||
1666 | HLD1045 display, 640x480. | |
1667 | Active, color, single scan. | |
1668 | ||
1669 | CONFIG_OPTREX_BW | |
1670 | ||
1671 | Optrex CBL50840-2 NF-FW 99 22 M5 | |
1672 | or | |
1673 | Hitachi LMG6912RPFC-00T | |
1674 | or | |
1675 | Hitachi SP14Q002 | |
1676 | ||
1677 | 320x240. Black & white. | |
1678 | ||
1679 | Normally display is black on white background; define | |
6d0f6bcf | 1680 | CONFIG_SYS_WHITE_ON_BLACK to get it inverted. |
c609719b | 1681 | |
676d319e SG |
1682 | CONFIG_LCD_ALIGNMENT |
1683 | ||
b445bbb4 | 1684 | Normally the LCD is page-aligned (typically 4KB). If this is |
676d319e SG |
1685 | defined then the LCD will be aligned to this value instead. |
1686 | For ARM it is sometimes useful to use MMU_SECTION_SIZE | |
1687 | here, since it is cheaper to change data cache settings on | |
1688 | a per-section basis. | |
1689 | ||
1690 | ||
604c7d4a HP |
1691 | CONFIG_LCD_ROTATION |
1692 | ||
1693 | Sometimes, for example if the display is mounted in portrait | |
1694 | mode or even if it's mounted landscape but rotated by 180degree, | |
1695 | we need to rotate our content of the display relative to the | |
1696 | framebuffer, so that user can read the messages which are | |
1697 | printed out. | |
1698 | Once CONFIG_LCD_ROTATION is defined, the lcd_console will be | |
1699 | initialized with a given rotation from "vl_rot" out of | |
1700 | "vidinfo_t" which is provided by the board specific code. | |
1701 | The value for vl_rot is coded as following (matching to | |
1702 | fbcon=rotate:<n> linux-kernel commandline): | |
1703 | 0 = no rotation respectively 0 degree | |
1704 | 1 = 90 degree rotation | |
1705 | 2 = 180 degree rotation | |
1706 | 3 = 270 degree rotation | |
1707 | ||
1708 | If CONFIG_LCD_ROTATION is not defined, the console will be | |
1709 | initialized with 0degree rotation. | |
1710 | ||
45d7f525 TWHT |
1711 | CONFIG_LCD_BMP_RLE8 |
1712 | ||
1713 | Support drawing of RLE8-compressed bitmaps on the LCD. | |
1714 | ||
735987c5 TWHT |
1715 | CONFIG_I2C_EDID |
1716 | ||
1717 | Enables an 'i2c edid' command which can read EDID | |
1718 | information over I2C from an attached LCD display. | |
1719 | ||
7152b1d0 | 1720 | - Splash Screen Support: CONFIG_SPLASH_SCREEN |
d791b1dc | 1721 | |
8bde7f77 WD |
1722 | If this option is set, the environment is checked for |
1723 | a variable "splashimage". If found, the usual display | |
1724 | of logo, copyright and system information on the LCD | |
e94d2cd9 | 1725 | is suppressed and the BMP image at the address |
8bde7f77 WD |
1726 | specified in "splashimage" is loaded instead. The |
1727 | console is redirected to the "nulldev", too. This | |
1728 | allows for a "silent" boot where a splash screen is | |
1729 | loaded very quickly after power-on. | |
d791b1dc | 1730 | |
c0880485 NK |
1731 | CONFIG_SPLASHIMAGE_GUARD |
1732 | ||
1733 | If this option is set, then U-Boot will prevent the environment | |
1734 | variable "splashimage" from being set to a problematic address | |
ab5645f1 | 1735 | (see doc/README.displaying-bmps). |
c0880485 NK |
1736 | This option is useful for targets where, due to alignment |
1737 | restrictions, an improperly aligned BMP image will cause a data | |
1738 | abort. If you think you will not have problems with unaligned | |
1739 | accesses (for example because your toolchain prevents them) | |
1740 | there is no need to set this option. | |
1741 | ||
1ca298ce MW |
1742 | CONFIG_SPLASH_SCREEN_ALIGN |
1743 | ||
1744 | If this option is set the splash image can be freely positioned | |
1745 | on the screen. Environment variable "splashpos" specifies the | |
1746 | position as "x,y". If a positive number is given it is used as | |
1747 | number of pixel from left/top. If a negative number is given it | |
1748 | is used as number of pixel from right/bottom. You can also | |
1749 | specify 'm' for centering the image. | |
1750 | ||
1751 | Example: | |
1752 | setenv splashpos m,m | |
1753 | => image at center of screen | |
1754 | ||
1755 | setenv splashpos 30,20 | |
1756 | => image at x = 30 and y = 20 | |
1757 | ||
1758 | setenv splashpos -10,m | |
1759 | => vertically centered image | |
1760 | at x = dspWidth - bmpWidth - 9 | |
1761 | ||
98f4a3df SR |
1762 | - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP |
1763 | ||
1764 | If this option is set, additionally to standard BMP | |
1765 | images, gzipped BMP images can be displayed via the | |
1766 | splashscreen support or the bmp command. | |
1767 | ||
d5011762 AG |
1768 | - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 |
1769 | ||
1770 | If this option is set, 8-bit RLE compressed BMP images | |
1771 | can be displayed via the splashscreen support or the | |
1772 | bmp command. | |
1773 | ||
c29fdfc1 | 1774 | - Compression support: |
8ef70478 KC |
1775 | CONFIG_GZIP |
1776 | ||
1777 | Enabled by default to support gzip compressed images. | |
1778 | ||
c29fdfc1 WD |
1779 | CONFIG_BZIP2 |
1780 | ||
1781 | If this option is set, support for bzip2 compressed | |
1782 | images is included. If not, only uncompressed and gzip | |
1783 | compressed images are supported. | |
1784 | ||
42d1f039 | 1785 | NOTE: the bzip2 algorithm requires a lot of RAM, so |
6d0f6bcf | 1786 | the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should |
42d1f039 | 1787 | be at least 4MB. |
d791b1dc | 1788 | |
fc9c1727 LCM |
1789 | CONFIG_LZMA |
1790 | ||
1791 | If this option is set, support for lzma compressed | |
1792 | images is included. | |
1793 | ||
1794 | Note: The LZMA algorithm adds between 2 and 4KB of code and it | |
1795 | requires an amount of dynamic memory that is given by the | |
1796 | formula: | |
1797 | ||
1798 | (1846 + 768 << (lc + lp)) * sizeof(uint16) | |
1799 | ||
1800 | Where lc and lp stand for, respectively, Literal context bits | |
1801 | and Literal pos bits. | |
1802 | ||
1803 | This value is upper-bounded by 14MB in the worst case. Anyway, | |
1804 | for a ~4MB large kernel image, we have lc=3 and lp=0 for a | |
1805 | total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is | |
1806 | a very small buffer. | |
1807 | ||
1808 | Use the lzmainfo tool to determinate the lc and lp values and | |
1809 | then calculate the amount of needed dynamic memory (ensuring | |
6d0f6bcf | 1810 | the appropriate CONFIG_SYS_MALLOC_LEN value). |
fc9c1727 | 1811 | |
8ef70478 KC |
1812 | CONFIG_LZO |
1813 | ||
1814 | If this option is set, support for LZO compressed images | |
1815 | is included. | |
1816 | ||
17ea1177 WD |
1817 | - MII/PHY support: |
1818 | CONFIG_PHY_ADDR | |
1819 | ||
1820 | The address of PHY on MII bus. | |
1821 | ||
1822 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) | |
1823 | ||
1824 | The clock frequency of the MII bus | |
1825 | ||
1826 | CONFIG_PHY_GIGE | |
1827 | ||
1828 | If this option is set, support for speed/duplex | |
11ccc33f | 1829 | detection of gigabit PHY is included. |
17ea1177 WD |
1830 | |
1831 | CONFIG_PHY_RESET_DELAY | |
1832 | ||
1833 | Some PHY like Intel LXT971A need extra delay after | |
1834 | reset before any MII register access is possible. | |
1835 | For such PHY, set this option to the usec delay | |
1836 | required. (minimum 300usec for LXT971A) | |
1837 | ||
1838 | CONFIG_PHY_CMD_DELAY (ppc4xx) | |
1839 | ||
1840 | Some PHY like Intel LXT971A need extra delay after | |
1841 | command issued before MII status register can be read | |
1842 | ||
c609719b WD |
1843 | - IP address: |
1844 | CONFIG_IPADDR | |
1845 | ||
1846 | Define a default value for the IP address to use for | |
11ccc33f | 1847 | the default Ethernet interface, in case this is not |
c609719b | 1848 | determined through e.g. bootp. |
1ebcd654 | 1849 | (Environment variable "ipaddr") |
c609719b WD |
1850 | |
1851 | - Server IP address: | |
1852 | CONFIG_SERVERIP | |
1853 | ||
11ccc33f | 1854 | Defines a default value for the IP address of a TFTP |
c609719b | 1855 | server to contact when using the "tftboot" command. |
1ebcd654 | 1856 | (Environment variable "serverip") |
c609719b | 1857 | |
97cfe861 RG |
1858 | CONFIG_KEEP_SERVERADDR |
1859 | ||
1860 | Keeps the server's MAC address, in the env 'serveraddr' | |
1861 | for passing to bootargs (like Linux's netconsole option) | |
1862 | ||
1ebcd654 WD |
1863 | - Gateway IP address: |
1864 | CONFIG_GATEWAYIP | |
1865 | ||
1866 | Defines a default value for the IP address of the | |
1867 | default router where packets to other networks are | |
1868 | sent to. | |
1869 | (Environment variable "gatewayip") | |
1870 | ||
1871 | - Subnet mask: | |
1872 | CONFIG_NETMASK | |
1873 | ||
1874 | Defines a default value for the subnet mask (or | |
1875 | routing prefix) which is used to determine if an IP | |
1876 | address belongs to the local subnet or needs to be | |
1877 | forwarded through a router. | |
1878 | (Environment variable "netmask") | |
1879 | ||
53a5c424 DU |
1880 | - Multicast TFTP Mode: |
1881 | CONFIG_MCAST_TFTP | |
1882 | ||
1883 | Defines whether you want to support multicast TFTP as per | |
1884 | rfc-2090; for example to work with atftp. Lets lots of targets | |
11ccc33f | 1885 | tftp down the same boot image concurrently. Note: the Ethernet |
53a5c424 DU |
1886 | driver in use must provide a function: mcast() to join/leave a |
1887 | multicast group. | |
1888 | ||
c609719b WD |
1889 | - BOOTP Recovery Mode: |
1890 | CONFIG_BOOTP_RANDOM_DELAY | |
1891 | ||
1892 | If you have many targets in a network that try to | |
1893 | boot using BOOTP, you may want to avoid that all | |
1894 | systems send out BOOTP requests at precisely the same | |
1895 | moment (which would happen for instance at recovery | |
1896 | from a power failure, when all systems will try to | |
1897 | boot, thus flooding the BOOTP server. Defining | |
1898 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be | |
1899 | inserted before sending out BOOTP requests. The | |
6c33c785 | 1900 | following delays are inserted then: |
c609719b WD |
1901 | |
1902 | 1st BOOTP request: delay 0 ... 1 sec | |
1903 | 2nd BOOTP request: delay 0 ... 2 sec | |
1904 | 3rd BOOTP request: delay 0 ... 4 sec | |
1905 | 4th and following | |
1906 | BOOTP requests: delay 0 ... 8 sec | |
1907 | ||
92ac8acc TR |
1908 | CONFIG_BOOTP_ID_CACHE_SIZE |
1909 | ||
1910 | BOOTP packets are uniquely identified using a 32-bit ID. The | |
1911 | server will copy the ID from client requests to responses and | |
1912 | U-Boot will use this to determine if it is the destination of | |
1913 | an incoming response. Some servers will check that addresses | |
1914 | aren't in use before handing them out (usually using an ARP | |
1915 | ping) and therefore take up to a few hundred milliseconds to | |
1916 | respond. Network congestion may also influence the time it | |
1917 | takes for a response to make it back to the client. If that | |
1918 | time is too long, U-Boot will retransmit requests. In order | |
1919 | to allow earlier responses to still be accepted after these | |
1920 | retransmissions, U-Boot's BOOTP client keeps a small cache of | |
1921 | IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this | |
1922 | cache. The default is to keep IDs for up to four outstanding | |
1923 | requests. Increasing this will allow U-Boot to accept offers | |
1924 | from a BOOTP client in networks with unusually high latency. | |
1925 | ||
fe389a82 | 1926 | - DHCP Advanced Options: |
1fe80d79 JL |
1927 | You can fine tune the DHCP functionality by defining |
1928 | CONFIG_BOOTP_* symbols: | |
1929 | ||
1930 | CONFIG_BOOTP_SUBNETMASK | |
1931 | CONFIG_BOOTP_GATEWAY | |
1932 | CONFIG_BOOTP_HOSTNAME | |
1933 | CONFIG_BOOTP_NISDOMAIN | |
1934 | CONFIG_BOOTP_BOOTPATH | |
1935 | CONFIG_BOOTP_BOOTFILESIZE | |
1936 | CONFIG_BOOTP_DNS | |
1937 | CONFIG_BOOTP_DNS2 | |
1938 | CONFIG_BOOTP_SEND_HOSTNAME | |
1939 | CONFIG_BOOTP_NTPSERVER | |
1940 | CONFIG_BOOTP_TIMEOFFSET | |
1941 | CONFIG_BOOTP_VENDOREX | |
2c00e099 | 1942 | CONFIG_BOOTP_MAY_FAIL |
fe389a82 | 1943 | |
5d110f0a WC |
1944 | CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip |
1945 | environment variable, not the BOOTP server. | |
fe389a82 | 1946 | |
2c00e099 JH |
1947 | CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found |
1948 | after the configured retry count, the call will fail | |
1949 | instead of starting over. This can be used to fail over | |
1950 | to Link-local IP address configuration if the DHCP server | |
1951 | is not available. | |
1952 | ||
fe389a82 SR |
1953 | CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS |
1954 | serverip from a DHCP server, it is possible that more | |
1955 | than one DNS serverip is offered to the client. | |
1956 | If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS | |
1957 | serverip will be stored in the additional environment | |
1958 | variable "dnsip2". The first DNS serverip is always | |
1959 | stored in the variable "dnsip", when CONFIG_BOOTP_DNS | |
1fe80d79 | 1960 | is defined. |
fe389a82 SR |
1961 | |
1962 | CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable | |
1963 | to do a dynamic update of a DNS server. To do this, they | |
1964 | need the hostname of the DHCP requester. | |
5d110f0a | 1965 | If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content |
1fe80d79 JL |
1966 | of the "hostname" environment variable is passed as |
1967 | option 12 to the DHCP server. | |
fe389a82 | 1968 | |
d9a2f416 AV |
1969 | CONFIG_BOOTP_DHCP_REQUEST_DELAY |
1970 | ||
1971 | A 32bit value in microseconds for a delay between | |
1972 | receiving a "DHCP Offer" and sending the "DHCP Request". | |
1973 | This fixes a problem with certain DHCP servers that don't | |
1974 | respond 100% of the time to a "DHCP request". E.g. On an | |
1975 | AT91RM9200 processor running at 180MHz, this delay needed | |
1976 | to be *at least* 15,000 usec before a Windows Server 2003 | |
1977 | DHCP server would reply 100% of the time. I recommend at | |
1978 | least 50,000 usec to be safe. The alternative is to hope | |
1979 | that one of the retries will be successful but note that | |
1980 | the DHCP timeout and retry process takes a longer than | |
1981 | this delay. | |
1982 | ||
d22c338e JH |
1983 | - Link-local IP address negotiation: |
1984 | Negotiate with other link-local clients on the local network | |
1985 | for an address that doesn't require explicit configuration. | |
1986 | This is especially useful if a DHCP server cannot be guaranteed | |
1987 | to exist in all environments that the device must operate. | |
1988 | ||
1989 | See doc/README.link-local for more information. | |
1990 | ||
a3d991bd | 1991 | - CDP Options: |
6e592385 | 1992 | CONFIG_CDP_DEVICE_ID |
a3d991bd WD |
1993 | |
1994 | The device id used in CDP trigger frames. | |
1995 | ||
1996 | CONFIG_CDP_DEVICE_ID_PREFIX | |
1997 | ||
1998 | A two character string which is prefixed to the MAC address | |
1999 | of the device. | |
2000 | ||
2001 | CONFIG_CDP_PORT_ID | |
2002 | ||
2003 | A printf format string which contains the ascii name of | |
2004 | the port. Normally is set to "eth%d" which sets | |
11ccc33f | 2005 | eth0 for the first Ethernet, eth1 for the second etc. |
a3d991bd WD |
2006 | |
2007 | CONFIG_CDP_CAPABILITIES | |
2008 | ||
2009 | A 32bit integer which indicates the device capabilities; | |
2010 | 0x00000010 for a normal host which does not forwards. | |
2011 | ||
2012 | CONFIG_CDP_VERSION | |
2013 | ||
2014 | An ascii string containing the version of the software. | |
2015 | ||
2016 | CONFIG_CDP_PLATFORM | |
2017 | ||
2018 | An ascii string containing the name of the platform. | |
2019 | ||
2020 | CONFIG_CDP_TRIGGER | |
2021 | ||
2022 | A 32bit integer sent on the trigger. | |
2023 | ||
2024 | CONFIG_CDP_POWER_CONSUMPTION | |
2025 | ||
2026 | A 16bit integer containing the power consumption of the | |
2027 | device in .1 of milliwatts. | |
2028 | ||
2029 | CONFIG_CDP_APPLIANCE_VLAN_TYPE | |
2030 | ||
2031 | A byte containing the id of the VLAN. | |
2032 | ||
79267edd | 2033 | - Status LED: CONFIG_LED_STATUS |
c609719b WD |
2034 | |
2035 | Several configurations allow to display the current | |
2036 | status using a LED. For instance, the LED will blink | |
2037 | fast while running U-Boot code, stop blinking as | |
2038 | soon as a reply to a BOOTP request was received, and | |
2039 | start blinking slow once the Linux kernel is running | |
2040 | (supported by a status LED driver in the Linux | |
79267edd | 2041 | kernel). Defining CONFIG_LED_STATUS enables this |
c609719b WD |
2042 | feature in U-Boot. |
2043 | ||
1df7bbba IG |
2044 | Additional options: |
2045 | ||
79267edd | 2046 | CONFIG_LED_STATUS_GPIO |
1df7bbba IG |
2047 | The status LED can be connected to a GPIO pin. |
2048 | In such cases, the gpio_led driver can be used as a | |
79267edd | 2049 | status LED backend implementation. Define CONFIG_LED_STATUS_GPIO |
1df7bbba IG |
2050 | to include the gpio_led driver in the U-Boot binary. |
2051 | ||
9dfdcdfe IG |
2052 | CONFIG_GPIO_LED_INVERTED_TABLE |
2053 | Some GPIO connected LEDs may have inverted polarity in which | |
2054 | case the GPIO high value corresponds to LED off state and | |
2055 | GPIO low value corresponds to LED on state. | |
2056 | In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined | |
2057 | with a list of GPIO LEDs that have inverted polarity. | |
2058 | ||
c609719b WD |
2059 | - CAN Support: CONFIG_CAN_DRIVER |
2060 | ||
2061 | Defining CONFIG_CAN_DRIVER enables CAN driver support | |
2062 | on those systems that support this (optional) | |
2063 | feature, like the TQM8xxL modules. | |
2064 | ||
3f4978c7 HS |
2065 | - I2C Support: CONFIG_SYS_I2C |
2066 | ||
2067 | This enable the NEW i2c subsystem, and will allow you to use | |
2068 | i2c commands at the u-boot command line (as long as you set | |
2069 | CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c | |
2070 | based realtime clock chips or other i2c devices. See | |
2071 | common/cmd_i2c.c for a description of the command line | |
2072 | interface. | |
2073 | ||
2074 | ported i2c driver to the new framework: | |
ea818dbb HS |
2075 | - drivers/i2c/soft_i2c.c: |
2076 | - activate first bus with CONFIG_SYS_I2C_SOFT define | |
2077 | CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE | |
2078 | for defining speed and slave address | |
2079 | - activate second bus with I2C_SOFT_DECLARATIONS2 define | |
2080 | CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 | |
2081 | for defining speed and slave address | |
2082 | - activate third bus with I2C_SOFT_DECLARATIONS3 define | |
2083 | CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 | |
2084 | for defining speed and slave address | |
2085 | - activate fourth bus with I2C_SOFT_DECLARATIONS4 define | |
2086 | CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 | |
2087 | for defining speed and slave address | |
3f4978c7 | 2088 | |
00f792e0 HS |
2089 | - drivers/i2c/fsl_i2c.c: |
2090 | - activate i2c driver with CONFIG_SYS_I2C_FSL | |
2091 | define CONFIG_SYS_FSL_I2C_OFFSET for setting the register | |
2092 | offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and | |
2093 | CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first | |
2094 | bus. | |
93e14596 | 2095 | - If your board supports a second fsl i2c bus, define |
00f792e0 HS |
2096 | CONFIG_SYS_FSL_I2C2_OFFSET for the register offset |
2097 | CONFIG_SYS_FSL_I2C2_SPEED for the speed and | |
2098 | CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the | |
2099 | second bus. | |
2100 | ||
1f2ba722 | 2101 | - drivers/i2c/tegra_i2c.c: |
10cee516 NI |
2102 | - activate this driver with CONFIG_SYS_I2C_TEGRA |
2103 | - This driver adds 4 i2c buses with a fix speed from | |
2104 | 100000 and the slave addr 0! | |
1f2ba722 | 2105 | |
880540de DE |
2106 | - drivers/i2c/ppc4xx_i2c.c |
2107 | - activate this driver with CONFIG_SYS_I2C_PPC4XX | |
2108 | - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 | |
2109 | - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 | |
2110 | ||
fac96408 | 2111 | - drivers/i2c/i2c_mxc.c |
2112 | - activate this driver with CONFIG_SYS_I2C_MXC | |
03544c66 AA |
2113 | - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 |
2114 | - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 | |
2115 | - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 | |
2116 | - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 | |
fac96408 | 2117 | - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED |
2118 | - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE | |
2119 | - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED | |
2120 | - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE | |
2121 | - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED | |
2122 | - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE | |
03544c66 AA |
2123 | - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED |
2124 | - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE | |
b445bbb4 | 2125 | If those defines are not set, default value is 100000 |
fac96408 | 2126 | for speed, and 0 for slave. |
2127 | ||
1086bfa9 NI |
2128 | - drivers/i2c/rcar_i2c.c: |
2129 | - activate this driver with CONFIG_SYS_I2C_RCAR | |
2130 | - This driver adds 4 i2c buses | |
2131 | ||
2132 | - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 | |
2133 | - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 | |
2134 | - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 | |
2135 | - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 | |
2136 | - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 | |
2137 | - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 | |
2138 | - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 | |
2139 | - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 | |
2140 | - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses | |
2141 | ||
2035d77d NI |
2142 | - drivers/i2c/sh_i2c.c: |
2143 | - activate this driver with CONFIG_SYS_I2C_SH | |
2144 | - This driver adds from 2 to 5 i2c buses | |
2145 | ||
2146 | - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 | |
2147 | - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 | |
2148 | - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 | |
2149 | - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 | |
2150 | - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 | |
2151 | - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 | |
2152 | - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 | |
2153 | - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 | |
2154 | - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 | |
2155 | - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 | |
b445bbb4 | 2156 | - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses |
2035d77d | 2157 | |
6789e84e HS |
2158 | - drivers/i2c/omap24xx_i2c.c |
2159 | - activate this driver with CONFIG_SYS_I2C_OMAP24XX | |
2160 | - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 | |
2161 | - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 | |
2162 | - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 | |
2163 | - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 | |
2164 | - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 | |
2165 | - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 | |
2166 | - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 | |
2167 | - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 | |
2168 | - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 | |
2169 | - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 | |
2170 | ||
0bdffe71 HS |
2171 | - drivers/i2c/zynq_i2c.c |
2172 | - activate this driver with CONFIG_SYS_I2C_ZYNQ | |
2173 | - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting | |
2174 | - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr | |
2175 | ||
e717fc6d NKC |
2176 | - drivers/i2c/s3c24x0_i2c.c: |
2177 | - activate this driver with CONFIG_SYS_I2C_S3C24X0 | |
2178 | - This driver adds i2c buses (11 for Exynos5250, Exynos5420 | |
2179 | 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) | |
2180 | with a fix speed from 100000 and the slave addr 0! | |
2181 | ||
b46226bd DE |
2182 | - drivers/i2c/ihs_i2c.c |
2183 | - activate this driver with CONFIG_SYS_I2C_IHS | |
2184 | - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 | |
2185 | - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 | |
2186 | - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 | |
2187 | - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 | |
2188 | - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 | |
2189 | - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 | |
2190 | - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 | |
2191 | - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 | |
2192 | - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 | |
2193 | - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 | |
2194 | - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 | |
2195 | - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 | |
071be896 DE |
2196 | - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL |
2197 | - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 | |
2198 | - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 | |
2199 | - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 | |
2200 | - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 | |
2201 | - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 | |
2202 | - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 | |
2203 | - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 | |
2204 | - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 | |
b46226bd | 2205 | |
3f4978c7 HS |
2206 | additional defines: |
2207 | ||
2208 | CONFIG_SYS_NUM_I2C_BUSES | |
945a18e6 | 2209 | Hold the number of i2c buses you want to use. |
3f4978c7 HS |
2210 | |
2211 | CONFIG_SYS_I2C_DIRECT_BUS | |
2212 | define this, if you don't use i2c muxes on your hardware. | |
2213 | if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can | |
2214 | omit this define. | |
2215 | ||
2216 | CONFIG_SYS_I2C_MAX_HOPS | |
2217 | define how many muxes are maximal consecutively connected | |
2218 | on one i2c bus. If you not use i2c muxes, omit this | |
2219 | define. | |
2220 | ||
2221 | CONFIG_SYS_I2C_BUSES | |
b445bbb4 | 2222 | hold a list of buses you want to use, only used if |
3f4978c7 HS |
2223 | CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example |
2224 | a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and | |
2225 | CONFIG_SYS_NUM_I2C_BUSES = 9: | |
2226 | ||
2227 | CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ | |
2228 | {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ | |
2229 | {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ | |
2230 | {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ | |
2231 | {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ | |
2232 | {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ | |
2233 | {1, {I2C_NULL_HOP}}, \ | |
2234 | {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ | |
2235 | {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ | |
2236 | } | |
2237 | ||
2238 | which defines | |
2239 | bus 0 on adapter 0 without a mux | |
ea818dbb HS |
2240 | bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 |
2241 | bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 | |
2242 | bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 | |
2243 | bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 | |
2244 | bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 | |
3f4978c7 | 2245 | bus 6 on adapter 1 without a mux |
ea818dbb HS |
2246 | bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 |
2247 | bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 | |
3f4978c7 HS |
2248 | |
2249 | If you do not have i2c muxes on your board, omit this define. | |
2250 | ||
ea818dbb | 2251 | - Legacy I2C Support: CONFIG_HARD_I2C |
3f4978c7 HS |
2252 | |
2253 | NOTE: It is intended to move drivers to CONFIG_SYS_I2C which | |
2254 | provides the following compelling advantages: | |
2255 | ||
2256 | - more than one i2c adapter is usable | |
2257 | - approved multibus support | |
2258 | - better i2c mux support | |
2259 | ||
2260 | ** Please consider updating your I2C driver now. ** | |
2261 | ||
ea818dbb HS |
2262 | These enable legacy I2C serial bus commands. Defining |
2263 | CONFIG_HARD_I2C will include the appropriate I2C driver | |
2264 | for the selected CPU. | |
c609719b | 2265 | |
945af8d7 | 2266 | This will allow you to use i2c commands at the u-boot |
602ad3b3 | 2267 | command line (as long as you set CONFIG_CMD_I2C in |
b37c7e5e WD |
2268 | CONFIG_COMMANDS) and communicate with i2c based realtime |
2269 | clock chips. See common/cmd_i2c.c for a description of the | |
43d9616c | 2270 | command line interface. |
c609719b | 2271 | |
bb99ad6d | 2272 | CONFIG_HARD_I2C selects a hardware I2C controller. |
b37c7e5e | 2273 | |
945af8d7 | 2274 | There are several other quantities that must also be |
ea818dbb | 2275 | defined when you define CONFIG_HARD_I2C. |
c609719b | 2276 | |
6d0f6bcf | 2277 | In both cases you will need to define CONFIG_SYS_I2C_SPEED |
945af8d7 | 2278 | to be the frequency (in Hz) at which you wish your i2c bus |
6d0f6bcf | 2279 | to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie |
11ccc33f | 2280 | the CPU's i2c node address). |
945af8d7 | 2281 | |
8d321b81 | 2282 | Now, the u-boot i2c code for the mpc8xx |
a47a12be | 2283 | (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node |
8d321b81 PT |
2284 | and so its address should therefore be cleared to 0 (See, |
2285 | eg, MPC823e User's Manual p.16-473). So, set | |
2286 | CONFIG_SYS_I2C_SLAVE to 0. | |
c609719b | 2287 | |
5da71efa EM |
2288 | CONFIG_SYS_I2C_INIT_MPC5XXX |
2289 | ||
2290 | When a board is reset during an i2c bus transfer | |
2291 | chips might think that the current transfer is still | |
2292 | in progress. Reset the slave devices by sending start | |
2293 | commands until the slave device responds. | |
2294 | ||
945af8d7 | 2295 | That's all that's required for CONFIG_HARD_I2C. |
c609719b | 2296 | |
ea818dbb | 2297 | If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) |
b37c7e5e WD |
2298 | then the following macros need to be defined (examples are |
2299 | from include/configs/lwmon.h): | |
c609719b WD |
2300 | |
2301 | I2C_INIT | |
2302 | ||
b37c7e5e | 2303 | (Optional). Any commands necessary to enable the I2C |
43d9616c | 2304 | controller or configure ports. |
c609719b | 2305 | |
ba56f625 | 2306 | eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) |
b37c7e5e | 2307 | |
c609719b WD |
2308 | I2C_PORT |
2309 | ||
43d9616c WD |
2310 | (Only for MPC8260 CPU). The I/O port to use (the code |
2311 | assumes both bits are on the same port). Valid values | |
2312 | are 0..3 for ports A..D. | |
c609719b WD |
2313 | |
2314 | I2C_ACTIVE | |
2315 | ||
2316 | The code necessary to make the I2C data line active | |
2317 | (driven). If the data line is open collector, this | |
2318 | define can be null. | |
2319 | ||
b37c7e5e WD |
2320 | eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) |
2321 | ||
c609719b WD |
2322 | I2C_TRISTATE |
2323 | ||
2324 | The code necessary to make the I2C data line tri-stated | |
2325 | (inactive). If the data line is open collector, this | |
2326 | define can be null. | |
2327 | ||
b37c7e5e WD |
2328 | eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) |
2329 | ||
c609719b WD |
2330 | I2C_READ |
2331 | ||
472d5460 YS |
2332 | Code that returns true if the I2C data line is high, |
2333 | false if it is low. | |
c609719b | 2334 | |
b37c7e5e WD |
2335 | eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) |
2336 | ||
c609719b WD |
2337 | I2C_SDA(bit) |
2338 | ||
472d5460 YS |
2339 | If <bit> is true, sets the I2C data line high. If it |
2340 | is false, it clears it (low). | |
c609719b | 2341 | |
b37c7e5e | 2342 | eg: #define I2C_SDA(bit) \ |
2535d602 | 2343 | if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ |
ba56f625 | 2344 | else immr->im_cpm.cp_pbdat &= ~PB_SDA |
b37c7e5e | 2345 | |
c609719b WD |
2346 | I2C_SCL(bit) |
2347 | ||
472d5460 YS |
2348 | If <bit> is true, sets the I2C clock line high. If it |
2349 | is false, it clears it (low). | |
c609719b | 2350 | |
b37c7e5e | 2351 | eg: #define I2C_SCL(bit) \ |
2535d602 | 2352 | if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ |
ba56f625 | 2353 | else immr->im_cpm.cp_pbdat &= ~PB_SCL |
b37c7e5e | 2354 | |
c609719b WD |
2355 | I2C_DELAY |
2356 | ||
2357 | This delay is invoked four times per clock cycle so this | |
2358 | controls the rate of data transfer. The data rate thus | |
b37c7e5e | 2359 | is 1 / (I2C_DELAY * 4). Often defined to be something |
945af8d7 WD |
2360 | like: |
2361 | ||
b37c7e5e | 2362 | #define I2C_DELAY udelay(2) |
c609719b | 2363 | |
793b5726 MF |
2364 | CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA |
2365 | ||
2366 | If your arch supports the generic GPIO framework (asm/gpio.h), | |
2367 | then you may alternatively define the two GPIOs that are to be | |
2368 | used as SCL / SDA. Any of the previous I2C_xxx macros will | |
2369 | have GPIO-based defaults assigned to them as appropriate. | |
2370 | ||
2371 | You should define these to the GPIO value as given directly to | |
2372 | the generic GPIO functions. | |
2373 | ||
6d0f6bcf | 2374 | CONFIG_SYS_I2C_INIT_BOARD |
47cd00fa | 2375 | |
8bde7f77 WD |
2376 | When a board is reset during an i2c bus transfer |
2377 | chips might think that the current transfer is still | |
2378 | in progress. On some boards it is possible to access | |
2379 | the i2c SCLK line directly, either by using the | |
2380 | processor pin as a GPIO or by having a second pin | |
2381 | connected to the bus. If this option is defined a | |
2382 | custom i2c_init_board() routine in boards/xxx/board.c | |
2383 | is run early in the boot sequence. | |
47cd00fa | 2384 | |
26a33504 RR |
2385 | CONFIG_SYS_I2C_BOARD_LATE_INIT |
2386 | ||
2387 | An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is | |
2388 | defined a custom i2c_board_late_init() routine in | |
2389 | boards/xxx/board.c is run AFTER the operations in i2c_init() | |
2390 | is completed. This callpoint can be used to unreset i2c bus | |
2391 | using CPU i2c controller register accesses for CPUs whose i2c | |
2392 | controller provide such a method. It is called at the end of | |
2393 | i2c_init() to allow i2c_init operations to setup the i2c bus | |
2394 | controller on the CPU (e.g. setting bus speed & slave address). | |
2395 | ||
17ea1177 WD |
2396 | CONFIG_I2CFAST (PPC405GP|PPC405EP only) |
2397 | ||
2398 | This option enables configuration of bi_iic_fast[] flags | |
2399 | in u-boot bd_info structure based on u-boot environment | |
2400 | variable "i2cfast". (see also i2cfast) | |
2401 | ||
bb99ad6d BW |
2402 | CONFIG_I2C_MULTI_BUS |
2403 | ||
2404 | This option allows the use of multiple I2C buses, each of which | |
c0f40859 WD |
2405 | must have a controller. At any point in time, only one bus is |
2406 | active. To switch to a different bus, use the 'i2c dev' command. | |
bb99ad6d BW |
2407 | Note that bus numbering is zero-based. |
2408 | ||
6d0f6bcf | 2409 | CONFIG_SYS_I2C_NOPROBES |
bb99ad6d BW |
2410 | |
2411 | This option specifies a list of I2C devices that will be skipped | |
c0f40859 | 2412 | when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS |
0f89c54b PT |
2413 | is set, specify a list of bus-device pairs. Otherwise, specify |
2414 | a 1D array of device addresses | |
bb99ad6d BW |
2415 | |
2416 | e.g. | |
2417 | #undef CONFIG_I2C_MULTI_BUS | |
c0f40859 | 2418 | #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} |
bb99ad6d BW |
2419 | |
2420 | will skip addresses 0x50 and 0x68 on a board with one I2C bus | |
2421 | ||
c0f40859 | 2422 | #define CONFIG_I2C_MULTI_BUS |
945a18e6 | 2423 | #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} |
bb99ad6d BW |
2424 | |
2425 | will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 | |
2426 | ||
6d0f6bcf | 2427 | CONFIG_SYS_SPD_BUS_NUM |
be5e6181 TT |
2428 | |
2429 | If defined, then this indicates the I2C bus number for DDR SPD. | |
2430 | If not defined, then U-Boot assumes that SPD is on I2C bus 0. | |
2431 | ||
6d0f6bcf | 2432 | CONFIG_SYS_RTC_BUS_NUM |
0dc018ec SR |
2433 | |
2434 | If defined, then this indicates the I2C bus number for the RTC. | |
2435 | If not defined, then U-Boot assumes that RTC is on I2C bus 0. | |
2436 | ||
6d0f6bcf | 2437 | CONFIG_SYS_DTT_BUS_NUM |
0dc018ec SR |
2438 | |
2439 | If defined, then this indicates the I2C bus number for the DTT. | |
2440 | If not defined, then U-Boot assumes that DTT is on I2C bus 0. | |
2441 | ||
6d0f6bcf | 2442 | CONFIG_SYS_I2C_DTT_ADDR: |
9ebbb54f VG |
2443 | |
2444 | If defined, specifies the I2C address of the DTT device. | |
2445 | If not defined, then U-Boot uses predefined value for | |
2446 | specified DTT device. | |
2447 | ||
2ac6985a AD |
2448 | CONFIG_SOFT_I2C_READ_REPEATED_START |
2449 | ||
2450 | defining this will force the i2c_read() function in | |
2451 | the soft_i2c driver to perform an I2C repeated start | |
2452 | between writing the address pointer and reading the | |
2453 | data. If this define is omitted the default behaviour | |
2454 | of doing a stop-start sequence will be used. Most I2C | |
2455 | devices can use either method, but some require one or | |
2456 | the other. | |
be5e6181 | 2457 | |
c609719b WD |
2458 | - SPI Support: CONFIG_SPI |
2459 | ||
2460 | Enables SPI driver (so far only tested with | |
2461 | SPI EEPROM, also an instance works with Crystal A/D and | |
2462 | D/As on the SACSng board) | |
2463 | ||
6639562e YS |
2464 | CONFIG_SH_SPI |
2465 | ||
2466 | Enables the driver for SPI controller on SuperH. Currently | |
2467 | only SH7757 is supported. | |
2468 | ||
c609719b WD |
2469 | CONFIG_SOFT_SPI |
2470 | ||
43d9616c WD |
2471 | Enables a software (bit-bang) SPI driver rather than |
2472 | using hardware support. This is a general purpose | |
2473 | driver that only requires three general I/O port pins | |
2474 | (two outputs, one input) to function. If this is | |
2475 | defined, the board configuration must define several | |
2476 | SPI configuration items (port pins to use, etc). For | |
2477 | an example, see include/configs/sacsng.h. | |
c609719b | 2478 | |
04a9e118 BW |
2479 | CONFIG_HARD_SPI |
2480 | ||
2481 | Enables a hardware SPI driver for general-purpose reads | |
2482 | and writes. As with CONFIG_SOFT_SPI, the board configuration | |
2483 | must define a list of chip-select function pointers. | |
c0f40859 | 2484 | Currently supported on some MPC8xxx processors. For an |
04a9e118 BW |
2485 | example, see include/configs/mpc8349emds.h. |
2486 | ||
38254f45 GL |
2487 | CONFIG_MXC_SPI |
2488 | ||
2489 | Enables the driver for the SPI controllers on i.MX and MXC | |
2e3cd1cd | 2490 | SoCs. Currently i.MX31/35/51 are supported. |
38254f45 | 2491 | |
f659b573 HS |
2492 | CONFIG_SYS_SPI_MXC_WAIT |
2493 | Timeout for waiting until spi transfer completed. | |
2494 | default: (CONFIG_SYS_HZ/100) /* 10 ms */ | |
2495 | ||
0133502e | 2496 | - FPGA Support: CONFIG_FPGA |
c609719b | 2497 | |
0133502e MF |
2498 | Enables FPGA subsystem. |
2499 | ||
2500 | CONFIG_FPGA_<vendor> | |
2501 | ||
2502 | Enables support for specific chip vendors. | |
2503 | (ALTERA, XILINX) | |
c609719b | 2504 | |
0133502e | 2505 | CONFIG_FPGA_<family> |
c609719b | 2506 | |
0133502e MF |
2507 | Enables support for FPGA family. |
2508 | (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) | |
2509 | ||
2510 | CONFIG_FPGA_COUNT | |
2511 | ||
2512 | Specify the number of FPGA devices to support. | |
c609719b | 2513 | |
64e809af SDPP |
2514 | CONFIG_CMD_FPGA_LOADMK |
2515 | ||
2516 | Enable support for fpga loadmk command | |
2517 | ||
67193864 MS |
2518 | CONFIG_CMD_FPGA_LOADP |
2519 | ||
2520 | Enable support for fpga loadp command - load partial bitstream | |
2521 | ||
2522 | CONFIG_CMD_FPGA_LOADBP | |
2523 | ||
2524 | Enable support for fpga loadbp command - load partial bitstream | |
2525 | (Xilinx only) | |
2526 | ||
6d0f6bcf | 2527 | CONFIG_SYS_FPGA_PROG_FEEDBACK |
c609719b | 2528 | |
8bde7f77 | 2529 | Enable printing of hash marks during FPGA configuration. |
c609719b | 2530 | |
6d0f6bcf | 2531 | CONFIG_SYS_FPGA_CHECK_BUSY |
c609719b | 2532 | |
43d9616c WD |
2533 | Enable checks on FPGA configuration interface busy |
2534 | status by the configuration function. This option | |
2535 | will require a board or device specific function to | |
2536 | be written. | |
c609719b WD |
2537 | |
2538 | CONFIG_FPGA_DELAY | |
2539 | ||
2540 | If defined, a function that provides delays in the FPGA | |
2541 | configuration driver. | |
2542 | ||
6d0f6bcf | 2543 | CONFIG_SYS_FPGA_CHECK_CTRLC |
c609719b WD |
2544 | Allow Control-C to interrupt FPGA configuration |
2545 | ||
6d0f6bcf | 2546 | CONFIG_SYS_FPGA_CHECK_ERROR |
c609719b | 2547 | |
43d9616c WD |
2548 | Check for configuration errors during FPGA bitfile |
2549 | loading. For example, abort during Virtex II | |
2550 | configuration if the INIT_B line goes low (which | |
2551 | indicated a CRC error). | |
c609719b | 2552 | |
6d0f6bcf | 2553 | CONFIG_SYS_FPGA_WAIT_INIT |
c609719b | 2554 | |
b445bbb4 JM |
2555 | Maximum time to wait for the INIT_B line to de-assert |
2556 | after PROB_B has been de-asserted during a Virtex II | |
43d9616c | 2557 | FPGA configuration sequence. The default time is 500 |
11ccc33f | 2558 | ms. |
c609719b | 2559 | |
6d0f6bcf | 2560 | CONFIG_SYS_FPGA_WAIT_BUSY |
c609719b | 2561 | |
b445bbb4 | 2562 | Maximum time to wait for BUSY to de-assert during |
11ccc33f | 2563 | Virtex II FPGA configuration. The default is 5 ms. |
c609719b | 2564 | |
6d0f6bcf | 2565 | CONFIG_SYS_FPGA_WAIT_CONFIG |
c609719b | 2566 | |
43d9616c | 2567 | Time to wait after FPGA configuration. The default is |
11ccc33f | 2568 | 200 ms. |
c609719b WD |
2569 | |
2570 | - Configuration Management: | |
b2b8a696 SR |
2571 | CONFIG_BUILD_TARGET |
2572 | ||
2573 | Some SoCs need special image types (e.g. U-Boot binary | |
2574 | with a special header) as build targets. By defining | |
2575 | CONFIG_BUILD_TARGET in the SoC / board header, this | |
2576 | special image will be automatically built upon calling | |
6de80f21 | 2577 | make / buildman. |
b2b8a696 | 2578 | |
c609719b WD |
2579 | CONFIG_IDENT_STRING |
2580 | ||
43d9616c WD |
2581 | If defined, this string will be added to the U-Boot |
2582 | version information (U_BOOT_VERSION) | |
c609719b WD |
2583 | |
2584 | - Vendor Parameter Protection: | |
2585 | ||
43d9616c WD |
2586 | U-Boot considers the values of the environment |
2587 | variables "serial#" (Board Serial Number) and | |
7152b1d0 | 2588 | "ethaddr" (Ethernet Address) to be parameters that |
43d9616c WD |
2589 | are set once by the board vendor / manufacturer, and |
2590 | protects these variables from casual modification by | |
2591 | the user. Once set, these variables are read-only, | |
2592 | and write or delete attempts are rejected. You can | |
11ccc33f | 2593 | change this behaviour: |
c609719b WD |
2594 | |
2595 | If CONFIG_ENV_OVERWRITE is #defined in your config | |
2596 | file, the write protection for vendor parameters is | |
47cd00fa | 2597 | completely disabled. Anybody can change or delete |
c609719b WD |
2598 | these parameters. |
2599 | ||
92ac5208 JH |
2600 | Alternatively, if you define _both_ an ethaddr in the |
2601 | default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default | |
11ccc33f | 2602 | Ethernet address is installed in the environment, |
c609719b WD |
2603 | which can be changed exactly ONCE by the user. [The |
2604 | serial# is unaffected by this, i. e. it remains | |
2605 | read-only.] | |
2606 | ||
2598090b JH |
2607 | The same can be accomplished in a more flexible way |
2608 | for any variable by configuring the type of access | |
2609 | to allow for those variables in the ".flags" variable | |
2610 | or define CONFIG_ENV_FLAGS_LIST_STATIC. | |
2611 | ||
c609719b WD |
2612 | - Protected RAM: |
2613 | CONFIG_PRAM | |
2614 | ||
2615 | Define this variable to enable the reservation of | |
2616 | "protected RAM", i. e. RAM which is not overwritten | |
2617 | by U-Boot. Define CONFIG_PRAM to hold the number of | |
2618 | kB you want to reserve for pRAM. You can overwrite | |
2619 | this default value by defining an environment | |
2620 | variable "pram" to the number of kB you want to | |
2621 | reserve. Note that the board info structure will | |
2622 | still show the full amount of RAM. If pRAM is | |
2623 | reserved, a new environment variable "mem" will | |
2624 | automatically be defined to hold the amount of | |
2625 | remaining RAM in a form that can be passed as boot | |
2626 | argument to Linux, for instance like that: | |
2627 | ||
fe126d8b | 2628 | setenv bootargs ... mem=\${mem} |
c609719b WD |
2629 | saveenv |
2630 | ||
2631 | This way you can tell Linux not to use this memory, | |
2632 | either, which results in a memory region that will | |
2633 | not be affected by reboots. | |
2634 | ||
2635 | *WARNING* If your board configuration uses automatic | |
2636 | detection of the RAM size, you must make sure that | |
2637 | this memory test is non-destructive. So far, the | |
2638 | following board configurations are known to be | |
2639 | "pRAM-clean": | |
2640 | ||
1b0757ec WD |
2641 | IVMS8, IVML24, SPD8xx, TQM8xxL, |
2642 | HERMES, IP860, RPXlite, LWMON, | |
544d97e9 | 2643 | FLAGADM, TQM8260 |
c609719b | 2644 | |
40fef049 GB |
2645 | - Access to physical memory region (> 4GB) |
2646 | Some basic support is provided for operations on memory not | |
2647 | normally accessible to U-Boot - e.g. some architectures | |
2648 | support access to more than 4GB of memory on 32-bit | |
2649 | machines using physical address extension or similar. | |
2650 | Define CONFIG_PHYSMEM to access this basic support, which | |
2651 | currently only supports clearing the memory. | |
2652 | ||
c609719b WD |
2653 | - Error Recovery: |
2654 | CONFIG_PANIC_HANG | |
2655 | ||
2656 | Define this variable to stop the system in case of a | |
2657 | fatal error, so that you have to reset it manually. | |
2658 | This is probably NOT a good idea for an embedded | |
11ccc33f | 2659 | system where you want the system to reboot |
c609719b WD |
2660 | automatically as fast as possible, but it may be |
2661 | useful during development since you can try to debug | |
2662 | the conditions that lead to the situation. | |
2663 | ||
2664 | CONFIG_NET_RETRY_COUNT | |
2665 | ||
43d9616c WD |
2666 | This variable defines the number of retries for |
2667 | network operations like ARP, RARP, TFTP, or BOOTP | |
2668 | before giving up the operation. If not defined, a | |
2669 | default value of 5 is used. | |
c609719b | 2670 | |
40cb90ee GL |
2671 | CONFIG_ARP_TIMEOUT |
2672 | ||
2673 | Timeout waiting for an ARP reply in milliseconds. | |
2674 | ||
48a3e999 TK |
2675 | CONFIG_NFS_TIMEOUT |
2676 | ||
2677 | Timeout in milliseconds used in NFS protocol. | |
2678 | If you encounter "ERROR: Cannot umount" in nfs command, | |
2679 | try longer timeout such as | |
2680 | #define CONFIG_NFS_TIMEOUT 10000UL | |
2681 | ||
c609719b | 2682 | - Command Interpreter: |
8078f1a5 | 2683 | CONFIG_AUTO_COMPLETE |
04a85b3b WD |
2684 | |
2685 | Enable auto completion of commands using TAB. | |
2686 | ||
6d0f6bcf | 2687 | CONFIG_SYS_PROMPT_HUSH_PS2 |
c609719b WD |
2688 | |
2689 | This defines the secondary prompt string, which is | |
2690 | printed when the command interpreter needs more input | |
2691 | to complete a command. Usually "> ". | |
2692 | ||
2693 | Note: | |
2694 | ||
8bde7f77 WD |
2695 | In the current implementation, the local variables |
2696 | space and global environment variables space are | |
2697 | separated. Local variables are those you define by | |
2698 | simply typing `name=value'. To access a local | |
2699 | variable later on, you have write `$name' or | |
2700 | `${name}'; to execute the contents of a variable | |
2701 | directly type `$name' at the command prompt. | |
c609719b | 2702 | |
43d9616c WD |
2703 | Global environment variables are those you use |
2704 | setenv/printenv to work with. To run a command stored | |
2705 | in such a variable, you need to use the run command, | |
2706 | and you must not use the '$' sign to access them. | |
c609719b WD |
2707 | |
2708 | To store commands and special characters in a | |
2709 | variable, please use double quotation marks | |
2710 | surrounding the whole text of the variable, instead | |
2711 | of the backslashes before semicolons and special | |
2712 | symbols. | |
2713 | ||
b445bbb4 | 2714 | - Command Line Editing and History: |
aa0c71ac WD |
2715 | CONFIG_CMDLINE_EDITING |
2716 | ||
11ccc33f | 2717 | Enable editing and History functions for interactive |
b445bbb4 | 2718 | command line input operations |
aa0c71ac | 2719 | |
f3b267b3 MV |
2720 | - Command Line PS1/PS2 support: |
2721 | CONFIG_CMDLINE_PS_SUPPORT | |
2722 | ||
2723 | Enable support for changing the command prompt string | |
2724 | at run-time. Only static string is supported so far. | |
2725 | The string is obtained from environment variables PS1 | |
2726 | and PS2. | |
2727 | ||
a8c7c708 | 2728 | - Default Environment: |
c609719b WD |
2729 | CONFIG_EXTRA_ENV_SETTINGS |
2730 | ||
43d9616c WD |
2731 | Define this to contain any number of null terminated |
2732 | strings (variable = value pairs) that will be part of | |
7152b1d0 | 2733 | the default environment compiled into the boot image. |
2262cfee | 2734 | |
43d9616c WD |
2735 | For example, place something like this in your |
2736 | board's config file: | |
c609719b WD |
2737 | |
2738 | #define CONFIG_EXTRA_ENV_SETTINGS \ | |
2739 | "myvar1=value1\0" \ | |
2740 | "myvar2=value2\0" | |
2741 | ||
43d9616c WD |
2742 | Warning: This method is based on knowledge about the |
2743 | internal format how the environment is stored by the | |
2744 | U-Boot code. This is NOT an official, exported | |
2745 | interface! Although it is unlikely that this format | |
7152b1d0 | 2746 | will change soon, there is no guarantee either. |
c609719b WD |
2747 | You better know what you are doing here. |
2748 | ||
43d9616c WD |
2749 | Note: overly (ab)use of the default environment is |
2750 | discouraged. Make sure to check other ways to preset | |
74de7aef | 2751 | the environment like the "source" command or the |
43d9616c | 2752 | boot command first. |
c609719b | 2753 | |
5e724ca2 SW |
2754 | CONFIG_ENV_VARS_UBOOT_CONFIG |
2755 | ||
2756 | Define this in order to add variables describing the | |
2757 | U-Boot build configuration to the default environment. | |
2758 | These will be named arch, cpu, board, vendor, and soc. | |
2759 | ||
2760 | Enabling this option will cause the following to be defined: | |
2761 | ||
2762 | - CONFIG_SYS_ARCH | |
2763 | - CONFIG_SYS_CPU | |
2764 | - CONFIG_SYS_BOARD | |
2765 | - CONFIG_SYS_VENDOR | |
2766 | - CONFIG_SYS_SOC | |
2767 | ||
7e27f89f TR |
2768 | CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG |
2769 | ||
2770 | Define this in order to add variables describing certain | |
2771 | run-time determined information about the hardware to the | |
2772 | environment. These will be named board_name, board_rev. | |
2773 | ||
06fd8538 SG |
2774 | CONFIG_DELAY_ENVIRONMENT |
2775 | ||
2776 | Normally the environment is loaded when the board is | |
b445bbb4 | 2777 | initialised so that it is available to U-Boot. This inhibits |
06fd8538 SG |
2778 | that so that the environment is not available until |
2779 | explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL | |
2780 | this is instead controlled by the value of | |
2781 | /config/load-environment. | |
2782 | ||
a8c7c708 | 2783 | - DataFlash Support: |
2abbe075 WD |
2784 | CONFIG_HAS_DATAFLASH |
2785 | ||
8bde7f77 WD |
2786 | Defining this option enables DataFlash features and |
2787 | allows to read/write in Dataflash via the standard | |
2788 | commands cp, md... | |
2abbe075 | 2789 | |
f61ec45e EN |
2790 | - Serial Flash support |
2791 | CONFIG_CMD_SF | |
2792 | ||
2793 | Defining this option enables SPI flash commands | |
2794 | 'sf probe/read/write/erase/update'. | |
2795 | ||
2796 | Usage requires an initial 'probe' to define the serial | |
2797 | flash parameters, followed by read/write/erase/update | |
2798 | commands. | |
2799 | ||
2800 | The following defaults may be provided by the platform | |
2801 | to handle the common case when only a single serial | |
2802 | flash is present on the system. | |
2803 | ||
2804 | CONFIG_SF_DEFAULT_BUS Bus identifier | |
2805 | CONFIG_SF_DEFAULT_CS Chip-select | |
2806 | CONFIG_SF_DEFAULT_MODE (see include/spi.h) | |
2807 | CONFIG_SF_DEFAULT_SPEED in Hz | |
2808 | ||
24007273 SG |
2809 | CONFIG_CMD_SF_TEST |
2810 | ||
2811 | Define this option to include a destructive SPI flash | |
2812 | test ('sf test'). | |
2813 | ||
b902e07c JT |
2814 | CONFIG_SF_DUAL_FLASH Dual flash memories |
2815 | ||
2816 | Define this option to use dual flash support where two flash | |
2817 | memories can be connected with a given cs line. | |
b445bbb4 | 2818 | Currently Xilinx Zynq qspi supports these type of connections. |
b902e07c | 2819 | |
3f85ce27 WD |
2820 | - SystemACE Support: |
2821 | CONFIG_SYSTEMACE | |
2822 | ||
2823 | Adding this option adds support for Xilinx SystemACE | |
2824 | chips attached via some sort of local bus. The address | |
11ccc33f | 2825 | of the chip must also be defined in the |
6d0f6bcf | 2826 | CONFIG_SYS_SYSTEMACE_BASE macro. For example: |
3f85ce27 WD |
2827 | |
2828 | #define CONFIG_SYSTEMACE | |
6d0f6bcf | 2829 | #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 |
3f85ce27 WD |
2830 | |
2831 | When SystemACE support is added, the "ace" device type | |
2832 | becomes available to the fat commands, i.e. fatls. | |
2833 | ||
ecb0ccd9 WD |
2834 | - TFTP Fixed UDP Port: |
2835 | CONFIG_TFTP_PORT | |
2836 | ||
28cb9375 | 2837 | If this is defined, the environment variable tftpsrcp |
ecb0ccd9 | 2838 | is used to supply the TFTP UDP source port value. |
28cb9375 | 2839 | If tftpsrcp isn't defined, the normal pseudo-random port |
ecb0ccd9 WD |
2840 | number generator is used. |
2841 | ||
28cb9375 WD |
2842 | Also, the environment variable tftpdstp is used to supply |
2843 | the TFTP UDP destination port value. If tftpdstp isn't | |
2844 | defined, the normal port 69 is used. | |
2845 | ||
2846 | The purpose for tftpsrcp is to allow a TFTP server to | |
ecb0ccd9 WD |
2847 | blindly start the TFTP transfer using the pre-configured |
2848 | target IP address and UDP port. This has the effect of | |
2849 | "punching through" the (Windows XP) firewall, allowing | |
2850 | the remainder of the TFTP transfer to proceed normally. | |
2851 | A better solution is to properly configure the firewall, | |
2852 | but sometimes that is not allowed. | |
2853 | ||
bf36c5d5 SG |
2854 | - Hashing support: |
2855 | CONFIG_CMD_HASH | |
2856 | ||
2857 | This enables a generic 'hash' command which can produce | |
2858 | hashes / digests from a few algorithms (e.g. SHA1, SHA256). | |
2859 | ||
2860 | CONFIG_HASH_VERIFY | |
2861 | ||
2862 | Enable the hash verify command (hash -v). This adds to code | |
2863 | size a little. | |
2864 | ||
94e3c8c4 | 2865 | CONFIG_SHA1 - This option enables support of hashing using SHA1 |
2866 | algorithm. The hash is calculated in software. | |
2867 | CONFIG_SHA256 - This option enables support of hashing using | |
2868 | SHA256 algorithm. The hash is calculated in software. | |
2869 | CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration | |
2870 | for SHA1/SHA256 hashing. | |
2871 | This affects the 'hash' command and also the | |
2872 | hash_lookup_algo() function. | |
2873 | CONFIG_SHA_PROG_HW_ACCEL - This option enables | |
2874 | hardware-acceleration for SHA1/SHA256 progressive hashing. | |
2875 | Data can be streamed in a block at a time and the hashing | |
2876 | is performed in hardware. | |
bf36c5d5 SG |
2877 | |
2878 | Note: There is also a sha1sum command, which should perhaps | |
2879 | be deprecated in favour of 'hash sha1'. | |
2880 | ||
a11f1873 RW |
2881 | - Freescale i.MX specific commands: |
2882 | CONFIG_CMD_HDMIDETECT | |
2883 | This enables 'hdmidet' command which returns true if an | |
2884 | HDMI monitor is detected. This command is i.MX 6 specific. | |
2885 | ||
2886 | CONFIG_CMD_BMODE | |
2887 | This enables the 'bmode' (bootmode) command for forcing | |
2888 | a boot from specific media. | |
2889 | ||
2890 | This is useful for forcing the ROM's usb downloader to | |
2891 | activate upon a watchdog reset which is nice when iterating | |
2892 | on U-Boot. Using the reset button or running bmode normal | |
2893 | will set it back to normal. This command currently | |
2894 | supports i.MX53 and i.MX6. | |
2895 | ||
9e50c406 HS |
2896 | - bootcount support: |
2897 | CONFIG_BOOTCOUNT_LIMIT | |
2898 | ||
2899 | This enables the bootcounter support, see: | |
2900 | http://www.denx.de/wiki/DULG/UBootBootCountLimit | |
2901 | ||
2902 | CONFIG_AT91SAM9XE | |
2903 | enable special bootcounter support on at91sam9xe based boards. | |
2904 | CONFIG_BLACKFIN | |
2905 | enable special bootcounter support on blackfin based boards. | |
2906 | CONFIG_SOC_DA8XX | |
2907 | enable special bootcounter support on da850 based boards. | |
2908 | CONFIG_BOOTCOUNT_RAM | |
2909 | enable support for the bootcounter in RAM | |
2910 | CONFIG_BOOTCOUNT_I2C | |
2911 | enable support for the bootcounter on an i2c (like RTC) device. | |
2912 | CONFIG_SYS_I2C_RTC_ADDR = i2c chip address | |
2913 | CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for | |
2914 | the bootcounter. | |
2915 | CONFIG_BOOTCOUNT_ALEN = address len | |
19c402af | 2916 | |
a8c7c708 | 2917 | - Show boot progress: |
c609719b WD |
2918 | CONFIG_SHOW_BOOT_PROGRESS |
2919 | ||
43d9616c WD |
2920 | Defining this option allows to add some board- |
2921 | specific code (calling a user-provided function | |
2922 | "show_boot_progress(int)") that enables you to show | |
2923 | the system's boot progress on some display (for | |
2924 | example, some LED's) on your board. At the moment, | |
2925 | the following checkpoints are implemented: | |
c609719b | 2926 | |
94fd1316 | 2927 | |
1372cce2 MB |
2928 | Legacy uImage format: |
2929 | ||
c609719b WD |
2930 | Arg Where When |
2931 | 1 common/cmd_bootm.c before attempting to boot an image | |
ba56f625 | 2932 | -1 common/cmd_bootm.c Image header has bad magic number |
c609719b | 2933 | 2 common/cmd_bootm.c Image header has correct magic number |
ba56f625 | 2934 | -2 common/cmd_bootm.c Image header has bad checksum |
c609719b | 2935 | 3 common/cmd_bootm.c Image header has correct checksum |
ba56f625 | 2936 | -3 common/cmd_bootm.c Image data has bad checksum |
c609719b WD |
2937 | 4 common/cmd_bootm.c Image data has correct checksum |
2938 | -4 common/cmd_bootm.c Image is for unsupported architecture | |
2939 | 5 common/cmd_bootm.c Architecture check OK | |
1372cce2 | 2940 | -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) |
c609719b WD |
2941 | 6 common/cmd_bootm.c Image Type check OK |
2942 | -6 common/cmd_bootm.c gunzip uncompression error | |
2943 | -7 common/cmd_bootm.c Unimplemented compression type | |
2944 | 7 common/cmd_bootm.c Uncompression OK | |
1372cce2 | 2945 | 8 common/cmd_bootm.c No uncompress/copy overwrite error |
c609719b | 2946 | -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) |
1372cce2 MB |
2947 | |
2948 | 9 common/image.c Start initial ramdisk verification | |
2949 | -10 common/image.c Ramdisk header has bad magic number | |
2950 | -11 common/image.c Ramdisk header has bad checksum | |
2951 | 10 common/image.c Ramdisk header is OK | |
2952 | -12 common/image.c Ramdisk data has bad checksum | |
2953 | 11 common/image.c Ramdisk data has correct checksum | |
2954 | 12 common/image.c Ramdisk verification complete, start loading | |
11ccc33f | 2955 | -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) |
1372cce2 MB |
2956 | 13 common/image.c Start multifile image verification |
2957 | 14 common/image.c No initial ramdisk, no multifile, continue. | |
2958 | ||
c0f40859 | 2959 | 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS |
c609719b | 2960 | |
a47a12be | 2961 | -30 arch/powerpc/lib/board.c Fatal error, hang the system |
11dadd54 WD |
2962 | -31 post/post.c POST test failed, detected by post_output_backlog() |
2963 | -32 post/post.c POST test failed, detected by post_run_single() | |
63e73c9a | 2964 | |
566a494f HS |
2965 | 34 common/cmd_doc.c before loading a Image from a DOC device |
2966 | -35 common/cmd_doc.c Bad usage of "doc" command | |
2967 | 35 common/cmd_doc.c correct usage of "doc" command | |
2968 | -36 common/cmd_doc.c No boot device | |
2969 | 36 common/cmd_doc.c correct boot device | |
2970 | -37 common/cmd_doc.c Unknown Chip ID on boot device | |
2971 | 37 common/cmd_doc.c correct chip ID found, device available | |
2972 | -38 common/cmd_doc.c Read Error on boot device | |
2973 | 38 common/cmd_doc.c reading Image header from DOC device OK | |
2974 | -39 common/cmd_doc.c Image header has bad magic number | |
2975 | 39 common/cmd_doc.c Image header has correct magic number | |
2976 | -40 common/cmd_doc.c Error reading Image from DOC device | |
2977 | 40 common/cmd_doc.c Image header has correct magic number | |
2978 | 41 common/cmd_ide.c before loading a Image from a IDE device | |
2979 | -42 common/cmd_ide.c Bad usage of "ide" command | |
2980 | 42 common/cmd_ide.c correct usage of "ide" command | |
2981 | -43 common/cmd_ide.c No boot device | |
2982 | 43 common/cmd_ide.c boot device found | |
2983 | -44 common/cmd_ide.c Device not available | |
2984 | 44 common/cmd_ide.c Device available | |
2985 | -45 common/cmd_ide.c wrong partition selected | |
2986 | 45 common/cmd_ide.c partition selected | |
2987 | -46 common/cmd_ide.c Unknown partition table | |
2988 | 46 common/cmd_ide.c valid partition table found | |
2989 | -47 common/cmd_ide.c Invalid partition type | |
2990 | 47 common/cmd_ide.c correct partition type | |
2991 | -48 common/cmd_ide.c Error reading Image Header on boot device | |
2992 | 48 common/cmd_ide.c reading Image Header from IDE device OK | |
2993 | -49 common/cmd_ide.c Image header has bad magic number | |
2994 | 49 common/cmd_ide.c Image header has correct magic number | |
2995 | -50 common/cmd_ide.c Image header has bad checksum | |
2996 | 50 common/cmd_ide.c Image header has correct checksum | |
2997 | -51 common/cmd_ide.c Error reading Image from IDE device | |
2998 | 51 common/cmd_ide.c reading Image from IDE device OK | |
2999 | 52 common/cmd_nand.c before loading a Image from a NAND device | |
3000 | -53 common/cmd_nand.c Bad usage of "nand" command | |
3001 | 53 common/cmd_nand.c correct usage of "nand" command | |
3002 | -54 common/cmd_nand.c No boot device | |
3003 | 54 common/cmd_nand.c boot device found | |
3004 | -55 common/cmd_nand.c Unknown Chip ID on boot device | |
3005 | 55 common/cmd_nand.c correct chip ID found, device available | |
3006 | -56 common/cmd_nand.c Error reading Image Header on boot device | |
3007 | 56 common/cmd_nand.c reading Image Header from NAND device OK | |
3008 | -57 common/cmd_nand.c Image header has bad magic number | |
3009 | 57 common/cmd_nand.c Image header has correct magic number | |
3010 | -58 common/cmd_nand.c Error reading Image from NAND device | |
3011 | 58 common/cmd_nand.c reading Image from NAND device OK | |
3012 | ||
3013 | -60 common/env_common.c Environment has a bad CRC, using default | |
3014 | ||
11ccc33f | 3015 | 64 net/eth.c starting with Ethernet configuration. |
566a494f HS |
3016 | -64 net/eth.c no Ethernet found. |
3017 | 65 net/eth.c Ethernet found. | |
3018 | ||
3019 | -80 common/cmd_net.c usage wrong | |
bc0571fc JH |
3020 | 80 common/cmd_net.c before calling net_loop() |
3021 | -81 common/cmd_net.c some error in net_loop() occurred | |
3022 | 81 common/cmd_net.c net_loop() back without error | |
566a494f HS |
3023 | -82 common/cmd_net.c size == 0 (File with size 0 loaded) |
3024 | 82 common/cmd_net.c trying automatic boot | |
74de7aef WD |
3025 | 83 common/cmd_net.c running "source" command |
3026 | -83 common/cmd_net.c some error in automatic boot or "source" command | |
566a494f | 3027 | 84 common/cmd_net.c end without errors |
c609719b | 3028 | |
1372cce2 MB |
3029 | FIT uImage format: |
3030 | ||
3031 | Arg Where When | |
3032 | 100 common/cmd_bootm.c Kernel FIT Image has correct format | |
3033 | -100 common/cmd_bootm.c Kernel FIT Image has incorrect format | |
3034 | 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration | |
3035 | -101 common/cmd_bootm.c Can't get configuration for kernel subimage | |
3036 | 102 common/cmd_bootm.c Kernel unit name specified | |
3037 | -103 common/cmd_bootm.c Can't get kernel subimage node offset | |
f773bea8 | 3038 | 103 common/cmd_bootm.c Found configuration node |
1372cce2 MB |
3039 | 104 common/cmd_bootm.c Got kernel subimage node offset |
3040 | -104 common/cmd_bootm.c Kernel subimage hash verification failed | |
3041 | 105 common/cmd_bootm.c Kernel subimage hash verification OK | |
3042 | -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture | |
3043 | 106 common/cmd_bootm.c Architecture check OK | |
11ccc33f MZ |
3044 | -106 common/cmd_bootm.c Kernel subimage has wrong type |
3045 | 107 common/cmd_bootm.c Kernel subimage type OK | |
1372cce2 MB |
3046 | -107 common/cmd_bootm.c Can't get kernel subimage data/size |
3047 | 108 common/cmd_bootm.c Got kernel subimage data/size | |
3048 | -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) | |
3049 | -109 common/cmd_bootm.c Can't get kernel subimage type | |
3050 | -110 common/cmd_bootm.c Can't get kernel subimage comp | |
3051 | -111 common/cmd_bootm.c Can't get kernel subimage os | |
3052 | -112 common/cmd_bootm.c Can't get kernel subimage load address | |
3053 | -113 common/cmd_bootm.c Image uncompress/copy overwrite error | |
3054 | ||
3055 | 120 common/image.c Start initial ramdisk verification | |
3056 | -120 common/image.c Ramdisk FIT image has incorrect format | |
3057 | 121 common/image.c Ramdisk FIT image has correct format | |
11ccc33f | 3058 | 122 common/image.c No ramdisk subimage unit name, using configuration |
1372cce2 MB |
3059 | -122 common/image.c Can't get configuration for ramdisk subimage |
3060 | 123 common/image.c Ramdisk unit name specified | |
3061 | -124 common/image.c Can't get ramdisk subimage node offset | |
3062 | 125 common/image.c Got ramdisk subimage node offset | |
3063 | -125 common/image.c Ramdisk subimage hash verification failed | |
3064 | 126 common/image.c Ramdisk subimage hash verification OK | |
3065 | -126 common/image.c Ramdisk subimage for unsupported architecture | |
3066 | 127 common/image.c Architecture check OK | |
3067 | -127 common/image.c Can't get ramdisk subimage data/size | |
3068 | 128 common/image.c Got ramdisk subimage data/size | |
3069 | 129 common/image.c Can't get ramdisk load address | |
3070 | -129 common/image.c Got ramdisk load address | |
3071 | ||
11ccc33f | 3072 | -130 common/cmd_doc.c Incorrect FIT image format |
1372cce2 MB |
3073 | 131 common/cmd_doc.c FIT image format OK |
3074 | ||
11ccc33f | 3075 | -140 common/cmd_ide.c Incorrect FIT image format |
1372cce2 MB |
3076 | 141 common/cmd_ide.c FIT image format OK |
3077 | ||
11ccc33f | 3078 | -150 common/cmd_nand.c Incorrect FIT image format |
1372cce2 MB |
3079 | 151 common/cmd_nand.c FIT image format OK |
3080 | ||
21d29f7f HS |
3081 | - legacy image format: |
3082 | CONFIG_IMAGE_FORMAT_LEGACY | |
3083 | enables the legacy image format support in U-Boot. | |
3084 | ||
3085 | Default: | |
3086 | enabled if CONFIG_FIT_SIGNATURE is not defined. | |
3087 | ||
3088 | CONFIG_DISABLE_IMAGE_LEGACY | |
3089 | disable the legacy image format | |
3090 | ||
3091 | This define is introduced, as the legacy image format is | |
3092 | enabled per default for backward compatibility. | |
3093 | ||
d95f6ec7 | 3094 | - FIT image support: |
9a4f479b DE |
3095 | CONFIG_FIT_DISABLE_SHA256 |
3096 | Supporting SHA256 hashes has quite an impact on binary size. | |
3097 | For constrained systems sha256 hash support can be disabled | |
3098 | with this option. | |
3099 | ||
73223f0e SG |
3100 | TODO([email protected]): Adjust this option to be positive, |
3101 | and move it to Kconfig | |
3102 | ||
4cf2609b WD |
3103 | - Standalone program support: |
3104 | CONFIG_STANDALONE_LOAD_ADDR | |
3105 | ||
6feff899 WD |
3106 | This option defines a board specific value for the |
3107 | address where standalone program gets loaded, thus | |
3108 | overwriting the architecture dependent default | |
4cf2609b WD |
3109 | settings. |
3110 | ||
3111 | - Frame Buffer Address: | |
3112 | CONFIG_FB_ADDR | |
3113 | ||
3114 | Define CONFIG_FB_ADDR if you want to use specific | |
44a53b57 WD |
3115 | address for frame buffer. This is typically the case |
3116 | when using a graphics controller has separate video | |
3117 | memory. U-Boot will then place the frame buffer at | |
3118 | the given address instead of dynamically reserving it | |
3119 | in system RAM by calling lcd_setmem(), which grabs | |
3120 | the memory for the frame buffer depending on the | |
3121 | configured panel size. | |
4cf2609b WD |
3122 | |
3123 | Please see board_init_f function. | |
3124 | ||
cccfc2ab DZ |
3125 | - Automatic software updates via TFTP server |
3126 | CONFIG_UPDATE_TFTP | |
3127 | CONFIG_UPDATE_TFTP_CNT_MAX | |
3128 | CONFIG_UPDATE_TFTP_MSEC_MAX | |
3129 | ||
3130 | These options enable and control the auto-update feature; | |
3131 | for a more detailed description refer to doc/README.update. | |
3132 | ||
3133 | - MTD Support (mtdparts command, UBI support) | |
3134 | CONFIG_MTD_DEVICE | |
3135 | ||
3136 | Adds the MTD device infrastructure from the Linux kernel. | |
3137 | Needed for mtdparts command support. | |
3138 | ||
3139 | CONFIG_MTD_PARTITIONS | |
3140 | ||
3141 | Adds the MTD partitioning infrastructure from the Linux | |
3142 | kernel. Needed for UBI support. | |
3143 | ||
70c219cd JH |
3144 | - UBI support |
3145 | CONFIG_CMD_UBI | |
3146 | ||
3147 | Adds commands for interacting with MTD partitions formatted | |
3148 | with the UBI flash translation layer | |
3149 | ||
3150 | Requires also defining CONFIG_RBTREE | |
3151 | ||
147162da JH |
3152 | CONFIG_UBI_SILENCE_MSG |
3153 | ||
3154 | Make the verbose messages from UBI stop printing. This leaves | |
3155 | warnings and errors enabled. | |
3156 | ||
ff94bc40 HS |
3157 | |
3158 | CONFIG_MTD_UBI_WL_THRESHOLD | |
3159 | This parameter defines the maximum difference between the highest | |
3160 | erase counter value and the lowest erase counter value of eraseblocks | |
3161 | of UBI devices. When this threshold is exceeded, UBI starts performing | |
3162 | wear leveling by means of moving data from eraseblock with low erase | |
3163 | counter to eraseblocks with high erase counter. | |
3164 | ||
3165 | The default value should be OK for SLC NAND flashes, NOR flashes and | |
3166 | other flashes which have eraseblock life-cycle 100000 or more. | |
3167 | However, in case of MLC NAND flashes which typically have eraseblock | |
3168 | life-cycle less than 10000, the threshold should be lessened (e.g., | |
3169 | to 128 or 256, although it does not have to be power of 2). | |
3170 | ||
3171 | default: 4096 | |
c654b517 | 3172 | |
ff94bc40 HS |
3173 | CONFIG_MTD_UBI_BEB_LIMIT |
3174 | This option specifies the maximum bad physical eraseblocks UBI | |
3175 | expects on the MTD device (per 1024 eraseblocks). If the | |
3176 | underlying flash does not admit of bad eraseblocks (e.g. NOR | |
3177 | flash), this value is ignored. | |
3178 | ||
3179 | NAND datasheets often specify the minimum and maximum NVM | |
3180 | (Number of Valid Blocks) for the flashes' endurance lifetime. | |
3181 | The maximum expected bad eraseblocks per 1024 eraseblocks | |
3182 | then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", | |
3183 | which gives 20 for most NANDs (MaxNVB is basically the total | |
3184 | count of eraseblocks on the chip). | |
3185 | ||
3186 | To put it differently, if this value is 20, UBI will try to | |
3187 | reserve about 1.9% of physical eraseblocks for bad blocks | |
3188 | handling. And that will be 1.9% of eraseblocks on the entire | |
3189 | NAND chip, not just the MTD partition UBI attaches. This means | |
3190 | that if you have, say, a NAND flash chip admits maximum 40 bad | |
3191 | eraseblocks, and it is split on two MTD partitions of the same | |
3192 | size, UBI will reserve 40 eraseblocks when attaching a | |
3193 | partition. | |
3194 | ||
3195 | default: 20 | |
3196 | ||
3197 | CONFIG_MTD_UBI_FASTMAP | |
3198 | Fastmap is a mechanism which allows attaching an UBI device | |
3199 | in nearly constant time. Instead of scanning the whole MTD device it | |
3200 | only has to locate a checkpoint (called fastmap) on the device. | |
3201 | The on-flash fastmap contains all information needed to attach | |
3202 | the device. Using fastmap makes only sense on large devices where | |
3203 | attaching by scanning takes long. UBI will not automatically install | |
3204 | a fastmap on old images, but you can set the UBI parameter | |
3205 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note | |
3206 | that fastmap-enabled images are still usable with UBI implementations | |
3207 | without fastmap support. On typical flash devices the whole fastmap | |
3208 | fits into one PEB. UBI will reserve PEBs to hold two fastmaps. | |
3209 | ||
3210 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT | |
3211 | Set this parameter to enable fastmap automatically on images | |
3212 | without a fastmap. | |
3213 | default: 0 | |
3214 | ||
0195a7bb HS |
3215 | CONFIG_MTD_UBI_FM_DEBUG |
3216 | Enable UBI fastmap debug | |
3217 | default: 0 | |
3218 | ||
70c219cd JH |
3219 | - UBIFS support |
3220 | CONFIG_CMD_UBIFS | |
3221 | ||
3222 | Adds commands for interacting with UBI volumes formatted as | |
3223 | UBIFS. UBIFS is read-only in u-boot. | |
3224 | ||
3225 | Requires UBI support as well as CONFIG_LZO | |
3226 | ||
147162da JH |
3227 | CONFIG_UBIFS_SILENCE_MSG |
3228 | ||
3229 | Make the verbose messages from UBIFS stop printing. This leaves | |
3230 | warnings and errors enabled. | |
3231 | ||
6a11cf48 | 3232 | - SPL framework |
04e5ae79 WD |
3233 | CONFIG_SPL |
3234 | Enable building of SPL globally. | |
6a11cf48 | 3235 | |
95579793 TR |
3236 | CONFIG_SPL_LDSCRIPT |
3237 | LDSCRIPT for linking the SPL binary. | |
3238 | ||
6ebc3461 AA |
3239 | CONFIG_SPL_MAX_FOOTPRINT |
3240 | Maximum size in memory allocated to the SPL, BSS included. | |
3241 | When defined, the linker checks that the actual memory | |
3242 | used by SPL from _start to __bss_end does not exceed it. | |
8960af8b | 3243 | CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE |
6ebc3461 AA |
3244 | must not be both defined at the same time. |
3245 | ||
95579793 | 3246 | CONFIG_SPL_MAX_SIZE |
6ebc3461 AA |
3247 | Maximum size of the SPL image (text, data, rodata, and |
3248 | linker lists sections), BSS excluded. | |
3249 | When defined, the linker checks that the actual size does | |
3250 | not exceed it. | |
95579793 | 3251 | |
04e5ae79 WD |
3252 | CONFIG_SPL_TEXT_BASE |
3253 | TEXT_BASE for linking the SPL binary. | |
6a11cf48 | 3254 | |
94a45bb1 SW |
3255 | CONFIG_SPL_RELOC_TEXT_BASE |
3256 | Address to relocate to. If unspecified, this is equal to | |
3257 | CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). | |
3258 | ||
95579793 TR |
3259 | CONFIG_SPL_BSS_START_ADDR |
3260 | Link address for the BSS within the SPL binary. | |
3261 | ||
3262 | CONFIG_SPL_BSS_MAX_SIZE | |
6ebc3461 AA |
3263 | Maximum size in memory allocated to the SPL BSS. |
3264 | When defined, the linker checks that the actual memory used | |
3265 | by SPL from __bss_start to __bss_end does not exceed it. | |
8960af8b | 3266 | CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE |
6ebc3461 | 3267 | must not be both defined at the same time. |
95579793 TR |
3268 | |
3269 | CONFIG_SPL_STACK | |
3270 | Adress of the start of the stack SPL will use | |
3271 | ||
8c80eb3b AA |
3272 | CONFIG_SPL_PANIC_ON_RAW_IMAGE |
3273 | When defined, SPL will panic() if the image it has | |
3274 | loaded does not have a signature. | |
3275 | Defining this is useful when code which loads images | |
3276 | in SPL cannot guarantee that absolutely all read errors | |
3277 | will be caught. | |
3278 | An example is the LPC32XX MLC NAND driver, which will | |
3279 | consider that a completely unreadable NAND block is bad, | |
3280 | and thus should be skipped silently. | |
3281 | ||
e0727515 MV |
3282 | CONFIG_SPL_ABORT_ON_RAW_IMAGE |
3283 | When defined, SPL will proceed to another boot method | |
3284 | if the image it has loaded does not have a signature. | |
3285 | ||
94a45bb1 SW |
3286 | CONFIG_SPL_RELOC_STACK |
3287 | Adress of the start of the stack SPL will use after | |
3288 | relocation. If unspecified, this is equal to | |
3289 | CONFIG_SPL_STACK. | |
3290 | ||
95579793 TR |
3291 | CONFIG_SYS_SPL_MALLOC_START |
3292 | Starting address of the malloc pool used in SPL. | |
9ac4fc82 FE |
3293 | When this option is set the full malloc is used in SPL and |
3294 | it is set up by spl_init() and before that, the simple malloc() | |
3295 | can be used if CONFIG_SYS_MALLOC_F is defined. | |
95579793 TR |
3296 | |
3297 | CONFIG_SYS_SPL_MALLOC_SIZE | |
3298 | The size of the malloc pool used in SPL. | |
6a11cf48 | 3299 | |
47f7bcae TR |
3300 | CONFIG_SPL_FRAMEWORK |
3301 | Enable the SPL framework under common/. This framework | |
3302 | supports MMC, NAND and YMODEM loading of U-Boot and NAND | |
3303 | NAND loading of the Linux Kernel. | |
3304 | ||
9607faf2 TR |
3305 | CONFIG_SPL_OS_BOOT |
3306 | Enable booting directly to an OS from SPL. | |
3307 | See also: doc/README.falcon | |
3308 | ||
861a86f4 TR |
3309 | CONFIG_SPL_DISPLAY_PRINT |
3310 | For ARM, enable an optional function to print more information | |
3311 | about the running system. | |
3312 | ||
4b919725 SW |
3313 | CONFIG_SPL_INIT_MINIMAL |
3314 | Arch init code should be built for a very small image | |
3315 | ||
b97300b6 PK |
3316 | CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION |
3317 | Partition on the MMC to load U-Boot from when the MMC is being | |
3318 | used in raw mode | |
3319 | ||
2b75b0ad PK |
3320 | CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR |
3321 | Sector to load kernel uImage from when MMC is being | |
3322 | used in raw mode (for Falcon mode) | |
3323 | ||
3324 | CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, | |
3325 | CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS | |
3326 | Sector and number of sectors to load kernel argument | |
3327 | parameters from when MMC is being used in raw mode | |
3328 | (for falcon mode) | |
3329 | ||
e2ccdf89 PK |
3330 | CONFIG_SYS_MMCSD_FS_BOOT_PARTITION |
3331 | Partition on the MMC to load U-Boot from when the MMC is being | |
3332 | used in fs mode | |
3333 | ||
fae81c72 GG |
3334 | CONFIG_SPL_FS_LOAD_PAYLOAD_NAME |
3335 | Filename to read to load U-Boot when reading from filesystem | |
3336 | ||
3337 | CONFIG_SPL_FS_LOAD_KERNEL_NAME | |
7ad2cc79 | 3338 | Filename to read to load kernel uImage when reading |
fae81c72 | 3339 | from filesystem (for Falcon mode) |
7ad2cc79 | 3340 | |
fae81c72 | 3341 | CONFIG_SPL_FS_LOAD_ARGS_NAME |
7ad2cc79 | 3342 | Filename to read to load kernel argument parameters |
fae81c72 | 3343 | when reading from filesystem (for Falcon mode) |
7ad2cc79 | 3344 | |
06f60ae3 SW |
3345 | CONFIG_SPL_MPC83XX_WAIT_FOR_NAND |
3346 | Set this for NAND SPL on PPC mpc83xx targets, so that | |
3347 | start.S waits for the rest of the SPL to load before | |
3348 | continuing (the hardware starts execution after just | |
3349 | loading the first page rather than the full 4K). | |
3350 | ||
651fcf60 PK |
3351 | CONFIG_SPL_SKIP_RELOCATE |
3352 | Avoid SPL relocation | |
3353 | ||
6f2f01b9 SW |
3354 | CONFIG_SPL_NAND_BASE |
3355 | Include nand_base.c in the SPL. Requires | |
3356 | CONFIG_SPL_NAND_DRIVERS. | |
3357 | ||
3358 | CONFIG_SPL_NAND_DRIVERS | |
3359 | SPL uses normal NAND drivers, not minimal drivers. | |
3360 | ||
3361 | CONFIG_SPL_NAND_ECC | |
3362 | Include standard software ECC in the SPL | |
3363 | ||
95579793 | 3364 | CONFIG_SPL_NAND_SIMPLE |
7d4b7955 SW |
3365 | Support for NAND boot using simple NAND drivers that |
3366 | expose the cmd_ctrl() interface. | |
95579793 | 3367 | |
6f4e7d3c TG |
3368 | CONFIG_SPL_UBI |
3369 | Support for a lightweight UBI (fastmap) scanner and | |
3370 | loader | |
3371 | ||
0c3117b1 HS |
3372 | CONFIG_SPL_NAND_RAW_ONLY |
3373 | Support to boot only raw u-boot.bin images. Use this only | |
3374 | if you need to save space. | |
3375 | ||
7c8eea59 YZ |
3376 | CONFIG_SPL_COMMON_INIT_DDR |
3377 | Set for common ddr init with serial presence detect in | |
3378 | SPL binary. | |
3379 | ||
95579793 TR |
3380 | CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, |
3381 | CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, | |
3382 | CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, | |
3383 | CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, | |
3384 | CONFIG_SYS_NAND_ECCBYTES | |
3385 | Defines the size and behavior of the NAND that SPL uses | |
7d4b7955 | 3386 | to read U-Boot |
95579793 | 3387 | |
fbe76ae4 PK |
3388 | CONFIG_SPL_NAND_BOOT |
3389 | Add support NAND boot | |
3390 | ||
95579793 | 3391 | CONFIG_SYS_NAND_U_BOOT_OFFS |
7d4b7955 SW |
3392 | Location in NAND to read U-Boot from |
3393 | ||
3394 | CONFIG_SYS_NAND_U_BOOT_DST | |
3395 | Location in memory to load U-Boot to | |
3396 | ||
3397 | CONFIG_SYS_NAND_U_BOOT_SIZE | |
3398 | Size of image to load | |
95579793 TR |
3399 | |
3400 | CONFIG_SYS_NAND_U_BOOT_START | |
7d4b7955 | 3401 | Entry point in loaded image to jump to |
95579793 TR |
3402 | |
3403 | CONFIG_SYS_NAND_HW_ECC_OOBFIRST | |
3404 | Define this if you need to first read the OOB and then the | |
b445bbb4 | 3405 | data. This is used, for example, on davinci platforms. |
95579793 TR |
3406 | |
3407 | CONFIG_SPL_OMAP3_ID_NAND | |
3408 | Support for an OMAP3-specific set of functions to return the | |
3409 | ID and MFR of the first attached NAND chip, if present. | |
3410 | ||
c57b953d PM |
3411 | CONFIG_SPL_RAM_DEVICE |
3412 | Support for running image already present in ram, in SPL binary | |
6a11cf48 | 3413 | |
74752baa | 3414 | CONFIG_SPL_PAD_TO |
6113d3f2 BT |
3415 | Image offset to which the SPL should be padded before appending |
3416 | the SPL payload. By default, this is defined as | |
3417 | CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. | |
3418 | CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL | |
3419 | payload without any padding, or >= CONFIG_SPL_MAX_SIZE. | |
74752baa | 3420 | |
ca2fca22 SW |
3421 | CONFIG_SPL_TARGET |
3422 | Final target image containing SPL and payload. Some SPLs | |
3423 | use an arch-specific makefile fragment instead, for | |
3424 | example if more than one image needs to be produced. | |
3425 | ||
87ebee39 SG |
3426 | CONFIG_FIT_SPL_PRINT |
3427 | Printing information about a FIT image adds quite a bit of | |
3428 | code to SPL. So this is normally disabled in SPL. Use this | |
3429 | option to re-enable it. This will affect the output of the | |
3430 | bootm command when booting a FIT image. | |
3431 | ||
3aa29de0 YZ |
3432 | - TPL framework |
3433 | CONFIG_TPL | |
3434 | Enable building of TPL globally. | |
3435 | ||
3436 | CONFIG_TPL_PAD_TO | |
3437 | Image offset to which the TPL should be padded before appending | |
3438 | the TPL payload. By default, this is defined as | |
93e14596 WD |
3439 | CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. |
3440 | CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL | |
3441 | payload without any padding, or >= CONFIG_SPL_MAX_SIZE. | |
3aa29de0 | 3442 | |
a8c7c708 WD |
3443 | - Interrupt support (PPC): |
3444 | ||
d4ca31c4 WD |
3445 | There are common interrupt_init() and timer_interrupt() |
3446 | for all PPC archs. interrupt_init() calls interrupt_init_cpu() | |
11ccc33f | 3447 | for CPU specific initialization. interrupt_init_cpu() |
d4ca31c4 | 3448 | should set decrementer_count to appropriate value. If |
11ccc33f | 3449 | CPU resets decrementer automatically after interrupt |
d4ca31c4 | 3450 | (ppc4xx) it should set decrementer_count to zero. |
11ccc33f | 3451 | timer_interrupt() calls timer_interrupt_cpu() for CPU |
d4ca31c4 WD |
3452 | specific handling. If board has watchdog / status_led |
3453 | / other_activity_monitor it works automatically from | |
3454 | general timer_interrupt(). | |
a8c7c708 | 3455 | |
c609719b | 3456 | |
9660e442 HR |
3457 | Board initialization settings: |
3458 | ------------------------------ | |
3459 | ||
3460 | During Initialization u-boot calls a number of board specific functions | |
3461 | to allow the preparation of board specific prerequisites, e.g. pin setup | |
3462 | before drivers are initialized. To enable these callbacks the | |
3463 | following configuration macros have to be defined. Currently this is | |
3464 | architecture specific, so please check arch/your_architecture/lib/board.c | |
3465 | typically in board_init_f() and board_init_r(). | |
3466 | ||
3467 | - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() | |
3468 | - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() | |
3469 | - CONFIG_BOARD_LATE_INIT: Call board_late_init() | |
3470 | - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() | |
c609719b | 3471 | |
c609719b WD |
3472 | Configuration Settings: |
3473 | ----------------------- | |
3474 | ||
4d1fd7f1 YS |
3475 | - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. |
3476 | Optionally it can be defined to support 64-bit memory commands. | |
3477 | ||
6d0f6bcf | 3478 | - CONFIG_SYS_LONGHELP: Defined when you want long help messages included; |
c609719b WD |
3479 | undefine this when you're short of memory. |
3480 | ||
2fb2604d PT |
3481 | - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default |
3482 | width of the commands listed in the 'help' command output. | |
3483 | ||
6d0f6bcf | 3484 | - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to |
c609719b WD |
3485 | prompt for user input. |
3486 | ||
6d0f6bcf | 3487 | - CONFIG_SYS_CBSIZE: Buffer size for input from the Console |
c609719b | 3488 | |
6d0f6bcf | 3489 | - CONFIG_SYS_PBSIZE: Buffer size for Console output |
c609719b | 3490 | |
6d0f6bcf | 3491 | - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands |
c609719b | 3492 | |
6d0f6bcf | 3493 | - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to |
c609719b WD |
3494 | the application (usually a Linux kernel) when it is |
3495 | booted | |
3496 | ||
6d0f6bcf | 3497 | - CONFIG_SYS_BAUDRATE_TABLE: |
c609719b WD |
3498 | List of legal baudrate settings for this board. |
3499 | ||
6d0f6bcf | 3500 | - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: |
c609719b WD |
3501 | Begin and End addresses of the area used by the |
3502 | simple memory test. | |
3503 | ||
6d0f6bcf | 3504 | - CONFIG_SYS_ALT_MEMTEST: |
8bde7f77 | 3505 | Enable an alternate, more extensive memory test. |
c609719b | 3506 | |
6d0f6bcf | 3507 | - CONFIG_SYS_MEMTEST_SCRATCH: |
5f535fe1 WD |
3508 | Scratch address used by the alternate memory test |
3509 | You only need to set this if address zero isn't writeable | |
3510 | ||
e8149522 | 3511 | - CONFIG_SYS_MEM_RESERVE_SECURE |
e61a7534 | 3512 | Only implemented for ARMv8 for now. |
e8149522 YS |
3513 | If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory |
3514 | is substracted from total RAM and won't be reported to OS. | |
3515 | This memory can be used as secure memory. A variable | |
e61a7534 | 3516 | gd->arch.secure_ram is used to track the location. In systems |
e8149522 YS |
3517 | the RAM base is not zero, or RAM is divided into banks, |
3518 | this variable needs to be recalcuated to get the address. | |
3519 | ||
aabd7ddb | 3520 | - CONFIG_SYS_MEM_TOP_HIDE: |
6d0f6bcf | 3521 | If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, |
14f73ca6 | 3522 | this specified memory area will get subtracted from the top |
11ccc33f | 3523 | (end) of RAM and won't get "touched" at all by U-Boot. By |
14f73ca6 SR |
3524 | fixing up gd->ram_size the Linux kernel should gets passed |
3525 | the now "corrected" memory size and won't touch it either. | |
3526 | This should work for arch/ppc and arch/powerpc. Only Linux | |
5e12e75d | 3527 | board ports in arch/powerpc with bootwrapper support that |
14f73ca6 | 3528 | recalculate the memory size from the SDRAM controller setup |
5e12e75d | 3529 | will have to get fixed in Linux additionally. |
14f73ca6 SR |
3530 | |
3531 | This option can be used as a workaround for the 440EPx/GRx | |
3532 | CHIP 11 errata where the last 256 bytes in SDRAM shouldn't | |
3533 | be touched. | |
3534 | ||
3535 | WARNING: Please make sure that this value is a multiple of | |
3536 | the Linux page size (normally 4k). If this is not the case, | |
3537 | then the end address of the Linux memory will be located at a | |
3538 | non page size aligned address and this could cause major | |
3539 | problems. | |
3540 | ||
6d0f6bcf | 3541 | - CONFIG_SYS_LOADS_BAUD_CHANGE: |
c609719b WD |
3542 | Enable temporary baudrate change while serial download |
3543 | ||
6d0f6bcf | 3544 | - CONFIG_SYS_SDRAM_BASE: |
c609719b WD |
3545 | Physical start address of SDRAM. _Must_ be 0 here. |
3546 | ||
6d0f6bcf | 3547 | - CONFIG_SYS_FLASH_BASE: |
c609719b WD |
3548 | Physical start address of Flash memory. |
3549 | ||
6d0f6bcf | 3550 | - CONFIG_SYS_MONITOR_BASE: |
c609719b WD |
3551 | Physical start address of boot monitor code (set by |
3552 | make config files to be same as the text base address | |
14d0a02a | 3553 | (CONFIG_SYS_TEXT_BASE) used when linking) - same as |
6d0f6bcf | 3554 | CONFIG_SYS_FLASH_BASE when booting from flash. |
c609719b | 3555 | |
6d0f6bcf | 3556 | - CONFIG_SYS_MONITOR_LEN: |
8bde7f77 WD |
3557 | Size of memory reserved for monitor code, used to |
3558 | determine _at_compile_time_ (!) if the environment is | |
3559 | embedded within the U-Boot image, or in a separate | |
3560 | flash sector. | |
c609719b | 3561 | |
6d0f6bcf | 3562 | - CONFIG_SYS_MALLOC_LEN: |
c609719b WD |
3563 | Size of DRAM reserved for malloc() use. |
3564 | ||
d59476b6 SG |
3565 | - CONFIG_SYS_MALLOC_F_LEN |
3566 | Size of the malloc() pool for use before relocation. If | |
3567 | this is defined, then a very simple malloc() implementation | |
3568 | will become available before relocation. The address is just | |
3569 | below the global data, and the stack is moved down to make | |
3570 | space. | |
3571 | ||
3572 | This feature allocates regions with increasing addresses | |
3573 | within the region. calloc() is supported, but realloc() | |
3574 | is not available. free() is supported but does nothing. | |
b445bbb4 | 3575 | The memory will be freed (or in fact just forgotten) when |
d59476b6 SG |
3576 | U-Boot relocates itself. |
3577 | ||
38687ae6 SG |
3578 | - CONFIG_SYS_MALLOC_SIMPLE |
3579 | Provides a simple and small malloc() and calloc() for those | |
3580 | boards which do not use the full malloc in SPL (which is | |
3581 | enabled with CONFIG_SYS_SPL_MALLOC_START). | |
3582 | ||
1dfdd9ba TR |
3583 | - CONFIG_SYS_NONCACHED_MEMORY: |
3584 | Size of non-cached memory area. This area of memory will be | |
3585 | typically located right below the malloc() area and mapped | |
3586 | uncached in the MMU. This is useful for drivers that would | |
3587 | otherwise require a lot of explicit cache maintenance. For | |
3588 | some drivers it's also impossible to properly maintain the | |
3589 | cache. For example if the regions that need to be flushed | |
3590 | are not a multiple of the cache-line size, *and* padding | |
3591 | cannot be allocated between the regions to align them (i.e. | |
3592 | if the HW requires a contiguous array of regions, and the | |
3593 | size of each region is not cache-aligned), then a flush of | |
3594 | one region may result in overwriting data that hardware has | |
3595 | written to another region in the same cache-line. This can | |
3596 | happen for example in network drivers where descriptors for | |
3597 | buffers are typically smaller than the CPU cache-line (e.g. | |
3598 | 16 bytes vs. 32 or 64 bytes). | |
3599 | ||
3600 | Non-cached memory is only supported on 32-bit ARM at present. | |
3601 | ||
6d0f6bcf | 3602 | - CONFIG_SYS_BOOTM_LEN: |
15940c9a SR |
3603 | Normally compressed uImages are limited to an |
3604 | uncompressed size of 8 MBytes. If this is not enough, | |
6d0f6bcf | 3605 | you can define CONFIG_SYS_BOOTM_LEN in your board config file |
15940c9a SR |
3606 | to adjust this setting to your needs. |
3607 | ||
6d0f6bcf | 3608 | - CONFIG_SYS_BOOTMAPSZ: |
c609719b WD |
3609 | Maximum size of memory mapped by the startup code of |
3610 | the Linux kernel; all data that must be processed by | |
7d721e34 BS |
3611 | the Linux kernel (bd_info, boot arguments, FDT blob if |
3612 | used) must be put below this limit, unless "bootm_low" | |
1bce2aeb | 3613 | environment variable is defined and non-zero. In such case |
7d721e34 | 3614 | all data for the Linux kernel must be between "bootm_low" |
c0f40859 | 3615 | and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment |
c3624e6e GL |
3616 | variable "bootm_mapsize" will override the value of |
3617 | CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, | |
3618 | then the value in "bootm_size" will be used instead. | |
c609719b | 3619 | |
fca43cc8 JR |
3620 | - CONFIG_SYS_BOOT_RAMDISK_HIGH: |
3621 | Enable initrd_high functionality. If defined then the | |
3622 | initrd_high feature is enabled and the bootm ramdisk subcommand | |
3623 | is enabled. | |
3624 | ||
3625 | - CONFIG_SYS_BOOT_GET_CMDLINE: | |
3626 | Enables allocating and saving kernel cmdline in space between | |
3627 | "bootm_low" and "bootm_low" + BOOTMAPSZ. | |
3628 | ||
3629 | - CONFIG_SYS_BOOT_GET_KBD: | |
3630 | Enables allocating and saving a kernel copy of the bd_info in | |
3631 | space between "bootm_low" and "bootm_low" + BOOTMAPSZ. | |
3632 | ||
6d0f6bcf | 3633 | - CONFIG_SYS_MAX_FLASH_BANKS: |
c609719b WD |
3634 | Max number of Flash memory banks |
3635 | ||
6d0f6bcf | 3636 | - CONFIG_SYS_MAX_FLASH_SECT: |
c609719b WD |
3637 | Max number of sectors on a Flash chip |
3638 | ||
6d0f6bcf | 3639 | - CONFIG_SYS_FLASH_ERASE_TOUT: |
c609719b WD |
3640 | Timeout for Flash erase operations (in ms) |
3641 | ||
6d0f6bcf | 3642 | - CONFIG_SYS_FLASH_WRITE_TOUT: |
c609719b WD |
3643 | Timeout for Flash write operations (in ms) |
3644 | ||
6d0f6bcf | 3645 | - CONFIG_SYS_FLASH_LOCK_TOUT |
8564acf9 WD |
3646 | Timeout for Flash set sector lock bit operation (in ms) |
3647 | ||
6d0f6bcf | 3648 | - CONFIG_SYS_FLASH_UNLOCK_TOUT |
8564acf9 WD |
3649 | Timeout for Flash clear lock bits operation (in ms) |
3650 | ||
6d0f6bcf | 3651 | - CONFIG_SYS_FLASH_PROTECTION |
8564acf9 WD |
3652 | If defined, hardware flash sectors protection is used |
3653 | instead of U-Boot software protection. | |
3654 | ||
6d0f6bcf | 3655 | - CONFIG_SYS_DIRECT_FLASH_TFTP: |
c609719b WD |
3656 | |
3657 | Enable TFTP transfers directly to flash memory; | |
3658 | without this option such a download has to be | |
3659 | performed in two steps: (1) download to RAM, and (2) | |
3660 | copy from RAM to flash. | |
3661 | ||
3662 | The two-step approach is usually more reliable, since | |
3663 | you can check if the download worked before you erase | |
11ccc33f MZ |
3664 | the flash, but in some situations (when system RAM is |
3665 | too limited to allow for a temporary copy of the | |
c609719b WD |
3666 | downloaded image) this option may be very useful. |
3667 | ||
6d0f6bcf | 3668 | - CONFIG_SYS_FLASH_CFI: |
43d9616c | 3669 | Define if the flash driver uses extra elements in the |
5653fc33 WD |
3670 | common flash structure for storing flash geometry. |
3671 | ||
00b1883a | 3672 | - CONFIG_FLASH_CFI_DRIVER |
5653fc33 WD |
3673 | This option also enables the building of the cfi_flash driver |
3674 | in the drivers directory | |
c609719b | 3675 | |
91809ed5 PZ |
3676 | - CONFIG_FLASH_CFI_MTD |
3677 | This option enables the building of the cfi_mtd driver | |
3678 | in the drivers directory. The driver exports CFI flash | |
3679 | to the MTD layer. | |
3680 | ||
6d0f6bcf | 3681 | - CONFIG_SYS_FLASH_USE_BUFFER_WRITE |
96ef831f GL |
3682 | Use buffered writes to flash. |
3683 | ||
3684 | - CONFIG_FLASH_SPANSION_S29WS_N | |
3685 | s29ws-n MirrorBit flash has non-standard addresses for buffered | |
3686 | write commands. | |
3687 | ||
6d0f6bcf | 3688 | - CONFIG_SYS_FLASH_QUIET_TEST |
5568e613 SR |
3689 | If this option is defined, the common CFI flash doesn't |
3690 | print it's warning upon not recognized FLASH banks. This | |
3691 | is useful, if some of the configured banks are only | |
3692 | optionally available. | |
3693 | ||
9a042e9c JVB |
3694 | - CONFIG_FLASH_SHOW_PROGRESS |
3695 | If defined (must be an integer), print out countdown | |
3696 | digits and dots. Recommended value: 45 (9..1) for 80 | |
3697 | column displays, 15 (3..1) for 40 column displays. | |
3698 | ||
352ef3f1 SR |
3699 | - CONFIG_FLASH_VERIFY |
3700 | If defined, the content of the flash (destination) is compared | |
3701 | against the source after the write operation. An error message | |
3702 | will be printed when the contents are not identical. | |
3703 | Please note that this option is useless in nearly all cases, | |
3704 | since such flash programming errors usually are detected earlier | |
3705 | while unprotecting/erasing/programming. Please only enable | |
3706 | this option if you really know what you are doing. | |
3707 | ||
6d0f6bcf | 3708 | - CONFIG_SYS_RX_ETH_BUFFER: |
11ccc33f MZ |
3709 | Defines the number of Ethernet receive buffers. On some |
3710 | Ethernet controllers it is recommended to set this value | |
53cf9435 SR |
3711 | to 8 or even higher (EEPRO100 or 405 EMAC), since all |
3712 | buffers can be full shortly after enabling the interface | |
11ccc33f | 3713 | on high Ethernet traffic. |
53cf9435 SR |
3714 | Defaults to 4 if not defined. |
3715 | ||
ea882baf WD |
3716 | - CONFIG_ENV_MAX_ENTRIES |
3717 | ||
071bc923 WD |
3718 | Maximum number of entries in the hash table that is used |
3719 | internally to store the environment settings. The default | |
3720 | setting is supposed to be generous and should work in most | |
3721 | cases. This setting can be used to tune behaviour; see | |
3722 | lib/hashtable.c for details. | |
ea882baf | 3723 | |
2598090b JH |
3724 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
3725 | - CONFIG_ENV_FLAGS_LIST_STATIC | |
1bce2aeb | 3726 | Enable validation of the values given to environment variables when |
2598090b JH |
3727 | calling env set. Variables can be restricted to only decimal, |
3728 | hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, | |
3729 | the variables can also be restricted to IP address or MAC address. | |
3730 | ||
3731 | The format of the list is: | |
3732 | type_attribute = [s|d|x|b|i|m] | |
b445bbb4 JM |
3733 | access_attribute = [a|r|o|c] |
3734 | attributes = type_attribute[access_attribute] | |
2598090b JH |
3735 | entry = variable_name[:attributes] |
3736 | list = entry[,list] | |
3737 | ||
3738 | The type attributes are: | |
3739 | s - String (default) | |
3740 | d - Decimal | |
3741 | x - Hexadecimal | |
3742 | b - Boolean ([1yYtT|0nNfF]) | |
3743 | i - IP address | |
3744 | m - MAC address | |
3745 | ||
267541f7 JH |
3746 | The access attributes are: |
3747 | a - Any (default) | |
3748 | r - Read-only | |
3749 | o - Write-once | |
3750 | c - Change-default | |
3751 | ||
2598090b JH |
3752 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
3753 | Define this to a list (string) to define the ".flags" | |
b445bbb4 | 3754 | environment variable in the default or embedded environment. |
2598090b JH |
3755 | |
3756 | - CONFIG_ENV_FLAGS_LIST_STATIC | |
3757 | Define this to a list (string) to define validation that | |
3758 | should be done if an entry is not found in the ".flags" | |
3759 | environment variable. To override a setting in the static | |
3760 | list, simply add an entry for the same variable name to the | |
3761 | ".flags" variable. | |
3762 | ||
bdf1fe4e JH |
3763 | If CONFIG_REGEX is defined, the variable_name above is evaluated as a |
3764 | regular expression. This allows multiple variables to define the same | |
3765 | flags without explicitly listing them for each variable. | |
3766 | ||
267541f7 JH |
3767 | - CONFIG_ENV_ACCESS_IGNORE_FORCE |
3768 | If defined, don't allow the -f switch to env set override variable | |
3769 | access flags. | |
3770 | ||
0b1b60c7 LV |
3771 | - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) |
3772 | This is set by OMAP boards for the max time that reset should | |
3773 | be asserted. See doc/README.omap-reset-time for details on how | |
b445bbb4 | 3774 | the value can be calculated on a given board. |
632efa74 | 3775 | |
0d296cc2 GB |
3776 | - CONFIG_USE_STDINT |
3777 | If stdint.h is available with your toolchain you can define this | |
3778 | option to enable it. You can provide option 'USE_STDINT=1' when | |
3779 | building U-Boot to enable this. | |
3780 | ||
c609719b WD |
3781 | The following definitions that deal with the placement and management |
3782 | of environment data (variable area); in general, we support the | |
3783 | following configurations: | |
3784 | ||
c3eb3fe4 MF |
3785 | - CONFIG_BUILD_ENVCRC: |
3786 | ||
3787 | Builds up envcrc with the target environment so that external utils | |
3788 | may easily extract it and embed it in final U-Boot images. | |
3789 | ||
5a1aceb0 | 3790 | - CONFIG_ENV_IS_IN_FLASH: |
c609719b WD |
3791 | |
3792 | Define this if the environment is in flash memory. | |
3793 | ||
3794 | a) The environment occupies one whole flash sector, which is | |
3795 | "embedded" in the text segment with the U-Boot code. This | |
3796 | happens usually with "bottom boot sector" or "top boot | |
3797 | sector" type flash chips, which have several smaller | |
3798 | sectors at the start or the end. For instance, such a | |
3799 | layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In | |
3800 | such a case you would place the environment in one of the | |
3801 | 4 kB sectors - with U-Boot code before and after it. With | |
3802 | "top boot sector" type flash chips, you would put the | |
3803 | environment in one of the last sectors, leaving a gap | |
3804 | between U-Boot and the environment. | |
3805 | ||
0e8d1586 | 3806 | - CONFIG_ENV_OFFSET: |
c609719b WD |
3807 | |
3808 | Offset of environment data (variable area) to the | |
3809 | beginning of flash memory; for instance, with bottom boot | |
3810 | type flash chips the second sector can be used: the offset | |
3811 | for this sector is given here. | |
3812 | ||
6d0f6bcf | 3813 | CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. |
c609719b | 3814 | |
0e8d1586 | 3815 | - CONFIG_ENV_ADDR: |
c609719b WD |
3816 | |
3817 | This is just another way to specify the start address of | |
3818 | the flash sector containing the environment (instead of | |
0e8d1586 | 3819 | CONFIG_ENV_OFFSET). |
c609719b | 3820 | |
0e8d1586 | 3821 | - CONFIG_ENV_SECT_SIZE: |
c609719b WD |
3822 | |
3823 | Size of the sector containing the environment. | |
3824 | ||
3825 | ||
3826 | b) Sometimes flash chips have few, equal sized, BIG sectors. | |
3827 | In such a case you don't want to spend a whole sector for | |
3828 | the environment. | |
3829 | ||
0e8d1586 | 3830 | - CONFIG_ENV_SIZE: |
c609719b | 3831 | |
5a1aceb0 | 3832 | If you use this in combination with CONFIG_ENV_IS_IN_FLASH |
0e8d1586 | 3833 | and CONFIG_ENV_SECT_SIZE, you can specify to use only a part |
c609719b WD |
3834 | of this flash sector for the environment. This saves |
3835 | memory for the RAM copy of the environment. | |
3836 | ||
3837 | It may also save flash memory if you decide to use this | |
3838 | when your environment is "embedded" within U-Boot code, | |
3839 | since then the remainder of the flash sector could be used | |
3840 | for U-Boot code. It should be pointed out that this is | |
3841 | STRONGLY DISCOURAGED from a robustness point of view: | |
3842 | updating the environment in flash makes it always | |
3843 | necessary to erase the WHOLE sector. If something goes | |
3844 | wrong before the contents has been restored from a copy in | |
3845 | RAM, your target system will be dead. | |
3846 | ||
0e8d1586 JCPV |
3847 | - CONFIG_ENV_ADDR_REDUND |
3848 | CONFIG_ENV_SIZE_REDUND | |
c609719b | 3849 | |
43d9616c | 3850 | These settings describe a second storage area used to hold |
11ccc33f | 3851 | a redundant copy of the environment data, so that there is |
3e38691e | 3852 | a valid backup copy in case there is a power failure during |
43d9616c | 3853 | a "saveenv" operation. |
c609719b WD |
3854 | |
3855 | BE CAREFUL! Any changes to the flash layout, and some changes to the | |
3856 | source code will make it necessary to adapt <board>/u-boot.lds* | |
3857 | accordingly! | |
3858 | ||
3859 | ||
9314cee6 | 3860 | - CONFIG_ENV_IS_IN_NVRAM: |
c609719b WD |
3861 | |
3862 | Define this if you have some non-volatile memory device | |
3863 | (NVRAM, battery buffered SRAM) which you want to use for the | |
3864 | environment. | |
3865 | ||
0e8d1586 JCPV |
3866 | - CONFIG_ENV_ADDR: |
3867 | - CONFIG_ENV_SIZE: | |
c609719b | 3868 | |
11ccc33f | 3869 | These two #defines are used to determine the memory area you |
c609719b WD |
3870 | want to use for environment. It is assumed that this memory |
3871 | can just be read and written to, without any special | |
3872 | provision. | |
3873 | ||
3874 | BE CAREFUL! The first access to the environment happens quite early | |
b445bbb4 | 3875 | in U-Boot initialization (when we try to get the setting of for the |
11ccc33f | 3876 | console baudrate). You *MUST* have mapped your NVRAM area then, or |
c609719b WD |
3877 | U-Boot will hang. |
3878 | ||
3879 | Please note that even with NVRAM we still use a copy of the | |
3880 | environment in RAM: we could work on NVRAM directly, but we want to | |
3881 | keep settings there always unmodified except somebody uses "saveenv" | |
3882 | to save the current settings. | |
3883 | ||
3884 | ||
bb1f8b4f | 3885 | - CONFIG_ENV_IS_IN_EEPROM: |
c609719b WD |
3886 | |
3887 | Use this if you have an EEPROM or similar serial access | |
3888 | device and a driver for it. | |
3889 | ||
0e8d1586 JCPV |
3890 | - CONFIG_ENV_OFFSET: |
3891 | - CONFIG_ENV_SIZE: | |
c609719b WD |
3892 | |
3893 | These two #defines specify the offset and size of the | |
3894 | environment area within the total memory of your EEPROM. | |
3895 | ||
6d0f6bcf | 3896 | - CONFIG_SYS_I2C_EEPROM_ADDR: |
c609719b WD |
3897 | If defined, specified the chip address of the EEPROM device. |
3898 | The default address is zero. | |
3899 | ||
189d257b CG |
3900 | - CONFIG_SYS_I2C_EEPROM_BUS: |
3901 | If defined, specified the i2c bus of the EEPROM device. | |
3902 | ||
6d0f6bcf | 3903 | - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: |
c609719b WD |
3904 | If defined, the number of bits used to address bytes in a |
3905 | single page in the EEPROM device. A 64 byte page, for example | |
3906 | would require six bits. | |
3907 | ||
6d0f6bcf | 3908 | - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: |
c609719b | 3909 | If defined, the number of milliseconds to delay between |
ba56f625 | 3910 | page writes. The default is zero milliseconds. |
c609719b | 3911 | |
6d0f6bcf | 3912 | - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: |
c609719b WD |
3913 | The length in bytes of the EEPROM memory array address. Note |
3914 | that this is NOT the chip address length! | |
3915 | ||
6d0f6bcf | 3916 | - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: |
5cf91d6b WD |
3917 | EEPROM chips that implement "address overflow" are ones |
3918 | like Catalyst 24WC04/08/16 which has 9/10/11 bits of | |
3919 | address and the extra bits end up in the "chip address" bit | |
3920 | slots. This makes a 24WC08 (1Kbyte) chip look like four 256 | |
3921 | byte chips. | |
3922 | ||
3923 | Note that we consider the length of the address field to | |
3924 | still be one byte because the extra address bits are hidden | |
3925 | in the chip address. | |
3926 | ||
6d0f6bcf | 3927 | - CONFIG_SYS_EEPROM_SIZE: |
c609719b WD |
3928 | The size in bytes of the EEPROM device. |
3929 | ||
548738b4 HS |
3930 | - CONFIG_ENV_EEPROM_IS_ON_I2C |
3931 | define this, if you have I2C and SPI activated, and your | |
3932 | EEPROM, which holds the environment, is on the I2C bus. | |
3933 | ||
3934 | - CONFIG_I2C_ENV_EEPROM_BUS | |
3935 | if you have an Environment on an EEPROM reached over | |
3936 | I2C muxes, you can define here, how to reach this | |
3937 | EEPROM. For example: | |
3938 | ||
ea818dbb | 3939 | #define CONFIG_I2C_ENV_EEPROM_BUS 1 |
548738b4 HS |
3940 | |
3941 | EEPROM which holds the environment, is reached over | |
3942 | a pca9547 i2c mux with address 0x70, channel 3. | |
c609719b | 3943 | |
057c849c | 3944 | - CONFIG_ENV_IS_IN_DATAFLASH: |
5779d8d9 | 3945 | |
d4ca31c4 | 3946 | Define this if you have a DataFlash memory device which you |
5779d8d9 WD |
3947 | want to use for the environment. |
3948 | ||
0e8d1586 JCPV |
3949 | - CONFIG_ENV_OFFSET: |
3950 | - CONFIG_ENV_ADDR: | |
3951 | - CONFIG_ENV_SIZE: | |
5779d8d9 WD |
3952 | |
3953 | These three #defines specify the offset and size of the | |
3954 | environment area within the total memory of your DataFlash placed | |
3955 | at the specified address. | |
3956 | ||
bd83b592 WJ |
3957 | - CONFIG_ENV_IS_IN_SPI_FLASH: |
3958 | ||
3959 | Define this if you have a SPI Flash memory device which you | |
3960 | want to use for the environment. | |
3961 | ||
3962 | - CONFIG_ENV_OFFSET: | |
3963 | - CONFIG_ENV_SIZE: | |
3964 | ||
3965 | These two #defines specify the offset and size of the | |
3966 | environment area within the SPI Flash. CONFIG_ENV_OFFSET must be | |
3967 | aligned to an erase sector boundary. | |
3968 | ||
3969 | - CONFIG_ENV_SECT_SIZE: | |
3970 | ||
3971 | Define the SPI flash's sector size. | |
3972 | ||
3973 | - CONFIG_ENV_OFFSET_REDUND (optional): | |
3974 | ||
3975 | This setting describes a second storage area of CONFIG_ENV_SIZE | |
3976 | size used to hold a redundant copy of the environment data, so | |
3977 | that there is a valid backup copy in case there is a power failure | |
9dd05fb8 | 3978 | during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be |
bd83b592 WJ |
3979 | aligned to an erase sector boundary. |
3980 | ||
3981 | - CONFIG_ENV_SPI_BUS (optional): | |
3982 | - CONFIG_ENV_SPI_CS (optional): | |
3983 | ||
3984 | Define the SPI bus and chip select. If not defined they will be 0. | |
3985 | ||
3986 | - CONFIG_ENV_SPI_MAX_HZ (optional): | |
3987 | ||
3988 | Define the SPI max work clock. If not defined then use 1MHz. | |
3989 | ||
3990 | - CONFIG_ENV_SPI_MODE (optional): | |
3991 | ||
3992 | Define the SPI work mode. If not defined then use SPI_MODE_3. | |
3993 | ||
0a85a9e7 LG |
3994 | - CONFIG_ENV_IS_IN_REMOTE: |
3995 | ||
3996 | Define this if you have a remote memory space which you | |
3997 | want to use for the local device's environment. | |
3998 | ||
3999 | - CONFIG_ENV_ADDR: | |
4000 | - CONFIG_ENV_SIZE: | |
4001 | ||
4002 | These two #defines specify the address and size of the | |
4003 | environment area within the remote memory space. The | |
4004 | local device can get the environment from remote memory | |
fc54c7fa | 4005 | space by SRIO or PCIE links. |
0a85a9e7 LG |
4006 | |
4007 | BE CAREFUL! For some special cases, the local device can not use | |
4008 | "saveenv" command. For example, the local device will get the | |
fc54c7fa LG |
4009 | environment stored in a remote NOR flash by SRIO or PCIE link, |
4010 | but it can not erase, write this NOR flash by SRIO or PCIE interface. | |
0a85a9e7 | 4011 | |
51bfee19 | 4012 | - CONFIG_ENV_IS_IN_NAND: |
13a5695b WD |
4013 | |
4014 | Define this if you have a NAND device which you want to use | |
4015 | for the environment. | |
4016 | ||
0e8d1586 JCPV |
4017 | - CONFIG_ENV_OFFSET: |
4018 | - CONFIG_ENV_SIZE: | |
13a5695b WD |
4019 | |
4020 | These two #defines specify the offset and size of the environment | |
fdd813de SW |
4021 | area within the first NAND device. CONFIG_ENV_OFFSET must be |
4022 | aligned to an erase block boundary. | |
5779d8d9 | 4023 | |
fdd813de | 4024 | - CONFIG_ENV_OFFSET_REDUND (optional): |
e443c944 | 4025 | |
0e8d1586 | 4026 | This setting describes a second storage area of CONFIG_ENV_SIZE |
fdd813de SW |
4027 | size used to hold a redundant copy of the environment data, so |
4028 | that there is a valid backup copy in case there is a power failure | |
9dd05fb8 | 4029 | during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be |
fdd813de SW |
4030 | aligned to an erase block boundary. |
4031 | ||
4032 | - CONFIG_ENV_RANGE (optional): | |
4033 | ||
4034 | Specifies the length of the region in which the environment | |
4035 | can be written. This should be a multiple of the NAND device's | |
4036 | block size. Specifying a range with more erase blocks than | |
4037 | are needed to hold CONFIG_ENV_SIZE allows bad blocks within | |
4038 | the range to be avoided. | |
4039 | ||
4040 | - CONFIG_ENV_OFFSET_OOB (optional): | |
4041 | ||
4042 | Enables support for dynamically retrieving the offset of the | |
4043 | environment from block zero's out-of-band data. The | |
4044 | "nand env.oob" command can be used to record this offset. | |
4045 | Currently, CONFIG_ENV_OFFSET_REDUND is not supported when | |
4046 | using CONFIG_ENV_OFFSET_OOB. | |
e443c944 | 4047 | |
b74ab737 GL |
4048 | - CONFIG_NAND_ENV_DST |
4049 | ||
4050 | Defines address in RAM to which the nand_spl code should copy the | |
4051 | environment. If redundant environment is used, it will be copied to | |
4052 | CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. | |
4053 | ||
2b74433f JH |
4054 | - CONFIG_ENV_IS_IN_UBI: |
4055 | ||
4056 | Define this if you have an UBI volume that you want to use for the | |
4057 | environment. This has the benefit of wear-leveling the environment | |
4058 | accesses, which is important on NAND. | |
4059 | ||
4060 | - CONFIG_ENV_UBI_PART: | |
4061 | ||
4062 | Define this to a string that is the mtd partition containing the UBI. | |
4063 | ||
4064 | - CONFIG_ENV_UBI_VOLUME: | |
4065 | ||
4066 | Define this to the name of the volume that you want to store the | |
4067 | environment in. | |
4068 | ||
785881f7 JH |
4069 | - CONFIG_ENV_UBI_VOLUME_REDUND: |
4070 | ||
4071 | Define this to the name of another volume to store a second copy of | |
4072 | the environment in. This will enable redundant environments in UBI. | |
4073 | It is assumed that both volumes are in the same MTD partition. | |
4074 | ||
2b74433f JH |
4075 | - CONFIG_UBI_SILENCE_MSG |
4076 | - CONFIG_UBIFS_SILENCE_MSG | |
4077 | ||
4078 | You will probably want to define these to avoid a really noisy system | |
4079 | when storing the env in UBI. | |
4080 | ||
d1db76f1 WJ |
4081 | - CONFIG_ENV_IS_IN_FAT: |
4082 | Define this if you want to use the FAT file system for the environment. | |
4083 | ||
4084 | - FAT_ENV_INTERFACE: | |
4085 | ||
4086 | Define this to a string that is the name of the block device. | |
4087 | ||
41987784 | 4088 | - FAT_ENV_DEVICE_AND_PART: |
d1db76f1 WJ |
4089 | |
4090 | Define this to a string to specify the partition of the device. It can | |
4091 | be as following: | |
4092 | ||
4093 | "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) | |
4094 | - "D:P": device D partition P. Error occurs if device D has no | |
4095 | partition table. | |
4096 | - "D:0": device D. | |
4097 | - "D" or "D:": device D partition 1 if device D has partition | |
4098 | table, or the whole device D if has no partition | |
4099 | table. | |
4100 | - "D:auto": first partition in device D with bootable flag set. | |
b445bbb4 | 4101 | If none, first valid partition in device D. If no |
d1db76f1 WJ |
4102 | partition table then means device D. |
4103 | ||
4104 | - FAT_ENV_FILE: | |
4105 | ||
4106 | It's a string of the FAT file name. This file use to store the | |
b445bbb4 | 4107 | environment. |
d1db76f1 WJ |
4108 | |
4109 | - CONFIG_FAT_WRITE: | |
b445bbb4 | 4110 | This should be defined. Otherwise it cannot save the environment file. |
d1db76f1 | 4111 | |
06e4ae5f SW |
4112 | - CONFIG_ENV_IS_IN_MMC: |
4113 | ||
4114 | Define this if you have an MMC device which you want to use for the | |
4115 | environment. | |
4116 | ||
4117 | - CONFIG_SYS_MMC_ENV_DEV: | |
4118 | ||
4119 | Specifies which MMC device the environment is stored in. | |
4120 | ||
4121 | - CONFIG_SYS_MMC_ENV_PART (optional): | |
4122 | ||
4123 | Specifies which MMC partition the environment is stored in. If not | |
4124 | set, defaults to partition 0, the user area. Common values might be | |
4125 | 1 (first MMC boot partition), 2 (second MMC boot partition). | |
4126 | ||
4127 | - CONFIG_ENV_OFFSET: | |
4128 | - CONFIG_ENV_SIZE: | |
4129 | ||
4130 | These two #defines specify the offset and size of the environment | |
4131 | area within the specified MMC device. | |
4132 | ||
5c088ee8 SW |
4133 | If offset is positive (the usual case), it is treated as relative to |
4134 | the start of the MMC partition. If offset is negative, it is treated | |
4135 | as relative to the end of the MMC partition. This can be useful if | |
4136 | your board may be fitted with different MMC devices, which have | |
4137 | different sizes for the MMC partitions, and you always want the | |
4138 | environment placed at the very end of the partition, to leave the | |
4139 | maximum possible space before it, to store other data. | |
4140 | ||
06e4ae5f SW |
4141 | These two values are in units of bytes, but must be aligned to an |
4142 | MMC sector boundary. | |
4143 | ||
4144 | - CONFIG_ENV_OFFSET_REDUND (optional): | |
4145 | ||
4146 | Specifies a second storage area, of CONFIG_ENV_SIZE size, used to | |
4147 | hold a redundant copy of the environment data. This provides a | |
4148 | valid backup copy in case the other copy is corrupted, e.g. due | |
4149 | to a power failure during a "saveenv" operation. | |
4150 | ||
5c088ee8 SW |
4151 | This value may also be positive or negative; this is handled in the |
4152 | same way as CONFIG_ENV_OFFSET. | |
4153 | ||
06e4ae5f SW |
4154 | This value is also in units of bytes, but must also be aligned to |
4155 | an MMC sector boundary. | |
4156 | ||
4157 | - CONFIG_ENV_SIZE_REDUND (optional): | |
4158 | ||
4159 | This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is | |
4160 | set. If this value is set, it must be set to the same value as | |
4161 | CONFIG_ENV_SIZE. | |
4162 | ||
6d0f6bcf | 4163 | - CONFIG_SYS_SPI_INIT_OFFSET |
c609719b WD |
4164 | |
4165 | Defines offset to the initial SPI buffer area in DPRAM. The | |
4166 | area is used at an early stage (ROM part) if the environment | |
4167 | is configured to reside in the SPI EEPROM: We need a 520 byte | |
4168 | scratch DPRAM area. It is used between the two initialization | |
4169 | calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems | |
4170 | to be a good choice since it makes it far enough from the | |
4171 | start of the data area as well as from the stack pointer. | |
4172 | ||
e881cb56 | 4173 | Please note that the environment is read-only until the monitor |
c609719b | 4174 | has been relocated to RAM and a RAM copy of the environment has been |
cdb74977 | 4175 | created; also, when using EEPROM you will have to use getenv_f() |
c609719b WD |
4176 | until then to read environment variables. |
4177 | ||
85ec0bcc WD |
4178 | The environment is protected by a CRC32 checksum. Before the monitor |
4179 | is relocated into RAM, as a result of a bad CRC you will be working | |
4180 | with the compiled-in default environment - *silently*!!! [This is | |
4181 | necessary, because the first environment variable we need is the | |
4182 | "baudrate" setting for the console - if we have a bad CRC, we don't | |
4183 | have any device yet where we could complain.] | |
c609719b WD |
4184 | |
4185 | Note: once the monitor has been relocated, then it will complain if | |
4186 | the default environment is used; a new CRC is computed as soon as you | |
85ec0bcc | 4187 | use the "saveenv" command to store a valid environment. |
c609719b | 4188 | |
6d0f6bcf | 4189 | - CONFIG_SYS_FAULT_ECHO_LINK_DOWN: |
42d1f039 | 4190 | Echo the inverted Ethernet link state to the fault LED. |
fc3e2165 | 4191 | |
6d0f6bcf | 4192 | Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR |
fc3e2165 WD |
4193 | also needs to be defined. |
4194 | ||
6d0f6bcf | 4195 | - CONFIG_SYS_FAULT_MII_ADDR: |
42d1f039 | 4196 | MII address of the PHY to check for the Ethernet link state. |
c609719b | 4197 | |
f5675aa5 RM |
4198 | - CONFIG_NS16550_MIN_FUNCTIONS: |
4199 | Define this if you desire to only have use of the NS16550_init | |
4200 | and NS16550_putc functions for the serial driver located at | |
4201 | drivers/serial/ns16550.c. This option is useful for saving | |
4202 | space for already greatly restricted images, including but not | |
4203 | limited to NAND_SPL configurations. | |
4204 | ||
b2b92f53 SG |
4205 | - CONFIG_DISPLAY_BOARDINFO |
4206 | Display information about the board that U-Boot is running on | |
4207 | when U-Boot starts up. The board function checkboard() is called | |
4208 | to do this. | |
4209 | ||
e2e3e2b1 SG |
4210 | - CONFIG_DISPLAY_BOARDINFO_LATE |
4211 | Similar to the previous option, but display this information | |
4212 | later, once stdio is running and output goes to the LCD, if | |
4213 | present. | |
4214 | ||
feb85801 SS |
4215 | - CONFIG_BOARD_SIZE_LIMIT: |
4216 | Maximum size of the U-Boot image. When defined, the | |
4217 | build system checks that the actual size does not | |
4218 | exceed it. | |
4219 | ||
c609719b | 4220 | Low Level (hardware related) configuration options: |
dc7c9a1a | 4221 | --------------------------------------------------- |
c609719b | 4222 | |
6d0f6bcf | 4223 | - CONFIG_SYS_CACHELINE_SIZE: |
c609719b WD |
4224 | Cache Line Size of the CPU. |
4225 | ||
6d0f6bcf | 4226 | - CONFIG_SYS_DEFAULT_IMMR: |
c609719b | 4227 | Default address of the IMMR after system reset. |
2535d602 | 4228 | |
42d1f039 WD |
4229 | Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, |
4230 | and RPXsuper) to be able to adjust the position of | |
4231 | the IMMR register after a reset. | |
c609719b | 4232 | |
e46fedfe TT |
4233 | - CONFIG_SYS_CCSRBAR_DEFAULT: |
4234 | Default (power-on reset) physical address of CCSR on Freescale | |
4235 | PowerPC SOCs. | |
4236 | ||
4237 | - CONFIG_SYS_CCSRBAR: | |
4238 | Virtual address of CCSR. On a 32-bit build, this is typically | |
4239 | the same value as CONFIG_SYS_CCSRBAR_DEFAULT. | |
4240 | ||
4241 | CONFIG_SYS_DEFAULT_IMMR must also be set to this value, | |
4242 | for cross-platform code that uses that macro instead. | |
4243 | ||
4244 | - CONFIG_SYS_CCSRBAR_PHYS: | |
4245 | Physical address of CCSR. CCSR can be relocated to a new | |
4246 | physical address, if desired. In this case, this macro should | |
c0f40859 | 4247 | be set to that address. Otherwise, it should be set to the |
e46fedfe TT |
4248 | same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR |
4249 | is typically relocated on 36-bit builds. It is recommended | |
4250 | that this macro be defined via the _HIGH and _LOW macros: | |
4251 | ||
4252 | #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH | |
4253 | * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) | |
4254 | ||
4255 | - CONFIG_SYS_CCSRBAR_PHYS_HIGH: | |
4cf2609b WD |
4256 | Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically |
4257 | either 0 (32-bit build) or 0xF (36-bit build). This macro is | |
e46fedfe TT |
4258 | used in assembly code, so it must not contain typecasts or |
4259 | integer size suffixes (e.g. "ULL"). | |
4260 | ||
4261 | - CONFIG_SYS_CCSRBAR_PHYS_LOW: | |
4262 | Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is | |
4263 | used in assembly code, so it must not contain typecasts or | |
4264 | integer size suffixes (e.g. "ULL"). | |
4265 | ||
4266 | - CONFIG_SYS_CCSR_DO_NOT_RELOCATE: | |
4267 | If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be | |
4268 | forced to a value that ensures that CCSR is not relocated. | |
4269 | ||
7f6c2cbc | 4270 | - Floppy Disk Support: |
6d0f6bcf | 4271 | CONFIG_SYS_FDC_DRIVE_NUMBER |
7f6c2cbc WD |
4272 | |
4273 | the default drive number (default value 0) | |
4274 | ||
6d0f6bcf | 4275 | CONFIG_SYS_ISA_IO_STRIDE |
7f6c2cbc | 4276 | |
11ccc33f | 4277 | defines the spacing between FDC chipset registers |
7f6c2cbc WD |
4278 | (default value 1) |
4279 | ||
6d0f6bcf | 4280 | CONFIG_SYS_ISA_IO_OFFSET |
7f6c2cbc | 4281 | |
43d9616c WD |
4282 | defines the offset of register from address. It |
4283 | depends on which part of the data bus is connected to | |
11ccc33f | 4284 | the FDC chipset. (default value 0) |
7f6c2cbc | 4285 | |
6d0f6bcf JCPV |
4286 | If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and |
4287 | CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their | |
43d9616c | 4288 | default value. |
7f6c2cbc | 4289 | |
6d0f6bcf | 4290 | if CONFIG_SYS_FDC_HW_INIT is defined, then the function |
43d9616c WD |
4291 | fdc_hw_init() is called at the beginning of the FDC |
4292 | setup. fdc_hw_init() must be provided by the board | |
b445bbb4 | 4293 | source code. It is used to make hardware-dependent |
43d9616c | 4294 | initializations. |
7f6c2cbc | 4295 | |
0abddf82 ML |
4296 | - CONFIG_IDE_AHB: |
4297 | Most IDE controllers were designed to be connected with PCI | |
4298 | interface. Only few of them were designed for AHB interface. | |
4299 | When software is doing ATA command and data transfer to | |
4300 | IDE devices through IDE-AHB controller, some additional | |
4301 | registers accessing to these kind of IDE-AHB controller | |
b445bbb4 | 4302 | is required. |
0abddf82 | 4303 | |
6d0f6bcf | 4304 | - CONFIG_SYS_IMMR: Physical address of the Internal Memory. |
efe2a4d5 | 4305 | DO NOT CHANGE unless you know exactly what you're |
25d6712a | 4306 | doing! (11-4) [MPC8xx/82xx systems only] |
c609719b | 4307 | |
6d0f6bcf | 4308 | - CONFIG_SYS_INIT_RAM_ADDR: |
c609719b | 4309 | |
7152b1d0 | 4310 | Start address of memory area that can be used for |
c609719b WD |
4311 | initial data and stack; please note that this must be |
4312 | writable memory that is working WITHOUT special | |
4313 | initialization, i. e. you CANNOT use normal RAM which | |
4314 | will become available only after programming the | |
4315 | memory controller and running certain initialization | |
4316 | sequences. | |
4317 | ||
4318 | U-Boot uses the following memory types: | |
4319 | - MPC8xx and MPC8260: IMMR (internal memory of the CPU) | |
4320 | - MPC824X: data cache | |
4321 | - PPC4xx: data cache | |
4322 | ||
6d0f6bcf | 4323 | - CONFIG_SYS_GBL_DATA_OFFSET: |
c609719b WD |
4324 | |
4325 | Offset of the initial data structure in the memory | |
6d0f6bcf JCPV |
4326 | area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually |
4327 | CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial | |
c609719b | 4328 | data is located at the end of the available space |
553f0982 | 4329 | (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - |
acd51f9d | 4330 | GENERATED_GBL_DATA_SIZE), and the initial stack is just |
6d0f6bcf JCPV |
4331 | below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + |
4332 | CONFIG_SYS_GBL_DATA_OFFSET) downward. | |
c609719b WD |
4333 | |
4334 | Note: | |
4335 | On the MPC824X (or other systems that use the data | |
4336 | cache for initial memory) the address chosen for | |
6d0f6bcf | 4337 | CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must |
c609719b WD |
4338 | point to an otherwise UNUSED address space between |
4339 | the top of RAM and the start of the PCI space. | |
4340 | ||
6d0f6bcf | 4341 | - CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) |
c609719b | 4342 | |
6d0f6bcf | 4343 | - CONFIG_SYS_SYPCR: System Protection Control (11-9) |
c609719b | 4344 | |
6d0f6bcf | 4345 | - CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) |
c609719b | 4346 | |
6d0f6bcf | 4347 | - CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) |
c609719b | 4348 | |
6d0f6bcf | 4349 | - CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) |
c609719b | 4350 | |
6d0f6bcf | 4351 | - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) |
c609719b | 4352 | |
6d0f6bcf | 4353 | - CONFIG_SYS_OR_TIMING_SDRAM: |
c609719b WD |
4354 | SDRAM timing |
4355 | ||
6d0f6bcf | 4356 | - CONFIG_SYS_MAMR_PTA: |
c609719b WD |
4357 | periodic timer for refresh |
4358 | ||
6d0f6bcf | 4359 | - CONFIG_SYS_DER: Debug Event Register (37-47) |
c609719b | 4360 | |
6d0f6bcf JCPV |
4361 | - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, |
4362 | CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, | |
4363 | CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, | |
4364 | CONFIG_SYS_BR1_PRELIM: | |
c609719b WD |
4365 | Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) |
4366 | ||
4367 | - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, | |
6d0f6bcf JCPV |
4368 | CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, |
4369 | CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: | |
c609719b WD |
4370 | Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) |
4371 | ||
6d0f6bcf JCPV |
4372 | - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, |
4373 | CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: | |
c609719b WD |
4374 | Machine Mode Register and Memory Periodic Timer |
4375 | Prescaler definitions (SDRAM timing) | |
4376 | ||
6d0f6bcf | 4377 | - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: |
c609719b WD |
4378 | enable I2C microcode relocation patch (MPC8xx); |
4379 | define relocation offset in DPRAM [DSP2] | |
4380 | ||
6d0f6bcf | 4381 | - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: |
b423d055 HS |
4382 | enable SMC microcode relocation patch (MPC8xx); |
4383 | define relocation offset in DPRAM [SMC1] | |
4384 | ||
6d0f6bcf | 4385 | - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: |
c609719b WD |
4386 | enable SPI microcode relocation patch (MPC8xx); |
4387 | define relocation offset in DPRAM [SCC4] | |
4388 | ||
6d0f6bcf | 4389 | - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) |
43d9616c WD |
4390 | Offset of the bootmode word in DPRAM used by post |
4391 | (Power On Self Tests). This definition overrides | |
4392 | #define'd default value in commproc.h resp. | |
4393 | cpm_8260.h. | |
ea909b76 | 4394 | |
6d0f6bcf JCPV |
4395 | - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, |
4396 | CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, | |
4397 | CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, | |
4398 | CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, | |
4399 | CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, | |
4400 | CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, | |
4401 | CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, | |
4402 | CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) | |
a47a12be | 4403 | Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. |
5d232d0e | 4404 | |
9cacf4fc DE |
4405 | - CONFIG_PCI_DISABLE_PCIE: |
4406 | Disable PCI-Express on systems where it is supported but not | |
4407 | required. | |
4408 | ||
69fd2d3b | 4409 | - CONFIG_PCI_ENUM_ONLY |
b445bbb4 | 4410 | Only scan through and get the devices on the buses. |
69fd2d3b AS |
4411 | Don't do any setup work, presumably because someone or |
4412 | something has already done it, and we don't need to do it | |
4413 | a second time. Useful for platforms that are pre-booted | |
4414 | by coreboot or similar. | |
4415 | ||
842033e6 GJ |
4416 | - CONFIG_PCI_INDIRECT_BRIDGE: |
4417 | Enable support for indirect PCI bridges. | |
4418 | ||
a09b9b68 KG |
4419 | - CONFIG_SYS_SRIO: |
4420 | Chip has SRIO or not | |
4421 | ||
4422 | - CONFIG_SRIO1: | |
4423 | Board has SRIO 1 port available | |
4424 | ||
4425 | - CONFIG_SRIO2: | |
4426 | Board has SRIO 2 port available | |
4427 | ||
c8b28152 LG |
4428 | - CONFIG_SRIO_PCIE_BOOT_MASTER |
4429 | Board can support master function for Boot from SRIO and PCIE | |
4430 | ||
a09b9b68 KG |
4431 | - CONFIG_SYS_SRIOn_MEM_VIRT: |
4432 | Virtual Address of SRIO port 'n' memory region | |
4433 | ||
4434 | - CONFIG_SYS_SRIOn_MEM_PHYS: | |
4435 | Physical Address of SRIO port 'n' memory region | |
4436 | ||
4437 | - CONFIG_SYS_SRIOn_MEM_SIZE: | |
4438 | Size of SRIO port 'n' memory region | |
4439 | ||
66bd1846 FE |
4440 | - CONFIG_SYS_NAND_BUSWIDTH_16BIT |
4441 | Defined to tell the NAND controller that the NAND chip is using | |
4442 | a 16 bit bus. | |
4443 | Not all NAND drivers use this symbol. | |
a430e916 | 4444 | Example of drivers that use it: |
66bd1846 | 4445 | - drivers/mtd/nand/ndfc.c |
a430e916 | 4446 | - drivers/mtd/nand/mxc_nand.c |
eced4626 AW |
4447 | |
4448 | - CONFIG_SYS_NDFC_EBC0_CFG | |
4449 | Sets the EBC0_CFG register for the NDFC. If not defined | |
4450 | a default value will be used. | |
4451 | ||
bb99ad6d | 4452 | - CONFIG_SPD_EEPROM |
218ca724 WD |
4453 | Get DDR timing information from an I2C EEPROM. Common |
4454 | with pluggable memory modules such as SODIMMs | |
4455 | ||
bb99ad6d BW |
4456 | SPD_EEPROM_ADDRESS |
4457 | I2C address of the SPD EEPROM | |
4458 | ||
6d0f6bcf | 4459 | - CONFIG_SYS_SPD_BUS_NUM |
218ca724 WD |
4460 | If SPD EEPROM is on an I2C bus other than the first |
4461 | one, specify here. Note that the value must resolve | |
4462 | to something your driver can deal with. | |
bb99ad6d | 4463 | |
1b3e3c4f YS |
4464 | - CONFIG_SYS_DDR_RAW_TIMING |
4465 | Get DDR timing information from other than SPD. Common with | |
4466 | soldered DDR chips onboard without SPD. DDR raw timing | |
4467 | parameters are extracted from datasheet and hard-coded into | |
4468 | header files or board specific files. | |
4469 | ||
6f5e1dc5 YS |
4470 | - CONFIG_FSL_DDR_INTERACTIVE |
4471 | Enable interactive DDR debugging. See doc/README.fsl-ddr. | |
4472 | ||
e32d59a2 YS |
4473 | - CONFIG_FSL_DDR_SYNC_REFRESH |
4474 | Enable sync of refresh for multiple controllers. | |
4475 | ||
4516ff81 YS |
4476 | - CONFIG_FSL_DDR_BIST |
4477 | Enable built-in memory test for Freescale DDR controllers. | |
4478 | ||
6d0f6bcf | 4479 | - CONFIG_SYS_83XX_DDR_USES_CS0 |
218ca724 WD |
4480 | Only for 83xx systems. If specified, then DDR should |
4481 | be configured using CS0 and CS1 instead of CS2 and CS3. | |
2ad6b513 | 4482 | |
c26e454d WD |
4483 | - CONFIG_ETHER_ON_FEC[12] |
4484 | Define to enable FEC[12] on a 8xx series processor. | |
4485 | ||
4486 | - CONFIG_FEC[12]_PHY | |
4487 | Define to the hardcoded PHY address which corresponds | |
6e592385 WD |
4488 | to the given FEC; i. e. |
4489 | #define CONFIG_FEC1_PHY 4 | |
c26e454d WD |
4490 | means that the PHY with address 4 is connected to FEC1 |
4491 | ||
4492 | When set to -1, means to probe for first available. | |
4493 | ||
4494 | - CONFIG_FEC[12]_PHY_NORXERR | |
4495 | The PHY does not have a RXERR line (RMII only). | |
4496 | (so program the FEC to ignore it). | |
4497 | ||
4498 | - CONFIG_RMII | |
4499 | Enable RMII mode for all FECs. | |
4500 | Note that this is a global option, we can't | |
4501 | have one FEC in standard MII mode and another in RMII mode. | |
4502 | ||
5cf91d6b WD |
4503 | - CONFIG_CRC32_VERIFY |
4504 | Add a verify option to the crc32 command. | |
4505 | The syntax is: | |
4506 | ||
4507 | => crc32 -v <address> <count> <crc32> | |
4508 | ||
4509 | Where address/count indicate a memory area | |
4510 | and crc32 is the correct crc32 which the | |
4511 | area should have. | |
4512 | ||
56523f12 WD |
4513 | - CONFIG_LOOPW |
4514 | Add the "loopw" memory command. This only takes effect if | |
602ad3b3 | 4515 | the memory commands are activated globally (CONFIG_CMD_MEM). |
56523f12 | 4516 | |
7b466641 SR |
4517 | - CONFIG_MX_CYCLIC |
4518 | Add the "mdc" and "mwc" memory commands. These are cyclic | |
4519 | "md/mw" commands. | |
4520 | Examples: | |
4521 | ||
efe2a4d5 | 4522 | => mdc.b 10 4 500 |
7b466641 SR |
4523 | This command will print 4 bytes (10,11,12,13) each 500 ms. |
4524 | ||
efe2a4d5 | 4525 | => mwc.l 100 12345678 10 |
7b466641 SR |
4526 | This command will write 12345678 to address 100 all 10 ms. |
4527 | ||
efe2a4d5 | 4528 | This only takes effect if the memory commands are activated |
602ad3b3 | 4529 | globally (CONFIG_CMD_MEM). |
7b466641 | 4530 | |
8aa1a2d1 | 4531 | - CONFIG_SKIP_LOWLEVEL_INIT |
afc1ce82 | 4532 | [ARM, NDS32, MIPS only] If this variable is defined, then certain |
844f07d8 WD |
4533 | low level initializations (like setting up the memory |
4534 | controller) are omitted and/or U-Boot does not | |
4535 | relocate itself into RAM. | |
4536 | ||
4537 | Normally this variable MUST NOT be defined. The only | |
4538 | exception is when U-Boot is loaded (to RAM) by some | |
4539 | other boot loader or by a debugger which performs | |
4540 | these initializations itself. | |
8aa1a2d1 | 4541 | |
b5bd0982 SG |
4542 | - CONFIG_SKIP_LOWLEVEL_INIT_ONLY |
4543 | [ARM926EJ-S only] This allows just the call to lowlevel_init() | |
90211f77 | 4544 | to be skipped. The normal CP15 init (such as enabling the |
b5bd0982 SG |
4545 | instruction cache) is still performed. |
4546 | ||
401bb30b | 4547 | - CONFIG_SPL_BUILD |
df81238b ML |
4548 | Modifies the behaviour of start.S when compiling a loader |
4549 | that is executed before the actual U-Boot. E.g. when | |
4550 | compiling a NAND SPL. | |
400558b5 | 4551 | |
3aa29de0 YZ |
4552 | - CONFIG_TPL_BUILD |
4553 | Modifies the behaviour of start.S when compiling a loader | |
4554 | that is executed after the SPL and before the actual U-Boot. | |
4555 | It is loaded by the SPL. | |
4556 | ||
5df572f0 YZ |
4557 | - CONFIG_SYS_MPC85XX_NO_RESETVEC |
4558 | Only for 85xx systems. If this variable is specified, the section | |
4559 | .resetvec is not kept and the section .bootpg is placed in the | |
4560 | previous 4k of the .text section. | |
4561 | ||
4213fc29 SG |
4562 | - CONFIG_ARCH_MAP_SYSMEM |
4563 | Generally U-Boot (and in particular the md command) uses | |
4564 | effective address. It is therefore not necessary to regard | |
4565 | U-Boot address as virtual addresses that need to be translated | |
4566 | to physical addresses. However, sandbox requires this, since | |
4567 | it maintains its own little RAM buffer which contains all | |
4568 | addressable memory. This option causes some memory accesses | |
4569 | to be mapped through map_sysmem() / unmap_sysmem(). | |
4570 | ||
588a13f7 SG |
4571 | - CONFIG_X86_RESET_VECTOR |
4572 | If defined, the x86 reset vector code is included. This is not | |
4573 | needed when U-Boot is running from Coreboot. | |
b16f521a | 4574 | |
fc33705e MJ |
4575 | - CONFIG_SYS_MPUCLK |
4576 | Defines the MPU clock speed (in MHz). | |
4577 | ||
4578 | NOTE : currently only supported on AM335x platforms. | |
5b5ece9e | 4579 | |
16678eb4 HS |
4580 | - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: |
4581 | Enables the RTC32K OSC on AM33xx based plattforms | |
4582 | ||
999d7d32 KM |
4583 | - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE |
4584 | Option to disable subpage write in NAND driver | |
4585 | driver that uses this: | |
4586 | drivers/mtd/nand/davinci_nand.c | |
4587 | ||
f2717b47 TT |
4588 | Freescale QE/FMAN Firmware Support: |
4589 | ----------------------------------- | |
4590 | ||
4591 | The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the | |
4592 | loading of "firmware", which is encoded in the QE firmware binary format. | |
4593 | This firmware often needs to be loaded during U-Boot booting, so macros | |
4594 | are used to identify the storage device (NOR flash, SPI, etc) and the address | |
4595 | within that device. | |
4596 | ||
dcf1d774 ZQ |
4597 | - CONFIG_SYS_FMAN_FW_ADDR |
4598 | The address in the storage device where the FMAN microcode is located. The | |
4599 | meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro | |
4600 | is also specified. | |
4601 | ||
4602 | - CONFIG_SYS_QE_FW_ADDR | |
4603 | The address in the storage device where the QE microcode is located. The | |
f2717b47 TT |
4604 | meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro |
4605 | is also specified. | |
4606 | ||
4607 | - CONFIG_SYS_QE_FMAN_FW_LENGTH | |
4608 | The maximum possible size of the firmware. The firmware binary format | |
4609 | has a field that specifies the actual size of the firmware, but it | |
4610 | might not be possible to read any part of the firmware unless some | |
4611 | local storage is allocated to hold the entire firmware first. | |
4612 | ||
4613 | - CONFIG_SYS_QE_FMAN_FW_IN_NOR | |
4614 | Specifies that QE/FMAN firmware is located in NOR flash, mapped as | |
4615 | normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the | |
4616 | virtual address in NOR flash. | |
4617 | ||
4618 | - CONFIG_SYS_QE_FMAN_FW_IN_NAND | |
4619 | Specifies that QE/FMAN firmware is located in NAND flash. | |
4620 | CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. | |
4621 | ||
4622 | - CONFIG_SYS_QE_FMAN_FW_IN_MMC | |
4623 | Specifies that QE/FMAN firmware is located on the primary SD/MMC | |
4624 | device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. | |
4625 | ||
292dc6c5 LG |
4626 | - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE |
4627 | Specifies that QE/FMAN firmware is located in the remote (master) | |
4628 | memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which | |
fc54c7fa LG |
4629 | can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound |
4630 | window->master inbound window->master LAW->the ucode address in | |
4631 | master's memory space. | |
f2717b47 | 4632 | |
b940ca64 GR |
4633 | Freescale Layerscape Management Complex Firmware Support: |
4634 | --------------------------------------------------------- | |
4635 | The Freescale Layerscape Management Complex (MC) supports the loading of | |
4636 | "firmware". | |
4637 | This firmware often needs to be loaded during U-Boot booting, so macros | |
4638 | are used to identify the storage device (NOR flash, SPI, etc) and the address | |
4639 | within that device. | |
4640 | ||
4641 | - CONFIG_FSL_MC_ENET | |
4642 | Enable the MC driver for Layerscape SoCs. | |
4643 | ||
5c055089 PK |
4644 | Freescale Layerscape Debug Server Support: |
4645 | ------------------------------------------- | |
4646 | The Freescale Layerscape Debug Server Support supports the loading of | |
4647 | "Debug Server firmware" and triggering SP boot-rom. | |
4648 | This firmware often needs to be loaded during U-Boot booting. | |
4649 | ||
c0492141 YS |
4650 | - CONFIG_SYS_MC_RSV_MEM_ALIGN |
4651 | Define alignment of reserved memory MC requires | |
5c055089 | 4652 | |
f3f431a7 PK |
4653 | Reproducible builds |
4654 | ------------------- | |
4655 | ||
4656 | In order to achieve reproducible builds, timestamps used in the U-Boot build | |
4657 | process have to be set to a fixed value. | |
4658 | ||
4659 | This is done using the SOURCE_DATE_EPOCH environment variable. | |
4660 | SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration | |
4661 | option for U-Boot or an environment variable in U-Boot. | |
4662 | ||
4663 | SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. | |
4664 | ||
c609719b WD |
4665 | Building the Software: |
4666 | ====================== | |
4667 | ||
218ca724 WD |
4668 | Building U-Boot has been tested in several native build environments |
4669 | and in many different cross environments. Of course we cannot support | |
4670 | all possibly existing versions of cross development tools in all | |
4671 | (potentially obsolete) versions. In case of tool chain problems we | |
4672 | recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) | |
4673 | which is extensively used to build and test U-Boot. | |
c609719b | 4674 | |
218ca724 WD |
4675 | If you are not using a native environment, it is assumed that you |
4676 | have GNU cross compiling tools available in your path. In this case, | |
4677 | you must set the environment variable CROSS_COMPILE in your shell. | |
4678 | Note that no changes to the Makefile or any other source files are | |
4679 | necessary. For example using the ELDK on a 4xx CPU, please enter: | |
c609719b | 4680 | |
218ca724 WD |
4681 | $ CROSS_COMPILE=ppc_4xx- |
4682 | $ export CROSS_COMPILE | |
c609719b | 4683 | |
2f8d396b PT |
4684 | Note: If you wish to generate Windows versions of the utilities in |
4685 | the tools directory you can use the MinGW toolchain | |
4686 | (http://www.mingw.org). Set your HOST tools to the MinGW | |
4687 | toolchain and execute 'make tools'. For example: | |
4688 | ||
4689 | $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools | |
4690 | ||
4691 | Binaries such as tools/mkimage.exe will be created which can | |
4692 | be executed on computers running Windows. | |
4693 | ||
218ca724 WD |
4694 | U-Boot is intended to be simple to build. After installing the |
4695 | sources you must configure U-Boot for one specific board type. This | |
c609719b WD |
4696 | is done by typing: |
4697 | ||
ab584d67 | 4698 | make NAME_defconfig |
c609719b | 4699 | |
ab584d67 | 4700 | where "NAME_defconfig" is the name of one of the existing configu- |
4d675ae6 | 4701 | rations; see boards.cfg for supported names. |
db01a2ea | 4702 | |
2729af9d WD |
4703 | Note: for some board special configuration names may exist; check if |
4704 | additional information is available from the board vendor; for | |
4705 | instance, the TQM823L systems are available without (standard) | |
4706 | or with LCD support. You can select such additional "features" | |
11ccc33f | 4707 | when choosing the configuration, i. e. |
2729af9d | 4708 | |
ab584d67 | 4709 | make TQM823L_defconfig |
2729af9d WD |
4710 | - will configure for a plain TQM823L, i. e. no LCD support |
4711 | ||
ab584d67 | 4712 | make TQM823L_LCD_defconfig |
2729af9d WD |
4713 | - will configure for a TQM823L with U-Boot console on LCD |
4714 | ||
4715 | etc. | |
4716 | ||
4717 | ||
4718 | Finally, type "make all", and you should get some working U-Boot | |
4719 | images ready for download to / installation on your system: | |
4720 | ||
4721 | - "u-boot.bin" is a raw binary image | |
4722 | - "u-boot" is an image in ELF binary format | |
4723 | - "u-boot.srec" is in Motorola S-Record format | |
4724 | ||
baf31249 MB |
4725 | By default the build is performed locally and the objects are saved |
4726 | in the source directory. One of the two methods can be used to change | |
4727 | this behavior and build U-Boot to some external directory: | |
4728 | ||
4729 | 1. Add O= to the make command line invocations: | |
4730 | ||
4731 | make O=/tmp/build distclean | |
ab584d67 | 4732 | make O=/tmp/build NAME_defconfig |
baf31249 MB |
4733 | make O=/tmp/build all |
4734 | ||
adbba996 | 4735 | 2. Set environment variable KBUILD_OUTPUT to point to the desired location: |
baf31249 | 4736 | |
adbba996 | 4737 | export KBUILD_OUTPUT=/tmp/build |
baf31249 | 4738 | make distclean |
ab584d67 | 4739 | make NAME_defconfig |
baf31249 MB |
4740 | make all |
4741 | ||
adbba996 | 4742 | Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment |
baf31249 MB |
4743 | variable. |
4744 | ||
2729af9d WD |
4745 | |
4746 | Please be aware that the Makefiles assume you are using GNU make, so | |
4747 | for instance on NetBSD you might need to use "gmake" instead of | |
4748 | native "make". | |
4749 | ||
4750 | ||
4751 | If the system board that you have is not listed, then you will need | |
4752 | to port U-Boot to your hardware platform. To do this, follow these | |
4753 | steps: | |
4754 | ||
3c1496cd | 4755 | 1. Create a new directory to hold your board specific code. Add any |
2729af9d | 4756 | files you need. In your board directory, you will need at least |
3c1496cd PS |
4757 | the "Makefile" and a "<board>.c". |
4758 | 2. Create a new configuration file "include/configs/<board>.h" for | |
4759 | your board. | |
2729af9d WD |
4760 | 3. If you're porting U-Boot to a new CPU, then also create a new |
4761 | directory to hold your CPU specific code. Add any files you need. | |
ab584d67 | 4762 | 4. Run "make <board>_defconfig" with your new name. |
2729af9d WD |
4763 | 5. Type "make", and you should get a working "u-boot.srec" file |
4764 | to be installed on your target system. | |
4765 | 6. Debug and solve any problems that might arise. | |
4766 | [Of course, this last step is much harder than it sounds.] | |
4767 | ||
4768 | ||
4769 | Testing of U-Boot Modifications, Ports to New Hardware, etc.: | |
4770 | ============================================================== | |
4771 | ||
218ca724 WD |
4772 | If you have modified U-Boot sources (for instance added a new board |
4773 | or support for new devices, a new CPU, etc.) you are expected to | |
2729af9d WD |
4774 | provide feedback to the other developers. The feedback normally takes |
4775 | the form of a "patch", i. e. a context diff against a certain (latest | |
218ca724 | 4776 | official or latest in the git repository) version of U-Boot sources. |
2729af9d | 4777 | |
218ca724 WD |
4778 | But before you submit such a patch, please verify that your modifi- |
4779 | cation did not break existing code. At least make sure that *ALL* of | |
2729af9d | 4780 | the supported boards compile WITHOUT ANY compiler warnings. To do so, |
6de80f21 SG |
4781 | just run the buildman script (tools/buildman/buildman), which will |
4782 | configure and build U-Boot for ALL supported system. Be warned, this | |
4783 | will take a while. Please see the buildman README, or run 'buildman -H' | |
4784 | for documentation. | |
baf31249 MB |
4785 | |
4786 | ||
2729af9d WD |
4787 | See also "U-Boot Porting Guide" below. |
4788 | ||
4789 | ||
4790 | Monitor Commands - Overview: | |
4791 | ============================ | |
4792 | ||
4793 | go - start application at address 'addr' | |
4794 | run - run commands in an environment variable | |
4795 | bootm - boot application image from memory | |
4796 | bootp - boot image via network using BootP/TFTP protocol | |
44f074c7 | 4797 | bootz - boot zImage from memory |
2729af9d WD |
4798 | tftpboot- boot image via network using TFTP protocol |
4799 | and env variables "ipaddr" and "serverip" | |
4800 | (and eventually "gatewayip") | |
1fb7cd49 | 4801 | tftpput - upload a file via network using TFTP protocol |
2729af9d WD |
4802 | rarpboot- boot image via network using RARP/TFTP protocol |
4803 | diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' | |
4804 | loads - load S-Record file over serial line | |
4805 | loadb - load binary file over serial line (kermit mode) | |
4806 | md - memory display | |
4807 | mm - memory modify (auto-incrementing) | |
4808 | nm - memory modify (constant address) | |
4809 | mw - memory write (fill) | |
4810 | cp - memory copy | |
4811 | cmp - memory compare | |
4812 | crc32 - checksum calculation | |
0f89c54b | 4813 | i2c - I2C sub-system |
2729af9d WD |
4814 | sspi - SPI utility commands |
4815 | base - print or set address offset | |
4816 | printenv- print environment variables | |
4817 | setenv - set environment variables | |
4818 | saveenv - save environment variables to persistent storage | |
4819 | protect - enable or disable FLASH write protection | |
4820 | erase - erase FLASH memory | |
4821 | flinfo - print FLASH memory information | |
10635afa | 4822 | nand - NAND memory operations (see doc/README.nand) |
2729af9d WD |
4823 | bdinfo - print Board Info structure |
4824 | iminfo - print header information for application image | |
4825 | coninfo - print console devices and informations | |
4826 | ide - IDE sub-system | |
4827 | loop - infinite loop on address range | |
56523f12 | 4828 | loopw - infinite write loop on address range |
2729af9d WD |
4829 | mtest - simple RAM test |
4830 | icache - enable or disable instruction cache | |
4831 | dcache - enable or disable data cache | |
4832 | reset - Perform RESET of the CPU | |
4833 | echo - echo args to console | |
4834 | version - print monitor version | |
4835 | help - print online help | |
4836 | ? - alias for 'help' | |
4837 | ||
4838 | ||
4839 | Monitor Commands - Detailed Description: | |
4840 | ======================================== | |
4841 | ||
4842 | TODO. | |
4843 | ||
4844 | For now: just type "help <command>". | |
4845 | ||
4846 | ||
4847 | Environment Variables: | |
4848 | ====================== | |
4849 | ||
4850 | U-Boot supports user configuration using Environment Variables which | |
4851 | can be made persistent by saving to Flash memory. | |
c609719b | 4852 | |
2729af9d WD |
4853 | Environment Variables are set using "setenv", printed using |
4854 | "printenv", and saved to Flash using "saveenv". Using "setenv" | |
4855 | without a value can be used to delete a variable from the | |
4856 | environment. As long as you don't save the environment you are | |
4857 | working with an in-memory copy. In case the Flash area containing the | |
4858 | environment is erased by accident, a default environment is provided. | |
c609719b | 4859 | |
c96f86ee WD |
4860 | Some configuration options can be set using Environment Variables. |
4861 | ||
4862 | List of environment variables (most likely not complete): | |
c609719b | 4863 | |
2729af9d | 4864 | baudrate - see CONFIG_BAUDRATE |
c609719b | 4865 | |
2729af9d | 4866 | bootdelay - see CONFIG_BOOTDELAY |
c609719b | 4867 | |
2729af9d | 4868 | bootcmd - see CONFIG_BOOTCOMMAND |
4a6fd34b | 4869 | |
2729af9d | 4870 | bootargs - Boot arguments when booting an RTOS image |
c609719b | 4871 | |
2729af9d | 4872 | bootfile - Name of the image to load with TFTP |
c609719b | 4873 | |
7d721e34 BS |
4874 | bootm_low - Memory range available for image processing in the bootm |
4875 | command can be restricted. This variable is given as | |
4876 | a hexadecimal number and defines lowest address allowed | |
4877 | for use by the bootm command. See also "bootm_size" | |
4878 | environment variable. Address defined by "bootm_low" is | |
4879 | also the base of the initial memory mapping for the Linux | |
c3624e6e GL |
4880 | kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and |
4881 | bootm_mapsize. | |
4882 | ||
c0f40859 | 4883 | bootm_mapsize - Size of the initial memory mapping for the Linux kernel. |
c3624e6e GL |
4884 | This variable is given as a hexadecimal number and it |
4885 | defines the size of the memory region starting at base | |
4886 | address bootm_low that is accessible by the Linux kernel | |
4887 | during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used | |
4888 | as the default value if it is defined, and bootm_size is | |
4889 | used otherwise. | |
7d721e34 BS |
4890 | |
4891 | bootm_size - Memory range available for image processing in the bootm | |
4892 | command can be restricted. This variable is given as | |
4893 | a hexadecimal number and defines the size of the region | |
4894 | allowed for use by the bootm command. See also "bootm_low" | |
4895 | environment variable. | |
4896 | ||
4bae9090 BS |
4897 | updatefile - Location of the software update file on a TFTP server, used |
4898 | by the automatic software update feature. Please refer to | |
4899 | documentation in doc/README.update for more details. | |
4900 | ||
2729af9d WD |
4901 | autoload - if set to "no" (any string beginning with 'n'), |
4902 | "bootp" will just load perform a lookup of the | |
4903 | configuration from the BOOTP server, but not try to | |
4904 | load any image using TFTP | |
c609719b | 4905 | |
2729af9d WD |
4906 | autostart - if set to "yes", an image loaded using the "bootp", |
4907 | "rarpboot", "tftpboot" or "diskboot" commands will | |
4908 | be automatically started (by internally calling | |
4909 | "bootm") | |
38b99261 | 4910 | |
2729af9d WD |
4911 | If set to "no", a standalone image passed to the |
4912 | "bootm" command will be copied to the load address | |
4913 | (and eventually uncompressed), but NOT be started. | |
4914 | This can be used to load and uncompress arbitrary | |
4915 | data. | |
c609719b | 4916 | |
a28afca5 DL |
4917 | fdt_high - if set this restricts the maximum address that the |
4918 | flattened device tree will be copied into upon boot. | |
fa34f6b2 SG |
4919 | For example, if you have a system with 1 GB memory |
4920 | at physical address 0x10000000, while Linux kernel | |
4921 | only recognizes the first 704 MB as low memory, you | |
4922 | may need to set fdt_high as 0x3C000000 to have the | |
4923 | device tree blob be copied to the maximum address | |
4924 | of the 704 MB low memory, so that Linux kernel can | |
4925 | access it during the boot procedure. | |
4926 | ||
a28afca5 DL |
4927 | If this is set to the special value 0xFFFFFFFF then |
4928 | the fdt will not be copied at all on boot. For this | |
4929 | to work it must reside in writable memory, have | |
4930 | sufficient padding on the end of it for u-boot to | |
4931 | add the information it needs into it, and the memory | |
4932 | must be accessible by the kernel. | |
4933 | ||
eea63e05 SG |
4934 | fdtcontroladdr- if set this is the address of the control flattened |
4935 | device tree used by U-Boot when CONFIG_OF_CONTROL is | |
4936 | defined. | |
4937 | ||
17ea1177 WD |
4938 | i2cfast - (PPC405GP|PPC405EP only) |
4939 | if set to 'y' configures Linux I2C driver for fast | |
4940 | mode (400kHZ). This environment variable is used in | |
4941 | initialization code. So, for changes to be effective | |
4942 | it must be saved and board must be reset. | |
4943 | ||
2729af9d WD |
4944 | initrd_high - restrict positioning of initrd images: |
4945 | If this variable is not set, initrd images will be | |
4946 | copied to the highest possible address in RAM; this | |
4947 | is usually what you want since it allows for | |
4948 | maximum initrd size. If for some reason you want to | |
4949 | make sure that the initrd image is loaded below the | |
6d0f6bcf | 4950 | CONFIG_SYS_BOOTMAPSZ limit, you can set this environment |
2729af9d WD |
4951 | variable to a value of "no" or "off" or "0". |
4952 | Alternatively, you can set it to a maximum upper | |
4953 | address to use (U-Boot will still check that it | |
4954 | does not overwrite the U-Boot stack and data). | |
c609719b | 4955 | |
2729af9d WD |
4956 | For instance, when you have a system with 16 MB |
4957 | RAM, and want to reserve 4 MB from use by Linux, | |
4958 | you can do this by adding "mem=12M" to the value of | |
4959 | the "bootargs" variable. However, now you must make | |
4960 | sure that the initrd image is placed in the first | |
4961 | 12 MB as well - this can be done with | |
c609719b | 4962 | |
2729af9d | 4963 | setenv initrd_high 00c00000 |
c609719b | 4964 | |
2729af9d WD |
4965 | If you set initrd_high to 0xFFFFFFFF, this is an |
4966 | indication to U-Boot that all addresses are legal | |
4967 | for the Linux kernel, including addresses in flash | |
4968 | memory. In this case U-Boot will NOT COPY the | |
4969 | ramdisk at all. This may be useful to reduce the | |
4970 | boot time on your system, but requires that this | |
4971 | feature is supported by your Linux kernel. | |
c609719b | 4972 | |
2729af9d | 4973 | ipaddr - IP address; needed for tftpboot command |
c609719b | 4974 | |
2729af9d WD |
4975 | loadaddr - Default load address for commands like "bootp", |
4976 | "rarpboot", "tftpboot", "loadb" or "diskboot" | |
c609719b | 4977 | |
2729af9d | 4978 | loads_echo - see CONFIG_LOADS_ECHO |
a3d991bd | 4979 | |
2729af9d | 4980 | serverip - TFTP server IP address; needed for tftpboot command |
a3d991bd | 4981 | |
2729af9d | 4982 | bootretry - see CONFIG_BOOT_RETRY_TIME |
a3d991bd | 4983 | |
2729af9d | 4984 | bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR |
a3d991bd | 4985 | |
2729af9d | 4986 | bootstopkey - see CONFIG_AUTOBOOT_STOP_STR |
c609719b | 4987 | |
e2a53458 | 4988 | ethprime - controls which interface is used first. |
c609719b | 4989 | |
e2a53458 MF |
4990 | ethact - controls which interface is currently active. |
4991 | For example you can do the following | |
c609719b | 4992 | |
48690d80 HS |
4993 | => setenv ethact FEC |
4994 | => ping 192.168.0.1 # traffic sent on FEC | |
4995 | => setenv ethact SCC | |
4996 | => ping 10.0.0.1 # traffic sent on SCC | |
c609719b | 4997 | |
e1692577 MF |
4998 | ethrotate - When set to "no" U-Boot does not go through all |
4999 | available network interfaces. | |
5000 | It just stays at the currently selected interface. | |
5001 | ||
c96f86ee | 5002 | netretry - When set to "no" each network operation will |
2729af9d WD |
5003 | either succeed or fail without retrying. |
5004 | When set to "once" the network operation will | |
5005 | fail when all the available network interfaces | |
5006 | are tried once without success. | |
5007 | Useful on scripts which control the retry operation | |
5008 | themselves. | |
c609719b | 5009 | |
b4e2f89d | 5010 | npe_ucode - set load address for the NPE microcode |
a1cf027a | 5011 | |
b445bbb4 | 5012 | silent_linux - If set then Linux will be told to boot silently, by |
8d51aacd SG |
5013 | changing the console to be empty. If "yes" it will be |
5014 | made silent. If "no" it will not be made silent. If | |
5015 | unset, then it will be made silent if the U-Boot console | |
5016 | is silent. | |
5017 | ||
f5fb7346 | 5018 | tftpsrcp - If this is set, the value is used for TFTP's |
ecb0ccd9 WD |
5019 | UDP source port. |
5020 | ||
f5fb7346 | 5021 | tftpdstp - If this is set, the value is used for TFTP's UDP |
28cb9375 WD |
5022 | destination port instead of the Well Know Port 69. |
5023 | ||
c96f86ee WD |
5024 | tftpblocksize - Block size to use for TFTP transfers; if not set, |
5025 | we use the TFTP server's default block size | |
5026 | ||
5027 | tftptimeout - Retransmission timeout for TFTP packets (in milli- | |
5028 | seconds, minimum value is 1000 = 1 second). Defines | |
5029 | when a packet is considered to be lost so it has to | |
5030 | be retransmitted. The default is 5000 = 5 seconds. | |
5031 | Lowering this value may make downloads succeed | |
5032 | faster in networks with high packet loss rates or | |
5033 | with unreliable TFTP servers. | |
5034 | ||
f5fb7346 AA |
5035 | tftptimeoutcountmax - maximum count of TFTP timeouts (no |
5036 | unit, minimum value = 0). Defines how many timeouts | |
5037 | can happen during a single file transfer before that | |
5038 | transfer is aborted. The default is 10, and 0 means | |
5039 | 'no timeouts allowed'. Increasing this value may help | |
5040 | downloads succeed with high packet loss rates, or with | |
5041 | unreliable TFTP servers or client hardware. | |
5042 | ||
c96f86ee | 5043 | vlan - When set to a value < 4095 the traffic over |
11ccc33f | 5044 | Ethernet is encapsulated/received over 802.1q |
2729af9d | 5045 | VLAN tagged frames. |
c609719b | 5046 | |
50768f5b AM |
5047 | bootpretryperiod - Period during which BOOTP/DHCP sends retries. |
5048 | Unsigned value, in milliseconds. If not set, the period will | |
5049 | be either the default (28000), or a value based on | |
5050 | CONFIG_NET_RETRY_COUNT, if defined. This value has | |
5051 | precedence over the valu based on CONFIG_NET_RETRY_COUNT. | |
5052 | ||
dc0b7b0e JH |
5053 | The following image location variables contain the location of images |
5054 | used in booting. The "Image" column gives the role of the image and is | |
5055 | not an environment variable name. The other columns are environment | |
5056 | variable names. "File Name" gives the name of the file on a TFTP | |
5057 | server, "RAM Address" gives the location in RAM the image will be | |
5058 | loaded to, and "Flash Location" gives the image's address in NOR | |
5059 | flash or offset in NAND flash. | |
5060 | ||
5061 | *Note* - these variables don't have to be defined for all boards, some | |
aed9fed9 | 5062 | boards currently use other variables for these purposes, and some |
dc0b7b0e JH |
5063 | boards use these variables for other purposes. |
5064 | ||
c0f40859 WD |
5065 | Image File Name RAM Address Flash Location |
5066 | ----- --------- ----------- -------------- | |
5067 | u-boot u-boot u-boot_addr_r u-boot_addr | |
5068 | Linux kernel bootfile kernel_addr_r kernel_addr | |
5069 | device tree blob fdtfile fdt_addr_r fdt_addr | |
5070 | ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr | |
dc0b7b0e | 5071 | |
2729af9d WD |
5072 | The following environment variables may be used and automatically |
5073 | updated by the network boot commands ("bootp" and "rarpboot"), | |
5074 | depending the information provided by your boot server: | |
c609719b | 5075 | |
2729af9d WD |
5076 | bootfile - see above |
5077 | dnsip - IP address of your Domain Name Server | |
5078 | dnsip2 - IP address of your secondary Domain Name Server | |
5079 | gatewayip - IP address of the Gateway (Router) to use | |
5080 | hostname - Target hostname | |
5081 | ipaddr - see above | |
5082 | netmask - Subnet Mask | |
5083 | rootpath - Pathname of the root filesystem on the NFS server | |
5084 | serverip - see above | |
c1551ea8 | 5085 | |
c1551ea8 | 5086 | |
2729af9d | 5087 | There are two special Environment Variables: |
c1551ea8 | 5088 | |
2729af9d WD |
5089 | serial# - contains hardware identification information such |
5090 | as type string and/or serial number | |
5091 | ethaddr - Ethernet address | |
c609719b | 5092 | |
2729af9d WD |
5093 | These variables can be set only once (usually during manufacturing of |
5094 | the board). U-Boot refuses to delete or overwrite these variables | |
5095 | once they have been set once. | |
c609719b | 5096 | |
f07771cc | 5097 | |
2729af9d | 5098 | Further special Environment Variables: |
f07771cc | 5099 | |
2729af9d WD |
5100 | ver - Contains the U-Boot version string as printed |
5101 | with the "version" command. This variable is | |
5102 | readonly (see CONFIG_VERSION_VARIABLE). | |
f07771cc | 5103 | |
f07771cc | 5104 | |
2729af9d WD |
5105 | Please note that changes to some configuration parameters may take |
5106 | only effect after the next boot (yes, that's just like Windoze :-). | |
f07771cc | 5107 | |
f07771cc | 5108 | |
170ab110 JH |
5109 | Callback functions for environment variables: |
5110 | --------------------------------------------- | |
5111 | ||
5112 | For some environment variables, the behavior of u-boot needs to change | |
b445bbb4 | 5113 | when their values are changed. This functionality allows functions to |
170ab110 JH |
5114 | be associated with arbitrary variables. On creation, overwrite, or |
5115 | deletion, the callback will provide the opportunity for some side | |
5116 | effect to happen or for the change to be rejected. | |
5117 | ||
5118 | The callbacks are named and associated with a function using the | |
5119 | U_BOOT_ENV_CALLBACK macro in your board or driver code. | |
5120 | ||
5121 | These callbacks are associated with variables in one of two ways. The | |
5122 | static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC | |
5123 | in the board configuration to a string that defines a list of | |
5124 | associations. The list must be in the following format: | |
5125 | ||
5126 | entry = variable_name[:callback_name] | |
5127 | list = entry[,list] | |
5128 | ||
5129 | If the callback name is not specified, then the callback is deleted. | |
5130 | Spaces are also allowed anywhere in the list. | |
5131 | ||
5132 | Callbacks can also be associated by defining the ".callbacks" variable | |
5133 | with the same list format above. Any association in ".callbacks" will | |
5134 | override any association in the static list. You can define | |
5135 | CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the | |
b445bbb4 | 5136 | ".callbacks" environment variable in the default or embedded environment. |
170ab110 | 5137 | |
bdf1fe4e JH |
5138 | If CONFIG_REGEX is defined, the variable_name above is evaluated as a |
5139 | regular expression. This allows multiple variables to be connected to | |
5140 | the same callback without explicitly listing them all out. | |
5141 | ||
170ab110 | 5142 | |
2729af9d WD |
5143 | Command Line Parsing: |
5144 | ===================== | |
f07771cc | 5145 | |
2729af9d WD |
5146 | There are two different command line parsers available with U-Boot: |
5147 | the old "simple" one, and the much more powerful "hush" shell: | |
c609719b | 5148 | |
2729af9d WD |
5149 | Old, simple command line parser: |
5150 | -------------------------------- | |
c609719b | 5151 | |
2729af9d WD |
5152 | - supports environment variables (through setenv / saveenv commands) |
5153 | - several commands on one line, separated by ';' | |
fe126d8b | 5154 | - variable substitution using "... ${name} ..." syntax |
2729af9d WD |
5155 | - special characters ('$', ';') can be escaped by prefixing with '\', |
5156 | for example: | |
fe126d8b | 5157 | setenv bootcmd bootm \${address} |
2729af9d WD |
5158 | - You can also escape text by enclosing in single apostrophes, for example: |
5159 | setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' | |
c609719b | 5160 | |
2729af9d WD |
5161 | Hush shell: |
5162 | ----------- | |
c609719b | 5163 | |
2729af9d WD |
5164 | - similar to Bourne shell, with control structures like |
5165 | if...then...else...fi, for...do...done; while...do...done, | |
5166 | until...do...done, ... | |
5167 | - supports environment ("global") variables (through setenv / saveenv | |
5168 | commands) and local shell variables (through standard shell syntax | |
5169 | "name=value"); only environment variables can be used with "run" | |
5170 | command | |
5171 | ||
5172 | General rules: | |
5173 | -------------- | |
c609719b | 5174 | |
2729af9d WD |
5175 | (1) If a command line (or an environment variable executed by a "run" |
5176 | command) contains several commands separated by semicolon, and | |
5177 | one of these commands fails, then the remaining commands will be | |
5178 | executed anyway. | |
c609719b | 5179 | |
2729af9d | 5180 | (2) If you execute several variables with one call to run (i. e. |
11ccc33f | 5181 | calling run with a list of variables as arguments), any failing |
2729af9d WD |
5182 | command will cause "run" to terminate, i. e. the remaining |
5183 | variables are not executed. | |
c609719b | 5184 | |
2729af9d WD |
5185 | Note for Redundant Ethernet Interfaces: |
5186 | ======================================= | |
c609719b | 5187 | |
11ccc33f | 5188 | Some boards come with redundant Ethernet interfaces; U-Boot supports |
2729af9d WD |
5189 | such configurations and is capable of automatic selection of a |
5190 | "working" interface when needed. MAC assignment works as follows: | |
c609719b | 5191 | |
2729af9d WD |
5192 | Network interfaces are numbered eth0, eth1, eth2, ... Corresponding |
5193 | MAC addresses can be stored in the environment as "ethaddr" (=>eth0), | |
5194 | "eth1addr" (=>eth1), "eth2addr", ... | |
c609719b | 5195 | |
2729af9d WD |
5196 | If the network interface stores some valid MAC address (for instance |
5197 | in SROM), this is used as default address if there is NO correspon- | |
5198 | ding setting in the environment; if the corresponding environment | |
5199 | variable is set, this overrides the settings in the card; that means: | |
c609719b | 5200 | |
2729af9d WD |
5201 | o If the SROM has a valid MAC address, and there is no address in the |
5202 | environment, the SROM's address is used. | |
c609719b | 5203 | |
2729af9d WD |
5204 | o If there is no valid address in the SROM, and a definition in the |
5205 | environment exists, then the value from the environment variable is | |
5206 | used. | |
c609719b | 5207 | |
2729af9d WD |
5208 | o If both the SROM and the environment contain a MAC address, and |
5209 | both addresses are the same, this MAC address is used. | |
c609719b | 5210 | |
2729af9d WD |
5211 | o If both the SROM and the environment contain a MAC address, and the |
5212 | addresses differ, the value from the environment is used and a | |
5213 | warning is printed. | |
c609719b | 5214 | |
2729af9d | 5215 | o If neither SROM nor the environment contain a MAC address, an error |
bef1014b JH |
5216 | is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case |
5217 | a random, locally-assigned MAC is used. | |
c609719b | 5218 | |
ecee9324 | 5219 | If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses |
c0f40859 | 5220 | will be programmed into hardware as part of the initialization process. This |
ecee9324 BW |
5221 | may be skipped by setting the appropriate 'ethmacskip' environment variable. |
5222 | The naming convention is as follows: | |
5223 | "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. | |
c609719b | 5224 | |
2729af9d WD |
5225 | Image Formats: |
5226 | ============== | |
c609719b | 5227 | |
3310c549 MB |
5228 | U-Boot is capable of booting (and performing other auxiliary operations on) |
5229 | images in two formats: | |
5230 | ||
5231 | New uImage format (FIT) | |
5232 | ----------------------- | |
5233 | ||
5234 | Flexible and powerful format based on Flattened Image Tree -- FIT (similar | |
5235 | to Flattened Device Tree). It allows the use of images with multiple | |
5236 | components (several kernels, ramdisks, etc.), with contents protected by | |
5237 | SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. | |
5238 | ||
5239 | ||
5240 | Old uImage format | |
5241 | ----------------- | |
5242 | ||
5243 | Old image format is based on binary files which can be basically anything, | |
5244 | preceded by a special header; see the definitions in include/image.h for | |
5245 | details; basically, the header defines the following image properties: | |
c609719b | 5246 | |
2729af9d WD |
5247 | * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, |
5248 | 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, | |
f5ed9e39 PT |
5249 | LynxOS, pSOS, QNX, RTEMS, INTEGRITY; |
5250 | Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, | |
5251 | INTEGRITY). | |
7b64fef3 | 5252 | * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, |
afc1ce82 ML |
5253 | IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; |
5254 | Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). | |
2729af9d WD |
5255 | * Compression Type (uncompressed, gzip, bzip2) |
5256 | * Load Address | |
5257 | * Entry Point | |
5258 | * Image Name | |
5259 | * Image Timestamp | |
c609719b | 5260 | |
2729af9d WD |
5261 | The header is marked by a special Magic Number, and both the header |
5262 | and the data portions of the image are secured against corruption by | |
5263 | CRC32 checksums. | |
c609719b WD |
5264 | |
5265 | ||
2729af9d WD |
5266 | Linux Support: |
5267 | ============== | |
c609719b | 5268 | |
2729af9d WD |
5269 | Although U-Boot should support any OS or standalone application |
5270 | easily, the main focus has always been on Linux during the design of | |
5271 | U-Boot. | |
c609719b | 5272 | |
2729af9d WD |
5273 | U-Boot includes many features that so far have been part of some |
5274 | special "boot loader" code within the Linux kernel. Also, any | |
5275 | "initrd" images to be used are no longer part of one big Linux image; | |
5276 | instead, kernel and "initrd" are separate images. This implementation | |
5277 | serves several purposes: | |
c609719b | 5278 | |
2729af9d WD |
5279 | - the same features can be used for other OS or standalone |
5280 | applications (for instance: using compressed images to reduce the | |
5281 | Flash memory footprint) | |
c609719b | 5282 | |
2729af9d WD |
5283 | - it becomes much easier to port new Linux kernel versions because |
5284 | lots of low-level, hardware dependent stuff are done by U-Boot | |
c609719b | 5285 | |
2729af9d WD |
5286 | - the same Linux kernel image can now be used with different "initrd" |
5287 | images; of course this also means that different kernel images can | |
5288 | be run with the same "initrd". This makes testing easier (you don't | |
5289 | have to build a new "zImage.initrd" Linux image when you just | |
5290 | change a file in your "initrd"). Also, a field-upgrade of the | |
5291 | software is easier now. | |
c609719b | 5292 | |
c609719b | 5293 | |
2729af9d WD |
5294 | Linux HOWTO: |
5295 | ============ | |
c609719b | 5296 | |
2729af9d WD |
5297 | Porting Linux to U-Boot based systems: |
5298 | --------------------------------------- | |
c609719b | 5299 | |
2729af9d WD |
5300 | U-Boot cannot save you from doing all the necessary modifications to |
5301 | configure the Linux device drivers for use with your target hardware | |
5302 | (no, we don't intend to provide a full virtual machine interface to | |
5303 | Linux :-). | |
c609719b | 5304 | |
a47a12be | 5305 | But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). |
24ee89b9 | 5306 | |
2729af9d WD |
5307 | Just make sure your machine specific header file (for instance |
5308 | include/asm-ppc/tqm8xx.h) includes the same definition of the Board | |
1dc30693 MH |
5309 | Information structure as we define in include/asm-<arch>/u-boot.h, |
5310 | and make sure that your definition of IMAP_ADDR uses the same value | |
6d0f6bcf | 5311 | as your U-Boot configuration in CONFIG_SYS_IMMR. |
24ee89b9 | 5312 | |
2eb31b13 SG |
5313 | Note that U-Boot now has a driver model, a unified model for drivers. |
5314 | If you are adding a new driver, plumb it into driver model. If there | |
5315 | is no uclass available, you are encouraged to create one. See | |
5316 | doc/driver-model. | |
5317 | ||
c609719b | 5318 | |
2729af9d WD |
5319 | Configuring the Linux kernel: |
5320 | ----------------------------- | |
c609719b | 5321 | |
2729af9d WD |
5322 | No specific requirements for U-Boot. Make sure you have some root |
5323 | device (initial ramdisk, NFS) for your target system. | |
5324 | ||
5325 | ||
5326 | Building a Linux Image: | |
5327 | ----------------------- | |
c609719b | 5328 | |
2729af9d WD |
5329 | With U-Boot, "normal" build targets like "zImage" or "bzImage" are |
5330 | not used. If you use recent kernel source, a new build target | |
5331 | "uImage" will exist which automatically builds an image usable by | |
5332 | U-Boot. Most older kernels also have support for a "pImage" target, | |
5333 | which was introduced for our predecessor project PPCBoot and uses a | |
5334 | 100% compatible format. | |
5335 | ||
5336 | Example: | |
5337 | ||
ab584d67 | 5338 | make TQM850L_defconfig |
2729af9d WD |
5339 | make oldconfig |
5340 | make dep | |
5341 | make uImage | |
5342 | ||
5343 | The "uImage" build target uses a special tool (in 'tools/mkimage') to | |
5344 | encapsulate a compressed Linux kernel image with header information, | |
5345 | CRC32 checksum etc. for use with U-Boot. This is what we are doing: | |
5346 | ||
5347 | * build a standard "vmlinux" kernel image (in ELF binary format): | |
5348 | ||
5349 | * convert the kernel into a raw binary image: | |
5350 | ||
5351 | ${CROSS_COMPILE}-objcopy -O binary \ | |
5352 | -R .note -R .comment \ | |
5353 | -S vmlinux linux.bin | |
5354 | ||
5355 | * compress the binary image: | |
5356 | ||
5357 | gzip -9 linux.bin | |
5358 | ||
5359 | * package compressed binary image for U-Boot: | |
5360 | ||
5361 | mkimage -A ppc -O linux -T kernel -C gzip \ | |
5362 | -a 0 -e 0 -n "Linux Kernel Image" \ | |
5363 | -d linux.bin.gz uImage | |
c609719b | 5364 | |
c609719b | 5365 | |
2729af9d WD |
5366 | The "mkimage" tool can also be used to create ramdisk images for use |
5367 | with U-Boot, either separated from the Linux kernel image, or | |
5368 | combined into one file. "mkimage" encapsulates the images with a 64 | |
5369 | byte header containing information about target architecture, | |
5370 | operating system, image type, compression method, entry points, time | |
5371 | stamp, CRC32 checksums, etc. | |
5372 | ||
5373 | "mkimage" can be called in two ways: to verify existing images and | |
5374 | print the header information, or to build new images. | |
5375 | ||
5376 | In the first form (with "-l" option) mkimage lists the information | |
5377 | contained in the header of an existing U-Boot image; this includes | |
5378 | checksum verification: | |
c609719b | 5379 | |
2729af9d WD |
5380 | tools/mkimage -l image |
5381 | -l ==> list image header information | |
5382 | ||
5383 | The second form (with "-d" option) is used to build a U-Boot image | |
5384 | from a "data file" which is used as image payload: | |
5385 | ||
5386 | tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ | |
5387 | -n name -d data_file image | |
5388 | -A ==> set architecture to 'arch' | |
5389 | -O ==> set operating system to 'os' | |
5390 | -T ==> set image type to 'type' | |
5391 | -C ==> set compression type 'comp' | |
5392 | -a ==> set load address to 'addr' (hex) | |
5393 | -e ==> set entry point to 'ep' (hex) | |
5394 | -n ==> set image name to 'name' | |
5395 | -d ==> use image data from 'datafile' | |
5396 | ||
69459791 WD |
5397 | Right now, all Linux kernels for PowerPC systems use the same load |
5398 | address (0x00000000), but the entry point address depends on the | |
5399 | kernel version: | |
2729af9d WD |
5400 | |
5401 | - 2.2.x kernels have the entry point at 0x0000000C, | |
5402 | - 2.3.x and later kernels have the entry point at 0x00000000. | |
5403 | ||
5404 | So a typical call to build a U-Boot image would read: | |
5405 | ||
5406 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ | |
5407 | > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ | |
a47a12be | 5408 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ |
2729af9d WD |
5409 | > examples/uImage.TQM850L |
5410 | Image Name: 2.4.4 kernel for TQM850L | |
5411 | Created: Wed Jul 19 02:34:59 2000 | |
5412 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5413 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB | |
5414 | Load Address: 0x00000000 | |
5415 | Entry Point: 0x00000000 | |
5416 | ||
5417 | To verify the contents of the image (or check for corruption): | |
5418 | ||
5419 | -> tools/mkimage -l examples/uImage.TQM850L | |
5420 | Image Name: 2.4.4 kernel for TQM850L | |
5421 | Created: Wed Jul 19 02:34:59 2000 | |
5422 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5423 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB | |
5424 | Load Address: 0x00000000 | |
5425 | Entry Point: 0x00000000 | |
5426 | ||
5427 | NOTE: for embedded systems where boot time is critical you can trade | |
5428 | speed for memory and install an UNCOMPRESSED image instead: this | |
5429 | needs more space in Flash, but boots much faster since it does not | |
5430 | need to be uncompressed: | |
5431 | ||
a47a12be | 5432 | -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz |
2729af9d WD |
5433 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
5434 | > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ | |
a47a12be | 5435 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ |
2729af9d WD |
5436 | > examples/uImage.TQM850L-uncompressed |
5437 | Image Name: 2.4.4 kernel for TQM850L | |
5438 | Created: Wed Jul 19 02:34:59 2000 | |
5439 | Image Type: PowerPC Linux Kernel Image (uncompressed) | |
5440 | Data Size: 792160 Bytes = 773.59 kB = 0.76 MB | |
5441 | Load Address: 0x00000000 | |
5442 | Entry Point: 0x00000000 | |
5443 | ||
5444 | ||
5445 | Similar you can build U-Boot images from a 'ramdisk.image.gz' file | |
5446 | when your kernel is intended to use an initial ramdisk: | |
5447 | ||
5448 | -> tools/mkimage -n 'Simple Ramdisk Image' \ | |
5449 | > -A ppc -O linux -T ramdisk -C gzip \ | |
5450 | > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd | |
5451 | Image Name: Simple Ramdisk Image | |
5452 | Created: Wed Jan 12 14:01:50 2000 | |
5453 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
5454 | Data Size: 566530 Bytes = 553.25 kB = 0.54 MB | |
5455 | Load Address: 0x00000000 | |
5456 | Entry Point: 0x00000000 | |
5457 | ||
a804b5ce GMF |
5458 | The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" |
5459 | option performs the converse operation of the mkimage's second form (the "-d" | |
5460 | option). Given an image built by mkimage, the dumpimage extracts a "data file" | |
5461 | from the image: | |
5462 | ||
f41f5b7c GMF |
5463 | tools/dumpimage -i image -T type -p position data_file |
5464 | -i ==> extract from the 'image' a specific 'data_file' | |
5465 | -T ==> set image type to 'type' | |
5466 | -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' | |
a804b5ce | 5467 | |
2729af9d WD |
5468 | |
5469 | Installing a Linux Image: | |
5470 | ------------------------- | |
5471 | ||
5472 | To downloading a U-Boot image over the serial (console) interface, | |
5473 | you must convert the image to S-Record format: | |
5474 | ||
5475 | objcopy -I binary -O srec examples/image examples/image.srec | |
5476 | ||
5477 | The 'objcopy' does not understand the information in the U-Boot | |
5478 | image header, so the resulting S-Record file will be relative to | |
5479 | address 0x00000000. To load it to a given address, you need to | |
5480 | specify the target address as 'offset' parameter with the 'loads' | |
5481 | command. | |
5482 | ||
5483 | Example: install the image to address 0x40100000 (which on the | |
5484 | TQM8xxL is in the first Flash bank): | |
5485 | ||
5486 | => erase 40100000 401FFFFF | |
5487 | ||
5488 | .......... done | |
5489 | Erased 8 sectors | |
5490 | ||
5491 | => loads 40100000 | |
5492 | ## Ready for S-Record download ... | |
5493 | ~>examples/image.srec | |
5494 | 1 2 3 4 5 6 7 8 9 10 11 12 13 ... | |
5495 | ... | |
5496 | 15989 15990 15991 15992 | |
5497 | [file transfer complete] | |
5498 | [connected] | |
5499 | ## Start Addr = 0x00000000 | |
5500 | ||
5501 | ||
5502 | You can check the success of the download using the 'iminfo' command; | |
218ca724 | 5503 | this includes a checksum verification so you can be sure no data |
2729af9d WD |
5504 | corruption happened: |
5505 | ||
5506 | => imi 40100000 | |
5507 | ||
5508 | ## Checking Image at 40100000 ... | |
5509 | Image Name: 2.2.13 for initrd on TQM850L | |
5510 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5511 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
5512 | Load Address: 00000000 | |
5513 | Entry Point: 0000000c | |
5514 | Verifying Checksum ... OK | |
5515 | ||
5516 | ||
5517 | Boot Linux: | |
5518 | ----------- | |
5519 | ||
5520 | The "bootm" command is used to boot an application that is stored in | |
5521 | memory (RAM or Flash). In case of a Linux kernel image, the contents | |
5522 | of the "bootargs" environment variable is passed to the kernel as | |
5523 | parameters. You can check and modify this variable using the | |
5524 | "printenv" and "setenv" commands: | |
5525 | ||
5526 | ||
5527 | => printenv bootargs | |
5528 | bootargs=root=/dev/ram | |
5529 | ||
5530 | => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
5531 | ||
5532 | => printenv bootargs | |
5533 | bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
5534 | ||
5535 | => bootm 40020000 | |
5536 | ## Booting Linux kernel at 40020000 ... | |
5537 | Image Name: 2.2.13 for NFS on TQM850L | |
5538 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5539 | Data Size: 381681 Bytes = 372 kB = 0 MB | |
5540 | Load Address: 00000000 | |
5541 | Entry Point: 0000000c | |
5542 | Verifying Checksum ... OK | |
5543 | Uncompressing Kernel Image ... OK | |
5544 | Linux version 2.2.13 ([email protected]) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000 | |
5545 | Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
5546 | time_init: decrementer frequency = 187500000/60 | |
5547 | Calibrating delay loop... 49.77 BogoMIPS | |
5548 | Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] | |
5549 | ... | |
5550 | ||
11ccc33f | 5551 | If you want to boot a Linux kernel with initial RAM disk, you pass |
2729af9d WD |
5552 | the memory addresses of both the kernel and the initrd image (PPBCOOT |
5553 | format!) to the "bootm" command: | |
5554 | ||
5555 | => imi 40100000 40200000 | |
5556 | ||
5557 | ## Checking Image at 40100000 ... | |
5558 | Image Name: 2.2.13 for initrd on TQM850L | |
5559 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5560 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
5561 | Load Address: 00000000 | |
5562 | Entry Point: 0000000c | |
5563 | Verifying Checksum ... OK | |
5564 | ||
5565 | ## Checking Image at 40200000 ... | |
5566 | Image Name: Simple Ramdisk Image | |
5567 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
5568 | Data Size: 566530 Bytes = 553 kB = 0 MB | |
5569 | Load Address: 00000000 | |
5570 | Entry Point: 00000000 | |
5571 | Verifying Checksum ... OK | |
5572 | ||
5573 | => bootm 40100000 40200000 | |
5574 | ## Booting Linux kernel at 40100000 ... | |
5575 | Image Name: 2.2.13 for initrd on TQM850L | |
5576 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5577 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
5578 | Load Address: 00000000 | |
5579 | Entry Point: 0000000c | |
5580 | Verifying Checksum ... OK | |
5581 | Uncompressing Kernel Image ... OK | |
5582 | ## Loading RAMDisk Image at 40200000 ... | |
5583 | Image Name: Simple Ramdisk Image | |
5584 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
5585 | Data Size: 566530 Bytes = 553 kB = 0 MB | |
5586 | Load Address: 00000000 | |
5587 | Entry Point: 00000000 | |
5588 | Verifying Checksum ... OK | |
5589 | Loading Ramdisk ... OK | |
5590 | Linux version 2.2.13 ([email protected]) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000 | |
5591 | Boot arguments: root=/dev/ram | |
5592 | time_init: decrementer frequency = 187500000/60 | |
5593 | Calibrating delay loop... 49.77 BogoMIPS | |
5594 | ... | |
5595 | RAMDISK: Compressed image found at block 0 | |
5596 | VFS: Mounted root (ext2 filesystem). | |
5597 | ||
5598 | bash# | |
5599 | ||
0267768e MM |
5600 | Boot Linux and pass a flat device tree: |
5601 | ----------- | |
5602 | ||
5603 | First, U-Boot must be compiled with the appropriate defines. See the section | |
5604 | titled "Linux Kernel Interface" above for a more in depth explanation. The | |
5605 | following is an example of how to start a kernel and pass an updated | |
5606 | flat device tree: | |
5607 | ||
5608 | => print oftaddr | |
5609 | oftaddr=0x300000 | |
5610 | => print oft | |
5611 | oft=oftrees/mpc8540ads.dtb | |
5612 | => tftp $oftaddr $oft | |
5613 | Speed: 1000, full duplex | |
5614 | Using TSEC0 device | |
5615 | TFTP from server 192.168.1.1; our IP address is 192.168.1.101 | |
5616 | Filename 'oftrees/mpc8540ads.dtb'. | |
5617 | Load address: 0x300000 | |
5618 | Loading: # | |
5619 | done | |
5620 | Bytes transferred = 4106 (100a hex) | |
5621 | => tftp $loadaddr $bootfile | |
5622 | Speed: 1000, full duplex | |
5623 | Using TSEC0 device | |
5624 | TFTP from server 192.168.1.1; our IP address is 192.168.1.2 | |
5625 | Filename 'uImage'. | |
5626 | Load address: 0x200000 | |
5627 | Loading:############ | |
5628 | done | |
5629 | Bytes transferred = 1029407 (fb51f hex) | |
5630 | => print loadaddr | |
5631 | loadaddr=200000 | |
5632 | => print oftaddr | |
5633 | oftaddr=0x300000 | |
5634 | => bootm $loadaddr - $oftaddr | |
5635 | ## Booting image at 00200000 ... | |
a9398e01 WD |
5636 | Image Name: Linux-2.6.17-dirty |
5637 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
5638 | Data Size: 1029343 Bytes = 1005.2 kB | |
0267768e | 5639 | Load Address: 00000000 |
a9398e01 | 5640 | Entry Point: 00000000 |
0267768e MM |
5641 | Verifying Checksum ... OK |
5642 | Uncompressing Kernel Image ... OK | |
5643 | Booting using flat device tree at 0x300000 | |
5644 | Using MPC85xx ADS machine description | |
5645 | Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb | |
5646 | [snip] | |
5647 | ||
5648 | ||
2729af9d WD |
5649 | More About U-Boot Image Types: |
5650 | ------------------------------ | |
5651 | ||
5652 | U-Boot supports the following image types: | |
5653 | ||
5654 | "Standalone Programs" are directly runnable in the environment | |
5655 | provided by U-Boot; it is expected that (if they behave | |
5656 | well) you can continue to work in U-Boot after return from | |
5657 | the Standalone Program. | |
5658 | "OS Kernel Images" are usually images of some Embedded OS which | |
5659 | will take over control completely. Usually these programs | |
5660 | will install their own set of exception handlers, device | |
5661 | drivers, set up the MMU, etc. - this means, that you cannot | |
5662 | expect to re-enter U-Boot except by resetting the CPU. | |
5663 | "RAMDisk Images" are more or less just data blocks, and their | |
5664 | parameters (address, size) are passed to an OS kernel that is | |
5665 | being started. | |
5666 | "Multi-File Images" contain several images, typically an OS | |
5667 | (Linux) kernel image and one or more data images like | |
5668 | RAMDisks. This construct is useful for instance when you want | |
5669 | to boot over the network using BOOTP etc., where the boot | |
5670 | server provides just a single image file, but you want to get | |
5671 | for instance an OS kernel and a RAMDisk image. | |
5672 | ||
5673 | "Multi-File Images" start with a list of image sizes, each | |
5674 | image size (in bytes) specified by an "uint32_t" in network | |
5675 | byte order. This list is terminated by an "(uint32_t)0". | |
5676 | Immediately after the terminating 0 follow the images, one by | |
5677 | one, all aligned on "uint32_t" boundaries (size rounded up to | |
5678 | a multiple of 4 bytes). | |
5679 | ||
5680 | "Firmware Images" are binary images containing firmware (like | |
5681 | U-Boot or FPGA images) which usually will be programmed to | |
5682 | flash memory. | |
5683 | ||
5684 | "Script files" are command sequences that will be executed by | |
5685 | U-Boot's command interpreter; this feature is especially | |
5686 | useful when you configure U-Boot to use a real shell (hush) | |
5687 | as command interpreter. | |
5688 | ||
44f074c7 MV |
5689 | Booting the Linux zImage: |
5690 | ------------------------- | |
5691 | ||
5692 | On some platforms, it's possible to boot Linux zImage. This is done | |
5693 | using the "bootz" command. The syntax of "bootz" command is the same | |
5694 | as the syntax of "bootm" command. | |
5695 | ||
8ac28563 | 5696 | Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply |
017e1f3f MV |
5697 | kernel with raw initrd images. The syntax is slightly different, the |
5698 | address of the initrd must be augmented by it's size, in the following | |
5699 | format: "<initrd addres>:<initrd size>". | |
5700 | ||
2729af9d WD |
5701 | |
5702 | Standalone HOWTO: | |
5703 | ================= | |
5704 | ||
5705 | One of the features of U-Boot is that you can dynamically load and | |
5706 | run "standalone" applications, which can use some resources of | |
5707 | U-Boot like console I/O functions or interrupt services. | |
5708 | ||
5709 | Two simple examples are included with the sources: | |
5710 | ||
5711 | "Hello World" Demo: | |
5712 | ------------------- | |
5713 | ||
5714 | 'examples/hello_world.c' contains a small "Hello World" Demo | |
5715 | application; it is automatically compiled when you build U-Boot. | |
5716 | It's configured to run at address 0x00040004, so you can play with it | |
5717 | like that: | |
5718 | ||
5719 | => loads | |
5720 | ## Ready for S-Record download ... | |
5721 | ~>examples/hello_world.srec | |
5722 | 1 2 3 4 5 6 7 8 9 10 11 ... | |
5723 | [file transfer complete] | |
5724 | [connected] | |
5725 | ## Start Addr = 0x00040004 | |
5726 | ||
5727 | => go 40004 Hello World! This is a test. | |
5728 | ## Starting application at 0x00040004 ... | |
5729 | Hello World | |
5730 | argc = 7 | |
5731 | argv[0] = "40004" | |
5732 | argv[1] = "Hello" | |
5733 | argv[2] = "World!" | |
5734 | argv[3] = "This" | |
5735 | argv[4] = "is" | |
5736 | argv[5] = "a" | |
5737 | argv[6] = "test." | |
5738 | argv[7] = "<NULL>" | |
5739 | Hit any key to exit ... | |
5740 | ||
5741 | ## Application terminated, rc = 0x0 | |
5742 | ||
5743 | Another example, which demonstrates how to register a CPM interrupt | |
5744 | handler with the U-Boot code, can be found in 'examples/timer.c'. | |
5745 | Here, a CPM timer is set up to generate an interrupt every second. | |
5746 | The interrupt service routine is trivial, just printing a '.' | |
5747 | character, but this is just a demo program. The application can be | |
5748 | controlled by the following keys: | |
5749 | ||
5750 | ? - print current values og the CPM Timer registers | |
5751 | b - enable interrupts and start timer | |
5752 | e - stop timer and disable interrupts | |
5753 | q - quit application | |
5754 | ||
5755 | => loads | |
5756 | ## Ready for S-Record download ... | |
5757 | ~>examples/timer.srec | |
5758 | 1 2 3 4 5 6 7 8 9 10 11 ... | |
5759 | [file transfer complete] | |
5760 | [connected] | |
5761 | ## Start Addr = 0x00040004 | |
5762 | ||
5763 | => go 40004 | |
5764 | ## Starting application at 0x00040004 ... | |
5765 | TIMERS=0xfff00980 | |
5766 | Using timer 1 | |
5767 | tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 | |
5768 | ||
5769 | Hit 'b': | |
5770 | [q, b, e, ?] Set interval 1000000 us | |
5771 | Enabling timer | |
5772 | Hit '?': | |
5773 | [q, b, e, ?] ........ | |
5774 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 | |
5775 | Hit '?': | |
5776 | [q, b, e, ?] . | |
5777 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 | |
5778 | Hit '?': | |
5779 | [q, b, e, ?] . | |
5780 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 | |
5781 | Hit '?': | |
5782 | [q, b, e, ?] . | |
5783 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 | |
5784 | Hit 'e': | |
5785 | [q, b, e, ?] ...Stopping timer | |
5786 | Hit 'q': | |
5787 | [q, b, e, ?] ## Application terminated, rc = 0x0 | |
5788 | ||
5789 | ||
5790 | Minicom warning: | |
5791 | ================ | |
5792 | ||
5793 | Over time, many people have reported problems when trying to use the | |
5794 | "minicom" terminal emulation program for serial download. I (wd) | |
5795 | consider minicom to be broken, and recommend not to use it. Under | |
5796 | Unix, I recommend to use C-Kermit for general purpose use (and | |
5797 | especially for kermit binary protocol download ("loadb" command), and | |
e53515a2 KP |
5798 | use "cu" for S-Record download ("loads" command). See |
5799 | http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. | |
5800 | for help with kermit. | |
5801 | ||
2729af9d WD |
5802 | |
5803 | Nevertheless, if you absolutely want to use it try adding this | |
5804 | configuration to your "File transfer protocols" section: | |
5805 | ||
5806 | Name Program Name U/D FullScr IO-Red. Multi | |
5807 | X kermit /usr/bin/kermit -i -l %l -s Y U Y N N | |
5808 | Y kermit /usr/bin/kermit -i -l %l -r N D Y N N | |
5809 | ||
5810 | ||
5811 | NetBSD Notes: | |
5812 | ============= | |
5813 | ||
5814 | Starting at version 0.9.2, U-Boot supports NetBSD both as host | |
5815 | (build U-Boot) and target system (boots NetBSD/mpc8xx). | |
5816 | ||
5817 | Building requires a cross environment; it is known to work on | |
5818 | NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also | |
5819 | need gmake since the Makefiles are not compatible with BSD make). | |
5820 | Note that the cross-powerpc package does not install include files; | |
5821 | attempting to build U-Boot will fail because <machine/ansi.h> is | |
5822 | missing. This file has to be installed and patched manually: | |
5823 | ||
5824 | # cd /usr/pkg/cross/powerpc-netbsd/include | |
5825 | # mkdir powerpc | |
5826 | # ln -s powerpc machine | |
5827 | # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h | |
5828 | # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST | |
5829 | ||
5830 | Native builds *don't* work due to incompatibilities between native | |
5831 | and U-Boot include files. | |
5832 | ||
5833 | Booting assumes that (the first part of) the image booted is a | |
5834 | stage-2 loader which in turn loads and then invokes the kernel | |
5835 | proper. Loader sources will eventually appear in the NetBSD source | |
5836 | tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the | |
2a8af187 | 5837 | meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz |
2729af9d WD |
5838 | |
5839 | ||
5840 | Implementation Internals: | |
5841 | ========================= | |
5842 | ||
5843 | The following is not intended to be a complete description of every | |
5844 | implementation detail. However, it should help to understand the | |
5845 | inner workings of U-Boot and make it easier to port it to custom | |
5846 | hardware. | |
5847 | ||
5848 | ||
5849 | Initial Stack, Global Data: | |
5850 | --------------------------- | |
5851 | ||
5852 | The implementation of U-Boot is complicated by the fact that U-Boot | |
5853 | starts running out of ROM (flash memory), usually without access to | |
5854 | system RAM (because the memory controller is not initialized yet). | |
5855 | This means that we don't have writable Data or BSS segments, and BSS | |
5856 | is not initialized as zero. To be able to get a C environment working | |
5857 | at all, we have to allocate at least a minimal stack. Implementation | |
5858 | options for this are defined and restricted by the CPU used: Some CPU | |
5859 | models provide on-chip memory (like the IMMR area on MPC8xx and | |
5860 | MPC826x processors), on others (parts of) the data cache can be | |
5861 | locked as (mis-) used as memory, etc. | |
5862 | ||
218ca724 | 5863 | Chris Hallinan posted a good summary of these issues to the |
0668236b | 5864 | U-Boot mailing list: |
2729af9d WD |
5865 | |
5866 | Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? | |
5867 | From: "Chris Hallinan" <[email protected]> | |
5868 | Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) | |
5869 | ... | |
5870 | ||
5871 | Correct me if I'm wrong, folks, but the way I understand it | |
5872 | is this: Using DCACHE as initial RAM for Stack, etc, does not | |
5873 | require any physical RAM backing up the cache. The cleverness | |
5874 | is that the cache is being used as a temporary supply of | |
5875 | necessary storage before the SDRAM controller is setup. It's | |
11ccc33f | 5876 | beyond the scope of this list to explain the details, but you |
2729af9d WD |
5877 | can see how this works by studying the cache architecture and |
5878 | operation in the architecture and processor-specific manuals. | |
5879 | ||
5880 | OCM is On Chip Memory, which I believe the 405GP has 4K. It | |
5881 | is another option for the system designer to use as an | |
11ccc33f | 5882 | initial stack/RAM area prior to SDRAM being available. Either |
2729af9d WD |
5883 | option should work for you. Using CS 4 should be fine if your |
5884 | board designers haven't used it for something that would | |
5885 | cause you grief during the initial boot! It is frequently not | |
5886 | used. | |
5887 | ||
6d0f6bcf | 5888 | CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere |
2729af9d WD |
5889 | with your processor/board/system design. The default value |
5890 | you will find in any recent u-boot distribution in | |
8a316c9b | 5891 | walnut.h should work for you. I'd set it to a value larger |
2729af9d WD |
5892 | than your SDRAM module. If you have a 64MB SDRAM module, set |
5893 | it above 400_0000. Just make sure your board has no resources | |
5894 | that are supposed to respond to that address! That code in | |
5895 | start.S has been around a while and should work as is when | |
5896 | you get the config right. | |
5897 | ||
5898 | -Chris Hallinan | |
5899 | DS4.COM, Inc. | |
5900 | ||
5901 | It is essential to remember this, since it has some impact on the C | |
5902 | code for the initialization procedures: | |
5903 | ||
5904 | * Initialized global data (data segment) is read-only. Do not attempt | |
5905 | to write it. | |
5906 | ||
b445bbb4 | 5907 | * Do not use any uninitialized global data (or implicitly initialized |
2729af9d WD |
5908 | as zero data - BSS segment) at all - this is undefined, initiali- |
5909 | zation is performed later (when relocating to RAM). | |
5910 | ||
5911 | * Stack space is very limited. Avoid big data buffers or things like | |
5912 | that. | |
5913 | ||
5914 | Having only the stack as writable memory limits means we cannot use | |
b445bbb4 | 5915 | normal global data to share information between the code. But it |
2729af9d WD |
5916 | turned out that the implementation of U-Boot can be greatly |
5917 | simplified by making a global data structure (gd_t) available to all | |
5918 | functions. We could pass a pointer to this data as argument to _all_ | |
5919 | functions, but this would bloat the code. Instead we use a feature of | |
5920 | the GCC compiler (Global Register Variables) to share the data: we | |
5921 | place a pointer (gd) to the global data into a register which we | |
5922 | reserve for this purpose. | |
5923 | ||
5924 | When choosing a register for such a purpose we are restricted by the | |
5925 | relevant (E)ABI specifications for the current architecture, and by | |
5926 | GCC's implementation. | |
5927 | ||
5928 | For PowerPC, the following registers have specific use: | |
5929 | R1: stack pointer | |
e7670f6c | 5930 | R2: reserved for system use |
2729af9d WD |
5931 | R3-R4: parameter passing and return values |
5932 | R5-R10: parameter passing | |
5933 | R13: small data area pointer | |
5934 | R30: GOT pointer | |
5935 | R31: frame pointer | |
5936 | ||
e6bee808 JT |
5937 | (U-Boot also uses R12 as internal GOT pointer. r12 |
5938 | is a volatile register so r12 needs to be reset when | |
5939 | going back and forth between asm and C) | |
2729af9d | 5940 | |
e7670f6c | 5941 | ==> U-Boot will use R2 to hold a pointer to the global data |
2729af9d WD |
5942 | |
5943 | Note: on PPC, we could use a static initializer (since the | |
5944 | address of the global data structure is known at compile time), | |
5945 | but it turned out that reserving a register results in somewhat | |
5946 | smaller code - although the code savings are not that big (on | |
5947 | average for all boards 752 bytes for the whole U-Boot image, | |
5948 | 624 text + 127 data). | |
5949 | ||
c4db335c | 5950 | On Blackfin, the normal C ABI (except for P3) is followed as documented here: |
4c58eb55 MF |
5951 | http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface |
5952 | ||
c4db335c | 5953 | ==> U-Boot will use P3 to hold a pointer to the global data |
4c58eb55 | 5954 | |
2729af9d WD |
5955 | On ARM, the following registers are used: |
5956 | ||
5957 | R0: function argument word/integer result | |
5958 | R1-R3: function argument word | |
12eba1b4 JH |
5959 | R9: platform specific |
5960 | R10: stack limit (used only if stack checking is enabled) | |
2729af9d WD |
5961 | R11: argument (frame) pointer |
5962 | R12: temporary workspace | |
5963 | R13: stack pointer | |
5964 | R14: link register | |
5965 | R15: program counter | |
5966 | ||
12eba1b4 JH |
5967 | ==> U-Boot will use R9 to hold a pointer to the global data |
5968 | ||
5969 | Note: on ARM, only R_ARM_RELATIVE relocations are supported. | |
2729af9d | 5970 | |
0df01fd3 TC |
5971 | On Nios II, the ABI is documented here: |
5972 | http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf | |
5973 | ||
5974 | ==> U-Boot will use gp to hold a pointer to the global data | |
5975 | ||
5976 | Note: on Nios II, we give "-G0" option to gcc and don't use gp | |
5977 | to access small data sections, so gp is free. | |
5978 | ||
afc1ce82 ML |
5979 | On NDS32, the following registers are used: |
5980 | ||
5981 | R0-R1: argument/return | |
5982 | R2-R5: argument | |
5983 | R15: temporary register for assembler | |
5984 | R16: trampoline register | |
5985 | R28: frame pointer (FP) | |
5986 | R29: global pointer (GP) | |
5987 | R30: link register (LP) | |
5988 | R31: stack pointer (SP) | |
5989 | PC: program counter (PC) | |
5990 | ||
5991 | ==> U-Boot will use R10 to hold a pointer to the global data | |
5992 | ||
d87080b7 WD |
5993 | NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, |
5994 | or current versions of GCC may "optimize" the code too much. | |
2729af9d WD |
5995 | |
5996 | Memory Management: | |
5997 | ------------------ | |
5998 | ||
5999 | U-Boot runs in system state and uses physical addresses, i.e. the | |
6000 | MMU is not used either for address mapping nor for memory protection. | |
6001 | ||
6002 | The available memory is mapped to fixed addresses using the memory | |
6003 | controller. In this process, a contiguous block is formed for each | |
6004 | memory type (Flash, SDRAM, SRAM), even when it consists of several | |
6005 | physical memory banks. | |
6006 | ||
6007 | U-Boot is installed in the first 128 kB of the first Flash bank (on | |
6008 | TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After | |
6009 | booting and sizing and initializing DRAM, the code relocates itself | |
6010 | to the upper end of DRAM. Immediately below the U-Boot code some | |
6d0f6bcf | 6011 | memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN |
2729af9d WD |
6012 | configuration setting]. Below that, a structure with global Board |
6013 | Info data is placed, followed by the stack (growing downward). | |
6014 | ||
6015 | Additionally, some exception handler code is copied to the low 8 kB | |
6016 | of DRAM (0x00000000 ... 0x00001FFF). | |
6017 | ||
6018 | So a typical memory configuration with 16 MB of DRAM could look like | |
6019 | this: | |
6020 | ||
6021 | 0x0000 0000 Exception Vector code | |
6022 | : | |
6023 | 0x0000 1FFF | |
6024 | 0x0000 2000 Free for Application Use | |
6025 | : | |
6026 | : | |
6027 | ||
6028 | : | |
6029 | : | |
6030 | 0x00FB FF20 Monitor Stack (Growing downward) | |
6031 | 0x00FB FFAC Board Info Data and permanent copy of global data | |
6032 | 0x00FC 0000 Malloc Arena | |
6033 | : | |
6034 | 0x00FD FFFF | |
6035 | 0x00FE 0000 RAM Copy of Monitor Code | |
6036 | ... eventually: LCD or video framebuffer | |
6037 | ... eventually: pRAM (Protected RAM - unchanged by reset) | |
6038 | 0x00FF FFFF [End of RAM] | |
6039 | ||
6040 | ||
6041 | System Initialization: | |
6042 | ---------------------- | |
c609719b | 6043 | |
2729af9d | 6044 | In the reset configuration, U-Boot starts at the reset entry point |
11ccc33f | 6045 | (on most PowerPC systems at address 0x00000100). Because of the reset |
b445bbb4 | 6046 | configuration for CS0# this is a mirror of the on board Flash memory. |
2729af9d WD |
6047 | To be able to re-map memory U-Boot then jumps to its link address. |
6048 | To be able to implement the initialization code in C, a (small!) | |
6049 | initial stack is set up in the internal Dual Ported RAM (in case CPUs | |
6050 | which provide such a feature like MPC8xx or MPC8260), or in a locked | |
6051 | part of the data cache. After that, U-Boot initializes the CPU core, | |
6052 | the caches and the SIU. | |
6053 | ||
6054 | Next, all (potentially) available memory banks are mapped using a | |
6055 | preliminary mapping. For example, we put them on 512 MB boundaries | |
6056 | (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash | |
6057 | on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is | |
6058 | programmed for SDRAM access. Using the temporary configuration, a | |
6059 | simple memory test is run that determines the size of the SDRAM | |
6060 | banks. | |
6061 | ||
6062 | When there is more than one SDRAM bank, and the banks are of | |
6063 | different size, the largest is mapped first. For equal size, the first | |
6064 | bank (CS2#) is mapped first. The first mapping is always for address | |
6065 | 0x00000000, with any additional banks following immediately to create | |
6066 | contiguous memory starting from 0. | |
6067 | ||
6068 | Then, the monitor installs itself at the upper end of the SDRAM area | |
6069 | and allocates memory for use by malloc() and for the global Board | |
6070 | Info data; also, the exception vector code is copied to the low RAM | |
6071 | pages, and the final stack is set up. | |
6072 | ||
6073 | Only after this relocation will you have a "normal" C environment; | |
6074 | until that you are restricted in several ways, mostly because you are | |
6075 | running from ROM, and because the code will have to be relocated to a | |
6076 | new address in RAM. | |
6077 | ||
6078 | ||
6079 | U-Boot Porting Guide: | |
6080 | ---------------------- | |
c609719b | 6081 | |
2729af9d WD |
6082 | [Based on messages by Jerry Van Baren in the U-Boot-Users mailing |
6083 | list, October 2002] | |
c609719b WD |
6084 | |
6085 | ||
6c3fef28 | 6086 | int main(int argc, char *argv[]) |
2729af9d WD |
6087 | { |
6088 | sighandler_t no_more_time; | |
c609719b | 6089 | |
6c3fef28 JVB |
6090 | signal(SIGALRM, no_more_time); |
6091 | alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); | |
c609719b | 6092 | |
2729af9d | 6093 | if (available_money > available_manpower) { |
6c3fef28 | 6094 | Pay consultant to port U-Boot; |
c609719b WD |
6095 | return 0; |
6096 | } | |
6097 | ||
2729af9d WD |
6098 | Download latest U-Boot source; |
6099 | ||
0668236b | 6100 | Subscribe to u-boot mailing list; |
2729af9d | 6101 | |
6c3fef28 JVB |
6102 | if (clueless) |
6103 | email("Hi, I am new to U-Boot, how do I get started?"); | |
2729af9d WD |
6104 | |
6105 | while (learning) { | |
6106 | Read the README file in the top level directory; | |
6c3fef28 JVB |
6107 | Read http://www.denx.de/twiki/bin/view/DULG/Manual; |
6108 | Read applicable doc/*.README; | |
2729af9d | 6109 | Read the source, Luke; |
6c3fef28 | 6110 | /* find . -name "*.[chS]" | xargs grep -i <keyword> */ |
2729af9d WD |
6111 | } |
6112 | ||
6c3fef28 JVB |
6113 | if (available_money > toLocalCurrency ($2500)) |
6114 | Buy a BDI3000; | |
6115 | else | |
2729af9d | 6116 | Add a lot of aggravation and time; |
2729af9d | 6117 | |
6c3fef28 JVB |
6118 | if (a similar board exists) { /* hopefully... */ |
6119 | cp -a board/<similar> board/<myboard> | |
6120 | cp include/configs/<similar>.h include/configs/<myboard>.h | |
6121 | } else { | |
6122 | Create your own board support subdirectory; | |
6123 | Create your own board include/configs/<myboard>.h file; | |
6124 | } | |
6125 | Edit new board/<myboard> files | |
6126 | Edit new include/configs/<myboard>.h | |
6127 | ||
6128 | while (!accepted) { | |
6129 | while (!running) { | |
6130 | do { | |
6131 | Add / modify source code; | |
6132 | } until (compiles); | |
6133 | Debug; | |
6134 | if (clueless) | |
6135 | email("Hi, I am having problems..."); | |
6136 | } | |
6137 | Send patch file to the U-Boot email list; | |
6138 | if (reasonable critiques) | |
6139 | Incorporate improvements from email list code review; | |
6140 | else | |
6141 | Defend code as written; | |
2729af9d | 6142 | } |
2729af9d WD |
6143 | |
6144 | return 0; | |
6145 | } | |
6146 | ||
6147 | void no_more_time (int sig) | |
6148 | { | |
6149 | hire_a_guru(); | |
6150 | } | |
6151 | ||
c609719b | 6152 | |
2729af9d WD |
6153 | Coding Standards: |
6154 | ----------------- | |
c609719b | 6155 | |
2729af9d | 6156 | All contributions to U-Boot should conform to the Linux kernel |
2c051651 | 6157 | coding style; see the file "Documentation/CodingStyle" and the script |
7ca9296e | 6158 | "scripts/Lindent" in your Linux kernel source directory. |
2c051651 DZ |
6159 | |
6160 | Source files originating from a different project (for example the | |
6161 | MTD subsystem) are generally exempt from these guidelines and are not | |
b445bbb4 | 6162 | reformatted to ease subsequent migration to newer versions of those |
2c051651 DZ |
6163 | sources. |
6164 | ||
6165 | Please note that U-Boot is implemented in C (and to some small parts in | |
6166 | Assembler); no C++ is used, so please do not use C++ style comments (//) | |
6167 | in your code. | |
c609719b | 6168 | |
2729af9d WD |
6169 | Please also stick to the following formatting rules: |
6170 | - remove any trailing white space | |
7ca9296e | 6171 | - use TAB characters for indentation and vertical alignment, not spaces |
2729af9d | 6172 | - make sure NOT to use DOS '\r\n' line feeds |
7ca9296e | 6173 | - do not add more than 2 consecutive empty lines to source files |
2729af9d | 6174 | - do not add trailing empty lines to source files |
180d3f74 | 6175 | |
2729af9d WD |
6176 | Submissions which do not conform to the standards may be returned |
6177 | with a request to reformat the changes. | |
c609719b WD |
6178 | |
6179 | ||
2729af9d WD |
6180 | Submitting Patches: |
6181 | ------------------- | |
c609719b | 6182 | |
2729af9d WD |
6183 | Since the number of patches for U-Boot is growing, we need to |
6184 | establish some rules. Submissions which do not conform to these rules | |
6185 | may be rejected, even when they contain important and valuable stuff. | |
c609719b | 6186 | |
0d28f34b | 6187 | Please see http://www.denx.de/wiki/U-Boot/Patches for details. |
218ca724 | 6188 | |
0668236b WD |
6189 | Patches shall be sent to the u-boot mailing list <[email protected]>; |
6190 | see http://lists.denx.de/mailman/listinfo/u-boot | |
6191 | ||
2729af9d WD |
6192 | When you send a patch, please include the following information with |
6193 | it: | |
c609719b | 6194 | |
2729af9d WD |
6195 | * For bug fixes: a description of the bug and how your patch fixes |
6196 | this bug. Please try to include a way of demonstrating that the | |
6197 | patch actually fixes something. | |
c609719b | 6198 | |
2729af9d WD |
6199 | * For new features: a description of the feature and your |
6200 | implementation. | |
c609719b | 6201 | |
2729af9d | 6202 | * A CHANGELOG entry as plaintext (separate from the patch) |
c609719b | 6203 | |
7207b366 RD |
6204 | * For major contributions, add a MAINTAINERS file with your |
6205 | information and associated file and directory references. | |
c609719b | 6206 | |
27af930e AA |
6207 | * When you add support for a new board, don't forget to add a |
6208 | maintainer e-mail address to the boards.cfg file, too. | |
c609719b | 6209 | |
2729af9d WD |
6210 | * If your patch adds new configuration options, don't forget to |
6211 | document these in the README file. | |
c609719b | 6212 | |
218ca724 WD |
6213 | * The patch itself. If you are using git (which is *strongly* |
6214 | recommended) you can easily generate the patch using the | |
7ca9296e | 6215 | "git format-patch". If you then use "git send-email" to send it to |
218ca724 WD |
6216 | the U-Boot mailing list, you will avoid most of the common problems |
6217 | with some other mail clients. | |
6218 | ||
6219 | If you cannot use git, use "diff -purN OLD NEW". If your version of | |
6220 | diff does not support these options, then get the latest version of | |
6221 | GNU diff. | |
c609719b | 6222 | |
218ca724 WD |
6223 | The current directory when running this command shall be the parent |
6224 | directory of the U-Boot source tree (i. e. please make sure that | |
6225 | your patch includes sufficient directory information for the | |
6226 | affected files). | |
6dff5529 | 6227 | |
218ca724 WD |
6228 | We prefer patches as plain text. MIME attachments are discouraged, |
6229 | and compressed attachments must not be used. | |
c609719b | 6230 | |
2729af9d WD |
6231 | * If one logical set of modifications affects or creates several |
6232 | files, all these changes shall be submitted in a SINGLE patch file. | |
52f52c14 | 6233 | |
2729af9d WD |
6234 | * Changesets that contain different, unrelated modifications shall be |
6235 | submitted as SEPARATE patches, one patch per changeset. | |
8bde7f77 | 6236 | |
52f52c14 | 6237 | |
2729af9d | 6238 | Notes: |
c609719b | 6239 | |
6de80f21 | 6240 | * Before sending the patch, run the buildman script on your patched |
2729af9d WD |
6241 | source tree and make sure that no errors or warnings are reported |
6242 | for any of the boards. | |
c609719b | 6243 | |
2729af9d WD |
6244 | * Keep your modifications to the necessary minimum: A patch |
6245 | containing several unrelated changes or arbitrary reformats will be | |
6246 | returned with a request to re-formatting / split it. | |
c609719b | 6247 | |
2729af9d WD |
6248 | * If you modify existing code, make sure that your new code does not |
6249 | add to the memory footprint of the code ;-) Small is beautiful! | |
6250 | When adding new features, these should compile conditionally only | |
6251 | (using #ifdef), and the resulting code with the new feature | |
6252 | disabled must not need more memory than the old code without your | |
6253 | modification. | |
90dc6704 | 6254 | |
0668236b WD |
6255 | * Remember that there is a size limit of 100 kB per message on the |
6256 | u-boot mailing list. Bigger patches will be moderated. If they are | |
6257 | reasonable and not too big, they will be acknowledged. But patches | |
6258 | bigger than the size limit should be avoided. |