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