blob: 07f1d11e5feb2565df5422f3ccf940f1174a747d [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
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000879 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 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
Heiko Schocher7d037f72011-11-15 10:00:04 -05001030 CONFIG_DRIVER_TI_EMAC
1031 Support for davinci emac
1032
1033 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1034 Define this if you have more then 3 PHYs.
1035
Macpaul Lin199c6252010-12-21 16:59:46 +08001036 CONFIG_FTGMAC100
1037 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1038
1039 CONFIG_FTGMAC100_EGIGA
1040 Define this to use GE link update with gigabit PHY.
1041 Define this if FTGMAC100 is connected to gigabit PHY.
1042 If your system has 10/100 PHY only, it might not occur
1043 wrong behavior. Because PHY usually return timeout or
1044 useless data when polling gigabit status and gigabit
1045 control registers. This behavior won't affect the
1046 correctnessof 10/100 link speed update.
1047
Mike Rapoportf4761af2009-11-11 10:03:03 +02001048 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001049 Support for SMSC's LAN911x and LAN921x chips
1050
Mike Rapoportf4761af2009-11-11 10:03:03 +02001051 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001052 Define this to hold the physical address
1053 of the device (I/O space)
1054
Mike Rapoportf4761af2009-11-11 10:03:03 +02001055 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001056 Define this if data bus is 32 bits
1057
Mike Rapoportf4761af2009-11-11 10:03:03 +02001058 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001059 Define this if data bus is 16 bits. If your processor
1060 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001061 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001062
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001063 CONFIG_SH_ETHER
1064 Support for Renesas on-chip Ethernet controller
1065
1066 CONFIG_SH_ETHER_USE_PORT
1067 Define the number of ports to be used
1068
1069 CONFIG_SH_ETHER_PHY_ADDR
1070 Define the ETH PHY's address
1071
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001072 CONFIG_SH_ETHER_CACHE_WRITEBACK
1073 If this option is set, the driver enables cache flush.
1074
wdenkc6097192002-11-03 00:24:07 +00001075- USB Support:
1076 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001077 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001078 CONFIG_USB_UHCI to enable it.
1079 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001080 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001081 storage devices.
1082 Note:
1083 Supported are USB Keyboards and USB Floppy drives
1084 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001085 MPC5200 USB requires additional defines:
1086 CONFIG_USB_CLOCK
1087 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001088 CONFIG_PSC3_USB
1089 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001090 CONFIG_USB_CONFIG
1091 for differential drivers: 0x00001000
1092 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001093 for differential drivers on PSC3: 0x00000100
1094 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001095 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001096 May be defined to allow interrupt polling
1097 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001098
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001099- USB Device:
1100 Define the below if you wish to use the USB console.
1101 Once firmware is rebuilt from a serial console issue the
1102 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001103 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001104 it has found a new device. The environment variable usbtty
1105 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001106 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001107 Common Device Class Abstract Control Model serial device.
1108 If you select usbtty = gserial you should be able to enumerate
1109 a Linux host by
1110 # modprobe usbserial vendor=0xVendorID product=0xProductID
1111 else if using cdc_acm, simply setting the environment
1112 variable usbtty to be cdc_acm should suffice. The following
1113 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001114
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001115 CONFIG_USB_DEVICE
1116 Define this to build a UDC device
1117
1118 CONFIG_USB_TTY
1119 Define this to have a tty type of device available to
1120 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001122 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001123 Define this if you want stdin, stdout &/or stderr to
1124 be set to usbtty.
1125
1126 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001127 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001128 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001129 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001131 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001132 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001133 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001134
Wolfgang Denke2601822006-06-14 18:14:56 +02001135 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001136 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001137 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001138 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1139 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1140 should pretend to be a Linux device to it's target host.
1141
1142 CONFIG_USBD_MANUFACTURER
1143 Define this string as the name of your company for
1144 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001145
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001146 CONFIG_USBD_PRODUCT_NAME
1147 Define this string as the name of your product
1148 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001149
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001150 CONFIG_USBD_VENDORID
1151 Define this as your assigned Vendor ID from the USB
1152 Implementors Forum. This *must* be a genuine Vendor ID
1153 to avoid polluting the USB namespace.
1154 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001155
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001156 CONFIG_USBD_PRODUCTID
1157 Define this as the unique Product ID
1158 for your device
1159 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001160
wdenkc6097192002-11-03 00:24:07 +00001161
wdenk7a428cc2003-06-15 22:40:42 +00001162- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001163 The MMC controller on the Intel PXA is supported. To
1164 enable this define CONFIG_MMC. The MMC can be
1165 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001166 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001167 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1168 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001169
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001170 CONFIG_SH_MMCIF
1171 Support for Renesas on-chip MMCIF controller
1172
1173 CONFIG_SH_MMCIF_ADDR
1174 Define the base address of MMCIF registers
1175
1176 CONFIG_SH_MMCIF_CLK
1177 Define the clock frequency for MMCIF
1178
wdenkda04a8b2004-08-02 23:22:59 +00001179- Journaling Flash filesystem support:
1180 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1181 CONFIG_JFFS2_NAND_DEV
1182 Define these for a default partition on a NAND device
1183
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001184 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1185 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001186 Define these for a default partition on a NOR device
1187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001188 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001189 Define this to create an own partition. You have to provide a
1190 function struct part_info* jffs2_part_info(int part_num)
1191
1192 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001193 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001194 to disable the command chpart. This is the default when you
1195 have not defined a custom partition
1196
Donggeun Kim8f814002011-10-24 21:15:28 +00001197- FAT(File Allocation Table) filesystem write function support:
1198 CONFIG_FAT_WRITE
1199 Support for saving memory data as a file
1200 in FAT formatted partition
1201
wdenkc6097192002-11-03 00:24:07 +00001202- Keyboard Support:
1203 CONFIG_ISA_KEYBOARD
1204
1205 Define this to enable standard (PC-Style) keyboard
1206 support
1207
1208 CONFIG_I8042_KBD
1209 Standard PC keyboard driver with US (is default) and
1210 GERMAN key layout (switch via environment 'keymap=de') support.
1211 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1212 for cfb_console. Supports cursor blinking.
1213
1214- Video support:
1215 CONFIG_VIDEO
1216
1217 Define this to enable video support (for output to
1218 video).
1219
1220 CONFIG_VIDEO_CT69000
1221
1222 Enable Chips & Technologies 69000 Video chip
1223
1224 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001225 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001226 video output is selected via environment 'videoout'
1227 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1228 assumed.
wdenkc6097192002-11-03 00:24:07 +00001229
wdenkd3602132004-03-25 15:14:43 +00001230 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001231 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001232 are possible:
1233 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001234 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001235
1236 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1237 -------------+---------------------------------------------
1238 8 bits | 0x301* 0x303 0x305 0x161 0x307
1239 15 bits | 0x310 0x313 0x316 0x162 0x319
1240 16 bits | 0x311 0x314 0x317 0x163 0x31A
1241 24 bits | 0x312 0x315 0x318 ? 0x31B
1242 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001243 (i.e. setenv videomode 317; saveenv; reset;)
1244
wdenkd3602132004-03-25 15:14:43 +00001245 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001246 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001247
1248
stroeseb9c17c52003-04-04 15:53:41 +00001249 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001250 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001251 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1252 or CONFIG_VIDEO_SED13806_16BPP
1253
Timur Tabi020edd22011-02-15 17:09:19 -06001254 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001255 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001256 SOCs that have a DIU should define this macro to enable DIU
1257 support, and should also define these other macros:
1258
1259 CONFIG_SYS_DIU_ADDR
1260 CONFIG_VIDEO
1261 CONFIG_CMD_BMP
1262 CONFIG_CFB_CONSOLE
1263 CONFIG_VIDEO_SW_CURSOR
1264 CONFIG_VGA_AS_SINGLE_DEVICE
1265 CONFIG_VIDEO_LOGO
1266 CONFIG_VIDEO_BMP_LOGO
1267
Timur Tabi32f709e2011-04-11 14:18:22 -05001268 The DIU driver will look for the 'video-mode' environment
1269 variable, and if defined, enable the DIU as a console during
1270 boot. See the documentation file README.video for a
1271 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001272
wdenk4e112c12003-06-03 23:54:09 +00001273- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001274 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001275
wdenk57b2d802003-06-27 21:31:46 +00001276 Define this to enable a custom keyboard support.
1277 This simply calls drv_keyboard_init() which must be
1278 defined in your board-specific files.
1279 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001280
wdenkc6097192002-11-03 00:24:07 +00001281- LCD Support: CONFIG_LCD
1282
1283 Define this to enable LCD support (for output to LCD
1284 display); also select one of the supported displays
1285 by defining one of these:
1286
Stelian Popf6f86652008-05-09 21:57:18 +02001287 CONFIG_ATMEL_LCD:
1288
1289 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1290
wdenkc0d54ae2003-11-25 16:55:19 +00001291 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001292
wdenkc0d54ae2003-11-25 16:55:19 +00001293 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001294
wdenkc0d54ae2003-11-25 16:55:19 +00001295 CONFIG_NEC_NL6448BC20
1296
1297 NEC NL6448BC20-08. 6.5", 640x480.
1298 Active, color, single scan.
1299
1300 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001301
wdenkc0d54ae2003-11-25 16:55:19 +00001302 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001303 Active, color, single scan.
1304
1305 CONFIG_SHARP_16x9
1306
1307 Sharp 320x240. Active, color, single scan.
1308 It isn't 16x9, and I am not sure what it is.
1309
1310 CONFIG_SHARP_LQ64D341
1311
1312 Sharp LQ64D341 display, 640x480.
1313 Active, color, single scan.
1314
1315 CONFIG_HLD1045
1316
1317 HLD1045 display, 640x480.
1318 Active, color, single scan.
1319
1320 CONFIG_OPTREX_BW
1321
1322 Optrex CBL50840-2 NF-FW 99 22 M5
1323 or
1324 Hitachi LMG6912RPFC-00T
1325 or
1326 Hitachi SP14Q002
1327
1328 320x240. Black & white.
1329
1330 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001331 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001332
wdenkeb20ad32003-09-05 23:19:14 +00001333- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001334
wdenk57b2d802003-06-27 21:31:46 +00001335 If this option is set, the environment is checked for
1336 a variable "splashimage". If found, the usual display
1337 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001338 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001339 specified in "splashimage" is loaded instead. The
1340 console is redirected to the "nulldev", too. This
1341 allows for a "silent" boot where a splash screen is
1342 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001343
Matthias Weisser53884182009-07-09 16:07:30 +02001344 CONFIG_SPLASH_SCREEN_ALIGN
1345
1346 If this option is set the splash image can be freely positioned
1347 on the screen. Environment variable "splashpos" specifies the
1348 position as "x,y". If a positive number is given it is used as
1349 number of pixel from left/top. If a negative number is given it
1350 is used as number of pixel from right/bottom. You can also
1351 specify 'm' for centering the image.
1352
1353 Example:
1354 setenv splashpos m,m
1355 => image at center of screen
1356
1357 setenv splashpos 30,20
1358 => image at x = 30 and y = 20
1359
1360 setenv splashpos -10,m
1361 => vertically centered image
1362 at x = dspWidth - bmpWidth - 9
1363
Stefan Roesed9d97742005-09-22 09:04:17 +02001364- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1365
1366 If this option is set, additionally to standard BMP
1367 images, gzipped BMP images can be displayed via the
1368 splashscreen support or the bmp command.
1369
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001370- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1371
1372 If this option is set, 8-bit RLE compressed BMP images
1373 can be displayed via the splashscreen support or the
1374 bmp command.
1375
wdenk710e3502003-08-29 20:57:53 +00001376- Compression support:
1377 CONFIG_BZIP2
1378
1379 If this option is set, support for bzip2 compressed
1380 images is included. If not, only uncompressed and gzip
1381 compressed images are supported.
1382
wdenk9c53f402003-10-15 23:53:47 +00001383 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001384 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001385 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001386
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001387 CONFIG_LZMA
1388
1389 If this option is set, support for lzma compressed
1390 images is included.
1391
1392 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1393 requires an amount of dynamic memory that is given by the
1394 formula:
1395
1396 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1397
1398 Where lc and lp stand for, respectively, Literal context bits
1399 and Literal pos bits.
1400
1401 This value is upper-bounded by 14MB in the worst case. Anyway,
1402 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1403 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1404 a very small buffer.
1405
1406 Use the lzmainfo tool to determinate the lc and lp values and
1407 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001408 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001409
wdenk0e2bd9c2004-06-06 21:51:03 +00001410- MII/PHY support:
1411 CONFIG_PHY_ADDR
1412
1413 The address of PHY on MII bus.
1414
1415 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1416
1417 The clock frequency of the MII bus
1418
1419 CONFIG_PHY_GIGE
1420
1421 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001422 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001423
1424 CONFIG_PHY_RESET_DELAY
1425
1426 Some PHY like Intel LXT971A need extra delay after
1427 reset before any MII register access is possible.
1428 For such PHY, set this option to the usec delay
1429 required. (minimum 300usec for LXT971A)
1430
1431 CONFIG_PHY_CMD_DELAY (ppc4xx)
1432
1433 Some PHY like Intel LXT971A need extra delay after
1434 command issued before MII status register can be read
1435
wdenkc6097192002-11-03 00:24:07 +00001436- Ethernet address:
1437 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001438 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001439 CONFIG_ETH2ADDR
1440 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001441 CONFIG_ETH4ADDR
1442 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001443
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001444 Define a default value for Ethernet address to use
1445 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001446 is not determined automatically.
1447
1448- IP address:
1449 CONFIG_IPADDR
1450
1451 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001452 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001453 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001454 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001455
1456- Server IP address:
1457 CONFIG_SERVERIP
1458
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001459 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001460 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001461 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001462
Robin Getz470a6d42009-07-21 12:15:28 -04001463 CONFIG_KEEP_SERVERADDR
1464
1465 Keeps the server's MAC address, in the env 'serveraddr'
1466 for passing to bootargs (like Linux's netconsole option)
1467
Wolfgang Denk26da2992011-10-26 10:21:22 +00001468- Gateway IP address:
1469 CONFIG_GATEWAYIP
1470
1471 Defines a default value for the IP address of the
1472 default router where packets to other networks are
1473 sent to.
1474 (Environment variable "gatewayip")
1475
1476- Subnet mask:
1477 CONFIG_NETMASK
1478
1479 Defines a default value for the subnet mask (or
1480 routing prefix) which is used to determine if an IP
1481 address belongs to the local subnet or needs to be
1482 forwarded through a router.
1483 (Environment variable "netmask")
1484
David Updegraff7280da72007-06-11 10:41:07 -05001485- Multicast TFTP Mode:
1486 CONFIG_MCAST_TFTP
1487
1488 Defines whether you want to support multicast TFTP as per
1489 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001490 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001491 driver in use must provide a function: mcast() to join/leave a
1492 multicast group.
1493
wdenkc6097192002-11-03 00:24:07 +00001494- BOOTP Recovery Mode:
1495 CONFIG_BOOTP_RANDOM_DELAY
1496
1497 If you have many targets in a network that try to
1498 boot using BOOTP, you may want to avoid that all
1499 systems send out BOOTP requests at precisely the same
1500 moment (which would happen for instance at recovery
1501 from a power failure, when all systems will try to
1502 boot, thus flooding the BOOTP server. Defining
1503 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1504 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001505 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001506
1507 1st BOOTP request: delay 0 ... 1 sec
1508 2nd BOOTP request: delay 0 ... 2 sec
1509 3rd BOOTP request: delay 0 ... 4 sec
1510 4th and following
1511 BOOTP requests: delay 0 ... 8 sec
1512
stroesee0aadfb2003-08-28 14:17:32 +00001513- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001514 You can fine tune the DHCP functionality by defining
1515 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001516
Jon Loeliger5336a762007-07-09 22:08:34 -05001517 CONFIG_BOOTP_SUBNETMASK
1518 CONFIG_BOOTP_GATEWAY
1519 CONFIG_BOOTP_HOSTNAME
1520 CONFIG_BOOTP_NISDOMAIN
1521 CONFIG_BOOTP_BOOTPATH
1522 CONFIG_BOOTP_BOOTFILESIZE
1523 CONFIG_BOOTP_DNS
1524 CONFIG_BOOTP_DNS2
1525 CONFIG_BOOTP_SEND_HOSTNAME
1526 CONFIG_BOOTP_NTPSERVER
1527 CONFIG_BOOTP_TIMEOFFSET
1528 CONFIG_BOOTP_VENDOREX
stroesee0aadfb2003-08-28 14:17:32 +00001529
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001530 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1531 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001532
1533 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1534 serverip from a DHCP server, it is possible that more
1535 than one DNS serverip is offered to the client.
1536 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1537 serverip will be stored in the additional environment
1538 variable "dnsip2". The first DNS serverip is always
1539 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001540 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001541
1542 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1543 to do a dynamic update of a DNS server. To do this, they
1544 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001545 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001546 of the "hostname" environment variable is passed as
1547 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001548
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001549 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1550
1551 A 32bit value in microseconds for a delay between
1552 receiving a "DHCP Offer" and sending the "DHCP Request".
1553 This fixes a problem with certain DHCP servers that don't
1554 respond 100% of the time to a "DHCP request". E.g. On an
1555 AT91RM9200 processor running at 180MHz, this delay needed
1556 to be *at least* 15,000 usec before a Windows Server 2003
1557 DHCP server would reply 100% of the time. I recommend at
1558 least 50,000 usec to be safe. The alternative is to hope
1559 that one of the retries will be successful but note that
1560 the DHCP timeout and retry process takes a longer than
1561 this delay.
1562
wdenk145d2c12004-04-15 21:48:45 +00001563 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001564 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001565
1566 The device id used in CDP trigger frames.
1567
1568 CONFIG_CDP_DEVICE_ID_PREFIX
1569
1570 A two character string which is prefixed to the MAC address
1571 of the device.
1572
1573 CONFIG_CDP_PORT_ID
1574
1575 A printf format string which contains the ascii name of
1576 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001577 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001578
1579 CONFIG_CDP_CAPABILITIES
1580
1581 A 32bit integer which indicates the device capabilities;
1582 0x00000010 for a normal host which does not forwards.
1583
1584 CONFIG_CDP_VERSION
1585
1586 An ascii string containing the version of the software.
1587
1588 CONFIG_CDP_PLATFORM
1589
1590 An ascii string containing the name of the platform.
1591
1592 CONFIG_CDP_TRIGGER
1593
1594 A 32bit integer sent on the trigger.
1595
1596 CONFIG_CDP_POWER_CONSUMPTION
1597
1598 A 16bit integer containing the power consumption of the
1599 device in .1 of milliwatts.
1600
1601 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1602
1603 A byte containing the id of the VLAN.
1604
wdenkc6097192002-11-03 00:24:07 +00001605- Status LED: CONFIG_STATUS_LED
1606
1607 Several configurations allow to display the current
1608 status using a LED. For instance, the LED will blink
1609 fast while running U-Boot code, stop blinking as
1610 soon as a reply to a BOOTP request was received, and
1611 start blinking slow once the Linux kernel is running
1612 (supported by a status LED driver in the Linux
1613 kernel). Defining CONFIG_STATUS_LED enables this
1614 feature in U-Boot.
1615
1616- CAN Support: CONFIG_CAN_DRIVER
1617
1618 Defining CONFIG_CAN_DRIVER enables CAN driver support
1619 on those systems that support this (optional)
1620 feature, like the TQM8xxL modules.
1621
1622- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1623
wdenkb9bbd242003-06-30 16:24:52 +00001624 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001625 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001626 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001627
wdenk21136db2003-07-16 21:53:01 +00001628 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001629 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001630 CONFIG_COMMANDS) and communicate with i2c based realtime
1631 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001632 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001633
Ben Warren45657152006-09-07 16:50:54 -04001634 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001635
wdenk21136db2003-07-16 21:53:01 +00001636 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001637 bit-banging) driver instead of CPM or similar hardware
1638 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001639
wdenk21136db2003-07-16 21:53:01 +00001640 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001641 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001643 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001644 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001645 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001646 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001647
Peter Tysere4d1abc2010-04-12 22:28:21 -05001648 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001649 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001650 and so its address should therefore be cleared to 0 (See,
1651 eg, MPC823e User's Manual p.16-473). So, set
1652 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001653
Eric Millbrandt12990a42009-09-03 08:09:44 -05001654 CONFIG_SYS_I2C_INIT_MPC5XXX
1655
1656 When a board is reset during an i2c bus transfer
1657 chips might think that the current transfer is still
1658 in progress. Reset the slave devices by sending start
1659 commands until the slave device responds.
1660
wdenk21136db2003-07-16 21:53:01 +00001661 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001662
wdenkb9bbd242003-06-30 16:24:52 +00001663 If you use the software i2c interface (CONFIG_SOFT_I2C)
1664 then the following macros need to be defined (examples are
1665 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001666
1667 I2C_INIT
1668
wdenkb9bbd242003-06-30 16:24:52 +00001669 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001670 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001671
wdenk544e9732004-02-06 23:19:44 +00001672 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001673
wdenkc6097192002-11-03 00:24:07 +00001674 I2C_PORT
1675
wdenk4a5c8a72003-03-06 00:02:04 +00001676 (Only for MPC8260 CPU). The I/O port to use (the code
1677 assumes both bits are on the same port). Valid values
1678 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001679
1680 I2C_ACTIVE
1681
1682 The code necessary to make the I2C data line active
1683 (driven). If the data line is open collector, this
1684 define can be null.
1685
wdenkb9bbd242003-06-30 16:24:52 +00001686 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1687
wdenkc6097192002-11-03 00:24:07 +00001688 I2C_TRISTATE
1689
1690 The code necessary to make the I2C data line tri-stated
1691 (inactive). If the data line is open collector, this
1692 define can be null.
1693
wdenkb9bbd242003-06-30 16:24:52 +00001694 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1695
wdenkc6097192002-11-03 00:24:07 +00001696 I2C_READ
1697
1698 Code that returns TRUE if the I2C data line is high,
1699 FALSE if it is low.
1700
wdenkb9bbd242003-06-30 16:24:52 +00001701 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1702
wdenkc6097192002-11-03 00:24:07 +00001703 I2C_SDA(bit)
1704
1705 If <bit> is TRUE, sets the I2C data line high. If it
1706 is FALSE, it clears it (low).
1707
wdenkb9bbd242003-06-30 16:24:52 +00001708 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001709 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001710 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001711
wdenkc6097192002-11-03 00:24:07 +00001712 I2C_SCL(bit)
1713
1714 If <bit> is TRUE, sets the I2C clock line high. If it
1715 is FALSE, it clears it (low).
1716
wdenkb9bbd242003-06-30 16:24:52 +00001717 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001718 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001719 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001720
wdenkc6097192002-11-03 00:24:07 +00001721 I2C_DELAY
1722
1723 This delay is invoked four times per clock cycle so this
1724 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001725 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001726 like:
1727
wdenkb9bbd242003-06-30 16:24:52 +00001728 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001729
Mike Frysingeree12d542010-07-21 13:38:02 -04001730 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1731
1732 If your arch supports the generic GPIO framework (asm/gpio.h),
1733 then you may alternatively define the two GPIOs that are to be
1734 used as SCL / SDA. Any of the previous I2C_xxx macros will
1735 have GPIO-based defaults assigned to them as appropriate.
1736
1737 You should define these to the GPIO value as given directly to
1738 the generic GPIO functions.
1739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001740 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001741
wdenk57b2d802003-06-27 21:31:46 +00001742 When a board is reset during an i2c bus transfer
1743 chips might think that the current transfer is still
1744 in progress. On some boards it is possible to access
1745 the i2c SCLK line directly, either by using the
1746 processor pin as a GPIO or by having a second pin
1747 connected to the bus. If this option is defined a
1748 custom i2c_init_board() routine in boards/xxx/board.c
1749 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001750
Richard Retanubundf0149c2010-04-12 15:08:17 -04001751 CONFIG_SYS_I2C_BOARD_LATE_INIT
1752
1753 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1754 defined a custom i2c_board_late_init() routine in
1755 boards/xxx/board.c is run AFTER the operations in i2c_init()
1756 is completed. This callpoint can be used to unreset i2c bus
1757 using CPU i2c controller register accesses for CPUs whose i2c
1758 controller provide such a method. It is called at the end of
1759 i2c_init() to allow i2c_init operations to setup the i2c bus
1760 controller on the CPU (e.g. setting bus speed & slave address).
1761
wdenk0e2bd9c2004-06-06 21:51:03 +00001762 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1763
1764 This option enables configuration of bi_iic_fast[] flags
1765 in u-boot bd_info structure based on u-boot environment
1766 variable "i2cfast". (see also i2cfast)
1767
Ben Warren45657152006-09-07 16:50:54 -04001768 CONFIG_I2C_MULTI_BUS
1769
1770 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001771 must have a controller. At any point in time, only one bus is
1772 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001773 Note that bus numbering is zero-based.
1774
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001775 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001776
1777 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001778 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001779 is set, specify a list of bus-device pairs. Otherwise, specify
1780 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001781
1782 e.g.
1783 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001784 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001785
1786 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1787
Wolfgang Denk092ae952011-10-26 10:21:21 +00001788 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001789 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001790
1791 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1792
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001793 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001794
1795 If defined, then this indicates the I2C bus number for DDR SPD.
1796 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001798 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001799
1800 If defined, then this indicates the I2C bus number for the RTC.
1801 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001803 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001804
1805 If defined, then this indicates the I2C bus number for the DTT.
1806 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001808 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001809
1810 If defined, specifies the I2C address of the DTT device.
1811 If not defined, then U-Boot uses predefined value for
1812 specified DTT device.
1813
Timur Tabiab347542006-11-03 19:15:00 -06001814 CONFIG_FSL_I2C
1815
1816 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01001817 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06001818
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001819 CONFIG_I2C_MUX
1820
1821 Define this option if you have I2C devices reached over 1 .. n
1822 I2C Muxes like the pca9544a. This option addes a new I2C
1823 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1824 new I2C Bus to the existing I2C Busses. If you select the
1825 new Bus with "i2c dev", u-bbot sends first the commandos for
1826 the muxes to activate this new "bus".
1827
1828 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1829 feature!
1830
1831 Example:
1832 Adding a new I2C Bus reached over 2 pca9544a muxes
1833 The First mux with address 70 and channel 6
1834 The Second mux with address 71 and channel 4
1835
1836 => i2c bus pca9544a:70:6:pca9544a:71:4
1837
1838 Use the "i2c bus" command without parameter, to get a list
1839 of I2C Busses with muxes:
1840
1841 => i2c bus
1842 Busses reached over muxes:
1843 Bus ID: 2
1844 reached over Mux(es):
1845 pca9544a@70 ch: 4
1846 Bus ID: 3
1847 reached over Mux(es):
1848 pca9544a@70 ch: 6
1849 pca9544a@71 ch: 4
1850 =>
1851
1852 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00001853 u-boot first sends the command to the mux@70 to enable
1854 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001855 the channel 4.
1856
1857 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00001858 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001859 the 2 muxes.
1860
1861 This option is actually implemented for the bitbanging
1862 algorithm in common/soft_i2c.c and for the Hardware I2C
1863 Bus on the MPC8260. But it should be not so difficult
1864 to add this option to other architectures.
1865
Andrew Dyer58c41f92008-12-29 17:36:01 -06001866 CONFIG_SOFT_I2C_READ_REPEATED_START
1867
1868 defining this will force the i2c_read() function in
1869 the soft_i2c driver to perform an I2C repeated start
1870 between writing the address pointer and reading the
1871 data. If this define is omitted the default behaviour
1872 of doing a stop-start sequence will be used. Most I2C
1873 devices can use either method, but some require one or
1874 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001875
wdenkc6097192002-11-03 00:24:07 +00001876- SPI Support: CONFIG_SPI
1877
1878 Enables SPI driver (so far only tested with
1879 SPI EEPROM, also an instance works with Crystal A/D and
1880 D/As on the SACSng board)
1881
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09001882 CONFIG_SH_SPI
1883
1884 Enables the driver for SPI controller on SuperH. Currently
1885 only SH7757 is supported.
1886
wdenkc6097192002-11-03 00:24:07 +00001887 CONFIG_SPI_X
1888
1889 Enables extended (16-bit) SPI EEPROM addressing.
1890 (symmetrical to CONFIG_I2C_X)
1891
1892 CONFIG_SOFT_SPI
1893
wdenk4a5c8a72003-03-06 00:02:04 +00001894 Enables a software (bit-bang) SPI driver rather than
1895 using hardware support. This is a general purpose
1896 driver that only requires three general I/O port pins
1897 (two outputs, one input) to function. If this is
1898 defined, the board configuration must define several
1899 SPI configuration items (port pins to use, etc). For
1900 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001901
Ben Warren7efe9272008-01-16 22:37:35 -05001902 CONFIG_HARD_SPI
1903
1904 Enables a hardware SPI driver for general-purpose reads
1905 and writes. As with CONFIG_SOFT_SPI, the board configuration
1906 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00001907 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05001908 example, see include/configs/mpc8349emds.h.
1909
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001910 CONFIG_MXC_SPI
1911
1912 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00001913 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001914
Matthias Fuchsa4400872007-12-27 17:12:34 +01001915- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001916
Matthias Fuchsa4400872007-12-27 17:12:34 +01001917 Enables FPGA subsystem.
1918
1919 CONFIG_FPGA_<vendor>
1920
1921 Enables support for specific chip vendors.
1922 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001923
Matthias Fuchsa4400872007-12-27 17:12:34 +01001924 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001925
Matthias Fuchsa4400872007-12-27 17:12:34 +01001926 Enables support for FPGA family.
1927 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1928
1929 CONFIG_FPGA_COUNT
1930
1931 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001933 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001934
wdenk57b2d802003-06-27 21:31:46 +00001935 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001937 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001938
wdenk4a5c8a72003-03-06 00:02:04 +00001939 Enable checks on FPGA configuration interface busy
1940 status by the configuration function. This option
1941 will require a board or device specific function to
1942 be written.
wdenkc6097192002-11-03 00:24:07 +00001943
1944 CONFIG_FPGA_DELAY
1945
1946 If defined, a function that provides delays in the FPGA
1947 configuration driver.
1948
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001949 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001950 Allow Control-C to interrupt FPGA configuration
1951
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001952 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001953
wdenk4a5c8a72003-03-06 00:02:04 +00001954 Check for configuration errors during FPGA bitfile
1955 loading. For example, abort during Virtex II
1956 configuration if the INIT_B line goes low (which
1957 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001958
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001959 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001960
wdenk4a5c8a72003-03-06 00:02:04 +00001961 Maximum time to wait for the INIT_B line to deassert
1962 after PROB_B has been deasserted during a Virtex II
1963 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001964 ms.
wdenkc6097192002-11-03 00:24:07 +00001965
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001966 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001967
wdenk4a5c8a72003-03-06 00:02:04 +00001968 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001969 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001970
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001971 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001972
wdenk4a5c8a72003-03-06 00:02:04 +00001973 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001974 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001975
1976- Configuration Management:
1977 CONFIG_IDENT_STRING
1978
wdenk4a5c8a72003-03-06 00:02:04 +00001979 If defined, this string will be added to the U-Boot
1980 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001981
1982- Vendor Parameter Protection:
1983
wdenk4a5c8a72003-03-06 00:02:04 +00001984 U-Boot considers the values of the environment
1985 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001986 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001987 are set once by the board vendor / manufacturer, and
1988 protects these variables from casual modification by
1989 the user. Once set, these variables are read-only,
1990 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001991 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001992
1993 If CONFIG_ENV_OVERWRITE is #defined in your config
1994 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001995 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001996 these parameters.
1997
1998 Alternatively, if you #define _both_ CONFIG_ETHADDR
1999 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002000 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002001 which can be changed exactly ONCE by the user. [The
2002 serial# is unaffected by this, i. e. it remains
2003 read-only.]
2004
2005- Protected RAM:
2006 CONFIG_PRAM
2007
2008 Define this variable to enable the reservation of
2009 "protected RAM", i. e. RAM which is not overwritten
2010 by U-Boot. Define CONFIG_PRAM to hold the number of
2011 kB you want to reserve for pRAM. You can overwrite
2012 this default value by defining an environment
2013 variable "pram" to the number of kB you want to
2014 reserve. Note that the board info structure will
2015 still show the full amount of RAM. If pRAM is
2016 reserved, a new environment variable "mem" will
2017 automatically be defined to hold the amount of
2018 remaining RAM in a form that can be passed as boot
2019 argument to Linux, for instance like that:
2020
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002021 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002022 saveenv
2023
2024 This way you can tell Linux not to use this memory,
2025 either, which results in a memory region that will
2026 not be affected by reboots.
2027
2028 *WARNING* If your board configuration uses automatic
2029 detection of the RAM size, you must make sure that
2030 this memory test is non-destructive. So far, the
2031 following board configurations are known to be
2032 "pRAM-clean":
2033
2034 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2035 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002036 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002037
2038- Error Recovery:
2039 CONFIG_PANIC_HANG
2040
2041 Define this variable to stop the system in case of a
2042 fatal error, so that you have to reset it manually.
2043 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002044 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002045 automatically as fast as possible, but it may be
2046 useful during development since you can try to debug
2047 the conditions that lead to the situation.
2048
2049 CONFIG_NET_RETRY_COUNT
2050
wdenk4a5c8a72003-03-06 00:02:04 +00002051 This variable defines the number of retries for
2052 network operations like ARP, RARP, TFTP, or BOOTP
2053 before giving up the operation. If not defined, a
2054 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002055
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002056 CONFIG_ARP_TIMEOUT
2057
2058 Timeout waiting for an ARP reply in milliseconds.
2059
wdenkc6097192002-11-03 00:24:07 +00002060- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002061 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002062
2063 Enable auto completion of commands using TAB.
2064
Wolfgang Denk018147d2006-11-27 15:32:42 +01002065 Note that this feature has NOT been implemented yet
2066 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002067
2068
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002069 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002070
2071 Define this variable to enable the "hush" shell (from
2072 Busybox) as command line interpreter, thus enabling
2073 powerful command line syntax like
2074 if...then...else...fi conditionals or `&&' and '||'
2075 constructs ("shell scripts").
2076
2077 If undefined, you get the old, much simpler behaviour
2078 with a somewhat smaller memory footprint.
2079
2080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002081 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002082
2083 This defines the secondary prompt string, which is
2084 printed when the command interpreter needs more input
2085 to complete a command. Usually "> ".
2086
2087 Note:
2088
wdenk57b2d802003-06-27 21:31:46 +00002089 In the current implementation, the local variables
2090 space and global environment variables space are
2091 separated. Local variables are those you define by
2092 simply typing `name=value'. To access a local
2093 variable later on, you have write `$name' or
2094 `${name}'; to execute the contents of a variable
2095 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002096
wdenk4a5c8a72003-03-06 00:02:04 +00002097 Global environment variables are those you use
2098 setenv/printenv to work with. To run a command stored
2099 in such a variable, you need to use the run command,
2100 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002101
2102 To store commands and special characters in a
2103 variable, please use double quotation marks
2104 surrounding the whole text of the variable, instead
2105 of the backslashes before semicolons and special
2106 symbols.
2107
Wolfgang Denk2039a072006-07-21 11:35:21 +02002108- Commandline Editing and History:
2109 CONFIG_CMDLINE_EDITING
2110
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002111 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002112 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002113
wdenkc0aa5c52003-12-06 19:49:23 +00002114- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002115 CONFIG_EXTRA_ENV_SETTINGS
2116
wdenk4a5c8a72003-03-06 00:02:04 +00002117 Define this to contain any number of null terminated
2118 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002119 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002120
wdenk4a5c8a72003-03-06 00:02:04 +00002121 For example, place something like this in your
2122 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002123
2124 #define CONFIG_EXTRA_ENV_SETTINGS \
2125 "myvar1=value1\0" \
2126 "myvar2=value2\0"
2127
wdenk4a5c8a72003-03-06 00:02:04 +00002128 Warning: This method is based on knowledge about the
2129 internal format how the environment is stored by the
2130 U-Boot code. This is NOT an official, exported
2131 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002132 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002133 You better know what you are doing here.
2134
wdenk4a5c8a72003-03-06 00:02:04 +00002135 Note: overly (ab)use of the default environment is
2136 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002137 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002138 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002139
wdenkc0aa5c52003-12-06 19:49:23 +00002140- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002141 CONFIG_HAS_DATAFLASH
2142
wdenk57b2d802003-06-27 21:31:46 +00002143 Defining this option enables DataFlash features and
2144 allows to read/write in Dataflash via the standard
2145 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002146
wdenkef893942004-02-23 16:11:30 +00002147- SystemACE Support:
2148 CONFIG_SYSTEMACE
2149
2150 Adding this option adds support for Xilinx SystemACE
2151 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002152 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002153 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002154
2155 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002156 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002157
2158 When SystemACE support is added, the "ace" device type
2159 becomes available to the fat commands, i.e. fatls.
2160
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002161- TFTP Fixed UDP Port:
2162 CONFIG_TFTP_PORT
2163
Wolfgang Denk227b5192005-09-24 23:25:46 +02002164 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002165 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002166 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002167 number generator is used.
2168
Wolfgang Denk227b5192005-09-24 23:25:46 +02002169 Also, the environment variable tftpdstp is used to supply
2170 the TFTP UDP destination port value. If tftpdstp isn't
2171 defined, the normal port 69 is used.
2172
2173 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002174 blindly start the TFTP transfer using the pre-configured
2175 target IP address and UDP port. This has the effect of
2176 "punching through" the (Windows XP) firewall, allowing
2177 the remainder of the TFTP transfer to proceed normally.
2178 A better solution is to properly configure the firewall,
2179 but sometimes that is not allowed.
2180
wdenkc0aa5c52003-12-06 19:49:23 +00002181- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002182 CONFIG_SHOW_BOOT_PROGRESS
2183
wdenk4a5c8a72003-03-06 00:02:04 +00002184 Defining this option allows to add some board-
2185 specific code (calling a user-provided function
2186 "show_boot_progress(int)") that enables you to show
2187 the system's boot progress on some display (for
2188 example, some LED's) on your board. At the moment,
2189 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002190
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002191Legacy uImage format:
2192
wdenkc6097192002-11-03 00:24:07 +00002193 Arg Where When
2194 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002195 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002196 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002197 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002198 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002199 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002200 4 common/cmd_bootm.c Image data has correct checksum
2201 -4 common/cmd_bootm.c Image is for unsupported architecture
2202 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002203 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002204 6 common/cmd_bootm.c Image Type check OK
2205 -6 common/cmd_bootm.c gunzip uncompression error
2206 -7 common/cmd_bootm.c Unimplemented compression type
2207 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002208 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002209 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002210
2211 9 common/image.c Start initial ramdisk verification
2212 -10 common/image.c Ramdisk header has bad magic number
2213 -11 common/image.c Ramdisk header has bad checksum
2214 10 common/image.c Ramdisk header is OK
2215 -12 common/image.c Ramdisk data has bad checksum
2216 11 common/image.c Ramdisk data has correct checksum
2217 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002218 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002219 13 common/image.c Start multifile image verification
2220 14 common/image.c No initial ramdisk, no multifile, continue.
2221
Wolfgang Denk092ae952011-10-26 10:21:21 +00002222 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002223
Stefan Roese88fbf932010-04-15 16:07:28 +02002224 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002225 -31 post/post.c POST test failed, detected by post_output_backlog()
2226 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002227
Heiko Schocher633e03a2007-06-22 19:11:54 +02002228 34 common/cmd_doc.c before loading a Image from a DOC device
2229 -35 common/cmd_doc.c Bad usage of "doc" command
2230 35 common/cmd_doc.c correct usage of "doc" command
2231 -36 common/cmd_doc.c No boot device
2232 36 common/cmd_doc.c correct boot device
2233 -37 common/cmd_doc.c Unknown Chip ID on boot device
2234 37 common/cmd_doc.c correct chip ID found, device available
2235 -38 common/cmd_doc.c Read Error on boot device
2236 38 common/cmd_doc.c reading Image header from DOC device OK
2237 -39 common/cmd_doc.c Image header has bad magic number
2238 39 common/cmd_doc.c Image header has correct magic number
2239 -40 common/cmd_doc.c Error reading Image from DOC device
2240 40 common/cmd_doc.c Image header has correct magic number
2241 41 common/cmd_ide.c before loading a Image from a IDE device
2242 -42 common/cmd_ide.c Bad usage of "ide" command
2243 42 common/cmd_ide.c correct usage of "ide" command
2244 -43 common/cmd_ide.c No boot device
2245 43 common/cmd_ide.c boot device found
2246 -44 common/cmd_ide.c Device not available
2247 44 common/cmd_ide.c Device available
2248 -45 common/cmd_ide.c wrong partition selected
2249 45 common/cmd_ide.c partition selected
2250 -46 common/cmd_ide.c Unknown partition table
2251 46 common/cmd_ide.c valid partition table found
2252 -47 common/cmd_ide.c Invalid partition type
2253 47 common/cmd_ide.c correct partition type
2254 -48 common/cmd_ide.c Error reading Image Header on boot device
2255 48 common/cmd_ide.c reading Image Header from IDE device OK
2256 -49 common/cmd_ide.c Image header has bad magic number
2257 49 common/cmd_ide.c Image header has correct magic number
2258 -50 common/cmd_ide.c Image header has bad checksum
2259 50 common/cmd_ide.c Image header has correct checksum
2260 -51 common/cmd_ide.c Error reading Image from IDE device
2261 51 common/cmd_ide.c reading Image from IDE device OK
2262 52 common/cmd_nand.c before loading a Image from a NAND device
2263 -53 common/cmd_nand.c Bad usage of "nand" command
2264 53 common/cmd_nand.c correct usage of "nand" command
2265 -54 common/cmd_nand.c No boot device
2266 54 common/cmd_nand.c boot device found
2267 -55 common/cmd_nand.c Unknown Chip ID on boot device
2268 55 common/cmd_nand.c correct chip ID found, device available
2269 -56 common/cmd_nand.c Error reading Image Header on boot device
2270 56 common/cmd_nand.c reading Image Header from NAND device OK
2271 -57 common/cmd_nand.c Image header has bad magic number
2272 57 common/cmd_nand.c Image header has correct magic number
2273 -58 common/cmd_nand.c Error reading Image from NAND device
2274 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002275
Heiko Schocher633e03a2007-06-22 19:11:54 +02002276 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002277
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002278 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002279 -64 net/eth.c no Ethernet found.
2280 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002281
Heiko Schocher633e03a2007-06-22 19:11:54 +02002282 -80 common/cmd_net.c usage wrong
2283 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002284 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002285 81 common/cmd_net.c NetLoop() back without error
2286 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2287 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002288 83 common/cmd_net.c running "source" command
2289 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002290 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002291
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002292FIT uImage format:
2293
2294 Arg Where When
2295 100 common/cmd_bootm.c Kernel FIT Image has correct format
2296 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2297 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2298 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2299 102 common/cmd_bootm.c Kernel unit name specified
2300 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002301 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002302 104 common/cmd_bootm.c Got kernel subimage node offset
2303 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2304 105 common/cmd_bootm.c Kernel subimage hash verification OK
2305 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2306 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002307 -106 common/cmd_bootm.c Kernel subimage has wrong type
2308 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002309 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2310 108 common/cmd_bootm.c Got kernel subimage data/size
2311 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2312 -109 common/cmd_bootm.c Can't get kernel subimage type
2313 -110 common/cmd_bootm.c Can't get kernel subimage comp
2314 -111 common/cmd_bootm.c Can't get kernel subimage os
2315 -112 common/cmd_bootm.c Can't get kernel subimage load address
2316 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2317
2318 120 common/image.c Start initial ramdisk verification
2319 -120 common/image.c Ramdisk FIT image has incorrect format
2320 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002321 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002322 -122 common/image.c Can't get configuration for ramdisk subimage
2323 123 common/image.c Ramdisk unit name specified
2324 -124 common/image.c Can't get ramdisk subimage node offset
2325 125 common/image.c Got ramdisk subimage node offset
2326 -125 common/image.c Ramdisk subimage hash verification failed
2327 126 common/image.c Ramdisk subimage hash verification OK
2328 -126 common/image.c Ramdisk subimage for unsupported architecture
2329 127 common/image.c Architecture check OK
2330 -127 common/image.c Can't get ramdisk subimage data/size
2331 128 common/image.c Got ramdisk subimage data/size
2332 129 common/image.c Can't get ramdisk load address
2333 -129 common/image.c Got ramdisk load address
2334
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002335 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002336 131 common/cmd_doc.c FIT image format OK
2337
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002338 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002339 141 common/cmd_ide.c FIT image format OK
2340
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002341 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002342 151 common/cmd_nand.c FIT image format OK
2343
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002344- Standalone program support:
2345 CONFIG_STANDALONE_LOAD_ADDR
2346
Wolfgang Denk23f78482011-10-09 21:06:34 +02002347 This option defines a board specific value for the
2348 address where standalone program gets loaded, thus
2349 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002350 settings.
2351
2352- Frame Buffer Address:
2353 CONFIG_FB_ADDR
2354
2355 Define CONFIG_FB_ADDR if you want to use specific
2356 address for frame buffer.
2357 Then system will reserve the frame buffer address to
2358 defined address instead of lcd_setmem (this function
Wolfgang Denk23f78482011-10-09 21:06:34 +02002359 grabs the memory for frame buffer by panel's size).
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002360
2361 Please see board_init_f function.
2362
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002363- Automatic software updates via TFTP server
2364 CONFIG_UPDATE_TFTP
2365 CONFIG_UPDATE_TFTP_CNT_MAX
2366 CONFIG_UPDATE_TFTP_MSEC_MAX
2367
2368 These options enable and control the auto-update feature;
2369 for a more detailed description refer to doc/README.update.
2370
2371- MTD Support (mtdparts command, UBI support)
2372 CONFIG_MTD_DEVICE
2373
2374 Adds the MTD device infrastructure from the Linux kernel.
2375 Needed for mtdparts command support.
2376
2377 CONFIG_MTD_PARTITIONS
2378
2379 Adds the MTD partitioning infrastructure from the Linux
2380 kernel. Needed for UBI support.
2381
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002382- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002383 CONFIG_SPL
2384 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002385
Wolfgang Denk825223d2011-09-11 21:24:09 +02002386 CONFIG_SPL_TEXT_BASE
2387 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002388
Wolfgang Denk825223d2011-09-11 21:24:09 +02002389 CONFIG_SPL_LDSCRIPT
2390 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002391
Wolfgang Denk825223d2011-09-11 21:24:09 +02002392 CONFIG_SPL_LIBCOMMON_SUPPORT
2393 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002394
Wolfgang Denk825223d2011-09-11 21:24:09 +02002395 CONFIG_SPL_LIBDISK_SUPPORT
2396 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002397
Wolfgang Denk825223d2011-09-11 21:24:09 +02002398 CONFIG_SPL_I2C_SUPPORT
2399 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002400
Wolfgang Denk825223d2011-09-11 21:24:09 +02002401 CONFIG_SPL_GPIO_SUPPORT
2402 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002403
Wolfgang Denk825223d2011-09-11 21:24:09 +02002404 CONFIG_SPL_MMC_SUPPORT
2405 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002406
Wolfgang Denk825223d2011-09-11 21:24:09 +02002407 CONFIG_SPL_SERIAL_SUPPORT
2408 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002409
Wolfgang Denk825223d2011-09-11 21:24:09 +02002410 CONFIG_SPL_SPI_FLASH_SUPPORT
2411 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002412
Wolfgang Denk825223d2011-09-11 21:24:09 +02002413 CONFIG_SPL_SPI_SUPPORT
2414 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002415
Wolfgang Denk825223d2011-09-11 21:24:09 +02002416 CONFIG_SPL_FAT_SUPPORT
2417 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002418
Wolfgang Denk825223d2011-09-11 21:24:09 +02002419 CONFIG_SPL_LIBGENERIC_SUPPORT
2420 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002421
wdenkc6097192002-11-03 00:24:07 +00002422Modem Support:
2423--------------
2424
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002425[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002426
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002427- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002428 CONFIG_MODEM_SUPPORT
2429
2430- RTS/CTS Flow control enable:
2431 CONFIG_HWFLOW
2432
2433- Modem debug support:
2434 CONFIG_MODEM_SUPPORT_DEBUG
2435
wdenk4a5c8a72003-03-06 00:02:04 +00002436 Enables debugging stuff (char screen[1024], dbg())
2437 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002438
wdenkc0aa5c52003-12-06 19:49:23 +00002439- Interrupt support (PPC):
2440
wdenk1ebf41e2004-01-02 14:00:00 +00002441 There are common interrupt_init() and timer_interrupt()
2442 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002443 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002444 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002445 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002446 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002447 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002448 specific handling. If board has watchdog / status_led
2449 / other_activity_monitor it works automatically from
2450 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002451
wdenkc6097192002-11-03 00:24:07 +00002452- General:
2453
wdenk4a5c8a72003-03-06 00:02:04 +00002454 In the target system modem support is enabled when a
2455 specific key (key combination) is pressed during
2456 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002457 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002458 board_init(). Currently key_pressed() is a dummy
2459 function, returning 1 and thus enabling modem
2460 initialization.
wdenkc6097192002-11-03 00:24:07 +00002461
wdenk4a5c8a72003-03-06 00:02:04 +00002462 If there are no modem init strings in the
2463 environment, U-Boot proceed to autoboot; the
2464 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002465 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002466
2467 See also: doc/README.Modem
2468
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002469Board initialization settings:
2470------------------------------
2471
2472During Initialization u-boot calls a number of board specific functions
2473to allow the preparation of board specific prerequisites, e.g. pin setup
2474before drivers are initialized. To enable these callbacks the
2475following configuration macros have to be defined. Currently this is
2476architecture specific, so please check arch/your_architecture/lib/board.c
2477typically in board_init_f() and board_init_r().
2478
2479- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2480- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2481- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2482- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002483
wdenkc6097192002-11-03 00:24:07 +00002484Configuration Settings:
2485-----------------------
2486
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002487- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002488 undefine this when you're short of memory.
2489
Peter Tyserdfb72b82009-01-27 18:03:12 -06002490- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2491 width of the commands listed in the 'help' command output.
2492
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002493- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002494 prompt for user input.
2495
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002496- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002497
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002498- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002500- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002502- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002503 the application (usually a Linux kernel) when it is
2504 booted
2505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002506- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002507 List of legal baudrate settings for this board.
2508
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002509- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002510 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002512- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002513 If the board specific function
2514 extern int overwrite_console (void);
2515 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002516 serial port, else the settings in the environment are used.
2517
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002518- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002519 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002520
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002521- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002522 Enable overwrite of previous console environment settings.
2523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002524- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002525 Begin and End addresses of the area used by the
2526 simple memory test.
2527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002528- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002529 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002531- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002532 Scratch address used by the alternate memory test
2533 You only need to set this if address zero isn't writeable
2534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2536 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002537 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002538 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002539 fixing up gd->ram_size the Linux kernel should gets passed
2540 the now "corrected" memory size and won't touch it either.
2541 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002542 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002543 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002544 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002545
2546 This option can be used as a workaround for the 440EPx/GRx
2547 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2548 be touched.
2549
2550 WARNING: Please make sure that this value is a multiple of
2551 the Linux page size (normally 4k). If this is not the case,
2552 then the end address of the Linux memory will be located at a
2553 non page size aligned address and this could cause major
2554 problems.
2555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002556- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002557 Default load address for network file downloads
2558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002559- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002560 Enable temporary baudrate change while serial download
2561
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002562- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002563 Physical start address of SDRAM. _Must_ be 0 here.
2564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002565- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002566 Physical start address of Motherboard I/O (if using a
2567 Cogent motherboard)
2568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002569- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002570 Physical start address of Flash memory.
2571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002572- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002573 Physical start address of boot monitor code (set by
2574 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002575 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002576 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002578- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002579 Size of memory reserved for monitor code, used to
2580 determine _at_compile_time_ (!) if the environment is
2581 embedded within the U-Boot image, or in a separate
2582 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002583
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002584- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002585 Size of DRAM reserved for malloc() use.
2586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002587- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002588 Normally compressed uImages are limited to an
2589 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002590 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002591 to adjust this setting to your needs.
2592
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002593- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002594 Maximum size of memory mapped by the startup code of
2595 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002596 the Linux kernel (bd_info, boot arguments, FDT blob if
2597 used) must be put below this limit, unless "bootm_low"
2598 enviroment variable is defined and non-zero. In such case
2599 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002600 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002601 variable "bootm_mapsize" will override the value of
2602 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2603 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002604
John Rigbyeea8e692010-10-13 13:57:35 -06002605- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2606 Enable initrd_high functionality. If defined then the
2607 initrd_high feature is enabled and the bootm ramdisk subcommand
2608 is enabled.
2609
2610- CONFIG_SYS_BOOT_GET_CMDLINE:
2611 Enables allocating and saving kernel cmdline in space between
2612 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2613
2614- CONFIG_SYS_BOOT_GET_KBD:
2615 Enables allocating and saving a kernel copy of the bd_info in
2616 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002618- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002619 Max number of Flash memory banks
2620
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002621- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002622 Max number of sectors on a Flash chip
2623
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002624- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002625 Timeout for Flash erase operations (in ms)
2626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002627- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002628 Timeout for Flash write operations (in ms)
2629
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002630- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002631 Timeout for Flash set sector lock bit operation (in ms)
2632
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002633- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002634 Timeout for Flash clear lock bits operation (in ms)
2635
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002636- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002637 If defined, hardware flash sectors protection is used
2638 instead of U-Boot software protection.
2639
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002640- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002641
2642 Enable TFTP transfers directly to flash memory;
2643 without this option such a download has to be
2644 performed in two steps: (1) download to RAM, and (2)
2645 copy from RAM to flash.
2646
2647 The two-step approach is usually more reliable, since
2648 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002649 the flash, but in some situations (when system RAM is
2650 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002651 downloaded image) this option may be very useful.
2652
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002653- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002654 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002655 common flash structure for storing flash geometry.
2656
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002657- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002658 This option also enables the building of the cfi_flash driver
2659 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002660
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002661- CONFIG_FLASH_CFI_MTD
2662 This option enables the building of the cfi_mtd driver
2663 in the drivers directory. The driver exports CFI flash
2664 to the MTD layer.
2665
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002666- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002667 Use buffered writes to flash.
2668
2669- CONFIG_FLASH_SPANSION_S29WS_N
2670 s29ws-n MirrorBit flash has non-standard addresses for buffered
2671 write commands.
2672
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002673- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002674 If this option is defined, the common CFI flash doesn't
2675 print it's warning upon not recognized FLASH banks. This
2676 is useful, if some of the configured banks are only
2677 optionally available.
2678
Jerry Van Barenaae73572008-03-08 13:48:01 -05002679- CONFIG_FLASH_SHOW_PROGRESS
2680 If defined (must be an integer), print out countdown
2681 digits and dots. Recommended value: 45 (9..1) for 80
2682 column displays, 15 (3..1) for 40 column displays.
2683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002684- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002685 Defines the number of Ethernet receive buffers. On some
2686 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002687 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2688 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002689 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002690 Defaults to 4 if not defined.
2691
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002692- CONFIG_ENV_MAX_ENTRIES
2693
Wolfgang Denk1136f692010-10-27 22:48:30 +02002694 Maximum number of entries in the hash table that is used
2695 internally to store the environment settings. The default
2696 setting is supposed to be generous and should work in most
2697 cases. This setting can be used to tune behaviour; see
2698 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002699
wdenkc6097192002-11-03 00:24:07 +00002700The following definitions that deal with the placement and management
2701of environment data (variable area); in general, we support the
2702following configurations:
2703
Mike Frysinger63b8f122011-07-08 10:44:25 +00002704- CONFIG_BUILD_ENVCRC:
2705
2706 Builds up envcrc with the target environment so that external utils
2707 may easily extract it and embed it in final U-Boot images.
2708
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002709- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002710
2711 Define this if the environment is in flash memory.
2712
2713 a) The environment occupies one whole flash sector, which is
2714 "embedded" in the text segment with the U-Boot code. This
2715 happens usually with "bottom boot sector" or "top boot
2716 sector" type flash chips, which have several smaller
2717 sectors at the start or the end. For instance, such a
2718 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2719 such a case you would place the environment in one of the
2720 4 kB sectors - with U-Boot code before and after it. With
2721 "top boot sector" type flash chips, you would put the
2722 environment in one of the last sectors, leaving a gap
2723 between U-Boot and the environment.
2724
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002725 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002726
2727 Offset of environment data (variable area) to the
2728 beginning of flash memory; for instance, with bottom boot
2729 type flash chips the second sector can be used: the offset
2730 for this sector is given here.
2731
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002732 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002733
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002734 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002735
2736 This is just another way to specify the start address of
2737 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002738 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002739
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002740 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002741
2742 Size of the sector containing the environment.
2743
2744
2745 b) Sometimes flash chips have few, equal sized, BIG sectors.
2746 In such a case you don't want to spend a whole sector for
2747 the environment.
2748
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002749 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002750
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002751 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002752 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002753 of this flash sector for the environment. This saves
2754 memory for the RAM copy of the environment.
2755
2756 It may also save flash memory if you decide to use this
2757 when your environment is "embedded" within U-Boot code,
2758 since then the remainder of the flash sector could be used
2759 for U-Boot code. It should be pointed out that this is
2760 STRONGLY DISCOURAGED from a robustness point of view:
2761 updating the environment in flash makes it always
2762 necessary to erase the WHOLE sector. If something goes
2763 wrong before the contents has been restored from a copy in
2764 RAM, your target system will be dead.
2765
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002766 - CONFIG_ENV_ADDR_REDUND
2767 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002768
wdenk4a5c8a72003-03-06 00:02:04 +00002769 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002770 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002771 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002772 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002773
2774BE CAREFUL! Any changes to the flash layout, and some changes to the
2775source code will make it necessary to adapt <board>/u-boot.lds*
2776accordingly!
2777
2778
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02002779- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002780
2781 Define this if you have some non-volatile memory device
2782 (NVRAM, battery buffered SRAM) which you want to use for the
2783 environment.
2784
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002785 - CONFIG_ENV_ADDR:
2786 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002787
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002788 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002789 want to use for environment. It is assumed that this memory
2790 can just be read and written to, without any special
2791 provision.
2792
2793BE CAREFUL! The first access to the environment happens quite early
2794in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002795console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002796U-Boot will hang.
2797
2798Please note that even with NVRAM we still use a copy of the
2799environment in RAM: we could work on NVRAM directly, but we want to
2800keep settings there always unmodified except somebody uses "saveenv"
2801to save the current settings.
2802
2803
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02002804- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002805
2806 Use this if you have an EEPROM or similar serial access
2807 device and a driver for it.
2808
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002809 - CONFIG_ENV_OFFSET:
2810 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002811
2812 These two #defines specify the offset and size of the
2813 environment area within the total memory of your EEPROM.
2814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002815 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002816 If defined, specified the chip address of the EEPROM device.
2817 The default address is zero.
2818
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002819 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002820 If defined, the number of bits used to address bytes in a
2821 single page in the EEPROM device. A 64 byte page, for example
2822 would require six bits.
2823
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002824 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002825 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002826 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002827
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002828 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002829 The length in bytes of the EEPROM memory array address. Note
2830 that this is NOT the chip address length!
2831
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002832 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00002833 EEPROM chips that implement "address overflow" are ones
2834 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2835 address and the extra bits end up in the "chip address" bit
2836 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2837 byte chips.
2838
2839 Note that we consider the length of the address field to
2840 still be one byte because the extra address bits are hidden
2841 in the chip address.
2842
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002843 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002844 The size in bytes of the EEPROM device.
2845
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01002846 - CONFIG_ENV_EEPROM_IS_ON_I2C
2847 define this, if you have I2C and SPI activated, and your
2848 EEPROM, which holds the environment, is on the I2C bus.
2849
2850 - CONFIG_I2C_ENV_EEPROM_BUS
2851 if you have an Environment on an EEPROM reached over
2852 I2C muxes, you can define here, how to reach this
2853 EEPROM. For example:
2854
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02002855 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01002856
2857 EEPROM which holds the environment, is reached over
2858 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002859
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02002860- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00002861
wdenk1ebf41e2004-01-02 14:00:00 +00002862 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002863 want to use for the environment.
2864
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002865 - CONFIG_ENV_OFFSET:
2866 - CONFIG_ENV_ADDR:
2867 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00002868
2869 These three #defines specify the offset and size of the
2870 environment area within the total memory of your DataFlash placed
2871 at the specified address.
2872
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02002873- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00002874
2875 Define this if you have a NAND device which you want to use
2876 for the environment.
2877
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002878 - CONFIG_ENV_OFFSET:
2879 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00002880
2881 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05002882 area within the first NAND device. CONFIG_ENV_OFFSET must be
2883 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00002884
Scott Wood08239322010-09-17 14:38:37 -05002885 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002886
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002887 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05002888 size used to hold a redundant copy of the environment data, so
2889 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00002890 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05002891 aligned to an erase block boundary.
2892
2893 - CONFIG_ENV_RANGE (optional):
2894
2895 Specifies the length of the region in which the environment
2896 can be written. This should be a multiple of the NAND device's
2897 block size. Specifying a range with more erase blocks than
2898 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2899 the range to be avoided.
2900
2901 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002902
Scott Wood08239322010-09-17 14:38:37 -05002903 Enables support for dynamically retrieving the offset of the
2904 environment from block zero's out-of-band data. The
2905 "nand env.oob" command can be used to record this offset.
2906 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2907 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002908
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002909- CONFIG_NAND_ENV_DST
2910
2911 Defines address in RAM to which the nand_spl code should copy the
2912 environment. If redundant environment is used, it will be copied to
2913 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002915- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002916
2917 Defines offset to the initial SPI buffer area in DPRAM. The
2918 area is used at an early stage (ROM part) if the environment
2919 is configured to reside in the SPI EEPROM: We need a 520 byte
2920 scratch DPRAM area. It is used between the two initialization
2921 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2922 to be a good choice since it makes it far enough from the
2923 start of the data area as well as from the stack pointer.
2924
Bruce Adleredecc942007-11-02 13:15:42 -07002925Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002926has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02002927created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002928until then to read environment variables.
2929
wdenk8dba0502003-03-31 16:34:49 +00002930The environment is protected by a CRC32 checksum. Before the monitor
2931is relocated into RAM, as a result of a bad CRC you will be working
2932with the compiled-in default environment - *silently*!!! [This is
2933necessary, because the first environment variable we need is the
2934"baudrate" setting for the console - if we have a bad CRC, we don't
2935have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002936
2937Note: once the monitor has been relocated, then it will complain if
2938the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002939use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002941- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002942 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002943
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002944 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002945 also needs to be defined.
2946
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002947- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002948 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002949
Ron Madriddfa028a2009-02-18 14:30:44 -08002950- CONFIG_NS16550_MIN_FUNCTIONS:
2951 Define this if you desire to only have use of the NS16550_init
2952 and NS16550_putc functions for the serial driver located at
2953 drivers/serial/ns16550.c. This option is useful for saving
2954 space for already greatly restricted images, including but not
2955 limited to NAND_SPL configurations.
2956
wdenkc6097192002-11-03 00:24:07 +00002957Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002958---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002959
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002960- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002961 Cache Line Size of the CPU.
2962
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002963- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002964 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002965
wdenk9c53f402003-10-15 23:53:47 +00002966 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2967 and RPXsuper) to be able to adjust the position of
2968 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002969
Timur Tabid8f341c2011-08-04 18:03:41 -05002970- CONFIG_SYS_CCSRBAR_DEFAULT:
2971 Default (power-on reset) physical address of CCSR on Freescale
2972 PowerPC SOCs.
2973
2974- CONFIG_SYS_CCSRBAR:
2975 Virtual address of CCSR. On a 32-bit build, this is typically
2976 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2977
2978 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2979 for cross-platform code that uses that macro instead.
2980
2981- CONFIG_SYS_CCSRBAR_PHYS:
2982 Physical address of CCSR. CCSR can be relocated to a new
2983 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002984 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002985 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2986 is typically relocated on 36-bit builds. It is recommended
2987 that this macro be defined via the _HIGH and _LOW macros:
2988
2989 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2990 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2991
2992- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002993 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2994 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002995 used in assembly code, so it must not contain typecasts or
2996 integer size suffixes (e.g. "ULL").
2997
2998- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2999 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3000 used in assembly code, so it must not contain typecasts or
3001 integer size suffixes (e.g. "ULL").
3002
3003- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3004 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3005 forced to a value that ensures that CCSR is not relocated.
3006
wdenk1272e232002-11-10 22:06:23 +00003007- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003008 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003009
3010 the default drive number (default value 0)
3011
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003012 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003013
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003014 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003015 (default value 1)
3016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003017 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003018
wdenk4a5c8a72003-03-06 00:02:04 +00003019 defines the offset of register from address. It
3020 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003021 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003022
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003023 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3024 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003025 default value.
wdenk1272e232002-11-10 22:06:23 +00003026
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003027 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003028 fdc_hw_init() is called at the beginning of the FDC
3029 setup. fdc_hw_init() must be provided by the board
3030 source code. It is used to make hardware dependant
3031 initializations.
wdenk1272e232002-11-10 22:06:23 +00003032
Macpaul Lind1e49942011-04-11 20:45:32 +00003033- CONFIG_IDE_AHB:
3034 Most IDE controllers were designed to be connected with PCI
3035 interface. Only few of them were designed for AHB interface.
3036 When software is doing ATA command and data transfer to
3037 IDE devices through IDE-AHB controller, some additional
3038 registers accessing to these kind of IDE-AHB controller
3039 is requierd.
3040
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003041- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003042 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003043 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003045- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003046
wdenkeb20ad32003-09-05 23:19:14 +00003047 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003048 initial data and stack; please note that this must be
3049 writable memory that is working WITHOUT special
3050 initialization, i. e. you CANNOT use normal RAM which
3051 will become available only after programming the
3052 memory controller and running certain initialization
3053 sequences.
3054
3055 U-Boot uses the following memory types:
3056 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3057 - MPC824X: data cache
3058 - PPC4xx: data cache
3059
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003060- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003061
3062 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003063 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3064 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003065 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003066 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003067 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3068 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3069 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003070
3071 Note:
3072 On the MPC824X (or other systems that use the data
3073 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003074 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003075 point to an otherwise UNUSED address space between
3076 the top of RAM and the start of the PCI space.
3077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003078- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003080- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003082- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003084- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003085
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003086- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003087
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003088- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003089
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003090- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003091 SDRAM timing
3092
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003093- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003094 periodic timer for refresh
3095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003096- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003098- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3099 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3100 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3101 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003102 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3103
3104- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3106 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003107 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3108
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003109- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3110 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003111 Machine Mode Register and Memory Periodic Timer
3112 Prescaler definitions (SDRAM timing)
3113
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003114- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003115 enable I2C microcode relocation patch (MPC8xx);
3116 define relocation offset in DPRAM [DSP2]
3117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003118- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003119 enable SMC microcode relocation patch (MPC8xx);
3120 define relocation offset in DPRAM [SMC1]
3121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003122- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003123 enable SPI microcode relocation patch (MPC8xx);
3124 define relocation offset in DPRAM [SCC4]
3125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003126- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003127 Use OSCM clock mode on MBX8xx board. Be careful,
3128 wrong setting might damage your board. Read
3129 doc/README.MBX before setting this variable!
3130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003131- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003132 Offset of the bootmode word in DPRAM used by post
3133 (Power On Self Tests). This definition overrides
3134 #define'd default value in commproc.h resp.
3135 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003136
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003137- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3138 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3139 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3140 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3141 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3142 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3143 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3144 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003145 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003146
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003147- CONFIG_PCI_DISABLE_PCIE:
3148 Disable PCI-Express on systems where it is supported but not
3149 required.
3150
Kumar Gala8975d7a2010-12-30 12:09:53 -06003151- CONFIG_SYS_SRIO:
3152 Chip has SRIO or not
3153
3154- CONFIG_SRIO1:
3155 Board has SRIO 1 port available
3156
3157- CONFIG_SRIO2:
3158 Board has SRIO 2 port available
3159
3160- CONFIG_SYS_SRIOn_MEM_VIRT:
3161 Virtual Address of SRIO port 'n' memory region
3162
3163- CONFIG_SYS_SRIOn_MEM_PHYS:
3164 Physical Address of SRIO port 'n' memory region
3165
3166- CONFIG_SYS_SRIOn_MEM_SIZE:
3167 Size of SRIO port 'n' memory region
3168
Alex Watermancd6aae32011-05-19 15:08:36 -04003169- CONFIG_SYS_NDFC_16
3170 Defined to tell the NDFC that the NAND chip is using a
3171 16 bit bus.
3172
3173- CONFIG_SYS_NDFC_EBC0_CFG
3174 Sets the EBC0_CFG register for the NDFC. If not defined
3175 a default value will be used.
3176
Ben Warren45657152006-09-07 16:50:54 -04003177- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003178 Get DDR timing information from an I2C EEPROM. Common
3179 with pluggable memory modules such as SODIMMs
3180
Ben Warren45657152006-09-07 16:50:54 -04003181 SPD_EEPROM_ADDRESS
3182 I2C address of the SPD EEPROM
3183
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003184- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003185 If SPD EEPROM is on an I2C bus other than the first
3186 one, specify here. Note that the value must resolve
3187 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003188
York Sune73cc042011-06-07 09:42:16 +08003189- CONFIG_SYS_DDR_RAW_TIMING
3190 Get DDR timing information from other than SPD. Common with
3191 soldered DDR chips onboard without SPD. DDR raw timing
3192 parameters are extracted from datasheet and hard-coded into
3193 header files or board specific files.
3194
York Sunbd495cf2011-09-16 13:21:35 -07003195- CONFIG_FSL_DDR_INTERACTIVE
3196 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003198- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003199 Only for 83xx systems. If specified, then DDR should
3200 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003201
wdenk6203e402004-04-18 10:13:26 +00003202- CONFIG_ETHER_ON_FEC[12]
3203 Define to enable FEC[12] on a 8xx series processor.
3204
3205- CONFIG_FEC[12]_PHY
3206 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003207 to the given FEC; i. e.
3208 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003209 means that the PHY with address 4 is connected to FEC1
3210
3211 When set to -1, means to probe for first available.
3212
3213- CONFIG_FEC[12]_PHY_NORXERR
3214 The PHY does not have a RXERR line (RMII only).
3215 (so program the FEC to ignore it).
3216
3217- CONFIG_RMII
3218 Enable RMII mode for all FECs.
3219 Note that this is a global option, we can't
3220 have one FEC in standard MII mode and another in RMII mode.
3221
wdenk20c98a62004-04-23 20:32:05 +00003222- CONFIG_CRC32_VERIFY
3223 Add a verify option to the crc32 command.
3224 The syntax is:
3225
3226 => crc32 -v <address> <count> <crc32>
3227
3228 Where address/count indicate a memory area
3229 and crc32 is the correct crc32 which the
3230 area should have.
3231
wdenk64519362004-07-11 17:40:54 +00003232- CONFIG_LOOPW
3233 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003234 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003235
stroesecc3af832004-12-16 18:46:55 +00003236- CONFIG_MX_CYCLIC
3237 Add the "mdc" and "mwc" memory commands. These are cyclic
3238 "md/mw" commands.
3239 Examples:
3240
wdenk07d7e6b2004-12-16 21:44:03 +00003241 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003242 This command will print 4 bytes (10,11,12,13) each 500 ms.
3243
wdenk07d7e6b2004-12-16 21:44:03 +00003244 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003245 This command will write 12345678 to address 100 all 10 ms.
3246
wdenk07d7e6b2004-12-16 21:44:03 +00003247 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003248 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003249
wdenk3d3d99f2005-04-04 12:44:11 +00003250- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003251 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003252 low level initializations (like setting up the memory
3253 controller) are omitted and/or U-Boot does not
3254 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003255
Wolfgang Denk302141d2010-11-27 23:30:56 +01003256 Normally this variable MUST NOT be defined. The only
3257 exception is when U-Boot is loaded (to RAM) by some
3258 other boot loader or by a debugger which performs
3259 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003260
Aneesh V552a3192011-07-13 05:11:07 +00003261- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003262 Modifies the behaviour of start.S when compiling a loader
3263 that is executed before the actual U-Boot. E.g. when
3264 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003265
Heiko Schocher44bd9b32011-11-01 20:00:30 +00003266- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3267 define this, if you want to read first the oob data
3268 and then the data. This is used for example on
3269 davinci plattforms.
3270
Matthias Weisser93416c12011-03-10 21:36:32 +00003271- CONFIG_USE_ARCH_MEMCPY
3272 CONFIG_USE_ARCH_MEMSET
3273 If these options are used a optimized version of memcpy/memset will
3274 be used if available. These functions may be faster under some
3275 conditions but may increase the binary size.
3276
wdenkc6097192002-11-03 00:24:07 +00003277Building the Software:
3278======================
3279
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003280Building U-Boot has been tested in several native build environments
3281and in many different cross environments. Of course we cannot support
3282all possibly existing versions of cross development tools in all
3283(potentially obsolete) versions. In case of tool chain problems we
3284recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3285which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003286
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003287If you are not using a native environment, it is assumed that you
3288have GNU cross compiling tools available in your path. In this case,
3289you must set the environment variable CROSS_COMPILE in your shell.
3290Note that no changes to the Makefile or any other source files are
3291necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003292
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003293 $ CROSS_COMPILE=ppc_4xx-
3294 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003295
Peter Tyserb06976d2009-03-13 18:54:51 -05003296Note: If you wish to generate Windows versions of the utilities in
3297 the tools directory you can use the MinGW toolchain
3298 (http://www.mingw.org). Set your HOST tools to the MinGW
3299 toolchain and execute 'make tools'. For example:
3300
3301 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3302
3303 Binaries such as tools/mkimage.exe will be created which can
3304 be executed on computers running Windows.
3305
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003306U-Boot is intended to be simple to build. After installing the
3307sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003308is done by typing:
3309
3310 make NAME_config
3311
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003312where "NAME_config" is the name of one of the existing configu-
3313rations; see the main Makefile for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003314
wdenk6c59edc2004-05-03 20:45:30 +00003315Note: for some board special configuration names may exist; check if
3316 additional information is available from the board vendor; for
3317 instance, the TQM823L systems are available without (standard)
3318 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003319 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003320
wdenk6c59edc2004-05-03 20:45:30 +00003321 make TQM823L_config
3322 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003323
wdenk6c59edc2004-05-03 20:45:30 +00003324 make TQM823L_LCD_config
3325 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk6c59edc2004-05-03 20:45:30 +00003327 etc.
wdenkc6097192002-11-03 00:24:07 +00003328
wdenkc6097192002-11-03 00:24:07 +00003329
wdenk6c59edc2004-05-03 20:45:30 +00003330Finally, type "make all", and you should get some working U-Boot
3331images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk6c59edc2004-05-03 20:45:30 +00003333- "u-boot.bin" is a raw binary image
3334- "u-boot" is an image in ELF binary format
3335- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003336
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003337By default the build is performed locally and the objects are saved
3338in the source directory. One of the two methods can be used to change
3339this behavior and build U-Boot to some external directory:
3340
33411. Add O= to the make command line invocations:
3342
3343 make O=/tmp/build distclean
3344 make O=/tmp/build NAME_config
3345 make O=/tmp/build all
3346
33472. Set environment variable BUILD_DIR to point to the desired location:
3348
3349 export BUILD_DIR=/tmp/build
3350 make distclean
3351 make NAME_config
3352 make all
3353
3354Note that the command line "O=" setting overrides the BUILD_DIR environment
3355variable.
3356
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk6c59edc2004-05-03 20:45:30 +00003358Please be aware that the Makefiles assume you are using GNU make, so
3359for instance on NetBSD you might need to use "gmake" instead of
3360native "make".
wdenkc6097192002-11-03 00:24:07 +00003361
wdenkc6097192002-11-03 00:24:07 +00003362
wdenk6c59edc2004-05-03 20:45:30 +00003363If the system board that you have is not listed, then you will need
3364to port U-Boot to your hardware platform. To do this, follow these
3365steps:
wdenkc6097192002-11-03 00:24:07 +00003366
wdenk6c59edc2004-05-03 20:45:30 +000033671. Add a new configuration option for your board to the toplevel
3368 "Makefile" and to the "MAKEALL" script, using the existing
3369 entries as examples. Note that here and at many other places
3370 boards and other names are listed in alphabetical sort order. Please
3371 keep this order.
33722. Create a new directory to hold your board specific code. Add any
3373 files you need. In your board directory, you will need at least
3374 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
33753. Create a new configuration file "include/configs/<board>.h" for
3376 your board
33773. If you're porting U-Boot to a new CPU, then also create a new
3378 directory to hold your CPU specific code. Add any files you need.
33794. Run "make <board>_config" with your new name.
33805. Type "make", and you should get a working "u-boot.srec" file
3381 to be installed on your target system.
33826. Debug and solve any problems that might arise.
3383 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003384
wdenkc6097192002-11-03 00:24:07 +00003385
wdenk6c59edc2004-05-03 20:45:30 +00003386Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3387==============================================================
wdenkc6097192002-11-03 00:24:07 +00003388
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003389If you have modified U-Boot sources (for instance added a new board
3390or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003391provide feedback to the other developers. The feedback normally takes
3392the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003393official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003394
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003395But before you submit such a patch, please verify that your modifi-
3396cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003397the supported boards compile WITHOUT ANY compiler warnings. To do so,
3398just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003399for ALL supported system. Be warned, this will take a while. You can
3400select which (cross) compiler to use by passing a `CROSS_COMPILE'
3401environment variable to the script, i. e. to use the ELDK cross tools
3402you can type
wdenkc6097192002-11-03 00:24:07 +00003403
wdenk6c59edc2004-05-03 20:45:30 +00003404 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk6c59edc2004-05-03 20:45:30 +00003406or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk6c59edc2004-05-03 20:45:30 +00003408 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003409
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003410When using the MAKEALL script, the default behaviour is to build
3411U-Boot in the source directory. This location can be changed by
3412setting the BUILD_DIR environment variable. Also, for each target
3413built, the MAKEALL script saves two log files (<target>.ERR and
3414<target>.MAKEALL) in the <source dir>/LOG directory. This default
3415location can be changed by setting the MAKEALL_LOGDIR environment
3416variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003417
3418 export BUILD_DIR=/tmp/build
3419 export MAKEALL_LOGDIR=/tmp/log
3420 CROSS_COMPILE=ppc_8xx- MAKEALL
3421
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003422With the above settings build objects are saved in the /tmp/build,
3423log files are saved in the /tmp/log and the source tree remains clean
3424during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003425
3426
wdenk6c59edc2004-05-03 20:45:30 +00003427See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003428
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk6c59edc2004-05-03 20:45:30 +00003430Monitor Commands - Overview:
3431============================
wdenkc6097192002-11-03 00:24:07 +00003432
wdenk6c59edc2004-05-03 20:45:30 +00003433go - start application at address 'addr'
3434run - run commands in an environment variable
3435bootm - boot application image from memory
3436bootp - boot image via network using BootP/TFTP protocol
3437tftpboot- boot image via network using TFTP protocol
3438 and env variables "ipaddr" and "serverip"
3439 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003440tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003441rarpboot- boot image via network using RARP/TFTP protocol
3442diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3443loads - load S-Record file over serial line
3444loadb - load binary file over serial line (kermit mode)
3445md - memory display
3446mm - memory modify (auto-incrementing)
3447nm - memory modify (constant address)
3448mw - memory write (fill)
3449cp - memory copy
3450cmp - memory compare
3451crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003452i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003453sspi - SPI utility commands
3454base - print or set address offset
3455printenv- print environment variables
3456setenv - set environment variables
3457saveenv - save environment variables to persistent storage
3458protect - enable or disable FLASH write protection
3459erase - erase FLASH memory
3460flinfo - print FLASH memory information
3461bdinfo - print Board Info structure
3462iminfo - print header information for application image
3463coninfo - print console devices and informations
3464ide - IDE sub-system
3465loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003466loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003467mtest - simple RAM test
3468icache - enable or disable instruction cache
3469dcache - enable or disable data cache
3470reset - Perform RESET of the CPU
3471echo - echo args to console
3472version - print monitor version
3473help - print online help
3474? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003475
wdenkc6097192002-11-03 00:24:07 +00003476
wdenk6c59edc2004-05-03 20:45:30 +00003477Monitor Commands - Detailed Description:
3478========================================
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk6c59edc2004-05-03 20:45:30 +00003480TODO.
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk6c59edc2004-05-03 20:45:30 +00003482For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003483
3484
wdenk6c59edc2004-05-03 20:45:30 +00003485Environment Variables:
3486======================
wdenkc6097192002-11-03 00:24:07 +00003487
wdenk6c59edc2004-05-03 20:45:30 +00003488U-Boot supports user configuration using Environment Variables which
3489can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003490
wdenk6c59edc2004-05-03 20:45:30 +00003491Environment Variables are set using "setenv", printed using
3492"printenv", and saved to Flash using "saveenv". Using "setenv"
3493without a value can be used to delete a variable from the
3494environment. As long as you don't save the environment you are
3495working with an in-memory copy. In case the Flash area containing the
3496environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003497
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003498Some configuration options can be set using Environment Variables.
3499
3500List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003501
wdenk6c59edc2004-05-03 20:45:30 +00003502 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk6c59edc2004-05-03 20:45:30 +00003504 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk6c59edc2004-05-03 20:45:30 +00003506 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk6c59edc2004-05-03 20:45:30 +00003508 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003509
wdenk6c59edc2004-05-03 20:45:30 +00003510 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003511
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003512 bootm_low - Memory range available for image processing in the bootm
3513 command can be restricted. This variable is given as
3514 a hexadecimal number and defines lowest address allowed
3515 for use by the bootm command. See also "bootm_size"
3516 environment variable. Address defined by "bootm_low" is
3517 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003518 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3519 bootm_mapsize.
3520
Wolfgang Denk092ae952011-10-26 10:21:21 +00003521 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00003522 This variable is given as a hexadecimal number and it
3523 defines the size of the memory region starting at base
3524 address bootm_low that is accessible by the Linux kernel
3525 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3526 as the default value if it is defined, and bootm_size is
3527 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003528
3529 bootm_size - Memory range available for image processing in the bootm
3530 command can be restricted. This variable is given as
3531 a hexadecimal number and defines the size of the region
3532 allowed for use by the bootm command. See also "bootm_low"
3533 environment variable.
3534
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003535 updatefile - Location of the software update file on a TFTP server, used
3536 by the automatic software update feature. Please refer to
3537 documentation in doc/README.update for more details.
3538
wdenk6c59edc2004-05-03 20:45:30 +00003539 autoload - if set to "no" (any string beginning with 'n'),
3540 "bootp" will just load perform a lookup of the
3541 configuration from the BOOTP server, but not try to
3542 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003543
wdenk6c59edc2004-05-03 20:45:30 +00003544 autostart - if set to "yes", an image loaded using the "bootp",
3545 "rarpboot", "tftpboot" or "diskboot" commands will
3546 be automatically started (by internally calling
3547 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003548
wdenk6c59edc2004-05-03 20:45:30 +00003549 If set to "no", a standalone image passed to the
3550 "bootm" command will be copied to the load address
3551 (and eventually uncompressed), but NOT be started.
3552 This can be used to load and uncompress arbitrary
3553 data.
wdenkc6097192002-11-03 00:24:07 +00003554
David A. Longd558a4e2011-07-09 16:40:19 -04003555 fdt_high - if set this restricts the maximum address that the
3556 flattened device tree will be copied into upon boot.
3557 If this is set to the special value 0xFFFFFFFF then
3558 the fdt will not be copied at all on boot. For this
3559 to work it must reside in writable memory, have
3560 sufficient padding on the end of it for u-boot to
3561 add the information it needs into it, and the memory
3562 must be accessible by the kernel.
3563
Simon Glassdc6fa642011-10-24 19:15:34 +00003564 fdtcontroladdr- if set this is the address of the control flattened
3565 device tree used by U-Boot when CONFIG_OF_CONTROL is
3566 defined.
3567
wdenk0e2bd9c2004-06-06 21:51:03 +00003568 i2cfast - (PPC405GP|PPC405EP only)
3569 if set to 'y' configures Linux I2C driver for fast
3570 mode (400kHZ). This environment variable is used in
3571 initialization code. So, for changes to be effective
3572 it must be saved and board must be reset.
3573
wdenk6c59edc2004-05-03 20:45:30 +00003574 initrd_high - restrict positioning of initrd images:
3575 If this variable is not set, initrd images will be
3576 copied to the highest possible address in RAM; this
3577 is usually what you want since it allows for
3578 maximum initrd size. If for some reason you want to
3579 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003581 variable to a value of "no" or "off" or "0".
3582 Alternatively, you can set it to a maximum upper
3583 address to use (U-Boot will still check that it
3584 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003585
wdenk6c59edc2004-05-03 20:45:30 +00003586 For instance, when you have a system with 16 MB
3587 RAM, and want to reserve 4 MB from use by Linux,
3588 you can do this by adding "mem=12M" to the value of
3589 the "bootargs" variable. However, now you must make
3590 sure that the initrd image is placed in the first
3591 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003592
wdenk6c59edc2004-05-03 20:45:30 +00003593 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003594
wdenk6c59edc2004-05-03 20:45:30 +00003595 If you set initrd_high to 0xFFFFFFFF, this is an
3596 indication to U-Boot that all addresses are legal
3597 for the Linux kernel, including addresses in flash
3598 memory. In this case U-Boot will NOT COPY the
3599 ramdisk at all. This may be useful to reduce the
3600 boot time on your system, but requires that this
3601 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003602
wdenk6c59edc2004-05-03 20:45:30 +00003603 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk6c59edc2004-05-03 20:45:30 +00003605 loadaddr - Default load address for commands like "bootp",
3606 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003607
wdenk6c59edc2004-05-03 20:45:30 +00003608 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003609
wdenk6c59edc2004-05-03 20:45:30 +00003610 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003611
wdenk6c59edc2004-05-03 20:45:30 +00003612 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk6c59edc2004-05-03 20:45:30 +00003614 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003615
wdenk6c59edc2004-05-03 20:45:30 +00003616 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003617
Mike Frysingera23230c2011-10-02 10:01:27 +00003618 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003619
Mike Frysingera23230c2011-10-02 10:01:27 +00003620 ethact - controls which interface is currently active.
3621 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003622
Heiko Schocherc5e84052010-07-20 17:45:02 +02003623 => setenv ethact FEC
3624 => ping 192.168.0.1 # traffic sent on FEC
3625 => setenv ethact SCC
3626 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003627
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003628 ethrotate - When set to "no" U-Boot does not go through all
3629 available network interfaces.
3630 It just stays at the currently selected interface.
3631
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003632 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003633 either succeed or fail without retrying.
3634 When set to "once" the network operation will
3635 fail when all the available network interfaces
3636 are tried once without success.
3637 Useful on scripts which control the retry operation
3638 themselves.
wdenkc6097192002-11-03 00:24:07 +00003639
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003640 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003641
Wolfgang Denk227b5192005-09-24 23:25:46 +02003642 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003643 UDP source port.
3644
Wolfgang Denk227b5192005-09-24 23:25:46 +02003645 tftpdstport - If this is set, the value is used for TFTP's UDP
3646 destination port instead of the Well Know Port 69.
3647
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003648 tftpblocksize - Block size to use for TFTP transfers; if not set,
3649 we use the TFTP server's default block size
3650
3651 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3652 seconds, minimum value is 1000 = 1 second). Defines
3653 when a packet is considered to be lost so it has to
3654 be retransmitted. The default is 5000 = 5 seconds.
3655 Lowering this value may make downloads succeed
3656 faster in networks with high packet loss rates or
3657 with unreliable TFTP servers.
3658
3659 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003660 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003661 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003662
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003663The following image location variables contain the location of images
3664used in booting. The "Image" column gives the role of the image and is
3665not an environment variable name. The other columns are environment
3666variable names. "File Name" gives the name of the file on a TFTP
3667server, "RAM Address" gives the location in RAM the image will be
3668loaded to, and "Flash Location" gives the image's address in NOR
3669flash or offset in NAND flash.
3670
3671*Note* - these variables don't have to be defined for all boards, some
3672boards currenlty use other variables for these purposes, and some
3673boards use these variables for other purposes.
3674
Wolfgang Denk092ae952011-10-26 10:21:21 +00003675Image File Name RAM Address Flash Location
3676----- --------- ----------- --------------
3677u-boot u-boot u-boot_addr_r u-boot_addr
3678Linux kernel bootfile kernel_addr_r kernel_addr
3679device tree blob fdtfile fdt_addr_r fdt_addr
3680ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003681
wdenk6c59edc2004-05-03 20:45:30 +00003682The following environment variables may be used and automatically
3683updated by the network boot commands ("bootp" and "rarpboot"),
3684depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003685
wdenk6c59edc2004-05-03 20:45:30 +00003686 bootfile - see above
3687 dnsip - IP address of your Domain Name Server
3688 dnsip2 - IP address of your secondary Domain Name Server
3689 gatewayip - IP address of the Gateway (Router) to use
3690 hostname - Target hostname
3691 ipaddr - see above
3692 netmask - Subnet Mask
3693 rootpath - Pathname of the root filesystem on the NFS server
3694 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003695
wdenk145d2c12004-04-15 21:48:45 +00003696
wdenk6c59edc2004-05-03 20:45:30 +00003697There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003698
wdenk6c59edc2004-05-03 20:45:30 +00003699 serial# - contains hardware identification information such
3700 as type string and/or serial number
3701 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk6c59edc2004-05-03 20:45:30 +00003703These variables can be set only once (usually during manufacturing of
3704the board). U-Boot refuses to delete or overwrite these variables
3705once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003706
3707
wdenk6c59edc2004-05-03 20:45:30 +00003708Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk6c59edc2004-05-03 20:45:30 +00003710 ver - Contains the U-Boot version string as printed
3711 with the "version" command. This variable is
3712 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003713
wdenkc6097192002-11-03 00:24:07 +00003714
wdenk6c59edc2004-05-03 20:45:30 +00003715Please note that changes to some configuration parameters may take
3716only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003717
stroeseb9c17c52003-04-04 15:53:41 +00003718
wdenk6c59edc2004-05-03 20:45:30 +00003719Command Line Parsing:
3720=====================
stroeseb9c17c52003-04-04 15:53:41 +00003721
wdenk6c59edc2004-05-03 20:45:30 +00003722There are two different command line parsers available with U-Boot:
3723the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk6c59edc2004-05-03 20:45:30 +00003725Old, simple command line parser:
3726--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk6c59edc2004-05-03 20:45:30 +00003728- supports environment variables (through setenv / saveenv commands)
3729- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003730- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003731- special characters ('$', ';') can be escaped by prefixing with '\',
3732 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003733 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003734- You can also escape text by enclosing in single apostrophes, for example:
3735 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003736
wdenk6c59edc2004-05-03 20:45:30 +00003737Hush shell:
3738-----------
wdenkf4688a22003-05-28 08:06:31 +00003739
wdenk6c59edc2004-05-03 20:45:30 +00003740- similar to Bourne shell, with control structures like
3741 if...then...else...fi, for...do...done; while...do...done,
3742 until...do...done, ...
3743- supports environment ("global") variables (through setenv / saveenv
3744 commands) and local shell variables (through standard shell syntax
3745 "name=value"); only environment variables can be used with "run"
3746 command
wdenkf4688a22003-05-28 08:06:31 +00003747
wdenk6c59edc2004-05-03 20:45:30 +00003748General rules:
3749--------------
wdenkf4688a22003-05-28 08:06:31 +00003750
wdenk6c59edc2004-05-03 20:45:30 +00003751(1) If a command line (or an environment variable executed by a "run"
3752 command) contains several commands separated by semicolon, and
3753 one of these commands fails, then the remaining commands will be
3754 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003755
wdenk6c59edc2004-05-03 20:45:30 +00003756(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003757 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003758 command will cause "run" to terminate, i. e. the remaining
3759 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003760
wdenk6c59edc2004-05-03 20:45:30 +00003761Note for Redundant Ethernet Interfaces:
3762=======================================
wdenkf4688a22003-05-28 08:06:31 +00003763
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003764Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003765such configurations and is capable of automatic selection of a
3766"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003767
wdenk6c59edc2004-05-03 20:45:30 +00003768Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3769MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3770"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003771
wdenk6c59edc2004-05-03 20:45:30 +00003772If the network interface stores some valid MAC address (for instance
3773in SROM), this is used as default address if there is NO correspon-
3774ding setting in the environment; if the corresponding environment
3775variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003776
wdenk6c59edc2004-05-03 20:45:30 +00003777o If the SROM has a valid MAC address, and there is no address in the
3778 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk6c59edc2004-05-03 20:45:30 +00003780o If there is no valid address in the SROM, and a definition in the
3781 environment exists, then the value from the environment variable is
3782 used.
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk6c59edc2004-05-03 20:45:30 +00003784o If both the SROM and the environment contain a MAC address, and
3785 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003786
wdenk6c59edc2004-05-03 20:45:30 +00003787o If both the SROM and the environment contain a MAC address, and the
3788 addresses differ, the value from the environment is used and a
3789 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003790
wdenk6c59edc2004-05-03 20:45:30 +00003791o If neither SROM nor the environment contain a MAC address, an error
3792 is raised.
wdenkc6097192002-11-03 00:24:07 +00003793
Ben Warren6db991a2010-04-26 11:11:46 -07003794If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00003795will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07003796may be skipped by setting the appropriate 'ethmacskip' environment variable.
3797The naming convention is as follows:
3798"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003799
wdenk6c59edc2004-05-03 20:45:30 +00003800Image Formats:
3801==============
wdenkc6097192002-11-03 00:24:07 +00003802
Marian Balakowicz18710b82008-03-12 12:13:13 +01003803U-Boot is capable of booting (and performing other auxiliary operations on)
3804images in two formats:
3805
3806New uImage format (FIT)
3807-----------------------
3808
3809Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3810to Flattened Device Tree). It allows the use of images with multiple
3811components (several kernels, ramdisks, etc.), with contents protected by
3812SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3813
3814
3815Old uImage format
3816-----------------
3817
3818Old image format is based on binary files which can be basically anything,
3819preceded by a special header; see the definitions in include/image.h for
3820details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003821
wdenk6c59edc2004-05-03 20:45:30 +00003822* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3823 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003824 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3825 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3826 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02003827* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003828 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3829 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003830* Compression Type (uncompressed, gzip, bzip2)
3831* Load Address
3832* Entry Point
3833* Image Name
3834* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003835
wdenk6c59edc2004-05-03 20:45:30 +00003836The header is marked by a special Magic Number, and both the header
3837and the data portions of the image are secured against corruption by
3838CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003839
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk6c59edc2004-05-03 20:45:30 +00003841Linux Support:
3842==============
wdenkc6097192002-11-03 00:24:07 +00003843
wdenk6c59edc2004-05-03 20:45:30 +00003844Although U-Boot should support any OS or standalone application
3845easily, the main focus has always been on Linux during the design of
3846U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk6c59edc2004-05-03 20:45:30 +00003848U-Boot includes many features that so far have been part of some
3849special "boot loader" code within the Linux kernel. Also, any
3850"initrd" images to be used are no longer part of one big Linux image;
3851instead, kernel and "initrd" are separate images. This implementation
3852serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003853
wdenk6c59edc2004-05-03 20:45:30 +00003854- the same features can be used for other OS or standalone
3855 applications (for instance: using compressed images to reduce the
3856 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003857
wdenk6c59edc2004-05-03 20:45:30 +00003858- it becomes much easier to port new Linux kernel versions because
3859 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003860
wdenk6c59edc2004-05-03 20:45:30 +00003861- the same Linux kernel image can now be used with different "initrd"
3862 images; of course this also means that different kernel images can
3863 be run with the same "initrd". This makes testing easier (you don't
3864 have to build a new "zImage.initrd" Linux image when you just
3865 change a file in your "initrd"). Also, a field-upgrade of the
3866 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003867
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk6c59edc2004-05-03 20:45:30 +00003869Linux HOWTO:
3870============
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk6c59edc2004-05-03 20:45:30 +00003872Porting Linux to U-Boot based systems:
3873---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk6c59edc2004-05-03 20:45:30 +00003875U-Boot cannot save you from doing all the necessary modifications to
3876configure the Linux device drivers for use with your target hardware
3877(no, we don't intend to provide a full virtual machine interface to
3878Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003879
Stefan Roese88fbf932010-04-15 16:07:28 +02003880But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk6c59edc2004-05-03 20:45:30 +00003882Just make sure your machine specific header file (for instance
3883include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003884Information structure as we define in include/asm-<arch>/u-boot.h,
3885and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003886as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003887
wdenkc6097192002-11-03 00:24:07 +00003888
wdenk6c59edc2004-05-03 20:45:30 +00003889Configuring the Linux kernel:
3890-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk6c59edc2004-05-03 20:45:30 +00003892No specific requirements for U-Boot. Make sure you have some root
3893device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003894
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk6c59edc2004-05-03 20:45:30 +00003896Building a Linux Image:
3897-----------------------
wdenkc6097192002-11-03 00:24:07 +00003898
wdenk6c59edc2004-05-03 20:45:30 +00003899With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3900not used. If you use recent kernel source, a new build target
3901"uImage" will exist which automatically builds an image usable by
3902U-Boot. Most older kernels also have support for a "pImage" target,
3903which was introduced for our predecessor project PPCBoot and uses a
3904100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk6c59edc2004-05-03 20:45:30 +00003906Example:
wdenkc6097192002-11-03 00:24:07 +00003907
wdenk6c59edc2004-05-03 20:45:30 +00003908 make TQM850L_config
3909 make oldconfig
3910 make dep
3911 make uImage
wdenkc6097192002-11-03 00:24:07 +00003912
wdenk6c59edc2004-05-03 20:45:30 +00003913The "uImage" build target uses a special tool (in 'tools/mkimage') to
3914encapsulate a compressed Linux kernel image with header information,
3915CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk6c59edc2004-05-03 20:45:30 +00003917* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003918
wdenk6c59edc2004-05-03 20:45:30 +00003919* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003920
wdenk6c59edc2004-05-03 20:45:30 +00003921 ${CROSS_COMPILE}-objcopy -O binary \
3922 -R .note -R .comment \
3923 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003924
wdenk6c59edc2004-05-03 20:45:30 +00003925* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003926
wdenk6c59edc2004-05-03 20:45:30 +00003927 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003928
wdenk6c59edc2004-05-03 20:45:30 +00003929* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003930
wdenk6c59edc2004-05-03 20:45:30 +00003931 mkimage -A ppc -O linux -T kernel -C gzip \
3932 -a 0 -e 0 -n "Linux Kernel Image" \
3933 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003934
wdenkc6097192002-11-03 00:24:07 +00003935
wdenk6c59edc2004-05-03 20:45:30 +00003936The "mkimage" tool can also be used to create ramdisk images for use
3937with U-Boot, either separated from the Linux kernel image, or
3938combined into one file. "mkimage" encapsulates the images with a 64
3939byte header containing information about target architecture,
3940operating system, image type, compression method, entry points, time
3941stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk6c59edc2004-05-03 20:45:30 +00003943"mkimage" can be called in two ways: to verify existing images and
3944print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003945
wdenk6c59edc2004-05-03 20:45:30 +00003946In the first form (with "-l" option) mkimage lists the information
3947contained in the header of an existing U-Boot image; this includes
3948checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003949
wdenk6c59edc2004-05-03 20:45:30 +00003950 tools/mkimage -l image
3951 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003952
wdenk6c59edc2004-05-03 20:45:30 +00003953The second form (with "-d" option) is used to build a U-Boot image
3954from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003955
wdenk6c59edc2004-05-03 20:45:30 +00003956 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3957 -n name -d data_file image
3958 -A ==> set architecture to 'arch'
3959 -O ==> set operating system to 'os'
3960 -T ==> set image type to 'type'
3961 -C ==> set compression type 'comp'
3962 -a ==> set load address to 'addr' (hex)
3963 -e ==> set entry point to 'ep' (hex)
3964 -n ==> set image name to 'name'
3965 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003966
wdenkcd914452004-05-29 16:53:29 +00003967Right now, all Linux kernels for PowerPC systems use the same load
3968address (0x00000000), but the entry point address depends on the
3969kernel version:
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk6c59edc2004-05-03 20:45:30 +00003971- 2.2.x kernels have the entry point at 0x0000000C,
3972- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003973
wdenk6c59edc2004-05-03 20:45:30 +00003974So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk6c59edc2004-05-03 20:45:30 +00003976 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3977 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003978 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003979 > examples/uImage.TQM850L
3980 Image Name: 2.4.4 kernel for TQM850L
3981 Created: Wed Jul 19 02:34:59 2000
3982 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3983 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3984 Load Address: 0x00000000
3985 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003986
wdenk6c59edc2004-05-03 20:45:30 +00003987To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk6c59edc2004-05-03 20:45:30 +00003989 -> tools/mkimage -l examples/uImage.TQM850L
3990 Image Name: 2.4.4 kernel for TQM850L
3991 Created: Wed Jul 19 02:34:59 2000
3992 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3993 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3994 Load Address: 0x00000000
3995 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003996
wdenk6c59edc2004-05-03 20:45:30 +00003997NOTE: for embedded systems where boot time is critical you can trade
3998speed for memory and install an UNCOMPRESSED image instead: this
3999needs more space in Flash, but boots much faster since it does not
4000need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004001
Stefan Roese88fbf932010-04-15 16:07:28 +02004002 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004003 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4004 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004005 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004006 > examples/uImage.TQM850L-uncompressed
4007 Image Name: 2.4.4 kernel for TQM850L
4008 Created: Wed Jul 19 02:34:59 2000
4009 Image Type: PowerPC Linux Kernel Image (uncompressed)
4010 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4011 Load Address: 0x00000000
4012 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004013
wdenkc6097192002-11-03 00:24:07 +00004014
wdenk6c59edc2004-05-03 20:45:30 +00004015Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4016when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk6c59edc2004-05-03 20:45:30 +00004018 -> tools/mkimage -n 'Simple Ramdisk Image' \
4019 > -A ppc -O linux -T ramdisk -C gzip \
4020 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4021 Image Name: Simple Ramdisk Image
4022 Created: Wed Jan 12 14:01:50 2000
4023 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4024 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4025 Load Address: 0x00000000
4026 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004027
wdenkc6097192002-11-03 00:24:07 +00004028
wdenk6c59edc2004-05-03 20:45:30 +00004029Installing a Linux Image:
4030-------------------------
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk6c59edc2004-05-03 20:45:30 +00004032To downloading a U-Boot image over the serial (console) interface,
4033you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk6c59edc2004-05-03 20:45:30 +00004035 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk6c59edc2004-05-03 20:45:30 +00004037The 'objcopy' does not understand the information in the U-Boot
4038image header, so the resulting S-Record file will be relative to
4039address 0x00000000. To load it to a given address, you need to
4040specify the target address as 'offset' parameter with the 'loads'
4041command.
wdenkc6097192002-11-03 00:24:07 +00004042
wdenk6c59edc2004-05-03 20:45:30 +00004043Example: install the image to address 0x40100000 (which on the
4044TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004045
wdenk6c59edc2004-05-03 20:45:30 +00004046 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk6c59edc2004-05-03 20:45:30 +00004048 .......... done
4049 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk6c59edc2004-05-03 20:45:30 +00004051 => loads 40100000
4052 ## Ready for S-Record download ...
4053 ~>examples/image.srec
4054 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4055 ...
4056 15989 15990 15991 15992
4057 [file transfer complete]
4058 [connected]
4059 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004060
wdenkc6097192002-11-03 00:24:07 +00004061
wdenk6c59edc2004-05-03 20:45:30 +00004062You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004063this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004064corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004065
wdenk6c59edc2004-05-03 20:45:30 +00004066 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk6c59edc2004-05-03 20:45:30 +00004068 ## Checking Image at 40100000 ...
4069 Image Name: 2.2.13 for initrd on TQM850L
4070 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4071 Data Size: 335725 Bytes = 327 kB = 0 MB
4072 Load Address: 00000000
4073 Entry Point: 0000000c
4074 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004075
4076
wdenk6c59edc2004-05-03 20:45:30 +00004077Boot Linux:
4078-----------
wdenkc6097192002-11-03 00:24:07 +00004079
wdenk6c59edc2004-05-03 20:45:30 +00004080The "bootm" command is used to boot an application that is stored in
4081memory (RAM or Flash). In case of a Linux kernel image, the contents
4082of the "bootargs" environment variable is passed to the kernel as
4083parameters. You can check and modify this variable using the
4084"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004085
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk6c59edc2004-05-03 20:45:30 +00004087 => printenv bootargs
4088 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk6c59edc2004-05-03 20:45:30 +00004090 => 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 +00004091
wdenk6c59edc2004-05-03 20:45:30 +00004092 => printenv bootargs
4093 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 +00004094
wdenk6c59edc2004-05-03 20:45:30 +00004095 => bootm 40020000
4096 ## Booting Linux kernel at 40020000 ...
4097 Image Name: 2.2.13 for NFS on TQM850L
4098 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4099 Data Size: 381681 Bytes = 372 kB = 0 MB
4100 Load Address: 00000000
4101 Entry Point: 0000000c
4102 Verifying Checksum ... OK
4103 Uncompressing Kernel Image ... OK
4104 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
4105 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4106 time_init: decrementer frequency = 187500000/60
4107 Calibrating delay loop... 49.77 BogoMIPS
4108 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4109 ...
wdenkc6097192002-11-03 00:24:07 +00004110
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004111If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004112the memory addresses of both the kernel and the initrd image (PPBCOOT
4113format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004114
wdenk6c59edc2004-05-03 20:45:30 +00004115 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk6c59edc2004-05-03 20:45:30 +00004117 ## Checking Image at 40100000 ...
4118 Image Name: 2.2.13 for initrd on TQM850L
4119 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4120 Data Size: 335725 Bytes = 327 kB = 0 MB
4121 Load Address: 00000000
4122 Entry Point: 0000000c
4123 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004124
wdenk6c59edc2004-05-03 20:45:30 +00004125 ## Checking Image at 40200000 ...
4126 Image Name: Simple Ramdisk Image
4127 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4128 Data Size: 566530 Bytes = 553 kB = 0 MB
4129 Load Address: 00000000
4130 Entry Point: 00000000
4131 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk6c59edc2004-05-03 20:45:30 +00004133 => bootm 40100000 40200000
4134 ## Booting Linux kernel at 40100000 ...
4135 Image Name: 2.2.13 for initrd on TQM850L
4136 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4137 Data Size: 335725 Bytes = 327 kB = 0 MB
4138 Load Address: 00000000
4139 Entry Point: 0000000c
4140 Verifying Checksum ... OK
4141 Uncompressing Kernel Image ... OK
4142 ## Loading RAMDisk Image at 40200000 ...
4143 Image Name: Simple Ramdisk Image
4144 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4145 Data Size: 566530 Bytes = 553 kB = 0 MB
4146 Load Address: 00000000
4147 Entry Point: 00000000
4148 Verifying Checksum ... OK
4149 Loading Ramdisk ... OK
4150 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
4151 Boot arguments: root=/dev/ram
4152 time_init: decrementer frequency = 187500000/60
4153 Calibrating delay loop... 49.77 BogoMIPS
4154 ...
4155 RAMDISK: Compressed image found at block 0
4156 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk6c59edc2004-05-03 20:45:30 +00004158 bash#
wdenkc6097192002-11-03 00:24:07 +00004159
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004160Boot Linux and pass a flat device tree:
4161-----------
4162
4163First, U-Boot must be compiled with the appropriate defines. See the section
4164titled "Linux Kernel Interface" above for a more in depth explanation. The
4165following is an example of how to start a kernel and pass an updated
4166flat device tree:
4167
4168=> print oftaddr
4169oftaddr=0x300000
4170=> print oft
4171oft=oftrees/mpc8540ads.dtb
4172=> tftp $oftaddr $oft
4173Speed: 1000, full duplex
4174Using TSEC0 device
4175TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4176Filename 'oftrees/mpc8540ads.dtb'.
4177Load address: 0x300000
4178Loading: #
4179done
4180Bytes transferred = 4106 (100a hex)
4181=> tftp $loadaddr $bootfile
4182Speed: 1000, full duplex
4183Using TSEC0 device
4184TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4185Filename 'uImage'.
4186Load address: 0x200000
4187Loading:############
4188done
4189Bytes transferred = 1029407 (fb51f hex)
4190=> print loadaddr
4191loadaddr=200000
4192=> print oftaddr
4193oftaddr=0x300000
4194=> bootm $loadaddr - $oftaddr
4195## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004196 Image Name: Linux-2.6.17-dirty
4197 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4198 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004199 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004200 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004201 Verifying Checksum ... OK
4202 Uncompressing Kernel Image ... OK
4203Booting using flat device tree at 0x300000
4204Using MPC85xx ADS machine description
4205Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4206[snip]
4207
4208
wdenk6c59edc2004-05-03 20:45:30 +00004209More About U-Boot Image Types:
4210------------------------------
wdenkc6097192002-11-03 00:24:07 +00004211
wdenk6c59edc2004-05-03 20:45:30 +00004212U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004213
wdenk6c59edc2004-05-03 20:45:30 +00004214 "Standalone Programs" are directly runnable in the environment
4215 provided by U-Boot; it is expected that (if they behave
4216 well) you can continue to work in U-Boot after return from
4217 the Standalone Program.
4218 "OS Kernel Images" are usually images of some Embedded OS which
4219 will take over control completely. Usually these programs
4220 will install their own set of exception handlers, device
4221 drivers, set up the MMU, etc. - this means, that you cannot
4222 expect to re-enter U-Boot except by resetting the CPU.
4223 "RAMDisk Images" are more or less just data blocks, and their
4224 parameters (address, size) are passed to an OS kernel that is
4225 being started.
4226 "Multi-File Images" contain several images, typically an OS
4227 (Linux) kernel image and one or more data images like
4228 RAMDisks. This construct is useful for instance when you want
4229 to boot over the network using BOOTP etc., where the boot
4230 server provides just a single image file, but you want to get
4231 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004232
wdenk6c59edc2004-05-03 20:45:30 +00004233 "Multi-File Images" start with a list of image sizes, each
4234 image size (in bytes) specified by an "uint32_t" in network
4235 byte order. This list is terminated by an "(uint32_t)0".
4236 Immediately after the terminating 0 follow the images, one by
4237 one, all aligned on "uint32_t" boundaries (size rounded up to
4238 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004239
wdenk6c59edc2004-05-03 20:45:30 +00004240 "Firmware Images" are binary images containing firmware (like
4241 U-Boot or FPGA images) which usually will be programmed to
4242 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004243
wdenk6c59edc2004-05-03 20:45:30 +00004244 "Script files" are command sequences that will be executed by
4245 U-Boot's command interpreter; this feature is especially
4246 useful when you configure U-Boot to use a real shell (hush)
4247 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004248
stroeseb9c17c52003-04-04 15:53:41 +00004249
wdenk6c59edc2004-05-03 20:45:30 +00004250Standalone HOWTO:
4251=================
stroeseb9c17c52003-04-04 15:53:41 +00004252
wdenk6c59edc2004-05-03 20:45:30 +00004253One of the features of U-Boot is that you can dynamically load and
4254run "standalone" applications, which can use some resources of
4255U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004256
wdenk6c59edc2004-05-03 20:45:30 +00004257Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004258
wdenk6c59edc2004-05-03 20:45:30 +00004259"Hello World" Demo:
4260-------------------
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk6c59edc2004-05-03 20:45:30 +00004262'examples/hello_world.c' contains a small "Hello World" Demo
4263application; it is automatically compiled when you build U-Boot.
4264It's configured to run at address 0x00040004, so you can play with it
4265like that:
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk6c59edc2004-05-03 20:45:30 +00004267 => loads
4268 ## Ready for S-Record download ...
4269 ~>examples/hello_world.srec
4270 1 2 3 4 5 6 7 8 9 10 11 ...
4271 [file transfer complete]
4272 [connected]
4273 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004274
wdenk6c59edc2004-05-03 20:45:30 +00004275 => go 40004 Hello World! This is a test.
4276 ## Starting application at 0x00040004 ...
4277 Hello World
4278 argc = 7
4279 argv[0] = "40004"
4280 argv[1] = "Hello"
4281 argv[2] = "World!"
4282 argv[3] = "This"
4283 argv[4] = "is"
4284 argv[5] = "a"
4285 argv[6] = "test."
4286 argv[7] = "<NULL>"
4287 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004288
wdenk6c59edc2004-05-03 20:45:30 +00004289 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004290
wdenk6c59edc2004-05-03 20:45:30 +00004291Another example, which demonstrates how to register a CPM interrupt
4292handler with the U-Boot code, can be found in 'examples/timer.c'.
4293Here, a CPM timer is set up to generate an interrupt every second.
4294The interrupt service routine is trivial, just printing a '.'
4295character, but this is just a demo program. The application can be
4296controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk6c59edc2004-05-03 20:45:30 +00004298 ? - print current values og the CPM Timer registers
4299 b - enable interrupts and start timer
4300 e - stop timer and disable interrupts
4301 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004302
wdenk6c59edc2004-05-03 20:45:30 +00004303 => loads
4304 ## Ready for S-Record download ...
4305 ~>examples/timer.srec
4306 1 2 3 4 5 6 7 8 9 10 11 ...
4307 [file transfer complete]
4308 [connected]
4309 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk6c59edc2004-05-03 20:45:30 +00004311 => go 40004
4312 ## Starting application at 0x00040004 ...
4313 TIMERS=0xfff00980
4314 Using timer 1
4315 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk6c59edc2004-05-03 20:45:30 +00004317Hit 'b':
4318 [q, b, e, ?] Set interval 1000000 us
4319 Enabling timer
4320Hit '?':
4321 [q, b, e, ?] ........
4322 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4323Hit '?':
4324 [q, b, e, ?] .
4325 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4326Hit '?':
4327 [q, b, e, ?] .
4328 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4329Hit '?':
4330 [q, b, e, ?] .
4331 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4332Hit 'e':
4333 [q, b, e, ?] ...Stopping timer
4334Hit 'q':
4335 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004336
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk6c59edc2004-05-03 20:45:30 +00004338Minicom warning:
4339================
wdenkc6097192002-11-03 00:24:07 +00004340
wdenk6c59edc2004-05-03 20:45:30 +00004341Over time, many people have reported problems when trying to use the
4342"minicom" terminal emulation program for serial download. I (wd)
4343consider minicom to be broken, and recommend not to use it. Under
4344Unix, I recommend to use C-Kermit for general purpose use (and
4345especially for kermit binary protocol download ("loadb" command), and
4346use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00004347
wdenk6c59edc2004-05-03 20:45:30 +00004348Nevertheless, if you absolutely want to use it try adding this
4349configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk6c59edc2004-05-03 20:45:30 +00004351 Name Program Name U/D FullScr IO-Red. Multi
4352 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4353 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004354
wdenk8dba0502003-03-31 16:34:49 +00004355
wdenk6c59edc2004-05-03 20:45:30 +00004356NetBSD Notes:
4357=============
wdenkc6097192002-11-03 00:24:07 +00004358
wdenk6c59edc2004-05-03 20:45:30 +00004359Starting at version 0.9.2, U-Boot supports NetBSD both as host
4360(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004361
wdenk6c59edc2004-05-03 20:45:30 +00004362Building requires a cross environment; it is known to work on
4363NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4364need gmake since the Makefiles are not compatible with BSD make).
4365Note that the cross-powerpc package does not install include files;
4366attempting to build U-Boot will fail because <machine/ansi.h> is
4367missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004368
wdenk6c59edc2004-05-03 20:45:30 +00004369 # cd /usr/pkg/cross/powerpc-netbsd/include
4370 # mkdir powerpc
4371 # ln -s powerpc machine
4372 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4373 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004374
wdenk6c59edc2004-05-03 20:45:30 +00004375Native builds *don't* work due to incompatibilities between native
4376and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk6c59edc2004-05-03 20:45:30 +00004378Booting assumes that (the first part of) the image booted is a
4379stage-2 loader which in turn loads and then invokes the kernel
4380proper. Loader sources will eventually appear in the NetBSD source
4381tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004382meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004383
wdenkc6097192002-11-03 00:24:07 +00004384
wdenk6c59edc2004-05-03 20:45:30 +00004385Implementation Internals:
4386=========================
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk6c59edc2004-05-03 20:45:30 +00004388The following is not intended to be a complete description of every
4389implementation detail. However, it should help to understand the
4390inner workings of U-Boot and make it easier to port it to custom
4391hardware.
wdenkc6097192002-11-03 00:24:07 +00004392
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk6c59edc2004-05-03 20:45:30 +00004394Initial Stack, Global Data:
4395---------------------------
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk6c59edc2004-05-03 20:45:30 +00004397The implementation of U-Boot is complicated by the fact that U-Boot
4398starts running out of ROM (flash memory), usually without access to
4399system RAM (because the memory controller is not initialized yet).
4400This means that we don't have writable Data or BSS segments, and BSS
4401is not initialized as zero. To be able to get a C environment working
4402at all, we have to allocate at least a minimal stack. Implementation
4403options for this are defined and restricted by the CPU used: Some CPU
4404models provide on-chip memory (like the IMMR area on MPC8xx and
4405MPC826x processors), on others (parts of) the data cache can be
4406locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004407
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004408 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004409 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk6c59edc2004-05-03 20:45:30 +00004411 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4412 From: "Chris Hallinan" <clh@net1plus.com>
4413 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4414 ...
wdenkc6097192002-11-03 00:24:07 +00004415
wdenk6c59edc2004-05-03 20:45:30 +00004416 Correct me if I'm wrong, folks, but the way I understand it
4417 is this: Using DCACHE as initial RAM for Stack, etc, does not
4418 require any physical RAM backing up the cache. The cleverness
4419 is that the cache is being used as a temporary supply of
4420 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004421 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004422 can see how this works by studying the cache architecture and
4423 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4426 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004427 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004428 option should work for you. Using CS 4 should be fine if your
4429 board designers haven't used it for something that would
4430 cause you grief during the initial boot! It is frequently not
4431 used.
wdenkc6097192002-11-03 00:24:07 +00004432
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004433 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004434 with your processor/board/system design. The default value
4435 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004436 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004437 than your SDRAM module. If you have a 64MB SDRAM module, set
4438 it above 400_0000. Just make sure your board has no resources
4439 that are supposed to respond to that address! That code in
4440 start.S has been around a while and should work as is when
4441 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004442
wdenk6c59edc2004-05-03 20:45:30 +00004443 -Chris Hallinan
4444 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004445
wdenk6c59edc2004-05-03 20:45:30 +00004446It is essential to remember this, since it has some impact on the C
4447code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004448
wdenk6c59edc2004-05-03 20:45:30 +00004449* Initialized global data (data segment) is read-only. Do not attempt
4450 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004451
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004452* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00004453 as zero data - BSS segment) at all - this is undefined, initiali-
4454 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004455
wdenk6c59edc2004-05-03 20:45:30 +00004456* Stack space is very limited. Avoid big data buffers or things like
4457 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004458
wdenk6c59edc2004-05-03 20:45:30 +00004459Having only the stack as writable memory limits means we cannot use
4460normal global data to share information beween the code. But it
4461turned out that the implementation of U-Boot can be greatly
4462simplified by making a global data structure (gd_t) available to all
4463functions. We could pass a pointer to this data as argument to _all_
4464functions, but this would bloat the code. Instead we use a feature of
4465the GCC compiler (Global Register Variables) to share the data: we
4466place a pointer (gd) to the global data into a register which we
4467reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004468
wdenk6c59edc2004-05-03 20:45:30 +00004469When choosing a register for such a purpose we are restricted by the
4470relevant (E)ABI specifications for the current architecture, and by
4471GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk6c59edc2004-05-03 20:45:30 +00004473For PowerPC, the following registers have specific use:
4474 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004475 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004476 R3-R4: parameter passing and return values
4477 R5-R10: parameter passing
4478 R13: small data area pointer
4479 R30: GOT pointer
4480 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004481
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004482 (U-Boot also uses R12 as internal GOT pointer. r12
4483 is a volatile register so r12 needs to be reset when
4484 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004485
Wolfgang Denk69c09642008-02-14 22:43:22 +01004486 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk6c59edc2004-05-03 20:45:30 +00004488 Note: on PPC, we could use a static initializer (since the
4489 address of the global data structure is known at compile time),
4490 but it turned out that reserving a register results in somewhat
4491 smaller code - although the code savings are not that big (on
4492 average for all boards 752 bytes for the whole U-Boot image,
4493 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004494
Robin Getz2773d5f2009-08-17 15:23:02 +00004495On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05004496 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4497
Robin Getz2773d5f2009-08-17 15:23:02 +00004498 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05004499
wdenk6c59edc2004-05-03 20:45:30 +00004500On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk6c59edc2004-05-03 20:45:30 +00004502 R0: function argument word/integer result
4503 R1-R3: function argument word
4504 R9: GOT pointer
4505 R10: stack limit (used only if stack checking if enabled)
4506 R11: argument (frame) pointer
4507 R12: temporary workspace
4508 R13: stack pointer
4509 R14: link register
4510 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004511
wdenk6c59edc2004-05-03 20:45:30 +00004512 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004513
Thomas Chou8fa38582010-05-21 11:08:03 +08004514On Nios II, the ABI is documented here:
4515 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4516
4517 ==> U-Boot will use gp to hold a pointer to the global data
4518
4519 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4520 to access small data sections, so gp is free.
4521
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004522On NDS32, the following registers are used:
4523
4524 R0-R1: argument/return
4525 R2-R5: argument
4526 R15: temporary register for assembler
4527 R16: trampoline register
4528 R28: frame pointer (FP)
4529 R29: global pointer (GP)
4530 R30: link register (LP)
4531 R31: stack pointer (SP)
4532 PC: program counter (PC)
4533
4534 ==> U-Boot will use R10 to hold a pointer to the global data
4535
Wolfgang Denk6405a152006-03-31 18:32:53 +02004536NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4537or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk6c59edc2004-05-03 20:45:30 +00004539Memory Management:
4540------------------
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542U-Boot runs in system state and uses physical addresses, i.e. the
4543MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004544
wdenk6c59edc2004-05-03 20:45:30 +00004545The available memory is mapped to fixed addresses using the memory
4546controller. In this process, a contiguous block is formed for each
4547memory type (Flash, SDRAM, SRAM), even when it consists of several
4548physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550U-Boot is installed in the first 128 kB of the first Flash bank (on
4551TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4552booting and sizing and initializing DRAM, the code relocates itself
4553to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004554memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004555configuration setting]. Below that, a structure with global Board
4556Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk6c59edc2004-05-03 20:45:30 +00004558Additionally, some exception handler code is copied to the low 8 kB
4559of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004560
wdenk6c59edc2004-05-03 20:45:30 +00004561So a typical memory configuration with 16 MB of DRAM could look like
4562this:
wdenkc6097192002-11-03 00:24:07 +00004563
wdenk6c59edc2004-05-03 20:45:30 +00004564 0x0000 0000 Exception Vector code
4565 :
4566 0x0000 1FFF
4567 0x0000 2000 Free for Application Use
4568 :
4569 :
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk6c59edc2004-05-03 20:45:30 +00004571 :
4572 :
4573 0x00FB FF20 Monitor Stack (Growing downward)
4574 0x00FB FFAC Board Info Data and permanent copy of global data
4575 0x00FC 0000 Malloc Arena
4576 :
4577 0x00FD FFFF
4578 0x00FE 0000 RAM Copy of Monitor Code
4579 ... eventually: LCD or video framebuffer
4580 ... eventually: pRAM (Protected RAM - unchanged by reset)
4581 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004582
wdenkc6097192002-11-03 00:24:07 +00004583
wdenk6c59edc2004-05-03 20:45:30 +00004584System Initialization:
4585----------------------
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk6c59edc2004-05-03 20:45:30 +00004587In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004588(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00004589configuration for CS0# this is a mirror of the onboard Flash memory.
4590To be able to re-map memory U-Boot then jumps to its link address.
4591To be able to implement the initialization code in C, a (small!)
4592initial stack is set up in the internal Dual Ported RAM (in case CPUs
4593which provide such a feature like MPC8xx or MPC8260), or in a locked
4594part of the data cache. After that, U-Boot initializes the CPU core,
4595the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004596
wdenk6c59edc2004-05-03 20:45:30 +00004597Next, all (potentially) available memory banks are mapped using a
4598preliminary mapping. For example, we put them on 512 MB boundaries
4599(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4600on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4601programmed for SDRAM access. Using the temporary configuration, a
4602simple memory test is run that determines the size of the SDRAM
4603banks.
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk6c59edc2004-05-03 20:45:30 +00004605When there is more than one SDRAM bank, and the banks are of
4606different size, the largest is mapped first. For equal size, the first
4607bank (CS2#) is mapped first. The first mapping is always for address
46080x00000000, with any additional banks following immediately to create
4609contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk6c59edc2004-05-03 20:45:30 +00004611Then, the monitor installs itself at the upper end of the SDRAM area
4612and allocates memory for use by malloc() and for the global Board
4613Info data; also, the exception vector code is copied to the low RAM
4614pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk6c59edc2004-05-03 20:45:30 +00004616Only after this relocation will you have a "normal" C environment;
4617until that you are restricted in several ways, mostly because you are
4618running from ROM, and because the code will have to be relocated to a
4619new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004620
wdenkc6097192002-11-03 00:24:07 +00004621
wdenk6c59edc2004-05-03 20:45:30 +00004622U-Boot Porting Guide:
4623----------------------
wdenkc6097192002-11-03 00:24:07 +00004624
wdenk6c59edc2004-05-03 20:45:30 +00004625[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4626list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004627
wdenkc6097192002-11-03 00:24:07 +00004628
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004629int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004630{
4631 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004632
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004633 signal(SIGALRM, no_more_time);
4634 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk6c59edc2004-05-03 20:45:30 +00004636 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004637 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004638 return 0;
4639 }
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk6c59edc2004-05-03 20:45:30 +00004641 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004642
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004643 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004644
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004645 if (clueless)
4646 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk6c59edc2004-05-03 20:45:30 +00004648 while (learning) {
4649 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004650 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4651 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00004652 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004653 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004654 }
wdenkc6097192002-11-03 00:24:07 +00004655
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004656 if (available_money > toLocalCurrency ($2500))
4657 Buy a BDI3000;
4658 else
wdenk6c59edc2004-05-03 20:45:30 +00004659 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004660
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004661 if (a similar board exists) { /* hopefully... */
4662 cp -a board/<similar> board/<myboard>
4663 cp include/configs/<similar>.h include/configs/<myboard>.h
4664 } else {
4665 Create your own board support subdirectory;
4666 Create your own board include/configs/<myboard>.h file;
4667 }
4668 Edit new board/<myboard> files
4669 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004670
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004671 while (!accepted) {
4672 while (!running) {
4673 do {
4674 Add / modify source code;
4675 } until (compiles);
4676 Debug;
4677 if (clueless)
4678 email("Hi, I am having problems...");
4679 }
4680 Send patch file to the U-Boot email list;
4681 if (reasonable critiques)
4682 Incorporate improvements from email list code review;
4683 else
4684 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004685 }
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687 return 0;
4688}
wdenkc6097192002-11-03 00:24:07 +00004689
wdenk6c59edc2004-05-03 20:45:30 +00004690void no_more_time (int sig)
4691{
4692 hire_a_guru();
4693}
wdenkc6097192002-11-03 00:24:07 +00004694
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696Coding Standards:
4697-----------------
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk6c59edc2004-05-03 20:45:30 +00004699All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02004700coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004701"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004702
4703Source files originating from a different project (for example the
4704MTD subsystem) are generally exempt from these guidelines and are not
4705reformated to ease subsequent migration to newer versions of those
4706sources.
wdenkc6097192002-11-03 00:24:07 +00004707
Detlev Zundelaa63d482006-09-01 15:39:02 +02004708Please note that U-Boot is implemented in C (and to some small parts in
4709Assembler); no C++ is used, so please do not use C++ style comments (//)
4710in your code.
wdenkad276f22004-01-04 16:28:35 +00004711
wdenk6c59edc2004-05-03 20:45:30 +00004712Please also stick to the following formatting rules:
4713- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004714- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004715- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004716- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004717- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004718
wdenk6c59edc2004-05-03 20:45:30 +00004719Submissions which do not conform to the standards may be returned
4720with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004721
wdenkc6097192002-11-03 00:24:07 +00004722
wdenk6c59edc2004-05-03 20:45:30 +00004723Submitting Patches:
4724-------------------
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk6c59edc2004-05-03 20:45:30 +00004726Since the number of patches for U-Boot is growing, we need to
4727establish some rules. Submissions which do not conform to these rules
4728may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004729
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004730Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004731
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004732Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4733see http://lists.denx.de/mailman/listinfo/u-boot
4734
wdenk6c59edc2004-05-03 20:45:30 +00004735When you send a patch, please include the following information with
4736it:
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk6c59edc2004-05-03 20:45:30 +00004738* For bug fixes: a description of the bug and how your patch fixes
4739 this bug. Please try to include a way of demonstrating that the
4740 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004741
wdenk6c59edc2004-05-03 20:45:30 +00004742* For new features: a description of the feature and your
4743 implementation.
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk6c59edc2004-05-03 20:45:30 +00004749* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004750 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk6c59edc2004-05-03 20:45:30 +00004752* If your patch adds new configuration options, don't forget to
4753 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004754
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004755* The patch itself. If you are using git (which is *strongly*
4756 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004757 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004758 the U-Boot mailing list, you will avoid most of the common problems
4759 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004760
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004761 If you cannot use git, use "diff -purN OLD NEW". If your version of
4762 diff does not support these options, then get the latest version of
4763 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004764
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004765 The current directory when running this command shall be the parent
4766 directory of the U-Boot source tree (i. e. please make sure that
4767 your patch includes sufficient directory information for the
4768 affected files).
4769
4770 We prefer patches as plain text. MIME attachments are discouraged,
4771 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004772
wdenk6c59edc2004-05-03 20:45:30 +00004773* If one logical set of modifications affects or creates several
4774 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004775
wdenk6c59edc2004-05-03 20:45:30 +00004776* Changesets that contain different, unrelated modifications shall be
4777 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004778
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk6c59edc2004-05-03 20:45:30 +00004780Notes:
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782* Before sending the patch, run the MAKEALL script on your patched
4783 source tree and make sure that no errors or warnings are reported
4784 for any of the boards.
4785
4786* Keep your modifications to the necessary minimum: A patch
4787 containing several unrelated changes or arbitrary reformats will be
4788 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk6c59edc2004-05-03 20:45:30 +00004790* If you modify existing code, make sure that your new code does not
4791 add to the memory footprint of the code ;-) Small is beautiful!
4792 When adding new features, these should compile conditionally only
4793 (using #ifdef), and the resulting code with the new feature
4794 disabled must not need more memory than the old code without your
4795 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004796
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004797* Remember that there is a size limit of 100 kB per message on the
4798 u-boot mailing list. Bigger patches will be moderated. If they are
4799 reasonable and not too big, they will be acknowledged. But patches
4800 bigger than the size limit should be avoided.