blob: 094869c10651ebdc4f7f27ba8b9c2b87ce08d33c [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00002# (C) Copyright 2000 - 2011
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
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
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /nds32 Files generic to NDS32 architecture
187 /cpu CPU specific files
188 /n1213 Files specific to Andes Technology N1213 CPUs
189 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /cpu CPU specific files
195 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
196 /mpc5xx Files specific to Freescale MPC5xx CPUs
197 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
198 /mpc8xx Files specific to Freescale MPC8xx CPUs
199 /mpc8220 Files specific to Freescale MPC8220 CPUs
200 /mpc824x Files specific to Freescale MPC824x CPUs
201 /mpc8260 Files specific to Freescale MPC8260 CPUs
202 /mpc85xx Files specific to Freescale MPC85xx CPUs
203 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
204 /lib Architecture specific library files
205 /sh Files generic to SH architecture
206 /cpu CPU specific files
207 /sh2 Files specific to sh2 CPUs
208 /sh3 Files specific to sh3 CPUs
209 /sh4 Files specific to sh4 CPUs
210 /lib Architecture specific library files
211 /sparc Files generic to SPARC architecture
212 /cpu CPU specific files
213 /leon2 Files specific to Gaisler LEON2 SPARC CPU
214 /leon3 Files specific to Gaisler LEON3 SPARC CPU
215 /lib Architecture specific library files
216/api Machine/arch independent API for external apps
217/board Board dependent files
218/common Misc architecture independent functions
219/disk Code for disk drive partition handling
220/doc Documentation (don't expect too much)
221/drivers Commonly used device drivers
222/examples Example code for standalone applications, etc.
223/fs Filesystem code (cramfs, ext2, jffs2, etc.)
224/include Header Files
225/lib Files generic to all architectures
226 /libfdt Library files to support flattened device trees
227 /lzma Library files to support LZMA decompression
228 /lzo Library files to support LZO decompression
229/net Networking code
230/post Power On Self Test
231/rtc Real Time Clock drivers
232/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software Configuration:
235=======================
236
237Configuration is usually done using C preprocessor defines; the
238rationale behind that is to avoid dead code whenever possible.
239
240There are two classes of configuration variables:
241
242* Configuration _OPTIONS_:
243 These are selectable by the user and have names beginning with
244 "CONFIG_".
245
246* Configuration _SETTINGS_:
247 These depend on the hardware etc. and should not be meddled with if
248 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
251Later we will add a configuration tool - probably similar to or even
252identical to what's used for the Linux kernel. Right now, we have to
253do the configuration by hand, which means creating some symbolic
254links and editing some configuration files. We use the TQM8xxL boards
255as an example here.
256
257
258Selection of Processor Architecture and Board Type:
259---------------------------------------------------
260
261For all supported boards there are ready-to-use default
262configurations available; just type "make <board_name>_config".
263
264Example: For a TQM823L module type:
265
266 cd u-boot
267 make TQM823L_config
268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.g. "make cogent_mpc8xx_config". And also configure the cogent
271directory according to the instructions in cogent/README.
272
273
274Configuration Options:
275----------------------
276
277Configuration depends on the combination of board and CPU type; all
278such information is kept in a configuration file
279"include/configs/<board_name>.h".
280
281Example: For a TQM823L module, all configuration settings are in
282"include/configs/TQM823L.h".
283
284
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many of the options are named exactly as the corresponding Linux
286kernel configuration options. The intention is to make it easier to
287build a config tool - later.
288
289
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
299- CPU Module Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA286_60_OLD
302--- FIXME --- not tested yet:
303 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306- Motherboard Type: (if CONFIG_COGENT is defined)
307 Define exactly one of
308 CONFIG_CMA101, CONFIG_CMA102
309
310- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311 Define one or more of
312 CONFIG_CMA302
313
314- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315 Define one or more of
316 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 85xx CPU Options:
366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100377- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200378 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100379
380 Defines the Monahans run mode to oscillator
381 ratio. Valid values are 8, 16, 24, 31. The core
382 frequency is this value multiplied by 13 MHz.
383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200384 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200385
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100386 Defines the Monahans turbo mode to oscillator
387 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200388 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100389 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200390
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200391- MIPS CPU options:
392 CONFIG_SYS_INIT_SP_OFFSET
393
394 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
395 pointer. This is needed for the temporary stack before
396 relocation.
397
398 CONFIG_SYS_MIPS_CACHE_MODE
399
400 Cache operation mode for the MIPS CPU.
401 See also arch/mips/include/asm/mipsregs.h.
402 Possible values are:
403 CONF_CM_CACHABLE_NO_WA
404 CONF_CM_CACHABLE_WA
405 CONF_CM_UNCACHED
406 CONF_CM_CACHABLE_NONCOHERENT
407 CONF_CM_CACHABLE_CE
408 CONF_CM_CACHABLE_COW
409 CONF_CM_CACHABLE_CUW
410 CONF_CM_CACHABLE_ACCELERATED
411
412 CONFIG_SYS_XWAY_EBU_BOOTCFG
413
414 Special option for Lantiq XWAY SoCs for booting from NOR flash.
415 See also arch/mips/cpu/mips32/start.S.
416
417 CONFIG_XWAY_SWAP_BYTES
418
419 Enable compilation of tools/xway-swap-bytes needed for Lantiq
420 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
421 be swapped if a flash programmer is used.
422
wdenk5da627a2003-10-09 20:09:04 +0000423- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000424 CONFIG_CLOCKS_IN_MHZ
425
426 U-Boot stores all clock information in Hz
427 internally. For binary compatibility with older Linux
428 kernels (which expect the clocks passed in the
429 bd_info data to be in MHz) the environment variable
430 "clocks_in_mhz" can be defined so that U-Boot
431 converts clock data to MHZ before passing it to the
432 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000433 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100434 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000435 default environment.
436
wdenk5da627a2003-10-09 20:09:04 +0000437 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
438
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200439 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000440 expect it to be in bytes, others in MB.
441 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
442
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400443 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200444
445 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400446 passed using flattened device trees (based on open firmware
447 concepts).
448
449 CONFIG_OF_LIBFDT
450 * New libfdt-based support
451 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500452 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400453
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200454 OF_CPU - The proper name of the cpus node (only required for
455 MPC512X and MPC5xxx based boards).
456 OF_SOC - The proper name of the soc node (only required for
457 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200458 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600459 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200460
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200461 boards with QUICC Engines require OF_QE to set UCC MAC
462 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500463
Kumar Gala4e253132006-01-11 13:54:17 -0600464 CONFIG_OF_BOARD_SETUP
465
466 Board code has addition modification that it wants to make
467 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000468
Matthew McClintock02677682006-06-28 10:41:37 -0500469 CONFIG_OF_BOOT_CPU
470
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200471 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500472 param header, the default value is zero if undefined.
473
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200474 CONFIG_OF_IDE_FIXUP
475
476 U-Boot can detect if an IDE device is present or not.
477 If not, and this new config option is activated, U-Boot
478 removes the ATA node from the DTS before booting Linux,
479 so the Linux IDE driver does not probe the device and
480 crash. This is needed for buggy hardware (uc101) where
481 no pull down resistor is connected to the signal IDE5V_DD7.
482
Igor Grinberg7eb29392011-07-14 05:45:07 +0000483 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
484
485 This setting is mandatory for all boards that have only one
486 machine type and must be used to specify the machine type
487 number as it appears in the ARM machine registry
488 (see http://www.arm.linux.org.uk/developer/machines/).
489 Only boards that have multiple machine types supported
490 in a single configuration file and the machine type is
491 runtime discoverable, do not have to use this setting.
492
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100493- vxWorks boot parameters:
494
495 bootvx constructs a valid bootline using the following
496 environments variables: bootfile, ipaddr, serverip, hostname.
497 It loads the vxWorks image pointed bootfile.
498
499 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
500 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
501 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
502 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
503
504 CONFIG_SYS_VXWORKS_ADD_PARAMS
505
506 Add it at the end of the bootline. E.g "u=username pw=secret"
507
508 Note: If a "bootargs" environment is defined, it will overwride
509 the defaults discussed just above.
510
Aneesh V2c451f72011-06-16 23:30:47 +0000511- Cache Configuration:
512 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
513 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
514 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
515
Aneesh V93bc2192011-06-16 23:30:51 +0000516- Cache Configuration for ARM:
517 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
518 controller
519 CONFIG_SYS_PL310_BASE - Physical base address of PL310
520 controller register space
521
wdenk6705d812004-08-02 23:22:59 +0000522- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200523 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000524
525 Define this if you want support for Amba PrimeCell PL010 UARTs.
526
Andreas Engel48d01922008-09-08 14:30:53 +0200527 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000528
529 Define this if you want support for Amba PrimeCell PL011 UARTs.
530
531 CONFIG_PL011_CLOCK
532
533 If you have Amba PrimeCell PL011 UARTs, set this variable to
534 the clock speed of the UARTs.
535
536 CONFIG_PL01x_PORTS
537
538 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
539 define this to a list of base addresses for each (supported)
540 port. See e.g. include/configs/versatile.h
541
John Rigby910f1ae2011-04-19 10:42:39 +0000542 CONFIG_PL011_SERIAL_RLCR
543
544 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
545 have separate receive and transmit line control registers. Set
546 this variable to initialize the extra register.
547
548 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
549
550 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
551 boot loader that has already initialized the UART. Define this
552 variable to flush the UART at init time.
553
wdenk6705d812004-08-02 23:22:59 +0000554
wdenkc6097192002-11-03 00:24:07 +0000555- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000556 Depending on board, define exactly one serial port
557 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
558 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
559 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000560
561 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
562 port routines must be defined elsewhere
563 (i.e. serial_init(), serial_getc(), ...)
564
565 CONFIG_CFB_CONSOLE
566 Enables console device for a color framebuffer. Needs following
567 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
568 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
569 (default big endian)
570 VIDEO_HW_RECTFILL graphic chip supports
571 rectangle fill
572 (cf. smiLynxEM)
573 VIDEO_HW_BITBLT graphic chip supports
574 bit-blit (cf. smiLynxEM)
575 VIDEO_VISIBLE_COLS visible pixel columns
576 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000577 VIDEO_VISIBLE_ROWS visible pixel rows
578 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000579 VIDEO_DATA_FORMAT graphic data format
580 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000581 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000582 VIDEO_KBD_INIT_FCT keyboard int fct
583 (i.e. i8042_kbd_init())
584 VIDEO_TSTC_FCT test char fct
585 (i.e. i8042_tstc)
586 VIDEO_GETC_FCT get char fct
587 (i.e. i8042_getc)
588 CONFIG_CONSOLE_CURSOR cursor drawing on/off
589 (requires blink timer
590 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200591 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000592 CONFIG_CONSOLE_TIME display time/date info in
593 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500594 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000595 CONFIG_VIDEO_LOGO display Linux logo in
596 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000597 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
598 linux_logo.h for logo.
599 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000600 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200601 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000602 the logo
603
wdenk43d96162003-03-06 00:02:04 +0000604 When CONFIG_CFB_CONSOLE is defined, video console is
605 default i/o. Serial console can be forced with
606 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000607
wdenkd4ca31c2004-01-02 14:00:00 +0000608 When CONFIG_SILENT_CONSOLE is defined, all console
609 messages (by U-Boot and Linux!) can be silenced with
610 the "silent" environment variable. See
611 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000612
wdenkc6097192002-11-03 00:24:07 +0000613- Console Baudrate:
614 CONFIG_BAUDRATE - in bps
615 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200616 CONFIG_SYS_BAUDRATE_TABLE, see below.
617 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000618
Heiko Schocherc92fac92009-01-30 12:55:38 +0100619- Console Rx buffer length
620 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
621 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100622 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100623 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
624 must be defined, to setup the maximum idle timeout for
625 the SMC.
626
Graeme Russ9558b482011-09-01 00:48:27 +0000627- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200628 Prior to the console being initialised (i.e. serial UART
629 initialised etc) all console output is silently discarded.
630 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
631 buffer any console messages prior to the console being
632 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
633 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
634 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200635 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200636 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000637
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200638 'Sane' compilers will generate smaller code if
639 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000640
wdenkc6097192002-11-03 00:24:07 +0000641- Boot Delay: CONFIG_BOOTDELAY - in seconds
642 Delay before automatically booting the default image;
643 set to -1 to disable autoboot.
644
645 See doc/README.autoboot for these options that
646 work with CONFIG_BOOTDELAY. None are required.
647 CONFIG_BOOT_RETRY_TIME
648 CONFIG_BOOT_RETRY_MIN
649 CONFIG_AUTOBOOT_KEYED
650 CONFIG_AUTOBOOT_PROMPT
651 CONFIG_AUTOBOOT_DELAY_STR
652 CONFIG_AUTOBOOT_STOP_STR
653 CONFIG_AUTOBOOT_DELAY_STR2
654 CONFIG_AUTOBOOT_STOP_STR2
655 CONFIG_ZERO_BOOTDELAY_CHECK
656 CONFIG_RESET_TO_RETRY
657
658- Autoboot Command:
659 CONFIG_BOOTCOMMAND
660 Only needed when CONFIG_BOOTDELAY is enabled;
661 define a command string that is automatically executed
662 when no character is read on the console interface
663 within "Boot Delay" after reset.
664
665 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000666 This can be used to pass arguments to the bootm
667 command. The value of CONFIG_BOOTARGS goes into the
668 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000669
670 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000671 The value of these goes into the environment as
672 "ramboot" and "nfsboot" respectively, and can be used
673 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200674 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000675
676- Pre-Boot Commands:
677 CONFIG_PREBOOT
678
679 When this option is #defined, the existence of the
680 environment variable "preboot" will be checked
681 immediately before starting the CONFIG_BOOTDELAY
682 countdown and/or running the auto-boot command resp.
683 entering interactive mode.
684
685 This feature is especially useful when "preboot" is
686 automatically generated or modified. For an example
687 see the LWMON board specific code: here "preboot" is
688 modified when the user holds down a certain
689 combination of keys on the (special) keyboard when
690 booting the systems
691
692- Serial Download Echo Mode:
693 CONFIG_LOADS_ECHO
694 If defined to 1, all characters received during a
695 serial download (using the "loads" command) are
696 echoed back. This might be needed by some terminal
697 emulations (like "cu"), but may as well just take
698 time on others. This setting #define's the initial
699 value of the "loads_echo" environment variable.
700
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000702 CONFIG_KGDB_BAUDRATE
703 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200704 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000705
706- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500707 Monitor commands can be included or excluded
708 from the build by using the #include files
709 "config_cmd_all.h" and #undef'ing unwanted
710 commands, or using "config_cmd_default.h"
711 and augmenting with additional #define's
712 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000713
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500714 The default command configuration includes all commands
715 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000716
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500717 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500718 CONFIG_CMD_BDI bdinfo
719 CONFIG_CMD_BEDBUG * Include BedBug Debugger
720 CONFIG_CMD_BMP * BMP support
721 CONFIG_CMD_BSP * Board specific commands
722 CONFIG_CMD_BOOTD bootd
723 CONFIG_CMD_CACHE * icache, dcache
724 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500725 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500726 CONFIG_CMD_DATE * support for RTC, date/time...
727 CONFIG_CMD_DHCP * DHCP support
728 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600729 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
730 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
731 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
732 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500733 CONFIG_CMD_DTT * Digital Therm and Thermostat
734 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500735 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 CONFIG_CMD_EEPROM * EEPROM read/write support
737 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500738 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500739 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500740 CONFIG_CMD_FDC * Floppy Disk Support
741 CONFIG_CMD_FAT * FAT partition support
742 CONFIG_CMD_FDOS * Dos diskette Support
743 CONFIG_CMD_FLASH flinfo, erase, protect
744 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500745 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000746 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500747 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
748 CONFIG_CMD_I2C * I2C serial bus support
749 CONFIG_CMD_IDE * IDE harddisk support
750 CONFIG_CMD_IMI iminfo
751 CONFIG_CMD_IMLS List all found images
752 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500753 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 CONFIG_CMD_IRQ * irqinfo
755 CONFIG_CMD_ITEST Integer/string test of 2 values
756 CONFIG_CMD_JFFS2 * JFFS2 Support
757 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500758 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500759 CONFIG_CMD_LOADB loadb
760 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400761 CONFIG_CMD_MD5SUM print md5 message digest
762 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500763 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
764 loop, loopw, mtest
765 CONFIG_CMD_MISC Misc functions like sleep etc
766 CONFIG_CMD_MMC * MMC memory mapped support
767 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100768 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 CONFIG_CMD_NAND * NAND support
770 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600771 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
772 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 CONFIG_CMD_PCI * pciinfo
774 CONFIG_CMD_PCMCIA * PCMCIA support
775 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
776 host
777 CONFIG_CMD_PORTIO * Port I/O
778 CONFIG_CMD_REGINFO * Register dump
779 CONFIG_CMD_RUN run command in env variable
780 CONFIG_CMD_SAVES * save S record dump
781 CONFIG_CMD_SCSI * SCSI Support
782 CONFIG_CMD_SDRAM * print SDRAM configuration information
783 (requires CONFIG_CMD_I2C)
784 CONFIG_CMD_SETGETDCR Support for DCR Register access
785 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100786 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400787 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200788 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500789 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000790 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000791 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000792 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500793 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500794 CONFIG_CMD_CDP * Cisco Discover Protocol support
795 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000796
wdenkc6097192002-11-03 00:24:07 +0000797
798 EXAMPLE: If you want all functions except of network
799 support you can write:
800
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 #include "config_cmd_all.h"
802 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000803
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400804 Other Commands:
805 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000806
807 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500808 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000809 what you (and your U-Boot users) are doing. Data
810 cache cannot be enabled on systems like the 8xx or
811 8260 (where accesses to the IMMR region must be
812 uncached), and it cannot be disabled on all other
813 systems where we (mis-) use the data cache to hold an
814 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000815
816
817 XXX - this list needs to get updated!
818
Simon Glass45ba8072011-10-15 05:48:20 +0000819- Device tree:
820 CONFIG_OF_CONTROL
821 If this variable is defined, U-Boot will use a device tree
822 to configure its devices, instead of relying on statically
823 compiled #defines in the board file. This option is
824 experimental and only available on a few boards. The device
825 tree is available in the global data as gd->fdt_blob.
826
Simon Glassbbb0b122011-10-15 05:48:21 +0000827 U-Boot needs to get its device tree from somewhere. At present
828 the only way is to embed it in the image with CONFIG_OF_EMBED.
829
830 CONFIG_OF_EMBED
831 If this variable is defined, U-Boot will embed a device tree
832 binary in its image. This device tree file should be in the
833 board directory and called <soc>-<board>.dts. The binary file
834 is then picked up in board_init_f() and made available through
835 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000836
wdenkc6097192002-11-03 00:24:07 +0000837- Watchdog:
838 CONFIG_WATCHDOG
839 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000840 support for the SoC. There must be support in the SoC
841 specific code for a watchdog. For the 8xx and 8260
842 CPUs, the SIU Watchdog feature is enabled in the SYPCR
843 register. When supported for a specific SoC is
844 available, then no further board specific code should
845 be needed to use it.
846
847 CONFIG_HW_WATCHDOG
848 When using a watchdog circuitry external to the used
849 SoC, then define this variable and provide board
850 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000851
stroesec1551ea2003-04-04 15:53:41 +0000852- U-Boot Version:
853 CONFIG_VERSION_VARIABLE
854 If this variable is defined, an environment variable
855 named "ver" is created by U-Boot showing the U-Boot
856 version as printed by the "version" command.
857 This variable is readonly.
858
wdenkc6097192002-11-03 00:24:07 +0000859- Real-Time Clock:
860
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500861 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000862 has to be selected, too. Define exactly one of the
863 following options:
864
865 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
866 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200867 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000868 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000869 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000870 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000871 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000872 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100873 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000874 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200875 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200876 CONFIG_SYS_RV3029_TCR - enable trickle charger on
877 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000878
wdenkb37c7e52003-06-30 16:24:52 +0000879 Note that if the RTC uses I2C, then the I2C interface
880 must also be configured. See I2C Support, below.
881
Peter Tysere92739d2008-12-17 16:36:21 -0600882- GPIO Support:
883 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
884 CONFIG_PCA953X_INFO - enable pca953x info command
885
Chris Packham5dec49c2010-12-19 10:12:13 +0000886 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
887 chip-ngpio pairs that tell the PCA953X driver the number of
888 pins supported by a particular chip.
889
Peter Tysere92739d2008-12-17 16:36:21 -0600890 Note that if the GPIO device uses I2C, then the I2C interface
891 must also be configured. See I2C Support, below.
892
wdenkc6097192002-11-03 00:24:07 +0000893- Timestamp Support:
894
wdenk43d96162003-03-06 00:02:04 +0000895 When CONFIG_TIMESTAMP is selected, the timestamp
896 (date and time) of an image is printed by image
897 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500898 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000899
900- Partition Support:
901 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400902 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000903
Wolfgang Denk218ca722008-03-26 10:40:12 +0100904 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
905 CONFIG_CMD_SCSI) you must configure support for at
906 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000907
908- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000909 CONFIG_IDE_RESET_ROUTINE - this is defined in several
910 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000911
wdenk4d13cba2004-03-14 14:09:05 +0000912 CONFIG_IDE_RESET - is this is defined, IDE Reset will
913 be performed by calling the function
914 ide_set_reset(int reset)
915 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000916
917- ATAPI Support:
918 CONFIG_ATAPI
919
920 Set this to enable ATAPI support.
921
wdenkc40b2952004-03-13 23:29:43 +0000922- LBA48 Support
923 CONFIG_LBA48
924
925 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100926 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000927 Whithout these , LBA48 support uses 32bit variables and will 'only'
928 support disks up to 2.1TB.
929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200930 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000931 When enabled, makes the IDE subsystem use 64bit sector addresses.
932 Default is 32bit.
933
wdenkc6097192002-11-03 00:24:07 +0000934- SCSI Support:
935 At the moment only there is only support for the
936 SYM53C8XX SCSI controller; define
937 CONFIG_SCSI_SYM53C8XX to enable it.
938
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200939 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
940 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
941 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000942 maximum numbers of LUNs, SCSI ID's and target
943 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200944 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000945
946- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000947 CONFIG_E1000
948 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000949
Andre Schwarzac3315c2008-03-06 16:45:44 +0100950 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200951 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100952
wdenkc6097192002-11-03 00:24:07 +0000953 CONFIG_EEPRO100
954 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200955 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000956 write routine for first time initialisation.
957
958 CONFIG_TULIP
959 Support for Digital 2114x chips.
960 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
961 modem chip initialisation (KS8761/QS6611).
962
963 CONFIG_NATSEMI
964 Support for National dp83815 chips.
965
966 CONFIG_NS8382X
967 Support for National dp8382[01] gigabit chips.
968
wdenk45219c42003-05-12 21:50:16 +0000969- NETWORK Support (other):
970
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100971 CONFIG_DRIVER_AT91EMAC
972 Support for AT91RM9200 EMAC.
973
974 CONFIG_RMII
975 Define this to use reduced MII inteface
976
977 CONFIG_DRIVER_AT91EMAC_QUIET
978 If this defined, the driver is quiet.
979 The driver doen't show link status messages.
980
wdenk45219c42003-05-12 21:50:16 +0000981 CONFIG_DRIVER_LAN91C96
982 Support for SMSC's LAN91C96 chips.
983
984 CONFIG_LAN91C96_BASE
985 Define this to hold the physical address
986 of the LAN91C96's I/O space
987
988 CONFIG_LAN91C96_USE_32_BIT
989 Define this to enable 32 bit addressing
990
wdenkf39748a2004-06-09 13:37:52 +0000991 CONFIG_DRIVER_SMC91111
992 Support for SMSC's LAN91C111 chip
993
994 CONFIG_SMC91111_BASE
995 Define this to hold the physical address
996 of the device (I/O space)
997
998 CONFIG_SMC_USE_32_BIT
999 Define this if data bus is 32 bits
1000
1001 CONFIG_SMC_USE_IOFUNCS
1002 Define this to use i/o functions instead of macros
1003 (some hardware wont work with macros)
1004
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001005 CONFIG_FTGMAC100
1006 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1007
1008 CONFIG_FTGMAC100_EGIGA
1009 Define this to use GE link update with gigabit PHY.
1010 Define this if FTGMAC100 is connected to gigabit PHY.
1011 If your system has 10/100 PHY only, it might not occur
1012 wrong behavior. Because PHY usually return timeout or
1013 useless data when polling gigabit status and gigabit
1014 control registers. This behavior won't affect the
1015 correctnessof 10/100 link speed update.
1016
Mike Rapoportc2fff332009-11-11 10:03:03 +02001017 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001018 Support for SMSC's LAN911x and LAN921x chips
1019
Mike Rapoportc2fff332009-11-11 10:03:03 +02001020 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001021 Define this to hold the physical address
1022 of the device (I/O space)
1023
Mike Rapoportc2fff332009-11-11 10:03:03 +02001024 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001025 Define this if data bus is 32 bits
1026
Mike Rapoportc2fff332009-11-11 10:03:03 +02001027 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001028 Define this if data bus is 16 bits. If your processor
1029 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001030 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001031
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001032 CONFIG_SH_ETHER
1033 Support for Renesas on-chip Ethernet controller
1034
1035 CONFIG_SH_ETHER_USE_PORT
1036 Define the number of ports to be used
1037
1038 CONFIG_SH_ETHER_PHY_ADDR
1039 Define the ETH PHY's address
1040
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001041 CONFIG_SH_ETHER_CACHE_WRITEBACK
1042 If this option is set, the driver enables cache flush.
1043
wdenkc6097192002-11-03 00:24:07 +00001044- USB Support:
1045 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001046 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001047 CONFIG_USB_UHCI to enable it.
1048 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001049 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001050 storage devices.
1051 Note:
1052 Supported are USB Keyboards and USB Floppy drives
1053 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001054 MPC5200 USB requires additional defines:
1055 CONFIG_USB_CLOCK
1056 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001057 CONFIG_PSC3_USB
1058 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001059 CONFIG_USB_CONFIG
1060 for differential drivers: 0x00001000
1061 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001062 for differential drivers on PSC3: 0x00000100
1063 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001064 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001065 May be defined to allow interrupt polling
1066 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001067
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001068- USB Device:
1069 Define the below if you wish to use the USB console.
1070 Once firmware is rebuilt from a serial console issue the
1071 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001072 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001073 it has found a new device. The environment variable usbtty
1074 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001075 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001076 Common Device Class Abstract Control Model serial device.
1077 If you select usbtty = gserial you should be able to enumerate
1078 a Linux host by
1079 # modprobe usbserial vendor=0xVendorID product=0xProductID
1080 else if using cdc_acm, simply setting the environment
1081 variable usbtty to be cdc_acm should suffice. The following
1082 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001083
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001084 CONFIG_USB_DEVICE
1085 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001086
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001087 CONFIG_USB_TTY
1088 Define this to have a tty type of device available to
1089 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001091 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001092 Define this if you want stdin, stdout &/or stderr to
1093 be set to usbtty.
1094
1095 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001096 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001097 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001098 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001100 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001101 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001102 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001103
Wolfgang Denk386eda02006-06-14 18:14:56 +02001104 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001105 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001106 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001107 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1108 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1109 should pretend to be a Linux device to it's target host.
1110
1111 CONFIG_USBD_MANUFACTURER
1112 Define this string as the name of your company for
1113 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001114
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001115 CONFIG_USBD_PRODUCT_NAME
1116 Define this string as the name of your product
1117 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1118
1119 CONFIG_USBD_VENDORID
1120 Define this as your assigned Vendor ID from the USB
1121 Implementors Forum. This *must* be a genuine Vendor ID
1122 to avoid polluting the USB namespace.
1123 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001124
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001125 CONFIG_USBD_PRODUCTID
1126 Define this as the unique Product ID
1127 for your device
1128 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001129
1130
1131- MMC Support:
1132 The MMC controller on the Intel PXA is supported. To
1133 enable this define CONFIG_MMC. The MMC can be
1134 accessed from the boot prompt by mapping the device
1135 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001136 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1137 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001138
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001139 CONFIG_SH_MMCIF
1140 Support for Renesas on-chip MMCIF controller
1141
1142 CONFIG_SH_MMCIF_ADDR
1143 Define the base address of MMCIF registers
1144
1145 CONFIG_SH_MMCIF_CLK
1146 Define the clock frequency for MMCIF
1147
wdenk6705d812004-08-02 23:22:59 +00001148- Journaling Flash filesystem support:
1149 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1150 CONFIG_JFFS2_NAND_DEV
1151 Define these for a default partition on a NAND device
1152
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001153 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1154 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001155 Define these for a default partition on a NOR device
1156
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001157 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001158 Define this to create an own partition. You have to provide a
1159 function struct part_info* jffs2_part_info(int part_num)
1160
1161 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001162 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001163 to disable the command chpart. This is the default when you
1164 have not defined a custom partition
1165
wdenkc6097192002-11-03 00:24:07 +00001166- Keyboard Support:
1167 CONFIG_ISA_KEYBOARD
1168
1169 Define this to enable standard (PC-Style) keyboard
1170 support
1171
1172 CONFIG_I8042_KBD
1173 Standard PC keyboard driver with US (is default) and
1174 GERMAN key layout (switch via environment 'keymap=de') support.
1175 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1176 for cfb_console. Supports cursor blinking.
1177
1178- Video support:
1179 CONFIG_VIDEO
1180
1181 Define this to enable video support (for output to
1182 video).
1183
1184 CONFIG_VIDEO_CT69000
1185
1186 Enable Chips & Technologies 69000 Video chip
1187
1188 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001189 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001190 video output is selected via environment 'videoout'
1191 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1192 assumed.
wdenkc6097192002-11-03 00:24:07 +00001193
wdenkb79a11c2004-03-25 15:14:43 +00001194 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001195 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001196 are possible:
1197 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001198 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001199
1200 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1201 -------------+---------------------------------------------
1202 8 bits | 0x301* 0x303 0x305 0x161 0x307
1203 15 bits | 0x310 0x313 0x316 0x162 0x319
1204 16 bits | 0x311 0x314 0x317 0x163 0x31A
1205 24 bits | 0x312 0x315 0x318 ? 0x31B
1206 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001207 (i.e. setenv videomode 317; saveenv; reset;)
1208
wdenkb79a11c2004-03-25 15:14:43 +00001209 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001210 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001211
1212
stroesec1551ea2003-04-04 15:53:41 +00001213 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001214 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001215 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1216 or CONFIG_VIDEO_SED13806_16BPP
1217
Timur Tabi7d3053f2011-02-15 17:09:19 -06001218 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001219 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001220 SOCs that have a DIU should define this macro to enable DIU
1221 support, and should also define these other macros:
1222
1223 CONFIG_SYS_DIU_ADDR
1224 CONFIG_VIDEO
1225 CONFIG_CMD_BMP
1226 CONFIG_CFB_CONSOLE
1227 CONFIG_VIDEO_SW_CURSOR
1228 CONFIG_VGA_AS_SINGLE_DEVICE
1229 CONFIG_VIDEO_LOGO
1230 CONFIG_VIDEO_BMP_LOGO
1231
Timur Tabiba8e76b2011-04-11 14:18:22 -05001232 The DIU driver will look for the 'video-mode' environment
1233 variable, and if defined, enable the DIU as a console during
1234 boot. See the documentation file README.video for a
1235 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001236
wdenk682011f2003-06-03 23:54:09 +00001237- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001238 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001239
wdenk8bde7f72003-06-27 21:31:46 +00001240 Define this to enable a custom keyboard support.
1241 This simply calls drv_keyboard_init() which must be
1242 defined in your board-specific files.
1243 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001244
wdenkc6097192002-11-03 00:24:07 +00001245- LCD Support: CONFIG_LCD
1246
1247 Define this to enable LCD support (for output to LCD
1248 display); also select one of the supported displays
1249 by defining one of these:
1250
Stelian Pop39cf4802008-05-09 21:57:18 +02001251 CONFIG_ATMEL_LCD:
1252
1253 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1254
wdenkfd3103b2003-11-25 16:55:19 +00001255 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001256
wdenkfd3103b2003-11-25 16:55:19 +00001257 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001258
wdenkfd3103b2003-11-25 16:55:19 +00001259 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001260
wdenkfd3103b2003-11-25 16:55:19 +00001261 NEC NL6448BC20-08. 6.5", 640x480.
1262 Active, color, single scan.
1263
1264 CONFIG_NEC_NL6448BC33_54
1265
1266 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001267 Active, color, single scan.
1268
1269 CONFIG_SHARP_16x9
1270
1271 Sharp 320x240. Active, color, single scan.
1272 It isn't 16x9, and I am not sure what it is.
1273
1274 CONFIG_SHARP_LQ64D341
1275
1276 Sharp LQ64D341 display, 640x480.
1277 Active, color, single scan.
1278
1279 CONFIG_HLD1045
1280
1281 HLD1045 display, 640x480.
1282 Active, color, single scan.
1283
1284 CONFIG_OPTREX_BW
1285
1286 Optrex CBL50840-2 NF-FW 99 22 M5
1287 or
1288 Hitachi LMG6912RPFC-00T
1289 or
1290 Hitachi SP14Q002
1291
1292 320x240. Black & white.
1293
1294 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001295 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001296
wdenk7152b1d2003-09-05 23:19:14 +00001297- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001298
wdenk8bde7f72003-06-27 21:31:46 +00001299 If this option is set, the environment is checked for
1300 a variable "splashimage". If found, the usual display
1301 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001302 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001303 specified in "splashimage" is loaded instead. The
1304 console is redirected to the "nulldev", too. This
1305 allows for a "silent" boot where a splash screen is
1306 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001307
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001308 CONFIG_SPLASH_SCREEN_ALIGN
1309
1310 If this option is set the splash image can be freely positioned
1311 on the screen. Environment variable "splashpos" specifies the
1312 position as "x,y". If a positive number is given it is used as
1313 number of pixel from left/top. If a negative number is given it
1314 is used as number of pixel from right/bottom. You can also
1315 specify 'm' for centering the image.
1316
1317 Example:
1318 setenv splashpos m,m
1319 => image at center of screen
1320
1321 setenv splashpos 30,20
1322 => image at x = 30 and y = 20
1323
1324 setenv splashpos -10,m
1325 => vertically centered image
1326 at x = dspWidth - bmpWidth - 9
1327
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001328- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1329
1330 If this option is set, additionally to standard BMP
1331 images, gzipped BMP images can be displayed via the
1332 splashscreen support or the bmp command.
1333
Anatolij Gustschind5011762010-03-15 14:50:25 +01001334- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1335
1336 If this option is set, 8-bit RLE compressed BMP images
1337 can be displayed via the splashscreen support or the
1338 bmp command.
1339
wdenkc29fdfc2003-08-29 20:57:53 +00001340- Compression support:
1341 CONFIG_BZIP2
1342
1343 If this option is set, support for bzip2 compressed
1344 images is included. If not, only uncompressed and gzip
1345 compressed images are supported.
1346
wdenk42d1f032003-10-15 23:53:47 +00001347 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001348 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001349 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001350
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001351 CONFIG_LZMA
1352
1353 If this option is set, support for lzma compressed
1354 images is included.
1355
1356 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1357 requires an amount of dynamic memory that is given by the
1358 formula:
1359
1360 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1361
1362 Where lc and lp stand for, respectively, Literal context bits
1363 and Literal pos bits.
1364
1365 This value is upper-bounded by 14MB in the worst case. Anyway,
1366 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1367 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1368 a very small buffer.
1369
1370 Use the lzmainfo tool to determinate the lc and lp values and
1371 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001372 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001373
wdenk17ea1172004-06-06 21:51:03 +00001374- MII/PHY support:
1375 CONFIG_PHY_ADDR
1376
1377 The address of PHY on MII bus.
1378
1379 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1380
1381 The clock frequency of the MII bus
1382
1383 CONFIG_PHY_GIGE
1384
1385 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001386 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001387
1388 CONFIG_PHY_RESET_DELAY
1389
1390 Some PHY like Intel LXT971A need extra delay after
1391 reset before any MII register access is possible.
1392 For such PHY, set this option to the usec delay
1393 required. (minimum 300usec for LXT971A)
1394
1395 CONFIG_PHY_CMD_DELAY (ppc4xx)
1396
1397 Some PHY like Intel LXT971A need extra delay after
1398 command issued before MII status register can be read
1399
wdenkc6097192002-11-03 00:24:07 +00001400- Ethernet address:
1401 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001402 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001403 CONFIG_ETH2ADDR
1404 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001405 CONFIG_ETH4ADDR
1406 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001407
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001408 Define a default value for Ethernet address to use
1409 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001410 is not determined automatically.
1411
1412- IP address:
1413 CONFIG_IPADDR
1414
1415 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001416 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001417 determined through e.g. bootp.
1418
1419- Server IP address:
1420 CONFIG_SERVERIP
1421
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001422 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001423 server to contact when using the "tftboot" command.
1424
Robin Getz97cfe862009-07-21 12:15:28 -04001425 CONFIG_KEEP_SERVERADDR
1426
1427 Keeps the server's MAC address, in the env 'serveraddr'
1428 for passing to bootargs (like Linux's netconsole option)
1429
David Updegraff53a5c422007-06-11 10:41:07 -05001430- Multicast TFTP Mode:
1431 CONFIG_MCAST_TFTP
1432
1433 Defines whether you want to support multicast TFTP as per
1434 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001435 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001436 driver in use must provide a function: mcast() to join/leave a
1437 multicast group.
1438
wdenkc6097192002-11-03 00:24:07 +00001439- BOOTP Recovery Mode:
1440 CONFIG_BOOTP_RANDOM_DELAY
1441
1442 If you have many targets in a network that try to
1443 boot using BOOTP, you may want to avoid that all
1444 systems send out BOOTP requests at precisely the same
1445 moment (which would happen for instance at recovery
1446 from a power failure, when all systems will try to
1447 boot, thus flooding the BOOTP server. Defining
1448 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1449 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001450 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001451
1452 1st BOOTP request: delay 0 ... 1 sec
1453 2nd BOOTP request: delay 0 ... 2 sec
1454 3rd BOOTP request: delay 0 ... 4 sec
1455 4th and following
1456 BOOTP requests: delay 0 ... 8 sec
1457
stroesefe389a82003-08-28 14:17:32 +00001458- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001459 You can fine tune the DHCP functionality by defining
1460 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001461
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001462 CONFIG_BOOTP_SUBNETMASK
1463 CONFIG_BOOTP_GATEWAY
1464 CONFIG_BOOTP_HOSTNAME
1465 CONFIG_BOOTP_NISDOMAIN
1466 CONFIG_BOOTP_BOOTPATH
1467 CONFIG_BOOTP_BOOTFILESIZE
1468 CONFIG_BOOTP_DNS
1469 CONFIG_BOOTP_DNS2
1470 CONFIG_BOOTP_SEND_HOSTNAME
1471 CONFIG_BOOTP_NTPSERVER
1472 CONFIG_BOOTP_TIMEOFFSET
1473 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001474
Wilson Callan5d110f02007-07-28 10:56:13 -04001475 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1476 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001477
1478 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1479 serverip from a DHCP server, it is possible that more
1480 than one DNS serverip is offered to the client.
1481 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1482 serverip will be stored in the additional environment
1483 variable "dnsip2". The first DNS serverip is always
1484 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001485 is defined.
stroesefe389a82003-08-28 14:17:32 +00001486
1487 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1488 to do a dynamic update of a DNS server. To do this, they
1489 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001490 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001491 of the "hostname" environment variable is passed as
1492 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001493
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001494 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1495
1496 A 32bit value in microseconds for a delay between
1497 receiving a "DHCP Offer" and sending the "DHCP Request".
1498 This fixes a problem with certain DHCP servers that don't
1499 respond 100% of the time to a "DHCP request". E.g. On an
1500 AT91RM9200 processor running at 180MHz, this delay needed
1501 to be *at least* 15,000 usec before a Windows Server 2003
1502 DHCP server would reply 100% of the time. I recommend at
1503 least 50,000 usec to be safe. The alternative is to hope
1504 that one of the retries will be successful but note that
1505 the DHCP timeout and retry process takes a longer than
1506 this delay.
1507
wdenka3d991b2004-04-15 21:48:45 +00001508 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001509 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001510
1511 The device id used in CDP trigger frames.
1512
1513 CONFIG_CDP_DEVICE_ID_PREFIX
1514
1515 A two character string which is prefixed to the MAC address
1516 of the device.
1517
1518 CONFIG_CDP_PORT_ID
1519
1520 A printf format string which contains the ascii name of
1521 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001522 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001523
1524 CONFIG_CDP_CAPABILITIES
1525
1526 A 32bit integer which indicates the device capabilities;
1527 0x00000010 for a normal host which does not forwards.
1528
1529 CONFIG_CDP_VERSION
1530
1531 An ascii string containing the version of the software.
1532
1533 CONFIG_CDP_PLATFORM
1534
1535 An ascii string containing the name of the platform.
1536
1537 CONFIG_CDP_TRIGGER
1538
1539 A 32bit integer sent on the trigger.
1540
1541 CONFIG_CDP_POWER_CONSUMPTION
1542
1543 A 16bit integer containing the power consumption of the
1544 device in .1 of milliwatts.
1545
1546 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1547
1548 A byte containing the id of the VLAN.
1549
wdenkc6097192002-11-03 00:24:07 +00001550- Status LED: CONFIG_STATUS_LED
1551
1552 Several configurations allow to display the current
1553 status using a LED. For instance, the LED will blink
1554 fast while running U-Boot code, stop blinking as
1555 soon as a reply to a BOOTP request was received, and
1556 start blinking slow once the Linux kernel is running
1557 (supported by a status LED driver in the Linux
1558 kernel). Defining CONFIG_STATUS_LED enables this
1559 feature in U-Boot.
1560
1561- CAN Support: CONFIG_CAN_DRIVER
1562
1563 Defining CONFIG_CAN_DRIVER enables CAN driver support
1564 on those systems that support this (optional)
1565 feature, like the TQM8xxL modules.
1566
1567- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1568
wdenkb37c7e52003-06-30 16:24:52 +00001569 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001570 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001571 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001572
wdenk945af8d2003-07-16 21:53:01 +00001573 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001574 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001575 CONFIG_COMMANDS) and communicate with i2c based realtime
1576 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001577 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001578
Ben Warrenbb99ad62006-09-07 16:50:54 -04001579 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001580
wdenk945af8d2003-07-16 21:53:01 +00001581 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001582 bit-banging) driver instead of CPM or similar hardware
1583 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001584
wdenk945af8d2003-07-16 21:53:01 +00001585 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001586 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001588 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001589 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001590 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001591 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001592
Peter Tyser8d321b82010-04-12 22:28:21 -05001593 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001594 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001595 and so its address should therefore be cleared to 0 (See,
1596 eg, MPC823e User's Manual p.16-473). So, set
1597 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001598
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001599 CONFIG_SYS_I2C_INIT_MPC5XXX
1600
1601 When a board is reset during an i2c bus transfer
1602 chips might think that the current transfer is still
1603 in progress. Reset the slave devices by sending start
1604 commands until the slave device responds.
1605
wdenk945af8d2003-07-16 21:53:01 +00001606 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001607
1608 If you use the software i2c interface (CONFIG_SOFT_I2C)
1609 then the following macros need to be defined (examples are
1610 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001611
1612 I2C_INIT
1613
wdenkb37c7e52003-06-30 16:24:52 +00001614 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001615 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001616
wdenkba56f622004-02-06 23:19:44 +00001617 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001618
wdenkc6097192002-11-03 00:24:07 +00001619 I2C_PORT
1620
wdenk43d96162003-03-06 00:02:04 +00001621 (Only for MPC8260 CPU). The I/O port to use (the code
1622 assumes both bits are on the same port). Valid values
1623 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001624
1625 I2C_ACTIVE
1626
1627 The code necessary to make the I2C data line active
1628 (driven). If the data line is open collector, this
1629 define can be null.
1630
wdenkb37c7e52003-06-30 16:24:52 +00001631 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1632
wdenkc6097192002-11-03 00:24:07 +00001633 I2C_TRISTATE
1634
1635 The code necessary to make the I2C data line tri-stated
1636 (inactive). If the data line is open collector, this
1637 define can be null.
1638
wdenkb37c7e52003-06-30 16:24:52 +00001639 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1640
wdenkc6097192002-11-03 00:24:07 +00001641 I2C_READ
1642
1643 Code that returns TRUE if the I2C data line is high,
1644 FALSE if it is low.
1645
wdenkb37c7e52003-06-30 16:24:52 +00001646 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1647
wdenkc6097192002-11-03 00:24:07 +00001648 I2C_SDA(bit)
1649
1650 If <bit> is TRUE, sets the I2C data line high. If it
1651 is FALSE, it clears it (low).
1652
wdenkb37c7e52003-06-30 16:24:52 +00001653 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001654 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001655 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001656
wdenkc6097192002-11-03 00:24:07 +00001657 I2C_SCL(bit)
1658
1659 If <bit> is TRUE, sets the I2C clock line high. If it
1660 is FALSE, it clears it (low).
1661
wdenkb37c7e52003-06-30 16:24:52 +00001662 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001663 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001664 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001665
wdenkc6097192002-11-03 00:24:07 +00001666 I2C_DELAY
1667
1668 This delay is invoked four times per clock cycle so this
1669 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001670 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001671 like:
1672
wdenkb37c7e52003-06-30 16:24:52 +00001673 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001674
Mike Frysinger793b5722010-07-21 13:38:02 -04001675 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1676
1677 If your arch supports the generic GPIO framework (asm/gpio.h),
1678 then you may alternatively define the two GPIOs that are to be
1679 used as SCL / SDA. Any of the previous I2C_xxx macros will
1680 have GPIO-based defaults assigned to them as appropriate.
1681
1682 You should define these to the GPIO value as given directly to
1683 the generic GPIO functions.
1684
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001685 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001686
wdenk8bde7f72003-06-27 21:31:46 +00001687 When a board is reset during an i2c bus transfer
1688 chips might think that the current transfer is still
1689 in progress. On some boards it is possible to access
1690 the i2c SCLK line directly, either by using the
1691 processor pin as a GPIO or by having a second pin
1692 connected to the bus. If this option is defined a
1693 custom i2c_init_board() routine in boards/xxx/board.c
1694 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001695
Richard Retanubun26a33502010-04-12 15:08:17 -04001696 CONFIG_SYS_I2C_BOARD_LATE_INIT
1697
1698 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1699 defined a custom i2c_board_late_init() routine in
1700 boards/xxx/board.c is run AFTER the operations in i2c_init()
1701 is completed. This callpoint can be used to unreset i2c bus
1702 using CPU i2c controller register accesses for CPUs whose i2c
1703 controller provide such a method. It is called at the end of
1704 i2c_init() to allow i2c_init operations to setup the i2c bus
1705 controller on the CPU (e.g. setting bus speed & slave address).
1706
wdenk17ea1172004-06-06 21:51:03 +00001707 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1708
1709 This option enables configuration of bi_iic_fast[] flags
1710 in u-boot bd_info structure based on u-boot environment
1711 variable "i2cfast". (see also i2cfast)
1712
Ben Warrenbb99ad62006-09-07 16:50:54 -04001713 CONFIG_I2C_MULTI_BUS
1714
1715 This option allows the use of multiple I2C buses, each of which
1716 must have a controller. At any point in time, only one bus is
1717 active. To switch to a different bus, use the 'i2c dev' command.
1718 Note that bus numbering is zero-based.
1719
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001720 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001721
1722 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001723 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1724 is set, specify a list of bus-device pairs. Otherwise, specify
1725 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001726
1727 e.g.
1728 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001729 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001730
1731 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1732
1733 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001734 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001735
1736 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001738 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001739
1740 If defined, then this indicates the I2C bus number for DDR SPD.
1741 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001743 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001744
1745 If defined, then this indicates the I2C bus number for the RTC.
1746 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001748 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001749
1750 If defined, then this indicates the I2C bus number for the DTT.
1751 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1752
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001753 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001754
1755 If defined, specifies the I2C address of the DTT device.
1756 If not defined, then U-Boot uses predefined value for
1757 specified DTT device.
1758
Timur Tabibe5e6182006-11-03 19:15:00 -06001759 CONFIG_FSL_I2C
1760
1761 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001762 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001763
Heiko Schocher67b23a32008-10-15 09:39:47 +02001764 CONFIG_I2C_MUX
1765
1766 Define this option if you have I2C devices reached over 1 .. n
1767 I2C Muxes like the pca9544a. This option addes a new I2C
1768 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1769 new I2C Bus to the existing I2C Busses. If you select the
1770 new Bus with "i2c dev", u-bbot sends first the commandos for
1771 the muxes to activate this new "bus".
1772
1773 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1774 feature!
1775
1776 Example:
1777 Adding a new I2C Bus reached over 2 pca9544a muxes
1778 The First mux with address 70 and channel 6
1779 The Second mux with address 71 and channel 4
1780
1781 => i2c bus pca9544a:70:6:pca9544a:71:4
1782
1783 Use the "i2c bus" command without parameter, to get a list
1784 of I2C Busses with muxes:
1785
1786 => i2c bus
1787 Busses reached over muxes:
1788 Bus ID: 2
1789 reached over Mux(es):
1790 pca9544a@70 ch: 4
1791 Bus ID: 3
1792 reached over Mux(es):
1793 pca9544a@70 ch: 6
1794 pca9544a@71 ch: 4
1795 =>
1796
1797 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001798 u-boot first sends the command to the mux@70 to enable
1799 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001800 the channel 4.
1801
1802 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001803 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001804 the 2 muxes.
1805
1806 This option is actually implemented for the bitbanging
1807 algorithm in common/soft_i2c.c and for the Hardware I2C
1808 Bus on the MPC8260. But it should be not so difficult
1809 to add this option to other architectures.
1810
Andrew Dyer2ac69852008-12-29 17:36:01 -06001811 CONFIG_SOFT_I2C_READ_REPEATED_START
1812
1813 defining this will force the i2c_read() function in
1814 the soft_i2c driver to perform an I2C repeated start
1815 between writing the address pointer and reading the
1816 data. If this define is omitted the default behaviour
1817 of doing a stop-start sequence will be used. Most I2C
1818 devices can use either method, but some require one or
1819 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001820
wdenkc6097192002-11-03 00:24:07 +00001821- SPI Support: CONFIG_SPI
1822
1823 Enables SPI driver (so far only tested with
1824 SPI EEPROM, also an instance works with Crystal A/D and
1825 D/As on the SACSng board)
1826
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001827 CONFIG_SH_SPI
1828
1829 Enables the driver for SPI controller on SuperH. Currently
1830 only SH7757 is supported.
1831
wdenkc6097192002-11-03 00:24:07 +00001832 CONFIG_SPI_X
1833
1834 Enables extended (16-bit) SPI EEPROM addressing.
1835 (symmetrical to CONFIG_I2C_X)
1836
1837 CONFIG_SOFT_SPI
1838
wdenk43d96162003-03-06 00:02:04 +00001839 Enables a software (bit-bang) SPI driver rather than
1840 using hardware support. This is a general purpose
1841 driver that only requires three general I/O port pins
1842 (two outputs, one input) to function. If this is
1843 defined, the board configuration must define several
1844 SPI configuration items (port pins to use, etc). For
1845 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001846
Ben Warren04a9e112008-01-16 22:37:35 -05001847 CONFIG_HARD_SPI
1848
1849 Enables a hardware SPI driver for general-purpose reads
1850 and writes. As with CONFIG_SOFT_SPI, the board configuration
1851 must define a list of chip-select function pointers.
1852 Currently supported on some MPC8xxx processors. For an
1853 example, see include/configs/mpc8349emds.h.
1854
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001855 CONFIG_MXC_SPI
1856
1857 Enables the driver for the SPI controllers on i.MX and MXC
1858 SoCs. Currently only i.MX31 is supported.
1859
Matthias Fuchs01335022007-12-27 17:12:34 +01001860- FPGA Support: CONFIG_FPGA
1861
1862 Enables FPGA subsystem.
1863
1864 CONFIG_FPGA_<vendor>
1865
1866 Enables support for specific chip vendors.
1867 (ALTERA, XILINX)
1868
1869 CONFIG_FPGA_<family>
1870
1871 Enables support for FPGA family.
1872 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1873
1874 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001875
wdenk43d96162003-03-06 00:02:04 +00001876 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001878 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001879
wdenk8bde7f72003-06-27 21:31:46 +00001880 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001881
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001882 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001883
wdenk43d96162003-03-06 00:02:04 +00001884 Enable checks on FPGA configuration interface busy
1885 status by the configuration function. This option
1886 will require a board or device specific function to
1887 be written.
wdenkc6097192002-11-03 00:24:07 +00001888
1889 CONFIG_FPGA_DELAY
1890
1891 If defined, a function that provides delays in the FPGA
1892 configuration driver.
1893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001894 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001895 Allow Control-C to interrupt FPGA configuration
1896
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001897 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001898
wdenk43d96162003-03-06 00:02:04 +00001899 Check for configuration errors during FPGA bitfile
1900 loading. For example, abort during Virtex II
1901 configuration if the INIT_B line goes low (which
1902 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001904 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001905
wdenk43d96162003-03-06 00:02:04 +00001906 Maximum time to wait for the INIT_B line to deassert
1907 after PROB_B has been deasserted during a Virtex II
1908 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001909 ms.
wdenkc6097192002-11-03 00:24:07 +00001910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001911 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001912
wdenk43d96162003-03-06 00:02:04 +00001913 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001914 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001916 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001917
wdenk43d96162003-03-06 00:02:04 +00001918 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001919 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001920
1921- Configuration Management:
1922 CONFIG_IDENT_STRING
1923
wdenk43d96162003-03-06 00:02:04 +00001924 If defined, this string will be added to the U-Boot
1925 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001926
1927- Vendor Parameter Protection:
1928
wdenk43d96162003-03-06 00:02:04 +00001929 U-Boot considers the values of the environment
1930 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001931 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001932 are set once by the board vendor / manufacturer, and
1933 protects these variables from casual modification by
1934 the user. Once set, these variables are read-only,
1935 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001936 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001937
1938 If CONFIG_ENV_OVERWRITE is #defined in your config
1939 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001940 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001941 these parameters.
1942
1943 Alternatively, if you #define _both_ CONFIG_ETHADDR
1944 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001945 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001946 which can be changed exactly ONCE by the user. [The
1947 serial# is unaffected by this, i. e. it remains
1948 read-only.]
1949
1950- Protected RAM:
1951 CONFIG_PRAM
1952
1953 Define this variable to enable the reservation of
1954 "protected RAM", i. e. RAM which is not overwritten
1955 by U-Boot. Define CONFIG_PRAM to hold the number of
1956 kB you want to reserve for pRAM. You can overwrite
1957 this default value by defining an environment
1958 variable "pram" to the number of kB you want to
1959 reserve. Note that the board info structure will
1960 still show the full amount of RAM. If pRAM is
1961 reserved, a new environment variable "mem" will
1962 automatically be defined to hold the amount of
1963 remaining RAM in a form that can be passed as boot
1964 argument to Linux, for instance like that:
1965
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001966 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001967 saveenv
1968
1969 This way you can tell Linux not to use this memory,
1970 either, which results in a memory region that will
1971 not be affected by reboots.
1972
1973 *WARNING* If your board configuration uses automatic
1974 detection of the RAM size, you must make sure that
1975 this memory test is non-destructive. So far, the
1976 following board configurations are known to be
1977 "pRAM-clean":
1978
1979 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1980 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001981 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001982
1983- Error Recovery:
1984 CONFIG_PANIC_HANG
1985
1986 Define this variable to stop the system in case of a
1987 fatal error, so that you have to reset it manually.
1988 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001989 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001990 automatically as fast as possible, but it may be
1991 useful during development since you can try to debug
1992 the conditions that lead to the situation.
1993
1994 CONFIG_NET_RETRY_COUNT
1995
wdenk43d96162003-03-06 00:02:04 +00001996 This variable defines the number of retries for
1997 network operations like ARP, RARP, TFTP, or BOOTP
1998 before giving up the operation. If not defined, a
1999 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002000
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002001 CONFIG_ARP_TIMEOUT
2002
2003 Timeout waiting for an ARP reply in milliseconds.
2004
wdenkc6097192002-11-03 00:24:07 +00002005- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002006 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002007
2008 Enable auto completion of commands using TAB.
2009
Wolfgang Denka9398e02006-11-27 15:32:42 +01002010 Note that this feature has NOT been implemented yet
2011 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002012
2013
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002014 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002015
2016 Define this variable to enable the "hush" shell (from
2017 Busybox) as command line interpreter, thus enabling
2018 powerful command line syntax like
2019 if...then...else...fi conditionals or `&&' and '||'
2020 constructs ("shell scripts").
2021
2022 If undefined, you get the old, much simpler behaviour
2023 with a somewhat smaller memory footprint.
2024
2025
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002026 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002027
2028 This defines the secondary prompt string, which is
2029 printed when the command interpreter needs more input
2030 to complete a command. Usually "> ".
2031
2032 Note:
2033
wdenk8bde7f72003-06-27 21:31:46 +00002034 In the current implementation, the local variables
2035 space and global environment variables space are
2036 separated. Local variables are those you define by
2037 simply typing `name=value'. To access a local
2038 variable later on, you have write `$name' or
2039 `${name}'; to execute the contents of a variable
2040 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002041
wdenk43d96162003-03-06 00:02:04 +00002042 Global environment variables are those you use
2043 setenv/printenv to work with. To run a command stored
2044 in such a variable, you need to use the run command,
2045 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002046
2047 To store commands and special characters in a
2048 variable, please use double quotation marks
2049 surrounding the whole text of the variable, instead
2050 of the backslashes before semicolons and special
2051 symbols.
2052
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002053- Commandline Editing and History:
2054 CONFIG_CMDLINE_EDITING
2055
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002056 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002057 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002058
wdenka8c7c702003-12-06 19:49:23 +00002059- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002060 CONFIG_EXTRA_ENV_SETTINGS
2061
wdenk43d96162003-03-06 00:02:04 +00002062 Define this to contain any number of null terminated
2063 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002064 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002065
wdenk43d96162003-03-06 00:02:04 +00002066 For example, place something like this in your
2067 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002068
2069 #define CONFIG_EXTRA_ENV_SETTINGS \
2070 "myvar1=value1\0" \
2071 "myvar2=value2\0"
2072
wdenk43d96162003-03-06 00:02:04 +00002073 Warning: This method is based on knowledge about the
2074 internal format how the environment is stored by the
2075 U-Boot code. This is NOT an official, exported
2076 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002077 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002078 You better know what you are doing here.
2079
wdenk43d96162003-03-06 00:02:04 +00002080 Note: overly (ab)use of the default environment is
2081 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002082 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002083 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002084
wdenka8c7c702003-12-06 19:49:23 +00002085- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002086 CONFIG_HAS_DATAFLASH
2087
wdenk8bde7f72003-06-27 21:31:46 +00002088 Defining this option enables DataFlash features and
2089 allows to read/write in Dataflash via the standard
2090 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002091
wdenk3f85ce22004-02-23 16:11:30 +00002092- SystemACE Support:
2093 CONFIG_SYSTEMACE
2094
2095 Adding this option adds support for Xilinx SystemACE
2096 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002097 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002098 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002099
2100 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002101 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002102
2103 When SystemACE support is added, the "ace" device type
2104 becomes available to the fat commands, i.e. fatls.
2105
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002106- TFTP Fixed UDP Port:
2107 CONFIG_TFTP_PORT
2108
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002109 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002110 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002111 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002112 number generator is used.
2113
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002114 Also, the environment variable tftpdstp is used to supply
2115 the TFTP UDP destination port value. If tftpdstp isn't
2116 defined, the normal port 69 is used.
2117
2118 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002119 blindly start the TFTP transfer using the pre-configured
2120 target IP address and UDP port. This has the effect of
2121 "punching through" the (Windows XP) firewall, allowing
2122 the remainder of the TFTP transfer to proceed normally.
2123 A better solution is to properly configure the firewall,
2124 but sometimes that is not allowed.
2125
wdenka8c7c702003-12-06 19:49:23 +00002126- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002127 CONFIG_SHOW_BOOT_PROGRESS
2128
wdenk43d96162003-03-06 00:02:04 +00002129 Defining this option allows to add some board-
2130 specific code (calling a user-provided function
2131 "show_boot_progress(int)") that enables you to show
2132 the system's boot progress on some display (for
2133 example, some LED's) on your board. At the moment,
2134 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002135
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002136Legacy uImage format:
2137
wdenkc6097192002-11-03 00:24:07 +00002138 Arg Where When
2139 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002140 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002141 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002142 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002143 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002144 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002145 4 common/cmd_bootm.c Image data has correct checksum
2146 -4 common/cmd_bootm.c Image is for unsupported architecture
2147 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002148 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002149 6 common/cmd_bootm.c Image Type check OK
2150 -6 common/cmd_bootm.c gunzip uncompression error
2151 -7 common/cmd_bootm.c Unimplemented compression type
2152 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002153 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002154 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002155
2156 9 common/image.c Start initial ramdisk verification
2157 -10 common/image.c Ramdisk header has bad magic number
2158 -11 common/image.c Ramdisk header has bad checksum
2159 10 common/image.c Ramdisk header is OK
2160 -12 common/image.c Ramdisk data has bad checksum
2161 11 common/image.c Ramdisk data has correct checksum
2162 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002163 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002164 13 common/image.c Start multifile image verification
2165 14 common/image.c No initial ramdisk, no multifile, continue.
2166
Peter Tyserea0364f2010-04-12 22:28:04 -05002167 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002168
Stefan Roesea47a12b2010-04-15 16:07:28 +02002169 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002170 -31 post/post.c POST test failed, detected by post_output_backlog()
2171 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002172
Heiko Schocher566a4942007-06-22 19:11:54 +02002173 34 common/cmd_doc.c before loading a Image from a DOC device
2174 -35 common/cmd_doc.c Bad usage of "doc" command
2175 35 common/cmd_doc.c correct usage of "doc" command
2176 -36 common/cmd_doc.c No boot device
2177 36 common/cmd_doc.c correct boot device
2178 -37 common/cmd_doc.c Unknown Chip ID on boot device
2179 37 common/cmd_doc.c correct chip ID found, device available
2180 -38 common/cmd_doc.c Read Error on boot device
2181 38 common/cmd_doc.c reading Image header from DOC device OK
2182 -39 common/cmd_doc.c Image header has bad magic number
2183 39 common/cmd_doc.c Image header has correct magic number
2184 -40 common/cmd_doc.c Error reading Image from DOC device
2185 40 common/cmd_doc.c Image header has correct magic number
2186 41 common/cmd_ide.c before loading a Image from a IDE device
2187 -42 common/cmd_ide.c Bad usage of "ide" command
2188 42 common/cmd_ide.c correct usage of "ide" command
2189 -43 common/cmd_ide.c No boot device
2190 43 common/cmd_ide.c boot device found
2191 -44 common/cmd_ide.c Device not available
2192 44 common/cmd_ide.c Device available
2193 -45 common/cmd_ide.c wrong partition selected
2194 45 common/cmd_ide.c partition selected
2195 -46 common/cmd_ide.c Unknown partition table
2196 46 common/cmd_ide.c valid partition table found
2197 -47 common/cmd_ide.c Invalid partition type
2198 47 common/cmd_ide.c correct partition type
2199 -48 common/cmd_ide.c Error reading Image Header on boot device
2200 48 common/cmd_ide.c reading Image Header from IDE device OK
2201 -49 common/cmd_ide.c Image header has bad magic number
2202 49 common/cmd_ide.c Image header has correct magic number
2203 -50 common/cmd_ide.c Image header has bad checksum
2204 50 common/cmd_ide.c Image header has correct checksum
2205 -51 common/cmd_ide.c Error reading Image from IDE device
2206 51 common/cmd_ide.c reading Image from IDE device OK
2207 52 common/cmd_nand.c before loading a Image from a NAND device
2208 -53 common/cmd_nand.c Bad usage of "nand" command
2209 53 common/cmd_nand.c correct usage of "nand" command
2210 -54 common/cmd_nand.c No boot device
2211 54 common/cmd_nand.c boot device found
2212 -55 common/cmd_nand.c Unknown Chip ID on boot device
2213 55 common/cmd_nand.c correct chip ID found, device available
2214 -56 common/cmd_nand.c Error reading Image Header on boot device
2215 56 common/cmd_nand.c reading Image Header from NAND device OK
2216 -57 common/cmd_nand.c Image header has bad magic number
2217 57 common/cmd_nand.c Image header has correct magic number
2218 -58 common/cmd_nand.c Error reading Image from NAND device
2219 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002220
Heiko Schocher566a4942007-06-22 19:11:54 +02002221 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002222
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002223 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002224 -64 net/eth.c no Ethernet found.
2225 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002226
Heiko Schocher566a4942007-06-22 19:11:54 +02002227 -80 common/cmd_net.c usage wrong
2228 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002229 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002230 81 common/cmd_net.c NetLoop() back without error
2231 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2232 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002233 83 common/cmd_net.c running "source" command
2234 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002235 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002236
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002237FIT uImage format:
2238
2239 Arg Where When
2240 100 common/cmd_bootm.c Kernel FIT Image has correct format
2241 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2242 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2243 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2244 102 common/cmd_bootm.c Kernel unit name specified
2245 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002246 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002247 104 common/cmd_bootm.c Got kernel subimage node offset
2248 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2249 105 common/cmd_bootm.c Kernel subimage hash verification OK
2250 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2251 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002252 -106 common/cmd_bootm.c Kernel subimage has wrong type
2253 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002254 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2255 108 common/cmd_bootm.c Got kernel subimage data/size
2256 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2257 -109 common/cmd_bootm.c Can't get kernel subimage type
2258 -110 common/cmd_bootm.c Can't get kernel subimage comp
2259 -111 common/cmd_bootm.c Can't get kernel subimage os
2260 -112 common/cmd_bootm.c Can't get kernel subimage load address
2261 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2262
2263 120 common/image.c Start initial ramdisk verification
2264 -120 common/image.c Ramdisk FIT image has incorrect format
2265 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002266 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002267 -122 common/image.c Can't get configuration for ramdisk subimage
2268 123 common/image.c Ramdisk unit name specified
2269 -124 common/image.c Can't get ramdisk subimage node offset
2270 125 common/image.c Got ramdisk subimage node offset
2271 -125 common/image.c Ramdisk subimage hash verification failed
2272 126 common/image.c Ramdisk subimage hash verification OK
2273 -126 common/image.c Ramdisk subimage for unsupported architecture
2274 127 common/image.c Architecture check OK
2275 -127 common/image.c Can't get ramdisk subimage data/size
2276 128 common/image.c Got ramdisk subimage data/size
2277 129 common/image.c Can't get ramdisk load address
2278 -129 common/image.c Got ramdisk load address
2279
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002280 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002281 131 common/cmd_doc.c FIT image format OK
2282
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002283 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002284 141 common/cmd_ide.c FIT image format OK
2285
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002286 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002287 151 common/cmd_nand.c FIT image format OK
2288
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002289- Standalone program support:
2290 CONFIG_STANDALONE_LOAD_ADDR
2291
Wolfgang Denk6feff892011-10-09 21:06:34 +02002292 This option defines a board specific value for the
2293 address where standalone program gets loaded, thus
2294 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002295 settings.
2296
2297- Frame Buffer Address:
2298 CONFIG_FB_ADDR
2299
2300 Define CONFIG_FB_ADDR if you want to use specific
2301 address for frame buffer.
2302 Then system will reserve the frame buffer address to
2303 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002304 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002305
2306 Please see board_init_f function.
2307
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002308- Automatic software updates via TFTP server
2309 CONFIG_UPDATE_TFTP
2310 CONFIG_UPDATE_TFTP_CNT_MAX
2311 CONFIG_UPDATE_TFTP_MSEC_MAX
2312
2313 These options enable and control the auto-update feature;
2314 for a more detailed description refer to doc/README.update.
2315
2316- MTD Support (mtdparts command, UBI support)
2317 CONFIG_MTD_DEVICE
2318
2319 Adds the MTD device infrastructure from the Linux kernel.
2320 Needed for mtdparts command support.
2321
2322 CONFIG_MTD_PARTITIONS
2323
2324 Adds the MTD partitioning infrastructure from the Linux
2325 kernel. Needed for UBI support.
2326
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002327- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002328 CONFIG_SPL
2329 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002330
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002331 CONFIG_SPL_TEXT_BASE
2332 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002333
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002334 CONFIG_SPL_LDSCRIPT
2335 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002336
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002337 CONFIG_SPL_LIBCOMMON_SUPPORT
2338 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002339
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002340 CONFIG_SPL_LIBDISK_SUPPORT
2341 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002342
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002343 CONFIG_SPL_I2C_SUPPORT
2344 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002345
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002346 CONFIG_SPL_GPIO_SUPPORT
2347 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002348
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002349 CONFIG_SPL_MMC_SUPPORT
2350 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002351
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002352 CONFIG_SPL_SERIAL_SUPPORT
2353 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002354
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002355 CONFIG_SPL_SPI_FLASH_SUPPORT
2356 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002357
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002358 CONFIG_SPL_SPI_SUPPORT
2359 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002360
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002361 CONFIG_SPL_FAT_SUPPORT
2362 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002363
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002364 CONFIG_SPL_LIBGENERIC_SUPPORT
2365 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002366
wdenkc6097192002-11-03 00:24:07 +00002367Modem Support:
2368--------------
2369
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002370[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002371
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002372- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002373 CONFIG_MODEM_SUPPORT
2374
2375- RTS/CTS Flow control enable:
2376 CONFIG_HWFLOW
2377
2378- Modem debug support:
2379 CONFIG_MODEM_SUPPORT_DEBUG
2380
wdenk43d96162003-03-06 00:02:04 +00002381 Enables debugging stuff (char screen[1024], dbg())
2382 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002383
wdenka8c7c702003-12-06 19:49:23 +00002384- Interrupt support (PPC):
2385
wdenkd4ca31c2004-01-02 14:00:00 +00002386 There are common interrupt_init() and timer_interrupt()
2387 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002388 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002389 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002390 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002391 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002392 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002393 specific handling. If board has watchdog / status_led
2394 / other_activity_monitor it works automatically from
2395 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002396
wdenkc6097192002-11-03 00:24:07 +00002397- General:
2398
wdenk43d96162003-03-06 00:02:04 +00002399 In the target system modem support is enabled when a
2400 specific key (key combination) is pressed during
2401 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002402 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002403 board_init(). Currently key_pressed() is a dummy
2404 function, returning 1 and thus enabling modem
2405 initialization.
wdenkc6097192002-11-03 00:24:07 +00002406
wdenk43d96162003-03-06 00:02:04 +00002407 If there are no modem init strings in the
2408 environment, U-Boot proceed to autoboot; the
2409 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002410 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002411
2412 See also: doc/README.Modem
2413
2414
wdenkc6097192002-11-03 00:24:07 +00002415Configuration Settings:
2416-----------------------
2417
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002418- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002419 undefine this when you're short of memory.
2420
Peter Tyser2fb26042009-01-27 18:03:12 -06002421- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2422 width of the commands listed in the 'help' command output.
2423
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002424- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002425 prompt for user input.
2426
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002427- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002428
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002429- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002431- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002432
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002433- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002434 the application (usually a Linux kernel) when it is
2435 booted
2436
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002437- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002438 List of legal baudrate settings for this board.
2439
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002440- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002441 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002442
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002443- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002444 If the board specific function
2445 extern int overwrite_console (void);
2446 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002447 serial port, else the settings in the environment are used.
2448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002449- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002450 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002451
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002452- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002453 Enable overwrite of previous console environment settings.
2454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002455- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002456 Begin and End addresses of the area used by the
2457 simple memory test.
2458
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002459- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002460 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002461
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002462- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002463 Scratch address used by the alternate memory test
2464 You only need to set this if address zero isn't writeable
2465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002466- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2467 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002468 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002469 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002470 fixing up gd->ram_size the Linux kernel should gets passed
2471 the now "corrected" memory size and won't touch it either.
2472 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002473 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002474 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002475 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002476
2477 This option can be used as a workaround for the 440EPx/GRx
2478 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2479 be touched.
2480
2481 WARNING: Please make sure that this value is a multiple of
2482 the Linux page size (normally 4k). If this is not the case,
2483 then the end address of the Linux memory will be located at a
2484 non page size aligned address and this could cause major
2485 problems.
2486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002488 Default load address for network file downloads
2489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002491 Enable temporary baudrate change while serial download
2492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002493- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002494 Physical start address of SDRAM. _Must_ be 0 here.
2495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002496- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002497 Physical start address of Motherboard I/O (if using a
2498 Cogent motherboard)
2499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002501 Physical start address of Flash memory.
2502
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002503- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002504 Physical start address of boot monitor code (set by
2505 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002506 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002507 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002508
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002509- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002510 Size of memory reserved for monitor code, used to
2511 determine _at_compile_time_ (!) if the environment is
2512 embedded within the U-Boot image, or in a separate
2513 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002515- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002516 Size of DRAM reserved for malloc() use.
2517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002518- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002519 Normally compressed uImages are limited to an
2520 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002521 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002522 to adjust this setting to your needs.
2523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002524- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002525 Maximum size of memory mapped by the startup code of
2526 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002527 the Linux kernel (bd_info, boot arguments, FDT blob if
2528 used) must be put below this limit, unless "bootm_low"
2529 enviroment variable is defined and non-zero. In such case
2530 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002531 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2532 variable "bootm_mapsize" will override the value of
2533 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2534 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002535
John Rigbyfca43cc2010-10-13 13:57:35 -06002536- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2537 Enable initrd_high functionality. If defined then the
2538 initrd_high feature is enabled and the bootm ramdisk subcommand
2539 is enabled.
2540
2541- CONFIG_SYS_BOOT_GET_CMDLINE:
2542 Enables allocating and saving kernel cmdline in space between
2543 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2544
2545- CONFIG_SYS_BOOT_GET_KBD:
2546 Enables allocating and saving a kernel copy of the bd_info in
2547 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002549- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002550 Max number of Flash memory banks
2551
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002552- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002553 Max number of sectors on a Flash chip
2554
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002555- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002556 Timeout for Flash erase operations (in ms)
2557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002558- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002559 Timeout for Flash write operations (in ms)
2560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002561- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002562 Timeout for Flash set sector lock bit operation (in ms)
2563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002564- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002565 Timeout for Flash clear lock bits operation (in ms)
2566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002567- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002568 If defined, hardware flash sectors protection is used
2569 instead of U-Boot software protection.
2570
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002571- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002572
2573 Enable TFTP transfers directly to flash memory;
2574 without this option such a download has to be
2575 performed in two steps: (1) download to RAM, and (2)
2576 copy from RAM to flash.
2577
2578 The two-step approach is usually more reliable, since
2579 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002580 the flash, but in some situations (when system RAM is
2581 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002582 downloaded image) this option may be very useful.
2583
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002584- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002585 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002586 common flash structure for storing flash geometry.
2587
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002588- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002589 This option also enables the building of the cfi_flash driver
2590 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002591
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002592- CONFIG_FLASH_CFI_MTD
2593 This option enables the building of the cfi_mtd driver
2594 in the drivers directory. The driver exports CFI flash
2595 to the MTD layer.
2596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002597- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002598 Use buffered writes to flash.
2599
2600- CONFIG_FLASH_SPANSION_S29WS_N
2601 s29ws-n MirrorBit flash has non-standard addresses for buffered
2602 write commands.
2603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002604- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002605 If this option is defined, the common CFI flash doesn't
2606 print it's warning upon not recognized FLASH banks. This
2607 is useful, if some of the configured banks are only
2608 optionally available.
2609
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002610- CONFIG_FLASH_SHOW_PROGRESS
2611 If defined (must be an integer), print out countdown
2612 digits and dots. Recommended value: 45 (9..1) for 80
2613 column displays, 15 (3..1) for 40 column displays.
2614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002615- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002616 Defines the number of Ethernet receive buffers. On some
2617 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002618 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2619 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002620 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002621 Defaults to 4 if not defined.
2622
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002623- CONFIG_ENV_MAX_ENTRIES
2624
Wolfgang Denk071bc922010-10-27 22:48:30 +02002625 Maximum number of entries in the hash table that is used
2626 internally to store the environment settings. The default
2627 setting is supposed to be generous and should work in most
2628 cases. This setting can be used to tune behaviour; see
2629 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002630
wdenkc6097192002-11-03 00:24:07 +00002631The following definitions that deal with the placement and management
2632of environment data (variable area); in general, we support the
2633following configurations:
2634
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002635- CONFIG_BUILD_ENVCRC:
2636
2637 Builds up envcrc with the target environment so that external utils
2638 may easily extract it and embed it in final U-Boot images.
2639
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002640- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002641
2642 Define this if the environment is in flash memory.
2643
2644 a) The environment occupies one whole flash sector, which is
2645 "embedded" in the text segment with the U-Boot code. This
2646 happens usually with "bottom boot sector" or "top boot
2647 sector" type flash chips, which have several smaller
2648 sectors at the start or the end. For instance, such a
2649 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2650 such a case you would place the environment in one of the
2651 4 kB sectors - with U-Boot code before and after it. With
2652 "top boot sector" type flash chips, you would put the
2653 environment in one of the last sectors, leaving a gap
2654 between U-Boot and the environment.
2655
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002656 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002657
2658 Offset of environment data (variable area) to the
2659 beginning of flash memory; for instance, with bottom boot
2660 type flash chips the second sector can be used: the offset
2661 for this sector is given here.
2662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002663 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002664
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002665 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002666
2667 This is just another way to specify the start address of
2668 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002669 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002670
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002671 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002672
2673 Size of the sector containing the environment.
2674
2675
2676 b) Sometimes flash chips have few, equal sized, BIG sectors.
2677 In such a case you don't want to spend a whole sector for
2678 the environment.
2679
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002680 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002681
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002682 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002683 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002684 of this flash sector for the environment. This saves
2685 memory for the RAM copy of the environment.
2686
2687 It may also save flash memory if you decide to use this
2688 when your environment is "embedded" within U-Boot code,
2689 since then the remainder of the flash sector could be used
2690 for U-Boot code. It should be pointed out that this is
2691 STRONGLY DISCOURAGED from a robustness point of view:
2692 updating the environment in flash makes it always
2693 necessary to erase the WHOLE sector. If something goes
2694 wrong before the contents has been restored from a copy in
2695 RAM, your target system will be dead.
2696
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002697 - CONFIG_ENV_ADDR_REDUND
2698 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002699
wdenk43d96162003-03-06 00:02:04 +00002700 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002701 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002702 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002703 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002704
2705BE CAREFUL! Any changes to the flash layout, and some changes to the
2706source code will make it necessary to adapt <board>/u-boot.lds*
2707accordingly!
2708
2709
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002710- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002711
2712 Define this if you have some non-volatile memory device
2713 (NVRAM, battery buffered SRAM) which you want to use for the
2714 environment.
2715
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002716 - CONFIG_ENV_ADDR:
2717 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002718
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002719 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002720 want to use for environment. It is assumed that this memory
2721 can just be read and written to, without any special
2722 provision.
2723
2724BE CAREFUL! The first access to the environment happens quite early
2725in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002726console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002727U-Boot will hang.
2728
2729Please note that even with NVRAM we still use a copy of the
2730environment in RAM: we could work on NVRAM directly, but we want to
2731keep settings there always unmodified except somebody uses "saveenv"
2732to save the current settings.
2733
2734
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002735- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002736
2737 Use this if you have an EEPROM or similar serial access
2738 device and a driver for it.
2739
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002740 - CONFIG_ENV_OFFSET:
2741 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002742
2743 These two #defines specify the offset and size of the
2744 environment area within the total memory of your EEPROM.
2745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002746 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002747 If defined, specified the chip address of the EEPROM device.
2748 The default address is zero.
2749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002750 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002751 If defined, the number of bits used to address bytes in a
2752 single page in the EEPROM device. A 64 byte page, for example
2753 would require six bits.
2754
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002755 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002756 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002757 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002758
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002759 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002760 The length in bytes of the EEPROM memory array address. Note
2761 that this is NOT the chip address length!
2762
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002763 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002764 EEPROM chips that implement "address overflow" are ones
2765 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2766 address and the extra bits end up in the "chip address" bit
2767 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2768 byte chips.
2769
2770 Note that we consider the length of the address field to
2771 still be one byte because the extra address bits are hidden
2772 in the chip address.
2773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002774 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002775 The size in bytes of the EEPROM device.
2776
Heiko Schocher548738b2010-01-07 08:55:40 +01002777 - CONFIG_ENV_EEPROM_IS_ON_I2C
2778 define this, if you have I2C and SPI activated, and your
2779 EEPROM, which holds the environment, is on the I2C bus.
2780
2781 - CONFIG_I2C_ENV_EEPROM_BUS
2782 if you have an Environment on an EEPROM reached over
2783 I2C muxes, you can define here, how to reach this
2784 EEPROM. For example:
2785
Wolfgang Denka9046b92010-06-13 17:48:15 +02002786 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002787
2788 EEPROM which holds the environment, is reached over
2789 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002790
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002791- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002792
wdenkd4ca31c2004-01-02 14:00:00 +00002793 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002794 want to use for the environment.
2795
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002796 - CONFIG_ENV_OFFSET:
2797 - CONFIG_ENV_ADDR:
2798 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002799
2800 These three #defines specify the offset and size of the
2801 environment area within the total memory of your DataFlash placed
2802 at the specified address.
2803
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002804- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002805
2806 Define this if you have a NAND device which you want to use
2807 for the environment.
2808
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002809 - CONFIG_ENV_OFFSET:
2810 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002811
2812 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002813 area within the first NAND device. CONFIG_ENV_OFFSET must be
2814 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002815
Scott Woodfdd813d2010-09-17 14:38:37 -05002816 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002817
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002818 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002819 size used to hold a redundant copy of the environment data, so
2820 that there is a valid backup copy in case there is a power failure
2821 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2822 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002823
Scott Woodfdd813d2010-09-17 14:38:37 -05002824 - CONFIG_ENV_RANGE (optional):
2825
2826 Specifies the length of the region in which the environment
2827 can be written. This should be a multiple of the NAND device's
2828 block size. Specifying a range with more erase blocks than
2829 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2830 the range to be avoided.
2831
2832 - CONFIG_ENV_OFFSET_OOB (optional):
2833
2834 Enables support for dynamically retrieving the offset of the
2835 environment from block zero's out-of-band data. The
2836 "nand env.oob" command can be used to record this offset.
2837 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2838 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002839
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002840- CONFIG_NAND_ENV_DST
2841
2842 Defines address in RAM to which the nand_spl code should copy the
2843 environment. If redundant environment is used, it will be copied to
2844 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2845
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002846- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002847
2848 Defines offset to the initial SPI buffer area in DPRAM. The
2849 area is used at an early stage (ROM part) if the environment
2850 is configured to reside in the SPI EEPROM: We need a 520 byte
2851 scratch DPRAM area. It is used between the two initialization
2852 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2853 to be a good choice since it makes it far enough from the
2854 start of the data area as well as from the stack pointer.
2855
Bruce Adlere881cb52007-11-02 13:15:42 -07002856Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002857has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002858created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002859until then to read environment variables.
2860
wdenk85ec0bc2003-03-31 16:34:49 +00002861The environment is protected by a CRC32 checksum. Before the monitor
2862is relocated into RAM, as a result of a bad CRC you will be working
2863with the compiled-in default environment - *silently*!!! [This is
2864necessary, because the first environment variable we need is the
2865"baudrate" setting for the console - if we have a bad CRC, we don't
2866have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002867
2868Note: once the monitor has been relocated, then it will complain if
2869the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002870use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002872- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002873 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002875 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002876 also needs to be defined.
2877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002878- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002879 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002880
Ron Madridf5675aa2009-02-18 14:30:44 -08002881- CONFIG_NS16550_MIN_FUNCTIONS:
2882 Define this if you desire to only have use of the NS16550_init
2883 and NS16550_putc functions for the serial driver located at
2884 drivers/serial/ns16550.c. This option is useful for saving
2885 space for already greatly restricted images, including but not
2886 limited to NAND_SPL configurations.
2887
wdenkc6097192002-11-03 00:24:07 +00002888Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002889---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002891- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002892 Cache Line Size of the CPU.
2893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002894- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002895 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002896
wdenk42d1f032003-10-15 23:53:47 +00002897 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2898 and RPXsuper) to be able to adjust the position of
2899 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002900
Timur Tabie46fedf2011-08-04 18:03:41 -05002901- CONFIG_SYS_CCSRBAR_DEFAULT:
2902 Default (power-on reset) physical address of CCSR on Freescale
2903 PowerPC SOCs.
2904
2905- CONFIG_SYS_CCSRBAR:
2906 Virtual address of CCSR. On a 32-bit build, this is typically
2907 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2908
2909 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2910 for cross-platform code that uses that macro instead.
2911
2912- CONFIG_SYS_CCSRBAR_PHYS:
2913 Physical address of CCSR. CCSR can be relocated to a new
2914 physical address, if desired. In this case, this macro should
2915 be set to that address. Otherwise, it should be set to the
2916 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2917 is typically relocated on 36-bit builds. It is recommended
2918 that this macro be defined via the _HIGH and _LOW macros:
2919
2920 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2921 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2922
2923- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002924 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2925 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002926 used in assembly code, so it must not contain typecasts or
2927 integer size suffixes (e.g. "ULL").
2928
2929- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2930 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2931 used in assembly code, so it must not contain typecasts or
2932 integer size suffixes (e.g. "ULL").
2933
2934- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2935 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2936 forced to a value that ensures that CCSR is not relocated.
2937
wdenk7f6c2cb2002-11-10 22:06:23 +00002938- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002939 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002940
2941 the default drive number (default value 0)
2942
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002943 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002944
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002945 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002946 (default value 1)
2947
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002948 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002949
wdenk43d96162003-03-06 00:02:04 +00002950 defines the offset of register from address. It
2951 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002952 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002954 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2955 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002956 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002957
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002958 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002959 fdc_hw_init() is called at the beginning of the FDC
2960 setup. fdc_hw_init() must be provided by the board
2961 source code. It is used to make hardware dependant
2962 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002963
Macpaul Lin0abddf82011-04-11 20:45:32 +00002964- CONFIG_IDE_AHB:
2965 Most IDE controllers were designed to be connected with PCI
2966 interface. Only few of them were designed for AHB interface.
2967 When software is doing ATA command and data transfer to
2968 IDE devices through IDE-AHB controller, some additional
2969 registers accessing to these kind of IDE-AHB controller
2970 is requierd.
2971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002972- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002973 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002974 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002976- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002977
wdenk7152b1d2003-09-05 23:19:14 +00002978 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002979 initial data and stack; please note that this must be
2980 writable memory that is working WITHOUT special
2981 initialization, i. e. you CANNOT use normal RAM which
2982 will become available only after programming the
2983 memory controller and running certain initialization
2984 sequences.
2985
2986 U-Boot uses the following memory types:
2987 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2988 - MPC824X: data cache
2989 - PPC4xx: data cache
2990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002991- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002992
2993 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002994 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2995 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002996 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002997 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002998 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2999 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3000 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003001
3002 Note:
3003 On the MPC824X (or other systems that use the data
3004 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003005 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003006 point to an otherwise UNUSED address space between
3007 the top of RAM and the start of the PCI space.
3008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003009- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003010
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003011- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003013- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003015- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003016
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003017- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003019- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003020
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003021- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003022 SDRAM timing
3023
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003024- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003025 periodic timer for refresh
3026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003028
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003029- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3030 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3031 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3032 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003033 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3034
3035- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003036 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3037 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003038 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3039
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003040- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3041 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003042 Machine Mode Register and Memory Periodic Timer
3043 Prescaler definitions (SDRAM timing)
3044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003045- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003046 enable I2C microcode relocation patch (MPC8xx);
3047 define relocation offset in DPRAM [DSP2]
3048
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003049- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003050 enable SMC microcode relocation patch (MPC8xx);
3051 define relocation offset in DPRAM [SMC1]
3052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003053- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003054 enable SPI microcode relocation patch (MPC8xx);
3055 define relocation offset in DPRAM [SCC4]
3056
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003057- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003058 Use OSCM clock mode on MBX8xx board. Be careful,
3059 wrong setting might damage your board. Read
3060 doc/README.MBX before setting this variable!
3061
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003062- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003063 Offset of the bootmode word in DPRAM used by post
3064 (Power On Self Tests). This definition overrides
3065 #define'd default value in commproc.h resp.
3066 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003067
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003068- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3069 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3070 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3071 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3072 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3073 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3074 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3075 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003076 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003077
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003078- CONFIG_PCI_DISABLE_PCIE:
3079 Disable PCI-Express on systems where it is supported but not
3080 required.
3081
Kumar Galaa09b9b62010-12-30 12:09:53 -06003082- CONFIG_SYS_SRIO:
3083 Chip has SRIO or not
3084
3085- CONFIG_SRIO1:
3086 Board has SRIO 1 port available
3087
3088- CONFIG_SRIO2:
3089 Board has SRIO 2 port available
3090
3091- CONFIG_SYS_SRIOn_MEM_VIRT:
3092 Virtual Address of SRIO port 'n' memory region
3093
3094- CONFIG_SYS_SRIOn_MEM_PHYS:
3095 Physical Address of SRIO port 'n' memory region
3096
3097- CONFIG_SYS_SRIOn_MEM_SIZE:
3098 Size of SRIO port 'n' memory region
3099
Alex Watermaneced4622011-05-19 15:08:36 -04003100- CONFIG_SYS_NDFC_16
3101 Defined to tell the NDFC that the NAND chip is using a
3102 16 bit bus.
3103
3104- CONFIG_SYS_NDFC_EBC0_CFG
3105 Sets the EBC0_CFG register for the NDFC. If not defined
3106 a default value will be used.
3107
Ben Warrenbb99ad62006-09-07 16:50:54 -04003108- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003109 Get DDR timing information from an I2C EEPROM. Common
3110 with pluggable memory modules such as SODIMMs
3111
Ben Warrenbb99ad62006-09-07 16:50:54 -04003112 SPD_EEPROM_ADDRESS
3113 I2C address of the SPD EEPROM
3114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003116 If SPD EEPROM is on an I2C bus other than the first
3117 one, specify here. Note that the value must resolve
3118 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003119
York Sun1b3e3c42011-06-07 09:42:16 +08003120- CONFIG_SYS_DDR_RAW_TIMING
3121 Get DDR timing information from other than SPD. Common with
3122 soldered DDR chips onboard without SPD. DDR raw timing
3123 parameters are extracted from datasheet and hard-coded into
3124 header files or board specific files.
3125
York Sun6f5e1dc2011-09-16 13:21:35 -07003126- CONFIG_FSL_DDR_INTERACTIVE
3127 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3128
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003129- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003130 Only for 83xx systems. If specified, then DDR should
3131 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003132
wdenkc26e4542004-04-18 10:13:26 +00003133- CONFIG_ETHER_ON_FEC[12]
3134 Define to enable FEC[12] on a 8xx series processor.
3135
3136- CONFIG_FEC[12]_PHY
3137 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003138 to the given FEC; i. e.
3139 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003140 means that the PHY with address 4 is connected to FEC1
3141
3142 When set to -1, means to probe for first available.
3143
3144- CONFIG_FEC[12]_PHY_NORXERR
3145 The PHY does not have a RXERR line (RMII only).
3146 (so program the FEC to ignore it).
3147
3148- CONFIG_RMII
3149 Enable RMII mode for all FECs.
3150 Note that this is a global option, we can't
3151 have one FEC in standard MII mode and another in RMII mode.
3152
wdenk5cf91d62004-04-23 20:32:05 +00003153- CONFIG_CRC32_VERIFY
3154 Add a verify option to the crc32 command.
3155 The syntax is:
3156
3157 => crc32 -v <address> <count> <crc32>
3158
3159 Where address/count indicate a memory area
3160 and crc32 is the correct crc32 which the
3161 area should have.
3162
wdenk56523f12004-07-11 17:40:54 +00003163- CONFIG_LOOPW
3164 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003165 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003166
stroese7b466642004-12-16 18:46:55 +00003167- CONFIG_MX_CYCLIC
3168 Add the "mdc" and "mwc" memory commands. These are cyclic
3169 "md/mw" commands.
3170 Examples:
3171
wdenkefe2a4d2004-12-16 21:44:03 +00003172 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003173 This command will print 4 bytes (10,11,12,13) each 500 ms.
3174
wdenkefe2a4d2004-12-16 21:44:03 +00003175 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003176 This command will write 12345678 to address 100 all 10 ms.
3177
wdenkefe2a4d2004-12-16 21:44:03 +00003178 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003179 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003180
wdenk8aa1a2d2005-04-04 12:44:11 +00003181- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003182 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003183 low level initializations (like setting up the memory
3184 controller) are omitted and/or U-Boot does not
3185 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003186
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003187 Normally this variable MUST NOT be defined. The only
3188 exception is when U-Boot is loaded (to RAM) by some
3189 other boot loader or by a debugger which performs
3190 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003191
Aneesh V401bb302011-07-13 05:11:07 +00003192- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003193 Modifies the behaviour of start.S when compiling a loader
3194 that is executed before the actual U-Boot. E.g. when
3195 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003196
Matthias Weisserd8834a12011-03-10 21:36:32 +00003197- CONFIG_USE_ARCH_MEMCPY
3198 CONFIG_USE_ARCH_MEMSET
3199 If these options are used a optimized version of memcpy/memset will
3200 be used if available. These functions may be faster under some
3201 conditions but may increase the binary size.
3202
wdenkc6097192002-11-03 00:24:07 +00003203Building the Software:
3204======================
3205
Wolfgang Denk218ca722008-03-26 10:40:12 +01003206Building U-Boot has been tested in several native build environments
3207and in many different cross environments. Of course we cannot support
3208all possibly existing versions of cross development tools in all
3209(potentially obsolete) versions. In case of tool chain problems we
3210recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3211which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003212
Wolfgang Denk218ca722008-03-26 10:40:12 +01003213If you are not using a native environment, it is assumed that you
3214have GNU cross compiling tools available in your path. In this case,
3215you must set the environment variable CROSS_COMPILE in your shell.
3216Note that no changes to the Makefile or any other source files are
3217necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003218
Wolfgang Denk218ca722008-03-26 10:40:12 +01003219 $ CROSS_COMPILE=ppc_4xx-
3220 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003221
Peter Tyser2f8d3962009-03-13 18:54:51 -05003222Note: If you wish to generate Windows versions of the utilities in
3223 the tools directory you can use the MinGW toolchain
3224 (http://www.mingw.org). Set your HOST tools to the MinGW
3225 toolchain and execute 'make tools'. For example:
3226
3227 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3228
3229 Binaries such as tools/mkimage.exe will be created which can
3230 be executed on computers running Windows.
3231
Wolfgang Denk218ca722008-03-26 10:40:12 +01003232U-Boot is intended to be simple to build. After installing the
3233sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003234is done by typing:
3235
3236 make NAME_config
3237
Wolfgang Denk218ca722008-03-26 10:40:12 +01003238where "NAME_config" is the name of one of the existing configu-
3239rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003240
wdenk2729af92004-05-03 20:45:30 +00003241Note: for some board special configuration names may exist; check if
3242 additional information is available from the board vendor; for
3243 instance, the TQM823L systems are available without (standard)
3244 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003245 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003246
wdenk2729af92004-05-03 20:45:30 +00003247 make TQM823L_config
3248 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003249
wdenk2729af92004-05-03 20:45:30 +00003250 make TQM823L_LCD_config
3251 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253 etc.
wdenkc6097192002-11-03 00:24:07 +00003254
wdenkc6097192002-11-03 00:24:07 +00003255
wdenk2729af92004-05-03 20:45:30 +00003256Finally, type "make all", and you should get some working U-Boot
3257images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk2729af92004-05-03 20:45:30 +00003259- "u-boot.bin" is a raw binary image
3260- "u-boot" is an image in ELF binary format
3261- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003262
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003263By default the build is performed locally and the objects are saved
3264in the source directory. One of the two methods can be used to change
3265this behavior and build U-Boot to some external directory:
3266
32671. Add O= to the make command line invocations:
3268
3269 make O=/tmp/build distclean
3270 make O=/tmp/build NAME_config
3271 make O=/tmp/build all
3272
32732. Set environment variable BUILD_DIR to point to the desired location:
3274
3275 export BUILD_DIR=/tmp/build
3276 make distclean
3277 make NAME_config
3278 make all
3279
3280Note that the command line "O=" setting overrides the BUILD_DIR environment
3281variable.
3282
wdenkc6097192002-11-03 00:24:07 +00003283
wdenk2729af92004-05-03 20:45:30 +00003284Please be aware that the Makefiles assume you are using GNU make, so
3285for instance on NetBSD you might need to use "gmake" instead of
3286native "make".
wdenkc6097192002-11-03 00:24:07 +00003287
wdenkc6097192002-11-03 00:24:07 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289If the system board that you have is not listed, then you will need
3290to port U-Boot to your hardware platform. To do this, follow these
3291steps:
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +000032931. Add a new configuration option for your board to the toplevel
3294 "Makefile" and to the "MAKEALL" script, using the existing
3295 entries as examples. Note that here and at many other places
3296 boards and other names are listed in alphabetical sort order. Please
3297 keep this order.
32982. Create a new directory to hold your board specific code. Add any
3299 files you need. In your board directory, you will need at least
3300 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
33013. Create a new configuration file "include/configs/<board>.h" for
3302 your board
33033. If you're porting U-Boot to a new CPU, then also create a new
3304 directory to hold your CPU specific code. Add any files you need.
33054. Run "make <board>_config" with your new name.
33065. Type "make", and you should get a working "u-boot.srec" file
3307 to be installed on your target system.
33086. Debug and solve any problems that might arise.
3309 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003310
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3313==============================================================
wdenkc6097192002-11-03 00:24:07 +00003314
Wolfgang Denk218ca722008-03-26 10:40:12 +01003315If you have modified U-Boot sources (for instance added a new board
3316or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003317provide feedback to the other developers. The feedback normally takes
3318the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003319official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003320
Wolfgang Denk218ca722008-03-26 10:40:12 +01003321But before you submit such a patch, please verify that your modifi-
3322cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003323the supported boards compile WITHOUT ANY compiler warnings. To do so,
3324just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003325for ALL supported system. Be warned, this will take a while. You can
3326select which (cross) compiler to use by passing a `CROSS_COMPILE'
3327environment variable to the script, i. e. to use the ELDK cross tools
3328you can type
wdenkc6097192002-11-03 00:24:07 +00003329
wdenk2729af92004-05-03 20:45:30 +00003330 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003331
wdenk2729af92004-05-03 20:45:30 +00003332or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003333
wdenk2729af92004-05-03 20:45:30 +00003334 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003335
Wolfgang Denk218ca722008-03-26 10:40:12 +01003336When using the MAKEALL script, the default behaviour is to build
3337U-Boot in the source directory. This location can be changed by
3338setting the BUILD_DIR environment variable. Also, for each target
3339built, the MAKEALL script saves two log files (<target>.ERR and
3340<target>.MAKEALL) in the <source dir>/LOG directory. This default
3341location can be changed by setting the MAKEALL_LOGDIR environment
3342variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003343
3344 export BUILD_DIR=/tmp/build
3345 export MAKEALL_LOGDIR=/tmp/log
3346 CROSS_COMPILE=ppc_8xx- MAKEALL
3347
Wolfgang Denk218ca722008-03-26 10:40:12 +01003348With the above settings build objects are saved in the /tmp/build,
3349log files are saved in the /tmp/log and the source tree remains clean
3350during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003351
3352
wdenk2729af92004-05-03 20:45:30 +00003353See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003354
wdenkc6097192002-11-03 00:24:07 +00003355
wdenk2729af92004-05-03 20:45:30 +00003356Monitor Commands - Overview:
3357============================
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359go - start application at address 'addr'
3360run - run commands in an environment variable
3361bootm - boot application image from memory
3362bootp - boot image via network using BootP/TFTP protocol
3363tftpboot- boot image via network using TFTP protocol
3364 and env variables "ipaddr" and "serverip"
3365 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003366tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003367rarpboot- boot image via network using RARP/TFTP protocol
3368diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3369loads - load S-Record file over serial line
3370loadb - load binary file over serial line (kermit mode)
3371md - memory display
3372mm - memory modify (auto-incrementing)
3373nm - memory modify (constant address)
3374mw - memory write (fill)
3375cp - memory copy
3376cmp - memory compare
3377crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003378i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003379sspi - SPI utility commands
3380base - print or set address offset
3381printenv- print environment variables
3382setenv - set environment variables
3383saveenv - save environment variables to persistent storage
3384protect - enable or disable FLASH write protection
3385erase - erase FLASH memory
3386flinfo - print FLASH memory information
3387bdinfo - print Board Info structure
3388iminfo - print header information for application image
3389coninfo - print console devices and informations
3390ide - IDE sub-system
3391loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003392loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003393mtest - simple RAM test
3394icache - enable or disable instruction cache
3395dcache - enable or disable data cache
3396reset - Perform RESET of the CPU
3397echo - echo args to console
3398version - print monitor version
3399help - print online help
3400? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003401
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403Monitor Commands - Detailed Description:
3404========================================
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406TODO.
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk2729af92004-05-03 20:45:30 +00003408For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003409
3410
wdenk2729af92004-05-03 20:45:30 +00003411Environment Variables:
3412======================
wdenkc6097192002-11-03 00:24:07 +00003413
wdenk2729af92004-05-03 20:45:30 +00003414U-Boot supports user configuration using Environment Variables which
3415can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003416
wdenk2729af92004-05-03 20:45:30 +00003417Environment Variables are set using "setenv", printed using
3418"printenv", and saved to Flash using "saveenv". Using "setenv"
3419without a value can be used to delete a variable from the
3420environment. As long as you don't save the environment you are
3421working with an in-memory copy. In case the Flash area containing the
3422environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003423
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003424Some configuration options can be set using Environment Variables.
3425
3426List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003427
wdenk2729af92004-05-03 20:45:30 +00003428 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003433
wdenk2729af92004-05-03 20:45:30 +00003434 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003437
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003438 bootm_low - Memory range available for image processing in the bootm
3439 command can be restricted. This variable is given as
3440 a hexadecimal number and defines lowest address allowed
3441 for use by the bootm command. See also "bootm_size"
3442 environment variable. Address defined by "bootm_low" is
3443 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003444 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3445 bootm_mapsize.
3446
3447 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3448 This variable is given as a hexadecimal number and it
3449 defines the size of the memory region starting at base
3450 address bootm_low that is accessible by the Linux kernel
3451 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3452 as the default value if it is defined, and bootm_size is
3453 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003454
3455 bootm_size - Memory range available for image processing in the bootm
3456 command can be restricted. This variable is given as
3457 a hexadecimal number and defines the size of the region
3458 allowed for use by the bootm command. See also "bootm_low"
3459 environment variable.
3460
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003461 updatefile - Location of the software update file on a TFTP server, used
3462 by the automatic software update feature. Please refer to
3463 documentation in doc/README.update for more details.
3464
wdenk2729af92004-05-03 20:45:30 +00003465 autoload - if set to "no" (any string beginning with 'n'),
3466 "bootp" will just load perform a lookup of the
3467 configuration from the BOOTP server, but not try to
3468 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003469
wdenk2729af92004-05-03 20:45:30 +00003470 autostart - if set to "yes", an image loaded using the "bootp",
3471 "rarpboot", "tftpboot" or "diskboot" commands will
3472 be automatically started (by internally calling
3473 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003474
wdenk2729af92004-05-03 20:45:30 +00003475 If set to "no", a standalone image passed to the
3476 "bootm" command will be copied to the load address
3477 (and eventually uncompressed), but NOT be started.
3478 This can be used to load and uncompress arbitrary
3479 data.
wdenkc6097192002-11-03 00:24:07 +00003480
David A. Longa28afca2011-07-09 16:40:19 -04003481 fdt_high - if set this restricts the maximum address that the
3482 flattened device tree will be copied into upon boot.
3483 If this is set to the special value 0xFFFFFFFF then
3484 the fdt will not be copied at all on boot. For this
3485 to work it must reside in writable memory, have
3486 sufficient padding on the end of it for u-boot to
3487 add the information it needs into it, and the memory
3488 must be accessible by the kernel.
3489
wdenk17ea1172004-06-06 21:51:03 +00003490 i2cfast - (PPC405GP|PPC405EP only)
3491 if set to 'y' configures Linux I2C driver for fast
3492 mode (400kHZ). This environment variable is used in
3493 initialization code. So, for changes to be effective
3494 it must be saved and board must be reset.
3495
wdenk2729af92004-05-03 20:45:30 +00003496 initrd_high - restrict positioning of initrd images:
3497 If this variable is not set, initrd images will be
3498 copied to the highest possible address in RAM; this
3499 is usually what you want since it allows for
3500 maximum initrd size. If for some reason you want to
3501 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003502 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003503 variable to a value of "no" or "off" or "0".
3504 Alternatively, you can set it to a maximum upper
3505 address to use (U-Boot will still check that it
3506 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508 For instance, when you have a system with 16 MB
3509 RAM, and want to reserve 4 MB from use by Linux,
3510 you can do this by adding "mem=12M" to the value of
3511 the "bootargs" variable. However, now you must make
3512 sure that the initrd image is placed in the first
3513 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003514
wdenk2729af92004-05-03 20:45:30 +00003515 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003516
wdenk2729af92004-05-03 20:45:30 +00003517 If you set initrd_high to 0xFFFFFFFF, this is an
3518 indication to U-Boot that all addresses are legal
3519 for the Linux kernel, including addresses in flash
3520 memory. In this case U-Boot will NOT COPY the
3521 ramdisk at all. This may be useful to reduce the
3522 boot time on your system, but requires that this
3523 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003526
wdenk2729af92004-05-03 20:45:30 +00003527 loadaddr - Default load address for commands like "bootp",
3528 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003529
wdenk2729af92004-05-03 20:45:30 +00003530 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003531
wdenk2729af92004-05-03 20:45:30 +00003532 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003533
wdenk2729af92004-05-03 20:45:30 +00003534 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003535
wdenk2729af92004-05-03 20:45:30 +00003536 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk2729af92004-05-03 20:45:30 +00003538 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003539
Mike Frysingere2a53452011-10-02 10:01:27 +00003540 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003541
Mike Frysingere2a53452011-10-02 10:01:27 +00003542 ethact - controls which interface is currently active.
3543 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003544
Heiko Schocher48690d82010-07-20 17:45:02 +02003545 => setenv ethact FEC
3546 => ping 192.168.0.1 # traffic sent on FEC
3547 => setenv ethact SCC
3548 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003549
Matthias Fuchse1692572008-01-17 07:45:05 +01003550 ethrotate - When set to "no" U-Boot does not go through all
3551 available network interfaces.
3552 It just stays at the currently selected interface.
3553
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003554 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003555 either succeed or fail without retrying.
3556 When set to "once" the network operation will
3557 fail when all the available network interfaces
3558 are tried once without success.
3559 Useful on scripts which control the retry operation
3560 themselves.
wdenkc6097192002-11-03 00:24:07 +00003561
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003562 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003563
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003564 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003565 UDP source port.
3566
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003567 tftpdstport - If this is set, the value is used for TFTP's UDP
3568 destination port instead of the Well Know Port 69.
3569
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003570 tftpblocksize - Block size to use for TFTP transfers; if not set,
3571 we use the TFTP server's default block size
3572
3573 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3574 seconds, minimum value is 1000 = 1 second). Defines
3575 when a packet is considered to be lost so it has to
3576 be retransmitted. The default is 5000 = 5 seconds.
3577 Lowering this value may make downloads succeed
3578 faster in networks with high packet loss rates or
3579 with unreliable TFTP servers.
3580
3581 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003582 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003583 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003584
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003585The following image location variables contain the location of images
3586used in booting. The "Image" column gives the role of the image and is
3587not an environment variable name. The other columns are environment
3588variable names. "File Name" gives the name of the file on a TFTP
3589server, "RAM Address" gives the location in RAM the image will be
3590loaded to, and "Flash Location" gives the image's address in NOR
3591flash or offset in NAND flash.
3592
3593*Note* - these variables don't have to be defined for all boards, some
3594boards currenlty use other variables for these purposes, and some
3595boards use these variables for other purposes.
3596
3597Image File Name RAM Address Flash Location
3598----- --------- ----------- --------------
3599u-boot u-boot u-boot_addr_r u-boot_addr
3600Linux kernel bootfile kernel_addr_r kernel_addr
3601device tree blob fdtfile fdt_addr_r fdt_addr
3602ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
3603
wdenk2729af92004-05-03 20:45:30 +00003604The following environment variables may be used and automatically
3605updated by the network boot commands ("bootp" and "rarpboot"),
3606depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003607
wdenk2729af92004-05-03 20:45:30 +00003608 bootfile - see above
3609 dnsip - IP address of your Domain Name Server
3610 dnsip2 - IP address of your secondary Domain Name Server
3611 gatewayip - IP address of the Gateway (Router) to use
3612 hostname - Target hostname
3613 ipaddr - see above
3614 netmask - Subnet Mask
3615 rootpath - Pathname of the root filesystem on the NFS server
3616 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003617
wdenka3d991b2004-04-15 21:48:45 +00003618
wdenk2729af92004-05-03 20:45:30 +00003619There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003620
wdenk2729af92004-05-03 20:45:30 +00003621 serial# - contains hardware identification information such
3622 as type string and/or serial number
3623 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625These variables can be set only once (usually during manufacturing of
3626the board). U-Boot refuses to delete or overwrite these variables
3627once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003628
3629
wdenk2729af92004-05-03 20:45:30 +00003630Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk2729af92004-05-03 20:45:30 +00003632 ver - Contains the U-Boot version string as printed
3633 with the "version" command. This variable is
3634 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003635
wdenkc6097192002-11-03 00:24:07 +00003636
wdenk2729af92004-05-03 20:45:30 +00003637Please note that changes to some configuration parameters may take
3638only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003639
stroesec1551ea2003-04-04 15:53:41 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641Command Line Parsing:
3642=====================
stroesec1551ea2003-04-04 15:53:41 +00003643
wdenk2729af92004-05-03 20:45:30 +00003644There are two different command line parsers available with U-Boot:
3645the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003646
wdenk2729af92004-05-03 20:45:30 +00003647Old, simple command line parser:
3648--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003649
wdenk2729af92004-05-03 20:45:30 +00003650- supports environment variables (through setenv / saveenv commands)
3651- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003652- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003653- special characters ('$', ';') can be escaped by prefixing with '\',
3654 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003655 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003656- You can also escape text by enclosing in single apostrophes, for example:
3657 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659Hush shell:
3660-----------
wdenkf07771c2003-05-28 08:06:31 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662- similar to Bourne shell, with control structures like
3663 if...then...else...fi, for...do...done; while...do...done,
3664 until...do...done, ...
3665- supports environment ("global") variables (through setenv / saveenv
3666 commands) and local shell variables (through standard shell syntax
3667 "name=value"); only environment variables can be used with "run"
3668 command
wdenkf07771c2003-05-28 08:06:31 +00003669
wdenk2729af92004-05-03 20:45:30 +00003670General rules:
3671--------------
wdenkf07771c2003-05-28 08:06:31 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673(1) If a command line (or an environment variable executed by a "run"
3674 command) contains several commands separated by semicolon, and
3675 one of these commands fails, then the remaining commands will be
3676 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003679 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003680 command will cause "run" to terminate, i. e. the remaining
3681 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003682
wdenk2729af92004-05-03 20:45:30 +00003683Note for Redundant Ethernet Interfaces:
3684=======================================
wdenkf07771c2003-05-28 08:06:31 +00003685
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003686Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003687such configurations and is capable of automatic selection of a
3688"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003689
wdenk2729af92004-05-03 20:45:30 +00003690Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3691MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3692"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694If the network interface stores some valid MAC address (for instance
3695in SROM), this is used as default address if there is NO correspon-
3696ding setting in the environment; if the corresponding environment
3697variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003698
wdenk2729af92004-05-03 20:45:30 +00003699o If the SROM has a valid MAC address, and there is no address in the
3700 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003701
wdenk2729af92004-05-03 20:45:30 +00003702o If there is no valid address in the SROM, and a definition in the
3703 environment exists, then the value from the environment variable is
3704 used.
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk2729af92004-05-03 20:45:30 +00003706o If both the SROM and the environment contain a MAC address, and
3707 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003708
wdenk2729af92004-05-03 20:45:30 +00003709o If both the SROM and the environment contain a MAC address, and the
3710 addresses differ, the value from the environment is used and a
3711 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713o If neither SROM nor the environment contain a MAC address, an error
3714 is raised.
wdenkc6097192002-11-03 00:24:07 +00003715
Ben Warrenecee9322010-04-26 11:11:46 -07003716If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3717will be programmed into hardware as part of the initialization process. This
3718may be skipped by setting the appropriate 'ethmacskip' environment variable.
3719The naming convention is as follows:
3720"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk2729af92004-05-03 20:45:30 +00003722Image Formats:
3723==============
wdenkc6097192002-11-03 00:24:07 +00003724
Marian Balakowicz3310c542008-03-12 12:13:13 +01003725U-Boot is capable of booting (and performing other auxiliary operations on)
3726images in two formats:
3727
3728New uImage format (FIT)
3729-----------------------
3730
3731Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3732to Flattened Device Tree). It allows the use of images with multiple
3733components (several kernels, ramdisks, etc.), with contents protected by
3734SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3735
3736
3737Old uImage format
3738-----------------
3739
3740Old image format is based on binary files which can be basically anything,
3741preceded by a special header; see the definitions in include/image.h for
3742details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003743
wdenk2729af92004-05-03 20:45:30 +00003744* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3745 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003746 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3747 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3748 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003749* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003750 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3751 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003752* Compression Type (uncompressed, gzip, bzip2)
3753* Load Address
3754* Entry Point
3755* Image Name
3756* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003757
wdenk2729af92004-05-03 20:45:30 +00003758The header is marked by a special Magic Number, and both the header
3759and the data portions of the image are secured against corruption by
3760CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003761
wdenkc6097192002-11-03 00:24:07 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763Linux Support:
3764==============
wdenkc6097192002-11-03 00:24:07 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766Although U-Boot should support any OS or standalone application
3767easily, the main focus has always been on Linux during the design of
3768U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770U-Boot includes many features that so far have been part of some
3771special "boot loader" code within the Linux kernel. Also, any
3772"initrd" images to be used are no longer part of one big Linux image;
3773instead, kernel and "initrd" are separate images. This implementation
3774serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776- the same features can be used for other OS or standalone
3777 applications (for instance: using compressed images to reduce the
3778 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk2729af92004-05-03 20:45:30 +00003780- it becomes much easier to port new Linux kernel versions because
3781 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783- the same Linux kernel image can now be used with different "initrd"
3784 images; of course this also means that different kernel images can
3785 be run with the same "initrd". This makes testing easier (you don't
3786 have to build a new "zImage.initrd" Linux image when you just
3787 change a file in your "initrd"). Also, a field-upgrade of the
3788 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003789
wdenkc6097192002-11-03 00:24:07 +00003790
wdenk2729af92004-05-03 20:45:30 +00003791Linux HOWTO:
3792============
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk2729af92004-05-03 20:45:30 +00003794Porting Linux to U-Boot based systems:
3795---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003796
wdenk2729af92004-05-03 20:45:30 +00003797U-Boot cannot save you from doing all the necessary modifications to
3798configure the Linux device drivers for use with your target hardware
3799(no, we don't intend to provide a full virtual machine interface to
3800Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003801
Stefan Roesea47a12b2010-04-15 16:07:28 +02003802But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804Just make sure your machine specific header file (for instance
3805include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003806Information structure as we define in include/asm-<arch>/u-boot.h,
3807and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003808as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003809
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk2729af92004-05-03 20:45:30 +00003811Configuring the Linux kernel:
3812-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk2729af92004-05-03 20:45:30 +00003814No specific requirements for U-Boot. Make sure you have some root
3815device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003816
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818Building a Linux Image:
3819-----------------------
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3822not used. If you use recent kernel source, a new build target
3823"uImage" will exist which automatically builds an image usable by
3824U-Boot. Most older kernels also have support for a "pImage" target,
3825which was introduced for our predecessor project PPCBoot and uses a
3826100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828Example:
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830 make TQM850L_config
3831 make oldconfig
3832 make dep
3833 make uImage
wdenkc6097192002-11-03 00:24:07 +00003834
wdenk2729af92004-05-03 20:45:30 +00003835The "uImage" build target uses a special tool (in 'tools/mkimage') to
3836encapsulate a compressed Linux kernel image with header information,
3837CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003838
wdenk2729af92004-05-03 20:45:30 +00003839* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk2729af92004-05-03 20:45:30 +00003841* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843 ${CROSS_COMPILE}-objcopy -O binary \
3844 -R .note -R .comment \
3845 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk2729af92004-05-03 20:45:30 +00003847* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk2729af92004-05-03 20:45:30 +00003849 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003852
wdenk2729af92004-05-03 20:45:30 +00003853 mkimage -A ppc -O linux -T kernel -C gzip \
3854 -a 0 -e 0 -n "Linux Kernel Image" \
3855 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003856
wdenk24ee89b2002-11-03 17:56:27 +00003857
wdenk2729af92004-05-03 20:45:30 +00003858The "mkimage" tool can also be used to create ramdisk images for use
3859with U-Boot, either separated from the Linux kernel image, or
3860combined into one file. "mkimage" encapsulates the images with a 64
3861byte header containing information about target architecture,
3862operating system, image type, compression method, entry points, time
3863stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003864
wdenk2729af92004-05-03 20:45:30 +00003865"mkimage" can be called in two ways: to verify existing images and
3866print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003867
wdenk2729af92004-05-03 20:45:30 +00003868In the first form (with "-l" option) mkimage lists the information
3869contained in the header of an existing U-Boot image; this includes
3870checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003871
wdenk2729af92004-05-03 20:45:30 +00003872 tools/mkimage -l image
3873 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003874
wdenk2729af92004-05-03 20:45:30 +00003875The second form (with "-d" option) is used to build a U-Boot image
3876from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003877
wdenk2729af92004-05-03 20:45:30 +00003878 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3879 -n name -d data_file image
3880 -A ==> set architecture to 'arch'
3881 -O ==> set operating system to 'os'
3882 -T ==> set image type to 'type'
3883 -C ==> set compression type 'comp'
3884 -a ==> set load address to 'addr' (hex)
3885 -e ==> set entry point to 'ep' (hex)
3886 -n ==> set image name to 'name'
3887 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003888
wdenk69459792004-05-29 16:53:29 +00003889Right now, all Linux kernels for PowerPC systems use the same load
3890address (0x00000000), but the entry point address depends on the
3891kernel version:
wdenkc6097192002-11-03 00:24:07 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893- 2.2.x kernels have the entry point at 0x0000000C,
3894- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003897
wdenk2729af92004-05-03 20:45:30 +00003898 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3899 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003900 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003901 > examples/uImage.TQM850L
3902 Image Name: 2.4.4 kernel for TQM850L
3903 Created: Wed Jul 19 02:34:59 2000
3904 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3905 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3906 Load Address: 0x00000000
3907 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003908
wdenk2729af92004-05-03 20:45:30 +00003909To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003910
wdenk2729af92004-05-03 20:45:30 +00003911 -> tools/mkimage -l examples/uImage.TQM850L
3912 Image Name: 2.4.4 kernel for TQM850L
3913 Created: Wed Jul 19 02:34:59 2000
3914 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3915 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3916 Load Address: 0x00000000
3917 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003918
wdenk2729af92004-05-03 20:45:30 +00003919NOTE: for embedded systems where boot time is critical you can trade
3920speed for memory and install an UNCOMPRESSED image instead: this
3921needs more space in Flash, but boots much faster since it does not
3922need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003923
Stefan Roesea47a12b2010-04-15 16:07:28 +02003924 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003925 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3926 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003927 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003928 > examples/uImage.TQM850L-uncompressed
3929 Image Name: 2.4.4 kernel for TQM850L
3930 Created: Wed Jul 19 02:34:59 2000
3931 Image Type: PowerPC Linux Kernel Image (uncompressed)
3932 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3933 Load Address: 0x00000000
3934 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003935
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3938when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003939
wdenk2729af92004-05-03 20:45:30 +00003940 -> tools/mkimage -n 'Simple Ramdisk Image' \
3941 > -A ppc -O linux -T ramdisk -C gzip \
3942 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3943 Image Name: Simple Ramdisk Image
3944 Created: Wed Jan 12 14:01:50 2000
3945 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3946 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3947 Load Address: 0x00000000
3948 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003949
wdenkdb01a2e2004-04-15 23:14:49 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951Installing a Linux Image:
3952-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003953
wdenk2729af92004-05-03 20:45:30 +00003954To downloading a U-Boot image over the serial (console) interface,
3955you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003958
wdenk2729af92004-05-03 20:45:30 +00003959The 'objcopy' does not understand the information in the U-Boot
3960image header, so the resulting S-Record file will be relative to
3961address 0x00000000. To load it to a given address, you need to
3962specify the target address as 'offset' parameter with the 'loads'
3963command.
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965Example: install the image to address 0x40100000 (which on the
3966TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003967
wdenk2729af92004-05-03 20:45:30 +00003968 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk2729af92004-05-03 20:45:30 +00003970 .......... done
3971 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973 => loads 40100000
3974 ## Ready for S-Record download ...
3975 ~>examples/image.srec
3976 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3977 ...
3978 15989 15990 15991 15992
3979 [file transfer complete]
3980 [connected]
3981 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003982
3983
wdenk2729af92004-05-03 20:45:30 +00003984You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003985this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003986corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk2729af92004-05-03 20:45:30 +00003988 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003989
wdenk2729af92004-05-03 20:45:30 +00003990 ## Checking Image at 40100000 ...
3991 Image Name: 2.2.13 for initrd on TQM850L
3992 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3993 Data Size: 335725 Bytes = 327 kB = 0 MB
3994 Load Address: 00000000
3995 Entry Point: 0000000c
3996 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003997
3998
wdenk2729af92004-05-03 20:45:30 +00003999Boot Linux:
4000-----------
wdenkc6097192002-11-03 00:24:07 +00004001
wdenk2729af92004-05-03 20:45:30 +00004002The "bootm" command is used to boot an application that is stored in
4003memory (RAM or Flash). In case of a Linux kernel image, the contents
4004of the "bootargs" environment variable is passed to the kernel as
4005parameters. You can check and modify this variable using the
4006"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004007
4008
wdenk2729af92004-05-03 20:45:30 +00004009 => printenv bootargs
4010 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004011
wdenk2729af92004-05-03 20:45:30 +00004012 => 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 +00004013
wdenk2729af92004-05-03 20:45:30 +00004014 => printenv bootargs
4015 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 +00004016
wdenk2729af92004-05-03 20:45:30 +00004017 => bootm 40020000
4018 ## Booting Linux kernel at 40020000 ...
4019 Image Name: 2.2.13 for NFS on TQM850L
4020 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4021 Data Size: 381681 Bytes = 372 kB = 0 MB
4022 Load Address: 00000000
4023 Entry Point: 0000000c
4024 Verifying Checksum ... OK
4025 Uncompressing Kernel Image ... OK
4026 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
4027 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4028 time_init: decrementer frequency = 187500000/60
4029 Calibrating delay loop... 49.77 BogoMIPS
4030 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4031 ...
wdenkc6097192002-11-03 00:24:07 +00004032
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004033If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004034the memory addresses of both the kernel and the initrd image (PPBCOOT
4035format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039 ## Checking Image at 40100000 ...
4040 Image Name: 2.2.13 for initrd on TQM850L
4041 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4042 Data Size: 335725 Bytes = 327 kB = 0 MB
4043 Load Address: 00000000
4044 Entry Point: 0000000c
4045 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004046
wdenk2729af92004-05-03 20:45:30 +00004047 ## Checking Image at 40200000 ...
4048 Image Name: Simple Ramdisk Image
4049 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4050 Data Size: 566530 Bytes = 553 kB = 0 MB
4051 Load Address: 00000000
4052 Entry Point: 00000000
4053 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055 => bootm 40100000 40200000
4056 ## Booting Linux kernel at 40100000 ...
4057 Image Name: 2.2.13 for initrd on TQM850L
4058 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4059 Data Size: 335725 Bytes = 327 kB = 0 MB
4060 Load Address: 00000000
4061 Entry Point: 0000000c
4062 Verifying Checksum ... OK
4063 Uncompressing Kernel Image ... OK
4064 ## Loading RAMDisk Image at 40200000 ...
4065 Image Name: Simple Ramdisk Image
4066 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4067 Data Size: 566530 Bytes = 553 kB = 0 MB
4068 Load Address: 00000000
4069 Entry Point: 00000000
4070 Verifying Checksum ... OK
4071 Loading Ramdisk ... OK
4072 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
4073 Boot arguments: root=/dev/ram
4074 time_init: decrementer frequency = 187500000/60
4075 Calibrating delay loop... 49.77 BogoMIPS
4076 ...
4077 RAMDISK: Compressed image found at block 0
4078 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004079
wdenk2729af92004-05-03 20:45:30 +00004080 bash#
wdenkc6097192002-11-03 00:24:07 +00004081
Matthew McClintock02677682006-06-28 10:41:37 -05004082Boot Linux and pass a flat device tree:
4083-----------
4084
4085First, U-Boot must be compiled with the appropriate defines. See the section
4086titled "Linux Kernel Interface" above for a more in depth explanation. The
4087following is an example of how to start a kernel and pass an updated
4088flat device tree:
4089
4090=> print oftaddr
4091oftaddr=0x300000
4092=> print oft
4093oft=oftrees/mpc8540ads.dtb
4094=> tftp $oftaddr $oft
4095Speed: 1000, full duplex
4096Using TSEC0 device
4097TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4098Filename 'oftrees/mpc8540ads.dtb'.
4099Load address: 0x300000
4100Loading: #
4101done
4102Bytes transferred = 4106 (100a hex)
4103=> tftp $loadaddr $bootfile
4104Speed: 1000, full duplex
4105Using TSEC0 device
4106TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4107Filename 'uImage'.
4108Load address: 0x200000
4109Loading:############
4110done
4111Bytes transferred = 1029407 (fb51f hex)
4112=> print loadaddr
4113loadaddr=200000
4114=> print oftaddr
4115oftaddr=0x300000
4116=> bootm $loadaddr - $oftaddr
4117## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004118 Image Name: Linux-2.6.17-dirty
4119 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4120 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004121 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004122 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004123 Verifying Checksum ... OK
4124 Uncompressing Kernel Image ... OK
4125Booting using flat device tree at 0x300000
4126Using MPC85xx ADS machine description
4127Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4128[snip]
4129
4130
wdenk2729af92004-05-03 20:45:30 +00004131More About U-Boot Image Types:
4132------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004135
wdenk2729af92004-05-03 20:45:30 +00004136 "Standalone Programs" are directly runnable in the environment
4137 provided by U-Boot; it is expected that (if they behave
4138 well) you can continue to work in U-Boot after return from
4139 the Standalone Program.
4140 "OS Kernel Images" are usually images of some Embedded OS which
4141 will take over control completely. Usually these programs
4142 will install their own set of exception handlers, device
4143 drivers, set up the MMU, etc. - this means, that you cannot
4144 expect to re-enter U-Boot except by resetting the CPU.
4145 "RAMDisk Images" are more or less just data blocks, and their
4146 parameters (address, size) are passed to an OS kernel that is
4147 being started.
4148 "Multi-File Images" contain several images, typically an OS
4149 (Linux) kernel image and one or more data images like
4150 RAMDisks. This construct is useful for instance when you want
4151 to boot over the network using BOOTP etc., where the boot
4152 server provides just a single image file, but you want to get
4153 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004154
wdenk2729af92004-05-03 20:45:30 +00004155 "Multi-File Images" start with a list of image sizes, each
4156 image size (in bytes) specified by an "uint32_t" in network
4157 byte order. This list is terminated by an "(uint32_t)0".
4158 Immediately after the terminating 0 follow the images, one by
4159 one, all aligned on "uint32_t" boundaries (size rounded up to
4160 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162 "Firmware Images" are binary images containing firmware (like
4163 U-Boot or FPGA images) which usually will be programmed to
4164 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166 "Script files" are command sequences that will be executed by
4167 U-Boot's command interpreter; this feature is especially
4168 useful when you configure U-Boot to use a real shell (hush)
4169 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004170
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172Standalone HOWTO:
4173=================
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk2729af92004-05-03 20:45:30 +00004175One of the features of U-Boot is that you can dynamically load and
4176run "standalone" applications, which can use some resources of
4177U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181"Hello World" Demo:
4182-------------------
wdenkc6097192002-11-03 00:24:07 +00004183
wdenk2729af92004-05-03 20:45:30 +00004184'examples/hello_world.c' contains a small "Hello World" Demo
4185application; it is automatically compiled when you build U-Boot.
4186It's configured to run at address 0x00040004, so you can play with it
4187like that:
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk2729af92004-05-03 20:45:30 +00004189 => loads
4190 ## Ready for S-Record download ...
4191 ~>examples/hello_world.srec
4192 1 2 3 4 5 6 7 8 9 10 11 ...
4193 [file transfer complete]
4194 [connected]
4195 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197 => go 40004 Hello World! This is a test.
4198 ## Starting application at 0x00040004 ...
4199 Hello World
4200 argc = 7
4201 argv[0] = "40004"
4202 argv[1] = "Hello"
4203 argv[2] = "World!"
4204 argv[3] = "This"
4205 argv[4] = "is"
4206 argv[5] = "a"
4207 argv[6] = "test."
4208 argv[7] = "<NULL>"
4209 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk2729af92004-05-03 20:45:30 +00004211 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213Another example, which demonstrates how to register a CPM interrupt
4214handler with the U-Boot code, can be found in 'examples/timer.c'.
4215Here, a CPM timer is set up to generate an interrupt every second.
4216The interrupt service routine is trivial, just printing a '.'
4217character, but this is just a demo program. The application can be
4218controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004219
wdenk2729af92004-05-03 20:45:30 +00004220 ? - print current values og the CPM Timer registers
4221 b - enable interrupts and start timer
4222 e - stop timer and disable interrupts
4223 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225 => loads
4226 ## Ready for S-Record download ...
4227 ~>examples/timer.srec
4228 1 2 3 4 5 6 7 8 9 10 11 ...
4229 [file transfer complete]
4230 [connected]
4231 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004232
wdenk2729af92004-05-03 20:45:30 +00004233 => go 40004
4234 ## Starting application at 0x00040004 ...
4235 TIMERS=0xfff00980
4236 Using timer 1
4237 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239Hit 'b':
4240 [q, b, e, ?] Set interval 1000000 us
4241 Enabling timer
4242Hit '?':
4243 [q, b, e, ?] ........
4244 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4245Hit '?':
4246 [q, b, e, ?] .
4247 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4248Hit '?':
4249 [q, b, e, ?] .
4250 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4251Hit '?':
4252 [q, b, e, ?] .
4253 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4254Hit 'e':
4255 [q, b, e, ?] ...Stopping timer
4256Hit 'q':
4257 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004258
4259
wdenk2729af92004-05-03 20:45:30 +00004260Minicom warning:
4261================
wdenk85ec0bc2003-03-31 16:34:49 +00004262
wdenk2729af92004-05-03 20:45:30 +00004263Over time, many people have reported problems when trying to use the
4264"minicom" terminal emulation program for serial download. I (wd)
4265consider minicom to be broken, and recommend not to use it. Under
4266Unix, I recommend to use C-Kermit for general purpose use (and
4267especially for kermit binary protocol download ("loadb" command), and
4268use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004269
wdenk2729af92004-05-03 20:45:30 +00004270Nevertheless, if you absolutely want to use it try adding this
4271configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004272
wdenk2729af92004-05-03 20:45:30 +00004273 Name Program Name U/D FullScr IO-Red. Multi
4274 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4275 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004276
4277
wdenk2729af92004-05-03 20:45:30 +00004278NetBSD Notes:
4279=============
wdenkc6097192002-11-03 00:24:07 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281Starting at version 0.9.2, U-Boot supports NetBSD both as host
4282(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284Building requires a cross environment; it is known to work on
4285NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4286need gmake since the Makefiles are not compatible with BSD make).
4287Note that the cross-powerpc package does not install include files;
4288attempting to build U-Boot will fail because <machine/ansi.h> is
4289missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004290
wdenk2729af92004-05-03 20:45:30 +00004291 # cd /usr/pkg/cross/powerpc-netbsd/include
4292 # mkdir powerpc
4293 # ln -s powerpc machine
4294 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4295 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004296
wdenk2729af92004-05-03 20:45:30 +00004297Native builds *don't* work due to incompatibilities between native
4298and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300Booting assumes that (the first part of) the image booted is a
4301stage-2 loader which in turn loads and then invokes the kernel
4302proper. Loader sources will eventually appear in the NetBSD source
4303tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004304meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004305
4306
wdenk2729af92004-05-03 20:45:30 +00004307Implementation Internals:
4308=========================
wdenkc6097192002-11-03 00:24:07 +00004309
wdenk2729af92004-05-03 20:45:30 +00004310The following is not intended to be a complete description of every
4311implementation detail. However, it should help to understand the
4312inner workings of U-Boot and make it easier to port it to custom
4313hardware.
wdenkc6097192002-11-03 00:24:07 +00004314
4315
wdenk2729af92004-05-03 20:45:30 +00004316Initial Stack, Global Data:
4317---------------------------
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk2729af92004-05-03 20:45:30 +00004319The implementation of U-Boot is complicated by the fact that U-Boot
4320starts running out of ROM (flash memory), usually without access to
4321system RAM (because the memory controller is not initialized yet).
4322This means that we don't have writable Data or BSS segments, and BSS
4323is not initialized as zero. To be able to get a C environment working
4324at all, we have to allocate at least a minimal stack. Implementation
4325options for this are defined and restricted by the CPU used: Some CPU
4326models provide on-chip memory (like the IMMR area on MPC8xx and
4327MPC826x processors), on others (parts of) the data cache can be
4328locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004329
Wolfgang Denk218ca722008-03-26 10:40:12 +01004330 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004331 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4334 From: "Chris Hallinan" <clh@net1plus.com>
4335 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4336 ...
wdenk43d96162003-03-06 00:02:04 +00004337
wdenk2729af92004-05-03 20:45:30 +00004338 Correct me if I'm wrong, folks, but the way I understand it
4339 is this: Using DCACHE as initial RAM for Stack, etc, does not
4340 require any physical RAM backing up the cache. The cleverness
4341 is that the cache is being used as a temporary supply of
4342 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004343 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004344 can see how this works by studying the cache architecture and
4345 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004346
wdenk2729af92004-05-03 20:45:30 +00004347 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4348 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004349 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004350 option should work for you. Using CS 4 should be fine if your
4351 board designers haven't used it for something that would
4352 cause you grief during the initial boot! It is frequently not
4353 used.
wdenk43d96162003-03-06 00:02:04 +00004354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004355 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004356 with your processor/board/system design. The default value
4357 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004358 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004359 than your SDRAM module. If you have a 64MB SDRAM module, set
4360 it above 400_0000. Just make sure your board has no resources
4361 that are supposed to respond to that address! That code in
4362 start.S has been around a while and should work as is when
4363 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004364
wdenk2729af92004-05-03 20:45:30 +00004365 -Chris Hallinan
4366 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004367
wdenk2729af92004-05-03 20:45:30 +00004368It is essential to remember this, since it has some impact on the C
4369code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004370
wdenk2729af92004-05-03 20:45:30 +00004371* Initialized global data (data segment) is read-only. Do not attempt
4372 to write it.
wdenkc6097192002-11-03 00:24:07 +00004373
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004374* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004375 as zero data - BSS segment) at all - this is undefined, initiali-
4376 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk2729af92004-05-03 20:45:30 +00004378* Stack space is very limited. Avoid big data buffers or things like
4379 that.
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk2729af92004-05-03 20:45:30 +00004381Having only the stack as writable memory limits means we cannot use
4382normal global data to share information beween the code. But it
4383turned out that the implementation of U-Boot can be greatly
4384simplified by making a global data structure (gd_t) available to all
4385functions. We could pass a pointer to this data as argument to _all_
4386functions, but this would bloat the code. Instead we use a feature of
4387the GCC compiler (Global Register Variables) to share the data: we
4388place a pointer (gd) to the global data into a register which we
4389reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004390
wdenk2729af92004-05-03 20:45:30 +00004391When choosing a register for such a purpose we are restricted by the
4392relevant (E)ABI specifications for the current architecture, and by
4393GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395For PowerPC, the following registers have specific use:
4396 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004397 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004398 R3-R4: parameter passing and return values
4399 R5-R10: parameter passing
4400 R13: small data area pointer
4401 R30: GOT pointer
4402 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004403
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004404 (U-Boot also uses R12 as internal GOT pointer. r12
4405 is a volatile register so r12 needs to be reset when
4406 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004407
Wolfgang Denke7670f62008-02-14 22:43:22 +01004408 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk2729af92004-05-03 20:45:30 +00004410 Note: on PPC, we could use a static initializer (since the
4411 address of the global data structure is known at compile time),
4412 but it turned out that reserving a register results in somewhat
4413 smaller code - although the code savings are not that big (on
4414 average for all boards 752 bytes for the whole U-Boot image,
4415 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004416
Robin Getzc4db3352009-08-17 15:23:02 +00004417On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004418 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4419
Robin Getzc4db3352009-08-17 15:23:02 +00004420 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004421
wdenk2729af92004-05-03 20:45:30 +00004422On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424 R0: function argument word/integer result
4425 R1-R3: function argument word
4426 R9: GOT pointer
4427 R10: stack limit (used only if stack checking if enabled)
4428 R11: argument (frame) pointer
4429 R12: temporary workspace
4430 R13: stack pointer
4431 R14: link register
4432 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk2729af92004-05-03 20:45:30 +00004434 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004435
Thomas Chou0df01fd2010-05-21 11:08:03 +08004436On Nios II, the ABI is documented here:
4437 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4438
4439 ==> U-Boot will use gp to hold a pointer to the global data
4440
4441 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4442 to access small data sections, so gp is free.
4443
Macpaul Linafc1ce82011-10-19 20:41:11 +00004444On NDS32, the following registers are used:
4445
4446 R0-R1: argument/return
4447 R2-R5: argument
4448 R15: temporary register for assembler
4449 R16: trampoline register
4450 R28: frame pointer (FP)
4451 R29: global pointer (GP)
4452 R30: link register (LP)
4453 R31: stack pointer (SP)
4454 PC: program counter (PC)
4455
4456 ==> U-Boot will use R10 to hold a pointer to the global data
4457
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004458NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4459or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk2729af92004-05-03 20:45:30 +00004461Memory Management:
4462------------------
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464U-Boot runs in system state and uses physical addresses, i.e. the
4465MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467The available memory is mapped to fixed addresses using the memory
4468controller. In this process, a contiguous block is formed for each
4469memory type (Flash, SDRAM, SRAM), even when it consists of several
4470physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk2729af92004-05-03 20:45:30 +00004472U-Boot is installed in the first 128 kB of the first Flash bank (on
4473TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4474booting and sizing and initializing DRAM, the code relocates itself
4475to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004476memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004477configuration setting]. Below that, a structure with global Board
4478Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004479
wdenk2729af92004-05-03 20:45:30 +00004480Additionally, some exception handler code is copied to the low 8 kB
4481of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004482
wdenk2729af92004-05-03 20:45:30 +00004483So a typical memory configuration with 16 MB of DRAM could look like
4484this:
wdenkc6097192002-11-03 00:24:07 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486 0x0000 0000 Exception Vector code
4487 :
4488 0x0000 1FFF
4489 0x0000 2000 Free for Application Use
4490 :
4491 :
wdenkc6097192002-11-03 00:24:07 +00004492
wdenk2729af92004-05-03 20:45:30 +00004493 :
4494 :
4495 0x00FB FF20 Monitor Stack (Growing downward)
4496 0x00FB FFAC Board Info Data and permanent copy of global data
4497 0x00FC 0000 Malloc Arena
4498 :
4499 0x00FD FFFF
4500 0x00FE 0000 RAM Copy of Monitor Code
4501 ... eventually: LCD or video framebuffer
4502 ... eventually: pRAM (Protected RAM - unchanged by reset)
4503 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004504
4505
wdenk2729af92004-05-03 20:45:30 +00004506System Initialization:
4507----------------------
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk2729af92004-05-03 20:45:30 +00004509In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004510(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004511configuration for CS0# this is a mirror of the onboard Flash memory.
4512To be able to re-map memory U-Boot then jumps to its link address.
4513To be able to implement the initialization code in C, a (small!)
4514initial stack is set up in the internal Dual Ported RAM (in case CPUs
4515which provide such a feature like MPC8xx or MPC8260), or in a locked
4516part of the data cache. After that, U-Boot initializes the CPU core,
4517the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk2729af92004-05-03 20:45:30 +00004519Next, all (potentially) available memory banks are mapped using a
4520preliminary mapping. For example, we put them on 512 MB boundaries
4521(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4522on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4523programmed for SDRAM access. Using the temporary configuration, a
4524simple memory test is run that determines the size of the SDRAM
4525banks.
wdenkc6097192002-11-03 00:24:07 +00004526
wdenk2729af92004-05-03 20:45:30 +00004527When there is more than one SDRAM bank, and the banks are of
4528different size, the largest is mapped first. For equal size, the first
4529bank (CS2#) is mapped first. The first mapping is always for address
45300x00000000, with any additional banks following immediately to create
4531contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533Then, the monitor installs itself at the upper end of the SDRAM area
4534and allocates memory for use by malloc() and for the global Board
4535Info data; also, the exception vector code is copied to the low RAM
4536pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004537
wdenk2729af92004-05-03 20:45:30 +00004538Only after this relocation will you have a "normal" C environment;
4539until that you are restricted in several ways, mostly because you are
4540running from ROM, and because the code will have to be relocated to a
4541new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004542
4543
wdenk2729af92004-05-03 20:45:30 +00004544U-Boot Porting Guide:
4545----------------------
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk2729af92004-05-03 20:45:30 +00004547[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4548list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004549
4550
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004551int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004552{
4553 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004554
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004555 signal(SIGALRM, no_more_time);
4556 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk2729af92004-05-03 20:45:30 +00004558 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004559 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004560 return 0;
4561 }
4562
wdenk2729af92004-05-03 20:45:30 +00004563 Download latest U-Boot source;
4564
Wolfgang Denk06682362008-12-30 22:56:11 +01004565 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004566
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004567 if (clueless)
4568 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004569
wdenk2729af92004-05-03 20:45:30 +00004570 while (learning) {
4571 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004572 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4573 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004574 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004575 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004576 }
wdenkc6097192002-11-03 00:24:07 +00004577
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004578 if (available_money > toLocalCurrency ($2500))
4579 Buy a BDI3000;
4580 else
wdenk2729af92004-05-03 20:45:30 +00004581 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004582
4583 if (a similar board exists) { /* hopefully... */
4584 cp -a board/<similar> board/<myboard>
4585 cp include/configs/<similar>.h include/configs/<myboard>.h
4586 } else {
4587 Create your own board support subdirectory;
4588 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004589 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004590 Edit new board/<myboard> files
4591 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004592
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004593 while (!accepted) {
4594 while (!running) {
4595 do {
4596 Add / modify source code;
4597 } until (compiles);
4598 Debug;
4599 if (clueless)
4600 email("Hi, I am having problems...");
4601 }
4602 Send patch file to the U-Boot email list;
4603 if (reasonable critiques)
4604 Incorporate improvements from email list code review;
4605 else
4606 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004607 }
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk2729af92004-05-03 20:45:30 +00004609 return 0;
4610}
4611
4612void no_more_time (int sig)
4613{
4614 hire_a_guru();
4615}
wdenkc6097192002-11-03 00:24:07 +00004616
4617
wdenk2729af92004-05-03 20:45:30 +00004618Coding Standards:
4619-----------------
wdenkc6097192002-11-03 00:24:07 +00004620
wdenk2729af92004-05-03 20:45:30 +00004621All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004622coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004623"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004624
Detlev Zundel2c051652006-09-01 15:39:02 +02004625Source files originating from a different project (for example the
4626MTD subsystem) are generally exempt from these guidelines and are not
4627reformated to ease subsequent migration to newer versions of those
4628sources.
4629
4630Please note that U-Boot is implemented in C (and to some small parts in
4631Assembler); no C++ is used, so please do not use C++ style comments (//)
4632in your code.
wdenk2729af92004-05-03 20:45:30 +00004633
4634Please also stick to the following formatting rules:
4635- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004636- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004637- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004638- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004639- do not add trailing empty lines to source files
4640
4641Submissions which do not conform to the standards may be returned
4642with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004643
4644
wdenk2729af92004-05-03 20:45:30 +00004645Submitting Patches:
4646-------------------
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk2729af92004-05-03 20:45:30 +00004648Since the number of patches for U-Boot is growing, we need to
4649establish some rules. Submissions which do not conform to these rules
4650may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004651
Magnus Lilja0d28f342008-08-06 19:32:33 +02004652Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004653
Wolfgang Denk06682362008-12-30 22:56:11 +01004654Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4655see http://lists.denx.de/mailman/listinfo/u-boot
4656
wdenk2729af92004-05-03 20:45:30 +00004657When you send a patch, please include the following information with
4658it:
wdenkc6097192002-11-03 00:24:07 +00004659
wdenk2729af92004-05-03 20:45:30 +00004660* For bug fixes: a description of the bug and how your patch fixes
4661 this bug. Please try to include a way of demonstrating that the
4662 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk2729af92004-05-03 20:45:30 +00004664* For new features: a description of the feature and your
4665 implementation.
wdenkc6097192002-11-03 00:24:07 +00004666
wdenk2729af92004-05-03 20:45:30 +00004667* A CHANGELOG entry as plaintext (separate from the patch)
4668
4669* For major contributions, your entry to the CREDITS file
4670
4671* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004672 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004673
4674* If your patch adds new configuration options, don't forget to
4675 document these in the README file.
4676
Wolfgang Denk218ca722008-03-26 10:40:12 +01004677* The patch itself. If you are using git (which is *strongly*
4678 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004679 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004680 the U-Boot mailing list, you will avoid most of the common problems
4681 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004682
Wolfgang Denk218ca722008-03-26 10:40:12 +01004683 If you cannot use git, use "diff -purN OLD NEW". If your version of
4684 diff does not support these options, then get the latest version of
4685 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004686
Wolfgang Denk218ca722008-03-26 10:40:12 +01004687 The current directory when running this command shall be the parent
4688 directory of the U-Boot source tree (i. e. please make sure that
4689 your patch includes sufficient directory information for the
4690 affected files).
4691
4692 We prefer patches as plain text. MIME attachments are discouraged,
4693 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004694
4695* If one logical set of modifications affects or creates several
4696 files, all these changes shall be submitted in a SINGLE patch file.
4697
4698* Changesets that contain different, unrelated modifications shall be
4699 submitted as SEPARATE patches, one patch per changeset.
4700
4701
4702Notes:
4703
4704* Before sending the patch, run the MAKEALL script on your patched
4705 source tree and make sure that no errors or warnings are reported
4706 for any of the boards.
4707
4708* Keep your modifications to the necessary minimum: A patch
4709 containing several unrelated changes or arbitrary reformats will be
4710 returned with a request to re-formatting / split it.
4711
4712* If you modify existing code, make sure that your new code does not
4713 add to the memory footprint of the code ;-) Small is beautiful!
4714 When adding new features, these should compile conditionally only
4715 (using #ifdef), and the resulting code with the new feature
4716 disabled must not need more memory than the old code without your
4717 modification.
wdenk90dc6702005-05-03 14:12:25 +00004718
Wolfgang Denk06682362008-12-30 22:56:11 +01004719* Remember that there is a size limit of 100 kB per message on the
4720 u-boot mailing list. Bigger patches will be moderated. If they are
4721 reasonable and not too big, they will be acknowledged. But patches
4722 bigger than the size limit should be avoided.