blob: 58e582d022175c43a7249c26438fd70904db8028 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00002# (C) Copyright 2000 - 2011
wdenkc6097192002-11-03 00:24:07 +00003# 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
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded 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.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support 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
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<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
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where 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
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- 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
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
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
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting 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.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200138 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
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/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
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /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
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /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
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /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
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /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.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software 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
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
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
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.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
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many 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
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
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
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- 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
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 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
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 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
Kumar Gala8f290842011-05-20 00:39:21 -0500372 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
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100377- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200378 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100379
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
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200384 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200385
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100386 Defines the Monahans turbo mode to oscillator
387 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200388 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100389 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200390
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200391- 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
wdenk5da627a2003-10-09 20:09:04 +0000423- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000424 CONFIG_CLOCKS_IN_MHZ
425
426 U-Boot stores all clock information in Hz
427 internally. For binary compatibility with older Linux
428 kernels (which expect the clocks passed in the
429 bd_info data to be in MHz) the environment variable
430 "clocks_in_mhz" can be defined so that U-Boot
431 converts clock data to MHZ before passing it to the
432 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000433 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100434 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000435 default environment.
436
wdenk5da627a2003-10-09 20:09:04 +0000437 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
438
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200439 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000440 expect it to be in bytes, others in MB.
441 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
442
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400443 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200444
445 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400446 passed using flattened device trees (based on open firmware
447 concepts).
448
449 CONFIG_OF_LIBFDT
450 * New libfdt-based support
451 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500452 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400453
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200454 OF_CPU - The proper name of the cpus node (only required for
455 MPC512X and MPC5xxx based boards).
456 OF_SOC - The proper name of the soc node (only required for
457 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200458 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600459 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200460
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200461 boards with QUICC Engines require OF_QE to set UCC MAC
462 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500463
Kumar Gala4e253132006-01-11 13:54:17 -0600464 CONFIG_OF_BOARD_SETUP
465
466 Board code has addition modification that it wants to make
467 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000468
Matthew McClintock02677682006-06-28 10:41:37 -0500469 CONFIG_OF_BOOT_CPU
470
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200471 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500472 param header, the default value is zero if undefined.
473
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200474 CONFIG_OF_IDE_FIXUP
475
476 U-Boot can detect if an IDE device is present or not.
477 If not, and this new config option is activated, U-Boot
478 removes the ATA node from the DTS before booting Linux,
479 so the Linux IDE driver does not probe the device and
480 crash. This is needed for buggy hardware (uc101) where
481 no pull down resistor is connected to the signal IDE5V_DD7.
482
Igor Grinberg7eb29392011-07-14 05:45:07 +0000483 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
484
485 This setting is mandatory for all boards that have only one
486 machine type and must be used to specify the machine type
487 number as it appears in the ARM machine registry
488 (see http://www.arm.linux.org.uk/developer/machines/).
489 Only boards that have multiple machine types supported
490 in a single configuration file and the machine type is
491 runtime discoverable, do not have to use this setting.
492
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100493- vxWorks boot parameters:
494
495 bootvx constructs a valid bootline using the following
496 environments variables: bootfile, ipaddr, serverip, hostname.
497 It loads the vxWorks image pointed bootfile.
498
499 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
500 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
501 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
502 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
503
504 CONFIG_SYS_VXWORKS_ADD_PARAMS
505
506 Add it at the end of the bootline. E.g "u=username pw=secret"
507
508 Note: If a "bootargs" environment is defined, it will overwride
509 the defaults discussed just above.
510
Aneesh V2c451f72011-06-16 23:30:47 +0000511- Cache Configuration:
512 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
513 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
514 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
515
Aneesh V93bc2192011-06-16 23:30:51 +0000516- Cache Configuration for ARM:
517 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
518 controller
519 CONFIG_SYS_PL310_BASE - Physical base address of PL310
520 controller register space
521
wdenk6705d812004-08-02 23:22:59 +0000522- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200523 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000524
525 Define this if you want support for Amba PrimeCell PL010 UARTs.
526
Andreas Engel48d01922008-09-08 14:30:53 +0200527 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000528
529 Define this if you want support for Amba PrimeCell PL011 UARTs.
530
531 CONFIG_PL011_CLOCK
532
533 If you have Amba PrimeCell PL011 UARTs, set this variable to
534 the clock speed of the UARTs.
535
536 CONFIG_PL01x_PORTS
537
538 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
539 define this to a list of base addresses for each (supported)
540 port. See e.g. include/configs/versatile.h
541
John Rigby910f1ae2011-04-19 10:42:39 +0000542 CONFIG_PL011_SERIAL_RLCR
543
544 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
545 have separate receive and transmit line control registers. Set
546 this variable to initialize the extra register.
547
548 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
549
550 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
551 boot loader that has already initialized the UART. Define this
552 variable to flush the UART at init time.
553
wdenk6705d812004-08-02 23:22:59 +0000554
wdenkc6097192002-11-03 00:24:07 +0000555- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000556 Depending on board, define exactly one serial port
557 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
558 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
559 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000560
561 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
562 port routines must be defined elsewhere
563 (i.e. serial_init(), serial_getc(), ...)
564
565 CONFIG_CFB_CONSOLE
566 Enables console device for a color framebuffer. Needs following
567 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
568 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
569 (default big endian)
570 VIDEO_HW_RECTFILL graphic chip supports
571 rectangle fill
572 (cf. smiLynxEM)
573 VIDEO_HW_BITBLT graphic chip supports
574 bit-blit (cf. smiLynxEM)
575 VIDEO_VISIBLE_COLS visible pixel columns
576 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000577 VIDEO_VISIBLE_ROWS visible pixel rows
578 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000579 VIDEO_DATA_FORMAT graphic data format
580 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000581 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000582 VIDEO_KBD_INIT_FCT keyboard int fct
583 (i.e. i8042_kbd_init())
584 VIDEO_TSTC_FCT test char fct
585 (i.e. i8042_tstc)
586 VIDEO_GETC_FCT get char fct
587 (i.e. i8042_getc)
588 CONFIG_CONSOLE_CURSOR cursor drawing on/off
589 (requires blink timer
590 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200591 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000592 CONFIG_CONSOLE_TIME display time/date info in
593 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500594 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000595 CONFIG_VIDEO_LOGO display Linux logo in
596 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000597 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
598 linux_logo.h for logo.
599 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000600 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200601 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000602 the logo
603
wdenk43d96162003-03-06 00:02:04 +0000604 When CONFIG_CFB_CONSOLE is defined, video console is
605 default i/o. Serial console can be forced with
606 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000607
wdenkd4ca31c2004-01-02 14:00:00 +0000608 When CONFIG_SILENT_CONSOLE is defined, all console
609 messages (by U-Boot and Linux!) can be silenced with
610 the "silent" environment variable. See
611 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000612
wdenkc6097192002-11-03 00:24:07 +0000613- Console Baudrate:
614 CONFIG_BAUDRATE - in bps
615 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200616 CONFIG_SYS_BAUDRATE_TABLE, see below.
617 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000618
Heiko Schocherc92fac92009-01-30 12:55:38 +0100619- Console Rx buffer length
620 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
621 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100622 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100623 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
624 must be defined, to setup the maximum idle timeout for
625 the SMC.
626
Graeme Russ9558b482011-09-01 00:48:27 +0000627- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200628 Prior to the console being initialised (i.e. serial UART
629 initialised etc) all console output is silently discarded.
630 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
631 buffer any console messages prior to the console being
632 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
633 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
634 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200635 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200636 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000637
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200638 'Sane' compilers will generate smaller code if
639 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000640
wdenkc6097192002-11-03 00:24:07 +0000641- Boot Delay: CONFIG_BOOTDELAY - in seconds
642 Delay before automatically booting the default image;
643 set to -1 to disable autoboot.
644
645 See doc/README.autoboot for these options that
646 work with CONFIG_BOOTDELAY. None are required.
647 CONFIG_BOOT_RETRY_TIME
648 CONFIG_BOOT_RETRY_MIN
649 CONFIG_AUTOBOOT_KEYED
650 CONFIG_AUTOBOOT_PROMPT
651 CONFIG_AUTOBOOT_DELAY_STR
652 CONFIG_AUTOBOOT_STOP_STR
653 CONFIG_AUTOBOOT_DELAY_STR2
654 CONFIG_AUTOBOOT_STOP_STR2
655 CONFIG_ZERO_BOOTDELAY_CHECK
656 CONFIG_RESET_TO_RETRY
657
658- Autoboot Command:
659 CONFIG_BOOTCOMMAND
660 Only needed when CONFIG_BOOTDELAY is enabled;
661 define a command string that is automatically executed
662 when no character is read on the console interface
663 within "Boot Delay" after reset.
664
665 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000666 This can be used to pass arguments to the bootm
667 command. The value of CONFIG_BOOTARGS goes into the
668 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000669
670 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000671 The value of these goes into the environment as
672 "ramboot" and "nfsboot" respectively, and can be used
673 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200674 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000675
676- Pre-Boot Commands:
677 CONFIG_PREBOOT
678
679 When this option is #defined, the existence of the
680 environment variable "preboot" will be checked
681 immediately before starting the CONFIG_BOOTDELAY
682 countdown and/or running the auto-boot command resp.
683 entering interactive mode.
684
685 This feature is especially useful when "preboot" is
686 automatically generated or modified. For an example
687 see the LWMON board specific code: here "preboot" is
688 modified when the user holds down a certain
689 combination of keys on the (special) keyboard when
690 booting the systems
691
692- Serial Download Echo Mode:
693 CONFIG_LOADS_ECHO
694 If defined to 1, all characters received during a
695 serial download (using the "loads" command) are
696 echoed back. This might be needed by some terminal
697 emulations (like "cu"), but may as well just take
698 time on others. This setting #define's the initial
699 value of the "loads_echo" environment variable.
700
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000702 CONFIG_KGDB_BAUDRATE
703 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200704 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000705
706- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500707 Monitor commands can be included or excluded
708 from the build by using the #include files
709 "config_cmd_all.h" and #undef'ing unwanted
710 commands, or using "config_cmd_default.h"
711 and augmenting with additional #define's
712 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000713
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500714 The default command configuration includes all commands
715 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000716
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500717 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500718 CONFIG_CMD_BDI bdinfo
719 CONFIG_CMD_BEDBUG * Include BedBug Debugger
720 CONFIG_CMD_BMP * BMP support
721 CONFIG_CMD_BSP * Board specific commands
722 CONFIG_CMD_BOOTD bootd
723 CONFIG_CMD_CACHE * icache, dcache
724 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500725 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500726 CONFIG_CMD_DATE * support for RTC, date/time...
727 CONFIG_CMD_DHCP * DHCP support
728 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600729 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
730 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
731 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
732 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500733 CONFIG_CMD_DTT * Digital Therm and Thermostat
734 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500735 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 CONFIG_CMD_EEPROM * EEPROM read/write support
737 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500738 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500739 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500740 CONFIG_CMD_FDC * Floppy Disk Support
741 CONFIG_CMD_FAT * FAT partition support
742 CONFIG_CMD_FDOS * Dos diskette Support
743 CONFIG_CMD_FLASH flinfo, erase, protect
744 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500745 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000746 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500747 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
748 CONFIG_CMD_I2C * I2C serial bus support
749 CONFIG_CMD_IDE * IDE harddisk support
750 CONFIG_CMD_IMI iminfo
751 CONFIG_CMD_IMLS List all found images
752 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500753 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 CONFIG_CMD_IRQ * irqinfo
755 CONFIG_CMD_ITEST Integer/string test of 2 values
756 CONFIG_CMD_JFFS2 * JFFS2 Support
757 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500758 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500759 CONFIG_CMD_LOADB loadb
760 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400761 CONFIG_CMD_MD5SUM print md5 message digest
762 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500763 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
764 loop, loopw, mtest
765 CONFIG_CMD_MISC Misc functions like sleep etc
766 CONFIG_CMD_MMC * MMC memory mapped support
767 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100768 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 CONFIG_CMD_NAND * NAND support
770 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600771 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000772 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 CONFIG_CMD_PCI * pciinfo
774 CONFIG_CMD_PCMCIA * PCMCIA support
775 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
776 host
777 CONFIG_CMD_PORTIO * Port I/O
778 CONFIG_CMD_REGINFO * Register dump
779 CONFIG_CMD_RUN run command in env variable
780 CONFIG_CMD_SAVES * save S record dump
781 CONFIG_CMD_SCSI * SCSI Support
782 CONFIG_CMD_SDRAM * print SDRAM configuration information
783 (requires CONFIG_CMD_I2C)
784 CONFIG_CMD_SETGETDCR Support for DCR Register access
785 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100786 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400787 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200788 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500789 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000790 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000791 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000792 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500793 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500794 CONFIG_CMD_CDP * Cisco Discover Protocol support
795 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000796
wdenkc6097192002-11-03 00:24:07 +0000797
798 EXAMPLE: If you want all functions except of network
799 support you can write:
800
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 #include "config_cmd_all.h"
802 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000803
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400804 Other Commands:
805 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000806
807 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500808 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000809 what you (and your U-Boot users) are doing. Data
810 cache cannot be enabled on systems like the 8xx or
811 8260 (where accesses to the IMMR region must be
812 uncached), and it cannot be disabled on all other
813 systems where we (mis-) use the data cache to hold an
814 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000815
816
817 XXX - this list needs to get updated!
818
Simon Glass45ba8072011-10-15 05:48:20 +0000819- Device tree:
820 CONFIG_OF_CONTROL
821 If this variable is defined, U-Boot will use a device tree
822 to configure its devices, instead of relying on statically
823 compiled #defines in the board file. This option is
824 experimental and only available on a few boards. The device
825 tree is available in the global data as gd->fdt_blob.
826
Simon Glass2c0f79e2011-10-24 19:15:31 +0000827 U-Boot needs to get its device tree from somewhere. This can
828 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000829
830 CONFIG_OF_EMBED
831 If this variable is defined, U-Boot will embed a device tree
832 binary in its image. This device tree file should be in the
833 board directory and called <soc>-<board>.dts. The binary file
834 is then picked up in board_init_f() and made available through
835 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000836
Simon Glass2c0f79e2011-10-24 19:15:31 +0000837 CONFIG_OF_SEPARATE
838 If this variable is defined, U-Boot will build a device tree
839 binary. It will be called u-boot.dtb. Architecture-specific
840 code will locate it at run-time. Generally this works by:
841
842 cat u-boot.bin u-boot.dtb >image.bin
843
844 and in fact, U-Boot does this for you, creating a file called
845 u-boot-dtb.bin which is useful in the common case. You can
846 still use the individual files if you need something more
847 exotic.
848
wdenkc6097192002-11-03 00:24:07 +0000849- Watchdog:
850 CONFIG_WATCHDOG
851 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000852 support for the SoC. There must be support in the SoC
853 specific code for a watchdog. For the 8xx and 8260
854 CPUs, the SIU Watchdog feature is enabled in the SYPCR
855 register. When supported for a specific SoC is
856 available, then no further board specific code should
857 be needed to use it.
858
859 CONFIG_HW_WATCHDOG
860 When using a watchdog circuitry external to the used
861 SoC, then define this variable and provide board
862 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000863
stroesec1551ea2003-04-04 15:53:41 +0000864- U-Boot Version:
865 CONFIG_VERSION_VARIABLE
866 If this variable is defined, an environment variable
867 named "ver" is created by U-Boot showing the U-Boot
868 version as printed by the "version" command.
869 This variable is readonly.
870
wdenkc6097192002-11-03 00:24:07 +0000871- Real-Time Clock:
872
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500873 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000874 has to be selected, too. Define exactly one of the
875 following options:
876
877 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
878 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200879 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000880 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000881 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000882 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000883 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000884 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100885 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000886 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200887 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200888 CONFIG_SYS_RV3029_TCR - enable trickle charger on
889 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000890
wdenkb37c7e52003-06-30 16:24:52 +0000891 Note that if the RTC uses I2C, then the I2C interface
892 must also be configured. See I2C Support, below.
893
Peter Tysere92739d2008-12-17 16:36:21 -0600894- GPIO Support:
895 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
896 CONFIG_PCA953X_INFO - enable pca953x info command
897
Chris Packham5dec49c2010-12-19 10:12:13 +0000898 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
899 chip-ngpio pairs that tell the PCA953X driver the number of
900 pins supported by a particular chip.
901
Peter Tysere92739d2008-12-17 16:36:21 -0600902 Note that if the GPIO device uses I2C, then the I2C interface
903 must also be configured. See I2C Support, below.
904
wdenkc6097192002-11-03 00:24:07 +0000905- Timestamp Support:
906
wdenk43d96162003-03-06 00:02:04 +0000907 When CONFIG_TIMESTAMP is selected, the timestamp
908 (date and time) of an image is printed by image
909 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500910 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000911
912- Partition Support:
913 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400914 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000915
Wolfgang Denk218ca722008-03-26 10:40:12 +0100916 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
917 CONFIG_CMD_SCSI) you must configure support for at
918 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000919
920- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000921 CONFIG_IDE_RESET_ROUTINE - this is defined in several
922 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000923
wdenk4d13cba2004-03-14 14:09:05 +0000924 CONFIG_IDE_RESET - is this is defined, IDE Reset will
925 be performed by calling the function
926 ide_set_reset(int reset)
927 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000928
929- ATAPI Support:
930 CONFIG_ATAPI
931
932 Set this to enable ATAPI support.
933
wdenkc40b2952004-03-13 23:29:43 +0000934- LBA48 Support
935 CONFIG_LBA48
936
937 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100938 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000939 Whithout these , LBA48 support uses 32bit variables and will 'only'
940 support disks up to 2.1TB.
941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200942 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000943 When enabled, makes the IDE subsystem use 64bit sector addresses.
944 Default is 32bit.
945
wdenkc6097192002-11-03 00:24:07 +0000946- SCSI Support:
947 At the moment only there is only support for the
948 SYM53C8XX SCSI controller; define
949 CONFIG_SCSI_SYM53C8XX to enable it.
950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200951 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
952 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
953 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000954 maximum numbers of LUNs, SCSI ID's and target
955 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200956 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000957
958- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000959 CONFIG_E1000
960 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000961
Andre Schwarzac3315c2008-03-06 16:45:44 +0100962 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200963 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100964
wdenkc6097192002-11-03 00:24:07 +0000965 CONFIG_EEPRO100
966 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200967 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000968 write routine for first time initialisation.
969
970 CONFIG_TULIP
971 Support for Digital 2114x chips.
972 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
973 modem chip initialisation (KS8761/QS6611).
974
975 CONFIG_NATSEMI
976 Support for National dp83815 chips.
977
978 CONFIG_NS8382X
979 Support for National dp8382[01] gigabit chips.
980
wdenk45219c42003-05-12 21:50:16 +0000981- NETWORK Support (other):
982
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100983 CONFIG_DRIVER_AT91EMAC
984 Support for AT91RM9200 EMAC.
985
986 CONFIG_RMII
987 Define this to use reduced MII inteface
988
989 CONFIG_DRIVER_AT91EMAC_QUIET
990 If this defined, the driver is quiet.
991 The driver doen't show link status messages.
992
wdenk45219c42003-05-12 21:50:16 +0000993 CONFIG_DRIVER_LAN91C96
994 Support for SMSC's LAN91C96 chips.
995
996 CONFIG_LAN91C96_BASE
997 Define this to hold the physical address
998 of the LAN91C96's I/O space
999
1000 CONFIG_LAN91C96_USE_32_BIT
1001 Define this to enable 32 bit addressing
1002
wdenkf39748a2004-06-09 13:37:52 +00001003 CONFIG_DRIVER_SMC91111
1004 Support for SMSC's LAN91C111 chip
1005
1006 CONFIG_SMC91111_BASE
1007 Define this to hold the physical address
1008 of the device (I/O space)
1009
1010 CONFIG_SMC_USE_32_BIT
1011 Define this if data bus is 32 bits
1012
1013 CONFIG_SMC_USE_IOFUNCS
1014 Define this to use i/o functions instead of macros
1015 (some hardware wont work with macros)
1016
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001017 CONFIG_FTGMAC100
1018 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1019
1020 CONFIG_FTGMAC100_EGIGA
1021 Define this to use GE link update with gigabit PHY.
1022 Define this if FTGMAC100 is connected to gigabit PHY.
1023 If your system has 10/100 PHY only, it might not occur
1024 wrong behavior. Because PHY usually return timeout or
1025 useless data when polling gigabit status and gigabit
1026 control registers. This behavior won't affect the
1027 correctnessof 10/100 link speed update.
1028
Mike Rapoportc2fff332009-11-11 10:03:03 +02001029 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001030 Support for SMSC's LAN911x and LAN921x chips
1031
Mike Rapoportc2fff332009-11-11 10:03:03 +02001032 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001033 Define this to hold the physical address
1034 of the device (I/O space)
1035
Mike Rapoportc2fff332009-11-11 10:03:03 +02001036 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001037 Define this if data bus is 32 bits
1038
Mike Rapoportc2fff332009-11-11 10:03:03 +02001039 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001040 Define this if data bus is 16 bits. If your processor
1041 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001042 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001043
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001044 CONFIG_SH_ETHER
1045 Support for Renesas on-chip Ethernet controller
1046
1047 CONFIG_SH_ETHER_USE_PORT
1048 Define the number of ports to be used
1049
1050 CONFIG_SH_ETHER_PHY_ADDR
1051 Define the ETH PHY's address
1052
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001053 CONFIG_SH_ETHER_CACHE_WRITEBACK
1054 If this option is set, the driver enables cache flush.
1055
wdenkc6097192002-11-03 00:24:07 +00001056- USB Support:
1057 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001058 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001059 CONFIG_USB_UHCI to enable it.
1060 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001061 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001062 storage devices.
1063 Note:
1064 Supported are USB Keyboards and USB Floppy drives
1065 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001066 MPC5200 USB requires additional defines:
1067 CONFIG_USB_CLOCK
1068 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001069 CONFIG_PSC3_USB
1070 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001071 CONFIG_USB_CONFIG
1072 for differential drivers: 0x00001000
1073 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001074 for differential drivers on PSC3: 0x00000100
1075 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001076 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001077 May be defined to allow interrupt polling
1078 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001079
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001080- USB Device:
1081 Define the below if you wish to use the USB console.
1082 Once firmware is rebuilt from a serial console issue the
1083 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001084 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001085 it has found a new device. The environment variable usbtty
1086 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001087 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001088 Common Device Class Abstract Control Model serial device.
1089 If you select usbtty = gserial you should be able to enumerate
1090 a Linux host by
1091 # modprobe usbserial vendor=0xVendorID product=0xProductID
1092 else if using cdc_acm, simply setting the environment
1093 variable usbtty to be cdc_acm should suffice. The following
1094 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001095
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001096 CONFIG_USB_DEVICE
1097 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001098
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001099 CONFIG_USB_TTY
1100 Define this to have a tty type of device available to
1101 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001103 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001104 Define this if you want stdin, stdout &/or stderr to
1105 be set to usbtty.
1106
1107 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001108 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001109 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001110 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001112 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001113 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001114 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001115
Wolfgang Denk386eda02006-06-14 18:14:56 +02001116 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001117 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001118 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001119 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1120 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1121 should pretend to be a Linux device to it's target host.
1122
1123 CONFIG_USBD_MANUFACTURER
1124 Define this string as the name of your company for
1125 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001126
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001127 CONFIG_USBD_PRODUCT_NAME
1128 Define this string as the name of your product
1129 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1130
1131 CONFIG_USBD_VENDORID
1132 Define this as your assigned Vendor ID from the USB
1133 Implementors Forum. This *must* be a genuine Vendor ID
1134 to avoid polluting the USB namespace.
1135 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001136
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001137 CONFIG_USBD_PRODUCTID
1138 Define this as the unique Product ID
1139 for your device
1140 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001141
1142
1143- MMC Support:
1144 The MMC controller on the Intel PXA is supported. To
1145 enable this define CONFIG_MMC. The MMC can be
1146 accessed from the boot prompt by mapping the device
1147 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001148 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1149 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001150
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001151 CONFIG_SH_MMCIF
1152 Support for Renesas on-chip MMCIF controller
1153
1154 CONFIG_SH_MMCIF_ADDR
1155 Define the base address of MMCIF registers
1156
1157 CONFIG_SH_MMCIF_CLK
1158 Define the clock frequency for MMCIF
1159
wdenk6705d812004-08-02 23:22:59 +00001160- Journaling Flash filesystem support:
1161 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1162 CONFIG_JFFS2_NAND_DEV
1163 Define these for a default partition on a NAND device
1164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001165 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1166 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001167 Define these for a default partition on a NOR device
1168
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001169 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001170 Define this to create an own partition. You have to provide a
1171 function struct part_info* jffs2_part_info(int part_num)
1172
1173 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001174 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001175 to disable the command chpart. This is the default when you
1176 have not defined a custom partition
1177
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001178- FAT(File Allocation Table) filesystem write function support:
1179 CONFIG_FAT_WRITE
1180 Support for saving memory data as a file
1181 in FAT formatted partition
1182
wdenkc6097192002-11-03 00:24:07 +00001183- Keyboard Support:
1184 CONFIG_ISA_KEYBOARD
1185
1186 Define this to enable standard (PC-Style) keyboard
1187 support
1188
1189 CONFIG_I8042_KBD
1190 Standard PC keyboard driver with US (is default) and
1191 GERMAN key layout (switch via environment 'keymap=de') support.
1192 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1193 for cfb_console. Supports cursor blinking.
1194
1195- Video support:
1196 CONFIG_VIDEO
1197
1198 Define this to enable video support (for output to
1199 video).
1200
1201 CONFIG_VIDEO_CT69000
1202
1203 Enable Chips & Technologies 69000 Video chip
1204
1205 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001206 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001207 video output is selected via environment 'videoout'
1208 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1209 assumed.
wdenkc6097192002-11-03 00:24:07 +00001210
wdenkb79a11c2004-03-25 15:14:43 +00001211 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001212 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001213 are possible:
1214 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001215 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001216
1217 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1218 -------------+---------------------------------------------
1219 8 bits | 0x301* 0x303 0x305 0x161 0x307
1220 15 bits | 0x310 0x313 0x316 0x162 0x319
1221 16 bits | 0x311 0x314 0x317 0x163 0x31A
1222 24 bits | 0x312 0x315 0x318 ? 0x31B
1223 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001224 (i.e. setenv videomode 317; saveenv; reset;)
1225
wdenkb79a11c2004-03-25 15:14:43 +00001226 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001227 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001228
1229
stroesec1551ea2003-04-04 15:53:41 +00001230 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001231 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001232 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1233 or CONFIG_VIDEO_SED13806_16BPP
1234
Timur Tabi7d3053f2011-02-15 17:09:19 -06001235 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001236 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001237 SOCs that have a DIU should define this macro to enable DIU
1238 support, and should also define these other macros:
1239
1240 CONFIG_SYS_DIU_ADDR
1241 CONFIG_VIDEO
1242 CONFIG_CMD_BMP
1243 CONFIG_CFB_CONSOLE
1244 CONFIG_VIDEO_SW_CURSOR
1245 CONFIG_VGA_AS_SINGLE_DEVICE
1246 CONFIG_VIDEO_LOGO
1247 CONFIG_VIDEO_BMP_LOGO
1248
Timur Tabiba8e76b2011-04-11 14:18:22 -05001249 The DIU driver will look for the 'video-mode' environment
1250 variable, and if defined, enable the DIU as a console during
1251 boot. See the documentation file README.video for a
1252 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001253
wdenk682011f2003-06-03 23:54:09 +00001254- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001255 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001256
wdenk8bde7f72003-06-27 21:31:46 +00001257 Define this to enable a custom keyboard support.
1258 This simply calls drv_keyboard_init() which must be
1259 defined in your board-specific files.
1260 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001261
wdenkc6097192002-11-03 00:24:07 +00001262- LCD Support: CONFIG_LCD
1263
1264 Define this to enable LCD support (for output to LCD
1265 display); also select one of the supported displays
1266 by defining one of these:
1267
Stelian Pop39cf4802008-05-09 21:57:18 +02001268 CONFIG_ATMEL_LCD:
1269
1270 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1271
wdenkfd3103b2003-11-25 16:55:19 +00001272 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001273
wdenkfd3103b2003-11-25 16:55:19 +00001274 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001275
wdenkfd3103b2003-11-25 16:55:19 +00001276 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001277
wdenkfd3103b2003-11-25 16:55:19 +00001278 NEC NL6448BC20-08. 6.5", 640x480.
1279 Active, color, single scan.
1280
1281 CONFIG_NEC_NL6448BC33_54
1282
1283 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001284 Active, color, single scan.
1285
1286 CONFIG_SHARP_16x9
1287
1288 Sharp 320x240. Active, color, single scan.
1289 It isn't 16x9, and I am not sure what it is.
1290
1291 CONFIG_SHARP_LQ64D341
1292
1293 Sharp LQ64D341 display, 640x480.
1294 Active, color, single scan.
1295
1296 CONFIG_HLD1045
1297
1298 HLD1045 display, 640x480.
1299 Active, color, single scan.
1300
1301 CONFIG_OPTREX_BW
1302
1303 Optrex CBL50840-2 NF-FW 99 22 M5
1304 or
1305 Hitachi LMG6912RPFC-00T
1306 or
1307 Hitachi SP14Q002
1308
1309 320x240. Black & white.
1310
1311 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001312 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001313
wdenk7152b1d2003-09-05 23:19:14 +00001314- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001315
wdenk8bde7f72003-06-27 21:31:46 +00001316 If this option is set, the environment is checked for
1317 a variable "splashimage". If found, the usual display
1318 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001319 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001320 specified in "splashimage" is loaded instead. The
1321 console is redirected to the "nulldev", too. This
1322 allows for a "silent" boot where a splash screen is
1323 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001324
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001325 CONFIG_SPLASH_SCREEN_ALIGN
1326
1327 If this option is set the splash image can be freely positioned
1328 on the screen. Environment variable "splashpos" specifies the
1329 position as "x,y". If a positive number is given it is used as
1330 number of pixel from left/top. If a negative number is given it
1331 is used as number of pixel from right/bottom. You can also
1332 specify 'm' for centering the image.
1333
1334 Example:
1335 setenv splashpos m,m
1336 => image at center of screen
1337
1338 setenv splashpos 30,20
1339 => image at x = 30 and y = 20
1340
1341 setenv splashpos -10,m
1342 => vertically centered image
1343 at x = dspWidth - bmpWidth - 9
1344
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001345- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1346
1347 If this option is set, additionally to standard BMP
1348 images, gzipped BMP images can be displayed via the
1349 splashscreen support or the bmp command.
1350
Anatolij Gustschind5011762010-03-15 14:50:25 +01001351- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1352
1353 If this option is set, 8-bit RLE compressed BMP images
1354 can be displayed via the splashscreen support or the
1355 bmp command.
1356
wdenkc29fdfc2003-08-29 20:57:53 +00001357- Compression support:
1358 CONFIG_BZIP2
1359
1360 If this option is set, support for bzip2 compressed
1361 images is included. If not, only uncompressed and gzip
1362 compressed images are supported.
1363
wdenk42d1f032003-10-15 23:53:47 +00001364 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001365 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001366 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001367
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001368 CONFIG_LZMA
1369
1370 If this option is set, support for lzma compressed
1371 images is included.
1372
1373 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1374 requires an amount of dynamic memory that is given by the
1375 formula:
1376
1377 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1378
1379 Where lc and lp stand for, respectively, Literal context bits
1380 and Literal pos bits.
1381
1382 This value is upper-bounded by 14MB in the worst case. Anyway,
1383 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1384 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1385 a very small buffer.
1386
1387 Use the lzmainfo tool to determinate the lc and lp values and
1388 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001389 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001390
wdenk17ea1172004-06-06 21:51:03 +00001391- MII/PHY support:
1392 CONFIG_PHY_ADDR
1393
1394 The address of PHY on MII bus.
1395
1396 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1397
1398 The clock frequency of the MII bus
1399
1400 CONFIG_PHY_GIGE
1401
1402 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001403 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001404
1405 CONFIG_PHY_RESET_DELAY
1406
1407 Some PHY like Intel LXT971A need extra delay after
1408 reset before any MII register access is possible.
1409 For such PHY, set this option to the usec delay
1410 required. (minimum 300usec for LXT971A)
1411
1412 CONFIG_PHY_CMD_DELAY (ppc4xx)
1413
1414 Some PHY like Intel LXT971A need extra delay after
1415 command issued before MII status register can be read
1416
wdenkc6097192002-11-03 00:24:07 +00001417- Ethernet address:
1418 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001419 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001420 CONFIG_ETH2ADDR
1421 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001422 CONFIG_ETH4ADDR
1423 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001424
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001425 Define a default value for Ethernet address to use
1426 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001427 is not determined automatically.
1428
1429- IP address:
1430 CONFIG_IPADDR
1431
1432 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001433 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001434 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001435 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001436
1437- Server IP address:
1438 CONFIG_SERVERIP
1439
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001440 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001441 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001442 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001443
Robin Getz97cfe862009-07-21 12:15:28 -04001444 CONFIG_KEEP_SERVERADDR
1445
1446 Keeps the server's MAC address, in the env 'serveraddr'
1447 for passing to bootargs (like Linux's netconsole option)
1448
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001449- Gateway IP address:
1450 CONFIG_GATEWAYIP
1451
1452 Defines a default value for the IP address of the
1453 default router where packets to other networks are
1454 sent to.
1455 (Environment variable "gatewayip")
1456
1457- Subnet mask:
1458 CONFIG_NETMASK
1459
1460 Defines a default value for the subnet mask (or
1461 routing prefix) which is used to determine if an IP
1462 address belongs to the local subnet or needs to be
1463 forwarded through a router.
1464 (Environment variable "netmask")
1465
David Updegraff53a5c422007-06-11 10:41:07 -05001466- Multicast TFTP Mode:
1467 CONFIG_MCAST_TFTP
1468
1469 Defines whether you want to support multicast TFTP as per
1470 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001471 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001472 driver in use must provide a function: mcast() to join/leave a
1473 multicast group.
1474
wdenkc6097192002-11-03 00:24:07 +00001475- BOOTP Recovery Mode:
1476 CONFIG_BOOTP_RANDOM_DELAY
1477
1478 If you have many targets in a network that try to
1479 boot using BOOTP, you may want to avoid that all
1480 systems send out BOOTP requests at precisely the same
1481 moment (which would happen for instance at recovery
1482 from a power failure, when all systems will try to
1483 boot, thus flooding the BOOTP server. Defining
1484 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1485 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001486 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001487
1488 1st BOOTP request: delay 0 ... 1 sec
1489 2nd BOOTP request: delay 0 ... 2 sec
1490 3rd BOOTP request: delay 0 ... 4 sec
1491 4th and following
1492 BOOTP requests: delay 0 ... 8 sec
1493
stroesefe389a82003-08-28 14:17:32 +00001494- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001495 You can fine tune the DHCP functionality by defining
1496 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001497
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001498 CONFIG_BOOTP_SUBNETMASK
1499 CONFIG_BOOTP_GATEWAY
1500 CONFIG_BOOTP_HOSTNAME
1501 CONFIG_BOOTP_NISDOMAIN
1502 CONFIG_BOOTP_BOOTPATH
1503 CONFIG_BOOTP_BOOTFILESIZE
1504 CONFIG_BOOTP_DNS
1505 CONFIG_BOOTP_DNS2
1506 CONFIG_BOOTP_SEND_HOSTNAME
1507 CONFIG_BOOTP_NTPSERVER
1508 CONFIG_BOOTP_TIMEOFFSET
1509 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001510
Wilson Callan5d110f02007-07-28 10:56:13 -04001511 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1512 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001513
1514 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1515 serverip from a DHCP server, it is possible that more
1516 than one DNS serverip is offered to the client.
1517 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1518 serverip will be stored in the additional environment
1519 variable "dnsip2". The first DNS serverip is always
1520 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001521 is defined.
stroesefe389a82003-08-28 14:17:32 +00001522
1523 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1524 to do a dynamic update of a DNS server. To do this, they
1525 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001526 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001527 of the "hostname" environment variable is passed as
1528 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001529
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001530 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1531
1532 A 32bit value in microseconds for a delay between
1533 receiving a "DHCP Offer" and sending the "DHCP Request".
1534 This fixes a problem with certain DHCP servers that don't
1535 respond 100% of the time to a "DHCP request". E.g. On an
1536 AT91RM9200 processor running at 180MHz, this delay needed
1537 to be *at least* 15,000 usec before a Windows Server 2003
1538 DHCP server would reply 100% of the time. I recommend at
1539 least 50,000 usec to be safe. The alternative is to hope
1540 that one of the retries will be successful but note that
1541 the DHCP timeout and retry process takes a longer than
1542 this delay.
1543
wdenka3d991b2004-04-15 21:48:45 +00001544 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001545 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001546
1547 The device id used in CDP trigger frames.
1548
1549 CONFIG_CDP_DEVICE_ID_PREFIX
1550
1551 A two character string which is prefixed to the MAC address
1552 of the device.
1553
1554 CONFIG_CDP_PORT_ID
1555
1556 A printf format string which contains the ascii name of
1557 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001558 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001559
1560 CONFIG_CDP_CAPABILITIES
1561
1562 A 32bit integer which indicates the device capabilities;
1563 0x00000010 for a normal host which does not forwards.
1564
1565 CONFIG_CDP_VERSION
1566
1567 An ascii string containing the version of the software.
1568
1569 CONFIG_CDP_PLATFORM
1570
1571 An ascii string containing the name of the platform.
1572
1573 CONFIG_CDP_TRIGGER
1574
1575 A 32bit integer sent on the trigger.
1576
1577 CONFIG_CDP_POWER_CONSUMPTION
1578
1579 A 16bit integer containing the power consumption of the
1580 device in .1 of milliwatts.
1581
1582 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1583
1584 A byte containing the id of the VLAN.
1585
wdenkc6097192002-11-03 00:24:07 +00001586- Status LED: CONFIG_STATUS_LED
1587
1588 Several configurations allow to display the current
1589 status using a LED. For instance, the LED will blink
1590 fast while running U-Boot code, stop blinking as
1591 soon as a reply to a BOOTP request was received, and
1592 start blinking slow once the Linux kernel is running
1593 (supported by a status LED driver in the Linux
1594 kernel). Defining CONFIG_STATUS_LED enables this
1595 feature in U-Boot.
1596
1597- CAN Support: CONFIG_CAN_DRIVER
1598
1599 Defining CONFIG_CAN_DRIVER enables CAN driver support
1600 on those systems that support this (optional)
1601 feature, like the TQM8xxL modules.
1602
1603- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1604
wdenkb37c7e52003-06-30 16:24:52 +00001605 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001606 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001607 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001608
wdenk945af8d2003-07-16 21:53:01 +00001609 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001610 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001611 CONFIG_COMMANDS) and communicate with i2c based realtime
1612 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001613 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001614
Ben Warrenbb99ad62006-09-07 16:50:54 -04001615 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001616
wdenk945af8d2003-07-16 21:53:01 +00001617 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001618 bit-banging) driver instead of CPM or similar hardware
1619 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001620
wdenk945af8d2003-07-16 21:53:01 +00001621 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001622 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001624 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001625 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001626 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001627 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001628
Peter Tyser8d321b82010-04-12 22:28:21 -05001629 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001630 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001631 and so its address should therefore be cleared to 0 (See,
1632 eg, MPC823e User's Manual p.16-473). So, set
1633 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001634
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001635 CONFIG_SYS_I2C_INIT_MPC5XXX
1636
1637 When a board is reset during an i2c bus transfer
1638 chips might think that the current transfer is still
1639 in progress. Reset the slave devices by sending start
1640 commands until the slave device responds.
1641
wdenk945af8d2003-07-16 21:53:01 +00001642 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001643
1644 If you use the software i2c interface (CONFIG_SOFT_I2C)
1645 then the following macros need to be defined (examples are
1646 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001647
1648 I2C_INIT
1649
wdenkb37c7e52003-06-30 16:24:52 +00001650 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001651 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001652
wdenkba56f622004-02-06 23:19:44 +00001653 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001654
wdenkc6097192002-11-03 00:24:07 +00001655 I2C_PORT
1656
wdenk43d96162003-03-06 00:02:04 +00001657 (Only for MPC8260 CPU). The I/O port to use (the code
1658 assumes both bits are on the same port). Valid values
1659 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001660
1661 I2C_ACTIVE
1662
1663 The code necessary to make the I2C data line active
1664 (driven). If the data line is open collector, this
1665 define can be null.
1666
wdenkb37c7e52003-06-30 16:24:52 +00001667 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1668
wdenkc6097192002-11-03 00:24:07 +00001669 I2C_TRISTATE
1670
1671 The code necessary to make the I2C data line tri-stated
1672 (inactive). If the data line is open collector, this
1673 define can be null.
1674
wdenkb37c7e52003-06-30 16:24:52 +00001675 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1676
wdenkc6097192002-11-03 00:24:07 +00001677 I2C_READ
1678
1679 Code that returns TRUE if the I2C data line is high,
1680 FALSE if it is low.
1681
wdenkb37c7e52003-06-30 16:24:52 +00001682 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1683
wdenkc6097192002-11-03 00:24:07 +00001684 I2C_SDA(bit)
1685
1686 If <bit> is TRUE, sets the I2C data line high. If it
1687 is FALSE, it clears it (low).
1688
wdenkb37c7e52003-06-30 16:24:52 +00001689 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001690 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001691 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001692
wdenkc6097192002-11-03 00:24:07 +00001693 I2C_SCL(bit)
1694
1695 If <bit> is TRUE, sets the I2C clock line high. If it
1696 is FALSE, it clears it (low).
1697
wdenkb37c7e52003-06-30 16:24:52 +00001698 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001699 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001700 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001701
wdenkc6097192002-11-03 00:24:07 +00001702 I2C_DELAY
1703
1704 This delay is invoked four times per clock cycle so this
1705 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001706 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001707 like:
1708
wdenkb37c7e52003-06-30 16:24:52 +00001709 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001710
Mike Frysinger793b5722010-07-21 13:38:02 -04001711 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1712
1713 If your arch supports the generic GPIO framework (asm/gpio.h),
1714 then you may alternatively define the two GPIOs that are to be
1715 used as SCL / SDA. Any of the previous I2C_xxx macros will
1716 have GPIO-based defaults assigned to them as appropriate.
1717
1718 You should define these to the GPIO value as given directly to
1719 the generic GPIO functions.
1720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001721 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001722
wdenk8bde7f72003-06-27 21:31:46 +00001723 When a board is reset during an i2c bus transfer
1724 chips might think that the current transfer is still
1725 in progress. On some boards it is possible to access
1726 the i2c SCLK line directly, either by using the
1727 processor pin as a GPIO or by having a second pin
1728 connected to the bus. If this option is defined a
1729 custom i2c_init_board() routine in boards/xxx/board.c
1730 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001731
Richard Retanubun26a33502010-04-12 15:08:17 -04001732 CONFIG_SYS_I2C_BOARD_LATE_INIT
1733
1734 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1735 defined a custom i2c_board_late_init() routine in
1736 boards/xxx/board.c is run AFTER the operations in i2c_init()
1737 is completed. This callpoint can be used to unreset i2c bus
1738 using CPU i2c controller register accesses for CPUs whose i2c
1739 controller provide such a method. It is called at the end of
1740 i2c_init() to allow i2c_init operations to setup the i2c bus
1741 controller on the CPU (e.g. setting bus speed & slave address).
1742
wdenk17ea1172004-06-06 21:51:03 +00001743 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1744
1745 This option enables configuration of bi_iic_fast[] flags
1746 in u-boot bd_info structure based on u-boot environment
1747 variable "i2cfast". (see also i2cfast)
1748
Ben Warrenbb99ad62006-09-07 16:50:54 -04001749 CONFIG_I2C_MULTI_BUS
1750
1751 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001752 must have a controller. At any point in time, only one bus is
1753 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001754 Note that bus numbering is zero-based.
1755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001756 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001757
1758 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001759 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001760 is set, specify a list of bus-device pairs. Otherwise, specify
1761 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001762
1763 e.g.
1764 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001765 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001766
1767 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1768
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001769 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001770 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001771
1772 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001774 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06001775
1776 If defined, then this indicates the I2C bus number for DDR SPD.
1777 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1778
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001779 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001780
1781 If defined, then this indicates the I2C bus number for the RTC.
1782 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001784 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001785
1786 If defined, then this indicates the I2C bus number for the DTT.
1787 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001789 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001790
1791 If defined, specifies the I2C address of the DTT device.
1792 If not defined, then U-Boot uses predefined value for
1793 specified DTT device.
1794
Timur Tabibe5e61812006-11-03 19:15:00 -06001795 CONFIG_FSL_I2C
1796
1797 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001798 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e61812006-11-03 19:15:00 -06001799
Heiko Schocher67b23a32008-10-15 09:39:47 +02001800 CONFIG_I2C_MUX
1801
1802 Define this option if you have I2C devices reached over 1 .. n
1803 I2C Muxes like the pca9544a. This option addes a new I2C
1804 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1805 new I2C Bus to the existing I2C Busses. If you select the
1806 new Bus with "i2c dev", u-bbot sends first the commandos for
1807 the muxes to activate this new "bus".
1808
1809 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1810 feature!
1811
1812 Example:
1813 Adding a new I2C Bus reached over 2 pca9544a muxes
1814 The First mux with address 70 and channel 6
1815 The Second mux with address 71 and channel 4
1816
1817 => i2c bus pca9544a:70:6:pca9544a:71:4
1818
1819 Use the "i2c bus" command without parameter, to get a list
1820 of I2C Busses with muxes:
1821
1822 => i2c bus
1823 Busses reached over muxes:
1824 Bus ID: 2
1825 reached over Mux(es):
1826 pca9544a@70 ch: 4
1827 Bus ID: 3
1828 reached over Mux(es):
1829 pca9544a@70 ch: 6
1830 pca9544a@71 ch: 4
1831 =>
1832
1833 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001834 u-boot first sends the command to the mux@70 to enable
1835 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001836 the channel 4.
1837
1838 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001839 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001840 the 2 muxes.
1841
1842 This option is actually implemented for the bitbanging
1843 algorithm in common/soft_i2c.c and for the Hardware I2C
1844 Bus on the MPC8260. But it should be not so difficult
1845 to add this option to other architectures.
1846
Andrew Dyer2ac69852008-12-29 17:36:01 -06001847 CONFIG_SOFT_I2C_READ_REPEATED_START
1848
1849 defining this will force the i2c_read() function in
1850 the soft_i2c driver to perform an I2C repeated start
1851 between writing the address pointer and reading the
1852 data. If this define is omitted the default behaviour
1853 of doing a stop-start sequence will be used. Most I2C
1854 devices can use either method, but some require one or
1855 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06001856
wdenkc6097192002-11-03 00:24:07 +00001857- SPI Support: CONFIG_SPI
1858
1859 Enables SPI driver (so far only tested with
1860 SPI EEPROM, also an instance works with Crystal A/D and
1861 D/As on the SACSng board)
1862
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001863 CONFIG_SH_SPI
1864
1865 Enables the driver for SPI controller on SuperH. Currently
1866 only SH7757 is supported.
1867
wdenkc6097192002-11-03 00:24:07 +00001868 CONFIG_SPI_X
1869
1870 Enables extended (16-bit) SPI EEPROM addressing.
1871 (symmetrical to CONFIG_I2C_X)
1872
1873 CONFIG_SOFT_SPI
1874
wdenk43d96162003-03-06 00:02:04 +00001875 Enables a software (bit-bang) SPI driver rather than
1876 using hardware support. This is a general purpose
1877 driver that only requires three general I/O port pins
1878 (two outputs, one input) to function. If this is
1879 defined, the board configuration must define several
1880 SPI configuration items (port pins to use, etc). For
1881 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001882
Ben Warren04a9e112008-01-16 22:37:35 -05001883 CONFIG_HARD_SPI
1884
1885 Enables a hardware SPI driver for general-purpose reads
1886 and writes. As with CONFIG_SOFT_SPI, the board configuration
1887 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001888 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001889 example, see include/configs/mpc8349emds.h.
1890
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001891 CONFIG_MXC_SPI
1892
1893 Enables the driver for the SPI controllers on i.MX and MXC
1894 SoCs. Currently only i.MX31 is supported.
1895
Matthias Fuchs01335022007-12-27 17:12:34 +01001896- FPGA Support: CONFIG_FPGA
1897
1898 Enables FPGA subsystem.
1899
1900 CONFIG_FPGA_<vendor>
1901
1902 Enables support for specific chip vendors.
1903 (ALTERA, XILINX)
1904
1905 CONFIG_FPGA_<family>
1906
1907 Enables support for FPGA family.
1908 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1909
1910 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001911
wdenk43d96162003-03-06 00:02:04 +00001912 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001914 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001915
wdenk8bde7f72003-06-27 21:31:46 +00001916 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001918 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001919
wdenk43d96162003-03-06 00:02:04 +00001920 Enable checks on FPGA configuration interface busy
1921 status by the configuration function. This option
1922 will require a board or device specific function to
1923 be written.
wdenkc6097192002-11-03 00:24:07 +00001924
1925 CONFIG_FPGA_DELAY
1926
1927 If defined, a function that provides delays in the FPGA
1928 configuration driver.
1929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001930 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001931 Allow Control-C to interrupt FPGA configuration
1932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001933 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001934
wdenk43d96162003-03-06 00:02:04 +00001935 Check for configuration errors during FPGA bitfile
1936 loading. For example, abort during Virtex II
1937 configuration if the INIT_B line goes low (which
1938 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001940 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001941
wdenk43d96162003-03-06 00:02:04 +00001942 Maximum time to wait for the INIT_B line to deassert
1943 after PROB_B has been deasserted during a Virtex II
1944 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001945 ms.
wdenkc6097192002-11-03 00:24:07 +00001946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001947 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001948
wdenk43d96162003-03-06 00:02:04 +00001949 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001950 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001951
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001952 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001953
wdenk43d96162003-03-06 00:02:04 +00001954 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001955 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001956
1957- Configuration Management:
1958 CONFIG_IDENT_STRING
1959
wdenk43d96162003-03-06 00:02:04 +00001960 If defined, this string will be added to the U-Boot
1961 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001962
1963- Vendor Parameter Protection:
1964
wdenk43d96162003-03-06 00:02:04 +00001965 U-Boot considers the values of the environment
1966 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001967 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001968 are set once by the board vendor / manufacturer, and
1969 protects these variables from casual modification by
1970 the user. Once set, these variables are read-only,
1971 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001972 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001973
1974 If CONFIG_ENV_OVERWRITE is #defined in your config
1975 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001976 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001977 these parameters.
1978
1979 Alternatively, if you #define _both_ CONFIG_ETHADDR
1980 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001981 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001982 which can be changed exactly ONCE by the user. [The
1983 serial# is unaffected by this, i. e. it remains
1984 read-only.]
1985
1986- Protected RAM:
1987 CONFIG_PRAM
1988
1989 Define this variable to enable the reservation of
1990 "protected RAM", i. e. RAM which is not overwritten
1991 by U-Boot. Define CONFIG_PRAM to hold the number of
1992 kB you want to reserve for pRAM. You can overwrite
1993 this default value by defining an environment
1994 variable "pram" to the number of kB you want to
1995 reserve. Note that the board info structure will
1996 still show the full amount of RAM. If pRAM is
1997 reserved, a new environment variable "mem" will
1998 automatically be defined to hold the amount of
1999 remaining RAM in a form that can be passed as boot
2000 argument to Linux, for instance like that:
2001
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002002 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002003 saveenv
2004
2005 This way you can tell Linux not to use this memory,
2006 either, which results in a memory region that will
2007 not be affected by reboots.
2008
2009 *WARNING* If your board configuration uses automatic
2010 detection of the RAM size, you must make sure that
2011 this memory test is non-destructive. So far, the
2012 following board configurations are known to be
2013 "pRAM-clean":
2014
2015 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2016 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002017 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002018
2019- Error Recovery:
2020 CONFIG_PANIC_HANG
2021
2022 Define this variable to stop the system in case of a
2023 fatal error, so that you have to reset it manually.
2024 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002025 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002026 automatically as fast as possible, but it may be
2027 useful during development since you can try to debug
2028 the conditions that lead to the situation.
2029
2030 CONFIG_NET_RETRY_COUNT
2031
wdenk43d96162003-03-06 00:02:04 +00002032 This variable defines the number of retries for
2033 network operations like ARP, RARP, TFTP, or BOOTP
2034 before giving up the operation. If not defined, a
2035 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002036
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002037 CONFIG_ARP_TIMEOUT
2038
2039 Timeout waiting for an ARP reply in milliseconds.
2040
wdenkc6097192002-11-03 00:24:07 +00002041- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002042 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002043
2044 Enable auto completion of commands using TAB.
2045
Wolfgang Denka9398e02006-11-27 15:32:42 +01002046 Note that this feature has NOT been implemented yet
2047 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002048
2049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002050 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002051
2052 Define this variable to enable the "hush" shell (from
2053 Busybox) as command line interpreter, thus enabling
2054 powerful command line syntax like
2055 if...then...else...fi conditionals or `&&' and '||'
2056 constructs ("shell scripts").
2057
2058 If undefined, you get the old, much simpler behaviour
2059 with a somewhat smaller memory footprint.
2060
2061
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002062 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002063
2064 This defines the secondary prompt string, which is
2065 printed when the command interpreter needs more input
2066 to complete a command. Usually "> ".
2067
2068 Note:
2069
wdenk8bde7f72003-06-27 21:31:46 +00002070 In the current implementation, the local variables
2071 space and global environment variables space are
2072 separated. Local variables are those you define by
2073 simply typing `name=value'. To access a local
2074 variable later on, you have write `$name' or
2075 `${name}'; to execute the contents of a variable
2076 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002077
wdenk43d96162003-03-06 00:02:04 +00002078 Global environment variables are those you use
2079 setenv/printenv to work with. To run a command stored
2080 in such a variable, you need to use the run command,
2081 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002082
2083 To store commands and special characters in a
2084 variable, please use double quotation marks
2085 surrounding the whole text of the variable, instead
2086 of the backslashes before semicolons and special
2087 symbols.
2088
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002089- Commandline Editing and History:
2090 CONFIG_CMDLINE_EDITING
2091
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002092 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002093 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002094
wdenka8c7c702003-12-06 19:49:23 +00002095- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002096 CONFIG_EXTRA_ENV_SETTINGS
2097
wdenk43d96162003-03-06 00:02:04 +00002098 Define this to contain any number of null terminated
2099 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002100 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002101
wdenk43d96162003-03-06 00:02:04 +00002102 For example, place something like this in your
2103 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002104
2105 #define CONFIG_EXTRA_ENV_SETTINGS \
2106 "myvar1=value1\0" \
2107 "myvar2=value2\0"
2108
wdenk43d96162003-03-06 00:02:04 +00002109 Warning: This method is based on knowledge about the
2110 internal format how the environment is stored by the
2111 U-Boot code. This is NOT an official, exported
2112 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002113 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002114 You better know what you are doing here.
2115
wdenk43d96162003-03-06 00:02:04 +00002116 Note: overly (ab)use of the default environment is
2117 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002118 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002119 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002120
wdenka8c7c702003-12-06 19:49:23 +00002121- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002122 CONFIG_HAS_DATAFLASH
2123
wdenk8bde7f72003-06-27 21:31:46 +00002124 Defining this option enables DataFlash features and
2125 allows to read/write in Dataflash via the standard
2126 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002127
wdenk3f85ce22004-02-23 16:11:30 +00002128- SystemACE Support:
2129 CONFIG_SYSTEMACE
2130
2131 Adding this option adds support for Xilinx SystemACE
2132 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002133 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002134 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002135
2136 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002137 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002138
2139 When SystemACE support is added, the "ace" device type
2140 becomes available to the fat commands, i.e. fatls.
2141
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002142- TFTP Fixed UDP Port:
2143 CONFIG_TFTP_PORT
2144
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002145 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002146 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002147 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002148 number generator is used.
2149
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002150 Also, the environment variable tftpdstp is used to supply
2151 the TFTP UDP destination port value. If tftpdstp isn't
2152 defined, the normal port 69 is used.
2153
2154 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002155 blindly start the TFTP transfer using the pre-configured
2156 target IP address and UDP port. This has the effect of
2157 "punching through" the (Windows XP) firewall, allowing
2158 the remainder of the TFTP transfer to proceed normally.
2159 A better solution is to properly configure the firewall,
2160 but sometimes that is not allowed.
2161
wdenka8c7c702003-12-06 19:49:23 +00002162- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002163 CONFIG_SHOW_BOOT_PROGRESS
2164
wdenk43d96162003-03-06 00:02:04 +00002165 Defining this option allows to add some board-
2166 specific code (calling a user-provided function
2167 "show_boot_progress(int)") that enables you to show
2168 the system's boot progress on some display (for
2169 example, some LED's) on your board. At the moment,
2170 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002171
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002172Legacy uImage format:
2173
wdenkc6097192002-11-03 00:24:07 +00002174 Arg Where When
2175 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002176 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002177 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002178 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002179 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002180 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002181 4 common/cmd_bootm.c Image data has correct checksum
2182 -4 common/cmd_bootm.c Image is for unsupported architecture
2183 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002184 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002185 6 common/cmd_bootm.c Image Type check OK
2186 -6 common/cmd_bootm.c gunzip uncompression error
2187 -7 common/cmd_bootm.c Unimplemented compression type
2188 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002189 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002190 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002191
2192 9 common/image.c Start initial ramdisk verification
2193 -10 common/image.c Ramdisk header has bad magic number
2194 -11 common/image.c Ramdisk header has bad checksum
2195 10 common/image.c Ramdisk header is OK
2196 -12 common/image.c Ramdisk data has bad checksum
2197 11 common/image.c Ramdisk data has correct checksum
2198 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002199 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002200 13 common/image.c Start multifile image verification
2201 14 common/image.c No initial ramdisk, no multifile, continue.
2202
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002203 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002204
Stefan Roesea47a12b2010-04-15 16:07:28 +02002205 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002206 -31 post/post.c POST test failed, detected by post_output_backlog()
2207 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002208
Heiko Schocher566a4942007-06-22 19:11:54 +02002209 34 common/cmd_doc.c before loading a Image from a DOC device
2210 -35 common/cmd_doc.c Bad usage of "doc" command
2211 35 common/cmd_doc.c correct usage of "doc" command
2212 -36 common/cmd_doc.c No boot device
2213 36 common/cmd_doc.c correct boot device
2214 -37 common/cmd_doc.c Unknown Chip ID on boot device
2215 37 common/cmd_doc.c correct chip ID found, device available
2216 -38 common/cmd_doc.c Read Error on boot device
2217 38 common/cmd_doc.c reading Image header from DOC device OK
2218 -39 common/cmd_doc.c Image header has bad magic number
2219 39 common/cmd_doc.c Image header has correct magic number
2220 -40 common/cmd_doc.c Error reading Image from DOC device
2221 40 common/cmd_doc.c Image header has correct magic number
2222 41 common/cmd_ide.c before loading a Image from a IDE device
2223 -42 common/cmd_ide.c Bad usage of "ide" command
2224 42 common/cmd_ide.c correct usage of "ide" command
2225 -43 common/cmd_ide.c No boot device
2226 43 common/cmd_ide.c boot device found
2227 -44 common/cmd_ide.c Device not available
2228 44 common/cmd_ide.c Device available
2229 -45 common/cmd_ide.c wrong partition selected
2230 45 common/cmd_ide.c partition selected
2231 -46 common/cmd_ide.c Unknown partition table
2232 46 common/cmd_ide.c valid partition table found
2233 -47 common/cmd_ide.c Invalid partition type
2234 47 common/cmd_ide.c correct partition type
2235 -48 common/cmd_ide.c Error reading Image Header on boot device
2236 48 common/cmd_ide.c reading Image Header from IDE device OK
2237 -49 common/cmd_ide.c Image header has bad magic number
2238 49 common/cmd_ide.c Image header has correct magic number
2239 -50 common/cmd_ide.c Image header has bad checksum
2240 50 common/cmd_ide.c Image header has correct checksum
2241 -51 common/cmd_ide.c Error reading Image from IDE device
2242 51 common/cmd_ide.c reading Image from IDE device OK
2243 52 common/cmd_nand.c before loading a Image from a NAND device
2244 -53 common/cmd_nand.c Bad usage of "nand" command
2245 53 common/cmd_nand.c correct usage of "nand" command
2246 -54 common/cmd_nand.c No boot device
2247 54 common/cmd_nand.c boot device found
2248 -55 common/cmd_nand.c Unknown Chip ID on boot device
2249 55 common/cmd_nand.c correct chip ID found, device available
2250 -56 common/cmd_nand.c Error reading Image Header on boot device
2251 56 common/cmd_nand.c reading Image Header from NAND device OK
2252 -57 common/cmd_nand.c Image header has bad magic number
2253 57 common/cmd_nand.c Image header has correct magic number
2254 -58 common/cmd_nand.c Error reading Image from NAND device
2255 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002256
Heiko Schocher566a4942007-06-22 19:11:54 +02002257 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002258
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002259 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002260 -64 net/eth.c no Ethernet found.
2261 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002262
Heiko Schocher566a4942007-06-22 19:11:54 +02002263 -80 common/cmd_net.c usage wrong
2264 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002265 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002266 81 common/cmd_net.c NetLoop() back without error
2267 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2268 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002269 83 common/cmd_net.c running "source" command
2270 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002271 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002272
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002273FIT uImage format:
2274
2275 Arg Where When
2276 100 common/cmd_bootm.c Kernel FIT Image has correct format
2277 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2278 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2279 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2280 102 common/cmd_bootm.c Kernel unit name specified
2281 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002282 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002283 104 common/cmd_bootm.c Got kernel subimage node offset
2284 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2285 105 common/cmd_bootm.c Kernel subimage hash verification OK
2286 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2287 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002288 -106 common/cmd_bootm.c Kernel subimage has wrong type
2289 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002290 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2291 108 common/cmd_bootm.c Got kernel subimage data/size
2292 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2293 -109 common/cmd_bootm.c Can't get kernel subimage type
2294 -110 common/cmd_bootm.c Can't get kernel subimage comp
2295 -111 common/cmd_bootm.c Can't get kernel subimage os
2296 -112 common/cmd_bootm.c Can't get kernel subimage load address
2297 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2298
2299 120 common/image.c Start initial ramdisk verification
2300 -120 common/image.c Ramdisk FIT image has incorrect format
2301 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002302 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002303 -122 common/image.c Can't get configuration for ramdisk subimage
2304 123 common/image.c Ramdisk unit name specified
2305 -124 common/image.c Can't get ramdisk subimage node offset
2306 125 common/image.c Got ramdisk subimage node offset
2307 -125 common/image.c Ramdisk subimage hash verification failed
2308 126 common/image.c Ramdisk subimage hash verification OK
2309 -126 common/image.c Ramdisk subimage for unsupported architecture
2310 127 common/image.c Architecture check OK
2311 -127 common/image.c Can't get ramdisk subimage data/size
2312 128 common/image.c Got ramdisk subimage data/size
2313 129 common/image.c Can't get ramdisk load address
2314 -129 common/image.c Got ramdisk load address
2315
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002316 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002317 131 common/cmd_doc.c FIT image format OK
2318
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002319 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002320 141 common/cmd_ide.c FIT image format OK
2321
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002322 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002323 151 common/cmd_nand.c FIT image format OK
2324
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002325- Standalone program support:
2326 CONFIG_STANDALONE_LOAD_ADDR
2327
Wolfgang Denk6feff892011-10-09 21:06:34 +02002328 This option defines a board specific value for the
2329 address where standalone program gets loaded, thus
2330 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002331 settings.
2332
2333- Frame Buffer Address:
2334 CONFIG_FB_ADDR
2335
2336 Define CONFIG_FB_ADDR if you want to use specific
2337 address for frame buffer.
2338 Then system will reserve the frame buffer address to
2339 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002340 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002341
2342 Please see board_init_f function.
2343
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002344- Automatic software updates via TFTP server
2345 CONFIG_UPDATE_TFTP
2346 CONFIG_UPDATE_TFTP_CNT_MAX
2347 CONFIG_UPDATE_TFTP_MSEC_MAX
2348
2349 These options enable and control the auto-update feature;
2350 for a more detailed description refer to doc/README.update.
2351
2352- MTD Support (mtdparts command, UBI support)
2353 CONFIG_MTD_DEVICE
2354
2355 Adds the MTD device infrastructure from the Linux kernel.
2356 Needed for mtdparts command support.
2357
2358 CONFIG_MTD_PARTITIONS
2359
2360 Adds the MTD partitioning infrastructure from the Linux
2361 kernel. Needed for UBI support.
2362
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002363- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002364 CONFIG_SPL
2365 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002366
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002367 CONFIG_SPL_TEXT_BASE
2368 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002369
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002370 CONFIG_SPL_LDSCRIPT
2371 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002372
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002373 CONFIG_SPL_LIBCOMMON_SUPPORT
2374 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002375
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002376 CONFIG_SPL_LIBDISK_SUPPORT
2377 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002378
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002379 CONFIG_SPL_I2C_SUPPORT
2380 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002381
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002382 CONFIG_SPL_GPIO_SUPPORT
2383 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002384
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002385 CONFIG_SPL_MMC_SUPPORT
2386 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002387
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002388 CONFIG_SPL_SERIAL_SUPPORT
2389 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002390
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002391 CONFIG_SPL_SPI_FLASH_SUPPORT
2392 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002393
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002394 CONFIG_SPL_SPI_SUPPORT
2395 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002396
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002397 CONFIG_SPL_FAT_SUPPORT
2398 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002399
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002400 CONFIG_SPL_LIBGENERIC_SUPPORT
2401 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002402
wdenkc6097192002-11-03 00:24:07 +00002403Modem Support:
2404--------------
2405
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002406[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002407
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002408- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002409 CONFIG_MODEM_SUPPORT
2410
2411- RTS/CTS Flow control enable:
2412 CONFIG_HWFLOW
2413
2414- Modem debug support:
2415 CONFIG_MODEM_SUPPORT_DEBUG
2416
wdenk43d96162003-03-06 00:02:04 +00002417 Enables debugging stuff (char screen[1024], dbg())
2418 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002419
wdenka8c7c702003-12-06 19:49:23 +00002420- Interrupt support (PPC):
2421
wdenkd4ca31c2004-01-02 14:00:00 +00002422 There are common interrupt_init() and timer_interrupt()
2423 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002424 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002425 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002426 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002427 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002428 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002429 specific handling. If board has watchdog / status_led
2430 / other_activity_monitor it works automatically from
2431 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002432
wdenkc6097192002-11-03 00:24:07 +00002433- General:
2434
wdenk43d96162003-03-06 00:02:04 +00002435 In the target system modem support is enabled when a
2436 specific key (key combination) is pressed during
2437 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002438 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002439 board_init(). Currently key_pressed() is a dummy
2440 function, returning 1 and thus enabling modem
2441 initialization.
wdenkc6097192002-11-03 00:24:07 +00002442
wdenk43d96162003-03-06 00:02:04 +00002443 If there are no modem init strings in the
2444 environment, U-Boot proceed to autoboot; the
2445 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002446 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002447
2448 See also: doc/README.Modem
2449
Helmut Raiger9660e442011-10-20 04:19:47 +00002450Board initialization settings:
2451------------------------------
2452
2453During Initialization u-boot calls a number of board specific functions
2454to allow the preparation of board specific prerequisites, e.g. pin setup
2455before drivers are initialized. To enable these callbacks the
2456following configuration macros have to be defined. Currently this is
2457architecture specific, so please check arch/your_architecture/lib/board.c
2458typically in board_init_f() and board_init_r().
2459
2460- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2461- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2462- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2463- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002464
wdenkc6097192002-11-03 00:24:07 +00002465Configuration Settings:
2466-----------------------
2467
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002468- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002469 undefine this when you're short of memory.
2470
Peter Tyser2fb26042009-01-27 18:03:12 -06002471- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2472 width of the commands listed in the 'help' command output.
2473
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002474- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002475 prompt for user input.
2476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002477- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002479- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002482
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002483- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002484 the application (usually a Linux kernel) when it is
2485 booted
2486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002488 List of legal baudrate settings for this board.
2489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002491 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002493- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002494 If the board specific function
2495 extern int overwrite_console (void);
2496 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002497 serial port, else the settings in the environment are used.
2498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002499- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002500 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002502- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002503 Enable overwrite of previous console environment settings.
2504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002505- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002506 Begin and End addresses of the area used by the
2507 simple memory test.
2508
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002509- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002510 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002512- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002513 Scratch address used by the alternate memory test
2514 You only need to set this if address zero isn't writeable
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2517 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002518 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002519 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002520 fixing up gd->ram_size the Linux kernel should gets passed
2521 the now "corrected" memory size and won't touch it either.
2522 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002523 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002524 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002525 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002526
2527 This option can be used as a workaround for the 440EPx/GRx
2528 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2529 be touched.
2530
2531 WARNING: Please make sure that this value is a multiple of
2532 the Linux page size (normally 4k). If this is not the case,
2533 then the end address of the Linux memory will be located at a
2534 non page size aligned address and this could cause major
2535 problems.
2536
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002537- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002538 Default load address for network file downloads
2539
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002540- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002541 Enable temporary baudrate change while serial download
2542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002543- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002544 Physical start address of SDRAM. _Must_ be 0 here.
2545
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002546- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002547 Physical start address of Motherboard I/O (if using a
2548 Cogent motherboard)
2549
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002550- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002551 Physical start address of Flash memory.
2552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002554 Physical start address of boot monitor code (set by
2555 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002556 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002557 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002558
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002559- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002560 Size of memory reserved for monitor code, used to
2561 determine _at_compile_time_ (!) if the environment is
2562 embedded within the U-Boot image, or in a separate
2563 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002565- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002566 Size of DRAM reserved for malloc() use.
2567
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002568- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002569 Normally compressed uImages are limited to an
2570 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002571 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002572 to adjust this setting to your needs.
2573
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002574- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002575 Maximum size of memory mapped by the startup code of
2576 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002577 the Linux kernel (bd_info, boot arguments, FDT blob if
2578 used) must be put below this limit, unless "bootm_low"
2579 enviroment variable is defined and non-zero. In such case
2580 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002581 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002582 variable "bootm_mapsize" will override the value of
2583 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2584 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002585
John Rigbyfca43cc2010-10-13 13:57:35 -06002586- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2587 Enable initrd_high functionality. If defined then the
2588 initrd_high feature is enabled and the bootm ramdisk subcommand
2589 is enabled.
2590
2591- CONFIG_SYS_BOOT_GET_CMDLINE:
2592 Enables allocating and saving kernel cmdline in space between
2593 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2594
2595- CONFIG_SYS_BOOT_GET_KBD:
2596 Enables allocating and saving a kernel copy of the bd_info in
2597 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002599- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002600 Max number of Flash memory banks
2601
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002602- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002603 Max number of sectors on a Flash chip
2604
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002605- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002606 Timeout for Flash erase operations (in ms)
2607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002608- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002609 Timeout for Flash write operations (in ms)
2610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002611- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002612 Timeout for Flash set sector lock bit operation (in ms)
2613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002614- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002615 Timeout for Flash clear lock bits operation (in ms)
2616
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002617- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002618 If defined, hardware flash sectors protection is used
2619 instead of U-Boot software protection.
2620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002621- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002622
2623 Enable TFTP transfers directly to flash memory;
2624 without this option such a download has to be
2625 performed in two steps: (1) download to RAM, and (2)
2626 copy from RAM to flash.
2627
2628 The two-step approach is usually more reliable, since
2629 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002630 the flash, but in some situations (when system RAM is
2631 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002632 downloaded image) this option may be very useful.
2633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002634- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002635 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002636 common flash structure for storing flash geometry.
2637
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002638- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002639 This option also enables the building of the cfi_flash driver
2640 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002641
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002642- CONFIG_FLASH_CFI_MTD
2643 This option enables the building of the cfi_mtd driver
2644 in the drivers directory. The driver exports CFI flash
2645 to the MTD layer.
2646
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002647- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002648 Use buffered writes to flash.
2649
2650- CONFIG_FLASH_SPANSION_S29WS_N
2651 s29ws-n MirrorBit flash has non-standard addresses for buffered
2652 write commands.
2653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002655 If this option is defined, the common CFI flash doesn't
2656 print it's warning upon not recognized FLASH banks. This
2657 is useful, if some of the configured banks are only
2658 optionally available.
2659
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002660- CONFIG_FLASH_SHOW_PROGRESS
2661 If defined (must be an integer), print out countdown
2662 digits and dots. Recommended value: 45 (9..1) for 80
2663 column displays, 15 (3..1) for 40 column displays.
2664
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002665- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002666 Defines the number of Ethernet receive buffers. On some
2667 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002668 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2669 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002670 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002671 Defaults to 4 if not defined.
2672
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002673- CONFIG_ENV_MAX_ENTRIES
2674
Wolfgang Denk071bc922010-10-27 22:48:30 +02002675 Maximum number of entries in the hash table that is used
2676 internally to store the environment settings. The default
2677 setting is supposed to be generous and should work in most
2678 cases. This setting can be used to tune behaviour; see
2679 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002680
wdenkc6097192002-11-03 00:24:07 +00002681The following definitions that deal with the placement and management
2682of environment data (variable area); in general, we support the
2683following configurations:
2684
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002685- CONFIG_BUILD_ENVCRC:
2686
2687 Builds up envcrc with the target environment so that external utils
2688 may easily extract it and embed it in final U-Boot images.
2689
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002690- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002691
2692 Define this if the environment is in flash memory.
2693
2694 a) The environment occupies one whole flash sector, which is
2695 "embedded" in the text segment with the U-Boot code. This
2696 happens usually with "bottom boot sector" or "top boot
2697 sector" type flash chips, which have several smaller
2698 sectors at the start or the end. For instance, such a
2699 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2700 such a case you would place the environment in one of the
2701 4 kB sectors - with U-Boot code before and after it. With
2702 "top boot sector" type flash chips, you would put the
2703 environment in one of the last sectors, leaving a gap
2704 between U-Boot and the environment.
2705
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002706 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002707
2708 Offset of environment data (variable area) to the
2709 beginning of flash memory; for instance, with bottom boot
2710 type flash chips the second sector can be used: the offset
2711 for this sector is given here.
2712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002714
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002715 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002716
2717 This is just another way to specify the start address of
2718 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002719 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002720
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002721 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002722
2723 Size of the sector containing the environment.
2724
2725
2726 b) Sometimes flash chips have few, equal sized, BIG sectors.
2727 In such a case you don't want to spend a whole sector for
2728 the environment.
2729
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002730 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002731
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002732 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002733 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002734 of this flash sector for the environment. This saves
2735 memory for the RAM copy of the environment.
2736
2737 It may also save flash memory if you decide to use this
2738 when your environment is "embedded" within U-Boot code,
2739 since then the remainder of the flash sector could be used
2740 for U-Boot code. It should be pointed out that this is
2741 STRONGLY DISCOURAGED from a robustness point of view:
2742 updating the environment in flash makes it always
2743 necessary to erase the WHOLE sector. If something goes
2744 wrong before the contents has been restored from a copy in
2745 RAM, your target system will be dead.
2746
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002747 - CONFIG_ENV_ADDR_REDUND
2748 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002749
wdenk43d96162003-03-06 00:02:04 +00002750 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002751 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002752 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002753 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002754
2755BE CAREFUL! Any changes to the flash layout, and some changes to the
2756source code will make it necessary to adapt <board>/u-boot.lds*
2757accordingly!
2758
2759
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002760- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002761
2762 Define this if you have some non-volatile memory device
2763 (NVRAM, battery buffered SRAM) which you want to use for the
2764 environment.
2765
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002766 - CONFIG_ENV_ADDR:
2767 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002768
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002769 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002770 want to use for environment. It is assumed that this memory
2771 can just be read and written to, without any special
2772 provision.
2773
2774BE CAREFUL! The first access to the environment happens quite early
2775in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002776console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002777U-Boot will hang.
2778
2779Please note that even with NVRAM we still use a copy of the
2780environment in RAM: we could work on NVRAM directly, but we want to
2781keep settings there always unmodified except somebody uses "saveenv"
2782to save the current settings.
2783
2784
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002785- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002786
2787 Use this if you have an EEPROM or similar serial access
2788 device and a driver for it.
2789
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002790 - CONFIG_ENV_OFFSET:
2791 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002792
2793 These two #defines specify the offset and size of the
2794 environment area within the total memory of your EEPROM.
2795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002796 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002797 If defined, specified the chip address of the EEPROM device.
2798 The default address is zero.
2799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002800 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002801 If defined, the number of bits used to address bytes in a
2802 single page in the EEPROM device. A 64 byte page, for example
2803 would require six bits.
2804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002805 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002806 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002807 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002808
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002810 The length in bytes of the EEPROM memory array address. Note
2811 that this is NOT the chip address length!
2812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002814 EEPROM chips that implement "address overflow" are ones
2815 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2816 address and the extra bits end up in the "chip address" bit
2817 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2818 byte chips.
2819
2820 Note that we consider the length of the address field to
2821 still be one byte because the extra address bits are hidden
2822 in the chip address.
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002825 The size in bytes of the EEPROM device.
2826
Heiko Schocher548738b2010-01-07 08:55:40 +01002827 - CONFIG_ENV_EEPROM_IS_ON_I2C
2828 define this, if you have I2C and SPI activated, and your
2829 EEPROM, which holds the environment, is on the I2C bus.
2830
2831 - CONFIG_I2C_ENV_EEPROM_BUS
2832 if you have an Environment on an EEPROM reached over
2833 I2C muxes, you can define here, how to reach this
2834 EEPROM. For example:
2835
Wolfgang Denka9046b92010-06-13 17:48:15 +02002836 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002837
2838 EEPROM which holds the environment, is reached over
2839 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002840
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002841- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002842
wdenkd4ca31c2004-01-02 14:00:00 +00002843 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002844 want to use for the environment.
2845
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002846 - CONFIG_ENV_OFFSET:
2847 - CONFIG_ENV_ADDR:
2848 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002849
2850 These three #defines specify the offset and size of the
2851 environment area within the total memory of your DataFlash placed
2852 at the specified address.
2853
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002854- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002855
2856 Define this if you have a NAND device which you want to use
2857 for the environment.
2858
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002859 - CONFIG_ENV_OFFSET:
2860 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002861
2862 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002863 area within the first NAND device. CONFIG_ENV_OFFSET must be
2864 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002865
Scott Woodfdd813d2010-09-17 14:38:37 -05002866 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002867
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002868 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002869 size used to hold a redundant copy of the environment data, so
2870 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002871 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05002872 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002873
Scott Woodfdd813d2010-09-17 14:38:37 -05002874 - CONFIG_ENV_RANGE (optional):
2875
2876 Specifies the length of the region in which the environment
2877 can be written. This should be a multiple of the NAND device's
2878 block size. Specifying a range with more erase blocks than
2879 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2880 the range to be avoided.
2881
2882 - CONFIG_ENV_OFFSET_OOB (optional):
2883
2884 Enables support for dynamically retrieving the offset of the
2885 environment from block zero's out-of-band data. The
2886 "nand env.oob" command can be used to record this offset.
2887 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2888 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002889
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002890- CONFIG_NAND_ENV_DST
2891
2892 Defines address in RAM to which the nand_spl code should copy the
2893 environment. If redundant environment is used, it will be copied to
2894 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002896- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002897
2898 Defines offset to the initial SPI buffer area in DPRAM. The
2899 area is used at an early stage (ROM part) if the environment
2900 is configured to reside in the SPI EEPROM: We need a 520 byte
2901 scratch DPRAM area. It is used between the two initialization
2902 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2903 to be a good choice since it makes it far enough from the
2904 start of the data area as well as from the stack pointer.
2905
Bruce Adlere881cb52007-11-02 13:15:42 -07002906Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002907has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002908created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002909until then to read environment variables.
2910
wdenk85ec0bc2003-03-31 16:34:49 +00002911The environment is protected by a CRC32 checksum. Before the monitor
2912is relocated into RAM, as a result of a bad CRC you will be working
2913with the compiled-in default environment - *silently*!!! [This is
2914necessary, because the first environment variable we need is the
2915"baudrate" setting for the console - if we have a bad CRC, we don't
2916have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002917
2918Note: once the monitor has been relocated, then it will complain if
2919the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002920use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002923 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002925 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002926 also needs to be defined.
2927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002928- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002929 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002930
Ron Madridf5675aa2009-02-18 14:30:44 -08002931- CONFIG_NS16550_MIN_FUNCTIONS:
2932 Define this if you desire to only have use of the NS16550_init
2933 and NS16550_putc functions for the serial driver located at
2934 drivers/serial/ns16550.c. This option is useful for saving
2935 space for already greatly restricted images, including but not
2936 limited to NAND_SPL configurations.
2937
wdenkc6097192002-11-03 00:24:07 +00002938Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002939---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002940
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002941- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002942 Cache Line Size of the CPU.
2943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002944- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002945 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002946
wdenk42d1f032003-10-15 23:53:47 +00002947 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2948 and RPXsuper) to be able to adjust the position of
2949 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002950
Timur Tabie46fedf2011-08-04 18:03:41 -05002951- CONFIG_SYS_CCSRBAR_DEFAULT:
2952 Default (power-on reset) physical address of CCSR on Freescale
2953 PowerPC SOCs.
2954
2955- CONFIG_SYS_CCSRBAR:
2956 Virtual address of CCSR. On a 32-bit build, this is typically
2957 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2958
2959 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2960 for cross-platform code that uses that macro instead.
2961
2962- CONFIG_SYS_CCSRBAR_PHYS:
2963 Physical address of CCSR. CCSR can be relocated to a new
2964 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002965 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05002966 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2967 is typically relocated on 36-bit builds. It is recommended
2968 that this macro be defined via the _HIGH and _LOW macros:
2969
2970 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2971 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2972
2973- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002974 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2975 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002976 used in assembly code, so it must not contain typecasts or
2977 integer size suffixes (e.g. "ULL").
2978
2979- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2980 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2981 used in assembly code, so it must not contain typecasts or
2982 integer size suffixes (e.g. "ULL").
2983
2984- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2985 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2986 forced to a value that ensures that CCSR is not relocated.
2987
wdenk7f6c2cb2002-11-10 22:06:23 +00002988- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002989 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002990
2991 the default drive number (default value 0)
2992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002993 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002994
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002995 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002996 (default value 1)
2997
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002998 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002999
wdenk43d96162003-03-06 00:02:04 +00003000 defines the offset of register from address. It
3001 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003002 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003003
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003004 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3005 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003006 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003007
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003008 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003009 fdc_hw_init() is called at the beginning of the FDC
3010 setup. fdc_hw_init() must be provided by the board
3011 source code. It is used to make hardware dependant
3012 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003013
Macpaul Lin0abddf82011-04-11 20:45:32 +00003014- CONFIG_IDE_AHB:
3015 Most IDE controllers were designed to be connected with PCI
3016 interface. Only few of them were designed for AHB interface.
3017 When software is doing ATA command and data transfer to
3018 IDE devices through IDE-AHB controller, some additional
3019 registers accessing to these kind of IDE-AHB controller
3020 is requierd.
3021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003022- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003023 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003024 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003025
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003026- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003027
wdenk7152b1d2003-09-05 23:19:14 +00003028 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003029 initial data and stack; please note that this must be
3030 writable memory that is working WITHOUT special
3031 initialization, i. e. you CANNOT use normal RAM which
3032 will become available only after programming the
3033 memory controller and running certain initialization
3034 sequences.
3035
3036 U-Boot uses the following memory types:
3037 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3038 - MPC824X: data cache
3039 - PPC4xx: data cache
3040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003041- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003042
3043 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003044 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3045 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003046 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003047 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003048 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3049 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3050 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003051
3052 Note:
3053 On the MPC824X (or other systems that use the data
3054 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003055 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003056 point to an otherwise UNUSED address space between
3057 the top of RAM and the start of the PCI space.
3058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003059- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003061- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003063- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003064
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003065- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003066
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003067- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003069- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003071- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003072 SDRAM timing
3073
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003074- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003075 periodic timer for refresh
3076
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003077- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003079- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3080 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3081 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3082 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003083 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3084
3085- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003086 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3087 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003088 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003090- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3091 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003092 Machine Mode Register and Memory Periodic Timer
3093 Prescaler definitions (SDRAM timing)
3094
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003095- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003096 enable I2C microcode relocation patch (MPC8xx);
3097 define relocation offset in DPRAM [DSP2]
3098
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003099- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003100 enable SMC microcode relocation patch (MPC8xx);
3101 define relocation offset in DPRAM [SMC1]
3102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003103- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003104 enable SPI microcode relocation patch (MPC8xx);
3105 define relocation offset in DPRAM [SCC4]
3106
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003107- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003108 Use OSCM clock mode on MBX8xx board. Be careful,
3109 wrong setting might damage your board. Read
3110 doc/README.MBX before setting this variable!
3111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003113 Offset of the bootmode word in DPRAM used by post
3114 (Power On Self Tests). This definition overrides
3115 #define'd default value in commproc.h resp.
3116 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003118- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3119 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3120 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3121 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3122 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3123 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3124 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3125 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003126 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003127
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003128- CONFIG_PCI_DISABLE_PCIE:
3129 Disable PCI-Express on systems where it is supported but not
3130 required.
3131
Kumar Galaa09b9b62010-12-30 12:09:53 -06003132- CONFIG_SYS_SRIO:
3133 Chip has SRIO or not
3134
3135- CONFIG_SRIO1:
3136 Board has SRIO 1 port available
3137
3138- CONFIG_SRIO2:
3139 Board has SRIO 2 port available
3140
3141- CONFIG_SYS_SRIOn_MEM_VIRT:
3142 Virtual Address of SRIO port 'n' memory region
3143
3144- CONFIG_SYS_SRIOn_MEM_PHYS:
3145 Physical Address of SRIO port 'n' memory region
3146
3147- CONFIG_SYS_SRIOn_MEM_SIZE:
3148 Size of SRIO port 'n' memory region
3149
Alex Watermaneced4622011-05-19 15:08:36 -04003150- CONFIG_SYS_NDFC_16
3151 Defined to tell the NDFC that the NAND chip is using a
3152 16 bit bus.
3153
3154- CONFIG_SYS_NDFC_EBC0_CFG
3155 Sets the EBC0_CFG register for the NDFC. If not defined
3156 a default value will be used.
3157
Ben Warrenbb99ad62006-09-07 16:50:54 -04003158- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003159 Get DDR timing information from an I2C EEPROM. Common
3160 with pluggable memory modules such as SODIMMs
3161
Ben Warrenbb99ad62006-09-07 16:50:54 -04003162 SPD_EEPROM_ADDRESS
3163 I2C address of the SPD EEPROM
3164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003165- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003166 If SPD EEPROM is on an I2C bus other than the first
3167 one, specify here. Note that the value must resolve
3168 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003169
York Sun1b3e3c42011-06-07 09:42:16 +08003170- CONFIG_SYS_DDR_RAW_TIMING
3171 Get DDR timing information from other than SPD. Common with
3172 soldered DDR chips onboard without SPD. DDR raw timing
3173 parameters are extracted from datasheet and hard-coded into
3174 header files or board specific files.
3175
York Sun6f5e1dc2011-09-16 13:21:35 -07003176- CONFIG_FSL_DDR_INTERACTIVE
3177 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3178
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003179- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003180 Only for 83xx systems. If specified, then DDR should
3181 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003182
wdenkc26e4542004-04-18 10:13:26 +00003183- CONFIG_ETHER_ON_FEC[12]
3184 Define to enable FEC[12] on a 8xx series processor.
3185
3186- CONFIG_FEC[12]_PHY
3187 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003188 to the given FEC; i. e.
3189 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003190 means that the PHY with address 4 is connected to FEC1
3191
3192 When set to -1, means to probe for first available.
3193
3194- CONFIG_FEC[12]_PHY_NORXERR
3195 The PHY does not have a RXERR line (RMII only).
3196 (so program the FEC to ignore it).
3197
3198- CONFIG_RMII
3199 Enable RMII mode for all FECs.
3200 Note that this is a global option, we can't
3201 have one FEC in standard MII mode and another in RMII mode.
3202
wdenk5cf91d62004-04-23 20:32:05 +00003203- CONFIG_CRC32_VERIFY
3204 Add a verify option to the crc32 command.
3205 The syntax is:
3206
3207 => crc32 -v <address> <count> <crc32>
3208
3209 Where address/count indicate a memory area
3210 and crc32 is the correct crc32 which the
3211 area should have.
3212
wdenk56523f12004-07-11 17:40:54 +00003213- CONFIG_LOOPW
3214 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003215 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003216
stroese7b466642004-12-16 18:46:55 +00003217- CONFIG_MX_CYCLIC
3218 Add the "mdc" and "mwc" memory commands. These are cyclic
3219 "md/mw" commands.
3220 Examples:
3221
wdenkefe2a4d2004-12-16 21:44:03 +00003222 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003223 This command will print 4 bytes (10,11,12,13) each 500 ms.
3224
wdenkefe2a4d2004-12-16 21:44:03 +00003225 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003226 This command will write 12345678 to address 100 all 10 ms.
3227
wdenkefe2a4d2004-12-16 21:44:03 +00003228 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003229 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003230
wdenk8aa1a2d2005-04-04 12:44:11 +00003231- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003232 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003233 low level initializations (like setting up the memory
3234 controller) are omitted and/or U-Boot does not
3235 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003236
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003237 Normally this variable MUST NOT be defined. The only
3238 exception is when U-Boot is loaded (to RAM) by some
3239 other boot loader or by a debugger which performs
3240 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003241
Aneesh V401bb302011-07-13 05:11:07 +00003242- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003243 Modifies the behaviour of start.S when compiling a loader
3244 that is executed before the actual U-Boot. E.g. when
3245 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003246
Matthias Weisserd8834a12011-03-10 21:36:32 +00003247- CONFIG_USE_ARCH_MEMCPY
3248 CONFIG_USE_ARCH_MEMSET
3249 If these options are used a optimized version of memcpy/memset will
3250 be used if available. These functions may be faster under some
3251 conditions but may increase the binary size.
3252
wdenkc6097192002-11-03 00:24:07 +00003253Building the Software:
3254======================
3255
Wolfgang Denk218ca722008-03-26 10:40:12 +01003256Building U-Boot has been tested in several native build environments
3257and in many different cross environments. Of course we cannot support
3258all possibly existing versions of cross development tools in all
3259(potentially obsolete) versions. In case of tool chain problems we
3260recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3261which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003262
Wolfgang Denk218ca722008-03-26 10:40:12 +01003263If you are not using a native environment, it is assumed that you
3264have GNU cross compiling tools available in your path. In this case,
3265you must set the environment variable CROSS_COMPILE in your shell.
3266Note that no changes to the Makefile or any other source files are
3267necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003268
Wolfgang Denk218ca722008-03-26 10:40:12 +01003269 $ CROSS_COMPILE=ppc_4xx-
3270 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003271
Peter Tyser2f8d3962009-03-13 18:54:51 -05003272Note: If you wish to generate Windows versions of the utilities in
3273 the tools directory you can use the MinGW toolchain
3274 (http://www.mingw.org). Set your HOST tools to the MinGW
3275 toolchain and execute 'make tools'. For example:
3276
3277 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3278
3279 Binaries such as tools/mkimage.exe will be created which can
3280 be executed on computers running Windows.
3281
Wolfgang Denk218ca722008-03-26 10:40:12 +01003282U-Boot is intended to be simple to build. After installing the
3283sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003284is done by typing:
3285
3286 make NAME_config
3287
Wolfgang Denk218ca722008-03-26 10:40:12 +01003288where "NAME_config" is the name of one of the existing configu-
3289rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003290
wdenk2729af92004-05-03 20:45:30 +00003291Note: for some board special configuration names may exist; check if
3292 additional information is available from the board vendor; for
3293 instance, the TQM823L systems are available without (standard)
3294 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003295 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003296
wdenk2729af92004-05-03 20:45:30 +00003297 make TQM823L_config
3298 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003299
wdenk2729af92004-05-03 20:45:30 +00003300 make TQM823L_LCD_config
3301 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303 etc.
wdenkc6097192002-11-03 00:24:07 +00003304
wdenkc6097192002-11-03 00:24:07 +00003305
wdenk2729af92004-05-03 20:45:30 +00003306Finally, type "make all", and you should get some working U-Boot
3307images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk2729af92004-05-03 20:45:30 +00003309- "u-boot.bin" is a raw binary image
3310- "u-boot" is an image in ELF binary format
3311- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003312
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003313By default the build is performed locally and the objects are saved
3314in the source directory. One of the two methods can be used to change
3315this behavior and build U-Boot to some external directory:
3316
33171. Add O= to the make command line invocations:
3318
3319 make O=/tmp/build distclean
3320 make O=/tmp/build NAME_config
3321 make O=/tmp/build all
3322
33232. Set environment variable BUILD_DIR to point to the desired location:
3324
3325 export BUILD_DIR=/tmp/build
3326 make distclean
3327 make NAME_config
3328 make all
3329
3330Note that the command line "O=" setting overrides the BUILD_DIR environment
3331variable.
3332
wdenkc6097192002-11-03 00:24:07 +00003333
wdenk2729af92004-05-03 20:45:30 +00003334Please be aware that the Makefiles assume you are using GNU make, so
3335for instance on NetBSD you might need to use "gmake" instead of
3336native "make".
wdenkc6097192002-11-03 00:24:07 +00003337
wdenkc6097192002-11-03 00:24:07 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339If the system board that you have is not listed, then you will need
3340to port U-Boot to your hardware platform. To do this, follow these
3341steps:
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk2729af92004-05-03 20:45:30 +000033431. Add a new configuration option for your board to the toplevel
3344 "Makefile" and to the "MAKEALL" script, using the existing
3345 entries as examples. Note that here and at many other places
3346 boards and other names are listed in alphabetical sort order. Please
3347 keep this order.
33482. Create a new directory to hold your board specific code. Add any
3349 files you need. In your board directory, you will need at least
3350 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
33513. Create a new configuration file "include/configs/<board>.h" for
3352 your board
33533. If you're porting U-Boot to a new CPU, then also create a new
3354 directory to hold your CPU specific code. Add any files you need.
33554. Run "make <board>_config" with your new name.
33565. Type "make", and you should get a working "u-boot.srec" file
3357 to be installed on your target system.
33586. Debug and solve any problems that might arise.
3359 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003360
wdenkc6097192002-11-03 00:24:07 +00003361
wdenk2729af92004-05-03 20:45:30 +00003362Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3363==============================================================
wdenkc6097192002-11-03 00:24:07 +00003364
Wolfgang Denk218ca722008-03-26 10:40:12 +01003365If you have modified U-Boot sources (for instance added a new board
3366or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003367provide feedback to the other developers. The feedback normally takes
3368the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003369official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003370
Wolfgang Denk218ca722008-03-26 10:40:12 +01003371But before you submit such a patch, please verify that your modifi-
3372cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003373the supported boards compile WITHOUT ANY compiler warnings. To do so,
3374just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003375for ALL supported system. Be warned, this will take a while. You can
3376select which (cross) compiler to use by passing a `CROSS_COMPILE'
3377environment variable to the script, i. e. to use the ELDK cross tools
3378you can type
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003381
wdenk2729af92004-05-03 20:45:30 +00003382or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003383
wdenk2729af92004-05-03 20:45:30 +00003384 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003385
Wolfgang Denk218ca722008-03-26 10:40:12 +01003386When using the MAKEALL script, the default behaviour is to build
3387U-Boot in the source directory. This location can be changed by
3388setting the BUILD_DIR environment variable. Also, for each target
3389built, the MAKEALL script saves two log files (<target>.ERR and
3390<target>.MAKEALL) in the <source dir>/LOG directory. This default
3391location can be changed by setting the MAKEALL_LOGDIR environment
3392variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003393
3394 export BUILD_DIR=/tmp/build
3395 export MAKEALL_LOGDIR=/tmp/log
3396 CROSS_COMPILE=ppc_8xx- MAKEALL
3397
Wolfgang Denk218ca722008-03-26 10:40:12 +01003398With the above settings build objects are saved in the /tmp/build,
3399log files are saved in the /tmp/log and the source tree remains clean
3400during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003401
3402
wdenk2729af92004-05-03 20:45:30 +00003403See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003404
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406Monitor Commands - Overview:
3407============================
wdenkc6097192002-11-03 00:24:07 +00003408
wdenk2729af92004-05-03 20:45:30 +00003409go - start application at address 'addr'
3410run - run commands in an environment variable
3411bootm - boot application image from memory
3412bootp - boot image via network using BootP/TFTP protocol
3413tftpboot- boot image via network using TFTP protocol
3414 and env variables "ipaddr" and "serverip"
3415 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003416tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003417rarpboot- boot image via network using RARP/TFTP protocol
3418diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3419loads - load S-Record file over serial line
3420loadb - load binary file over serial line (kermit mode)
3421md - memory display
3422mm - memory modify (auto-incrementing)
3423nm - memory modify (constant address)
3424mw - memory write (fill)
3425cp - memory copy
3426cmp - memory compare
3427crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003428i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003429sspi - SPI utility commands
3430base - print or set address offset
3431printenv- print environment variables
3432setenv - set environment variables
3433saveenv - save environment variables to persistent storage
3434protect - enable or disable FLASH write protection
3435erase - erase FLASH memory
3436flinfo - print FLASH memory information
3437bdinfo - print Board Info structure
3438iminfo - print header information for application image
3439coninfo - print console devices and informations
3440ide - IDE sub-system
3441loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003442loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003443mtest - simple RAM test
3444icache - enable or disable instruction cache
3445dcache - enable or disable data cache
3446reset - Perform RESET of the CPU
3447echo - echo args to console
3448version - print monitor version
3449help - print online help
3450? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003451
wdenkc6097192002-11-03 00:24:07 +00003452
wdenk2729af92004-05-03 20:45:30 +00003453Monitor Commands - Detailed Description:
3454========================================
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk2729af92004-05-03 20:45:30 +00003456TODO.
wdenkc6097192002-11-03 00:24:07 +00003457
wdenk2729af92004-05-03 20:45:30 +00003458For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003459
3460
wdenk2729af92004-05-03 20:45:30 +00003461Environment Variables:
3462======================
wdenkc6097192002-11-03 00:24:07 +00003463
wdenk2729af92004-05-03 20:45:30 +00003464U-Boot supports user configuration using Environment Variables which
3465can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003466
wdenk2729af92004-05-03 20:45:30 +00003467Environment Variables are set using "setenv", printed using
3468"printenv", and saved to Flash using "saveenv". Using "setenv"
3469without a value can be used to delete a variable from the
3470environment. As long as you don't save the environment you are
3471working with an in-memory copy. In case the Flash area containing the
3472environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003473
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003474Some configuration options can be set using Environment Variables.
3475
3476List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003477
wdenk2729af92004-05-03 20:45:30 +00003478 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003485
wdenk2729af92004-05-03 20:45:30 +00003486 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003487
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003488 bootm_low - Memory range available for image processing in the bootm
3489 command can be restricted. This variable is given as
3490 a hexadecimal number and defines lowest address allowed
3491 for use by the bootm command. See also "bootm_size"
3492 environment variable. Address defined by "bootm_low" is
3493 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003494 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3495 bootm_mapsize.
3496
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003497 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003498 This variable is given as a hexadecimal number and it
3499 defines the size of the memory region starting at base
3500 address bootm_low that is accessible by the Linux kernel
3501 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3502 as the default value if it is defined, and bootm_size is
3503 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003504
3505 bootm_size - Memory range available for image processing in the bootm
3506 command can be restricted. This variable is given as
3507 a hexadecimal number and defines the size of the region
3508 allowed for use by the bootm command. See also "bootm_low"
3509 environment variable.
3510
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003511 updatefile - Location of the software update file on a TFTP server, used
3512 by the automatic software update feature. Please refer to
3513 documentation in doc/README.update for more details.
3514
wdenk2729af92004-05-03 20:45:30 +00003515 autoload - if set to "no" (any string beginning with 'n'),
3516 "bootp" will just load perform a lookup of the
3517 configuration from the BOOTP server, but not try to
3518 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003519
wdenk2729af92004-05-03 20:45:30 +00003520 autostart - if set to "yes", an image loaded using the "bootp",
3521 "rarpboot", "tftpboot" or "diskboot" commands will
3522 be automatically started (by internally calling
3523 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525 If set to "no", a standalone image passed to the
3526 "bootm" command will be copied to the load address
3527 (and eventually uncompressed), but NOT be started.
3528 This can be used to load and uncompress arbitrary
3529 data.
wdenkc6097192002-11-03 00:24:07 +00003530
David A. Longa28afca2011-07-09 16:40:19 -04003531 fdt_high - if set this restricts the maximum address that the
3532 flattened device tree will be copied into upon boot.
3533 If this is set to the special value 0xFFFFFFFF then
3534 the fdt will not be copied at all on boot. For this
3535 to work it must reside in writable memory, have
3536 sufficient padding on the end of it for u-boot to
3537 add the information it needs into it, and the memory
3538 must be accessible by the kernel.
3539
Simon Glasseea63e02011-10-24 19:15:34 +00003540 fdtcontroladdr- if set this is the address of the control flattened
3541 device tree used by U-Boot when CONFIG_OF_CONTROL is
3542 defined.
3543
wdenk17ea1172004-06-06 21:51:03 +00003544 i2cfast - (PPC405GP|PPC405EP only)
3545 if set to 'y' configures Linux I2C driver for fast
3546 mode (400kHZ). This environment variable is used in
3547 initialization code. So, for changes to be effective
3548 it must be saved and board must be reset.
3549
wdenk2729af92004-05-03 20:45:30 +00003550 initrd_high - restrict positioning of initrd images:
3551 If this variable is not set, initrd images will be
3552 copied to the highest possible address in RAM; this
3553 is usually what you want since it allows for
3554 maximum initrd size. If for some reason you want to
3555 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003557 variable to a value of "no" or "off" or "0".
3558 Alternatively, you can set it to a maximum upper
3559 address to use (U-Boot will still check that it
3560 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562 For instance, when you have a system with 16 MB
3563 RAM, and want to reserve 4 MB from use by Linux,
3564 you can do this by adding "mem=12M" to the value of
3565 the "bootargs" variable. However, now you must make
3566 sure that the initrd image is placed in the first
3567 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk2729af92004-05-03 20:45:30 +00003569 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk2729af92004-05-03 20:45:30 +00003571 If you set initrd_high to 0xFFFFFFFF, this is an
3572 indication to U-Boot that all addresses are legal
3573 for the Linux kernel, including addresses in flash
3574 memory. In this case U-Boot will NOT COPY the
3575 ramdisk at all. This may be useful to reduce the
3576 boot time on your system, but requires that this
3577 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk2729af92004-05-03 20:45:30 +00003581 loadaddr - Default load address for commands like "bootp",
3582 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk2729af92004-05-03 20:45:30 +00003584 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003585
wdenk2729af92004-05-03 20:45:30 +00003586 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003587
wdenk2729af92004-05-03 20:45:30 +00003588 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003589
wdenk2729af92004-05-03 20:45:30 +00003590 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk2729af92004-05-03 20:45:30 +00003592 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003593
Mike Frysingere2a53452011-10-02 10:01:27 +00003594 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003595
Mike Frysingere2a53452011-10-02 10:01:27 +00003596 ethact - controls which interface is currently active.
3597 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003598
Heiko Schocher48690d82010-07-20 17:45:02 +02003599 => setenv ethact FEC
3600 => ping 192.168.0.1 # traffic sent on FEC
3601 => setenv ethact SCC
3602 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003603
Matthias Fuchse1692572008-01-17 07:45:05 +01003604 ethrotate - When set to "no" U-Boot does not go through all
3605 available network interfaces.
3606 It just stays at the currently selected interface.
3607
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003608 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003609 either succeed or fail without retrying.
3610 When set to "once" the network operation will
3611 fail when all the available network interfaces
3612 are tried once without success.
3613 Useful on scripts which control the retry operation
3614 themselves.
wdenkc6097192002-11-03 00:24:07 +00003615
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003616 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003617
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003618 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003619 UDP source port.
3620
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003621 tftpdstport - If this is set, the value is used for TFTP's UDP
3622 destination port instead of the Well Know Port 69.
3623
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003624 tftpblocksize - Block size to use for TFTP transfers; if not set,
3625 we use the TFTP server's default block size
3626
3627 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3628 seconds, minimum value is 1000 = 1 second). Defines
3629 when a packet is considered to be lost so it has to
3630 be retransmitted. The default is 5000 = 5 seconds.
3631 Lowering this value may make downloads succeed
3632 faster in networks with high packet loss rates or
3633 with unreliable TFTP servers.
3634
3635 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003636 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003637 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003638
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003639The following image location variables contain the location of images
3640used in booting. The "Image" column gives the role of the image and is
3641not an environment variable name. The other columns are environment
3642variable names. "File Name" gives the name of the file on a TFTP
3643server, "RAM Address" gives the location in RAM the image will be
3644loaded to, and "Flash Location" gives the image's address in NOR
3645flash or offset in NAND flash.
3646
3647*Note* - these variables don't have to be defined for all boards, some
3648boards currenlty use other variables for these purposes, and some
3649boards use these variables for other purposes.
3650
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003651Image File Name RAM Address Flash Location
3652----- --------- ----------- --------------
3653u-boot u-boot u-boot_addr_r u-boot_addr
3654Linux kernel bootfile kernel_addr_r kernel_addr
3655device tree blob fdtfile fdt_addr_r fdt_addr
3656ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003657
wdenk2729af92004-05-03 20:45:30 +00003658The following environment variables may be used and automatically
3659updated by the network boot commands ("bootp" and "rarpboot"),
3660depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662 bootfile - see above
3663 dnsip - IP address of your Domain Name Server
3664 dnsip2 - IP address of your secondary Domain Name Server
3665 gatewayip - IP address of the Gateway (Router) to use
3666 hostname - Target hostname
3667 ipaddr - see above
3668 netmask - Subnet Mask
3669 rootpath - Pathname of the root filesystem on the NFS server
3670 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003671
wdenka3d991b2004-04-15 21:48:45 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675 serial# - contains hardware identification information such
3676 as type string and/or serial number
3677 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003678
wdenk2729af92004-05-03 20:45:30 +00003679These variables can be set only once (usually during manufacturing of
3680the board). U-Boot refuses to delete or overwrite these variables
3681once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003682
3683
wdenk2729af92004-05-03 20:45:30 +00003684Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003685
wdenk2729af92004-05-03 20:45:30 +00003686 ver - Contains the U-Boot version string as printed
3687 with the "version" command. This variable is
3688 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003689
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691Please note that changes to some configuration parameters may take
3692only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003693
stroesec1551ea2003-04-04 15:53:41 +00003694
wdenk2729af92004-05-03 20:45:30 +00003695Command Line Parsing:
3696=====================
stroesec1551ea2003-04-04 15:53:41 +00003697
wdenk2729af92004-05-03 20:45:30 +00003698There are two different command line parsers available with U-Boot:
3699the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003700
wdenk2729af92004-05-03 20:45:30 +00003701Old, simple command line parser:
3702--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003703
wdenk2729af92004-05-03 20:45:30 +00003704- supports environment variables (through setenv / saveenv commands)
3705- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003706- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003707- special characters ('$', ';') can be escaped by prefixing with '\',
3708 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003709 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003710- You can also escape text by enclosing in single apostrophes, for example:
3711 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713Hush shell:
3714-----------
wdenkf07771c2003-05-28 08:06:31 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716- similar to Bourne shell, with control structures like
3717 if...then...else...fi, for...do...done; while...do...done,
3718 until...do...done, ...
3719- supports environment ("global") variables (through setenv / saveenv
3720 commands) and local shell variables (through standard shell syntax
3721 "name=value"); only environment variables can be used with "run"
3722 command
wdenkf07771c2003-05-28 08:06:31 +00003723
wdenk2729af92004-05-03 20:45:30 +00003724General rules:
3725--------------
wdenkf07771c2003-05-28 08:06:31 +00003726
wdenk2729af92004-05-03 20:45:30 +00003727(1) If a command line (or an environment variable executed by a "run"
3728 command) contains several commands separated by semicolon, and
3729 one of these commands fails, then the remaining commands will be
3730 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003731
wdenk2729af92004-05-03 20:45:30 +00003732(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003733 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003734 command will cause "run" to terminate, i. e. the remaining
3735 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737Note for Redundant Ethernet Interfaces:
3738=======================================
wdenkf07771c2003-05-28 08:06:31 +00003739
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003740Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003741such configurations and is capable of automatic selection of a
3742"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003743
wdenk2729af92004-05-03 20:45:30 +00003744Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3745MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3746"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003747
wdenk2729af92004-05-03 20:45:30 +00003748If the network interface stores some valid MAC address (for instance
3749in SROM), this is used as default address if there is NO correspon-
3750ding setting in the environment; if the corresponding environment
3751variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003752
wdenk2729af92004-05-03 20:45:30 +00003753o If the SROM has a valid MAC address, and there is no address in the
3754 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756o If there is no valid address in the SROM, and a definition in the
3757 environment exists, then the value from the environment variable is
3758 used.
wdenkc6097192002-11-03 00:24:07 +00003759
wdenk2729af92004-05-03 20:45:30 +00003760o If both the SROM and the environment contain a MAC address, and
3761 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763o If both the SROM and the environment contain a MAC address, and the
3764 addresses differ, the value from the environment is used and a
3765 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk2729af92004-05-03 20:45:30 +00003767o If neither SROM nor the environment contain a MAC address, an error
3768 is raised.
wdenkc6097192002-11-03 00:24:07 +00003769
Ben Warrenecee9322010-04-26 11:11:46 -07003770If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003771will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003772may be skipped by setting the appropriate 'ethmacskip' environment variable.
3773The naming convention is as follows:
3774"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776Image Formats:
3777==============
wdenkc6097192002-11-03 00:24:07 +00003778
Marian Balakowicz3310c542008-03-12 12:13:13 +01003779U-Boot is capable of booting (and performing other auxiliary operations on)
3780images in two formats:
3781
3782New uImage format (FIT)
3783-----------------------
3784
3785Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3786to Flattened Device Tree). It allows the use of images with multiple
3787components (several kernels, ramdisks, etc.), with contents protected by
3788SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3789
3790
3791Old uImage format
3792-----------------
3793
3794Old image format is based on binary files which can be basically anything,
3795preceded by a special header; see the definitions in include/image.h for
3796details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk2729af92004-05-03 20:45:30 +00003798* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3799 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003800 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3801 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3802 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003803* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003804 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3805 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003806* Compression Type (uncompressed, gzip, bzip2)
3807* Load Address
3808* Entry Point
3809* Image Name
3810* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812The header is marked by a special Magic Number, and both the header
3813and the data portions of the image are secured against corruption by
3814CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003815
wdenkc6097192002-11-03 00:24:07 +00003816
wdenk2729af92004-05-03 20:45:30 +00003817Linux Support:
3818==============
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820Although U-Boot should support any OS or standalone application
3821easily, the main focus has always been on Linux during the design of
3822U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003823
wdenk2729af92004-05-03 20:45:30 +00003824U-Boot includes many features that so far have been part of some
3825special "boot loader" code within the Linux kernel. Also, any
3826"initrd" images to be used are no longer part of one big Linux image;
3827instead, kernel and "initrd" are separate images. This implementation
3828serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830- the same features can be used for other OS or standalone
3831 applications (for instance: using compressed images to reduce the
3832 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834- it becomes much easier to port new Linux kernel versions because
3835 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003836
wdenk2729af92004-05-03 20:45:30 +00003837- the same Linux kernel image can now be used with different "initrd"
3838 images; of course this also means that different kernel images can
3839 be run with the same "initrd". This makes testing easier (you don't
3840 have to build a new "zImage.initrd" Linux image when you just
3841 change a file in your "initrd"). Also, a field-upgrade of the
3842 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003843
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk2729af92004-05-03 20:45:30 +00003845Linux HOWTO:
3846============
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848Porting Linux to U-Boot based systems:
3849---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851U-Boot cannot save you from doing all the necessary modifications to
3852configure the Linux device drivers for use with your target hardware
3853(no, we don't intend to provide a full virtual machine interface to
3854Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003855
Stefan Roesea47a12b2010-04-15 16:07:28 +02003856But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003857
wdenk2729af92004-05-03 20:45:30 +00003858Just make sure your machine specific header file (for instance
3859include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003860Information structure as we define in include/asm-<arch>/u-boot.h,
3861and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003862as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003863
wdenkc6097192002-11-03 00:24:07 +00003864
wdenk2729af92004-05-03 20:45:30 +00003865Configuring the Linux kernel:
3866-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003867
wdenk2729af92004-05-03 20:45:30 +00003868No specific requirements for U-Boot. Make sure you have some root
3869device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003870
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk2729af92004-05-03 20:45:30 +00003872Building a Linux Image:
3873-----------------------
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk2729af92004-05-03 20:45:30 +00003875With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3876not used. If you use recent kernel source, a new build target
3877"uImage" will exist which automatically builds an image usable by
3878U-Boot. Most older kernels also have support for a "pImage" target,
3879which was introduced for our predecessor project PPCBoot and uses a
3880100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882Example:
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884 make TQM850L_config
3885 make oldconfig
3886 make dep
3887 make uImage
wdenkc6097192002-11-03 00:24:07 +00003888
wdenk2729af92004-05-03 20:45:30 +00003889The "uImage" build target uses a special tool (in 'tools/mkimage') to
3890encapsulate a compressed Linux kernel image with header information,
3891CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003896
wdenk2729af92004-05-03 20:45:30 +00003897 ${CROSS_COMPILE}-objcopy -O binary \
3898 -R .note -R .comment \
3899 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk2729af92004-05-03 20:45:30 +00003901* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003902
wdenk2729af92004-05-03 20:45:30 +00003903 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003904
wdenk2729af92004-05-03 20:45:30 +00003905* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003906
wdenk2729af92004-05-03 20:45:30 +00003907 mkimage -A ppc -O linux -T kernel -C gzip \
3908 -a 0 -e 0 -n "Linux Kernel Image" \
3909 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003910
wdenk24ee89b2002-11-03 17:56:27 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912The "mkimage" tool can also be used to create ramdisk images for use
3913with U-Boot, either separated from the Linux kernel image, or
3914combined into one file. "mkimage" encapsulates the images with a 64
3915byte header containing information about target architecture,
3916operating system, image type, compression method, entry points, time
3917stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003918
wdenk2729af92004-05-03 20:45:30 +00003919"mkimage" can be called in two ways: to verify existing images and
3920print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003921
wdenk2729af92004-05-03 20:45:30 +00003922In the first form (with "-l" option) mkimage lists the information
3923contained in the header of an existing U-Boot image; this includes
3924checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926 tools/mkimage -l image
3927 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929The second form (with "-d" option) is used to build a U-Boot image
3930from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3933 -n name -d data_file image
3934 -A ==> set architecture to 'arch'
3935 -O ==> set operating system to 'os'
3936 -T ==> set image type to 'type'
3937 -C ==> set compression type 'comp'
3938 -a ==> set load address to 'addr' (hex)
3939 -e ==> set entry point to 'ep' (hex)
3940 -n ==> set image name to 'name'
3941 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003942
wdenk69459792004-05-29 16:53:29 +00003943Right now, all Linux kernels for PowerPC systems use the same load
3944address (0x00000000), but the entry point address depends on the
3945kernel version:
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947- 2.2.x kernels have the entry point at 0x0000000C,
3948- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003951
wdenk2729af92004-05-03 20:45:30 +00003952 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3953 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003954 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003955 > examples/uImage.TQM850L
3956 Image Name: 2.4.4 kernel for TQM850L
3957 Created: Wed Jul 19 02:34:59 2000
3958 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3959 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3960 Load Address: 0x00000000
3961 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk2729af92004-05-03 20:45:30 +00003963To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965 -> tools/mkimage -l examples/uImage.TQM850L
3966 Image Name: 2.4.4 kernel for TQM850L
3967 Created: Wed Jul 19 02:34:59 2000
3968 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3969 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3970 Load Address: 0x00000000
3971 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973NOTE: for embedded systems where boot time is critical you can trade
3974speed for memory and install an UNCOMPRESSED image instead: this
3975needs more space in Flash, but boots much faster since it does not
3976need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003977
Stefan Roesea47a12b2010-04-15 16:07:28 +02003978 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003979 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3980 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003981 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003982 > examples/uImage.TQM850L-uncompressed
3983 Image Name: 2.4.4 kernel for TQM850L
3984 Created: Wed Jul 19 02:34:59 2000
3985 Image Type: PowerPC Linux Kernel Image (uncompressed)
3986 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3987 Load Address: 0x00000000
3988 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003989
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3992when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994 -> tools/mkimage -n 'Simple Ramdisk Image' \
3995 > -A ppc -O linux -T ramdisk -C gzip \
3996 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3997 Image Name: Simple Ramdisk Image
3998 Created: Wed Jan 12 14:01:50 2000
3999 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4000 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4001 Load Address: 0x00000000
4002 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004003
wdenkdb01a2e2004-04-15 23:14:49 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005Installing a Linux Image:
4006-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008To downloading a U-Boot image over the serial (console) interface,
4009you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004010
wdenk2729af92004-05-03 20:45:30 +00004011 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013The 'objcopy' does not understand the information in the U-Boot
4014image header, so the resulting S-Record file will be relative to
4015address 0x00000000. To load it to a given address, you need to
4016specify the target address as 'offset' parameter with the 'loads'
4017command.
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019Example: install the image to address 0x40100000 (which on the
4020TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024 .......... done
4025 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk2729af92004-05-03 20:45:30 +00004027 => loads 40100000
4028 ## Ready for S-Record download ...
4029 ~>examples/image.srec
4030 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4031 ...
4032 15989 15990 15991 15992
4033 [file transfer complete]
4034 [connected]
4035 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004036
4037
wdenk2729af92004-05-03 20:45:30 +00004038You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004039this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004040corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004041
wdenk2729af92004-05-03 20:45:30 +00004042 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004043
wdenk2729af92004-05-03 20:45:30 +00004044 ## Checking Image at 40100000 ...
4045 Image Name: 2.2.13 for initrd on TQM850L
4046 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4047 Data Size: 335725 Bytes = 327 kB = 0 MB
4048 Load Address: 00000000
4049 Entry Point: 0000000c
4050 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004051
4052
wdenk2729af92004-05-03 20:45:30 +00004053Boot Linux:
4054-----------
wdenkc6097192002-11-03 00:24:07 +00004055
wdenk2729af92004-05-03 20:45:30 +00004056The "bootm" command is used to boot an application that is stored in
4057memory (RAM or Flash). In case of a Linux kernel image, the contents
4058of the "bootargs" environment variable is passed to the kernel as
4059parameters. You can check and modify this variable using the
4060"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004061
4062
wdenk2729af92004-05-03 20:45:30 +00004063 => printenv bootargs
4064 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004065
wdenk2729af92004-05-03 20:45:30 +00004066 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068 => printenv bootargs
4069 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 => bootm 40020000
4072 ## Booting Linux kernel at 40020000 ...
4073 Image Name: 2.2.13 for NFS on TQM850L
4074 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4075 Data Size: 381681 Bytes = 372 kB = 0 MB
4076 Load Address: 00000000
4077 Entry Point: 0000000c
4078 Verifying Checksum ... OK
4079 Uncompressing Kernel Image ... OK
4080 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
4081 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4082 time_init: decrementer frequency = 187500000/60
4083 Calibrating delay loop... 49.77 BogoMIPS
4084 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4085 ...
wdenkc6097192002-11-03 00:24:07 +00004086
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004087If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004088the memory addresses of both the kernel and the initrd image (PPBCOOT
4089format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004090
wdenk2729af92004-05-03 20:45:30 +00004091 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004092
wdenk2729af92004-05-03 20:45:30 +00004093 ## Checking Image at 40100000 ...
4094 Image Name: 2.2.13 for initrd on TQM850L
4095 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4096 Data Size: 335725 Bytes = 327 kB = 0 MB
4097 Load Address: 00000000
4098 Entry Point: 0000000c
4099 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004100
wdenk2729af92004-05-03 20:45:30 +00004101 ## Checking Image at 40200000 ...
4102 Image Name: Simple Ramdisk Image
4103 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4104 Data Size: 566530 Bytes = 553 kB = 0 MB
4105 Load Address: 00000000
4106 Entry Point: 00000000
4107 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004108
wdenk2729af92004-05-03 20:45:30 +00004109 => bootm 40100000 40200000
4110 ## Booting Linux kernel at 40100000 ...
4111 Image Name: 2.2.13 for initrd on TQM850L
4112 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4113 Data Size: 335725 Bytes = 327 kB = 0 MB
4114 Load Address: 00000000
4115 Entry Point: 0000000c
4116 Verifying Checksum ... OK
4117 Uncompressing Kernel Image ... OK
4118 ## Loading RAMDisk Image at 40200000 ...
4119 Image Name: Simple Ramdisk Image
4120 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4121 Data Size: 566530 Bytes = 553 kB = 0 MB
4122 Load Address: 00000000
4123 Entry Point: 00000000
4124 Verifying Checksum ... OK
4125 Loading Ramdisk ... OK
4126 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
4127 Boot arguments: root=/dev/ram
4128 time_init: decrementer frequency = 187500000/60
4129 Calibrating delay loop... 49.77 BogoMIPS
4130 ...
4131 RAMDISK: Compressed image found at block 0
4132 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134 bash#
wdenkc6097192002-11-03 00:24:07 +00004135
Matthew McClintock02677682006-06-28 10:41:37 -05004136Boot Linux and pass a flat device tree:
4137-----------
4138
4139First, U-Boot must be compiled with the appropriate defines. See the section
4140titled "Linux Kernel Interface" above for a more in depth explanation. The
4141following is an example of how to start a kernel and pass an updated
4142flat device tree:
4143
4144=> print oftaddr
4145oftaddr=0x300000
4146=> print oft
4147oft=oftrees/mpc8540ads.dtb
4148=> tftp $oftaddr $oft
4149Speed: 1000, full duplex
4150Using TSEC0 device
4151TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4152Filename 'oftrees/mpc8540ads.dtb'.
4153Load address: 0x300000
4154Loading: #
4155done
4156Bytes transferred = 4106 (100a hex)
4157=> tftp $loadaddr $bootfile
4158Speed: 1000, full duplex
4159Using TSEC0 device
4160TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4161Filename 'uImage'.
4162Load address: 0x200000
4163Loading:############
4164done
4165Bytes transferred = 1029407 (fb51f hex)
4166=> print loadaddr
4167loadaddr=200000
4168=> print oftaddr
4169oftaddr=0x300000
4170=> bootm $loadaddr - $oftaddr
4171## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004172 Image Name: Linux-2.6.17-dirty
4173 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4174 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004175 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004176 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004177 Verifying Checksum ... OK
4178 Uncompressing Kernel Image ... OK
4179Booting using flat device tree at 0x300000
4180Using MPC85xx ADS machine description
4181Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4182[snip]
4183
4184
wdenk2729af92004-05-03 20:45:30 +00004185More About U-Boot Image Types:
4186------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190 "Standalone Programs" are directly runnable in the environment
4191 provided by U-Boot; it is expected that (if they behave
4192 well) you can continue to work in U-Boot after return from
4193 the Standalone Program.
4194 "OS Kernel Images" are usually images of some Embedded OS which
4195 will take over control completely. Usually these programs
4196 will install their own set of exception handlers, device
4197 drivers, set up the MMU, etc. - this means, that you cannot
4198 expect to re-enter U-Boot except by resetting the CPU.
4199 "RAMDisk Images" are more or less just data blocks, and their
4200 parameters (address, size) are passed to an OS kernel that is
4201 being started.
4202 "Multi-File Images" contain several images, typically an OS
4203 (Linux) kernel image and one or more data images like
4204 RAMDisks. This construct is useful for instance when you want
4205 to boot over the network using BOOTP etc., where the boot
4206 server provides just a single image file, but you want to get
4207 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209 "Multi-File Images" start with a list of image sizes, each
4210 image size (in bytes) specified by an "uint32_t" in network
4211 byte order. This list is terminated by an "(uint32_t)0".
4212 Immediately after the terminating 0 follow the images, one by
4213 one, all aligned on "uint32_t" boundaries (size rounded up to
4214 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004215
wdenk2729af92004-05-03 20:45:30 +00004216 "Firmware Images" are binary images containing firmware (like
4217 U-Boot or FPGA images) which usually will be programmed to
4218 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004219
wdenk2729af92004-05-03 20:45:30 +00004220 "Script files" are command sequences that will be executed by
4221 U-Boot's command interpreter; this feature is especially
4222 useful when you configure U-Boot to use a real shell (hush)
4223 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004224
wdenkc6097192002-11-03 00:24:07 +00004225
wdenk2729af92004-05-03 20:45:30 +00004226Standalone HOWTO:
4227=================
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229One of the features of U-Boot is that you can dynamically load and
4230run "standalone" applications, which can use some resources of
4231U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004232
wdenk2729af92004-05-03 20:45:30 +00004233Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004234
wdenk2729af92004-05-03 20:45:30 +00004235"Hello World" Demo:
4236-------------------
wdenkc6097192002-11-03 00:24:07 +00004237
wdenk2729af92004-05-03 20:45:30 +00004238'examples/hello_world.c' contains a small "Hello World" Demo
4239application; it is automatically compiled when you build U-Boot.
4240It's configured to run at address 0x00040004, so you can play with it
4241like that:
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243 => loads
4244 ## Ready for S-Record download ...
4245 ~>examples/hello_world.srec
4246 1 2 3 4 5 6 7 8 9 10 11 ...
4247 [file transfer complete]
4248 [connected]
4249 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004250
wdenk2729af92004-05-03 20:45:30 +00004251 => go 40004 Hello World! This is a test.
4252 ## Starting application at 0x00040004 ...
4253 Hello World
4254 argc = 7
4255 argv[0] = "40004"
4256 argv[1] = "Hello"
4257 argv[2] = "World!"
4258 argv[3] = "This"
4259 argv[4] = "is"
4260 argv[5] = "a"
4261 argv[6] = "test."
4262 argv[7] = "<NULL>"
4263 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk2729af92004-05-03 20:45:30 +00004265 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267Another example, which demonstrates how to register a CPM interrupt
4268handler with the U-Boot code, can be found in 'examples/timer.c'.
4269Here, a CPM timer is set up to generate an interrupt every second.
4270The interrupt service routine is trivial, just printing a '.'
4271character, but this is just a demo program. The application can be
4272controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004273
wdenk2729af92004-05-03 20:45:30 +00004274 ? - print current values og the CPM Timer registers
4275 b - enable interrupts and start timer
4276 e - stop timer and disable interrupts
4277 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 => loads
4280 ## Ready for S-Record download ...
4281 ~>examples/timer.srec
4282 1 2 3 4 5 6 7 8 9 10 11 ...
4283 [file transfer complete]
4284 [connected]
4285 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk2729af92004-05-03 20:45:30 +00004287 => go 40004
4288 ## Starting application at 0x00040004 ...
4289 TIMERS=0xfff00980
4290 Using timer 1
4291 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004292
wdenk2729af92004-05-03 20:45:30 +00004293Hit 'b':
4294 [q, b, e, ?] Set interval 1000000 us
4295 Enabling timer
4296Hit '?':
4297 [q, b, e, ?] ........
4298 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4299Hit '?':
4300 [q, b, e, ?] .
4301 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4302Hit '?':
4303 [q, b, e, ?] .
4304 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4305Hit '?':
4306 [q, b, e, ?] .
4307 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4308Hit 'e':
4309 [q, b, e, ?] ...Stopping timer
4310Hit 'q':
4311 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004312
4313
wdenk2729af92004-05-03 20:45:30 +00004314Minicom warning:
4315================
wdenk85ec0bc2003-03-31 16:34:49 +00004316
wdenk2729af92004-05-03 20:45:30 +00004317Over time, many people have reported problems when trying to use the
4318"minicom" terminal emulation program for serial download. I (wd)
4319consider minicom to be broken, and recommend not to use it. Under
4320Unix, I recommend to use C-Kermit for general purpose use (and
4321especially for kermit binary protocol download ("loadb" command), and
4322use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004323
wdenk2729af92004-05-03 20:45:30 +00004324Nevertheless, if you absolutely want to use it try adding this
4325configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327 Name Program Name U/D FullScr IO-Red. Multi
4328 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4329 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004330
4331
wdenk2729af92004-05-03 20:45:30 +00004332NetBSD Notes:
4333=============
wdenkc6097192002-11-03 00:24:07 +00004334
wdenk2729af92004-05-03 20:45:30 +00004335Starting at version 0.9.2, U-Boot supports NetBSD both as host
4336(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk2729af92004-05-03 20:45:30 +00004338Building requires a cross environment; it is known to work on
4339NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4340need gmake since the Makefiles are not compatible with BSD make).
4341Note that the cross-powerpc package does not install include files;
4342attempting to build U-Boot will fail because <machine/ansi.h> is
4343missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345 # cd /usr/pkg/cross/powerpc-netbsd/include
4346 # mkdir powerpc
4347 # ln -s powerpc machine
4348 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4349 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk2729af92004-05-03 20:45:30 +00004351Native builds *don't* work due to incompatibilities between native
4352and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004353
wdenk2729af92004-05-03 20:45:30 +00004354Booting assumes that (the first part of) the image booted is a
4355stage-2 loader which in turn loads and then invokes the kernel
4356proper. Loader sources will eventually appear in the NetBSD source
4357tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004358meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004359
4360
wdenk2729af92004-05-03 20:45:30 +00004361Implementation Internals:
4362=========================
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364The following is not intended to be a complete description of every
4365implementation detail. However, it should help to understand the
4366inner workings of U-Boot and make it easier to port it to custom
4367hardware.
wdenkc6097192002-11-03 00:24:07 +00004368
4369
wdenk2729af92004-05-03 20:45:30 +00004370Initial Stack, Global Data:
4371---------------------------
wdenkc6097192002-11-03 00:24:07 +00004372
wdenk2729af92004-05-03 20:45:30 +00004373The implementation of U-Boot is complicated by the fact that U-Boot
4374starts running out of ROM (flash memory), usually without access to
4375system RAM (because the memory controller is not initialized yet).
4376This means that we don't have writable Data or BSS segments, and BSS
4377is not initialized as zero. To be able to get a C environment working
4378at all, we have to allocate at least a minimal stack. Implementation
4379options for this are defined and restricted by the CPU used: Some CPU
4380models provide on-chip memory (like the IMMR area on MPC8xx and
4381MPC826x processors), on others (parts of) the data cache can be
4382locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004383
Wolfgang Denk218ca722008-03-26 10:40:12 +01004384 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004385 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004386
wdenk2729af92004-05-03 20:45:30 +00004387 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4388 From: "Chris Hallinan" <clh@net1plus.com>
4389 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4390 ...
wdenk43d96162003-03-06 00:02:04 +00004391
wdenk2729af92004-05-03 20:45:30 +00004392 Correct me if I'm wrong, folks, but the way I understand it
4393 is this: Using DCACHE as initial RAM for Stack, etc, does not
4394 require any physical RAM backing up the cache. The cleverness
4395 is that the cache is being used as a temporary supply of
4396 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004397 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004398 can see how this works by studying the cache architecture and
4399 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004400
wdenk2729af92004-05-03 20:45:30 +00004401 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4402 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004403 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004404 option should work for you. Using CS 4 should be fine if your
4405 board designers haven't used it for something that would
4406 cause you grief during the initial boot! It is frequently not
4407 used.
wdenk43d96162003-03-06 00:02:04 +00004408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004409 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004410 with your processor/board/system design. The default value
4411 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004412 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004413 than your SDRAM module. If you have a 64MB SDRAM module, set
4414 it above 400_0000. Just make sure your board has no resources
4415 that are supposed to respond to that address! That code in
4416 start.S has been around a while and should work as is when
4417 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419 -Chris Hallinan
4420 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004421
wdenk2729af92004-05-03 20:45:30 +00004422It is essential to remember this, since it has some impact on the C
4423code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk2729af92004-05-03 20:45:30 +00004425* Initialized global data (data segment) is read-only. Do not attempt
4426 to write it.
wdenkc6097192002-11-03 00:24:07 +00004427
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004428* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004429 as zero data - BSS segment) at all - this is undefined, initiali-
4430 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk2729af92004-05-03 20:45:30 +00004432* Stack space is very limited. Avoid big data buffers or things like
4433 that.
wdenkc6097192002-11-03 00:24:07 +00004434
wdenk2729af92004-05-03 20:45:30 +00004435Having only the stack as writable memory limits means we cannot use
4436normal global data to share information beween the code. But it
4437turned out that the implementation of U-Boot can be greatly
4438simplified by making a global data structure (gd_t) available to all
4439functions. We could pass a pointer to this data as argument to _all_
4440functions, but this would bloat the code. Instead we use a feature of
4441the GCC compiler (Global Register Variables) to share the data: we
4442place a pointer (gd) to the global data into a register which we
4443reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk2729af92004-05-03 20:45:30 +00004445When choosing a register for such a purpose we are restricted by the
4446relevant (E)ABI specifications for the current architecture, and by
4447GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449For PowerPC, the following registers have specific use:
4450 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004451 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004452 R3-R4: parameter passing and return values
4453 R5-R10: parameter passing
4454 R13: small data area pointer
4455 R30: GOT pointer
4456 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004457
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004458 (U-Boot also uses R12 as internal GOT pointer. r12
4459 is a volatile register so r12 needs to be reset when
4460 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004461
Wolfgang Denke7670f62008-02-14 22:43:22 +01004462 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464 Note: on PPC, we could use a static initializer (since the
4465 address of the global data structure is known at compile time),
4466 but it turned out that reserving a register results in somewhat
4467 smaller code - although the code savings are not that big (on
4468 average for all boards 752 bytes for the whole U-Boot image,
4469 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004470
Robin Getzc4db3352009-08-17 15:23:02 +00004471On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004472 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4473
Robin Getzc4db3352009-08-17 15:23:02 +00004474 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004475
wdenk2729af92004-05-03 20:45:30 +00004476On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk2729af92004-05-03 20:45:30 +00004478 R0: function argument word/integer result
4479 R1-R3: function argument word
4480 R9: GOT pointer
4481 R10: stack limit (used only if stack checking if enabled)
4482 R11: argument (frame) pointer
4483 R12: temporary workspace
4484 R13: stack pointer
4485 R14: link register
4486 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004489
Thomas Chou0df01fd2010-05-21 11:08:03 +08004490On Nios II, the ABI is documented here:
4491 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4492
4493 ==> U-Boot will use gp to hold a pointer to the global data
4494
4495 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4496 to access small data sections, so gp is free.
4497
Macpaul Linafc1ce82011-10-19 20:41:11 +00004498On NDS32, the following registers are used:
4499
4500 R0-R1: argument/return
4501 R2-R5: argument
4502 R15: temporary register for assembler
4503 R16: trampoline register
4504 R28: frame pointer (FP)
4505 R29: global pointer (GP)
4506 R30: link register (LP)
4507 R31: stack pointer (SP)
4508 PC: program counter (PC)
4509
4510 ==> U-Boot will use R10 to hold a pointer to the global data
4511
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004512NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4513or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004514
wdenk2729af92004-05-03 20:45:30 +00004515Memory Management:
4516------------------
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk2729af92004-05-03 20:45:30 +00004518U-Boot runs in system state and uses physical addresses, i.e. the
4519MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk2729af92004-05-03 20:45:30 +00004521The available memory is mapped to fixed addresses using the memory
4522controller. In this process, a contiguous block is formed for each
4523memory type (Flash, SDRAM, SRAM), even when it consists of several
4524physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004525
wdenk2729af92004-05-03 20:45:30 +00004526U-Boot is installed in the first 128 kB of the first Flash bank (on
4527TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4528booting and sizing and initializing DRAM, the code relocates itself
4529to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004530memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004531configuration setting]. Below that, a structure with global Board
4532Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004533
wdenk2729af92004-05-03 20:45:30 +00004534Additionally, some exception handler code is copied to the low 8 kB
4535of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004536
wdenk2729af92004-05-03 20:45:30 +00004537So a typical memory configuration with 16 MB of DRAM could look like
4538this:
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk2729af92004-05-03 20:45:30 +00004540 0x0000 0000 Exception Vector code
4541 :
4542 0x0000 1FFF
4543 0x0000 2000 Free for Application Use
4544 :
4545 :
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk2729af92004-05-03 20:45:30 +00004547 :
4548 :
4549 0x00FB FF20 Monitor Stack (Growing downward)
4550 0x00FB FFAC Board Info Data and permanent copy of global data
4551 0x00FC 0000 Malloc Arena
4552 :
4553 0x00FD FFFF
4554 0x00FE 0000 RAM Copy of Monitor Code
4555 ... eventually: LCD or video framebuffer
4556 ... eventually: pRAM (Protected RAM - unchanged by reset)
4557 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004558
4559
wdenk2729af92004-05-03 20:45:30 +00004560System Initialization:
4561----------------------
wdenkc6097192002-11-03 00:24:07 +00004562
wdenk2729af92004-05-03 20:45:30 +00004563In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004564(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004565configuration for CS0# this is a mirror of the onboard Flash memory.
4566To be able to re-map memory U-Boot then jumps to its link address.
4567To be able to implement the initialization code in C, a (small!)
4568initial stack is set up in the internal Dual Ported RAM (in case CPUs
4569which provide such a feature like MPC8xx or MPC8260), or in a locked
4570part of the data cache. After that, U-Boot initializes the CPU core,
4571the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004572
wdenk2729af92004-05-03 20:45:30 +00004573Next, all (potentially) available memory banks are mapped using a
4574preliminary mapping. For example, we put them on 512 MB boundaries
4575(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4576on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4577programmed for SDRAM access. Using the temporary configuration, a
4578simple memory test is run that determines the size of the SDRAM
4579banks.
wdenkc6097192002-11-03 00:24:07 +00004580
wdenk2729af92004-05-03 20:45:30 +00004581When there is more than one SDRAM bank, and the banks are of
4582different size, the largest is mapped first. For equal size, the first
4583bank (CS2#) is mapped first. The first mapping is always for address
45840x00000000, with any additional banks following immediately to create
4585contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587Then, the monitor installs itself at the upper end of the SDRAM area
4588and allocates memory for use by malloc() and for the global Board
4589Info data; also, the exception vector code is copied to the low RAM
4590pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004591
wdenk2729af92004-05-03 20:45:30 +00004592Only after this relocation will you have a "normal" C environment;
4593until that you are restricted in several ways, mostly because you are
4594running from ROM, and because the code will have to be relocated to a
4595new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004596
4597
wdenk2729af92004-05-03 20:45:30 +00004598U-Boot Porting Guide:
4599----------------------
wdenkc6097192002-11-03 00:24:07 +00004600
wdenk2729af92004-05-03 20:45:30 +00004601[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4602list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004603
4604
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004605int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004606{
4607 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004608
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004609 signal(SIGALRM, no_more_time);
4610 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk2729af92004-05-03 20:45:30 +00004612 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004613 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004614 return 0;
4615 }
4616
wdenk2729af92004-05-03 20:45:30 +00004617 Download latest U-Boot source;
4618
Wolfgang Denk06682362008-12-30 22:56:11 +01004619 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004620
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004621 if (clueless)
4622 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk2729af92004-05-03 20:45:30 +00004624 while (learning) {
4625 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004626 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4627 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004628 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004629 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004630 }
wdenkc6097192002-11-03 00:24:07 +00004631
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004632 if (available_money > toLocalCurrency ($2500))
4633 Buy a BDI3000;
4634 else
wdenk2729af92004-05-03 20:45:30 +00004635 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004636
4637 if (a similar board exists) { /* hopefully... */
4638 cp -a board/<similar> board/<myboard>
4639 cp include/configs/<similar>.h include/configs/<myboard>.h
4640 } else {
4641 Create your own board support subdirectory;
4642 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004643 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004644 Edit new board/<myboard> files
4645 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004646
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004647 while (!accepted) {
4648 while (!running) {
4649 do {
4650 Add / modify source code;
4651 } until (compiles);
4652 Debug;
4653 if (clueless)
4654 email("Hi, I am having problems...");
4655 }
4656 Send patch file to the U-Boot email list;
4657 if (reasonable critiques)
4658 Incorporate improvements from email list code review;
4659 else
4660 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004661 }
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663 return 0;
4664}
4665
4666void no_more_time (int sig)
4667{
4668 hire_a_guru();
4669}
wdenkc6097192002-11-03 00:24:07 +00004670
4671
wdenk2729af92004-05-03 20:45:30 +00004672Coding Standards:
4673-----------------
wdenkc6097192002-11-03 00:24:07 +00004674
wdenk2729af92004-05-03 20:45:30 +00004675All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004676coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004677"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004678
Detlev Zundel2c051652006-09-01 15:39:02 +02004679Source files originating from a different project (for example the
4680MTD subsystem) are generally exempt from these guidelines and are not
4681reformated to ease subsequent migration to newer versions of those
4682sources.
4683
4684Please note that U-Boot is implemented in C (and to some small parts in
4685Assembler); no C++ is used, so please do not use C++ style comments (//)
4686in your code.
wdenk2729af92004-05-03 20:45:30 +00004687
4688Please also stick to the following formatting rules:
4689- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004690- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004691- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004692- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004693- do not add trailing empty lines to source files
4694
4695Submissions which do not conform to the standards may be returned
4696with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004697
4698
wdenk2729af92004-05-03 20:45:30 +00004699Submitting Patches:
4700-------------------
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702Since the number of patches for U-Boot is growing, we need to
4703establish some rules. Submissions which do not conform to these rules
4704may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004705
Magnus Lilja0d28f342008-08-06 19:32:33 +02004706Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004707
Wolfgang Denk06682362008-12-30 22:56:11 +01004708Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4709see http://lists.denx.de/mailman/listinfo/u-boot
4710
wdenk2729af92004-05-03 20:45:30 +00004711When you send a patch, please include the following information with
4712it:
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk2729af92004-05-03 20:45:30 +00004714* For bug fixes: a description of the bug and how your patch fixes
4715 this bug. Please try to include a way of demonstrating that the
4716 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718* For new features: a description of the feature and your
4719 implementation.
wdenkc6097192002-11-03 00:24:07 +00004720
wdenk2729af92004-05-03 20:45:30 +00004721* A CHANGELOG entry as plaintext (separate from the patch)
4722
4723* For major contributions, your entry to the CREDITS file
4724
4725* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004726 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004727
4728* If your patch adds new configuration options, don't forget to
4729 document these in the README file.
4730
Wolfgang Denk218ca722008-03-26 10:40:12 +01004731* The patch itself. If you are using git (which is *strongly*
4732 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004733 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004734 the U-Boot mailing list, you will avoid most of the common problems
4735 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004736
Wolfgang Denk218ca722008-03-26 10:40:12 +01004737 If you cannot use git, use "diff -purN OLD NEW". If your version of
4738 diff does not support these options, then get the latest version of
4739 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004740
Wolfgang Denk218ca722008-03-26 10:40:12 +01004741 The current directory when running this command shall be the parent
4742 directory of the U-Boot source tree (i. e. please make sure that
4743 your patch includes sufficient directory information for the
4744 affected files).
4745
4746 We prefer patches as plain text. MIME attachments are discouraged,
4747 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004748
4749* If one logical set of modifications affects or creates several
4750 files, all these changes shall be submitted in a SINGLE patch file.
4751
4752* Changesets that contain different, unrelated modifications shall be
4753 submitted as SEPARATE patches, one patch per changeset.
4754
4755
4756Notes:
4757
4758* Before sending the patch, run the MAKEALL script on your patched
4759 source tree and make sure that no errors or warnings are reported
4760 for any of the boards.
4761
4762* Keep your modifications to the necessary minimum: A patch
4763 containing several unrelated changes or arbitrary reformats will be
4764 returned with a request to re-formatting / split it.
4765
4766* If you modify existing code, make sure that your new code does not
4767 add to the memory footprint of the code ;-) Small is beautiful!
4768 When adding new features, these should compile conditionally only
4769 (using #ifdef), and the resulting code with the new feature
4770 disabled must not need more memory than the old code without your
4771 modification.
wdenk90dc6702005-05-03 14:12:25 +00004772
Wolfgang Denk06682362008-12-30 22:56:11 +01004773* Remember that there is a size limit of 100 kB per message on the
4774 u-boot mailing list. Bigger patches will be moderated. If they are
4775 reasonable and not too big, they will be acknowledged. But patches
4776 bigger than the size limit should be avoided.