blob: eb9ade9ad4c987a553f1198786b5e8b051c5425d [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:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
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
Peter Tysere4d1abc2010-04-12 22:28:21 -0500186 /nios2 Files generic to Altera NIOS2 architecture
187 /cpu CPU specific files
188 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200189 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500190 /cpu CPU specific files
191 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
192 /mpc5xx Files specific to Freescale MPC5xx CPUs
193 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
194 /mpc8xx Files specific to Freescale MPC8xx CPUs
195 /mpc8220 Files specific to Freescale MPC8220 CPUs
196 /mpc824x Files specific to Freescale MPC824x CPUs
197 /mpc8260 Files specific to Freescale MPC8260 CPUs
198 /mpc85xx Files specific to Freescale MPC85xx CPUs
199 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
200 /lib Architecture specific library files
201 /sh Files generic to SH architecture
202 /cpu CPU specific files
203 /sh2 Files specific to sh2 CPUs
204 /sh3 Files specific to sh3 CPUs
205 /sh4 Files specific to sh4 CPUs
206 /lib Architecture specific library files
207 /sparc Files generic to SPARC architecture
208 /cpu CPU specific files
209 /leon2 Files specific to Gaisler LEON2 SPARC CPU
210 /leon3 Files specific to Gaisler LEON3 SPARC CPU
211 /lib Architecture specific library files
212/api Machine/arch independent API for external apps
213/board Board dependent files
214/common Misc architecture independent functions
215/disk Code for disk drive partition handling
216/doc Documentation (don't expect too much)
217/drivers Commonly used device drivers
218/examples Example code for standalone applications, etc.
219/fs Filesystem code (cramfs, ext2, jffs2, etc.)
220/include Header Files
221/lib Files generic to all architectures
222 /libfdt Library files to support flattened device trees
223 /lzma Library files to support LZMA decompression
224 /lzo Library files to support LZO decompression
225/net Networking code
226/post Power On Self Test
227/rtc Real Time Clock drivers
228/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000229
wdenkc6097192002-11-03 00:24:07 +0000230Software Configuration:
231=======================
232
233Configuration is usually done using C preprocessor defines; the
234rationale behind that is to avoid dead code whenever possible.
235
236There are two classes of configuration variables:
237
238* Configuration _OPTIONS_:
239 These are selectable by the user and have names beginning with
240 "CONFIG_".
241
242* Configuration _SETTINGS_:
243 These depend on the hardware etc. and should not be meddled with if
244 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200245 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000246
247Later we will add a configuration tool - probably similar to or even
248identical to what's used for the Linux kernel. Right now, we have to
249do the configuration by hand, which means creating some symbolic
250links and editing some configuration files. We use the TQM8xxL boards
251as an example here.
252
253
254Selection of Processor Architecture and Board Type:
255---------------------------------------------------
256
257For all supported boards there are ready-to-use default
258configurations available; just type "make <board_name>_config".
259
260Example: For a TQM823L module type:
261
262 cd u-boot
263 make TQM823L_config
264
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200265For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000266e.g. "make cogent_mpc8xx_config". And also configure the cogent
267directory according to the instructions in cogent/README.
268
269
270Configuration Options:
271----------------------
272
273Configuration depends on the combination of board and CPU type; all
274such information is kept in a configuration file
275"include/configs/<board_name>.h".
276
277Example: For a TQM823L module, all configuration settings are in
278"include/configs/TQM823L.h".
279
280
wdenk1272e232002-11-10 22:06:23 +0000281Many of the options are named exactly as the corresponding Linux
282kernel configuration options. The intention is to make it easier to
283build a config tool - later.
284
285
wdenkc6097192002-11-03 00:24:07 +0000286The following options need to be configured:
287
Kim Phillips203fee32007-08-10 13:28:25 -0500288- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000289
Kim Phillips203fee32007-08-10 13:28:25 -0500290- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200291
292- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100293 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000294
295- CPU Module Type: (if CONFIG_COGENT is defined)
296 Define exactly one of
297 CONFIG_CMA286_60_OLD
298--- FIXME --- not tested yet:
299 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
300 CONFIG_CMA287_23, CONFIG_CMA287_50
301
302- Motherboard Type: (if CONFIG_COGENT is defined)
303 Define exactly one of
304 CONFIG_CMA101, CONFIG_CMA102
305
306- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
307 Define one or more of
308 CONFIG_CMA302
309
310- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
311 Define one or more of
312 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200313 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000314 a "rotator" |\-/|\-/
315
wdenk2bb11052003-07-17 23:16:40 +0000316- Board flavour: (if CONFIG_MPC8260ADS is defined)
317 CONFIG_ADSTYPE
318 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200319 CONFIG_SYS_8260ADS - original MPC8260ADS
320 CONFIG_SYS_8266ADS - MPC8266ADS
321 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
322 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000323
Lei Wen20014762011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
362 CONFIG_SYS_FSL_TBCLK_DIV
363
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
367
Kumar Gala179b1b22011-05-20 00:39:21 -0500368 CONFIG_SYS_FSL_PCIE_COMPAT
369
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
372
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100373- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200374 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100375
376 Defines the Monahans run mode to oscillator
377 ratio. Valid values are 8, 16, 24, 31. The core
378 frequency is this value multiplied by 13 MHz.
379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200380 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200381
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100382 Defines the Monahans turbo mode to oscillator
383 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200384 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100385 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200386
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200387- MIPS CPU options:
388 CONFIG_SYS_INIT_SP_OFFSET
389
390 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
391 pointer. This is needed for the temporary stack before
392 relocation.
393
394 CONFIG_SYS_MIPS_CACHE_MODE
395
396 Cache operation mode for the MIPS CPU.
397 See also arch/mips/include/asm/mipsregs.h.
398 Possible values are:
399 CONF_CM_CACHABLE_NO_WA
400 CONF_CM_CACHABLE_WA
401 CONF_CM_UNCACHED
402 CONF_CM_CACHABLE_NONCOHERENT
403 CONF_CM_CACHABLE_CE
404 CONF_CM_CACHABLE_COW
405 CONF_CM_CACHABLE_CUW
406 CONF_CM_CACHABLE_ACCELERATED
407
408 CONFIG_SYS_XWAY_EBU_BOOTCFG
409
410 Special option for Lantiq XWAY SoCs for booting from NOR flash.
411 See also arch/mips/cpu/mips32/start.S.
412
413 CONFIG_XWAY_SWAP_BYTES
414
415 Enable compilation of tools/xway-swap-bytes needed for Lantiq
416 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
417 be swapped if a flash programmer is used.
418
wdenk9b7f3842003-10-09 20:09:04 +0000419- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000420 CONFIG_CLOCKS_IN_MHZ
421
422 U-Boot stores all clock information in Hz
423 internally. For binary compatibility with older Linux
424 kernels (which expect the clocks passed in the
425 bd_info data to be in MHz) the environment variable
426 "clocks_in_mhz" can be defined so that U-Boot
427 converts clock data to MHZ before passing it to the
428 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000429 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100430 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000431 default environment.
432
wdenk9b7f3842003-10-09 20:09:04 +0000433 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
434
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200435 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000436 expect it to be in bytes, others in MB.
437 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
438
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400439 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200440
441 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400442 passed using flattened device trees (based on open firmware
443 concepts).
444
445 CONFIG_OF_LIBFDT
446 * New libfdt-based support
447 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500448 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400449
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200450 OF_CPU - The proper name of the cpus node (only required for
451 MPC512X and MPC5xxx based boards).
452 OF_SOC - The proper name of the soc node (only required for
453 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200454 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600455 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200456
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200457 boards with QUICC Engines require OF_QE to set UCC MAC
458 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500459
Kumar Gala1e26aa52006-01-11 13:54:17 -0600460 CONFIG_OF_BOARD_SETUP
461
462 Board code has addition modification that it wants to make
463 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000464
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500465 CONFIG_OF_BOOT_CPU
466
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200467 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500468 param header, the default value is zero if undefined.
469
Heiko Schocherffb293a2009-09-23 07:56:08 +0200470 CONFIG_OF_IDE_FIXUP
471
472 U-Boot can detect if an IDE device is present or not.
473 If not, and this new config option is activated, U-Boot
474 removes the ATA node from the DTS before booting Linux,
475 so the Linux IDE driver does not probe the device and
476 crash. This is needed for buggy hardware (uc101) where
477 no pull down resistor is connected to the signal IDE5V_DD7.
478
Igor Grinberg06890672011-07-14 05:45:07 +0000479 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
480
481 This setting is mandatory for all boards that have only one
482 machine type and must be used to specify the machine type
483 number as it appears in the ARM machine registry
484 (see http://www.arm.linux.org.uk/developer/machines/).
485 Only boards that have multiple machine types supported
486 in a single configuration file and the machine type is
487 runtime discoverable, do not have to use this setting.
488
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100489- vxWorks boot parameters:
490
491 bootvx constructs a valid bootline using the following
492 environments variables: bootfile, ipaddr, serverip, hostname.
493 It loads the vxWorks image pointed bootfile.
494
495 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
496 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
497 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
498 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
499
500 CONFIG_SYS_VXWORKS_ADD_PARAMS
501
502 Add it at the end of the bootline. E.g "u=username pw=secret"
503
504 Note: If a "bootargs" environment is defined, it will overwride
505 the defaults discussed just above.
506
Aneesh V960f5c02011-06-16 23:30:47 +0000507- Cache Configuration:
508 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
509 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
510 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
511
Aneesh V686a0752011-06-16 23:30:51 +0000512- Cache Configuration for ARM:
513 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
514 controller
515 CONFIG_SYS_PL310_BASE - Physical base address of PL310
516 controller register space
517
wdenkda04a8b2004-08-02 23:22:59 +0000518- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200519 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000520
521 Define this if you want support for Amba PrimeCell PL010 UARTs.
522
Andreas Engel0813b122008-09-08 14:30:53 +0200523 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000524
525 Define this if you want support for Amba PrimeCell PL011 UARTs.
526
527 CONFIG_PL011_CLOCK
528
529 If you have Amba PrimeCell PL011 UARTs, set this variable to
530 the clock speed of the UARTs.
531
532 CONFIG_PL01x_PORTS
533
534 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
535 define this to a list of base addresses for each (supported)
536 port. See e.g. include/configs/versatile.h
537
John Rigby34e21ee2011-04-19 10:42:39 +0000538 CONFIG_PL011_SERIAL_RLCR
539
540 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
541 have separate receive and transmit line control registers. Set
542 this variable to initialize the extra register.
543
544 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
545
546 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
547 boot loader that has already initialized the UART. Define this
548 variable to flush the UART at init time.
549
wdenkda04a8b2004-08-02 23:22:59 +0000550
wdenkc6097192002-11-03 00:24:07 +0000551- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000552 Depending on board, define exactly one serial port
553 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
554 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
555 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000556
557 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
558 port routines must be defined elsewhere
559 (i.e. serial_init(), serial_getc(), ...)
560
561 CONFIG_CFB_CONSOLE
562 Enables console device for a color framebuffer. Needs following
563 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
564 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
565 (default big endian)
566 VIDEO_HW_RECTFILL graphic chip supports
567 rectangle fill
568 (cf. smiLynxEM)
569 VIDEO_HW_BITBLT graphic chip supports
570 bit-blit (cf. smiLynxEM)
571 VIDEO_VISIBLE_COLS visible pixel columns
572 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000573 VIDEO_VISIBLE_ROWS visible pixel rows
574 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000575 VIDEO_DATA_FORMAT graphic data format
576 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000577 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000578 VIDEO_KBD_INIT_FCT keyboard int fct
579 (i.e. i8042_kbd_init())
580 VIDEO_TSTC_FCT test char fct
581 (i.e. i8042_tstc)
582 VIDEO_GETC_FCT get char fct
583 (i.e. i8042_getc)
584 CONFIG_CONSOLE_CURSOR cursor drawing on/off
585 (requires blink timer
586 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200587 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000588 CONFIG_CONSOLE_TIME display time/date info in
589 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500590 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000591 CONFIG_VIDEO_LOGO display Linux logo in
592 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000593 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
594 linux_logo.h for logo.
595 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000596 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200597 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000598 the logo
599
wdenk4a5c8a72003-03-06 00:02:04 +0000600 When CONFIG_CFB_CONSOLE is defined, video console is
601 default i/o. Serial console can be forced with
602 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000603
wdenk1ebf41e2004-01-02 14:00:00 +0000604 When CONFIG_SILENT_CONSOLE is defined, all console
605 messages (by U-Boot and Linux!) can be silenced with
606 the "silent" environment variable. See
607 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000608
wdenkc6097192002-11-03 00:24:07 +0000609- Console Baudrate:
610 CONFIG_BAUDRATE - in bps
611 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200612 CONFIG_SYS_BAUDRATE_TABLE, see below.
613 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000614
Heiko Schocher327480a2009-01-30 12:55:38 +0100615- Console Rx buffer length
616 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
617 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100618 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100619 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
620 must be defined, to setup the maximum idle timeout for
621 the SMC.
622
Graeme Russ3c28f482011-09-01 00:48:27 +0000623- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200624 Prior to the console being initialised (i.e. serial UART
625 initialised etc) all console output is silently discarded.
626 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
627 buffer any console messages prior to the console being
628 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
629 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
630 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200631 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200632 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000633
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200634 'Sane' compilers will generate smaller code if
635 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000636
wdenkc6097192002-11-03 00:24:07 +0000637- Boot Delay: CONFIG_BOOTDELAY - in seconds
638 Delay before automatically booting the default image;
639 set to -1 to disable autoboot.
640
641 See doc/README.autoboot for these options that
642 work with CONFIG_BOOTDELAY. None are required.
643 CONFIG_BOOT_RETRY_TIME
644 CONFIG_BOOT_RETRY_MIN
645 CONFIG_AUTOBOOT_KEYED
646 CONFIG_AUTOBOOT_PROMPT
647 CONFIG_AUTOBOOT_DELAY_STR
648 CONFIG_AUTOBOOT_STOP_STR
649 CONFIG_AUTOBOOT_DELAY_STR2
650 CONFIG_AUTOBOOT_STOP_STR2
651 CONFIG_ZERO_BOOTDELAY_CHECK
652 CONFIG_RESET_TO_RETRY
653
654- Autoboot Command:
655 CONFIG_BOOTCOMMAND
656 Only needed when CONFIG_BOOTDELAY is enabled;
657 define a command string that is automatically executed
658 when no character is read on the console interface
659 within "Boot Delay" after reset.
660
661 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000662 This can be used to pass arguments to the bootm
663 command. The value of CONFIG_BOOTARGS goes into the
664 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000665
666 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000667 The value of these goes into the environment as
668 "ramboot" and "nfsboot" respectively, and can be used
669 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200670 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000671
672- Pre-Boot Commands:
673 CONFIG_PREBOOT
674
675 When this option is #defined, the existence of the
676 environment variable "preboot" will be checked
677 immediately before starting the CONFIG_BOOTDELAY
678 countdown and/or running the auto-boot command resp.
679 entering interactive mode.
680
681 This feature is especially useful when "preboot" is
682 automatically generated or modified. For an example
683 see the LWMON board specific code: here "preboot" is
684 modified when the user holds down a certain
685 combination of keys on the (special) keyboard when
686 booting the systems
687
688- Serial Download Echo Mode:
689 CONFIG_LOADS_ECHO
690 If defined to 1, all characters received during a
691 serial download (using the "loads" command) are
692 echoed back. This might be needed by some terminal
693 emulations (like "cu"), but may as well just take
694 time on others. This setting #define's the initial
695 value of the "loads_echo" environment variable.
696
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500697- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000698 CONFIG_KGDB_BAUDRATE
699 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200700 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000701
702- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500703 Monitor commands can be included or excluded
704 from the build by using the #include files
705 "config_cmd_all.h" and #undef'ing unwanted
706 commands, or using "config_cmd_default.h"
707 and augmenting with additional #define's
708 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000709
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500710 The default command configuration includes all commands
711 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000712
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500713 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500714 CONFIG_CMD_BDI bdinfo
715 CONFIG_CMD_BEDBUG * Include BedBug Debugger
716 CONFIG_CMD_BMP * BMP support
717 CONFIG_CMD_BSP * Board specific commands
718 CONFIG_CMD_BOOTD bootd
719 CONFIG_CMD_CACHE * icache, dcache
720 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500721 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500722 CONFIG_CMD_DATE * support for RTC, date/time...
723 CONFIG_CMD_DHCP * DHCP support
724 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600725 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
726 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
727 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
728 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500729 CONFIG_CMD_DTT * Digital Therm and Thermostat
730 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500731 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500732 CONFIG_CMD_EEPROM * EEPROM read/write support
733 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500734 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500735 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500736 CONFIG_CMD_FDC * Floppy Disk Support
737 CONFIG_CMD_FAT * FAT partition support
738 CONFIG_CMD_FDOS * Dos diskette Support
739 CONFIG_CMD_FLASH flinfo, erase, protect
740 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500741 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000742 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500743 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
744 CONFIG_CMD_I2C * I2C serial bus support
745 CONFIG_CMD_IDE * IDE harddisk support
746 CONFIG_CMD_IMI iminfo
747 CONFIG_CMD_IMLS List all found images
748 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500749 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500750 CONFIG_CMD_IRQ * irqinfo
751 CONFIG_CMD_ITEST Integer/string test of 2 values
752 CONFIG_CMD_JFFS2 * JFFS2 Support
753 CONFIG_CMD_KGDB * kgdb
Mike Frysingerfc6508a2010-12-26 12:34:49 -0500754 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500755 CONFIG_CMD_LOADB loadb
756 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400757 CONFIG_CMD_MD5SUM print md5 message digest
758 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500759 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
760 loop, loopw, mtest
761 CONFIG_CMD_MISC Misc functions like sleep etc
762 CONFIG_CMD_MMC * MMC memory mapped support
763 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100764 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500765 CONFIG_CMD_NAND * NAND support
766 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600767 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
768 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500769 CONFIG_CMD_PCI * pciinfo
770 CONFIG_CMD_PCMCIA * PCMCIA support
771 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
772 host
773 CONFIG_CMD_PORTIO * Port I/O
774 CONFIG_CMD_REGINFO * Register dump
775 CONFIG_CMD_RUN run command in env variable
776 CONFIG_CMD_SAVES * save S record dump
777 CONFIG_CMD_SCSI * SCSI Support
778 CONFIG_CMD_SDRAM * print SDRAM configuration information
779 (requires CONFIG_CMD_I2C)
780 CONFIG_CMD_SETGETDCR Support for DCR Register access
781 (4xx only)
Alexander Holler37ef5392011-01-18 09:48:08 +0100782 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400783 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200784 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500785 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000786 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Che-liang Chioufd763002011-10-06 23:40:48 +0000787 CONFIG_CMD_TIME * run command and report execution time
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500788 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500789 CONFIG_CMD_CDP * Cisco Discover Protocol support
790 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000791
wdenkc6097192002-11-03 00:24:07 +0000792
793 EXAMPLE: If you want all functions except of network
794 support you can write:
795
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500796 #include "config_cmd_all.h"
797 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000798
Gerald Van Barend6abef42007-03-31 12:23:51 -0400799 Other Commands:
800 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000801
802 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500803 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000804 what you (and your U-Boot users) are doing. Data
805 cache cannot be enabled on systems like the 8xx or
806 8260 (where accesses to the IMMR region must be
807 uncached), and it cannot be disabled on all other
808 systems where we (mis-) use the data cache to hold an
809 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000810
811
812 XXX - this list needs to get updated!
813
814- Watchdog:
815 CONFIG_WATCHDOG
816 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000817 support for the SoC. There must be support in the SoC
818 specific code for a watchdog. For the 8xx and 8260
819 CPUs, the SIU Watchdog feature is enabled in the SYPCR
820 register. When supported for a specific SoC is
821 available, then no further board specific code should
822 be needed to use it.
823
824 CONFIG_HW_WATCHDOG
825 When using a watchdog circuitry external to the used
826 SoC, then define this variable and provide board
827 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000828
stroeseb9c17c52003-04-04 15:53:41 +0000829- U-Boot Version:
830 CONFIG_VERSION_VARIABLE
831 If this variable is defined, an environment variable
832 named "ver" is created by U-Boot showing the U-Boot
833 version as printed by the "version" command.
834 This variable is readonly.
835
wdenkc6097192002-11-03 00:24:07 +0000836- Real-Time Clock:
837
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500838 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000839 has to be selected, too. Define exactly one of the
840 following options:
841
842 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
843 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetskid4387492008-04-15 14:15:30 +0200844 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000845 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000846 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000847 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000848 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000849 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100850 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000851 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200852 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200853 CONFIG_SYS_RV3029_TCR - enable trickle charger on
854 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000855
wdenkb9bbd242003-06-30 16:24:52 +0000856 Note that if the RTC uses I2C, then the I2C interface
857 must also be configured. See I2C Support, below.
858
Peter Tyser9902e422008-12-17 16:36:21 -0600859- GPIO Support:
860 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
861 CONFIG_PCA953X_INFO - enable pca953x info command
862
Chris Packham9b383202010-12-19 10:12:13 +0000863 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
864 chip-ngpio pairs that tell the PCA953X driver the number of
865 pins supported by a particular chip.
866
Peter Tyser9902e422008-12-17 16:36:21 -0600867 Note that if the GPIO device uses I2C, then the I2C interface
868 must also be configured. See I2C Support, below.
869
wdenkc6097192002-11-03 00:24:07 +0000870- Timestamp Support:
871
wdenk4a5c8a72003-03-06 00:02:04 +0000872 When CONFIG_TIMESTAMP is selected, the timestamp
873 (date and time) of an image is printed by image
874 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500875 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000876
877- Partition Support:
878 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubune6745592008-09-26 11:13:22 -0400879 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000880
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100881 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
882 CONFIG_CMD_SCSI) you must configure support for at
883 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000884
885- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000886 CONFIG_IDE_RESET_ROUTINE - this is defined in several
887 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000888
wdenk369d43d2004-03-14 14:09:05 +0000889 CONFIG_IDE_RESET - is this is defined, IDE Reset will
890 be performed by calling the function
891 ide_set_reset(int reset)
892 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000893
894- ATAPI Support:
895 CONFIG_ATAPI
896
897 Set this to enable ATAPI support.
898
wdenkf602aa02004-03-13 23:29:43 +0000899- LBA48 Support
900 CONFIG_LBA48
901
902 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100903 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000904 Whithout these , LBA48 support uses 32bit variables and will 'only'
905 support disks up to 2.1TB.
906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200907 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000908 When enabled, makes the IDE subsystem use 64bit sector addresses.
909 Default is 32bit.
910
wdenkc6097192002-11-03 00:24:07 +0000911- SCSI Support:
912 At the moment only there is only support for the
913 SYM53C8XX SCSI controller; define
914 CONFIG_SCSI_SYM53C8XX to enable it.
915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200916 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
917 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
918 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000919 maximum numbers of LUNs, SCSI ID's and target
920 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200921 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000922
923- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000924 CONFIG_E1000
925 Support for Intel 8254x gigabit chips.
stroese94ef1cf2003-06-05 15:39:44 +0000926
Andre Schwarz68c2a302008-03-06 16:45:44 +0100927 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200928 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +0100929
wdenkc6097192002-11-03 00:24:07 +0000930 CONFIG_EEPRO100
931 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200932 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000933 write routine for first time initialisation.
934
935 CONFIG_TULIP
936 Support for Digital 2114x chips.
937 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
938 modem chip initialisation (KS8761/QS6611).
939
940 CONFIG_NATSEMI
941 Support for National dp83815 chips.
942
943 CONFIG_NS8382X
944 Support for National dp8382[01] gigabit chips.
945
wdenkaa603362003-05-12 21:50:16 +0000946- NETWORK Support (other):
947
Jens Scharsigdab7cb82010-01-23 12:03:45 +0100948 CONFIG_DRIVER_AT91EMAC
949 Support for AT91RM9200 EMAC.
950
951 CONFIG_RMII
952 Define this to use reduced MII inteface
953
954 CONFIG_DRIVER_AT91EMAC_QUIET
955 If this defined, the driver is quiet.
956 The driver doen't show link status messages.
957
wdenkaa603362003-05-12 21:50:16 +0000958 CONFIG_DRIVER_LAN91C96
959 Support for SMSC's LAN91C96 chips.
960
961 CONFIG_LAN91C96_BASE
962 Define this to hold the physical address
963 of the LAN91C96's I/O space
964
965 CONFIG_LAN91C96_USE_32_BIT
966 Define this to enable 32 bit addressing
967
wdenk3c711762004-06-09 13:37:52 +0000968 CONFIG_DRIVER_SMC91111
969 Support for SMSC's LAN91C111 chip
970
971 CONFIG_SMC91111_BASE
972 Define this to hold the physical address
973 of the device (I/O space)
974
975 CONFIG_SMC_USE_32_BIT
976 Define this if data bus is 32 bits
977
978 CONFIG_SMC_USE_IOFUNCS
979 Define this to use i/o functions instead of macros
980 (some hardware wont work with macros)
981
Macpaul Lin199c6252010-12-21 16:59:46 +0800982 CONFIG_FTGMAC100
983 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
984
985 CONFIG_FTGMAC100_EGIGA
986 Define this to use GE link update with gigabit PHY.
987 Define this if FTGMAC100 is connected to gigabit PHY.
988 If your system has 10/100 PHY only, it might not occur
989 wrong behavior. Because PHY usually return timeout or
990 useless data when polling gigabit status and gigabit
991 control registers. This behavior won't affect the
992 correctnessof 10/100 link speed update.
993
Mike Rapoportf4761af2009-11-11 10:03:03 +0200994 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +0200995 Support for SMSC's LAN911x and LAN921x chips
996
Mike Rapoportf4761af2009-11-11 10:03:03 +0200997 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +0200998 Define this to hold the physical address
999 of the device (I/O space)
1000
Mike Rapoportf4761af2009-11-11 10:03:03 +02001001 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001002 Define this if data bus is 32 bits
1003
Mike Rapoportf4761af2009-11-11 10:03:03 +02001004 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001005 Define this if data bus is 16 bits. If your processor
1006 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001007 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001008
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001009 CONFIG_SH_ETHER
1010 Support for Renesas on-chip Ethernet controller
1011
1012 CONFIG_SH_ETHER_USE_PORT
1013 Define the number of ports to be used
1014
1015 CONFIG_SH_ETHER_PHY_ADDR
1016 Define the ETH PHY's address
1017
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001018 CONFIG_SH_ETHER_CACHE_WRITEBACK
1019 If this option is set, the driver enables cache flush.
1020
wdenkc6097192002-11-03 00:24:07 +00001021- USB Support:
1022 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001023 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001024 CONFIG_USB_UHCI to enable it.
1025 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001026 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001027 storage devices.
1028 Note:
1029 Supported are USB Keyboards and USB Floppy drives
1030 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001031 MPC5200 USB requires additional defines:
1032 CONFIG_USB_CLOCK
1033 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001034 CONFIG_PSC3_USB
1035 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001036 CONFIG_USB_CONFIG
1037 for differential drivers: 0x00001000
1038 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001039 for differential drivers on PSC3: 0x00000100
1040 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001041 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001042 May be defined to allow interrupt polling
1043 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001044
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001045- USB Device:
1046 Define the below if you wish to use the USB console.
1047 Once firmware is rebuilt from a serial console issue the
1048 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001049 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001050 it has found a new device. The environment variable usbtty
1051 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001052 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001053 Common Device Class Abstract Control Model serial device.
1054 If you select usbtty = gserial you should be able to enumerate
1055 a Linux host by
1056 # modprobe usbserial vendor=0xVendorID product=0xProductID
1057 else if using cdc_acm, simply setting the environment
1058 variable usbtty to be cdc_acm should suffice. The following
1059 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001060
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001061 CONFIG_USB_DEVICE
1062 Define this to build a UDC device
1063
1064 CONFIG_USB_TTY
1065 Define this to have a tty type of device available to
1066 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001067
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001068 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001069 Define this if you want stdin, stdout &/or stderr to
1070 be set to usbtty.
1071
1072 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001073 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001074 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001075 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001076
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001077 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001078 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001079 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001080
Wolfgang Denke2601822006-06-14 18:14:56 +02001081 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001082 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001083 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001084 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1085 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1086 should pretend to be a Linux device to it's target host.
1087
1088 CONFIG_USBD_MANUFACTURER
1089 Define this string as the name of your company for
1090 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001091
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001092 CONFIG_USBD_PRODUCT_NAME
1093 Define this string as the name of your product
1094 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001095
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001096 CONFIG_USBD_VENDORID
1097 Define this as your assigned Vendor ID from the USB
1098 Implementors Forum. This *must* be a genuine Vendor ID
1099 to avoid polluting the USB namespace.
1100 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001101
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001102 CONFIG_USBD_PRODUCTID
1103 Define this as the unique Product ID
1104 for your device
1105 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001106
wdenkc6097192002-11-03 00:24:07 +00001107
wdenk7a428cc2003-06-15 22:40:42 +00001108- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001109 The MMC controller on the Intel PXA is supported. To
1110 enable this define CONFIG_MMC. The MMC can be
1111 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001112 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001113 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1114 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001115
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001116 CONFIG_SH_MMCIF
1117 Support for Renesas on-chip MMCIF controller
1118
1119 CONFIG_SH_MMCIF_ADDR
1120 Define the base address of MMCIF registers
1121
1122 CONFIG_SH_MMCIF_CLK
1123 Define the clock frequency for MMCIF
1124
wdenkda04a8b2004-08-02 23:22:59 +00001125- Journaling Flash filesystem support:
1126 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1127 CONFIG_JFFS2_NAND_DEV
1128 Define these for a default partition on a NAND device
1129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001130 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1131 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001132 Define these for a default partition on a NOR device
1133
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001134 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001135 Define this to create an own partition. You have to provide a
1136 function struct part_info* jffs2_part_info(int part_num)
1137
1138 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001139 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001140 to disable the command chpart. This is the default when you
1141 have not defined a custom partition
1142
wdenkc6097192002-11-03 00:24:07 +00001143- Keyboard Support:
1144 CONFIG_ISA_KEYBOARD
1145
1146 Define this to enable standard (PC-Style) keyboard
1147 support
1148
1149 CONFIG_I8042_KBD
1150 Standard PC keyboard driver with US (is default) and
1151 GERMAN key layout (switch via environment 'keymap=de') support.
1152 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1153 for cfb_console. Supports cursor blinking.
1154
1155- Video support:
1156 CONFIG_VIDEO
1157
1158 Define this to enable video support (for output to
1159 video).
1160
1161 CONFIG_VIDEO_CT69000
1162
1163 Enable Chips & Technologies 69000 Video chip
1164
1165 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001166 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001167 video output is selected via environment 'videoout'
1168 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1169 assumed.
wdenkc6097192002-11-03 00:24:07 +00001170
wdenkd3602132004-03-25 15:14:43 +00001171 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001172 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001173 are possible:
1174 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001175 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001176
1177 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1178 -------------+---------------------------------------------
1179 8 bits | 0x301* 0x303 0x305 0x161 0x307
1180 15 bits | 0x310 0x313 0x316 0x162 0x319
1181 16 bits | 0x311 0x314 0x317 0x163 0x31A
1182 24 bits | 0x312 0x315 0x318 ? 0x31B
1183 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001184 (i.e. setenv videomode 317; saveenv; reset;)
1185
wdenkd3602132004-03-25 15:14:43 +00001186 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001187 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001188
1189
stroeseb9c17c52003-04-04 15:53:41 +00001190 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001191 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001192 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1193 or CONFIG_VIDEO_SED13806_16BPP
1194
Timur Tabi020edd22011-02-15 17:09:19 -06001195 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001196 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001197 SOCs that have a DIU should define this macro to enable DIU
1198 support, and should also define these other macros:
1199
1200 CONFIG_SYS_DIU_ADDR
1201 CONFIG_VIDEO
1202 CONFIG_CMD_BMP
1203 CONFIG_CFB_CONSOLE
1204 CONFIG_VIDEO_SW_CURSOR
1205 CONFIG_VGA_AS_SINGLE_DEVICE
1206 CONFIG_VIDEO_LOGO
1207 CONFIG_VIDEO_BMP_LOGO
1208
Timur Tabi32f709e2011-04-11 14:18:22 -05001209 The DIU driver will look for the 'video-mode' environment
1210 variable, and if defined, enable the DIU as a console during
1211 boot. See the documentation file README.video for a
1212 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001213
wdenk4e112c12003-06-03 23:54:09 +00001214- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001215 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001216
wdenk57b2d802003-06-27 21:31:46 +00001217 Define this to enable a custom keyboard support.
1218 This simply calls drv_keyboard_init() which must be
1219 defined in your board-specific files.
1220 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001221
wdenkc6097192002-11-03 00:24:07 +00001222- LCD Support: CONFIG_LCD
1223
1224 Define this to enable LCD support (for output to LCD
1225 display); also select one of the supported displays
1226 by defining one of these:
1227
Stelian Popf6f86652008-05-09 21:57:18 +02001228 CONFIG_ATMEL_LCD:
1229
1230 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1231
wdenkc0d54ae2003-11-25 16:55:19 +00001232 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001233
wdenkc0d54ae2003-11-25 16:55:19 +00001234 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001235
wdenkc0d54ae2003-11-25 16:55:19 +00001236 CONFIG_NEC_NL6448BC20
1237
1238 NEC NL6448BC20-08. 6.5", 640x480.
1239 Active, color, single scan.
1240
1241 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001242
wdenkc0d54ae2003-11-25 16:55:19 +00001243 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001244 Active, color, single scan.
1245
1246 CONFIG_SHARP_16x9
1247
1248 Sharp 320x240. Active, color, single scan.
1249 It isn't 16x9, and I am not sure what it is.
1250
1251 CONFIG_SHARP_LQ64D341
1252
1253 Sharp LQ64D341 display, 640x480.
1254 Active, color, single scan.
1255
1256 CONFIG_HLD1045
1257
1258 HLD1045 display, 640x480.
1259 Active, color, single scan.
1260
1261 CONFIG_OPTREX_BW
1262
1263 Optrex CBL50840-2 NF-FW 99 22 M5
1264 or
1265 Hitachi LMG6912RPFC-00T
1266 or
1267 Hitachi SP14Q002
1268
1269 320x240. Black & white.
1270
1271 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001272 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001273
wdenkeb20ad32003-09-05 23:19:14 +00001274- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001275
wdenk57b2d802003-06-27 21:31:46 +00001276 If this option is set, the environment is checked for
1277 a variable "splashimage". If found, the usual display
1278 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001279 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001280 specified in "splashimage" is loaded instead. The
1281 console is redirected to the "nulldev", too. This
1282 allows for a "silent" boot where a splash screen is
1283 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001284
Matthias Weisser53884182009-07-09 16:07:30 +02001285 CONFIG_SPLASH_SCREEN_ALIGN
1286
1287 If this option is set the splash image can be freely positioned
1288 on the screen. Environment variable "splashpos" specifies the
1289 position as "x,y". If a positive number is given it is used as
1290 number of pixel from left/top. If a negative number is given it
1291 is used as number of pixel from right/bottom. You can also
1292 specify 'm' for centering the image.
1293
1294 Example:
1295 setenv splashpos m,m
1296 => image at center of screen
1297
1298 setenv splashpos 30,20
1299 => image at x = 30 and y = 20
1300
1301 setenv splashpos -10,m
1302 => vertically centered image
1303 at x = dspWidth - bmpWidth - 9
1304
Stefan Roesed9d97742005-09-22 09:04:17 +02001305- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1306
1307 If this option is set, additionally to standard BMP
1308 images, gzipped BMP images can be displayed via the
1309 splashscreen support or the bmp command.
1310
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001311- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1312
1313 If this option is set, 8-bit RLE compressed BMP images
1314 can be displayed via the splashscreen support or the
1315 bmp command.
1316
wdenk710e3502003-08-29 20:57:53 +00001317- Compression support:
1318 CONFIG_BZIP2
1319
1320 If this option is set, support for bzip2 compressed
1321 images is included. If not, only uncompressed and gzip
1322 compressed images are supported.
1323
wdenk9c53f402003-10-15 23:53:47 +00001324 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001325 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001326 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001327
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001328 CONFIG_LZMA
1329
1330 If this option is set, support for lzma compressed
1331 images is included.
1332
1333 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1334 requires an amount of dynamic memory that is given by the
1335 formula:
1336
1337 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1338
1339 Where lc and lp stand for, respectively, Literal context bits
1340 and Literal pos bits.
1341
1342 This value is upper-bounded by 14MB in the worst case. Anyway,
1343 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1344 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1345 a very small buffer.
1346
1347 Use the lzmainfo tool to determinate the lc and lp values and
1348 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001349 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001350
wdenk0e2bd9c2004-06-06 21:51:03 +00001351- MII/PHY support:
1352 CONFIG_PHY_ADDR
1353
1354 The address of PHY on MII bus.
1355
1356 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1357
1358 The clock frequency of the MII bus
1359
1360 CONFIG_PHY_GIGE
1361
1362 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001363 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001364
1365 CONFIG_PHY_RESET_DELAY
1366
1367 Some PHY like Intel LXT971A need extra delay after
1368 reset before any MII register access is possible.
1369 For such PHY, set this option to the usec delay
1370 required. (minimum 300usec for LXT971A)
1371
1372 CONFIG_PHY_CMD_DELAY (ppc4xx)
1373
1374 Some PHY like Intel LXT971A need extra delay after
1375 command issued before MII status register can be read
1376
wdenkc6097192002-11-03 00:24:07 +00001377- Ethernet address:
1378 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001379 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001380 CONFIG_ETH2ADDR
1381 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001382 CONFIG_ETH4ADDR
1383 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001384
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001385 Define a default value for Ethernet address to use
1386 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001387 is not determined automatically.
1388
1389- IP address:
1390 CONFIG_IPADDR
1391
1392 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001393 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001394 determined through e.g. bootp.
1395
1396- Server IP address:
1397 CONFIG_SERVERIP
1398
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001399 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001400 server to contact when using the "tftboot" command.
1401
Robin Getz470a6d42009-07-21 12:15:28 -04001402 CONFIG_KEEP_SERVERADDR
1403
1404 Keeps the server's MAC address, in the env 'serveraddr'
1405 for passing to bootargs (like Linux's netconsole option)
1406
David Updegraff7280da72007-06-11 10:41:07 -05001407- Multicast TFTP Mode:
1408 CONFIG_MCAST_TFTP
1409
1410 Defines whether you want to support multicast TFTP as per
1411 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001412 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001413 driver in use must provide a function: mcast() to join/leave a
1414 multicast group.
1415
wdenkc6097192002-11-03 00:24:07 +00001416- BOOTP Recovery Mode:
1417 CONFIG_BOOTP_RANDOM_DELAY
1418
1419 If you have many targets in a network that try to
1420 boot using BOOTP, you may want to avoid that all
1421 systems send out BOOTP requests at precisely the same
1422 moment (which would happen for instance at recovery
1423 from a power failure, when all systems will try to
1424 boot, thus flooding the BOOTP server. Defining
1425 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1426 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001427 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001428
1429 1st BOOTP request: delay 0 ... 1 sec
1430 2nd BOOTP request: delay 0 ... 2 sec
1431 3rd BOOTP request: delay 0 ... 4 sec
1432 4th and following
1433 BOOTP requests: delay 0 ... 8 sec
1434
stroesee0aadfb2003-08-28 14:17:32 +00001435- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001436 You can fine tune the DHCP functionality by defining
1437 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001438
Jon Loeliger5336a762007-07-09 22:08:34 -05001439 CONFIG_BOOTP_SUBNETMASK
1440 CONFIG_BOOTP_GATEWAY
1441 CONFIG_BOOTP_HOSTNAME
1442 CONFIG_BOOTP_NISDOMAIN
1443 CONFIG_BOOTP_BOOTPATH
1444 CONFIG_BOOTP_BOOTFILESIZE
1445 CONFIG_BOOTP_DNS
1446 CONFIG_BOOTP_DNS2
1447 CONFIG_BOOTP_SEND_HOSTNAME
1448 CONFIG_BOOTP_NTPSERVER
1449 CONFIG_BOOTP_TIMEOFFSET
1450 CONFIG_BOOTP_VENDOREX
stroesee0aadfb2003-08-28 14:17:32 +00001451
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001452 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1453 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001454
1455 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1456 serverip from a DHCP server, it is possible that more
1457 than one DNS serverip is offered to the client.
1458 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1459 serverip will be stored in the additional environment
1460 variable "dnsip2". The first DNS serverip is always
1461 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001462 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001463
1464 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1465 to do a dynamic update of a DNS server. To do this, they
1466 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001467 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001468 of the "hostname" environment variable is passed as
1469 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001470
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001471 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1472
1473 A 32bit value in microseconds for a delay between
1474 receiving a "DHCP Offer" and sending the "DHCP Request".
1475 This fixes a problem with certain DHCP servers that don't
1476 respond 100% of the time to a "DHCP request". E.g. On an
1477 AT91RM9200 processor running at 180MHz, this delay needed
1478 to be *at least* 15,000 usec before a Windows Server 2003
1479 DHCP server would reply 100% of the time. I recommend at
1480 least 50,000 usec to be safe. The alternative is to hope
1481 that one of the retries will be successful but note that
1482 the DHCP timeout and retry process takes a longer than
1483 this delay.
1484
wdenk145d2c12004-04-15 21:48:45 +00001485 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001486 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001487
1488 The device id used in CDP trigger frames.
1489
1490 CONFIG_CDP_DEVICE_ID_PREFIX
1491
1492 A two character string which is prefixed to the MAC address
1493 of the device.
1494
1495 CONFIG_CDP_PORT_ID
1496
1497 A printf format string which contains the ascii name of
1498 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001499 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001500
1501 CONFIG_CDP_CAPABILITIES
1502
1503 A 32bit integer which indicates the device capabilities;
1504 0x00000010 for a normal host which does not forwards.
1505
1506 CONFIG_CDP_VERSION
1507
1508 An ascii string containing the version of the software.
1509
1510 CONFIG_CDP_PLATFORM
1511
1512 An ascii string containing the name of the platform.
1513
1514 CONFIG_CDP_TRIGGER
1515
1516 A 32bit integer sent on the trigger.
1517
1518 CONFIG_CDP_POWER_CONSUMPTION
1519
1520 A 16bit integer containing the power consumption of the
1521 device in .1 of milliwatts.
1522
1523 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1524
1525 A byte containing the id of the VLAN.
1526
wdenkc6097192002-11-03 00:24:07 +00001527- Status LED: CONFIG_STATUS_LED
1528
1529 Several configurations allow to display the current
1530 status using a LED. For instance, the LED will blink
1531 fast while running U-Boot code, stop blinking as
1532 soon as a reply to a BOOTP request was received, and
1533 start blinking slow once the Linux kernel is running
1534 (supported by a status LED driver in the Linux
1535 kernel). Defining CONFIG_STATUS_LED enables this
1536 feature in U-Boot.
1537
1538- CAN Support: CONFIG_CAN_DRIVER
1539
1540 Defining CONFIG_CAN_DRIVER enables CAN driver support
1541 on those systems that support this (optional)
1542 feature, like the TQM8xxL modules.
1543
1544- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1545
wdenkb9bbd242003-06-30 16:24:52 +00001546 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001547 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001548 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001549
wdenk21136db2003-07-16 21:53:01 +00001550 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001551 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001552 CONFIG_COMMANDS) and communicate with i2c based realtime
1553 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001554 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001555
Ben Warren45657152006-09-07 16:50:54 -04001556 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001557
wdenk21136db2003-07-16 21:53:01 +00001558 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001559 bit-banging) driver instead of CPM or similar hardware
1560 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001561
wdenk21136db2003-07-16 21:53:01 +00001562 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001563 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001565 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001566 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001567 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001568 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001569
Peter Tysere4d1abc2010-04-12 22:28:21 -05001570 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001571 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001572 and so its address should therefore be cleared to 0 (See,
1573 eg, MPC823e User's Manual p.16-473). So, set
1574 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001575
Eric Millbrandt12990a42009-09-03 08:09:44 -05001576 CONFIG_SYS_I2C_INIT_MPC5XXX
1577
1578 When a board is reset during an i2c bus transfer
1579 chips might think that the current transfer is still
1580 in progress. Reset the slave devices by sending start
1581 commands until the slave device responds.
1582
wdenk21136db2003-07-16 21:53:01 +00001583 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001584
wdenkb9bbd242003-06-30 16:24:52 +00001585 If you use the software i2c interface (CONFIG_SOFT_I2C)
1586 then the following macros need to be defined (examples are
1587 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001588
1589 I2C_INIT
1590
wdenkb9bbd242003-06-30 16:24:52 +00001591 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001592 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001593
wdenk544e9732004-02-06 23:19:44 +00001594 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001595
wdenkc6097192002-11-03 00:24:07 +00001596 I2C_PORT
1597
wdenk4a5c8a72003-03-06 00:02:04 +00001598 (Only for MPC8260 CPU). The I/O port to use (the code
1599 assumes both bits are on the same port). Valid values
1600 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001601
1602 I2C_ACTIVE
1603
1604 The code necessary to make the I2C data line active
1605 (driven). If the data line is open collector, this
1606 define can be null.
1607
wdenkb9bbd242003-06-30 16:24:52 +00001608 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1609
wdenkc6097192002-11-03 00:24:07 +00001610 I2C_TRISTATE
1611
1612 The code necessary to make the I2C data line tri-stated
1613 (inactive). If the data line is open collector, this
1614 define can be null.
1615
wdenkb9bbd242003-06-30 16:24:52 +00001616 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1617
wdenkc6097192002-11-03 00:24:07 +00001618 I2C_READ
1619
1620 Code that returns TRUE if the I2C data line is high,
1621 FALSE if it is low.
1622
wdenkb9bbd242003-06-30 16:24:52 +00001623 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1624
wdenkc6097192002-11-03 00:24:07 +00001625 I2C_SDA(bit)
1626
1627 If <bit> is TRUE, sets the I2C data line high. If it
1628 is FALSE, it clears it (low).
1629
wdenkb9bbd242003-06-30 16:24:52 +00001630 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001631 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001632 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001633
wdenkc6097192002-11-03 00:24:07 +00001634 I2C_SCL(bit)
1635
1636 If <bit> is TRUE, sets the I2C clock line high. If it
1637 is FALSE, it clears it (low).
1638
wdenkb9bbd242003-06-30 16:24:52 +00001639 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001640 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001641 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001642
wdenkc6097192002-11-03 00:24:07 +00001643 I2C_DELAY
1644
1645 This delay is invoked four times per clock cycle so this
1646 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001647 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001648 like:
1649
wdenkb9bbd242003-06-30 16:24:52 +00001650 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001651
Mike Frysingeree12d542010-07-21 13:38:02 -04001652 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1653
1654 If your arch supports the generic GPIO framework (asm/gpio.h),
1655 then you may alternatively define the two GPIOs that are to be
1656 used as SCL / SDA. Any of the previous I2C_xxx macros will
1657 have GPIO-based defaults assigned to them as appropriate.
1658
1659 You should define these to the GPIO value as given directly to
1660 the generic GPIO functions.
1661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001662 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001663
wdenk57b2d802003-06-27 21:31:46 +00001664 When a board is reset during an i2c bus transfer
1665 chips might think that the current transfer is still
1666 in progress. On some boards it is possible to access
1667 the i2c SCLK line directly, either by using the
1668 processor pin as a GPIO or by having a second pin
1669 connected to the bus. If this option is defined a
1670 custom i2c_init_board() routine in boards/xxx/board.c
1671 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001672
Richard Retanubundf0149c2010-04-12 15:08:17 -04001673 CONFIG_SYS_I2C_BOARD_LATE_INIT
1674
1675 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1676 defined a custom i2c_board_late_init() routine in
1677 boards/xxx/board.c is run AFTER the operations in i2c_init()
1678 is completed. This callpoint can be used to unreset i2c bus
1679 using CPU i2c controller register accesses for CPUs whose i2c
1680 controller provide such a method. It is called at the end of
1681 i2c_init() to allow i2c_init operations to setup the i2c bus
1682 controller on the CPU (e.g. setting bus speed & slave address).
1683
wdenk0e2bd9c2004-06-06 21:51:03 +00001684 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1685
1686 This option enables configuration of bi_iic_fast[] flags
1687 in u-boot bd_info structure based on u-boot environment
1688 variable "i2cfast". (see also i2cfast)
1689
Ben Warren45657152006-09-07 16:50:54 -04001690 CONFIG_I2C_MULTI_BUS
1691
1692 This option allows the use of multiple I2C buses, each of which
1693 must have a controller. At any point in time, only one bus is
1694 active. To switch to a different bus, use the 'i2c dev' command.
1695 Note that bus numbering is zero-based.
1696
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001697 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001698
1699 This option specifies a list of I2C devices that will be skipped
Peter Tyser469cde42009-04-18 22:34:03 -05001700 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1701 is set, specify a list of bus-device pairs. Otherwise, specify
1702 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001703
1704 e.g.
1705 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001706 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001707
1708 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1709
1710 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001711 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001712
1713 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1714
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001715 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001716
1717 If defined, then this indicates the I2C bus number for DDR SPD.
1718 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1719
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001720 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001721
1722 If defined, then this indicates the I2C bus number for the RTC.
1723 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1724
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001725 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001726
1727 If defined, then this indicates the I2C bus number for the DTT.
1728 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1729
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001730 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001731
1732 If defined, specifies the I2C address of the DTT device.
1733 If not defined, then U-Boot uses predefined value for
1734 specified DTT device.
1735
Timur Tabiab347542006-11-03 19:15:00 -06001736 CONFIG_FSL_I2C
1737
1738 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01001739 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06001740
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001741 CONFIG_I2C_MUX
1742
1743 Define this option if you have I2C devices reached over 1 .. n
1744 I2C Muxes like the pca9544a. This option addes a new I2C
1745 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1746 new I2C Bus to the existing I2C Busses. If you select the
1747 new Bus with "i2c dev", u-bbot sends first the commandos for
1748 the muxes to activate this new "bus".
1749
1750 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1751 feature!
1752
1753 Example:
1754 Adding a new I2C Bus reached over 2 pca9544a muxes
1755 The First mux with address 70 and channel 6
1756 The Second mux with address 71 and channel 4
1757
1758 => i2c bus pca9544a:70:6:pca9544a:71:4
1759
1760 Use the "i2c bus" command without parameter, to get a list
1761 of I2C Busses with muxes:
1762
1763 => i2c bus
1764 Busses reached over muxes:
1765 Bus ID: 2
1766 reached over Mux(es):
1767 pca9544a@70 ch: 4
1768 Bus ID: 3
1769 reached over Mux(es):
1770 pca9544a@70 ch: 6
1771 pca9544a@71 ch: 4
1772 =>
1773
1774 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00001775 u-boot first sends the command to the mux@70 to enable
1776 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001777 the channel 4.
1778
1779 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00001780 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001781 the 2 muxes.
1782
1783 This option is actually implemented for the bitbanging
1784 algorithm in common/soft_i2c.c and for the Hardware I2C
1785 Bus on the MPC8260. But it should be not so difficult
1786 to add this option to other architectures.
1787
Andrew Dyer58c41f92008-12-29 17:36:01 -06001788 CONFIG_SOFT_I2C_READ_REPEATED_START
1789
1790 defining this will force the i2c_read() function in
1791 the soft_i2c driver to perform an I2C repeated start
1792 between writing the address pointer and reading the
1793 data. If this define is omitted the default behaviour
1794 of doing a stop-start sequence will be used. Most I2C
1795 devices can use either method, but some require one or
1796 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001797
wdenkc6097192002-11-03 00:24:07 +00001798- SPI Support: CONFIG_SPI
1799
1800 Enables SPI driver (so far only tested with
1801 SPI EEPROM, also an instance works with Crystal A/D and
1802 D/As on the SACSng board)
1803
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09001804 CONFIG_SH_SPI
1805
1806 Enables the driver for SPI controller on SuperH. Currently
1807 only SH7757 is supported.
1808
wdenkc6097192002-11-03 00:24:07 +00001809 CONFIG_SPI_X
1810
1811 Enables extended (16-bit) SPI EEPROM addressing.
1812 (symmetrical to CONFIG_I2C_X)
1813
1814 CONFIG_SOFT_SPI
1815
wdenk4a5c8a72003-03-06 00:02:04 +00001816 Enables a software (bit-bang) SPI driver rather than
1817 using hardware support. This is a general purpose
1818 driver that only requires three general I/O port pins
1819 (two outputs, one input) to function. If this is
1820 defined, the board configuration must define several
1821 SPI configuration items (port pins to use, etc). For
1822 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001823
Ben Warren7efe9272008-01-16 22:37:35 -05001824 CONFIG_HARD_SPI
1825
1826 Enables a hardware SPI driver for general-purpose reads
1827 and writes. As with CONFIG_SOFT_SPI, the board configuration
1828 must define a list of chip-select function pointers.
1829 Currently supported on some MPC8xxx processors. For an
1830 example, see include/configs/mpc8349emds.h.
1831
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001832 CONFIG_MXC_SPI
1833
1834 Enables the driver for the SPI controllers on i.MX and MXC
1835 SoCs. Currently only i.MX31 is supported.
1836
Matthias Fuchsa4400872007-12-27 17:12:34 +01001837- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001838
Matthias Fuchsa4400872007-12-27 17:12:34 +01001839 Enables FPGA subsystem.
1840
1841 CONFIG_FPGA_<vendor>
1842
1843 Enables support for specific chip vendors.
1844 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001845
Matthias Fuchsa4400872007-12-27 17:12:34 +01001846 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001847
Matthias Fuchsa4400872007-12-27 17:12:34 +01001848 Enables support for FPGA family.
1849 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1850
1851 CONFIG_FPGA_COUNT
1852
1853 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001854
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001855 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001856
wdenk57b2d802003-06-27 21:31:46 +00001857 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001859 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001860
wdenk4a5c8a72003-03-06 00:02:04 +00001861 Enable checks on FPGA configuration interface busy
1862 status by the configuration function. This option
1863 will require a board or device specific function to
1864 be written.
wdenkc6097192002-11-03 00:24:07 +00001865
1866 CONFIG_FPGA_DELAY
1867
1868 If defined, a function that provides delays in the FPGA
1869 configuration driver.
1870
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001871 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001872 Allow Control-C to interrupt FPGA configuration
1873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001874 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001875
wdenk4a5c8a72003-03-06 00:02:04 +00001876 Check for configuration errors during FPGA bitfile
1877 loading. For example, abort during Virtex II
1878 configuration if the INIT_B line goes low (which
1879 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001880
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001881 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001882
wdenk4a5c8a72003-03-06 00:02:04 +00001883 Maximum time to wait for the INIT_B line to deassert
1884 after PROB_B has been deasserted during a Virtex II
1885 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001886 ms.
wdenkc6097192002-11-03 00:24:07 +00001887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001888 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001889
wdenk4a5c8a72003-03-06 00:02:04 +00001890 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001891 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001892
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001893 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001894
wdenk4a5c8a72003-03-06 00:02:04 +00001895 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001896 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001897
1898- Configuration Management:
1899 CONFIG_IDENT_STRING
1900
wdenk4a5c8a72003-03-06 00:02:04 +00001901 If defined, this string will be added to the U-Boot
1902 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001903
1904- Vendor Parameter Protection:
1905
wdenk4a5c8a72003-03-06 00:02:04 +00001906 U-Boot considers the values of the environment
1907 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001908 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001909 are set once by the board vendor / manufacturer, and
1910 protects these variables from casual modification by
1911 the user. Once set, these variables are read-only,
1912 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001913 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001914
1915 If CONFIG_ENV_OVERWRITE is #defined in your config
1916 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001917 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001918 these parameters.
1919
1920 Alternatively, if you #define _both_ CONFIG_ETHADDR
1921 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001922 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001923 which can be changed exactly ONCE by the user. [The
1924 serial# is unaffected by this, i. e. it remains
1925 read-only.]
1926
1927- Protected RAM:
1928 CONFIG_PRAM
1929
1930 Define this variable to enable the reservation of
1931 "protected RAM", i. e. RAM which is not overwritten
1932 by U-Boot. Define CONFIG_PRAM to hold the number of
1933 kB you want to reserve for pRAM. You can overwrite
1934 this default value by defining an environment
1935 variable "pram" to the number of kB you want to
1936 reserve. Note that the board info structure will
1937 still show the full amount of RAM. If pRAM is
1938 reserved, a new environment variable "mem" will
1939 automatically be defined to hold the amount of
1940 remaining RAM in a form that can be passed as boot
1941 argument to Linux, for instance like that:
1942
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001943 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001944 saveenv
1945
1946 This way you can tell Linux not to use this memory,
1947 either, which results in a memory region that will
1948 not be affected by reboots.
1949
1950 *WARNING* If your board configuration uses automatic
1951 detection of the RAM size, you must make sure that
1952 this memory test is non-destructive. So far, the
1953 following board configurations are known to be
1954 "pRAM-clean":
1955
1956 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1957 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02001958 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001959
1960- Error Recovery:
1961 CONFIG_PANIC_HANG
1962
1963 Define this variable to stop the system in case of a
1964 fatal error, so that you have to reset it manually.
1965 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001966 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001967 automatically as fast as possible, but it may be
1968 useful during development since you can try to debug
1969 the conditions that lead to the situation.
1970
1971 CONFIG_NET_RETRY_COUNT
1972
wdenk4a5c8a72003-03-06 00:02:04 +00001973 This variable defines the number of retries for
1974 network operations like ARP, RARP, TFTP, or BOOTP
1975 before giving up the operation. If not defined, a
1976 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001977
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001978 CONFIG_ARP_TIMEOUT
1979
1980 Timeout waiting for an ARP reply in milliseconds.
1981
wdenkc6097192002-11-03 00:24:07 +00001982- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001983 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00001984
1985 Enable auto completion of commands using TAB.
1986
Wolfgang Denk018147d2006-11-27 15:32:42 +01001987 Note that this feature has NOT been implemented yet
1988 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001989
1990
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001991 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001992
1993 Define this variable to enable the "hush" shell (from
1994 Busybox) as command line interpreter, thus enabling
1995 powerful command line syntax like
1996 if...then...else...fi conditionals or `&&' and '||'
1997 constructs ("shell scripts").
1998
1999 If undefined, you get the old, much simpler behaviour
2000 with a somewhat smaller memory footprint.
2001
2002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002003 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002004
2005 This defines the secondary prompt string, which is
2006 printed when the command interpreter needs more input
2007 to complete a command. Usually "> ".
2008
2009 Note:
2010
wdenk57b2d802003-06-27 21:31:46 +00002011 In the current implementation, the local variables
2012 space and global environment variables space are
2013 separated. Local variables are those you define by
2014 simply typing `name=value'. To access a local
2015 variable later on, you have write `$name' or
2016 `${name}'; to execute the contents of a variable
2017 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002018
wdenk4a5c8a72003-03-06 00:02:04 +00002019 Global environment variables are those you use
2020 setenv/printenv to work with. To run a command stored
2021 in such a variable, you need to use the run command,
2022 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002023
2024 To store commands and special characters in a
2025 variable, please use double quotation marks
2026 surrounding the whole text of the variable, instead
2027 of the backslashes before semicolons and special
2028 symbols.
2029
Wolfgang Denk2039a072006-07-21 11:35:21 +02002030- Commandline Editing and History:
2031 CONFIG_CMDLINE_EDITING
2032
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002033 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002034 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002035
wdenkc0aa5c52003-12-06 19:49:23 +00002036- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002037 CONFIG_EXTRA_ENV_SETTINGS
2038
wdenk4a5c8a72003-03-06 00:02:04 +00002039 Define this to contain any number of null terminated
2040 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002041 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002042
wdenk4a5c8a72003-03-06 00:02:04 +00002043 For example, place something like this in your
2044 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002045
2046 #define CONFIG_EXTRA_ENV_SETTINGS \
2047 "myvar1=value1\0" \
2048 "myvar2=value2\0"
2049
wdenk4a5c8a72003-03-06 00:02:04 +00002050 Warning: This method is based on knowledge about the
2051 internal format how the environment is stored by the
2052 U-Boot code. This is NOT an official, exported
2053 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002054 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002055 You better know what you are doing here.
2056
wdenk4a5c8a72003-03-06 00:02:04 +00002057 Note: overly (ab)use of the default environment is
2058 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002059 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002060 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002061
wdenkc0aa5c52003-12-06 19:49:23 +00002062- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002063 CONFIG_HAS_DATAFLASH
2064
wdenk57b2d802003-06-27 21:31:46 +00002065 Defining this option enables DataFlash features and
2066 allows to read/write in Dataflash via the standard
2067 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002068
wdenkef893942004-02-23 16:11:30 +00002069- SystemACE Support:
2070 CONFIG_SYSTEMACE
2071
2072 Adding this option adds support for Xilinx SystemACE
2073 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002074 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002075 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002076
2077 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002078 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002079
2080 When SystemACE support is added, the "ace" device type
2081 becomes available to the fat commands, i.e. fatls.
2082
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002083- TFTP Fixed UDP Port:
2084 CONFIG_TFTP_PORT
2085
Wolfgang Denk227b5192005-09-24 23:25:46 +02002086 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002087 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002088 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002089 number generator is used.
2090
Wolfgang Denk227b5192005-09-24 23:25:46 +02002091 Also, the environment variable tftpdstp is used to supply
2092 the TFTP UDP destination port value. If tftpdstp isn't
2093 defined, the normal port 69 is used.
2094
2095 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002096 blindly start the TFTP transfer using the pre-configured
2097 target IP address and UDP port. This has the effect of
2098 "punching through" the (Windows XP) firewall, allowing
2099 the remainder of the TFTP transfer to proceed normally.
2100 A better solution is to properly configure the firewall,
2101 but sometimes that is not allowed.
2102
wdenkc0aa5c52003-12-06 19:49:23 +00002103- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002104 CONFIG_SHOW_BOOT_PROGRESS
2105
wdenk4a5c8a72003-03-06 00:02:04 +00002106 Defining this option allows to add some board-
2107 specific code (calling a user-provided function
2108 "show_boot_progress(int)") that enables you to show
2109 the system's boot progress on some display (for
2110 example, some LED's) on your board. At the moment,
2111 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002112
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002113Legacy uImage format:
2114
wdenkc6097192002-11-03 00:24:07 +00002115 Arg Where When
2116 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002117 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002118 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002119 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002120 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002121 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002122 4 common/cmd_bootm.c Image data has correct checksum
2123 -4 common/cmd_bootm.c Image is for unsupported architecture
2124 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002125 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002126 6 common/cmd_bootm.c Image Type check OK
2127 -6 common/cmd_bootm.c gunzip uncompression error
2128 -7 common/cmd_bootm.c Unimplemented compression type
2129 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002130 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002131 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002132
2133 9 common/image.c Start initial ramdisk verification
2134 -10 common/image.c Ramdisk header has bad magic number
2135 -11 common/image.c Ramdisk header has bad checksum
2136 10 common/image.c Ramdisk header is OK
2137 -12 common/image.c Ramdisk data has bad checksum
2138 11 common/image.c Ramdisk data has correct checksum
2139 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002140 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002141 13 common/image.c Start multifile image verification
2142 14 common/image.c No initial ramdisk, no multifile, continue.
2143
Peter Tysercede5d82010-04-12 22:28:04 -05002144 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002145
Stefan Roese88fbf932010-04-15 16:07:28 +02002146 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002147 -31 post/post.c POST test failed, detected by post_output_backlog()
2148 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002149
Heiko Schocher633e03a2007-06-22 19:11:54 +02002150 34 common/cmd_doc.c before loading a Image from a DOC device
2151 -35 common/cmd_doc.c Bad usage of "doc" command
2152 35 common/cmd_doc.c correct usage of "doc" command
2153 -36 common/cmd_doc.c No boot device
2154 36 common/cmd_doc.c correct boot device
2155 -37 common/cmd_doc.c Unknown Chip ID on boot device
2156 37 common/cmd_doc.c correct chip ID found, device available
2157 -38 common/cmd_doc.c Read Error on boot device
2158 38 common/cmd_doc.c reading Image header from DOC device OK
2159 -39 common/cmd_doc.c Image header has bad magic number
2160 39 common/cmd_doc.c Image header has correct magic number
2161 -40 common/cmd_doc.c Error reading Image from DOC device
2162 40 common/cmd_doc.c Image header has correct magic number
2163 41 common/cmd_ide.c before loading a Image from a IDE device
2164 -42 common/cmd_ide.c Bad usage of "ide" command
2165 42 common/cmd_ide.c correct usage of "ide" command
2166 -43 common/cmd_ide.c No boot device
2167 43 common/cmd_ide.c boot device found
2168 -44 common/cmd_ide.c Device not available
2169 44 common/cmd_ide.c Device available
2170 -45 common/cmd_ide.c wrong partition selected
2171 45 common/cmd_ide.c partition selected
2172 -46 common/cmd_ide.c Unknown partition table
2173 46 common/cmd_ide.c valid partition table found
2174 -47 common/cmd_ide.c Invalid partition type
2175 47 common/cmd_ide.c correct partition type
2176 -48 common/cmd_ide.c Error reading Image Header on boot device
2177 48 common/cmd_ide.c reading Image Header from IDE device OK
2178 -49 common/cmd_ide.c Image header has bad magic number
2179 49 common/cmd_ide.c Image header has correct magic number
2180 -50 common/cmd_ide.c Image header has bad checksum
2181 50 common/cmd_ide.c Image header has correct checksum
2182 -51 common/cmd_ide.c Error reading Image from IDE device
2183 51 common/cmd_ide.c reading Image from IDE device OK
2184 52 common/cmd_nand.c before loading a Image from a NAND device
2185 -53 common/cmd_nand.c Bad usage of "nand" command
2186 53 common/cmd_nand.c correct usage of "nand" command
2187 -54 common/cmd_nand.c No boot device
2188 54 common/cmd_nand.c boot device found
2189 -55 common/cmd_nand.c Unknown Chip ID on boot device
2190 55 common/cmd_nand.c correct chip ID found, device available
2191 -56 common/cmd_nand.c Error reading Image Header on boot device
2192 56 common/cmd_nand.c reading Image Header from NAND device OK
2193 -57 common/cmd_nand.c Image header has bad magic number
2194 57 common/cmd_nand.c Image header has correct magic number
2195 -58 common/cmd_nand.c Error reading Image from NAND device
2196 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002197
Heiko Schocher633e03a2007-06-22 19:11:54 +02002198 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002199
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002200 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002201 -64 net/eth.c no Ethernet found.
2202 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002203
Heiko Schocher633e03a2007-06-22 19:11:54 +02002204 -80 common/cmd_net.c usage wrong
2205 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002206 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002207 81 common/cmd_net.c NetLoop() back without error
2208 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2209 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002210 83 common/cmd_net.c running "source" command
2211 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002212 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002213
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002214FIT uImage format:
2215
2216 Arg Where When
2217 100 common/cmd_bootm.c Kernel FIT Image has correct format
2218 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2219 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2220 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2221 102 common/cmd_bootm.c Kernel unit name specified
2222 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002223 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002224 104 common/cmd_bootm.c Got kernel subimage node offset
2225 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2226 105 common/cmd_bootm.c Kernel subimage hash verification OK
2227 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2228 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002229 -106 common/cmd_bootm.c Kernel subimage has wrong type
2230 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002231 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2232 108 common/cmd_bootm.c Got kernel subimage data/size
2233 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2234 -109 common/cmd_bootm.c Can't get kernel subimage type
2235 -110 common/cmd_bootm.c Can't get kernel subimage comp
2236 -111 common/cmd_bootm.c Can't get kernel subimage os
2237 -112 common/cmd_bootm.c Can't get kernel subimage load address
2238 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2239
2240 120 common/image.c Start initial ramdisk verification
2241 -120 common/image.c Ramdisk FIT image has incorrect format
2242 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002243 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002244 -122 common/image.c Can't get configuration for ramdisk subimage
2245 123 common/image.c Ramdisk unit name specified
2246 -124 common/image.c Can't get ramdisk subimage node offset
2247 125 common/image.c Got ramdisk subimage node offset
2248 -125 common/image.c Ramdisk subimage hash verification failed
2249 126 common/image.c Ramdisk subimage hash verification OK
2250 -126 common/image.c Ramdisk subimage for unsupported architecture
2251 127 common/image.c Architecture check OK
2252 -127 common/image.c Can't get ramdisk subimage data/size
2253 128 common/image.c Got ramdisk subimage data/size
2254 129 common/image.c Can't get ramdisk load address
2255 -129 common/image.c Got ramdisk load address
2256
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002257 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002258 131 common/cmd_doc.c FIT image format OK
2259
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002260 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002261 141 common/cmd_ide.c FIT image format OK
2262
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002263 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002264 151 common/cmd_nand.c FIT image format OK
2265
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002266- Standalone program support:
2267 CONFIG_STANDALONE_LOAD_ADDR
2268
Wolfgang Denk23f78482011-10-09 21:06:34 +02002269 This option defines a board specific value for the
2270 address where standalone program gets loaded, thus
2271 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002272 settings.
2273
2274- Frame Buffer Address:
2275 CONFIG_FB_ADDR
2276
2277 Define CONFIG_FB_ADDR if you want to use specific
2278 address for frame buffer.
2279 Then system will reserve the frame buffer address to
2280 defined address instead of lcd_setmem (this function
Wolfgang Denk23f78482011-10-09 21:06:34 +02002281 grabs the memory for frame buffer by panel's size).
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002282
2283 Please see board_init_f function.
2284
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002285- Automatic software updates via TFTP server
2286 CONFIG_UPDATE_TFTP
2287 CONFIG_UPDATE_TFTP_CNT_MAX
2288 CONFIG_UPDATE_TFTP_MSEC_MAX
2289
2290 These options enable and control the auto-update feature;
2291 for a more detailed description refer to doc/README.update.
2292
2293- MTD Support (mtdparts command, UBI support)
2294 CONFIG_MTD_DEVICE
2295
2296 Adds the MTD device infrastructure from the Linux kernel.
2297 Needed for mtdparts command support.
2298
2299 CONFIG_MTD_PARTITIONS
2300
2301 Adds the MTD partitioning infrastructure from the Linux
2302 kernel. Needed for UBI support.
2303
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002304- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002305 CONFIG_SPL
2306 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002307
Wolfgang Denk825223d2011-09-11 21:24:09 +02002308 CONFIG_SPL_TEXT_BASE
2309 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002310
Wolfgang Denk825223d2011-09-11 21:24:09 +02002311 CONFIG_SPL_LDSCRIPT
2312 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002313
Wolfgang Denk825223d2011-09-11 21:24:09 +02002314 CONFIG_SPL_LIBCOMMON_SUPPORT
2315 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002316
Wolfgang Denk825223d2011-09-11 21:24:09 +02002317 CONFIG_SPL_LIBDISK_SUPPORT
2318 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002319
Wolfgang Denk825223d2011-09-11 21:24:09 +02002320 CONFIG_SPL_I2C_SUPPORT
2321 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002322
Wolfgang Denk825223d2011-09-11 21:24:09 +02002323 CONFIG_SPL_GPIO_SUPPORT
2324 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002325
Wolfgang Denk825223d2011-09-11 21:24:09 +02002326 CONFIG_SPL_MMC_SUPPORT
2327 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002328
Wolfgang Denk825223d2011-09-11 21:24:09 +02002329 CONFIG_SPL_SERIAL_SUPPORT
2330 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002331
Wolfgang Denk825223d2011-09-11 21:24:09 +02002332 CONFIG_SPL_SPI_FLASH_SUPPORT
2333 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002334
Wolfgang Denk825223d2011-09-11 21:24:09 +02002335 CONFIG_SPL_SPI_SUPPORT
2336 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002337
Wolfgang Denk825223d2011-09-11 21:24:09 +02002338 CONFIG_SPL_FAT_SUPPORT
2339 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002340
Wolfgang Denk825223d2011-09-11 21:24:09 +02002341 CONFIG_SPL_LIBGENERIC_SUPPORT
2342 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002343
wdenkc6097192002-11-03 00:24:07 +00002344Modem Support:
2345--------------
2346
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002347[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002348
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002349- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002350 CONFIG_MODEM_SUPPORT
2351
2352- RTS/CTS Flow control enable:
2353 CONFIG_HWFLOW
2354
2355- Modem debug support:
2356 CONFIG_MODEM_SUPPORT_DEBUG
2357
wdenk4a5c8a72003-03-06 00:02:04 +00002358 Enables debugging stuff (char screen[1024], dbg())
2359 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002360
wdenkc0aa5c52003-12-06 19:49:23 +00002361- Interrupt support (PPC):
2362
wdenk1ebf41e2004-01-02 14:00:00 +00002363 There are common interrupt_init() and timer_interrupt()
2364 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002365 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002366 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002367 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002368 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002369 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002370 specific handling. If board has watchdog / status_led
2371 / other_activity_monitor it works automatically from
2372 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002373
wdenkc6097192002-11-03 00:24:07 +00002374- General:
2375
wdenk4a5c8a72003-03-06 00:02:04 +00002376 In the target system modem support is enabled when a
2377 specific key (key combination) is pressed during
2378 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002379 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002380 board_init(). Currently key_pressed() is a dummy
2381 function, returning 1 and thus enabling modem
2382 initialization.
wdenkc6097192002-11-03 00:24:07 +00002383
wdenk4a5c8a72003-03-06 00:02:04 +00002384 If there are no modem init strings in the
2385 environment, U-Boot proceed to autoboot; the
2386 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002387 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002388
2389 See also: doc/README.Modem
2390
2391
wdenkc6097192002-11-03 00:24:07 +00002392Configuration Settings:
2393-----------------------
2394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002395- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002396 undefine this when you're short of memory.
2397
Peter Tyserdfb72b82009-01-27 18:03:12 -06002398- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2399 width of the commands listed in the 'help' command output.
2400
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002401- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002402 prompt for user input.
2403
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002404- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002405
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002406- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002408- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002410- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002411 the application (usually a Linux kernel) when it is
2412 booted
2413
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002414- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002415 List of legal baudrate settings for this board.
2416
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002417- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002418 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002419
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002420- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002421 If the board specific function
2422 extern int overwrite_console (void);
2423 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002424 serial port, else the settings in the environment are used.
2425
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002426- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002427 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002428
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002429- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002430 Enable overwrite of previous console environment settings.
2431
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002432- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002433 Begin and End addresses of the area used by the
2434 simple memory test.
2435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002436- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002437 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002439- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002440 Scratch address used by the alternate memory test
2441 You only need to set this if address zero isn't writeable
2442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002443- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2444 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002445 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002446 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002447 fixing up gd->ram_size the Linux kernel should gets passed
2448 the now "corrected" memory size and won't touch it either.
2449 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002450 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002451 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002452 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002453
2454 This option can be used as a workaround for the 440EPx/GRx
2455 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2456 be touched.
2457
2458 WARNING: Please make sure that this value is a multiple of
2459 the Linux page size (normally 4k). If this is not the case,
2460 then the end address of the Linux memory will be located at a
2461 non page size aligned address and this could cause major
2462 problems.
2463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002464- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002465 Default load address for network file downloads
2466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002467- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002468 Enable temporary baudrate change while serial download
2469
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002470- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002471 Physical start address of SDRAM. _Must_ be 0 here.
2472
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002473- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002474 Physical start address of Motherboard I/O (if using a
2475 Cogent motherboard)
2476
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002477- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002478 Physical start address of Flash memory.
2479
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002480- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002481 Physical start address of boot monitor code (set by
2482 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02002483 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002484 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002485
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002486- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002487 Size of memory reserved for monitor code, used to
2488 determine _at_compile_time_ (!) if the environment is
2489 embedded within the U-Boot image, or in a separate
2490 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002491
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002492- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002493 Size of DRAM reserved for malloc() use.
2494
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002495- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002496 Normally compressed uImages are limited to an
2497 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002498 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002499 to adjust this setting to your needs.
2500
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002501- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002502 Maximum size of memory mapped by the startup code of
2503 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002504 the Linux kernel (bd_info, boot arguments, FDT blob if
2505 used) must be put below this limit, unless "bootm_low"
2506 enviroment variable is defined and non-zero. In such case
2507 all data for the Linux kernel must be between "bootm_low"
Grant Likely26396382011-03-28 09:58:43 +00002508 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2509 variable "bootm_mapsize" will override the value of
2510 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2511 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002512
John Rigbyeea8e692010-10-13 13:57:35 -06002513- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2514 Enable initrd_high functionality. If defined then the
2515 initrd_high feature is enabled and the bootm ramdisk subcommand
2516 is enabled.
2517
2518- CONFIG_SYS_BOOT_GET_CMDLINE:
2519 Enables allocating and saving kernel cmdline in space between
2520 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2521
2522- CONFIG_SYS_BOOT_GET_KBD:
2523 Enables allocating and saving a kernel copy of the bd_info in
2524 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2525
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002526- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002527 Max number of Flash memory banks
2528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002529- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002530 Max number of sectors on a Flash chip
2531
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002532- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002533 Timeout for Flash erase operations (in ms)
2534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002536 Timeout for Flash write operations (in ms)
2537
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002538- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002539 Timeout for Flash set sector lock bit operation (in ms)
2540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002541- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002542 Timeout for Flash clear lock bits operation (in ms)
2543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002545 If defined, hardware flash sectors protection is used
2546 instead of U-Boot software protection.
2547
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002548- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002549
2550 Enable TFTP transfers directly to flash memory;
2551 without this option such a download has to be
2552 performed in two steps: (1) download to RAM, and (2)
2553 copy from RAM to flash.
2554
2555 The two-step approach is usually more reliable, since
2556 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002557 the flash, but in some situations (when system RAM is
2558 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002559 downloaded image) this option may be very useful.
2560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002561- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002562 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002563 common flash structure for storing flash geometry.
2564
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002565- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002566 This option also enables the building of the cfi_flash driver
2567 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002568
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002569- CONFIG_FLASH_CFI_MTD
2570 This option enables the building of the cfi_mtd driver
2571 in the drivers directory. The driver exports CFI flash
2572 to the MTD layer.
2573
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002574- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002575 Use buffered writes to flash.
2576
2577- CONFIG_FLASH_SPANSION_S29WS_N
2578 s29ws-n MirrorBit flash has non-standard addresses for buffered
2579 write commands.
2580
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002581- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002582 If this option is defined, the common CFI flash doesn't
2583 print it's warning upon not recognized FLASH banks. This
2584 is useful, if some of the configured banks are only
2585 optionally available.
2586
Jerry Van Barenaae73572008-03-08 13:48:01 -05002587- CONFIG_FLASH_SHOW_PROGRESS
2588 If defined (must be an integer), print out countdown
2589 digits and dots. Recommended value: 45 (9..1) for 80
2590 column displays, 15 (3..1) for 40 column displays.
2591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002592- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002593 Defines the number of Ethernet receive buffers. On some
2594 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002595 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2596 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002597 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002598 Defaults to 4 if not defined.
2599
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002600- CONFIG_ENV_MAX_ENTRIES
2601
Wolfgang Denk1136f692010-10-27 22:48:30 +02002602 Maximum number of entries in the hash table that is used
2603 internally to store the environment settings. The default
2604 setting is supposed to be generous and should work in most
2605 cases. This setting can be used to tune behaviour; see
2606 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002607
wdenkc6097192002-11-03 00:24:07 +00002608The following definitions that deal with the placement and management
2609of environment data (variable area); in general, we support the
2610following configurations:
2611
Mike Frysinger63b8f122011-07-08 10:44:25 +00002612- CONFIG_BUILD_ENVCRC:
2613
2614 Builds up envcrc with the target environment so that external utils
2615 may easily extract it and embed it in final U-Boot images.
2616
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002617- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002618
2619 Define this if the environment is in flash memory.
2620
2621 a) The environment occupies one whole flash sector, which is
2622 "embedded" in the text segment with the U-Boot code. This
2623 happens usually with "bottom boot sector" or "top boot
2624 sector" type flash chips, which have several smaller
2625 sectors at the start or the end. For instance, such a
2626 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2627 such a case you would place the environment in one of the
2628 4 kB sectors - with U-Boot code before and after it. With
2629 "top boot sector" type flash chips, you would put the
2630 environment in one of the last sectors, leaving a gap
2631 between U-Boot and the environment.
2632
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002633 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002634
2635 Offset of environment data (variable area) to the
2636 beginning of flash memory; for instance, with bottom boot
2637 type flash chips the second sector can be used: the offset
2638 for this sector is given here.
2639
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002640 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002641
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002642 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002643
2644 This is just another way to specify the start address of
2645 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002646 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002647
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002648 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002649
2650 Size of the sector containing the environment.
2651
2652
2653 b) Sometimes flash chips have few, equal sized, BIG sectors.
2654 In such a case you don't want to spend a whole sector for
2655 the environment.
2656
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002657 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002658
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002659 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002660 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002661 of this flash sector for the environment. This saves
2662 memory for the RAM copy of the environment.
2663
2664 It may also save flash memory if you decide to use this
2665 when your environment is "embedded" within U-Boot code,
2666 since then the remainder of the flash sector could be used
2667 for U-Boot code. It should be pointed out that this is
2668 STRONGLY DISCOURAGED from a robustness point of view:
2669 updating the environment in flash makes it always
2670 necessary to erase the WHOLE sector. If something goes
2671 wrong before the contents has been restored from a copy in
2672 RAM, your target system will be dead.
2673
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002674 - CONFIG_ENV_ADDR_REDUND
2675 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002676
wdenk4a5c8a72003-03-06 00:02:04 +00002677 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002678 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002679 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002680 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002681
2682BE CAREFUL! Any changes to the flash layout, and some changes to the
2683source code will make it necessary to adapt <board>/u-boot.lds*
2684accordingly!
2685
2686
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02002687- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002688
2689 Define this if you have some non-volatile memory device
2690 (NVRAM, battery buffered SRAM) which you want to use for the
2691 environment.
2692
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002693 - CONFIG_ENV_ADDR:
2694 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002695
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002696 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002697 want to use for environment. It is assumed that this memory
2698 can just be read and written to, without any special
2699 provision.
2700
2701BE CAREFUL! The first access to the environment happens quite early
2702in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002703console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002704U-Boot will hang.
2705
2706Please note that even with NVRAM we still use a copy of the
2707environment in RAM: we could work on NVRAM directly, but we want to
2708keep settings there always unmodified except somebody uses "saveenv"
2709to save the current settings.
2710
2711
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02002712- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002713
2714 Use this if you have an EEPROM or similar serial access
2715 device and a driver for it.
2716
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002717 - CONFIG_ENV_OFFSET:
2718 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002719
2720 These two #defines specify the offset and size of the
2721 environment area within the total memory of your EEPROM.
2722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002723 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002724 If defined, specified the chip address of the EEPROM device.
2725 The default address is zero.
2726
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002727 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002728 If defined, the number of bits used to address bytes in a
2729 single page in the EEPROM device. A 64 byte page, for example
2730 would require six bits.
2731
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002732 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002733 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002734 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002735
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002736 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002737 The length in bytes of the EEPROM memory array address. Note
2738 that this is NOT the chip address length!
2739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002740 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00002741 EEPROM chips that implement "address overflow" are ones
2742 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2743 address and the extra bits end up in the "chip address" bit
2744 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2745 byte chips.
2746
2747 Note that we consider the length of the address field to
2748 still be one byte because the extra address bits are hidden
2749 in the chip address.
2750
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002751 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002752 The size in bytes of the EEPROM device.
2753
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01002754 - CONFIG_ENV_EEPROM_IS_ON_I2C
2755 define this, if you have I2C and SPI activated, and your
2756 EEPROM, which holds the environment, is on the I2C bus.
2757
2758 - CONFIG_I2C_ENV_EEPROM_BUS
2759 if you have an Environment on an EEPROM reached over
2760 I2C muxes, you can define here, how to reach this
2761 EEPROM. For example:
2762
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02002763 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01002764
2765 EEPROM which holds the environment, is reached over
2766 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002767
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02002768- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00002769
wdenk1ebf41e2004-01-02 14:00:00 +00002770 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002771 want to use for the environment.
2772
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002773 - CONFIG_ENV_OFFSET:
2774 - CONFIG_ENV_ADDR:
2775 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00002776
2777 These three #defines specify the offset and size of the
2778 environment area within the total memory of your DataFlash placed
2779 at the specified address.
2780
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02002781- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00002782
2783 Define this if you have a NAND device which you want to use
2784 for the environment.
2785
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002786 - CONFIG_ENV_OFFSET:
2787 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00002788
2789 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05002790 area within the first NAND device. CONFIG_ENV_OFFSET must be
2791 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00002792
Scott Wood08239322010-09-17 14:38:37 -05002793 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002794
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002795 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05002796 size used to hold a redundant copy of the environment data, so
2797 that there is a valid backup copy in case there is a power failure
2798 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2799 aligned to an erase block boundary.
2800
2801 - CONFIG_ENV_RANGE (optional):
2802
2803 Specifies the length of the region in which the environment
2804 can be written. This should be a multiple of the NAND device's
2805 block size. Specifying a range with more erase blocks than
2806 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2807 the range to be avoided.
2808
2809 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002810
Scott Wood08239322010-09-17 14:38:37 -05002811 Enables support for dynamically retrieving the offset of the
2812 environment from block zero's out-of-band data. The
2813 "nand env.oob" command can be used to record this offset.
2814 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2815 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002816
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002817- CONFIG_NAND_ENV_DST
2818
2819 Defines address in RAM to which the nand_spl code should copy the
2820 environment. If redundant environment is used, it will be copied to
2821 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2822
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002823- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002824
2825 Defines offset to the initial SPI buffer area in DPRAM. The
2826 area is used at an early stage (ROM part) if the environment
2827 is configured to reside in the SPI EEPROM: We need a 520 byte
2828 scratch DPRAM area. It is used between the two initialization
2829 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2830 to be a good choice since it makes it far enough from the
2831 start of the data area as well as from the stack pointer.
2832
Bruce Adleredecc942007-11-02 13:15:42 -07002833Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002834has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02002835created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002836until then to read environment variables.
2837
wdenk8dba0502003-03-31 16:34:49 +00002838The environment is protected by a CRC32 checksum. Before the monitor
2839is relocated into RAM, as a result of a bad CRC you will be working
2840with the compiled-in default environment - *silently*!!! [This is
2841necessary, because the first environment variable we need is the
2842"baudrate" setting for the console - if we have a bad CRC, we don't
2843have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002844
2845Note: once the monitor has been relocated, then it will complain if
2846the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002847use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002849- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002850 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002851
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002852 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002853 also needs to be defined.
2854
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002855- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002856 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002857
Ron Madriddfa028a2009-02-18 14:30:44 -08002858- CONFIG_NS16550_MIN_FUNCTIONS:
2859 Define this if you desire to only have use of the NS16550_init
2860 and NS16550_putc functions for the serial driver located at
2861 drivers/serial/ns16550.c. This option is useful for saving
2862 space for already greatly restricted images, including but not
2863 limited to NAND_SPL configurations.
2864
wdenkc6097192002-11-03 00:24:07 +00002865Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002866---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002867
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002868- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002869 Cache Line Size of the CPU.
2870
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002871- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002872 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002873
wdenk9c53f402003-10-15 23:53:47 +00002874 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2875 and RPXsuper) to be able to adjust the position of
2876 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002877
Timur Tabid8f341c2011-08-04 18:03:41 -05002878- CONFIG_SYS_CCSRBAR_DEFAULT:
2879 Default (power-on reset) physical address of CCSR on Freescale
2880 PowerPC SOCs.
2881
2882- CONFIG_SYS_CCSRBAR:
2883 Virtual address of CCSR. On a 32-bit build, this is typically
2884 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2885
2886 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2887 for cross-platform code that uses that macro instead.
2888
2889- CONFIG_SYS_CCSRBAR_PHYS:
2890 Physical address of CCSR. CCSR can be relocated to a new
2891 physical address, if desired. In this case, this macro should
2892 be set to that address. Otherwise, it should be set to the
2893 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2894 is typically relocated on 36-bit builds. It is recommended
2895 that this macro be defined via the _HIGH and _LOW macros:
2896
2897 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2898 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2899
2900- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002901 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2902 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002903 used in assembly code, so it must not contain typecasts or
2904 integer size suffixes (e.g. "ULL").
2905
2906- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2907 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2908 used in assembly code, so it must not contain typecasts or
2909 integer size suffixes (e.g. "ULL").
2910
2911- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2912 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2913 forced to a value that ensures that CCSR is not relocated.
2914
wdenk1272e232002-11-10 22:06:23 +00002915- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002916 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00002917
2918 the default drive number (default value 0)
2919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002920 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00002921
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002922 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00002923 (default value 1)
2924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002925 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00002926
wdenk4a5c8a72003-03-06 00:02:04 +00002927 defines the offset of register from address. It
2928 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002929 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00002930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002931 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2932 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00002933 default value.
wdenk1272e232002-11-10 22:06:23 +00002934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002935 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00002936 fdc_hw_init() is called at the beginning of the FDC
2937 setup. fdc_hw_init() must be provided by the board
2938 source code. It is used to make hardware dependant
2939 initializations.
wdenk1272e232002-11-10 22:06:23 +00002940
Macpaul Lind1e49942011-04-11 20:45:32 +00002941- CONFIG_IDE_AHB:
2942 Most IDE controllers were designed to be connected with PCI
2943 interface. Only few of them were designed for AHB interface.
2944 When software is doing ATA command and data transfer to
2945 IDE devices through IDE-AHB controller, some additional
2946 registers accessing to these kind of IDE-AHB controller
2947 is requierd.
2948
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002949- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002950 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00002951 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002953- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002954
wdenkeb20ad32003-09-05 23:19:14 +00002955 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002956 initial data and stack; please note that this must be
2957 writable memory that is working WITHOUT special
2958 initialization, i. e. you CANNOT use normal RAM which
2959 will become available only after programming the
2960 memory controller and running certain initialization
2961 sequences.
2962
2963 U-Boot uses the following memory types:
2964 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2965 - MPC824X: data cache
2966 - PPC4xx: data cache
2967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002968- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002969
2970 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002971 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2972 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002973 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002974 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002975 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2976 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2977 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002978
2979 Note:
2980 On the MPC824X (or other systems that use the data
2981 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002982 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002983 point to an otherwise UNUSED address space between
2984 the top of RAM and the start of the PCI space.
2985
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002986- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002988- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002990- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002991
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002992- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002993
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002994- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002995
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002996- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002997
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002998- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002999 SDRAM timing
3000
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003001- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003002 periodic timer for refresh
3003
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003004- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003005
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003006- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3007 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3008 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3009 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003010 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3011
3012- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003013 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3014 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003015 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003017- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3018 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003019 Machine Mode Register and Memory Periodic Timer
3020 Prescaler definitions (SDRAM timing)
3021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003022- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003023 enable I2C microcode relocation patch (MPC8xx);
3024 define relocation offset in DPRAM [DSP2]
3025
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003026- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003027 enable SMC microcode relocation patch (MPC8xx);
3028 define relocation offset in DPRAM [SMC1]
3029
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003030- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003031 enable SPI microcode relocation patch (MPC8xx);
3032 define relocation offset in DPRAM [SCC4]
3033
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003034- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003035 Use OSCM clock mode on MBX8xx board. Be careful,
3036 wrong setting might damage your board. Read
3037 doc/README.MBX before setting this variable!
3038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003039- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003040 Offset of the bootmode word in DPRAM used by post
3041 (Power On Self Tests). This definition overrides
3042 #define'd default value in commproc.h resp.
3043 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003045- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3046 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3047 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3048 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3049 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3050 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3051 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3052 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003053 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003054
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003055- CONFIG_PCI_DISABLE_PCIE:
3056 Disable PCI-Express on systems where it is supported but not
3057 required.
3058
Kumar Gala8975d7a2010-12-30 12:09:53 -06003059- CONFIG_SYS_SRIO:
3060 Chip has SRIO or not
3061
3062- CONFIG_SRIO1:
3063 Board has SRIO 1 port available
3064
3065- CONFIG_SRIO2:
3066 Board has SRIO 2 port available
3067
3068- CONFIG_SYS_SRIOn_MEM_VIRT:
3069 Virtual Address of SRIO port 'n' memory region
3070
3071- CONFIG_SYS_SRIOn_MEM_PHYS:
3072 Physical Address of SRIO port 'n' memory region
3073
3074- CONFIG_SYS_SRIOn_MEM_SIZE:
3075 Size of SRIO port 'n' memory region
3076
Alex Watermancd6aae32011-05-19 15:08:36 -04003077- CONFIG_SYS_NDFC_16
3078 Defined to tell the NDFC that the NAND chip is using a
3079 16 bit bus.
3080
3081- CONFIG_SYS_NDFC_EBC0_CFG
3082 Sets the EBC0_CFG register for the NDFC. If not defined
3083 a default value will be used.
3084
Ben Warren45657152006-09-07 16:50:54 -04003085- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003086 Get DDR timing information from an I2C EEPROM. Common
3087 with pluggable memory modules such as SODIMMs
3088
Ben Warren45657152006-09-07 16:50:54 -04003089 SPD_EEPROM_ADDRESS
3090 I2C address of the SPD EEPROM
3091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003092- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003093 If SPD EEPROM is on an I2C bus other than the first
3094 one, specify here. Note that the value must resolve
3095 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003096
York Sune73cc042011-06-07 09:42:16 +08003097- CONFIG_SYS_DDR_RAW_TIMING
3098 Get DDR timing information from other than SPD. Common with
3099 soldered DDR chips onboard without SPD. DDR raw timing
3100 parameters are extracted from datasheet and hard-coded into
3101 header files or board specific files.
3102
York Sunbd495cf2011-09-16 13:21:35 -07003103- CONFIG_FSL_DDR_INTERACTIVE
3104 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003106- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003107 Only for 83xx systems. If specified, then DDR should
3108 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003109
wdenk6203e402004-04-18 10:13:26 +00003110- CONFIG_ETHER_ON_FEC[12]
3111 Define to enable FEC[12] on a 8xx series processor.
3112
3113- CONFIG_FEC[12]_PHY
3114 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003115 to the given FEC; i. e.
3116 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003117 means that the PHY with address 4 is connected to FEC1
3118
3119 When set to -1, means to probe for first available.
3120
3121- CONFIG_FEC[12]_PHY_NORXERR
3122 The PHY does not have a RXERR line (RMII only).
3123 (so program the FEC to ignore it).
3124
3125- CONFIG_RMII
3126 Enable RMII mode for all FECs.
3127 Note that this is a global option, we can't
3128 have one FEC in standard MII mode and another in RMII mode.
3129
wdenk20c98a62004-04-23 20:32:05 +00003130- CONFIG_CRC32_VERIFY
3131 Add a verify option to the crc32 command.
3132 The syntax is:
3133
3134 => crc32 -v <address> <count> <crc32>
3135
3136 Where address/count indicate a memory area
3137 and crc32 is the correct crc32 which the
3138 area should have.
3139
wdenk64519362004-07-11 17:40:54 +00003140- CONFIG_LOOPW
3141 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003142 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003143
stroesecc3af832004-12-16 18:46:55 +00003144- CONFIG_MX_CYCLIC
3145 Add the "mdc" and "mwc" memory commands. These are cyclic
3146 "md/mw" commands.
3147 Examples:
3148
wdenk07d7e6b2004-12-16 21:44:03 +00003149 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003150 This command will print 4 bytes (10,11,12,13) each 500 ms.
3151
wdenk07d7e6b2004-12-16 21:44:03 +00003152 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003153 This command will write 12345678 to address 100 all 10 ms.
3154
wdenk07d7e6b2004-12-16 21:44:03 +00003155 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003156 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003157
wdenk3d3d99f2005-04-04 12:44:11 +00003158- CONFIG_SKIP_LOWLEVEL_INIT
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +02003159 [ARM, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003160 low level initializations (like setting up the memory
3161 controller) are omitted and/or U-Boot does not
3162 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003163
Wolfgang Denk302141d2010-11-27 23:30:56 +01003164 Normally this variable MUST NOT be defined. The only
3165 exception is when U-Boot is loaded (to RAM) by some
3166 other boot loader or by a debugger which performs
3167 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003168
Aneesh V552a3192011-07-13 05:11:07 +00003169- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003170 Modifies the behaviour of start.S when compiling a loader
3171 that is executed before the actual U-Boot. E.g. when
3172 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003173
Matthias Weisser93416c12011-03-10 21:36:32 +00003174- CONFIG_USE_ARCH_MEMCPY
3175 CONFIG_USE_ARCH_MEMSET
3176 If these options are used a optimized version of memcpy/memset will
3177 be used if available. These functions may be faster under some
3178 conditions but may increase the binary size.
3179
wdenkc6097192002-11-03 00:24:07 +00003180Building the Software:
3181======================
3182
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003183Building U-Boot has been tested in several native build environments
3184and in many different cross environments. Of course we cannot support
3185all possibly existing versions of cross development tools in all
3186(potentially obsolete) versions. In case of tool chain problems we
3187recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3188which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003189
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003190If you are not using a native environment, it is assumed that you
3191have GNU cross compiling tools available in your path. In this case,
3192you must set the environment variable CROSS_COMPILE in your shell.
3193Note that no changes to the Makefile or any other source files are
3194necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003195
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003196 $ CROSS_COMPILE=ppc_4xx-
3197 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003198
Peter Tyserb06976d2009-03-13 18:54:51 -05003199Note: If you wish to generate Windows versions of the utilities in
3200 the tools directory you can use the MinGW toolchain
3201 (http://www.mingw.org). Set your HOST tools to the MinGW
3202 toolchain and execute 'make tools'. For example:
3203
3204 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3205
3206 Binaries such as tools/mkimage.exe will be created which can
3207 be executed on computers running Windows.
3208
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003209U-Boot is intended to be simple to build. After installing the
3210sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003211is done by typing:
3212
3213 make NAME_config
3214
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003215where "NAME_config" is the name of one of the existing configu-
3216rations; see the main Makefile for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003217
wdenk6c59edc2004-05-03 20:45:30 +00003218Note: for some board special configuration names may exist; check if
3219 additional information is available from the board vendor; for
3220 instance, the TQM823L systems are available without (standard)
3221 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003222 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003223
wdenk6c59edc2004-05-03 20:45:30 +00003224 make TQM823L_config
3225 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003226
wdenk6c59edc2004-05-03 20:45:30 +00003227 make TQM823L_LCD_config
3228 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003229
wdenk6c59edc2004-05-03 20:45:30 +00003230 etc.
wdenkc6097192002-11-03 00:24:07 +00003231
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk6c59edc2004-05-03 20:45:30 +00003233Finally, type "make all", and you should get some working U-Boot
3234images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk6c59edc2004-05-03 20:45:30 +00003236- "u-boot.bin" is a raw binary image
3237- "u-boot" is an image in ELF binary format
3238- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003239
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003240By default the build is performed locally and the objects are saved
3241in the source directory. One of the two methods can be used to change
3242this behavior and build U-Boot to some external directory:
3243
32441. Add O= to the make command line invocations:
3245
3246 make O=/tmp/build distclean
3247 make O=/tmp/build NAME_config
3248 make O=/tmp/build all
3249
32502. Set environment variable BUILD_DIR to point to the desired location:
3251
3252 export BUILD_DIR=/tmp/build
3253 make distclean
3254 make NAME_config
3255 make all
3256
3257Note that the command line "O=" setting overrides the BUILD_DIR environment
3258variable.
3259
wdenkc6097192002-11-03 00:24:07 +00003260
wdenk6c59edc2004-05-03 20:45:30 +00003261Please be aware that the Makefiles assume you are using GNU make, so
3262for instance on NetBSD you might need to use "gmake" instead of
3263native "make".
wdenkc6097192002-11-03 00:24:07 +00003264
wdenkc6097192002-11-03 00:24:07 +00003265
wdenk6c59edc2004-05-03 20:45:30 +00003266If the system board that you have is not listed, then you will need
3267to port U-Boot to your hardware platform. To do this, follow these
3268steps:
wdenkc6097192002-11-03 00:24:07 +00003269
wdenk6c59edc2004-05-03 20:45:30 +000032701. Add a new configuration option for your board to the toplevel
3271 "Makefile" and to the "MAKEALL" script, using the existing
3272 entries as examples. Note that here and at many other places
3273 boards and other names are listed in alphabetical sort order. Please
3274 keep this order.
32752. Create a new directory to hold your board specific code. Add any
3276 files you need. In your board directory, you will need at least
3277 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
32783. Create a new configuration file "include/configs/<board>.h" for
3279 your board
32803. If you're porting U-Boot to a new CPU, then also create a new
3281 directory to hold your CPU specific code. Add any files you need.
32824. Run "make <board>_config" with your new name.
32835. Type "make", and you should get a working "u-boot.srec" file
3284 to be installed on your target system.
32856. Debug and solve any problems that might arise.
3286 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003287
wdenkc6097192002-11-03 00:24:07 +00003288
wdenk6c59edc2004-05-03 20:45:30 +00003289Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3290==============================================================
wdenkc6097192002-11-03 00:24:07 +00003291
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003292If you have modified U-Boot sources (for instance added a new board
3293or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003294provide feedback to the other developers. The feedback normally takes
3295the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003296official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003297
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003298But before you submit such a patch, please verify that your modifi-
3299cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003300the supported boards compile WITHOUT ANY compiler warnings. To do so,
3301just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003302for ALL supported system. Be warned, this will take a while. You can
3303select which (cross) compiler to use by passing a `CROSS_COMPILE'
3304environment variable to the script, i. e. to use the ELDK cross tools
3305you can type
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk6c59edc2004-05-03 20:45:30 +00003307 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk6c59edc2004-05-03 20:45:30 +00003309or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003310
wdenk6c59edc2004-05-03 20:45:30 +00003311 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003312
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003313When using the MAKEALL script, the default behaviour is to build
3314U-Boot in the source directory. This location can be changed by
3315setting the BUILD_DIR environment variable. Also, for each target
3316built, the MAKEALL script saves two log files (<target>.ERR and
3317<target>.MAKEALL) in the <source dir>/LOG directory. This default
3318location can be changed by setting the MAKEALL_LOGDIR environment
3319variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003320
3321 export BUILD_DIR=/tmp/build
3322 export MAKEALL_LOGDIR=/tmp/log
3323 CROSS_COMPILE=ppc_8xx- MAKEALL
3324
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003325With the above settings build objects are saved in the /tmp/build,
3326log files are saved in the /tmp/log and the source tree remains clean
3327during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003328
3329
wdenk6c59edc2004-05-03 20:45:30 +00003330See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003331
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk6c59edc2004-05-03 20:45:30 +00003333Monitor Commands - Overview:
3334============================
wdenkc6097192002-11-03 00:24:07 +00003335
wdenk6c59edc2004-05-03 20:45:30 +00003336go - start application at address 'addr'
3337run - run commands in an environment variable
3338bootm - boot application image from memory
3339bootp - boot image via network using BootP/TFTP protocol
3340tftpboot- boot image via network using TFTP protocol
3341 and env variables "ipaddr" and "serverip"
3342 (and eventually "gatewayip")
3343rarpboot- boot image via network using RARP/TFTP protocol
3344diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3345loads - load S-Record file over serial line
3346loadb - load binary file over serial line (kermit mode)
3347md - memory display
3348mm - memory modify (auto-incrementing)
3349nm - memory modify (constant address)
3350mw - memory write (fill)
3351cp - memory copy
3352cmp - memory compare
3353crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003354i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003355sspi - SPI utility commands
3356base - print or set address offset
3357printenv- print environment variables
3358setenv - set environment variables
3359saveenv - save environment variables to persistent storage
3360protect - enable or disable FLASH write protection
3361erase - erase FLASH memory
3362flinfo - print FLASH memory information
3363bdinfo - print Board Info structure
3364iminfo - print header information for application image
3365coninfo - print console devices and informations
3366ide - IDE sub-system
3367loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00003368loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00003369mtest - simple RAM test
3370icache - enable or disable instruction cache
3371dcache - enable or disable data cache
3372reset - Perform RESET of the CPU
3373echo - echo args to console
3374version - print monitor version
3375help - print online help
3376? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003377
wdenkc6097192002-11-03 00:24:07 +00003378
wdenk6c59edc2004-05-03 20:45:30 +00003379Monitor Commands - Detailed Description:
3380========================================
wdenkc6097192002-11-03 00:24:07 +00003381
wdenk6c59edc2004-05-03 20:45:30 +00003382TODO.
wdenkc6097192002-11-03 00:24:07 +00003383
wdenk6c59edc2004-05-03 20:45:30 +00003384For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003385
3386
wdenk6c59edc2004-05-03 20:45:30 +00003387Environment Variables:
3388======================
wdenkc6097192002-11-03 00:24:07 +00003389
wdenk6c59edc2004-05-03 20:45:30 +00003390U-Boot supports user configuration using Environment Variables which
3391can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003392
wdenk6c59edc2004-05-03 20:45:30 +00003393Environment Variables are set using "setenv", printed using
3394"printenv", and saved to Flash using "saveenv". Using "setenv"
3395without a value can be used to delete a variable from the
3396environment. As long as you don't save the environment you are
3397working with an in-memory copy. In case the Flash area containing the
3398environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003399
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003400Some configuration options can be set using Environment Variables.
3401
3402List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003403
wdenk6c59edc2004-05-03 20:45:30 +00003404 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk6c59edc2004-05-03 20:45:30 +00003406 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk6c59edc2004-05-03 20:45:30 +00003408 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003409
wdenk6c59edc2004-05-03 20:45:30 +00003410 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003411
wdenk6c59edc2004-05-03 20:45:30 +00003412 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003413
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003414 bootm_low - Memory range available for image processing in the bootm
3415 command can be restricted. This variable is given as
3416 a hexadecimal number and defines lowest address allowed
3417 for use by the bootm command. See also "bootm_size"
3418 environment variable. Address defined by "bootm_low" is
3419 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00003420 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3421 bootm_mapsize.
3422
3423 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3424 This variable is given as a hexadecimal number and it
3425 defines the size of the memory region starting at base
3426 address bootm_low that is accessible by the Linux kernel
3427 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3428 as the default value if it is defined, and bootm_size is
3429 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003430
3431 bootm_size - Memory range available for image processing in the bootm
3432 command can be restricted. This variable is given as
3433 a hexadecimal number and defines the size of the region
3434 allowed for use by the bootm command. See also "bootm_low"
3435 environment variable.
3436
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02003437 updatefile - Location of the software update file on a TFTP server, used
3438 by the automatic software update feature. Please refer to
3439 documentation in doc/README.update for more details.
3440
wdenk6c59edc2004-05-03 20:45:30 +00003441 autoload - if set to "no" (any string beginning with 'n'),
3442 "bootp" will just load perform a lookup of the
3443 configuration from the BOOTP server, but not try to
3444 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003445
wdenk6c59edc2004-05-03 20:45:30 +00003446 autostart - if set to "yes", an image loaded using the "bootp",
3447 "rarpboot", "tftpboot" or "diskboot" commands will
3448 be automatically started (by internally calling
3449 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003450
wdenk6c59edc2004-05-03 20:45:30 +00003451 If set to "no", a standalone image passed to the
3452 "bootm" command will be copied to the load address
3453 (and eventually uncompressed), but NOT be started.
3454 This can be used to load and uncompress arbitrary
3455 data.
wdenkc6097192002-11-03 00:24:07 +00003456
David A. Longd558a4e2011-07-09 16:40:19 -04003457 fdt_high - if set this restricts the maximum address that the
3458 flattened device tree will be copied into upon boot.
3459 If this is set to the special value 0xFFFFFFFF then
3460 the fdt will not be copied at all on boot. For this
3461 to work it must reside in writable memory, have
3462 sufficient padding on the end of it for u-boot to
3463 add the information it needs into it, and the memory
3464 must be accessible by the kernel.
3465
wdenk0e2bd9c2004-06-06 21:51:03 +00003466 i2cfast - (PPC405GP|PPC405EP only)
3467 if set to 'y' configures Linux I2C driver for fast
3468 mode (400kHZ). This environment variable is used in
3469 initialization code. So, for changes to be effective
3470 it must be saved and board must be reset.
3471
wdenk6c59edc2004-05-03 20:45:30 +00003472 initrd_high - restrict positioning of initrd images:
3473 If this variable is not set, initrd images will be
3474 copied to the highest possible address in RAM; this
3475 is usually what you want since it allows for
3476 maximum initrd size. If for some reason you want to
3477 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003478 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003479 variable to a value of "no" or "off" or "0".
3480 Alternatively, you can set it to a maximum upper
3481 address to use (U-Boot will still check that it
3482 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk6c59edc2004-05-03 20:45:30 +00003484 For instance, when you have a system with 16 MB
3485 RAM, and want to reserve 4 MB from use by Linux,
3486 you can do this by adding "mem=12M" to the value of
3487 the "bootargs" variable. However, now you must make
3488 sure that the initrd image is placed in the first
3489 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003490
wdenk6c59edc2004-05-03 20:45:30 +00003491 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003492
wdenk6c59edc2004-05-03 20:45:30 +00003493 If you set initrd_high to 0xFFFFFFFF, this is an
3494 indication to U-Boot that all addresses are legal
3495 for the Linux kernel, including addresses in flash
3496 memory. In this case U-Boot will NOT COPY the
3497 ramdisk at all. This may be useful to reduce the
3498 boot time on your system, but requires that this
3499 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003500
wdenk6c59edc2004-05-03 20:45:30 +00003501 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk6c59edc2004-05-03 20:45:30 +00003503 loadaddr - Default load address for commands like "bootp",
3504 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk6c59edc2004-05-03 20:45:30 +00003506 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk6c59edc2004-05-03 20:45:30 +00003508 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003509
wdenk6c59edc2004-05-03 20:45:30 +00003510 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003511
wdenk6c59edc2004-05-03 20:45:30 +00003512 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003513
wdenk6c59edc2004-05-03 20:45:30 +00003514 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003515
Mike Frysingera23230c2011-10-02 10:01:27 +00003516 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003517
Mike Frysingera23230c2011-10-02 10:01:27 +00003518 ethact - controls which interface is currently active.
3519 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003520
Heiko Schocherc5e84052010-07-20 17:45:02 +02003521 => setenv ethact FEC
3522 => ping 192.168.0.1 # traffic sent on FEC
3523 => setenv ethact SCC
3524 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003525
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003526 ethrotate - When set to "no" U-Boot does not go through all
3527 available network interfaces.
3528 It just stays at the currently selected interface.
3529
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003530 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00003531 either succeed or fail without retrying.
3532 When set to "once" the network operation will
3533 fail when all the available network interfaces
3534 are tried once without success.
3535 Useful on scripts which control the retry operation
3536 themselves.
wdenkc6097192002-11-03 00:24:07 +00003537
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003538 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003539
Wolfgang Denk227b5192005-09-24 23:25:46 +02003540 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003541 UDP source port.
3542
Wolfgang Denk227b5192005-09-24 23:25:46 +02003543 tftpdstport - If this is set, the value is used for TFTP's UDP
3544 destination port instead of the Well Know Port 69.
3545
Wolfgang Denkb233bd72010-01-17 23:55:53 +01003546 tftpblocksize - Block size to use for TFTP transfers; if not set,
3547 we use the TFTP server's default block size
3548
3549 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3550 seconds, minimum value is 1000 = 1 second). Defines
3551 when a packet is considered to be lost so it has to
3552 be retransmitted. The default is 5000 = 5 seconds.
3553 Lowering this value may make downloads succeed
3554 faster in networks with high packet loss rates or
3555 with unreliable TFTP servers.
3556
3557 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003558 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003559 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003560
Jason Hobbse3fe08e2011-08-31 05:37:28 +00003561The following image location variables contain the location of images
3562used in booting. The "Image" column gives the role of the image and is
3563not an environment variable name. The other columns are environment
3564variable names. "File Name" gives the name of the file on a TFTP
3565server, "RAM Address" gives the location in RAM the image will be
3566loaded to, and "Flash Location" gives the image's address in NOR
3567flash or offset in NAND flash.
3568
3569*Note* - these variables don't have to be defined for all boards, some
3570boards currenlty use other variables for these purposes, and some
3571boards use these variables for other purposes.
3572
3573Image File Name RAM Address Flash Location
3574----- --------- ----------- --------------
3575u-boot u-boot u-boot_addr_r u-boot_addr
3576Linux kernel bootfile kernel_addr_r kernel_addr
3577device tree blob fdtfile fdt_addr_r fdt_addr
3578ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
3579
wdenk6c59edc2004-05-03 20:45:30 +00003580The following environment variables may be used and automatically
3581updated by the network boot commands ("bootp" and "rarpboot"),
3582depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003583
wdenk6c59edc2004-05-03 20:45:30 +00003584 bootfile - see above
3585 dnsip - IP address of your Domain Name Server
3586 dnsip2 - IP address of your secondary Domain Name Server
3587 gatewayip - IP address of the Gateway (Router) to use
3588 hostname - Target hostname
3589 ipaddr - see above
3590 netmask - Subnet Mask
3591 rootpath - Pathname of the root filesystem on the NFS server
3592 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003593
wdenk145d2c12004-04-15 21:48:45 +00003594
wdenk6c59edc2004-05-03 20:45:30 +00003595There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk6c59edc2004-05-03 20:45:30 +00003597 serial# - contains hardware identification information such
3598 as type string and/or serial number
3599 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003600
wdenk6c59edc2004-05-03 20:45:30 +00003601These variables can be set only once (usually during manufacturing of
3602the board). U-Boot refuses to delete or overwrite these variables
3603once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003604
3605
wdenk6c59edc2004-05-03 20:45:30 +00003606Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003607
wdenk6c59edc2004-05-03 20:45:30 +00003608 ver - Contains the U-Boot version string as printed
3609 with the "version" command. This variable is
3610 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003611
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk6c59edc2004-05-03 20:45:30 +00003613Please note that changes to some configuration parameters may take
3614only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003615
stroeseb9c17c52003-04-04 15:53:41 +00003616
wdenk6c59edc2004-05-03 20:45:30 +00003617Command Line Parsing:
3618=====================
stroeseb9c17c52003-04-04 15:53:41 +00003619
wdenk6c59edc2004-05-03 20:45:30 +00003620There are two different command line parsers available with U-Boot:
3621the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003622
wdenk6c59edc2004-05-03 20:45:30 +00003623Old, simple command line parser:
3624--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003625
wdenk6c59edc2004-05-03 20:45:30 +00003626- supports environment variables (through setenv / saveenv commands)
3627- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003628- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003629- special characters ('$', ';') can be escaped by prefixing with '\',
3630 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003631 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003632- You can also escape text by enclosing in single apostrophes, for example:
3633 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003634
wdenk6c59edc2004-05-03 20:45:30 +00003635Hush shell:
3636-----------
wdenkf4688a22003-05-28 08:06:31 +00003637
wdenk6c59edc2004-05-03 20:45:30 +00003638- similar to Bourne shell, with control structures like
3639 if...then...else...fi, for...do...done; while...do...done,
3640 until...do...done, ...
3641- supports environment ("global") variables (through setenv / saveenv
3642 commands) and local shell variables (through standard shell syntax
3643 "name=value"); only environment variables can be used with "run"
3644 command
wdenkf4688a22003-05-28 08:06:31 +00003645
wdenk6c59edc2004-05-03 20:45:30 +00003646General rules:
3647--------------
wdenkf4688a22003-05-28 08:06:31 +00003648
wdenk6c59edc2004-05-03 20:45:30 +00003649(1) If a command line (or an environment variable executed by a "run"
3650 command) contains several commands separated by semicolon, and
3651 one of these commands fails, then the remaining commands will be
3652 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003653
wdenk6c59edc2004-05-03 20:45:30 +00003654(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003655 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003656 command will cause "run" to terminate, i. e. the remaining
3657 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003658
wdenk6c59edc2004-05-03 20:45:30 +00003659Note for Redundant Ethernet Interfaces:
3660=======================================
wdenkf4688a22003-05-28 08:06:31 +00003661
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003662Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003663such configurations and is capable of automatic selection of a
3664"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003665
wdenk6c59edc2004-05-03 20:45:30 +00003666Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3667MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3668"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003669
wdenk6c59edc2004-05-03 20:45:30 +00003670If the network interface stores some valid MAC address (for instance
3671in SROM), this is used as default address if there is NO correspon-
3672ding setting in the environment; if the corresponding environment
3673variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003674
wdenk6c59edc2004-05-03 20:45:30 +00003675o If the SROM has a valid MAC address, and there is no address in the
3676 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk6c59edc2004-05-03 20:45:30 +00003678o If there is no valid address in the SROM, and a definition in the
3679 environment exists, then the value from the environment variable is
3680 used.
wdenkc6097192002-11-03 00:24:07 +00003681
wdenk6c59edc2004-05-03 20:45:30 +00003682o If both the SROM and the environment contain a MAC address, and
3683 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk6c59edc2004-05-03 20:45:30 +00003685o If both the SROM and the environment contain a MAC address, and the
3686 addresses differ, the value from the environment is used and a
3687 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk6c59edc2004-05-03 20:45:30 +00003689o If neither SROM nor the environment contain a MAC address, an error
3690 is raised.
wdenkc6097192002-11-03 00:24:07 +00003691
Ben Warren6db991a2010-04-26 11:11:46 -07003692If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3693will be programmed into hardware as part of the initialization process. This
3694may be skipped by setting the appropriate 'ethmacskip' environment variable.
3695The naming convention is as follows:
3696"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk6c59edc2004-05-03 20:45:30 +00003698Image Formats:
3699==============
wdenkc6097192002-11-03 00:24:07 +00003700
Marian Balakowicz18710b82008-03-12 12:13:13 +01003701U-Boot is capable of booting (and performing other auxiliary operations on)
3702images in two formats:
3703
3704New uImage format (FIT)
3705-----------------------
3706
3707Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3708to Flattened Device Tree). It allows the use of images with multiple
3709components (several kernels, ramdisks, etc.), with contents protected by
3710SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3711
3712
3713Old uImage format
3714-----------------
3715
3716Old image format is based on binary files which can be basically anything,
3717preceded by a special header; see the definitions in include/image.h for
3718details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003719
wdenk6c59edc2004-05-03 20:45:30 +00003720* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3721 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003722 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3723 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3724 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02003725* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou56fff492010-05-28 10:56:50 +08003726 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3727 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003728* Compression Type (uncompressed, gzip, bzip2)
3729* Load Address
3730* Entry Point
3731* Image Name
3732* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003733
wdenk6c59edc2004-05-03 20:45:30 +00003734The header is marked by a special Magic Number, and both the header
3735and the data portions of the image are secured against corruption by
3736CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003737
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk6c59edc2004-05-03 20:45:30 +00003739Linux Support:
3740==============
wdenkc6097192002-11-03 00:24:07 +00003741
wdenk6c59edc2004-05-03 20:45:30 +00003742Although U-Boot should support any OS or standalone application
3743easily, the main focus has always been on Linux during the design of
3744U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003745
wdenk6c59edc2004-05-03 20:45:30 +00003746U-Boot includes many features that so far have been part of some
3747special "boot loader" code within the Linux kernel. Also, any
3748"initrd" images to be used are no longer part of one big Linux image;
3749instead, kernel and "initrd" are separate images. This implementation
3750serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003751
wdenk6c59edc2004-05-03 20:45:30 +00003752- the same features can be used for other OS or standalone
3753 applications (for instance: using compressed images to reduce the
3754 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk6c59edc2004-05-03 20:45:30 +00003756- it becomes much easier to port new Linux kernel versions because
3757 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk6c59edc2004-05-03 20:45:30 +00003759- the same Linux kernel image can now be used with different "initrd"
3760 images; of course this also means that different kernel images can
3761 be run with the same "initrd". This makes testing easier (you don't
3762 have to build a new "zImage.initrd" Linux image when you just
3763 change a file in your "initrd"). Also, a field-upgrade of the
3764 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003765
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk6c59edc2004-05-03 20:45:30 +00003767Linux HOWTO:
3768============
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk6c59edc2004-05-03 20:45:30 +00003770Porting Linux to U-Boot based systems:
3771---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk6c59edc2004-05-03 20:45:30 +00003773U-Boot cannot save you from doing all the necessary modifications to
3774configure the Linux device drivers for use with your target hardware
3775(no, we don't intend to provide a full virtual machine interface to
3776Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003777
Stefan Roese88fbf932010-04-15 16:07:28 +02003778But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk6c59edc2004-05-03 20:45:30 +00003780Just make sure your machine specific header file (for instance
3781include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003782Information structure as we define in include/asm-<arch>/u-boot.h,
3783and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003784as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003785
wdenkc6097192002-11-03 00:24:07 +00003786
wdenk6c59edc2004-05-03 20:45:30 +00003787Configuring the Linux kernel:
3788-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003789
wdenk6c59edc2004-05-03 20:45:30 +00003790No specific requirements for U-Boot. Make sure you have some root
3791device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003792
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk6c59edc2004-05-03 20:45:30 +00003794Building a Linux Image:
3795-----------------------
wdenkc6097192002-11-03 00:24:07 +00003796
wdenk6c59edc2004-05-03 20:45:30 +00003797With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3798not used. If you use recent kernel source, a new build target
3799"uImage" will exist which automatically builds an image usable by
3800U-Boot. Most older kernels also have support for a "pImage" target,
3801which was introduced for our predecessor project PPCBoot and uses a
3802100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk6c59edc2004-05-03 20:45:30 +00003804Example:
wdenkc6097192002-11-03 00:24:07 +00003805
wdenk6c59edc2004-05-03 20:45:30 +00003806 make TQM850L_config
3807 make oldconfig
3808 make dep
3809 make uImage
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk6c59edc2004-05-03 20:45:30 +00003811The "uImage" build target uses a special tool (in 'tools/mkimage') to
3812encapsulate a compressed Linux kernel image with header information,
3813CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk6c59edc2004-05-03 20:45:30 +00003815* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003816
wdenk6c59edc2004-05-03 20:45:30 +00003817* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003818
wdenk6c59edc2004-05-03 20:45:30 +00003819 ${CROSS_COMPILE}-objcopy -O binary \
3820 -R .note -R .comment \
3821 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003822
wdenk6c59edc2004-05-03 20:45:30 +00003823* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003824
wdenk6c59edc2004-05-03 20:45:30 +00003825 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003826
wdenk6c59edc2004-05-03 20:45:30 +00003827* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003828
wdenk6c59edc2004-05-03 20:45:30 +00003829 mkimage -A ppc -O linux -T kernel -C gzip \
3830 -a 0 -e 0 -n "Linux Kernel Image" \
3831 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003832
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk6c59edc2004-05-03 20:45:30 +00003834The "mkimage" tool can also be used to create ramdisk images for use
3835with U-Boot, either separated from the Linux kernel image, or
3836combined into one file. "mkimage" encapsulates the images with a 64
3837byte header containing information about target architecture,
3838operating system, image type, compression method, entry points, time
3839stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk6c59edc2004-05-03 20:45:30 +00003841"mkimage" can be called in two ways: to verify existing images and
3842print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003843
wdenk6c59edc2004-05-03 20:45:30 +00003844In the first form (with "-l" option) mkimage lists the information
3845contained in the header of an existing U-Boot image; this includes
3846checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003847
wdenk6c59edc2004-05-03 20:45:30 +00003848 tools/mkimage -l image
3849 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003850
wdenk6c59edc2004-05-03 20:45:30 +00003851The second form (with "-d" option) is used to build a U-Boot image
3852from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003853
wdenk6c59edc2004-05-03 20:45:30 +00003854 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3855 -n name -d data_file image
3856 -A ==> set architecture to 'arch'
3857 -O ==> set operating system to 'os'
3858 -T ==> set image type to 'type'
3859 -C ==> set compression type 'comp'
3860 -a ==> set load address to 'addr' (hex)
3861 -e ==> set entry point to 'ep' (hex)
3862 -n ==> set image name to 'name'
3863 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003864
wdenkcd914452004-05-29 16:53:29 +00003865Right now, all Linux kernels for PowerPC systems use the same load
3866address (0x00000000), but the entry point address depends on the
3867kernel version:
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk6c59edc2004-05-03 20:45:30 +00003869- 2.2.x kernels have the entry point at 0x0000000C,
3870- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk6c59edc2004-05-03 20:45:30 +00003872So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk6c59edc2004-05-03 20:45:30 +00003874 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3875 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003876 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00003877 > examples/uImage.TQM850L
3878 Image Name: 2.4.4 kernel for TQM850L
3879 Created: Wed Jul 19 02:34:59 2000
3880 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3881 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3882 Load Address: 0x00000000
3883 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk6c59edc2004-05-03 20:45:30 +00003885To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk6c59edc2004-05-03 20:45:30 +00003887 -> tools/mkimage -l examples/uImage.TQM850L
3888 Image Name: 2.4.4 kernel for TQM850L
3889 Created: Wed Jul 19 02:34:59 2000
3890 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3891 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3892 Load Address: 0x00000000
3893 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk6c59edc2004-05-03 20:45:30 +00003895NOTE: for embedded systems where boot time is critical you can trade
3896speed for memory and install an UNCOMPRESSED image instead: this
3897needs more space in Flash, but boots much faster since it does not
3898need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003899
Stefan Roese88fbf932010-04-15 16:07:28 +02003900 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00003901 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3902 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02003903 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00003904 > examples/uImage.TQM850L-uncompressed
3905 Image Name: 2.4.4 kernel for TQM850L
3906 Created: Wed Jul 19 02:34:59 2000
3907 Image Type: PowerPC Linux Kernel Image (uncompressed)
3908 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3909 Load Address: 0x00000000
3910 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003911
wdenkc6097192002-11-03 00:24:07 +00003912
wdenk6c59edc2004-05-03 20:45:30 +00003913Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3914when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003915
wdenk6c59edc2004-05-03 20:45:30 +00003916 -> tools/mkimage -n 'Simple Ramdisk Image' \
3917 > -A ppc -O linux -T ramdisk -C gzip \
3918 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3919 Image Name: Simple Ramdisk Image
3920 Created: Wed Jan 12 14:01:50 2000
3921 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3922 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3923 Load Address: 0x00000000
3924 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003925
wdenkc6097192002-11-03 00:24:07 +00003926
wdenk6c59edc2004-05-03 20:45:30 +00003927Installing a Linux Image:
3928-------------------------
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk6c59edc2004-05-03 20:45:30 +00003930To downloading a U-Boot image over the serial (console) interface,
3931you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk6c59edc2004-05-03 20:45:30 +00003933 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk6c59edc2004-05-03 20:45:30 +00003935The 'objcopy' does not understand the information in the U-Boot
3936image header, so the resulting S-Record file will be relative to
3937address 0x00000000. To load it to a given address, you need to
3938specify the target address as 'offset' parameter with the 'loads'
3939command.
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk6c59edc2004-05-03 20:45:30 +00003941Example: install the image to address 0x40100000 (which on the
3942TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003945
wdenk6c59edc2004-05-03 20:45:30 +00003946 .......... done
3947 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003948
wdenk6c59edc2004-05-03 20:45:30 +00003949 => loads 40100000
3950 ## Ready for S-Record download ...
3951 ~>examples/image.srec
3952 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3953 ...
3954 15989 15990 15991 15992
3955 [file transfer complete]
3956 [connected]
3957 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003958
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk6c59edc2004-05-03 20:45:30 +00003960You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003961this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003962corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003963
wdenk6c59edc2004-05-03 20:45:30 +00003964 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk6c59edc2004-05-03 20:45:30 +00003966 ## Checking Image at 40100000 ...
3967 Image Name: 2.2.13 for initrd on TQM850L
3968 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3969 Data Size: 335725 Bytes = 327 kB = 0 MB
3970 Load Address: 00000000
3971 Entry Point: 0000000c
3972 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003973
3974
wdenk6c59edc2004-05-03 20:45:30 +00003975Boot Linux:
3976-----------
wdenkc6097192002-11-03 00:24:07 +00003977
wdenk6c59edc2004-05-03 20:45:30 +00003978The "bootm" command is used to boot an application that is stored in
3979memory (RAM or Flash). In case of a Linux kernel image, the contents
3980of the "bootargs" environment variable is passed to the kernel as
3981parameters. You can check and modify this variable using the
3982"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003983
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk6c59edc2004-05-03 20:45:30 +00003985 => printenv bootargs
3986 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk6c59edc2004-05-03 20:45:30 +00003988 => 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 +00003989
wdenk6c59edc2004-05-03 20:45:30 +00003990 => printenv bootargs
3991 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 +00003992
wdenk6c59edc2004-05-03 20:45:30 +00003993 => bootm 40020000
3994 ## Booting Linux kernel at 40020000 ...
3995 Image Name: 2.2.13 for NFS on TQM850L
3996 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3997 Data Size: 381681 Bytes = 372 kB = 0 MB
3998 Load Address: 00000000
3999 Entry Point: 0000000c
4000 Verifying Checksum ... OK
4001 Uncompressing Kernel Image ... OK
4002 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
4003 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4004 time_init: decrementer frequency = 187500000/60
4005 Calibrating delay loop... 49.77 BogoMIPS
4006 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4007 ...
wdenkc6097192002-11-03 00:24:07 +00004008
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004009If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004010the memory addresses of both the kernel and the initrd image (PPBCOOT
4011format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk6c59edc2004-05-03 20:45:30 +00004013 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004014
wdenk6c59edc2004-05-03 20:45:30 +00004015 ## Checking Image at 40100000 ...
4016 Image Name: 2.2.13 for initrd on TQM850L
4017 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4018 Data Size: 335725 Bytes = 327 kB = 0 MB
4019 Load Address: 00000000
4020 Entry Point: 0000000c
4021 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk6c59edc2004-05-03 20:45:30 +00004023 ## Checking Image at 40200000 ...
4024 Image Name: Simple Ramdisk Image
4025 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4026 Data Size: 566530 Bytes = 553 kB = 0 MB
4027 Load Address: 00000000
4028 Entry Point: 00000000
4029 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004030
wdenk6c59edc2004-05-03 20:45:30 +00004031 => bootm 40100000 40200000
4032 ## Booting Linux kernel at 40100000 ...
4033 Image Name: 2.2.13 for initrd on TQM850L
4034 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4035 Data Size: 335725 Bytes = 327 kB = 0 MB
4036 Load Address: 00000000
4037 Entry Point: 0000000c
4038 Verifying Checksum ... OK
4039 Uncompressing Kernel Image ... OK
4040 ## Loading RAMDisk Image at 40200000 ...
4041 Image Name: Simple Ramdisk Image
4042 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4043 Data Size: 566530 Bytes = 553 kB = 0 MB
4044 Load Address: 00000000
4045 Entry Point: 00000000
4046 Verifying Checksum ... OK
4047 Loading Ramdisk ... OK
4048 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
4049 Boot arguments: root=/dev/ram
4050 time_init: decrementer frequency = 187500000/60
4051 Calibrating delay loop... 49.77 BogoMIPS
4052 ...
4053 RAMDISK: Compressed image found at block 0
4054 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004055
wdenk6c59edc2004-05-03 20:45:30 +00004056 bash#
wdenkc6097192002-11-03 00:24:07 +00004057
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004058Boot Linux and pass a flat device tree:
4059-----------
4060
4061First, U-Boot must be compiled with the appropriate defines. See the section
4062titled "Linux Kernel Interface" above for a more in depth explanation. The
4063following is an example of how to start a kernel and pass an updated
4064flat device tree:
4065
4066=> print oftaddr
4067oftaddr=0x300000
4068=> print oft
4069oft=oftrees/mpc8540ads.dtb
4070=> tftp $oftaddr $oft
4071Speed: 1000, full duplex
4072Using TSEC0 device
4073TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4074Filename 'oftrees/mpc8540ads.dtb'.
4075Load address: 0x300000
4076Loading: #
4077done
4078Bytes transferred = 4106 (100a hex)
4079=> tftp $loadaddr $bootfile
4080Speed: 1000, full duplex
4081Using TSEC0 device
4082TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4083Filename 'uImage'.
4084Load address: 0x200000
4085Loading:############
4086done
4087Bytes transferred = 1029407 (fb51f hex)
4088=> print loadaddr
4089loadaddr=200000
4090=> print oftaddr
4091oftaddr=0x300000
4092=> bootm $loadaddr - $oftaddr
4093## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004094 Image Name: Linux-2.6.17-dirty
4095 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4096 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004097 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004098 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004099 Verifying Checksum ... OK
4100 Uncompressing Kernel Image ... OK
4101Booting using flat device tree at 0x300000
4102Using MPC85xx ADS machine description
4103Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4104[snip]
4105
4106
wdenk6c59edc2004-05-03 20:45:30 +00004107More About U-Boot Image Types:
4108------------------------------
wdenkc6097192002-11-03 00:24:07 +00004109
wdenk6c59edc2004-05-03 20:45:30 +00004110U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004111
wdenk6c59edc2004-05-03 20:45:30 +00004112 "Standalone Programs" are directly runnable in the environment
4113 provided by U-Boot; it is expected that (if they behave
4114 well) you can continue to work in U-Boot after return from
4115 the Standalone Program.
4116 "OS Kernel Images" are usually images of some Embedded OS which
4117 will take over control completely. Usually these programs
4118 will install their own set of exception handlers, device
4119 drivers, set up the MMU, etc. - this means, that you cannot
4120 expect to re-enter U-Boot except by resetting the CPU.
4121 "RAMDisk Images" are more or less just data blocks, and their
4122 parameters (address, size) are passed to an OS kernel that is
4123 being started.
4124 "Multi-File Images" contain several images, typically an OS
4125 (Linux) kernel image and one or more data images like
4126 RAMDisks. This construct is useful for instance when you want
4127 to boot over the network using BOOTP etc., where the boot
4128 server provides just a single image file, but you want to get
4129 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk6c59edc2004-05-03 20:45:30 +00004131 "Multi-File Images" start with a list of image sizes, each
4132 image size (in bytes) specified by an "uint32_t" in network
4133 byte order. This list is terminated by an "(uint32_t)0".
4134 Immediately after the terminating 0 follow the images, one by
4135 one, all aligned on "uint32_t" boundaries (size rounded up to
4136 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138 "Firmware Images" are binary images containing firmware (like
4139 U-Boot or FPGA images) which usually will be programmed to
4140 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004141
wdenk6c59edc2004-05-03 20:45:30 +00004142 "Script files" are command sequences that will be executed by
4143 U-Boot's command interpreter; this feature is especially
4144 useful when you configure U-Boot to use a real shell (hush)
4145 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004146
stroeseb9c17c52003-04-04 15:53:41 +00004147
wdenk6c59edc2004-05-03 20:45:30 +00004148Standalone HOWTO:
4149=================
stroeseb9c17c52003-04-04 15:53:41 +00004150
wdenk6c59edc2004-05-03 20:45:30 +00004151One of the features of U-Boot is that you can dynamically load and
4152run "standalone" applications, which can use some resources of
4153U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004154
wdenk6c59edc2004-05-03 20:45:30 +00004155Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004156
wdenk6c59edc2004-05-03 20:45:30 +00004157"Hello World" Demo:
4158-------------------
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk6c59edc2004-05-03 20:45:30 +00004160'examples/hello_world.c' contains a small "Hello World" Demo
4161application; it is automatically compiled when you build U-Boot.
4162It's configured to run at address 0x00040004, so you can play with it
4163like that:
wdenkc6097192002-11-03 00:24:07 +00004164
wdenk6c59edc2004-05-03 20:45:30 +00004165 => loads
4166 ## Ready for S-Record download ...
4167 ~>examples/hello_world.srec
4168 1 2 3 4 5 6 7 8 9 10 11 ...
4169 [file transfer complete]
4170 [connected]
4171 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004172
wdenk6c59edc2004-05-03 20:45:30 +00004173 => go 40004 Hello World! This is a test.
4174 ## Starting application at 0x00040004 ...
4175 Hello World
4176 argc = 7
4177 argv[0] = "40004"
4178 argv[1] = "Hello"
4179 argv[2] = "World!"
4180 argv[3] = "This"
4181 argv[4] = "is"
4182 argv[5] = "a"
4183 argv[6] = "test."
4184 argv[7] = "<NULL>"
4185 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk6c59edc2004-05-03 20:45:30 +00004187 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk6c59edc2004-05-03 20:45:30 +00004189Another example, which demonstrates how to register a CPM interrupt
4190handler with the U-Boot code, can be found in 'examples/timer.c'.
4191Here, a CPM timer is set up to generate an interrupt every second.
4192The interrupt service routine is trivial, just printing a '.'
4193character, but this is just a demo program. The application can be
4194controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004195
wdenk6c59edc2004-05-03 20:45:30 +00004196 ? - print current values og the CPM Timer registers
4197 b - enable interrupts and start timer
4198 e - stop timer and disable interrupts
4199 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk6c59edc2004-05-03 20:45:30 +00004201 => loads
4202 ## Ready for S-Record download ...
4203 ~>examples/timer.srec
4204 1 2 3 4 5 6 7 8 9 10 11 ...
4205 [file transfer complete]
4206 [connected]
4207 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk6c59edc2004-05-03 20:45:30 +00004209 => go 40004
4210 ## Starting application at 0x00040004 ...
4211 TIMERS=0xfff00980
4212 Using timer 1
4213 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004214
wdenk6c59edc2004-05-03 20:45:30 +00004215Hit 'b':
4216 [q, b, e, ?] Set interval 1000000 us
4217 Enabling timer
4218Hit '?':
4219 [q, b, e, ?] ........
4220 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4221Hit '?':
4222 [q, b, e, ?] .
4223 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4224Hit '?':
4225 [q, b, e, ?] .
4226 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4227Hit '?':
4228 [q, b, e, ?] .
4229 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4230Hit 'e':
4231 [q, b, e, ?] ...Stopping timer
4232Hit 'q':
4233 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004234
wdenkc6097192002-11-03 00:24:07 +00004235
wdenk6c59edc2004-05-03 20:45:30 +00004236Minicom warning:
4237================
wdenkc6097192002-11-03 00:24:07 +00004238
wdenk6c59edc2004-05-03 20:45:30 +00004239Over time, many people have reported problems when trying to use the
4240"minicom" terminal emulation program for serial download. I (wd)
4241consider minicom to be broken, and recommend not to use it. Under
4242Unix, I recommend to use C-Kermit for general purpose use (and
4243especially for kermit binary protocol download ("loadb" command), and
4244use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246Nevertheless, if you absolutely want to use it try adding this
4247configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk6c59edc2004-05-03 20:45:30 +00004249 Name Program Name U/D FullScr IO-Red. Multi
4250 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4251 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004252
wdenk8dba0502003-03-31 16:34:49 +00004253
wdenk6c59edc2004-05-03 20:45:30 +00004254NetBSD Notes:
4255=============
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk6c59edc2004-05-03 20:45:30 +00004257Starting at version 0.9.2, U-Boot supports NetBSD both as host
4258(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004259
wdenk6c59edc2004-05-03 20:45:30 +00004260Building requires a cross environment; it is known to work on
4261NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4262need gmake since the Makefiles are not compatible with BSD make).
4263Note that the cross-powerpc package does not install include files;
4264attempting to build U-Boot will fail because <machine/ansi.h> is
4265missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004266
wdenk6c59edc2004-05-03 20:45:30 +00004267 # cd /usr/pkg/cross/powerpc-netbsd/include
4268 # mkdir powerpc
4269 # ln -s powerpc machine
4270 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4271 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004272
wdenk6c59edc2004-05-03 20:45:30 +00004273Native builds *don't* work due to incompatibilities between native
4274and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk6c59edc2004-05-03 20:45:30 +00004276Booting assumes that (the first part of) the image booted is a
4277stage-2 loader which in turn loads and then invokes the kernel
4278proper. Loader sources will eventually appear in the NetBSD source
4279tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004280meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004281
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk6c59edc2004-05-03 20:45:30 +00004283Implementation Internals:
4284=========================
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk6c59edc2004-05-03 20:45:30 +00004286The following is not intended to be a complete description of every
4287implementation detail. However, it should help to understand the
4288inner workings of U-Boot and make it easier to port it to custom
4289hardware.
wdenkc6097192002-11-03 00:24:07 +00004290
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk6c59edc2004-05-03 20:45:30 +00004292Initial Stack, Global Data:
4293---------------------------
wdenkc6097192002-11-03 00:24:07 +00004294
wdenk6c59edc2004-05-03 20:45:30 +00004295The implementation of U-Boot is complicated by the fact that U-Boot
4296starts running out of ROM (flash memory), usually without access to
4297system RAM (because the memory controller is not initialized yet).
4298This means that we don't have writable Data or BSS segments, and BSS
4299is not initialized as zero. To be able to get a C environment working
4300at all, we have to allocate at least a minimal stack. Implementation
4301options for this are defined and restricted by the CPU used: Some CPU
4302models provide on-chip memory (like the IMMR area on MPC8xx and
4303MPC826x processors), on others (parts of) the data cache can be
4304locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004305
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004306 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004307 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00004308
wdenk6c59edc2004-05-03 20:45:30 +00004309 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4310 From: "Chris Hallinan" <clh@net1plus.com>
4311 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4312 ...
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk6c59edc2004-05-03 20:45:30 +00004314 Correct me if I'm wrong, folks, but the way I understand it
4315 is this: Using DCACHE as initial RAM for Stack, etc, does not
4316 require any physical RAM backing up the cache. The cleverness
4317 is that the cache is being used as a temporary supply of
4318 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004319 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00004320 can see how this works by studying the cache architecture and
4321 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00004322
wdenk6c59edc2004-05-03 20:45:30 +00004323 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4324 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004325 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00004326 option should work for you. Using CS 4 should be fine if your
4327 board designers haven't used it for something that would
4328 cause you grief during the initial boot! It is frequently not
4329 used.
wdenkc6097192002-11-03 00:24:07 +00004330
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004331 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00004332 with your processor/board/system design. The default value
4333 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02004334 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00004335 than your SDRAM module. If you have a 64MB SDRAM module, set
4336 it above 400_0000. Just make sure your board has no resources
4337 that are supposed to respond to that address! That code in
4338 start.S has been around a while and should work as is when
4339 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00004340
wdenk6c59edc2004-05-03 20:45:30 +00004341 -Chris Hallinan
4342 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00004343
wdenk6c59edc2004-05-03 20:45:30 +00004344It is essential to remember this, since it has some impact on the C
4345code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00004346
wdenk6c59edc2004-05-03 20:45:30 +00004347* Initialized global data (data segment) is read-only. Do not attempt
4348 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00004349
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004350* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00004351 as zero data - BSS segment) at all - this is undefined, initiali-
4352 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00004353
wdenk6c59edc2004-05-03 20:45:30 +00004354* Stack space is very limited. Avoid big data buffers or things like
4355 that.
wdenk4a5c8a72003-03-06 00:02:04 +00004356
wdenk6c59edc2004-05-03 20:45:30 +00004357Having only the stack as writable memory limits means we cannot use
4358normal global data to share information beween the code. But it
4359turned out that the implementation of U-Boot can be greatly
4360simplified by making a global data structure (gd_t) available to all
4361functions. We could pass a pointer to this data as argument to _all_
4362functions, but this would bloat the code. Instead we use a feature of
4363the GCC compiler (Global Register Variables) to share the data: we
4364place a pointer (gd) to the global data into a register which we
4365reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367When choosing a register for such a purpose we are restricted by the
4368relevant (E)ABI specifications for the current architecture, and by
4369GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004370
wdenk6c59edc2004-05-03 20:45:30 +00004371For PowerPC, the following registers have specific use:
4372 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01004373 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00004374 R3-R4: parameter passing and return values
4375 R5-R10: parameter passing
4376 R13: small data area pointer
4377 R30: GOT pointer
4378 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004379
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01004380 (U-Boot also uses R12 as internal GOT pointer. r12
4381 is a volatile register so r12 needs to be reset when
4382 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004383
Wolfgang Denk69c09642008-02-14 22:43:22 +01004384 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk6c59edc2004-05-03 20:45:30 +00004386 Note: on PPC, we could use a static initializer (since the
4387 address of the global data structure is known at compile time),
4388 but it turned out that reserving a register results in somewhat
4389 smaller code - although the code savings are not that big (on
4390 average for all boards 752 bytes for the whole U-Boot image,
4391 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004392
Robin Getz2773d5f2009-08-17 15:23:02 +00004393On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05004394 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4395
Robin Getz2773d5f2009-08-17 15:23:02 +00004396 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05004397
wdenk6c59edc2004-05-03 20:45:30 +00004398On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk6c59edc2004-05-03 20:45:30 +00004400 R0: function argument word/integer result
4401 R1-R3: function argument word
4402 R9: GOT pointer
4403 R10: stack limit (used only if stack checking if enabled)
4404 R11: argument (frame) pointer
4405 R12: temporary workspace
4406 R13: stack pointer
4407 R14: link register
4408 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk6c59edc2004-05-03 20:45:30 +00004410 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004411
Thomas Chou8fa38582010-05-21 11:08:03 +08004412On Nios II, the ABI is documented here:
4413 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4414
4415 ==> U-Boot will use gp to hold a pointer to the global data
4416
4417 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4418 to access small data sections, so gp is free.
4419
Wolfgang Denk6405a152006-03-31 18:32:53 +02004420NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4421or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004422
wdenk6c59edc2004-05-03 20:45:30 +00004423Memory Management:
4424------------------
wdenkc6097192002-11-03 00:24:07 +00004425
wdenk6c59edc2004-05-03 20:45:30 +00004426U-Boot runs in system state and uses physical addresses, i.e. the
4427MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk6c59edc2004-05-03 20:45:30 +00004429The available memory is mapped to fixed addresses using the memory
4430controller. In this process, a contiguous block is formed for each
4431memory type (Flash, SDRAM, SRAM), even when it consists of several
4432physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk6c59edc2004-05-03 20:45:30 +00004434U-Boot is installed in the first 128 kB of the first Flash bank (on
4435TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4436booting and sizing and initializing DRAM, the code relocates itself
4437to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004438memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00004439configuration setting]. Below that, a structure with global Board
4440Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk6c59edc2004-05-03 20:45:30 +00004442Additionally, some exception handler code is copied to the low 8 kB
4443of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk6c59edc2004-05-03 20:45:30 +00004445So a typical memory configuration with 16 MB of DRAM could look like
4446this:
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448 0x0000 0000 Exception Vector code
4449 :
4450 0x0000 1FFF
4451 0x0000 2000 Free for Application Use
4452 :
4453 :
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk6c59edc2004-05-03 20:45:30 +00004455 :
4456 :
4457 0x00FB FF20 Monitor Stack (Growing downward)
4458 0x00FB FFAC Board Info Data and permanent copy of global data
4459 0x00FC 0000 Malloc Arena
4460 :
4461 0x00FD FFFF
4462 0x00FE 0000 RAM Copy of Monitor Code
4463 ... eventually: LCD or video framebuffer
4464 ... eventually: pRAM (Protected RAM - unchanged by reset)
4465 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004466
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk6c59edc2004-05-03 20:45:30 +00004468System Initialization:
4469----------------------
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk6c59edc2004-05-03 20:45:30 +00004471In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004472(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00004473configuration for CS0# this is a mirror of the onboard Flash memory.
4474To be able to re-map memory U-Boot then jumps to its link address.
4475To be able to implement the initialization code in C, a (small!)
4476initial stack is set up in the internal Dual Ported RAM (in case CPUs
4477which provide such a feature like MPC8xx or MPC8260), or in a locked
4478part of the data cache. After that, U-Boot initializes the CPU core,
4479the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk6c59edc2004-05-03 20:45:30 +00004481Next, all (potentially) available memory banks are mapped using a
4482preliminary mapping. For example, we put them on 512 MB boundaries
4483(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4484on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4485programmed for SDRAM access. Using the temporary configuration, a
4486simple memory test is run that determines the size of the SDRAM
4487banks.
wdenkc6097192002-11-03 00:24:07 +00004488
wdenk6c59edc2004-05-03 20:45:30 +00004489When there is more than one SDRAM bank, and the banks are of
4490different size, the largest is mapped first. For equal size, the first
4491bank (CS2#) is mapped first. The first mapping is always for address
44920x00000000, with any additional banks following immediately to create
4493contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004494
wdenk6c59edc2004-05-03 20:45:30 +00004495Then, the monitor installs itself at the upper end of the SDRAM area
4496and allocates memory for use by malloc() and for the global Board
4497Info data; also, the exception vector code is copied to the low RAM
4498pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004499
wdenk6c59edc2004-05-03 20:45:30 +00004500Only after this relocation will you have a "normal" C environment;
4501until that you are restricted in several ways, mostly because you are
4502running from ROM, and because the code will have to be relocated to a
4503new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004504
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk6c59edc2004-05-03 20:45:30 +00004506U-Boot Porting Guide:
4507----------------------
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4510list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004511
wdenkc6097192002-11-03 00:24:07 +00004512
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004513int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004514{
4515 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004516
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004517 signal(SIGALRM, no_more_time);
4518 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk6c59edc2004-05-03 20:45:30 +00004520 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004521 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004522 return 0;
4523 }
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004526
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004527 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004528
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004529 if (clueless)
4530 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk6c59edc2004-05-03 20:45:30 +00004532 while (learning) {
4533 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004534 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4535 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00004536 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004537 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004538 }
wdenkc6097192002-11-03 00:24:07 +00004539
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004540 if (available_money > toLocalCurrency ($2500))
4541 Buy a BDI3000;
4542 else
wdenk6c59edc2004-05-03 20:45:30 +00004543 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004544
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004545 if (a similar board exists) { /* hopefully... */
4546 cp -a board/<similar> board/<myboard>
4547 cp include/configs/<similar>.h include/configs/<myboard>.h
4548 } else {
4549 Create your own board support subdirectory;
4550 Create your own board include/configs/<myboard>.h file;
4551 }
4552 Edit new board/<myboard> files
4553 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004554
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004555 while (!accepted) {
4556 while (!running) {
4557 do {
4558 Add / modify source code;
4559 } until (compiles);
4560 Debug;
4561 if (clueless)
4562 email("Hi, I am having problems...");
4563 }
4564 Send patch file to the U-Boot email list;
4565 if (reasonable critiques)
4566 Incorporate improvements from email list code review;
4567 else
4568 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004569 }
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk6c59edc2004-05-03 20:45:30 +00004571 return 0;
4572}
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk6c59edc2004-05-03 20:45:30 +00004574void no_more_time (int sig)
4575{
4576 hire_a_guru();
4577}
wdenkc6097192002-11-03 00:24:07 +00004578
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk6c59edc2004-05-03 20:45:30 +00004580Coding Standards:
4581-----------------
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk6c59edc2004-05-03 20:45:30 +00004583All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02004584coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004585"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02004586
4587Source files originating from a different project (for example the
4588MTD subsystem) are generally exempt from these guidelines and are not
4589reformated to ease subsequent migration to newer versions of those
4590sources.
wdenkc6097192002-11-03 00:24:07 +00004591
Detlev Zundelaa63d482006-09-01 15:39:02 +02004592Please note that U-Boot is implemented in C (and to some small parts in
4593Assembler); no C++ is used, so please do not use C++ style comments (//)
4594in your code.
wdenkad276f22004-01-04 16:28:35 +00004595
wdenk6c59edc2004-05-03 20:45:30 +00004596Please also stick to the following formatting rules:
4597- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004598- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00004599- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004600- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00004601- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004602
wdenk6c59edc2004-05-03 20:45:30 +00004603Submissions which do not conform to the standards may be returned
4604with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004605
wdenkc6097192002-11-03 00:24:07 +00004606
wdenk6c59edc2004-05-03 20:45:30 +00004607Submitting Patches:
4608-------------------
wdenkc6097192002-11-03 00:24:07 +00004609
wdenk6c59edc2004-05-03 20:45:30 +00004610Since the number of patches for U-Boot is growing, we need to
4611establish some rules. Submissions which do not conform to these rules
4612may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004613
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004614Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004615
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004616Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4617see http://lists.denx.de/mailman/listinfo/u-boot
4618
wdenk6c59edc2004-05-03 20:45:30 +00004619When you send a patch, please include the following information with
4620it:
wdenkc6097192002-11-03 00:24:07 +00004621
wdenk6c59edc2004-05-03 20:45:30 +00004622* For bug fixes: a description of the bug and how your patch fixes
4623 this bug. Please try to include a way of demonstrating that the
4624 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004625
wdenk6c59edc2004-05-03 20:45:30 +00004626* For new features: a description of the feature and your
4627 implementation.
wdenkc6097192002-11-03 00:24:07 +00004628
wdenk6c59edc2004-05-03 20:45:30 +00004629* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk6c59edc2004-05-03 20:45:30 +00004631* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk6c59edc2004-05-03 20:45:30 +00004633* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004634 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk6c59edc2004-05-03 20:45:30 +00004636* If your patch adds new configuration options, don't forget to
4637 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004638
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004639* The patch itself. If you are using git (which is *strongly*
4640 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00004641 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004642 the U-Boot mailing list, you will avoid most of the common problems
4643 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004644
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004645 If you cannot use git, use "diff -purN OLD NEW". If your version of
4646 diff does not support these options, then get the latest version of
4647 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004648
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004649 The current directory when running this command shall be the parent
4650 directory of the U-Boot source tree (i. e. please make sure that
4651 your patch includes sufficient directory information for the
4652 affected files).
4653
4654 We prefer patches as plain text. MIME attachments are discouraged,
4655 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657* If one logical set of modifications affects or creates several
4658 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004659
wdenk6c59edc2004-05-03 20:45:30 +00004660* Changesets that contain different, unrelated modifications shall be
4661 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004662
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk6c59edc2004-05-03 20:45:30 +00004664Notes:
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666* Before sending the patch, run the MAKEALL script on your patched
4667 source tree and make sure that no errors or warnings are reported
4668 for any of the boards.
4669
4670* Keep your modifications to the necessary minimum: A patch
4671 containing several unrelated changes or arbitrary reformats will be
4672 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674* If you modify existing code, make sure that your new code does not
4675 add to the memory footprint of the code ;-) Small is beautiful!
4676 When adding new features, these should compile conditionally only
4677 (using #ifdef), and the resulting code with the new feature
4678 disabled must not need more memory than the old code without your
4679 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004680
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004681* Remember that there is a size limit of 100 kB per message on the
4682 u-boot mailing list. Bigger patches will be moderated. If they are
4683 reasonable and not too big, they will be acknowledged. But patches
4684 bigger than the size limit should be avoided.