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