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