blob: d1c60de0a84d0d1bf85dc6c66cedbfe0013c1078 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
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
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000057Note: There is no CHANGELOG file in the actual U-Boot source tree;
58it can be created dynamically from the Git log using:
59
60 make CHANGELOG
61
wdenkc6097192002-11-03 00:24:07 +000062
63Where to get help:
64==================
65
wdenk24ee89b2002-11-03 17:56:27 +000066In case you have questions about, problems with or contributions for
67U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050068<u-boot@lists.denx.de>. There is also an archive of previous traffic
69on the mailing list - please search the archive before asking FAQ's.
70Please see http://lists.denx.de/pipermail/u-boot and
71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000072
73
Wolfgang Denk218ca722008-03-26 10:40:12 +010074Where to get source code:
75=========================
76
77The U-Boot source code is maintained in the git repository at
78git://www.denx.de/git/u-boot.git ; you can browse it online at
79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80
81The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010087ftp://ftp.denx.de/pub/u-boot/images/
88
89
wdenkc6097192002-11-03 00:24:07 +000090Where we come from:
91===================
92
93- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000094- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000095- clean up code
96- make it easier to add custom boards
97- make it possible to add other [PowerPC] CPUs
98- extend functions, especially:
99 * Provide extended interface to Linux boot loader
100 * S-Record download
101 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +0000103- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +0000104- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000105- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200106- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000107
108
109Names and Spelling:
110===================
111
112The "official" name of this project is "Das U-Boot". The spelling
113"U-Boot" shall be used in all written text (documentation, comments
114in source files etc.). Example:
115
116 This is the README file for the U-Boot project.
117
118File names etc. shall be based on the string "u-boot". Examples:
119
120 include/asm-ppc/u-boot.h
121
122 #include <asm/u-boot.h>
123
124Variable names, preprocessor constants etc. shall be either based on
125the string "u_boot" or on "U_BOOT". Example:
126
127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000129
130
wdenk93f19cc2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Weber360d8832010-09-28 08:06:25 +0200134Starting with the release in October 2008, the names of the releases
135were changed from numerical release numbers without deeper meaning
136into a time stamp based numbering. Regular releases are identified by
137names consisting of the calendar year and month of the release date.
138Additional fields (if present) indicate release candidates or bug fix
139releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000140
Thomas Weber360d8832010-09-28 08:06:25 +0200141Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/arch Architecture specific files
151 /arm Files generic to ARM architecture
152 /cpu CPU specific files
153 /arm720t Files specific to ARM 720 CPUs
154 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500158 /arm925t Files specific to ARM 925 CPUs
159 /arm926ejs Files specific to ARM 926 CPUs
160 /arm1136 Files specific to ARM 1136 CPUs
161 /ixp Files specific to Intel XScale IXP CPUs
162 /pxa Files specific to Intel XScale PXA CPUs
163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
165 /lib Architecture specific library files
166 /avr32 Files generic to AVR32 architecture
167 /cpu CPU specific files
168 /lib Architecture specific library files
169 /blackfin Files generic to Analog Devices Blackfin architecture
170 /cpu CPU specific files
171 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500173 /cpu CPU specific files
174 /lib Architecture specific library files
175 /m68k Files generic to m68k architecture
176 /cpu CPU specific files
177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
182 /lib Architecture specific library files
183 /microblaze Files generic to microblaze architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
186 /mips Files generic to MIPS architecture
187 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000191 /nds32 Files generic to NDS32 architecture
192 /cpu CPU specific files
193 /n1213 Files specific to Andes Technology N1213 CPUs
194 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500195 /nios2 Files generic to Altera NIOS2 architecture
196 /cpu CPU specific files
197 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500199 /cpu CPU specific files
200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
201 /mpc5xx Files specific to Freescale MPC5xx CPUs
202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
203 /mpc8xx Files specific to Freescale MPC8xx CPUs
204 /mpc8220 Files specific to Freescale MPC8220 CPUs
205 /mpc824x Files specific to Freescale MPC824x CPUs
206 /mpc8260 Files specific to Freescale MPC8260 CPUs
207 /mpc85xx Files specific to Freescale MPC85xx CPUs
208 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
209 /lib Architecture specific library files
210 /sh Files generic to SH architecture
211 /cpu CPU specific files
212 /sh2 Files specific to sh2 CPUs
213 /sh3 Files specific to sh3 CPUs
214 /sh4 Files specific to sh4 CPUs
215 /lib Architecture specific library files
216 /sparc Files generic to SPARC architecture
217 /cpu CPU specific files
218 /leon2 Files specific to Gaisler LEON2 SPARC CPU
219 /leon3 Files specific to Gaisler LEON3 SPARC CPU
220 /lib Architecture specific library files
221/api Machine/arch independent API for external apps
222/board Board dependent files
223/common Misc architecture independent functions
224/disk Code for disk drive partition handling
225/doc Documentation (don't expect too much)
226/drivers Commonly used device drivers
227/examples Example code for standalone applications, etc.
228/fs Filesystem code (cramfs, ext2, jffs2, etc.)
229/include Header Files
230/lib Files generic to all architectures
231 /libfdt Library files to support flattened device trees
232 /lzma Library files to support LZMA decompression
233 /lzo Library files to support LZO decompression
234/net Networking code
235/post Power On Self Test
236/rtc Real Time Clock drivers
237/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000238
wdenkc6097192002-11-03 00:24:07 +0000239Software Configuration:
240=======================
241
242Configuration is usually done using C preprocessor defines; the
243rationale behind that is to avoid dead code whenever possible.
244
245There are two classes of configuration variables:
246
247* Configuration _OPTIONS_:
248 These are selectable by the user and have names beginning with
249 "CONFIG_".
250
251* Configuration _SETTINGS_:
252 These depend on the hardware etc. and should not be meddled with if
253 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200254 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000255
256Later we will add a configuration tool - probably similar to or even
257identical to what's used for the Linux kernel. Right now, we have to
258do the configuration by hand, which means creating some symbolic
259links and editing some configuration files. We use the TQM8xxL boards
260as an example here.
261
262
263Selection of Processor Architecture and Board Type:
264---------------------------------------------------
265
266For all supported boards there are ready-to-use default
267configurations available; just type "make <board_name>_config".
268
269Example: For a TQM823L module type:
270
271 cd u-boot
272 make TQM823L_config
273
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200274For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000275e.g. "make cogent_mpc8xx_config". And also configure the cogent
276directory according to the instructions in cogent/README.
277
278
279Configuration Options:
280----------------------
281
282Configuration depends on the combination of board and CPU type; all
283such information is kept in a configuration file
284"include/configs/<board_name>.h".
285
286Example: For a TQM823L module, all configuration settings are in
287"include/configs/TQM823L.h".
288
289
wdenk7f6c2cb2002-11-10 22:06:23 +0000290Many of the options are named exactly as the corresponding Linux
291kernel configuration options. The intention is to make it easier to
292build a config tool - later.
293
294
wdenkc6097192002-11-03 00:24:07 +0000295The following options need to be configured:
296
Kim Phillips26281142007-08-10 13:28:25 -0500297- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000298
Kim Phillips26281142007-08-10 13:28:25 -0500299- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200300
301- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100302 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000303
304- CPU Module Type: (if CONFIG_COGENT is defined)
305 Define exactly one of
306 CONFIG_CMA286_60_OLD
307--- FIXME --- not tested yet:
308 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
309 CONFIG_CMA287_23, CONFIG_CMA287_50
310
311- Motherboard Type: (if CONFIG_COGENT is defined)
312 Define exactly one of
313 CONFIG_CMA101, CONFIG_CMA102
314
315- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
316 Define one or more of
317 CONFIG_CMA302
318
319- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
320 Define one or more of
321 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200322 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000323 a "rotator" |\-/|\-/
324
wdenk2535d602003-07-17 23:16:40 +0000325- Board flavour: (if CONFIG_MPC8260ADS is defined)
326 CONFIG_ADSTYPE
327 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200328 CONFIG_SYS_8260ADS - original MPC8260ADS
329 CONFIG_SYS_8266ADS - MPC8266ADS
330 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
331 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000332
Lei Wencf946c62011-02-09 18:06:58 +0530333- Marvell Family Member
334 CONFIG_SYS_MVFS - define it if you want to enable
335 multiple fs option at one time
336 for marvell soc family
337
wdenkc6097192002-11-03 00:24:07 +0000338- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000339 Define exactly one of
340 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000341
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200342- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000343 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
344 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000345 e.g. if there is no 32KHz
346 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000347 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
348 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000349
wdenk66ca92a2004-09-28 17:59:53 +0000350- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_8xx_CPUCLK_MIN
352 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000353 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000354 See doc/README.MPC866
355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200356 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000357
wdenkba56f622004-02-06 23:19:44 +0000358 Define this to measure the actual CPU clock instead
359 of relying on the correctness of the configured
360 values. Mostly useful for board bringup to make sure
361 the PLL is locked at the intended frequency. Note
362 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200363 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000364
Heiko Schocher506f3912009-03-12 07:37:15 +0100365 CONFIG_SYS_DELAYED_ICACHE
366
367 Define this option if you want to enable the
368 ICache only when Code runs from RAM.
369
Kumar Gala66412c62011-02-18 05:40:54 -0600370- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000371 CONFIG_SYS_PPC64
372
373 Specifies that the core is a 64-bit PowerPC implementation (implements
374 the "64" category of the Power ISA). This is necessary for ePAPR
375 compliance, among other possible reasons.
376
Kumar Gala66412c62011-02-18 05:40:54 -0600377 CONFIG_SYS_FSL_TBCLK_DIV
378
379 Defines the core time base clock divider ratio compared to the
380 system clock. On most PQ3 devices this is 8, on newer QorIQ
381 devices it can be 16 or 32. The ratio varies from SoC to Soc.
382
Kumar Gala8f290842011-05-20 00:39:21 -0500383 CONFIG_SYS_FSL_PCIE_COMPAT
384
385 Defines the string to utilize when trying to match PCIe device
386 tree nodes for the given platform.
387
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000388 CONFIG_SYS_PPC_E500_DEBUG_TLB
389
390 Enables a temporary TLB entry to be used during boot to work
391 around limitations in e500v1 and e500v2 external debugger
392 support. This reduces the portions of the boot code where
393 breakpoints and single stepping do not work. The value of this
394 symbol should be set to the TLB1 entry to be used for this
395 purpose.
396
Scott Wood33eee332012-08-14 10:14:53 +0000397 CONFIG_SYS_FSL_ERRATUM_A004510
398
399 Enables a workaround for erratum A004510. If set,
400 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
401 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
402
403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
404 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
405
406 Defines one or two SoC revisions (low 8 bits of SVR)
407 for which the A004510 workaround should be applied.
408
409 The rest of SVR is either not relevant to the decision
410 of whether the erratum is present (e.g. p2040 versus
411 p2041) or is implied by the build target, which controls
412 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
413
414 See Freescale App Note 4493 for more information about
415 this erratum.
416
417 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
418
419 This is the value to write into CCSR offset 0x18600
420 according to the A004510 workaround.
421
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000422- Generic CPU options:
423 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
424
425 Defines the endianess of the CPU. Implementation of those
426 values is arch specific.
427
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100428- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200429 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100430
431 Defines the Monahans run mode to oscillator
432 ratio. Valid values are 8, 16, 24, 31. The core
433 frequency is this value multiplied by 13 MHz.
434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200435 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200436
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100437 Defines the Monahans turbo mode to oscillator
438 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200439 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100440 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200441
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200442- MIPS CPU options:
443 CONFIG_SYS_INIT_SP_OFFSET
444
445 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
446 pointer. This is needed for the temporary stack before
447 relocation.
448
449 CONFIG_SYS_MIPS_CACHE_MODE
450
451 Cache operation mode for the MIPS CPU.
452 See also arch/mips/include/asm/mipsregs.h.
453 Possible values are:
454 CONF_CM_CACHABLE_NO_WA
455 CONF_CM_CACHABLE_WA
456 CONF_CM_UNCACHED
457 CONF_CM_CACHABLE_NONCOHERENT
458 CONF_CM_CACHABLE_CE
459 CONF_CM_CACHABLE_COW
460 CONF_CM_CACHABLE_CUW
461 CONF_CM_CACHABLE_ACCELERATED
462
463 CONFIG_SYS_XWAY_EBU_BOOTCFG
464
465 Special option for Lantiq XWAY SoCs for booting from NOR flash.
466 See also arch/mips/cpu/mips32/start.S.
467
468 CONFIG_XWAY_SWAP_BYTES
469
470 Enable compilation of tools/xway-swap-bytes needed for Lantiq
471 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
472 be swapped if a flash programmer is used.
473
Christian Rieschb67d8812012-02-02 00:44:39 +0000474- ARM options:
475 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
476
477 Select high exception vectors of the ARM core, e.g., do not
478 clear the V bit of the c1 register of CP15.
479
Aneesh V5356f542012-03-08 07:20:19 +0000480 CONFIG_SYS_THUMB_BUILD
481
482 Use this flag to build U-Boot using the Thumb instruction
483 set for ARM architectures. Thumb instruction set provides
484 better code density. For ARM architectures that support
485 Thumb2 this flag will result in Thumb2 code generated by
486 GCC.
487
wdenk5da627a2003-10-09 20:09:04 +0000488- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000489 CONFIG_CLOCKS_IN_MHZ
490
491 U-Boot stores all clock information in Hz
492 internally. For binary compatibility with older Linux
493 kernels (which expect the clocks passed in the
494 bd_info data to be in MHz) the environment variable
495 "clocks_in_mhz" can be defined so that U-Boot
496 converts clock data to MHZ before passing it to the
497 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000498 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100499 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000500 default environment.
501
wdenk5da627a2003-10-09 20:09:04 +0000502 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
503
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200504 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000505 expect it to be in bytes, others in MB.
506 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
507
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400508 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200509
510 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400511 passed using flattened device trees (based on open firmware
512 concepts).
513
514 CONFIG_OF_LIBFDT
515 * New libfdt-based support
516 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500517 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400518
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200519 OF_CPU - The proper name of the cpus node (only required for
520 MPC512X and MPC5xxx based boards).
521 OF_SOC - The proper name of the soc node (only required for
522 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200523 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600524 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200525
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200526 boards with QUICC Engines require OF_QE to set UCC MAC
527 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500528
Kumar Gala4e253132006-01-11 13:54:17 -0600529 CONFIG_OF_BOARD_SETUP
530
531 Board code has addition modification that it wants to make
532 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000533
Matthew McClintock02677682006-06-28 10:41:37 -0500534 CONFIG_OF_BOOT_CPU
535
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200536 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500537 param header, the default value is zero if undefined.
538
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200539 CONFIG_OF_IDE_FIXUP
540
541 U-Boot can detect if an IDE device is present or not.
542 If not, and this new config option is activated, U-Boot
543 removes the ATA node from the DTS before booting Linux,
544 so the Linux IDE driver does not probe the device and
545 crash. This is needed for buggy hardware (uc101) where
546 no pull down resistor is connected to the signal IDE5V_DD7.
547
Igor Grinberg7eb29392011-07-14 05:45:07 +0000548 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
549
550 This setting is mandatory for all boards that have only one
551 machine type and must be used to specify the machine type
552 number as it appears in the ARM machine registry
553 (see http://www.arm.linux.org.uk/developer/machines/).
554 Only boards that have multiple machine types supported
555 in a single configuration file and the machine type is
556 runtime discoverable, do not have to use this setting.
557
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100558- vxWorks boot parameters:
559
560 bootvx constructs a valid bootline using the following
561 environments variables: bootfile, ipaddr, serverip, hostname.
562 It loads the vxWorks image pointed bootfile.
563
564 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
565 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
566 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
567 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
568
569 CONFIG_SYS_VXWORKS_ADD_PARAMS
570
571 Add it at the end of the bootline. E.g "u=username pw=secret"
572
573 Note: If a "bootargs" environment is defined, it will overwride
574 the defaults discussed just above.
575
Aneesh V2c451f72011-06-16 23:30:47 +0000576- Cache Configuration:
577 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
578 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
579 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
580
Aneesh V93bc2192011-06-16 23:30:51 +0000581- Cache Configuration for ARM:
582 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
583 controller
584 CONFIG_SYS_PL310_BASE - Physical base address of PL310
585 controller register space
586
wdenk6705d812004-08-02 23:22:59 +0000587- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200588 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000589
590 Define this if you want support for Amba PrimeCell PL010 UARTs.
591
Andreas Engel48d01922008-09-08 14:30:53 +0200592 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000593
594 Define this if you want support for Amba PrimeCell PL011 UARTs.
595
596 CONFIG_PL011_CLOCK
597
598 If you have Amba PrimeCell PL011 UARTs, set this variable to
599 the clock speed of the UARTs.
600
601 CONFIG_PL01x_PORTS
602
603 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
604 define this to a list of base addresses for each (supported)
605 port. See e.g. include/configs/versatile.h
606
John Rigby910f1ae2011-04-19 10:42:39 +0000607 CONFIG_PL011_SERIAL_RLCR
608
609 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
610 have separate receive and transmit line control registers. Set
611 this variable to initialize the extra register.
612
613 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
614
615 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
616 boot loader that has already initialized the UART. Define this
617 variable to flush the UART at init time.
618
wdenk6705d812004-08-02 23:22:59 +0000619
wdenkc6097192002-11-03 00:24:07 +0000620- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000621 Depending on board, define exactly one serial port
622 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
623 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
624 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000625
626 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
627 port routines must be defined elsewhere
628 (i.e. serial_init(), serial_getc(), ...)
629
630 CONFIG_CFB_CONSOLE
631 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000632 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000633 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
634 (default big endian)
635 VIDEO_HW_RECTFILL graphic chip supports
636 rectangle fill
637 (cf. smiLynxEM)
638 VIDEO_HW_BITBLT graphic chip supports
639 bit-blit (cf. smiLynxEM)
640 VIDEO_VISIBLE_COLS visible pixel columns
641 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000642 VIDEO_VISIBLE_ROWS visible pixel rows
643 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000644 VIDEO_DATA_FORMAT graphic data format
645 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000646 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000647 VIDEO_KBD_INIT_FCT keyboard int fct
648 (i.e. i8042_kbd_init())
649 VIDEO_TSTC_FCT test char fct
650 (i.e. i8042_tstc)
651 VIDEO_GETC_FCT get char fct
652 (i.e. i8042_getc)
653 CONFIG_CONSOLE_CURSOR cursor drawing on/off
654 (requires blink timer
655 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200656 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000657 CONFIG_CONSOLE_TIME display time/date info in
658 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500659 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000660 CONFIG_VIDEO_LOGO display Linux logo in
661 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000662 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
663 linux_logo.h for logo.
664 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000665 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200666 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000667 the logo
668
Pali Rohár33a35bb2012-10-19 13:30:09 +0000669 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
670 a limited number of ANSI escape sequences (cursor control,
671 erase functions and limited graphics rendition control).
672
wdenk43d96162003-03-06 00:02:04 +0000673 When CONFIG_CFB_CONSOLE is defined, video console is
674 default i/o. Serial console can be forced with
675 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000676
wdenkd4ca31c2004-01-02 14:00:00 +0000677 When CONFIG_SILENT_CONSOLE is defined, all console
678 messages (by U-Boot and Linux!) can be silenced with
679 the "silent" environment variable. See
680 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000681
wdenkc6097192002-11-03 00:24:07 +0000682- Console Baudrate:
683 CONFIG_BAUDRATE - in bps
684 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200685 CONFIG_SYS_BAUDRATE_TABLE, see below.
686 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000687
Heiko Schocherc92fac92009-01-30 12:55:38 +0100688- Console Rx buffer length
689 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
690 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100691 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100692 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
693 must be defined, to setup the maximum idle timeout for
694 the SMC.
695
Graeme Russ9558b482011-09-01 00:48:27 +0000696- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200697 Prior to the console being initialised (i.e. serial UART
698 initialised etc) all console output is silently discarded.
699 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
700 buffer any console messages prior to the console being
701 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
702 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
703 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200704 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200705 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000706
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200707 'Sane' compilers will generate smaller code if
708 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000709
Sonny Rao046a37b2011-11-02 09:52:08 +0000710- Safe printf() functions
711 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
712 the printf() functions. These are defined in
713 include/vsprintf.h and include snprintf(), vsnprintf() and
714 so on. Code size increase is approximately 300-500 bytes.
715 If this option is not given then these functions will
716 silently discard their buffer size argument - this means
717 you are not getting any overflow checking in this case.
718
wdenkc6097192002-11-03 00:24:07 +0000719- Boot Delay: CONFIG_BOOTDELAY - in seconds
720 Delay before automatically booting the default image;
721 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000722 set to -2 to autoboot with no delay and not check for abort
723 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000724
725 See doc/README.autoboot for these options that
726 work with CONFIG_BOOTDELAY. None are required.
727 CONFIG_BOOT_RETRY_TIME
728 CONFIG_BOOT_RETRY_MIN
729 CONFIG_AUTOBOOT_KEYED
730 CONFIG_AUTOBOOT_PROMPT
731 CONFIG_AUTOBOOT_DELAY_STR
732 CONFIG_AUTOBOOT_STOP_STR
733 CONFIG_AUTOBOOT_DELAY_STR2
734 CONFIG_AUTOBOOT_STOP_STR2
735 CONFIG_ZERO_BOOTDELAY_CHECK
736 CONFIG_RESET_TO_RETRY
737
738- Autoboot Command:
739 CONFIG_BOOTCOMMAND
740 Only needed when CONFIG_BOOTDELAY is enabled;
741 define a command string that is automatically executed
742 when no character is read on the console interface
743 within "Boot Delay" after reset.
744
745 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000746 This can be used to pass arguments to the bootm
747 command. The value of CONFIG_BOOTARGS goes into the
748 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000749
750 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000751 The value of these goes into the environment as
752 "ramboot" and "nfsboot" respectively, and can be used
753 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200754 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000755
756- Pre-Boot Commands:
757 CONFIG_PREBOOT
758
759 When this option is #defined, the existence of the
760 environment variable "preboot" will be checked
761 immediately before starting the CONFIG_BOOTDELAY
762 countdown and/or running the auto-boot command resp.
763 entering interactive mode.
764
765 This feature is especially useful when "preboot" is
766 automatically generated or modified. For an example
767 see the LWMON board specific code: here "preboot" is
768 modified when the user holds down a certain
769 combination of keys on the (special) keyboard when
770 booting the systems
771
772- Serial Download Echo Mode:
773 CONFIG_LOADS_ECHO
774 If defined to 1, all characters received during a
775 serial download (using the "loads" command) are
776 echoed back. This might be needed by some terminal
777 emulations (like "cu"), but may as well just take
778 time on others. This setting #define's the initial
779 value of the "loads_echo" environment variable.
780
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500781- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000782 CONFIG_KGDB_BAUDRATE
783 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200784 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000785
786- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500787 Monitor commands can be included or excluded
788 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000789 <config_cmd_all.h> and #undef'ing unwanted
790 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500791 and augmenting with additional #define's
792 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000793
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500794 The default command configuration includes all commands
795 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000796
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500797 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500798 CONFIG_CMD_BDI bdinfo
799 CONFIG_CMD_BEDBUG * Include BedBug Debugger
800 CONFIG_CMD_BMP * BMP support
801 CONFIG_CMD_BSP * Board specific commands
802 CONFIG_CMD_BOOTD bootd
803 CONFIG_CMD_CACHE * icache, dcache
804 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500805 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500806 CONFIG_CMD_DATE * support for RTC, date/time...
807 CONFIG_CMD_DHCP * DHCP support
808 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600809 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
810 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
811 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
812 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500813 CONFIG_CMD_DTT * Digital Therm and Thermostat
814 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500815 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500816 CONFIG_CMD_EEPROM * EEPROM read/write support
817 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500818 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000819 CONFIG_CMD_EXT2 * ext2 command support
820 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500821 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500822 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000823 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_FDOS * Dos diskette Support
825 CONFIG_CMD_FLASH flinfo, erase, protect
826 CONFIG_CMD_FPGA FPGA device initialization support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000827 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500828 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000829 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
831 CONFIG_CMD_I2C * I2C serial bus support
832 CONFIG_CMD_IDE * IDE harddisk support
833 CONFIG_CMD_IMI iminfo
834 CONFIG_CMD_IMLS List all found images
835 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500836 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000837 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500838 CONFIG_CMD_IRQ * irqinfo
839 CONFIG_CMD_ITEST Integer/string test of 2 values
840 CONFIG_CMD_JFFS2 * JFFS2 Support
841 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500842 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000843 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
844 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500845 CONFIG_CMD_LOADB loadb
846 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400847 CONFIG_CMD_MD5SUM print md5 message digest
848 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500849 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
850 loop, loopw, mtest
851 CONFIG_CMD_MISC Misc functions like sleep etc
852 CONFIG_CMD_MMC * MMC memory mapped support
853 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100854 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500855 CONFIG_CMD_NAND * NAND support
856 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600857 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000858 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500859 CONFIG_CMD_PCI * pciinfo
860 CONFIG_CMD_PCMCIA * PCMCIA support
861 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
862 host
863 CONFIG_CMD_PORTIO * Port I/O
864 CONFIG_CMD_REGINFO * Register dump
865 CONFIG_CMD_RUN run command in env variable
866 CONFIG_CMD_SAVES * save S record dump
867 CONFIG_CMD_SCSI * SCSI Support
868 CONFIG_CMD_SDRAM * print SDRAM configuration information
869 (requires CONFIG_CMD_I2C)
870 CONFIG_CMD_SETGETDCR Support for DCR Register access
871 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700872 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100873 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400874 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200875 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500876 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000877 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000878 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000879 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
880 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500881 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500882 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000883 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000884
wdenkc6097192002-11-03 00:24:07 +0000885
886 EXAMPLE: If you want all functions except of network
887 support you can write:
888
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500889 #include "config_cmd_all.h"
890 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000891
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400892 Other Commands:
893 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000894
895 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500896 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000897 what you (and your U-Boot users) are doing. Data
898 cache cannot be enabled on systems like the 8xx or
899 8260 (where accesses to the IMMR region must be
900 uncached), and it cannot be disabled on all other
901 systems where we (mis-) use the data cache to hold an
902 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000903
904
905 XXX - this list needs to get updated!
906
Simon Glass45ba8072011-10-15 05:48:20 +0000907- Device tree:
908 CONFIG_OF_CONTROL
909 If this variable is defined, U-Boot will use a device tree
910 to configure its devices, instead of relying on statically
911 compiled #defines in the board file. This option is
912 experimental and only available on a few boards. The device
913 tree is available in the global data as gd->fdt_blob.
914
Simon Glass2c0f79e2011-10-24 19:15:31 +0000915 U-Boot needs to get its device tree from somewhere. This can
916 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000917
918 CONFIG_OF_EMBED
919 If this variable is defined, U-Boot will embed a device tree
920 binary in its image. This device tree file should be in the
921 board directory and called <soc>-<board>.dts. The binary file
922 is then picked up in board_init_f() and made available through
923 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000924
Simon Glass2c0f79e2011-10-24 19:15:31 +0000925 CONFIG_OF_SEPARATE
926 If this variable is defined, U-Boot will build a device tree
927 binary. It will be called u-boot.dtb. Architecture-specific
928 code will locate it at run-time. Generally this works by:
929
930 cat u-boot.bin u-boot.dtb >image.bin
931
932 and in fact, U-Boot does this for you, creating a file called
933 u-boot-dtb.bin which is useful in the common case. You can
934 still use the individual files if you need something more
935 exotic.
936
wdenkc6097192002-11-03 00:24:07 +0000937- Watchdog:
938 CONFIG_WATCHDOG
939 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000940 support for the SoC. There must be support in the SoC
941 specific code for a watchdog. For the 8xx and 8260
942 CPUs, the SIU Watchdog feature is enabled in the SYPCR
943 register. When supported for a specific SoC is
944 available, then no further board specific code should
945 be needed to use it.
946
947 CONFIG_HW_WATCHDOG
948 When using a watchdog circuitry external to the used
949 SoC, then define this variable and provide board
950 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000951
stroesec1551ea2003-04-04 15:53:41 +0000952- U-Boot Version:
953 CONFIG_VERSION_VARIABLE
954 If this variable is defined, an environment variable
955 named "ver" is created by U-Boot showing the U-Boot
956 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200957 Any change to this variable will be reverted at the
958 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000959
wdenkc6097192002-11-03 00:24:07 +0000960- Real-Time Clock:
961
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500962 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000963 has to be selected, too. Define exactly one of the
964 following options:
965
966 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
967 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000968 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000969 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000970 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000971 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000972 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000973 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100974 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000975 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200976 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200977 CONFIG_SYS_RV3029_TCR - enable trickle charger on
978 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000979
wdenkb37c7e52003-06-30 16:24:52 +0000980 Note that if the RTC uses I2C, then the I2C interface
981 must also be configured. See I2C Support, below.
982
Peter Tysere92739d2008-12-17 16:36:21 -0600983- GPIO Support:
984 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
985 CONFIG_PCA953X_INFO - enable pca953x info command
986
Chris Packham5dec49c2010-12-19 10:12:13 +0000987 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
988 chip-ngpio pairs that tell the PCA953X driver the number of
989 pins supported by a particular chip.
990
Peter Tysere92739d2008-12-17 16:36:21 -0600991 Note that if the GPIO device uses I2C, then the I2C interface
992 must also be configured. See I2C Support, below.
993
wdenkc6097192002-11-03 00:24:07 +0000994- Timestamp Support:
995
wdenk43d96162003-03-06 00:02:04 +0000996 When CONFIG_TIMESTAMP is selected, the timestamp
997 (date and time) of an image is printed by image
998 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500999 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001000
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001001- Partition Labels (disklabels) Supported:
1002 Zero or more of the following:
1003 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1004 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1005 Intel architecture, USB sticks, etc.
1006 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1007 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1008 bootloader. Note 2TB partition limit; see
1009 disk/part_efi.c
1010 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001011
Wolfgang Denk218ca722008-03-26 10:40:12 +01001012 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1013 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001014 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001015
1016- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001017 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1018 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001019
wdenk4d13cba2004-03-14 14:09:05 +00001020 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1021 be performed by calling the function
1022 ide_set_reset(int reset)
1023 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001024
1025- ATAPI Support:
1026 CONFIG_ATAPI
1027
1028 Set this to enable ATAPI support.
1029
wdenkc40b2952004-03-13 23:29:43 +00001030- LBA48 Support
1031 CONFIG_LBA48
1032
1033 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001034 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001035 Whithout these , LBA48 support uses 32bit variables and will 'only'
1036 support disks up to 2.1TB.
1037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001038 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001039 When enabled, makes the IDE subsystem use 64bit sector addresses.
1040 Default is 32bit.
1041
wdenkc6097192002-11-03 00:24:07 +00001042- SCSI Support:
1043 At the moment only there is only support for the
1044 SYM53C8XX SCSI controller; define
1045 CONFIG_SCSI_SYM53C8XX to enable it.
1046
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001047 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1048 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1049 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001050 maximum numbers of LUNs, SCSI ID's and target
1051 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001052 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001053
Stefan Reinauer447c0312012-10-29 05:23:48 +00001054 The environment variable 'scsidevs' is set to the number of
1055 SCSI devices found during the last scan.
1056
wdenkc6097192002-11-03 00:24:07 +00001057- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001058 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001059 Support for Intel 8254x/8257x gigabit chips.
1060
1061 CONFIG_E1000_SPI
1062 Utility code for direct access to the SPI bus on Intel 8257x.
1063 This does not do anything useful unless you set at least one
1064 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1065
1066 CONFIG_E1000_SPI_GENERIC
1067 Allow generic access to the SPI bus on the Intel 8257x, for
1068 example with the "sspi" command.
1069
1070 CONFIG_CMD_E1000
1071 Management command for E1000 devices. When used on devices
1072 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001073
Andre Schwarzac3315c2008-03-06 16:45:44 +01001074 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001075 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001076
wdenkc6097192002-11-03 00:24:07 +00001077 CONFIG_EEPRO100
1078 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001079 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001080 write routine for first time initialisation.
1081
1082 CONFIG_TULIP
1083 Support for Digital 2114x chips.
1084 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1085 modem chip initialisation (KS8761/QS6611).
1086
1087 CONFIG_NATSEMI
1088 Support for National dp83815 chips.
1089
1090 CONFIG_NS8382X
1091 Support for National dp8382[01] gigabit chips.
1092
wdenk45219c42003-05-12 21:50:16 +00001093- NETWORK Support (other):
1094
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001095 CONFIG_DRIVER_AT91EMAC
1096 Support for AT91RM9200 EMAC.
1097
1098 CONFIG_RMII
1099 Define this to use reduced MII inteface
1100
1101 CONFIG_DRIVER_AT91EMAC_QUIET
1102 If this defined, the driver is quiet.
1103 The driver doen't show link status messages.
1104
Rob Herringefdd7312011-12-15 11:15:49 +00001105 CONFIG_CALXEDA_XGMAC
1106 Support for the Calxeda XGMAC device
1107
Ashok3bb46d22012-10-15 06:20:47 +00001108 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001109 Support for SMSC's LAN91C96 chips.
1110
1111 CONFIG_LAN91C96_BASE
1112 Define this to hold the physical address
1113 of the LAN91C96's I/O space
1114
1115 CONFIG_LAN91C96_USE_32_BIT
1116 Define this to enable 32 bit addressing
1117
Ashok3bb46d22012-10-15 06:20:47 +00001118 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001119 Support for SMSC's LAN91C111 chip
1120
1121 CONFIG_SMC91111_BASE
1122 Define this to hold the physical address
1123 of the device (I/O space)
1124
1125 CONFIG_SMC_USE_32_BIT
1126 Define this if data bus is 32 bits
1127
1128 CONFIG_SMC_USE_IOFUNCS
1129 Define this to use i/o functions instead of macros
1130 (some hardware wont work with macros)
1131
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001132 CONFIG_DRIVER_TI_EMAC
1133 Support for davinci emac
1134
1135 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1136 Define this if you have more then 3 PHYs.
1137
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001138 CONFIG_FTGMAC100
1139 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1140
1141 CONFIG_FTGMAC100_EGIGA
1142 Define this to use GE link update with gigabit PHY.
1143 Define this if FTGMAC100 is connected to gigabit PHY.
1144 If your system has 10/100 PHY only, it might not occur
1145 wrong behavior. Because PHY usually return timeout or
1146 useless data when polling gigabit status and gigabit
1147 control registers. This behavior won't affect the
1148 correctnessof 10/100 link speed update.
1149
Mike Rapoportc2fff332009-11-11 10:03:03 +02001150 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001151 Support for SMSC's LAN911x and LAN921x chips
1152
Mike Rapoportc2fff332009-11-11 10:03:03 +02001153 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001154 Define this to hold the physical address
1155 of the device (I/O space)
1156
Mike Rapoportc2fff332009-11-11 10:03:03 +02001157 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001158 Define this if data bus is 32 bits
1159
Mike Rapoportc2fff332009-11-11 10:03:03 +02001160 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001161 Define this if data bus is 16 bits. If your processor
1162 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001163 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001164
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001165 CONFIG_SH_ETHER
1166 Support for Renesas on-chip Ethernet controller
1167
1168 CONFIG_SH_ETHER_USE_PORT
1169 Define the number of ports to be used
1170
1171 CONFIG_SH_ETHER_PHY_ADDR
1172 Define the ETH PHY's address
1173
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001174 CONFIG_SH_ETHER_CACHE_WRITEBACK
1175 If this option is set, the driver enables cache flush.
1176
Vadim Bendebury5e124722011-10-17 08:36:14 +00001177- TPM Support:
1178 CONFIG_GENERIC_LPC_TPM
1179 Support for generic parallel port TPM devices. Only one device
1180 per system is supported at this time.
1181
1182 CONFIG_TPM_TIS_BASE_ADDRESS
1183 Base address where the generic TPM device is mapped
1184 to. Contemporary x86 systems usually map it at
1185 0xfed40000.
1186
wdenkc6097192002-11-03 00:24:07 +00001187- USB Support:
1188 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001189 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001190 CONFIG_USB_UHCI to enable it.
1191 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001192 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001193 storage devices.
1194 Note:
1195 Supported are USB Keyboards and USB Floppy drives
1196 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001197 MPC5200 USB requires additional defines:
1198 CONFIG_USB_CLOCK
1199 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001200 CONFIG_PSC3_USB
1201 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001202 CONFIG_USB_CONFIG
1203 for differential drivers: 0x00001000
1204 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001205 for differential drivers on PSC3: 0x00000100
1206 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001207 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001208 May be defined to allow interrupt polling
1209 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001210
Simon Glass9ab4ce22012-02-27 10:52:47 +00001211 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1212 txfilltuning field in the EHCI controller on reset.
1213
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001214- USB Device:
1215 Define the below if you wish to use the USB console.
1216 Once firmware is rebuilt from a serial console issue the
1217 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001218 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001219 it has found a new device. The environment variable usbtty
1220 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001221 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001222 Common Device Class Abstract Control Model serial device.
1223 If you select usbtty = gserial you should be able to enumerate
1224 a Linux host by
1225 # modprobe usbserial vendor=0xVendorID product=0xProductID
1226 else if using cdc_acm, simply setting the environment
1227 variable usbtty to be cdc_acm should suffice. The following
1228 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001229
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001230 CONFIG_USB_DEVICE
1231 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001232
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001233 CONFIG_USB_TTY
1234 Define this to have a tty type of device available to
1235 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001236
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301237 CONFIG_USBD_HS
1238 Define this to enable the high speed support for usb
1239 device and usbtty. If this feature is enabled, a routine
1240 int is_usbd_high_speed(void)
1241 also needs to be defined by the driver to dynamically poll
1242 whether the enumeration has succeded at high speed or full
1243 speed.
1244
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001245 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001246 Define this if you want stdin, stdout &/or stderr to
1247 be set to usbtty.
1248
1249 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001250 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001251 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001252 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001253
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001254 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001255 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001256 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001257
Wolfgang Denk386eda02006-06-14 18:14:56 +02001258 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001259 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001260 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001261 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1262 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1263 should pretend to be a Linux device to it's target host.
1264
1265 CONFIG_USBD_MANUFACTURER
1266 Define this string as the name of your company for
1267 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001268
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001269 CONFIG_USBD_PRODUCT_NAME
1270 Define this string as the name of your product
1271 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1272
1273 CONFIG_USBD_VENDORID
1274 Define this as your assigned Vendor ID from the USB
1275 Implementors Forum. This *must* be a genuine Vendor ID
1276 to avoid polluting the USB namespace.
1277 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001278
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001279 CONFIG_USBD_PRODUCTID
1280 Define this as the unique Product ID
1281 for your device
1282 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001283
Igor Grinbergd70a5602011-12-12 12:08:35 +02001284- ULPI Layer Support:
1285 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1286 the generic ULPI layer. The generic layer accesses the ULPI PHY
1287 via the platform viewport, so you need both the genric layer and
1288 the viewport enabled. Currently only Chipidea/ARC based
1289 viewport is supported.
1290 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1291 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001292 If your ULPI phy needs a different reference clock than the
1293 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1294 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001295
1296- MMC Support:
1297 The MMC controller on the Intel PXA is supported. To
1298 enable this define CONFIG_MMC. The MMC can be
1299 accessed from the boot prompt by mapping the device
1300 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001301 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1302 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001303
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001304 CONFIG_SH_MMCIF
1305 Support for Renesas on-chip MMCIF controller
1306
1307 CONFIG_SH_MMCIF_ADDR
1308 Define the base address of MMCIF registers
1309
1310 CONFIG_SH_MMCIF_CLK
1311 Define the clock frequency for MMCIF
1312
wdenk6705d812004-08-02 23:22:59 +00001313- Journaling Flash filesystem support:
1314 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1315 CONFIG_JFFS2_NAND_DEV
1316 Define these for a default partition on a NAND device
1317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001318 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1319 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001320 Define these for a default partition on a NOR device
1321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001322 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001323 Define this to create an own partition. You have to provide a
1324 function struct part_info* jffs2_part_info(int part_num)
1325
1326 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001327 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001328 to disable the command chpart. This is the default when you
1329 have not defined a custom partition
1330
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001331- FAT(File Allocation Table) filesystem write function support:
1332 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001333
1334 Define this to enable support for saving memory data as a
1335 file in FAT formatted partition.
1336
1337 This will also enable the command "fatwrite" enabling the
1338 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001339
Gabe Black84cd9322012-10-12 14:26:11 +00001340CBFS (Coreboot Filesystem) support
1341 CONFIG_CMD_CBFS
1342
1343 Define this to enable support for reading from a Coreboot
1344 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1345 and cbfsload.
1346
wdenkc6097192002-11-03 00:24:07 +00001347- Keyboard Support:
1348 CONFIG_ISA_KEYBOARD
1349
1350 Define this to enable standard (PC-Style) keyboard
1351 support
1352
1353 CONFIG_I8042_KBD
1354 Standard PC keyboard driver with US (is default) and
1355 GERMAN key layout (switch via environment 'keymap=de') support.
1356 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1357 for cfb_console. Supports cursor blinking.
1358
1359- Video support:
1360 CONFIG_VIDEO
1361
1362 Define this to enable video support (for output to
1363 video).
1364
1365 CONFIG_VIDEO_CT69000
1366
1367 Enable Chips & Technologies 69000 Video chip
1368
1369 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001370 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001371 video output is selected via environment 'videoout'
1372 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1373 assumed.
wdenkc6097192002-11-03 00:24:07 +00001374
wdenkb79a11c2004-03-25 15:14:43 +00001375 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001376 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001377 are possible:
1378 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001379 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001380
1381 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1382 -------------+---------------------------------------------
1383 8 bits | 0x301* 0x303 0x305 0x161 0x307
1384 15 bits | 0x310 0x313 0x316 0x162 0x319
1385 16 bits | 0x311 0x314 0x317 0x163 0x31A
1386 24 bits | 0x312 0x315 0x318 ? 0x31B
1387 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001388 (i.e. setenv videomode 317; saveenv; reset;)
1389
wdenkb79a11c2004-03-25 15:14:43 +00001390 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001391 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001392
1393
stroesec1551ea2003-04-04 15:53:41 +00001394 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001395 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001396 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1397 or CONFIG_VIDEO_SED13806_16BPP
1398
Timur Tabi7d3053f2011-02-15 17:09:19 -06001399 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001400 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001401 SOCs that have a DIU should define this macro to enable DIU
1402 support, and should also define these other macros:
1403
1404 CONFIG_SYS_DIU_ADDR
1405 CONFIG_VIDEO
1406 CONFIG_CMD_BMP
1407 CONFIG_CFB_CONSOLE
1408 CONFIG_VIDEO_SW_CURSOR
1409 CONFIG_VGA_AS_SINGLE_DEVICE
1410 CONFIG_VIDEO_LOGO
1411 CONFIG_VIDEO_BMP_LOGO
1412
Timur Tabiba8e76b2011-04-11 14:18:22 -05001413 The DIU driver will look for the 'video-mode' environment
1414 variable, and if defined, enable the DIU as a console during
1415 boot. See the documentation file README.video for a
1416 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001417
Simon Glass058d59b2012-12-03 13:59:47 +00001418 CONFIG_VIDEO_VGA
1419
1420 Enable the VGA video / BIOS for x86. The alternative if you
1421 are using coreboot is to use the coreboot frame buffer
1422 driver.
1423
1424
wdenk682011f2003-06-03 23:54:09 +00001425- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001426 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001427
wdenk8bde7f72003-06-27 21:31:46 +00001428 Define this to enable a custom keyboard support.
1429 This simply calls drv_keyboard_init() which must be
1430 defined in your board-specific files.
1431 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001432
wdenkc6097192002-11-03 00:24:07 +00001433- LCD Support: CONFIG_LCD
1434
1435 Define this to enable LCD support (for output to LCD
1436 display); also select one of the supported displays
1437 by defining one of these:
1438
Stelian Pop39cf4802008-05-09 21:57:18 +02001439 CONFIG_ATMEL_LCD:
1440
1441 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1442
wdenkfd3103b2003-11-25 16:55:19 +00001443 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001444
wdenkfd3103b2003-11-25 16:55:19 +00001445 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001446
wdenkfd3103b2003-11-25 16:55:19 +00001447 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001448
wdenkfd3103b2003-11-25 16:55:19 +00001449 NEC NL6448BC20-08. 6.5", 640x480.
1450 Active, color, single scan.
1451
1452 CONFIG_NEC_NL6448BC33_54
1453
1454 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001455 Active, color, single scan.
1456
1457 CONFIG_SHARP_16x9
1458
1459 Sharp 320x240. Active, color, single scan.
1460 It isn't 16x9, and I am not sure what it is.
1461
1462 CONFIG_SHARP_LQ64D341
1463
1464 Sharp LQ64D341 display, 640x480.
1465 Active, color, single scan.
1466
1467 CONFIG_HLD1045
1468
1469 HLD1045 display, 640x480.
1470 Active, color, single scan.
1471
1472 CONFIG_OPTREX_BW
1473
1474 Optrex CBL50840-2 NF-FW 99 22 M5
1475 or
1476 Hitachi LMG6912RPFC-00T
1477 or
1478 Hitachi SP14Q002
1479
1480 320x240. Black & white.
1481
1482 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001483 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001484
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001485 CONFIG_LCD_BMP_RLE8
1486
1487 Support drawing of RLE8-compressed bitmaps on the LCD.
1488
1489
wdenk7152b1d2003-09-05 23:19:14 +00001490- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001491
wdenk8bde7f72003-06-27 21:31:46 +00001492 If this option is set, the environment is checked for
1493 a variable "splashimage". If found, the usual display
1494 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001495 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001496 specified in "splashimage" is loaded instead. The
1497 console is redirected to the "nulldev", too. This
1498 allows for a "silent" boot where a splash screen is
1499 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001500
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001501 CONFIG_SPLASH_SCREEN_ALIGN
1502
1503 If this option is set the splash image can be freely positioned
1504 on the screen. Environment variable "splashpos" specifies the
1505 position as "x,y". If a positive number is given it is used as
1506 number of pixel from left/top. If a negative number is given it
1507 is used as number of pixel from right/bottom. You can also
1508 specify 'm' for centering the image.
1509
1510 Example:
1511 setenv splashpos m,m
1512 => image at center of screen
1513
1514 setenv splashpos 30,20
1515 => image at x = 30 and y = 20
1516
1517 setenv splashpos -10,m
1518 => vertically centered image
1519 at x = dspWidth - bmpWidth - 9
1520
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001521- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1522
1523 If this option is set, additionally to standard BMP
1524 images, gzipped BMP images can be displayed via the
1525 splashscreen support or the bmp command.
1526
Anatolij Gustschind5011762010-03-15 14:50:25 +01001527- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1528
1529 If this option is set, 8-bit RLE compressed BMP images
1530 can be displayed via the splashscreen support or the
1531 bmp command.
1532
Lei Wenf2b96df2012-09-28 04:26:47 +00001533- Do compresssing for memory range:
1534 CONFIG_CMD_ZIP
1535
1536 If this option is set, it would use zlib deflate method
1537 to compress the specified memory at its best effort.
1538
wdenkc29fdfc2003-08-29 20:57:53 +00001539- Compression support:
1540 CONFIG_BZIP2
1541
1542 If this option is set, support for bzip2 compressed
1543 images is included. If not, only uncompressed and gzip
1544 compressed images are supported.
1545
wdenk42d1f032003-10-15 23:53:47 +00001546 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001547 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001548 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001549
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001550 CONFIG_LZMA
1551
1552 If this option is set, support for lzma compressed
1553 images is included.
1554
1555 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1556 requires an amount of dynamic memory that is given by the
1557 formula:
1558
1559 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1560
1561 Where lc and lp stand for, respectively, Literal context bits
1562 and Literal pos bits.
1563
1564 This value is upper-bounded by 14MB in the worst case. Anyway,
1565 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1566 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1567 a very small buffer.
1568
1569 Use the lzmainfo tool to determinate the lc and lp values and
1570 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001571 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001572
wdenk17ea1172004-06-06 21:51:03 +00001573- MII/PHY support:
1574 CONFIG_PHY_ADDR
1575
1576 The address of PHY on MII bus.
1577
1578 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1579
1580 The clock frequency of the MII bus
1581
1582 CONFIG_PHY_GIGE
1583
1584 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001585 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001586
1587 CONFIG_PHY_RESET_DELAY
1588
1589 Some PHY like Intel LXT971A need extra delay after
1590 reset before any MII register access is possible.
1591 For such PHY, set this option to the usec delay
1592 required. (minimum 300usec for LXT971A)
1593
1594 CONFIG_PHY_CMD_DELAY (ppc4xx)
1595
1596 Some PHY like Intel LXT971A need extra delay after
1597 command issued before MII status register can be read
1598
wdenkc6097192002-11-03 00:24:07 +00001599- Ethernet address:
1600 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001601 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001602 CONFIG_ETH2ADDR
1603 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001604 CONFIG_ETH4ADDR
1605 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001606
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001607 Define a default value for Ethernet address to use
1608 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001609 is not determined automatically.
1610
1611- IP address:
1612 CONFIG_IPADDR
1613
1614 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001615 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001616 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001617 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001618
1619- Server IP address:
1620 CONFIG_SERVERIP
1621
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001622 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001623 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001624 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001625
Robin Getz97cfe862009-07-21 12:15:28 -04001626 CONFIG_KEEP_SERVERADDR
1627
1628 Keeps the server's MAC address, in the env 'serveraddr'
1629 for passing to bootargs (like Linux's netconsole option)
1630
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001631- Gateway IP address:
1632 CONFIG_GATEWAYIP
1633
1634 Defines a default value for the IP address of the
1635 default router where packets to other networks are
1636 sent to.
1637 (Environment variable "gatewayip")
1638
1639- Subnet mask:
1640 CONFIG_NETMASK
1641
1642 Defines a default value for the subnet mask (or
1643 routing prefix) which is used to determine if an IP
1644 address belongs to the local subnet or needs to be
1645 forwarded through a router.
1646 (Environment variable "netmask")
1647
David Updegraff53a5c422007-06-11 10:41:07 -05001648- Multicast TFTP Mode:
1649 CONFIG_MCAST_TFTP
1650
1651 Defines whether you want to support multicast TFTP as per
1652 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001653 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001654 driver in use must provide a function: mcast() to join/leave a
1655 multicast group.
1656
wdenkc6097192002-11-03 00:24:07 +00001657- BOOTP Recovery Mode:
1658 CONFIG_BOOTP_RANDOM_DELAY
1659
1660 If you have many targets in a network that try to
1661 boot using BOOTP, you may want to avoid that all
1662 systems send out BOOTP requests at precisely the same
1663 moment (which would happen for instance at recovery
1664 from a power failure, when all systems will try to
1665 boot, thus flooding the BOOTP server. Defining
1666 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1667 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001668 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001669
1670 1st BOOTP request: delay 0 ... 1 sec
1671 2nd BOOTP request: delay 0 ... 2 sec
1672 3rd BOOTP request: delay 0 ... 4 sec
1673 4th and following
1674 BOOTP requests: delay 0 ... 8 sec
1675
stroesefe389a82003-08-28 14:17:32 +00001676- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001677 You can fine tune the DHCP functionality by defining
1678 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001679
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001680 CONFIG_BOOTP_SUBNETMASK
1681 CONFIG_BOOTP_GATEWAY
1682 CONFIG_BOOTP_HOSTNAME
1683 CONFIG_BOOTP_NISDOMAIN
1684 CONFIG_BOOTP_BOOTPATH
1685 CONFIG_BOOTP_BOOTFILESIZE
1686 CONFIG_BOOTP_DNS
1687 CONFIG_BOOTP_DNS2
1688 CONFIG_BOOTP_SEND_HOSTNAME
1689 CONFIG_BOOTP_NTPSERVER
1690 CONFIG_BOOTP_TIMEOFFSET
1691 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001692 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001693
Wilson Callan5d110f02007-07-28 10:56:13 -04001694 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1695 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001696
Joe Hershberger2c00e092012-05-23 07:59:19 +00001697 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1698 after the configured retry count, the call will fail
1699 instead of starting over. This can be used to fail over
1700 to Link-local IP address configuration if the DHCP server
1701 is not available.
1702
stroesefe389a82003-08-28 14:17:32 +00001703 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1704 serverip from a DHCP server, it is possible that more
1705 than one DNS serverip is offered to the client.
1706 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1707 serverip will be stored in the additional environment
1708 variable "dnsip2". The first DNS serverip is always
1709 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001710 is defined.
stroesefe389a82003-08-28 14:17:32 +00001711
1712 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1713 to do a dynamic update of a DNS server. To do this, they
1714 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001715 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001716 of the "hostname" environment variable is passed as
1717 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001718
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001719 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1720
1721 A 32bit value in microseconds for a delay between
1722 receiving a "DHCP Offer" and sending the "DHCP Request".
1723 This fixes a problem with certain DHCP servers that don't
1724 respond 100% of the time to a "DHCP request". E.g. On an
1725 AT91RM9200 processor running at 180MHz, this delay needed
1726 to be *at least* 15,000 usec before a Windows Server 2003
1727 DHCP server would reply 100% of the time. I recommend at
1728 least 50,000 usec to be safe. The alternative is to hope
1729 that one of the retries will be successful but note that
1730 the DHCP timeout and retry process takes a longer than
1731 this delay.
1732
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001733 - Link-local IP address negotiation:
1734 Negotiate with other link-local clients on the local network
1735 for an address that doesn't require explicit configuration.
1736 This is especially useful if a DHCP server cannot be guaranteed
1737 to exist in all environments that the device must operate.
1738
1739 See doc/README.link-local for more information.
1740
wdenka3d991b2004-04-15 21:48:45 +00001741 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001742 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001743
1744 The device id used in CDP trigger frames.
1745
1746 CONFIG_CDP_DEVICE_ID_PREFIX
1747
1748 A two character string which is prefixed to the MAC address
1749 of the device.
1750
1751 CONFIG_CDP_PORT_ID
1752
1753 A printf format string which contains the ascii name of
1754 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001755 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001756
1757 CONFIG_CDP_CAPABILITIES
1758
1759 A 32bit integer which indicates the device capabilities;
1760 0x00000010 for a normal host which does not forwards.
1761
1762 CONFIG_CDP_VERSION
1763
1764 An ascii string containing the version of the software.
1765
1766 CONFIG_CDP_PLATFORM
1767
1768 An ascii string containing the name of the platform.
1769
1770 CONFIG_CDP_TRIGGER
1771
1772 A 32bit integer sent on the trigger.
1773
1774 CONFIG_CDP_POWER_CONSUMPTION
1775
1776 A 16bit integer containing the power consumption of the
1777 device in .1 of milliwatts.
1778
1779 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1780
1781 A byte containing the id of the VLAN.
1782
wdenkc6097192002-11-03 00:24:07 +00001783- Status LED: CONFIG_STATUS_LED
1784
1785 Several configurations allow to display the current
1786 status using a LED. For instance, the LED will blink
1787 fast while running U-Boot code, stop blinking as
1788 soon as a reply to a BOOTP request was received, and
1789 start blinking slow once the Linux kernel is running
1790 (supported by a status LED driver in the Linux
1791 kernel). Defining CONFIG_STATUS_LED enables this
1792 feature in U-Boot.
1793
1794- CAN Support: CONFIG_CAN_DRIVER
1795
1796 Defining CONFIG_CAN_DRIVER enables CAN driver support
1797 on those systems that support this (optional)
1798 feature, like the TQM8xxL modules.
1799
1800- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1801
wdenkb37c7e52003-06-30 16:24:52 +00001802 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001803 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001804 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001805
wdenk945af8d2003-07-16 21:53:01 +00001806 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001807 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001808 CONFIG_COMMANDS) and communicate with i2c based realtime
1809 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001810 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001811
Ben Warrenbb99ad62006-09-07 16:50:54 -04001812 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001813
wdenk945af8d2003-07-16 21:53:01 +00001814 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001815 bit-banging) driver instead of CPM or similar hardware
1816 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001817
wdenk945af8d2003-07-16 21:53:01 +00001818 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001819 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001820
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001821 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001822 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001823 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001824 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001825
Peter Tyser8d321b82010-04-12 22:28:21 -05001826 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001827 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001828 and so its address should therefore be cleared to 0 (See,
1829 eg, MPC823e User's Manual p.16-473). So, set
1830 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001831
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001832 CONFIG_SYS_I2C_INIT_MPC5XXX
1833
1834 When a board is reset during an i2c bus transfer
1835 chips might think that the current transfer is still
1836 in progress. Reset the slave devices by sending start
1837 commands until the slave device responds.
1838
wdenk945af8d2003-07-16 21:53:01 +00001839 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001840
1841 If you use the software i2c interface (CONFIG_SOFT_I2C)
1842 then the following macros need to be defined (examples are
1843 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001844
1845 I2C_INIT
1846
wdenkb37c7e52003-06-30 16:24:52 +00001847 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001848 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001849
wdenkba56f622004-02-06 23:19:44 +00001850 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001851
wdenkc6097192002-11-03 00:24:07 +00001852 I2C_PORT
1853
wdenk43d96162003-03-06 00:02:04 +00001854 (Only for MPC8260 CPU). The I/O port to use (the code
1855 assumes both bits are on the same port). Valid values
1856 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001857
1858 I2C_ACTIVE
1859
1860 The code necessary to make the I2C data line active
1861 (driven). If the data line is open collector, this
1862 define can be null.
1863
wdenkb37c7e52003-06-30 16:24:52 +00001864 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1865
wdenkc6097192002-11-03 00:24:07 +00001866 I2C_TRISTATE
1867
1868 The code necessary to make the I2C data line tri-stated
1869 (inactive). If the data line is open collector, this
1870 define can be null.
1871
wdenkb37c7e52003-06-30 16:24:52 +00001872 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1873
wdenkc6097192002-11-03 00:24:07 +00001874 I2C_READ
1875
1876 Code that returns TRUE if the I2C data line is high,
1877 FALSE if it is low.
1878
wdenkb37c7e52003-06-30 16:24:52 +00001879 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1880
wdenkc6097192002-11-03 00:24:07 +00001881 I2C_SDA(bit)
1882
1883 If <bit> is TRUE, sets the I2C data line high. If it
1884 is FALSE, it clears it (low).
1885
wdenkb37c7e52003-06-30 16:24:52 +00001886 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001887 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001888 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001889
wdenkc6097192002-11-03 00:24:07 +00001890 I2C_SCL(bit)
1891
1892 If <bit> is TRUE, sets the I2C clock line high. If it
1893 is FALSE, it clears it (low).
1894
wdenkb37c7e52003-06-30 16:24:52 +00001895 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001896 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001897 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001898
wdenkc6097192002-11-03 00:24:07 +00001899 I2C_DELAY
1900
1901 This delay is invoked four times per clock cycle so this
1902 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001903 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001904 like:
1905
wdenkb37c7e52003-06-30 16:24:52 +00001906 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001907
Mike Frysinger793b5722010-07-21 13:38:02 -04001908 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1909
1910 If your arch supports the generic GPIO framework (asm/gpio.h),
1911 then you may alternatively define the two GPIOs that are to be
1912 used as SCL / SDA. Any of the previous I2C_xxx macros will
1913 have GPIO-based defaults assigned to them as appropriate.
1914
1915 You should define these to the GPIO value as given directly to
1916 the generic GPIO functions.
1917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001918 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001919
wdenk8bde7f72003-06-27 21:31:46 +00001920 When a board is reset during an i2c bus transfer
1921 chips might think that the current transfer is still
1922 in progress. On some boards it is possible to access
1923 the i2c SCLK line directly, either by using the
1924 processor pin as a GPIO or by having a second pin
1925 connected to the bus. If this option is defined a
1926 custom i2c_init_board() routine in boards/xxx/board.c
1927 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001928
Richard Retanubun26a33502010-04-12 15:08:17 -04001929 CONFIG_SYS_I2C_BOARD_LATE_INIT
1930
1931 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1932 defined a custom i2c_board_late_init() routine in
1933 boards/xxx/board.c is run AFTER the operations in i2c_init()
1934 is completed. This callpoint can be used to unreset i2c bus
1935 using CPU i2c controller register accesses for CPUs whose i2c
1936 controller provide such a method. It is called at the end of
1937 i2c_init() to allow i2c_init operations to setup the i2c bus
1938 controller on the CPU (e.g. setting bus speed & slave address).
1939
wdenk17ea1172004-06-06 21:51:03 +00001940 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1941
1942 This option enables configuration of bi_iic_fast[] flags
1943 in u-boot bd_info structure based on u-boot environment
1944 variable "i2cfast". (see also i2cfast)
1945
Ben Warrenbb99ad62006-09-07 16:50:54 -04001946 CONFIG_I2C_MULTI_BUS
1947
1948 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001949 must have a controller. At any point in time, only one bus is
1950 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001951 Note that bus numbering is zero-based.
1952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001953 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001954
1955 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001956 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001957 is set, specify a list of bus-device pairs. Otherwise, specify
1958 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001959
1960 e.g.
1961 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001962 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001963
1964 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1965
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001966 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001967 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001968
1969 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001971 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001972
1973 If defined, then this indicates the I2C bus number for DDR SPD.
1974 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001976 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001977
1978 If defined, then this indicates the I2C bus number for the RTC.
1979 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1980
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001981 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001982
1983 If defined, then this indicates the I2C bus number for the DTT.
1984 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1985
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001986 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001987
1988 If defined, specifies the I2C address of the DTT device.
1989 If not defined, then U-Boot uses predefined value for
1990 specified DTT device.
1991
Timur Tabibe5e6182006-11-03 19:15:00 -06001992 CONFIG_FSL_I2C
1993
1994 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001995 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001996
Heiko Schocher67b23a32008-10-15 09:39:47 +02001997 CONFIG_I2C_MUX
1998
1999 Define this option if you have I2C devices reached over 1 .. n
2000 I2C Muxes like the pca9544a. This option addes a new I2C
2001 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2002 new I2C Bus to the existing I2C Busses. If you select the
2003 new Bus with "i2c dev", u-bbot sends first the commandos for
2004 the muxes to activate this new "bus".
2005
2006 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2007 feature!
2008
2009 Example:
2010 Adding a new I2C Bus reached over 2 pca9544a muxes
2011 The First mux with address 70 and channel 6
2012 The Second mux with address 71 and channel 4
2013
2014 => i2c bus pca9544a:70:6:pca9544a:71:4
2015
2016 Use the "i2c bus" command without parameter, to get a list
2017 of I2C Busses with muxes:
2018
2019 => i2c bus
2020 Busses reached over muxes:
2021 Bus ID: 2
2022 reached over Mux(es):
2023 pca9544a@70 ch: 4
2024 Bus ID: 3
2025 reached over Mux(es):
2026 pca9544a@70 ch: 6
2027 pca9544a@71 ch: 4
2028 =>
2029
2030 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002031 u-boot first sends the command to the mux@70 to enable
2032 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002033 the channel 4.
2034
2035 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002036 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002037 the 2 muxes.
2038
2039 This option is actually implemented for the bitbanging
2040 algorithm in common/soft_i2c.c and for the Hardware I2C
2041 Bus on the MPC8260. But it should be not so difficult
2042 to add this option to other architectures.
2043
Andrew Dyer2ac69852008-12-29 17:36:01 -06002044 CONFIG_SOFT_I2C_READ_REPEATED_START
2045
2046 defining this will force the i2c_read() function in
2047 the soft_i2c driver to perform an I2C repeated start
2048 between writing the address pointer and reading the
2049 data. If this define is omitted the default behaviour
2050 of doing a stop-start sequence will be used. Most I2C
2051 devices can use either method, but some require one or
2052 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002053
wdenkc6097192002-11-03 00:24:07 +00002054- SPI Support: CONFIG_SPI
2055
2056 Enables SPI driver (so far only tested with
2057 SPI EEPROM, also an instance works with Crystal A/D and
2058 D/As on the SACSng board)
2059
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002060 CONFIG_SH_SPI
2061
2062 Enables the driver for SPI controller on SuperH. Currently
2063 only SH7757 is supported.
2064
wdenkc6097192002-11-03 00:24:07 +00002065 CONFIG_SPI_X
2066
2067 Enables extended (16-bit) SPI EEPROM addressing.
2068 (symmetrical to CONFIG_I2C_X)
2069
2070 CONFIG_SOFT_SPI
2071
wdenk43d96162003-03-06 00:02:04 +00002072 Enables a software (bit-bang) SPI driver rather than
2073 using hardware support. This is a general purpose
2074 driver that only requires three general I/O port pins
2075 (two outputs, one input) to function. If this is
2076 defined, the board configuration must define several
2077 SPI configuration items (port pins to use, etc). For
2078 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002079
Ben Warren04a9e112008-01-16 22:37:35 -05002080 CONFIG_HARD_SPI
2081
2082 Enables a hardware SPI driver for general-purpose reads
2083 and writes. As with CONFIG_SOFT_SPI, the board configuration
2084 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002085 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002086 example, see include/configs/mpc8349emds.h.
2087
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002088 CONFIG_MXC_SPI
2089
2090 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002091 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002092
Matthias Fuchs01335022007-12-27 17:12:34 +01002093- FPGA Support: CONFIG_FPGA
2094
2095 Enables FPGA subsystem.
2096
2097 CONFIG_FPGA_<vendor>
2098
2099 Enables support for specific chip vendors.
2100 (ALTERA, XILINX)
2101
2102 CONFIG_FPGA_<family>
2103
2104 Enables support for FPGA family.
2105 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2106
2107 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002108
wdenk43d96162003-03-06 00:02:04 +00002109 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002110
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002111 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002112
wdenk8bde7f72003-06-27 21:31:46 +00002113 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002115 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002116
wdenk43d96162003-03-06 00:02:04 +00002117 Enable checks on FPGA configuration interface busy
2118 status by the configuration function. This option
2119 will require a board or device specific function to
2120 be written.
wdenkc6097192002-11-03 00:24:07 +00002121
2122 CONFIG_FPGA_DELAY
2123
2124 If defined, a function that provides delays in the FPGA
2125 configuration driver.
2126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002127 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002128 Allow Control-C to interrupt FPGA configuration
2129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002130 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002131
wdenk43d96162003-03-06 00:02:04 +00002132 Check for configuration errors during FPGA bitfile
2133 loading. For example, abort during Virtex II
2134 configuration if the INIT_B line goes low (which
2135 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002137 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002138
wdenk43d96162003-03-06 00:02:04 +00002139 Maximum time to wait for the INIT_B line to deassert
2140 after PROB_B has been deasserted during a Virtex II
2141 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002142 ms.
wdenkc6097192002-11-03 00:24:07 +00002143
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002144 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002145
wdenk43d96162003-03-06 00:02:04 +00002146 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002147 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002148
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002149 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002150
wdenk43d96162003-03-06 00:02:04 +00002151 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002152 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002153
2154- Configuration Management:
2155 CONFIG_IDENT_STRING
2156
wdenk43d96162003-03-06 00:02:04 +00002157 If defined, this string will be added to the U-Boot
2158 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002159
2160- Vendor Parameter Protection:
2161
wdenk43d96162003-03-06 00:02:04 +00002162 U-Boot considers the values of the environment
2163 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002164 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002165 are set once by the board vendor / manufacturer, and
2166 protects these variables from casual modification by
2167 the user. Once set, these variables are read-only,
2168 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002169 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002170
2171 If CONFIG_ENV_OVERWRITE is #defined in your config
2172 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002173 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002174 these parameters.
2175
2176 Alternatively, if you #define _both_ CONFIG_ETHADDR
2177 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002178 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002179 which can be changed exactly ONCE by the user. [The
2180 serial# is unaffected by this, i. e. it remains
2181 read-only.]
2182
2183- Protected RAM:
2184 CONFIG_PRAM
2185
2186 Define this variable to enable the reservation of
2187 "protected RAM", i. e. RAM which is not overwritten
2188 by U-Boot. Define CONFIG_PRAM to hold the number of
2189 kB you want to reserve for pRAM. You can overwrite
2190 this default value by defining an environment
2191 variable "pram" to the number of kB you want to
2192 reserve. Note that the board info structure will
2193 still show the full amount of RAM. If pRAM is
2194 reserved, a new environment variable "mem" will
2195 automatically be defined to hold the amount of
2196 remaining RAM in a form that can be passed as boot
2197 argument to Linux, for instance like that:
2198
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002199 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002200 saveenv
2201
2202 This way you can tell Linux not to use this memory,
2203 either, which results in a memory region that will
2204 not be affected by reboots.
2205
2206 *WARNING* If your board configuration uses automatic
2207 detection of the RAM size, you must make sure that
2208 this memory test is non-destructive. So far, the
2209 following board configurations are known to be
2210 "pRAM-clean":
2211
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002212 IVMS8, IVML24, SPD8xx, TQM8xxL,
2213 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002214 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002215
Gabe Black40fef042012-12-02 04:55:18 +00002216- Access to physical memory region (> 4GB)
2217 Some basic support is provided for operations on memory not
2218 normally accessible to U-Boot - e.g. some architectures
2219 support access to more than 4GB of memory on 32-bit
2220 machines using physical address extension or similar.
2221 Define CONFIG_PHYSMEM to access this basic support, which
2222 currently only supports clearing the memory.
2223
wdenkc6097192002-11-03 00:24:07 +00002224- Error Recovery:
2225 CONFIG_PANIC_HANG
2226
2227 Define this variable to stop the system in case of a
2228 fatal error, so that you have to reset it manually.
2229 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002230 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002231 automatically as fast as possible, but it may be
2232 useful during development since you can try to debug
2233 the conditions that lead to the situation.
2234
2235 CONFIG_NET_RETRY_COUNT
2236
wdenk43d96162003-03-06 00:02:04 +00002237 This variable defines the number of retries for
2238 network operations like ARP, RARP, TFTP, or BOOTP
2239 before giving up the operation. If not defined, a
2240 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002241
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002242 CONFIG_ARP_TIMEOUT
2243
2244 Timeout waiting for an ARP reply in milliseconds.
2245
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002246 CONFIG_NFS_TIMEOUT
2247
2248 Timeout in milliseconds used in NFS protocol.
2249 If you encounter "ERROR: Cannot umount" in nfs command,
2250 try longer timeout such as
2251 #define CONFIG_NFS_TIMEOUT 10000UL
2252
wdenkc6097192002-11-03 00:24:07 +00002253- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002254 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002255
2256 Enable auto completion of commands using TAB.
2257
Wolfgang Denka9398e02006-11-27 15:32:42 +01002258 Note that this feature has NOT been implemented yet
2259 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002260
2261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002262 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002263
2264 Define this variable to enable the "hush" shell (from
2265 Busybox) as command line interpreter, thus enabling
2266 powerful command line syntax like
2267 if...then...else...fi conditionals or `&&' and '||'
2268 constructs ("shell scripts").
2269
2270 If undefined, you get the old, much simpler behaviour
2271 with a somewhat smaller memory footprint.
2272
2273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002274 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002275
2276 This defines the secondary prompt string, which is
2277 printed when the command interpreter needs more input
2278 to complete a command. Usually "> ".
2279
2280 Note:
2281
wdenk8bde7f72003-06-27 21:31:46 +00002282 In the current implementation, the local variables
2283 space and global environment variables space are
2284 separated. Local variables are those you define by
2285 simply typing `name=value'. To access a local
2286 variable later on, you have write `$name' or
2287 `${name}'; to execute the contents of a variable
2288 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002289
wdenk43d96162003-03-06 00:02:04 +00002290 Global environment variables are those you use
2291 setenv/printenv to work with. To run a command stored
2292 in such a variable, you need to use the run command,
2293 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002294
2295 To store commands and special characters in a
2296 variable, please use double quotation marks
2297 surrounding the whole text of the variable, instead
2298 of the backslashes before semicolons and special
2299 symbols.
2300
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002301- Commandline Editing and History:
2302 CONFIG_CMDLINE_EDITING
2303
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002304 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002305 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002306
wdenka8c7c702003-12-06 19:49:23 +00002307- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002308 CONFIG_EXTRA_ENV_SETTINGS
2309
wdenk43d96162003-03-06 00:02:04 +00002310 Define this to contain any number of null terminated
2311 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002312 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002313
wdenk43d96162003-03-06 00:02:04 +00002314 For example, place something like this in your
2315 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002316
2317 #define CONFIG_EXTRA_ENV_SETTINGS \
2318 "myvar1=value1\0" \
2319 "myvar2=value2\0"
2320
wdenk43d96162003-03-06 00:02:04 +00002321 Warning: This method is based on knowledge about the
2322 internal format how the environment is stored by the
2323 U-Boot code. This is NOT an official, exported
2324 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002325 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002326 You better know what you are doing here.
2327
wdenk43d96162003-03-06 00:02:04 +00002328 Note: overly (ab)use of the default environment is
2329 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002330 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002331 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002332
Stephen Warren5e724ca2012-05-22 09:21:54 +00002333 CONFIG_ENV_VARS_UBOOT_CONFIG
2334
2335 Define this in order to add variables describing the
2336 U-Boot build configuration to the default environment.
2337 These will be named arch, cpu, board, vendor, and soc.
2338
2339 Enabling this option will cause the following to be defined:
2340
2341 - CONFIG_SYS_ARCH
2342 - CONFIG_SYS_CPU
2343 - CONFIG_SYS_BOARD
2344 - CONFIG_SYS_VENDOR
2345 - CONFIG_SYS_SOC
2346
Tom Rini7e27f892012-10-24 07:28:16 +00002347 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2348
2349 Define this in order to add variables describing certain
2350 run-time determined information about the hardware to the
2351 environment. These will be named board_name, board_rev.
2352
wdenka8c7c702003-12-06 19:49:23 +00002353- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002354 CONFIG_HAS_DATAFLASH
2355
wdenk8bde7f72003-06-27 21:31:46 +00002356 Defining this option enables DataFlash features and
2357 allows to read/write in Dataflash via the standard
2358 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002359
Eric Nelsonf61ec452012-01-31 10:52:08 -07002360- Serial Flash support
2361 CONFIG_CMD_SF
2362
2363 Defining this option enables SPI flash commands
2364 'sf probe/read/write/erase/update'.
2365
2366 Usage requires an initial 'probe' to define the serial
2367 flash parameters, followed by read/write/erase/update
2368 commands.
2369
2370 The following defaults may be provided by the platform
2371 to handle the common case when only a single serial
2372 flash is present on the system.
2373
2374 CONFIG_SF_DEFAULT_BUS Bus identifier
2375 CONFIG_SF_DEFAULT_CS Chip-select
2376 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2377 CONFIG_SF_DEFAULT_SPEED in Hz
2378
wdenk3f85ce22004-02-23 16:11:30 +00002379- SystemACE Support:
2380 CONFIG_SYSTEMACE
2381
2382 Adding this option adds support for Xilinx SystemACE
2383 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002384 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002385 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002386
2387 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002388 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002389
2390 When SystemACE support is added, the "ace" device type
2391 becomes available to the fat commands, i.e. fatls.
2392
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002393- TFTP Fixed UDP Port:
2394 CONFIG_TFTP_PORT
2395
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002396 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002397 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002398 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002399 number generator is used.
2400
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002401 Also, the environment variable tftpdstp is used to supply
2402 the TFTP UDP destination port value. If tftpdstp isn't
2403 defined, the normal port 69 is used.
2404
2405 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002406 blindly start the TFTP transfer using the pre-configured
2407 target IP address and UDP port. This has the effect of
2408 "punching through" the (Windows XP) firewall, allowing
2409 the remainder of the TFTP transfer to proceed normally.
2410 A better solution is to properly configure the firewall,
2411 but sometimes that is not allowed.
2412
wdenka8c7c702003-12-06 19:49:23 +00002413- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002414 CONFIG_SHOW_BOOT_PROGRESS
2415
wdenk43d96162003-03-06 00:02:04 +00002416 Defining this option allows to add some board-
2417 specific code (calling a user-provided function
2418 "show_boot_progress(int)") that enables you to show
2419 the system's boot progress on some display (for
2420 example, some LED's) on your board. At the moment,
2421 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002422
Simon Glass3a608ca2012-02-13 13:51:19 +00002423- Detailed boot stage timing
2424 CONFIG_BOOTSTAGE
2425 Define this option to get detailed timing of each stage
2426 of the boot process.
2427
2428 CONFIG_BOOTSTAGE_USER_COUNT
2429 This is the number of available user bootstage records.
2430 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2431 a new ID will be allocated from this stash. If you exceed
2432 the limit, recording will stop.
2433
2434 CONFIG_BOOTSTAGE_REPORT
2435 Define this to print a report before boot, similar to this:
2436
2437 Timer summary in microseconds:
2438 Mark Elapsed Stage
2439 0 0 reset
2440 3,575,678 3,575,678 board_init_f start
2441 3,575,695 17 arch_cpu_init A9
2442 3,575,777 82 arch_cpu_init done
2443 3,659,598 83,821 board_init_r start
2444 3,910,375 250,777 main_loop
2445 29,916,167 26,005,792 bootm_start
2446 30,361,327 445,160 start_kernel
2447
Simon Glass2eba38c2012-09-28 08:56:39 +00002448 CONFIG_CMD_BOOTSTAGE
2449 Add a 'bootstage' command which supports printing a report
2450 and un/stashing of bootstage data.
2451
Simon Glass94fd1312012-09-28 08:56:37 +00002452 CONFIG_BOOTSTAGE_FDT
2453 Stash the bootstage information in the FDT. A root 'bootstage'
2454 node is created with each bootstage id as a child. Each child
2455 has a 'name' property and either 'mark' containing the
2456 mark time in microsecond, or 'accum' containing the
2457 accumulated time for that bootstage id in microseconds.
2458 For example:
2459
2460 bootstage {
2461 154 {
2462 name = "board_init_f";
2463 mark = <3575678>;
2464 };
2465 170 {
2466 name = "lcd";
2467 accum = <33482>;
2468 };
2469 };
2470
2471 Code in the Linux kernel can find this in /proc/devicetree.
2472
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002473Legacy uImage format:
2474
wdenkc6097192002-11-03 00:24:07 +00002475 Arg Where When
2476 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002477 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002478 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002479 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002480 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002481 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002482 4 common/cmd_bootm.c Image data has correct checksum
2483 -4 common/cmd_bootm.c Image is for unsupported architecture
2484 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002485 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002486 6 common/cmd_bootm.c Image Type check OK
2487 -6 common/cmd_bootm.c gunzip uncompression error
2488 -7 common/cmd_bootm.c Unimplemented compression type
2489 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002490 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002491 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002492
2493 9 common/image.c Start initial ramdisk verification
2494 -10 common/image.c Ramdisk header has bad magic number
2495 -11 common/image.c Ramdisk header has bad checksum
2496 10 common/image.c Ramdisk header is OK
2497 -12 common/image.c Ramdisk data has bad checksum
2498 11 common/image.c Ramdisk data has correct checksum
2499 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002500 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002501 13 common/image.c Start multifile image verification
2502 14 common/image.c No initial ramdisk, no multifile, continue.
2503
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002504 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002505
Stefan Roesea47a12b2010-04-15 16:07:28 +02002506 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002507 -31 post/post.c POST test failed, detected by post_output_backlog()
2508 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002509
Heiko Schocher566a4942007-06-22 19:11:54 +02002510 34 common/cmd_doc.c before loading a Image from a DOC device
2511 -35 common/cmd_doc.c Bad usage of "doc" command
2512 35 common/cmd_doc.c correct usage of "doc" command
2513 -36 common/cmd_doc.c No boot device
2514 36 common/cmd_doc.c correct boot device
2515 -37 common/cmd_doc.c Unknown Chip ID on boot device
2516 37 common/cmd_doc.c correct chip ID found, device available
2517 -38 common/cmd_doc.c Read Error on boot device
2518 38 common/cmd_doc.c reading Image header from DOC device OK
2519 -39 common/cmd_doc.c Image header has bad magic number
2520 39 common/cmd_doc.c Image header has correct magic number
2521 -40 common/cmd_doc.c Error reading Image from DOC device
2522 40 common/cmd_doc.c Image header has correct magic number
2523 41 common/cmd_ide.c before loading a Image from a IDE device
2524 -42 common/cmd_ide.c Bad usage of "ide" command
2525 42 common/cmd_ide.c correct usage of "ide" command
2526 -43 common/cmd_ide.c No boot device
2527 43 common/cmd_ide.c boot device found
2528 -44 common/cmd_ide.c Device not available
2529 44 common/cmd_ide.c Device available
2530 -45 common/cmd_ide.c wrong partition selected
2531 45 common/cmd_ide.c partition selected
2532 -46 common/cmd_ide.c Unknown partition table
2533 46 common/cmd_ide.c valid partition table found
2534 -47 common/cmd_ide.c Invalid partition type
2535 47 common/cmd_ide.c correct partition type
2536 -48 common/cmd_ide.c Error reading Image Header on boot device
2537 48 common/cmd_ide.c reading Image Header from IDE device OK
2538 -49 common/cmd_ide.c Image header has bad magic number
2539 49 common/cmd_ide.c Image header has correct magic number
2540 -50 common/cmd_ide.c Image header has bad checksum
2541 50 common/cmd_ide.c Image header has correct checksum
2542 -51 common/cmd_ide.c Error reading Image from IDE device
2543 51 common/cmd_ide.c reading Image from IDE device OK
2544 52 common/cmd_nand.c before loading a Image from a NAND device
2545 -53 common/cmd_nand.c Bad usage of "nand" command
2546 53 common/cmd_nand.c correct usage of "nand" command
2547 -54 common/cmd_nand.c No boot device
2548 54 common/cmd_nand.c boot device found
2549 -55 common/cmd_nand.c Unknown Chip ID on boot device
2550 55 common/cmd_nand.c correct chip ID found, device available
2551 -56 common/cmd_nand.c Error reading Image Header on boot device
2552 56 common/cmd_nand.c reading Image Header from NAND device OK
2553 -57 common/cmd_nand.c Image header has bad magic number
2554 57 common/cmd_nand.c Image header has correct magic number
2555 -58 common/cmd_nand.c Error reading Image from NAND device
2556 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002557
Heiko Schocher566a4942007-06-22 19:11:54 +02002558 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002559
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002560 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002561 -64 net/eth.c no Ethernet found.
2562 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002563
Heiko Schocher566a4942007-06-22 19:11:54 +02002564 -80 common/cmd_net.c usage wrong
2565 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002566 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002567 81 common/cmd_net.c NetLoop() back without error
2568 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2569 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002570 83 common/cmd_net.c running "source" command
2571 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002572 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002573
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002574FIT uImage format:
2575
2576 Arg Where When
2577 100 common/cmd_bootm.c Kernel FIT Image has correct format
2578 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2579 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2580 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2581 102 common/cmd_bootm.c Kernel unit name specified
2582 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002583 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002584 104 common/cmd_bootm.c Got kernel subimage node offset
2585 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2586 105 common/cmd_bootm.c Kernel subimage hash verification OK
2587 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2588 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002589 -106 common/cmd_bootm.c Kernel subimage has wrong type
2590 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002591 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2592 108 common/cmd_bootm.c Got kernel subimage data/size
2593 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2594 -109 common/cmd_bootm.c Can't get kernel subimage type
2595 -110 common/cmd_bootm.c Can't get kernel subimage comp
2596 -111 common/cmd_bootm.c Can't get kernel subimage os
2597 -112 common/cmd_bootm.c Can't get kernel subimage load address
2598 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2599
2600 120 common/image.c Start initial ramdisk verification
2601 -120 common/image.c Ramdisk FIT image has incorrect format
2602 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002603 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002604 -122 common/image.c Can't get configuration for ramdisk subimage
2605 123 common/image.c Ramdisk unit name specified
2606 -124 common/image.c Can't get ramdisk subimage node offset
2607 125 common/image.c Got ramdisk subimage node offset
2608 -125 common/image.c Ramdisk subimage hash verification failed
2609 126 common/image.c Ramdisk subimage hash verification OK
2610 -126 common/image.c Ramdisk subimage for unsupported architecture
2611 127 common/image.c Architecture check OK
2612 -127 common/image.c Can't get ramdisk subimage data/size
2613 128 common/image.c Got ramdisk subimage data/size
2614 129 common/image.c Can't get ramdisk load address
2615 -129 common/image.c Got ramdisk load address
2616
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002617 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002618 131 common/cmd_doc.c FIT image format OK
2619
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002620 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002621 141 common/cmd_ide.c FIT image format OK
2622
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002623 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002624 151 common/cmd_nand.c FIT image format OK
2625
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002626- FIT image support:
2627 CONFIG_FIT
2628 Enable support for the FIT uImage format.
2629
2630 CONFIG_FIT_BEST_MATCH
2631 When no configuration is explicitly selected, default to the
2632 one whose fdt's compatibility field best matches that of
2633 U-Boot itself. A match is considered "best" if it matches the
2634 most specific compatibility entry of U-Boot's fdt's root node.
2635 The order of entries in the configuration's fdt is ignored.
2636
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002637- Standalone program support:
2638 CONFIG_STANDALONE_LOAD_ADDR
2639
Wolfgang Denk6feff892011-10-09 21:06:34 +02002640 This option defines a board specific value for the
2641 address where standalone program gets loaded, thus
2642 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002643 settings.
2644
2645- Frame Buffer Address:
2646 CONFIG_FB_ADDR
2647
2648 Define CONFIG_FB_ADDR if you want to use specific
2649 address for frame buffer.
2650 Then system will reserve the frame buffer address to
2651 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002652 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002653
2654 Please see board_init_f function.
2655
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002656- Automatic software updates via TFTP server
2657 CONFIG_UPDATE_TFTP
2658 CONFIG_UPDATE_TFTP_CNT_MAX
2659 CONFIG_UPDATE_TFTP_MSEC_MAX
2660
2661 These options enable and control the auto-update feature;
2662 for a more detailed description refer to doc/README.update.
2663
2664- MTD Support (mtdparts command, UBI support)
2665 CONFIG_MTD_DEVICE
2666
2667 Adds the MTD device infrastructure from the Linux kernel.
2668 Needed for mtdparts command support.
2669
2670 CONFIG_MTD_PARTITIONS
2671
2672 Adds the MTD partitioning infrastructure from the Linux
2673 kernel. Needed for UBI support.
2674
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002675- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002676 CONFIG_SPL
2677 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002678
Tom Rini95579792012-02-14 07:29:40 +00002679 CONFIG_SPL_LDSCRIPT
2680 LDSCRIPT for linking the SPL binary.
2681
2682 CONFIG_SPL_MAX_SIZE
2683 Maximum binary size (text, data and rodata) of the SPL binary.
2684
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002685 CONFIG_SPL_TEXT_BASE
2686 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002687
Scott Wood94a45bb2012-09-20 19:05:12 -05002688 CONFIG_SPL_RELOC_TEXT_BASE
2689 Address to relocate to. If unspecified, this is equal to
2690 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2691
Tom Rini95579792012-02-14 07:29:40 +00002692 CONFIG_SPL_BSS_START_ADDR
2693 Link address for the BSS within the SPL binary.
2694
2695 CONFIG_SPL_BSS_MAX_SIZE
2696 Maximum binary size of the BSS section of the SPL binary.
2697
2698 CONFIG_SPL_STACK
2699 Adress of the start of the stack SPL will use
2700
Scott Wood94a45bb2012-09-20 19:05:12 -05002701 CONFIG_SPL_RELOC_STACK
2702 Adress of the start of the stack SPL will use after
2703 relocation. If unspecified, this is equal to
2704 CONFIG_SPL_STACK.
2705
Tom Rini95579792012-02-14 07:29:40 +00002706 CONFIG_SYS_SPL_MALLOC_START
2707 Starting address of the malloc pool used in SPL.
2708
2709 CONFIG_SYS_SPL_MALLOC_SIZE
2710 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002711
Tom Rini47f7bca2012-08-13 12:03:19 -07002712 CONFIG_SPL_FRAMEWORK
2713 Enable the SPL framework under common/. This framework
2714 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2715 NAND loading of the Linux Kernel.
2716
Tom Rini861a86f2012-08-13 11:37:56 -07002717 CONFIG_SPL_DISPLAY_PRINT
2718 For ARM, enable an optional function to print more information
2719 about the running system.
2720
Scott Wood4b919722012-09-20 16:35:21 -05002721 CONFIG_SPL_INIT_MINIMAL
2722 Arch init code should be built for a very small image
2723
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002724 CONFIG_SPL_LIBCOMMON_SUPPORT
2725 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002726
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002727 CONFIG_SPL_LIBDISK_SUPPORT
2728 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002729
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002730 CONFIG_SPL_I2C_SUPPORT
2731 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002732
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002733 CONFIG_SPL_GPIO_SUPPORT
2734 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002735
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002736 CONFIG_SPL_MMC_SUPPORT
2737 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002738
Tom Rini95579792012-02-14 07:29:40 +00002739 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2740 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2741 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2742 Address, size and partition on the MMC to load U-Boot from
2743 when the MMC is being used in raw mode.
2744
2745 CONFIG_SPL_FAT_SUPPORT
2746 Support for fs/fat/libfat.o in SPL binary
2747
2748 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2749 Filename to read to load U-Boot when reading from FAT
2750
Scott Wood6f2f01b2012-09-20 19:09:07 -05002751 CONFIG_SPL_NAND_BASE
2752 Include nand_base.c in the SPL. Requires
2753 CONFIG_SPL_NAND_DRIVERS.
2754
2755 CONFIG_SPL_NAND_DRIVERS
2756 SPL uses normal NAND drivers, not minimal drivers.
2757
2758 CONFIG_SPL_NAND_ECC
2759 Include standard software ECC in the SPL
2760
Tom Rini95579792012-02-14 07:29:40 +00002761 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002762 Support for NAND boot using simple NAND drivers that
2763 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002764
2765 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2766 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2767 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2768 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2769 CONFIG_SYS_NAND_ECCBYTES
2770 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002771 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002772
2773 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002774 Location in NAND to read U-Boot from
2775
2776 CONFIG_SYS_NAND_U_BOOT_DST
2777 Location in memory to load U-Boot to
2778
2779 CONFIG_SYS_NAND_U_BOOT_SIZE
2780 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002781
2782 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002783 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002784
2785 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2786 Define this if you need to first read the OOB and then the
2787 data. This is used for example on davinci plattforms.
2788
2789 CONFIG_SPL_OMAP3_ID_NAND
2790 Support for an OMAP3-specific set of functions to return the
2791 ID and MFR of the first attached NAND chip, if present.
2792
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002793 CONFIG_SPL_SERIAL_SUPPORT
2794 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002795
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002796 CONFIG_SPL_SPI_FLASH_SUPPORT
2797 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002798
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002799 CONFIG_SPL_SPI_SUPPORT
2800 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002801
Pavel Machekc57b9532012-08-30 22:42:11 +02002802 CONFIG_SPL_RAM_DEVICE
2803 Support for running image already present in ram, in SPL binary
2804
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002805 CONFIG_SPL_LIBGENERIC_SUPPORT
2806 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002807
Scott Woodca2fca22012-09-21 16:27:32 -05002808 CONFIG_SPL_TARGET
2809 Final target image containing SPL and payload. Some SPLs
2810 use an arch-specific makefile fragment instead, for
2811 example if more than one image needs to be produced.
2812
wdenkc6097192002-11-03 00:24:07 +00002813Modem Support:
2814--------------
2815
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002816[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002817
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002818- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002819 CONFIG_MODEM_SUPPORT
2820
2821- RTS/CTS Flow control enable:
2822 CONFIG_HWFLOW
2823
2824- Modem debug support:
2825 CONFIG_MODEM_SUPPORT_DEBUG
2826
wdenk43d96162003-03-06 00:02:04 +00002827 Enables debugging stuff (char screen[1024], dbg())
2828 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002829
wdenka8c7c702003-12-06 19:49:23 +00002830- Interrupt support (PPC):
2831
wdenkd4ca31c2004-01-02 14:00:00 +00002832 There are common interrupt_init() and timer_interrupt()
2833 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002834 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002835 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002836 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002837 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002838 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002839 specific handling. If board has watchdog / status_led
2840 / other_activity_monitor it works automatically from
2841 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002842
wdenkc6097192002-11-03 00:24:07 +00002843- General:
2844
wdenk43d96162003-03-06 00:02:04 +00002845 In the target system modem support is enabled when a
2846 specific key (key combination) is pressed during
2847 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002848 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002849 board_init(). Currently key_pressed() is a dummy
2850 function, returning 1 and thus enabling modem
2851 initialization.
wdenkc6097192002-11-03 00:24:07 +00002852
wdenk43d96162003-03-06 00:02:04 +00002853 If there are no modem init strings in the
2854 environment, U-Boot proceed to autoboot; the
2855 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002856 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002857
2858 See also: doc/README.Modem
2859
Helmut Raiger9660e442011-10-20 04:19:47 +00002860Board initialization settings:
2861------------------------------
2862
2863During Initialization u-boot calls a number of board specific functions
2864to allow the preparation of board specific prerequisites, e.g. pin setup
2865before drivers are initialized. To enable these callbacks the
2866following configuration macros have to be defined. Currently this is
2867architecture specific, so please check arch/your_architecture/lib/board.c
2868typically in board_init_f() and board_init_r().
2869
2870- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2871- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2872- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2873- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002874
wdenkc6097192002-11-03 00:24:07 +00002875Configuration Settings:
2876-----------------------
2877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002878- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002879 undefine this when you're short of memory.
2880
Peter Tyser2fb26042009-01-27 18:03:12 -06002881- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2882 width of the commands listed in the 'help' command output.
2883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002884- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002885 prompt for user input.
2886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002887- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002889- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002891- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002893- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002894 the application (usually a Linux kernel) when it is
2895 booted
2896
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002897- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002898 List of legal baudrate settings for this board.
2899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002900- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002901 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002904 If the board specific function
2905 extern int overwrite_console (void);
2906 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002907 serial port, else the settings in the environment are used.
2908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002909- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002910 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002912- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002913 Enable overwrite of previous console environment settings.
2914
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002915- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002916 Begin and End addresses of the area used by the
2917 simple memory test.
2918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002919- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002920 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002923 Scratch address used by the alternate memory test
2924 You only need to set this if address zero isn't writeable
2925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002926- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2927 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002928 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002929 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002930 fixing up gd->ram_size the Linux kernel should gets passed
2931 the now "corrected" memory size and won't touch it either.
2932 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002933 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002934 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002935 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002936
2937 This option can be used as a workaround for the 440EPx/GRx
2938 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2939 be touched.
2940
2941 WARNING: Please make sure that this value is a multiple of
2942 the Linux page size (normally 4k). If this is not the case,
2943 then the end address of the Linux memory will be located at a
2944 non page size aligned address and this could cause major
2945 problems.
2946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002947- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002948 Default load address for network file downloads
2949
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002950- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002951 Enable temporary baudrate change while serial download
2952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002953- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002954 Physical start address of SDRAM. _Must_ be 0 here.
2955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002956- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002957 Physical start address of Motherboard I/O (if using a
2958 Cogent motherboard)
2959
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002960- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002961 Physical start address of Flash memory.
2962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002963- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002964 Physical start address of boot monitor code (set by
2965 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002966 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002967 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002969- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002970 Size of memory reserved for monitor code, used to
2971 determine _at_compile_time_ (!) if the environment is
2972 embedded within the U-Boot image, or in a separate
2973 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002975- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002976 Size of DRAM reserved for malloc() use.
2977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002978- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002979 Normally compressed uImages are limited to an
2980 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002981 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002982 to adjust this setting to your needs.
2983
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002984- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002985 Maximum size of memory mapped by the startup code of
2986 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002987 the Linux kernel (bd_info, boot arguments, FDT blob if
2988 used) must be put below this limit, unless "bootm_low"
2989 enviroment variable is defined and non-zero. In such case
2990 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002991 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002992 variable "bootm_mapsize" will override the value of
2993 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2994 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002995
John Rigbyfca43cc2010-10-13 13:57:35 -06002996- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2997 Enable initrd_high functionality. If defined then the
2998 initrd_high feature is enabled and the bootm ramdisk subcommand
2999 is enabled.
3000
3001- CONFIG_SYS_BOOT_GET_CMDLINE:
3002 Enables allocating and saving kernel cmdline in space between
3003 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3004
3005- CONFIG_SYS_BOOT_GET_KBD:
3006 Enables allocating and saving a kernel copy of the bd_info in
3007 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003009- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003010 Max number of Flash memory banks
3011
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003012- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003013 Max number of sectors on a Flash chip
3014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003015- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003016 Timeout for Flash erase operations (in ms)
3017
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003018- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003019 Timeout for Flash write operations (in ms)
3020
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003021- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003022 Timeout for Flash set sector lock bit operation (in ms)
3023
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003024- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003025 Timeout for Flash clear lock bits operation (in ms)
3026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003028 If defined, hardware flash sectors protection is used
3029 instead of U-Boot software protection.
3030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003031- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003032
3033 Enable TFTP transfers directly to flash memory;
3034 without this option such a download has to be
3035 performed in two steps: (1) download to RAM, and (2)
3036 copy from RAM to flash.
3037
3038 The two-step approach is usually more reliable, since
3039 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003040 the flash, but in some situations (when system RAM is
3041 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003042 downloaded image) this option may be very useful.
3043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003044- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003045 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003046 common flash structure for storing flash geometry.
3047
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003048- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003049 This option also enables the building of the cfi_flash driver
3050 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003051
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003052- CONFIG_FLASH_CFI_MTD
3053 This option enables the building of the cfi_mtd driver
3054 in the drivers directory. The driver exports CFI flash
3055 to the MTD layer.
3056
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003057- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003058 Use buffered writes to flash.
3059
3060- CONFIG_FLASH_SPANSION_S29WS_N
3061 s29ws-n MirrorBit flash has non-standard addresses for buffered
3062 write commands.
3063
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003064- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003065 If this option is defined, the common CFI flash doesn't
3066 print it's warning upon not recognized FLASH banks. This
3067 is useful, if some of the configured banks are only
3068 optionally available.
3069
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003070- CONFIG_FLASH_SHOW_PROGRESS
3071 If defined (must be an integer), print out countdown
3072 digits and dots. Recommended value: 45 (9..1) for 80
3073 column displays, 15 (3..1) for 40 column displays.
3074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003075- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003076 Defines the number of Ethernet receive buffers. On some
3077 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003078 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3079 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003080 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003081 Defaults to 4 if not defined.
3082
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003083- CONFIG_ENV_MAX_ENTRIES
3084
Wolfgang Denk071bc922010-10-27 22:48:30 +02003085 Maximum number of entries in the hash table that is used
3086 internally to store the environment settings. The default
3087 setting is supposed to be generous and should work in most
3088 cases. This setting can be used to tune behaviour; see
3089 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003090
wdenkc6097192002-11-03 00:24:07 +00003091The following definitions that deal with the placement and management
3092of environment data (variable area); in general, we support the
3093following configurations:
3094
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003095- CONFIG_BUILD_ENVCRC:
3096
3097 Builds up envcrc with the target environment so that external utils
3098 may easily extract it and embed it in final U-Boot images.
3099
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003100- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003101
3102 Define this if the environment is in flash memory.
3103
3104 a) The environment occupies one whole flash sector, which is
3105 "embedded" in the text segment with the U-Boot code. This
3106 happens usually with "bottom boot sector" or "top boot
3107 sector" type flash chips, which have several smaller
3108 sectors at the start or the end. For instance, such a
3109 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3110 such a case you would place the environment in one of the
3111 4 kB sectors - with U-Boot code before and after it. With
3112 "top boot sector" type flash chips, you would put the
3113 environment in one of the last sectors, leaving a gap
3114 between U-Boot and the environment.
3115
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003116 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003117
3118 Offset of environment data (variable area) to the
3119 beginning of flash memory; for instance, with bottom boot
3120 type flash chips the second sector can be used: the offset
3121 for this sector is given here.
3122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003123 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003124
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003125 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003126
3127 This is just another way to specify the start address of
3128 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003129 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003130
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003131 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003132
3133 Size of the sector containing the environment.
3134
3135
3136 b) Sometimes flash chips have few, equal sized, BIG sectors.
3137 In such a case you don't want to spend a whole sector for
3138 the environment.
3139
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003140 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003141
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003142 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003143 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003144 of this flash sector for the environment. This saves
3145 memory for the RAM copy of the environment.
3146
3147 It may also save flash memory if you decide to use this
3148 when your environment is "embedded" within U-Boot code,
3149 since then the remainder of the flash sector could be used
3150 for U-Boot code. It should be pointed out that this is
3151 STRONGLY DISCOURAGED from a robustness point of view:
3152 updating the environment in flash makes it always
3153 necessary to erase the WHOLE sector. If something goes
3154 wrong before the contents has been restored from a copy in
3155 RAM, your target system will be dead.
3156
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003157 - CONFIG_ENV_ADDR_REDUND
3158 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003159
wdenk43d96162003-03-06 00:02:04 +00003160 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003161 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003162 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003163 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003164
3165BE CAREFUL! Any changes to the flash layout, and some changes to the
3166source code will make it necessary to adapt <board>/u-boot.lds*
3167accordingly!
3168
3169
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003170- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003171
3172 Define this if you have some non-volatile memory device
3173 (NVRAM, battery buffered SRAM) which you want to use for the
3174 environment.
3175
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003176 - CONFIG_ENV_ADDR:
3177 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003178
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003179 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003180 want to use for environment. It is assumed that this memory
3181 can just be read and written to, without any special
3182 provision.
3183
3184BE CAREFUL! The first access to the environment happens quite early
3185in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003186console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003187U-Boot will hang.
3188
3189Please note that even with NVRAM we still use a copy of the
3190environment in RAM: we could work on NVRAM directly, but we want to
3191keep settings there always unmodified except somebody uses "saveenv"
3192to save the current settings.
3193
3194
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003195- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003196
3197 Use this if you have an EEPROM or similar serial access
3198 device and a driver for it.
3199
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003200 - CONFIG_ENV_OFFSET:
3201 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003202
3203 These two #defines specify the offset and size of the
3204 environment area within the total memory of your EEPROM.
3205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003206 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003207 If defined, specified the chip address of the EEPROM device.
3208 The default address is zero.
3209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003210 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003211 If defined, the number of bits used to address bytes in a
3212 single page in the EEPROM device. A 64 byte page, for example
3213 would require six bits.
3214
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003215 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003216 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003217 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003218
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003219 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003220 The length in bytes of the EEPROM memory array address. Note
3221 that this is NOT the chip address length!
3222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003223 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003224 EEPROM chips that implement "address overflow" are ones
3225 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3226 address and the extra bits end up in the "chip address" bit
3227 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3228 byte chips.
3229
3230 Note that we consider the length of the address field to
3231 still be one byte because the extra address bits are hidden
3232 in the chip address.
3233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003234 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003235 The size in bytes of the EEPROM device.
3236
Heiko Schocher548738b2010-01-07 08:55:40 +01003237 - CONFIG_ENV_EEPROM_IS_ON_I2C
3238 define this, if you have I2C and SPI activated, and your
3239 EEPROM, which holds the environment, is on the I2C bus.
3240
3241 - CONFIG_I2C_ENV_EEPROM_BUS
3242 if you have an Environment on an EEPROM reached over
3243 I2C muxes, you can define here, how to reach this
3244 EEPROM. For example:
3245
Wolfgang Denka9046b92010-06-13 17:48:15 +02003246 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003247
3248 EEPROM which holds the environment, is reached over
3249 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003250
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003251- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003252
wdenkd4ca31c2004-01-02 14:00:00 +00003253 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003254 want to use for the environment.
3255
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003256 - CONFIG_ENV_OFFSET:
3257 - CONFIG_ENV_ADDR:
3258 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003259
3260 These three #defines specify the offset and size of the
3261 environment area within the total memory of your DataFlash placed
3262 at the specified address.
3263
Liu Gang0a85a9e2012-03-08 00:33:20 +00003264- CONFIG_ENV_IS_IN_REMOTE:
3265
3266 Define this if you have a remote memory space which you
3267 want to use for the local device's environment.
3268
3269 - CONFIG_ENV_ADDR:
3270 - CONFIG_ENV_SIZE:
3271
3272 These two #defines specify the address and size of the
3273 environment area within the remote memory space. The
3274 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003275 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003276
3277BE CAREFUL! For some special cases, the local device can not use
3278"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003279environment stored in a remote NOR flash by SRIO or PCIE link,
3280but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003281
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003282- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003283
3284 Define this if you have a NAND device which you want to use
3285 for the environment.
3286
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003287 - CONFIG_ENV_OFFSET:
3288 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003289
3290 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003291 area within the first NAND device. CONFIG_ENV_OFFSET must be
3292 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003293
Scott Woodfdd813d2010-09-17 14:38:37 -05003294 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003295
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003296 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003297 size used to hold a redundant copy of the environment data, so
3298 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003299 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003300 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003301
Scott Woodfdd813d2010-09-17 14:38:37 -05003302 - CONFIG_ENV_RANGE (optional):
3303
3304 Specifies the length of the region in which the environment
3305 can be written. This should be a multiple of the NAND device's
3306 block size. Specifying a range with more erase blocks than
3307 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3308 the range to be avoided.
3309
3310 - CONFIG_ENV_OFFSET_OOB (optional):
3311
3312 Enables support for dynamically retrieving the offset of the
3313 environment from block zero's out-of-band data. The
3314 "nand env.oob" command can be used to record this offset.
3315 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3316 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003317
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003318- CONFIG_NAND_ENV_DST
3319
3320 Defines address in RAM to which the nand_spl code should copy the
3321 environment. If redundant environment is used, it will be copied to
3322 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003324- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003325
3326 Defines offset to the initial SPI buffer area in DPRAM. The
3327 area is used at an early stage (ROM part) if the environment
3328 is configured to reside in the SPI EEPROM: We need a 520 byte
3329 scratch DPRAM area. It is used between the two initialization
3330 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3331 to be a good choice since it makes it far enough from the
3332 start of the data area as well as from the stack pointer.
3333
Bruce Adlere881cb52007-11-02 13:15:42 -07003334Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003335has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003336created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003337until then to read environment variables.
3338
wdenk85ec0bc2003-03-31 16:34:49 +00003339The environment is protected by a CRC32 checksum. Before the monitor
3340is relocated into RAM, as a result of a bad CRC you will be working
3341with the compiled-in default environment - *silently*!!! [This is
3342necessary, because the first environment variable we need is the
3343"baudrate" setting for the console - if we have a bad CRC, we don't
3344have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003345
3346Note: once the monitor has been relocated, then it will complain if
3347the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003348use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003349
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003350- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003351 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003353 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003354 also needs to be defined.
3355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003356- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003357 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003358
Ron Madridf5675aa2009-02-18 14:30:44 -08003359- CONFIG_NS16550_MIN_FUNCTIONS:
3360 Define this if you desire to only have use of the NS16550_init
3361 and NS16550_putc functions for the serial driver located at
3362 drivers/serial/ns16550.c. This option is useful for saving
3363 space for already greatly restricted images, including but not
3364 limited to NAND_SPL configurations.
3365
wdenkc6097192002-11-03 00:24:07 +00003366Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003367---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003369- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003370 Cache Line Size of the CPU.
3371
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003372- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003373 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003374
wdenk42d1f032003-10-15 23:53:47 +00003375 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3376 and RPXsuper) to be able to adjust the position of
3377 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003378
Timur Tabie46fedf2011-08-04 18:03:41 -05003379- CONFIG_SYS_CCSRBAR_DEFAULT:
3380 Default (power-on reset) physical address of CCSR on Freescale
3381 PowerPC SOCs.
3382
3383- CONFIG_SYS_CCSRBAR:
3384 Virtual address of CCSR. On a 32-bit build, this is typically
3385 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3386
3387 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3388 for cross-platform code that uses that macro instead.
3389
3390- CONFIG_SYS_CCSRBAR_PHYS:
3391 Physical address of CCSR. CCSR can be relocated to a new
3392 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003393 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003394 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3395 is typically relocated on 36-bit builds. It is recommended
3396 that this macro be defined via the _HIGH and _LOW macros:
3397
3398 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3399 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3400
3401- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003402 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3403 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003404 used in assembly code, so it must not contain typecasts or
3405 integer size suffixes (e.g. "ULL").
3406
3407- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3408 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3409 used in assembly code, so it must not contain typecasts or
3410 integer size suffixes (e.g. "ULL").
3411
3412- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3413 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3414 forced to a value that ensures that CCSR is not relocated.
3415
wdenk7f6c2cb2002-11-10 22:06:23 +00003416- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003417 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003418
3419 the default drive number (default value 0)
3420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003421 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003422
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003423 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003424 (default value 1)
3425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003426 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003427
wdenk43d96162003-03-06 00:02:04 +00003428 defines the offset of register from address. It
3429 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003430 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003432 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3433 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003434 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003436 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003437 fdc_hw_init() is called at the beginning of the FDC
3438 setup. fdc_hw_init() must be provided by the board
3439 source code. It is used to make hardware dependant
3440 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003441
Macpaul Lin0abddf82011-04-11 20:45:32 +00003442- CONFIG_IDE_AHB:
3443 Most IDE controllers were designed to be connected with PCI
3444 interface. Only few of them were designed for AHB interface.
3445 When software is doing ATA command and data transfer to
3446 IDE devices through IDE-AHB controller, some additional
3447 registers accessing to these kind of IDE-AHB controller
3448 is requierd.
3449
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003450- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003451 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003452 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003454- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk7152b1d2003-09-05 23:19:14 +00003456 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003457 initial data and stack; please note that this must be
3458 writable memory that is working WITHOUT special
3459 initialization, i. e. you CANNOT use normal RAM which
3460 will become available only after programming the
3461 memory controller and running certain initialization
3462 sequences.
3463
3464 U-Boot uses the following memory types:
3465 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3466 - MPC824X: data cache
3467 - PPC4xx: data cache
3468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003469- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003470
3471 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003472 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3473 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003474 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003475 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003476 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3477 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3478 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003479
3480 Note:
3481 On the MPC824X (or other systems that use the data
3482 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003483 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003484 point to an otherwise UNUSED address space between
3485 the top of RAM and the start of the PCI space.
3486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003487- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003488
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003489- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003491- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003493- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003494
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003495- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003497- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003499- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003500 SDRAM timing
3501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003502- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003503 periodic timer for refresh
3504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003505- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003506
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003507- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3508 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3509 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3510 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003511 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3512
3513- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003514 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3515 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003516 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003518- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3519 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003520 Machine Mode Register and Memory Periodic Timer
3521 Prescaler definitions (SDRAM timing)
3522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003523- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003524 enable I2C microcode relocation patch (MPC8xx);
3525 define relocation offset in DPRAM [DSP2]
3526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003527- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003528 enable SMC microcode relocation patch (MPC8xx);
3529 define relocation offset in DPRAM [SMC1]
3530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003531- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003532 enable SPI microcode relocation patch (MPC8xx);
3533 define relocation offset in DPRAM [SCC4]
3534
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003535- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003536 Use OSCM clock mode on MBX8xx board. Be careful,
3537 wrong setting might damage your board. Read
3538 doc/README.MBX before setting this variable!
3539
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003540- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003541 Offset of the bootmode word in DPRAM used by post
3542 (Power On Self Tests). This definition overrides
3543 #define'd default value in commproc.h resp.
3544 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003545
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003546- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3547 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3548 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3549 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3550 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3551 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3552 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3553 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003554 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003555
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003556- CONFIG_PCI_DISABLE_PCIE:
3557 Disable PCI-Express on systems where it is supported but not
3558 required.
3559
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003560- CONFIG_PCI_ENUM_ONLY
3561 Only scan through and get the devices on the busses.
3562 Don't do any setup work, presumably because someone or
3563 something has already done it, and we don't need to do it
3564 a second time. Useful for platforms that are pre-booted
3565 by coreboot or similar.
3566
Kumar Galaa09b9b62010-12-30 12:09:53 -06003567- CONFIG_SYS_SRIO:
3568 Chip has SRIO or not
3569
3570- CONFIG_SRIO1:
3571 Board has SRIO 1 port available
3572
3573- CONFIG_SRIO2:
3574 Board has SRIO 2 port available
3575
3576- CONFIG_SYS_SRIOn_MEM_VIRT:
3577 Virtual Address of SRIO port 'n' memory region
3578
3579- CONFIG_SYS_SRIOn_MEM_PHYS:
3580 Physical Address of SRIO port 'n' memory region
3581
3582- CONFIG_SYS_SRIOn_MEM_SIZE:
3583 Size of SRIO port 'n' memory region
3584
Alex Watermaneced4622011-05-19 15:08:36 -04003585- CONFIG_SYS_NDFC_16
3586 Defined to tell the NDFC that the NAND chip is using a
3587 16 bit bus.
3588
3589- CONFIG_SYS_NDFC_EBC0_CFG
3590 Sets the EBC0_CFG register for the NDFC. If not defined
3591 a default value will be used.
3592
Ben Warrenbb99ad62006-09-07 16:50:54 -04003593- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003594 Get DDR timing information from an I2C EEPROM. Common
3595 with pluggable memory modules such as SODIMMs
3596
Ben Warrenbb99ad62006-09-07 16:50:54 -04003597 SPD_EEPROM_ADDRESS
3598 I2C address of the SPD EEPROM
3599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003600- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003601 If SPD EEPROM is on an I2C bus other than the first
3602 one, specify here. Note that the value must resolve
3603 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003604
York Sun1b3e3c42011-06-07 09:42:16 +08003605- CONFIG_SYS_DDR_RAW_TIMING
3606 Get DDR timing information from other than SPD. Common with
3607 soldered DDR chips onboard without SPD. DDR raw timing
3608 parameters are extracted from datasheet and hard-coded into
3609 header files or board specific files.
3610
York Sun6f5e1dc2011-09-16 13:21:35 -07003611- CONFIG_FSL_DDR_INTERACTIVE
3612 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003614- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003615 Only for 83xx systems. If specified, then DDR should
3616 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003617
wdenkc26e4542004-04-18 10:13:26 +00003618- CONFIG_ETHER_ON_FEC[12]
3619 Define to enable FEC[12] on a 8xx series processor.
3620
3621- CONFIG_FEC[12]_PHY
3622 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003623 to the given FEC; i. e.
3624 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003625 means that the PHY with address 4 is connected to FEC1
3626
3627 When set to -1, means to probe for first available.
3628
3629- CONFIG_FEC[12]_PHY_NORXERR
3630 The PHY does not have a RXERR line (RMII only).
3631 (so program the FEC to ignore it).
3632
3633- CONFIG_RMII
3634 Enable RMII mode for all FECs.
3635 Note that this is a global option, we can't
3636 have one FEC in standard MII mode and another in RMII mode.
3637
wdenk5cf91d62004-04-23 20:32:05 +00003638- CONFIG_CRC32_VERIFY
3639 Add a verify option to the crc32 command.
3640 The syntax is:
3641
3642 => crc32 -v <address> <count> <crc32>
3643
3644 Where address/count indicate a memory area
3645 and crc32 is the correct crc32 which the
3646 area should have.
3647
wdenk56523f12004-07-11 17:40:54 +00003648- CONFIG_LOOPW
3649 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003650 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003651
stroese7b466642004-12-16 18:46:55 +00003652- CONFIG_MX_CYCLIC
3653 Add the "mdc" and "mwc" memory commands. These are cyclic
3654 "md/mw" commands.
3655 Examples:
3656
wdenkefe2a4d2004-12-16 21:44:03 +00003657 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003658 This command will print 4 bytes (10,11,12,13) each 500 ms.
3659
wdenkefe2a4d2004-12-16 21:44:03 +00003660 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003661 This command will write 12345678 to address 100 all 10 ms.
3662
wdenkefe2a4d2004-12-16 21:44:03 +00003663 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003664 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003665
wdenk8aa1a2d2005-04-04 12:44:11 +00003666- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003667 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003668 low level initializations (like setting up the memory
3669 controller) are omitted and/or U-Boot does not
3670 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003671
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003672 Normally this variable MUST NOT be defined. The only
3673 exception is when U-Boot is loaded (to RAM) by some
3674 other boot loader or by a debugger which performs
3675 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003676
Aneesh V401bb302011-07-13 05:11:07 +00003677- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003678 Modifies the behaviour of start.S when compiling a loader
3679 that is executed before the actual U-Boot. E.g. when
3680 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003681
Matthias Weisserd8834a12011-03-10 21:36:32 +00003682- CONFIG_USE_ARCH_MEMCPY
3683 CONFIG_USE_ARCH_MEMSET
3684 If these options are used a optimized version of memcpy/memset will
3685 be used if available. These functions may be faster under some
3686 conditions but may increase the binary size.
3687
Gabe Blackb16f5212012-11-27 21:08:06 +00003688- CONFIG_X86_NO_RESET_VECTOR
3689 If defined, the x86 reset vector code is excluded. You will need
3690 to do this when U-Boot is running from Coreboot.
3691
Gabe Black5b5ece92012-11-29 16:23:41 +00003692- CONFIG_X86_NO_REAL_MODE
3693 If defined, x86 real mode code is omitted. This assumes a
3694 32-bit environment where such code is not needed. You will
3695 need to do this when U-Boot is running from Coreboot.
3696
3697
Timur Tabif2717b42011-11-22 09:21:25 -06003698Freescale QE/FMAN Firmware Support:
3699-----------------------------------
3700
3701The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3702loading of "firmware", which is encoded in the QE firmware binary format.
3703This firmware often needs to be loaded during U-Boot booting, so macros
3704are used to identify the storage device (NOR flash, SPI, etc) and the address
3705within that device.
3706
3707- CONFIG_SYS_QE_FMAN_FW_ADDR
3708 The address in the storage device where the firmware is located. The
3709 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3710 is also specified.
3711
3712- CONFIG_SYS_QE_FMAN_FW_LENGTH
3713 The maximum possible size of the firmware. The firmware binary format
3714 has a field that specifies the actual size of the firmware, but it
3715 might not be possible to read any part of the firmware unless some
3716 local storage is allocated to hold the entire firmware first.
3717
3718- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3719 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3720 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3721 virtual address in NOR flash.
3722
3723- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3724 Specifies that QE/FMAN firmware is located in NAND flash.
3725 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3726
3727- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3728 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3729 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3730
3731- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3732 Specifies that QE/FMAN firmware is located on the primary SPI
3733 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3734
Liu Gang292dc6c2012-03-08 00:33:18 +00003735- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3736 Specifies that QE/FMAN firmware is located in the remote (master)
3737 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003738 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3739 window->master inbound window->master LAW->the ucode address in
3740 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003741
wdenkc6097192002-11-03 00:24:07 +00003742Building the Software:
3743======================
3744
Wolfgang Denk218ca722008-03-26 10:40:12 +01003745Building U-Boot has been tested in several native build environments
3746and in many different cross environments. Of course we cannot support
3747all possibly existing versions of cross development tools in all
3748(potentially obsolete) versions. In case of tool chain problems we
3749recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3750which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003751
Wolfgang Denk218ca722008-03-26 10:40:12 +01003752If you are not using a native environment, it is assumed that you
3753have GNU cross compiling tools available in your path. In this case,
3754you must set the environment variable CROSS_COMPILE in your shell.
3755Note that no changes to the Makefile or any other source files are
3756necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003757
Wolfgang Denk218ca722008-03-26 10:40:12 +01003758 $ CROSS_COMPILE=ppc_4xx-
3759 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003760
Peter Tyser2f8d3962009-03-13 18:54:51 -05003761Note: If you wish to generate Windows versions of the utilities in
3762 the tools directory you can use the MinGW toolchain
3763 (http://www.mingw.org). Set your HOST tools to the MinGW
3764 toolchain and execute 'make tools'. For example:
3765
3766 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3767
3768 Binaries such as tools/mkimage.exe will be created which can
3769 be executed on computers running Windows.
3770
Wolfgang Denk218ca722008-03-26 10:40:12 +01003771U-Boot is intended to be simple to build. After installing the
3772sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003773is done by typing:
3774
3775 make NAME_config
3776
Wolfgang Denk218ca722008-03-26 10:40:12 +01003777where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003778rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003779
wdenk2729af92004-05-03 20:45:30 +00003780Note: for some board special configuration names may exist; check if
3781 additional information is available from the board vendor; for
3782 instance, the TQM823L systems are available without (standard)
3783 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003784 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003785
wdenk2729af92004-05-03 20:45:30 +00003786 make TQM823L_config
3787 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003788
wdenk2729af92004-05-03 20:45:30 +00003789 make TQM823L_LCD_config
3790 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk2729af92004-05-03 20:45:30 +00003792 etc.
wdenkc6097192002-11-03 00:24:07 +00003793
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795Finally, type "make all", and you should get some working U-Boot
3796images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk2729af92004-05-03 20:45:30 +00003798- "u-boot.bin" is a raw binary image
3799- "u-boot" is an image in ELF binary format
3800- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003801
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003802By default the build is performed locally and the objects are saved
3803in the source directory. One of the two methods can be used to change
3804this behavior and build U-Boot to some external directory:
3805
38061. Add O= to the make command line invocations:
3807
3808 make O=/tmp/build distclean
3809 make O=/tmp/build NAME_config
3810 make O=/tmp/build all
3811
38122. Set environment variable BUILD_DIR to point to the desired location:
3813
3814 export BUILD_DIR=/tmp/build
3815 make distclean
3816 make NAME_config
3817 make all
3818
3819Note that the command line "O=" setting overrides the BUILD_DIR environment
3820variable.
3821
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823Please be aware that the Makefiles assume you are using GNU make, so
3824for instance on NetBSD you might need to use "gmake" instead of
3825native "make".
wdenkc6097192002-11-03 00:24:07 +00003826
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828If the system board that you have is not listed, then you will need
3829to port U-Boot to your hardware platform. To do this, follow these
3830steps:
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk2729af92004-05-03 20:45:30 +000038321. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003833 "boards.cfg" file, using the existing entries as examples.
3834 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000038352. Create a new directory to hold your board specific code. Add any
3836 files you need. In your board directory, you will need at least
3837 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
38383. Create a new configuration file "include/configs/<board>.h" for
3839 your board
38403. If you're porting U-Boot to a new CPU, then also create a new
3841 directory to hold your CPU specific code. Add any files you need.
38424. Run "make <board>_config" with your new name.
38435. Type "make", and you should get a working "u-boot.srec" file
3844 to be installed on your target system.
38456. Debug and solve any problems that might arise.
3846 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003847
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk2729af92004-05-03 20:45:30 +00003849Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3850==============================================================
wdenkc6097192002-11-03 00:24:07 +00003851
Wolfgang Denk218ca722008-03-26 10:40:12 +01003852If you have modified U-Boot sources (for instance added a new board
3853or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003854provide feedback to the other developers. The feedback normally takes
3855the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003856official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003857
Wolfgang Denk218ca722008-03-26 10:40:12 +01003858But before you submit such a patch, please verify that your modifi-
3859cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003860the supported boards compile WITHOUT ANY compiler warnings. To do so,
3861just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003862for ALL supported system. Be warned, this will take a while. You can
3863select which (cross) compiler to use by passing a `CROSS_COMPILE'
3864environment variable to the script, i. e. to use the ELDK cross tools
3865you can type
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk2729af92004-05-03 20:45:30 +00003867 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk2729af92004-05-03 20:45:30 +00003869or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003872
Wolfgang Denk218ca722008-03-26 10:40:12 +01003873When using the MAKEALL script, the default behaviour is to build
3874U-Boot in the source directory. This location can be changed by
3875setting the BUILD_DIR environment variable. Also, for each target
3876built, the MAKEALL script saves two log files (<target>.ERR and
3877<target>.MAKEALL) in the <source dir>/LOG directory. This default
3878location can be changed by setting the MAKEALL_LOGDIR environment
3879variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003880
3881 export BUILD_DIR=/tmp/build
3882 export MAKEALL_LOGDIR=/tmp/log
3883 CROSS_COMPILE=ppc_8xx- MAKEALL
3884
Wolfgang Denk218ca722008-03-26 10:40:12 +01003885With the above settings build objects are saved in the /tmp/build,
3886log files are saved in the /tmp/log and the source tree remains clean
3887during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003888
3889
wdenk2729af92004-05-03 20:45:30 +00003890See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003891
wdenkc6097192002-11-03 00:24:07 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893Monitor Commands - Overview:
3894============================
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896go - start application at address 'addr'
3897run - run commands in an environment variable
3898bootm - boot application image from memory
3899bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003900bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003901tftpboot- boot image via network using TFTP protocol
3902 and env variables "ipaddr" and "serverip"
3903 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003904tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003905rarpboot- boot image via network using RARP/TFTP protocol
3906diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3907loads - load S-Record file over serial line
3908loadb - load binary file over serial line (kermit mode)
3909md - memory display
3910mm - memory modify (auto-incrementing)
3911nm - memory modify (constant address)
3912mw - memory write (fill)
3913cp - memory copy
3914cmp - memory compare
3915crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003916i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003917sspi - SPI utility commands
3918base - print or set address offset
3919printenv- print environment variables
3920setenv - set environment variables
3921saveenv - save environment variables to persistent storage
3922protect - enable or disable FLASH write protection
3923erase - erase FLASH memory
3924flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003925nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003926bdinfo - print Board Info structure
3927iminfo - print header information for application image
3928coninfo - print console devices and informations
3929ide - IDE sub-system
3930loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003931loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003932mtest - simple RAM test
3933icache - enable or disable instruction cache
3934dcache - enable or disable data cache
3935reset - Perform RESET of the CPU
3936echo - echo args to console
3937version - print monitor version
3938help - print online help
3939? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003940
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk2729af92004-05-03 20:45:30 +00003942Monitor Commands - Detailed Description:
3943========================================
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945TODO.
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003948
3949
wdenk2729af92004-05-03 20:45:30 +00003950Environment Variables:
3951======================
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953U-Boot supports user configuration using Environment Variables which
3954can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk2729af92004-05-03 20:45:30 +00003956Environment Variables are set using "setenv", printed using
3957"printenv", and saved to Flash using "saveenv". Using "setenv"
3958without a value can be used to delete a variable from the
3959environment. As long as you don't save the environment you are
3960working with an in-memory copy. In case the Flash area containing the
3961environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003962
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003963Some configuration options can be set using Environment Variables.
3964
3965List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk2729af92004-05-03 20:45:30 +00003969 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk2729af92004-05-03 20:45:30 +00003971 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003974
wdenk2729af92004-05-03 20:45:30 +00003975 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003976
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003977 bootm_low - Memory range available for image processing in the bootm
3978 command can be restricted. This variable is given as
3979 a hexadecimal number and defines lowest address allowed
3980 for use by the bootm command. See also "bootm_size"
3981 environment variable. Address defined by "bootm_low" is
3982 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003983 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3984 bootm_mapsize.
3985
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003986 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003987 This variable is given as a hexadecimal number and it
3988 defines the size of the memory region starting at base
3989 address bootm_low that is accessible by the Linux kernel
3990 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3991 as the default value if it is defined, and bootm_size is
3992 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003993
3994 bootm_size - Memory range available for image processing in the bootm
3995 command can be restricted. This variable is given as
3996 a hexadecimal number and defines the size of the region
3997 allowed for use by the bootm command. See also "bootm_low"
3998 environment variable.
3999
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004000 updatefile - Location of the software update file on a TFTP server, used
4001 by the automatic software update feature. Please refer to
4002 documentation in doc/README.update for more details.
4003
wdenk2729af92004-05-03 20:45:30 +00004004 autoload - if set to "no" (any string beginning with 'n'),
4005 "bootp" will just load perform a lookup of the
4006 configuration from the BOOTP server, but not try to
4007 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004008
wdenk2729af92004-05-03 20:45:30 +00004009 autostart - if set to "yes", an image loaded using the "bootp",
4010 "rarpboot", "tftpboot" or "diskboot" commands will
4011 be automatically started (by internally calling
4012 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004013
wdenk2729af92004-05-03 20:45:30 +00004014 If set to "no", a standalone image passed to the
4015 "bootm" command will be copied to the load address
4016 (and eventually uncompressed), but NOT be started.
4017 This can be used to load and uncompress arbitrary
4018 data.
wdenkc6097192002-11-03 00:24:07 +00004019
David A. Longa28afca2011-07-09 16:40:19 -04004020 fdt_high - if set this restricts the maximum address that the
4021 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004022 For example, if you have a system with 1 GB memory
4023 at physical address 0x10000000, while Linux kernel
4024 only recognizes the first 704 MB as low memory, you
4025 may need to set fdt_high as 0x3C000000 to have the
4026 device tree blob be copied to the maximum address
4027 of the 704 MB low memory, so that Linux kernel can
4028 access it during the boot procedure.
4029
David A. Longa28afca2011-07-09 16:40:19 -04004030 If this is set to the special value 0xFFFFFFFF then
4031 the fdt will not be copied at all on boot. For this
4032 to work it must reside in writable memory, have
4033 sufficient padding on the end of it for u-boot to
4034 add the information it needs into it, and the memory
4035 must be accessible by the kernel.
4036
Simon Glasseea63e02011-10-24 19:15:34 +00004037 fdtcontroladdr- if set this is the address of the control flattened
4038 device tree used by U-Boot when CONFIG_OF_CONTROL is
4039 defined.
4040
wdenk17ea1172004-06-06 21:51:03 +00004041 i2cfast - (PPC405GP|PPC405EP only)
4042 if set to 'y' configures Linux I2C driver for fast
4043 mode (400kHZ). This environment variable is used in
4044 initialization code. So, for changes to be effective
4045 it must be saved and board must be reset.
4046
wdenk2729af92004-05-03 20:45:30 +00004047 initrd_high - restrict positioning of initrd images:
4048 If this variable is not set, initrd images will be
4049 copied to the highest possible address in RAM; this
4050 is usually what you want since it allows for
4051 maximum initrd size. If for some reason you want to
4052 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004053 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004054 variable to a value of "no" or "off" or "0".
4055 Alternatively, you can set it to a maximum upper
4056 address to use (U-Boot will still check that it
4057 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004058
wdenk2729af92004-05-03 20:45:30 +00004059 For instance, when you have a system with 16 MB
4060 RAM, and want to reserve 4 MB from use by Linux,
4061 you can do this by adding "mem=12M" to the value of
4062 the "bootargs" variable. However, now you must make
4063 sure that the initrd image is placed in the first
4064 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004065
wdenk2729af92004-05-03 20:45:30 +00004066 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068 If you set initrd_high to 0xFFFFFFFF, this is an
4069 indication to U-Boot that all addresses are legal
4070 for the Linux kernel, including addresses in flash
4071 memory. In this case U-Boot will NOT COPY the
4072 ramdisk at all. This may be useful to reduce the
4073 boot time on your system, but requires that this
4074 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004077
wdenk2729af92004-05-03 20:45:30 +00004078 loadaddr - Default load address for commands like "bootp",
4079 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004082
wdenk2729af92004-05-03 20:45:30 +00004083 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004090
Mike Frysingere2a53452011-10-02 10:01:27 +00004091 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004092
Mike Frysingere2a53452011-10-02 10:01:27 +00004093 ethact - controls which interface is currently active.
4094 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004095
Heiko Schocher48690d82010-07-20 17:45:02 +02004096 => setenv ethact FEC
4097 => ping 192.168.0.1 # traffic sent on FEC
4098 => setenv ethact SCC
4099 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004100
Matthias Fuchse1692572008-01-17 07:45:05 +01004101 ethrotate - When set to "no" U-Boot does not go through all
4102 available network interfaces.
4103 It just stays at the currently selected interface.
4104
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004105 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004106 either succeed or fail without retrying.
4107 When set to "once" the network operation will
4108 fail when all the available network interfaces
4109 are tried once without success.
4110 Useful on scripts which control the retry operation
4111 themselves.
wdenkc6097192002-11-03 00:24:07 +00004112
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004113 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004114
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004115 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004116 UDP source port.
4117
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004118 tftpdstport - If this is set, the value is used for TFTP's UDP
4119 destination port instead of the Well Know Port 69.
4120
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004121 tftpblocksize - Block size to use for TFTP transfers; if not set,
4122 we use the TFTP server's default block size
4123
4124 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4125 seconds, minimum value is 1000 = 1 second). Defines
4126 when a packet is considered to be lost so it has to
4127 be retransmitted. The default is 5000 = 5 seconds.
4128 Lowering this value may make downloads succeed
4129 faster in networks with high packet loss rates or
4130 with unreliable TFTP servers.
4131
4132 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004133 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004134 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004135
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004136The following image location variables contain the location of images
4137used in booting. The "Image" column gives the role of the image and is
4138not an environment variable name. The other columns are environment
4139variable names. "File Name" gives the name of the file on a TFTP
4140server, "RAM Address" gives the location in RAM the image will be
4141loaded to, and "Flash Location" gives the image's address in NOR
4142flash or offset in NAND flash.
4143
4144*Note* - these variables don't have to be defined for all boards, some
4145boards currenlty use other variables for these purposes, and some
4146boards use these variables for other purposes.
4147
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004148Image File Name RAM Address Flash Location
4149----- --------- ----------- --------------
4150u-boot u-boot u-boot_addr_r u-boot_addr
4151Linux kernel bootfile kernel_addr_r kernel_addr
4152device tree blob fdtfile fdt_addr_r fdt_addr
4153ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004154
wdenk2729af92004-05-03 20:45:30 +00004155The following environment variables may be used and automatically
4156updated by the network boot commands ("bootp" and "rarpboot"),
4157depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004158
wdenk2729af92004-05-03 20:45:30 +00004159 bootfile - see above
4160 dnsip - IP address of your Domain Name Server
4161 dnsip2 - IP address of your secondary Domain Name Server
4162 gatewayip - IP address of the Gateway (Router) to use
4163 hostname - Target hostname
4164 ipaddr - see above
4165 netmask - Subnet Mask
4166 rootpath - Pathname of the root filesystem on the NFS server
4167 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004168
wdenka3d991b2004-04-15 21:48:45 +00004169
wdenk2729af92004-05-03 20:45:30 +00004170There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172 serial# - contains hardware identification information such
4173 as type string and/or serial number
4174 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176These variables can be set only once (usually during manufacturing of
4177the board). U-Boot refuses to delete or overwrite these variables
4178once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004179
4180
wdenk2729af92004-05-03 20:45:30 +00004181Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk2729af92004-05-03 20:45:30 +00004183 ver - Contains the U-Boot version string as printed
4184 with the "version" command. This variable is
4185 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004186
wdenkc6097192002-11-03 00:24:07 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188Please note that changes to some configuration parameters may take
4189only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004190
stroesec1551ea2003-04-04 15:53:41 +00004191
wdenk2729af92004-05-03 20:45:30 +00004192Command Line Parsing:
4193=====================
stroesec1551ea2003-04-04 15:53:41 +00004194
wdenk2729af92004-05-03 20:45:30 +00004195There are two different command line parsers available with U-Boot:
4196the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004197
wdenk2729af92004-05-03 20:45:30 +00004198Old, simple command line parser:
4199--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201- supports environment variables (through setenv / saveenv commands)
4202- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004203- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004204- special characters ('$', ';') can be escaped by prefixing with '\',
4205 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004206 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004207- You can also escape text by enclosing in single apostrophes, for example:
4208 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004209
wdenk2729af92004-05-03 20:45:30 +00004210Hush shell:
4211-----------
wdenkf07771c2003-05-28 08:06:31 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213- similar to Bourne shell, with control structures like
4214 if...then...else...fi, for...do...done; while...do...done,
4215 until...do...done, ...
4216- supports environment ("global") variables (through setenv / saveenv
4217 commands) and local shell variables (through standard shell syntax
4218 "name=value"); only environment variables can be used with "run"
4219 command
wdenkf07771c2003-05-28 08:06:31 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221General rules:
4222--------------
wdenkf07771c2003-05-28 08:06:31 +00004223
wdenk2729af92004-05-03 20:45:30 +00004224(1) If a command line (or an environment variable executed by a "run"
4225 command) contains several commands separated by semicolon, and
4226 one of these commands fails, then the remaining commands will be
4227 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004230 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004231 command will cause "run" to terminate, i. e. the remaining
4232 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004233
wdenk2729af92004-05-03 20:45:30 +00004234Note for Redundant Ethernet Interfaces:
4235=======================================
wdenkf07771c2003-05-28 08:06:31 +00004236
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004237Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004238such configurations and is capable of automatic selection of a
4239"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004240
wdenk2729af92004-05-03 20:45:30 +00004241Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4242MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4243"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004244
wdenk2729af92004-05-03 20:45:30 +00004245If the network interface stores some valid MAC address (for instance
4246in SROM), this is used as default address if there is NO correspon-
4247ding setting in the environment; if the corresponding environment
4248variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250o If the SROM has a valid MAC address, and there is no address in the
4251 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253o If there is no valid address in the SROM, and a definition in the
4254 environment exists, then the value from the environment variable is
4255 used.
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257o If both the SROM and the environment contain a MAC address, and
4258 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004259
wdenk2729af92004-05-03 20:45:30 +00004260o If both the SROM and the environment contain a MAC address, and the
4261 addresses differ, the value from the environment is used and a
4262 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264o If neither SROM nor the environment contain a MAC address, an error
4265 is raised.
wdenkc6097192002-11-03 00:24:07 +00004266
Ben Warrenecee9322010-04-26 11:11:46 -07004267If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004268will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004269may be skipped by setting the appropriate 'ethmacskip' environment variable.
4270The naming convention is as follows:
4271"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk2729af92004-05-03 20:45:30 +00004273Image Formats:
4274==============
wdenkc6097192002-11-03 00:24:07 +00004275
Marian Balakowicz3310c542008-03-12 12:13:13 +01004276U-Boot is capable of booting (and performing other auxiliary operations on)
4277images in two formats:
4278
4279New uImage format (FIT)
4280-----------------------
4281
4282Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4283to Flattened Device Tree). It allows the use of images with multiple
4284components (several kernels, ramdisks, etc.), with contents protected by
4285SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4286
4287
4288Old uImage format
4289-----------------
4290
4291Old image format is based on binary files which can be basically anything,
4292preceded by a special header; see the definitions in include/image.h for
4293details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004294
wdenk2729af92004-05-03 20:45:30 +00004295* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4296 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004297 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4298 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4299 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004300* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004301 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4302 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004303* Compression Type (uncompressed, gzip, bzip2)
4304* Load Address
4305* Entry Point
4306* Image Name
4307* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004308
wdenk2729af92004-05-03 20:45:30 +00004309The header is marked by a special Magic Number, and both the header
4310and the data portions of the image are secured against corruption by
4311CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004312
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk2729af92004-05-03 20:45:30 +00004314Linux Support:
4315==============
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk2729af92004-05-03 20:45:30 +00004317Although U-Boot should support any OS or standalone application
4318easily, the main focus has always been on Linux during the design of
4319U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004320
wdenk2729af92004-05-03 20:45:30 +00004321U-Boot includes many features that so far have been part of some
4322special "boot loader" code within the Linux kernel. Also, any
4323"initrd" images to be used are no longer part of one big Linux image;
4324instead, kernel and "initrd" are separate images. This implementation
4325serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327- the same features can be used for other OS or standalone
4328 applications (for instance: using compressed images to reduce the
4329 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004330
wdenk2729af92004-05-03 20:45:30 +00004331- it becomes much easier to port new Linux kernel versions because
4332 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004333
wdenk2729af92004-05-03 20:45:30 +00004334- the same Linux kernel image can now be used with different "initrd"
4335 images; of course this also means that different kernel images can
4336 be run with the same "initrd". This makes testing easier (you don't
4337 have to build a new "zImage.initrd" Linux image when you just
4338 change a file in your "initrd"). Also, a field-upgrade of the
4339 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004340
wdenkc6097192002-11-03 00:24:07 +00004341
wdenk2729af92004-05-03 20:45:30 +00004342Linux HOWTO:
4343============
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345Porting Linux to U-Boot based systems:
4346---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004347
wdenk2729af92004-05-03 20:45:30 +00004348U-Boot cannot save you from doing all the necessary modifications to
4349configure the Linux device drivers for use with your target hardware
4350(no, we don't intend to provide a full virtual machine interface to
4351Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004352
Stefan Roesea47a12b2010-04-15 16:07:28 +02004353But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk2729af92004-05-03 20:45:30 +00004355Just make sure your machine specific header file (for instance
4356include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004357Information structure as we define in include/asm-<arch>/u-boot.h,
4358and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004359as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004360
wdenkc6097192002-11-03 00:24:07 +00004361
wdenk2729af92004-05-03 20:45:30 +00004362Configuring the Linux kernel:
4363-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk2729af92004-05-03 20:45:30 +00004365No specific requirements for U-Boot. Make sure you have some root
4366device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004367
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk2729af92004-05-03 20:45:30 +00004369Building a Linux Image:
4370-----------------------
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk2729af92004-05-03 20:45:30 +00004372With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4373not used. If you use recent kernel source, a new build target
4374"uImage" will exist which automatically builds an image usable by
4375U-Boot. Most older kernels also have support for a "pImage" target,
4376which was introduced for our predecessor project PPCBoot and uses a
4377100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004378
wdenk2729af92004-05-03 20:45:30 +00004379Example:
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk2729af92004-05-03 20:45:30 +00004381 make TQM850L_config
4382 make oldconfig
4383 make dep
4384 make uImage
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386The "uImage" build target uses a special tool (in 'tools/mkimage') to
4387encapsulate a compressed Linux kernel image with header information,
4388CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004389
wdenk2729af92004-05-03 20:45:30 +00004390* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004391
wdenk2729af92004-05-03 20:45:30 +00004392* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk2729af92004-05-03 20:45:30 +00004394 ${CROSS_COMPILE}-objcopy -O binary \
4395 -R .note -R .comment \
4396 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004397
wdenk2729af92004-05-03 20:45:30 +00004398* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk2729af92004-05-03 20:45:30 +00004402* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004403
wdenk2729af92004-05-03 20:45:30 +00004404 mkimage -A ppc -O linux -T kernel -C gzip \
4405 -a 0 -e 0 -n "Linux Kernel Image" \
4406 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004407
wdenk24ee89b2002-11-03 17:56:27 +00004408
wdenk2729af92004-05-03 20:45:30 +00004409The "mkimage" tool can also be used to create ramdisk images for use
4410with U-Boot, either separated from the Linux kernel image, or
4411combined into one file. "mkimage" encapsulates the images with a 64
4412byte header containing information about target architecture,
4413operating system, image type, compression method, entry points, time
4414stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004415
wdenk2729af92004-05-03 20:45:30 +00004416"mkimage" can be called in two ways: to verify existing images and
4417print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419In the first form (with "-l" option) mkimage lists the information
4420contained in the header of an existing U-Boot image; this includes
4421checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004422
wdenk2729af92004-05-03 20:45:30 +00004423 tools/mkimage -l image
4424 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004425
wdenk2729af92004-05-03 20:45:30 +00004426The second form (with "-d" option) is used to build a U-Boot image
4427from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004428
wdenk2729af92004-05-03 20:45:30 +00004429 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4430 -n name -d data_file image
4431 -A ==> set architecture to 'arch'
4432 -O ==> set operating system to 'os'
4433 -T ==> set image type to 'type'
4434 -C ==> set compression type 'comp'
4435 -a ==> set load address to 'addr' (hex)
4436 -e ==> set entry point to 'ep' (hex)
4437 -n ==> set image name to 'name'
4438 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004439
wdenk69459792004-05-29 16:53:29 +00004440Right now, all Linux kernels for PowerPC systems use the same load
4441address (0x00000000), but the entry point address depends on the
4442kernel version:
wdenkc6097192002-11-03 00:24:07 +00004443
wdenk2729af92004-05-03 20:45:30 +00004444- 2.2.x kernels have the entry point at 0x0000000C,
4445- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4450 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004451 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004452 > examples/uImage.TQM850L
4453 Image Name: 2.4.4 kernel for TQM850L
4454 Created: Wed Jul 19 02:34:59 2000
4455 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4456 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4457 Load Address: 0x00000000
4458 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk2729af92004-05-03 20:45:30 +00004462 -> tools/mkimage -l examples/uImage.TQM850L
4463 Image Name: 2.4.4 kernel for TQM850L
4464 Created: Wed Jul 19 02:34:59 2000
4465 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4466 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4467 Load Address: 0x00000000
4468 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004469
wdenk2729af92004-05-03 20:45:30 +00004470NOTE: for embedded systems where boot time is critical you can trade
4471speed for memory and install an UNCOMPRESSED image instead: this
4472needs more space in Flash, but boots much faster since it does not
4473need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004474
Stefan Roesea47a12b2010-04-15 16:07:28 +02004475 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004476 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4477 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004478 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004479 > examples/uImage.TQM850L-uncompressed
4480 Image Name: 2.4.4 kernel for TQM850L
4481 Created: Wed Jul 19 02:34:59 2000
4482 Image Type: PowerPC Linux Kernel Image (uncompressed)
4483 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4484 Load Address: 0x00000000
4485 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004486
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4489when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491 -> tools/mkimage -n 'Simple Ramdisk Image' \
4492 > -A ppc -O linux -T ramdisk -C gzip \
4493 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4494 Image Name: Simple Ramdisk Image
4495 Created: Wed Jan 12 14:01:50 2000
4496 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4497 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4498 Load Address: 0x00000000
4499 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004500
wdenkdb01a2e2004-04-15 23:14:49 +00004501
wdenk2729af92004-05-03 20:45:30 +00004502Installing a Linux Image:
4503-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004504
wdenk2729af92004-05-03 20:45:30 +00004505To downloading a U-Boot image over the serial (console) interface,
4506you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004507
wdenk2729af92004-05-03 20:45:30 +00004508 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004509
wdenk2729af92004-05-03 20:45:30 +00004510The 'objcopy' does not understand the information in the U-Boot
4511image header, so the resulting S-Record file will be relative to
4512address 0x00000000. To load it to a given address, you need to
4513specify the target address as 'offset' parameter with the 'loads'
4514command.
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk2729af92004-05-03 20:45:30 +00004516Example: install the image to address 0x40100000 (which on the
4517TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk2729af92004-05-03 20:45:30 +00004519 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk2729af92004-05-03 20:45:30 +00004521 .......... done
4522 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524 => loads 40100000
4525 ## Ready for S-Record download ...
4526 ~>examples/image.srec
4527 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4528 ...
4529 15989 15990 15991 15992
4530 [file transfer complete]
4531 [connected]
4532 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004533
4534
wdenk2729af92004-05-03 20:45:30 +00004535You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004536this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004537corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk2729af92004-05-03 20:45:30 +00004541 ## Checking Image at 40100000 ...
4542 Image Name: 2.2.13 for initrd on TQM850L
4543 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4544 Data Size: 335725 Bytes = 327 kB = 0 MB
4545 Load Address: 00000000
4546 Entry Point: 0000000c
4547 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004548
4549
wdenk2729af92004-05-03 20:45:30 +00004550Boot Linux:
4551-----------
wdenkc6097192002-11-03 00:24:07 +00004552
wdenk2729af92004-05-03 20:45:30 +00004553The "bootm" command is used to boot an application that is stored in
4554memory (RAM or Flash). In case of a Linux kernel image, the contents
4555of the "bootargs" environment variable is passed to the kernel as
4556parameters. You can check and modify this variable using the
4557"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004558
4559
wdenk2729af92004-05-03 20:45:30 +00004560 => printenv bootargs
4561 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004562
wdenk2729af92004-05-03 20:45:30 +00004563 => 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 +00004564
wdenk2729af92004-05-03 20:45:30 +00004565 => printenv bootargs
4566 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 +00004567
wdenk2729af92004-05-03 20:45:30 +00004568 => bootm 40020000
4569 ## Booting Linux kernel at 40020000 ...
4570 Image Name: 2.2.13 for NFS on TQM850L
4571 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4572 Data Size: 381681 Bytes = 372 kB = 0 MB
4573 Load Address: 00000000
4574 Entry Point: 0000000c
4575 Verifying Checksum ... OK
4576 Uncompressing Kernel Image ... OK
4577 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
4578 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4579 time_init: decrementer frequency = 187500000/60
4580 Calibrating delay loop... 49.77 BogoMIPS
4581 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4582 ...
wdenkc6097192002-11-03 00:24:07 +00004583
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004584If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004585the memory addresses of both the kernel and the initrd image (PPBCOOT
4586format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004587
wdenk2729af92004-05-03 20:45:30 +00004588 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590 ## Checking Image at 40100000 ...
4591 Image Name: 2.2.13 for initrd on TQM850L
4592 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4593 Data Size: 335725 Bytes = 327 kB = 0 MB
4594 Load Address: 00000000
4595 Entry Point: 0000000c
4596 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598 ## Checking Image at 40200000 ...
4599 Image Name: Simple Ramdisk Image
4600 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4601 Data Size: 566530 Bytes = 553 kB = 0 MB
4602 Load Address: 00000000
4603 Entry Point: 00000000
4604 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk2729af92004-05-03 20:45:30 +00004606 => bootm 40100000 40200000
4607 ## Booting Linux kernel at 40100000 ...
4608 Image Name: 2.2.13 for initrd on TQM850L
4609 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4610 Data Size: 335725 Bytes = 327 kB = 0 MB
4611 Load Address: 00000000
4612 Entry Point: 0000000c
4613 Verifying Checksum ... OK
4614 Uncompressing Kernel Image ... OK
4615 ## Loading RAMDisk Image at 40200000 ...
4616 Image Name: Simple Ramdisk Image
4617 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4618 Data Size: 566530 Bytes = 553 kB = 0 MB
4619 Load Address: 00000000
4620 Entry Point: 00000000
4621 Verifying Checksum ... OK
4622 Loading Ramdisk ... OK
4623 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
4624 Boot arguments: root=/dev/ram
4625 time_init: decrementer frequency = 187500000/60
4626 Calibrating delay loop... 49.77 BogoMIPS
4627 ...
4628 RAMDISK: Compressed image found at block 0
4629 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk2729af92004-05-03 20:45:30 +00004631 bash#
wdenkc6097192002-11-03 00:24:07 +00004632
Matthew McClintock02677682006-06-28 10:41:37 -05004633Boot Linux and pass a flat device tree:
4634-----------
4635
4636First, U-Boot must be compiled with the appropriate defines. See the section
4637titled "Linux Kernel Interface" above for a more in depth explanation. The
4638following is an example of how to start a kernel and pass an updated
4639flat device tree:
4640
4641=> print oftaddr
4642oftaddr=0x300000
4643=> print oft
4644oft=oftrees/mpc8540ads.dtb
4645=> tftp $oftaddr $oft
4646Speed: 1000, full duplex
4647Using TSEC0 device
4648TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4649Filename 'oftrees/mpc8540ads.dtb'.
4650Load address: 0x300000
4651Loading: #
4652done
4653Bytes transferred = 4106 (100a hex)
4654=> tftp $loadaddr $bootfile
4655Speed: 1000, full duplex
4656Using TSEC0 device
4657TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4658Filename 'uImage'.
4659Load address: 0x200000
4660Loading:############
4661done
4662Bytes transferred = 1029407 (fb51f hex)
4663=> print loadaddr
4664loadaddr=200000
4665=> print oftaddr
4666oftaddr=0x300000
4667=> bootm $loadaddr - $oftaddr
4668## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004669 Image Name: Linux-2.6.17-dirty
4670 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4671 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004672 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004673 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004674 Verifying Checksum ... OK
4675 Uncompressing Kernel Image ... OK
4676Booting using flat device tree at 0x300000
4677Using MPC85xx ADS machine description
4678Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4679[snip]
4680
4681
wdenk2729af92004-05-03 20:45:30 +00004682More About U-Boot Image Types:
4683------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004684
wdenk2729af92004-05-03 20:45:30 +00004685U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004686
wdenk2729af92004-05-03 20:45:30 +00004687 "Standalone Programs" are directly runnable in the environment
4688 provided by U-Boot; it is expected that (if they behave
4689 well) you can continue to work in U-Boot after return from
4690 the Standalone Program.
4691 "OS Kernel Images" are usually images of some Embedded OS which
4692 will take over control completely. Usually these programs
4693 will install their own set of exception handlers, device
4694 drivers, set up the MMU, etc. - this means, that you cannot
4695 expect to re-enter U-Boot except by resetting the CPU.
4696 "RAMDisk Images" are more or less just data blocks, and their
4697 parameters (address, size) are passed to an OS kernel that is
4698 being started.
4699 "Multi-File Images" contain several images, typically an OS
4700 (Linux) kernel image and one or more data images like
4701 RAMDisks. This construct is useful for instance when you want
4702 to boot over the network using BOOTP etc., where the boot
4703 server provides just a single image file, but you want to get
4704 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004705
wdenk2729af92004-05-03 20:45:30 +00004706 "Multi-File Images" start with a list of image sizes, each
4707 image size (in bytes) specified by an "uint32_t" in network
4708 byte order. This list is terminated by an "(uint32_t)0".
4709 Immediately after the terminating 0 follow the images, one by
4710 one, all aligned on "uint32_t" boundaries (size rounded up to
4711 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004712
wdenk2729af92004-05-03 20:45:30 +00004713 "Firmware Images" are binary images containing firmware (like
4714 U-Boot or FPGA images) which usually will be programmed to
4715 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004716
wdenk2729af92004-05-03 20:45:30 +00004717 "Script files" are command sequences that will be executed by
4718 U-Boot's command interpreter; this feature is especially
4719 useful when you configure U-Boot to use a real shell (hush)
4720 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004721
Marek Vasut44f074c2012-03-14 21:52:45 +00004722Booting the Linux zImage:
4723-------------------------
4724
4725On some platforms, it's possible to boot Linux zImage. This is done
4726using the "bootz" command. The syntax of "bootz" command is the same
4727as the syntax of "bootm" command.
4728
Marek Vasut017e1f32012-03-18 11:47:58 +00004729Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4730kernel with raw initrd images. The syntax is slightly different, the
4731address of the initrd must be augmented by it's size, in the following
4732format: "<initrd addres>:<initrd size>".
4733
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735Standalone HOWTO:
4736=================
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738One of the features of U-Boot is that you can dynamically load and
4739run "standalone" applications, which can use some resources of
4740U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004741
wdenk2729af92004-05-03 20:45:30 +00004742Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004743
wdenk2729af92004-05-03 20:45:30 +00004744"Hello World" Demo:
4745-------------------
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747'examples/hello_world.c' contains a small "Hello World" Demo
4748application; it is automatically compiled when you build U-Boot.
4749It's configured to run at address 0x00040004, so you can play with it
4750like that:
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk2729af92004-05-03 20:45:30 +00004752 => loads
4753 ## Ready for S-Record download ...
4754 ~>examples/hello_world.srec
4755 1 2 3 4 5 6 7 8 9 10 11 ...
4756 [file transfer complete]
4757 [connected]
4758 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk2729af92004-05-03 20:45:30 +00004760 => go 40004 Hello World! This is a test.
4761 ## Starting application at 0x00040004 ...
4762 Hello World
4763 argc = 7
4764 argv[0] = "40004"
4765 argv[1] = "Hello"
4766 argv[2] = "World!"
4767 argv[3] = "This"
4768 argv[4] = "is"
4769 argv[5] = "a"
4770 argv[6] = "test."
4771 argv[7] = "<NULL>"
4772 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk2729af92004-05-03 20:45:30 +00004776Another example, which demonstrates how to register a CPM interrupt
4777handler with the U-Boot code, can be found in 'examples/timer.c'.
4778Here, a CPM timer is set up to generate an interrupt every second.
4779The interrupt service routine is trivial, just printing a '.'
4780character, but this is just a demo program. The application can be
4781controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk2729af92004-05-03 20:45:30 +00004783 ? - print current values og the CPM Timer registers
4784 b - enable interrupts and start timer
4785 e - stop timer and disable interrupts
4786 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk2729af92004-05-03 20:45:30 +00004788 => loads
4789 ## Ready for S-Record download ...
4790 ~>examples/timer.srec
4791 1 2 3 4 5 6 7 8 9 10 11 ...
4792 [file transfer complete]
4793 [connected]
4794 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk2729af92004-05-03 20:45:30 +00004796 => go 40004
4797 ## Starting application at 0x00040004 ...
4798 TIMERS=0xfff00980
4799 Using timer 1
4800 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk2729af92004-05-03 20:45:30 +00004802Hit 'b':
4803 [q, b, e, ?] Set interval 1000000 us
4804 Enabling timer
4805Hit '?':
4806 [q, b, e, ?] ........
4807 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4808Hit '?':
4809 [q, b, e, ?] .
4810 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4811Hit '?':
4812 [q, b, e, ?] .
4813 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4814Hit '?':
4815 [q, b, e, ?] .
4816 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4817Hit 'e':
4818 [q, b, e, ?] ...Stopping timer
4819Hit 'q':
4820 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004821
4822
wdenk2729af92004-05-03 20:45:30 +00004823Minicom warning:
4824================
wdenk85ec0bc2003-03-31 16:34:49 +00004825
wdenk2729af92004-05-03 20:45:30 +00004826Over time, many people have reported problems when trying to use the
4827"minicom" terminal emulation program for serial download. I (wd)
4828consider minicom to be broken, and recommend not to use it. Under
4829Unix, I recommend to use C-Kermit for general purpose use (and
4830especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004831use "cu" for S-Record download ("loads" command). See
4832http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4833for help with kermit.
4834
wdenk85ec0bc2003-03-31 16:34:49 +00004835
wdenk2729af92004-05-03 20:45:30 +00004836Nevertheless, if you absolutely want to use it try adding this
4837configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004838
wdenk2729af92004-05-03 20:45:30 +00004839 Name Program Name U/D FullScr IO-Red. Multi
4840 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4841 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004842
4843
wdenk2729af92004-05-03 20:45:30 +00004844NetBSD Notes:
4845=============
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk2729af92004-05-03 20:45:30 +00004847Starting at version 0.9.2, U-Boot supports NetBSD both as host
4848(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004849
wdenk2729af92004-05-03 20:45:30 +00004850Building requires a cross environment; it is known to work on
4851NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4852need gmake since the Makefiles are not compatible with BSD make).
4853Note that the cross-powerpc package does not install include files;
4854attempting to build U-Boot will fail because <machine/ansi.h> is
4855missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857 # cd /usr/pkg/cross/powerpc-netbsd/include
4858 # mkdir powerpc
4859 # ln -s powerpc machine
4860 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4861 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863Native builds *don't* work due to incompatibilities between native
4864and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk2729af92004-05-03 20:45:30 +00004866Booting assumes that (the first part of) the image booted is a
4867stage-2 loader which in turn loads and then invokes the kernel
4868proper. Loader sources will eventually appear in the NetBSD source
4869tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004870meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004871
4872
wdenk2729af92004-05-03 20:45:30 +00004873Implementation Internals:
4874=========================
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk2729af92004-05-03 20:45:30 +00004876The following is not intended to be a complete description of every
4877implementation detail. However, it should help to understand the
4878inner workings of U-Boot and make it easier to port it to custom
4879hardware.
wdenkc6097192002-11-03 00:24:07 +00004880
4881
wdenk2729af92004-05-03 20:45:30 +00004882Initial Stack, Global Data:
4883---------------------------
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk2729af92004-05-03 20:45:30 +00004885The implementation of U-Boot is complicated by the fact that U-Boot
4886starts running out of ROM (flash memory), usually without access to
4887system RAM (because the memory controller is not initialized yet).
4888This means that we don't have writable Data or BSS segments, and BSS
4889is not initialized as zero. To be able to get a C environment working
4890at all, we have to allocate at least a minimal stack. Implementation
4891options for this are defined and restricted by the CPU used: Some CPU
4892models provide on-chip memory (like the IMMR area on MPC8xx and
4893MPC826x processors), on others (parts of) the data cache can be
4894locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004895
Wolfgang Denk218ca722008-03-26 10:40:12 +01004896 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004897 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004898
wdenk2729af92004-05-03 20:45:30 +00004899 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4900 From: "Chris Hallinan" <clh@net1plus.com>
4901 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4902 ...
wdenk43d96162003-03-06 00:02:04 +00004903
wdenk2729af92004-05-03 20:45:30 +00004904 Correct me if I'm wrong, folks, but the way I understand it
4905 is this: Using DCACHE as initial RAM for Stack, etc, does not
4906 require any physical RAM backing up the cache. The cleverness
4907 is that the cache is being used as a temporary supply of
4908 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004909 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004910 can see how this works by studying the cache architecture and
4911 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004912
wdenk2729af92004-05-03 20:45:30 +00004913 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4914 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004915 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004916 option should work for you. Using CS 4 should be fine if your
4917 board designers haven't used it for something that would
4918 cause you grief during the initial boot! It is frequently not
4919 used.
wdenk43d96162003-03-06 00:02:04 +00004920
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004921 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004922 with your processor/board/system design. The default value
4923 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004924 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004925 than your SDRAM module. If you have a 64MB SDRAM module, set
4926 it above 400_0000. Just make sure your board has no resources
4927 that are supposed to respond to that address! That code in
4928 start.S has been around a while and should work as is when
4929 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931 -Chris Hallinan
4932 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004933
wdenk2729af92004-05-03 20:45:30 +00004934It is essential to remember this, since it has some impact on the C
4935code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004936
wdenk2729af92004-05-03 20:45:30 +00004937* Initialized global data (data segment) is read-only. Do not attempt
4938 to write it.
wdenkc6097192002-11-03 00:24:07 +00004939
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004940* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004941 as zero data - BSS segment) at all - this is undefined, initiali-
4942 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk2729af92004-05-03 20:45:30 +00004944* Stack space is very limited. Avoid big data buffers or things like
4945 that.
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk2729af92004-05-03 20:45:30 +00004947Having only the stack as writable memory limits means we cannot use
4948normal global data to share information beween the code. But it
4949turned out that the implementation of U-Boot can be greatly
4950simplified by making a global data structure (gd_t) available to all
4951functions. We could pass a pointer to this data as argument to _all_
4952functions, but this would bloat the code. Instead we use a feature of
4953the GCC compiler (Global Register Variables) to share the data: we
4954place a pointer (gd) to the global data into a register which we
4955reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk2729af92004-05-03 20:45:30 +00004957When choosing a register for such a purpose we are restricted by the
4958relevant (E)ABI specifications for the current architecture, and by
4959GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004960
wdenk2729af92004-05-03 20:45:30 +00004961For PowerPC, the following registers have specific use:
4962 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004963 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004964 R3-R4: parameter passing and return values
4965 R5-R10: parameter passing
4966 R13: small data area pointer
4967 R30: GOT pointer
4968 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004969
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004970 (U-Boot also uses R12 as internal GOT pointer. r12
4971 is a volatile register so r12 needs to be reset when
4972 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004973
Wolfgang Denke7670f62008-02-14 22:43:22 +01004974 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk2729af92004-05-03 20:45:30 +00004976 Note: on PPC, we could use a static initializer (since the
4977 address of the global data structure is known at compile time),
4978 but it turned out that reserving a register results in somewhat
4979 smaller code - although the code savings are not that big (on
4980 average for all boards 752 bytes for the whole U-Boot image,
4981 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004982
Robin Getzc4db3352009-08-17 15:23:02 +00004983On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004984 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4985
Robin Getzc4db3352009-08-17 15:23:02 +00004986 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004987
wdenk2729af92004-05-03 20:45:30 +00004988On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990 R0: function argument word/integer result
4991 R1-R3: function argument word
4992 R9: GOT pointer
4993 R10: stack limit (used only if stack checking if enabled)
4994 R11: argument (frame) pointer
4995 R12: temporary workspace
4996 R13: stack pointer
4997 R14: link register
4998 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004999
wdenk2729af92004-05-03 20:45:30 +00005000 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005001
Thomas Chou0df01fd2010-05-21 11:08:03 +08005002On Nios II, the ABI is documented here:
5003 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5004
5005 ==> U-Boot will use gp to hold a pointer to the global data
5006
5007 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5008 to access small data sections, so gp is free.
5009
Macpaul Linafc1ce82011-10-19 20:41:11 +00005010On NDS32, the following registers are used:
5011
5012 R0-R1: argument/return
5013 R2-R5: argument
5014 R15: temporary register for assembler
5015 R16: trampoline register
5016 R28: frame pointer (FP)
5017 R29: global pointer (GP)
5018 R30: link register (LP)
5019 R31: stack pointer (SP)
5020 PC: program counter (PC)
5021
5022 ==> U-Boot will use R10 to hold a pointer to the global data
5023
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005024NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5025or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005026
wdenk2729af92004-05-03 20:45:30 +00005027Memory Management:
5028------------------
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk2729af92004-05-03 20:45:30 +00005030U-Boot runs in system state and uses physical addresses, i.e. the
5031MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033The available memory is mapped to fixed addresses using the memory
5034controller. In this process, a contiguous block is formed for each
5035memory type (Flash, SDRAM, SRAM), even when it consists of several
5036physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005037
wdenk2729af92004-05-03 20:45:30 +00005038U-Boot is installed in the first 128 kB of the first Flash bank (on
5039TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5040booting and sizing and initializing DRAM, the code relocates itself
5041to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005042memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005043configuration setting]. Below that, a structure with global Board
5044Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005045
wdenk2729af92004-05-03 20:45:30 +00005046Additionally, some exception handler code is copied to the low 8 kB
5047of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk2729af92004-05-03 20:45:30 +00005049So a typical memory configuration with 16 MB of DRAM could look like
5050this:
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk2729af92004-05-03 20:45:30 +00005052 0x0000 0000 Exception Vector code
5053 :
5054 0x0000 1FFF
5055 0x0000 2000 Free for Application Use
5056 :
5057 :
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk2729af92004-05-03 20:45:30 +00005059 :
5060 :
5061 0x00FB FF20 Monitor Stack (Growing downward)
5062 0x00FB FFAC Board Info Data and permanent copy of global data
5063 0x00FC 0000 Malloc Arena
5064 :
5065 0x00FD FFFF
5066 0x00FE 0000 RAM Copy of Monitor Code
5067 ... eventually: LCD or video framebuffer
5068 ... eventually: pRAM (Protected RAM - unchanged by reset)
5069 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005070
5071
wdenk2729af92004-05-03 20:45:30 +00005072System Initialization:
5073----------------------
wdenkc6097192002-11-03 00:24:07 +00005074
wdenk2729af92004-05-03 20:45:30 +00005075In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005076(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005077configuration for CS0# this is a mirror of the onboard Flash memory.
5078To be able to re-map memory U-Boot then jumps to its link address.
5079To be able to implement the initialization code in C, a (small!)
5080initial stack is set up in the internal Dual Ported RAM (in case CPUs
5081which provide such a feature like MPC8xx or MPC8260), or in a locked
5082part of the data cache. After that, U-Boot initializes the CPU core,
5083the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085Next, all (potentially) available memory banks are mapped using a
5086preliminary mapping. For example, we put them on 512 MB boundaries
5087(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5088on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5089programmed for SDRAM access. Using the temporary configuration, a
5090simple memory test is run that determines the size of the SDRAM
5091banks.
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk2729af92004-05-03 20:45:30 +00005093When there is more than one SDRAM bank, and the banks are of
5094different size, the largest is mapped first. For equal size, the first
5095bank (CS2#) is mapped first. The first mapping is always for address
50960x00000000, with any additional banks following immediately to create
5097contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005098
wdenk2729af92004-05-03 20:45:30 +00005099Then, the monitor installs itself at the upper end of the SDRAM area
5100and allocates memory for use by malloc() and for the global Board
5101Info data; also, the exception vector code is copied to the low RAM
5102pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk2729af92004-05-03 20:45:30 +00005104Only after this relocation will you have a "normal" C environment;
5105until that you are restricted in several ways, mostly because you are
5106running from ROM, and because the code will have to be relocated to a
5107new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005108
5109
wdenk2729af92004-05-03 20:45:30 +00005110U-Boot Porting Guide:
5111----------------------
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5114list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005115
5116
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005117int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005118{
5119 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005120
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005121 signal(SIGALRM, no_more_time);
5122 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk2729af92004-05-03 20:45:30 +00005124 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005125 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005126 return 0;
5127 }
5128
wdenk2729af92004-05-03 20:45:30 +00005129 Download latest U-Boot source;
5130
Wolfgang Denk06682362008-12-30 22:56:11 +01005131 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005132
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005133 if (clueless)
5134 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk2729af92004-05-03 20:45:30 +00005136 while (learning) {
5137 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005138 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5139 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005140 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005141 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005142 }
wdenkc6097192002-11-03 00:24:07 +00005143
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005144 if (available_money > toLocalCurrency ($2500))
5145 Buy a BDI3000;
5146 else
wdenk2729af92004-05-03 20:45:30 +00005147 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005148
5149 if (a similar board exists) { /* hopefully... */
5150 cp -a board/<similar> board/<myboard>
5151 cp include/configs/<similar>.h include/configs/<myboard>.h
5152 } else {
5153 Create your own board support subdirectory;
5154 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005155 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005156 Edit new board/<myboard> files
5157 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005158
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005159 while (!accepted) {
5160 while (!running) {
5161 do {
5162 Add / modify source code;
5163 } until (compiles);
5164 Debug;
5165 if (clueless)
5166 email("Hi, I am having problems...");
5167 }
5168 Send patch file to the U-Boot email list;
5169 if (reasonable critiques)
5170 Incorporate improvements from email list code review;
5171 else
5172 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005173 }
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175 return 0;
5176}
5177
5178void no_more_time (int sig)
5179{
5180 hire_a_guru();
5181}
wdenkc6097192002-11-03 00:24:07 +00005182
5183
wdenk2729af92004-05-03 20:45:30 +00005184Coding Standards:
5185-----------------
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk2729af92004-05-03 20:45:30 +00005187All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005188coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005189"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005190
Detlev Zundel2c051652006-09-01 15:39:02 +02005191Source files originating from a different project (for example the
5192MTD subsystem) are generally exempt from these guidelines and are not
5193reformated to ease subsequent migration to newer versions of those
5194sources.
5195
5196Please note that U-Boot is implemented in C (and to some small parts in
5197Assembler); no C++ is used, so please do not use C++ style comments (//)
5198in your code.
wdenk2729af92004-05-03 20:45:30 +00005199
5200Please also stick to the following formatting rules:
5201- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005202- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005203- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005204- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005205- do not add trailing empty lines to source files
5206
5207Submissions which do not conform to the standards may be returned
5208with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005209
5210
wdenk2729af92004-05-03 20:45:30 +00005211Submitting Patches:
5212-------------------
wdenkc6097192002-11-03 00:24:07 +00005213
wdenk2729af92004-05-03 20:45:30 +00005214Since the number of patches for U-Boot is growing, we need to
5215establish some rules. Submissions which do not conform to these rules
5216may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005217
Magnus Lilja0d28f342008-08-06 19:32:33 +02005218Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005219
Wolfgang Denk06682362008-12-30 22:56:11 +01005220Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5221see http://lists.denx.de/mailman/listinfo/u-boot
5222
wdenk2729af92004-05-03 20:45:30 +00005223When you send a patch, please include the following information with
5224it:
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk2729af92004-05-03 20:45:30 +00005226* For bug fixes: a description of the bug and how your patch fixes
5227 this bug. Please try to include a way of demonstrating that the
5228 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230* For new features: a description of the feature and your
5231 implementation.
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk2729af92004-05-03 20:45:30 +00005233* A CHANGELOG entry as plaintext (separate from the patch)
5234
5235* For major contributions, your entry to the CREDITS file
5236
5237* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005238 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005239
5240* If your patch adds new configuration options, don't forget to
5241 document these in the README file.
5242
Wolfgang Denk218ca722008-03-26 10:40:12 +01005243* The patch itself. If you are using git (which is *strongly*
5244 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005245 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005246 the U-Boot mailing list, you will avoid most of the common problems
5247 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005248
Wolfgang Denk218ca722008-03-26 10:40:12 +01005249 If you cannot use git, use "diff -purN OLD NEW". If your version of
5250 diff does not support these options, then get the latest version of
5251 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005252
Wolfgang Denk218ca722008-03-26 10:40:12 +01005253 The current directory when running this command shall be the parent
5254 directory of the U-Boot source tree (i. e. please make sure that
5255 your patch includes sufficient directory information for the
5256 affected files).
5257
5258 We prefer patches as plain text. MIME attachments are discouraged,
5259 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005260
5261* If one logical set of modifications affects or creates several
5262 files, all these changes shall be submitted in a SINGLE patch file.
5263
5264* Changesets that contain different, unrelated modifications shall be
5265 submitted as SEPARATE patches, one patch per changeset.
5266
5267
5268Notes:
5269
5270* Before sending the patch, run the MAKEALL script on your patched
5271 source tree and make sure that no errors or warnings are reported
5272 for any of the boards.
5273
5274* Keep your modifications to the necessary minimum: A patch
5275 containing several unrelated changes or arbitrary reformats will be
5276 returned with a request to re-formatting / split it.
5277
5278* If you modify existing code, make sure that your new code does not
5279 add to the memory footprint of the code ;-) Small is beautiful!
5280 When adding new features, these should compile conditionally only
5281 (using #ifdef), and the resulting code with the new feature
5282 disabled must not need more memory than the old code without your
5283 modification.
wdenk90dc6702005-05-03 14:12:25 +00005284
Wolfgang Denk06682362008-12-30 22:56:11 +01005285* Remember that there is a size limit of 100 kB per message on the
5286 u-boot mailing list. Bigger patches will be moderated. If they are
5287 reasonable and not too big, they will be acknowledged. But patches
5288 bigger than the size limit should be avoided.