blob: 06f5ef2354d6983df2f686a7d51bffd49dec3cda [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
Mike Frysingera641b972010-12-26 23:32:22 -0500827 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000828 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500829 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
830 CONFIG_CMD_I2C * I2C serial bus support
831 CONFIG_CMD_IDE * IDE harddisk support
832 CONFIG_CMD_IMI iminfo
833 CONFIG_CMD_IMLS List all found images
834 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500835 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000836 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_IRQ * irqinfo
838 CONFIG_CMD_ITEST Integer/string test of 2 values
839 CONFIG_CMD_JFFS2 * JFFS2 Support
840 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500841 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000842 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
843 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_LOADB loadb
845 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400846 CONFIG_CMD_MD5SUM print md5 message digest
847 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500848 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
849 loop, loopw, mtest
850 CONFIG_CMD_MISC Misc functions like sleep etc
851 CONFIG_CMD_MMC * MMC memory mapped support
852 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100853 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500854 CONFIG_CMD_NAND * NAND support
855 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600856 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000857 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500858 CONFIG_CMD_PCI * pciinfo
859 CONFIG_CMD_PCMCIA * PCMCIA support
860 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
861 host
862 CONFIG_CMD_PORTIO * Port I/O
863 CONFIG_CMD_REGINFO * Register dump
864 CONFIG_CMD_RUN run command in env variable
865 CONFIG_CMD_SAVES * save S record dump
866 CONFIG_CMD_SCSI * SCSI Support
867 CONFIG_CMD_SDRAM * print SDRAM configuration information
868 (requires CONFIG_CMD_I2C)
869 CONFIG_CMD_SETGETDCR Support for DCR Register access
870 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700871 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100872 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400873 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200874 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500875 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000876 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000877 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000878 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
879 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500880 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500881 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000882 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000883
wdenkc6097192002-11-03 00:24:07 +0000884
885 EXAMPLE: If you want all functions except of network
886 support you can write:
887
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500888 #include "config_cmd_all.h"
889 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000890
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400891 Other Commands:
892 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000893
894 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500895 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000896 what you (and your U-Boot users) are doing. Data
897 cache cannot be enabled on systems like the 8xx or
898 8260 (where accesses to the IMMR region must be
899 uncached), and it cannot be disabled on all other
900 systems where we (mis-) use the data cache to hold an
901 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000902
903
904 XXX - this list needs to get updated!
905
Simon Glass45ba8072011-10-15 05:48:20 +0000906- Device tree:
907 CONFIG_OF_CONTROL
908 If this variable is defined, U-Boot will use a device tree
909 to configure its devices, instead of relying on statically
910 compiled #defines in the board file. This option is
911 experimental and only available on a few boards. The device
912 tree is available in the global data as gd->fdt_blob.
913
Simon Glass2c0f79e2011-10-24 19:15:31 +0000914 U-Boot needs to get its device tree from somewhere. This can
915 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000916
917 CONFIG_OF_EMBED
918 If this variable is defined, U-Boot will embed a device tree
919 binary in its image. This device tree file should be in the
920 board directory and called <soc>-<board>.dts. The binary file
921 is then picked up in board_init_f() and made available through
922 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000923
Simon Glass2c0f79e2011-10-24 19:15:31 +0000924 CONFIG_OF_SEPARATE
925 If this variable is defined, U-Boot will build a device tree
926 binary. It will be called u-boot.dtb. Architecture-specific
927 code will locate it at run-time. Generally this works by:
928
929 cat u-boot.bin u-boot.dtb >image.bin
930
931 and in fact, U-Boot does this for you, creating a file called
932 u-boot-dtb.bin which is useful in the common case. You can
933 still use the individual files if you need something more
934 exotic.
935
wdenkc6097192002-11-03 00:24:07 +0000936- Watchdog:
937 CONFIG_WATCHDOG
938 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000939 support for the SoC. There must be support in the SoC
940 specific code for a watchdog. For the 8xx and 8260
941 CPUs, the SIU Watchdog feature is enabled in the SYPCR
942 register. When supported for a specific SoC is
943 available, then no further board specific code should
944 be needed to use it.
945
946 CONFIG_HW_WATCHDOG
947 When using a watchdog circuitry external to the used
948 SoC, then define this variable and provide board
949 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000950
stroesec1551ea2003-04-04 15:53:41 +0000951- U-Boot Version:
952 CONFIG_VERSION_VARIABLE
953 If this variable is defined, an environment variable
954 named "ver" is created by U-Boot showing the U-Boot
955 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200956 Any change to this variable will be reverted at the
957 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000958
wdenkc6097192002-11-03 00:24:07 +0000959- Real-Time Clock:
960
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500961 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000962 has to be selected, too. Define exactly one of the
963 following options:
964
965 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
966 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000967 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000968 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000969 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000970 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000971 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000972 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100973 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000974 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200975 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200976 CONFIG_SYS_RV3029_TCR - enable trickle charger on
977 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000978
wdenkb37c7e52003-06-30 16:24:52 +0000979 Note that if the RTC uses I2C, then the I2C interface
980 must also be configured. See I2C Support, below.
981
Peter Tysere92739d2008-12-17 16:36:21 -0600982- GPIO Support:
983 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
984 CONFIG_PCA953X_INFO - enable pca953x info command
985
Chris Packham5dec49c2010-12-19 10:12:13 +0000986 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
987 chip-ngpio pairs that tell the PCA953X driver the number of
988 pins supported by a particular chip.
989
Peter Tysere92739d2008-12-17 16:36:21 -0600990 Note that if the GPIO device uses I2C, then the I2C interface
991 must also be configured. See I2C Support, below.
992
wdenkc6097192002-11-03 00:24:07 +0000993- Timestamp Support:
994
wdenk43d96162003-03-06 00:02:04 +0000995 When CONFIG_TIMESTAMP is selected, the timestamp
996 (date and time) of an image is printed by image
997 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500998 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000999
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001000- Partition Labels (disklabels) Supported:
1001 Zero or more of the following:
1002 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1003 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1004 Intel architecture, USB sticks, etc.
1005 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1006 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1007 bootloader. Note 2TB partition limit; see
1008 disk/part_efi.c
1009 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001010
Wolfgang Denk218ca722008-03-26 10:40:12 +01001011 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1012 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001013 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001014
1015- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001016 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1017 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001018
wdenk4d13cba2004-03-14 14:09:05 +00001019 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1020 be performed by calling the function
1021 ide_set_reset(int reset)
1022 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001023
1024- ATAPI Support:
1025 CONFIG_ATAPI
1026
1027 Set this to enable ATAPI support.
1028
wdenkc40b2952004-03-13 23:29:43 +00001029- LBA48 Support
1030 CONFIG_LBA48
1031
1032 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001033 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001034 Whithout these , LBA48 support uses 32bit variables and will 'only'
1035 support disks up to 2.1TB.
1036
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001037 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001038 When enabled, makes the IDE subsystem use 64bit sector addresses.
1039 Default is 32bit.
1040
wdenkc6097192002-11-03 00:24:07 +00001041- SCSI Support:
1042 At the moment only there is only support for the
1043 SYM53C8XX SCSI controller; define
1044 CONFIG_SCSI_SYM53C8XX to enable it.
1045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001046 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1047 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1048 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001049 maximum numbers of LUNs, SCSI ID's and target
1050 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001051 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001052
Stefan Reinauer447c0312012-10-29 05:23:48 +00001053 The environment variable 'scsidevs' is set to the number of
1054 SCSI devices found during the last scan.
1055
wdenkc6097192002-11-03 00:24:07 +00001056- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001057 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001058 Support for Intel 8254x/8257x gigabit chips.
1059
1060 CONFIG_E1000_SPI
1061 Utility code for direct access to the SPI bus on Intel 8257x.
1062 This does not do anything useful unless you set at least one
1063 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1064
1065 CONFIG_E1000_SPI_GENERIC
1066 Allow generic access to the SPI bus on the Intel 8257x, for
1067 example with the "sspi" command.
1068
1069 CONFIG_CMD_E1000
1070 Management command for E1000 devices. When used on devices
1071 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001072
Andre Schwarzac3315c2008-03-06 16:45:44 +01001073 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001074 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001075
wdenkc6097192002-11-03 00:24:07 +00001076 CONFIG_EEPRO100
1077 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001078 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001079 write routine for first time initialisation.
1080
1081 CONFIG_TULIP
1082 Support for Digital 2114x chips.
1083 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1084 modem chip initialisation (KS8761/QS6611).
1085
1086 CONFIG_NATSEMI
1087 Support for National dp83815 chips.
1088
1089 CONFIG_NS8382X
1090 Support for National dp8382[01] gigabit chips.
1091
wdenk45219c42003-05-12 21:50:16 +00001092- NETWORK Support (other):
1093
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001094 CONFIG_DRIVER_AT91EMAC
1095 Support for AT91RM9200 EMAC.
1096
1097 CONFIG_RMII
1098 Define this to use reduced MII inteface
1099
1100 CONFIG_DRIVER_AT91EMAC_QUIET
1101 If this defined, the driver is quiet.
1102 The driver doen't show link status messages.
1103
Rob Herringefdd7312011-12-15 11:15:49 +00001104 CONFIG_CALXEDA_XGMAC
1105 Support for the Calxeda XGMAC device
1106
Ashok3bb46d22012-10-15 06:20:47 +00001107 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001108 Support for SMSC's LAN91C96 chips.
1109
1110 CONFIG_LAN91C96_BASE
1111 Define this to hold the physical address
1112 of the LAN91C96's I/O space
1113
1114 CONFIG_LAN91C96_USE_32_BIT
1115 Define this to enable 32 bit addressing
1116
Ashok3bb46d22012-10-15 06:20:47 +00001117 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001118 Support for SMSC's LAN91C111 chip
1119
1120 CONFIG_SMC91111_BASE
1121 Define this to hold the physical address
1122 of the device (I/O space)
1123
1124 CONFIG_SMC_USE_32_BIT
1125 Define this if data bus is 32 bits
1126
1127 CONFIG_SMC_USE_IOFUNCS
1128 Define this to use i/o functions instead of macros
1129 (some hardware wont work with macros)
1130
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001131 CONFIG_DRIVER_TI_EMAC
1132 Support for davinci emac
1133
1134 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1135 Define this if you have more then 3 PHYs.
1136
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001137 CONFIG_FTGMAC100
1138 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1139
1140 CONFIG_FTGMAC100_EGIGA
1141 Define this to use GE link update with gigabit PHY.
1142 Define this if FTGMAC100 is connected to gigabit PHY.
1143 If your system has 10/100 PHY only, it might not occur
1144 wrong behavior. Because PHY usually return timeout or
1145 useless data when polling gigabit status and gigabit
1146 control registers. This behavior won't affect the
1147 correctnessof 10/100 link speed update.
1148
Mike Rapoportc2fff332009-11-11 10:03:03 +02001149 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001150 Support for SMSC's LAN911x and LAN921x chips
1151
Mike Rapoportc2fff332009-11-11 10:03:03 +02001152 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001153 Define this to hold the physical address
1154 of the device (I/O space)
1155
Mike Rapoportc2fff332009-11-11 10:03:03 +02001156 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001157 Define this if data bus is 32 bits
1158
Mike Rapoportc2fff332009-11-11 10:03:03 +02001159 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001160 Define this if data bus is 16 bits. If your processor
1161 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001162 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001163
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001164 CONFIG_SH_ETHER
1165 Support for Renesas on-chip Ethernet controller
1166
1167 CONFIG_SH_ETHER_USE_PORT
1168 Define the number of ports to be used
1169
1170 CONFIG_SH_ETHER_PHY_ADDR
1171 Define the ETH PHY's address
1172
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001173 CONFIG_SH_ETHER_CACHE_WRITEBACK
1174 If this option is set, the driver enables cache flush.
1175
Vadim Bendebury5e124722011-10-17 08:36:14 +00001176- TPM Support:
1177 CONFIG_GENERIC_LPC_TPM
1178 Support for generic parallel port TPM devices. Only one device
1179 per system is supported at this time.
1180
1181 CONFIG_TPM_TIS_BASE_ADDRESS
1182 Base address where the generic TPM device is mapped
1183 to. Contemporary x86 systems usually map it at
1184 0xfed40000.
1185
wdenkc6097192002-11-03 00:24:07 +00001186- USB Support:
1187 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001188 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001189 CONFIG_USB_UHCI to enable it.
1190 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001191 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001192 storage devices.
1193 Note:
1194 Supported are USB Keyboards and USB Floppy drives
1195 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001196 MPC5200 USB requires additional defines:
1197 CONFIG_USB_CLOCK
1198 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001199 CONFIG_PSC3_USB
1200 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001201 CONFIG_USB_CONFIG
1202 for differential drivers: 0x00001000
1203 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001204 for differential drivers on PSC3: 0x00000100
1205 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001206 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001207 May be defined to allow interrupt polling
1208 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001209
Simon Glass9ab4ce22012-02-27 10:52:47 +00001210 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1211 txfilltuning field in the EHCI controller on reset.
1212
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001213- USB Device:
1214 Define the below if you wish to use the USB console.
1215 Once firmware is rebuilt from a serial console issue the
1216 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001217 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001218 it has found a new device. The environment variable usbtty
1219 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001220 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001221 Common Device Class Abstract Control Model serial device.
1222 If you select usbtty = gserial you should be able to enumerate
1223 a Linux host by
1224 # modprobe usbserial vendor=0xVendorID product=0xProductID
1225 else if using cdc_acm, simply setting the environment
1226 variable usbtty to be cdc_acm should suffice. The following
1227 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001228
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001229 CONFIG_USB_DEVICE
1230 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001231
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001232 CONFIG_USB_TTY
1233 Define this to have a tty type of device available to
1234 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001235
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301236 CONFIG_USBD_HS
1237 Define this to enable the high speed support for usb
1238 device and usbtty. If this feature is enabled, a routine
1239 int is_usbd_high_speed(void)
1240 also needs to be defined by the driver to dynamically poll
1241 whether the enumeration has succeded at high speed or full
1242 speed.
1243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001244 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001245 Define this if you want stdin, stdout &/or stderr to
1246 be set to usbtty.
1247
1248 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001249 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001250 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001251 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001253 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001254 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001255 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001256
Wolfgang Denk386eda02006-06-14 18:14:56 +02001257 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001258 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001259 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001260 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1261 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1262 should pretend to be a Linux device to it's target host.
1263
1264 CONFIG_USBD_MANUFACTURER
1265 Define this string as the name of your company for
1266 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001267
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001268 CONFIG_USBD_PRODUCT_NAME
1269 Define this string as the name of your product
1270 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1271
1272 CONFIG_USBD_VENDORID
1273 Define this as your assigned Vendor ID from the USB
1274 Implementors Forum. This *must* be a genuine Vendor ID
1275 to avoid polluting the USB namespace.
1276 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001277
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001278 CONFIG_USBD_PRODUCTID
1279 Define this as the unique Product ID
1280 for your device
1281 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001282
Igor Grinbergd70a5602011-12-12 12:08:35 +02001283- ULPI Layer Support:
1284 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1285 the generic ULPI layer. The generic layer accesses the ULPI PHY
1286 via the platform viewport, so you need both the genric layer and
1287 the viewport enabled. Currently only Chipidea/ARC based
1288 viewport is supported.
1289 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1290 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001291 If your ULPI phy needs a different reference clock than the
1292 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1293 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001294
1295- MMC Support:
1296 The MMC controller on the Intel PXA is supported. To
1297 enable this define CONFIG_MMC. The MMC can be
1298 accessed from the boot prompt by mapping the device
1299 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001300 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1301 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001302
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001303 CONFIG_SH_MMCIF
1304 Support for Renesas on-chip MMCIF controller
1305
1306 CONFIG_SH_MMCIF_ADDR
1307 Define the base address of MMCIF registers
1308
1309 CONFIG_SH_MMCIF_CLK
1310 Define the clock frequency for MMCIF
1311
wdenk6705d812004-08-02 23:22:59 +00001312- Journaling Flash filesystem support:
1313 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1314 CONFIG_JFFS2_NAND_DEV
1315 Define these for a default partition on a NAND device
1316
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001317 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1318 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001319 Define these for a default partition on a NOR device
1320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001321 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001322 Define this to create an own partition. You have to provide a
1323 function struct part_info* jffs2_part_info(int part_num)
1324
1325 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001326 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001327 to disable the command chpart. This is the default when you
1328 have not defined a custom partition
1329
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001330- FAT(File Allocation Table) filesystem write function support:
1331 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001332
1333 Define this to enable support for saving memory data as a
1334 file in FAT formatted partition.
1335
1336 This will also enable the command "fatwrite" enabling the
1337 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001338
Gabe Black84cd9322012-10-12 14:26:11 +00001339CBFS (Coreboot Filesystem) support
1340 CONFIG_CMD_CBFS
1341
1342 Define this to enable support for reading from a Coreboot
1343 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1344 and cbfsload.
1345
wdenkc6097192002-11-03 00:24:07 +00001346- Keyboard Support:
1347 CONFIG_ISA_KEYBOARD
1348
1349 Define this to enable standard (PC-Style) keyboard
1350 support
1351
1352 CONFIG_I8042_KBD
1353 Standard PC keyboard driver with US (is default) and
1354 GERMAN key layout (switch via environment 'keymap=de') support.
1355 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1356 for cfb_console. Supports cursor blinking.
1357
1358- Video support:
1359 CONFIG_VIDEO
1360
1361 Define this to enable video support (for output to
1362 video).
1363
1364 CONFIG_VIDEO_CT69000
1365
1366 Enable Chips & Technologies 69000 Video chip
1367
1368 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001369 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001370 video output is selected via environment 'videoout'
1371 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1372 assumed.
wdenkc6097192002-11-03 00:24:07 +00001373
wdenkb79a11c2004-03-25 15:14:43 +00001374 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001375 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001376 are possible:
1377 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001378 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001379
1380 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1381 -------------+---------------------------------------------
1382 8 bits | 0x301* 0x303 0x305 0x161 0x307
1383 15 bits | 0x310 0x313 0x316 0x162 0x319
1384 16 bits | 0x311 0x314 0x317 0x163 0x31A
1385 24 bits | 0x312 0x315 0x318 ? 0x31B
1386 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001387 (i.e. setenv videomode 317; saveenv; reset;)
1388
wdenkb79a11c2004-03-25 15:14:43 +00001389 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001390 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001391
1392
stroesec1551ea2003-04-04 15:53:41 +00001393 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001394 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001395 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1396 or CONFIG_VIDEO_SED13806_16BPP
1397
Timur Tabi7d3053f2011-02-15 17:09:19 -06001398 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001399 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001400 SOCs that have a DIU should define this macro to enable DIU
1401 support, and should also define these other macros:
1402
1403 CONFIG_SYS_DIU_ADDR
1404 CONFIG_VIDEO
1405 CONFIG_CMD_BMP
1406 CONFIG_CFB_CONSOLE
1407 CONFIG_VIDEO_SW_CURSOR
1408 CONFIG_VGA_AS_SINGLE_DEVICE
1409 CONFIG_VIDEO_LOGO
1410 CONFIG_VIDEO_BMP_LOGO
1411
Timur Tabiba8e76b2011-04-11 14:18:22 -05001412 The DIU driver will look for the 'video-mode' environment
1413 variable, and if defined, enable the DIU as a console during
1414 boot. See the documentation file README.video for a
1415 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001416
wdenk682011f2003-06-03 23:54:09 +00001417- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001418 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001419
wdenk8bde7f72003-06-27 21:31:46 +00001420 Define this to enable a custom keyboard support.
1421 This simply calls drv_keyboard_init() which must be
1422 defined in your board-specific files.
1423 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001424
wdenkc6097192002-11-03 00:24:07 +00001425- LCD Support: CONFIG_LCD
1426
1427 Define this to enable LCD support (for output to LCD
1428 display); also select one of the supported displays
1429 by defining one of these:
1430
Stelian Pop39cf4802008-05-09 21:57:18 +02001431 CONFIG_ATMEL_LCD:
1432
1433 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1434
wdenkfd3103b2003-11-25 16:55:19 +00001435 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001436
wdenkfd3103b2003-11-25 16:55:19 +00001437 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001438
wdenkfd3103b2003-11-25 16:55:19 +00001439 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001440
wdenkfd3103b2003-11-25 16:55:19 +00001441 NEC NL6448BC20-08. 6.5", 640x480.
1442 Active, color, single scan.
1443
1444 CONFIG_NEC_NL6448BC33_54
1445
1446 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001447 Active, color, single scan.
1448
1449 CONFIG_SHARP_16x9
1450
1451 Sharp 320x240. Active, color, single scan.
1452 It isn't 16x9, and I am not sure what it is.
1453
1454 CONFIG_SHARP_LQ64D341
1455
1456 Sharp LQ64D341 display, 640x480.
1457 Active, color, single scan.
1458
1459 CONFIG_HLD1045
1460
1461 HLD1045 display, 640x480.
1462 Active, color, single scan.
1463
1464 CONFIG_OPTREX_BW
1465
1466 Optrex CBL50840-2 NF-FW 99 22 M5
1467 or
1468 Hitachi LMG6912RPFC-00T
1469 or
1470 Hitachi SP14Q002
1471
1472 320x240. Black & white.
1473
1474 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001475 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001476
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001477 CONFIG_LCD_BMP_RLE8
1478
1479 Support drawing of RLE8-compressed bitmaps on the LCD.
1480
1481
wdenk7152b1d2003-09-05 23:19:14 +00001482- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001483
wdenk8bde7f72003-06-27 21:31:46 +00001484 If this option is set, the environment is checked for
1485 a variable "splashimage". If found, the usual display
1486 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001487 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001488 specified in "splashimage" is loaded instead. The
1489 console is redirected to the "nulldev", too. This
1490 allows for a "silent" boot where a splash screen is
1491 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001492
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001493 CONFIG_SPLASH_SCREEN_ALIGN
1494
1495 If this option is set the splash image can be freely positioned
1496 on the screen. Environment variable "splashpos" specifies the
1497 position as "x,y". If a positive number is given it is used as
1498 number of pixel from left/top. If a negative number is given it
1499 is used as number of pixel from right/bottom. You can also
1500 specify 'm' for centering the image.
1501
1502 Example:
1503 setenv splashpos m,m
1504 => image at center of screen
1505
1506 setenv splashpos 30,20
1507 => image at x = 30 and y = 20
1508
1509 setenv splashpos -10,m
1510 => vertically centered image
1511 at x = dspWidth - bmpWidth - 9
1512
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001513- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1514
1515 If this option is set, additionally to standard BMP
1516 images, gzipped BMP images can be displayed via the
1517 splashscreen support or the bmp command.
1518
Anatolij Gustschind5011762010-03-15 14:50:25 +01001519- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1520
1521 If this option is set, 8-bit RLE compressed BMP images
1522 can be displayed via the splashscreen support or the
1523 bmp command.
1524
Lei Wenf2b96df2012-09-28 04:26:47 +00001525- Do compresssing for memory range:
1526 CONFIG_CMD_ZIP
1527
1528 If this option is set, it would use zlib deflate method
1529 to compress the specified memory at its best effort.
1530
wdenkc29fdfc2003-08-29 20:57:53 +00001531- Compression support:
1532 CONFIG_BZIP2
1533
1534 If this option is set, support for bzip2 compressed
1535 images is included. If not, only uncompressed and gzip
1536 compressed images are supported.
1537
wdenk42d1f032003-10-15 23:53:47 +00001538 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001539 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001540 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001541
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001542 CONFIG_LZMA
1543
1544 If this option is set, support for lzma compressed
1545 images is included.
1546
1547 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1548 requires an amount of dynamic memory that is given by the
1549 formula:
1550
1551 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1552
1553 Where lc and lp stand for, respectively, Literal context bits
1554 and Literal pos bits.
1555
1556 This value is upper-bounded by 14MB in the worst case. Anyway,
1557 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1558 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1559 a very small buffer.
1560
1561 Use the lzmainfo tool to determinate the lc and lp values and
1562 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001563 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001564
wdenk17ea1172004-06-06 21:51:03 +00001565- MII/PHY support:
1566 CONFIG_PHY_ADDR
1567
1568 The address of PHY on MII bus.
1569
1570 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1571
1572 The clock frequency of the MII bus
1573
1574 CONFIG_PHY_GIGE
1575
1576 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001577 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001578
1579 CONFIG_PHY_RESET_DELAY
1580
1581 Some PHY like Intel LXT971A need extra delay after
1582 reset before any MII register access is possible.
1583 For such PHY, set this option to the usec delay
1584 required. (minimum 300usec for LXT971A)
1585
1586 CONFIG_PHY_CMD_DELAY (ppc4xx)
1587
1588 Some PHY like Intel LXT971A need extra delay after
1589 command issued before MII status register can be read
1590
wdenkc6097192002-11-03 00:24:07 +00001591- Ethernet address:
1592 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001593 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001594 CONFIG_ETH2ADDR
1595 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001596 CONFIG_ETH4ADDR
1597 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001598
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001599 Define a default value for Ethernet address to use
1600 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001601 is not determined automatically.
1602
1603- IP address:
1604 CONFIG_IPADDR
1605
1606 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001607 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001608 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001609 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001610
1611- Server IP address:
1612 CONFIG_SERVERIP
1613
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001614 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001615 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001616 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001617
Robin Getz97cfe862009-07-21 12:15:28 -04001618 CONFIG_KEEP_SERVERADDR
1619
1620 Keeps the server's MAC address, in the env 'serveraddr'
1621 for passing to bootargs (like Linux's netconsole option)
1622
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001623- Gateway IP address:
1624 CONFIG_GATEWAYIP
1625
1626 Defines a default value for the IP address of the
1627 default router where packets to other networks are
1628 sent to.
1629 (Environment variable "gatewayip")
1630
1631- Subnet mask:
1632 CONFIG_NETMASK
1633
1634 Defines a default value for the subnet mask (or
1635 routing prefix) which is used to determine if an IP
1636 address belongs to the local subnet or needs to be
1637 forwarded through a router.
1638 (Environment variable "netmask")
1639
David Updegraff53a5c422007-06-11 10:41:07 -05001640- Multicast TFTP Mode:
1641 CONFIG_MCAST_TFTP
1642
1643 Defines whether you want to support multicast TFTP as per
1644 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001645 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001646 driver in use must provide a function: mcast() to join/leave a
1647 multicast group.
1648
wdenkc6097192002-11-03 00:24:07 +00001649- BOOTP Recovery Mode:
1650 CONFIG_BOOTP_RANDOM_DELAY
1651
1652 If you have many targets in a network that try to
1653 boot using BOOTP, you may want to avoid that all
1654 systems send out BOOTP requests at precisely the same
1655 moment (which would happen for instance at recovery
1656 from a power failure, when all systems will try to
1657 boot, thus flooding the BOOTP server. Defining
1658 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1659 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001660 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001661
1662 1st BOOTP request: delay 0 ... 1 sec
1663 2nd BOOTP request: delay 0 ... 2 sec
1664 3rd BOOTP request: delay 0 ... 4 sec
1665 4th and following
1666 BOOTP requests: delay 0 ... 8 sec
1667
stroesefe389a82003-08-28 14:17:32 +00001668- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001669 You can fine tune the DHCP functionality by defining
1670 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001671
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001672 CONFIG_BOOTP_SUBNETMASK
1673 CONFIG_BOOTP_GATEWAY
1674 CONFIG_BOOTP_HOSTNAME
1675 CONFIG_BOOTP_NISDOMAIN
1676 CONFIG_BOOTP_BOOTPATH
1677 CONFIG_BOOTP_BOOTFILESIZE
1678 CONFIG_BOOTP_DNS
1679 CONFIG_BOOTP_DNS2
1680 CONFIG_BOOTP_SEND_HOSTNAME
1681 CONFIG_BOOTP_NTPSERVER
1682 CONFIG_BOOTP_TIMEOFFSET
1683 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001684 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001685
Wilson Callan5d110f02007-07-28 10:56:13 -04001686 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1687 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001688
Joe Hershberger2c00e092012-05-23 07:59:19 +00001689 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1690 after the configured retry count, the call will fail
1691 instead of starting over. This can be used to fail over
1692 to Link-local IP address configuration if the DHCP server
1693 is not available.
1694
stroesefe389a82003-08-28 14:17:32 +00001695 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1696 serverip from a DHCP server, it is possible that more
1697 than one DNS serverip is offered to the client.
1698 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1699 serverip will be stored in the additional environment
1700 variable "dnsip2". The first DNS serverip is always
1701 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001702 is defined.
stroesefe389a82003-08-28 14:17:32 +00001703
1704 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1705 to do a dynamic update of a DNS server. To do this, they
1706 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001707 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001708 of the "hostname" environment variable is passed as
1709 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001710
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001711 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1712
1713 A 32bit value in microseconds for a delay between
1714 receiving a "DHCP Offer" and sending the "DHCP Request".
1715 This fixes a problem with certain DHCP servers that don't
1716 respond 100% of the time to a "DHCP request". E.g. On an
1717 AT91RM9200 processor running at 180MHz, this delay needed
1718 to be *at least* 15,000 usec before a Windows Server 2003
1719 DHCP server would reply 100% of the time. I recommend at
1720 least 50,000 usec to be safe. The alternative is to hope
1721 that one of the retries will be successful but note that
1722 the DHCP timeout and retry process takes a longer than
1723 this delay.
1724
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001725 - Link-local IP address negotiation:
1726 Negotiate with other link-local clients on the local network
1727 for an address that doesn't require explicit configuration.
1728 This is especially useful if a DHCP server cannot be guaranteed
1729 to exist in all environments that the device must operate.
1730
1731 See doc/README.link-local for more information.
1732
wdenka3d991b2004-04-15 21:48:45 +00001733 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001734 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001735
1736 The device id used in CDP trigger frames.
1737
1738 CONFIG_CDP_DEVICE_ID_PREFIX
1739
1740 A two character string which is prefixed to the MAC address
1741 of the device.
1742
1743 CONFIG_CDP_PORT_ID
1744
1745 A printf format string which contains the ascii name of
1746 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001747 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001748
1749 CONFIG_CDP_CAPABILITIES
1750
1751 A 32bit integer which indicates the device capabilities;
1752 0x00000010 for a normal host which does not forwards.
1753
1754 CONFIG_CDP_VERSION
1755
1756 An ascii string containing the version of the software.
1757
1758 CONFIG_CDP_PLATFORM
1759
1760 An ascii string containing the name of the platform.
1761
1762 CONFIG_CDP_TRIGGER
1763
1764 A 32bit integer sent on the trigger.
1765
1766 CONFIG_CDP_POWER_CONSUMPTION
1767
1768 A 16bit integer containing the power consumption of the
1769 device in .1 of milliwatts.
1770
1771 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1772
1773 A byte containing the id of the VLAN.
1774
wdenkc6097192002-11-03 00:24:07 +00001775- Status LED: CONFIG_STATUS_LED
1776
1777 Several configurations allow to display the current
1778 status using a LED. For instance, the LED will blink
1779 fast while running U-Boot code, stop blinking as
1780 soon as a reply to a BOOTP request was received, and
1781 start blinking slow once the Linux kernel is running
1782 (supported by a status LED driver in the Linux
1783 kernel). Defining CONFIG_STATUS_LED enables this
1784 feature in U-Boot.
1785
1786- CAN Support: CONFIG_CAN_DRIVER
1787
1788 Defining CONFIG_CAN_DRIVER enables CAN driver support
1789 on those systems that support this (optional)
1790 feature, like the TQM8xxL modules.
1791
1792- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1793
wdenkb37c7e52003-06-30 16:24:52 +00001794 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001795 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001796 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001797
wdenk945af8d2003-07-16 21:53:01 +00001798 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001799 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001800 CONFIG_COMMANDS) and communicate with i2c based realtime
1801 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001802 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001803
Ben Warrenbb99ad62006-09-07 16:50:54 -04001804 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001805
wdenk945af8d2003-07-16 21:53:01 +00001806 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001807 bit-banging) driver instead of CPM or similar hardware
1808 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001809
wdenk945af8d2003-07-16 21:53:01 +00001810 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001811 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001814 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001815 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001816 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001817
Peter Tyser8d321b82010-04-12 22:28:21 -05001818 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001819 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001820 and so its address should therefore be cleared to 0 (See,
1821 eg, MPC823e User's Manual p.16-473). So, set
1822 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001823
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001824 CONFIG_SYS_I2C_INIT_MPC5XXX
1825
1826 When a board is reset during an i2c bus transfer
1827 chips might think that the current transfer is still
1828 in progress. Reset the slave devices by sending start
1829 commands until the slave device responds.
1830
wdenk945af8d2003-07-16 21:53:01 +00001831 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001832
1833 If you use the software i2c interface (CONFIG_SOFT_I2C)
1834 then the following macros need to be defined (examples are
1835 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001836
1837 I2C_INIT
1838
wdenkb37c7e52003-06-30 16:24:52 +00001839 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001840 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001841
wdenkba56f622004-02-06 23:19:44 +00001842 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001843
wdenkc6097192002-11-03 00:24:07 +00001844 I2C_PORT
1845
wdenk43d96162003-03-06 00:02:04 +00001846 (Only for MPC8260 CPU). The I/O port to use (the code
1847 assumes both bits are on the same port). Valid values
1848 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001849
1850 I2C_ACTIVE
1851
1852 The code necessary to make the I2C data line active
1853 (driven). If the data line is open collector, this
1854 define can be null.
1855
wdenkb37c7e52003-06-30 16:24:52 +00001856 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1857
wdenkc6097192002-11-03 00:24:07 +00001858 I2C_TRISTATE
1859
1860 The code necessary to make the I2C data line tri-stated
1861 (inactive). If the data line is open collector, this
1862 define can be null.
1863
wdenkb37c7e52003-06-30 16:24:52 +00001864 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1865
wdenkc6097192002-11-03 00:24:07 +00001866 I2C_READ
1867
1868 Code that returns TRUE if the I2C data line is high,
1869 FALSE if it is low.
1870
wdenkb37c7e52003-06-30 16:24:52 +00001871 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1872
wdenkc6097192002-11-03 00:24:07 +00001873 I2C_SDA(bit)
1874
1875 If <bit> is TRUE, sets the I2C data line high. If it
1876 is FALSE, it clears it (low).
1877
wdenkb37c7e52003-06-30 16:24:52 +00001878 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001879 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001880 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001881
wdenkc6097192002-11-03 00:24:07 +00001882 I2C_SCL(bit)
1883
1884 If <bit> is TRUE, sets the I2C clock line high. If it
1885 is FALSE, it clears it (low).
1886
wdenkb37c7e52003-06-30 16:24:52 +00001887 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001888 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001889 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001890
wdenkc6097192002-11-03 00:24:07 +00001891 I2C_DELAY
1892
1893 This delay is invoked four times per clock cycle so this
1894 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001895 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001896 like:
1897
wdenkb37c7e52003-06-30 16:24:52 +00001898 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001899
Mike Frysinger793b5722010-07-21 13:38:02 -04001900 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1901
1902 If your arch supports the generic GPIO framework (asm/gpio.h),
1903 then you may alternatively define the two GPIOs that are to be
1904 used as SCL / SDA. Any of the previous I2C_xxx macros will
1905 have GPIO-based defaults assigned to them as appropriate.
1906
1907 You should define these to the GPIO value as given directly to
1908 the generic GPIO functions.
1909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001910 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001911
wdenk8bde7f72003-06-27 21:31:46 +00001912 When a board is reset during an i2c bus transfer
1913 chips might think that the current transfer is still
1914 in progress. On some boards it is possible to access
1915 the i2c SCLK line directly, either by using the
1916 processor pin as a GPIO or by having a second pin
1917 connected to the bus. If this option is defined a
1918 custom i2c_init_board() routine in boards/xxx/board.c
1919 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001920
Richard Retanubun26a33502010-04-12 15:08:17 -04001921 CONFIG_SYS_I2C_BOARD_LATE_INIT
1922
1923 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1924 defined a custom i2c_board_late_init() routine in
1925 boards/xxx/board.c is run AFTER the operations in i2c_init()
1926 is completed. This callpoint can be used to unreset i2c bus
1927 using CPU i2c controller register accesses for CPUs whose i2c
1928 controller provide such a method. It is called at the end of
1929 i2c_init() to allow i2c_init operations to setup the i2c bus
1930 controller on the CPU (e.g. setting bus speed & slave address).
1931
wdenk17ea1172004-06-06 21:51:03 +00001932 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1933
1934 This option enables configuration of bi_iic_fast[] flags
1935 in u-boot bd_info structure based on u-boot environment
1936 variable "i2cfast". (see also i2cfast)
1937
Ben Warrenbb99ad62006-09-07 16:50:54 -04001938 CONFIG_I2C_MULTI_BUS
1939
1940 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001941 must have a controller. At any point in time, only one bus is
1942 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001943 Note that bus numbering is zero-based.
1944
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001945 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001946
1947 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001948 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001949 is set, specify a list of bus-device pairs. Otherwise, specify
1950 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001951
1952 e.g.
1953 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001954 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001955
1956 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1957
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001958 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001959 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001960
1961 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001963 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001964
1965 If defined, then this indicates the I2C bus number for DDR SPD.
1966 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001968 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001969
1970 If defined, then this indicates the I2C bus number for the RTC.
1971 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1972
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001973 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001974
1975 If defined, then this indicates the I2C bus number for the DTT.
1976 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001978 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001979
1980 If defined, specifies the I2C address of the DTT device.
1981 If not defined, then U-Boot uses predefined value for
1982 specified DTT device.
1983
Timur Tabibe5e6182006-11-03 19:15:00 -06001984 CONFIG_FSL_I2C
1985
1986 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001987 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001988
Heiko Schocher67b23a32008-10-15 09:39:47 +02001989 CONFIG_I2C_MUX
1990
1991 Define this option if you have I2C devices reached over 1 .. n
1992 I2C Muxes like the pca9544a. This option addes a new I2C
1993 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1994 new I2C Bus to the existing I2C Busses. If you select the
1995 new Bus with "i2c dev", u-bbot sends first the commandos for
1996 the muxes to activate this new "bus".
1997
1998 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1999 feature!
2000
2001 Example:
2002 Adding a new I2C Bus reached over 2 pca9544a muxes
2003 The First mux with address 70 and channel 6
2004 The Second mux with address 71 and channel 4
2005
2006 => i2c bus pca9544a:70:6:pca9544a:71:4
2007
2008 Use the "i2c bus" command without parameter, to get a list
2009 of I2C Busses with muxes:
2010
2011 => i2c bus
2012 Busses reached over muxes:
2013 Bus ID: 2
2014 reached over Mux(es):
2015 pca9544a@70 ch: 4
2016 Bus ID: 3
2017 reached over Mux(es):
2018 pca9544a@70 ch: 6
2019 pca9544a@71 ch: 4
2020 =>
2021
2022 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002023 u-boot first sends the command to the mux@70 to enable
2024 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002025 the channel 4.
2026
2027 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002028 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002029 the 2 muxes.
2030
2031 This option is actually implemented for the bitbanging
2032 algorithm in common/soft_i2c.c and for the Hardware I2C
2033 Bus on the MPC8260. But it should be not so difficult
2034 to add this option to other architectures.
2035
Andrew Dyer2ac69852008-12-29 17:36:01 -06002036 CONFIG_SOFT_I2C_READ_REPEATED_START
2037
2038 defining this will force the i2c_read() function in
2039 the soft_i2c driver to perform an I2C repeated start
2040 between writing the address pointer and reading the
2041 data. If this define is omitted the default behaviour
2042 of doing a stop-start sequence will be used. Most I2C
2043 devices can use either method, but some require one or
2044 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002045
wdenkc6097192002-11-03 00:24:07 +00002046- SPI Support: CONFIG_SPI
2047
2048 Enables SPI driver (so far only tested with
2049 SPI EEPROM, also an instance works with Crystal A/D and
2050 D/As on the SACSng board)
2051
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002052 CONFIG_SH_SPI
2053
2054 Enables the driver for SPI controller on SuperH. Currently
2055 only SH7757 is supported.
2056
wdenkc6097192002-11-03 00:24:07 +00002057 CONFIG_SPI_X
2058
2059 Enables extended (16-bit) SPI EEPROM addressing.
2060 (symmetrical to CONFIG_I2C_X)
2061
2062 CONFIG_SOFT_SPI
2063
wdenk43d96162003-03-06 00:02:04 +00002064 Enables a software (bit-bang) SPI driver rather than
2065 using hardware support. This is a general purpose
2066 driver that only requires three general I/O port pins
2067 (two outputs, one input) to function. If this is
2068 defined, the board configuration must define several
2069 SPI configuration items (port pins to use, etc). For
2070 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002071
Ben Warren04a9e112008-01-16 22:37:35 -05002072 CONFIG_HARD_SPI
2073
2074 Enables a hardware SPI driver for general-purpose reads
2075 and writes. As with CONFIG_SOFT_SPI, the board configuration
2076 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002077 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002078 example, see include/configs/mpc8349emds.h.
2079
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002080 CONFIG_MXC_SPI
2081
2082 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002083 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002084
Matthias Fuchs01335022007-12-27 17:12:34 +01002085- FPGA Support: CONFIG_FPGA
2086
2087 Enables FPGA subsystem.
2088
2089 CONFIG_FPGA_<vendor>
2090
2091 Enables support for specific chip vendors.
2092 (ALTERA, XILINX)
2093
2094 CONFIG_FPGA_<family>
2095
2096 Enables support for FPGA family.
2097 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2098
2099 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002100
wdenk43d96162003-03-06 00:02:04 +00002101 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002103 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002104
wdenk8bde7f72003-06-27 21:31:46 +00002105 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002106
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002107 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002108
wdenk43d96162003-03-06 00:02:04 +00002109 Enable checks on FPGA configuration interface busy
2110 status by the configuration function. This option
2111 will require a board or device specific function to
2112 be written.
wdenkc6097192002-11-03 00:24:07 +00002113
2114 CONFIG_FPGA_DELAY
2115
2116 If defined, a function that provides delays in the FPGA
2117 configuration driver.
2118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002119 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002120 Allow Control-C to interrupt FPGA configuration
2121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002122 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002123
wdenk43d96162003-03-06 00:02:04 +00002124 Check for configuration errors during FPGA bitfile
2125 loading. For example, abort during Virtex II
2126 configuration if the INIT_B line goes low (which
2127 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002128
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002129 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002130
wdenk43d96162003-03-06 00:02:04 +00002131 Maximum time to wait for the INIT_B line to deassert
2132 after PROB_B has been deasserted during a Virtex II
2133 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002134 ms.
wdenkc6097192002-11-03 00:24:07 +00002135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002136 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002137
wdenk43d96162003-03-06 00:02:04 +00002138 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002139 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002141 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002142
wdenk43d96162003-03-06 00:02:04 +00002143 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002145
2146- Configuration Management:
2147 CONFIG_IDENT_STRING
2148
wdenk43d96162003-03-06 00:02:04 +00002149 If defined, this string will be added to the U-Boot
2150 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002151
2152- Vendor Parameter Protection:
2153
wdenk43d96162003-03-06 00:02:04 +00002154 U-Boot considers the values of the environment
2155 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002156 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002157 are set once by the board vendor / manufacturer, and
2158 protects these variables from casual modification by
2159 the user. Once set, these variables are read-only,
2160 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002161 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002162
2163 If CONFIG_ENV_OVERWRITE is #defined in your config
2164 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002165 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002166 these parameters.
2167
2168 Alternatively, if you #define _both_ CONFIG_ETHADDR
2169 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002170 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002171 which can be changed exactly ONCE by the user. [The
2172 serial# is unaffected by this, i. e. it remains
2173 read-only.]
2174
2175- Protected RAM:
2176 CONFIG_PRAM
2177
2178 Define this variable to enable the reservation of
2179 "protected RAM", i. e. RAM which is not overwritten
2180 by U-Boot. Define CONFIG_PRAM to hold the number of
2181 kB you want to reserve for pRAM. You can overwrite
2182 this default value by defining an environment
2183 variable "pram" to the number of kB you want to
2184 reserve. Note that the board info structure will
2185 still show the full amount of RAM. If pRAM is
2186 reserved, a new environment variable "mem" will
2187 automatically be defined to hold the amount of
2188 remaining RAM in a form that can be passed as boot
2189 argument to Linux, for instance like that:
2190
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002191 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002192 saveenv
2193
2194 This way you can tell Linux not to use this memory,
2195 either, which results in a memory region that will
2196 not be affected by reboots.
2197
2198 *WARNING* If your board configuration uses automatic
2199 detection of the RAM size, you must make sure that
2200 this memory test is non-destructive. So far, the
2201 following board configurations are known to be
2202 "pRAM-clean":
2203
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002204 IVMS8, IVML24, SPD8xx, TQM8xxL,
2205 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002206 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002207
2208- Error Recovery:
2209 CONFIG_PANIC_HANG
2210
2211 Define this variable to stop the system in case of a
2212 fatal error, so that you have to reset it manually.
2213 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002214 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002215 automatically as fast as possible, but it may be
2216 useful during development since you can try to debug
2217 the conditions that lead to the situation.
2218
2219 CONFIG_NET_RETRY_COUNT
2220
wdenk43d96162003-03-06 00:02:04 +00002221 This variable defines the number of retries for
2222 network operations like ARP, RARP, TFTP, or BOOTP
2223 before giving up the operation. If not defined, a
2224 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002225
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002226 CONFIG_ARP_TIMEOUT
2227
2228 Timeout waiting for an ARP reply in milliseconds.
2229
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002230 CONFIG_NFS_TIMEOUT
2231
2232 Timeout in milliseconds used in NFS protocol.
2233 If you encounter "ERROR: Cannot umount" in nfs command,
2234 try longer timeout such as
2235 #define CONFIG_NFS_TIMEOUT 10000UL
2236
wdenkc6097192002-11-03 00:24:07 +00002237- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002238 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002239
2240 Enable auto completion of commands using TAB.
2241
Wolfgang Denka9398e02006-11-27 15:32:42 +01002242 Note that this feature has NOT been implemented yet
2243 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002244
2245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002246 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002247
2248 Define this variable to enable the "hush" shell (from
2249 Busybox) as command line interpreter, thus enabling
2250 powerful command line syntax like
2251 if...then...else...fi conditionals or `&&' and '||'
2252 constructs ("shell scripts").
2253
2254 If undefined, you get the old, much simpler behaviour
2255 with a somewhat smaller memory footprint.
2256
2257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002258 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002259
2260 This defines the secondary prompt string, which is
2261 printed when the command interpreter needs more input
2262 to complete a command. Usually "> ".
2263
2264 Note:
2265
wdenk8bde7f72003-06-27 21:31:46 +00002266 In the current implementation, the local variables
2267 space and global environment variables space are
2268 separated. Local variables are those you define by
2269 simply typing `name=value'. To access a local
2270 variable later on, you have write `$name' or
2271 `${name}'; to execute the contents of a variable
2272 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002273
wdenk43d96162003-03-06 00:02:04 +00002274 Global environment variables are those you use
2275 setenv/printenv to work with. To run a command stored
2276 in such a variable, you need to use the run command,
2277 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002278
2279 To store commands and special characters in a
2280 variable, please use double quotation marks
2281 surrounding the whole text of the variable, instead
2282 of the backslashes before semicolons and special
2283 symbols.
2284
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002285- Commandline Editing and History:
2286 CONFIG_CMDLINE_EDITING
2287
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002288 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002289 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002290
wdenka8c7c702003-12-06 19:49:23 +00002291- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002292 CONFIG_EXTRA_ENV_SETTINGS
2293
wdenk43d96162003-03-06 00:02:04 +00002294 Define this to contain any number of null terminated
2295 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002296 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002297
wdenk43d96162003-03-06 00:02:04 +00002298 For example, place something like this in your
2299 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002300
2301 #define CONFIG_EXTRA_ENV_SETTINGS \
2302 "myvar1=value1\0" \
2303 "myvar2=value2\0"
2304
wdenk43d96162003-03-06 00:02:04 +00002305 Warning: This method is based on knowledge about the
2306 internal format how the environment is stored by the
2307 U-Boot code. This is NOT an official, exported
2308 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002309 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002310 You better know what you are doing here.
2311
wdenk43d96162003-03-06 00:02:04 +00002312 Note: overly (ab)use of the default environment is
2313 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002314 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002315 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002316
Stephen Warren5e724ca2012-05-22 09:21:54 +00002317 CONFIG_ENV_VARS_UBOOT_CONFIG
2318
2319 Define this in order to add variables describing the
2320 U-Boot build configuration to the default environment.
2321 These will be named arch, cpu, board, vendor, and soc.
2322
2323 Enabling this option will cause the following to be defined:
2324
2325 - CONFIG_SYS_ARCH
2326 - CONFIG_SYS_CPU
2327 - CONFIG_SYS_BOARD
2328 - CONFIG_SYS_VENDOR
2329 - CONFIG_SYS_SOC
2330
Tom Rini7e27f892012-10-24 07:28:16 +00002331 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2332
2333 Define this in order to add variables describing certain
2334 run-time determined information about the hardware to the
2335 environment. These will be named board_name, board_rev.
2336
wdenka8c7c702003-12-06 19:49:23 +00002337- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002338 CONFIG_HAS_DATAFLASH
2339
wdenk8bde7f72003-06-27 21:31:46 +00002340 Defining this option enables DataFlash features and
2341 allows to read/write in Dataflash via the standard
2342 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002343
Eric Nelsonf61ec452012-01-31 10:52:08 -07002344- Serial Flash support
2345 CONFIG_CMD_SF
2346
2347 Defining this option enables SPI flash commands
2348 'sf probe/read/write/erase/update'.
2349
2350 Usage requires an initial 'probe' to define the serial
2351 flash parameters, followed by read/write/erase/update
2352 commands.
2353
2354 The following defaults may be provided by the platform
2355 to handle the common case when only a single serial
2356 flash is present on the system.
2357
2358 CONFIG_SF_DEFAULT_BUS Bus identifier
2359 CONFIG_SF_DEFAULT_CS Chip-select
2360 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2361 CONFIG_SF_DEFAULT_SPEED in Hz
2362
wdenk3f85ce22004-02-23 16:11:30 +00002363- SystemACE Support:
2364 CONFIG_SYSTEMACE
2365
2366 Adding this option adds support for Xilinx SystemACE
2367 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002368 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002369 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002370
2371 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002372 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002373
2374 When SystemACE support is added, the "ace" device type
2375 becomes available to the fat commands, i.e. fatls.
2376
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002377- TFTP Fixed UDP Port:
2378 CONFIG_TFTP_PORT
2379
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002380 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002381 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002382 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002383 number generator is used.
2384
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002385 Also, the environment variable tftpdstp is used to supply
2386 the TFTP UDP destination port value. If tftpdstp isn't
2387 defined, the normal port 69 is used.
2388
2389 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002390 blindly start the TFTP transfer using the pre-configured
2391 target IP address and UDP port. This has the effect of
2392 "punching through" the (Windows XP) firewall, allowing
2393 the remainder of the TFTP transfer to proceed normally.
2394 A better solution is to properly configure the firewall,
2395 but sometimes that is not allowed.
2396
wdenka8c7c702003-12-06 19:49:23 +00002397- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002398 CONFIG_SHOW_BOOT_PROGRESS
2399
wdenk43d96162003-03-06 00:02:04 +00002400 Defining this option allows to add some board-
2401 specific code (calling a user-provided function
2402 "show_boot_progress(int)") that enables you to show
2403 the system's boot progress on some display (for
2404 example, some LED's) on your board. At the moment,
2405 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002406
Simon Glass3a608ca2012-02-13 13:51:19 +00002407- Detailed boot stage timing
2408 CONFIG_BOOTSTAGE
2409 Define this option to get detailed timing of each stage
2410 of the boot process.
2411
2412 CONFIG_BOOTSTAGE_USER_COUNT
2413 This is the number of available user bootstage records.
2414 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2415 a new ID will be allocated from this stash. If you exceed
2416 the limit, recording will stop.
2417
2418 CONFIG_BOOTSTAGE_REPORT
2419 Define this to print a report before boot, similar to this:
2420
2421 Timer summary in microseconds:
2422 Mark Elapsed Stage
2423 0 0 reset
2424 3,575,678 3,575,678 board_init_f start
2425 3,575,695 17 arch_cpu_init A9
2426 3,575,777 82 arch_cpu_init done
2427 3,659,598 83,821 board_init_r start
2428 3,910,375 250,777 main_loop
2429 29,916,167 26,005,792 bootm_start
2430 30,361,327 445,160 start_kernel
2431
Simon Glass2eba38c2012-09-28 08:56:39 +00002432 CONFIG_CMD_BOOTSTAGE
2433 Add a 'bootstage' command which supports printing a report
2434 and un/stashing of bootstage data.
2435
Simon Glass94fd1312012-09-28 08:56:37 +00002436 CONFIG_BOOTSTAGE_FDT
2437 Stash the bootstage information in the FDT. A root 'bootstage'
2438 node is created with each bootstage id as a child. Each child
2439 has a 'name' property and either 'mark' containing the
2440 mark time in microsecond, or 'accum' containing the
2441 accumulated time for that bootstage id in microseconds.
2442 For example:
2443
2444 bootstage {
2445 154 {
2446 name = "board_init_f";
2447 mark = <3575678>;
2448 };
2449 170 {
2450 name = "lcd";
2451 accum = <33482>;
2452 };
2453 };
2454
2455 Code in the Linux kernel can find this in /proc/devicetree.
2456
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002457Legacy uImage format:
2458
wdenkc6097192002-11-03 00:24:07 +00002459 Arg Where When
2460 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002461 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002462 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002463 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002464 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002465 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002466 4 common/cmd_bootm.c Image data has correct checksum
2467 -4 common/cmd_bootm.c Image is for unsupported architecture
2468 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002469 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002470 6 common/cmd_bootm.c Image Type check OK
2471 -6 common/cmd_bootm.c gunzip uncompression error
2472 -7 common/cmd_bootm.c Unimplemented compression type
2473 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002474 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002475 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002476
2477 9 common/image.c Start initial ramdisk verification
2478 -10 common/image.c Ramdisk header has bad magic number
2479 -11 common/image.c Ramdisk header has bad checksum
2480 10 common/image.c Ramdisk header is OK
2481 -12 common/image.c Ramdisk data has bad checksum
2482 11 common/image.c Ramdisk data has correct checksum
2483 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002484 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002485 13 common/image.c Start multifile image verification
2486 14 common/image.c No initial ramdisk, no multifile, continue.
2487
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002488 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002489
Stefan Roesea47a12b2010-04-15 16:07:28 +02002490 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002491 -31 post/post.c POST test failed, detected by post_output_backlog()
2492 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002493
Heiko Schocher566a4942007-06-22 19:11:54 +02002494 34 common/cmd_doc.c before loading a Image from a DOC device
2495 -35 common/cmd_doc.c Bad usage of "doc" command
2496 35 common/cmd_doc.c correct usage of "doc" command
2497 -36 common/cmd_doc.c No boot device
2498 36 common/cmd_doc.c correct boot device
2499 -37 common/cmd_doc.c Unknown Chip ID on boot device
2500 37 common/cmd_doc.c correct chip ID found, device available
2501 -38 common/cmd_doc.c Read Error on boot device
2502 38 common/cmd_doc.c reading Image header from DOC device OK
2503 -39 common/cmd_doc.c Image header has bad magic number
2504 39 common/cmd_doc.c Image header has correct magic number
2505 -40 common/cmd_doc.c Error reading Image from DOC device
2506 40 common/cmd_doc.c Image header has correct magic number
2507 41 common/cmd_ide.c before loading a Image from a IDE device
2508 -42 common/cmd_ide.c Bad usage of "ide" command
2509 42 common/cmd_ide.c correct usage of "ide" command
2510 -43 common/cmd_ide.c No boot device
2511 43 common/cmd_ide.c boot device found
2512 -44 common/cmd_ide.c Device not available
2513 44 common/cmd_ide.c Device available
2514 -45 common/cmd_ide.c wrong partition selected
2515 45 common/cmd_ide.c partition selected
2516 -46 common/cmd_ide.c Unknown partition table
2517 46 common/cmd_ide.c valid partition table found
2518 -47 common/cmd_ide.c Invalid partition type
2519 47 common/cmd_ide.c correct partition type
2520 -48 common/cmd_ide.c Error reading Image Header on boot device
2521 48 common/cmd_ide.c reading Image Header from IDE device OK
2522 -49 common/cmd_ide.c Image header has bad magic number
2523 49 common/cmd_ide.c Image header has correct magic number
2524 -50 common/cmd_ide.c Image header has bad checksum
2525 50 common/cmd_ide.c Image header has correct checksum
2526 -51 common/cmd_ide.c Error reading Image from IDE device
2527 51 common/cmd_ide.c reading Image from IDE device OK
2528 52 common/cmd_nand.c before loading a Image from a NAND device
2529 -53 common/cmd_nand.c Bad usage of "nand" command
2530 53 common/cmd_nand.c correct usage of "nand" command
2531 -54 common/cmd_nand.c No boot device
2532 54 common/cmd_nand.c boot device found
2533 -55 common/cmd_nand.c Unknown Chip ID on boot device
2534 55 common/cmd_nand.c correct chip ID found, device available
2535 -56 common/cmd_nand.c Error reading Image Header on boot device
2536 56 common/cmd_nand.c reading Image Header from NAND device OK
2537 -57 common/cmd_nand.c Image header has bad magic number
2538 57 common/cmd_nand.c Image header has correct magic number
2539 -58 common/cmd_nand.c Error reading Image from NAND device
2540 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002541
Heiko Schocher566a4942007-06-22 19:11:54 +02002542 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002543
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002544 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002545 -64 net/eth.c no Ethernet found.
2546 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002547
Heiko Schocher566a4942007-06-22 19:11:54 +02002548 -80 common/cmd_net.c usage wrong
2549 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002550 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002551 81 common/cmd_net.c NetLoop() back without error
2552 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2553 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002554 83 common/cmd_net.c running "source" command
2555 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002556 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002557
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002558FIT uImage format:
2559
2560 Arg Where When
2561 100 common/cmd_bootm.c Kernel FIT Image has correct format
2562 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2563 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2564 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2565 102 common/cmd_bootm.c Kernel unit name specified
2566 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002567 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002568 104 common/cmd_bootm.c Got kernel subimage node offset
2569 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2570 105 common/cmd_bootm.c Kernel subimage hash verification OK
2571 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2572 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002573 -106 common/cmd_bootm.c Kernel subimage has wrong type
2574 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002575 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2576 108 common/cmd_bootm.c Got kernel subimage data/size
2577 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2578 -109 common/cmd_bootm.c Can't get kernel subimage type
2579 -110 common/cmd_bootm.c Can't get kernel subimage comp
2580 -111 common/cmd_bootm.c Can't get kernel subimage os
2581 -112 common/cmd_bootm.c Can't get kernel subimage load address
2582 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2583
2584 120 common/image.c Start initial ramdisk verification
2585 -120 common/image.c Ramdisk FIT image has incorrect format
2586 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002587 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002588 -122 common/image.c Can't get configuration for ramdisk subimage
2589 123 common/image.c Ramdisk unit name specified
2590 -124 common/image.c Can't get ramdisk subimage node offset
2591 125 common/image.c Got ramdisk subimage node offset
2592 -125 common/image.c Ramdisk subimage hash verification failed
2593 126 common/image.c Ramdisk subimage hash verification OK
2594 -126 common/image.c Ramdisk subimage for unsupported architecture
2595 127 common/image.c Architecture check OK
2596 -127 common/image.c Can't get ramdisk subimage data/size
2597 128 common/image.c Got ramdisk subimage data/size
2598 129 common/image.c Can't get ramdisk load address
2599 -129 common/image.c Got ramdisk load address
2600
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002601 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002602 131 common/cmd_doc.c FIT image format OK
2603
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002604 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002605 141 common/cmd_ide.c FIT image format OK
2606
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002607 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002608 151 common/cmd_nand.c FIT image format OK
2609
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002610- FIT image support:
2611 CONFIG_FIT
2612 Enable support for the FIT uImage format.
2613
2614 CONFIG_FIT_BEST_MATCH
2615 When no configuration is explicitly selected, default to the
2616 one whose fdt's compatibility field best matches that of
2617 U-Boot itself. A match is considered "best" if it matches the
2618 most specific compatibility entry of U-Boot's fdt's root node.
2619 The order of entries in the configuration's fdt is ignored.
2620
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002621- Standalone program support:
2622 CONFIG_STANDALONE_LOAD_ADDR
2623
Wolfgang Denk6feff892011-10-09 21:06:34 +02002624 This option defines a board specific value for the
2625 address where standalone program gets loaded, thus
2626 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002627 settings.
2628
2629- Frame Buffer Address:
2630 CONFIG_FB_ADDR
2631
2632 Define CONFIG_FB_ADDR if you want to use specific
2633 address for frame buffer.
2634 Then system will reserve the frame buffer address to
2635 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002636 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002637
2638 Please see board_init_f function.
2639
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002640- Automatic software updates via TFTP server
2641 CONFIG_UPDATE_TFTP
2642 CONFIG_UPDATE_TFTP_CNT_MAX
2643 CONFIG_UPDATE_TFTP_MSEC_MAX
2644
2645 These options enable and control the auto-update feature;
2646 for a more detailed description refer to doc/README.update.
2647
2648- MTD Support (mtdparts command, UBI support)
2649 CONFIG_MTD_DEVICE
2650
2651 Adds the MTD device infrastructure from the Linux kernel.
2652 Needed for mtdparts command support.
2653
2654 CONFIG_MTD_PARTITIONS
2655
2656 Adds the MTD partitioning infrastructure from the Linux
2657 kernel. Needed for UBI support.
2658
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002659- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002660 CONFIG_SPL
2661 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002662
Tom Rini95579792012-02-14 07:29:40 +00002663 CONFIG_SPL_LDSCRIPT
2664 LDSCRIPT for linking the SPL binary.
2665
2666 CONFIG_SPL_MAX_SIZE
2667 Maximum binary size (text, data and rodata) of the SPL binary.
2668
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002669 CONFIG_SPL_TEXT_BASE
2670 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002671
Scott Wood94a45bb2012-09-20 19:05:12 -05002672 CONFIG_SPL_RELOC_TEXT_BASE
2673 Address to relocate to. If unspecified, this is equal to
2674 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2675
Tom Rini95579792012-02-14 07:29:40 +00002676 CONFIG_SPL_BSS_START_ADDR
2677 Link address for the BSS within the SPL binary.
2678
2679 CONFIG_SPL_BSS_MAX_SIZE
2680 Maximum binary size of the BSS section of the SPL binary.
2681
2682 CONFIG_SPL_STACK
2683 Adress of the start of the stack SPL will use
2684
Scott Wood94a45bb2012-09-20 19:05:12 -05002685 CONFIG_SPL_RELOC_STACK
2686 Adress of the start of the stack SPL will use after
2687 relocation. If unspecified, this is equal to
2688 CONFIG_SPL_STACK.
2689
Tom Rini95579792012-02-14 07:29:40 +00002690 CONFIG_SYS_SPL_MALLOC_START
2691 Starting address of the malloc pool used in SPL.
2692
2693 CONFIG_SYS_SPL_MALLOC_SIZE
2694 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002695
Tom Rini47f7bca2012-08-13 12:03:19 -07002696 CONFIG_SPL_FRAMEWORK
2697 Enable the SPL framework under common/. This framework
2698 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2699 NAND loading of the Linux Kernel.
2700
Tom Rini861a86f2012-08-13 11:37:56 -07002701 CONFIG_SPL_DISPLAY_PRINT
2702 For ARM, enable an optional function to print more information
2703 about the running system.
2704
Scott Wood4b919722012-09-20 16:35:21 -05002705 CONFIG_SPL_INIT_MINIMAL
2706 Arch init code should be built for a very small image
2707
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002708 CONFIG_SPL_LIBCOMMON_SUPPORT
2709 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002710
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002711 CONFIG_SPL_LIBDISK_SUPPORT
2712 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002713
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002714 CONFIG_SPL_I2C_SUPPORT
2715 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002716
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002717 CONFIG_SPL_GPIO_SUPPORT
2718 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002719
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002720 CONFIG_SPL_MMC_SUPPORT
2721 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002722
Tom Rini95579792012-02-14 07:29:40 +00002723 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2724 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2725 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2726 Address, size and partition on the MMC to load U-Boot from
2727 when the MMC is being used in raw mode.
2728
2729 CONFIG_SPL_FAT_SUPPORT
2730 Support for fs/fat/libfat.o in SPL binary
2731
2732 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2733 Filename to read to load U-Boot when reading from FAT
2734
Scott Wood6f2f01b2012-09-20 19:09:07 -05002735 CONFIG_SPL_NAND_BASE
2736 Include nand_base.c in the SPL. Requires
2737 CONFIG_SPL_NAND_DRIVERS.
2738
2739 CONFIG_SPL_NAND_DRIVERS
2740 SPL uses normal NAND drivers, not minimal drivers.
2741
2742 CONFIG_SPL_NAND_ECC
2743 Include standard software ECC in the SPL
2744
Tom Rini95579792012-02-14 07:29:40 +00002745 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002746 Support for NAND boot using simple NAND drivers that
2747 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002748
2749 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2750 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2751 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2752 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2753 CONFIG_SYS_NAND_ECCBYTES
2754 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002755 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002756
2757 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002758 Location in NAND to read U-Boot from
2759
2760 CONFIG_SYS_NAND_U_BOOT_DST
2761 Location in memory to load U-Boot to
2762
2763 CONFIG_SYS_NAND_U_BOOT_SIZE
2764 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002765
2766 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002767 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002768
2769 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2770 Define this if you need to first read the OOB and then the
2771 data. This is used for example on davinci plattforms.
2772
2773 CONFIG_SPL_OMAP3_ID_NAND
2774 Support for an OMAP3-specific set of functions to return the
2775 ID and MFR of the first attached NAND chip, if present.
2776
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002777 CONFIG_SPL_SERIAL_SUPPORT
2778 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002779
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002780 CONFIG_SPL_SPI_FLASH_SUPPORT
2781 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002782
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002783 CONFIG_SPL_SPI_SUPPORT
2784 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002785
Pavel Machekc57b9532012-08-30 22:42:11 +02002786 CONFIG_SPL_RAM_DEVICE
2787 Support for running image already present in ram, in SPL binary
2788
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002789 CONFIG_SPL_LIBGENERIC_SUPPORT
2790 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002791
Scott Woodca2fca22012-09-21 16:27:32 -05002792 CONFIG_SPL_TARGET
2793 Final target image containing SPL and payload. Some SPLs
2794 use an arch-specific makefile fragment instead, for
2795 example if more than one image needs to be produced.
2796
wdenkc6097192002-11-03 00:24:07 +00002797Modem Support:
2798--------------
2799
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002800[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002801
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002802- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002803 CONFIG_MODEM_SUPPORT
2804
2805- RTS/CTS Flow control enable:
2806 CONFIG_HWFLOW
2807
2808- Modem debug support:
2809 CONFIG_MODEM_SUPPORT_DEBUG
2810
wdenk43d96162003-03-06 00:02:04 +00002811 Enables debugging stuff (char screen[1024], dbg())
2812 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002813
wdenka8c7c702003-12-06 19:49:23 +00002814- Interrupt support (PPC):
2815
wdenkd4ca31c2004-01-02 14:00:00 +00002816 There are common interrupt_init() and timer_interrupt()
2817 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002818 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002819 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002820 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002821 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002822 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002823 specific handling. If board has watchdog / status_led
2824 / other_activity_monitor it works automatically from
2825 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002826
wdenkc6097192002-11-03 00:24:07 +00002827- General:
2828
wdenk43d96162003-03-06 00:02:04 +00002829 In the target system modem support is enabled when a
2830 specific key (key combination) is pressed during
2831 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002832 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002833 board_init(). Currently key_pressed() is a dummy
2834 function, returning 1 and thus enabling modem
2835 initialization.
wdenkc6097192002-11-03 00:24:07 +00002836
wdenk43d96162003-03-06 00:02:04 +00002837 If there are no modem init strings in the
2838 environment, U-Boot proceed to autoboot; the
2839 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002840 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002841
2842 See also: doc/README.Modem
2843
Helmut Raiger9660e442011-10-20 04:19:47 +00002844Board initialization settings:
2845------------------------------
2846
2847During Initialization u-boot calls a number of board specific functions
2848to allow the preparation of board specific prerequisites, e.g. pin setup
2849before drivers are initialized. To enable these callbacks the
2850following configuration macros have to be defined. Currently this is
2851architecture specific, so please check arch/your_architecture/lib/board.c
2852typically in board_init_f() and board_init_r().
2853
2854- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2855- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2856- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2857- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002858
wdenkc6097192002-11-03 00:24:07 +00002859Configuration Settings:
2860-----------------------
2861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002862- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002863 undefine this when you're short of memory.
2864
Peter Tyser2fb26042009-01-27 18:03:12 -06002865- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2866 width of the commands listed in the 'help' command output.
2867
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002868- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002869 prompt for user input.
2870
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002871- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002873- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002875- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002876
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002877- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002878 the application (usually a Linux kernel) when it is
2879 booted
2880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002881- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002882 List of legal baudrate settings for this board.
2883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002884- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002885 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002887- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002888 If the board specific function
2889 extern int overwrite_console (void);
2890 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002891 serial port, else the settings in the environment are used.
2892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002893- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002894 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002896- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002897 Enable overwrite of previous console environment settings.
2898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002899- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002900 Begin and End addresses of the area used by the
2901 simple memory test.
2902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002904 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002905
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002906- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002907 Scratch address used by the alternate memory test
2908 You only need to set this if address zero isn't writeable
2909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002910- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2911 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002912 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002913 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002914 fixing up gd->ram_size the Linux kernel should gets passed
2915 the now "corrected" memory size and won't touch it either.
2916 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002917 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002918 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002919 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002920
2921 This option can be used as a workaround for the 440EPx/GRx
2922 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2923 be touched.
2924
2925 WARNING: Please make sure that this value is a multiple of
2926 the Linux page size (normally 4k). If this is not the case,
2927 then the end address of the Linux memory will be located at a
2928 non page size aligned address and this could cause major
2929 problems.
2930
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002931- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002932 Default load address for network file downloads
2933
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002934- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002935 Enable temporary baudrate change while serial download
2936
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002937- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002938 Physical start address of SDRAM. _Must_ be 0 here.
2939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002940- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002941 Physical start address of Motherboard I/O (if using a
2942 Cogent motherboard)
2943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002944- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002945 Physical start address of Flash memory.
2946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002947- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002948 Physical start address of boot monitor code (set by
2949 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002950 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002951 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002953- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002954 Size of memory reserved for monitor code, used to
2955 determine _at_compile_time_ (!) if the environment is
2956 embedded within the U-Boot image, or in a separate
2957 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002959- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002960 Size of DRAM reserved for malloc() use.
2961
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002962- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002963 Normally compressed uImages are limited to an
2964 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002965 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002966 to adjust this setting to your needs.
2967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002968- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002969 Maximum size of memory mapped by the startup code of
2970 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002971 the Linux kernel (bd_info, boot arguments, FDT blob if
2972 used) must be put below this limit, unless "bootm_low"
2973 enviroment variable is defined and non-zero. In such case
2974 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002975 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002976 variable "bootm_mapsize" will override the value of
2977 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2978 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002979
John Rigbyfca43cc2010-10-13 13:57:35 -06002980- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2981 Enable initrd_high functionality. If defined then the
2982 initrd_high feature is enabled and the bootm ramdisk subcommand
2983 is enabled.
2984
2985- CONFIG_SYS_BOOT_GET_CMDLINE:
2986 Enables allocating and saving kernel cmdline in space between
2987 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2988
2989- CONFIG_SYS_BOOT_GET_KBD:
2990 Enables allocating and saving a kernel copy of the bd_info in
2991 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002993- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002994 Max number of Flash memory banks
2995
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002996- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002997 Max number of sectors on a Flash chip
2998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002999- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003000 Timeout for Flash erase operations (in ms)
3001
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003002- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003003 Timeout for Flash write operations (in ms)
3004
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003005- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003006 Timeout for Flash set sector lock bit operation (in ms)
3007
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003008- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003009 Timeout for Flash clear lock bits operation (in ms)
3010
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003011- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003012 If defined, hardware flash sectors protection is used
3013 instead of U-Boot software protection.
3014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003015- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003016
3017 Enable TFTP transfers directly to flash memory;
3018 without this option such a download has to be
3019 performed in two steps: (1) download to RAM, and (2)
3020 copy from RAM to flash.
3021
3022 The two-step approach is usually more reliable, since
3023 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003024 the flash, but in some situations (when system RAM is
3025 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003026 downloaded image) this option may be very useful.
3027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003028- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003029 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003030 common flash structure for storing flash geometry.
3031
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003032- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003033 This option also enables the building of the cfi_flash driver
3034 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003035
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003036- CONFIG_FLASH_CFI_MTD
3037 This option enables the building of the cfi_mtd driver
3038 in the drivers directory. The driver exports CFI flash
3039 to the MTD layer.
3040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003041- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003042 Use buffered writes to flash.
3043
3044- CONFIG_FLASH_SPANSION_S29WS_N
3045 s29ws-n MirrorBit flash has non-standard addresses for buffered
3046 write commands.
3047
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003048- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003049 If this option is defined, the common CFI flash doesn't
3050 print it's warning upon not recognized FLASH banks. This
3051 is useful, if some of the configured banks are only
3052 optionally available.
3053
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003054- CONFIG_FLASH_SHOW_PROGRESS
3055 If defined (must be an integer), print out countdown
3056 digits and dots. Recommended value: 45 (9..1) for 80
3057 column displays, 15 (3..1) for 40 column displays.
3058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003059- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003060 Defines the number of Ethernet receive buffers. On some
3061 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003062 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3063 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003064 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003065 Defaults to 4 if not defined.
3066
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003067- CONFIG_ENV_MAX_ENTRIES
3068
Wolfgang Denk071bc922010-10-27 22:48:30 +02003069 Maximum number of entries in the hash table that is used
3070 internally to store the environment settings. The default
3071 setting is supposed to be generous and should work in most
3072 cases. This setting can be used to tune behaviour; see
3073 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003074
wdenkc6097192002-11-03 00:24:07 +00003075The following definitions that deal with the placement and management
3076of environment data (variable area); in general, we support the
3077following configurations:
3078
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003079- CONFIG_BUILD_ENVCRC:
3080
3081 Builds up envcrc with the target environment so that external utils
3082 may easily extract it and embed it in final U-Boot images.
3083
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003084- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003085
3086 Define this if the environment is in flash memory.
3087
3088 a) The environment occupies one whole flash sector, which is
3089 "embedded" in the text segment with the U-Boot code. This
3090 happens usually with "bottom boot sector" or "top boot
3091 sector" type flash chips, which have several smaller
3092 sectors at the start or the end. For instance, such a
3093 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3094 such a case you would place the environment in one of the
3095 4 kB sectors - with U-Boot code before and after it. With
3096 "top boot sector" type flash chips, you would put the
3097 environment in one of the last sectors, leaving a gap
3098 between U-Boot and the environment.
3099
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003100 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003101
3102 Offset of environment data (variable area) to the
3103 beginning of flash memory; for instance, with bottom boot
3104 type flash chips the second sector can be used: the offset
3105 for this sector is given here.
3106
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003107 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003108
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003109 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003110
3111 This is just another way to specify the start address of
3112 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003113 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003114
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003115 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003116
3117 Size of the sector containing the environment.
3118
3119
3120 b) Sometimes flash chips have few, equal sized, BIG sectors.
3121 In such a case you don't want to spend a whole sector for
3122 the environment.
3123
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003124 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003125
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003126 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003127 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003128 of this flash sector for the environment. This saves
3129 memory for the RAM copy of the environment.
3130
3131 It may also save flash memory if you decide to use this
3132 when your environment is "embedded" within U-Boot code,
3133 since then the remainder of the flash sector could be used
3134 for U-Boot code. It should be pointed out that this is
3135 STRONGLY DISCOURAGED from a robustness point of view:
3136 updating the environment in flash makes it always
3137 necessary to erase the WHOLE sector. If something goes
3138 wrong before the contents has been restored from a copy in
3139 RAM, your target system will be dead.
3140
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003141 - CONFIG_ENV_ADDR_REDUND
3142 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003143
wdenk43d96162003-03-06 00:02:04 +00003144 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003145 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003146 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003147 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003148
3149BE CAREFUL! Any changes to the flash layout, and some changes to the
3150source code will make it necessary to adapt <board>/u-boot.lds*
3151accordingly!
3152
3153
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003154- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003155
3156 Define this if you have some non-volatile memory device
3157 (NVRAM, battery buffered SRAM) which you want to use for the
3158 environment.
3159
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003160 - CONFIG_ENV_ADDR:
3161 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003162
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003163 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003164 want to use for environment. It is assumed that this memory
3165 can just be read and written to, without any special
3166 provision.
3167
3168BE CAREFUL! The first access to the environment happens quite early
3169in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003170console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003171U-Boot will hang.
3172
3173Please note that even with NVRAM we still use a copy of the
3174environment in RAM: we could work on NVRAM directly, but we want to
3175keep settings there always unmodified except somebody uses "saveenv"
3176to save the current settings.
3177
3178
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003179- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003180
3181 Use this if you have an EEPROM or similar serial access
3182 device and a driver for it.
3183
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003184 - CONFIG_ENV_OFFSET:
3185 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003186
3187 These two #defines specify the offset and size of the
3188 environment area within the total memory of your EEPROM.
3189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003190 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003191 If defined, specified the chip address of the EEPROM device.
3192 The default address is zero.
3193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003194 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003195 If defined, the number of bits used to address bytes in a
3196 single page in the EEPROM device. A 64 byte page, for example
3197 would require six bits.
3198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003199 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003200 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003201 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003203 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003204 The length in bytes of the EEPROM memory array address. Note
3205 that this is NOT the chip address length!
3206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003207 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003208 EEPROM chips that implement "address overflow" are ones
3209 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3210 address and the extra bits end up in the "chip address" bit
3211 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3212 byte chips.
3213
3214 Note that we consider the length of the address field to
3215 still be one byte because the extra address bits are hidden
3216 in the chip address.
3217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003218 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003219 The size in bytes of the EEPROM device.
3220
Heiko Schocher548738b2010-01-07 08:55:40 +01003221 - CONFIG_ENV_EEPROM_IS_ON_I2C
3222 define this, if you have I2C and SPI activated, and your
3223 EEPROM, which holds the environment, is on the I2C bus.
3224
3225 - CONFIG_I2C_ENV_EEPROM_BUS
3226 if you have an Environment on an EEPROM reached over
3227 I2C muxes, you can define here, how to reach this
3228 EEPROM. For example:
3229
Wolfgang Denka9046b92010-06-13 17:48:15 +02003230 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003231
3232 EEPROM which holds the environment, is reached over
3233 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003234
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003235- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003236
wdenkd4ca31c2004-01-02 14:00:00 +00003237 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003238 want to use for the environment.
3239
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003240 - CONFIG_ENV_OFFSET:
3241 - CONFIG_ENV_ADDR:
3242 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003243
3244 These three #defines specify the offset and size of the
3245 environment area within the total memory of your DataFlash placed
3246 at the specified address.
3247
Liu Gang0a85a9e2012-03-08 00:33:20 +00003248- CONFIG_ENV_IS_IN_REMOTE:
3249
3250 Define this if you have a remote memory space which you
3251 want to use for the local device's environment.
3252
3253 - CONFIG_ENV_ADDR:
3254 - CONFIG_ENV_SIZE:
3255
3256 These two #defines specify the address and size of the
3257 environment area within the remote memory space. The
3258 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003259 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003260
3261BE CAREFUL! For some special cases, the local device can not use
3262"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003263environment stored in a remote NOR flash by SRIO or PCIE link,
3264but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003265
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003266- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003267
3268 Define this if you have a NAND device which you want to use
3269 for the environment.
3270
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003271 - CONFIG_ENV_OFFSET:
3272 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003273
3274 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003275 area within the first NAND device. CONFIG_ENV_OFFSET must be
3276 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003277
Scott Woodfdd813d2010-09-17 14:38:37 -05003278 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003279
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003280 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003281 size used to hold a redundant copy of the environment data, so
3282 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003283 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003284 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003285
Scott Woodfdd813d2010-09-17 14:38:37 -05003286 - CONFIG_ENV_RANGE (optional):
3287
3288 Specifies the length of the region in which the environment
3289 can be written. This should be a multiple of the NAND device's
3290 block size. Specifying a range with more erase blocks than
3291 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3292 the range to be avoided.
3293
3294 - CONFIG_ENV_OFFSET_OOB (optional):
3295
3296 Enables support for dynamically retrieving the offset of the
3297 environment from block zero's out-of-band data. The
3298 "nand env.oob" command can be used to record this offset.
3299 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3300 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003301
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003302- CONFIG_NAND_ENV_DST
3303
3304 Defines address in RAM to which the nand_spl code should copy the
3305 environment. If redundant environment is used, it will be copied to
3306 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003308- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003309
3310 Defines offset to the initial SPI buffer area in DPRAM. The
3311 area is used at an early stage (ROM part) if the environment
3312 is configured to reside in the SPI EEPROM: We need a 520 byte
3313 scratch DPRAM area. It is used between the two initialization
3314 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3315 to be a good choice since it makes it far enough from the
3316 start of the data area as well as from the stack pointer.
3317
Bruce Adlere881cb52007-11-02 13:15:42 -07003318Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003319has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003320created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003321until then to read environment variables.
3322
wdenk85ec0bc2003-03-31 16:34:49 +00003323The environment is protected by a CRC32 checksum. Before the monitor
3324is relocated into RAM, as a result of a bad CRC you will be working
3325with the compiled-in default environment - *silently*!!! [This is
3326necessary, because the first environment variable we need is the
3327"baudrate" setting for the console - if we have a bad CRC, we don't
3328have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003329
3330Note: once the monitor has been relocated, then it will complain if
3331the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003332use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003334- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003335 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003337 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003338 also needs to be defined.
3339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003340- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003341 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003342
Ron Madridf5675aa2009-02-18 14:30:44 -08003343- CONFIG_NS16550_MIN_FUNCTIONS:
3344 Define this if you desire to only have use of the NS16550_init
3345 and NS16550_putc functions for the serial driver located at
3346 drivers/serial/ns16550.c. This option is useful for saving
3347 space for already greatly restricted images, including but not
3348 limited to NAND_SPL configurations.
3349
wdenkc6097192002-11-03 00:24:07 +00003350Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003351---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003353- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003354 Cache Line Size of the CPU.
3355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003356- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003357 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003358
wdenk42d1f032003-10-15 23:53:47 +00003359 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3360 and RPXsuper) to be able to adjust the position of
3361 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003362
Timur Tabie46fedf2011-08-04 18:03:41 -05003363- CONFIG_SYS_CCSRBAR_DEFAULT:
3364 Default (power-on reset) physical address of CCSR on Freescale
3365 PowerPC SOCs.
3366
3367- CONFIG_SYS_CCSRBAR:
3368 Virtual address of CCSR. On a 32-bit build, this is typically
3369 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3370
3371 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3372 for cross-platform code that uses that macro instead.
3373
3374- CONFIG_SYS_CCSRBAR_PHYS:
3375 Physical address of CCSR. CCSR can be relocated to a new
3376 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003377 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003378 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3379 is typically relocated on 36-bit builds. It is recommended
3380 that this macro be defined via the _HIGH and _LOW macros:
3381
3382 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3383 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3384
3385- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003386 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3387 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003388 used in assembly code, so it must not contain typecasts or
3389 integer size suffixes (e.g. "ULL").
3390
3391- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3392 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3393 used in assembly code, so it must not contain typecasts or
3394 integer size suffixes (e.g. "ULL").
3395
3396- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3397 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3398 forced to a value that ensures that CCSR is not relocated.
3399
wdenk7f6c2cb2002-11-10 22:06:23 +00003400- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003401 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003402
3403 the default drive number (default value 0)
3404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003405 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003406
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003407 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003408 (default value 1)
3409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003410 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003411
wdenk43d96162003-03-06 00:02:04 +00003412 defines the offset of register from address. It
3413 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003414 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003416 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3417 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003418 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003419
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003420 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003421 fdc_hw_init() is called at the beginning of the FDC
3422 setup. fdc_hw_init() must be provided by the board
3423 source code. It is used to make hardware dependant
3424 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003425
Macpaul Lin0abddf82011-04-11 20:45:32 +00003426- CONFIG_IDE_AHB:
3427 Most IDE controllers were designed to be connected with PCI
3428 interface. Only few of them were designed for AHB interface.
3429 When software is doing ATA command and data transfer to
3430 IDE devices through IDE-AHB controller, some additional
3431 registers accessing to these kind of IDE-AHB controller
3432 is requierd.
3433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003434- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003435 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003436 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003438- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003439
wdenk7152b1d2003-09-05 23:19:14 +00003440 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003441 initial data and stack; please note that this must be
3442 writable memory that is working WITHOUT special
3443 initialization, i. e. you CANNOT use normal RAM which
3444 will become available only after programming the
3445 memory controller and running certain initialization
3446 sequences.
3447
3448 U-Boot uses the following memory types:
3449 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3450 - MPC824X: data cache
3451 - PPC4xx: data cache
3452
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003453- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003454
3455 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003456 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3457 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003458 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003459 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003460 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3461 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3462 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003463
3464 Note:
3465 On the MPC824X (or other systems that use the data
3466 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003467 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003468 point to an otherwise UNUSED address space between
3469 the top of RAM and the start of the PCI space.
3470
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003471- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003472
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003473- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003474
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003475- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003477- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003479- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003481- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003482
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003483- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003484 SDRAM timing
3485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003486- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003487 periodic timer for refresh
3488
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003489- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003491- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3492 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3493 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3494 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003495 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3496
3497- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003498 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3499 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003500 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003502- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3503 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003504 Machine Mode Register and Memory Periodic Timer
3505 Prescaler definitions (SDRAM timing)
3506
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003507- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003508 enable I2C microcode relocation patch (MPC8xx);
3509 define relocation offset in DPRAM [DSP2]
3510
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003511- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003512 enable SMC microcode relocation patch (MPC8xx);
3513 define relocation offset in DPRAM [SMC1]
3514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003515- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003516 enable SPI microcode relocation patch (MPC8xx);
3517 define relocation offset in DPRAM [SCC4]
3518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003519- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003520 Use OSCM clock mode on MBX8xx board. Be careful,
3521 wrong setting might damage your board. Read
3522 doc/README.MBX before setting this variable!
3523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003525 Offset of the bootmode word in DPRAM used by post
3526 (Power On Self Tests). This definition overrides
3527 #define'd default value in commproc.h resp.
3528 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003529
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003530- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3531 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3532 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3533 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3534 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3535 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3536 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3537 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003538 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003539
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003540- CONFIG_PCI_DISABLE_PCIE:
3541 Disable PCI-Express on systems where it is supported but not
3542 required.
3543
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003544- CONFIG_PCI_ENUM_ONLY
3545 Only scan through and get the devices on the busses.
3546 Don't do any setup work, presumably because someone or
3547 something has already done it, and we don't need to do it
3548 a second time. Useful for platforms that are pre-booted
3549 by coreboot or similar.
3550
Kumar Galaa09b9b62010-12-30 12:09:53 -06003551- CONFIG_SYS_SRIO:
3552 Chip has SRIO or not
3553
3554- CONFIG_SRIO1:
3555 Board has SRIO 1 port available
3556
3557- CONFIG_SRIO2:
3558 Board has SRIO 2 port available
3559
3560- CONFIG_SYS_SRIOn_MEM_VIRT:
3561 Virtual Address of SRIO port 'n' memory region
3562
3563- CONFIG_SYS_SRIOn_MEM_PHYS:
3564 Physical Address of SRIO port 'n' memory region
3565
3566- CONFIG_SYS_SRIOn_MEM_SIZE:
3567 Size of SRIO port 'n' memory region
3568
Alex Watermaneced4622011-05-19 15:08:36 -04003569- CONFIG_SYS_NDFC_16
3570 Defined to tell the NDFC that the NAND chip is using a
3571 16 bit bus.
3572
3573- CONFIG_SYS_NDFC_EBC0_CFG
3574 Sets the EBC0_CFG register for the NDFC. If not defined
3575 a default value will be used.
3576
Ben Warrenbb99ad62006-09-07 16:50:54 -04003577- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003578 Get DDR timing information from an I2C EEPROM. Common
3579 with pluggable memory modules such as SODIMMs
3580
Ben Warrenbb99ad62006-09-07 16:50:54 -04003581 SPD_EEPROM_ADDRESS
3582 I2C address of the SPD EEPROM
3583
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003584- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003585 If SPD EEPROM is on an I2C bus other than the first
3586 one, specify here. Note that the value must resolve
3587 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003588
York Sun1b3e3c42011-06-07 09:42:16 +08003589- CONFIG_SYS_DDR_RAW_TIMING
3590 Get DDR timing information from other than SPD. Common with
3591 soldered DDR chips onboard without SPD. DDR raw timing
3592 parameters are extracted from datasheet and hard-coded into
3593 header files or board specific files.
3594
York Sun6f5e1dc2011-09-16 13:21:35 -07003595- CONFIG_FSL_DDR_INTERACTIVE
3596 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003598- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003599 Only for 83xx systems. If specified, then DDR should
3600 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003601
wdenkc26e4542004-04-18 10:13:26 +00003602- CONFIG_ETHER_ON_FEC[12]
3603 Define to enable FEC[12] on a 8xx series processor.
3604
3605- CONFIG_FEC[12]_PHY
3606 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003607 to the given FEC; i. e.
3608 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003609 means that the PHY with address 4 is connected to FEC1
3610
3611 When set to -1, means to probe for first available.
3612
3613- CONFIG_FEC[12]_PHY_NORXERR
3614 The PHY does not have a RXERR line (RMII only).
3615 (so program the FEC to ignore it).
3616
3617- CONFIG_RMII
3618 Enable RMII mode for all FECs.
3619 Note that this is a global option, we can't
3620 have one FEC in standard MII mode and another in RMII mode.
3621
wdenk5cf91d62004-04-23 20:32:05 +00003622- CONFIG_CRC32_VERIFY
3623 Add a verify option to the crc32 command.
3624 The syntax is:
3625
3626 => crc32 -v <address> <count> <crc32>
3627
3628 Where address/count indicate a memory area
3629 and crc32 is the correct crc32 which the
3630 area should have.
3631
wdenk56523f12004-07-11 17:40:54 +00003632- CONFIG_LOOPW
3633 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003634 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003635
stroese7b466642004-12-16 18:46:55 +00003636- CONFIG_MX_CYCLIC
3637 Add the "mdc" and "mwc" memory commands. These are cyclic
3638 "md/mw" commands.
3639 Examples:
3640
wdenkefe2a4d2004-12-16 21:44:03 +00003641 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003642 This command will print 4 bytes (10,11,12,13) each 500 ms.
3643
wdenkefe2a4d2004-12-16 21:44:03 +00003644 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003645 This command will write 12345678 to address 100 all 10 ms.
3646
wdenkefe2a4d2004-12-16 21:44:03 +00003647 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003648 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003649
wdenk8aa1a2d2005-04-04 12:44:11 +00003650- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003651 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003652 low level initializations (like setting up the memory
3653 controller) are omitted and/or U-Boot does not
3654 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003655
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003656 Normally this variable MUST NOT be defined. The only
3657 exception is when U-Boot is loaded (to RAM) by some
3658 other boot loader or by a debugger which performs
3659 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003660
Aneesh V401bb302011-07-13 05:11:07 +00003661- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003662 Modifies the behaviour of start.S when compiling a loader
3663 that is executed before the actual U-Boot. E.g. when
3664 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003665
Matthias Weisserd8834a12011-03-10 21:36:32 +00003666- CONFIG_USE_ARCH_MEMCPY
3667 CONFIG_USE_ARCH_MEMSET
3668 If these options are used a optimized version of memcpy/memset will
3669 be used if available. These functions may be faster under some
3670 conditions but may increase the binary size.
3671
Gabe Blackb16f5212012-11-27 21:08:06 +00003672- CONFIG_X86_NO_RESET_VECTOR
3673 If defined, the x86 reset vector code is excluded. You will need
3674 to do this when U-Boot is running from Coreboot.
3675
Gabe Black5b5ece92012-11-29 16:23:41 +00003676- CONFIG_X86_NO_REAL_MODE
3677 If defined, x86 real mode code is omitted. This assumes a
3678 32-bit environment where such code is not needed. You will
3679 need to do this when U-Boot is running from Coreboot.
3680
3681
Timur Tabif2717b42011-11-22 09:21:25 -06003682Freescale QE/FMAN Firmware Support:
3683-----------------------------------
3684
3685The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3686loading of "firmware", which is encoded in the QE firmware binary format.
3687This firmware often needs to be loaded during U-Boot booting, so macros
3688are used to identify the storage device (NOR flash, SPI, etc) and the address
3689within that device.
3690
3691- CONFIG_SYS_QE_FMAN_FW_ADDR
3692 The address in the storage device where the firmware is located. The
3693 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3694 is also specified.
3695
3696- CONFIG_SYS_QE_FMAN_FW_LENGTH
3697 The maximum possible size of the firmware. The firmware binary format
3698 has a field that specifies the actual size of the firmware, but it
3699 might not be possible to read any part of the firmware unless some
3700 local storage is allocated to hold the entire firmware first.
3701
3702- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3703 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3704 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3705 virtual address in NOR flash.
3706
3707- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3708 Specifies that QE/FMAN firmware is located in NAND flash.
3709 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3710
3711- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3712 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3713 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3714
3715- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3716 Specifies that QE/FMAN firmware is located on the primary SPI
3717 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3718
Liu Gang292dc6c2012-03-08 00:33:18 +00003719- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3720 Specifies that QE/FMAN firmware is located in the remote (master)
3721 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003722 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3723 window->master inbound window->master LAW->the ucode address in
3724 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003725
wdenkc6097192002-11-03 00:24:07 +00003726Building the Software:
3727======================
3728
Wolfgang Denk218ca722008-03-26 10:40:12 +01003729Building U-Boot has been tested in several native build environments
3730and in many different cross environments. Of course we cannot support
3731all possibly existing versions of cross development tools in all
3732(potentially obsolete) versions. In case of tool chain problems we
3733recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3734which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003735
Wolfgang Denk218ca722008-03-26 10:40:12 +01003736If you are not using a native environment, it is assumed that you
3737have GNU cross compiling tools available in your path. In this case,
3738you must set the environment variable CROSS_COMPILE in your shell.
3739Note that no changes to the Makefile or any other source files are
3740necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003741
Wolfgang Denk218ca722008-03-26 10:40:12 +01003742 $ CROSS_COMPILE=ppc_4xx-
3743 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003744
Peter Tyser2f8d3962009-03-13 18:54:51 -05003745Note: If you wish to generate Windows versions of the utilities in
3746 the tools directory you can use the MinGW toolchain
3747 (http://www.mingw.org). Set your HOST tools to the MinGW
3748 toolchain and execute 'make tools'. For example:
3749
3750 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3751
3752 Binaries such as tools/mkimage.exe will be created which can
3753 be executed on computers running Windows.
3754
Wolfgang Denk218ca722008-03-26 10:40:12 +01003755U-Boot is intended to be simple to build. After installing the
3756sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003757is done by typing:
3758
3759 make NAME_config
3760
Wolfgang Denk218ca722008-03-26 10:40:12 +01003761where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003762rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764Note: for some board special configuration names may exist; check if
3765 additional information is available from the board vendor; for
3766 instance, the TQM823L systems are available without (standard)
3767 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003768 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770 make TQM823L_config
3771 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773 make TQM823L_LCD_config
3774 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776 etc.
wdenkc6097192002-11-03 00:24:07 +00003777
wdenkc6097192002-11-03 00:24:07 +00003778
wdenk2729af92004-05-03 20:45:30 +00003779Finally, type "make all", and you should get some working U-Boot
3780images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk2729af92004-05-03 20:45:30 +00003782- "u-boot.bin" is a raw binary image
3783- "u-boot" is an image in ELF binary format
3784- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003785
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003786By default the build is performed locally and the objects are saved
3787in the source directory. One of the two methods can be used to change
3788this behavior and build U-Boot to some external directory:
3789
37901. Add O= to the make command line invocations:
3791
3792 make O=/tmp/build distclean
3793 make O=/tmp/build NAME_config
3794 make O=/tmp/build all
3795
37962. Set environment variable BUILD_DIR to point to the desired location:
3797
3798 export BUILD_DIR=/tmp/build
3799 make distclean
3800 make NAME_config
3801 make all
3802
3803Note that the command line "O=" setting overrides the BUILD_DIR environment
3804variable.
3805
wdenkc6097192002-11-03 00:24:07 +00003806
wdenk2729af92004-05-03 20:45:30 +00003807Please be aware that the Makefiles assume you are using GNU make, so
3808for instance on NetBSD you might need to use "gmake" instead of
3809native "make".
wdenkc6097192002-11-03 00:24:07 +00003810
wdenkc6097192002-11-03 00:24:07 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812If the system board that you have is not listed, then you will need
3813to port U-Boot to your hardware platform. To do this, follow these
3814steps:
wdenkc6097192002-11-03 00:24:07 +00003815
wdenk2729af92004-05-03 20:45:30 +000038161. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003817 "boards.cfg" file, using the existing entries as examples.
3818 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000038192. Create a new directory to hold your board specific code. Add any
3820 files you need. In your board directory, you will need at least
3821 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
38223. Create a new configuration file "include/configs/<board>.h" for
3823 your board
38243. If you're porting U-Boot to a new CPU, then also create a new
3825 directory to hold your CPU specific code. Add any files you need.
38264. Run "make <board>_config" with your new name.
38275. Type "make", and you should get a working "u-boot.srec" file
3828 to be installed on your target system.
38296. Debug and solve any problems that might arise.
3830 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003831
wdenkc6097192002-11-03 00:24:07 +00003832
wdenk2729af92004-05-03 20:45:30 +00003833Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3834==============================================================
wdenkc6097192002-11-03 00:24:07 +00003835
Wolfgang Denk218ca722008-03-26 10:40:12 +01003836If you have modified U-Boot sources (for instance added a new board
3837or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003838provide feedback to the other developers. The feedback normally takes
3839the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003840official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003841
Wolfgang Denk218ca722008-03-26 10:40:12 +01003842But before you submit such a patch, please verify that your modifi-
3843cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003844the supported boards compile WITHOUT ANY compiler warnings. To do so,
3845just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003846for ALL supported system. Be warned, this will take a while. You can
3847select which (cross) compiler to use by passing a `CROSS_COMPILE'
3848environment variable to the script, i. e. to use the ELDK cross tools
3849you can type
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003852
wdenk2729af92004-05-03 20:45:30 +00003853or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003854
wdenk2729af92004-05-03 20:45:30 +00003855 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003856
Wolfgang Denk218ca722008-03-26 10:40:12 +01003857When using the MAKEALL script, the default behaviour is to build
3858U-Boot in the source directory. This location can be changed by
3859setting the BUILD_DIR environment variable. Also, for each target
3860built, the MAKEALL script saves two log files (<target>.ERR and
3861<target>.MAKEALL) in the <source dir>/LOG directory. This default
3862location can be changed by setting the MAKEALL_LOGDIR environment
3863variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003864
3865 export BUILD_DIR=/tmp/build
3866 export MAKEALL_LOGDIR=/tmp/log
3867 CROSS_COMPILE=ppc_8xx- MAKEALL
3868
Wolfgang Denk218ca722008-03-26 10:40:12 +01003869With the above settings build objects are saved in the /tmp/build,
3870log files are saved in the /tmp/log and the source tree remains clean
3871during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003872
3873
wdenk2729af92004-05-03 20:45:30 +00003874See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003875
wdenkc6097192002-11-03 00:24:07 +00003876
wdenk2729af92004-05-03 20:45:30 +00003877Monitor Commands - Overview:
3878============================
wdenkc6097192002-11-03 00:24:07 +00003879
wdenk2729af92004-05-03 20:45:30 +00003880go - start application at address 'addr'
3881run - run commands in an environment variable
3882bootm - boot application image from memory
3883bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003884bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003885tftpboot- boot image via network using TFTP protocol
3886 and env variables "ipaddr" and "serverip"
3887 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003888tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003889rarpboot- boot image via network using RARP/TFTP protocol
3890diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3891loads - load S-Record file over serial line
3892loadb - load binary file over serial line (kermit mode)
3893md - memory display
3894mm - memory modify (auto-incrementing)
3895nm - memory modify (constant address)
3896mw - memory write (fill)
3897cp - memory copy
3898cmp - memory compare
3899crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003900i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003901sspi - SPI utility commands
3902base - print or set address offset
3903printenv- print environment variables
3904setenv - set environment variables
3905saveenv - save environment variables to persistent storage
3906protect - enable or disable FLASH write protection
3907erase - erase FLASH memory
3908flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003909nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003910bdinfo - print Board Info structure
3911iminfo - print header information for application image
3912coninfo - print console devices and informations
3913ide - IDE sub-system
3914loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003915loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003916mtest - simple RAM test
3917icache - enable or disable instruction cache
3918dcache - enable or disable data cache
3919reset - Perform RESET of the CPU
3920echo - echo args to console
3921version - print monitor version
3922help - print online help
3923? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003924
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926Monitor Commands - Detailed Description:
3927========================================
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929TODO.
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003932
3933
wdenk2729af92004-05-03 20:45:30 +00003934Environment Variables:
3935======================
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937U-Boot supports user configuration using Environment Variables which
3938can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003939
wdenk2729af92004-05-03 20:45:30 +00003940Environment Variables are set using "setenv", printed using
3941"printenv", and saved to Flash using "saveenv". Using "setenv"
3942without a value can be used to delete a variable from the
3943environment. As long as you don't save the environment you are
3944working with an in-memory copy. In case the Flash area containing the
3945environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003946
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003947Some configuration options can be set using Environment Variables.
3948
3949List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003958
wdenk2729af92004-05-03 20:45:30 +00003959 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003960
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003961 bootm_low - Memory range available for image processing in the bootm
3962 command can be restricted. This variable is given as
3963 a hexadecimal number and defines lowest address allowed
3964 for use by the bootm command. See also "bootm_size"
3965 environment variable. Address defined by "bootm_low" is
3966 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003967 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3968 bootm_mapsize.
3969
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003970 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003971 This variable is given as a hexadecimal number and it
3972 defines the size of the memory region starting at base
3973 address bootm_low that is accessible by the Linux kernel
3974 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3975 as the default value if it is defined, and bootm_size is
3976 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003977
3978 bootm_size - Memory range available for image processing in the bootm
3979 command can be restricted. This variable is given as
3980 a hexadecimal number and defines the size of the region
3981 allowed for use by the bootm command. See also "bootm_low"
3982 environment variable.
3983
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003984 updatefile - Location of the software update file on a TFTP server, used
3985 by the automatic software update feature. Please refer to
3986 documentation in doc/README.update for more details.
3987
wdenk2729af92004-05-03 20:45:30 +00003988 autoload - if set to "no" (any string beginning with 'n'),
3989 "bootp" will just load perform a lookup of the
3990 configuration from the BOOTP server, but not try to
3991 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003992
wdenk2729af92004-05-03 20:45:30 +00003993 autostart - if set to "yes", an image loaded using the "bootp",
3994 "rarpboot", "tftpboot" or "diskboot" commands will
3995 be automatically started (by internally calling
3996 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003997
wdenk2729af92004-05-03 20:45:30 +00003998 If set to "no", a standalone image passed to the
3999 "bootm" command will be copied to the load address
4000 (and eventually uncompressed), but NOT be started.
4001 This can be used to load and uncompress arbitrary
4002 data.
wdenkc6097192002-11-03 00:24:07 +00004003
David A. Longa28afca2011-07-09 16:40:19 -04004004 fdt_high - if set this restricts the maximum address that the
4005 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004006 For example, if you have a system with 1 GB memory
4007 at physical address 0x10000000, while Linux kernel
4008 only recognizes the first 704 MB as low memory, you
4009 may need to set fdt_high as 0x3C000000 to have the
4010 device tree blob be copied to the maximum address
4011 of the 704 MB low memory, so that Linux kernel can
4012 access it during the boot procedure.
4013
David A. Longa28afca2011-07-09 16:40:19 -04004014 If this is set to the special value 0xFFFFFFFF then
4015 the fdt will not be copied at all on boot. For this
4016 to work it must reside in writable memory, have
4017 sufficient padding on the end of it for u-boot to
4018 add the information it needs into it, and the memory
4019 must be accessible by the kernel.
4020
Simon Glasseea63e02011-10-24 19:15:34 +00004021 fdtcontroladdr- if set this is the address of the control flattened
4022 device tree used by U-Boot when CONFIG_OF_CONTROL is
4023 defined.
4024
wdenk17ea1172004-06-06 21:51:03 +00004025 i2cfast - (PPC405GP|PPC405EP only)
4026 if set to 'y' configures Linux I2C driver for fast
4027 mode (400kHZ). This environment variable is used in
4028 initialization code. So, for changes to be effective
4029 it must be saved and board must be reset.
4030
wdenk2729af92004-05-03 20:45:30 +00004031 initrd_high - restrict positioning of initrd images:
4032 If this variable is not set, initrd images will be
4033 copied to the highest possible address in RAM; this
4034 is usually what you want since it allows for
4035 maximum initrd size. If for some reason you want to
4036 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004037 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004038 variable to a value of "no" or "off" or "0".
4039 Alternatively, you can set it to a maximum upper
4040 address to use (U-Boot will still check that it
4041 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004042
wdenk2729af92004-05-03 20:45:30 +00004043 For instance, when you have a system with 16 MB
4044 RAM, and want to reserve 4 MB from use by Linux,
4045 you can do this by adding "mem=12M" to the value of
4046 the "bootargs" variable. However, now you must make
4047 sure that the initrd image is placed in the first
4048 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052 If you set initrd_high to 0xFFFFFFFF, this is an
4053 indication to U-Boot that all addresses are legal
4054 for the Linux kernel, including addresses in flash
4055 memory. In this case U-Boot will NOT COPY the
4056 ramdisk at all. This may be useful to reduce the
4057 boot time on your system, but requires that this
4058 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004059
wdenk2729af92004-05-03 20:45:30 +00004060 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004061
wdenk2729af92004-05-03 20:45:30 +00004062 loadaddr - Default load address for commands like "bootp",
4063 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004064
wdenk2729af92004-05-03 20:45:30 +00004065 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004074
Mike Frysingere2a53452011-10-02 10:01:27 +00004075 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004076
Mike Frysingere2a53452011-10-02 10:01:27 +00004077 ethact - controls which interface is currently active.
4078 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004079
Heiko Schocher48690d82010-07-20 17:45:02 +02004080 => setenv ethact FEC
4081 => ping 192.168.0.1 # traffic sent on FEC
4082 => setenv ethact SCC
4083 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004084
Matthias Fuchse1692572008-01-17 07:45:05 +01004085 ethrotate - When set to "no" U-Boot does not go through all
4086 available network interfaces.
4087 It just stays at the currently selected interface.
4088
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004089 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004090 either succeed or fail without retrying.
4091 When set to "once" the network operation will
4092 fail when all the available network interfaces
4093 are tried once without success.
4094 Useful on scripts which control the retry operation
4095 themselves.
wdenkc6097192002-11-03 00:24:07 +00004096
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004097 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004098
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004099 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004100 UDP source port.
4101
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004102 tftpdstport - If this is set, the value is used for TFTP's UDP
4103 destination port instead of the Well Know Port 69.
4104
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004105 tftpblocksize - Block size to use for TFTP transfers; if not set,
4106 we use the TFTP server's default block size
4107
4108 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4109 seconds, minimum value is 1000 = 1 second). Defines
4110 when a packet is considered to be lost so it has to
4111 be retransmitted. The default is 5000 = 5 seconds.
4112 Lowering this value may make downloads succeed
4113 faster in networks with high packet loss rates or
4114 with unreliable TFTP servers.
4115
4116 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004117 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004118 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004119
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004120The following image location variables contain the location of images
4121used in booting. The "Image" column gives the role of the image and is
4122not an environment variable name. The other columns are environment
4123variable names. "File Name" gives the name of the file on a TFTP
4124server, "RAM Address" gives the location in RAM the image will be
4125loaded to, and "Flash Location" gives the image's address in NOR
4126flash or offset in NAND flash.
4127
4128*Note* - these variables don't have to be defined for all boards, some
4129boards currenlty use other variables for these purposes, and some
4130boards use these variables for other purposes.
4131
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004132Image File Name RAM Address Flash Location
4133----- --------- ----------- --------------
4134u-boot u-boot u-boot_addr_r u-boot_addr
4135Linux kernel bootfile kernel_addr_r kernel_addr
4136device tree blob fdtfile fdt_addr_r fdt_addr
4137ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139The following environment variables may be used and automatically
4140updated by the network boot commands ("bootp" and "rarpboot"),
4141depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143 bootfile - see above
4144 dnsip - IP address of your Domain Name Server
4145 dnsip2 - IP address of your secondary Domain Name Server
4146 gatewayip - IP address of the Gateway (Router) to use
4147 hostname - Target hostname
4148 ipaddr - see above
4149 netmask - Subnet Mask
4150 rootpath - Pathname of the root filesystem on the NFS server
4151 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004152
wdenka3d991b2004-04-15 21:48:45 +00004153
wdenk2729af92004-05-03 20:45:30 +00004154There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk2729af92004-05-03 20:45:30 +00004156 serial# - contains hardware identification information such
4157 as type string and/or serial number
4158 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk2729af92004-05-03 20:45:30 +00004160These variables can be set only once (usually during manufacturing of
4161the board). U-Boot refuses to delete or overwrite these variables
4162once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004163
4164
wdenk2729af92004-05-03 20:45:30 +00004165Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004166
wdenk2729af92004-05-03 20:45:30 +00004167 ver - Contains the U-Boot version string as printed
4168 with the "version" command. This variable is
4169 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004170
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172Please note that changes to some configuration parameters may take
4173only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004174
stroesec1551ea2003-04-04 15:53:41 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176Command Line Parsing:
4177=====================
stroesec1551ea2003-04-04 15:53:41 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179There are two different command line parsers available with U-Boot:
4180the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004181
wdenk2729af92004-05-03 20:45:30 +00004182Old, simple command line parser:
4183--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004184
wdenk2729af92004-05-03 20:45:30 +00004185- supports environment variables (through setenv / saveenv commands)
4186- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004187- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004188- special characters ('$', ';') can be escaped by prefixing with '\',
4189 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004190 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004191- You can also escape text by enclosing in single apostrophes, for example:
4192 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk2729af92004-05-03 20:45:30 +00004194Hush shell:
4195-----------
wdenkf07771c2003-05-28 08:06:31 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197- similar to Bourne shell, with control structures like
4198 if...then...else...fi, for...do...done; while...do...done,
4199 until...do...done, ...
4200- supports environment ("global") variables (through setenv / saveenv
4201 commands) and local shell variables (through standard shell syntax
4202 "name=value"); only environment variables can be used with "run"
4203 command
wdenkf07771c2003-05-28 08:06:31 +00004204
wdenk2729af92004-05-03 20:45:30 +00004205General rules:
4206--------------
wdenkf07771c2003-05-28 08:06:31 +00004207
wdenk2729af92004-05-03 20:45:30 +00004208(1) If a command line (or an environment variable executed by a "run"
4209 command) contains several commands separated by semicolon, and
4210 one of these commands fails, then the remaining commands will be
4211 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004214 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004215 command will cause "run" to terminate, i. e. the remaining
4216 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004217
wdenk2729af92004-05-03 20:45:30 +00004218Note for Redundant Ethernet Interfaces:
4219=======================================
wdenkf07771c2003-05-28 08:06:31 +00004220
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004221Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004222such configurations and is capable of automatic selection of a
4223"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4226MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4227"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229If the network interface stores some valid MAC address (for instance
4230in SROM), this is used as default address if there is NO correspon-
4231ding setting in the environment; if the corresponding environment
4232variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004233
wdenk2729af92004-05-03 20:45:30 +00004234o If the SROM has a valid MAC address, and there is no address in the
4235 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk2729af92004-05-03 20:45:30 +00004237o If there is no valid address in the SROM, and a definition in the
4238 environment exists, then the value from the environment variable is
4239 used.
wdenkc6097192002-11-03 00:24:07 +00004240
wdenk2729af92004-05-03 20:45:30 +00004241o If both the SROM and the environment contain a MAC address, and
4242 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004243
wdenk2729af92004-05-03 20:45:30 +00004244o If both the SROM and the environment contain a MAC address, and the
4245 addresses differ, the value from the environment is used and a
4246 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk2729af92004-05-03 20:45:30 +00004248o If neither SROM nor the environment contain a MAC address, an error
4249 is raised.
wdenkc6097192002-11-03 00:24:07 +00004250
Ben Warrenecee9322010-04-26 11:11:46 -07004251If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004252will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004253may be skipped by setting the appropriate 'ethmacskip' environment variable.
4254The naming convention is as follows:
4255"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257Image Formats:
4258==============
wdenkc6097192002-11-03 00:24:07 +00004259
Marian Balakowicz3310c542008-03-12 12:13:13 +01004260U-Boot is capable of booting (and performing other auxiliary operations on)
4261images in two formats:
4262
4263New uImage format (FIT)
4264-----------------------
4265
4266Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4267to Flattened Device Tree). It allows the use of images with multiple
4268components (several kernels, ramdisks, etc.), with contents protected by
4269SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4270
4271
4272Old uImage format
4273-----------------
4274
4275Old image format is based on binary files which can be basically anything,
4276preceded by a special header; see the definitions in include/image.h for
4277details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4280 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004281 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4282 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4283 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004284* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004285 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4286 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004287* Compression Type (uncompressed, gzip, bzip2)
4288* Load Address
4289* Entry Point
4290* Image Name
4291* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004292
wdenk2729af92004-05-03 20:45:30 +00004293The header is marked by a special Magic Number, and both the header
4294and the data portions of the image are secured against corruption by
4295CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004296
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk2729af92004-05-03 20:45:30 +00004298Linux Support:
4299==============
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301Although U-Boot should support any OS or standalone application
4302easily, the main focus has always been on Linux during the design of
4303U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk2729af92004-05-03 20:45:30 +00004305U-Boot includes many features that so far have been part of some
4306special "boot loader" code within the Linux kernel. Also, any
4307"initrd" images to be used are no longer part of one big Linux image;
4308instead, kernel and "initrd" are separate images. This implementation
4309serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk2729af92004-05-03 20:45:30 +00004311- the same features can be used for other OS or standalone
4312 applications (for instance: using compressed images to reduce the
4313 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315- it becomes much easier to port new Linux kernel versions because
4316 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004317
wdenk2729af92004-05-03 20:45:30 +00004318- the same Linux kernel image can now be used with different "initrd"
4319 images; of course this also means that different kernel images can
4320 be run with the same "initrd". This makes testing easier (you don't
4321 have to build a new "zImage.initrd" Linux image when you just
4322 change a file in your "initrd"). Also, a field-upgrade of the
4323 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004324
wdenkc6097192002-11-03 00:24:07 +00004325
wdenk2729af92004-05-03 20:45:30 +00004326Linux HOWTO:
4327============
wdenkc6097192002-11-03 00:24:07 +00004328
wdenk2729af92004-05-03 20:45:30 +00004329Porting Linux to U-Boot based systems:
4330---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004331
wdenk2729af92004-05-03 20:45:30 +00004332U-Boot cannot save you from doing all the necessary modifications to
4333configure the Linux device drivers for use with your target hardware
4334(no, we don't intend to provide a full virtual machine interface to
4335Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004336
Stefan Roesea47a12b2010-04-15 16:07:28 +02004337But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004338
wdenk2729af92004-05-03 20:45:30 +00004339Just make sure your machine specific header file (for instance
4340include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004341Information structure as we define in include/asm-<arch>/u-boot.h,
4342and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004343as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004344
wdenkc6097192002-11-03 00:24:07 +00004345
wdenk2729af92004-05-03 20:45:30 +00004346Configuring the Linux kernel:
4347-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004348
wdenk2729af92004-05-03 20:45:30 +00004349No specific requirements for U-Boot. Make sure you have some root
4350device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004351
wdenkc6097192002-11-03 00:24:07 +00004352
wdenk2729af92004-05-03 20:45:30 +00004353Building a Linux Image:
4354-----------------------
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4357not used. If you use recent kernel source, a new build target
4358"uImage" will exist which automatically builds an image usable by
4359U-Boot. Most older kernels also have support for a "pImage" target,
4360which was introduced for our predecessor project PPCBoot and uses a
4361100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004362
wdenk2729af92004-05-03 20:45:30 +00004363Example:
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk2729af92004-05-03 20:45:30 +00004365 make TQM850L_config
4366 make oldconfig
4367 make dep
4368 make uImage
wdenkc6097192002-11-03 00:24:07 +00004369
wdenk2729af92004-05-03 20:45:30 +00004370The "uImage" build target uses a special tool (in 'tools/mkimage') to
4371encapsulate a compressed Linux kernel image with header information,
4372CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk2729af92004-05-03 20:45:30 +00004374* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk2729af92004-05-03 20:45:30 +00004376* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk2729af92004-05-03 20:45:30 +00004378 ${CROSS_COMPILE}-objcopy -O binary \
4379 -R .note -R .comment \
4380 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk2729af92004-05-03 20:45:30 +00004384 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388 mkimage -A ppc -O linux -T kernel -C gzip \
4389 -a 0 -e 0 -n "Linux Kernel Image" \
4390 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004391
wdenk24ee89b2002-11-03 17:56:27 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393The "mkimage" tool can also be used to create ramdisk images for use
4394with U-Boot, either separated from the Linux kernel image, or
4395combined into one file. "mkimage" encapsulates the images with a 64
4396byte header containing information about target architecture,
4397operating system, image type, compression method, entry points, time
4398stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400"mkimage" can be called in two ways: to verify existing images and
4401print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403In the first form (with "-l" option) mkimage lists the information
4404contained in the header of an existing U-Boot image; this includes
4405checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004406
wdenk2729af92004-05-03 20:45:30 +00004407 tools/mkimage -l image
4408 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004409
wdenk2729af92004-05-03 20:45:30 +00004410The second form (with "-d" option) is used to build a U-Boot image
4411from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004412
wdenk2729af92004-05-03 20:45:30 +00004413 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4414 -n name -d data_file image
4415 -A ==> set architecture to 'arch'
4416 -O ==> set operating system to 'os'
4417 -T ==> set image type to 'type'
4418 -C ==> set compression type 'comp'
4419 -a ==> set load address to 'addr' (hex)
4420 -e ==> set entry point to 'ep' (hex)
4421 -n ==> set image name to 'name'
4422 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004423
wdenk69459792004-05-29 16:53:29 +00004424Right now, all Linux kernels for PowerPC systems use the same load
4425address (0x00000000), but the entry point address depends on the
4426kernel version:
wdenkc6097192002-11-03 00:24:07 +00004427
wdenk2729af92004-05-03 20:45:30 +00004428- 2.2.x kernels have the entry point at 0x0000000C,
4429- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk2729af92004-05-03 20:45:30 +00004431So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004432
wdenk2729af92004-05-03 20:45:30 +00004433 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4434 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004435 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004436 > examples/uImage.TQM850L
4437 Image Name: 2.4.4 kernel for TQM850L
4438 Created: Wed Jul 19 02:34:59 2000
4439 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4440 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4441 Load Address: 0x00000000
4442 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004443
wdenk2729af92004-05-03 20:45:30 +00004444To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004445
wdenk2729af92004-05-03 20:45:30 +00004446 -> tools/mkimage -l examples/uImage.TQM850L
4447 Image Name: 2.4.4 kernel for TQM850L
4448 Created: Wed Jul 19 02:34:59 2000
4449 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4450 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4451 Load Address: 0x00000000
4452 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk2729af92004-05-03 20:45:30 +00004454NOTE: for embedded systems where boot time is critical you can trade
4455speed for memory and install an UNCOMPRESSED image instead: this
4456needs more space in Flash, but boots much faster since it does not
4457need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004458
Stefan Roesea47a12b2010-04-15 16:07:28 +02004459 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004460 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4461 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004462 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004463 > examples/uImage.TQM850L-uncompressed
4464 Image Name: 2.4.4 kernel for TQM850L
4465 Created: Wed Jul 19 02:34:59 2000
4466 Image Type: PowerPC Linux Kernel Image (uncompressed)
4467 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4468 Load Address: 0x00000000
4469 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004470
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk2729af92004-05-03 20:45:30 +00004472Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4473when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004474
wdenk2729af92004-05-03 20:45:30 +00004475 -> tools/mkimage -n 'Simple Ramdisk Image' \
4476 > -A ppc -O linux -T ramdisk -C gzip \
4477 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4478 Image Name: Simple Ramdisk Image
4479 Created: Wed Jan 12 14:01:50 2000
4480 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4481 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4482 Load Address: 0x00000000
4483 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004484
wdenkdb01a2e2004-04-15 23:14:49 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486Installing a Linux Image:
4487-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004488
wdenk2729af92004-05-03 20:45:30 +00004489To downloading a U-Boot image over the serial (console) interface,
4490you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004491
wdenk2729af92004-05-03 20:45:30 +00004492 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004493
wdenk2729af92004-05-03 20:45:30 +00004494The 'objcopy' does not understand the information in the U-Boot
4495image header, so the resulting S-Record file will be relative to
4496address 0x00000000. To load it to a given address, you need to
4497specify the target address as 'offset' parameter with the 'loads'
4498command.
wdenkc6097192002-11-03 00:24:07 +00004499
wdenk2729af92004-05-03 20:45:30 +00004500Example: install the image to address 0x40100000 (which on the
4501TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk2729af92004-05-03 20:45:30 +00004503 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004504
wdenk2729af92004-05-03 20:45:30 +00004505 .......... done
4506 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004507
wdenk2729af92004-05-03 20:45:30 +00004508 => loads 40100000
4509 ## Ready for S-Record download ...
4510 ~>examples/image.srec
4511 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4512 ...
4513 15989 15990 15991 15992
4514 [file transfer complete]
4515 [connected]
4516 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004517
4518
wdenk2729af92004-05-03 20:45:30 +00004519You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004520this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004521corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004522
wdenk2729af92004-05-03 20:45:30 +00004523 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk2729af92004-05-03 20:45:30 +00004525 ## Checking Image at 40100000 ...
4526 Image Name: 2.2.13 for initrd on TQM850L
4527 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4528 Data Size: 335725 Bytes = 327 kB = 0 MB
4529 Load Address: 00000000
4530 Entry Point: 0000000c
4531 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004532
4533
wdenk2729af92004-05-03 20:45:30 +00004534Boot Linux:
4535-----------
wdenkc6097192002-11-03 00:24:07 +00004536
wdenk2729af92004-05-03 20:45:30 +00004537The "bootm" command is used to boot an application that is stored in
4538memory (RAM or Flash). In case of a Linux kernel image, the contents
4539of the "bootargs" environment variable is passed to the kernel as
4540parameters. You can check and modify this variable using the
4541"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004542
4543
wdenk2729af92004-05-03 20:45:30 +00004544 => printenv bootargs
4545 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk2729af92004-05-03 20:45:30 +00004547 => 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 +00004548
wdenk2729af92004-05-03 20:45:30 +00004549 => printenv bootargs
4550 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 +00004551
wdenk2729af92004-05-03 20:45:30 +00004552 => bootm 40020000
4553 ## Booting Linux kernel at 40020000 ...
4554 Image Name: 2.2.13 for NFS on TQM850L
4555 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4556 Data Size: 381681 Bytes = 372 kB = 0 MB
4557 Load Address: 00000000
4558 Entry Point: 0000000c
4559 Verifying Checksum ... OK
4560 Uncompressing Kernel Image ... OK
4561 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
4562 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4563 time_init: decrementer frequency = 187500000/60
4564 Calibrating delay loop... 49.77 BogoMIPS
4565 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4566 ...
wdenkc6097192002-11-03 00:24:07 +00004567
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004568If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004569the memory addresses of both the kernel and the initrd image (PPBCOOT
4570format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk2729af92004-05-03 20:45:30 +00004572 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 ## Checking Image at 40100000 ...
4575 Image Name: 2.2.13 for initrd on TQM850L
4576 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4577 Data Size: 335725 Bytes = 327 kB = 0 MB
4578 Load Address: 00000000
4579 Entry Point: 0000000c
4580 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004581
wdenk2729af92004-05-03 20:45:30 +00004582 ## Checking Image at 40200000 ...
4583 Image Name: Simple Ramdisk Image
4584 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4585 Data Size: 566530 Bytes = 553 kB = 0 MB
4586 Load Address: 00000000
4587 Entry Point: 00000000
4588 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590 => bootm 40100000 40200000
4591 ## Booting Linux kernel at 40100000 ...
4592 Image Name: 2.2.13 for initrd on TQM850L
4593 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4594 Data Size: 335725 Bytes = 327 kB = 0 MB
4595 Load Address: 00000000
4596 Entry Point: 0000000c
4597 Verifying Checksum ... OK
4598 Uncompressing Kernel Image ... OK
4599 ## Loading RAMDisk Image at 40200000 ...
4600 Image Name: Simple Ramdisk Image
4601 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4602 Data Size: 566530 Bytes = 553 kB = 0 MB
4603 Load Address: 00000000
4604 Entry Point: 00000000
4605 Verifying Checksum ... OK
4606 Loading Ramdisk ... OK
4607 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
4608 Boot arguments: root=/dev/ram
4609 time_init: decrementer frequency = 187500000/60
4610 Calibrating delay loop... 49.77 BogoMIPS
4611 ...
4612 RAMDISK: Compressed image found at block 0
4613 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004614
wdenk2729af92004-05-03 20:45:30 +00004615 bash#
wdenkc6097192002-11-03 00:24:07 +00004616
Matthew McClintock02677682006-06-28 10:41:37 -05004617Boot Linux and pass a flat device tree:
4618-----------
4619
4620First, U-Boot must be compiled with the appropriate defines. See the section
4621titled "Linux Kernel Interface" above for a more in depth explanation. The
4622following is an example of how to start a kernel and pass an updated
4623flat device tree:
4624
4625=> print oftaddr
4626oftaddr=0x300000
4627=> print oft
4628oft=oftrees/mpc8540ads.dtb
4629=> tftp $oftaddr $oft
4630Speed: 1000, full duplex
4631Using TSEC0 device
4632TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4633Filename 'oftrees/mpc8540ads.dtb'.
4634Load address: 0x300000
4635Loading: #
4636done
4637Bytes transferred = 4106 (100a hex)
4638=> tftp $loadaddr $bootfile
4639Speed: 1000, full duplex
4640Using TSEC0 device
4641TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4642Filename 'uImage'.
4643Load address: 0x200000
4644Loading:############
4645done
4646Bytes transferred = 1029407 (fb51f hex)
4647=> print loadaddr
4648loadaddr=200000
4649=> print oftaddr
4650oftaddr=0x300000
4651=> bootm $loadaddr - $oftaddr
4652## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004653 Image Name: Linux-2.6.17-dirty
4654 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4655 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004656 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004657 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004658 Verifying Checksum ... OK
4659 Uncompressing Kernel Image ... OK
4660Booting using flat device tree at 0x300000
4661Using MPC85xx ADS machine description
4662Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4663[snip]
4664
4665
wdenk2729af92004-05-03 20:45:30 +00004666More About U-Boot Image Types:
4667------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004668
wdenk2729af92004-05-03 20:45:30 +00004669U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004670
wdenk2729af92004-05-03 20:45:30 +00004671 "Standalone Programs" are directly runnable in the environment
4672 provided by U-Boot; it is expected that (if they behave
4673 well) you can continue to work in U-Boot after return from
4674 the Standalone Program.
4675 "OS Kernel Images" are usually images of some Embedded OS which
4676 will take over control completely. Usually these programs
4677 will install their own set of exception handlers, device
4678 drivers, set up the MMU, etc. - this means, that you cannot
4679 expect to re-enter U-Boot except by resetting the CPU.
4680 "RAMDisk Images" are more or less just data blocks, and their
4681 parameters (address, size) are passed to an OS kernel that is
4682 being started.
4683 "Multi-File Images" contain several images, typically an OS
4684 (Linux) kernel image and one or more data images like
4685 RAMDisks. This construct is useful for instance when you want
4686 to boot over the network using BOOTP etc., where the boot
4687 server provides just a single image file, but you want to get
4688 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004689
wdenk2729af92004-05-03 20:45:30 +00004690 "Multi-File Images" start with a list of image sizes, each
4691 image size (in bytes) specified by an "uint32_t" in network
4692 byte order. This list is terminated by an "(uint32_t)0".
4693 Immediately after the terminating 0 follow the images, one by
4694 one, all aligned on "uint32_t" boundaries (size rounded up to
4695 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004696
wdenk2729af92004-05-03 20:45:30 +00004697 "Firmware Images" are binary images containing firmware (like
4698 U-Boot or FPGA images) which usually will be programmed to
4699 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004700
wdenk2729af92004-05-03 20:45:30 +00004701 "Script files" are command sequences that will be executed by
4702 U-Boot's command interpreter; this feature is especially
4703 useful when you configure U-Boot to use a real shell (hush)
4704 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004705
Marek Vasut44f074c2012-03-14 21:52:45 +00004706Booting the Linux zImage:
4707-------------------------
4708
4709On some platforms, it's possible to boot Linux zImage. This is done
4710using the "bootz" command. The syntax of "bootz" command is the same
4711as the syntax of "bootm" command.
4712
Marek Vasut017e1f32012-03-18 11:47:58 +00004713Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4714kernel with raw initrd images. The syntax is slightly different, the
4715address of the initrd must be augmented by it's size, in the following
4716format: "<initrd addres>:<initrd size>".
4717
wdenkc6097192002-11-03 00:24:07 +00004718
wdenk2729af92004-05-03 20:45:30 +00004719Standalone HOWTO:
4720=================
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722One of the features of U-Boot is that you can dynamically load and
4723run "standalone" applications, which can use some resources of
4724U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk2729af92004-05-03 20:45:30 +00004726Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk2729af92004-05-03 20:45:30 +00004728"Hello World" Demo:
4729-------------------
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk2729af92004-05-03 20:45:30 +00004731'examples/hello_world.c' contains a small "Hello World" Demo
4732application; it is automatically compiled when you build U-Boot.
4733It's configured to run at address 0x00040004, so you can play with it
4734like that:
wdenkc6097192002-11-03 00:24:07 +00004735
wdenk2729af92004-05-03 20:45:30 +00004736 => loads
4737 ## Ready for S-Record download ...
4738 ~>examples/hello_world.srec
4739 1 2 3 4 5 6 7 8 9 10 11 ...
4740 [file transfer complete]
4741 [connected]
4742 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004743
wdenk2729af92004-05-03 20:45:30 +00004744 => go 40004 Hello World! This is a test.
4745 ## Starting application at 0x00040004 ...
4746 Hello World
4747 argc = 7
4748 argv[0] = "40004"
4749 argv[1] = "Hello"
4750 argv[2] = "World!"
4751 argv[3] = "This"
4752 argv[4] = "is"
4753 argv[5] = "a"
4754 argv[6] = "test."
4755 argv[7] = "<NULL>"
4756 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004757
wdenk2729af92004-05-03 20:45:30 +00004758 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk2729af92004-05-03 20:45:30 +00004760Another example, which demonstrates how to register a CPM interrupt
4761handler with the U-Boot code, can be found in 'examples/timer.c'.
4762Here, a CPM timer is set up to generate an interrupt every second.
4763The interrupt service routine is trivial, just printing a '.'
4764character, but this is just a demo program. The application can be
4765controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk2729af92004-05-03 20:45:30 +00004767 ? - print current values og the CPM Timer registers
4768 b - enable interrupts and start timer
4769 e - stop timer and disable interrupts
4770 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk2729af92004-05-03 20:45:30 +00004772 => loads
4773 ## Ready for S-Record download ...
4774 ~>examples/timer.srec
4775 1 2 3 4 5 6 7 8 9 10 11 ...
4776 [file transfer complete]
4777 [connected]
4778 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk2729af92004-05-03 20:45:30 +00004780 => go 40004
4781 ## Starting application at 0x00040004 ...
4782 TIMERS=0xfff00980
4783 Using timer 1
4784 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk2729af92004-05-03 20:45:30 +00004786Hit 'b':
4787 [q, b, e, ?] Set interval 1000000 us
4788 Enabling timer
4789Hit '?':
4790 [q, b, e, ?] ........
4791 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4792Hit '?':
4793 [q, b, e, ?] .
4794 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4795Hit '?':
4796 [q, b, e, ?] .
4797 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4798Hit '?':
4799 [q, b, e, ?] .
4800 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4801Hit 'e':
4802 [q, b, e, ?] ...Stopping timer
4803Hit 'q':
4804 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004805
4806
wdenk2729af92004-05-03 20:45:30 +00004807Minicom warning:
4808================
wdenk85ec0bc2003-03-31 16:34:49 +00004809
wdenk2729af92004-05-03 20:45:30 +00004810Over time, many people have reported problems when trying to use the
4811"minicom" terminal emulation program for serial download. I (wd)
4812consider minicom to be broken, and recommend not to use it. Under
4813Unix, I recommend to use C-Kermit for general purpose use (and
4814especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004815use "cu" for S-Record download ("loads" command). See
4816http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4817for help with kermit.
4818
wdenk85ec0bc2003-03-31 16:34:49 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820Nevertheless, if you absolutely want to use it try adding this
4821configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004822
wdenk2729af92004-05-03 20:45:30 +00004823 Name Program Name U/D FullScr IO-Red. Multi
4824 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4825 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004826
4827
wdenk2729af92004-05-03 20:45:30 +00004828NetBSD Notes:
4829=============
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk2729af92004-05-03 20:45:30 +00004831Starting at version 0.9.2, U-Boot supports NetBSD both as host
4832(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834Building requires a cross environment; it is known to work on
4835NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4836need gmake since the Makefiles are not compatible with BSD make).
4837Note that the cross-powerpc package does not install include files;
4838attempting to build U-Boot will fail because <machine/ansi.h> is
4839missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk2729af92004-05-03 20:45:30 +00004841 # cd /usr/pkg/cross/powerpc-netbsd/include
4842 # mkdir powerpc
4843 # ln -s powerpc machine
4844 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4845 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk2729af92004-05-03 20:45:30 +00004847Native builds *don't* work due to incompatibilities between native
4848and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004849
wdenk2729af92004-05-03 20:45:30 +00004850Booting assumes that (the first part of) the image booted is a
4851stage-2 loader which in turn loads and then invokes the kernel
4852proper. Loader sources will eventually appear in the NetBSD source
4853tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004854meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004855
4856
wdenk2729af92004-05-03 20:45:30 +00004857Implementation Internals:
4858=========================
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk2729af92004-05-03 20:45:30 +00004860The following is not intended to be a complete description of every
4861implementation detail. However, it should help to understand the
4862inner workings of U-Boot and make it easier to port it to custom
4863hardware.
wdenkc6097192002-11-03 00:24:07 +00004864
4865
wdenk2729af92004-05-03 20:45:30 +00004866Initial Stack, Global Data:
4867---------------------------
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869The implementation of U-Boot is complicated by the fact that U-Boot
4870starts running out of ROM (flash memory), usually without access to
4871system RAM (because the memory controller is not initialized yet).
4872This means that we don't have writable Data or BSS segments, and BSS
4873is not initialized as zero. To be able to get a C environment working
4874at all, we have to allocate at least a minimal stack. Implementation
4875options for this are defined and restricted by the CPU used: Some CPU
4876models provide on-chip memory (like the IMMR area on MPC8xx and
4877MPC826x processors), on others (parts of) the data cache can be
4878locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004879
Wolfgang Denk218ca722008-03-26 10:40:12 +01004880 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004881 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004882
wdenk2729af92004-05-03 20:45:30 +00004883 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4884 From: "Chris Hallinan" <clh@net1plus.com>
4885 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4886 ...
wdenk43d96162003-03-06 00:02:04 +00004887
wdenk2729af92004-05-03 20:45:30 +00004888 Correct me if I'm wrong, folks, but the way I understand it
4889 is this: Using DCACHE as initial RAM for Stack, etc, does not
4890 require any physical RAM backing up the cache. The cleverness
4891 is that the cache is being used as a temporary supply of
4892 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004893 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004894 can see how this works by studying the cache architecture and
4895 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004896
wdenk2729af92004-05-03 20:45:30 +00004897 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4898 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004899 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004900 option should work for you. Using CS 4 should be fine if your
4901 board designers haven't used it for something that would
4902 cause you grief during the initial boot! It is frequently not
4903 used.
wdenk43d96162003-03-06 00:02:04 +00004904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004905 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004906 with your processor/board/system design. The default value
4907 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004908 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004909 than your SDRAM module. If you have a 64MB SDRAM module, set
4910 it above 400_0000. Just make sure your board has no resources
4911 that are supposed to respond to that address! That code in
4912 start.S has been around a while and should work as is when
4913 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004914
wdenk2729af92004-05-03 20:45:30 +00004915 -Chris Hallinan
4916 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004917
wdenk2729af92004-05-03 20:45:30 +00004918It is essential to remember this, since it has some impact on the C
4919code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk2729af92004-05-03 20:45:30 +00004921* Initialized global data (data segment) is read-only. Do not attempt
4922 to write it.
wdenkc6097192002-11-03 00:24:07 +00004923
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004924* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004925 as zero data - BSS segment) at all - this is undefined, initiali-
4926 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk2729af92004-05-03 20:45:30 +00004928* Stack space is very limited. Avoid big data buffers or things like
4929 that.
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931Having only the stack as writable memory limits means we cannot use
4932normal global data to share information beween the code. But it
4933turned out that the implementation of U-Boot can be greatly
4934simplified by making a global data structure (gd_t) available to all
4935functions. We could pass a pointer to this data as argument to _all_
4936functions, but this would bloat the code. Instead we use a feature of
4937the GCC compiler (Global Register Variables) to share the data: we
4938place a pointer (gd) to the global data into a register which we
4939reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004940
wdenk2729af92004-05-03 20:45:30 +00004941When choosing a register for such a purpose we are restricted by the
4942relevant (E)ABI specifications for the current architecture, and by
4943GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk2729af92004-05-03 20:45:30 +00004945For PowerPC, the following registers have specific use:
4946 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004947 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004948 R3-R4: parameter passing and return values
4949 R5-R10: parameter passing
4950 R13: small data area pointer
4951 R30: GOT pointer
4952 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004953
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004954 (U-Boot also uses R12 as internal GOT pointer. r12
4955 is a volatile register so r12 needs to be reset when
4956 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004957
Wolfgang Denke7670f62008-02-14 22:43:22 +01004958 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk2729af92004-05-03 20:45:30 +00004960 Note: on PPC, we could use a static initializer (since the
4961 address of the global data structure is known at compile time),
4962 but it turned out that reserving a register results in somewhat
4963 smaller code - although the code savings are not that big (on
4964 average for all boards 752 bytes for the whole U-Boot image,
4965 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004966
Robin Getzc4db3352009-08-17 15:23:02 +00004967On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004968 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4969
Robin Getzc4db3352009-08-17 15:23:02 +00004970 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004971
wdenk2729af92004-05-03 20:45:30 +00004972On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk2729af92004-05-03 20:45:30 +00004974 R0: function argument word/integer result
4975 R1-R3: function argument word
4976 R9: GOT pointer
4977 R10: stack limit (used only if stack checking if enabled)
4978 R11: argument (frame) pointer
4979 R12: temporary workspace
4980 R13: stack pointer
4981 R14: link register
4982 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004985
Thomas Chou0df01fd2010-05-21 11:08:03 +08004986On Nios II, the ABI is documented here:
4987 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4988
4989 ==> U-Boot will use gp to hold a pointer to the global data
4990
4991 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4992 to access small data sections, so gp is free.
4993
Macpaul Linafc1ce82011-10-19 20:41:11 +00004994On NDS32, the following registers are used:
4995
4996 R0-R1: argument/return
4997 R2-R5: argument
4998 R15: temporary register for assembler
4999 R16: trampoline register
5000 R28: frame pointer (FP)
5001 R29: global pointer (GP)
5002 R30: link register (LP)
5003 R31: stack pointer (SP)
5004 PC: program counter (PC)
5005
5006 ==> U-Boot will use R10 to hold a pointer to the global data
5007
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005008NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5009or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011Memory Management:
5012------------------
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk2729af92004-05-03 20:45:30 +00005014U-Boot runs in system state and uses physical addresses, i.e. the
5015MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005016
wdenk2729af92004-05-03 20:45:30 +00005017The available memory is mapped to fixed addresses using the memory
5018controller. In this process, a contiguous block is formed for each
5019memory type (Flash, SDRAM, SRAM), even when it consists of several
5020physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk2729af92004-05-03 20:45:30 +00005022U-Boot is installed in the first 128 kB of the first Flash bank (on
5023TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5024booting and sizing and initializing DRAM, the code relocates itself
5025to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005026memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005027configuration setting]. Below that, a structure with global Board
5028Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk2729af92004-05-03 20:45:30 +00005030Additionally, some exception handler code is copied to the low 8 kB
5031of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033So a typical memory configuration with 16 MB of DRAM could look like
5034this:
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036 0x0000 0000 Exception Vector code
5037 :
5038 0x0000 1FFF
5039 0x0000 2000 Free for Application Use
5040 :
5041 :
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk2729af92004-05-03 20:45:30 +00005043 :
5044 :
5045 0x00FB FF20 Monitor Stack (Growing downward)
5046 0x00FB FFAC Board Info Data and permanent copy of global data
5047 0x00FC 0000 Malloc Arena
5048 :
5049 0x00FD FFFF
5050 0x00FE 0000 RAM Copy of Monitor Code
5051 ... eventually: LCD or video framebuffer
5052 ... eventually: pRAM (Protected RAM - unchanged by reset)
5053 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005054
5055
wdenk2729af92004-05-03 20:45:30 +00005056System Initialization:
5057----------------------
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk2729af92004-05-03 20:45:30 +00005059In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005060(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005061configuration for CS0# this is a mirror of the onboard Flash memory.
5062To be able to re-map memory U-Boot then jumps to its link address.
5063To be able to implement the initialization code in C, a (small!)
5064initial stack is set up in the internal Dual Ported RAM (in case CPUs
5065which provide such a feature like MPC8xx or MPC8260), or in a locked
5066part of the data cache. After that, U-Boot initializes the CPU core,
5067the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069Next, all (potentially) available memory banks are mapped using a
5070preliminary mapping. For example, we put them on 512 MB boundaries
5071(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5072on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5073programmed for SDRAM access. Using the temporary configuration, a
5074simple memory test is run that determines the size of the SDRAM
5075banks.
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk2729af92004-05-03 20:45:30 +00005077When there is more than one SDRAM bank, and the banks are of
5078different size, the largest is mapped first. For equal size, the first
5079bank (CS2#) is mapped first. The first mapping is always for address
50800x00000000, with any additional banks following immediately to create
5081contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005082
wdenk2729af92004-05-03 20:45:30 +00005083Then, the monitor installs itself at the upper end of the SDRAM area
5084and allocates memory for use by malloc() and for the global Board
5085Info data; also, the exception vector code is copied to the low RAM
5086pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk2729af92004-05-03 20:45:30 +00005088Only after this relocation will you have a "normal" C environment;
5089until that you are restricted in several ways, mostly because you are
5090running from ROM, and because the code will have to be relocated to a
5091new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005092
5093
wdenk2729af92004-05-03 20:45:30 +00005094U-Boot Porting Guide:
5095----------------------
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk2729af92004-05-03 20:45:30 +00005097[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5098list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005099
5100
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005101int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005102{
5103 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005104
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005105 signal(SIGALRM, no_more_time);
5106 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005107
wdenk2729af92004-05-03 20:45:30 +00005108 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005109 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005110 return 0;
5111 }
5112
wdenk2729af92004-05-03 20:45:30 +00005113 Download latest U-Boot source;
5114
Wolfgang Denk06682362008-12-30 22:56:11 +01005115 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005116
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005117 if (clueless)
5118 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk2729af92004-05-03 20:45:30 +00005120 while (learning) {
5121 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005122 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5123 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005124 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005125 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005126 }
wdenkc6097192002-11-03 00:24:07 +00005127
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005128 if (available_money > toLocalCurrency ($2500))
5129 Buy a BDI3000;
5130 else
wdenk2729af92004-05-03 20:45:30 +00005131 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005132
5133 if (a similar board exists) { /* hopefully... */
5134 cp -a board/<similar> board/<myboard>
5135 cp include/configs/<similar>.h include/configs/<myboard>.h
5136 } else {
5137 Create your own board support subdirectory;
5138 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005139 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005140 Edit new board/<myboard> files
5141 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005142
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005143 while (!accepted) {
5144 while (!running) {
5145 do {
5146 Add / modify source code;
5147 } until (compiles);
5148 Debug;
5149 if (clueless)
5150 email("Hi, I am having problems...");
5151 }
5152 Send patch file to the U-Boot email list;
5153 if (reasonable critiques)
5154 Incorporate improvements from email list code review;
5155 else
5156 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005157 }
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159 return 0;
5160}
5161
5162void no_more_time (int sig)
5163{
5164 hire_a_guru();
5165}
wdenkc6097192002-11-03 00:24:07 +00005166
5167
wdenk2729af92004-05-03 20:45:30 +00005168Coding Standards:
5169-----------------
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005172coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005173"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005174
Detlev Zundel2c051652006-09-01 15:39:02 +02005175Source files originating from a different project (for example the
5176MTD subsystem) are generally exempt from these guidelines and are not
5177reformated to ease subsequent migration to newer versions of those
5178sources.
5179
5180Please note that U-Boot is implemented in C (and to some small parts in
5181Assembler); no C++ is used, so please do not use C++ style comments (//)
5182in your code.
wdenk2729af92004-05-03 20:45:30 +00005183
5184Please also stick to the following formatting rules:
5185- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005186- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005187- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005188- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005189- do not add trailing empty lines to source files
5190
5191Submissions which do not conform to the standards may be returned
5192with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005193
5194
wdenk2729af92004-05-03 20:45:30 +00005195Submitting Patches:
5196-------------------
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +00005198Since the number of patches for U-Boot is growing, we need to
5199establish some rules. Submissions which do not conform to these rules
5200may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005201
Magnus Lilja0d28f342008-08-06 19:32:33 +02005202Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005203
Wolfgang Denk06682362008-12-30 22:56:11 +01005204Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5205see http://lists.denx.de/mailman/listinfo/u-boot
5206
wdenk2729af92004-05-03 20:45:30 +00005207When you send a patch, please include the following information with
5208it:
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk2729af92004-05-03 20:45:30 +00005210* For bug fixes: a description of the bug and how your patch fixes
5211 this bug. Please try to include a way of demonstrating that the
5212 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005213
wdenk2729af92004-05-03 20:45:30 +00005214* For new features: a description of the feature and your
5215 implementation.
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk2729af92004-05-03 20:45:30 +00005217* A CHANGELOG entry as plaintext (separate from the patch)
5218
5219* For major contributions, your entry to the CREDITS file
5220
5221* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005222 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005223
5224* If your patch adds new configuration options, don't forget to
5225 document these in the README file.
5226
Wolfgang Denk218ca722008-03-26 10:40:12 +01005227* The patch itself. If you are using git (which is *strongly*
5228 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005229 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005230 the U-Boot mailing list, you will avoid most of the common problems
5231 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005232
Wolfgang Denk218ca722008-03-26 10:40:12 +01005233 If you cannot use git, use "diff -purN OLD NEW". If your version of
5234 diff does not support these options, then get the latest version of
5235 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005236
Wolfgang Denk218ca722008-03-26 10:40:12 +01005237 The current directory when running this command shall be the parent
5238 directory of the U-Boot source tree (i. e. please make sure that
5239 your patch includes sufficient directory information for the
5240 affected files).
5241
5242 We prefer patches as plain text. MIME attachments are discouraged,
5243 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005244
5245* If one logical set of modifications affects or creates several
5246 files, all these changes shall be submitted in a SINGLE patch file.
5247
5248* Changesets that contain different, unrelated modifications shall be
5249 submitted as SEPARATE patches, one patch per changeset.
5250
5251
5252Notes:
5253
5254* Before sending the patch, run the MAKEALL script on your patched
5255 source tree and make sure that no errors or warnings are reported
5256 for any of the boards.
5257
5258* Keep your modifications to the necessary minimum: A patch
5259 containing several unrelated changes or arbitrary reformats will be
5260 returned with a request to re-formatting / split it.
5261
5262* If you modify existing code, make sure that your new code does not
5263 add to the memory footprint of the code ;-) Small is beautiful!
5264 When adding new features, these should compile conditionally only
5265 (using #ifdef), and the resulting code with the new feature
5266 disabled must not need more memory than the old code without your
5267 modification.
wdenk90dc6702005-05-03 14:12:25 +00005268
Wolfgang Denk06682362008-12-30 22:56:11 +01005269* Remember that there is a size limit of 100 kB per message on the
5270 u-boot mailing list. Bigger patches will be moderated. If they are
5271 reasonable and not too big, they will be acknowledged. But patches
5272 bigger than the size limit should be avoided.