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