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