blob: c05c40af0e58acc83e62feb1b7ff1e31cd75e526 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundel6aa4d7b2011-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
wdenkce4832c2004-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 Denkb240aef2008-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 Tyser8804a612008-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 Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschin08337f32008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000121
wdenk24ee89b2002-11-03 17:56:27 +0000122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
124
wdenkc6097192002-11-03 00:24:07 +0000125
wdenk7474aca2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000135
Thomas Webere89e6282010-09-28 08:06:25 +0200136Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-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
wdenk7474aca2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tysere4d1abc2010-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ßmannd9a9d562011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-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 Russcbfce1d2011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-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 Schwierzeckd52a6232011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Lin1cac36e2011-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 Tysere4d1abc2010-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 Roese88fbf932010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-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-VILLARD03836942008-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 Ziswilerabd8dcb2008-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips203fee32007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2bb11052003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-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
wdenk2bb11052003-07-17 23:16:40 +0000327
Lei Wen20014762011-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)
wdenk9b7f3842003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000352
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000359
Heiko Schocher734f0272009-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100377- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200378 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-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-VILLARD03836942008-10-16 15:01:15 +0200384 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200385
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100386 Defines the Monahans turbo mode to oscillator
387 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200388 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100389 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200390
Daniel Schwierzeckd52a6232011-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
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000437 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
438
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200439 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400443 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200444
445 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500452 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400453
Marcel Ziswilerb29bc712009-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 Denk27a5b0b2005-10-13 01:45:54 +0200458 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600459 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200460
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200461 boards with QUICC Engines require OF_QE to set UCC MAC
462 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500463
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000468
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500469 CONFIG_OF_BOOT_CPU
470
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200471 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500472 param header, the default value is zero if undefined.
473
Heiko Schocherffb293a2009-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 Grinberg06890672011-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 Giger0ab978d2008-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 V960f5c02011-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 V686a0752011-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
wdenkda04a8b2004-08-02 23:22:59 +0000522- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200523 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000524
525 Define this if you want support for Amba PrimeCell PL010 UARTs.
526
Andreas Engel0813b122008-09-08 14:30:53 +0200527 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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 Rigby34e21ee2011-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
wdenkda04a8b2004-08-02 23:22:59 +0000554
wdenkc6097192002-11-03 00:24:07 +0000555- Console Interface:
wdenk4a5c8a72003-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)
wdenk544e9732004-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)
wdenk544e9732004-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-VILLARD03836942008-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 Loeligerc1da5c92007-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
wdenk9dd2b882002-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200601 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000602 the logo
603
wdenk4a5c8a72003-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
wdenk1ebf41e2004-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.
wdenk3da587e2003-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-VILLARD03836942008-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 Schocher327480a2009-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 Schocher362447f2009-02-10 09:31:47 +0100622 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-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 Russ3c28f482011-09-01 00:48:27 +0000627- Pre-Console Buffer:
Wolfgang Denkd590fb12011-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 Denk23f78482011-10-09 21:06:34 +0200635 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200636 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000637
Wolfgang Denkd590fb12011-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 Russ3c28f482011-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
wdenk4a5c8a72003-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
wdenk4a5c8a72003-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 Ziswilerabd8dcb2008-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 Loeligerc1da5c92007-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-VILLARD03836942008-10-16 15:01:15 +0200704 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000705
706- Monitor Functions:
Jon Loeligerc1da5c92007-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 Loeligerc1da5c92007-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 Loeligerc1da5c92007-06-11 19:03:39 -0500717 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-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 Frysinger321ab9e2010-12-21 14:19:51 -0500725 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-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 Tyser15258042008-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 Loeligerc1da5c92007-06-11 19:03:39 -0500733 CONFIG_CMD_DTT * Digital Therm and Thermostat
734 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500735 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500736 CONFIG_CMD_EEPROM * EEPROM read/write support
737 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500738 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500739 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-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 Frysinger2ed02412010-12-26 23:32:22 -0500745 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000746 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-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 Frysingerf3ddf202010-12-26 23:09:45 -0500753 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeligerc1da5c92007-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 Frysingerfc6508a2010-12-26 12:34:49 -0500758 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500759 CONFIG_CMD_LOADB loadb
760 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400761 CONFIG_CMD_MD5SUM print md5 message digest
762 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeligerc1da5c92007-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 Roeseb1423dd2009-03-19 13:30:36 +0100768 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500769 CONFIG_CMD_NAND * NAND support
770 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600771 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000772 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-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 Holler37ef5392011-01-18 09:48:08 +0100786 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400787 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200788 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500789 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000790 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000791 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chioufd763002011-10-06 23:40:48 +0000792 CONFIG_CMD_TIME * run command and report execution time
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500793 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-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 Loeligerc1da5c92007-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 Barend6abef42007-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 Loeligerc1da5c92007-06-11 19:03:39 -0500808 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-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 Glass3d686442011-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 Glass5cb34db2011-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 Glass38d6b8d2011-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 Glass3d686442011-10-15 05:48:20 +0000836
Simon Glass5cb34db2011-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 Zundel6aa4d7b2011-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
stroeseb9c17c52003-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 Loeligerc1da5c92007-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 Liakhovetskid4387492008-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
wdenk1fe2c702003-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
wdenk0893c472003-05-20 14:25:27 +0000883 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000884 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100885 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000886 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200887 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200888 CONFIG_SYS_RV3029_TCR - enable trickle charger on
889 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000890
wdenkb9bbd242003-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 Tyser9902e422008-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 Packham9b383202010-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 Tyser9902e422008-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
wdenk4a5c8a72003-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 Loeligerc1da5c92007-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
richardretanubune6745592008-09-26 11:13:22 -0400914 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000915
Wolfgang Denkb240aef2008-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:
wdenk369d43d2004-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
wdenk369d43d2004-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
wdenkf602aa02004-03-13 23:29:43 +0000934- LBA48 Support
935 CONFIG_LBA48
936
937 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100938 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-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-VILLARD03836942008-10-16 15:01:15 +0200942 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-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-VILLARD03836942008-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-VILLARD03836942008-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):
wdenk4e112c12003-06-03 23:54:09 +0000959 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000960 Support for Intel 8254x/8257x gigabit chips.
961
962 CONFIG_E1000_SPI
963 Utility code for direct access to the SPI bus on Intel 8257x.
964 This does not do anything useful unless you set at least one
965 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
966
967 CONFIG_E1000_SPI_GENERIC
968 Allow generic access to the SPI bus on the Intel 8257x, for
969 example with the "sspi" command.
970
971 CONFIG_CMD_E1000
972 Management command for E1000 devices. When used on devices
973 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +0000974
Andre Schwarz68c2a302008-03-06 16:45:44 +0100975 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200976 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +0100977
wdenkc6097192002-11-03 00:24:07 +0000978 CONFIG_EEPRO100
979 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200980 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000981 write routine for first time initialisation.
982
983 CONFIG_TULIP
984 Support for Digital 2114x chips.
985 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
986 modem chip initialisation (KS8761/QS6611).
987
988 CONFIG_NATSEMI
989 Support for National dp83815 chips.
990
991 CONFIG_NS8382X
992 Support for National dp8382[01] gigabit chips.
993
wdenkaa603362003-05-12 21:50:16 +0000994- NETWORK Support (other):
995
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100996 CONFIG_DRIVER_AT91EMAC
997 Support for AT91RM9200 EMAC.
998
999 CONFIG_RMII
1000 Define this to use reduced MII inteface
1001
1002 CONFIG_DRIVER_AT91EMAC_QUIET
1003 If this defined, the driver is quiet.
1004 The driver doen't show link status messages.
1005
wdenkaa603362003-05-12 21:50:16 +00001006 CONFIG_DRIVER_LAN91C96
1007 Support for SMSC's LAN91C96 chips.
1008
1009 CONFIG_LAN91C96_BASE
1010 Define this to hold the physical address
1011 of the LAN91C96's I/O space
1012
1013 CONFIG_LAN91C96_USE_32_BIT
1014 Define this to enable 32 bit addressing
1015
wdenk3c711762004-06-09 13:37:52 +00001016 CONFIG_DRIVER_SMC91111
1017 Support for SMSC's LAN91C111 chip
1018
1019 CONFIG_SMC91111_BASE
1020 Define this to hold the physical address
1021 of the device (I/O space)
1022
1023 CONFIG_SMC_USE_32_BIT
1024 Define this if data bus is 32 bits
1025
1026 CONFIG_SMC_USE_IOFUNCS
1027 Define this to use i/o functions instead of macros
1028 (some hardware wont work with macros)
1029
Macpaul Lin199c6252010-12-21 16:59:46 +08001030 CONFIG_FTGMAC100
1031 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1032
1033 CONFIG_FTGMAC100_EGIGA
1034 Define this to use GE link update with gigabit PHY.
1035 Define this if FTGMAC100 is connected to gigabit PHY.
1036 If your system has 10/100 PHY only, it might not occur
1037 wrong behavior. Because PHY usually return timeout or
1038 useless data when polling gigabit status and gigabit
1039 control registers. This behavior won't affect the
1040 correctnessof 10/100 link speed update.
1041
Mike Rapoportf4761af2009-11-11 10:03:03 +02001042 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001043 Support for SMSC's LAN911x and LAN921x chips
1044
Mike Rapoportf4761af2009-11-11 10:03:03 +02001045 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001046 Define this to hold the physical address
1047 of the device (I/O space)
1048
Mike Rapoportf4761af2009-11-11 10:03:03 +02001049 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001050 Define this if data bus is 32 bits
1051
Mike Rapoportf4761af2009-11-11 10:03:03 +02001052 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001053 Define this if data bus is 16 bits. If your processor
1054 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001055 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001056
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001057 CONFIG_SH_ETHER
1058 Support for Renesas on-chip Ethernet controller
1059
1060 CONFIG_SH_ETHER_USE_PORT
1061 Define the number of ports to be used
1062
1063 CONFIG_SH_ETHER_PHY_ADDR
1064 Define the ETH PHY's address
1065
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001066 CONFIG_SH_ETHER_CACHE_WRITEBACK
1067 If this option is set, the driver enables cache flush.
1068
wdenkc6097192002-11-03 00:24:07 +00001069- USB Support:
1070 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001071 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001072 CONFIG_USB_UHCI to enable it.
1073 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001074 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001075 storage devices.
1076 Note:
1077 Supported are USB Keyboards and USB Floppy drives
1078 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001079 MPC5200 USB requires additional defines:
1080 CONFIG_USB_CLOCK
1081 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001082 CONFIG_PSC3_USB
1083 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001084 CONFIG_USB_CONFIG
1085 for differential drivers: 0x00001000
1086 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001087 for differential drivers on PSC3: 0x00000100
1088 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001089 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001090 May be defined to allow interrupt polling
1091 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001092
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001093- USB Device:
1094 Define the below if you wish to use the USB console.
1095 Once firmware is rebuilt from a serial console issue the
1096 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001097 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001098 it has found a new device. The environment variable usbtty
1099 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001100 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001101 Common Device Class Abstract Control Model serial device.
1102 If you select usbtty = gserial you should be able to enumerate
1103 a Linux host by
1104 # modprobe usbserial vendor=0xVendorID product=0xProductID
1105 else if using cdc_acm, simply setting the environment
1106 variable usbtty to be cdc_acm should suffice. The following
1107 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001108
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001109 CONFIG_USB_DEVICE
1110 Define this to build a UDC device
1111
1112 CONFIG_USB_TTY
1113 Define this to have a tty type of device available to
1114 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001116 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001117 Define this if you want stdin, stdout &/or stderr to
1118 be set to usbtty.
1119
1120 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001121 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001122 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001123 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001125 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001126 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001127 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001128
Wolfgang Denke2601822006-06-14 18:14:56 +02001129 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001130 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001131 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001132 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1133 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1134 should pretend to be a Linux device to it's target host.
1135
1136 CONFIG_USBD_MANUFACTURER
1137 Define this string as the name of your company for
1138 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001139
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001140 CONFIG_USBD_PRODUCT_NAME
1141 Define this string as the name of your product
1142 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001143
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001144 CONFIG_USBD_VENDORID
1145 Define this as your assigned Vendor ID from the USB
1146 Implementors Forum. This *must* be a genuine Vendor ID
1147 to avoid polluting the USB namespace.
1148 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001149
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001150 CONFIG_USBD_PRODUCTID
1151 Define this as the unique Product ID
1152 for your device
1153 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001154
wdenkc6097192002-11-03 00:24:07 +00001155
wdenk7a428cc2003-06-15 22:40:42 +00001156- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001157 The MMC controller on the Intel PXA is supported. To
1158 enable this define CONFIG_MMC. The MMC can be
1159 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001160 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001161 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1162 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001163
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001164 CONFIG_SH_MMCIF
1165 Support for Renesas on-chip MMCIF controller
1166
1167 CONFIG_SH_MMCIF_ADDR
1168 Define the base address of MMCIF registers
1169
1170 CONFIG_SH_MMCIF_CLK
1171 Define the clock frequency for MMCIF
1172
wdenkda04a8b2004-08-02 23:22:59 +00001173- Journaling Flash filesystem support:
1174 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1175 CONFIG_JFFS2_NAND_DEV
1176 Define these for a default partition on a NAND device
1177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001178 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1179 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001180 Define these for a default partition on a NOR device
1181
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001182 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001183 Define this to create an own partition. You have to provide a
1184 function struct part_info* jffs2_part_info(int part_num)
1185
1186 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001187 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001188 to disable the command chpart. This is the default when you
1189 have not defined a custom partition
1190
Donggeun Kim8f814002011-10-24 21:15:28 +00001191- FAT(File Allocation Table) filesystem write function support:
1192 CONFIG_FAT_WRITE
1193 Support for saving memory data as a file
1194 in FAT formatted partition
1195
wdenkc6097192002-11-03 00:24:07 +00001196- Keyboard Support:
1197 CONFIG_ISA_KEYBOARD
1198
1199 Define this to enable standard (PC-Style) keyboard
1200 support
1201
1202 CONFIG_I8042_KBD
1203 Standard PC keyboard driver with US (is default) and
1204 GERMAN key layout (switch via environment 'keymap=de') support.
1205 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1206 for cfb_console. Supports cursor blinking.
1207
1208- Video support:
1209 CONFIG_VIDEO
1210
1211 Define this to enable video support (for output to
1212 video).
1213
1214 CONFIG_VIDEO_CT69000
1215
1216 Enable Chips & Technologies 69000 Video chip
1217
1218 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001219 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001220 video output is selected via environment 'videoout'
1221 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1222 assumed.
wdenkc6097192002-11-03 00:24:07 +00001223
wdenkd3602132004-03-25 15:14:43 +00001224 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001225 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001226 are possible:
1227 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001228 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001229
1230 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1231 -------------+---------------------------------------------
1232 8 bits | 0x301* 0x303 0x305 0x161 0x307
1233 15 bits | 0x310 0x313 0x316 0x162 0x319
1234 16 bits | 0x311 0x314 0x317 0x163 0x31A
1235 24 bits | 0x312 0x315 0x318 ? 0x31B
1236 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001237 (i.e. setenv videomode 317; saveenv; reset;)
1238
wdenkd3602132004-03-25 15:14:43 +00001239 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001240 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001241
1242
stroeseb9c17c52003-04-04 15:53:41 +00001243 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001244 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001245 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1246 or CONFIG_VIDEO_SED13806_16BPP
1247
Timur Tabi020edd22011-02-15 17:09:19 -06001248 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001249 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001250 SOCs that have a DIU should define this macro to enable DIU
1251 support, and should also define these other macros:
1252
1253 CONFIG_SYS_DIU_ADDR
1254 CONFIG_VIDEO
1255 CONFIG_CMD_BMP
1256 CONFIG_CFB_CONSOLE
1257 CONFIG_VIDEO_SW_CURSOR
1258 CONFIG_VGA_AS_SINGLE_DEVICE
1259 CONFIG_VIDEO_LOGO
1260 CONFIG_VIDEO_BMP_LOGO
1261
Timur Tabi32f709e2011-04-11 14:18:22 -05001262 The DIU driver will look for the 'video-mode' environment
1263 variable, and if defined, enable the DIU as a console during
1264 boot. See the documentation file README.video for a
1265 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001266
wdenk4e112c12003-06-03 23:54:09 +00001267- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001268 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001269
wdenk57b2d802003-06-27 21:31:46 +00001270 Define this to enable a custom keyboard support.
1271 This simply calls drv_keyboard_init() which must be
1272 defined in your board-specific files.
1273 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001274
wdenkc6097192002-11-03 00:24:07 +00001275- LCD Support: CONFIG_LCD
1276
1277 Define this to enable LCD support (for output to LCD
1278 display); also select one of the supported displays
1279 by defining one of these:
1280
Stelian Popf6f86652008-05-09 21:57:18 +02001281 CONFIG_ATMEL_LCD:
1282
1283 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1284
wdenkc0d54ae2003-11-25 16:55:19 +00001285 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001286
wdenkc0d54ae2003-11-25 16:55:19 +00001287 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001288
wdenkc0d54ae2003-11-25 16:55:19 +00001289 CONFIG_NEC_NL6448BC20
1290
1291 NEC NL6448BC20-08. 6.5", 640x480.
1292 Active, color, single scan.
1293
1294 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001295
wdenkc0d54ae2003-11-25 16:55:19 +00001296 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001297 Active, color, single scan.
1298
1299 CONFIG_SHARP_16x9
1300
1301 Sharp 320x240. Active, color, single scan.
1302 It isn't 16x9, and I am not sure what it is.
1303
1304 CONFIG_SHARP_LQ64D341
1305
1306 Sharp LQ64D341 display, 640x480.
1307 Active, color, single scan.
1308
1309 CONFIG_HLD1045
1310
1311 HLD1045 display, 640x480.
1312 Active, color, single scan.
1313
1314 CONFIG_OPTREX_BW
1315
1316 Optrex CBL50840-2 NF-FW 99 22 M5
1317 or
1318 Hitachi LMG6912RPFC-00T
1319 or
1320 Hitachi SP14Q002
1321
1322 320x240. Black & white.
1323
1324 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001325 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001326
wdenkeb20ad32003-09-05 23:19:14 +00001327- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001328
wdenk57b2d802003-06-27 21:31:46 +00001329 If this option is set, the environment is checked for
1330 a variable "splashimage". If found, the usual display
1331 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001332 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001333 specified in "splashimage" is loaded instead. The
1334 console is redirected to the "nulldev", too. This
1335 allows for a "silent" boot where a splash screen is
1336 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001337
Matthias Weisser53884182009-07-09 16:07:30 +02001338 CONFIG_SPLASH_SCREEN_ALIGN
1339
1340 If this option is set the splash image can be freely positioned
1341 on the screen. Environment variable "splashpos" specifies the
1342 position as "x,y". If a positive number is given it is used as
1343 number of pixel from left/top. If a negative number is given it
1344 is used as number of pixel from right/bottom. You can also
1345 specify 'm' for centering the image.
1346
1347 Example:
1348 setenv splashpos m,m
1349 => image at center of screen
1350
1351 setenv splashpos 30,20
1352 => image at x = 30 and y = 20
1353
1354 setenv splashpos -10,m
1355 => vertically centered image
1356 at x = dspWidth - bmpWidth - 9
1357
Stefan Roesed9d97742005-09-22 09:04:17 +02001358- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1359
1360 If this option is set, additionally to standard BMP
1361 images, gzipped BMP images can be displayed via the
1362 splashscreen support or the bmp command.
1363
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001364- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1365
1366 If this option is set, 8-bit RLE compressed BMP images
1367 can be displayed via the splashscreen support or the
1368 bmp command.
1369
wdenk710e3502003-08-29 20:57:53 +00001370- Compression support:
1371 CONFIG_BZIP2
1372
1373 If this option is set, support for bzip2 compressed
1374 images is included. If not, only uncompressed and gzip
1375 compressed images are supported.
1376
wdenk9c53f402003-10-15 23:53:47 +00001377 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001378 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001379 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001380
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001381 CONFIG_LZMA
1382
1383 If this option is set, support for lzma compressed
1384 images is included.
1385
1386 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1387 requires an amount of dynamic memory that is given by the
1388 formula:
1389
1390 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1391
1392 Where lc and lp stand for, respectively, Literal context bits
1393 and Literal pos bits.
1394
1395 This value is upper-bounded by 14MB in the worst case. Anyway,
1396 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1397 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1398 a very small buffer.
1399
1400 Use the lzmainfo tool to determinate the lc and lp values and
1401 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001402 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001403
wdenk0e2bd9c2004-06-06 21:51:03 +00001404- MII/PHY support:
1405 CONFIG_PHY_ADDR
1406
1407 The address of PHY on MII bus.
1408
1409 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1410
1411 The clock frequency of the MII bus
1412
1413 CONFIG_PHY_GIGE
1414
1415 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001416 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001417
1418 CONFIG_PHY_RESET_DELAY
1419
1420 Some PHY like Intel LXT971A need extra delay after
1421 reset before any MII register access is possible.
1422 For such PHY, set this option to the usec delay
1423 required. (minimum 300usec for LXT971A)
1424
1425 CONFIG_PHY_CMD_DELAY (ppc4xx)
1426
1427 Some PHY like Intel LXT971A need extra delay after
1428 command issued before MII status register can be read
1429
wdenkc6097192002-11-03 00:24:07 +00001430- Ethernet address:
1431 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001432 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001433 CONFIG_ETH2ADDR
1434 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001435 CONFIG_ETH4ADDR
1436 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001437
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001438 Define a default value for Ethernet address to use
1439 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001440 is not determined automatically.
1441
1442- IP address:
1443 CONFIG_IPADDR
1444
1445 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001446 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001447 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001448 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001449
1450- Server IP address:
1451 CONFIG_SERVERIP
1452
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001453 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001454 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001455 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001456
Robin Getz470a6d42009-07-21 12:15:28 -04001457 CONFIG_KEEP_SERVERADDR
1458
1459 Keeps the server's MAC address, in the env 'serveraddr'
1460 for passing to bootargs (like Linux's netconsole option)
1461
Wolfgang Denk26da2992011-10-26 10:21:22 +00001462- Gateway IP address:
1463 CONFIG_GATEWAYIP
1464
1465 Defines a default value for the IP address of the
1466 default router where packets to other networks are
1467 sent to.
1468 (Environment variable "gatewayip")
1469
1470- Subnet mask:
1471 CONFIG_NETMASK
1472
1473 Defines a default value for the subnet mask (or
1474 routing prefix) which is used to determine if an IP
1475 address belongs to the local subnet or needs to be
1476 forwarded through a router.
1477 (Environment variable "netmask")
1478
David Updegraff7280da72007-06-11 10:41:07 -05001479- Multicast TFTP Mode:
1480 CONFIG_MCAST_TFTP
1481
1482 Defines whether you want to support multicast TFTP as per
1483 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001484 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001485 driver in use must provide a function: mcast() to join/leave a
1486 multicast group.
1487
wdenkc6097192002-11-03 00:24:07 +00001488- BOOTP Recovery Mode:
1489 CONFIG_BOOTP_RANDOM_DELAY
1490
1491 If you have many targets in a network that try to
1492 boot using BOOTP, you may want to avoid that all
1493 systems send out BOOTP requests at precisely the same
1494 moment (which would happen for instance at recovery
1495 from a power failure, when all systems will try to
1496 boot, thus flooding the BOOTP server. Defining
1497 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1498 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001499 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001500
1501 1st BOOTP request: delay 0 ... 1 sec
1502 2nd BOOTP request: delay 0 ... 2 sec
1503 3rd BOOTP request: delay 0 ... 4 sec
1504 4th and following
1505 BOOTP requests: delay 0 ... 8 sec
1506
stroesee0aadfb2003-08-28 14:17:32 +00001507- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001508 You can fine tune the DHCP functionality by defining
1509 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001510
Jon Loeliger5336a762007-07-09 22:08:34 -05001511 CONFIG_BOOTP_SUBNETMASK
1512 CONFIG_BOOTP_GATEWAY
1513 CONFIG_BOOTP_HOSTNAME
1514 CONFIG_BOOTP_NISDOMAIN
1515 CONFIG_BOOTP_BOOTPATH
1516 CONFIG_BOOTP_BOOTFILESIZE
1517 CONFIG_BOOTP_DNS
1518 CONFIG_BOOTP_DNS2
1519 CONFIG_BOOTP_SEND_HOSTNAME
1520 CONFIG_BOOTP_NTPSERVER
1521 CONFIG_BOOTP_TIMEOFFSET
1522 CONFIG_BOOTP_VENDOREX
stroesee0aadfb2003-08-28 14:17:32 +00001523
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001524 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1525 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001526
1527 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1528 serverip from a DHCP server, it is possible that more
1529 than one DNS serverip is offered to the client.
1530 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1531 serverip will be stored in the additional environment
1532 variable "dnsip2". The first DNS serverip is always
1533 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001534 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001535
1536 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1537 to do a dynamic update of a DNS server. To do this, they
1538 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001539 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001540 of the "hostname" environment variable is passed as
1541 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001542
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001543 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1544
1545 A 32bit value in microseconds for a delay between
1546 receiving a "DHCP Offer" and sending the "DHCP Request".
1547 This fixes a problem with certain DHCP servers that don't
1548 respond 100% of the time to a "DHCP request". E.g. On an
1549 AT91RM9200 processor running at 180MHz, this delay needed
1550 to be *at least* 15,000 usec before a Windows Server 2003
1551 DHCP server would reply 100% of the time. I recommend at
1552 least 50,000 usec to be safe. The alternative is to hope
1553 that one of the retries will be successful but note that
1554 the DHCP timeout and retry process takes a longer than
1555 this delay.
1556
wdenk145d2c12004-04-15 21:48:45 +00001557 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001558 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001559
1560 The device id used in CDP trigger frames.
1561
1562 CONFIG_CDP_DEVICE_ID_PREFIX
1563
1564 A two character string which is prefixed to the MAC address
1565 of the device.
1566
1567 CONFIG_CDP_PORT_ID
1568
1569 A printf format string which contains the ascii name of
1570 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001571 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001572
1573 CONFIG_CDP_CAPABILITIES
1574
1575 A 32bit integer which indicates the device capabilities;
1576 0x00000010 for a normal host which does not forwards.
1577
1578 CONFIG_CDP_VERSION
1579
1580 An ascii string containing the version of the software.
1581
1582 CONFIG_CDP_PLATFORM
1583
1584 An ascii string containing the name of the platform.
1585
1586 CONFIG_CDP_TRIGGER
1587
1588 A 32bit integer sent on the trigger.
1589
1590 CONFIG_CDP_POWER_CONSUMPTION
1591
1592 A 16bit integer containing the power consumption of the
1593 device in .1 of milliwatts.
1594
1595 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1596
1597 A byte containing the id of the VLAN.
1598
wdenkc6097192002-11-03 00:24:07 +00001599- Status LED: CONFIG_STATUS_LED
1600
1601 Several configurations allow to display the current
1602 status using a LED. For instance, the LED will blink
1603 fast while running U-Boot code, stop blinking as
1604 soon as a reply to a BOOTP request was received, and
1605 start blinking slow once the Linux kernel is running
1606 (supported by a status LED driver in the Linux
1607 kernel). Defining CONFIG_STATUS_LED enables this
1608 feature in U-Boot.
1609
1610- CAN Support: CONFIG_CAN_DRIVER
1611
1612 Defining CONFIG_CAN_DRIVER enables CAN driver support
1613 on those systems that support this (optional)
1614 feature, like the TQM8xxL modules.
1615
1616- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1617
wdenkb9bbd242003-06-30 16:24:52 +00001618 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001619 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001620 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001621
wdenk21136db2003-07-16 21:53:01 +00001622 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001623 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001624 CONFIG_COMMANDS) and communicate with i2c based realtime
1625 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001626 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001627
Ben Warren45657152006-09-07 16:50:54 -04001628 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001629
wdenk21136db2003-07-16 21:53:01 +00001630 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001631 bit-banging) driver instead of CPM or similar hardware
1632 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001633
wdenk21136db2003-07-16 21:53:01 +00001634 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001635 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001637 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001638 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001639 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001640 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001641
Peter Tysere4d1abc2010-04-12 22:28:21 -05001642 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001643 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001644 and so its address should therefore be cleared to 0 (See,
1645 eg, MPC823e User's Manual p.16-473). So, set
1646 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001647
Eric Millbrandt12990a42009-09-03 08:09:44 -05001648 CONFIG_SYS_I2C_INIT_MPC5XXX
1649
1650 When a board is reset during an i2c bus transfer
1651 chips might think that the current transfer is still
1652 in progress. Reset the slave devices by sending start
1653 commands until the slave device responds.
1654
wdenk21136db2003-07-16 21:53:01 +00001655 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001656
wdenkb9bbd242003-06-30 16:24:52 +00001657 If you use the software i2c interface (CONFIG_SOFT_I2C)
1658 then the following macros need to be defined (examples are
1659 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001660
1661 I2C_INIT
1662
wdenkb9bbd242003-06-30 16:24:52 +00001663 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001664 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001665
wdenk544e9732004-02-06 23:19:44 +00001666 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001667
wdenkc6097192002-11-03 00:24:07 +00001668 I2C_PORT
1669
wdenk4a5c8a72003-03-06 00:02:04 +00001670 (Only for MPC8260 CPU). The I/O port to use (the code
1671 assumes both bits are on the same port). Valid values
1672 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001673
1674 I2C_ACTIVE
1675
1676 The code necessary to make the I2C data line active
1677 (driven). If the data line is open collector, this
1678 define can be null.
1679
wdenkb9bbd242003-06-30 16:24:52 +00001680 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1681
wdenkc6097192002-11-03 00:24:07 +00001682 I2C_TRISTATE
1683
1684 The code necessary to make the I2C data line tri-stated
1685 (inactive). If the data line is open collector, this
1686 define can be null.
1687
wdenkb9bbd242003-06-30 16:24:52 +00001688 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1689
wdenkc6097192002-11-03 00:24:07 +00001690 I2C_READ
1691
1692 Code that returns TRUE if the I2C data line is high,
1693 FALSE if it is low.
1694
wdenkb9bbd242003-06-30 16:24:52 +00001695 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1696
wdenkc6097192002-11-03 00:24:07 +00001697 I2C_SDA(bit)
1698
1699 If <bit> is TRUE, sets the I2C data line high. If it
1700 is FALSE, it clears it (low).
1701
wdenkb9bbd242003-06-30 16:24:52 +00001702 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001703 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001704 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001705
wdenkc6097192002-11-03 00:24:07 +00001706 I2C_SCL(bit)
1707
1708 If <bit> is TRUE, sets the I2C clock line high. If it
1709 is FALSE, it clears it (low).
1710
wdenkb9bbd242003-06-30 16:24:52 +00001711 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001712 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001713 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001714
wdenkc6097192002-11-03 00:24:07 +00001715 I2C_DELAY
1716
1717 This delay is invoked four times per clock cycle so this
1718 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001719 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001720 like:
1721
wdenkb9bbd242003-06-30 16:24:52 +00001722 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001723
Mike Frysingeree12d542010-07-21 13:38:02 -04001724 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1725
1726 If your arch supports the generic GPIO framework (asm/gpio.h),
1727 then you may alternatively define the two GPIOs that are to be
1728 used as SCL / SDA. Any of the previous I2C_xxx macros will
1729 have GPIO-based defaults assigned to them as appropriate.
1730
1731 You should define these to the GPIO value as given directly to
1732 the generic GPIO functions.
1733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001734 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001735
wdenk57b2d802003-06-27 21:31:46 +00001736 When a board is reset during an i2c bus transfer
1737 chips might think that the current transfer is still
1738 in progress. On some boards it is possible to access
1739 the i2c SCLK line directly, either by using the
1740 processor pin as a GPIO or by having a second pin
1741 connected to the bus. If this option is defined a
1742 custom i2c_init_board() routine in boards/xxx/board.c
1743 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001744
Richard Retanubundf0149c2010-04-12 15:08:17 -04001745 CONFIG_SYS_I2C_BOARD_LATE_INIT
1746
1747 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1748 defined a custom i2c_board_late_init() routine in
1749 boards/xxx/board.c is run AFTER the operations in i2c_init()
1750 is completed. This callpoint can be used to unreset i2c bus
1751 using CPU i2c controller register accesses for CPUs whose i2c
1752 controller provide such a method. It is called at the end of
1753 i2c_init() to allow i2c_init operations to setup the i2c bus
1754 controller on the CPU (e.g. setting bus speed & slave address).
1755
wdenk0e2bd9c2004-06-06 21:51:03 +00001756 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1757
1758 This option enables configuration of bi_iic_fast[] flags
1759 in u-boot bd_info structure based on u-boot environment
1760 variable "i2cfast". (see also i2cfast)
1761
Ben Warren45657152006-09-07 16:50:54 -04001762 CONFIG_I2C_MULTI_BUS
1763
1764 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001765 must have a controller. At any point in time, only one bus is
1766 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001767 Note that bus numbering is zero-based.
1768
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001769 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001770
1771 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001772 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001773 is set, specify a list of bus-device pairs. Otherwise, specify
1774 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001775
1776 e.g.
1777 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001778 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001779
1780 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1781
Wolfgang Denk092ae952011-10-26 10:21:21 +00001782 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001783 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001784
1785 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001787 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001788
1789 If defined, then this indicates the I2C bus number for DDR SPD.
1790 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001792 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001793
1794 If defined, then this indicates the I2C bus number for the RTC.
1795 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1796
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001797 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001798
1799 If defined, then this indicates the I2C bus number for the DTT.
1800 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001802 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001803
1804 If defined, specifies the I2C address of the DTT device.
1805 If not defined, then U-Boot uses predefined value for
1806 specified DTT device.
1807
Timur Tabiab347542006-11-03 19:15:00 -06001808 CONFIG_FSL_I2C
1809
1810 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01001811 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06001812
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001813 CONFIG_I2C_MUX
1814
1815 Define this option if you have I2C devices reached over 1 .. n
1816 I2C Muxes like the pca9544a. This option addes a new I2C
1817 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1818 new I2C Bus to the existing I2C Busses. If you select the
1819 new Bus with "i2c dev", u-bbot sends first the commandos for
1820 the muxes to activate this new "bus".
1821
1822 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1823 feature!
1824
1825 Example:
1826 Adding a new I2C Bus reached over 2 pca9544a muxes
1827 The First mux with address 70 and channel 6
1828 The Second mux with address 71 and channel 4
1829
1830 => i2c bus pca9544a:70:6:pca9544a:71:4
1831
1832 Use the "i2c bus" command without parameter, to get a list
1833 of I2C Busses with muxes:
1834
1835 => i2c bus
1836 Busses reached over muxes:
1837 Bus ID: 2
1838 reached over Mux(es):
1839 pca9544a@70 ch: 4
1840 Bus ID: 3
1841 reached over Mux(es):
1842 pca9544a@70 ch: 6
1843 pca9544a@71 ch: 4
1844 =>
1845
1846 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00001847 u-boot first sends the command to the mux@70 to enable
1848 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001849 the channel 4.
1850
1851 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00001852 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001853 the 2 muxes.
1854
1855 This option is actually implemented for the bitbanging
1856 algorithm in common/soft_i2c.c and for the Hardware I2C
1857 Bus on the MPC8260. But it should be not so difficult
1858 to add this option to other architectures.
1859
Andrew Dyer58c41f92008-12-29 17:36:01 -06001860 CONFIG_SOFT_I2C_READ_REPEATED_START
1861
1862 defining this will force the i2c_read() function in
1863 the soft_i2c driver to perform an I2C repeated start
1864 between writing the address pointer and reading the
1865 data. If this define is omitted the default behaviour
1866 of doing a stop-start sequence will be used. Most I2C
1867 devices can use either method, but some require one or
1868 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001869
wdenkc6097192002-11-03 00:24:07 +00001870- SPI Support: CONFIG_SPI
1871
1872 Enables SPI driver (so far only tested with
1873 SPI EEPROM, also an instance works with Crystal A/D and
1874 D/As on the SACSng board)
1875
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09001876 CONFIG_SH_SPI
1877
1878 Enables the driver for SPI controller on SuperH. Currently
1879 only SH7757 is supported.
1880
wdenkc6097192002-11-03 00:24:07 +00001881 CONFIG_SPI_X
1882
1883 Enables extended (16-bit) SPI EEPROM addressing.
1884 (symmetrical to CONFIG_I2C_X)
1885
1886 CONFIG_SOFT_SPI
1887
wdenk4a5c8a72003-03-06 00:02:04 +00001888 Enables a software (bit-bang) SPI driver rather than
1889 using hardware support. This is a general purpose
1890 driver that only requires three general I/O port pins
1891 (two outputs, one input) to function. If this is
1892 defined, the board configuration must define several
1893 SPI configuration items (port pins to use, etc). For
1894 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001895
Ben Warren7efe9272008-01-16 22:37:35 -05001896 CONFIG_HARD_SPI
1897
1898 Enables a hardware SPI driver for general-purpose reads
1899 and writes. As with CONFIG_SOFT_SPI, the board configuration
1900 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00001901 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05001902 example, see include/configs/mpc8349emds.h.
1903
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001904 CONFIG_MXC_SPI
1905
1906 Enables the driver for the SPI controllers on i.MX and MXC
1907 SoCs. Currently only i.MX31 is supported.
1908
Matthias Fuchsa4400872007-12-27 17:12:34 +01001909- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001910
Matthias Fuchsa4400872007-12-27 17:12:34 +01001911 Enables FPGA subsystem.
1912
1913 CONFIG_FPGA_<vendor>
1914
1915 Enables support for specific chip vendors.
1916 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001917
Matthias Fuchsa4400872007-12-27 17:12:34 +01001918 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001919
Matthias Fuchsa4400872007-12-27 17:12:34 +01001920 Enables support for FPGA family.
1921 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1922
1923 CONFIG_FPGA_COUNT
1924
1925 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001926
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001927 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001928
wdenk57b2d802003-06-27 21:31:46 +00001929 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001931 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001932
wdenk4a5c8a72003-03-06 00:02:04 +00001933 Enable checks on FPGA configuration interface busy
1934 status by the configuration function. This option
1935 will require a board or device specific function to
1936 be written.
wdenkc6097192002-11-03 00:24:07 +00001937
1938 CONFIG_FPGA_DELAY
1939
1940 If defined, a function that provides delays in the FPGA
1941 configuration driver.
1942
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001943 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001944 Allow Control-C to interrupt FPGA configuration
1945
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001946 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001947
wdenk4a5c8a72003-03-06 00:02:04 +00001948 Check for configuration errors during FPGA bitfile
1949 loading. For example, abort during Virtex II
1950 configuration if the INIT_B line goes low (which
1951 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001953 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001954
wdenk4a5c8a72003-03-06 00:02:04 +00001955 Maximum time to wait for the INIT_B line to deassert
1956 after PROB_B has been deasserted during a Virtex II
1957 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001958 ms.
wdenkc6097192002-11-03 00:24:07 +00001959
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001960 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001961
wdenk4a5c8a72003-03-06 00:02:04 +00001962 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001963 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001964
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001965 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001966
wdenk4a5c8a72003-03-06 00:02:04 +00001967 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001968 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001969
1970- Configuration Management:
1971 CONFIG_IDENT_STRING
1972
wdenk4a5c8a72003-03-06 00:02:04 +00001973 If defined, this string will be added to the U-Boot
1974 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001975
1976- Vendor Parameter Protection:
1977
wdenk4a5c8a72003-03-06 00:02:04 +00001978 U-Boot considers the values of the environment
1979 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001980 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001981 are set once by the board vendor / manufacturer, and
1982 protects these variables from casual modification by
1983 the user. Once set, these variables are read-only,
1984 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001985 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001986
1987 If CONFIG_ENV_OVERWRITE is #defined in your config
1988 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001989 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001990 these parameters.
1991
1992 Alternatively, if you #define _both_ CONFIG_ETHADDR
1993 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001994 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001995 which can be changed exactly ONCE by the user. [The
1996 serial# is unaffected by this, i. e. it remains
1997 read-only.]
1998
1999- Protected RAM:
2000 CONFIG_PRAM
2001
2002 Define this variable to enable the reservation of
2003 "protected RAM", i. e. RAM which is not overwritten
2004 by U-Boot. Define CONFIG_PRAM to hold the number of
2005 kB you want to reserve for pRAM. You can overwrite
2006 this default value by defining an environment
2007 variable "pram" to the number of kB you want to
2008 reserve. Note that the board info structure will
2009 still show the full amount of RAM. If pRAM is
2010 reserved, a new environment variable "mem" will
2011 automatically be defined to hold the amount of
2012 remaining RAM in a form that can be passed as boot
2013 argument to Linux, for instance like that:
2014
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002015 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002016 saveenv
2017
2018 This way you can tell Linux not to use this memory,
2019 either, which results in a memory region that will
2020 not be affected by reboots.
2021
2022 *WARNING* If your board configuration uses automatic
2023 detection of the RAM size, you must make sure that
2024 this memory test is non-destructive. So far, the
2025 following board configurations are known to be
2026 "pRAM-clean":
2027
2028 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2029 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002030 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002031
2032- Error Recovery:
2033 CONFIG_PANIC_HANG
2034
2035 Define this variable to stop the system in case of a
2036 fatal error, so that you have to reset it manually.
2037 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002038 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002039 automatically as fast as possible, but it may be
2040 useful during development since you can try to debug
2041 the conditions that lead to the situation.
2042
2043 CONFIG_NET_RETRY_COUNT
2044
wdenk4a5c8a72003-03-06 00:02:04 +00002045 This variable defines the number of retries for
2046 network operations like ARP, RARP, TFTP, or BOOTP
2047 before giving up the operation. If not defined, a
2048 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002049
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002050 CONFIG_ARP_TIMEOUT
2051
2052 Timeout waiting for an ARP reply in milliseconds.
2053
wdenkc6097192002-11-03 00:24:07 +00002054- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002055 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002056
2057 Enable auto completion of commands using TAB.
2058
Wolfgang Denk018147d2006-11-27 15:32:42 +01002059 Note that this feature has NOT been implemented yet
2060 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002061
2062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002063 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002064
2065 Define this variable to enable the "hush" shell (from
2066 Busybox) as command line interpreter, thus enabling
2067 powerful command line syntax like
2068 if...then...else...fi conditionals or `&&' and '||'
2069 constructs ("shell scripts").
2070
2071 If undefined, you get the old, much simpler behaviour
2072 with a somewhat smaller memory footprint.
2073
2074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002075 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002076
2077 This defines the secondary prompt string, which is
2078 printed when the command interpreter needs more input
2079 to complete a command. Usually "> ".
2080
2081 Note:
2082
wdenk57b2d802003-06-27 21:31:46 +00002083 In the current implementation, the local variables
2084 space and global environment variables space are
2085 separated. Local variables are those you define by
2086 simply typing `name=value'. To access a local
2087 variable later on, you have write `$name' or
2088 `${name}'; to execute the contents of a variable
2089 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002090
wdenk4a5c8a72003-03-06 00:02:04 +00002091 Global environment variables are those you use
2092 setenv/printenv to work with. To run a command stored
2093 in such a variable, you need to use the run command,
2094 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002095
2096 To store commands and special characters in a
2097 variable, please use double quotation marks
2098 surrounding the whole text of the variable, instead
2099 of the backslashes before semicolons and special
2100 symbols.
2101
Wolfgang Denk2039a072006-07-21 11:35:21 +02002102- Commandline Editing and History:
2103 CONFIG_CMDLINE_EDITING
2104
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002105 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002106 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002107
wdenkc0aa5c52003-12-06 19:49:23 +00002108- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002109 CONFIG_EXTRA_ENV_SETTINGS
2110
wdenk4a5c8a72003-03-06 00:02:04 +00002111 Define this to contain any number of null terminated
2112 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002113 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002114
wdenk4a5c8a72003-03-06 00:02:04 +00002115 For example, place something like this in your
2116 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002117
2118 #define CONFIG_EXTRA_ENV_SETTINGS \
2119 "myvar1=value1\0" \
2120 "myvar2=value2\0"
2121
wdenk4a5c8a72003-03-06 00:02:04 +00002122 Warning: This method is based on knowledge about the
2123 internal format how the environment is stored by the
2124 U-Boot code. This is NOT an official, exported
2125 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002126 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002127 You better know what you are doing here.
2128
wdenk4a5c8a72003-03-06 00:02:04 +00002129 Note: overly (ab)use of the default environment is
2130 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002131 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002132 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002133
wdenkc0aa5c52003-12-06 19:49:23 +00002134- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002135 CONFIG_HAS_DATAFLASH
2136
wdenk57b2d802003-06-27 21:31:46 +00002137 Defining this option enables DataFlash features and
2138 allows to read/write in Dataflash via the standard
2139 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002140
wdenkef893942004-02-23 16:11:30 +00002141- SystemACE Support:
2142 CONFIG_SYSTEMACE
2143
2144 Adding this option adds support for Xilinx SystemACE
2145 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002146 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002147 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002148
2149 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002150 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002151
2152 When SystemACE support is added, the "ace" device type
2153 becomes available to the fat commands, i.e. fatls.
2154
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002155- TFTP Fixed UDP Port:
2156 CONFIG_TFTP_PORT
2157
Wolfgang Denk227b5192005-09-24 23:25:46 +02002158 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002159 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002160 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002161 number generator is used.
2162
Wolfgang Denk227b5192005-09-24 23:25:46 +02002163 Also, the environment variable tftpdstp is used to supply
2164 the TFTP UDP destination port value. If tftpdstp isn't
2165 defined, the normal port 69 is used.
2166
2167 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002168 blindly start the TFTP transfer using the pre-configured
2169 target IP address and UDP port. This has the effect of
2170 "punching through" the (Windows XP) firewall, allowing
2171 the remainder of the TFTP transfer to proceed normally.
2172 A better solution is to properly configure the firewall,
2173 but sometimes that is not allowed.
2174
wdenkc0aa5c52003-12-06 19:49:23 +00002175- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002176 CONFIG_SHOW_BOOT_PROGRESS
2177
wdenk4a5c8a72003-03-06 00:02:04 +00002178 Defining this option allows to add some board-
2179 specific code (calling a user-provided function
2180 "show_boot_progress(int)") that enables you to show
2181 the system's boot progress on some display (for
2182 example, some LED's) on your board. At the moment,
2183 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002184
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002185Legacy uImage format:
2186
wdenkc6097192002-11-03 00:24:07 +00002187 Arg Where When
2188 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002189 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002190 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002191 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002192 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002193 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002194 4 common/cmd_bootm.c Image data has correct checksum
2195 -4 common/cmd_bootm.c Image is for unsupported architecture
2196 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002197 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002198 6 common/cmd_bootm.c Image Type check OK
2199 -6 common/cmd_bootm.c gunzip uncompression error
2200 -7 common/cmd_bootm.c Unimplemented compression type
2201 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002202 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002203 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002204
2205 9 common/image.c Start initial ramdisk verification
2206 -10 common/image.c Ramdisk header has bad magic number
2207 -11 common/image.c Ramdisk header has bad checksum
2208 10 common/image.c Ramdisk header is OK
2209 -12 common/image.c Ramdisk data has bad checksum
2210 11 common/image.c Ramdisk data has correct checksum
2211 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002212 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002213 13 common/image.c Start multifile image verification
2214 14 common/image.c No initial ramdisk, no multifile, continue.
2215
Wolfgang Denk092ae952011-10-26 10:21:21 +00002216 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002217
Stefan Roese88fbf932010-04-15 16:07:28 +02002218 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002219 -31 post/post.c POST test failed, detected by post_output_backlog()
2220 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002221
Heiko Schocher633e03a2007-06-22 19:11:54 +02002222 34 common/cmd_doc.c before loading a Image from a DOC device
2223 -35 common/cmd_doc.c Bad usage of "doc" command
2224 35 common/cmd_doc.c correct usage of "doc" command
2225 -36 common/cmd_doc.c No boot device
2226 36 common/cmd_doc.c correct boot device
2227 -37 common/cmd_doc.c Unknown Chip ID on boot device
2228 37 common/cmd_doc.c correct chip ID found, device available
2229 -38 common/cmd_doc.c Read Error on boot device
2230 38 common/cmd_doc.c reading Image header from DOC device OK
2231 -39 common/cmd_doc.c Image header has bad magic number
2232 39 common/cmd_doc.c Image header has correct magic number
2233 -40 common/cmd_doc.c Error reading Image from DOC device
2234 40 common/cmd_doc.c Image header has correct magic number
2235 41 common/cmd_ide.c before loading a Image from a IDE device
2236 -42 common/cmd_ide.c Bad usage of "ide" command
2237 42 common/cmd_ide.c correct usage of "ide" command
2238 -43 common/cmd_ide.c No boot device
2239 43 common/cmd_ide.c boot device found
2240 -44 common/cmd_ide.c Device not available
2241 44 common/cmd_ide.c Device available
2242 -45 common/cmd_ide.c wrong partition selected
2243 45 common/cmd_ide.c partition selected
2244 -46 common/cmd_ide.c Unknown partition table
2245 46 common/cmd_ide.c valid partition table found
2246 -47 common/cmd_ide.c Invalid partition type
2247 47 common/cmd_ide.c correct partition type
2248 -48 common/cmd_ide.c Error reading Image Header on boot device
2249 48 common/cmd_ide.c reading Image Header from IDE device OK
2250 -49 common/cmd_ide.c Image header has bad magic number
2251 49 common/cmd_ide.c Image header has correct magic number
2252 -50 common/cmd_ide.c Image header has bad checksum
2253 50 common/cmd_ide.c Image header has correct checksum
2254 -51 common/cmd_ide.c Error reading Image from IDE device
2255 51 common/cmd_ide.c reading Image from IDE device OK
2256 52 common/cmd_nand.c before loading a Image from a NAND device
2257 -53 common/cmd_nand.c Bad usage of "nand" command
2258 53 common/cmd_nand.c correct usage of "nand" command
2259 -54 common/cmd_nand.c No boot device
2260 54 common/cmd_nand.c boot device found
2261 -55 common/cmd_nand.c Unknown Chip ID on boot device
2262 55 common/cmd_nand.c correct chip ID found, device available
2263 -56 common/cmd_nand.c Error reading Image Header on boot device
2264 56 common/cmd_nand.c reading Image Header from NAND device OK
2265 -57 common/cmd_nand.c Image header has bad magic number
2266 57 common/cmd_nand.c Image header has correct magic number
2267 -58 common/cmd_nand.c Error reading Image from NAND device
2268 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002269
Heiko Schocher633e03a2007-06-22 19:11:54 +02002270 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002271
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002272 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002273 -64 net/eth.c no Ethernet found.
2274 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002275
Heiko Schocher633e03a2007-06-22 19:11:54 +02002276 -80 common/cmd_net.c usage wrong
2277 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002278 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002279 81 common/cmd_net.c NetLoop() back without error
2280 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2281 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002282 83 common/cmd_net.c running "source" command
2283 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002284 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002285
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002286FIT uImage format:
2287
2288 Arg Where When
2289 100 common/cmd_bootm.c Kernel FIT Image has correct format
2290 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2291 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2292 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2293 102 common/cmd_bootm.c Kernel unit name specified
2294 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002295 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002296 104 common/cmd_bootm.c Got kernel subimage node offset
2297 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2298 105 common/cmd_bootm.c Kernel subimage hash verification OK
2299 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2300 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002301 -106 common/cmd_bootm.c Kernel subimage has wrong type
2302 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002303 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2304 108 common/cmd_bootm.c Got kernel subimage data/size
2305 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2306 -109 common/cmd_bootm.c Can't get kernel subimage type
2307 -110 common/cmd_bootm.c Can't get kernel subimage comp
2308 -111 common/cmd_bootm.c Can't get kernel subimage os
2309 -112 common/cmd_bootm.c Can't get kernel subimage load address
2310 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2311
2312 120 common/image.c Start initial ramdisk verification
2313 -120 common/image.c Ramdisk FIT image has incorrect format
2314 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002315 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002316 -122 common/image.c Can't get configuration for ramdisk subimage
2317 123 common/image.c Ramdisk unit name specified
2318 -124 common/image.c Can't get ramdisk subimage node offset
2319 125 common/image.c Got ramdisk subimage node offset
2320 -125 common/image.c Ramdisk subimage hash verification failed
2321 126 common/image.c Ramdisk subimage hash verification OK
2322 -126 common/image.c Ramdisk subimage for unsupported architecture
2323 127 common/image.c Architecture check OK
2324 -127 common/image.c Can't get ramdisk subimage data/size
2325 128 common/image.c Got ramdisk subimage data/size
2326 129 common/image.c Can't get ramdisk load address
2327 -129 common/image.c Got ramdisk load address
2328
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002329 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002330 131 common/cmd_doc.c FIT image format OK
2331
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002332 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002333 141 common/cmd_ide.c FIT image format OK
2334
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002335 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002336 151 common/cmd_nand.c FIT image format OK
2337
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002338- Standalone program support:
2339 CONFIG_STANDALONE_LOAD_ADDR
2340
Wolfgang Denk23f78482011-10-09 21:06:34 +02002341 This option defines a board specific value for the
2342 address where standalone program gets loaded, thus
2343 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002344 settings.
2345
2346- Frame Buffer Address:
2347 CONFIG_FB_ADDR
2348
2349 Define CONFIG_FB_ADDR if you want to use specific
2350 address for frame buffer.
2351 Then system will reserve the frame buffer address to
2352 defined address instead of lcd_setmem (this function
Wolfgang Denk23f78482011-10-09 21:06:34 +02002353 grabs the memory for frame buffer by panel's size).
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002354
2355 Please see board_init_f function.
2356
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002357- Automatic software updates via TFTP server
2358 CONFIG_UPDATE_TFTP
2359 CONFIG_UPDATE_TFTP_CNT_MAX
2360 CONFIG_UPDATE_TFTP_MSEC_MAX
2361
2362 These options enable and control the auto-update feature;
2363 for a more detailed description refer to doc/README.update.
2364
2365- MTD Support (mtdparts command, UBI support)
2366 CONFIG_MTD_DEVICE
2367
2368 Adds the MTD device infrastructure from the Linux kernel.
2369 Needed for mtdparts command support.
2370
2371 CONFIG_MTD_PARTITIONS
2372
2373 Adds the MTD partitioning infrastructure from the Linux
2374 kernel. Needed for UBI support.
2375
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002376- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002377 CONFIG_SPL
2378 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002379
Wolfgang Denk825223d2011-09-11 21:24:09 +02002380 CONFIG_SPL_TEXT_BASE
2381 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002382
Wolfgang Denk825223d2011-09-11 21:24:09 +02002383 CONFIG_SPL_LDSCRIPT
2384 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002385
Wolfgang Denk825223d2011-09-11 21:24:09 +02002386 CONFIG_SPL_LIBCOMMON_SUPPORT
2387 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002388
Wolfgang Denk825223d2011-09-11 21:24:09 +02002389 CONFIG_SPL_LIBDISK_SUPPORT
2390 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002391
Wolfgang Denk825223d2011-09-11 21:24:09 +02002392 CONFIG_SPL_I2C_SUPPORT
2393 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002394
Wolfgang Denk825223d2011-09-11 21:24:09 +02002395 CONFIG_SPL_GPIO_SUPPORT
2396 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002397
Wolfgang Denk825223d2011-09-11 21:24:09 +02002398 CONFIG_SPL_MMC_SUPPORT
2399 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002400
Wolfgang Denk825223d2011-09-11 21:24:09 +02002401 CONFIG_SPL_SERIAL_SUPPORT
2402 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002403
Wolfgang Denk825223d2011-09-11 21:24:09 +02002404 CONFIG_SPL_SPI_FLASH_SUPPORT
2405 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002406
Wolfgang Denk825223d2011-09-11 21:24:09 +02002407 CONFIG_SPL_SPI_SUPPORT
2408 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002409
Wolfgang Denk825223d2011-09-11 21:24:09 +02002410 CONFIG_SPL_FAT_SUPPORT
2411 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002412
Wolfgang Denk825223d2011-09-11 21:24:09 +02002413 CONFIG_SPL_LIBGENERIC_SUPPORT
2414 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002415
wdenkc6097192002-11-03 00:24:07 +00002416Modem Support:
2417--------------
2418
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002419[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002420
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002421- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002422 CONFIG_MODEM_SUPPORT
2423
2424- RTS/CTS Flow control enable:
2425 CONFIG_HWFLOW
2426
2427- Modem debug support:
2428 CONFIG_MODEM_SUPPORT_DEBUG
2429
wdenk4a5c8a72003-03-06 00:02:04 +00002430 Enables debugging stuff (char screen[1024], dbg())
2431 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002432
wdenkc0aa5c52003-12-06 19:49:23 +00002433- Interrupt support (PPC):
2434
wdenk1ebf41e2004-01-02 14:00:00 +00002435 There are common interrupt_init() and timer_interrupt()
2436 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002437 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002438 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002439 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002440 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002441 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002442 specific handling. If board has watchdog / status_led
2443 / other_activity_monitor it works automatically from
2444 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002445
wdenkc6097192002-11-03 00:24:07 +00002446- General:
2447
wdenk4a5c8a72003-03-06 00:02:04 +00002448 In the target system modem support is enabled when a
2449 specific key (key combination) is pressed during
2450 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002451 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002452 board_init(). Currently key_pressed() is a dummy
2453 function, returning 1 and thus enabling modem
2454 initialization.
wdenkc6097192002-11-03 00:24:07 +00002455
wdenk4a5c8a72003-03-06 00:02:04 +00002456 If there are no modem init strings in the
2457 environment, U-Boot proceed to autoboot; the
2458 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002459 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002460
2461 See also: doc/README.Modem
2462
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002463Board initialization settings:
2464------------------------------
2465
2466During Initialization u-boot calls a number of board specific functions
2467to allow the preparation of board specific prerequisites, e.g. pin setup
2468before drivers are initialized. To enable these callbacks the
2469following configuration macros have to be defined. Currently this is
2470architecture specific, so please check arch/your_architecture/lib/board.c
2471typically in board_init_f() and board_init_r().
2472
2473- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2474- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2475- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2476- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002477
wdenkc6097192002-11-03 00:24:07 +00002478Configuration Settings:
2479-----------------------
2480
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002481- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002482 undefine this when you're short of memory.
2483
Peter Tyserdfb72b82009-01-27 18:03:12 -06002484- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2485 width of the commands listed in the 'help' command output.
2486
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002487- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002488 prompt for user input.
2489
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002490- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002491
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002492- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002494- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002495
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002496- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002497 the application (usually a Linux kernel) when it is
2498 booted
2499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002500- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002501 List of legal baudrate settings for this board.
2502
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002503- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002504 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002506- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002507 If the board specific function
2508 extern int overwrite_console (void);
2509 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002510 serial port, else the settings in the environment are used.
2511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002512- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002513 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002514
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002515- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002516 Enable overwrite of previous console environment settings.
2517
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002518- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002519 Begin and End addresses of the area used by the
2520 simple memory test.
2521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002522- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002523 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002525- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002526 Scratch address used by the alternate memory test
2527 You only need to set this if address zero isn't writeable
2528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002529- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2530 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002531 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002532 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002533 fixing up gd->ram_size the Linux kernel should gets passed
2534 the now "corrected" memory size and won't touch it either.
2535 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002536 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002537 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002538 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002539
2540 This option can be used as a workaround for the 440EPx/GRx
2541 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2542 be touched.
2543
2544 WARNING: Please make sure that this value is a multiple of
2545 the Linux page size (normally 4k). If this is not the case,
2546 then the end address of the Linux memory will be located at a
2547 non page size aligned address and this could cause major
2548 problems.
2549
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002550- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002551 Default load address for network file downloads
2552
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002553- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002554 Enable temporary baudrate change while serial download
2555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002556- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002557 Physical start address of SDRAM. _Must_ be 0 here.
2558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002559- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002560 Physical start address of Motherboard I/O (if using a
2561 Cogent motherboard)
2562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002563- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002564 Physical start address of Flash memory.
2565
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002566- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002567 Physical start address of boot monitor code (set by
2568 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002569 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002570 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002572- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002573 Size of memory reserved for monitor code, used to
2574 determine _at_compile_time_ (!) if the environment is
2575 embedded within the U-Boot image, or in a separate
2576 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002578- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002579 Size of DRAM reserved for malloc() use.
2580
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002581- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002582 Normally compressed uImages are limited to an
2583 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002584 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002585 to adjust this setting to your needs.
2586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002587- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002588 Maximum size of memory mapped by the startup code of
2589 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002590 the Linux kernel (bd_info, boot arguments, FDT blob if
2591 used) must be put below this limit, unless "bootm_low"
2592 enviroment variable is defined and non-zero. In such case
2593 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002594 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002595 variable "bootm_mapsize" will override the value of
2596 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2597 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002598
John Rigbyeea8e692010-10-13 13:57:35 -06002599- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2600 Enable initrd_high functionality. If defined then the
2601 initrd_high feature is enabled and the bootm ramdisk subcommand
2602 is enabled.
2603
2604- CONFIG_SYS_BOOT_GET_CMDLINE:
2605 Enables allocating and saving kernel cmdline in space between
2606 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2607
2608- CONFIG_SYS_BOOT_GET_KBD:
2609 Enables allocating and saving a kernel copy of the bd_info in
2610 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2611
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002612- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002613 Max number of Flash memory banks
2614
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002615- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002616 Max number of sectors on a Flash chip
2617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002618- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002619 Timeout for Flash erase operations (in ms)
2620
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002621- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002622 Timeout for Flash write operations (in ms)
2623
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002624- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002625 Timeout for Flash set sector lock bit operation (in ms)
2626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002627- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002628 Timeout for Flash clear lock bits operation (in ms)
2629
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002630- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002631 If defined, hardware flash sectors protection is used
2632 instead of U-Boot software protection.
2633
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002634- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002635
2636 Enable TFTP transfers directly to flash memory;
2637 without this option such a download has to be
2638 performed in two steps: (1) download to RAM, and (2)
2639 copy from RAM to flash.
2640
2641 The two-step approach is usually more reliable, since
2642 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002643 the flash, but in some situations (when system RAM is
2644 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002645 downloaded image) this option may be very useful.
2646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002647- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002648 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002649 common flash structure for storing flash geometry.
2650
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002651- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002652 This option also enables the building of the cfi_flash driver
2653 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002654
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002655- CONFIG_FLASH_CFI_MTD
2656 This option enables the building of the cfi_mtd driver
2657 in the drivers directory. The driver exports CFI flash
2658 to the MTD layer.
2659
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002660- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002661 Use buffered writes to flash.
2662
2663- CONFIG_FLASH_SPANSION_S29WS_N
2664 s29ws-n MirrorBit flash has non-standard addresses for buffered
2665 write commands.
2666
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002667- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002668 If this option is defined, the common CFI flash doesn't
2669 print it's warning upon not recognized FLASH banks. This
2670 is useful, if some of the configured banks are only
2671 optionally available.
2672
Jerry Van Barenaae73572008-03-08 13:48:01 -05002673- CONFIG_FLASH_SHOW_PROGRESS
2674 If defined (must be an integer), print out countdown
2675 digits and dots. Recommended value: 45 (9..1) for 80
2676 column displays, 15 (3..1) for 40 column displays.
2677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002678- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002679 Defines the number of Ethernet receive buffers. On some
2680 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002681 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2682 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002683 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002684 Defaults to 4 if not defined.
2685
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002686- CONFIG_ENV_MAX_ENTRIES
2687
Wolfgang Denk1136f692010-10-27 22:48:30 +02002688 Maximum number of entries in the hash table that is used
2689 internally to store the environment settings. The default
2690 setting is supposed to be generous and should work in most
2691 cases. This setting can be used to tune behaviour; see
2692 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002693
wdenkc6097192002-11-03 00:24:07 +00002694The following definitions that deal with the placement and management
2695of environment data (variable area); in general, we support the
2696following configurations:
2697
Mike Frysinger63b8f122011-07-08 10:44:25 +00002698- CONFIG_BUILD_ENVCRC:
2699
2700 Builds up envcrc with the target environment so that external utils
2701 may easily extract it and embed it in final U-Boot images.
2702
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002703- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002704
2705 Define this if the environment is in flash memory.
2706
2707 a) The environment occupies one whole flash sector, which is
2708 "embedded" in the text segment with the U-Boot code. This
2709 happens usually with "bottom boot sector" or "top boot
2710 sector" type flash chips, which have several smaller
2711 sectors at the start or the end. For instance, such a
2712 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2713 such a case you would place the environment in one of the
2714 4 kB sectors - with U-Boot code before and after it. With
2715 "top boot sector" type flash chips, you would put the
2716 environment in one of the last sectors, leaving a gap
2717 between U-Boot and the environment.
2718
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002719 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002720
2721 Offset of environment data (variable area) to the
2722 beginning of flash memory; for instance, with bottom boot
2723 type flash chips the second sector can be used: the offset
2724 for this sector is given here.
2725
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002726 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002727
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002728 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002729
2730 This is just another way to specify the start address of
2731 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002732 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002733
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002734 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002735
2736 Size of the sector containing the environment.
2737
2738
2739 b) Sometimes flash chips have few, equal sized, BIG sectors.
2740 In such a case you don't want to spend a whole sector for
2741 the environment.
2742
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002743 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002744
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002745 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002746 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002747 of this flash sector for the environment. This saves
2748 memory for the RAM copy of the environment.
2749
2750 It may also save flash memory if you decide to use this
2751 when your environment is "embedded" within U-Boot code,
2752 since then the remainder of the flash sector could be used
2753 for U-Boot code. It should be pointed out that this is
2754 STRONGLY DISCOURAGED from a robustness point of view:
2755 updating the environment in flash makes it always
2756 necessary to erase the WHOLE sector. If something goes
2757 wrong before the contents has been restored from a copy in
2758 RAM, your target system will be dead.
2759
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002760 - CONFIG_ENV_ADDR_REDUND
2761 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002762
wdenk4a5c8a72003-03-06 00:02:04 +00002763 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002764 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002765 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002766 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002767
2768BE CAREFUL! Any changes to the flash layout, and some changes to the
2769source code will make it necessary to adapt <board>/u-boot.lds*
2770accordingly!
2771
2772
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02002773- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002774
2775 Define this if you have some non-volatile memory device
2776 (NVRAM, battery buffered SRAM) which you want to use for the
2777 environment.
2778
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002779 - CONFIG_ENV_ADDR:
2780 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002781
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002782 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002783 want to use for environment. It is assumed that this memory
2784 can just be read and written to, without any special
2785 provision.
2786
2787BE CAREFUL! The first access to the environment happens quite early
2788in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002789console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002790U-Boot will hang.
2791
2792Please note that even with NVRAM we still use a copy of the
2793environment in RAM: we could work on NVRAM directly, but we want to
2794keep settings there always unmodified except somebody uses "saveenv"
2795to save the current settings.
2796
2797
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02002798- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002799
2800 Use this if you have an EEPROM or similar serial access
2801 device and a driver for it.
2802
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002803 - CONFIG_ENV_OFFSET:
2804 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002805
2806 These two #defines specify the offset and size of the
2807 environment area within the total memory of your EEPROM.
2808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002809 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002810 If defined, specified the chip address of the EEPROM device.
2811 The default address is zero.
2812
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002813 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002814 If defined, the number of bits used to address bytes in a
2815 single page in the EEPROM device. A 64 byte page, for example
2816 would require six bits.
2817
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002818 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002819 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002820 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002821
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002822 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002823 The length in bytes of the EEPROM memory array address. Note
2824 that this is NOT the chip address length!
2825
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002826 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00002827 EEPROM chips that implement "address overflow" are ones
2828 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2829 address and the extra bits end up in the "chip address" bit
2830 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2831 byte chips.
2832
2833 Note that we consider the length of the address field to
2834 still be one byte because the extra address bits are hidden
2835 in the chip address.
2836
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002837 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002838 The size in bytes of the EEPROM device.
2839
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01002840 - CONFIG_ENV_EEPROM_IS_ON_I2C
2841 define this, if you have I2C and SPI activated, and your
2842 EEPROM, which holds the environment, is on the I2C bus.
2843
2844 - CONFIG_I2C_ENV_EEPROM_BUS
2845 if you have an Environment on an EEPROM reached over
2846 I2C muxes, you can define here, how to reach this
2847 EEPROM. For example:
2848
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02002849 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01002850
2851 EEPROM which holds the environment, is reached over
2852 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002853
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02002854- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00002855
wdenk1ebf41e2004-01-02 14:00:00 +00002856 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002857 want to use for the environment.
2858
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002859 - CONFIG_ENV_OFFSET:
2860 - CONFIG_ENV_ADDR:
2861 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00002862
2863 These three #defines specify the offset and size of the
2864 environment area within the total memory of your DataFlash placed
2865 at the specified address.
2866
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02002867- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00002868
2869 Define this if you have a NAND device which you want to use
2870 for the environment.
2871
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002872 - CONFIG_ENV_OFFSET:
2873 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00002874
2875 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05002876 area within the first NAND device. CONFIG_ENV_OFFSET must be
2877 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00002878
Scott Wood08239322010-09-17 14:38:37 -05002879 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002880
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002881 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05002882 size used to hold a redundant copy of the environment data, so
2883 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00002884 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05002885 aligned to an erase block boundary.
2886
2887 - CONFIG_ENV_RANGE (optional):
2888
2889 Specifies the length of the region in which the environment
2890 can be written. This should be a multiple of the NAND device's
2891 block size. Specifying a range with more erase blocks than
2892 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2893 the range to be avoided.
2894
2895 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002896
Scott Wood08239322010-09-17 14:38:37 -05002897 Enables support for dynamically retrieving the offset of the
2898 environment from block zero's out-of-band data. The
2899 "nand env.oob" command can be used to record this offset.
2900 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2901 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002902
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002903- CONFIG_NAND_ENV_DST
2904
2905 Defines address in RAM to which the nand_spl code should copy the
2906 environment. If redundant environment is used, it will be copied to
2907 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2908
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002909- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002910
2911 Defines offset to the initial SPI buffer area in DPRAM. The
2912 area is used at an early stage (ROM part) if the environment
2913 is configured to reside in the SPI EEPROM: We need a 520 byte
2914 scratch DPRAM area. It is used between the two initialization
2915 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2916 to be a good choice since it makes it far enough from the
2917 start of the data area as well as from the stack pointer.
2918
Bruce Adleredecc942007-11-02 13:15:42 -07002919Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002920has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02002921created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002922until then to read environment variables.
2923
wdenk8dba0502003-03-31 16:34:49 +00002924The environment is protected by a CRC32 checksum. Before the monitor
2925is relocated into RAM, as a result of a bad CRC you will be working
2926with the compiled-in default environment - *silently*!!! [This is
2927necessary, because the first environment variable we need is the
2928"baudrate" setting for the console - if we have a bad CRC, we don't
2929have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002930
2931Note: once the monitor has been relocated, then it will complain if
2932the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002933use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002935- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002936 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002937
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002938 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002939 also needs to be defined.
2940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002941- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002942 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002943
Ron Madriddfa028a2009-02-18 14:30:44 -08002944- CONFIG_NS16550_MIN_FUNCTIONS:
2945 Define this if you desire to only have use of the NS16550_init
2946 and NS16550_putc functions for the serial driver located at
2947 drivers/serial/ns16550.c. This option is useful for saving
2948 space for already greatly restricted images, including but not
2949 limited to NAND_SPL configurations.
2950
wdenkc6097192002-11-03 00:24:07 +00002951Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002952---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002953
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002954- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002955 Cache Line Size of the CPU.
2956
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002957- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002958 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002959
wdenk9c53f402003-10-15 23:53:47 +00002960 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2961 and RPXsuper) to be able to adjust the position of
2962 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002963
Timur Tabid8f341c2011-08-04 18:03:41 -05002964- CONFIG_SYS_CCSRBAR_DEFAULT:
2965 Default (power-on reset) physical address of CCSR on Freescale
2966 PowerPC SOCs.
2967
2968- CONFIG_SYS_CCSRBAR:
2969 Virtual address of CCSR. On a 32-bit build, this is typically
2970 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2971
2972 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2973 for cross-platform code that uses that macro instead.
2974
2975- CONFIG_SYS_CCSRBAR_PHYS:
2976 Physical address of CCSR. CCSR can be relocated to a new
2977 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002978 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002979 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2980 is typically relocated on 36-bit builds. It is recommended
2981 that this macro be defined via the _HIGH and _LOW macros:
2982
2983 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2984 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2985
2986- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002987 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2988 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002989 used in assembly code, so it must not contain typecasts or
2990 integer size suffixes (e.g. "ULL").
2991
2992- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2993 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2994 used in assembly code, so it must not contain typecasts or
2995 integer size suffixes (e.g. "ULL").
2996
2997- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2998 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2999 forced to a value that ensures that CCSR is not relocated.
3000
wdenk1272e232002-11-10 22:06:23 +00003001- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003002 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003003
3004 the default drive number (default value 0)
3005
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003006 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003007
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003008 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003009 (default value 1)
3010
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003011 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003012
wdenk4a5c8a72003-03-06 00:02:04 +00003013 defines the offset of register from address. It
3014 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003015 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003017 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3018 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003019 default value.
wdenk1272e232002-11-10 22:06:23 +00003020
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003021 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003022 fdc_hw_init() is called at the beginning of the FDC
3023 setup. fdc_hw_init() must be provided by the board
3024 source code. It is used to make hardware dependant
3025 initializations.
wdenk1272e232002-11-10 22:06:23 +00003026
Macpaul Lind1e49942011-04-11 20:45:32 +00003027- CONFIG_IDE_AHB:
3028 Most IDE controllers were designed to be connected with PCI
3029 interface. Only few of them were designed for AHB interface.
3030 When software is doing ATA command and data transfer to
3031 IDE devices through IDE-AHB controller, some additional
3032 registers accessing to these kind of IDE-AHB controller
3033 is requierd.
3034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003035- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003036 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003037 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003039- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003040
wdenkeb20ad32003-09-05 23:19:14 +00003041 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003042 initial data and stack; please note that this must be
3043 writable memory that is working WITHOUT special
3044 initialization, i. e. you CANNOT use normal RAM which
3045 will become available only after programming the
3046 memory controller and running certain initialization
3047 sequences.
3048
3049 U-Boot uses the following memory types:
3050 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3051 - MPC824X: data cache
3052 - PPC4xx: data cache
3053
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003054- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003055
3056 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003057 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3058 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003059 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003060 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003061 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3062 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3063 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003064
3065 Note:
3066 On the MPC824X (or other systems that use the data
3067 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003068 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003069 point to an otherwise UNUSED address space between
3070 the top of RAM and the start of the PCI space.
3071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003072- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003074- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003076- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003078- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003080- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003082- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003084- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003085 SDRAM timing
3086
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003087- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003088 periodic timer for refresh
3089
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003090- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003092- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3093 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3094 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3095 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003096 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3097
3098- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003099 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3100 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003101 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003103- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3104 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003105 Machine Mode Register and Memory Periodic Timer
3106 Prescaler definitions (SDRAM timing)
3107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003108- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003109 enable I2C microcode relocation patch (MPC8xx);
3110 define relocation offset in DPRAM [DSP2]
3111
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003112- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003113 enable SMC microcode relocation patch (MPC8xx);
3114 define relocation offset in DPRAM [SMC1]
3115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003116- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003117 enable SPI microcode relocation patch (MPC8xx);
3118 define relocation offset in DPRAM [SCC4]
3119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003120- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003121 Use OSCM clock mode on MBX8xx board. Be careful,
3122 wrong setting might damage your board. Read
3123 doc/README.MBX before setting this variable!
3124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003125- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003126 Offset of the bootmode word in DPRAM used by post
3127 (Power On Self Tests). This definition overrides
3128 #define'd default value in commproc.h resp.
3129 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003131- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3132 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3133 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3134 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3135 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3136 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3137 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3138 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003139 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003140
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003141- CONFIG_PCI_DISABLE_PCIE:
3142 Disable PCI-Express on systems where it is supported but not
3143 required.
3144
Kumar Gala8975d7a2010-12-30 12:09:53 -06003145- CONFIG_SYS_SRIO:
3146 Chip has SRIO or not
3147
3148- CONFIG_SRIO1:
3149 Board has SRIO 1 port available
3150
3151- CONFIG_SRIO2:
3152 Board has SRIO 2 port available
3153
3154- CONFIG_SYS_SRIOn_MEM_VIRT:
3155 Virtual Address of SRIO port 'n' memory region
3156
3157- CONFIG_SYS_SRIOn_MEM_PHYS:
3158 Physical Address of SRIO port 'n' memory region
3159
3160- CONFIG_SYS_SRIOn_MEM_SIZE:
3161 Size of SRIO port 'n' memory region
3162
Alex Watermancd6aae32011-05-19 15:08:36 -04003163- CONFIG_SYS_NDFC_16
3164 Defined to tell the NDFC that the NAND chip is using a
3165 16 bit bus.
3166
3167- CONFIG_SYS_NDFC_EBC0_CFG
3168 Sets the EBC0_CFG register for the NDFC. If not defined
3169 a default value will be used.
3170
Ben Warren45657152006-09-07 16:50:54 -04003171- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003172 Get DDR timing information from an I2C EEPROM. Common
3173 with pluggable memory modules such as SODIMMs
3174
Ben Warren45657152006-09-07 16:50:54 -04003175 SPD_EEPROM_ADDRESS
3176 I2C address of the SPD EEPROM
3177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003178- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003179 If SPD EEPROM is on an I2C bus other than the first
3180 one, specify here. Note that the value must resolve
3181 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003182
York Sune73cc042011-06-07 09:42:16 +08003183- CONFIG_SYS_DDR_RAW_TIMING
3184 Get DDR timing information from other than SPD. Common with
3185 soldered DDR chips onboard without SPD. DDR raw timing
3186 parameters are extracted from datasheet and hard-coded into
3187 header files or board specific files.
3188
York Sunbd495cf2011-09-16 13:21:35 -07003189- CONFIG_FSL_DDR_INTERACTIVE
3190 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3191
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003192- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003193 Only for 83xx systems. If specified, then DDR should
3194 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003195
wdenk6203e402004-04-18 10:13:26 +00003196- CONFIG_ETHER_ON_FEC[12]
3197 Define to enable FEC[12] on a 8xx series processor.
3198
3199- CONFIG_FEC[12]_PHY
3200 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003201 to the given FEC; i. e.
3202 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003203 means that the PHY with address 4 is connected to FEC1
3204
3205 When set to -1, means to probe for first available.
3206
3207- CONFIG_FEC[12]_PHY_NORXERR
3208 The PHY does not have a RXERR line (RMII only).
3209 (so program the FEC to ignore it).
3210
3211- CONFIG_RMII
3212 Enable RMII mode for all FECs.
3213 Note that this is a global option, we can't
3214 have one FEC in standard MII mode and another in RMII mode.
3215
wdenk20c98a62004-04-23 20:32:05 +00003216- CONFIG_CRC32_VERIFY
3217 Add a verify option to the crc32 command.
3218 The syntax is:
3219
3220 => crc32 -v <address> <count> <crc32>
3221
3222 Where address/count indicate a memory area
3223 and crc32 is the correct crc32 which the
3224 area should have.
3225
wdenk64519362004-07-11 17:40:54 +00003226- CONFIG_LOOPW
3227 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003228 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003229
stroesecc3af832004-12-16 18:46:55 +00003230- CONFIG_MX_CYCLIC
3231 Add the "mdc" and "mwc" memory commands. These are cyclic
3232 "md/mw" commands.
3233 Examples:
3234
wdenk07d7e6b2004-12-16 21:44:03 +00003235 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003236 This command will print 4 bytes (10,11,12,13) each 500 ms.
3237
wdenk07d7e6b2004-12-16 21:44:03 +00003238 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003239 This command will write 12345678 to address 100 all 10 ms.
3240
wdenk07d7e6b2004-12-16 21:44:03 +00003241 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003242 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003243
wdenk3d3d99f2005-04-04 12:44:11 +00003244- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003245 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003246 low level initializations (like setting up the memory
3247 controller) are omitted and/or U-Boot does not
3248 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003249
Wolfgang Denk302141d2010-11-27 23:30:56 +01003250 Normally this variable MUST NOT be defined. The only
3251 exception is when U-Boot is loaded (to RAM) by some
3252 other boot loader or by a debugger which performs
3253 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003254
Aneesh V552a3192011-07-13 05:11:07 +00003255- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003256 Modifies the behaviour of start.S when compiling a loader
3257 that is executed before the actual U-Boot. E.g. when
3258 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003259
Matthias Weisser93416c12011-03-10 21:36:32 +00003260- CONFIG_USE_ARCH_MEMCPY
3261 CONFIG_USE_ARCH_MEMSET
3262 If these options are used a optimized version of memcpy/memset will
3263 be used if available. These functions may be faster under some
3264 conditions but may increase the binary size.
3265
wdenkc6097192002-11-03 00:24:07 +00003266Building the Software:
3267======================
3268
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003269Building U-Boot has been tested in several native build environments
3270and in many different cross environments. Of course we cannot support
3271all possibly existing versions of cross development tools in all
3272(potentially obsolete) versions. In case of tool chain problems we
3273recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3274which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003275
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003276If you are not using a native environment, it is assumed that you
3277have GNU cross compiling tools available in your path. In this case,
3278you must set the environment variable CROSS_COMPILE in your shell.
3279Note that no changes to the Makefile or any other source files are
3280necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003281
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003282 $ CROSS_COMPILE=ppc_4xx-
3283 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003284
Peter Tyserb06976d2009-03-13 18:54:51 -05003285Note: If you wish to generate Windows versions of the utilities in
3286 the tools directory you can use the MinGW toolchain
3287 (http://www.mingw.org). Set your HOST tools to the MinGW
3288 toolchain and execute 'make tools'. For example:
3289
3290 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3291
3292 Binaries such as tools/mkimage.exe will be created which can
3293 be executed on computers running Windows.
3294
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003295U-Boot is intended to be simple to build. After installing the
3296sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003297is done by typing:
3298
3299 make NAME_config
3300
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003301where "NAME_config" is the name of one of the existing configu-
3302rations; see the main Makefile for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003303
wdenk6c59edc2004-05-03 20:45:30 +00003304Note: for some board special configuration names may exist; check if
3305 additional information is available from the board vendor; for
3306 instance, the TQM823L systems are available without (standard)
3307 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003308 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003309
wdenk6c59edc2004-05-03 20:45:30 +00003310 make TQM823L_config
3311 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003312
wdenk6c59edc2004-05-03 20:45:30 +00003313 make TQM823L_LCD_config
3314 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003315
wdenk6c59edc2004-05-03 20:45:30 +00003316 etc.
wdenkc6097192002-11-03 00:24:07 +00003317
wdenkc6097192002-11-03 00:24:07 +00003318
wdenk6c59edc2004-05-03 20:45:30 +00003319Finally, type "make all", and you should get some working U-Boot
3320images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003321
wdenk6c59edc2004-05-03 20:45:30 +00003322- "u-boot.bin" is a raw binary image
3323- "u-boot" is an image in ELF binary format
3324- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003325
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003326By default the build is performed locally and the objects are saved
3327in the source directory. One of the two methods can be used to change
3328this behavior and build U-Boot to some external directory:
3329
33301. Add O= to the make command line invocations:
3331
3332 make O=/tmp/build distclean
3333 make O=/tmp/build NAME_config
3334 make O=/tmp/build all
3335
33362. Set environment variable BUILD_DIR to point to the desired location:
3337
3338 export BUILD_DIR=/tmp/build
3339 make distclean
3340 make NAME_config
3341 make all
3342
3343Note that the command line "O=" setting overrides the BUILD_DIR environment
3344variable.
3345
wdenkc6097192002-11-03 00:24:07 +00003346
wdenk6c59edc2004-05-03 20:45:30 +00003347Please be aware that the Makefiles assume you are using GNU make, so
3348for instance on NetBSD you might need to use "gmake" instead of
3349native "make".
wdenkc6097192002-11-03 00:24:07 +00003350
wdenkc6097192002-11-03 00:24:07 +00003351
wdenk6c59edc2004-05-03 20:45:30 +00003352If the system board that you have is not listed, then you will need
3353to port U-Boot to your hardware platform. To do this, follow these
3354steps:
wdenkc6097192002-11-03 00:24:07 +00003355
wdenk6c59edc2004-05-03 20:45:30 +000033561. Add a new configuration option for your board to the toplevel
3357 "Makefile" and to the "MAKEALL" script, using the existing
3358 entries as examples. Note that here and at many other places
3359 boards and other names are listed in alphabetical sort order. Please
3360 keep this order.
33612. Create a new directory to hold your board specific code. Add any
3362 files you need. In your board directory, you will need at least
3363 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
33643. Create a new configuration file "include/configs/<board>.h" for
3365 your board
33663. If you're porting U-Boot to a new CPU, then also create a new
3367 directory to hold your CPU specific code. Add any files you need.
33684. Run "make <board>_config" with your new name.
33695. Type "make", and you should get a working "u-boot.srec" file
3370 to be installed on your target system.
33716. Debug and solve any problems that might arise.
3372 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003373
wdenkc6097192002-11-03 00:24:07 +00003374
wdenk6c59edc2004-05-03 20:45:30 +00003375Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3376==============================================================
wdenkc6097192002-11-03 00:24:07 +00003377
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003378If you have modified U-Boot sources (for instance added a new board
3379or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003380provide feedback to the other developers. The feedback normally takes
3381the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003382official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003383
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003384But before you submit such a patch, please verify that your modifi-
3385cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003386the supported boards compile WITHOUT ANY compiler warnings. To do so,
3387just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003388for ALL supported system. Be warned, this will take a while. You can
3389select which (cross) compiler to use by passing a `CROSS_COMPILE'
3390environment variable to the script, i. e. to use the ELDK cross tools
3391you can type
wdenkc6097192002-11-03 00:24:07 +00003392
wdenk6c59edc2004-05-03 20:45:30 +00003393 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003394
wdenk6c59edc2004-05-03 20:45:30 +00003395or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003396
wdenk6c59edc2004-05-03 20:45:30 +00003397 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003398
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003399When using the MAKEALL script, the default behaviour is to build
3400U-Boot in the source directory. This location can be changed by
3401setting the BUILD_DIR environment variable. Also, for each target
3402built, the MAKEALL script saves two log files (<target>.ERR and
3403<target>.MAKEALL) in the <source dir>/LOG directory. This default
3404location can be changed by setting the MAKEALL_LOGDIR environment
3405variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003406
3407 export BUILD_DIR=/tmp/build
3408 export MAKEALL_LOGDIR=/tmp/log
3409 CROSS_COMPILE=ppc_8xx- MAKEALL
3410
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003411With the above settings build objects are saved in the /tmp/build,
3412log files are saved in the /tmp/log and the source tree remains clean
3413during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003414
3415
wdenk6c59edc2004-05-03 20:45:30 +00003416See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003417
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk6c59edc2004-05-03 20:45:30 +00003419Monitor Commands - Overview:
3420============================
wdenkc6097192002-11-03 00:24:07 +00003421
wdenk6c59edc2004-05-03 20:45:30 +00003422go - start application at address 'addr'
3423run - run commands in an environment variable
3424bootm - boot application image from memory
3425bootp - boot image via network using BootP/TFTP protocol
3426tftpboot- boot image via network using TFTP protocol
3427 and env variables "ipaddr" and "serverip"
3428 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003429tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003430rarpboot- boot image via network using RARP/TFTP protocol
3431diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3432loads - load S-Record file over serial line
3433loadb - load binary file over serial line (kermit mode)
3434md - memory display
3435mm - memory modify (auto-incrementing)
3436nm - memory modify (constant address)
3437mw - memory write (fill)
3438cp - memory copy
3439cmp - memory compare
3440crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003441i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003442sspi - SPI utility commands
3443base - print or set address offset
3444printenv- print environment variables
3445setenv - set environment variables
3446saveenv - save environment variables to persistent storage
3447protect - enable or disable FLASH write protection
3448erase - erase FLASH memory
3449flinfo - print FLASH memory information
3450bdinfo - print Board Info structure
3451iminfo - print header information for application image
3452coninfo - print console devices and informations
3453ide - IDE sub-system
3454loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003455loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003456mtest - simple RAM test
3457icache - enable or disable instruction cache
3458dcache - enable or disable data cache
3459reset - Perform RESET of the CPU
3460echo - echo args to console
3461version - print monitor version
3462help - print online help
3463? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003464
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk6c59edc2004-05-03 20:45:30 +00003466Monitor Commands - Detailed Description:
3467========================================
wdenkc6097192002-11-03 00:24:07 +00003468
wdenk6c59edc2004-05-03 20:45:30 +00003469TODO.
wdenkc6097192002-11-03 00:24:07 +00003470
wdenk6c59edc2004-05-03 20:45:30 +00003471For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003472
3473
wdenk6c59edc2004-05-03 20:45:30 +00003474Environment Variables:
3475======================
wdenkc6097192002-11-03 00:24:07 +00003476
wdenk6c59edc2004-05-03 20:45:30 +00003477U-Boot supports user configuration using Environment Variables which
3478can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk6c59edc2004-05-03 20:45:30 +00003480Environment Variables are set using "setenv", printed using
3481"printenv", and saved to Flash using "saveenv". Using "setenv"
3482without a value can be used to delete a variable from the
3483environment. As long as you don't save the environment you are
3484working with an in-memory copy. In case the Flash area containing the
3485environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003486
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003487Some configuration options can be set using Environment Variables.
3488
3489List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003490
wdenk6c59edc2004-05-03 20:45:30 +00003491 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003492
wdenk6c59edc2004-05-03 20:45:30 +00003493 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003494
wdenk6c59edc2004-05-03 20:45:30 +00003495 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003496
wdenk6c59edc2004-05-03 20:45:30 +00003497 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003498
wdenk6c59edc2004-05-03 20:45:30 +00003499 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003500
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003501 bootm_low - Memory range available for image processing in the bootm
3502 command can be restricted. This variable is given as
3503 a hexadecimal number and defines lowest address allowed
3504 for use by the bootm command. See also "bootm_size"
3505 environment variable. Address defined by "bootm_low" is
3506 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003507 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3508 bootm_mapsize.
3509
Wolfgang Denk092ae952011-10-26 10:21:21 +00003510 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003511 This variable is given as a hexadecimal number and it
3512 defines the size of the memory region starting at base
3513 address bootm_low that is accessible by the Linux kernel
3514 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3515 as the default value if it is defined, and bootm_size is
3516 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003517
3518 bootm_size - Memory range available for image processing in the bootm
3519 command can be restricted. This variable is given as
3520 a hexadecimal number and defines the size of the region
3521 allowed for use by the bootm command. See also "bootm_low"
3522 environment variable.
3523
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003524 updatefile - Location of the software update file on a TFTP server, used
3525 by the automatic software update feature. Please refer to
3526 documentation in doc/README.update for more details.
3527
wdenk6c59edc2004-05-03 20:45:30 +00003528 autoload - if set to "no" (any string beginning with 'n'),
3529 "bootp" will just load perform a lookup of the
3530 configuration from the BOOTP server, but not try to
3531 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003532
wdenk6c59edc2004-05-03 20:45:30 +00003533 autostart - if set to "yes", an image loaded using the "bootp",
3534 "rarpboot", "tftpboot" or "diskboot" commands will
3535 be automatically started (by internally calling
3536 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk6c59edc2004-05-03 20:45:30 +00003538 If set to "no", a standalone image passed to the
3539 "bootm" command will be copied to the load address
3540 (and eventually uncompressed), but NOT be started.
3541 This can be used to load and uncompress arbitrary
3542 data.
wdenkc6097192002-11-03 00:24:07 +00003543
David A. Longd558a4e2011-07-09 16:40:19 -04003544 fdt_high - if set this restricts the maximum address that the
3545 flattened device tree will be copied into upon boot.
3546 If this is set to the special value 0xFFFFFFFF then
3547 the fdt will not be copied at all on boot. For this
3548 to work it must reside in writable memory, have
3549 sufficient padding on the end of it for u-boot to
3550 add the information it needs into it, and the memory
3551 must be accessible by the kernel.
3552
Simon Glassdc6fa642011-10-24 19:15:34 +00003553 fdtcontroladdr- if set this is the address of the control flattened
3554 device tree used by U-Boot when CONFIG_OF_CONTROL is
3555 defined.
3556
wdenk0e2bd9c2004-06-06 21:51:03 +00003557 i2cfast - (PPC405GP|PPC405EP only)
3558 if set to 'y' configures Linux I2C driver for fast
3559 mode (400kHZ). This environment variable is used in
3560 initialization code. So, for changes to be effective
3561 it must be saved and board must be reset.
3562
wdenk6c59edc2004-05-03 20:45:30 +00003563 initrd_high - restrict positioning of initrd images:
3564 If this variable is not set, initrd images will be
3565 copied to the highest possible address in RAM; this
3566 is usually what you want since it allows for
3567 maximum initrd size. If for some reason you want to
3568 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003569 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003570 variable to a value of "no" or "off" or "0".
3571 Alternatively, you can set it to a maximum upper
3572 address to use (U-Boot will still check that it
3573 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk6c59edc2004-05-03 20:45:30 +00003575 For instance, when you have a system with 16 MB
3576 RAM, and want to reserve 4 MB from use by Linux,
3577 you can do this by adding "mem=12M" to the value of
3578 the "bootargs" variable. However, now you must make
3579 sure that the initrd image is placed in the first
3580 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003581
wdenk6c59edc2004-05-03 20:45:30 +00003582 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk6c59edc2004-05-03 20:45:30 +00003584 If you set initrd_high to 0xFFFFFFFF, this is an
3585 indication to U-Boot that all addresses are legal
3586 for the Linux kernel, including addresses in flash
3587 memory. In this case U-Boot will NOT COPY the
3588 ramdisk at all. This may be useful to reduce the
3589 boot time on your system, but requires that this
3590 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003591
wdenk6c59edc2004-05-03 20:45:30 +00003592 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003593
wdenk6c59edc2004-05-03 20:45:30 +00003594 loadaddr - Default load address for commands like "bootp",
3595 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk6c59edc2004-05-03 20:45:30 +00003597 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003598
wdenk6c59edc2004-05-03 20:45:30 +00003599 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003600
wdenk6c59edc2004-05-03 20:45:30 +00003601 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk6c59edc2004-05-03 20:45:30 +00003603 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk6c59edc2004-05-03 20:45:30 +00003605 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003606
Mike Frysingera23230c2011-10-02 10:01:27 +00003607 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003608
Mike Frysingera23230c2011-10-02 10:01:27 +00003609 ethact - controls which interface is currently active.
3610 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003611
Heiko Schocherc5e84052010-07-20 17:45:02 +02003612 => setenv ethact FEC
3613 => ping 192.168.0.1 # traffic sent on FEC
3614 => setenv ethact SCC
3615 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003616
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003617 ethrotate - When set to "no" U-Boot does not go through all
3618 available network interfaces.
3619 It just stays at the currently selected interface.
3620
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003621 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003622 either succeed or fail without retrying.
3623 When set to "once" the network operation will
3624 fail when all the available network interfaces
3625 are tried once without success.
3626 Useful on scripts which control the retry operation
3627 themselves.
wdenkc6097192002-11-03 00:24:07 +00003628
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003629 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003630
Wolfgang Denk227b5192005-09-24 23:25:46 +02003631 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003632 UDP source port.
3633
Wolfgang Denk227b5192005-09-24 23:25:46 +02003634 tftpdstport - If this is set, the value is used for TFTP's UDP
3635 destination port instead of the Well Know Port 69.
3636
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003637 tftpblocksize - Block size to use for TFTP transfers; if not set,
3638 we use the TFTP server's default block size
3639
3640 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3641 seconds, minimum value is 1000 = 1 second). Defines
3642 when a packet is considered to be lost so it has to
3643 be retransmitted. The default is 5000 = 5 seconds.
3644 Lowering this value may make downloads succeed
3645 faster in networks with high packet loss rates or
3646 with unreliable TFTP servers.
3647
3648 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003649 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003650 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003651
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003652The following image location variables contain the location of images
3653used in booting. The "Image" column gives the role of the image and is
3654not an environment variable name. The other columns are environment
3655variable names. "File Name" gives the name of the file on a TFTP
3656server, "RAM Address" gives the location in RAM the image will be
3657loaded to, and "Flash Location" gives the image's address in NOR
3658flash or offset in NAND flash.
3659
3660*Note* - these variables don't have to be defined for all boards, some
3661boards currenlty use other variables for these purposes, and some
3662boards use these variables for other purposes.
3663
Wolfgang Denk092ae952011-10-26 10:21:21 +00003664Image File Name RAM Address Flash Location
3665----- --------- ----------- --------------
3666u-boot u-boot u-boot_addr_r u-boot_addr
3667Linux kernel bootfile kernel_addr_r kernel_addr
3668device tree blob fdtfile fdt_addr_r fdt_addr
3669ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003670
wdenk6c59edc2004-05-03 20:45:30 +00003671The following environment variables may be used and automatically
3672updated by the network boot commands ("bootp" and "rarpboot"),
3673depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003674
wdenk6c59edc2004-05-03 20:45:30 +00003675 bootfile - see above
3676 dnsip - IP address of your Domain Name Server
3677 dnsip2 - IP address of your secondary Domain Name Server
3678 gatewayip - IP address of the Gateway (Router) to use
3679 hostname - Target hostname
3680 ipaddr - see above
3681 netmask - Subnet Mask
3682 rootpath - Pathname of the root filesystem on the NFS server
3683 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003684
wdenk145d2c12004-04-15 21:48:45 +00003685
wdenk6c59edc2004-05-03 20:45:30 +00003686There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003687
wdenk6c59edc2004-05-03 20:45:30 +00003688 serial# - contains hardware identification information such
3689 as type string and/or serial number
3690 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk6c59edc2004-05-03 20:45:30 +00003692These variables can be set only once (usually during manufacturing of
3693the board). U-Boot refuses to delete or overwrite these variables
3694once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003695
3696
wdenk6c59edc2004-05-03 20:45:30 +00003697Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003698
wdenk6c59edc2004-05-03 20:45:30 +00003699 ver - Contains the U-Boot version string as printed
3700 with the "version" command. This variable is
3701 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003702
wdenkc6097192002-11-03 00:24:07 +00003703
wdenk6c59edc2004-05-03 20:45:30 +00003704Please note that changes to some configuration parameters may take
3705only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003706
stroeseb9c17c52003-04-04 15:53:41 +00003707
wdenk6c59edc2004-05-03 20:45:30 +00003708Command Line Parsing:
3709=====================
stroeseb9c17c52003-04-04 15:53:41 +00003710
wdenk6c59edc2004-05-03 20:45:30 +00003711There are two different command line parsers available with U-Boot:
3712the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk6c59edc2004-05-03 20:45:30 +00003714Old, simple command line parser:
3715--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk6c59edc2004-05-03 20:45:30 +00003717- supports environment variables (through setenv / saveenv commands)
3718- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003719- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003720- special characters ('$', ';') can be escaped by prefixing with '\',
3721 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003722 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003723- You can also escape text by enclosing in single apostrophes, for example:
3724 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk6c59edc2004-05-03 20:45:30 +00003726Hush shell:
3727-----------
wdenkf4688a22003-05-28 08:06:31 +00003728
wdenk6c59edc2004-05-03 20:45:30 +00003729- similar to Bourne shell, with control structures like
3730 if...then...else...fi, for...do...done; while...do...done,
3731 until...do...done, ...
3732- supports environment ("global") variables (through setenv / saveenv
3733 commands) and local shell variables (through standard shell syntax
3734 "name=value"); only environment variables can be used with "run"
3735 command
wdenkf4688a22003-05-28 08:06:31 +00003736
wdenk6c59edc2004-05-03 20:45:30 +00003737General rules:
3738--------------
wdenkf4688a22003-05-28 08:06:31 +00003739
wdenk6c59edc2004-05-03 20:45:30 +00003740(1) If a command line (or an environment variable executed by a "run"
3741 command) contains several commands separated by semicolon, and
3742 one of these commands fails, then the remaining commands will be
3743 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003744
wdenk6c59edc2004-05-03 20:45:30 +00003745(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003746 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003747 command will cause "run" to terminate, i. e. the remaining
3748 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003749
wdenk6c59edc2004-05-03 20:45:30 +00003750Note for Redundant Ethernet Interfaces:
3751=======================================
wdenkf4688a22003-05-28 08:06:31 +00003752
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003753Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003754such configurations and is capable of automatic selection of a
3755"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003756
wdenk6c59edc2004-05-03 20:45:30 +00003757Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3758MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3759"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003760
wdenk6c59edc2004-05-03 20:45:30 +00003761If the network interface stores some valid MAC address (for instance
3762in SROM), this is used as default address if there is NO correspon-
3763ding setting in the environment; if the corresponding environment
3764variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003765
wdenk6c59edc2004-05-03 20:45:30 +00003766o If the SROM has a valid MAC address, and there is no address in the
3767 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk6c59edc2004-05-03 20:45:30 +00003769o If there is no valid address in the SROM, and a definition in the
3770 environment exists, then the value from the environment variable is
3771 used.
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk6c59edc2004-05-03 20:45:30 +00003773o If both the SROM and the environment contain a MAC address, and
3774 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk6c59edc2004-05-03 20:45:30 +00003776o If both the SROM and the environment contain a MAC address, and the
3777 addresses differ, the value from the environment is used and a
3778 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk6c59edc2004-05-03 20:45:30 +00003780o If neither SROM nor the environment contain a MAC address, an error
3781 is raised.
wdenkc6097192002-11-03 00:24:07 +00003782
Ben Warren6db991a2010-04-26 11:11:46 -07003783If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003784will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003785may be skipped by setting the appropriate 'ethmacskip' environment variable.
3786The naming convention is as follows:
3787"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003788
wdenk6c59edc2004-05-03 20:45:30 +00003789Image Formats:
3790==============
wdenkc6097192002-11-03 00:24:07 +00003791
Marian Balakowicz18710b82008-03-12 12:13:13 +01003792U-Boot is capable of booting (and performing other auxiliary operations on)
3793images in two formats:
3794
3795New uImage format (FIT)
3796-----------------------
3797
3798Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3799to Flattened Device Tree). It allows the use of images with multiple
3800components (several kernels, ramdisks, etc.), with contents protected by
3801SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3802
3803
3804Old uImage format
3805-----------------
3806
3807Old image format is based on binary files which can be basically anything,
3808preceded by a special header; see the definitions in include/image.h for
3809details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk6c59edc2004-05-03 20:45:30 +00003811* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3812 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003813 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3814 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3815 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02003816* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003817 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3818 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003819* Compression Type (uncompressed, gzip, bzip2)
3820* Load Address
3821* Entry Point
3822* Image Name
3823* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003824
wdenk6c59edc2004-05-03 20:45:30 +00003825The header is marked by a special Magic Number, and both the header
3826and the data portions of the image are secured against corruption by
3827CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003828
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk6c59edc2004-05-03 20:45:30 +00003830Linux Support:
3831==============
wdenkc6097192002-11-03 00:24:07 +00003832
wdenk6c59edc2004-05-03 20:45:30 +00003833Although U-Boot should support any OS or standalone application
3834easily, the main focus has always been on Linux during the design of
3835U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003836
wdenk6c59edc2004-05-03 20:45:30 +00003837U-Boot includes many features that so far have been part of some
3838special "boot loader" code within the Linux kernel. Also, any
3839"initrd" images to be used are no longer part of one big Linux image;
3840instead, kernel and "initrd" are separate images. This implementation
3841serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk6c59edc2004-05-03 20:45:30 +00003843- the same features can be used for other OS or standalone
3844 applications (for instance: using compressed images to reduce the
3845 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk6c59edc2004-05-03 20:45:30 +00003847- it becomes much easier to port new Linux kernel versions because
3848 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk6c59edc2004-05-03 20:45:30 +00003850- the same Linux kernel image can now be used with different "initrd"
3851 images; of course this also means that different kernel images can
3852 be run with the same "initrd". This makes testing easier (you don't
3853 have to build a new "zImage.initrd" Linux image when you just
3854 change a file in your "initrd"). Also, a field-upgrade of the
3855 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003856
wdenkc6097192002-11-03 00:24:07 +00003857
wdenk6c59edc2004-05-03 20:45:30 +00003858Linux HOWTO:
3859============
wdenkc6097192002-11-03 00:24:07 +00003860
wdenk6c59edc2004-05-03 20:45:30 +00003861Porting Linux to U-Boot based systems:
3862---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk6c59edc2004-05-03 20:45:30 +00003864U-Boot cannot save you from doing all the necessary modifications to
3865configure the Linux device drivers for use with your target hardware
3866(no, we don't intend to provide a full virtual machine interface to
3867Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003868
Stefan Roese88fbf932010-04-15 16:07:28 +02003869But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003870
wdenk6c59edc2004-05-03 20:45:30 +00003871Just make sure your machine specific header file (for instance
3872include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003873Information structure as we define in include/asm-<arch>/u-boot.h,
3874and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003875as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003876
wdenkc6097192002-11-03 00:24:07 +00003877
wdenk6c59edc2004-05-03 20:45:30 +00003878Configuring the Linux kernel:
3879-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003880
wdenk6c59edc2004-05-03 20:45:30 +00003881No specific requirements for U-Boot. Make sure you have some root
3882device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003883
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk6c59edc2004-05-03 20:45:30 +00003885Building a Linux Image:
3886-----------------------
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk6c59edc2004-05-03 20:45:30 +00003888With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3889not used. If you use recent kernel source, a new build target
3890"uImage" will exist which automatically builds an image usable by
3891U-Boot. Most older kernels also have support for a "pImage" target,
3892which was introduced for our predecessor project PPCBoot and uses a
3893100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk6c59edc2004-05-03 20:45:30 +00003895Example:
wdenkc6097192002-11-03 00:24:07 +00003896
wdenk6c59edc2004-05-03 20:45:30 +00003897 make TQM850L_config
3898 make oldconfig
3899 make dep
3900 make uImage
wdenkc6097192002-11-03 00:24:07 +00003901
wdenk6c59edc2004-05-03 20:45:30 +00003902The "uImage" build target uses a special tool (in 'tools/mkimage') to
3903encapsulate a compressed Linux kernel image with header information,
3904CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk6c59edc2004-05-03 20:45:30 +00003906* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003907
wdenk6c59edc2004-05-03 20:45:30 +00003908* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003909
wdenk6c59edc2004-05-03 20:45:30 +00003910 ${CROSS_COMPILE}-objcopy -O binary \
3911 -R .note -R .comment \
3912 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003913
wdenk6c59edc2004-05-03 20:45:30 +00003914* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003915
wdenk6c59edc2004-05-03 20:45:30 +00003916 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003917
wdenk6c59edc2004-05-03 20:45:30 +00003918* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003919
wdenk6c59edc2004-05-03 20:45:30 +00003920 mkimage -A ppc -O linux -T kernel -C gzip \
3921 -a 0 -e 0 -n "Linux Kernel Image" \
3922 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003923
wdenkc6097192002-11-03 00:24:07 +00003924
wdenk6c59edc2004-05-03 20:45:30 +00003925The "mkimage" tool can also be used to create ramdisk images for use
3926with U-Boot, either separated from the Linux kernel image, or
3927combined into one file. "mkimage" encapsulates the images with a 64
3928byte header containing information about target architecture,
3929operating system, image type, compression method, entry points, time
3930stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003931
wdenk6c59edc2004-05-03 20:45:30 +00003932"mkimage" can be called in two ways: to verify existing images and
3933print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003934
wdenk6c59edc2004-05-03 20:45:30 +00003935In the first form (with "-l" option) mkimage lists the information
3936contained in the header of an existing U-Boot image; this includes
3937checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003938
wdenk6c59edc2004-05-03 20:45:30 +00003939 tools/mkimage -l image
3940 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003941
wdenk6c59edc2004-05-03 20:45:30 +00003942The second form (with "-d" option) is used to build a U-Boot image
3943from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003944
wdenk6c59edc2004-05-03 20:45:30 +00003945 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3946 -n name -d data_file image
3947 -A ==> set architecture to 'arch'
3948 -O ==> set operating system to 'os'
3949 -T ==> set image type to 'type'
3950 -C ==> set compression type 'comp'
3951 -a ==> set load address to 'addr' (hex)
3952 -e ==> set entry point to 'ep' (hex)
3953 -n ==> set image name to 'name'
3954 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003955
wdenkcd914452004-05-29 16:53:29 +00003956Right now, all Linux kernels for PowerPC systems use the same load
3957address (0x00000000), but the entry point address depends on the
3958kernel version:
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk6c59edc2004-05-03 20:45:30 +00003960- 2.2.x kernels have the entry point at 0x0000000C,
3961- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk6c59edc2004-05-03 20:45:30 +00003963So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk6c59edc2004-05-03 20:45:30 +00003965 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3966 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003967 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003968 > examples/uImage.TQM850L
3969 Image Name: 2.4.4 kernel for TQM850L
3970 Created: Wed Jul 19 02:34:59 2000
3971 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3972 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3973 Load Address: 0x00000000
3974 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk6c59edc2004-05-03 20:45:30 +00003976To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003977
wdenk6c59edc2004-05-03 20:45:30 +00003978 -> tools/mkimage -l examples/uImage.TQM850L
3979 Image Name: 2.4.4 kernel for TQM850L
3980 Created: Wed Jul 19 02:34:59 2000
3981 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3982 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3983 Load Address: 0x00000000
3984 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003985
wdenk6c59edc2004-05-03 20:45:30 +00003986NOTE: for embedded systems where boot time is critical you can trade
3987speed for memory and install an UNCOMPRESSED image instead: this
3988needs more space in Flash, but boots much faster since it does not
3989need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003990
Stefan Roese88fbf932010-04-15 16:07:28 +02003991 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00003992 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3993 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003994 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00003995 > examples/uImage.TQM850L-uncompressed
3996 Image Name: 2.4.4 kernel for TQM850L
3997 Created: Wed Jul 19 02:34:59 2000
3998 Image Type: PowerPC Linux Kernel Image (uncompressed)
3999 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4000 Load Address: 0x00000000
4001 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004002
wdenkc6097192002-11-03 00:24:07 +00004003
wdenk6c59edc2004-05-03 20:45:30 +00004004Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4005when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004006
wdenk6c59edc2004-05-03 20:45:30 +00004007 -> tools/mkimage -n 'Simple Ramdisk Image' \
4008 > -A ppc -O linux -T ramdisk -C gzip \
4009 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4010 Image Name: Simple Ramdisk Image
4011 Created: Wed Jan 12 14:01:50 2000
4012 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4013 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4014 Load Address: 0x00000000
4015 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004016
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk6c59edc2004-05-03 20:45:30 +00004018Installing a Linux Image:
4019-------------------------
wdenkc6097192002-11-03 00:24:07 +00004020
wdenk6c59edc2004-05-03 20:45:30 +00004021To downloading a U-Boot image over the serial (console) interface,
4022you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk6c59edc2004-05-03 20:45:30 +00004024 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004025
wdenk6c59edc2004-05-03 20:45:30 +00004026The 'objcopy' does not understand the information in the U-Boot
4027image header, so the resulting S-Record file will be relative to
4028address 0x00000000. To load it to a given address, you need to
4029specify the target address as 'offset' parameter with the 'loads'
4030command.
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk6c59edc2004-05-03 20:45:30 +00004032Example: install the image to address 0x40100000 (which on the
4033TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk6c59edc2004-05-03 20:45:30 +00004035 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk6c59edc2004-05-03 20:45:30 +00004037 .......... done
4038 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004039
wdenk6c59edc2004-05-03 20:45:30 +00004040 => loads 40100000
4041 ## Ready for S-Record download ...
4042 ~>examples/image.srec
4043 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4044 ...
4045 15989 15990 15991 15992
4046 [file transfer complete]
4047 [connected]
4048 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004049
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk6c59edc2004-05-03 20:45:30 +00004051You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004052this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004053corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk6c59edc2004-05-03 20:45:30 +00004055 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004056
wdenk6c59edc2004-05-03 20:45:30 +00004057 ## Checking Image at 40100000 ...
4058 Image Name: 2.2.13 for initrd on TQM850L
4059 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4060 Data Size: 335725 Bytes = 327 kB = 0 MB
4061 Load Address: 00000000
4062 Entry Point: 0000000c
4063 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004064
4065
wdenk6c59edc2004-05-03 20:45:30 +00004066Boot Linux:
4067-----------
wdenkc6097192002-11-03 00:24:07 +00004068
wdenk6c59edc2004-05-03 20:45:30 +00004069The "bootm" command is used to boot an application that is stored in
4070memory (RAM or Flash). In case of a Linux kernel image, the contents
4071of the "bootargs" environment variable is passed to the kernel as
4072parameters. You can check and modify this variable using the
4073"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004074
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk6c59edc2004-05-03 20:45:30 +00004076 => printenv bootargs
4077 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk6c59edc2004-05-03 20:45:30 +00004079 => 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 +00004080
wdenk6c59edc2004-05-03 20:45:30 +00004081 => printenv bootargs
4082 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 +00004083
wdenk6c59edc2004-05-03 20:45:30 +00004084 => bootm 40020000
4085 ## Booting Linux kernel at 40020000 ...
4086 Image Name: 2.2.13 for NFS on TQM850L
4087 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4088 Data Size: 381681 Bytes = 372 kB = 0 MB
4089 Load Address: 00000000
4090 Entry Point: 0000000c
4091 Verifying Checksum ... OK
4092 Uncompressing Kernel Image ... OK
4093 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
4094 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4095 time_init: decrementer frequency = 187500000/60
4096 Calibrating delay loop... 49.77 BogoMIPS
4097 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4098 ...
wdenkc6097192002-11-03 00:24:07 +00004099
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004100If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004101the memory addresses of both the kernel and the initrd image (PPBCOOT
4102format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004103
wdenk6c59edc2004-05-03 20:45:30 +00004104 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004105
wdenk6c59edc2004-05-03 20:45:30 +00004106 ## Checking Image at 40100000 ...
4107 Image Name: 2.2.13 for initrd on TQM850L
4108 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4109 Data Size: 335725 Bytes = 327 kB = 0 MB
4110 Load Address: 00000000
4111 Entry Point: 0000000c
4112 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk6c59edc2004-05-03 20:45:30 +00004114 ## Checking Image at 40200000 ...
4115 Image Name: Simple Ramdisk Image
4116 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4117 Data Size: 566530 Bytes = 553 kB = 0 MB
4118 Load Address: 00000000
4119 Entry Point: 00000000
4120 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004121
wdenk6c59edc2004-05-03 20:45:30 +00004122 => bootm 40100000 40200000
4123 ## Booting Linux kernel at 40100000 ...
4124 Image Name: 2.2.13 for initrd on TQM850L
4125 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4126 Data Size: 335725 Bytes = 327 kB = 0 MB
4127 Load Address: 00000000
4128 Entry Point: 0000000c
4129 Verifying Checksum ... OK
4130 Uncompressing Kernel Image ... OK
4131 ## Loading RAMDisk Image at 40200000 ...
4132 Image Name: Simple Ramdisk Image
4133 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4134 Data Size: 566530 Bytes = 553 kB = 0 MB
4135 Load Address: 00000000
4136 Entry Point: 00000000
4137 Verifying Checksum ... OK
4138 Loading Ramdisk ... OK
4139 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
4140 Boot arguments: root=/dev/ram
4141 time_init: decrementer frequency = 187500000/60
4142 Calibrating delay loop... 49.77 BogoMIPS
4143 ...
4144 RAMDISK: Compressed image found at block 0
4145 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004146
wdenk6c59edc2004-05-03 20:45:30 +00004147 bash#
wdenkc6097192002-11-03 00:24:07 +00004148
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004149Boot Linux and pass a flat device tree:
4150-----------
4151
4152First, U-Boot must be compiled with the appropriate defines. See the section
4153titled "Linux Kernel Interface" above for a more in depth explanation. The
4154following is an example of how to start a kernel and pass an updated
4155flat device tree:
4156
4157=> print oftaddr
4158oftaddr=0x300000
4159=> print oft
4160oft=oftrees/mpc8540ads.dtb
4161=> tftp $oftaddr $oft
4162Speed: 1000, full duplex
4163Using TSEC0 device
4164TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4165Filename 'oftrees/mpc8540ads.dtb'.
4166Load address: 0x300000
4167Loading: #
4168done
4169Bytes transferred = 4106 (100a hex)
4170=> tftp $loadaddr $bootfile
4171Speed: 1000, full duplex
4172Using TSEC0 device
4173TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4174Filename 'uImage'.
4175Load address: 0x200000
4176Loading:############
4177done
4178Bytes transferred = 1029407 (fb51f hex)
4179=> print loadaddr
4180loadaddr=200000
4181=> print oftaddr
4182oftaddr=0x300000
4183=> bootm $loadaddr - $oftaddr
4184## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004185 Image Name: Linux-2.6.17-dirty
4186 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4187 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004188 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004189 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004190 Verifying Checksum ... OK
4191 Uncompressing Kernel Image ... OK
4192Booting using flat device tree at 0x300000
4193Using MPC85xx ADS machine description
4194Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4195[snip]
4196
4197
wdenk6c59edc2004-05-03 20:45:30 +00004198More About U-Boot Image Types:
4199------------------------------
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk6c59edc2004-05-03 20:45:30 +00004201U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004202
wdenk6c59edc2004-05-03 20:45:30 +00004203 "Standalone Programs" are directly runnable in the environment
4204 provided by U-Boot; it is expected that (if they behave
4205 well) you can continue to work in U-Boot after return from
4206 the Standalone Program.
4207 "OS Kernel Images" are usually images of some Embedded OS which
4208 will take over control completely. Usually these programs
4209 will install their own set of exception handlers, device
4210 drivers, set up the MMU, etc. - this means, that you cannot
4211 expect to re-enter U-Boot except by resetting the CPU.
4212 "RAMDisk Images" are more or less just data blocks, and their
4213 parameters (address, size) are passed to an OS kernel that is
4214 being started.
4215 "Multi-File Images" contain several images, typically an OS
4216 (Linux) kernel image and one or more data images like
4217 RAMDisks. This construct is useful for instance when you want
4218 to boot over the network using BOOTP etc., where the boot
4219 server provides just a single image file, but you want to get
4220 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004221
wdenk6c59edc2004-05-03 20:45:30 +00004222 "Multi-File Images" start with a list of image sizes, each
4223 image size (in bytes) specified by an "uint32_t" in network
4224 byte order. This list is terminated by an "(uint32_t)0".
4225 Immediately after the terminating 0 follow the images, one by
4226 one, all aligned on "uint32_t" boundaries (size rounded up to
4227 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk6c59edc2004-05-03 20:45:30 +00004229 "Firmware Images" are binary images containing firmware (like
4230 U-Boot or FPGA images) which usually will be programmed to
4231 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004232
wdenk6c59edc2004-05-03 20:45:30 +00004233 "Script files" are command sequences that will be executed by
4234 U-Boot's command interpreter; this feature is especially
4235 useful when you configure U-Boot to use a real shell (hush)
4236 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004237
stroeseb9c17c52003-04-04 15:53:41 +00004238
wdenk6c59edc2004-05-03 20:45:30 +00004239Standalone HOWTO:
4240=================
stroeseb9c17c52003-04-04 15:53:41 +00004241
wdenk6c59edc2004-05-03 20:45:30 +00004242One of the features of U-Boot is that you can dynamically load and
4243run "standalone" applications, which can use some resources of
4244U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004247
wdenk6c59edc2004-05-03 20:45:30 +00004248"Hello World" Demo:
4249-------------------
wdenkc6097192002-11-03 00:24:07 +00004250
wdenk6c59edc2004-05-03 20:45:30 +00004251'examples/hello_world.c' contains a small "Hello World" Demo
4252application; it is automatically compiled when you build U-Boot.
4253It's configured to run at address 0x00040004, so you can play with it
4254like that:
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk6c59edc2004-05-03 20:45:30 +00004256 => loads
4257 ## Ready for S-Record download ...
4258 ~>examples/hello_world.srec
4259 1 2 3 4 5 6 7 8 9 10 11 ...
4260 [file transfer complete]
4261 [connected]
4262 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk6c59edc2004-05-03 20:45:30 +00004264 => go 40004 Hello World! This is a test.
4265 ## Starting application at 0x00040004 ...
4266 Hello World
4267 argc = 7
4268 argv[0] = "40004"
4269 argv[1] = "Hello"
4270 argv[2] = "World!"
4271 argv[3] = "This"
4272 argv[4] = "is"
4273 argv[5] = "a"
4274 argv[6] = "test."
4275 argv[7] = "<NULL>"
4276 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004277
wdenk6c59edc2004-05-03 20:45:30 +00004278 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004279
wdenk6c59edc2004-05-03 20:45:30 +00004280Another example, which demonstrates how to register a CPM interrupt
4281handler with the U-Boot code, can be found in 'examples/timer.c'.
4282Here, a CPM timer is set up to generate an interrupt every second.
4283The interrupt service routine is trivial, just printing a '.'
4284character, but this is just a demo program. The application can be
4285controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk6c59edc2004-05-03 20:45:30 +00004287 ? - print current values og the CPM Timer registers
4288 b - enable interrupts and start timer
4289 e - stop timer and disable interrupts
4290 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk6c59edc2004-05-03 20:45:30 +00004292 => loads
4293 ## Ready for S-Record download ...
4294 ~>examples/timer.srec
4295 1 2 3 4 5 6 7 8 9 10 11 ...
4296 [file transfer complete]
4297 [connected]
4298 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk6c59edc2004-05-03 20:45:30 +00004300 => go 40004
4301 ## Starting application at 0x00040004 ...
4302 TIMERS=0xfff00980
4303 Using timer 1
4304 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk6c59edc2004-05-03 20:45:30 +00004306Hit 'b':
4307 [q, b, e, ?] Set interval 1000000 us
4308 Enabling timer
4309Hit '?':
4310 [q, b, e, ?] ........
4311 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4312Hit '?':
4313 [q, b, e, ?] .
4314 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4315Hit '?':
4316 [q, b, e, ?] .
4317 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4318Hit '?':
4319 [q, b, e, ?] .
4320 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4321Hit 'e':
4322 [q, b, e, ?] ...Stopping timer
4323Hit 'q':
4324 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004325
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk6c59edc2004-05-03 20:45:30 +00004327Minicom warning:
4328================
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk6c59edc2004-05-03 20:45:30 +00004330Over time, many people have reported problems when trying to use the
4331"minicom" terminal emulation program for serial download. I (wd)
4332consider minicom to be broken, and recommend not to use it. Under
4333Unix, I recommend to use C-Kermit for general purpose use (and
4334especially for kermit binary protocol download ("loadb" command), and
4335use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk6c59edc2004-05-03 20:45:30 +00004337Nevertheless, if you absolutely want to use it try adding this
4338configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004339
wdenk6c59edc2004-05-03 20:45:30 +00004340 Name Program Name U/D FullScr IO-Red. Multi
4341 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4342 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004343
wdenk8dba0502003-03-31 16:34:49 +00004344
wdenk6c59edc2004-05-03 20:45:30 +00004345NetBSD Notes:
4346=============
wdenkc6097192002-11-03 00:24:07 +00004347
wdenk6c59edc2004-05-03 20:45:30 +00004348Starting at version 0.9.2, U-Boot supports NetBSD both as host
4349(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004350
wdenk6c59edc2004-05-03 20:45:30 +00004351Building requires a cross environment; it is known to work on
4352NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4353need gmake since the Makefiles are not compatible with BSD make).
4354Note that the cross-powerpc package does not install include files;
4355attempting to build U-Boot will fail because <machine/ansi.h> is
4356missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004357
wdenk6c59edc2004-05-03 20:45:30 +00004358 # cd /usr/pkg/cross/powerpc-netbsd/include
4359 # mkdir powerpc
4360 # ln -s powerpc machine
4361 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4362 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004363
wdenk6c59edc2004-05-03 20:45:30 +00004364Native builds *don't* work due to incompatibilities between native
4365and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367Booting assumes that (the first part of) the image booted is a
4368stage-2 loader which in turn loads and then invokes the kernel
4369proper. Loader sources will eventually appear in the NetBSD source
4370tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004371meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004372
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk6c59edc2004-05-03 20:45:30 +00004374Implementation Internals:
4375=========================
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk6c59edc2004-05-03 20:45:30 +00004377The following is not intended to be a complete description of every
4378implementation detail. However, it should help to understand the
4379inner workings of U-Boot and make it easier to port it to custom
4380hardware.
wdenkc6097192002-11-03 00:24:07 +00004381
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk6c59edc2004-05-03 20:45:30 +00004383Initial Stack, Global Data:
4384---------------------------
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk6c59edc2004-05-03 20:45:30 +00004386The implementation of U-Boot is complicated by the fact that U-Boot
4387starts running out of ROM (flash memory), usually without access to
4388system RAM (because the memory controller is not initialized yet).
4389This means that we don't have writable Data or BSS segments, and BSS
4390is not initialized as zero. To be able to get a C environment working
4391at all, we have to allocate at least a minimal stack. Implementation
4392options for this are defined and restricted by the CPU used: Some CPU
4393models provide on-chip memory (like the IMMR area on MPC8xx and
4394MPC826x processors), on others (parts of) the data cache can be
4395locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004396
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004397 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004398 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk6c59edc2004-05-03 20:45:30 +00004400 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4401 From: "Chris Hallinan" <clh@net1plus.com>
4402 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4403 ...
wdenkc6097192002-11-03 00:24:07 +00004404
wdenk6c59edc2004-05-03 20:45:30 +00004405 Correct me if I'm wrong, folks, but the way I understand it
4406 is this: Using DCACHE as initial RAM for Stack, etc, does not
4407 require any physical RAM backing up the cache. The cleverness
4408 is that the cache is being used as a temporary supply of
4409 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004410 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004411 can see how this works by studying the cache architecture and
4412 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004413
wdenk6c59edc2004-05-03 20:45:30 +00004414 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4415 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004416 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004417 option should work for you. Using CS 4 should be fine if your
4418 board designers haven't used it for something that would
4419 cause you grief during the initial boot! It is frequently not
4420 used.
wdenkc6097192002-11-03 00:24:07 +00004421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004422 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004423 with your processor/board/system design. The default value
4424 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004425 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004426 than your SDRAM module. If you have a 64MB SDRAM module, set
4427 it above 400_0000. Just make sure your board has no resources
4428 that are supposed to respond to that address! That code in
4429 start.S has been around a while and should work as is when
4430 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004431
wdenk6c59edc2004-05-03 20:45:30 +00004432 -Chris Hallinan
4433 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004434
wdenk6c59edc2004-05-03 20:45:30 +00004435It is essential to remember this, since it has some impact on the C
4436code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004437
wdenk6c59edc2004-05-03 20:45:30 +00004438* Initialized global data (data segment) is read-only. Do not attempt
4439 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004440
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004441* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00004442 as zero data - BSS segment) at all - this is undefined, initiali-
4443 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004444
wdenk6c59edc2004-05-03 20:45:30 +00004445* Stack space is very limited. Avoid big data buffers or things like
4446 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448Having only the stack as writable memory limits means we cannot use
4449normal global data to share information beween the code. But it
4450turned out that the implementation of U-Boot can be greatly
4451simplified by making a global data structure (gd_t) available to all
4452functions. We could pass a pointer to this data as argument to _all_
4453functions, but this would bloat the code. Instead we use a feature of
4454the GCC compiler (Global Register Variables) to share the data: we
4455place a pointer (gd) to the global data into a register which we
4456reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004457
wdenk6c59edc2004-05-03 20:45:30 +00004458When choosing a register for such a purpose we are restricted by the
4459relevant (E)ABI specifications for the current architecture, and by
4460GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk6c59edc2004-05-03 20:45:30 +00004462For PowerPC, the following registers have specific use:
4463 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004464 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004465 R3-R4: parameter passing and return values
4466 R5-R10: parameter passing
4467 R13: small data area pointer
4468 R30: GOT pointer
4469 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004470
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004471 (U-Boot also uses R12 as internal GOT pointer. r12
4472 is a volatile register so r12 needs to be reset when
4473 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004474
Wolfgang Denk69c09642008-02-14 22:43:22 +01004475 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk6c59edc2004-05-03 20:45:30 +00004477 Note: on PPC, we could use a static initializer (since the
4478 address of the global data structure is known at compile time),
4479 but it turned out that reserving a register results in somewhat
4480 smaller code - although the code savings are not that big (on
4481 average for all boards 752 bytes for the whole U-Boot image,
4482 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004483
Robin Getz2773d5f2009-08-17 15:23:02 +00004484On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05004485 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4486
Robin Getz2773d5f2009-08-17 15:23:02 +00004487 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05004488
wdenk6c59edc2004-05-03 20:45:30 +00004489On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk6c59edc2004-05-03 20:45:30 +00004491 R0: function argument word/integer result
4492 R1-R3: function argument word
4493 R9: GOT pointer
4494 R10: stack limit (used only if stack checking if enabled)
4495 R11: argument (frame) pointer
4496 R12: temporary workspace
4497 R13: stack pointer
4498 R14: link register
4499 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004500
wdenk6c59edc2004-05-03 20:45:30 +00004501 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004502
Thomas Chou8fa38582010-05-21 11:08:03 +08004503On Nios II, the ABI is documented here:
4504 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4505
4506 ==> U-Boot will use gp to hold a pointer to the global data
4507
4508 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4509 to access small data sections, so gp is free.
4510
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004511On NDS32, the following registers are used:
4512
4513 R0-R1: argument/return
4514 R2-R5: argument
4515 R15: temporary register for assembler
4516 R16: trampoline register
4517 R28: frame pointer (FP)
4518 R29: global pointer (GP)
4519 R30: link register (LP)
4520 R31: stack pointer (SP)
4521 PC: program counter (PC)
4522
4523 ==> U-Boot will use R10 to hold a pointer to the global data
4524
Wolfgang Denk6405a152006-03-31 18:32:53 +02004525NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4526or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk6c59edc2004-05-03 20:45:30 +00004528Memory Management:
4529------------------
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk6c59edc2004-05-03 20:45:30 +00004531U-Boot runs in system state and uses physical addresses, i.e. the
4532MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004533
wdenk6c59edc2004-05-03 20:45:30 +00004534The available memory is mapped to fixed addresses using the memory
4535controller. In this process, a contiguous block is formed for each
4536memory type (Flash, SDRAM, SRAM), even when it consists of several
4537physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk6c59edc2004-05-03 20:45:30 +00004539U-Boot is installed in the first 128 kB of the first Flash bank (on
4540TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4541booting and sizing and initializing DRAM, the code relocates itself
4542to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004543memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004544configuration setting]. Below that, a structure with global Board
4545Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547Additionally, some exception handler code is copied to the low 8 kB
4548of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550So a typical memory configuration with 16 MB of DRAM could look like
4551this:
wdenkc6097192002-11-03 00:24:07 +00004552
wdenk6c59edc2004-05-03 20:45:30 +00004553 0x0000 0000 Exception Vector code
4554 :
4555 0x0000 1FFF
4556 0x0000 2000 Free for Application Use
4557 :
4558 :
wdenkc6097192002-11-03 00:24:07 +00004559
wdenk6c59edc2004-05-03 20:45:30 +00004560 :
4561 :
4562 0x00FB FF20 Monitor Stack (Growing downward)
4563 0x00FB FFAC Board Info Data and permanent copy of global data
4564 0x00FC 0000 Malloc Arena
4565 :
4566 0x00FD FFFF
4567 0x00FE 0000 RAM Copy of Monitor Code
4568 ... eventually: LCD or video framebuffer
4569 ... eventually: pRAM (Protected RAM - unchanged by reset)
4570 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004571
wdenkc6097192002-11-03 00:24:07 +00004572
wdenk6c59edc2004-05-03 20:45:30 +00004573System Initialization:
4574----------------------
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk6c59edc2004-05-03 20:45:30 +00004576In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004577(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00004578configuration for CS0# this is a mirror of the onboard Flash memory.
4579To be able to re-map memory U-Boot then jumps to its link address.
4580To be able to implement the initialization code in C, a (small!)
4581initial stack is set up in the internal Dual Ported RAM (in case CPUs
4582which provide such a feature like MPC8xx or MPC8260), or in a locked
4583part of the data cache. After that, U-Boot initializes the CPU core,
4584the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004585
wdenk6c59edc2004-05-03 20:45:30 +00004586Next, all (potentially) available memory banks are mapped using a
4587preliminary mapping. For example, we put them on 512 MB boundaries
4588(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4589on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4590programmed for SDRAM access. Using the temporary configuration, a
4591simple memory test is run that determines the size of the SDRAM
4592banks.
wdenkc6097192002-11-03 00:24:07 +00004593
wdenk6c59edc2004-05-03 20:45:30 +00004594When there is more than one SDRAM bank, and the banks are of
4595different size, the largest is mapped first. For equal size, the first
4596bank (CS2#) is mapped first. The first mapping is always for address
45970x00000000, with any additional banks following immediately to create
4598contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk6c59edc2004-05-03 20:45:30 +00004600Then, the monitor installs itself at the upper end of the SDRAM area
4601and allocates memory for use by malloc() and for the global Board
4602Info data; also, the exception vector code is copied to the low RAM
4603pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk6c59edc2004-05-03 20:45:30 +00004605Only after this relocation will you have a "normal" C environment;
4606until that you are restricted in several ways, mostly because you are
4607running from ROM, and because the code will have to be relocated to a
4608new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004609
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk6c59edc2004-05-03 20:45:30 +00004611U-Boot Porting Guide:
4612----------------------
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk6c59edc2004-05-03 20:45:30 +00004614[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4615list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004616
wdenkc6097192002-11-03 00:24:07 +00004617
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004618int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004619{
4620 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004621
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004622 signal(SIGALRM, no_more_time);
4623 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004624
wdenk6c59edc2004-05-03 20:45:30 +00004625 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004626 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004627 return 0;
4628 }
wdenkc6097192002-11-03 00:24:07 +00004629
wdenk6c59edc2004-05-03 20:45:30 +00004630 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004631
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004632 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004633
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004634 if (clueless)
4635 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637 while (learning) {
4638 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004639 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4640 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00004641 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004642 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004643 }
wdenkc6097192002-11-03 00:24:07 +00004644
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004645 if (available_money > toLocalCurrency ($2500))
4646 Buy a BDI3000;
4647 else
wdenk6c59edc2004-05-03 20:45:30 +00004648 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004649
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004650 if (a similar board exists) { /* hopefully... */
4651 cp -a board/<similar> board/<myboard>
4652 cp include/configs/<similar>.h include/configs/<myboard>.h
4653 } else {
4654 Create your own board support subdirectory;
4655 Create your own board include/configs/<myboard>.h file;
4656 }
4657 Edit new board/<myboard> files
4658 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004659
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004660 while (!accepted) {
4661 while (!running) {
4662 do {
4663 Add / modify source code;
4664 } until (compiles);
4665 Debug;
4666 if (clueless)
4667 email("Hi, I am having problems...");
4668 }
4669 Send patch file to the U-Boot email list;
4670 if (reasonable critiques)
4671 Incorporate improvements from email list code review;
4672 else
4673 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004674 }
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk6c59edc2004-05-03 20:45:30 +00004676 return 0;
4677}
wdenkc6097192002-11-03 00:24:07 +00004678
wdenk6c59edc2004-05-03 20:45:30 +00004679void no_more_time (int sig)
4680{
4681 hire_a_guru();
4682}
wdenkc6097192002-11-03 00:24:07 +00004683
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685Coding Standards:
4686-----------------
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02004689coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004690"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004691
4692Source files originating from a different project (for example the
4693MTD subsystem) are generally exempt from these guidelines and are not
4694reformated to ease subsequent migration to newer versions of those
4695sources.
wdenkc6097192002-11-03 00:24:07 +00004696
Detlev Zundelaa63d482006-09-01 15:39:02 +02004697Please note that U-Boot is implemented in C (and to some small parts in
4698Assembler); no C++ is used, so please do not use C++ style comments (//)
4699in your code.
wdenkad276f22004-01-04 16:28:35 +00004700
wdenk6c59edc2004-05-03 20:45:30 +00004701Please also stick to the following formatting rules:
4702- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004703- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004704- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004705- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004706- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004707
wdenk6c59edc2004-05-03 20:45:30 +00004708Submissions which do not conform to the standards may be returned
4709with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004710
wdenkc6097192002-11-03 00:24:07 +00004711
wdenk6c59edc2004-05-03 20:45:30 +00004712Submitting Patches:
4713-------------------
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk6c59edc2004-05-03 20:45:30 +00004715Since the number of patches for U-Boot is growing, we need to
4716establish some rules. Submissions which do not conform to these rules
4717may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004718
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004719Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004720
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004721Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4722see http://lists.denx.de/mailman/listinfo/u-boot
4723
wdenk6c59edc2004-05-03 20:45:30 +00004724When you send a patch, please include the following information with
4725it:
wdenkc6097192002-11-03 00:24:07 +00004726
wdenk6c59edc2004-05-03 20:45:30 +00004727* For bug fixes: a description of the bug and how your patch fixes
4728 this bug. Please try to include a way of demonstrating that the
4729 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk6c59edc2004-05-03 20:45:30 +00004731* For new features: a description of the feature and your
4732 implementation.
wdenkc6097192002-11-03 00:24:07 +00004733
wdenk6c59edc2004-05-03 20:45:30 +00004734* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004735
wdenk6c59edc2004-05-03 20:45:30 +00004736* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk6c59edc2004-05-03 20:45:30 +00004738* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004739 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00004740
wdenk6c59edc2004-05-03 20:45:30 +00004741* If your patch adds new configuration options, don't forget to
4742 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004743
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004744* The patch itself. If you are using git (which is *strongly*
4745 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004746 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004747 the U-Boot mailing list, you will avoid most of the common problems
4748 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004749
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004750 If you cannot use git, use "diff -purN OLD NEW". If your version of
4751 diff does not support these options, then get the latest version of
4752 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004753
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004754 The current directory when running this command shall be the parent
4755 directory of the U-Boot source tree (i. e. please make sure that
4756 your patch includes sufficient directory information for the
4757 affected files).
4758
4759 We prefer patches as plain text. MIME attachments are discouraged,
4760 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004761
wdenk6c59edc2004-05-03 20:45:30 +00004762* If one logical set of modifications affects or creates several
4763 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004764
wdenk6c59edc2004-05-03 20:45:30 +00004765* Changesets that contain different, unrelated modifications shall be
4766 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004767
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769Notes:
wdenkc6097192002-11-03 00:24:07 +00004770
wdenk6c59edc2004-05-03 20:45:30 +00004771* Before sending the patch, run the MAKEALL script on your patched
4772 source tree and make sure that no errors or warnings are reported
4773 for any of the boards.
4774
4775* Keep your modifications to the necessary minimum: A patch
4776 containing several unrelated changes or arbitrary reformats will be
4777 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk6c59edc2004-05-03 20:45:30 +00004779* If you modify existing code, make sure that your new code does not
4780 add to the memory footprint of the code ;-) Small is beautiful!
4781 When adding new features, these should compile conditionally only
4782 (using #ifdef), and the resulting code with the new feature
4783 disabled must not need more memory than the old code without your
4784 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004785
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004786* Remember that there is a size limit of 100 kB per message on the
4787 u-boot mailing list. Bigger patches will be moderated. If they are
4788 reasonable and not too big, they will be acknowledged. But patches
4789 bigger than the size limit should be avoided.