]> git.ipfire.org Git - people/ms/u-boot.git/blame - README
lcd: restore ability to display 8 bpp BMPs on 16 bpp LCDs
[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
98f4a3df
SR
1553- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1554
1555 If this option is set, additionally to standard BMP
1556 images, gzipped BMP images can be displayed via the
1557 splashscreen support or the bmp command.
1558
d5011762
AG
1559- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1560
1561 If this option is set, 8-bit RLE compressed BMP images
1562 can be displayed via the splashscreen support or the
1563 bmp command.
1564
f2b96dfb
LW
1565- Do compresssing for memory range:
1566 CONFIG_CMD_ZIP
1567
1568 If this option is set, it would use zlib deflate method
1569 to compress the specified memory at its best effort.
1570
c29fdfc1
WD
1571- Compression support:
1572 CONFIG_BZIP2
1573
1574 If this option is set, support for bzip2 compressed
1575 images is included. If not, only uncompressed and gzip
1576 compressed images are supported.
1577
42d1f039 1578 NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf 1579 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f039 1580 be at least 4MB.
d791b1dc 1581
fc9c1727
LCM
1582 CONFIG_LZMA
1583
1584 If this option is set, support for lzma compressed
1585 images is included.
1586
1587 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1588 requires an amount of dynamic memory that is given by the
1589 formula:
1590
1591 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1592
1593 Where lc and lp stand for, respectively, Literal context bits
1594 and Literal pos bits.
1595
1596 This value is upper-bounded by 14MB in the worst case. Anyway,
1597 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1598 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1599 a very small buffer.
1600
1601 Use the lzmainfo tool to determinate the lc and lp values and
1602 then calculate the amount of needed dynamic memory (ensuring
6d0f6bcf 1603 the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727 1604
17ea1177
WD
1605- MII/PHY support:
1606 CONFIG_PHY_ADDR
1607
1608 The address of PHY on MII bus.
1609
1610 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1611
1612 The clock frequency of the MII bus
1613
1614 CONFIG_PHY_GIGE
1615
1616 If this option is set, support for speed/duplex
11ccc33f 1617 detection of gigabit PHY is included.
17ea1177
WD
1618
1619 CONFIG_PHY_RESET_DELAY
1620
1621 Some PHY like Intel LXT971A need extra delay after
1622 reset before any MII register access is possible.
1623 For such PHY, set this option to the usec delay
1624 required. (minimum 300usec for LXT971A)
1625
1626 CONFIG_PHY_CMD_DELAY (ppc4xx)
1627
1628 Some PHY like Intel LXT971A need extra delay after
1629 command issued before MII status register can be read
1630
c609719b
WD
1631- Ethernet address:
1632 CONFIG_ETHADDR
c68a05fe 1633 CONFIG_ETH1ADDR
c609719b
WD
1634 CONFIG_ETH2ADDR
1635 CONFIG_ETH3ADDR
c68a05fe 1636 CONFIG_ETH4ADDR
1637 CONFIG_ETH5ADDR
c609719b 1638
11ccc33f
MZ
1639 Define a default value for Ethernet address to use
1640 for the respective Ethernet interface, in case this
c609719b
WD
1641 is not determined automatically.
1642
1643- IP address:
1644 CONFIG_IPADDR
1645
1646 Define a default value for the IP address to use for
11ccc33f 1647 the default Ethernet interface, in case this is not
c609719b 1648 determined through e.g. bootp.
1ebcd654 1649 (Environment variable "ipaddr")
c609719b
WD
1650
1651- Server IP address:
1652 CONFIG_SERVERIP
1653
11ccc33f 1654 Defines a default value for the IP address of a TFTP
c609719b 1655 server to contact when using the "tftboot" command.
1ebcd654 1656 (Environment variable "serverip")
c609719b 1657
97cfe861
RG
1658 CONFIG_KEEP_SERVERADDR
1659
1660 Keeps the server's MAC address, in the env 'serveraddr'
1661 for passing to bootargs (like Linux's netconsole option)
1662
1ebcd654
WD
1663- Gateway IP address:
1664 CONFIG_GATEWAYIP
1665
1666 Defines a default value for the IP address of the
1667 default router where packets to other networks are
1668 sent to.
1669 (Environment variable "gatewayip")
1670
1671- Subnet mask:
1672 CONFIG_NETMASK
1673
1674 Defines a default value for the subnet mask (or
1675 routing prefix) which is used to determine if an IP
1676 address belongs to the local subnet or needs to be
1677 forwarded through a router.
1678 (Environment variable "netmask")
1679
53a5c424
DU
1680- Multicast TFTP Mode:
1681 CONFIG_MCAST_TFTP
1682
1683 Defines whether you want to support multicast TFTP as per
1684 rfc-2090; for example to work with atftp. Lets lots of targets
11ccc33f 1685 tftp down the same boot image concurrently. Note: the Ethernet
53a5c424
DU
1686 driver in use must provide a function: mcast() to join/leave a
1687 multicast group.
1688
c609719b
WD
1689- BOOTP Recovery Mode:
1690 CONFIG_BOOTP_RANDOM_DELAY
1691
1692 If you have many targets in a network that try to
1693 boot using BOOTP, you may want to avoid that all
1694 systems send out BOOTP requests at precisely the same
1695 moment (which would happen for instance at recovery
1696 from a power failure, when all systems will try to
1697 boot, thus flooding the BOOTP server. Defining
1698 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1699 inserted before sending out BOOTP requests. The
6c33c785 1700 following delays are inserted then:
c609719b
WD
1701
1702 1st BOOTP request: delay 0 ... 1 sec
1703 2nd BOOTP request: delay 0 ... 2 sec
1704 3rd BOOTP request: delay 0 ... 4 sec
1705 4th and following
1706 BOOTP requests: delay 0 ... 8 sec
1707
fe389a82 1708- DHCP Advanced Options:
1fe80d79
JL
1709 You can fine tune the DHCP functionality by defining
1710 CONFIG_BOOTP_* symbols:
1711
1712 CONFIG_BOOTP_SUBNETMASK
1713 CONFIG_BOOTP_GATEWAY
1714 CONFIG_BOOTP_HOSTNAME
1715 CONFIG_BOOTP_NISDOMAIN
1716 CONFIG_BOOTP_BOOTPATH
1717 CONFIG_BOOTP_BOOTFILESIZE
1718 CONFIG_BOOTP_DNS
1719 CONFIG_BOOTP_DNS2
1720 CONFIG_BOOTP_SEND_HOSTNAME
1721 CONFIG_BOOTP_NTPSERVER
1722 CONFIG_BOOTP_TIMEOFFSET
1723 CONFIG_BOOTP_VENDOREX
2c00e099 1724 CONFIG_BOOTP_MAY_FAIL
fe389a82 1725
5d110f0a
WC
1726 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1727 environment variable, not the BOOTP server.
fe389a82 1728
2c00e099
JH
1729 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1730 after the configured retry count, the call will fail
1731 instead of starting over. This can be used to fail over
1732 to Link-local IP address configuration if the DHCP server
1733 is not available.
1734
fe389a82
SR
1735 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1736 serverip from a DHCP server, it is possible that more
1737 than one DNS serverip is offered to the client.
1738 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1739 serverip will be stored in the additional environment
1740 variable "dnsip2". The first DNS serverip is always
1741 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1fe80d79 1742 is defined.
fe389a82
SR
1743
1744 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1745 to do a dynamic update of a DNS server. To do this, they
1746 need the hostname of the DHCP requester.
5d110f0a 1747 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79
JL
1748 of the "hostname" environment variable is passed as
1749 option 12 to the DHCP server.
fe389a82 1750
d9a2f416
AV
1751 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1752
1753 A 32bit value in microseconds for a delay between
1754 receiving a "DHCP Offer" and sending the "DHCP Request".
1755 This fixes a problem with certain DHCP servers that don't
1756 respond 100% of the time to a "DHCP request". E.g. On an
1757 AT91RM9200 processor running at 180MHz, this delay needed
1758 to be *at least* 15,000 usec before a Windows Server 2003
1759 DHCP server would reply 100% of the time. I recommend at
1760 least 50,000 usec to be safe. The alternative is to hope
1761 that one of the retries will be successful but note that
1762 the DHCP timeout and retry process takes a longer than
1763 this delay.
1764
d22c338e
JH
1765 - Link-local IP address negotiation:
1766 Negotiate with other link-local clients on the local network
1767 for an address that doesn't require explicit configuration.
1768 This is especially useful if a DHCP server cannot be guaranteed
1769 to exist in all environments that the device must operate.
1770
1771 See doc/README.link-local for more information.
1772
a3d991bd 1773 - CDP Options:
6e592385 1774 CONFIG_CDP_DEVICE_ID
a3d991bd
WD
1775
1776 The device id used in CDP trigger frames.
1777
1778 CONFIG_CDP_DEVICE_ID_PREFIX
1779
1780 A two character string which is prefixed to the MAC address
1781 of the device.
1782
1783 CONFIG_CDP_PORT_ID
1784
1785 A printf format string which contains the ascii name of
1786 the port. Normally is set to "eth%d" which sets
11ccc33f 1787 eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd
WD
1788
1789 CONFIG_CDP_CAPABILITIES
1790
1791 A 32bit integer which indicates the device capabilities;
1792 0x00000010 for a normal host which does not forwards.
1793
1794 CONFIG_CDP_VERSION
1795
1796 An ascii string containing the version of the software.
1797
1798 CONFIG_CDP_PLATFORM
1799
1800 An ascii string containing the name of the platform.
1801
1802 CONFIG_CDP_TRIGGER
1803
1804 A 32bit integer sent on the trigger.
1805
1806 CONFIG_CDP_POWER_CONSUMPTION
1807
1808 A 16bit integer containing the power consumption of the
1809 device in .1 of milliwatts.
1810
1811 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1812
1813 A byte containing the id of the VLAN.
1814
c609719b
WD
1815- Status LED: CONFIG_STATUS_LED
1816
1817 Several configurations allow to display the current
1818 status using a LED. For instance, the LED will blink
1819 fast while running U-Boot code, stop blinking as
1820 soon as a reply to a BOOTP request was received, and
1821 start blinking slow once the Linux kernel is running
1822 (supported by a status LED driver in the Linux
1823 kernel). Defining CONFIG_STATUS_LED enables this
1824 feature in U-Boot.
1825
1826- CAN Support: CONFIG_CAN_DRIVER
1827
1828 Defining CONFIG_CAN_DRIVER enables CAN driver support
1829 on those systems that support this (optional)
1830 feature, like the TQM8xxL modules.
1831
1832- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1833
b37c7e5e 1834 These enable I2C serial bus commands. Defining either of
945af8d7 1835 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
11ccc33f 1836 include the appropriate I2C driver for the selected CPU.
c609719b 1837
945af8d7 1838 This will allow you to use i2c commands at the u-boot
602ad3b3 1839 command line (as long as you set CONFIG_CMD_I2C in
b37c7e5e
WD
1840 CONFIG_COMMANDS) and communicate with i2c based realtime
1841 clock chips. See common/cmd_i2c.c for a description of the
43d9616c 1842 command line interface.
c609719b 1843
bb99ad6d 1844 CONFIG_HARD_I2C selects a hardware I2C controller.
b37c7e5e 1845
945af8d7 1846 CONFIG_SOFT_I2C configures u-boot to use a software (aka
b37c7e5e
WD
1847 bit-banging) driver instead of CPM or similar hardware
1848 support for I2C.
c609719b 1849
945af8d7 1850 There are several other quantities that must also be
b37c7e5e 1851 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
c609719b 1852
6d0f6bcf 1853 In both cases you will need to define CONFIG_SYS_I2C_SPEED
945af8d7 1854 to be the frequency (in Hz) at which you wish your i2c bus
6d0f6bcf 1855 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
11ccc33f 1856 the CPU's i2c node address).
945af8d7 1857
8d321b81 1858 Now, the u-boot i2c code for the mpc8xx
a47a12be 1859 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
8d321b81
PT
1860 and so its address should therefore be cleared to 0 (See,
1861 eg, MPC823e User's Manual p.16-473). So, set
1862 CONFIG_SYS_I2C_SLAVE to 0.
c609719b 1863
5da71efa
EM
1864 CONFIG_SYS_I2C_INIT_MPC5XXX
1865
1866 When a board is reset during an i2c bus transfer
1867 chips might think that the current transfer is still
1868 in progress. Reset the slave devices by sending start
1869 commands until the slave device responds.
1870
945af8d7 1871 That's all that's required for CONFIG_HARD_I2C.
c609719b 1872
b37c7e5e
WD
1873 If you use the software i2c interface (CONFIG_SOFT_I2C)
1874 then the following macros need to be defined (examples are
1875 from include/configs/lwmon.h):
c609719b
WD
1876
1877 I2C_INIT
1878
b37c7e5e 1879 (Optional). Any commands necessary to enable the I2C
43d9616c 1880 controller or configure ports.
c609719b 1881
ba56f625 1882 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
b37c7e5e 1883
c609719b
WD
1884 I2C_PORT
1885
43d9616c
WD
1886 (Only for MPC8260 CPU). The I/O port to use (the code
1887 assumes both bits are on the same port). Valid values
1888 are 0..3 for ports A..D.
c609719b
WD
1889
1890 I2C_ACTIVE
1891
1892 The code necessary to make the I2C data line active
1893 (driven). If the data line is open collector, this
1894 define can be null.
1895
b37c7e5e
WD
1896 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1897
c609719b
WD
1898 I2C_TRISTATE
1899
1900 The code necessary to make the I2C data line tri-stated
1901 (inactive). If the data line is open collector, this
1902 define can be null.
1903
b37c7e5e
WD
1904 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1905
c609719b
WD
1906 I2C_READ
1907
1908 Code that returns TRUE if the I2C data line is high,
1909 FALSE if it is low.
1910
b37c7e5e
WD
1911 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1912
c609719b
WD
1913 I2C_SDA(bit)
1914
1915 If <bit> is TRUE, sets the I2C data line high. If it
1916 is FALSE, it clears it (low).
1917
b37c7e5e 1918 eg: #define I2C_SDA(bit) \
2535d602 1919 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
ba56f625 1920 else immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e 1921
c609719b
WD
1922 I2C_SCL(bit)
1923
1924 If <bit> is TRUE, sets the I2C clock line high. If it
1925 is FALSE, it clears it (low).
1926
b37c7e5e 1927 eg: #define I2C_SCL(bit) \
2535d602 1928 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
ba56f625 1929 else immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e 1930
c609719b
WD
1931 I2C_DELAY
1932
1933 This delay is invoked four times per clock cycle so this
1934 controls the rate of data transfer. The data rate thus
b37c7e5e 1935 is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d7
WD
1936 like:
1937
b37c7e5e 1938 #define I2C_DELAY udelay(2)
c609719b 1939
793b5726
MF
1940 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1941
1942 If your arch supports the generic GPIO framework (asm/gpio.h),
1943 then you may alternatively define the two GPIOs that are to be
1944 used as SCL / SDA. Any of the previous I2C_xxx macros will
1945 have GPIO-based defaults assigned to them as appropriate.
1946
1947 You should define these to the GPIO value as given directly to
1948 the generic GPIO functions.
1949
6d0f6bcf 1950 CONFIG_SYS_I2C_INIT_BOARD
47cd00fa 1951
8bde7f77
WD
1952 When a board is reset during an i2c bus transfer
1953 chips might think that the current transfer is still
1954 in progress. On some boards it is possible to access
1955 the i2c SCLK line directly, either by using the
1956 processor pin as a GPIO or by having a second pin
1957 connected to the bus. If this option is defined a
1958 custom i2c_init_board() routine in boards/xxx/board.c
1959 is run early in the boot sequence.
47cd00fa 1960
26a33504
RR
1961 CONFIG_SYS_I2C_BOARD_LATE_INIT
1962
1963 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1964 defined a custom i2c_board_late_init() routine in
1965 boards/xxx/board.c is run AFTER the operations in i2c_init()
1966 is completed. This callpoint can be used to unreset i2c bus
1967 using CPU i2c controller register accesses for CPUs whose i2c
1968 controller provide such a method. It is called at the end of
1969 i2c_init() to allow i2c_init operations to setup the i2c bus
1970 controller on the CPU (e.g. setting bus speed & slave address).
1971
17ea1177
WD
1972 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1973
1974 This option enables configuration of bi_iic_fast[] flags
1975 in u-boot bd_info structure based on u-boot environment
1976 variable "i2cfast". (see also i2cfast)
1977
bb99ad6d
BW
1978 CONFIG_I2C_MULTI_BUS
1979
1980 This option allows the use of multiple I2C buses, each of which
c0f40859
WD
1981 must have a controller. At any point in time, only one bus is
1982 active. To switch to a different bus, use the 'i2c dev' command.
bb99ad6d
BW
1983 Note that bus numbering is zero-based.
1984
6d0f6bcf 1985 CONFIG_SYS_I2C_NOPROBES
bb99ad6d
BW
1986
1987 This option specifies a list of I2C devices that will be skipped
c0f40859 1988 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
0f89c54b
PT
1989 is set, specify a list of bus-device pairs. Otherwise, specify
1990 a 1D array of device addresses
bb99ad6d
BW
1991
1992 e.g.
1993 #undef CONFIG_I2C_MULTI_BUS
c0f40859 1994 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d
BW
1995
1996 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1997
c0f40859 1998 #define CONFIG_I2C_MULTI_BUS
6d0f6bcf 1999 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d
BW
2000
2001 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2002
6d0f6bcf 2003 CONFIG_SYS_SPD_BUS_NUM
be5e6181
TT
2004
2005 If defined, then this indicates the I2C bus number for DDR SPD.
2006 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2007
6d0f6bcf 2008 CONFIG_SYS_RTC_BUS_NUM
0dc018ec
SR
2009
2010 If defined, then this indicates the I2C bus number for the RTC.
2011 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2012
6d0f6bcf 2013 CONFIG_SYS_DTT_BUS_NUM
0dc018ec
SR
2014
2015 If defined, then this indicates the I2C bus number for the DTT.
2016 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2017
6d0f6bcf 2018 CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f
VG
2019
2020 If defined, specifies the I2C address of the DTT device.
2021 If not defined, then U-Boot uses predefined value for
2022 specified DTT device.
2023
be5e6181
TT
2024 CONFIG_FSL_I2C
2025
2026 Define this option if you want to use Freescale's I2C driver in
7817cb20 2027 drivers/i2c/fsl_i2c.c.
be5e6181 2028
67b23a32
HS
2029 CONFIG_I2C_MUX
2030
2031 Define this option if you have I2C devices reached over 1 .. n
2032 I2C Muxes like the pca9544a. This option addes a new I2C
2033 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2034 new I2C Bus to the existing I2C Busses. If you select the
2035 new Bus with "i2c dev", u-bbot sends first the commandos for
2036 the muxes to activate this new "bus".
2037
2038 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2039 feature!
2040
2041 Example:
2042 Adding a new I2C Bus reached over 2 pca9544a muxes
2043 The First mux with address 70 and channel 6
2044 The Second mux with address 71 and channel 4
2045
2046 => i2c bus pca9544a:70:6:pca9544a:71:4
2047
2048 Use the "i2c bus" command without parameter, to get a list
2049 of I2C Busses with muxes:
2050
2051 => i2c bus
2052 Busses reached over muxes:
2053 Bus ID: 2
2054 reached over Mux(es):
2055 pca9544a@70 ch: 4
2056 Bus ID: 3
2057 reached over Mux(es):
2058 pca9544a@70 ch: 6
2059 pca9544a@71 ch: 4
2060 =>
2061
2062 If you now switch to the new I2C Bus 3 with "i2c dev 3"
f9a78b8d
MJ
2063 u-boot first sends the command to the mux@70 to enable
2064 channel 6, and then the command to the mux@71 to enable
67b23a32
HS
2065 the channel 4.
2066
2067 After that, you can use the "normal" i2c commands as
f9a78b8d 2068 usual to communicate with your I2C devices behind
67b23a32
HS
2069 the 2 muxes.
2070
2071 This option is actually implemented for the bitbanging
2072 algorithm in common/soft_i2c.c and for the Hardware I2C
2073 Bus on the MPC8260. But it should be not so difficult
2074 to add this option to other architectures.
2075
2ac6985a
AD
2076 CONFIG_SOFT_I2C_READ_REPEATED_START
2077
2078 defining this will force the i2c_read() function in
2079 the soft_i2c driver to perform an I2C repeated start
2080 between writing the address pointer and reading the
2081 data. If this define is omitted the default behaviour
2082 of doing a stop-start sequence will be used. Most I2C
2083 devices can use either method, but some require one or
2084 the other.
be5e6181 2085
c609719b
WD
2086- SPI Support: CONFIG_SPI
2087
2088 Enables SPI driver (so far only tested with
2089 SPI EEPROM, also an instance works with Crystal A/D and
2090 D/As on the SACSng board)
2091
6639562e
YS
2092 CONFIG_SH_SPI
2093
2094 Enables the driver for SPI controller on SuperH. Currently
2095 only SH7757 is supported.
2096
c609719b
WD
2097 CONFIG_SPI_X
2098
2099 Enables extended (16-bit) SPI EEPROM addressing.
2100 (symmetrical to CONFIG_I2C_X)
2101
2102 CONFIG_SOFT_SPI
2103
43d9616c
WD
2104 Enables a software (bit-bang) SPI driver rather than
2105 using hardware support. This is a general purpose
2106 driver that only requires three general I/O port pins
2107 (two outputs, one input) to function. If this is
2108 defined, the board configuration must define several
2109 SPI configuration items (port pins to use, etc). For
2110 an example, see include/configs/sacsng.h.
c609719b 2111
04a9e118
BW
2112 CONFIG_HARD_SPI
2113
2114 Enables a hardware SPI driver for general-purpose reads
2115 and writes. As with CONFIG_SOFT_SPI, the board configuration
2116 must define a list of chip-select function pointers.
c0f40859 2117 Currently supported on some MPC8xxx processors. For an
04a9e118
BW
2118 example, see include/configs/mpc8349emds.h.
2119
38254f45
GL
2120 CONFIG_MXC_SPI
2121
2122 Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cd 2123 SoCs. Currently i.MX31/35/51 are supported.
38254f45 2124
0133502e 2125- FPGA Support: CONFIG_FPGA
c609719b 2126
0133502e
MF
2127 Enables FPGA subsystem.
2128
2129 CONFIG_FPGA_<vendor>
2130
2131 Enables support for specific chip vendors.
2132 (ALTERA, XILINX)
c609719b 2133
0133502e 2134 CONFIG_FPGA_<family>
c609719b 2135
0133502e
MF
2136 Enables support for FPGA family.
2137 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2138
2139 CONFIG_FPGA_COUNT
2140
2141 Specify the number of FPGA devices to support.
c609719b 2142
6d0f6bcf 2143 CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b 2144
8bde7f77 2145 Enable printing of hash marks during FPGA configuration.
c609719b 2146
6d0f6bcf 2147 CONFIG_SYS_FPGA_CHECK_BUSY
c609719b 2148
43d9616c
WD
2149 Enable checks on FPGA configuration interface busy
2150 status by the configuration function. This option
2151 will require a board or device specific function to
2152 be written.
c609719b
WD
2153
2154 CONFIG_FPGA_DELAY
2155
2156 If defined, a function that provides delays in the FPGA
2157 configuration driver.
2158
6d0f6bcf 2159 CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b
WD
2160 Allow Control-C to interrupt FPGA configuration
2161
6d0f6bcf 2162 CONFIG_SYS_FPGA_CHECK_ERROR
c609719b 2163
43d9616c
WD
2164 Check for configuration errors during FPGA bitfile
2165 loading. For example, abort during Virtex II
2166 configuration if the INIT_B line goes low (which
2167 indicated a CRC error).
c609719b 2168
6d0f6bcf 2169 CONFIG_SYS_FPGA_WAIT_INIT
c609719b 2170
43d9616c
WD
2171 Maximum time to wait for the INIT_B line to deassert
2172 after PROB_B has been deasserted during a Virtex II
2173 FPGA configuration sequence. The default time is 500
11ccc33f 2174 ms.
c609719b 2175
6d0f6bcf 2176 CONFIG_SYS_FPGA_WAIT_BUSY
c609719b 2177
43d9616c 2178 Maximum time to wait for BUSY to deassert during
11ccc33f 2179 Virtex II FPGA configuration. The default is 5 ms.
c609719b 2180
6d0f6bcf 2181 CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b 2182
43d9616c 2183 Time to wait after FPGA configuration. The default is
11ccc33f 2184 200 ms.
c609719b
WD
2185
2186- Configuration Management:
2187 CONFIG_IDENT_STRING
2188
43d9616c
WD
2189 If defined, this string will be added to the U-Boot
2190 version information (U_BOOT_VERSION)
c609719b
WD
2191
2192- Vendor Parameter Protection:
2193
43d9616c
WD
2194 U-Boot considers the values of the environment
2195 variables "serial#" (Board Serial Number) and
7152b1d0 2196 "ethaddr" (Ethernet Address) to be parameters that
43d9616c
WD
2197 are set once by the board vendor / manufacturer, and
2198 protects these variables from casual modification by
2199 the user. Once set, these variables are read-only,
2200 and write or delete attempts are rejected. You can
11ccc33f 2201 change this behaviour:
c609719b
WD
2202
2203 If CONFIG_ENV_OVERWRITE is #defined in your config
2204 file, the write protection for vendor parameters is
47cd00fa 2205 completely disabled. Anybody can change or delete
c609719b
WD
2206 these parameters.
2207
2208 Alternatively, if you #define _both_ CONFIG_ETHADDR
2209 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33f 2210 Ethernet address is installed in the environment,
c609719b
WD
2211 which can be changed exactly ONCE by the user. [The
2212 serial# is unaffected by this, i. e. it remains
2213 read-only.]
2214
2598090b
JH
2215 The same can be accomplished in a more flexible way
2216 for any variable by configuring the type of access
2217 to allow for those variables in the ".flags" variable
2218 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2219
c609719b
WD
2220- Protected RAM:
2221 CONFIG_PRAM
2222
2223 Define this variable to enable the reservation of
2224 "protected RAM", i. e. RAM which is not overwritten
2225 by U-Boot. Define CONFIG_PRAM to hold the number of
2226 kB you want to reserve for pRAM. You can overwrite
2227 this default value by defining an environment
2228 variable "pram" to the number of kB you want to
2229 reserve. Note that the board info structure will
2230 still show the full amount of RAM. If pRAM is
2231 reserved, a new environment variable "mem" will
2232 automatically be defined to hold the amount of
2233 remaining RAM in a form that can be passed as boot
2234 argument to Linux, for instance like that:
2235
fe126d8b 2236 setenv bootargs ... mem=\${mem}
c609719b
WD
2237 saveenv
2238
2239 This way you can tell Linux not to use this memory,
2240 either, which results in a memory region that will
2241 not be affected by reboots.
2242
2243 *WARNING* If your board configuration uses automatic
2244 detection of the RAM size, you must make sure that
2245 this memory test is non-destructive. So far, the
2246 following board configurations are known to be
2247 "pRAM-clean":
2248
1b0757ec
WD
2249 IVMS8, IVML24, SPD8xx, TQM8xxL,
2250 HERMES, IP860, RPXlite, LWMON,
544d97e9 2251 FLAGADM, TQM8260
c609719b 2252
40fef049
GB
2253- Access to physical memory region (> 4GB)
2254 Some basic support is provided for operations on memory not
2255 normally accessible to U-Boot - e.g. some architectures
2256 support access to more than 4GB of memory on 32-bit
2257 machines using physical address extension or similar.
2258 Define CONFIG_PHYSMEM to access this basic support, which
2259 currently only supports clearing the memory.
2260
c609719b
WD
2261- Error Recovery:
2262 CONFIG_PANIC_HANG
2263
2264 Define this variable to stop the system in case of a
2265 fatal error, so that you have to reset it manually.
2266 This is probably NOT a good idea for an embedded
11ccc33f 2267 system where you want the system to reboot
c609719b
WD
2268 automatically as fast as possible, but it may be
2269 useful during development since you can try to debug
2270 the conditions that lead to the situation.
2271
2272 CONFIG_NET_RETRY_COUNT
2273
43d9616c
WD
2274 This variable defines the number of retries for
2275 network operations like ARP, RARP, TFTP, or BOOTP
2276 before giving up the operation. If not defined, a
2277 default value of 5 is used.
c609719b 2278
40cb90ee
GL
2279 CONFIG_ARP_TIMEOUT
2280
2281 Timeout waiting for an ARP reply in milliseconds.
2282
48a3e999
TK
2283 CONFIG_NFS_TIMEOUT
2284
2285 Timeout in milliseconds used in NFS protocol.
2286 If you encounter "ERROR: Cannot umount" in nfs command,
2287 try longer timeout such as
2288 #define CONFIG_NFS_TIMEOUT 10000UL
2289
c609719b 2290- Command Interpreter:
8078f1a5 2291 CONFIG_AUTO_COMPLETE
04a85b3b
WD
2292
2293 Enable auto completion of commands using TAB.
2294
a9398e01
WD
2295 Note that this feature has NOT been implemented yet
2296 for the "hush" shell.
8078f1a5
WD
2297
2298
6d0f6bcf 2299 CONFIG_SYS_HUSH_PARSER
c609719b
WD
2300
2301 Define this variable to enable the "hush" shell (from
2302 Busybox) as command line interpreter, thus enabling
2303 powerful command line syntax like
2304 if...then...else...fi conditionals or `&&' and '||'
2305 constructs ("shell scripts").
2306
2307 If undefined, you get the old, much simpler behaviour
2308 with a somewhat smaller memory footprint.
2309
2310
6d0f6bcf 2311 CONFIG_SYS_PROMPT_HUSH_PS2
c609719b
WD
2312
2313 This defines the secondary prompt string, which is
2314 printed when the command interpreter needs more input
2315 to complete a command. Usually "> ".
2316
2317 Note:
2318
8bde7f77
WD
2319 In the current implementation, the local variables
2320 space and global environment variables space are
2321 separated. Local variables are those you define by
2322 simply typing `name=value'. To access a local
2323 variable later on, you have write `$name' or
2324 `${name}'; to execute the contents of a variable
2325 directly type `$name' at the command prompt.
c609719b 2326
43d9616c
WD
2327 Global environment variables are those you use
2328 setenv/printenv to work with. To run a command stored
2329 in such a variable, you need to use the run command,
2330 and you must not use the '$' sign to access them.
c609719b
WD
2331
2332 To store commands and special characters in a
2333 variable, please use double quotation marks
2334 surrounding the whole text of the variable, instead
2335 of the backslashes before semicolons and special
2336 symbols.
2337
aa0c71ac
WD
2338- Commandline Editing and History:
2339 CONFIG_CMDLINE_EDITING
2340
11ccc33f 2341 Enable editing and History functions for interactive
b9365a26 2342 commandline input operations
aa0c71ac 2343
a8c7c708 2344- Default Environment:
c609719b
WD
2345 CONFIG_EXTRA_ENV_SETTINGS
2346
43d9616c
WD
2347 Define this to contain any number of null terminated
2348 strings (variable = value pairs) that will be part of
7152b1d0 2349 the default environment compiled into the boot image.
2262cfee 2350
43d9616c
WD
2351 For example, place something like this in your
2352 board's config file:
c609719b
WD
2353
2354 #define CONFIG_EXTRA_ENV_SETTINGS \
2355 "myvar1=value1\0" \
2356 "myvar2=value2\0"
2357
43d9616c
WD
2358 Warning: This method is based on knowledge about the
2359 internal format how the environment is stored by the
2360 U-Boot code. This is NOT an official, exported
2361 interface! Although it is unlikely that this format
7152b1d0 2362 will change soon, there is no guarantee either.
c609719b
WD
2363 You better know what you are doing here.
2364
43d9616c
WD
2365 Note: overly (ab)use of the default environment is
2366 discouraged. Make sure to check other ways to preset
74de7aef 2367 the environment like the "source" command or the
43d9616c 2368 boot command first.
c609719b 2369
5e724ca2
SW
2370 CONFIG_ENV_VARS_UBOOT_CONFIG
2371
2372 Define this in order to add variables describing the
2373 U-Boot build configuration to the default environment.
2374 These will be named arch, cpu, board, vendor, and soc.
2375
2376 Enabling this option will cause the following to be defined:
2377
2378 - CONFIG_SYS_ARCH
2379 - CONFIG_SYS_CPU
2380 - CONFIG_SYS_BOARD
2381 - CONFIG_SYS_VENDOR
2382 - CONFIG_SYS_SOC
2383
7e27f89f
TR
2384 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2385
2386 Define this in order to add variables describing certain
2387 run-time determined information about the hardware to the
2388 environment. These will be named board_name, board_rev.
2389
06fd8538
SG
2390 CONFIG_DELAY_ENVIRONMENT
2391
2392 Normally the environment is loaded when the board is
2393 intialised so that it is available to U-Boot. This inhibits
2394 that so that the environment is not available until
2395 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2396 this is instead controlled by the value of
2397 /config/load-environment.
2398
a8c7c708 2399- DataFlash Support:
2abbe075
WD
2400 CONFIG_HAS_DATAFLASH
2401
8bde7f77
WD
2402 Defining this option enables DataFlash features and
2403 allows to read/write in Dataflash via the standard
2404 commands cp, md...
2abbe075 2405
f61ec45e
EN
2406- Serial Flash support
2407 CONFIG_CMD_SF
2408
2409 Defining this option enables SPI flash commands
2410 'sf probe/read/write/erase/update'.
2411
2412 Usage requires an initial 'probe' to define the serial
2413 flash parameters, followed by read/write/erase/update
2414 commands.
2415
2416 The following defaults may be provided by the platform
2417 to handle the common case when only a single serial
2418 flash is present on the system.
2419
2420 CONFIG_SF_DEFAULT_BUS Bus identifier
2421 CONFIG_SF_DEFAULT_CS Chip-select
2422 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2423 CONFIG_SF_DEFAULT_SPEED in Hz
2424
24007273
SG
2425 CONFIG_CMD_SF_TEST
2426
2427 Define this option to include a destructive SPI flash
2428 test ('sf test').
2429
3f85ce27
WD
2430- SystemACE Support:
2431 CONFIG_SYSTEMACE
2432
2433 Adding this option adds support for Xilinx SystemACE
2434 chips attached via some sort of local bus. The address
11ccc33f 2435 of the chip must also be defined in the
6d0f6bcf 2436 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce27
WD
2437
2438 #define CONFIG_SYSTEMACE
6d0f6bcf 2439 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce27
WD
2440
2441 When SystemACE support is added, the "ace" device type
2442 becomes available to the fat commands, i.e. fatls.
2443
ecb0ccd9
WD
2444- TFTP Fixed UDP Port:
2445 CONFIG_TFTP_PORT
2446
28cb9375 2447 If this is defined, the environment variable tftpsrcp
ecb0ccd9 2448 is used to supply the TFTP UDP source port value.
28cb9375 2449 If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9
WD
2450 number generator is used.
2451
28cb9375
WD
2452 Also, the environment variable tftpdstp is used to supply
2453 the TFTP UDP destination port value. If tftpdstp isn't
2454 defined, the normal port 69 is used.
2455
2456 The purpose for tftpsrcp is to allow a TFTP server to
ecb0ccd9
WD
2457 blindly start the TFTP transfer using the pre-configured
2458 target IP address and UDP port. This has the effect of
2459 "punching through" the (Windows XP) firewall, allowing
2460 the remainder of the TFTP transfer to proceed normally.
2461 A better solution is to properly configure the firewall,
2462 but sometimes that is not allowed.
2463
bf36c5d5
SG
2464- Hashing support:
2465 CONFIG_CMD_HASH
2466
2467 This enables a generic 'hash' command which can produce
2468 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2469
2470 CONFIG_HASH_VERIFY
2471
2472 Enable the hash verify command (hash -v). This adds to code
2473 size a little.
2474
2475 CONFIG_SHA1 - support SHA1 hashing
2476 CONFIG_SHA256 - support SHA256 hashing
2477
2478 Note: There is also a sha1sum command, which should perhaps
2479 be deprecated in favour of 'hash sha1'.
2480
a8c7c708 2481- Show boot progress:
c609719b
WD
2482 CONFIG_SHOW_BOOT_PROGRESS
2483
43d9616c
WD
2484 Defining this option allows to add some board-
2485 specific code (calling a user-provided function
2486 "show_boot_progress(int)") that enables you to show
2487 the system's boot progress on some display (for
2488 example, some LED's) on your board. At the moment,
2489 the following checkpoints are implemented:
c609719b 2490
3a608ca0
SG
2491- Detailed boot stage timing
2492 CONFIG_BOOTSTAGE
2493 Define this option to get detailed timing of each stage
2494 of the boot process.
2495
2496 CONFIG_BOOTSTAGE_USER_COUNT
2497 This is the number of available user bootstage records.
2498 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2499 a new ID will be allocated from this stash. If you exceed
2500 the limit, recording will stop.
2501
2502 CONFIG_BOOTSTAGE_REPORT
2503 Define this to print a report before boot, similar to this:
2504
2505 Timer summary in microseconds:
2506 Mark Elapsed Stage
2507 0 0 reset
2508 3,575,678 3,575,678 board_init_f start
2509 3,575,695 17 arch_cpu_init A9
2510 3,575,777 82 arch_cpu_init done
2511 3,659,598 83,821 board_init_r start
2512 3,910,375 250,777 main_loop
2513 29,916,167 26,005,792 bootm_start
2514 30,361,327 445,160 start_kernel
2515
2eba38cf
SG
2516 CONFIG_CMD_BOOTSTAGE
2517 Add a 'bootstage' command which supports printing a report
2518 and un/stashing of bootstage data.
2519
94fd1316
SG
2520 CONFIG_BOOTSTAGE_FDT
2521 Stash the bootstage information in the FDT. A root 'bootstage'
2522 node is created with each bootstage id as a child. Each child
2523 has a 'name' property and either 'mark' containing the
2524 mark time in microsecond, or 'accum' containing the
2525 accumulated time for that bootstage id in microseconds.
2526 For example:
2527
2528 bootstage {
2529 154 {
2530 name = "board_init_f";
2531 mark = <3575678>;
2532 };
2533 170 {
2534 name = "lcd";
2535 accum = <33482>;
2536 };
2537 };
2538
2539 Code in the Linux kernel can find this in /proc/devicetree.
2540
1372cce2
MB
2541Legacy uImage format:
2542
c609719b
WD
2543 Arg Where When
2544 1 common/cmd_bootm.c before attempting to boot an image
ba56f625 2545 -1 common/cmd_bootm.c Image header has bad magic number
c609719b 2546 2 common/cmd_bootm.c Image header has correct magic number
ba56f625 2547 -2 common/cmd_bootm.c Image header has bad checksum
c609719b 2548 3 common/cmd_bootm.c Image header has correct checksum
ba56f625 2549 -3 common/cmd_bootm.c Image data has bad checksum
c609719b
WD
2550 4 common/cmd_bootm.c Image data has correct checksum
2551 -4 common/cmd_bootm.c Image is for unsupported architecture
2552 5 common/cmd_bootm.c Architecture check OK
1372cce2 2553 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
c609719b
WD
2554 6 common/cmd_bootm.c Image Type check OK
2555 -6 common/cmd_bootm.c gunzip uncompression error
2556 -7 common/cmd_bootm.c Unimplemented compression type
2557 7 common/cmd_bootm.c Uncompression OK
1372cce2 2558 8 common/cmd_bootm.c No uncompress/copy overwrite error
c609719b 2559 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2
MB
2560
2561 9 common/image.c Start initial ramdisk verification
2562 -10 common/image.c Ramdisk header has bad magic number
2563 -11 common/image.c Ramdisk header has bad checksum
2564 10 common/image.c Ramdisk header is OK
2565 -12 common/image.c Ramdisk data has bad checksum
2566 11 common/image.c Ramdisk data has correct checksum
2567 12 common/image.c Ramdisk verification complete, start loading
11ccc33f 2568 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1372cce2
MB
2569 13 common/image.c Start multifile image verification
2570 14 common/image.c No initial ramdisk, no multifile, continue.
2571
c0f40859 2572 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b 2573
a47a12be 2574 -30 arch/powerpc/lib/board.c Fatal error, hang the system
11dadd54
WD
2575 -31 post/post.c POST test failed, detected by post_output_backlog()
2576 -32 post/post.c POST test failed, detected by post_run_single()
63e73c9a 2577
566a494f
HS
2578 34 common/cmd_doc.c before loading a Image from a DOC device
2579 -35 common/cmd_doc.c Bad usage of "doc" command
2580 35 common/cmd_doc.c correct usage of "doc" command
2581 -36 common/cmd_doc.c No boot device
2582 36 common/cmd_doc.c correct boot device
2583 -37 common/cmd_doc.c Unknown Chip ID on boot device
2584 37 common/cmd_doc.c correct chip ID found, device available
2585 -38 common/cmd_doc.c Read Error on boot device
2586 38 common/cmd_doc.c reading Image header from DOC device OK
2587 -39 common/cmd_doc.c Image header has bad magic number
2588 39 common/cmd_doc.c Image header has correct magic number
2589 -40 common/cmd_doc.c Error reading Image from DOC device
2590 40 common/cmd_doc.c Image header has correct magic number
2591 41 common/cmd_ide.c before loading a Image from a IDE device
2592 -42 common/cmd_ide.c Bad usage of "ide" command
2593 42 common/cmd_ide.c correct usage of "ide" command
2594 -43 common/cmd_ide.c No boot device
2595 43 common/cmd_ide.c boot device found
2596 -44 common/cmd_ide.c Device not available
2597 44 common/cmd_ide.c Device available
2598 -45 common/cmd_ide.c wrong partition selected
2599 45 common/cmd_ide.c partition selected
2600 -46 common/cmd_ide.c Unknown partition table
2601 46 common/cmd_ide.c valid partition table found
2602 -47 common/cmd_ide.c Invalid partition type
2603 47 common/cmd_ide.c correct partition type
2604 -48 common/cmd_ide.c Error reading Image Header on boot device
2605 48 common/cmd_ide.c reading Image Header from IDE device OK
2606 -49 common/cmd_ide.c Image header has bad magic number
2607 49 common/cmd_ide.c Image header has correct magic number
2608 -50 common/cmd_ide.c Image header has bad checksum
2609 50 common/cmd_ide.c Image header has correct checksum
2610 -51 common/cmd_ide.c Error reading Image from IDE device
2611 51 common/cmd_ide.c reading Image from IDE device OK
2612 52 common/cmd_nand.c before loading a Image from a NAND device
2613 -53 common/cmd_nand.c Bad usage of "nand" command
2614 53 common/cmd_nand.c correct usage of "nand" command
2615 -54 common/cmd_nand.c No boot device
2616 54 common/cmd_nand.c boot device found
2617 -55 common/cmd_nand.c Unknown Chip ID on boot device
2618 55 common/cmd_nand.c correct chip ID found, device available
2619 -56 common/cmd_nand.c Error reading Image Header on boot device
2620 56 common/cmd_nand.c reading Image Header from NAND device OK
2621 -57 common/cmd_nand.c Image header has bad magic number
2622 57 common/cmd_nand.c Image header has correct magic number
2623 -58 common/cmd_nand.c Error reading Image from NAND device
2624 58 common/cmd_nand.c reading Image from NAND device OK
2625
2626 -60 common/env_common.c Environment has a bad CRC, using default
2627
11ccc33f 2628 64 net/eth.c starting with Ethernet configuration.
566a494f
HS
2629 -64 net/eth.c no Ethernet found.
2630 65 net/eth.c Ethernet found.
2631
2632 -80 common/cmd_net.c usage wrong
2633 80 common/cmd_net.c before calling NetLoop()
11ccc33f 2634 -81 common/cmd_net.c some error in NetLoop() occurred
566a494f
HS
2635 81 common/cmd_net.c NetLoop() back without error
2636 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2637 82 common/cmd_net.c trying automatic boot
74de7aef
WD
2638 83 common/cmd_net.c running "source" command
2639 -83 common/cmd_net.c some error in automatic boot or "source" command
566a494f 2640 84 common/cmd_net.c end without errors
c609719b 2641
1372cce2
MB
2642FIT uImage format:
2643
2644 Arg Where When
2645 100 common/cmd_bootm.c Kernel FIT Image has correct format
2646 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2647 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2648 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2649 102 common/cmd_bootm.c Kernel unit name specified
2650 -103 common/cmd_bootm.c Can't get kernel subimage node offset
f773bea8 2651 103 common/cmd_bootm.c Found configuration node
1372cce2
MB
2652 104 common/cmd_bootm.c Got kernel subimage node offset
2653 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2654 105 common/cmd_bootm.c Kernel subimage hash verification OK
2655 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2656 106 common/cmd_bootm.c Architecture check OK
11ccc33f
MZ
2657 -106 common/cmd_bootm.c Kernel subimage has wrong type
2658 107 common/cmd_bootm.c Kernel subimage type OK
1372cce2
MB
2659 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2660 108 common/cmd_bootm.c Got kernel subimage data/size
2661 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2662 -109 common/cmd_bootm.c Can't get kernel subimage type
2663 -110 common/cmd_bootm.c Can't get kernel subimage comp
2664 -111 common/cmd_bootm.c Can't get kernel subimage os
2665 -112 common/cmd_bootm.c Can't get kernel subimage load address
2666 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2667
2668 120 common/image.c Start initial ramdisk verification
2669 -120 common/image.c Ramdisk FIT image has incorrect format
2670 121 common/image.c Ramdisk FIT image has correct format
11ccc33f 2671 122 common/image.c No ramdisk subimage unit name, using configuration
1372cce2
MB
2672 -122 common/image.c Can't get configuration for ramdisk subimage
2673 123 common/image.c Ramdisk unit name specified
2674 -124 common/image.c Can't get ramdisk subimage node offset
2675 125 common/image.c Got ramdisk subimage node offset
2676 -125 common/image.c Ramdisk subimage hash verification failed
2677 126 common/image.c Ramdisk subimage hash verification OK
2678 -126 common/image.c Ramdisk subimage for unsupported architecture
2679 127 common/image.c Architecture check OK
2680 -127 common/image.c Can't get ramdisk subimage data/size
2681 128 common/image.c Got ramdisk subimage data/size
2682 129 common/image.c Can't get ramdisk load address
2683 -129 common/image.c Got ramdisk load address
2684
11ccc33f 2685 -130 common/cmd_doc.c Incorrect FIT image format
1372cce2
MB
2686 131 common/cmd_doc.c FIT image format OK
2687
11ccc33f 2688 -140 common/cmd_ide.c Incorrect FIT image format
1372cce2
MB
2689 141 common/cmd_ide.c FIT image format OK
2690
11ccc33f 2691 -150 common/cmd_nand.c Incorrect FIT image format
1372cce2
MB
2692 151 common/cmd_nand.c FIT image format OK
2693
d95f6ec7
GB
2694- FIT image support:
2695 CONFIG_FIT
2696 Enable support for the FIT uImage format.
2697
2698 CONFIG_FIT_BEST_MATCH
2699 When no configuration is explicitly selected, default to the
2700 one whose fdt's compatibility field best matches that of
2701 U-Boot itself. A match is considered "best" if it matches the
2702 most specific compatibility entry of U-Boot's fdt's root node.
2703 The order of entries in the configuration's fdt is ignored.
2704
4cf2609b
WD
2705- Standalone program support:
2706 CONFIG_STANDALONE_LOAD_ADDR
2707
6feff899
WD
2708 This option defines a board specific value for the
2709 address where standalone program gets loaded, thus
2710 overwriting the architecture dependent default
4cf2609b
WD
2711 settings.
2712
2713- Frame Buffer Address:
2714 CONFIG_FB_ADDR
2715
2716 Define CONFIG_FB_ADDR if you want to use specific
2717 address for frame buffer.
2718 Then system will reserve the frame buffer address to
2719 defined address instead of lcd_setmem (this function
6feff899 2720 grabs the memory for frame buffer by panel's size).
4cf2609b
WD
2721
2722 Please see board_init_f function.
2723
cccfc2ab
DZ
2724- Automatic software updates via TFTP server
2725 CONFIG_UPDATE_TFTP
2726 CONFIG_UPDATE_TFTP_CNT_MAX
2727 CONFIG_UPDATE_TFTP_MSEC_MAX
2728
2729 These options enable and control the auto-update feature;
2730 for a more detailed description refer to doc/README.update.
2731
2732- MTD Support (mtdparts command, UBI support)
2733 CONFIG_MTD_DEVICE
2734
2735 Adds the MTD device infrastructure from the Linux kernel.
2736 Needed for mtdparts command support.
2737
2738 CONFIG_MTD_PARTITIONS
2739
2740 Adds the MTD partitioning infrastructure from the Linux
2741 kernel. Needed for UBI support.
2742
6a11cf48 2743- SPL framework
04e5ae79
WD
2744 CONFIG_SPL
2745 Enable building of SPL globally.
6a11cf48 2746
95579793
TR
2747 CONFIG_SPL_LDSCRIPT
2748 LDSCRIPT for linking the SPL binary.
2749
2750 CONFIG_SPL_MAX_SIZE
2751 Maximum binary size (text, data and rodata) of the SPL binary.
2752
04e5ae79
WD
2753 CONFIG_SPL_TEXT_BASE
2754 TEXT_BASE for linking the SPL binary.
6a11cf48 2755
94a45bb1
SW
2756 CONFIG_SPL_RELOC_TEXT_BASE
2757 Address to relocate to. If unspecified, this is equal to
2758 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2759
95579793
TR
2760 CONFIG_SPL_BSS_START_ADDR
2761 Link address for the BSS within the SPL binary.
2762
2763 CONFIG_SPL_BSS_MAX_SIZE
2764 Maximum binary size of the BSS section of the SPL binary.
2765
2766 CONFIG_SPL_STACK
2767 Adress of the start of the stack SPL will use
2768
94a45bb1
SW
2769 CONFIG_SPL_RELOC_STACK
2770 Adress of the start of the stack SPL will use after
2771 relocation. If unspecified, this is equal to
2772 CONFIG_SPL_STACK.
2773
95579793
TR
2774 CONFIG_SYS_SPL_MALLOC_START
2775 Starting address of the malloc pool used in SPL.
2776
2777 CONFIG_SYS_SPL_MALLOC_SIZE
2778 The size of the malloc pool used in SPL.
6a11cf48 2779
47f7bcae
TR
2780 CONFIG_SPL_FRAMEWORK
2781 Enable the SPL framework under common/. This framework
2782 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2783 NAND loading of the Linux Kernel.
2784
861a86f4
TR
2785 CONFIG_SPL_DISPLAY_PRINT
2786 For ARM, enable an optional function to print more information
2787 about the running system.
2788
4b919725
SW
2789 CONFIG_SPL_INIT_MINIMAL
2790 Arch init code should be built for a very small image
2791
04e5ae79
WD
2792 CONFIG_SPL_LIBCOMMON_SUPPORT
2793 Support for common/libcommon.o in SPL binary
6a11cf48 2794
04e5ae79
WD
2795 CONFIG_SPL_LIBDISK_SUPPORT
2796 Support for disk/libdisk.o in SPL binary
6a11cf48 2797
04e5ae79
WD
2798 CONFIG_SPL_I2C_SUPPORT
2799 Support for drivers/i2c/libi2c.o in SPL binary
6a11cf48 2800
04e5ae79
WD
2801 CONFIG_SPL_GPIO_SUPPORT
2802 Support for drivers/gpio/libgpio.o in SPL binary
6a11cf48 2803
04e5ae79
WD
2804 CONFIG_SPL_MMC_SUPPORT
2805 Support for drivers/mmc/libmmc.o in SPL binary
6a11cf48 2806
95579793
TR
2807 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2808 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2809 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2810 Address, size and partition on the MMC to load U-Boot from
2811 when the MMC is being used in raw mode.
2812
2813 CONFIG_SPL_FAT_SUPPORT
2814 Support for fs/fat/libfat.o in SPL binary
2815
2816 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2817 Filename to read to load U-Boot when reading from FAT
2818
6f2f01b9
SW
2819 CONFIG_SPL_NAND_BASE
2820 Include nand_base.c in the SPL. Requires
2821 CONFIG_SPL_NAND_DRIVERS.
2822
2823 CONFIG_SPL_NAND_DRIVERS
2824 SPL uses normal NAND drivers, not minimal drivers.
2825
2826 CONFIG_SPL_NAND_ECC
2827 Include standard software ECC in the SPL
2828
95579793 2829 CONFIG_SPL_NAND_SIMPLE
7d4b7955
SW
2830 Support for NAND boot using simple NAND drivers that
2831 expose the cmd_ctrl() interface.
95579793
TR
2832
2833 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2834 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2835 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2836 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2837 CONFIG_SYS_NAND_ECCBYTES
2838 Defines the size and behavior of the NAND that SPL uses
7d4b7955 2839 to read U-Boot
95579793
TR
2840
2841 CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b7955
SW
2842 Location in NAND to read U-Boot from
2843
2844 CONFIG_SYS_NAND_U_BOOT_DST
2845 Location in memory to load U-Boot to
2846
2847 CONFIG_SYS_NAND_U_BOOT_SIZE
2848 Size of image to load
95579793
TR
2849
2850 CONFIG_SYS_NAND_U_BOOT_START
7d4b7955 2851 Entry point in loaded image to jump to
95579793
TR
2852
2853 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2854 Define this if you need to first read the OOB and then the
2855 data. This is used for example on davinci plattforms.
2856
2857 CONFIG_SPL_OMAP3_ID_NAND
2858 Support for an OMAP3-specific set of functions to return the
2859 ID and MFR of the first attached NAND chip, if present.
2860
04e5ae79
WD
2861 CONFIG_SPL_SERIAL_SUPPORT
2862 Support for drivers/serial/libserial.o in SPL binary
6a11cf48 2863
04e5ae79
WD
2864 CONFIG_SPL_SPI_FLASH_SUPPORT
2865 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
6a11cf48 2866
04e5ae79
WD
2867 CONFIG_SPL_SPI_SUPPORT
2868 Support for drivers/spi/libspi.o in SPL binary
c57b953d
PM
2869
2870 CONFIG_SPL_RAM_DEVICE
2871 Support for running image already present in ram, in SPL binary
6a11cf48 2872
04e5ae79
WD
2873 CONFIG_SPL_LIBGENERIC_SUPPORT
2874 Support for lib/libgeneric.o in SPL binary
1372cce2 2875
ca2fca22
SW
2876 CONFIG_SPL_TARGET
2877 Final target image containing SPL and payload. Some SPLs
2878 use an arch-specific makefile fragment instead, for
2879 example if more than one image needs to be produced.
2880
c609719b
WD
2881Modem Support:
2882--------------
2883
566e5cf4 2884[so far only for SMDK2400 boards]
c609719b 2885
11ccc33f 2886- Modem support enable:
c609719b
WD
2887 CONFIG_MODEM_SUPPORT
2888
2889- RTS/CTS Flow control enable:
2890 CONFIG_HWFLOW
2891
2892- Modem debug support:
2893 CONFIG_MODEM_SUPPORT_DEBUG
2894
43d9616c
WD
2895 Enables debugging stuff (char screen[1024], dbg())
2896 for modem support. Useful only with BDI2000.
c609719b 2897
a8c7c708
WD
2898- Interrupt support (PPC):
2899
d4ca31c4
WD
2900 There are common interrupt_init() and timer_interrupt()
2901 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33f 2902 for CPU specific initialization. interrupt_init_cpu()
d4ca31c4 2903 should set decrementer_count to appropriate value. If
11ccc33f 2904 CPU resets decrementer automatically after interrupt
d4ca31c4 2905 (ppc4xx) it should set decrementer_count to zero.
11ccc33f 2906 timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c4
WD
2907 specific handling. If board has watchdog / status_led
2908 / other_activity_monitor it works automatically from
2909 general timer_interrupt().
a8c7c708 2910
c609719b
WD
2911- General:
2912
43d9616c
WD
2913 In the target system modem support is enabled when a
2914 specific key (key combination) is pressed during
2915 power-on. Otherwise U-Boot will boot normally
11ccc33f 2916 (autoboot). The key_pressed() function is called from
43d9616c
WD
2917 board_init(). Currently key_pressed() is a dummy
2918 function, returning 1 and thus enabling modem
2919 initialization.
c609719b 2920
43d9616c
WD
2921 If there are no modem init strings in the
2922 environment, U-Boot proceed to autoboot; the
2923 previous output (banner, info printfs) will be
11ccc33f 2924 suppressed, though.
c609719b
WD
2925
2926 See also: doc/README.Modem
2927
9660e442
HR
2928Board initialization settings:
2929------------------------------
2930
2931During Initialization u-boot calls a number of board specific functions
2932to allow the preparation of board specific prerequisites, e.g. pin setup
2933before drivers are initialized. To enable these callbacks the
2934following configuration macros have to be defined. Currently this is
2935architecture specific, so please check arch/your_architecture/lib/board.c
2936typically in board_init_f() and board_init_r().
2937
2938- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2939- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2940- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2941- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
c609719b 2942
c609719b
WD
2943Configuration Settings:
2944-----------------------
2945
6d0f6bcf 2946- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b
WD
2947 undefine this when you're short of memory.
2948
2fb2604d
PT
2949- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2950 width of the commands listed in the 'help' command output.
2951
6d0f6bcf 2952- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
c609719b
WD
2953 prompt for user input.
2954
6d0f6bcf 2955- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
c609719b 2956
6d0f6bcf 2957- CONFIG_SYS_PBSIZE: Buffer size for Console output
c609719b 2958
6d0f6bcf 2959- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
c609719b 2960
6d0f6bcf 2961- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b
WD
2962 the application (usually a Linux kernel) when it is
2963 booted
2964
6d0f6bcf 2965- CONFIG_SYS_BAUDRATE_TABLE:
c609719b
WD
2966 List of legal baudrate settings for this board.
2967
6d0f6bcf 2968- CONFIG_SYS_CONSOLE_INFO_QUIET
8bde7f77 2969 Suppress display of console information at boot.
c609719b 2970
6d0f6bcf 2971- CONFIG_SYS_CONSOLE_IS_IN_ENV
8bde7f77
WD
2972 If the board specific function
2973 extern int overwrite_console (void);
2974 returns 1, the stdin, stderr and stdout are switched to the
c609719b
WD
2975 serial port, else the settings in the environment are used.
2976
6d0f6bcf 2977- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
8bde7f77 2978 Enable the call to overwrite_console().
c609719b 2979
6d0f6bcf 2980- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
c609719b
WD
2981 Enable overwrite of previous console environment settings.
2982
6d0f6bcf 2983- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b
WD
2984 Begin and End addresses of the area used by the
2985 simple memory test.
2986
6d0f6bcf 2987- CONFIG_SYS_ALT_MEMTEST:
8bde7f77 2988 Enable an alternate, more extensive memory test.
c609719b 2989
6d0f6bcf 2990- CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe1
WD
2991 Scratch address used by the alternate memory test
2992 You only need to set this if address zero isn't writeable
2993
6d0f6bcf
JCPV
2994- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2995 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca6 2996 this specified memory area will get subtracted from the top
11ccc33f 2997 (end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca6
SR
2998 fixing up gd->ram_size the Linux kernel should gets passed
2999 the now "corrected" memory size and won't touch it either.
3000 This should work for arch/ppc and arch/powerpc. Only Linux
5e12e75d 3001 board ports in arch/powerpc with bootwrapper support that
14f73ca6 3002 recalculate the memory size from the SDRAM controller setup
5e12e75d 3003 will have to get fixed in Linux additionally.
14f73ca6
SR
3004
3005 This option can be used as a workaround for the 440EPx/GRx
3006 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3007 be touched.
3008
3009 WARNING: Please make sure that this value is a multiple of
3010 the Linux page size (normally 4k). If this is not the case,
3011 then the end address of the Linux memory will be located at a
3012 non page size aligned address and this could cause major
3013 problems.
3014
6d0f6bcf 3015- CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b
WD
3016 Enable temporary baudrate change while serial download
3017
6d0f6bcf 3018- CONFIG_SYS_SDRAM_BASE:
c609719b
WD
3019 Physical start address of SDRAM. _Must_ be 0 here.
3020
6d0f6bcf 3021- CONFIG_SYS_MBIO_BASE:
c609719b
WD
3022 Physical start address of Motherboard I/O (if using a
3023 Cogent motherboard)
3024
6d0f6bcf 3025- CONFIG_SYS_FLASH_BASE:
c609719b
WD
3026 Physical start address of Flash memory.
3027
6d0f6bcf 3028- CONFIG_SYS_MONITOR_BASE:
c609719b
WD
3029 Physical start address of boot monitor code (set by
3030 make config files to be same as the text base address
14d0a02a 3031 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf 3032 CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b 3033
6d0f6bcf 3034- CONFIG_SYS_MONITOR_LEN:
8bde7f77
WD
3035 Size of memory reserved for monitor code, used to
3036 determine _at_compile_time_ (!) if the environment is
3037 embedded within the U-Boot image, or in a separate
3038 flash sector.
c609719b 3039
6d0f6bcf 3040- CONFIG_SYS_MALLOC_LEN:
c609719b
WD
3041 Size of DRAM reserved for malloc() use.
3042
6d0f6bcf 3043- CONFIG_SYS_BOOTM_LEN:
15940c9a
SR
3044 Normally compressed uImages are limited to an
3045 uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf 3046 you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9a
SR
3047 to adjust this setting to your needs.
3048
6d0f6bcf 3049- CONFIG_SYS_BOOTMAPSZ:
c609719b
WD
3050 Maximum size of memory mapped by the startup code of
3051 the Linux kernel; all data that must be processed by
7d721e34
BS
3052 the Linux kernel (bd_info, boot arguments, FDT blob if
3053 used) must be put below this limit, unless "bootm_low"
3054 enviroment variable is defined and non-zero. In such case
3055 all data for the Linux kernel must be between "bootm_low"
c0f40859 3056 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
c3624e6e
GL
3057 variable "bootm_mapsize" will override the value of
3058 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3059 then the value in "bootm_size" will be used instead.
c609719b 3060
fca43cc8
JR
3061- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3062 Enable initrd_high functionality. If defined then the
3063 initrd_high feature is enabled and the bootm ramdisk subcommand
3064 is enabled.
3065
3066- CONFIG_SYS_BOOT_GET_CMDLINE:
3067 Enables allocating and saving kernel cmdline in space between
3068 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3069
3070- CONFIG_SYS_BOOT_GET_KBD:
3071 Enables allocating and saving a kernel copy of the bd_info in
3072 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3073
6d0f6bcf 3074- CONFIG_SYS_MAX_FLASH_BANKS:
c609719b
WD
3075 Max number of Flash memory banks
3076
6d0f6bcf 3077- CONFIG_SYS_MAX_FLASH_SECT:
c609719b
WD
3078 Max number of sectors on a Flash chip
3079
6d0f6bcf 3080- CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b
WD
3081 Timeout for Flash erase operations (in ms)
3082
6d0f6bcf 3083- CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b
WD
3084 Timeout for Flash write operations (in ms)
3085
6d0f6bcf 3086- CONFIG_SYS_FLASH_LOCK_TOUT
8564acf9
WD
3087 Timeout for Flash set sector lock bit operation (in ms)
3088
6d0f6bcf 3089- CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf9
WD
3090 Timeout for Flash clear lock bits operation (in ms)
3091
6d0f6bcf 3092- CONFIG_SYS_FLASH_PROTECTION
8564acf9
WD
3093 If defined, hardware flash sectors protection is used
3094 instead of U-Boot software protection.
3095
6d0f6bcf 3096- CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b
WD
3097
3098 Enable TFTP transfers directly to flash memory;
3099 without this option such a download has to be
3100 performed in two steps: (1) download to RAM, and (2)
3101 copy from RAM to flash.
3102
3103 The two-step approach is usually more reliable, since
3104 you can check if the download worked before you erase
11ccc33f
MZ
3105 the flash, but in some situations (when system RAM is
3106 too limited to allow for a temporary copy of the
c609719b
WD
3107 downloaded image) this option may be very useful.
3108
6d0f6bcf 3109- CONFIG_SYS_FLASH_CFI:
43d9616c 3110 Define if the flash driver uses extra elements in the
5653fc33
WD
3111 common flash structure for storing flash geometry.
3112
00b1883a 3113- CONFIG_FLASH_CFI_DRIVER
5653fc33
WD
3114 This option also enables the building of the cfi_flash driver
3115 in the drivers directory
c609719b 3116
91809ed5
PZ
3117- CONFIG_FLASH_CFI_MTD
3118 This option enables the building of the cfi_mtd driver
3119 in the drivers directory. The driver exports CFI flash
3120 to the MTD layer.
3121
6d0f6bcf 3122- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f
GL
3123 Use buffered writes to flash.
3124
3125- CONFIG_FLASH_SPANSION_S29WS_N
3126 s29ws-n MirrorBit flash has non-standard addresses for buffered
3127 write commands.
3128
6d0f6bcf 3129- CONFIG_SYS_FLASH_QUIET_TEST
5568e613
SR
3130 If this option is defined, the common CFI flash doesn't
3131 print it's warning upon not recognized FLASH banks. This
3132 is useful, if some of the configured banks are only
3133 optionally available.
3134
9a042e9c
JVB
3135- CONFIG_FLASH_SHOW_PROGRESS
3136 If defined (must be an integer), print out countdown
3137 digits and dots. Recommended value: 45 (9..1) for 80
3138 column displays, 15 (3..1) for 40 column displays.
3139
6d0f6bcf 3140- CONFIG_SYS_RX_ETH_BUFFER:
11ccc33f
MZ
3141 Defines the number of Ethernet receive buffers. On some
3142 Ethernet controllers it is recommended to set this value
53cf9435
SR
3143 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3144 buffers can be full shortly after enabling the interface
11ccc33f 3145 on high Ethernet traffic.
53cf9435
SR
3146 Defaults to 4 if not defined.
3147
ea882baf
WD
3148- CONFIG_ENV_MAX_ENTRIES
3149
071bc923
WD
3150 Maximum number of entries in the hash table that is used
3151 internally to store the environment settings. The default
3152 setting is supposed to be generous and should work in most
3153 cases. This setting can be used to tune behaviour; see
3154 lib/hashtable.c for details.
ea882baf 3155
2598090b
JH
3156- CONFIG_ENV_FLAGS_LIST_DEFAULT
3157- CONFIG_ENV_FLAGS_LIST_STATIC
3158 Enable validation of the values given to enviroment variables when
3159 calling env set. Variables can be restricted to only decimal,
3160 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3161 the variables can also be restricted to IP address or MAC address.
3162
3163 The format of the list is:
3164 type_attribute = [s|d|x|b|i|m]
267541f7
JH
3165 access_atribute = [a|r|o|c]
3166 attributes = type_attribute[access_atribute]
2598090b
JH
3167 entry = variable_name[:attributes]
3168 list = entry[,list]
3169
3170 The type attributes are:
3171 s - String (default)
3172 d - Decimal
3173 x - Hexadecimal
3174 b - Boolean ([1yYtT|0nNfF])
3175 i - IP address
3176 m - MAC address
3177
267541f7
JH
3178 The access attributes are:
3179 a - Any (default)
3180 r - Read-only
3181 o - Write-once
3182 c - Change-default
3183
2598090b
JH
3184 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3185 Define this to a list (string) to define the ".flags"
3186 envirnoment variable in the default or embedded environment.
3187
3188 - CONFIG_ENV_FLAGS_LIST_STATIC
3189 Define this to a list (string) to define validation that
3190 should be done if an entry is not found in the ".flags"
3191 environment variable. To override a setting in the static
3192 list, simply add an entry for the same variable name to the
3193 ".flags" variable.
3194
267541f7
JH
3195- CONFIG_ENV_ACCESS_IGNORE_FORCE
3196 If defined, don't allow the -f switch to env set override variable
3197 access flags.
3198
c609719b
WD
3199The following definitions that deal with the placement and management
3200of environment data (variable area); in general, we support the
3201following configurations:
3202
c3eb3fe4
MF
3203- CONFIG_BUILD_ENVCRC:
3204
3205 Builds up envcrc with the target environment so that external utils
3206 may easily extract it and embed it in final U-Boot images.
3207
5a1aceb0 3208- CONFIG_ENV_IS_IN_FLASH:
c609719b
WD
3209
3210 Define this if the environment is in flash memory.
3211
3212 a) The environment occupies one whole flash sector, which is
3213 "embedded" in the text segment with the U-Boot code. This
3214 happens usually with "bottom boot sector" or "top boot
3215 sector" type flash chips, which have several smaller
3216 sectors at the start or the end. For instance, such a
3217 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3218 such a case you would place the environment in one of the
3219 4 kB sectors - with U-Boot code before and after it. With
3220 "top boot sector" type flash chips, you would put the
3221 environment in one of the last sectors, leaving a gap
3222 between U-Boot and the environment.
3223
0e8d1586 3224 - CONFIG_ENV_OFFSET:
c609719b
WD
3225
3226 Offset of environment data (variable area) to the
3227 beginning of flash memory; for instance, with bottom boot
3228 type flash chips the second sector can be used: the offset
3229 for this sector is given here.
3230
6d0f6bcf 3231 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b 3232
0e8d1586 3233 - CONFIG_ENV_ADDR:
c609719b
WD
3234
3235 This is just another way to specify the start address of
3236 the flash sector containing the environment (instead of
0e8d1586 3237 CONFIG_ENV_OFFSET).
c609719b 3238
0e8d1586 3239 - CONFIG_ENV_SECT_SIZE:
c609719b
WD
3240
3241 Size of the sector containing the environment.
3242
3243
3244 b) Sometimes flash chips have few, equal sized, BIG sectors.
3245 In such a case you don't want to spend a whole sector for
3246 the environment.
3247
0e8d1586 3248 - CONFIG_ENV_SIZE:
c609719b 3249
5a1aceb0 3250 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
0e8d1586 3251 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
c609719b
WD
3252 of this flash sector for the environment. This saves
3253 memory for the RAM copy of the environment.
3254
3255 It may also save flash memory if you decide to use this
3256 when your environment is "embedded" within U-Boot code,
3257 since then the remainder of the flash sector could be used
3258 for U-Boot code. It should be pointed out that this is
3259 STRONGLY DISCOURAGED from a robustness point of view:
3260 updating the environment in flash makes it always
3261 necessary to erase the WHOLE sector. If something goes
3262 wrong before the contents has been restored from a copy in
3263 RAM, your target system will be dead.
3264
0e8d1586
JCPV
3265 - CONFIG_ENV_ADDR_REDUND
3266 CONFIG_ENV_SIZE_REDUND
c609719b 3267
43d9616c 3268 These settings describe a second storage area used to hold
11ccc33f 3269 a redundant copy of the environment data, so that there is
3e38691e 3270 a valid backup copy in case there is a power failure during
43d9616c 3271 a "saveenv" operation.
c609719b
WD
3272
3273BE CAREFUL! Any changes to the flash layout, and some changes to the
3274source code will make it necessary to adapt <board>/u-boot.lds*
3275accordingly!
3276
3277
9314cee6 3278- CONFIG_ENV_IS_IN_NVRAM:
c609719b
WD
3279
3280 Define this if you have some non-volatile memory device
3281 (NVRAM, battery buffered SRAM) which you want to use for the
3282 environment.
3283
0e8d1586
JCPV
3284 - CONFIG_ENV_ADDR:
3285 - CONFIG_ENV_SIZE:
c609719b 3286
11ccc33f 3287 These two #defines are used to determine the memory area you
c609719b
WD
3288 want to use for environment. It is assumed that this memory
3289 can just be read and written to, without any special
3290 provision.
3291
3292BE CAREFUL! The first access to the environment happens quite early
3293in U-Boot initalization (when we try to get the setting of for the
11ccc33f 3294console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b
WD
3295U-Boot will hang.
3296
3297Please note that even with NVRAM we still use a copy of the
3298environment in RAM: we could work on NVRAM directly, but we want to
3299keep settings there always unmodified except somebody uses "saveenv"
3300to save the current settings.
3301
3302
bb1f8b4f 3303- CONFIG_ENV_IS_IN_EEPROM:
c609719b
WD
3304
3305 Use this if you have an EEPROM or similar serial access
3306 device and a driver for it.
3307
0e8d1586
JCPV
3308 - CONFIG_ENV_OFFSET:
3309 - CONFIG_ENV_SIZE:
c609719b
WD
3310
3311 These two #defines specify the offset and size of the
3312 environment area within the total memory of your EEPROM.
3313
6d0f6bcf 3314 - CONFIG_SYS_I2C_EEPROM_ADDR:
c609719b
WD
3315 If defined, specified the chip address of the EEPROM device.
3316 The default address is zero.
3317
6d0f6bcf 3318 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
c609719b
WD
3319 If defined, the number of bits used to address bytes in a
3320 single page in the EEPROM device. A 64 byte page, for example
3321 would require six bits.
3322
6d0f6bcf 3323 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
c609719b 3324 If defined, the number of milliseconds to delay between
ba56f625 3325 page writes. The default is zero milliseconds.
c609719b 3326
6d0f6bcf 3327 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
c609719b
WD
3328 The length in bytes of the EEPROM memory array address. Note
3329 that this is NOT the chip address length!
3330
6d0f6bcf 3331 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
5cf91d6b
WD
3332 EEPROM chips that implement "address overflow" are ones
3333 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3334 address and the extra bits end up in the "chip address" bit
3335 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3336 byte chips.
3337
3338 Note that we consider the length of the address field to
3339 still be one byte because the extra address bits are hidden
3340 in the chip address.
3341
6d0f6bcf 3342 - CONFIG_SYS_EEPROM_SIZE:
c609719b
WD
3343 The size in bytes of the EEPROM device.
3344
548738b4
HS
3345 - CONFIG_ENV_EEPROM_IS_ON_I2C
3346 define this, if you have I2C and SPI activated, and your
3347 EEPROM, which holds the environment, is on the I2C bus.
3348
3349 - CONFIG_I2C_ENV_EEPROM_BUS
3350 if you have an Environment on an EEPROM reached over
3351 I2C muxes, you can define here, how to reach this
3352 EEPROM. For example:
3353
a9046b9e 3354 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
548738b4
HS
3355
3356 EEPROM which holds the environment, is reached over
3357 a pca9547 i2c mux with address 0x70, channel 3.
c609719b 3358
057c849c 3359- CONFIG_ENV_IS_IN_DATAFLASH:
5779d8d9 3360
d4ca31c4 3361 Define this if you have a DataFlash memory device which you
5779d8d9
WD
3362 want to use for the environment.
3363
0e8d1586
JCPV
3364 - CONFIG_ENV_OFFSET:
3365 - CONFIG_ENV_ADDR:
3366 - CONFIG_ENV_SIZE:
5779d8d9
WD
3367
3368 These three #defines specify the offset and size of the
3369 environment area within the total memory of your DataFlash placed
3370 at the specified address.
3371
0a85a9e7
LG
3372- CONFIG_ENV_IS_IN_REMOTE:
3373
3374 Define this if you have a remote memory space which you
3375 want to use for the local device's environment.
3376
3377 - CONFIG_ENV_ADDR:
3378 - CONFIG_ENV_SIZE:
3379
3380 These two #defines specify the address and size of the
3381 environment area within the remote memory space. The
3382 local device can get the environment from remote memory
fc54c7fa 3383 space by SRIO or PCIE links.
0a85a9e7
LG
3384
3385BE CAREFUL! For some special cases, the local device can not use
3386"saveenv" command. For example, the local device will get the
fc54c7fa
LG
3387environment stored in a remote NOR flash by SRIO or PCIE link,
3388but it can not erase, write this NOR flash by SRIO or PCIE interface.
0a85a9e7 3389
51bfee19 3390- CONFIG_ENV_IS_IN_NAND:
13a5695b
WD
3391
3392 Define this if you have a NAND device which you want to use
3393 for the environment.
3394
0e8d1586
JCPV
3395 - CONFIG_ENV_OFFSET:
3396 - CONFIG_ENV_SIZE:
13a5695b
WD
3397
3398 These two #defines specify the offset and size of the environment
fdd813de
SW
3399 area within the first NAND device. CONFIG_ENV_OFFSET must be
3400 aligned to an erase block boundary.
5779d8d9 3401
fdd813de 3402 - CONFIG_ENV_OFFSET_REDUND (optional):
e443c944 3403
0e8d1586 3404 This setting describes a second storage area of CONFIG_ENV_SIZE
fdd813de
SW
3405 size used to hold a redundant copy of the environment data, so
3406 that there is a valid backup copy in case there is a power failure
c0f40859 3407 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
fdd813de
SW
3408 aligned to an erase block boundary.
3409
3410 - CONFIG_ENV_RANGE (optional):
3411
3412 Specifies the length of the region in which the environment
3413 can be written. This should be a multiple of the NAND device's
3414 block size. Specifying a range with more erase blocks than
3415 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3416 the range to be avoided.
3417
3418 - CONFIG_ENV_OFFSET_OOB (optional):
3419
3420 Enables support for dynamically retrieving the offset of the
3421 environment from block zero's out-of-band data. The
3422 "nand env.oob" command can be used to record this offset.
3423 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3424 using CONFIG_ENV_OFFSET_OOB.
e443c944 3425
b74ab737
GL
3426- CONFIG_NAND_ENV_DST
3427
3428 Defines address in RAM to which the nand_spl code should copy the
3429 environment. If redundant environment is used, it will be copied to
3430 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3431
6d0f6bcf 3432- CONFIG_SYS_SPI_INIT_OFFSET
c609719b
WD
3433
3434 Defines offset to the initial SPI buffer area in DPRAM. The
3435 area is used at an early stage (ROM part) if the environment
3436 is configured to reside in the SPI EEPROM: We need a 520 byte
3437 scratch DPRAM area. It is used between the two initialization
3438 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3439 to be a good choice since it makes it far enough from the
3440 start of the data area as well as from the stack pointer.
3441
e881cb56 3442Please note that the environment is read-only until the monitor
c609719b 3443has been relocated to RAM and a RAM copy of the environment has been
cdb74977 3444created; also, when using EEPROM you will have to use getenv_f()
c609719b
WD
3445until then to read environment variables.
3446
85ec0bcc
WD
3447The environment is protected by a CRC32 checksum. Before the monitor
3448is relocated into RAM, as a result of a bad CRC you will be working
3449with the compiled-in default environment - *silently*!!! [This is
3450necessary, because the first environment variable we need is the
3451"baudrate" setting for the console - if we have a bad CRC, we don't
3452have any device yet where we could complain.]
c609719b
WD
3453
3454Note: once the monitor has been relocated, then it will complain if
3455the default environment is used; a new CRC is computed as soon as you
85ec0bcc 3456use the "saveenv" command to store a valid environment.
c609719b 3457
6d0f6bcf 3458- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
42d1f039 3459 Echo the inverted Ethernet link state to the fault LED.
fc3e2165 3460
6d0f6bcf 3461 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
fc3e2165
WD
3462 also needs to be defined.
3463
6d0f6bcf 3464- CONFIG_SYS_FAULT_MII_ADDR:
42d1f039 3465 MII address of the PHY to check for the Ethernet link state.
c609719b 3466
f5675aa5
RM
3467- CONFIG_NS16550_MIN_FUNCTIONS:
3468 Define this if you desire to only have use of the NS16550_init
3469 and NS16550_putc functions for the serial driver located at
3470 drivers/serial/ns16550.c. This option is useful for saving
3471 space for already greatly restricted images, including but not
3472 limited to NAND_SPL configurations.
3473
b2b92f53
SG
3474- CONFIG_DISPLAY_BOARDINFO
3475 Display information about the board that U-Boot is running on
3476 when U-Boot starts up. The board function checkboard() is called
3477 to do this.
3478
e2e3e2b1
SG
3479- CONFIG_DISPLAY_BOARDINFO_LATE
3480 Similar to the previous option, but display this information
3481 later, once stdio is running and output goes to the LCD, if
3482 present.
3483
c609719b 3484Low Level (hardware related) configuration options:
dc7c9a1a 3485---------------------------------------------------
c609719b 3486
6d0f6bcf 3487- CONFIG_SYS_CACHELINE_SIZE:
c609719b
WD
3488 Cache Line Size of the CPU.
3489
6d0f6bcf 3490- CONFIG_SYS_DEFAULT_IMMR:
c609719b 3491 Default address of the IMMR after system reset.
2535d602 3492
42d1f039
WD
3493 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3494 and RPXsuper) to be able to adjust the position of
3495 the IMMR register after a reset.
c609719b 3496
e46fedfe
TT
3497- CONFIG_SYS_CCSRBAR_DEFAULT:
3498 Default (power-on reset) physical address of CCSR on Freescale
3499 PowerPC SOCs.
3500
3501- CONFIG_SYS_CCSRBAR:
3502 Virtual address of CCSR. On a 32-bit build, this is typically
3503 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3504
3505 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3506 for cross-platform code that uses that macro instead.
3507
3508- CONFIG_SYS_CCSRBAR_PHYS:
3509 Physical address of CCSR. CCSR can be relocated to a new
3510 physical address, if desired. In this case, this macro should
c0f40859 3511 be set to that address. Otherwise, it should be set to the
e46fedfe
TT
3512 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3513 is typically relocated on 36-bit builds. It is recommended
3514 that this macro be defined via the _HIGH and _LOW macros:
3515
3516 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3517 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3518
3519- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4cf2609b
WD
3520 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3521 either 0 (32-bit build) or 0xF (36-bit build). This macro is
e46fedfe
TT
3522 used in assembly code, so it must not contain typecasts or
3523 integer size suffixes (e.g. "ULL").
3524
3525- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3526 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3527 used in assembly code, so it must not contain typecasts or
3528 integer size suffixes (e.g. "ULL").
3529
3530- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3531 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3532 forced to a value that ensures that CCSR is not relocated.
3533
7f6c2cbc 3534- Floppy Disk Support:
6d0f6bcf 3535 CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc
WD
3536
3537 the default drive number (default value 0)
3538
6d0f6bcf 3539 CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc 3540
11ccc33f 3541 defines the spacing between FDC chipset registers
7f6c2cbc
WD
3542 (default value 1)
3543
6d0f6bcf 3544 CONFIG_SYS_ISA_IO_OFFSET
7f6c2cbc 3545
43d9616c
WD
3546 defines the offset of register from address. It
3547 depends on which part of the data bus is connected to
11ccc33f 3548 the FDC chipset. (default value 0)
7f6c2cbc 3549
6d0f6bcf
JCPV
3550 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3551 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43d9616c 3552 default value.
7f6c2cbc 3553
6d0f6bcf 3554 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616c
WD
3555 fdc_hw_init() is called at the beginning of the FDC
3556 setup. fdc_hw_init() must be provided by the board
3557 source code. It is used to make hardware dependant
3558 initializations.
7f6c2cbc 3559
0abddf82
ML
3560- CONFIG_IDE_AHB:
3561 Most IDE controllers were designed to be connected with PCI
3562 interface. Only few of them were designed for AHB interface.
3563 When software is doing ATA command and data transfer to
3564 IDE devices through IDE-AHB controller, some additional
3565 registers accessing to these kind of IDE-AHB controller
3566 is requierd.
3567
6d0f6bcf 3568- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
efe2a4d5 3569 DO NOT CHANGE unless you know exactly what you're
25d6712a 3570 doing! (11-4) [MPC8xx/82xx systems only]
c609719b 3571
6d0f6bcf 3572- CONFIG_SYS_INIT_RAM_ADDR:
c609719b 3573
7152b1d0 3574 Start address of memory area that can be used for
c609719b
WD
3575 initial data and stack; please note that this must be
3576 writable memory that is working WITHOUT special
3577 initialization, i. e. you CANNOT use normal RAM which
3578 will become available only after programming the
3579 memory controller and running certain initialization
3580 sequences.
3581
3582 U-Boot uses the following memory types:
3583 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3584 - MPC824X: data cache
3585 - PPC4xx: data cache
3586
6d0f6bcf 3587- CONFIG_SYS_GBL_DATA_OFFSET:
c609719b
WD
3588
3589 Offset of the initial data structure in the memory
6d0f6bcf
JCPV
3590 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3591 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b 3592 data is located at the end of the available space
553f0982 3593 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
6d0f6bcf
JCPV
3594 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3595 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3596 CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b
WD
3597
3598 Note:
3599 On the MPC824X (or other systems that use the data
3600 cache for initial memory) the address chosen for
6d0f6bcf 3601 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b
WD
3602 point to an otherwise UNUSED address space between
3603 the top of RAM and the start of the PCI space.
3604
6d0f6bcf 3605- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
c609719b 3606
6d0f6bcf 3607- CONFIG_SYS_SYPCR: System Protection Control (11-9)
c609719b 3608
6d0f6bcf 3609- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
c609719b 3610
6d0f6bcf 3611- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
c609719b 3612
6d0f6bcf 3613- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
c609719b 3614
6d0f6bcf 3615- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
c609719b 3616
6d0f6bcf 3617- CONFIG_SYS_OR_TIMING_SDRAM:
c609719b
WD
3618 SDRAM timing
3619
6d0f6bcf 3620- CONFIG_SYS_MAMR_PTA:
c609719b
WD
3621 periodic timer for refresh
3622
6d0f6bcf 3623- CONFIG_SYS_DER: Debug Event Register (37-47)
c609719b 3624
6d0f6bcf
JCPV
3625- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3626 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3627 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3628 CONFIG_SYS_BR1_PRELIM:
c609719b
WD
3629 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3630
3631- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
6d0f6bcf
JCPV
3632 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3633 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
c609719b
WD
3634 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3635
6d0f6bcf
JCPV
3636- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3637 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
c609719b
WD
3638 Machine Mode Register and Memory Periodic Timer
3639 Prescaler definitions (SDRAM timing)
3640
6d0f6bcf 3641- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
3642 enable I2C microcode relocation patch (MPC8xx);
3643 define relocation offset in DPRAM [DSP2]
3644
6d0f6bcf 3645- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055
HS
3646 enable SMC microcode relocation patch (MPC8xx);
3647 define relocation offset in DPRAM [SMC1]
3648
6d0f6bcf 3649- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
3650 enable SPI microcode relocation patch (MPC8xx);
3651 define relocation offset in DPRAM [SCC4]
3652
6d0f6bcf 3653- CONFIG_SYS_USE_OSCCLK:
c609719b
WD
3654 Use OSCM clock mode on MBX8xx board. Be careful,
3655 wrong setting might damage your board. Read
3656 doc/README.MBX before setting this variable!
3657
6d0f6bcf 3658- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616c
WD
3659 Offset of the bootmode word in DPRAM used by post
3660 (Power On Self Tests). This definition overrides
3661 #define'd default value in commproc.h resp.
3662 cpm_8260.h.
ea909b76 3663
6d0f6bcf
JCPV
3664- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3665 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3666 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3667 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3668 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3669 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3670 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3671 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
a47a12be 3672 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
5d232d0e 3673
9cacf4fc
DE
3674- CONFIG_PCI_DISABLE_PCIE:
3675 Disable PCI-Express on systems where it is supported but not
3676 required.
3677
69fd2d3b
AS
3678- CONFIG_PCI_ENUM_ONLY
3679 Only scan through and get the devices on the busses.
3680 Don't do any setup work, presumably because someone or
3681 something has already done it, and we don't need to do it
3682 a second time. Useful for platforms that are pre-booted
3683 by coreboot or similar.
3684
a09b9b68
KG
3685- CONFIG_SYS_SRIO:
3686 Chip has SRIO or not
3687
3688- CONFIG_SRIO1:
3689 Board has SRIO 1 port available
3690
3691- CONFIG_SRIO2:
3692 Board has SRIO 2 port available
3693
3694- CONFIG_SYS_SRIOn_MEM_VIRT:
3695 Virtual Address of SRIO port 'n' memory region
3696
3697- CONFIG_SYS_SRIOn_MEM_PHYS:
3698 Physical Address of SRIO port 'n' memory region
3699
3700- CONFIG_SYS_SRIOn_MEM_SIZE:
3701 Size of SRIO port 'n' memory region
3702
eced4626
AW
3703- CONFIG_SYS_NDFC_16
3704 Defined to tell the NDFC that the NAND chip is using a
3705 16 bit bus.
3706
3707- CONFIG_SYS_NDFC_EBC0_CFG
3708 Sets the EBC0_CFG register for the NDFC. If not defined
3709 a default value will be used.
3710
bb99ad6d 3711- CONFIG_SPD_EEPROM
218ca724
WD
3712 Get DDR timing information from an I2C EEPROM. Common
3713 with pluggable memory modules such as SODIMMs
3714
bb99ad6d
BW
3715 SPD_EEPROM_ADDRESS
3716 I2C address of the SPD EEPROM
3717
6d0f6bcf 3718- CONFIG_SYS_SPD_BUS_NUM
218ca724
WD
3719 If SPD EEPROM is on an I2C bus other than the first
3720 one, specify here. Note that the value must resolve
3721 to something your driver can deal with.
bb99ad6d 3722
1b3e3c4f
YS
3723- CONFIG_SYS_DDR_RAW_TIMING
3724 Get DDR timing information from other than SPD. Common with
3725 soldered DDR chips onboard without SPD. DDR raw timing
3726 parameters are extracted from datasheet and hard-coded into
3727 header files or board specific files.
3728
6f5e1dc5
YS
3729- CONFIG_FSL_DDR_INTERACTIVE
3730 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3731
6d0f6bcf 3732- CONFIG_SYS_83XX_DDR_USES_CS0
218ca724
WD
3733 Only for 83xx systems. If specified, then DDR should
3734 be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513 3735
c26e454d
WD
3736- CONFIG_ETHER_ON_FEC[12]
3737 Define to enable FEC[12] on a 8xx series processor.
3738
3739- CONFIG_FEC[12]_PHY
3740 Define to the hardcoded PHY address which corresponds
6e592385
WD
3741 to the given FEC; i. e.
3742 #define CONFIG_FEC1_PHY 4
c26e454d
WD
3743 means that the PHY with address 4 is connected to FEC1
3744
3745 When set to -1, means to probe for first available.
3746
3747- CONFIG_FEC[12]_PHY_NORXERR
3748 The PHY does not have a RXERR line (RMII only).
3749 (so program the FEC to ignore it).
3750
3751- CONFIG_RMII
3752 Enable RMII mode for all FECs.
3753 Note that this is a global option, we can't
3754 have one FEC in standard MII mode and another in RMII mode.
3755
5cf91d6b
WD
3756- CONFIG_CRC32_VERIFY
3757 Add a verify option to the crc32 command.
3758 The syntax is:
3759
3760 => crc32 -v <address> <count> <crc32>
3761
3762 Where address/count indicate a memory area
3763 and crc32 is the correct crc32 which the
3764 area should have.
3765
56523f12
WD
3766- CONFIG_LOOPW
3767 Add the "loopw" memory command. This only takes effect if
602ad3b3 3768 the memory commands are activated globally (CONFIG_CMD_MEM).
56523f12 3769
7b466641
SR
3770- CONFIG_MX_CYCLIC
3771 Add the "mdc" and "mwc" memory commands. These are cyclic
3772 "md/mw" commands.
3773 Examples:
3774
efe2a4d5 3775 => mdc.b 10 4 500
7b466641
SR
3776 This command will print 4 bytes (10,11,12,13) each 500 ms.
3777
efe2a4d5 3778 => mwc.l 100 12345678 10
7b466641
SR
3779 This command will write 12345678 to address 100 all 10 ms.
3780
efe2a4d5 3781 This only takes effect if the memory commands are activated
602ad3b3 3782 globally (CONFIG_CMD_MEM).
7b466641 3783
8aa1a2d1 3784- CONFIG_SKIP_LOWLEVEL_INIT
afc1ce82 3785 [ARM, NDS32, MIPS only] If this variable is defined, then certain
844f07d8
WD
3786 low level initializations (like setting up the memory
3787 controller) are omitted and/or U-Boot does not
3788 relocate itself into RAM.
3789
3790 Normally this variable MUST NOT be defined. The only
3791 exception is when U-Boot is loaded (to RAM) by some
3792 other boot loader or by a debugger which performs
3793 these initializations itself.
8aa1a2d1 3794
401bb30b 3795- CONFIG_SPL_BUILD
df81238b
ML
3796 Modifies the behaviour of start.S when compiling a loader
3797 that is executed before the actual U-Boot. E.g. when
3798 compiling a NAND SPL.
400558b5 3799
d8834a13
MW
3800- CONFIG_USE_ARCH_MEMCPY
3801 CONFIG_USE_ARCH_MEMSET
3802 If these options are used a optimized version of memcpy/memset will
3803 be used if available. These functions may be faster under some
3804 conditions but may increase the binary size.
3805
b16f521a
GB
3806- CONFIG_X86_NO_RESET_VECTOR
3807 If defined, the x86 reset vector code is excluded. You will need
3808 to do this when U-Boot is running from Coreboot.
3809
5b5ece9e
GB
3810- CONFIG_X86_NO_REAL_MODE
3811 If defined, x86 real mode code is omitted. This assumes a
3812 32-bit environment where such code is not needed. You will
3813 need to do this when U-Boot is running from Coreboot.
3814
3815
f2717b47
TT
3816Freescale QE/FMAN Firmware Support:
3817-----------------------------------
3818
3819The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3820loading of "firmware", which is encoded in the QE firmware binary format.
3821This firmware often needs to be loaded during U-Boot booting, so macros
3822are used to identify the storage device (NOR flash, SPI, etc) and the address
3823within that device.
3824
3825- CONFIG_SYS_QE_FMAN_FW_ADDR
3826 The address in the storage device where the firmware is located. The
3827 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3828 is also specified.
3829
3830- CONFIG_SYS_QE_FMAN_FW_LENGTH
3831 The maximum possible size of the firmware. The firmware binary format
3832 has a field that specifies the actual size of the firmware, but it
3833 might not be possible to read any part of the firmware unless some
3834 local storage is allocated to hold the entire firmware first.
3835
3836- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3837 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3838 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3839 virtual address in NOR flash.
3840
3841- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3842 Specifies that QE/FMAN firmware is located in NAND flash.
3843 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3844
3845- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3846 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3847 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3848
3849- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3850 Specifies that QE/FMAN firmware is located on the primary SPI
3851 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3852
292dc6c5
LG
3853- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3854 Specifies that QE/FMAN firmware is located in the remote (master)
3855 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
fc54c7fa
LG
3856 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3857 window->master inbound window->master LAW->the ucode address in
3858 master's memory space.
f2717b47 3859
c609719b
WD
3860Building the Software:
3861======================
3862
218ca724
WD
3863Building U-Boot has been tested in several native build environments
3864and in many different cross environments. Of course we cannot support
3865all possibly existing versions of cross development tools in all
3866(potentially obsolete) versions. In case of tool chain problems we
3867recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3868which is extensively used to build and test U-Boot.
c609719b 3869
218ca724
WD
3870If you are not using a native environment, it is assumed that you
3871have GNU cross compiling tools available in your path. In this case,
3872you must set the environment variable CROSS_COMPILE in your shell.
3873Note that no changes to the Makefile or any other source files are
3874necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b 3875
218ca724
WD
3876 $ CROSS_COMPILE=ppc_4xx-
3877 $ export CROSS_COMPILE
c609719b 3878
2f8d396b
PT
3879Note: If you wish to generate Windows versions of the utilities in
3880 the tools directory you can use the MinGW toolchain
3881 (http://www.mingw.org). Set your HOST tools to the MinGW
3882 toolchain and execute 'make tools'. For example:
3883
3884 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3885
3886 Binaries such as tools/mkimage.exe will be created which can
3887 be executed on computers running Windows.
3888
218ca724
WD
3889U-Boot is intended to be simple to build. After installing the
3890sources you must configure U-Boot for one specific board type. This
c609719b
WD
3891is done by typing:
3892
3893 make NAME_config
3894
218ca724 3895where "NAME_config" is the name of one of the existing configu-
4d675ae6 3896rations; see boards.cfg for supported names.
db01a2ea 3897
2729af9d
WD
3898Note: for some board special configuration names may exist; check if
3899 additional information is available from the board vendor; for
3900 instance, the TQM823L systems are available without (standard)
3901 or with LCD support. You can select such additional "features"
11ccc33f 3902 when choosing the configuration, i. e.
2729af9d
WD
3903
3904 make TQM823L_config
3905 - will configure for a plain TQM823L, i. e. no LCD support
3906
3907 make TQM823L_LCD_config
3908 - will configure for a TQM823L with U-Boot console on LCD
3909
3910 etc.
3911
3912
3913Finally, type "make all", and you should get some working U-Boot
3914images ready for download to / installation on your system:
3915
3916- "u-boot.bin" is a raw binary image
3917- "u-boot" is an image in ELF binary format
3918- "u-boot.srec" is in Motorola S-Record format
3919
baf31249
MB
3920By default the build is performed locally and the objects are saved
3921in the source directory. One of the two methods can be used to change
3922this behavior and build U-Boot to some external directory:
3923
39241. Add O= to the make command line invocations:
3925
3926 make O=/tmp/build distclean
3927 make O=/tmp/build NAME_config
3928 make O=/tmp/build all
3929
39302. Set environment variable BUILD_DIR to point to the desired location:
3931
3932 export BUILD_DIR=/tmp/build
3933 make distclean
3934 make NAME_config
3935 make all
3936
3937Note that the command line "O=" setting overrides the BUILD_DIR environment
3938variable.
3939
2729af9d
WD
3940
3941Please be aware that the Makefiles assume you are using GNU make, so
3942for instance on NetBSD you might need to use "gmake" instead of
3943native "make".
3944
3945
3946If the system board that you have is not listed, then you will need
3947to port U-Boot to your hardware platform. To do this, follow these
3948steps:
3949
39501. Add a new configuration option for your board to the toplevel
4d675ae6
MJ
3951 "boards.cfg" file, using the existing entries as examples.
3952 Follow the instructions there to keep the boards in order.
2729af9d
WD
39532. Create a new directory to hold your board specific code. Add any
3954 files you need. In your board directory, you will need at least
3955 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
39563. Create a new configuration file "include/configs/<board>.h" for
3957 your board
39583. If you're porting U-Boot to a new CPU, then also create a new
3959 directory to hold your CPU specific code. Add any files you need.
39604. Run "make <board>_config" with your new name.
39615. Type "make", and you should get a working "u-boot.srec" file
3962 to be installed on your target system.
39636. Debug and solve any problems that might arise.
3964 [Of course, this last step is much harder than it sounds.]
3965
3966
3967Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3968==============================================================
3969
218ca724
WD
3970If you have modified U-Boot sources (for instance added a new board
3971or support for new devices, a new CPU, etc.) you are expected to
2729af9d
WD
3972provide feedback to the other developers. The feedback normally takes
3973the form of a "patch", i. e. a context diff against a certain (latest
218ca724 3974official or latest in the git repository) version of U-Boot sources.
2729af9d 3975
218ca724
WD
3976But before you submit such a patch, please verify that your modifi-
3977cation did not break existing code. At least make sure that *ALL* of
2729af9d
WD
3978the supported boards compile WITHOUT ANY compiler warnings. To do so,
3979just run the "MAKEALL" script, which will configure and build U-Boot
218ca724
WD
3980for ALL supported system. Be warned, this will take a while. You can
3981select which (cross) compiler to use by passing a `CROSS_COMPILE'
3982environment variable to the script, i. e. to use the ELDK cross tools
3983you can type
2729af9d
WD
3984
3985 CROSS_COMPILE=ppc_8xx- MAKEALL
3986
3987or to build on a native PowerPC system you can type
3988
3989 CROSS_COMPILE=' ' MAKEALL
3990
218ca724
WD
3991When using the MAKEALL script, the default behaviour is to build
3992U-Boot in the source directory. This location can be changed by
3993setting the BUILD_DIR environment variable. Also, for each target
3994built, the MAKEALL script saves two log files (<target>.ERR and
3995<target>.MAKEALL) in the <source dir>/LOG directory. This default
3996location can be changed by setting the MAKEALL_LOGDIR environment
3997variable. For example:
baf31249
MB
3998
3999 export BUILD_DIR=/tmp/build
4000 export MAKEALL_LOGDIR=/tmp/log
4001 CROSS_COMPILE=ppc_8xx- MAKEALL
4002
218ca724
WD
4003With the above settings build objects are saved in the /tmp/build,
4004log files are saved in the /tmp/log and the source tree remains clean
4005during the whole build process.
baf31249
MB
4006
4007
2729af9d
WD
4008See also "U-Boot Porting Guide" below.
4009
4010
4011Monitor Commands - Overview:
4012============================
4013
4014go - start application at address 'addr'
4015run - run commands in an environment variable
4016bootm - boot application image from memory
4017bootp - boot image via network using BootP/TFTP protocol
44f074c7 4018bootz - boot zImage from memory
2729af9d
WD
4019tftpboot- boot image via network using TFTP protocol
4020 and env variables "ipaddr" and "serverip"
4021 (and eventually "gatewayip")
1fb7cd49 4022tftpput - upload a file via network using TFTP protocol
2729af9d
WD
4023rarpboot- boot image via network using RARP/TFTP protocol
4024diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4025loads - load S-Record file over serial line
4026loadb - load binary file over serial line (kermit mode)
4027md - memory display
4028mm - memory modify (auto-incrementing)
4029nm - memory modify (constant address)
4030mw - memory write (fill)
4031cp - memory copy
4032cmp - memory compare
4033crc32 - checksum calculation
0f89c54b 4034i2c - I2C sub-system
2729af9d
WD
4035sspi - SPI utility commands
4036base - print or set address offset
4037printenv- print environment variables
4038setenv - set environment variables
4039saveenv - save environment variables to persistent storage
4040protect - enable or disable FLASH write protection
4041erase - erase FLASH memory
4042flinfo - print FLASH memory information
10635afa 4043nand - NAND memory operations (see doc/README.nand)
2729af9d
WD
4044bdinfo - print Board Info structure
4045iminfo - print header information for application image
4046coninfo - print console devices and informations
4047ide - IDE sub-system
4048loop - infinite loop on address range
56523f12 4049loopw - infinite write loop on address range
2729af9d
WD
4050mtest - simple RAM test
4051icache - enable or disable instruction cache
4052dcache - enable or disable data cache
4053reset - Perform RESET of the CPU
4054echo - echo args to console
4055version - print monitor version
4056help - print online help
4057? - alias for 'help'
4058
4059
4060Monitor Commands - Detailed Description:
4061========================================
4062
4063TODO.
4064
4065For now: just type "help <command>".
4066
4067
4068Environment Variables:
4069======================
4070
4071U-Boot supports user configuration using Environment Variables which
4072can be made persistent by saving to Flash memory.
c609719b 4073
2729af9d
WD
4074Environment Variables are set using "setenv", printed using
4075"printenv", and saved to Flash using "saveenv". Using "setenv"
4076without a value can be used to delete a variable from the
4077environment. As long as you don't save the environment you are
4078working with an in-memory copy. In case the Flash area containing the
4079environment is erased by accident, a default environment is provided.
c609719b 4080
c96f86ee
WD
4081Some configuration options can be set using Environment Variables.
4082
4083List of environment variables (most likely not complete):
c609719b 4084
2729af9d 4085 baudrate - see CONFIG_BAUDRATE
c609719b 4086
2729af9d 4087 bootdelay - see CONFIG_BOOTDELAY
c609719b 4088
2729af9d 4089 bootcmd - see CONFIG_BOOTCOMMAND
4a6fd34b 4090
2729af9d 4091 bootargs - Boot arguments when booting an RTOS image
c609719b 4092
2729af9d 4093 bootfile - Name of the image to load with TFTP
c609719b 4094
7d721e34
BS
4095 bootm_low - Memory range available for image processing in the bootm
4096 command can be restricted. This variable is given as
4097 a hexadecimal number and defines lowest address allowed
4098 for use by the bootm command. See also "bootm_size"
4099 environment variable. Address defined by "bootm_low" is
4100 also the base of the initial memory mapping for the Linux
c3624e6e
GL
4101 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4102 bootm_mapsize.
4103
c0f40859 4104 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6e
GL
4105 This variable is given as a hexadecimal number and it
4106 defines the size of the memory region starting at base
4107 address bootm_low that is accessible by the Linux kernel
4108 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4109 as the default value if it is defined, and bootm_size is
4110 used otherwise.
7d721e34
BS
4111
4112 bootm_size - Memory range available for image processing in the bootm
4113 command can be restricted. This variable is given as
4114 a hexadecimal number and defines the size of the region
4115 allowed for use by the bootm command. See also "bootm_low"
4116 environment variable.
4117
4bae9090
BS
4118 updatefile - Location of the software update file on a TFTP server, used
4119 by the automatic software update feature. Please refer to
4120 documentation in doc/README.update for more details.
4121
2729af9d
WD
4122 autoload - if set to "no" (any string beginning with 'n'),
4123 "bootp" will just load perform a lookup of the
4124 configuration from the BOOTP server, but not try to
4125 load any image using TFTP
c609719b 4126
2729af9d
WD
4127 autostart - if set to "yes", an image loaded using the "bootp",
4128 "rarpboot", "tftpboot" or "diskboot" commands will
4129 be automatically started (by internally calling
4130 "bootm")
38b99261 4131
2729af9d
WD
4132 If set to "no", a standalone image passed to the
4133 "bootm" command will be copied to the load address
4134 (and eventually uncompressed), but NOT be started.
4135 This can be used to load and uncompress arbitrary
4136 data.
c609719b 4137
a28afca5
DL
4138 fdt_high - if set this restricts the maximum address that the
4139 flattened device tree will be copied into upon boot.
fa34f6b2
SG
4140 For example, if you have a system with 1 GB memory
4141 at physical address 0x10000000, while Linux kernel
4142 only recognizes the first 704 MB as low memory, you
4143 may need to set fdt_high as 0x3C000000 to have the
4144 device tree blob be copied to the maximum address
4145 of the 704 MB low memory, so that Linux kernel can
4146 access it during the boot procedure.
4147
a28afca5
DL
4148 If this is set to the special value 0xFFFFFFFF then
4149 the fdt will not be copied at all on boot. For this
4150 to work it must reside in writable memory, have
4151 sufficient padding on the end of it for u-boot to
4152 add the information it needs into it, and the memory
4153 must be accessible by the kernel.
4154
eea63e05
SG
4155 fdtcontroladdr- if set this is the address of the control flattened
4156 device tree used by U-Boot when CONFIG_OF_CONTROL is
4157 defined.
4158
17ea1177
WD
4159 i2cfast - (PPC405GP|PPC405EP only)
4160 if set to 'y' configures Linux I2C driver for fast
4161 mode (400kHZ). This environment variable is used in
4162 initialization code. So, for changes to be effective
4163 it must be saved and board must be reset.
4164
2729af9d
WD
4165 initrd_high - restrict positioning of initrd images:
4166 If this variable is not set, initrd images will be
4167 copied to the highest possible address in RAM; this
4168 is usually what you want since it allows for
4169 maximum initrd size. If for some reason you want to
4170 make sure that the initrd image is loaded below the
6d0f6bcf 4171 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d
WD
4172 variable to a value of "no" or "off" or "0".
4173 Alternatively, you can set it to a maximum upper
4174 address to use (U-Boot will still check that it
4175 does not overwrite the U-Boot stack and data).
c609719b 4176
2729af9d
WD
4177 For instance, when you have a system with 16 MB
4178 RAM, and want to reserve 4 MB from use by Linux,
4179 you can do this by adding "mem=12M" to the value of
4180 the "bootargs" variable. However, now you must make
4181 sure that the initrd image is placed in the first
4182 12 MB as well - this can be done with
c609719b 4183
2729af9d 4184 setenv initrd_high 00c00000
c609719b 4185
2729af9d
WD
4186 If you set initrd_high to 0xFFFFFFFF, this is an
4187 indication to U-Boot that all addresses are legal
4188 for the Linux kernel, including addresses in flash
4189 memory. In this case U-Boot will NOT COPY the
4190 ramdisk at all. This may be useful to reduce the
4191 boot time on your system, but requires that this
4192 feature is supported by your Linux kernel.
c609719b 4193
2729af9d 4194 ipaddr - IP address; needed for tftpboot command
c609719b 4195
2729af9d
WD
4196 loadaddr - Default load address for commands like "bootp",
4197 "rarpboot", "tftpboot", "loadb" or "diskboot"
c609719b 4198
2729af9d 4199 loads_echo - see CONFIG_LOADS_ECHO
a3d991bd 4200
2729af9d 4201 serverip - TFTP server IP address; needed for tftpboot command
a3d991bd 4202
2729af9d 4203 bootretry - see CONFIG_BOOT_RETRY_TIME
a3d991bd 4204
2729af9d 4205 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
a3d991bd 4206
2729af9d 4207 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
c609719b 4208
e2a53458 4209 ethprime - controls which interface is used first.
c609719b 4210
e2a53458
MF
4211 ethact - controls which interface is currently active.
4212 For example you can do the following
c609719b 4213
48690d80
HS
4214 => setenv ethact FEC
4215 => ping 192.168.0.1 # traffic sent on FEC
4216 => setenv ethact SCC
4217 => ping 10.0.0.1 # traffic sent on SCC
c609719b 4218
e1692577
MF
4219 ethrotate - When set to "no" U-Boot does not go through all
4220 available network interfaces.
4221 It just stays at the currently selected interface.
4222
c96f86ee 4223 netretry - When set to "no" each network operation will
2729af9d
WD
4224 either succeed or fail without retrying.
4225 When set to "once" the network operation will
4226 fail when all the available network interfaces
4227 are tried once without success.
4228 Useful on scripts which control the retry operation
4229 themselves.
c609719b 4230
b4e2f89d 4231 npe_ucode - set load address for the NPE microcode
a1cf027a 4232
28cb9375 4233 tftpsrcport - If this is set, the value is used for TFTP's
ecb0ccd9
WD
4234 UDP source port.
4235
28cb9375
WD
4236 tftpdstport - If this is set, the value is used for TFTP's UDP
4237 destination port instead of the Well Know Port 69.
4238
c96f86ee
WD
4239 tftpblocksize - Block size to use for TFTP transfers; if not set,
4240 we use the TFTP server's default block size
4241
4242 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4243 seconds, minimum value is 1000 = 1 second). Defines
4244 when a packet is considered to be lost so it has to
4245 be retransmitted. The default is 5000 = 5 seconds.
4246 Lowering this value may make downloads succeed
4247 faster in networks with high packet loss rates or
4248 with unreliable TFTP servers.
4249
4250 vlan - When set to a value < 4095 the traffic over
11ccc33f 4251 Ethernet is encapsulated/received over 802.1q
2729af9d 4252 VLAN tagged frames.
c609719b 4253
dc0b7b0e
JH
4254The following image location variables contain the location of images
4255used in booting. The "Image" column gives the role of the image and is
4256not an environment variable name. The other columns are environment
4257variable names. "File Name" gives the name of the file on a TFTP
4258server, "RAM Address" gives the location in RAM the image will be
4259loaded to, and "Flash Location" gives the image's address in NOR
4260flash or offset in NAND flash.
4261
4262*Note* - these variables don't have to be defined for all boards, some
4263boards currenlty use other variables for these purposes, and some
4264boards use these variables for other purposes.
4265
c0f40859
WD
4266Image File Name RAM Address Flash Location
4267----- --------- ----------- --------------
4268u-boot u-boot u-boot_addr_r u-boot_addr
4269Linux kernel bootfile kernel_addr_r kernel_addr
4270device tree blob fdtfile fdt_addr_r fdt_addr
4271ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
dc0b7b0e 4272
2729af9d
WD
4273The following environment variables may be used and automatically
4274updated by the network boot commands ("bootp" and "rarpboot"),
4275depending the information provided by your boot server:
c609719b 4276
2729af9d
WD
4277 bootfile - see above
4278 dnsip - IP address of your Domain Name Server
4279 dnsip2 - IP address of your secondary Domain Name Server
4280 gatewayip - IP address of the Gateway (Router) to use
4281 hostname - Target hostname
4282 ipaddr - see above
4283 netmask - Subnet Mask
4284 rootpath - Pathname of the root filesystem on the NFS server
4285 serverip - see above
c1551ea8 4286
c1551ea8 4287
2729af9d 4288There are two special Environment Variables:
c1551ea8 4289
2729af9d
WD
4290 serial# - contains hardware identification information such
4291 as type string and/or serial number
4292 ethaddr - Ethernet address
c609719b 4293
2729af9d
WD
4294These variables can be set only once (usually during manufacturing of
4295the board). U-Boot refuses to delete or overwrite these variables
4296once they have been set once.
c609719b 4297
f07771cc 4298
2729af9d 4299Further special Environment Variables:
f07771cc 4300
2729af9d
WD
4301 ver - Contains the U-Boot version string as printed
4302 with the "version" command. This variable is
4303 readonly (see CONFIG_VERSION_VARIABLE).
f07771cc 4304
f07771cc 4305
2729af9d
WD
4306Please note that changes to some configuration parameters may take
4307only effect after the next boot (yes, that's just like Windoze :-).
f07771cc 4308
f07771cc 4309
170ab110
JH
4310Callback functions for environment variables:
4311---------------------------------------------
4312
4313For some environment variables, the behavior of u-boot needs to change
4314when their values are changed. This functionailty allows functions to
4315be associated with arbitrary variables. On creation, overwrite, or
4316deletion, the callback will provide the opportunity for some side
4317effect to happen or for the change to be rejected.
4318
4319The callbacks are named and associated with a function using the
4320U_BOOT_ENV_CALLBACK macro in your board or driver code.
4321
4322These callbacks are associated with variables in one of two ways. The
4323static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4324in the board configuration to a string that defines a list of
4325associations. The list must be in the following format:
4326
4327 entry = variable_name[:callback_name]
4328 list = entry[,list]
4329
4330If the callback name is not specified, then the callback is deleted.
4331Spaces are also allowed anywhere in the list.
4332
4333Callbacks can also be associated by defining the ".callbacks" variable
4334with the same list format above. Any association in ".callbacks" will
4335override any association in the static list. You can define
4336CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4337".callbacks" envirnoment variable in the default or embedded environment.
4338
4339
2729af9d
WD
4340Command Line Parsing:
4341=====================
f07771cc 4342
2729af9d
WD
4343There are two different command line parsers available with U-Boot:
4344the old "simple" one, and the much more powerful "hush" shell:
c609719b 4345
2729af9d
WD
4346Old, simple command line parser:
4347--------------------------------
c609719b 4348
2729af9d
WD
4349- supports environment variables (through setenv / saveenv commands)
4350- several commands on one line, separated by ';'
fe126d8b 4351- variable substitution using "... ${name} ..." syntax
2729af9d
WD
4352- special characters ('$', ';') can be escaped by prefixing with '\',
4353 for example:
fe126d8b 4354 setenv bootcmd bootm \${address}
2729af9d
WD
4355- You can also escape text by enclosing in single apostrophes, for example:
4356 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
c609719b 4357
2729af9d
WD
4358Hush shell:
4359-----------
c609719b 4360
2729af9d
WD
4361- similar to Bourne shell, with control structures like
4362 if...then...else...fi, for...do...done; while...do...done,
4363 until...do...done, ...
4364- supports environment ("global") variables (through setenv / saveenv
4365 commands) and local shell variables (through standard shell syntax
4366 "name=value"); only environment variables can be used with "run"
4367 command
4368
4369General rules:
4370--------------
c609719b 4371
2729af9d
WD
4372(1) If a command line (or an environment variable executed by a "run"
4373 command) contains several commands separated by semicolon, and
4374 one of these commands fails, then the remaining commands will be
4375 executed anyway.
c609719b 4376
2729af9d 4377(2) If you execute several variables with one call to run (i. e.
11ccc33f 4378 calling run with a list of variables as arguments), any failing
2729af9d
WD
4379 command will cause "run" to terminate, i. e. the remaining
4380 variables are not executed.
c609719b 4381
2729af9d
WD
4382Note for Redundant Ethernet Interfaces:
4383=======================================
c609719b 4384
11ccc33f 4385Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d
WD
4386such configurations and is capable of automatic selection of a
4387"working" interface when needed. MAC assignment works as follows:
c609719b 4388
2729af9d
WD
4389Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4390MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4391"eth1addr" (=>eth1), "eth2addr", ...
c609719b 4392
2729af9d
WD
4393If the network interface stores some valid MAC address (for instance
4394in SROM), this is used as default address if there is NO correspon-
4395ding setting in the environment; if the corresponding environment
4396variable is set, this overrides the settings in the card; that means:
c609719b 4397
2729af9d
WD
4398o If the SROM has a valid MAC address, and there is no address in the
4399 environment, the SROM's address is used.
c609719b 4400
2729af9d
WD
4401o If there is no valid address in the SROM, and a definition in the
4402 environment exists, then the value from the environment variable is
4403 used.
c609719b 4404
2729af9d
WD
4405o If both the SROM and the environment contain a MAC address, and
4406 both addresses are the same, this MAC address is used.
c609719b 4407
2729af9d
WD
4408o If both the SROM and the environment contain a MAC address, and the
4409 addresses differ, the value from the environment is used and a
4410 warning is printed.
c609719b 4411
2729af9d
WD
4412o If neither SROM nor the environment contain a MAC address, an error
4413 is raised.
c609719b 4414
ecee9324 4415If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859 4416will be programmed into hardware as part of the initialization process. This
ecee9324
BW
4417may be skipped by setting the appropriate 'ethmacskip' environment variable.
4418The naming convention is as follows:
4419"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
c609719b 4420
2729af9d
WD
4421Image Formats:
4422==============
c609719b 4423
3310c549
MB
4424U-Boot is capable of booting (and performing other auxiliary operations on)
4425images in two formats:
4426
4427New uImage format (FIT)
4428-----------------------
4429
4430Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4431to Flattened Device Tree). It allows the use of images with multiple
4432components (several kernels, ramdisks, etc.), with contents protected by
4433SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4434
4435
4436Old uImage format
4437-----------------
4438
4439Old image format is based on binary files which can be basically anything,
4440preceded by a special header; see the definitions in include/image.h for
4441details; basically, the header defines the following image properties:
c609719b 4442
2729af9d
WD
4443* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4444 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e39
PT
4445 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4446 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4447 INTEGRITY).
7b64fef3 4448* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
afc1ce82
ML
4449 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4450 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d
WD
4451* Compression Type (uncompressed, gzip, bzip2)
4452* Load Address
4453* Entry Point
4454* Image Name
4455* Image Timestamp
c609719b 4456
2729af9d
WD
4457The header is marked by a special Magic Number, and both the header
4458and the data portions of the image are secured against corruption by
4459CRC32 checksums.
c609719b
WD
4460
4461
2729af9d
WD
4462Linux Support:
4463==============
c609719b 4464
2729af9d
WD
4465Although U-Boot should support any OS or standalone application
4466easily, the main focus has always been on Linux during the design of
4467U-Boot.
c609719b 4468
2729af9d
WD
4469U-Boot includes many features that so far have been part of some
4470special "boot loader" code within the Linux kernel. Also, any
4471"initrd" images to be used are no longer part of one big Linux image;
4472instead, kernel and "initrd" are separate images. This implementation
4473serves several purposes:
c609719b 4474
2729af9d
WD
4475- the same features can be used for other OS or standalone
4476 applications (for instance: using compressed images to reduce the
4477 Flash memory footprint)
c609719b 4478
2729af9d
WD
4479- it becomes much easier to port new Linux kernel versions because
4480 lots of low-level, hardware dependent stuff are done by U-Boot
c609719b 4481
2729af9d
WD
4482- the same Linux kernel image can now be used with different "initrd"
4483 images; of course this also means that different kernel images can
4484 be run with the same "initrd". This makes testing easier (you don't
4485 have to build a new "zImage.initrd" Linux image when you just
4486 change a file in your "initrd"). Also, a field-upgrade of the
4487 software is easier now.
c609719b 4488
c609719b 4489
2729af9d
WD
4490Linux HOWTO:
4491============
c609719b 4492
2729af9d
WD
4493Porting Linux to U-Boot based systems:
4494---------------------------------------
c609719b 4495
2729af9d
WD
4496U-Boot cannot save you from doing all the necessary modifications to
4497configure the Linux device drivers for use with your target hardware
4498(no, we don't intend to provide a full virtual machine interface to
4499Linux :-).
c609719b 4500
a47a12be 4501But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
24ee89b9 4502
2729af9d
WD
4503Just make sure your machine specific header file (for instance
4504include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc30693
MH
4505Information structure as we define in include/asm-<arch>/u-boot.h,
4506and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf 4507as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b9 4508
c609719b 4509
2729af9d
WD
4510Configuring the Linux kernel:
4511-----------------------------
c609719b 4512
2729af9d
WD
4513No specific requirements for U-Boot. Make sure you have some root
4514device (initial ramdisk, NFS) for your target system.
4515
4516
4517Building a Linux Image:
4518-----------------------
c609719b 4519
2729af9d
WD
4520With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4521not used. If you use recent kernel source, a new build target
4522"uImage" will exist which automatically builds an image usable by
4523U-Boot. Most older kernels also have support for a "pImage" target,
4524which was introduced for our predecessor project PPCBoot and uses a
4525100% compatible format.
4526
4527Example:
4528
4529 make TQM850L_config
4530 make oldconfig
4531 make dep
4532 make uImage
4533
4534The "uImage" build target uses a special tool (in 'tools/mkimage') to
4535encapsulate a compressed Linux kernel image with header information,
4536CRC32 checksum etc. for use with U-Boot. This is what we are doing:
4537
4538* build a standard "vmlinux" kernel image (in ELF binary format):
4539
4540* convert the kernel into a raw binary image:
4541
4542 ${CROSS_COMPILE}-objcopy -O binary \
4543 -R .note -R .comment \
4544 -S vmlinux linux.bin
4545
4546* compress the binary image:
4547
4548 gzip -9 linux.bin
4549
4550* package compressed binary image for U-Boot:
4551
4552 mkimage -A ppc -O linux -T kernel -C gzip \
4553 -a 0 -e 0 -n "Linux Kernel Image" \
4554 -d linux.bin.gz uImage
c609719b 4555
c609719b 4556
2729af9d
WD
4557The "mkimage" tool can also be used to create ramdisk images for use
4558with U-Boot, either separated from the Linux kernel image, or
4559combined into one file. "mkimage" encapsulates the images with a 64
4560byte header containing information about target architecture,
4561operating system, image type, compression method, entry points, time
4562stamp, CRC32 checksums, etc.
4563
4564"mkimage" can be called in two ways: to verify existing images and
4565print the header information, or to build new images.
4566
4567In the first form (with "-l" option) mkimage lists the information
4568contained in the header of an existing U-Boot image; this includes
4569checksum verification:
c609719b 4570
2729af9d
WD
4571 tools/mkimage -l image
4572 -l ==> list image header information
4573
4574The second form (with "-d" option) is used to build a U-Boot image
4575from a "data file" which is used as image payload:
4576
4577 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4578 -n name -d data_file image
4579 -A ==> set architecture to 'arch'
4580 -O ==> set operating system to 'os'
4581 -T ==> set image type to 'type'
4582 -C ==> set compression type 'comp'
4583 -a ==> set load address to 'addr' (hex)
4584 -e ==> set entry point to 'ep' (hex)
4585 -n ==> set image name to 'name'
4586 -d ==> use image data from 'datafile'
4587
69459791
WD
4588Right now, all Linux kernels for PowerPC systems use the same load
4589address (0x00000000), but the entry point address depends on the
4590kernel version:
2729af9d
WD
4591
4592- 2.2.x kernels have the entry point at 0x0000000C,
4593- 2.3.x and later kernels have the entry point at 0x00000000.
4594
4595So a typical call to build a U-Boot image would read:
4596
4597 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4598 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
a47a12be 4599 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d
WD
4600 > examples/uImage.TQM850L
4601 Image Name: 2.4.4 kernel for TQM850L
4602 Created: Wed Jul 19 02:34:59 2000
4603 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4604 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4605 Load Address: 0x00000000
4606 Entry Point: 0x00000000
4607
4608To verify the contents of the image (or check for corruption):
4609
4610 -> tools/mkimage -l examples/uImage.TQM850L
4611 Image Name: 2.4.4 kernel for TQM850L
4612 Created: Wed Jul 19 02:34:59 2000
4613 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4614 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4615 Load Address: 0x00000000
4616 Entry Point: 0x00000000
4617
4618NOTE: for embedded systems where boot time is critical you can trade
4619speed for memory and install an UNCOMPRESSED image instead: this
4620needs more space in Flash, but boots much faster since it does not
4621need to be uncompressed:
4622
a47a12be 4623 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d
WD
4624 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4625 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
a47a12be 4626 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d
WD
4627 > examples/uImage.TQM850L-uncompressed
4628 Image Name: 2.4.4 kernel for TQM850L
4629 Created: Wed Jul 19 02:34:59 2000
4630 Image Type: PowerPC Linux Kernel Image (uncompressed)
4631 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4632 Load Address: 0x00000000
4633 Entry Point: 0x00000000
4634
4635
4636Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4637when your kernel is intended to use an initial ramdisk:
4638
4639 -> tools/mkimage -n 'Simple Ramdisk Image' \
4640 > -A ppc -O linux -T ramdisk -C gzip \
4641 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4642 Image Name: Simple Ramdisk Image
4643 Created: Wed Jan 12 14:01:50 2000
4644 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4645 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4646 Load Address: 0x00000000
4647 Entry Point: 0x00000000
4648
4649
4650Installing a Linux Image:
4651-------------------------
4652
4653To downloading a U-Boot image over the serial (console) interface,
4654you must convert the image to S-Record format:
4655
4656 objcopy -I binary -O srec examples/image examples/image.srec
4657
4658The 'objcopy' does not understand the information in the U-Boot
4659image header, so the resulting S-Record file will be relative to
4660address 0x00000000. To load it to a given address, you need to
4661specify the target address as 'offset' parameter with the 'loads'
4662command.
4663
4664Example: install the image to address 0x40100000 (which on the
4665TQM8xxL is in the first Flash bank):
4666
4667 => erase 40100000 401FFFFF
4668
4669 .......... done
4670 Erased 8 sectors
4671
4672 => loads 40100000
4673 ## Ready for S-Record download ...
4674 ~>examples/image.srec
4675 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4676 ...
4677 15989 15990 15991 15992
4678 [file transfer complete]
4679 [connected]
4680 ## Start Addr = 0x00000000
4681
4682
4683You can check the success of the download using the 'iminfo' command;
218ca724 4684this includes a checksum verification so you can be sure no data
2729af9d
WD
4685corruption happened:
4686
4687 => imi 40100000
4688
4689 ## Checking Image at 40100000 ...
4690 Image Name: 2.2.13 for initrd on TQM850L
4691 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4692 Data Size: 335725 Bytes = 327 kB = 0 MB
4693 Load Address: 00000000
4694 Entry Point: 0000000c
4695 Verifying Checksum ... OK
4696
4697
4698Boot Linux:
4699-----------
4700
4701The "bootm" command is used to boot an application that is stored in
4702memory (RAM or Flash). In case of a Linux kernel image, the contents
4703of the "bootargs" environment variable is passed to the kernel as
4704parameters. You can check and modify this variable using the
4705"printenv" and "setenv" commands:
4706
4707
4708 => printenv bootargs
4709 bootargs=root=/dev/ram
4710
4711 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4712
4713 => printenv bootargs
4714 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4715
4716 => bootm 40020000
4717 ## Booting Linux kernel at 40020000 ...
4718 Image Name: 2.2.13 for NFS on TQM850L
4719 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4720 Data Size: 381681 Bytes = 372 kB = 0 MB
4721 Load Address: 00000000
4722 Entry Point: 0000000c
4723 Verifying Checksum ... OK
4724 Uncompressing Kernel Image ... OK
4725 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
4726 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4727 time_init: decrementer frequency = 187500000/60
4728 Calibrating delay loop... 49.77 BogoMIPS
4729 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4730 ...
4731
11ccc33f 4732If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d
WD
4733the memory addresses of both the kernel and the initrd image (PPBCOOT
4734format!) to the "bootm" command:
4735
4736 => imi 40100000 40200000
4737
4738 ## Checking Image at 40100000 ...
4739 Image Name: 2.2.13 for initrd on TQM850L
4740 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4741 Data Size: 335725 Bytes = 327 kB = 0 MB
4742 Load Address: 00000000
4743 Entry Point: 0000000c
4744 Verifying Checksum ... OK
4745
4746 ## Checking Image at 40200000 ...
4747 Image Name: Simple Ramdisk Image
4748 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4749 Data Size: 566530 Bytes = 553 kB = 0 MB
4750 Load Address: 00000000
4751 Entry Point: 00000000
4752 Verifying Checksum ... OK
4753
4754 => bootm 40100000 40200000
4755 ## Booting Linux kernel at 40100000 ...
4756 Image Name: 2.2.13 for initrd on TQM850L
4757 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4758 Data Size: 335725 Bytes = 327 kB = 0 MB
4759 Load Address: 00000000
4760 Entry Point: 0000000c
4761 Verifying Checksum ... OK
4762 Uncompressing Kernel Image ... OK
4763 ## Loading RAMDisk Image at 40200000 ...
4764 Image Name: Simple Ramdisk Image
4765 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4766 Data Size: 566530 Bytes = 553 kB = 0 MB
4767 Load Address: 00000000
4768 Entry Point: 00000000
4769 Verifying Checksum ... OK
4770 Loading Ramdisk ... OK
4771 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
4772 Boot arguments: root=/dev/ram
4773 time_init: decrementer frequency = 187500000/60
4774 Calibrating delay loop... 49.77 BogoMIPS
4775 ...
4776 RAMDISK: Compressed image found at block 0
4777 VFS: Mounted root (ext2 filesystem).
4778
4779 bash#
4780
0267768e
MM
4781Boot Linux and pass a flat device tree:
4782-----------
4783
4784First, U-Boot must be compiled with the appropriate defines. See the section
4785titled "Linux Kernel Interface" above for a more in depth explanation. The
4786following is an example of how to start a kernel and pass an updated
4787flat device tree:
4788
4789=> print oftaddr
4790oftaddr=0x300000
4791=> print oft
4792oft=oftrees/mpc8540ads.dtb
4793=> tftp $oftaddr $oft
4794Speed: 1000, full duplex
4795Using TSEC0 device
4796TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4797Filename 'oftrees/mpc8540ads.dtb'.
4798Load address: 0x300000
4799Loading: #
4800done
4801Bytes transferred = 4106 (100a hex)
4802=> tftp $loadaddr $bootfile
4803Speed: 1000, full duplex
4804Using TSEC0 device
4805TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4806Filename 'uImage'.
4807Load address: 0x200000
4808Loading:############
4809done
4810Bytes transferred = 1029407 (fb51f hex)
4811=> print loadaddr
4812loadaddr=200000
4813=> print oftaddr
4814oftaddr=0x300000
4815=> bootm $loadaddr - $oftaddr
4816## Booting image at 00200000 ...
a9398e01
WD
4817 Image Name: Linux-2.6.17-dirty
4818 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4819 Data Size: 1029343 Bytes = 1005.2 kB
0267768e 4820 Load Address: 00000000
a9398e01 4821 Entry Point: 00000000
0267768e
MM
4822 Verifying Checksum ... OK
4823 Uncompressing Kernel Image ... OK
4824Booting using flat device tree at 0x300000
4825Using MPC85xx ADS machine description
4826Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4827[snip]
4828
4829
2729af9d
WD
4830More About U-Boot Image Types:
4831------------------------------
4832
4833U-Boot supports the following image types:
4834
4835 "Standalone Programs" are directly runnable in the environment
4836 provided by U-Boot; it is expected that (if they behave
4837 well) you can continue to work in U-Boot after return from
4838 the Standalone Program.
4839 "OS Kernel Images" are usually images of some Embedded OS which
4840 will take over control completely. Usually these programs
4841 will install their own set of exception handlers, device
4842 drivers, set up the MMU, etc. - this means, that you cannot
4843 expect to re-enter U-Boot except by resetting the CPU.
4844 "RAMDisk Images" are more or less just data blocks, and their
4845 parameters (address, size) are passed to an OS kernel that is
4846 being started.
4847 "Multi-File Images" contain several images, typically an OS
4848 (Linux) kernel image and one or more data images like
4849 RAMDisks. This construct is useful for instance when you want
4850 to boot over the network using BOOTP etc., where the boot
4851 server provides just a single image file, but you want to get
4852 for instance an OS kernel and a RAMDisk image.
4853
4854 "Multi-File Images" start with a list of image sizes, each
4855 image size (in bytes) specified by an "uint32_t" in network
4856 byte order. This list is terminated by an "(uint32_t)0".
4857 Immediately after the terminating 0 follow the images, one by
4858 one, all aligned on "uint32_t" boundaries (size rounded up to
4859 a multiple of 4 bytes).
4860
4861 "Firmware Images" are binary images containing firmware (like
4862 U-Boot or FPGA images) which usually will be programmed to
4863 flash memory.
4864
4865 "Script files" are command sequences that will be executed by
4866 U-Boot's command interpreter; this feature is especially
4867 useful when you configure U-Boot to use a real shell (hush)
4868 as command interpreter.
4869
44f074c7
MV
4870Booting the Linux zImage:
4871-------------------------
4872
4873On some platforms, it's possible to boot Linux zImage. This is done
4874using the "bootz" command. The syntax of "bootz" command is the same
4875as the syntax of "bootm" command.
4876
017e1f3f
MV
4877Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4878kernel with raw initrd images. The syntax is slightly different, the
4879address of the initrd must be augmented by it's size, in the following
4880format: "<initrd addres>:<initrd size>".
4881
2729af9d
WD
4882
4883Standalone HOWTO:
4884=================
4885
4886One of the features of U-Boot is that you can dynamically load and
4887run "standalone" applications, which can use some resources of
4888U-Boot like console I/O functions or interrupt services.
4889
4890Two simple examples are included with the sources:
4891
4892"Hello World" Demo:
4893-------------------
4894
4895'examples/hello_world.c' contains a small "Hello World" Demo
4896application; it is automatically compiled when you build U-Boot.
4897It's configured to run at address 0x00040004, so you can play with it
4898like that:
4899
4900 => loads
4901 ## Ready for S-Record download ...
4902 ~>examples/hello_world.srec
4903 1 2 3 4 5 6 7 8 9 10 11 ...
4904 [file transfer complete]
4905 [connected]
4906 ## Start Addr = 0x00040004
4907
4908 => go 40004 Hello World! This is a test.
4909 ## Starting application at 0x00040004 ...
4910 Hello World
4911 argc = 7
4912 argv[0] = "40004"
4913 argv[1] = "Hello"
4914 argv[2] = "World!"
4915 argv[3] = "This"
4916 argv[4] = "is"
4917 argv[5] = "a"
4918 argv[6] = "test."
4919 argv[7] = "<NULL>"
4920 Hit any key to exit ...
4921
4922 ## Application terminated, rc = 0x0
4923
4924Another example, which demonstrates how to register a CPM interrupt
4925handler with the U-Boot code, can be found in 'examples/timer.c'.
4926Here, a CPM timer is set up to generate an interrupt every second.
4927The interrupt service routine is trivial, just printing a '.'
4928character, but this is just a demo program. The application can be
4929controlled by the following keys:
4930
4931 ? - print current values og the CPM Timer registers
4932 b - enable interrupts and start timer
4933 e - stop timer and disable interrupts
4934 q - quit application
4935
4936 => loads
4937 ## Ready for S-Record download ...
4938 ~>examples/timer.srec
4939 1 2 3 4 5 6 7 8 9 10 11 ...
4940 [file transfer complete]
4941 [connected]
4942 ## Start Addr = 0x00040004
4943
4944 => go 40004
4945 ## Starting application at 0x00040004 ...
4946 TIMERS=0xfff00980
4947 Using timer 1
4948 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4949
4950Hit 'b':
4951 [q, b, e, ?] Set interval 1000000 us
4952 Enabling timer
4953Hit '?':
4954 [q, b, e, ?] ........
4955 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4956Hit '?':
4957 [q, b, e, ?] .
4958 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4959Hit '?':
4960 [q, b, e, ?] .
4961 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4962Hit '?':
4963 [q, b, e, ?] .
4964 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4965Hit 'e':
4966 [q, b, e, ?] ...Stopping timer
4967Hit 'q':
4968 [q, b, e, ?] ## Application terminated, rc = 0x0
4969
4970
4971Minicom warning:
4972================
4973
4974Over time, many people have reported problems when trying to use the
4975"minicom" terminal emulation program for serial download. I (wd)
4976consider minicom to be broken, and recommend not to use it. Under
4977Unix, I recommend to use C-Kermit for general purpose use (and
4978especially for kermit binary protocol download ("loadb" command), and
e53515a2
KP
4979use "cu" for S-Record download ("loads" command). See
4980http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4981for help with kermit.
4982
2729af9d
WD
4983
4984Nevertheless, if you absolutely want to use it try adding this
4985configuration to your "File transfer protocols" section:
4986
4987 Name Program Name U/D FullScr IO-Red. Multi
4988 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4989 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
4990
4991
4992NetBSD Notes:
4993=============
4994
4995Starting at version 0.9.2, U-Boot supports NetBSD both as host
4996(build U-Boot) and target system (boots NetBSD/mpc8xx).
4997
4998Building requires a cross environment; it is known to work on
4999NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5000need gmake since the Makefiles are not compatible with BSD make).
5001Note that the cross-powerpc package does not install include files;
5002attempting to build U-Boot will fail because <machine/ansi.h> is
5003missing. This file has to be installed and patched manually:
5004
5005 # cd /usr/pkg/cross/powerpc-netbsd/include
5006 # mkdir powerpc
5007 # ln -s powerpc machine
5008 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5009 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
5010
5011Native builds *don't* work due to incompatibilities between native
5012and U-Boot include files.
5013
5014Booting assumes that (the first part of) the image booted is a
5015stage-2 loader which in turn loads and then invokes the kernel
5016proper. Loader sources will eventually appear in the NetBSD source
5017tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af187 5018meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d
WD
5019
5020
5021Implementation Internals:
5022=========================
5023
5024The following is not intended to be a complete description of every
5025implementation detail. However, it should help to understand the
5026inner workings of U-Boot and make it easier to port it to custom
5027hardware.
5028
5029
5030Initial Stack, Global Data:
5031---------------------------
5032
5033The implementation of U-Boot is complicated by the fact that U-Boot
5034starts running out of ROM (flash memory), usually without access to
5035system RAM (because the memory controller is not initialized yet).
5036This means that we don't have writable Data or BSS segments, and BSS
5037is not initialized as zero. To be able to get a C environment working
5038at all, we have to allocate at least a minimal stack. Implementation
5039options for this are defined and restricted by the CPU used: Some CPU
5040models provide on-chip memory (like the IMMR area on MPC8xx and
5041MPC826x processors), on others (parts of) the data cache can be
5042locked as (mis-) used as memory, etc.
5043
218ca724 5044 Chris Hallinan posted a good summary of these issues to the
0668236b 5045 U-Boot mailing list:
2729af9d
WD
5046
5047 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5048 From: "Chris Hallinan" <clh@net1plus.com>
5049 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5050 ...
5051
5052 Correct me if I'm wrong, folks, but the way I understand it
5053 is this: Using DCACHE as initial RAM for Stack, etc, does not
5054 require any physical RAM backing up the cache. The cleverness
5055 is that the cache is being used as a temporary supply of
5056 necessary storage before the SDRAM controller is setup. It's
11ccc33f 5057 beyond the scope of this list to explain the details, but you
2729af9d
WD
5058 can see how this works by studying the cache architecture and
5059 operation in the architecture and processor-specific manuals.
5060
5061 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5062 is another option for the system designer to use as an
11ccc33f 5063 initial stack/RAM area prior to SDRAM being available. Either
2729af9d
WD
5064 option should work for you. Using CS 4 should be fine if your
5065 board designers haven't used it for something that would
5066 cause you grief during the initial boot! It is frequently not
5067 used.
5068
6d0f6bcf 5069 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d
WD
5070 with your processor/board/system design. The default value
5071 you will find in any recent u-boot distribution in
8a316c9b 5072 walnut.h should work for you. I'd set it to a value larger
2729af9d
WD
5073 than your SDRAM module. If you have a 64MB SDRAM module, set
5074 it above 400_0000. Just make sure your board has no resources
5075 that are supposed to respond to that address! That code in
5076 start.S has been around a while and should work as is when
5077 you get the config right.
5078
5079 -Chris Hallinan
5080 DS4.COM, Inc.
5081
5082It is essential to remember this, since it has some impact on the C
5083code for the initialization procedures:
5084
5085* Initialized global data (data segment) is read-only. Do not attempt
5086 to write it.
5087
11ccc33f 5088* Do not use any uninitialized global data (or implicitely initialized
2729af9d
WD
5089 as zero data - BSS segment) at all - this is undefined, initiali-
5090 zation is performed later (when relocating to RAM).
5091
5092* Stack space is very limited. Avoid big data buffers or things like
5093 that.
5094
5095Having only the stack as writable memory limits means we cannot use
5096normal global data to share information beween the code. But it
5097turned out that the implementation of U-Boot can be greatly
5098simplified by making a global data structure (gd_t) available to all
5099functions. We could pass a pointer to this data as argument to _all_
5100functions, but this would bloat the code. Instead we use a feature of
5101the GCC compiler (Global Register Variables) to share the data: we
5102place a pointer (gd) to the global data into a register which we
5103reserve for this purpose.
5104
5105When choosing a register for such a purpose we are restricted by the
5106relevant (E)ABI specifications for the current architecture, and by
5107GCC's implementation.
5108
5109For PowerPC, the following registers have specific use:
5110 R1: stack pointer
e7670f6c 5111 R2: reserved for system use
2729af9d
WD
5112 R3-R4: parameter passing and return values
5113 R5-R10: parameter passing
5114 R13: small data area pointer
5115 R30: GOT pointer
5116 R31: frame pointer
5117
e6bee808
JT
5118 (U-Boot also uses R12 as internal GOT pointer. r12
5119 is a volatile register so r12 needs to be reset when
5120 going back and forth between asm and C)
2729af9d 5121
e7670f6c 5122 ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d
WD
5123
5124 Note: on PPC, we could use a static initializer (since the
5125 address of the global data structure is known at compile time),
5126 but it turned out that reserving a register results in somewhat
5127 smaller code - although the code savings are not that big (on
5128 average for all boards 752 bytes for the whole U-Boot image,
5129 624 text + 127 data).
5130
c4db335c 5131On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4c58eb55
MF
5132 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5133
c4db335c 5134 ==> U-Boot will use P3 to hold a pointer to the global data
4c58eb55 5135
2729af9d
WD
5136On ARM, the following registers are used:
5137
5138 R0: function argument word/integer result
5139 R1-R3: function argument word
5140 R9: GOT pointer
5141 R10: stack limit (used only if stack checking if enabled)
5142 R11: argument (frame) pointer
5143 R12: temporary workspace
5144 R13: stack pointer
5145 R14: link register
5146 R15: program counter
5147
5148 ==> U-Boot will use R8 to hold a pointer to the global data
5149
0df01fd3
TC
5150On Nios II, the ABI is documented here:
5151 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5152
5153 ==> U-Boot will use gp to hold a pointer to the global data
5154
5155 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5156 to access small data sections, so gp is free.
5157
afc1ce82
ML
5158On NDS32, the following registers are used:
5159
5160 R0-R1: argument/return
5161 R2-R5: argument
5162 R15: temporary register for assembler
5163 R16: trampoline register
5164 R28: frame pointer (FP)
5165 R29: global pointer (GP)
5166 R30: link register (LP)
5167 R31: stack pointer (SP)
5168 PC: program counter (PC)
5169
5170 ==> U-Boot will use R10 to hold a pointer to the global data
5171
d87080b7
WD
5172NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5173or current versions of GCC may "optimize" the code too much.
2729af9d
WD
5174
5175Memory Management:
5176------------------
5177
5178U-Boot runs in system state and uses physical addresses, i.e. the
5179MMU is not used either for address mapping nor for memory protection.
5180
5181The available memory is mapped to fixed addresses using the memory
5182controller. In this process, a contiguous block is formed for each
5183memory type (Flash, SDRAM, SRAM), even when it consists of several
5184physical memory banks.
5185
5186U-Boot is installed in the first 128 kB of the first Flash bank (on
5187TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5188booting and sizing and initializing DRAM, the code relocates itself
5189to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf 5190memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d
WD
5191configuration setting]. Below that, a structure with global Board
5192Info data is placed, followed by the stack (growing downward).
5193
5194Additionally, some exception handler code is copied to the low 8 kB
5195of DRAM (0x00000000 ... 0x00001FFF).
5196
5197So a typical memory configuration with 16 MB of DRAM could look like
5198this:
5199
5200 0x0000 0000 Exception Vector code
5201 :
5202 0x0000 1FFF
5203 0x0000 2000 Free for Application Use
5204 :
5205 :
5206
5207 :
5208 :
5209 0x00FB FF20 Monitor Stack (Growing downward)
5210 0x00FB FFAC Board Info Data and permanent copy of global data
5211 0x00FC 0000 Malloc Arena
5212 :
5213 0x00FD FFFF
5214 0x00FE 0000 RAM Copy of Monitor Code
5215 ... eventually: LCD or video framebuffer
5216 ... eventually: pRAM (Protected RAM - unchanged by reset)
5217 0x00FF FFFF [End of RAM]
5218
5219
5220System Initialization:
5221----------------------
c609719b 5222
2729af9d 5223In the reset configuration, U-Boot starts at the reset entry point
11ccc33f 5224(on most PowerPC systems at address 0x00000100). Because of the reset
2729af9d
WD
5225configuration for CS0# this is a mirror of the onboard Flash memory.
5226To be able to re-map memory U-Boot then jumps to its link address.
5227To be able to implement the initialization code in C, a (small!)
5228initial stack is set up in the internal Dual Ported RAM (in case CPUs
5229which provide such a feature like MPC8xx or MPC8260), or in a locked
5230part of the data cache. After that, U-Boot initializes the CPU core,
5231the caches and the SIU.
5232
5233Next, all (potentially) available memory banks are mapped using a
5234preliminary mapping. For example, we put them on 512 MB boundaries
5235(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5236on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5237programmed for SDRAM access. Using the temporary configuration, a
5238simple memory test is run that determines the size of the SDRAM
5239banks.
5240
5241When there is more than one SDRAM bank, and the banks are of
5242different size, the largest is mapped first. For equal size, the first
5243bank (CS2#) is mapped first. The first mapping is always for address
52440x00000000, with any additional banks following immediately to create
5245contiguous memory starting from 0.
5246
5247Then, the monitor installs itself at the upper end of the SDRAM area
5248and allocates memory for use by malloc() and for the global Board
5249Info data; also, the exception vector code is copied to the low RAM
5250pages, and the final stack is set up.
5251
5252Only after this relocation will you have a "normal" C environment;
5253until that you are restricted in several ways, mostly because you are
5254running from ROM, and because the code will have to be relocated to a
5255new address in RAM.
5256
5257
5258U-Boot Porting Guide:
5259----------------------
c609719b 5260
2729af9d
WD
5261[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5262list, October 2002]
c609719b
WD
5263
5264
6c3fef28 5265int main(int argc, char *argv[])
2729af9d
WD
5266{
5267 sighandler_t no_more_time;
c609719b 5268
6c3fef28
JVB
5269 signal(SIGALRM, no_more_time);
5270 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b 5271
2729af9d 5272 if (available_money > available_manpower) {
6c3fef28 5273 Pay consultant to port U-Boot;
c609719b
WD
5274 return 0;
5275 }
5276
2729af9d
WD
5277 Download latest U-Boot source;
5278
0668236b 5279 Subscribe to u-boot mailing list;
2729af9d 5280
6c3fef28
JVB
5281 if (clueless)
5282 email("Hi, I am new to U-Boot, how do I get started?");
2729af9d
WD
5283
5284 while (learning) {
5285 Read the README file in the top level directory;
6c3fef28
JVB
5286 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5287 Read applicable doc/*.README;
2729af9d 5288 Read the source, Luke;
6c3fef28 5289 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d
WD
5290 }
5291
6c3fef28
JVB
5292 if (available_money > toLocalCurrency ($2500))
5293 Buy a BDI3000;
5294 else
2729af9d 5295 Add a lot of aggravation and time;
2729af9d 5296
6c3fef28
JVB
5297 if (a similar board exists) { /* hopefully... */
5298 cp -a board/<similar> board/<myboard>
5299 cp include/configs/<similar>.h include/configs/<myboard>.h
5300 } else {
5301 Create your own board support subdirectory;
5302 Create your own board include/configs/<myboard>.h file;
5303 }
5304 Edit new board/<myboard> files
5305 Edit new include/configs/<myboard>.h
5306
5307 while (!accepted) {
5308 while (!running) {
5309 do {
5310 Add / modify source code;
5311 } until (compiles);
5312 Debug;
5313 if (clueless)
5314 email("Hi, I am having problems...");
5315 }
5316 Send patch file to the U-Boot email list;
5317 if (reasonable critiques)
5318 Incorporate improvements from email list code review;
5319 else
5320 Defend code as written;
2729af9d 5321 }
2729af9d
WD
5322
5323 return 0;
5324}
5325
5326void no_more_time (int sig)
5327{
5328 hire_a_guru();
5329}
5330
c609719b 5331
2729af9d
WD
5332Coding Standards:
5333-----------------
c609719b 5334
2729af9d 5335All contributions to U-Boot should conform to the Linux kernel
2c051651 5336coding style; see the file "Documentation/CodingStyle" and the script
7ca9296e 5337"scripts/Lindent" in your Linux kernel source directory.
2c051651
DZ
5338
5339Source files originating from a different project (for example the
5340MTD subsystem) are generally exempt from these guidelines and are not
5341reformated to ease subsequent migration to newer versions of those
5342sources.
5343
5344Please note that U-Boot is implemented in C (and to some small parts in
5345Assembler); no C++ is used, so please do not use C++ style comments (//)
5346in your code.
c609719b 5347
2729af9d
WD
5348Please also stick to the following formatting rules:
5349- remove any trailing white space
7ca9296e 5350- use TAB characters for indentation and vertical alignment, not spaces
2729af9d 5351- make sure NOT to use DOS '\r\n' line feeds
7ca9296e 5352- do not add more than 2 consecutive empty lines to source files
2729af9d 5353- do not add trailing empty lines to source files
180d3f74 5354
2729af9d
WD
5355Submissions which do not conform to the standards may be returned
5356with a request to reformat the changes.
c609719b
WD
5357
5358
2729af9d
WD
5359Submitting Patches:
5360-------------------
c609719b 5361
2729af9d
WD
5362Since the number of patches for U-Boot is growing, we need to
5363establish some rules. Submissions which do not conform to these rules
5364may be rejected, even when they contain important and valuable stuff.
c609719b 5365
0d28f34b 5366Please see http://www.denx.de/wiki/U-Boot/Patches for details.
218ca724 5367
0668236b
WD
5368Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5369see http://lists.denx.de/mailman/listinfo/u-boot
5370
2729af9d
WD
5371When you send a patch, please include the following information with
5372it:
c609719b 5373
2729af9d
WD
5374* For bug fixes: a description of the bug and how your patch fixes
5375 this bug. Please try to include a way of demonstrating that the
5376 patch actually fixes something.
c609719b 5377
2729af9d
WD
5378* For new features: a description of the feature and your
5379 implementation.
c609719b 5380
2729af9d 5381* A CHANGELOG entry as plaintext (separate from the patch)
c609719b 5382
2729af9d 5383* For major contributions, your entry to the CREDITS file
c609719b 5384
2729af9d 5385* When you add support for a new board, don't forget to add this
7ca9296e 5386 board to the MAINTAINERS file, too.
c609719b 5387
2729af9d
WD
5388* If your patch adds new configuration options, don't forget to
5389 document these in the README file.
c609719b 5390
218ca724
WD
5391* The patch itself. If you are using git (which is *strongly*
5392 recommended) you can easily generate the patch using the
7ca9296e 5393 "git format-patch". If you then use "git send-email" to send it to
218ca724
WD
5394 the U-Boot mailing list, you will avoid most of the common problems
5395 with some other mail clients.
5396
5397 If you cannot use git, use "diff -purN OLD NEW". If your version of
5398 diff does not support these options, then get the latest version of
5399 GNU diff.
c609719b 5400
218ca724
WD
5401 The current directory when running this command shall be the parent
5402 directory of the U-Boot source tree (i. e. please make sure that
5403 your patch includes sufficient directory information for the
5404 affected files).
6dff5529 5405
218ca724
WD
5406 We prefer patches as plain text. MIME attachments are discouraged,
5407 and compressed attachments must not be used.
c609719b 5408
2729af9d
WD
5409* If one logical set of modifications affects or creates several
5410 files, all these changes shall be submitted in a SINGLE patch file.
52f52c14 5411
2729af9d
WD
5412* Changesets that contain different, unrelated modifications shall be
5413 submitted as SEPARATE patches, one patch per changeset.
8bde7f77 5414
52f52c14 5415
2729af9d 5416Notes:
c609719b 5417
2729af9d
WD
5418* Before sending the patch, run the MAKEALL script on your patched
5419 source tree and make sure that no errors or warnings are reported
5420 for any of the boards.
c609719b 5421
2729af9d
WD
5422* Keep your modifications to the necessary minimum: A patch
5423 containing several unrelated changes or arbitrary reformats will be
5424 returned with a request to re-formatting / split it.
c609719b 5425
2729af9d
WD
5426* If you modify existing code, make sure that your new code does not
5427 add to the memory footprint of the code ;-) Small is beautiful!
5428 When adding new features, these should compile conditionally only
5429 (using #ifdef), and the resulting code with the new feature
5430 disabled must not need more memory than the old code without your
5431 modification.
90dc6704 5432
0668236b
WD
5433* Remember that there is a size limit of 100 kB per message on the
5434 u-boot mailing list. Bigger patches will be moderated. If they are
5435 reasonable and not too big, they will be acknowledged. But patches
5436 bigger than the size limit should be avoided.