blob: ac61a32adf33c471887111515a9d677a902d4146 [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
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600818 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500819 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000820 CONFIG_CMD_EXT2 * ext2 command support
821 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500822 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500823 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000824 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500825 CONFIG_CMD_FDOS * Dos diskette Support
826 CONFIG_CMD_FLASH flinfo, erase, protect
827 CONFIG_CMD_FPGA FPGA device initialization support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000828 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500829 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000830 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000831 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500832 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
833 CONFIG_CMD_I2C * I2C serial bus support
834 CONFIG_CMD_IDE * IDE harddisk support
835 CONFIG_CMD_IMI iminfo
836 CONFIG_CMD_IMLS List all found images
837 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500838 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000839 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500840 CONFIG_CMD_IRQ * irqinfo
841 CONFIG_CMD_ITEST Integer/string test of 2 values
842 CONFIG_CMD_JFFS2 * JFFS2 Support
843 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500844 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000845 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
846 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500847 CONFIG_CMD_LOADB loadb
848 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400849 CONFIG_CMD_MD5SUM print md5 message digest
850 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500851 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
852 loop, loopw, mtest
853 CONFIG_CMD_MISC Misc functions like sleep etc
854 CONFIG_CMD_MMC * MMC memory mapped support
855 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100856 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500857 CONFIG_CMD_NAND * NAND support
858 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600859 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000860 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500861 CONFIG_CMD_PCI * pciinfo
862 CONFIG_CMD_PCMCIA * PCMCIA support
863 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
864 host
865 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000866 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 CONFIG_CMD_REGINFO * Register dump
868 CONFIG_CMD_RUN run command in env variable
869 CONFIG_CMD_SAVES * save S record dump
870 CONFIG_CMD_SCSI * SCSI Support
871 CONFIG_CMD_SDRAM * print SDRAM configuration information
872 (requires CONFIG_CMD_I2C)
873 CONFIG_CMD_SETGETDCR Support for DCR Register access
874 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700875 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100876 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400877 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200878 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500879 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000880 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000881 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000882 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
883 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500884 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500885 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000886 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000887
wdenkc6097192002-11-03 00:24:07 +0000888
889 EXAMPLE: If you want all functions except of network
890 support you can write:
891
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500892 #include "config_cmd_all.h"
893 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000894
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400895 Other Commands:
896 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000897
898 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500899 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000900 what you (and your U-Boot users) are doing. Data
901 cache cannot be enabled on systems like the 8xx or
902 8260 (where accesses to the IMMR region must be
903 uncached), and it cannot be disabled on all other
904 systems where we (mis-) use the data cache to hold an
905 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000906
907
908 XXX - this list needs to get updated!
909
Simon Glass45ba8072011-10-15 05:48:20 +0000910- Device tree:
911 CONFIG_OF_CONTROL
912 If this variable is defined, U-Boot will use a device tree
913 to configure its devices, instead of relying on statically
914 compiled #defines in the board file. This option is
915 experimental and only available on a few boards. The device
916 tree is available in the global data as gd->fdt_blob.
917
Simon Glass2c0f79e2011-10-24 19:15:31 +0000918 U-Boot needs to get its device tree from somewhere. This can
919 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000920
921 CONFIG_OF_EMBED
922 If this variable is defined, U-Boot will embed a device tree
923 binary in its image. This device tree file should be in the
924 board directory and called <soc>-<board>.dts. The binary file
925 is then picked up in board_init_f() and made available through
926 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000927
Simon Glass2c0f79e2011-10-24 19:15:31 +0000928 CONFIG_OF_SEPARATE
929 If this variable is defined, U-Boot will build a device tree
930 binary. It will be called u-boot.dtb. Architecture-specific
931 code will locate it at run-time. Generally this works by:
932
933 cat u-boot.bin u-boot.dtb >image.bin
934
935 and in fact, U-Boot does this for you, creating a file called
936 u-boot-dtb.bin which is useful in the common case. You can
937 still use the individual files if you need something more
938 exotic.
939
wdenkc6097192002-11-03 00:24:07 +0000940- Watchdog:
941 CONFIG_WATCHDOG
942 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000943 support for the SoC. There must be support in the SoC
944 specific code for a watchdog. For the 8xx and 8260
945 CPUs, the SIU Watchdog feature is enabled in the SYPCR
946 register. When supported for a specific SoC is
947 available, then no further board specific code should
948 be needed to use it.
949
950 CONFIG_HW_WATCHDOG
951 When using a watchdog circuitry external to the used
952 SoC, then define this variable and provide board
953 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000954
stroesec1551ea2003-04-04 15:53:41 +0000955- U-Boot Version:
956 CONFIG_VERSION_VARIABLE
957 If this variable is defined, an environment variable
958 named "ver" is created by U-Boot showing the U-Boot
959 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200960 Any change to this variable will be reverted at the
961 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000962
wdenkc6097192002-11-03 00:24:07 +0000963- Real-Time Clock:
964
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500965 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000966 has to be selected, too. Define exactly one of the
967 following options:
968
969 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
970 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000971 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000972 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000973 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000974 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000975 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000976 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100977 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000978 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200979 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200980 CONFIG_SYS_RV3029_TCR - enable trickle charger on
981 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000982
wdenkb37c7e52003-06-30 16:24:52 +0000983 Note that if the RTC uses I2C, then the I2C interface
984 must also be configured. See I2C Support, below.
985
Peter Tysere92739d2008-12-17 16:36:21 -0600986- GPIO Support:
987 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
988 CONFIG_PCA953X_INFO - enable pca953x info command
989
Chris Packham5dec49c2010-12-19 10:12:13 +0000990 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
991 chip-ngpio pairs that tell the PCA953X driver the number of
992 pins supported by a particular chip.
993
Peter Tysere92739d2008-12-17 16:36:21 -0600994 Note that if the GPIO device uses I2C, then the I2C interface
995 must also be configured. See I2C Support, below.
996
wdenkc6097192002-11-03 00:24:07 +0000997- Timestamp Support:
998
wdenk43d96162003-03-06 00:02:04 +0000999 When CONFIG_TIMESTAMP is selected, the timestamp
1000 (date and time) of an image is printed by image
1001 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001003
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001004- Partition Labels (disklabels) Supported:
1005 Zero or more of the following:
1006 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1007 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1008 Intel architecture, USB sticks, etc.
1009 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1010 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1011 bootloader. Note 2TB partition limit; see
1012 disk/part_efi.c
1013 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001014
Wolfgang Denk218ca722008-03-26 10:40:12 +01001015 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1016 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001017 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001018
1019- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001020 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1021 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001022
wdenk4d13cba2004-03-14 14:09:05 +00001023 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1024 be performed by calling the function
1025 ide_set_reset(int reset)
1026 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001027
1028- ATAPI Support:
1029 CONFIG_ATAPI
1030
1031 Set this to enable ATAPI support.
1032
wdenkc40b2952004-03-13 23:29:43 +00001033- LBA48 Support
1034 CONFIG_LBA48
1035
1036 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001037 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001038 Whithout these , LBA48 support uses 32bit variables and will 'only'
1039 support disks up to 2.1TB.
1040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001041 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001042 When enabled, makes the IDE subsystem use 64bit sector addresses.
1043 Default is 32bit.
1044
wdenkc6097192002-11-03 00:24:07 +00001045- SCSI Support:
1046 At the moment only there is only support for the
1047 SYM53C8XX SCSI controller; define
1048 CONFIG_SCSI_SYM53C8XX to enable it.
1049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001050 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1051 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1052 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001053 maximum numbers of LUNs, SCSI ID's and target
1054 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001055 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001056
Stefan Reinauer447c0312012-10-29 05:23:48 +00001057 The environment variable 'scsidevs' is set to the number of
1058 SCSI devices found during the last scan.
1059
wdenkc6097192002-11-03 00:24:07 +00001060- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001061 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001062 Support for Intel 8254x/8257x gigabit chips.
1063
1064 CONFIG_E1000_SPI
1065 Utility code for direct access to the SPI bus on Intel 8257x.
1066 This does not do anything useful unless you set at least one
1067 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1068
1069 CONFIG_E1000_SPI_GENERIC
1070 Allow generic access to the SPI bus on the Intel 8257x, for
1071 example with the "sspi" command.
1072
1073 CONFIG_CMD_E1000
1074 Management command for E1000 devices. When used on devices
1075 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001076
Andre Schwarzac3315c2008-03-06 16:45:44 +01001077 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001078 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001079
wdenkc6097192002-11-03 00:24:07 +00001080 CONFIG_EEPRO100
1081 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001082 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001083 write routine for first time initialisation.
1084
1085 CONFIG_TULIP
1086 Support for Digital 2114x chips.
1087 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1088 modem chip initialisation (KS8761/QS6611).
1089
1090 CONFIG_NATSEMI
1091 Support for National dp83815 chips.
1092
1093 CONFIG_NS8382X
1094 Support for National dp8382[01] gigabit chips.
1095
wdenk45219c42003-05-12 21:50:16 +00001096- NETWORK Support (other):
1097
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001098 CONFIG_DRIVER_AT91EMAC
1099 Support for AT91RM9200 EMAC.
1100
1101 CONFIG_RMII
1102 Define this to use reduced MII inteface
1103
1104 CONFIG_DRIVER_AT91EMAC_QUIET
1105 If this defined, the driver is quiet.
1106 The driver doen't show link status messages.
1107
Rob Herringefdd7312011-12-15 11:15:49 +00001108 CONFIG_CALXEDA_XGMAC
1109 Support for the Calxeda XGMAC device
1110
Ashok3bb46d22012-10-15 06:20:47 +00001111 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001112 Support for SMSC's LAN91C96 chips.
1113
1114 CONFIG_LAN91C96_BASE
1115 Define this to hold the physical address
1116 of the LAN91C96's I/O space
1117
1118 CONFIG_LAN91C96_USE_32_BIT
1119 Define this to enable 32 bit addressing
1120
Ashok3bb46d22012-10-15 06:20:47 +00001121 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001122 Support for SMSC's LAN91C111 chip
1123
1124 CONFIG_SMC91111_BASE
1125 Define this to hold the physical address
1126 of the device (I/O space)
1127
1128 CONFIG_SMC_USE_32_BIT
1129 Define this if data bus is 32 bits
1130
1131 CONFIG_SMC_USE_IOFUNCS
1132 Define this to use i/o functions instead of macros
1133 (some hardware wont work with macros)
1134
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001135 CONFIG_DRIVER_TI_EMAC
1136 Support for davinci emac
1137
1138 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1139 Define this if you have more then 3 PHYs.
1140
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001141 CONFIG_FTGMAC100
1142 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1143
1144 CONFIG_FTGMAC100_EGIGA
1145 Define this to use GE link update with gigabit PHY.
1146 Define this if FTGMAC100 is connected to gigabit PHY.
1147 If your system has 10/100 PHY only, it might not occur
1148 wrong behavior. Because PHY usually return timeout or
1149 useless data when polling gigabit status and gigabit
1150 control registers. This behavior won't affect the
1151 correctnessof 10/100 link speed update.
1152
Mike Rapoportc2fff332009-11-11 10:03:03 +02001153 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001154 Support for SMSC's LAN911x and LAN921x chips
1155
Mike Rapoportc2fff332009-11-11 10:03:03 +02001156 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001157 Define this to hold the physical address
1158 of the device (I/O space)
1159
Mike Rapoportc2fff332009-11-11 10:03:03 +02001160 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001161 Define this if data bus is 32 bits
1162
Mike Rapoportc2fff332009-11-11 10:03:03 +02001163 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001164 Define this if data bus is 16 bits. If your processor
1165 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001166 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001167
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001168 CONFIG_SH_ETHER
1169 Support for Renesas on-chip Ethernet controller
1170
1171 CONFIG_SH_ETHER_USE_PORT
1172 Define the number of ports to be used
1173
1174 CONFIG_SH_ETHER_PHY_ADDR
1175 Define the ETH PHY's address
1176
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001177 CONFIG_SH_ETHER_CACHE_WRITEBACK
1178 If this option is set, the driver enables cache flush.
1179
Vadim Bendebury5e124722011-10-17 08:36:14 +00001180- TPM Support:
1181 CONFIG_GENERIC_LPC_TPM
1182 Support for generic parallel port TPM devices. Only one device
1183 per system is supported at this time.
1184
1185 CONFIG_TPM_TIS_BASE_ADDRESS
1186 Base address where the generic TPM device is mapped
1187 to. Contemporary x86 systems usually map it at
1188 0xfed40000.
1189
wdenkc6097192002-11-03 00:24:07 +00001190- USB Support:
1191 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001192 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001193 CONFIG_USB_UHCI to enable it.
1194 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001195 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001196 storage devices.
1197 Note:
1198 Supported are USB Keyboards and USB Floppy drives
1199 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001200 MPC5200 USB requires additional defines:
1201 CONFIG_USB_CLOCK
1202 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001203 CONFIG_PSC3_USB
1204 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001205 CONFIG_USB_CONFIG
1206 for differential drivers: 0x00001000
1207 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001208 for differential drivers on PSC3: 0x00000100
1209 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001210 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001211 May be defined to allow interrupt polling
1212 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001213
Simon Glass9ab4ce22012-02-27 10:52:47 +00001214 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1215 txfilltuning field in the EHCI controller on reset.
1216
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001217- USB Device:
1218 Define the below if you wish to use the USB console.
1219 Once firmware is rebuilt from a serial console issue the
1220 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001221 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001222 it has found a new device. The environment variable usbtty
1223 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001224 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001225 Common Device Class Abstract Control Model serial device.
1226 If you select usbtty = gserial you should be able to enumerate
1227 a Linux host by
1228 # modprobe usbserial vendor=0xVendorID product=0xProductID
1229 else if using cdc_acm, simply setting the environment
1230 variable usbtty to be cdc_acm should suffice. The following
1231 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001232
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001233 CONFIG_USB_DEVICE
1234 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001235
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001236 CONFIG_USB_TTY
1237 Define this to have a tty type of device available to
1238 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001239
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301240 CONFIG_USBD_HS
1241 Define this to enable the high speed support for usb
1242 device and usbtty. If this feature is enabled, a routine
1243 int is_usbd_high_speed(void)
1244 also needs to be defined by the driver to dynamically poll
1245 whether the enumeration has succeded at high speed or full
1246 speed.
1247
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001248 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001249 Define this if you want stdin, stdout &/or stderr to
1250 be set to usbtty.
1251
1252 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001253 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001254 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001255 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001257 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001258 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001259 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001260
Wolfgang Denk386eda02006-06-14 18:14:56 +02001261 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001262 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001263 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001264 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1265 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1266 should pretend to be a Linux device to it's target host.
1267
1268 CONFIG_USBD_MANUFACTURER
1269 Define this string as the name of your company for
1270 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001271
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001272 CONFIG_USBD_PRODUCT_NAME
1273 Define this string as the name of your product
1274 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1275
1276 CONFIG_USBD_VENDORID
1277 Define this as your assigned Vendor ID from the USB
1278 Implementors Forum. This *must* be a genuine Vendor ID
1279 to avoid polluting the USB namespace.
1280 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001281
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001282 CONFIG_USBD_PRODUCTID
1283 Define this as the unique Product ID
1284 for your device
1285 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001286
Igor Grinbergd70a5602011-12-12 12:08:35 +02001287- ULPI Layer Support:
1288 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1289 the generic ULPI layer. The generic layer accesses the ULPI PHY
1290 via the platform viewport, so you need both the genric layer and
1291 the viewport enabled. Currently only Chipidea/ARC based
1292 viewport is supported.
1293 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1294 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001295 If your ULPI phy needs a different reference clock than the
1296 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1297 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001298
1299- MMC Support:
1300 The MMC controller on the Intel PXA is supported. To
1301 enable this define CONFIG_MMC. The MMC can be
1302 accessed from the boot prompt by mapping the device
1303 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001304 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1305 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001306
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001307 CONFIG_SH_MMCIF
1308 Support for Renesas on-chip MMCIF controller
1309
1310 CONFIG_SH_MMCIF_ADDR
1311 Define the base address of MMCIF registers
1312
1313 CONFIG_SH_MMCIF_CLK
1314 Define the clock frequency for MMCIF
1315
wdenk6705d812004-08-02 23:22:59 +00001316- Journaling Flash filesystem support:
1317 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1318 CONFIG_JFFS2_NAND_DEV
1319 Define these for a default partition on a NAND device
1320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001321 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1322 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001323 Define these for a default partition on a NOR device
1324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001325 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001326 Define this to create an own partition. You have to provide a
1327 function struct part_info* jffs2_part_info(int part_num)
1328
1329 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001330 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001331 to disable the command chpart. This is the default when you
1332 have not defined a custom partition
1333
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001334- FAT(File Allocation Table) filesystem write function support:
1335 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001336
1337 Define this to enable support for saving memory data as a
1338 file in FAT formatted partition.
1339
1340 This will also enable the command "fatwrite" enabling the
1341 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001342
Gabe Black84cd9322012-10-12 14:26:11 +00001343CBFS (Coreboot Filesystem) support
1344 CONFIG_CMD_CBFS
1345
1346 Define this to enable support for reading from a Coreboot
1347 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1348 and cbfsload.
1349
wdenkc6097192002-11-03 00:24:07 +00001350- Keyboard Support:
1351 CONFIG_ISA_KEYBOARD
1352
1353 Define this to enable standard (PC-Style) keyboard
1354 support
1355
1356 CONFIG_I8042_KBD
1357 Standard PC keyboard driver with US (is default) and
1358 GERMAN key layout (switch via environment 'keymap=de') support.
1359 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1360 for cfb_console. Supports cursor blinking.
1361
1362- Video support:
1363 CONFIG_VIDEO
1364
1365 Define this to enable video support (for output to
1366 video).
1367
1368 CONFIG_VIDEO_CT69000
1369
1370 Enable Chips & Technologies 69000 Video chip
1371
1372 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001373 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001374 video output is selected via environment 'videoout'
1375 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1376 assumed.
wdenkc6097192002-11-03 00:24:07 +00001377
wdenkb79a11c2004-03-25 15:14:43 +00001378 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001379 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001380 are possible:
1381 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001382 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001383
1384 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1385 -------------+---------------------------------------------
1386 8 bits | 0x301* 0x303 0x305 0x161 0x307
1387 15 bits | 0x310 0x313 0x316 0x162 0x319
1388 16 bits | 0x311 0x314 0x317 0x163 0x31A
1389 24 bits | 0x312 0x315 0x318 ? 0x31B
1390 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001391 (i.e. setenv videomode 317; saveenv; reset;)
1392
wdenkb79a11c2004-03-25 15:14:43 +00001393 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001394 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001395
1396
stroesec1551ea2003-04-04 15:53:41 +00001397 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001398 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001399 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1400 or CONFIG_VIDEO_SED13806_16BPP
1401
Timur Tabi7d3053f2011-02-15 17:09:19 -06001402 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001403 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001404 SOCs that have a DIU should define this macro to enable DIU
1405 support, and should also define these other macros:
1406
1407 CONFIG_SYS_DIU_ADDR
1408 CONFIG_VIDEO
1409 CONFIG_CMD_BMP
1410 CONFIG_CFB_CONSOLE
1411 CONFIG_VIDEO_SW_CURSOR
1412 CONFIG_VGA_AS_SINGLE_DEVICE
1413 CONFIG_VIDEO_LOGO
1414 CONFIG_VIDEO_BMP_LOGO
1415
Timur Tabiba8e76b2011-04-11 14:18:22 -05001416 The DIU driver will look for the 'video-mode' environment
1417 variable, and if defined, enable the DIU as a console during
1418 boot. See the documentation file README.video for a
1419 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001420
Simon Glass058d59b2012-12-03 13:59:47 +00001421 CONFIG_VIDEO_VGA
1422
1423 Enable the VGA video / BIOS for x86. The alternative if you
1424 are using coreboot is to use the coreboot frame buffer
1425 driver.
1426
1427
wdenk682011f2003-06-03 23:54:09 +00001428- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001429 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001430
wdenk8bde7f72003-06-27 21:31:46 +00001431 Define this to enable a custom keyboard support.
1432 This simply calls drv_keyboard_init() which must be
1433 defined in your board-specific files.
1434 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001435
wdenkc6097192002-11-03 00:24:07 +00001436- LCD Support: CONFIG_LCD
1437
1438 Define this to enable LCD support (for output to LCD
1439 display); also select one of the supported displays
1440 by defining one of these:
1441
Stelian Pop39cf4802008-05-09 21:57:18 +02001442 CONFIG_ATMEL_LCD:
1443
1444 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1445
wdenkfd3103b2003-11-25 16:55:19 +00001446 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001447
wdenkfd3103b2003-11-25 16:55:19 +00001448 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001449
wdenkfd3103b2003-11-25 16:55:19 +00001450 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001451
wdenkfd3103b2003-11-25 16:55:19 +00001452 NEC NL6448BC20-08. 6.5", 640x480.
1453 Active, color, single scan.
1454
1455 CONFIG_NEC_NL6448BC33_54
1456
1457 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001458 Active, color, single scan.
1459
1460 CONFIG_SHARP_16x9
1461
1462 Sharp 320x240. Active, color, single scan.
1463 It isn't 16x9, and I am not sure what it is.
1464
1465 CONFIG_SHARP_LQ64D341
1466
1467 Sharp LQ64D341 display, 640x480.
1468 Active, color, single scan.
1469
1470 CONFIG_HLD1045
1471
1472 HLD1045 display, 640x480.
1473 Active, color, single scan.
1474
1475 CONFIG_OPTREX_BW
1476
1477 Optrex CBL50840-2 NF-FW 99 22 M5
1478 or
1479 Hitachi LMG6912RPFC-00T
1480 or
1481 Hitachi SP14Q002
1482
1483 320x240. Black & white.
1484
1485 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001486 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001487
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001488 CONFIG_LCD_BMP_RLE8
1489
1490 Support drawing of RLE8-compressed bitmaps on the LCD.
1491
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001492 CONFIG_I2C_EDID
1493
1494 Enables an 'i2c edid' command which can read EDID
1495 information over I2C from an attached LCD display.
1496
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001497
wdenk7152b1d2003-09-05 23:19:14 +00001498- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001499
wdenk8bde7f72003-06-27 21:31:46 +00001500 If this option is set, the environment is checked for
1501 a variable "splashimage". If found, the usual display
1502 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001503 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001504 specified in "splashimage" is loaded instead. The
1505 console is redirected to the "nulldev", too. This
1506 allows for a "silent" boot where a splash screen is
1507 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001508
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001509 CONFIG_SPLASH_SCREEN_ALIGN
1510
1511 If this option is set the splash image can be freely positioned
1512 on the screen. Environment variable "splashpos" specifies the
1513 position as "x,y". If a positive number is given it is used as
1514 number of pixel from left/top. If a negative number is given it
1515 is used as number of pixel from right/bottom. You can also
1516 specify 'm' for centering the image.
1517
1518 Example:
1519 setenv splashpos m,m
1520 => image at center of screen
1521
1522 setenv splashpos 30,20
1523 => image at x = 30 and y = 20
1524
1525 setenv splashpos -10,m
1526 => vertically centered image
1527 at x = dspWidth - bmpWidth - 9
1528
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001529- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1530
1531 If this option is set, additionally to standard BMP
1532 images, gzipped BMP images can be displayed via the
1533 splashscreen support or the bmp command.
1534
Anatolij Gustschind5011762010-03-15 14:50:25 +01001535- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1536
1537 If this option is set, 8-bit RLE compressed BMP images
1538 can be displayed via the splashscreen support or the
1539 bmp command.
1540
Lei Wenf2b96df2012-09-28 04:26:47 +00001541- Do compresssing for memory range:
1542 CONFIG_CMD_ZIP
1543
1544 If this option is set, it would use zlib deflate method
1545 to compress the specified memory at its best effort.
1546
wdenkc29fdfc2003-08-29 20:57:53 +00001547- Compression support:
1548 CONFIG_BZIP2
1549
1550 If this option is set, support for bzip2 compressed
1551 images is included. If not, only uncompressed and gzip
1552 compressed images are supported.
1553
wdenk42d1f032003-10-15 23:53:47 +00001554 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001555 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001556 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001557
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001558 CONFIG_LZMA
1559
1560 If this option is set, support for lzma compressed
1561 images is included.
1562
1563 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1564 requires an amount of dynamic memory that is given by the
1565 formula:
1566
1567 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1568
1569 Where lc and lp stand for, respectively, Literal context bits
1570 and Literal pos bits.
1571
1572 This value is upper-bounded by 14MB in the worst case. Anyway,
1573 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1574 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1575 a very small buffer.
1576
1577 Use the lzmainfo tool to determinate the lc and lp values and
1578 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001579 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001580
wdenk17ea1172004-06-06 21:51:03 +00001581- MII/PHY support:
1582 CONFIG_PHY_ADDR
1583
1584 The address of PHY on MII bus.
1585
1586 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1587
1588 The clock frequency of the MII bus
1589
1590 CONFIG_PHY_GIGE
1591
1592 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001593 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001594
1595 CONFIG_PHY_RESET_DELAY
1596
1597 Some PHY like Intel LXT971A need extra delay after
1598 reset before any MII register access is possible.
1599 For such PHY, set this option to the usec delay
1600 required. (minimum 300usec for LXT971A)
1601
1602 CONFIG_PHY_CMD_DELAY (ppc4xx)
1603
1604 Some PHY like Intel LXT971A need extra delay after
1605 command issued before MII status register can be read
1606
wdenkc6097192002-11-03 00:24:07 +00001607- Ethernet address:
1608 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001609 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001610 CONFIG_ETH2ADDR
1611 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001612 CONFIG_ETH4ADDR
1613 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001614
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001615 Define a default value for Ethernet address to use
1616 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001617 is not determined automatically.
1618
1619- IP address:
1620 CONFIG_IPADDR
1621
1622 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001623 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001624 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001625 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001626
1627- Server IP address:
1628 CONFIG_SERVERIP
1629
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001630 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001631 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001632 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001633
Robin Getz97cfe862009-07-21 12:15:28 -04001634 CONFIG_KEEP_SERVERADDR
1635
1636 Keeps the server's MAC address, in the env 'serveraddr'
1637 for passing to bootargs (like Linux's netconsole option)
1638
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001639- Gateway IP address:
1640 CONFIG_GATEWAYIP
1641
1642 Defines a default value for the IP address of the
1643 default router where packets to other networks are
1644 sent to.
1645 (Environment variable "gatewayip")
1646
1647- Subnet mask:
1648 CONFIG_NETMASK
1649
1650 Defines a default value for the subnet mask (or
1651 routing prefix) which is used to determine if an IP
1652 address belongs to the local subnet or needs to be
1653 forwarded through a router.
1654 (Environment variable "netmask")
1655
David Updegraff53a5c422007-06-11 10:41:07 -05001656- Multicast TFTP Mode:
1657 CONFIG_MCAST_TFTP
1658
1659 Defines whether you want to support multicast TFTP as per
1660 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001661 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001662 driver in use must provide a function: mcast() to join/leave a
1663 multicast group.
1664
wdenkc6097192002-11-03 00:24:07 +00001665- BOOTP Recovery Mode:
1666 CONFIG_BOOTP_RANDOM_DELAY
1667
1668 If you have many targets in a network that try to
1669 boot using BOOTP, you may want to avoid that all
1670 systems send out BOOTP requests at precisely the same
1671 moment (which would happen for instance at recovery
1672 from a power failure, when all systems will try to
1673 boot, thus flooding the BOOTP server. Defining
1674 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1675 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001676 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001677
1678 1st BOOTP request: delay 0 ... 1 sec
1679 2nd BOOTP request: delay 0 ... 2 sec
1680 3rd BOOTP request: delay 0 ... 4 sec
1681 4th and following
1682 BOOTP requests: delay 0 ... 8 sec
1683
stroesefe389a82003-08-28 14:17:32 +00001684- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001685 You can fine tune the DHCP functionality by defining
1686 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001687
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001688 CONFIG_BOOTP_SUBNETMASK
1689 CONFIG_BOOTP_GATEWAY
1690 CONFIG_BOOTP_HOSTNAME
1691 CONFIG_BOOTP_NISDOMAIN
1692 CONFIG_BOOTP_BOOTPATH
1693 CONFIG_BOOTP_BOOTFILESIZE
1694 CONFIG_BOOTP_DNS
1695 CONFIG_BOOTP_DNS2
1696 CONFIG_BOOTP_SEND_HOSTNAME
1697 CONFIG_BOOTP_NTPSERVER
1698 CONFIG_BOOTP_TIMEOFFSET
1699 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001700 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001701
Wilson Callan5d110f02007-07-28 10:56:13 -04001702 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1703 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001704
Joe Hershberger2c00e092012-05-23 07:59:19 +00001705 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1706 after the configured retry count, the call will fail
1707 instead of starting over. This can be used to fail over
1708 to Link-local IP address configuration if the DHCP server
1709 is not available.
1710
stroesefe389a82003-08-28 14:17:32 +00001711 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1712 serverip from a DHCP server, it is possible that more
1713 than one DNS serverip is offered to the client.
1714 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1715 serverip will be stored in the additional environment
1716 variable "dnsip2". The first DNS serverip is always
1717 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001718 is defined.
stroesefe389a82003-08-28 14:17:32 +00001719
1720 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1721 to do a dynamic update of a DNS server. To do this, they
1722 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001723 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001724 of the "hostname" environment variable is passed as
1725 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001726
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001727 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1728
1729 A 32bit value in microseconds for a delay between
1730 receiving a "DHCP Offer" and sending the "DHCP Request".
1731 This fixes a problem with certain DHCP servers that don't
1732 respond 100% of the time to a "DHCP request". E.g. On an
1733 AT91RM9200 processor running at 180MHz, this delay needed
1734 to be *at least* 15,000 usec before a Windows Server 2003
1735 DHCP server would reply 100% of the time. I recommend at
1736 least 50,000 usec to be safe. The alternative is to hope
1737 that one of the retries will be successful but note that
1738 the DHCP timeout and retry process takes a longer than
1739 this delay.
1740
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001741 - Link-local IP address negotiation:
1742 Negotiate with other link-local clients on the local network
1743 for an address that doesn't require explicit configuration.
1744 This is especially useful if a DHCP server cannot be guaranteed
1745 to exist in all environments that the device must operate.
1746
1747 See doc/README.link-local for more information.
1748
wdenka3d991b2004-04-15 21:48:45 +00001749 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001750 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001751
1752 The device id used in CDP trigger frames.
1753
1754 CONFIG_CDP_DEVICE_ID_PREFIX
1755
1756 A two character string which is prefixed to the MAC address
1757 of the device.
1758
1759 CONFIG_CDP_PORT_ID
1760
1761 A printf format string which contains the ascii name of
1762 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001763 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001764
1765 CONFIG_CDP_CAPABILITIES
1766
1767 A 32bit integer which indicates the device capabilities;
1768 0x00000010 for a normal host which does not forwards.
1769
1770 CONFIG_CDP_VERSION
1771
1772 An ascii string containing the version of the software.
1773
1774 CONFIG_CDP_PLATFORM
1775
1776 An ascii string containing the name of the platform.
1777
1778 CONFIG_CDP_TRIGGER
1779
1780 A 32bit integer sent on the trigger.
1781
1782 CONFIG_CDP_POWER_CONSUMPTION
1783
1784 A 16bit integer containing the power consumption of the
1785 device in .1 of milliwatts.
1786
1787 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1788
1789 A byte containing the id of the VLAN.
1790
wdenkc6097192002-11-03 00:24:07 +00001791- Status LED: CONFIG_STATUS_LED
1792
1793 Several configurations allow to display the current
1794 status using a LED. For instance, the LED will blink
1795 fast while running U-Boot code, stop blinking as
1796 soon as a reply to a BOOTP request was received, and
1797 start blinking slow once the Linux kernel is running
1798 (supported by a status LED driver in the Linux
1799 kernel). Defining CONFIG_STATUS_LED enables this
1800 feature in U-Boot.
1801
1802- CAN Support: CONFIG_CAN_DRIVER
1803
1804 Defining CONFIG_CAN_DRIVER enables CAN driver support
1805 on those systems that support this (optional)
1806 feature, like the TQM8xxL modules.
1807
1808- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1809
wdenkb37c7e52003-06-30 16:24:52 +00001810 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001811 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001812 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001813
wdenk945af8d2003-07-16 21:53:01 +00001814 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001815 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001816 CONFIG_COMMANDS) and communicate with i2c based realtime
1817 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001818 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001819
Ben Warrenbb99ad62006-09-07 16:50:54 -04001820 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001821
wdenk945af8d2003-07-16 21:53:01 +00001822 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001823 bit-banging) driver instead of CPM or similar hardware
1824 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001825
wdenk945af8d2003-07-16 21:53:01 +00001826 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001827 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001829 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001830 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001831 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001832 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001833
Peter Tyser8d321b82010-04-12 22:28:21 -05001834 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001835 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001836 and so its address should therefore be cleared to 0 (See,
1837 eg, MPC823e User's Manual p.16-473). So, set
1838 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001839
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001840 CONFIG_SYS_I2C_INIT_MPC5XXX
1841
1842 When a board is reset during an i2c bus transfer
1843 chips might think that the current transfer is still
1844 in progress. Reset the slave devices by sending start
1845 commands until the slave device responds.
1846
wdenk945af8d2003-07-16 21:53:01 +00001847 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001848
1849 If you use the software i2c interface (CONFIG_SOFT_I2C)
1850 then the following macros need to be defined (examples are
1851 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001852
1853 I2C_INIT
1854
wdenkb37c7e52003-06-30 16:24:52 +00001855 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001856 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001857
wdenkba56f622004-02-06 23:19:44 +00001858 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001859
wdenkc6097192002-11-03 00:24:07 +00001860 I2C_PORT
1861
wdenk43d96162003-03-06 00:02:04 +00001862 (Only for MPC8260 CPU). The I/O port to use (the code
1863 assumes both bits are on the same port). Valid values
1864 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001865
1866 I2C_ACTIVE
1867
1868 The code necessary to make the I2C data line active
1869 (driven). If the data line is open collector, this
1870 define can be null.
1871
wdenkb37c7e52003-06-30 16:24:52 +00001872 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1873
wdenkc6097192002-11-03 00:24:07 +00001874 I2C_TRISTATE
1875
1876 The code necessary to make the I2C data line tri-stated
1877 (inactive). If the data line is open collector, this
1878 define can be null.
1879
wdenkb37c7e52003-06-30 16:24:52 +00001880 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1881
wdenkc6097192002-11-03 00:24:07 +00001882 I2C_READ
1883
1884 Code that returns TRUE if the I2C data line is high,
1885 FALSE if it is low.
1886
wdenkb37c7e52003-06-30 16:24:52 +00001887 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1888
wdenkc6097192002-11-03 00:24:07 +00001889 I2C_SDA(bit)
1890
1891 If <bit> is TRUE, sets the I2C data line high. If it
1892 is FALSE, it clears it (low).
1893
wdenkb37c7e52003-06-30 16:24:52 +00001894 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001895 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001896 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001897
wdenkc6097192002-11-03 00:24:07 +00001898 I2C_SCL(bit)
1899
1900 If <bit> is TRUE, sets the I2C clock line high. If it
1901 is FALSE, it clears it (low).
1902
wdenkb37c7e52003-06-30 16:24:52 +00001903 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001904 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001905 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001906
wdenkc6097192002-11-03 00:24:07 +00001907 I2C_DELAY
1908
1909 This delay is invoked four times per clock cycle so this
1910 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001911 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001912 like:
1913
wdenkb37c7e52003-06-30 16:24:52 +00001914 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001915
Mike Frysinger793b5722010-07-21 13:38:02 -04001916 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1917
1918 If your arch supports the generic GPIO framework (asm/gpio.h),
1919 then you may alternatively define the two GPIOs that are to be
1920 used as SCL / SDA. Any of the previous I2C_xxx macros will
1921 have GPIO-based defaults assigned to them as appropriate.
1922
1923 You should define these to the GPIO value as given directly to
1924 the generic GPIO functions.
1925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001926 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001927
wdenk8bde7f72003-06-27 21:31:46 +00001928 When a board is reset during an i2c bus transfer
1929 chips might think that the current transfer is still
1930 in progress. On some boards it is possible to access
1931 the i2c SCLK line directly, either by using the
1932 processor pin as a GPIO or by having a second pin
1933 connected to the bus. If this option is defined a
1934 custom i2c_init_board() routine in boards/xxx/board.c
1935 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001936
Richard Retanubun26a33502010-04-12 15:08:17 -04001937 CONFIG_SYS_I2C_BOARD_LATE_INIT
1938
1939 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1940 defined a custom i2c_board_late_init() routine in
1941 boards/xxx/board.c is run AFTER the operations in i2c_init()
1942 is completed. This callpoint can be used to unreset i2c bus
1943 using CPU i2c controller register accesses for CPUs whose i2c
1944 controller provide such a method. It is called at the end of
1945 i2c_init() to allow i2c_init operations to setup the i2c bus
1946 controller on the CPU (e.g. setting bus speed & slave address).
1947
wdenk17ea1172004-06-06 21:51:03 +00001948 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1949
1950 This option enables configuration of bi_iic_fast[] flags
1951 in u-boot bd_info structure based on u-boot environment
1952 variable "i2cfast". (see also i2cfast)
1953
Ben Warrenbb99ad62006-09-07 16:50:54 -04001954 CONFIG_I2C_MULTI_BUS
1955
1956 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001957 must have a controller. At any point in time, only one bus is
1958 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001959 Note that bus numbering is zero-based.
1960
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001961 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001962
1963 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001964 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001965 is set, specify a list of bus-device pairs. Otherwise, specify
1966 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001967
1968 e.g.
1969 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001970 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001971
1972 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1973
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001974 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001975 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001976
1977 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001979 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001980
1981 If defined, then this indicates the I2C bus number for DDR SPD.
1982 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1983
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001984 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001985
1986 If defined, then this indicates the I2C bus number for the RTC.
1987 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001989 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001990
1991 If defined, then this indicates the I2C bus number for the DTT.
1992 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1993
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001994 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001995
1996 If defined, specifies the I2C address of the DTT device.
1997 If not defined, then U-Boot uses predefined value for
1998 specified DTT device.
1999
Timur Tabibe5e6182006-11-03 19:15:00 -06002000 CONFIG_FSL_I2C
2001
2002 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002003 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002004
Heiko Schocher67b23a32008-10-15 09:39:47 +02002005 CONFIG_I2C_MUX
2006
2007 Define this option if you have I2C devices reached over 1 .. n
2008 I2C Muxes like the pca9544a. This option addes a new I2C
2009 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2010 new I2C Bus to the existing I2C Busses. If you select the
2011 new Bus with "i2c dev", u-bbot sends first the commandos for
2012 the muxes to activate this new "bus".
2013
2014 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2015 feature!
2016
2017 Example:
2018 Adding a new I2C Bus reached over 2 pca9544a muxes
2019 The First mux with address 70 and channel 6
2020 The Second mux with address 71 and channel 4
2021
2022 => i2c bus pca9544a:70:6:pca9544a:71:4
2023
2024 Use the "i2c bus" command without parameter, to get a list
2025 of I2C Busses with muxes:
2026
2027 => i2c bus
2028 Busses reached over muxes:
2029 Bus ID: 2
2030 reached over Mux(es):
2031 pca9544a@70 ch: 4
2032 Bus ID: 3
2033 reached over Mux(es):
2034 pca9544a@70 ch: 6
2035 pca9544a@71 ch: 4
2036 =>
2037
2038 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002039 u-boot first sends the command to the mux@70 to enable
2040 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002041 the channel 4.
2042
2043 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002044 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002045 the 2 muxes.
2046
2047 This option is actually implemented for the bitbanging
2048 algorithm in common/soft_i2c.c and for the Hardware I2C
2049 Bus on the MPC8260. But it should be not so difficult
2050 to add this option to other architectures.
2051
Andrew Dyer2ac69852008-12-29 17:36:01 -06002052 CONFIG_SOFT_I2C_READ_REPEATED_START
2053
2054 defining this will force the i2c_read() function in
2055 the soft_i2c driver to perform an I2C repeated start
2056 between writing the address pointer and reading the
2057 data. If this define is omitted the default behaviour
2058 of doing a stop-start sequence will be used. Most I2C
2059 devices can use either method, but some require one or
2060 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002061
wdenkc6097192002-11-03 00:24:07 +00002062- SPI Support: CONFIG_SPI
2063
2064 Enables SPI driver (so far only tested with
2065 SPI EEPROM, also an instance works with Crystal A/D and
2066 D/As on the SACSng board)
2067
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002068 CONFIG_SH_SPI
2069
2070 Enables the driver for SPI controller on SuperH. Currently
2071 only SH7757 is supported.
2072
wdenkc6097192002-11-03 00:24:07 +00002073 CONFIG_SPI_X
2074
2075 Enables extended (16-bit) SPI EEPROM addressing.
2076 (symmetrical to CONFIG_I2C_X)
2077
2078 CONFIG_SOFT_SPI
2079
wdenk43d96162003-03-06 00:02:04 +00002080 Enables a software (bit-bang) SPI driver rather than
2081 using hardware support. This is a general purpose
2082 driver that only requires three general I/O port pins
2083 (two outputs, one input) to function. If this is
2084 defined, the board configuration must define several
2085 SPI configuration items (port pins to use, etc). For
2086 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002087
Ben Warren04a9e112008-01-16 22:37:35 -05002088 CONFIG_HARD_SPI
2089
2090 Enables a hardware SPI driver for general-purpose reads
2091 and writes. As with CONFIG_SOFT_SPI, the board configuration
2092 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002093 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002094 example, see include/configs/mpc8349emds.h.
2095
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002096 CONFIG_MXC_SPI
2097
2098 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002099 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002100
Matthias Fuchs01335022007-12-27 17:12:34 +01002101- FPGA Support: CONFIG_FPGA
2102
2103 Enables FPGA subsystem.
2104
2105 CONFIG_FPGA_<vendor>
2106
2107 Enables support for specific chip vendors.
2108 (ALTERA, XILINX)
2109
2110 CONFIG_FPGA_<family>
2111
2112 Enables support for FPGA family.
2113 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2114
2115 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002116
wdenk43d96162003-03-06 00:02:04 +00002117 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002119 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002120
wdenk8bde7f72003-06-27 21:31:46 +00002121 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002123 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002124
wdenk43d96162003-03-06 00:02:04 +00002125 Enable checks on FPGA configuration interface busy
2126 status by the configuration function. This option
2127 will require a board or device specific function to
2128 be written.
wdenkc6097192002-11-03 00:24:07 +00002129
2130 CONFIG_FPGA_DELAY
2131
2132 If defined, a function that provides delays in the FPGA
2133 configuration driver.
2134
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002135 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002136 Allow Control-C to interrupt FPGA configuration
2137
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002138 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002139
wdenk43d96162003-03-06 00:02:04 +00002140 Check for configuration errors during FPGA bitfile
2141 loading. For example, abort during Virtex II
2142 configuration if the INIT_B line goes low (which
2143 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002144
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002145 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002146
wdenk43d96162003-03-06 00:02:04 +00002147 Maximum time to wait for the INIT_B line to deassert
2148 after PROB_B has been deasserted during a Virtex II
2149 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002150 ms.
wdenkc6097192002-11-03 00:24:07 +00002151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002152 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002153
wdenk43d96162003-03-06 00:02:04 +00002154 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002155 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002156
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002157 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002158
wdenk43d96162003-03-06 00:02:04 +00002159 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002160 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002161
2162- Configuration Management:
2163 CONFIG_IDENT_STRING
2164
wdenk43d96162003-03-06 00:02:04 +00002165 If defined, this string will be added to the U-Boot
2166 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002167
2168- Vendor Parameter Protection:
2169
wdenk43d96162003-03-06 00:02:04 +00002170 U-Boot considers the values of the environment
2171 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002172 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002173 are set once by the board vendor / manufacturer, and
2174 protects these variables from casual modification by
2175 the user. Once set, these variables are read-only,
2176 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002177 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002178
2179 If CONFIG_ENV_OVERWRITE is #defined in your config
2180 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002181 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002182 these parameters.
2183
2184 Alternatively, if you #define _both_ CONFIG_ETHADDR
2185 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002186 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002187 which can be changed exactly ONCE by the user. [The
2188 serial# is unaffected by this, i. e. it remains
2189 read-only.]
2190
2191- Protected RAM:
2192 CONFIG_PRAM
2193
2194 Define this variable to enable the reservation of
2195 "protected RAM", i. e. RAM which is not overwritten
2196 by U-Boot. Define CONFIG_PRAM to hold the number of
2197 kB you want to reserve for pRAM. You can overwrite
2198 this default value by defining an environment
2199 variable "pram" to the number of kB you want to
2200 reserve. Note that the board info structure will
2201 still show the full amount of RAM. If pRAM is
2202 reserved, a new environment variable "mem" will
2203 automatically be defined to hold the amount of
2204 remaining RAM in a form that can be passed as boot
2205 argument to Linux, for instance like that:
2206
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002207 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002208 saveenv
2209
2210 This way you can tell Linux not to use this memory,
2211 either, which results in a memory region that will
2212 not be affected by reboots.
2213
2214 *WARNING* If your board configuration uses automatic
2215 detection of the RAM size, you must make sure that
2216 this memory test is non-destructive. So far, the
2217 following board configurations are known to be
2218 "pRAM-clean":
2219
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002220 IVMS8, IVML24, SPD8xx, TQM8xxL,
2221 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002222 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002223
Gabe Black40fef042012-12-02 04:55:18 +00002224- Access to physical memory region (> 4GB)
2225 Some basic support is provided for operations on memory not
2226 normally accessible to U-Boot - e.g. some architectures
2227 support access to more than 4GB of memory on 32-bit
2228 machines using physical address extension or similar.
2229 Define CONFIG_PHYSMEM to access this basic support, which
2230 currently only supports clearing the memory.
2231
wdenkc6097192002-11-03 00:24:07 +00002232- Error Recovery:
2233 CONFIG_PANIC_HANG
2234
2235 Define this variable to stop the system in case of a
2236 fatal error, so that you have to reset it manually.
2237 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002238 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002239 automatically as fast as possible, but it may be
2240 useful during development since you can try to debug
2241 the conditions that lead to the situation.
2242
2243 CONFIG_NET_RETRY_COUNT
2244
wdenk43d96162003-03-06 00:02:04 +00002245 This variable defines the number of retries for
2246 network operations like ARP, RARP, TFTP, or BOOTP
2247 before giving up the operation. If not defined, a
2248 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002249
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002250 CONFIG_ARP_TIMEOUT
2251
2252 Timeout waiting for an ARP reply in milliseconds.
2253
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002254 CONFIG_NFS_TIMEOUT
2255
2256 Timeout in milliseconds used in NFS protocol.
2257 If you encounter "ERROR: Cannot umount" in nfs command,
2258 try longer timeout such as
2259 #define CONFIG_NFS_TIMEOUT 10000UL
2260
wdenkc6097192002-11-03 00:24:07 +00002261- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002262 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002263
2264 Enable auto completion of commands using TAB.
2265
Wolfgang Denka9398e02006-11-27 15:32:42 +01002266 Note that this feature has NOT been implemented yet
2267 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002268
2269
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002270 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002271
2272 Define this variable to enable the "hush" shell (from
2273 Busybox) as command line interpreter, thus enabling
2274 powerful command line syntax like
2275 if...then...else...fi conditionals or `&&' and '||'
2276 constructs ("shell scripts").
2277
2278 If undefined, you get the old, much simpler behaviour
2279 with a somewhat smaller memory footprint.
2280
2281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002282 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002283
2284 This defines the secondary prompt string, which is
2285 printed when the command interpreter needs more input
2286 to complete a command. Usually "> ".
2287
2288 Note:
2289
wdenk8bde7f72003-06-27 21:31:46 +00002290 In the current implementation, the local variables
2291 space and global environment variables space are
2292 separated. Local variables are those you define by
2293 simply typing `name=value'. To access a local
2294 variable later on, you have write `$name' or
2295 `${name}'; to execute the contents of a variable
2296 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002297
wdenk43d96162003-03-06 00:02:04 +00002298 Global environment variables are those you use
2299 setenv/printenv to work with. To run a command stored
2300 in such a variable, you need to use the run command,
2301 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002302
2303 To store commands and special characters in a
2304 variable, please use double quotation marks
2305 surrounding the whole text of the variable, instead
2306 of the backslashes before semicolons and special
2307 symbols.
2308
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002309- Commandline Editing and History:
2310 CONFIG_CMDLINE_EDITING
2311
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002312 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002313 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002314
wdenka8c7c702003-12-06 19:49:23 +00002315- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002316 CONFIG_EXTRA_ENV_SETTINGS
2317
wdenk43d96162003-03-06 00:02:04 +00002318 Define this to contain any number of null terminated
2319 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002320 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002321
wdenk43d96162003-03-06 00:02:04 +00002322 For example, place something like this in your
2323 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002324
2325 #define CONFIG_EXTRA_ENV_SETTINGS \
2326 "myvar1=value1\0" \
2327 "myvar2=value2\0"
2328
wdenk43d96162003-03-06 00:02:04 +00002329 Warning: This method is based on knowledge about the
2330 internal format how the environment is stored by the
2331 U-Boot code. This is NOT an official, exported
2332 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002333 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002334 You better know what you are doing here.
2335
wdenk43d96162003-03-06 00:02:04 +00002336 Note: overly (ab)use of the default environment is
2337 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002338 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002339 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002340
Stephen Warren5e724ca2012-05-22 09:21:54 +00002341 CONFIG_ENV_VARS_UBOOT_CONFIG
2342
2343 Define this in order to add variables describing the
2344 U-Boot build configuration to the default environment.
2345 These will be named arch, cpu, board, vendor, and soc.
2346
2347 Enabling this option will cause the following to be defined:
2348
2349 - CONFIG_SYS_ARCH
2350 - CONFIG_SYS_CPU
2351 - CONFIG_SYS_BOARD
2352 - CONFIG_SYS_VENDOR
2353 - CONFIG_SYS_SOC
2354
Tom Rini7e27f892012-10-24 07:28:16 +00002355 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2356
2357 Define this in order to add variables describing certain
2358 run-time determined information about the hardware to the
2359 environment. These will be named board_name, board_rev.
2360
wdenka8c7c702003-12-06 19:49:23 +00002361- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002362 CONFIG_HAS_DATAFLASH
2363
wdenk8bde7f72003-06-27 21:31:46 +00002364 Defining this option enables DataFlash features and
2365 allows to read/write in Dataflash via the standard
2366 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002367
Eric Nelsonf61ec452012-01-31 10:52:08 -07002368- Serial Flash support
2369 CONFIG_CMD_SF
2370
2371 Defining this option enables SPI flash commands
2372 'sf probe/read/write/erase/update'.
2373
2374 Usage requires an initial 'probe' to define the serial
2375 flash parameters, followed by read/write/erase/update
2376 commands.
2377
2378 The following defaults may be provided by the platform
2379 to handle the common case when only a single serial
2380 flash is present on the system.
2381
2382 CONFIG_SF_DEFAULT_BUS Bus identifier
2383 CONFIG_SF_DEFAULT_CS Chip-select
2384 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2385 CONFIG_SF_DEFAULT_SPEED in Hz
2386
wdenk3f85ce22004-02-23 16:11:30 +00002387- SystemACE Support:
2388 CONFIG_SYSTEMACE
2389
2390 Adding this option adds support for Xilinx SystemACE
2391 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002392 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002394
2395 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002396 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002397
2398 When SystemACE support is added, the "ace" device type
2399 becomes available to the fat commands, i.e. fatls.
2400
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002401- TFTP Fixed UDP Port:
2402 CONFIG_TFTP_PORT
2403
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002404 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002405 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002406 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002407 number generator is used.
2408
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002409 Also, the environment variable tftpdstp is used to supply
2410 the TFTP UDP destination port value. If tftpdstp isn't
2411 defined, the normal port 69 is used.
2412
2413 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002414 blindly start the TFTP transfer using the pre-configured
2415 target IP address and UDP port. This has the effect of
2416 "punching through" the (Windows XP) firewall, allowing
2417 the remainder of the TFTP transfer to proceed normally.
2418 A better solution is to properly configure the firewall,
2419 but sometimes that is not allowed.
2420
Simon Glassbf36c5d2012-12-05 14:46:38 +00002421- Hashing support:
2422 CONFIG_CMD_HASH
2423
2424 This enables a generic 'hash' command which can produce
2425 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2426
2427 CONFIG_HASH_VERIFY
2428
2429 Enable the hash verify command (hash -v). This adds to code
2430 size a little.
2431
2432 CONFIG_SHA1 - support SHA1 hashing
2433 CONFIG_SHA256 - support SHA256 hashing
2434
2435 Note: There is also a sha1sum command, which should perhaps
2436 be deprecated in favour of 'hash sha1'.
2437
wdenka8c7c702003-12-06 19:49:23 +00002438- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002439 CONFIG_SHOW_BOOT_PROGRESS
2440
wdenk43d96162003-03-06 00:02:04 +00002441 Defining this option allows to add some board-
2442 specific code (calling a user-provided function
2443 "show_boot_progress(int)") that enables you to show
2444 the system's boot progress on some display (for
2445 example, some LED's) on your board. At the moment,
2446 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002447
Simon Glass3a608ca2012-02-13 13:51:19 +00002448- Detailed boot stage timing
2449 CONFIG_BOOTSTAGE
2450 Define this option to get detailed timing of each stage
2451 of the boot process.
2452
2453 CONFIG_BOOTSTAGE_USER_COUNT
2454 This is the number of available user bootstage records.
2455 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2456 a new ID will be allocated from this stash. If you exceed
2457 the limit, recording will stop.
2458
2459 CONFIG_BOOTSTAGE_REPORT
2460 Define this to print a report before boot, similar to this:
2461
2462 Timer summary in microseconds:
2463 Mark Elapsed Stage
2464 0 0 reset
2465 3,575,678 3,575,678 board_init_f start
2466 3,575,695 17 arch_cpu_init A9
2467 3,575,777 82 arch_cpu_init done
2468 3,659,598 83,821 board_init_r start
2469 3,910,375 250,777 main_loop
2470 29,916,167 26,005,792 bootm_start
2471 30,361,327 445,160 start_kernel
2472
Simon Glass2eba38c2012-09-28 08:56:39 +00002473 CONFIG_CMD_BOOTSTAGE
2474 Add a 'bootstage' command which supports printing a report
2475 and un/stashing of bootstage data.
2476
Simon Glass94fd1312012-09-28 08:56:37 +00002477 CONFIG_BOOTSTAGE_FDT
2478 Stash the bootstage information in the FDT. A root 'bootstage'
2479 node is created with each bootstage id as a child. Each child
2480 has a 'name' property and either 'mark' containing the
2481 mark time in microsecond, or 'accum' containing the
2482 accumulated time for that bootstage id in microseconds.
2483 For example:
2484
2485 bootstage {
2486 154 {
2487 name = "board_init_f";
2488 mark = <3575678>;
2489 };
2490 170 {
2491 name = "lcd";
2492 accum = <33482>;
2493 };
2494 };
2495
2496 Code in the Linux kernel can find this in /proc/devicetree.
2497
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002498Legacy uImage format:
2499
wdenkc6097192002-11-03 00:24:07 +00002500 Arg Where When
2501 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002502 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002503 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002504 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002505 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002506 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002507 4 common/cmd_bootm.c Image data has correct checksum
2508 -4 common/cmd_bootm.c Image is for unsupported architecture
2509 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002510 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002511 6 common/cmd_bootm.c Image Type check OK
2512 -6 common/cmd_bootm.c gunzip uncompression error
2513 -7 common/cmd_bootm.c Unimplemented compression type
2514 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002515 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002516 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002517
2518 9 common/image.c Start initial ramdisk verification
2519 -10 common/image.c Ramdisk header has bad magic number
2520 -11 common/image.c Ramdisk header has bad checksum
2521 10 common/image.c Ramdisk header is OK
2522 -12 common/image.c Ramdisk data has bad checksum
2523 11 common/image.c Ramdisk data has correct checksum
2524 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002525 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002526 13 common/image.c Start multifile image verification
2527 14 common/image.c No initial ramdisk, no multifile, continue.
2528
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002529 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002530
Stefan Roesea47a12b2010-04-15 16:07:28 +02002531 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002532 -31 post/post.c POST test failed, detected by post_output_backlog()
2533 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002534
Heiko Schocher566a4942007-06-22 19:11:54 +02002535 34 common/cmd_doc.c before loading a Image from a DOC device
2536 -35 common/cmd_doc.c Bad usage of "doc" command
2537 35 common/cmd_doc.c correct usage of "doc" command
2538 -36 common/cmd_doc.c No boot device
2539 36 common/cmd_doc.c correct boot device
2540 -37 common/cmd_doc.c Unknown Chip ID on boot device
2541 37 common/cmd_doc.c correct chip ID found, device available
2542 -38 common/cmd_doc.c Read Error on boot device
2543 38 common/cmd_doc.c reading Image header from DOC device OK
2544 -39 common/cmd_doc.c Image header has bad magic number
2545 39 common/cmd_doc.c Image header has correct magic number
2546 -40 common/cmd_doc.c Error reading Image from DOC device
2547 40 common/cmd_doc.c Image header has correct magic number
2548 41 common/cmd_ide.c before loading a Image from a IDE device
2549 -42 common/cmd_ide.c Bad usage of "ide" command
2550 42 common/cmd_ide.c correct usage of "ide" command
2551 -43 common/cmd_ide.c No boot device
2552 43 common/cmd_ide.c boot device found
2553 -44 common/cmd_ide.c Device not available
2554 44 common/cmd_ide.c Device available
2555 -45 common/cmd_ide.c wrong partition selected
2556 45 common/cmd_ide.c partition selected
2557 -46 common/cmd_ide.c Unknown partition table
2558 46 common/cmd_ide.c valid partition table found
2559 -47 common/cmd_ide.c Invalid partition type
2560 47 common/cmd_ide.c correct partition type
2561 -48 common/cmd_ide.c Error reading Image Header on boot device
2562 48 common/cmd_ide.c reading Image Header from IDE device OK
2563 -49 common/cmd_ide.c Image header has bad magic number
2564 49 common/cmd_ide.c Image header has correct magic number
2565 -50 common/cmd_ide.c Image header has bad checksum
2566 50 common/cmd_ide.c Image header has correct checksum
2567 -51 common/cmd_ide.c Error reading Image from IDE device
2568 51 common/cmd_ide.c reading Image from IDE device OK
2569 52 common/cmd_nand.c before loading a Image from a NAND device
2570 -53 common/cmd_nand.c Bad usage of "nand" command
2571 53 common/cmd_nand.c correct usage of "nand" command
2572 -54 common/cmd_nand.c No boot device
2573 54 common/cmd_nand.c boot device found
2574 -55 common/cmd_nand.c Unknown Chip ID on boot device
2575 55 common/cmd_nand.c correct chip ID found, device available
2576 -56 common/cmd_nand.c Error reading Image Header on boot device
2577 56 common/cmd_nand.c reading Image Header from NAND device OK
2578 -57 common/cmd_nand.c Image header has bad magic number
2579 57 common/cmd_nand.c Image header has correct magic number
2580 -58 common/cmd_nand.c Error reading Image from NAND device
2581 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002582
Heiko Schocher566a4942007-06-22 19:11:54 +02002583 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002584
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002585 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002586 -64 net/eth.c no Ethernet found.
2587 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002588
Heiko Schocher566a4942007-06-22 19:11:54 +02002589 -80 common/cmd_net.c usage wrong
2590 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002591 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002592 81 common/cmd_net.c NetLoop() back without error
2593 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2594 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002595 83 common/cmd_net.c running "source" command
2596 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002597 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002598
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002599FIT uImage format:
2600
2601 Arg Where When
2602 100 common/cmd_bootm.c Kernel FIT Image has correct format
2603 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2604 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2605 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2606 102 common/cmd_bootm.c Kernel unit name specified
2607 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002608 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002609 104 common/cmd_bootm.c Got kernel subimage node offset
2610 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2611 105 common/cmd_bootm.c Kernel subimage hash verification OK
2612 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2613 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002614 -106 common/cmd_bootm.c Kernel subimage has wrong type
2615 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002616 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2617 108 common/cmd_bootm.c Got kernel subimage data/size
2618 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2619 -109 common/cmd_bootm.c Can't get kernel subimage type
2620 -110 common/cmd_bootm.c Can't get kernel subimage comp
2621 -111 common/cmd_bootm.c Can't get kernel subimage os
2622 -112 common/cmd_bootm.c Can't get kernel subimage load address
2623 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2624
2625 120 common/image.c Start initial ramdisk verification
2626 -120 common/image.c Ramdisk FIT image has incorrect format
2627 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002628 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002629 -122 common/image.c Can't get configuration for ramdisk subimage
2630 123 common/image.c Ramdisk unit name specified
2631 -124 common/image.c Can't get ramdisk subimage node offset
2632 125 common/image.c Got ramdisk subimage node offset
2633 -125 common/image.c Ramdisk subimage hash verification failed
2634 126 common/image.c Ramdisk subimage hash verification OK
2635 -126 common/image.c Ramdisk subimage for unsupported architecture
2636 127 common/image.c Architecture check OK
2637 -127 common/image.c Can't get ramdisk subimage data/size
2638 128 common/image.c Got ramdisk subimage data/size
2639 129 common/image.c Can't get ramdisk load address
2640 -129 common/image.c Got ramdisk load address
2641
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002642 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002643 131 common/cmd_doc.c FIT image format OK
2644
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002645 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002646 141 common/cmd_ide.c FIT image format OK
2647
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002648 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002649 151 common/cmd_nand.c FIT image format OK
2650
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002651- FIT image support:
2652 CONFIG_FIT
2653 Enable support for the FIT uImage format.
2654
2655 CONFIG_FIT_BEST_MATCH
2656 When no configuration is explicitly selected, default to the
2657 one whose fdt's compatibility field best matches that of
2658 U-Boot itself. A match is considered "best" if it matches the
2659 most specific compatibility entry of U-Boot's fdt's root node.
2660 The order of entries in the configuration's fdt is ignored.
2661
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002662- Standalone program support:
2663 CONFIG_STANDALONE_LOAD_ADDR
2664
Wolfgang Denk6feff892011-10-09 21:06:34 +02002665 This option defines a board specific value for the
2666 address where standalone program gets loaded, thus
2667 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002668 settings.
2669
2670- Frame Buffer Address:
2671 CONFIG_FB_ADDR
2672
2673 Define CONFIG_FB_ADDR if you want to use specific
2674 address for frame buffer.
2675 Then system will reserve the frame buffer address to
2676 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002677 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002678
2679 Please see board_init_f function.
2680
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002681- Automatic software updates via TFTP server
2682 CONFIG_UPDATE_TFTP
2683 CONFIG_UPDATE_TFTP_CNT_MAX
2684 CONFIG_UPDATE_TFTP_MSEC_MAX
2685
2686 These options enable and control the auto-update feature;
2687 for a more detailed description refer to doc/README.update.
2688
2689- MTD Support (mtdparts command, UBI support)
2690 CONFIG_MTD_DEVICE
2691
2692 Adds the MTD device infrastructure from the Linux kernel.
2693 Needed for mtdparts command support.
2694
2695 CONFIG_MTD_PARTITIONS
2696
2697 Adds the MTD partitioning infrastructure from the Linux
2698 kernel. Needed for UBI support.
2699
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002700- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002701 CONFIG_SPL
2702 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002703
Tom Rini95579792012-02-14 07:29:40 +00002704 CONFIG_SPL_LDSCRIPT
2705 LDSCRIPT for linking the SPL binary.
2706
2707 CONFIG_SPL_MAX_SIZE
2708 Maximum binary size (text, data and rodata) of the SPL binary.
2709
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002710 CONFIG_SPL_TEXT_BASE
2711 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002712
Scott Wood94a45bb2012-09-20 19:05:12 -05002713 CONFIG_SPL_RELOC_TEXT_BASE
2714 Address to relocate to. If unspecified, this is equal to
2715 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2716
Tom Rini95579792012-02-14 07:29:40 +00002717 CONFIG_SPL_BSS_START_ADDR
2718 Link address for the BSS within the SPL binary.
2719
2720 CONFIG_SPL_BSS_MAX_SIZE
2721 Maximum binary size of the BSS section of the SPL binary.
2722
2723 CONFIG_SPL_STACK
2724 Adress of the start of the stack SPL will use
2725
Scott Wood94a45bb2012-09-20 19:05:12 -05002726 CONFIG_SPL_RELOC_STACK
2727 Adress of the start of the stack SPL will use after
2728 relocation. If unspecified, this is equal to
2729 CONFIG_SPL_STACK.
2730
Tom Rini95579792012-02-14 07:29:40 +00002731 CONFIG_SYS_SPL_MALLOC_START
2732 Starting address of the malloc pool used in SPL.
2733
2734 CONFIG_SYS_SPL_MALLOC_SIZE
2735 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002736
Tom Rini47f7bca2012-08-13 12:03:19 -07002737 CONFIG_SPL_FRAMEWORK
2738 Enable the SPL framework under common/. This framework
2739 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2740 NAND loading of the Linux Kernel.
2741
Tom Rini861a86f2012-08-13 11:37:56 -07002742 CONFIG_SPL_DISPLAY_PRINT
2743 For ARM, enable an optional function to print more information
2744 about the running system.
2745
Scott Wood4b919722012-09-20 16:35:21 -05002746 CONFIG_SPL_INIT_MINIMAL
2747 Arch init code should be built for a very small image
2748
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002749 CONFIG_SPL_LIBCOMMON_SUPPORT
2750 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002751
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002752 CONFIG_SPL_LIBDISK_SUPPORT
2753 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002754
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002755 CONFIG_SPL_I2C_SUPPORT
2756 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002757
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002758 CONFIG_SPL_GPIO_SUPPORT
2759 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002760
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002761 CONFIG_SPL_MMC_SUPPORT
2762 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002763
Tom Rini95579792012-02-14 07:29:40 +00002764 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2765 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2766 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2767 Address, size and partition on the MMC to load U-Boot from
2768 when the MMC is being used in raw mode.
2769
2770 CONFIG_SPL_FAT_SUPPORT
2771 Support for fs/fat/libfat.o in SPL binary
2772
2773 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2774 Filename to read to load U-Boot when reading from FAT
2775
Scott Wood6f2f01b2012-09-20 19:09:07 -05002776 CONFIG_SPL_NAND_BASE
2777 Include nand_base.c in the SPL. Requires
2778 CONFIG_SPL_NAND_DRIVERS.
2779
2780 CONFIG_SPL_NAND_DRIVERS
2781 SPL uses normal NAND drivers, not minimal drivers.
2782
2783 CONFIG_SPL_NAND_ECC
2784 Include standard software ECC in the SPL
2785
Tom Rini95579792012-02-14 07:29:40 +00002786 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002787 Support for NAND boot using simple NAND drivers that
2788 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002789
2790 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2791 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2792 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2793 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2794 CONFIG_SYS_NAND_ECCBYTES
2795 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002796 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002797
2798 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002799 Location in NAND to read U-Boot from
2800
2801 CONFIG_SYS_NAND_U_BOOT_DST
2802 Location in memory to load U-Boot to
2803
2804 CONFIG_SYS_NAND_U_BOOT_SIZE
2805 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002806
2807 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002808 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002809
2810 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2811 Define this if you need to first read the OOB and then the
2812 data. This is used for example on davinci plattforms.
2813
2814 CONFIG_SPL_OMAP3_ID_NAND
2815 Support for an OMAP3-specific set of functions to return the
2816 ID and MFR of the first attached NAND chip, if present.
2817
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002818 CONFIG_SPL_SERIAL_SUPPORT
2819 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002820
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002821 CONFIG_SPL_SPI_FLASH_SUPPORT
2822 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002823
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002824 CONFIG_SPL_SPI_SUPPORT
2825 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002826
Pavel Machekc57b9532012-08-30 22:42:11 +02002827 CONFIG_SPL_RAM_DEVICE
2828 Support for running image already present in ram, in SPL binary
2829
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002830 CONFIG_SPL_LIBGENERIC_SUPPORT
2831 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002832
Scott Woodca2fca22012-09-21 16:27:32 -05002833 CONFIG_SPL_TARGET
2834 Final target image containing SPL and payload. Some SPLs
2835 use an arch-specific makefile fragment instead, for
2836 example if more than one image needs to be produced.
2837
wdenkc6097192002-11-03 00:24:07 +00002838Modem Support:
2839--------------
2840
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002841[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002842
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002843- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002844 CONFIG_MODEM_SUPPORT
2845
2846- RTS/CTS Flow control enable:
2847 CONFIG_HWFLOW
2848
2849- Modem debug support:
2850 CONFIG_MODEM_SUPPORT_DEBUG
2851
wdenk43d96162003-03-06 00:02:04 +00002852 Enables debugging stuff (char screen[1024], dbg())
2853 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002854
wdenka8c7c702003-12-06 19:49:23 +00002855- Interrupt support (PPC):
2856
wdenkd4ca31c2004-01-02 14:00:00 +00002857 There are common interrupt_init() and timer_interrupt()
2858 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002859 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002860 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002861 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002862 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002863 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002864 specific handling. If board has watchdog / status_led
2865 / other_activity_monitor it works automatically from
2866 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002867
wdenkc6097192002-11-03 00:24:07 +00002868- General:
2869
wdenk43d96162003-03-06 00:02:04 +00002870 In the target system modem support is enabled when a
2871 specific key (key combination) is pressed during
2872 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002873 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002874 board_init(). Currently key_pressed() is a dummy
2875 function, returning 1 and thus enabling modem
2876 initialization.
wdenkc6097192002-11-03 00:24:07 +00002877
wdenk43d96162003-03-06 00:02:04 +00002878 If there are no modem init strings in the
2879 environment, U-Boot proceed to autoboot; the
2880 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002881 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002882
2883 See also: doc/README.Modem
2884
Helmut Raiger9660e442011-10-20 04:19:47 +00002885Board initialization settings:
2886------------------------------
2887
2888During Initialization u-boot calls a number of board specific functions
2889to allow the preparation of board specific prerequisites, e.g. pin setup
2890before drivers are initialized. To enable these callbacks the
2891following configuration macros have to be defined. Currently this is
2892architecture specific, so please check arch/your_architecture/lib/board.c
2893typically in board_init_f() and board_init_r().
2894
2895- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2896- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2897- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2898- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002899
wdenkc6097192002-11-03 00:24:07 +00002900Configuration Settings:
2901-----------------------
2902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002904 undefine this when you're short of memory.
2905
Peter Tyser2fb26042009-01-27 18:03:12 -06002906- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2907 width of the commands listed in the 'help' command output.
2908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002909- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002910 prompt for user input.
2911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002912- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002914- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002916- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002918- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002919 the application (usually a Linux kernel) when it is
2920 booted
2921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002923 List of legal baudrate settings for this board.
2924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002925- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002926 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002928- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002929 If the board specific function
2930 extern int overwrite_console (void);
2931 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002932 serial port, else the settings in the environment are used.
2933
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002934- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002935 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002936
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002937- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002938 Enable overwrite of previous console environment settings.
2939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002940- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002941 Begin and End addresses of the area used by the
2942 simple memory test.
2943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002944- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002945 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002947- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002948 Scratch address used by the alternate memory test
2949 You only need to set this if address zero isn't writeable
2950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002951- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2952 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002953 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002954 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002955 fixing up gd->ram_size the Linux kernel should gets passed
2956 the now "corrected" memory size and won't touch it either.
2957 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002958 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002959 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002960 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002961
2962 This option can be used as a workaround for the 440EPx/GRx
2963 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2964 be touched.
2965
2966 WARNING: Please make sure that this value is a multiple of
2967 the Linux page size (normally 4k). If this is not the case,
2968 then the end address of the Linux memory will be located at a
2969 non page size aligned address and this could cause major
2970 problems.
2971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002972- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002973 Default load address for network file downloads
2974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002975- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002976 Enable temporary baudrate change while serial download
2977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002978- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002979 Physical start address of SDRAM. _Must_ be 0 here.
2980
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002981- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002982 Physical start address of Motherboard I/O (if using a
2983 Cogent motherboard)
2984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002985- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002986 Physical start address of Flash memory.
2987
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002988- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002989 Physical start address of boot monitor code (set by
2990 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002991 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002992 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002993
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002994- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002995 Size of memory reserved for monitor code, used to
2996 determine _at_compile_time_ (!) if the environment is
2997 embedded within the U-Boot image, or in a separate
2998 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003000- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003001 Size of DRAM reserved for malloc() use.
3002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003003- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003004 Normally compressed uImages are limited to an
3005 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003006 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003007 to adjust this setting to your needs.
3008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003009- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003010 Maximum size of memory mapped by the startup code of
3011 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003012 the Linux kernel (bd_info, boot arguments, FDT blob if
3013 used) must be put below this limit, unless "bootm_low"
3014 enviroment variable is defined and non-zero. In such case
3015 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003016 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003017 variable "bootm_mapsize" will override the value of
3018 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3019 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003020
John Rigbyfca43cc2010-10-13 13:57:35 -06003021- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3022 Enable initrd_high functionality. If defined then the
3023 initrd_high feature is enabled and the bootm ramdisk subcommand
3024 is enabled.
3025
3026- CONFIG_SYS_BOOT_GET_CMDLINE:
3027 Enables allocating and saving kernel cmdline in space between
3028 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3029
3030- CONFIG_SYS_BOOT_GET_KBD:
3031 Enables allocating and saving a kernel copy of the bd_info in
3032 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3033
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003034- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003035 Max number of Flash memory banks
3036
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003037- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003038 Max number of sectors on a Flash chip
3039
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003040- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003041 Timeout for Flash erase operations (in ms)
3042
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003043- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003044 Timeout for Flash write operations (in ms)
3045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003046- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003047 Timeout for Flash set sector lock bit operation (in ms)
3048
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003049- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003050 Timeout for Flash clear lock bits operation (in ms)
3051
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003052- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003053 If defined, hardware flash sectors protection is used
3054 instead of U-Boot software protection.
3055
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003056- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003057
3058 Enable TFTP transfers directly to flash memory;
3059 without this option such a download has to be
3060 performed in two steps: (1) download to RAM, and (2)
3061 copy from RAM to flash.
3062
3063 The two-step approach is usually more reliable, since
3064 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003065 the flash, but in some situations (when system RAM is
3066 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003067 downloaded image) this option may be very useful.
3068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003069- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003070 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003071 common flash structure for storing flash geometry.
3072
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003073- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003074 This option also enables the building of the cfi_flash driver
3075 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003076
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003077- CONFIG_FLASH_CFI_MTD
3078 This option enables the building of the cfi_mtd driver
3079 in the drivers directory. The driver exports CFI flash
3080 to the MTD layer.
3081
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003082- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003083 Use buffered writes to flash.
3084
3085- CONFIG_FLASH_SPANSION_S29WS_N
3086 s29ws-n MirrorBit flash has non-standard addresses for buffered
3087 write commands.
3088
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003089- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003090 If this option is defined, the common CFI flash doesn't
3091 print it's warning upon not recognized FLASH banks. This
3092 is useful, if some of the configured banks are only
3093 optionally available.
3094
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003095- CONFIG_FLASH_SHOW_PROGRESS
3096 If defined (must be an integer), print out countdown
3097 digits and dots. Recommended value: 45 (9..1) for 80
3098 column displays, 15 (3..1) for 40 column displays.
3099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003100- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003101 Defines the number of Ethernet receive buffers. On some
3102 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003103 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3104 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003105 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003106 Defaults to 4 if not defined.
3107
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003108- CONFIG_ENV_MAX_ENTRIES
3109
Wolfgang Denk071bc922010-10-27 22:48:30 +02003110 Maximum number of entries in the hash table that is used
3111 internally to store the environment settings. The default
3112 setting is supposed to be generous and should work in most
3113 cases. This setting can be used to tune behaviour; see
3114 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003115
wdenkc6097192002-11-03 00:24:07 +00003116The following definitions that deal with the placement and management
3117of environment data (variable area); in general, we support the
3118following configurations:
3119
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003120- CONFIG_BUILD_ENVCRC:
3121
3122 Builds up envcrc with the target environment so that external utils
3123 may easily extract it and embed it in final U-Boot images.
3124
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003125- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003126
3127 Define this if the environment is in flash memory.
3128
3129 a) The environment occupies one whole flash sector, which is
3130 "embedded" in the text segment with the U-Boot code. This
3131 happens usually with "bottom boot sector" or "top boot
3132 sector" type flash chips, which have several smaller
3133 sectors at the start or the end. For instance, such a
3134 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3135 such a case you would place the environment in one of the
3136 4 kB sectors - with U-Boot code before and after it. With
3137 "top boot sector" type flash chips, you would put the
3138 environment in one of the last sectors, leaving a gap
3139 between U-Boot and the environment.
3140
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003141 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003142
3143 Offset of environment data (variable area) to the
3144 beginning of flash memory; for instance, with bottom boot
3145 type flash chips the second sector can be used: the offset
3146 for this sector is given here.
3147
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003148 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003149
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003150 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003151
3152 This is just another way to specify the start address of
3153 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003154 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003155
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003156 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003157
3158 Size of the sector containing the environment.
3159
3160
3161 b) Sometimes flash chips have few, equal sized, BIG sectors.
3162 In such a case you don't want to spend a whole sector for
3163 the environment.
3164
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003165 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003166
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003167 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003168 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003169 of this flash sector for the environment. This saves
3170 memory for the RAM copy of the environment.
3171
3172 It may also save flash memory if you decide to use this
3173 when your environment is "embedded" within U-Boot code,
3174 since then the remainder of the flash sector could be used
3175 for U-Boot code. It should be pointed out that this is
3176 STRONGLY DISCOURAGED from a robustness point of view:
3177 updating the environment in flash makes it always
3178 necessary to erase the WHOLE sector. If something goes
3179 wrong before the contents has been restored from a copy in
3180 RAM, your target system will be dead.
3181
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003182 - CONFIG_ENV_ADDR_REDUND
3183 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003184
wdenk43d96162003-03-06 00:02:04 +00003185 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003186 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003187 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003188 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003189
3190BE CAREFUL! Any changes to the flash layout, and some changes to the
3191source code will make it necessary to adapt <board>/u-boot.lds*
3192accordingly!
3193
3194
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003195- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003196
3197 Define this if you have some non-volatile memory device
3198 (NVRAM, battery buffered SRAM) which you want to use for the
3199 environment.
3200
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003201 - CONFIG_ENV_ADDR:
3202 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003203
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003204 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003205 want to use for environment. It is assumed that this memory
3206 can just be read and written to, without any special
3207 provision.
3208
3209BE CAREFUL! The first access to the environment happens quite early
3210in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003211console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003212U-Boot will hang.
3213
3214Please note that even with NVRAM we still use a copy of the
3215environment in RAM: we could work on NVRAM directly, but we want to
3216keep settings there always unmodified except somebody uses "saveenv"
3217to save the current settings.
3218
3219
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003220- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003221
3222 Use this if you have an EEPROM or similar serial access
3223 device and a driver for it.
3224
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003225 - CONFIG_ENV_OFFSET:
3226 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003227
3228 These two #defines specify the offset and size of the
3229 environment area within the total memory of your EEPROM.
3230
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003231 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003232 If defined, specified the chip address of the EEPROM device.
3233 The default address is zero.
3234
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003235 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003236 If defined, the number of bits used to address bytes in a
3237 single page in the EEPROM device. A 64 byte page, for example
3238 would require six bits.
3239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003240 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003241 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003242 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003244 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003245 The length in bytes of the EEPROM memory array address. Note
3246 that this is NOT the chip address length!
3247
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003248 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003249 EEPROM chips that implement "address overflow" are ones
3250 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3251 address and the extra bits end up in the "chip address" bit
3252 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3253 byte chips.
3254
3255 Note that we consider the length of the address field to
3256 still be one byte because the extra address bits are hidden
3257 in the chip address.
3258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003260 The size in bytes of the EEPROM device.
3261
Heiko Schocher548738b2010-01-07 08:55:40 +01003262 - CONFIG_ENV_EEPROM_IS_ON_I2C
3263 define this, if you have I2C and SPI activated, and your
3264 EEPROM, which holds the environment, is on the I2C bus.
3265
3266 - CONFIG_I2C_ENV_EEPROM_BUS
3267 if you have an Environment on an EEPROM reached over
3268 I2C muxes, you can define here, how to reach this
3269 EEPROM. For example:
3270
Wolfgang Denka9046b92010-06-13 17:48:15 +02003271 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003272
3273 EEPROM which holds the environment, is reached over
3274 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003275
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003276- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003277
wdenkd4ca31c2004-01-02 14:00:00 +00003278 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003279 want to use for the environment.
3280
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003281 - CONFIG_ENV_OFFSET:
3282 - CONFIG_ENV_ADDR:
3283 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003284
3285 These three #defines specify the offset and size of the
3286 environment area within the total memory of your DataFlash placed
3287 at the specified address.
3288
Liu Gang0a85a9e2012-03-08 00:33:20 +00003289- CONFIG_ENV_IS_IN_REMOTE:
3290
3291 Define this if you have a remote memory space which you
3292 want to use for the local device's environment.
3293
3294 - CONFIG_ENV_ADDR:
3295 - CONFIG_ENV_SIZE:
3296
3297 These two #defines specify the address and size of the
3298 environment area within the remote memory space. The
3299 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003300 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003301
3302BE CAREFUL! For some special cases, the local device can not use
3303"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003304environment stored in a remote NOR flash by SRIO or PCIE link,
3305but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003306
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003307- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003308
3309 Define this if you have a NAND device which you want to use
3310 for the environment.
3311
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003312 - CONFIG_ENV_OFFSET:
3313 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003314
3315 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003316 area within the first NAND device. CONFIG_ENV_OFFSET must be
3317 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003318
Scott Woodfdd813d2010-09-17 14:38:37 -05003319 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003320
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003321 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003322 size used to hold a redundant copy of the environment data, so
3323 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003324 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003325 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003326
Scott Woodfdd813d2010-09-17 14:38:37 -05003327 - CONFIG_ENV_RANGE (optional):
3328
3329 Specifies the length of the region in which the environment
3330 can be written. This should be a multiple of the NAND device's
3331 block size. Specifying a range with more erase blocks than
3332 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3333 the range to be avoided.
3334
3335 - CONFIG_ENV_OFFSET_OOB (optional):
3336
3337 Enables support for dynamically retrieving the offset of the
3338 environment from block zero's out-of-band data. The
3339 "nand env.oob" command can be used to record this offset.
3340 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3341 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003342
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003343- CONFIG_NAND_ENV_DST
3344
3345 Defines address in RAM to which the nand_spl code should copy the
3346 environment. If redundant environment is used, it will be copied to
3347 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003349- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003350
3351 Defines offset to the initial SPI buffer area in DPRAM. The
3352 area is used at an early stage (ROM part) if the environment
3353 is configured to reside in the SPI EEPROM: We need a 520 byte
3354 scratch DPRAM area. It is used between the two initialization
3355 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3356 to be a good choice since it makes it far enough from the
3357 start of the data area as well as from the stack pointer.
3358
Bruce Adlere881cb52007-11-02 13:15:42 -07003359Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003360has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003361created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003362until then to read environment variables.
3363
wdenk85ec0bc2003-03-31 16:34:49 +00003364The environment is protected by a CRC32 checksum. Before the monitor
3365is relocated into RAM, as a result of a bad CRC you will be working
3366with the compiled-in default environment - *silently*!!! [This is
3367necessary, because the first environment variable we need is the
3368"baudrate" setting for the console - if we have a bad CRC, we don't
3369have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003370
3371Note: once the monitor has been relocated, then it will complain if
3372the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003373use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003375- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003376 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003377
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003378 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003379 also needs to be defined.
3380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003381- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003382 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003383
Ron Madridf5675aa2009-02-18 14:30:44 -08003384- CONFIG_NS16550_MIN_FUNCTIONS:
3385 Define this if you desire to only have use of the NS16550_init
3386 and NS16550_putc functions for the serial driver located at
3387 drivers/serial/ns16550.c. This option is useful for saving
3388 space for already greatly restricted images, including but not
3389 limited to NAND_SPL configurations.
3390
wdenkc6097192002-11-03 00:24:07 +00003391Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003392---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003394- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003395 Cache Line Size of the CPU.
3396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003397- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003398 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003399
wdenk42d1f032003-10-15 23:53:47 +00003400 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3401 and RPXsuper) to be able to adjust the position of
3402 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003403
Timur Tabie46fedf2011-08-04 18:03:41 -05003404- CONFIG_SYS_CCSRBAR_DEFAULT:
3405 Default (power-on reset) physical address of CCSR on Freescale
3406 PowerPC SOCs.
3407
3408- CONFIG_SYS_CCSRBAR:
3409 Virtual address of CCSR. On a 32-bit build, this is typically
3410 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3411
3412 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3413 for cross-platform code that uses that macro instead.
3414
3415- CONFIG_SYS_CCSRBAR_PHYS:
3416 Physical address of CCSR. CCSR can be relocated to a new
3417 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003418 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003419 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3420 is typically relocated on 36-bit builds. It is recommended
3421 that this macro be defined via the _HIGH and _LOW macros:
3422
3423 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3424 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3425
3426- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003427 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3428 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003429 used in assembly code, so it must not contain typecasts or
3430 integer size suffixes (e.g. "ULL").
3431
3432- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3433 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3434 used in assembly code, so it must not contain typecasts or
3435 integer size suffixes (e.g. "ULL").
3436
3437- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3438 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3439 forced to a value that ensures that CCSR is not relocated.
3440
wdenk7f6c2cb2002-11-10 22:06:23 +00003441- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003442 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003443
3444 the default drive number (default value 0)
3445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003446 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003447
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003448 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003449 (default value 1)
3450
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003451 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003452
wdenk43d96162003-03-06 00:02:04 +00003453 defines the offset of register from address. It
3454 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003455 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003457 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3458 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003459 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003461 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003462 fdc_hw_init() is called at the beginning of the FDC
3463 setup. fdc_hw_init() must be provided by the board
3464 source code. It is used to make hardware dependant
3465 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003466
Macpaul Lin0abddf82011-04-11 20:45:32 +00003467- CONFIG_IDE_AHB:
3468 Most IDE controllers were designed to be connected with PCI
3469 interface. Only few of them were designed for AHB interface.
3470 When software is doing ATA command and data transfer to
3471 IDE devices through IDE-AHB controller, some additional
3472 registers accessing to these kind of IDE-AHB controller
3473 is requierd.
3474
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003475- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003476 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003477 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003479- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003480
wdenk7152b1d2003-09-05 23:19:14 +00003481 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003482 initial data and stack; please note that this must be
3483 writable memory that is working WITHOUT special
3484 initialization, i. e. you CANNOT use normal RAM which
3485 will become available only after programming the
3486 memory controller and running certain initialization
3487 sequences.
3488
3489 U-Boot uses the following memory types:
3490 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3491 - MPC824X: data cache
3492 - PPC4xx: data cache
3493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003494- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003495
3496 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003497 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3498 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003499 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003500 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003501 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3502 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3503 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003504
3505 Note:
3506 On the MPC824X (or other systems that use the data
3507 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003508 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003509 point to an otherwise UNUSED address space between
3510 the top of RAM and the start of the PCI space.
3511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003512- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003513
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003514- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003516- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003518- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003520- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003522- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003525 SDRAM timing
3526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003527- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003528 periodic timer for refresh
3529
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003530- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003531
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003532- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3533 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3534 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3535 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003536 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3537
3538- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003539 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3540 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003541 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003543- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3544 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003545 Machine Mode Register and Memory Periodic Timer
3546 Prescaler definitions (SDRAM timing)
3547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003548- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003549 enable I2C microcode relocation patch (MPC8xx);
3550 define relocation offset in DPRAM [DSP2]
3551
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003552- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003553 enable SMC microcode relocation patch (MPC8xx);
3554 define relocation offset in DPRAM [SMC1]
3555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003557 enable SPI microcode relocation patch (MPC8xx);
3558 define relocation offset in DPRAM [SCC4]
3559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003560- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003561 Use OSCM clock mode on MBX8xx board. Be careful,
3562 wrong setting might damage your board. Read
3563 doc/README.MBX before setting this variable!
3564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003565- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003566 Offset of the bootmode word in DPRAM used by post
3567 (Power On Self Tests). This definition overrides
3568 #define'd default value in commproc.h resp.
3569 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003570
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003571- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3572 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3573 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3574 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3575 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3576 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3577 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3578 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003579 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003580
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003581- CONFIG_PCI_DISABLE_PCIE:
3582 Disable PCI-Express on systems where it is supported but not
3583 required.
3584
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003585- CONFIG_PCI_ENUM_ONLY
3586 Only scan through and get the devices on the busses.
3587 Don't do any setup work, presumably because someone or
3588 something has already done it, and we don't need to do it
3589 a second time. Useful for platforms that are pre-booted
3590 by coreboot or similar.
3591
Kumar Galaa09b9b62010-12-30 12:09:53 -06003592- CONFIG_SYS_SRIO:
3593 Chip has SRIO or not
3594
3595- CONFIG_SRIO1:
3596 Board has SRIO 1 port available
3597
3598- CONFIG_SRIO2:
3599 Board has SRIO 2 port available
3600
3601- CONFIG_SYS_SRIOn_MEM_VIRT:
3602 Virtual Address of SRIO port 'n' memory region
3603
3604- CONFIG_SYS_SRIOn_MEM_PHYS:
3605 Physical Address of SRIO port 'n' memory region
3606
3607- CONFIG_SYS_SRIOn_MEM_SIZE:
3608 Size of SRIO port 'n' memory region
3609
Alex Watermaneced4622011-05-19 15:08:36 -04003610- CONFIG_SYS_NDFC_16
3611 Defined to tell the NDFC that the NAND chip is using a
3612 16 bit bus.
3613
3614- CONFIG_SYS_NDFC_EBC0_CFG
3615 Sets the EBC0_CFG register for the NDFC. If not defined
3616 a default value will be used.
3617
Ben Warrenbb99ad62006-09-07 16:50:54 -04003618- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003619 Get DDR timing information from an I2C EEPROM. Common
3620 with pluggable memory modules such as SODIMMs
3621
Ben Warrenbb99ad62006-09-07 16:50:54 -04003622 SPD_EEPROM_ADDRESS
3623 I2C address of the SPD EEPROM
3624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003625- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003626 If SPD EEPROM is on an I2C bus other than the first
3627 one, specify here. Note that the value must resolve
3628 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003629
York Sun1b3e3c42011-06-07 09:42:16 +08003630- CONFIG_SYS_DDR_RAW_TIMING
3631 Get DDR timing information from other than SPD. Common with
3632 soldered DDR chips onboard without SPD. DDR raw timing
3633 parameters are extracted from datasheet and hard-coded into
3634 header files or board specific files.
3635
York Sun6f5e1dc2011-09-16 13:21:35 -07003636- CONFIG_FSL_DDR_INTERACTIVE
3637 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003639- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003640 Only for 83xx systems. If specified, then DDR should
3641 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003642
wdenkc26e4542004-04-18 10:13:26 +00003643- CONFIG_ETHER_ON_FEC[12]
3644 Define to enable FEC[12] on a 8xx series processor.
3645
3646- CONFIG_FEC[12]_PHY
3647 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003648 to the given FEC; i. e.
3649 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003650 means that the PHY with address 4 is connected to FEC1
3651
3652 When set to -1, means to probe for first available.
3653
3654- CONFIG_FEC[12]_PHY_NORXERR
3655 The PHY does not have a RXERR line (RMII only).
3656 (so program the FEC to ignore it).
3657
3658- CONFIG_RMII
3659 Enable RMII mode for all FECs.
3660 Note that this is a global option, we can't
3661 have one FEC in standard MII mode and another in RMII mode.
3662
wdenk5cf91d62004-04-23 20:32:05 +00003663- CONFIG_CRC32_VERIFY
3664 Add a verify option to the crc32 command.
3665 The syntax is:
3666
3667 => crc32 -v <address> <count> <crc32>
3668
3669 Where address/count indicate a memory area
3670 and crc32 is the correct crc32 which the
3671 area should have.
3672
wdenk56523f12004-07-11 17:40:54 +00003673- CONFIG_LOOPW
3674 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003675 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003676
stroese7b466642004-12-16 18:46:55 +00003677- CONFIG_MX_CYCLIC
3678 Add the "mdc" and "mwc" memory commands. These are cyclic
3679 "md/mw" commands.
3680 Examples:
3681
wdenkefe2a4d2004-12-16 21:44:03 +00003682 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003683 This command will print 4 bytes (10,11,12,13) each 500 ms.
3684
wdenkefe2a4d2004-12-16 21:44:03 +00003685 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003686 This command will write 12345678 to address 100 all 10 ms.
3687
wdenkefe2a4d2004-12-16 21:44:03 +00003688 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003689 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003690
wdenk8aa1a2d2005-04-04 12:44:11 +00003691- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003692 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003693 low level initializations (like setting up the memory
3694 controller) are omitted and/or U-Boot does not
3695 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003696
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003697 Normally this variable MUST NOT be defined. The only
3698 exception is when U-Boot is loaded (to RAM) by some
3699 other boot loader or by a debugger which performs
3700 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003701
Aneesh V401bb302011-07-13 05:11:07 +00003702- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003703 Modifies the behaviour of start.S when compiling a loader
3704 that is executed before the actual U-Boot. E.g. when
3705 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003706
Matthias Weisserd8834a12011-03-10 21:36:32 +00003707- CONFIG_USE_ARCH_MEMCPY
3708 CONFIG_USE_ARCH_MEMSET
3709 If these options are used a optimized version of memcpy/memset will
3710 be used if available. These functions may be faster under some
3711 conditions but may increase the binary size.
3712
Gabe Blackb16f5212012-11-27 21:08:06 +00003713- CONFIG_X86_NO_RESET_VECTOR
3714 If defined, the x86 reset vector code is excluded. You will need
3715 to do this when U-Boot is running from Coreboot.
3716
Gabe Black5b5ece92012-11-29 16:23:41 +00003717- CONFIG_X86_NO_REAL_MODE
3718 If defined, x86 real mode code is omitted. This assumes a
3719 32-bit environment where such code is not needed. You will
3720 need to do this when U-Boot is running from Coreboot.
3721
3722
Timur Tabif2717b42011-11-22 09:21:25 -06003723Freescale QE/FMAN Firmware Support:
3724-----------------------------------
3725
3726The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3727loading of "firmware", which is encoded in the QE firmware binary format.
3728This firmware often needs to be loaded during U-Boot booting, so macros
3729are used to identify the storage device (NOR flash, SPI, etc) and the address
3730within that device.
3731
3732- CONFIG_SYS_QE_FMAN_FW_ADDR
3733 The address in the storage device where the firmware is located. The
3734 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3735 is also specified.
3736
3737- CONFIG_SYS_QE_FMAN_FW_LENGTH
3738 The maximum possible size of the firmware. The firmware binary format
3739 has a field that specifies the actual size of the firmware, but it
3740 might not be possible to read any part of the firmware unless some
3741 local storage is allocated to hold the entire firmware first.
3742
3743- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3744 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3745 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3746 virtual address in NOR flash.
3747
3748- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3749 Specifies that QE/FMAN firmware is located in NAND flash.
3750 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3751
3752- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3753 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3754 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3755
3756- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3757 Specifies that QE/FMAN firmware is located on the primary SPI
3758 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3759
Liu Gang292dc6c2012-03-08 00:33:18 +00003760- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3761 Specifies that QE/FMAN firmware is located in the remote (master)
3762 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003763 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3764 window->master inbound window->master LAW->the ucode address in
3765 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003766
wdenkc6097192002-11-03 00:24:07 +00003767Building the Software:
3768======================
3769
Wolfgang Denk218ca722008-03-26 10:40:12 +01003770Building U-Boot has been tested in several native build environments
3771and in many different cross environments. Of course we cannot support
3772all possibly existing versions of cross development tools in all
3773(potentially obsolete) versions. In case of tool chain problems we
3774recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3775which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003776
Wolfgang Denk218ca722008-03-26 10:40:12 +01003777If you are not using a native environment, it is assumed that you
3778have GNU cross compiling tools available in your path. In this case,
3779you must set the environment variable CROSS_COMPILE in your shell.
3780Note that no changes to the Makefile or any other source files are
3781necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003782
Wolfgang Denk218ca722008-03-26 10:40:12 +01003783 $ CROSS_COMPILE=ppc_4xx-
3784 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003785
Peter Tyser2f8d3962009-03-13 18:54:51 -05003786Note: If you wish to generate Windows versions of the utilities in
3787 the tools directory you can use the MinGW toolchain
3788 (http://www.mingw.org). Set your HOST tools to the MinGW
3789 toolchain and execute 'make tools'. For example:
3790
3791 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3792
3793 Binaries such as tools/mkimage.exe will be created which can
3794 be executed on computers running Windows.
3795
Wolfgang Denk218ca722008-03-26 10:40:12 +01003796U-Boot is intended to be simple to build. After installing the
3797sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003798is done by typing:
3799
3800 make NAME_config
3801
Wolfgang Denk218ca722008-03-26 10:40:12 +01003802where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003803rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003804
wdenk2729af92004-05-03 20:45:30 +00003805Note: for some board special configuration names may exist; check if
3806 additional information is available from the board vendor; for
3807 instance, the TQM823L systems are available without (standard)
3808 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003809 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk2729af92004-05-03 20:45:30 +00003811 make TQM823L_config
3812 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk2729af92004-05-03 20:45:30 +00003814 make TQM823L_LCD_config
3815 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003816
wdenk2729af92004-05-03 20:45:30 +00003817 etc.
wdenkc6097192002-11-03 00:24:07 +00003818
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820Finally, type "make all", and you should get some working U-Boot
3821images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823- "u-boot.bin" is a raw binary image
3824- "u-boot" is an image in ELF binary format
3825- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003826
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003827By default the build is performed locally and the objects are saved
3828in the source directory. One of the two methods can be used to change
3829this behavior and build U-Boot to some external directory:
3830
38311. Add O= to the make command line invocations:
3832
3833 make O=/tmp/build distclean
3834 make O=/tmp/build NAME_config
3835 make O=/tmp/build all
3836
38372. Set environment variable BUILD_DIR to point to the desired location:
3838
3839 export BUILD_DIR=/tmp/build
3840 make distclean
3841 make NAME_config
3842 make all
3843
3844Note that the command line "O=" setting overrides the BUILD_DIR environment
3845variable.
3846
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848Please be aware that the Makefiles assume you are using GNU make, so
3849for instance on NetBSD you might need to use "gmake" instead of
3850native "make".
wdenkc6097192002-11-03 00:24:07 +00003851
wdenkc6097192002-11-03 00:24:07 +00003852
wdenk2729af92004-05-03 20:45:30 +00003853If the system board that you have is not listed, then you will need
3854to port U-Boot to your hardware platform. To do this, follow these
3855steps:
wdenkc6097192002-11-03 00:24:07 +00003856
wdenk2729af92004-05-03 20:45:30 +000038571. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003858 "boards.cfg" file, using the existing entries as examples.
3859 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000038602. Create a new directory to hold your board specific code. Add any
3861 files you need. In your board directory, you will need at least
3862 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
38633. Create a new configuration file "include/configs/<board>.h" for
3864 your board
38653. If you're porting U-Boot to a new CPU, then also create a new
3866 directory to hold your CPU specific code. Add any files you need.
38674. Run "make <board>_config" with your new name.
38685. Type "make", and you should get a working "u-boot.srec" file
3869 to be installed on your target system.
38706. Debug and solve any problems that might arise.
3871 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003872
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3875==============================================================
wdenkc6097192002-11-03 00:24:07 +00003876
Wolfgang Denk218ca722008-03-26 10:40:12 +01003877If you have modified U-Boot sources (for instance added a new board
3878or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003879provide feedback to the other developers. The feedback normally takes
3880the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003881official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003882
Wolfgang Denk218ca722008-03-26 10:40:12 +01003883But before you submit such a patch, please verify that your modifi-
3884cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003885the supported boards compile WITHOUT ANY compiler warnings. To do so,
3886just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003887for ALL supported system. Be warned, this will take a while. You can
3888select which (cross) compiler to use by passing a `CROSS_COMPILE'
3889environment variable to the script, i. e. to use the ELDK cross tools
3890you can type
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003893
wdenk2729af92004-05-03 20:45:30 +00003894or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003897
Wolfgang Denk218ca722008-03-26 10:40:12 +01003898When using the MAKEALL script, the default behaviour is to build
3899U-Boot in the source directory. This location can be changed by
3900setting the BUILD_DIR environment variable. Also, for each target
3901built, the MAKEALL script saves two log files (<target>.ERR and
3902<target>.MAKEALL) in the <source dir>/LOG directory. This default
3903location can be changed by setting the MAKEALL_LOGDIR environment
3904variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003905
3906 export BUILD_DIR=/tmp/build
3907 export MAKEALL_LOGDIR=/tmp/log
3908 CROSS_COMPILE=ppc_8xx- MAKEALL
3909
Wolfgang Denk218ca722008-03-26 10:40:12 +01003910With the above settings build objects are saved in the /tmp/build,
3911log files are saved in the /tmp/log and the source tree remains clean
3912during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003913
3914
wdenk2729af92004-05-03 20:45:30 +00003915See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003916
wdenkc6097192002-11-03 00:24:07 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918Monitor Commands - Overview:
3919============================
wdenkc6097192002-11-03 00:24:07 +00003920
wdenk2729af92004-05-03 20:45:30 +00003921go - start application at address 'addr'
3922run - run commands in an environment variable
3923bootm - boot application image from memory
3924bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003925bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003926tftpboot- boot image via network using TFTP protocol
3927 and env variables "ipaddr" and "serverip"
3928 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003929tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003930rarpboot- boot image via network using RARP/TFTP protocol
3931diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3932loads - load S-Record file over serial line
3933loadb - load binary file over serial line (kermit mode)
3934md - memory display
3935mm - memory modify (auto-incrementing)
3936nm - memory modify (constant address)
3937mw - memory write (fill)
3938cp - memory copy
3939cmp - memory compare
3940crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003941i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003942sspi - SPI utility commands
3943base - print or set address offset
3944printenv- print environment variables
3945setenv - set environment variables
3946saveenv - save environment variables to persistent storage
3947protect - enable or disable FLASH write protection
3948erase - erase FLASH memory
3949flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00003950nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00003951bdinfo - print Board Info structure
3952iminfo - print header information for application image
3953coninfo - print console devices and informations
3954ide - IDE sub-system
3955loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003956loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003957mtest - simple RAM test
3958icache - enable or disable instruction cache
3959dcache - enable or disable data cache
3960reset - Perform RESET of the CPU
3961echo - echo args to console
3962version - print monitor version
3963help - print online help
3964? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003965
wdenkc6097192002-11-03 00:24:07 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967Monitor Commands - Detailed Description:
3968========================================
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk2729af92004-05-03 20:45:30 +00003970TODO.
wdenkc6097192002-11-03 00:24:07 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003973
3974
wdenk2729af92004-05-03 20:45:30 +00003975Environment Variables:
3976======================
wdenkc6097192002-11-03 00:24:07 +00003977
wdenk2729af92004-05-03 20:45:30 +00003978U-Boot supports user configuration using Environment Variables which
3979can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003980
wdenk2729af92004-05-03 20:45:30 +00003981Environment Variables are set using "setenv", printed using
3982"printenv", and saved to Flash using "saveenv". Using "setenv"
3983without a value can be used to delete a variable from the
3984environment. As long as you don't save the environment you are
3985working with an in-memory copy. In case the Flash area containing the
3986environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003987
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003988Some configuration options can be set using Environment Variables.
3989
3990List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk2729af92004-05-03 20:45:30 +00003996 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003997
wdenk2729af92004-05-03 20:45:30 +00003998 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003999
wdenk2729af92004-05-03 20:45:30 +00004000 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004001
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004002 bootm_low - Memory range available for image processing in the bootm
4003 command can be restricted. This variable is given as
4004 a hexadecimal number and defines lowest address allowed
4005 for use by the bootm command. See also "bootm_size"
4006 environment variable. Address defined by "bootm_low" is
4007 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004008 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4009 bootm_mapsize.
4010
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004011 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004012 This variable is given as a hexadecimal number and it
4013 defines the size of the memory region starting at base
4014 address bootm_low that is accessible by the Linux kernel
4015 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4016 as the default value if it is defined, and bootm_size is
4017 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004018
4019 bootm_size - Memory range available for image processing in the bootm
4020 command can be restricted. This variable is given as
4021 a hexadecimal number and defines the size of the region
4022 allowed for use by the bootm command. See also "bootm_low"
4023 environment variable.
4024
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004025 updatefile - Location of the software update file on a TFTP server, used
4026 by the automatic software update feature. Please refer to
4027 documentation in doc/README.update for more details.
4028
wdenk2729af92004-05-03 20:45:30 +00004029 autoload - if set to "no" (any string beginning with 'n'),
4030 "bootp" will just load perform a lookup of the
4031 configuration from the BOOTP server, but not try to
4032 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk2729af92004-05-03 20:45:30 +00004034 autostart - if set to "yes", an image loaded using the "bootp",
4035 "rarpboot", "tftpboot" or "diskboot" commands will
4036 be automatically started (by internally calling
4037 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039 If set to "no", a standalone image passed to the
4040 "bootm" command will be copied to the load address
4041 (and eventually uncompressed), but NOT be started.
4042 This can be used to load and uncompress arbitrary
4043 data.
wdenkc6097192002-11-03 00:24:07 +00004044
David A. Longa28afca2011-07-09 16:40:19 -04004045 fdt_high - if set this restricts the maximum address that the
4046 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004047 For example, if you have a system with 1 GB memory
4048 at physical address 0x10000000, while Linux kernel
4049 only recognizes the first 704 MB as low memory, you
4050 may need to set fdt_high as 0x3C000000 to have the
4051 device tree blob be copied to the maximum address
4052 of the 704 MB low memory, so that Linux kernel can
4053 access it during the boot procedure.
4054
David A. Longa28afca2011-07-09 16:40:19 -04004055 If this is set to the special value 0xFFFFFFFF then
4056 the fdt will not be copied at all on boot. For this
4057 to work it must reside in writable memory, have
4058 sufficient padding on the end of it for u-boot to
4059 add the information it needs into it, and the memory
4060 must be accessible by the kernel.
4061
Simon Glasseea63e02011-10-24 19:15:34 +00004062 fdtcontroladdr- if set this is the address of the control flattened
4063 device tree used by U-Boot when CONFIG_OF_CONTROL is
4064 defined.
4065
wdenk17ea1172004-06-06 21:51:03 +00004066 i2cfast - (PPC405GP|PPC405EP only)
4067 if set to 'y' configures Linux I2C driver for fast
4068 mode (400kHZ). This environment variable is used in
4069 initialization code. So, for changes to be effective
4070 it must be saved and board must be reset.
4071
wdenk2729af92004-05-03 20:45:30 +00004072 initrd_high - restrict positioning of initrd images:
4073 If this variable is not set, initrd images will be
4074 copied to the highest possible address in RAM; this
4075 is usually what you want since it allows for
4076 maximum initrd size. If for some reason you want to
4077 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004078 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004079 variable to a value of "no" or "off" or "0".
4080 Alternatively, you can set it to a maximum upper
4081 address to use (U-Boot will still check that it
4082 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004083
wdenk2729af92004-05-03 20:45:30 +00004084 For instance, when you have a system with 16 MB
4085 RAM, and want to reserve 4 MB from use by Linux,
4086 you can do this by adding "mem=12M" to the value of
4087 the "bootargs" variable. However, now you must make
4088 sure that the initrd image is placed in the first
4089 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004090
wdenk2729af92004-05-03 20:45:30 +00004091 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004092
wdenk2729af92004-05-03 20:45:30 +00004093 If you set initrd_high to 0xFFFFFFFF, this is an
4094 indication to U-Boot that all addresses are legal
4095 for the Linux kernel, including addresses in flash
4096 memory. In this case U-Boot will NOT COPY the
4097 ramdisk at all. This may be useful to reduce the
4098 boot time on your system, but requires that this
4099 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004100
wdenk2729af92004-05-03 20:45:30 +00004101 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103 loadaddr - Default load address for commands like "bootp",
4104 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004105
wdenk2729af92004-05-03 20:45:30 +00004106 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004109
wdenk2729af92004-05-03 20:45:30 +00004110 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004111
wdenk2729af92004-05-03 20:45:30 +00004112 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004115
Mike Frysingere2a53452011-10-02 10:01:27 +00004116 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004117
Mike Frysingere2a53452011-10-02 10:01:27 +00004118 ethact - controls which interface is currently active.
4119 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004120
Heiko Schocher48690d82010-07-20 17:45:02 +02004121 => setenv ethact FEC
4122 => ping 192.168.0.1 # traffic sent on FEC
4123 => setenv ethact SCC
4124 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004125
Matthias Fuchse1692572008-01-17 07:45:05 +01004126 ethrotate - When set to "no" U-Boot does not go through all
4127 available network interfaces.
4128 It just stays at the currently selected interface.
4129
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004130 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004131 either succeed or fail without retrying.
4132 When set to "once" the network operation will
4133 fail when all the available network interfaces
4134 are tried once without success.
4135 Useful on scripts which control the retry operation
4136 themselves.
wdenkc6097192002-11-03 00:24:07 +00004137
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004138 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004139
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004140 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004141 UDP source port.
4142
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004143 tftpdstport - If this is set, the value is used for TFTP's UDP
4144 destination port instead of the Well Know Port 69.
4145
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004146 tftpblocksize - Block size to use for TFTP transfers; if not set,
4147 we use the TFTP server's default block size
4148
4149 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4150 seconds, minimum value is 1000 = 1 second). Defines
4151 when a packet is considered to be lost so it has to
4152 be retransmitted. The default is 5000 = 5 seconds.
4153 Lowering this value may make downloads succeed
4154 faster in networks with high packet loss rates or
4155 with unreliable TFTP servers.
4156
4157 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004158 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004159 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004160
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004161The following image location variables contain the location of images
4162used in booting. The "Image" column gives the role of the image and is
4163not an environment variable name. The other columns are environment
4164variable names. "File Name" gives the name of the file on a TFTP
4165server, "RAM Address" gives the location in RAM the image will be
4166loaded to, and "Flash Location" gives the image's address in NOR
4167flash or offset in NAND flash.
4168
4169*Note* - these variables don't have to be defined for all boards, some
4170boards currenlty use other variables for these purposes, and some
4171boards use these variables for other purposes.
4172
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004173Image File Name RAM Address Flash Location
4174----- --------- ----------- --------------
4175u-boot u-boot u-boot_addr_r u-boot_addr
4176Linux kernel bootfile kernel_addr_r kernel_addr
4177device tree blob fdtfile fdt_addr_r fdt_addr
4178ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004179
wdenk2729af92004-05-03 20:45:30 +00004180The following environment variables may be used and automatically
4181updated by the network boot commands ("bootp" and "rarpboot"),
4182depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004183
wdenk2729af92004-05-03 20:45:30 +00004184 bootfile - see above
4185 dnsip - IP address of your Domain Name Server
4186 dnsip2 - IP address of your secondary Domain Name Server
4187 gatewayip - IP address of the Gateway (Router) to use
4188 hostname - Target hostname
4189 ipaddr - see above
4190 netmask - Subnet Mask
4191 rootpath - Pathname of the root filesystem on the NFS server
4192 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004193
wdenka3d991b2004-04-15 21:48:45 +00004194
wdenk2729af92004-05-03 20:45:30 +00004195There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197 serial# - contains hardware identification information such
4198 as type string and/or serial number
4199 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201These variables can be set only once (usually during manufacturing of
4202the board). U-Boot refuses to delete or overwrite these variables
4203once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004204
4205
wdenk2729af92004-05-03 20:45:30 +00004206Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004207
wdenk2729af92004-05-03 20:45:30 +00004208 ver - Contains the U-Boot version string as printed
4209 with the "version" command. This variable is
4210 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004211
wdenkc6097192002-11-03 00:24:07 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213Please note that changes to some configuration parameters may take
4214only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004215
stroesec1551ea2003-04-04 15:53:41 +00004216
Joe Hershberger170ab112012-12-11 22:16:24 -06004217Callback functions for environment variables:
4218---------------------------------------------
4219
4220For some environment variables, the behavior of u-boot needs to change
4221when their values are changed. This functionailty allows functions to
4222be associated with arbitrary variables. On creation, overwrite, or
4223deletion, the callback will provide the opportunity for some side
4224effect to happen or for the change to be rejected.
4225
4226The callbacks are named and associated with a function using the
4227U_BOOT_ENV_CALLBACK macro in your board or driver code.
4228
4229These callbacks are associated with variables in one of two ways. The
4230static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4231in the board configuration to a string that defines a list of
4232associations. The list must be in the following format:
4233
4234 entry = variable_name[:callback_name]
4235 list = entry[,list]
4236
4237If the callback name is not specified, then the callback is deleted.
4238Spaces are also allowed anywhere in the list.
4239
4240Callbacks can also be associated by defining the ".callbacks" variable
4241with the same list format above. Any association in ".callbacks" will
4242override any association in the static list. You can define
4243CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4244".callbacks" envirnoment variable in the default or embedded environment.
4245
4246
wdenk2729af92004-05-03 20:45:30 +00004247Command Line Parsing:
4248=====================
stroesec1551ea2003-04-04 15:53:41 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250There are two different command line parsers available with U-Boot:
4251the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253Old, simple command line parser:
4254--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk2729af92004-05-03 20:45:30 +00004256- supports environment variables (through setenv / saveenv commands)
4257- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004258- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004259- special characters ('$', ';') can be escaped by prefixing with '\',
4260 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004261 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004262- You can also escape text by enclosing in single apostrophes, for example:
4263 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk2729af92004-05-03 20:45:30 +00004265Hush shell:
4266-----------
wdenkf07771c2003-05-28 08:06:31 +00004267
wdenk2729af92004-05-03 20:45:30 +00004268- similar to Bourne shell, with control structures like
4269 if...then...else...fi, for...do...done; while...do...done,
4270 until...do...done, ...
4271- supports environment ("global") variables (through setenv / saveenv
4272 commands) and local shell variables (through standard shell syntax
4273 "name=value"); only environment variables can be used with "run"
4274 command
wdenkf07771c2003-05-28 08:06:31 +00004275
wdenk2729af92004-05-03 20:45:30 +00004276General rules:
4277--------------
wdenkf07771c2003-05-28 08:06:31 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279(1) If a command line (or an environment variable executed by a "run"
4280 command) contains several commands separated by semicolon, and
4281 one of these commands fails, then the remaining commands will be
4282 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004285 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004286 command will cause "run" to terminate, i. e. the remaining
4287 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004288
wdenk2729af92004-05-03 20:45:30 +00004289Note for Redundant Ethernet Interfaces:
4290=======================================
wdenkf07771c2003-05-28 08:06:31 +00004291
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004292Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004293such configurations and is capable of automatic selection of a
4294"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004295
wdenk2729af92004-05-03 20:45:30 +00004296Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4297MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4298"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300If the network interface stores some valid MAC address (for instance
4301in SROM), this is used as default address if there is NO correspon-
4302ding setting in the environment; if the corresponding environment
4303variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004304
wdenk2729af92004-05-03 20:45:30 +00004305o If the SROM has a valid MAC address, and there is no address in the
4306 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004307
wdenk2729af92004-05-03 20:45:30 +00004308o If there is no valid address in the SROM, and a definition in the
4309 environment exists, then the value from the environment variable is
4310 used.
wdenkc6097192002-11-03 00:24:07 +00004311
wdenk2729af92004-05-03 20:45:30 +00004312o If both the SROM and the environment contain a MAC address, and
4313 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315o If both the SROM and the environment contain a MAC address, and the
4316 addresses differ, the value from the environment is used and a
4317 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk2729af92004-05-03 20:45:30 +00004319o If neither SROM nor the environment contain a MAC address, an error
4320 is raised.
wdenkc6097192002-11-03 00:24:07 +00004321
Ben Warrenecee9322010-04-26 11:11:46 -07004322If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004323will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004324may be skipped by setting the appropriate 'ethmacskip' environment variable.
4325The naming convention is as follows:
4326"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk2729af92004-05-03 20:45:30 +00004328Image Formats:
4329==============
wdenkc6097192002-11-03 00:24:07 +00004330
Marian Balakowicz3310c542008-03-12 12:13:13 +01004331U-Boot is capable of booting (and performing other auxiliary operations on)
4332images in two formats:
4333
4334New uImage format (FIT)
4335-----------------------
4336
4337Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4338to Flattened Device Tree). It allows the use of images with multiple
4339components (several kernels, ramdisks, etc.), with contents protected by
4340SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4341
4342
4343Old uImage format
4344-----------------
4345
4346Old image format is based on binary files which can be basically anything,
4347preceded by a special header; see the definitions in include/image.h for
4348details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004349
wdenk2729af92004-05-03 20:45:30 +00004350* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4351 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004352 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4353 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4354 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004355* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004356 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4357 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004358* Compression Type (uncompressed, gzip, bzip2)
4359* Load Address
4360* Entry Point
4361* Image Name
4362* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364The header is marked by a special Magic Number, and both the header
4365and the data portions of the image are secured against corruption by
4366CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004367
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk2729af92004-05-03 20:45:30 +00004369Linux Support:
4370==============
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk2729af92004-05-03 20:45:30 +00004372Although U-Boot should support any OS or standalone application
4373easily, the main focus has always been on Linux during the design of
4374U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk2729af92004-05-03 20:45:30 +00004376U-Boot includes many features that so far have been part of some
4377special "boot loader" code within the Linux kernel. Also, any
4378"initrd" images to be used are no longer part of one big Linux image;
4379instead, kernel and "initrd" are separate images. This implementation
4380serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382- the same features can be used for other OS or standalone
4383 applications (for instance: using compressed images to reduce the
4384 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386- it becomes much easier to port new Linux kernel versions because
4387 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389- the same Linux kernel image can now be used with different "initrd"
4390 images; of course this also means that different kernel images can
4391 be run with the same "initrd". This makes testing easier (you don't
4392 have to build a new "zImage.initrd" Linux image when you just
4393 change a file in your "initrd"). Also, a field-upgrade of the
4394 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004395
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk2729af92004-05-03 20:45:30 +00004397Linux HOWTO:
4398============
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400Porting Linux to U-Boot based systems:
4401---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403U-Boot cannot save you from doing all the necessary modifications to
4404configure the Linux device drivers for use with your target hardware
4405(no, we don't intend to provide a full virtual machine interface to
4406Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004407
Stefan Roesea47a12b2010-04-15 16:07:28 +02004408But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk2729af92004-05-03 20:45:30 +00004410Just make sure your machine specific header file (for instance
4411include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004412Information structure as we define in include/asm-<arch>/u-boot.h,
4413and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004414as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004415
wdenkc6097192002-11-03 00:24:07 +00004416
wdenk2729af92004-05-03 20:45:30 +00004417Configuring the Linux kernel:
4418-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004419
wdenk2729af92004-05-03 20:45:30 +00004420No specific requirements for U-Boot. Make sure you have some root
4421device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004422
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424Building a Linux Image:
4425-----------------------
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk2729af92004-05-03 20:45:30 +00004427With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4428not used. If you use recent kernel source, a new build target
4429"uImage" will exist which automatically builds an image usable by
4430U-Boot. Most older kernels also have support for a "pImage" target,
4431which was introduced for our predecessor project PPCBoot and uses a
4432100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk2729af92004-05-03 20:45:30 +00004434Example:
wdenkc6097192002-11-03 00:24:07 +00004435
wdenk2729af92004-05-03 20:45:30 +00004436 make TQM850L_config
4437 make oldconfig
4438 make dep
4439 make uImage
wdenkc6097192002-11-03 00:24:07 +00004440
wdenk2729af92004-05-03 20:45:30 +00004441The "uImage" build target uses a special tool (in 'tools/mkimage') to
4442encapsulate a compressed Linux kernel image with header information,
4443CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk2729af92004-05-03 20:45:30 +00004445* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449 ${CROSS_COMPILE}-objcopy -O binary \
4450 -R .note -R .comment \
4451 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004452
wdenk2729af92004-05-03 20:45:30 +00004453* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004456
wdenk2729af92004-05-03 20:45:30 +00004457* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459 mkimage -A ppc -O linux -T kernel -C gzip \
4460 -a 0 -e 0 -n "Linux Kernel Image" \
4461 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004462
wdenk24ee89b2002-11-03 17:56:27 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464The "mkimage" tool can also be used to create ramdisk images for use
4465with U-Boot, either separated from the Linux kernel image, or
4466combined into one file. "mkimage" encapsulates the images with a 64
4467byte header containing information about target architecture,
4468operating system, image type, compression method, entry points, time
4469stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004470
wdenk2729af92004-05-03 20:45:30 +00004471"mkimage" can be called in two ways: to verify existing images and
4472print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004473
wdenk2729af92004-05-03 20:45:30 +00004474In the first form (with "-l" option) mkimage lists the information
4475contained in the header of an existing U-Boot image; this includes
4476checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004477
wdenk2729af92004-05-03 20:45:30 +00004478 tools/mkimage -l image
4479 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004480
wdenk2729af92004-05-03 20:45:30 +00004481The second form (with "-d" option) is used to build a U-Boot image
4482from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004483
wdenk2729af92004-05-03 20:45:30 +00004484 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4485 -n name -d data_file image
4486 -A ==> set architecture to 'arch'
4487 -O ==> set operating system to 'os'
4488 -T ==> set image type to 'type'
4489 -C ==> set compression type 'comp'
4490 -a ==> set load address to 'addr' (hex)
4491 -e ==> set entry point to 'ep' (hex)
4492 -n ==> set image name to 'name'
4493 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004494
wdenk69459792004-05-29 16:53:29 +00004495Right now, all Linux kernels for PowerPC systems use the same load
4496address (0x00000000), but the entry point address depends on the
4497kernel version:
wdenkc6097192002-11-03 00:24:07 +00004498
wdenk2729af92004-05-03 20:45:30 +00004499- 2.2.x kernels have the entry point at 0x0000000C,
4500- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk2729af92004-05-03 20:45:30 +00004502So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk2729af92004-05-03 20:45:30 +00004504 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4505 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004506 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004507 > examples/uImage.TQM850L
4508 Image Name: 2.4.4 kernel for TQM850L
4509 Created: Wed Jul 19 02:34:59 2000
4510 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4511 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4512 Load Address: 0x00000000
4513 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004514
wdenk2729af92004-05-03 20:45:30 +00004515To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk2729af92004-05-03 20:45:30 +00004517 -> tools/mkimage -l examples/uImage.TQM850L
4518 Image Name: 2.4.4 kernel for TQM850L
4519 Created: Wed Jul 19 02:34:59 2000
4520 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4521 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4522 Load Address: 0x00000000
4523 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk2729af92004-05-03 20:45:30 +00004525NOTE: for embedded systems where boot time is critical you can trade
4526speed for memory and install an UNCOMPRESSED image instead: this
4527needs more space in Flash, but boots much faster since it does not
4528need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004529
Stefan Roesea47a12b2010-04-15 16:07:28 +02004530 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004531 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4532 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004533 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004534 > examples/uImage.TQM850L-uncompressed
4535 Image Name: 2.4.4 kernel for TQM850L
4536 Created: Wed Jul 19 02:34:59 2000
4537 Image Type: PowerPC Linux Kernel Image (uncompressed)
4538 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4539 Load Address: 0x00000000
4540 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004541
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk2729af92004-05-03 20:45:30 +00004543Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4544when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004545
wdenk2729af92004-05-03 20:45:30 +00004546 -> tools/mkimage -n 'Simple Ramdisk Image' \
4547 > -A ppc -O linux -T ramdisk -C gzip \
4548 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4549 Image Name: Simple Ramdisk Image
4550 Created: Wed Jan 12 14:01:50 2000
4551 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4552 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4553 Load Address: 0x00000000
4554 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004555
wdenkdb01a2e2004-04-15 23:14:49 +00004556
wdenk2729af92004-05-03 20:45:30 +00004557Installing a Linux Image:
4558-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004559
wdenk2729af92004-05-03 20:45:30 +00004560To downloading a U-Boot image over the serial (console) interface,
4561you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004562
wdenk2729af92004-05-03 20:45:30 +00004563 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004564
wdenk2729af92004-05-03 20:45:30 +00004565The 'objcopy' does not understand the information in the U-Boot
4566image header, so the resulting S-Record file will be relative to
4567address 0x00000000. To load it to a given address, you need to
4568specify the target address as 'offset' parameter with the 'loads'
4569command.
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk2729af92004-05-03 20:45:30 +00004571Example: install the image to address 0x40100000 (which on the
4572TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk2729af92004-05-03 20:45:30 +00004576 .......... done
4577 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk2729af92004-05-03 20:45:30 +00004579 => loads 40100000
4580 ## Ready for S-Record download ...
4581 ~>examples/image.srec
4582 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4583 ...
4584 15989 15990 15991 15992
4585 [file transfer complete]
4586 [connected]
4587 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004588
4589
wdenk2729af92004-05-03 20:45:30 +00004590You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004591this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004592corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004593
wdenk2729af92004-05-03 20:45:30 +00004594 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk2729af92004-05-03 20:45:30 +00004596 ## Checking Image at 40100000 ...
4597 Image Name: 2.2.13 for initrd on TQM850L
4598 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4599 Data Size: 335725 Bytes = 327 kB = 0 MB
4600 Load Address: 00000000
4601 Entry Point: 0000000c
4602 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004603
4604
wdenk2729af92004-05-03 20:45:30 +00004605Boot Linux:
4606-----------
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk2729af92004-05-03 20:45:30 +00004608The "bootm" command is used to boot an application that is stored in
4609memory (RAM or Flash). In case of a Linux kernel image, the contents
4610of the "bootargs" environment variable is passed to the kernel as
4611parameters. You can check and modify this variable using the
4612"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004613
4614
wdenk2729af92004-05-03 20:45:30 +00004615 => printenv bootargs
4616 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004617
wdenk2729af92004-05-03 20:45:30 +00004618 => 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 +00004619
wdenk2729af92004-05-03 20:45:30 +00004620 => printenv bootargs
4621 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 +00004622
wdenk2729af92004-05-03 20:45:30 +00004623 => bootm 40020000
4624 ## Booting Linux kernel at 40020000 ...
4625 Image Name: 2.2.13 for NFS on TQM850L
4626 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4627 Data Size: 381681 Bytes = 372 kB = 0 MB
4628 Load Address: 00000000
4629 Entry Point: 0000000c
4630 Verifying Checksum ... OK
4631 Uncompressing Kernel Image ... OK
4632 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
4633 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4634 time_init: decrementer frequency = 187500000/60
4635 Calibrating delay loop... 49.77 BogoMIPS
4636 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4637 ...
wdenkc6097192002-11-03 00:24:07 +00004638
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004639If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004640the memory addresses of both the kernel and the initrd image (PPBCOOT
4641format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk2729af92004-05-03 20:45:30 +00004645 ## Checking Image at 40100000 ...
4646 Image Name: 2.2.13 for initrd on TQM850L
4647 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4648 Data Size: 335725 Bytes = 327 kB = 0 MB
4649 Load Address: 00000000
4650 Entry Point: 0000000c
4651 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004652
wdenk2729af92004-05-03 20:45:30 +00004653 ## Checking Image at 40200000 ...
4654 Image Name: Simple Ramdisk Image
4655 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4656 Data Size: 566530 Bytes = 553 kB = 0 MB
4657 Load Address: 00000000
4658 Entry Point: 00000000
4659 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk2729af92004-05-03 20:45:30 +00004661 => bootm 40100000 40200000
4662 ## Booting Linux kernel at 40100000 ...
4663 Image Name: 2.2.13 for initrd on TQM850L
4664 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4665 Data Size: 335725 Bytes = 327 kB = 0 MB
4666 Load Address: 00000000
4667 Entry Point: 0000000c
4668 Verifying Checksum ... OK
4669 Uncompressing Kernel Image ... OK
4670 ## Loading RAMDisk Image at 40200000 ...
4671 Image Name: Simple Ramdisk Image
4672 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4673 Data Size: 566530 Bytes = 553 kB = 0 MB
4674 Load Address: 00000000
4675 Entry Point: 00000000
4676 Verifying Checksum ... OK
4677 Loading Ramdisk ... OK
4678 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
4679 Boot arguments: root=/dev/ram
4680 time_init: decrementer frequency = 187500000/60
4681 Calibrating delay loop... 49.77 BogoMIPS
4682 ...
4683 RAMDISK: Compressed image found at block 0
4684 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686 bash#
wdenkc6097192002-11-03 00:24:07 +00004687
Matthew McClintock02677682006-06-28 10:41:37 -05004688Boot Linux and pass a flat device tree:
4689-----------
4690
4691First, U-Boot must be compiled with the appropriate defines. See the section
4692titled "Linux Kernel Interface" above for a more in depth explanation. The
4693following is an example of how to start a kernel and pass an updated
4694flat device tree:
4695
4696=> print oftaddr
4697oftaddr=0x300000
4698=> print oft
4699oft=oftrees/mpc8540ads.dtb
4700=> tftp $oftaddr $oft
4701Speed: 1000, full duplex
4702Using TSEC0 device
4703TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4704Filename 'oftrees/mpc8540ads.dtb'.
4705Load address: 0x300000
4706Loading: #
4707done
4708Bytes transferred = 4106 (100a hex)
4709=> tftp $loadaddr $bootfile
4710Speed: 1000, full duplex
4711Using TSEC0 device
4712TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4713Filename 'uImage'.
4714Load address: 0x200000
4715Loading:############
4716done
4717Bytes transferred = 1029407 (fb51f hex)
4718=> print loadaddr
4719loadaddr=200000
4720=> print oftaddr
4721oftaddr=0x300000
4722=> bootm $loadaddr - $oftaddr
4723## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004724 Image Name: Linux-2.6.17-dirty
4725 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4726 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004727 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004728 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004729 Verifying Checksum ... OK
4730 Uncompressing Kernel Image ... OK
4731Booting using flat device tree at 0x300000
4732Using MPC85xx ADS machine description
4733Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4734[snip]
4735
4736
wdenk2729af92004-05-03 20:45:30 +00004737More About U-Boot Image Types:
4738------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004739
wdenk2729af92004-05-03 20:45:30 +00004740U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004741
wdenk2729af92004-05-03 20:45:30 +00004742 "Standalone Programs" are directly runnable in the environment
4743 provided by U-Boot; it is expected that (if they behave
4744 well) you can continue to work in U-Boot after return from
4745 the Standalone Program.
4746 "OS Kernel Images" are usually images of some Embedded OS which
4747 will take over control completely. Usually these programs
4748 will install their own set of exception handlers, device
4749 drivers, set up the MMU, etc. - this means, that you cannot
4750 expect to re-enter U-Boot except by resetting the CPU.
4751 "RAMDisk Images" are more or less just data blocks, and their
4752 parameters (address, size) are passed to an OS kernel that is
4753 being started.
4754 "Multi-File Images" contain several images, typically an OS
4755 (Linux) kernel image and one or more data images like
4756 RAMDisks. This construct is useful for instance when you want
4757 to boot over the network using BOOTP etc., where the boot
4758 server provides just a single image file, but you want to get
4759 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761 "Multi-File Images" start with a list of image sizes, each
4762 image size (in bytes) specified by an "uint32_t" in network
4763 byte order. This list is terminated by an "(uint32_t)0".
4764 Immediately after the terminating 0 follow the images, one by
4765 one, all aligned on "uint32_t" boundaries (size rounded up to
4766 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004767
wdenk2729af92004-05-03 20:45:30 +00004768 "Firmware Images" are binary images containing firmware (like
4769 U-Boot or FPGA images) which usually will be programmed to
4770 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004771
wdenk2729af92004-05-03 20:45:30 +00004772 "Script files" are command sequences that will be executed by
4773 U-Boot's command interpreter; this feature is especially
4774 useful when you configure U-Boot to use a real shell (hush)
4775 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004776
Marek Vasut44f074c2012-03-14 21:52:45 +00004777Booting the Linux zImage:
4778-------------------------
4779
4780On some platforms, it's possible to boot Linux zImage. This is done
4781using the "bootz" command. The syntax of "bootz" command is the same
4782as the syntax of "bootm" command.
4783
Marek Vasut017e1f32012-03-18 11:47:58 +00004784Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4785kernel with raw initrd images. The syntax is slightly different, the
4786address of the initrd must be augmented by it's size, in the following
4787format: "<initrd addres>:<initrd size>".
4788
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790Standalone HOWTO:
4791=================
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk2729af92004-05-03 20:45:30 +00004793One of the features of U-Boot is that you can dynamically load and
4794run "standalone" applications, which can use some resources of
4795U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004796
wdenk2729af92004-05-03 20:45:30 +00004797Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004798
wdenk2729af92004-05-03 20:45:30 +00004799"Hello World" Demo:
4800-------------------
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk2729af92004-05-03 20:45:30 +00004802'examples/hello_world.c' contains a small "Hello World" Demo
4803application; it is automatically compiled when you build U-Boot.
4804It's configured to run at address 0x00040004, so you can play with it
4805like that:
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk2729af92004-05-03 20:45:30 +00004807 => loads
4808 ## Ready for S-Record download ...
4809 ~>examples/hello_world.srec
4810 1 2 3 4 5 6 7 8 9 10 11 ...
4811 [file transfer complete]
4812 [connected]
4813 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk2729af92004-05-03 20:45:30 +00004815 => go 40004 Hello World! This is a test.
4816 ## Starting application at 0x00040004 ...
4817 Hello World
4818 argc = 7
4819 argv[0] = "40004"
4820 argv[1] = "Hello"
4821 argv[2] = "World!"
4822 argv[3] = "This"
4823 argv[4] = "is"
4824 argv[5] = "a"
4825 argv[6] = "test."
4826 argv[7] = "<NULL>"
4827 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk2729af92004-05-03 20:45:30 +00004829 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk2729af92004-05-03 20:45:30 +00004831Another example, which demonstrates how to register a CPM interrupt
4832handler with the U-Boot code, can be found in 'examples/timer.c'.
4833Here, a CPM timer is set up to generate an interrupt every second.
4834The interrupt service routine is trivial, just printing a '.'
4835character, but this is just a demo program. The application can be
4836controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004837
wdenk2729af92004-05-03 20:45:30 +00004838 ? - print current values og the CPM Timer registers
4839 b - enable interrupts and start timer
4840 e - stop timer and disable interrupts
4841 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004842
wdenk2729af92004-05-03 20:45:30 +00004843 => loads
4844 ## Ready for S-Record download ...
4845 ~>examples/timer.srec
4846 1 2 3 4 5 6 7 8 9 10 11 ...
4847 [file transfer complete]
4848 [connected]
4849 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004850
wdenk2729af92004-05-03 20:45:30 +00004851 => go 40004
4852 ## Starting application at 0x00040004 ...
4853 TIMERS=0xfff00980
4854 Using timer 1
4855 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857Hit 'b':
4858 [q, b, e, ?] Set interval 1000000 us
4859 Enabling timer
4860Hit '?':
4861 [q, b, e, ?] ........
4862 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4863Hit '?':
4864 [q, b, e, ?] .
4865 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4866Hit '?':
4867 [q, b, e, ?] .
4868 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4869Hit '?':
4870 [q, b, e, ?] .
4871 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4872Hit 'e':
4873 [q, b, e, ?] ...Stopping timer
4874Hit 'q':
4875 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004876
4877
wdenk2729af92004-05-03 20:45:30 +00004878Minicom warning:
4879================
wdenk85ec0bc2003-03-31 16:34:49 +00004880
wdenk2729af92004-05-03 20:45:30 +00004881Over time, many people have reported problems when trying to use the
4882"minicom" terminal emulation program for serial download. I (wd)
4883consider minicom to be broken, and recommend not to use it. Under
4884Unix, I recommend to use C-Kermit for general purpose use (and
4885especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004886use "cu" for S-Record download ("loads" command). See
4887http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4888for help with kermit.
4889
wdenk85ec0bc2003-03-31 16:34:49 +00004890
wdenk2729af92004-05-03 20:45:30 +00004891Nevertheless, if you absolutely want to use it try adding this
4892configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004893
wdenk2729af92004-05-03 20:45:30 +00004894 Name Program Name U/D FullScr IO-Red. Multi
4895 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4896 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004897
4898
wdenk2729af92004-05-03 20:45:30 +00004899NetBSD Notes:
4900=============
wdenkc6097192002-11-03 00:24:07 +00004901
wdenk2729af92004-05-03 20:45:30 +00004902Starting at version 0.9.2, U-Boot supports NetBSD both as host
4903(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004904
wdenk2729af92004-05-03 20:45:30 +00004905Building requires a cross environment; it is known to work on
4906NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4907need gmake since the Makefiles are not compatible with BSD make).
4908Note that the cross-powerpc package does not install include files;
4909attempting to build U-Boot will fail because <machine/ansi.h> is
4910missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004911
wdenk2729af92004-05-03 20:45:30 +00004912 # cd /usr/pkg/cross/powerpc-netbsd/include
4913 # mkdir powerpc
4914 # ln -s powerpc machine
4915 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4916 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004917
wdenk2729af92004-05-03 20:45:30 +00004918Native builds *don't* work due to incompatibilities between native
4919and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk2729af92004-05-03 20:45:30 +00004921Booting assumes that (the first part of) the image booted is a
4922stage-2 loader which in turn loads and then invokes the kernel
4923proper. Loader sources will eventually appear in the NetBSD source
4924tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004925meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004926
4927
wdenk2729af92004-05-03 20:45:30 +00004928Implementation Internals:
4929=========================
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931The following is not intended to be a complete description of every
4932implementation detail. However, it should help to understand the
4933inner workings of U-Boot and make it easier to port it to custom
4934hardware.
wdenkc6097192002-11-03 00:24:07 +00004935
4936
wdenk2729af92004-05-03 20:45:30 +00004937Initial Stack, Global Data:
4938---------------------------
wdenkc6097192002-11-03 00:24:07 +00004939
wdenk2729af92004-05-03 20:45:30 +00004940The implementation of U-Boot is complicated by the fact that U-Boot
4941starts running out of ROM (flash memory), usually without access to
4942system RAM (because the memory controller is not initialized yet).
4943This means that we don't have writable Data or BSS segments, and BSS
4944is not initialized as zero. To be able to get a C environment working
4945at all, we have to allocate at least a minimal stack. Implementation
4946options for this are defined and restricted by the CPU used: Some CPU
4947models provide on-chip memory (like the IMMR area on MPC8xx and
4948MPC826x processors), on others (parts of) the data cache can be
4949locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004950
Wolfgang Denk218ca722008-03-26 10:40:12 +01004951 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004952 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004953
wdenk2729af92004-05-03 20:45:30 +00004954 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4955 From: "Chris Hallinan" <clh@net1plus.com>
4956 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4957 ...
wdenk43d96162003-03-06 00:02:04 +00004958
wdenk2729af92004-05-03 20:45:30 +00004959 Correct me if I'm wrong, folks, but the way I understand it
4960 is this: Using DCACHE as initial RAM for Stack, etc, does not
4961 require any physical RAM backing up the cache. The cleverness
4962 is that the cache is being used as a temporary supply of
4963 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004964 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004965 can see how this works by studying the cache architecture and
4966 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004967
wdenk2729af92004-05-03 20:45:30 +00004968 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4969 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004970 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004971 option should work for you. Using CS 4 should be fine if your
4972 board designers haven't used it for something that would
4973 cause you grief during the initial boot! It is frequently not
4974 used.
wdenk43d96162003-03-06 00:02:04 +00004975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004976 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004977 with your processor/board/system design. The default value
4978 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004979 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004980 than your SDRAM module. If you have a 64MB SDRAM module, set
4981 it above 400_0000. Just make sure your board has no resources
4982 that are supposed to respond to that address! That code in
4983 start.S has been around a while and should work as is when
4984 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004985
wdenk2729af92004-05-03 20:45:30 +00004986 -Chris Hallinan
4987 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004988
wdenk2729af92004-05-03 20:45:30 +00004989It is essential to remember this, since it has some impact on the C
4990code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992* Initialized global data (data segment) is read-only. Do not attempt
4993 to write it.
wdenkc6097192002-11-03 00:24:07 +00004994
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004995* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004996 as zero data - BSS segment) at all - this is undefined, initiali-
4997 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk2729af92004-05-03 20:45:30 +00004999* Stack space is very limited. Avoid big data buffers or things like
5000 that.
wdenkc6097192002-11-03 00:24:07 +00005001
wdenk2729af92004-05-03 20:45:30 +00005002Having only the stack as writable memory limits means we cannot use
5003normal global data to share information beween the code. But it
5004turned out that the implementation of U-Boot can be greatly
5005simplified by making a global data structure (gd_t) available to all
5006functions. We could pass a pointer to this data as argument to _all_
5007functions, but this would bloat the code. Instead we use a feature of
5008the GCC compiler (Global Register Variables) to share the data: we
5009place a pointer (gd) to the global data into a register which we
5010reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005011
wdenk2729af92004-05-03 20:45:30 +00005012When choosing a register for such a purpose we are restricted by the
5013relevant (E)ABI specifications for the current architecture, and by
5014GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk2729af92004-05-03 20:45:30 +00005016For PowerPC, the following registers have specific use:
5017 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005018 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005019 R3-R4: parameter passing and return values
5020 R5-R10: parameter passing
5021 R13: small data area pointer
5022 R30: GOT pointer
5023 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005024
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005025 (U-Boot also uses R12 as internal GOT pointer. r12
5026 is a volatile register so r12 needs to be reset when
5027 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005028
Wolfgang Denke7670f62008-02-14 22:43:22 +01005029 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005030
wdenk2729af92004-05-03 20:45:30 +00005031 Note: on PPC, we could use a static initializer (since the
5032 address of the global data structure is known at compile time),
5033 but it turned out that reserving a register results in somewhat
5034 smaller code - although the code savings are not that big (on
5035 average for all boards 752 bytes for the whole U-Boot image,
5036 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005037
Robin Getzc4db3352009-08-17 15:23:02 +00005038On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005039 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5040
Robin Getzc4db3352009-08-17 15:23:02 +00005041 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005042
wdenk2729af92004-05-03 20:45:30 +00005043On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005044
wdenk2729af92004-05-03 20:45:30 +00005045 R0: function argument word/integer result
5046 R1-R3: function argument word
5047 R9: GOT pointer
5048 R10: stack limit (used only if stack checking if enabled)
5049 R11: argument (frame) pointer
5050 R12: temporary workspace
5051 R13: stack pointer
5052 R14: link register
5053 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005056
Thomas Chou0df01fd2010-05-21 11:08:03 +08005057On Nios II, the ABI is documented here:
5058 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5059
5060 ==> U-Boot will use gp to hold a pointer to the global data
5061
5062 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5063 to access small data sections, so gp is free.
5064
Macpaul Linafc1ce82011-10-19 20:41:11 +00005065On NDS32, the following registers are used:
5066
5067 R0-R1: argument/return
5068 R2-R5: argument
5069 R15: temporary register for assembler
5070 R16: trampoline register
5071 R28: frame pointer (FP)
5072 R29: global pointer (GP)
5073 R30: link register (LP)
5074 R31: stack pointer (SP)
5075 PC: program counter (PC)
5076
5077 ==> U-Boot will use R10 to hold a pointer to the global data
5078
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005079NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5080or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005081
wdenk2729af92004-05-03 20:45:30 +00005082Memory Management:
5083------------------
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085U-Boot runs in system state and uses physical addresses, i.e. the
5086MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk2729af92004-05-03 20:45:30 +00005088The available memory is mapped to fixed addresses using the memory
5089controller. In this process, a contiguous block is formed for each
5090memory type (Flash, SDRAM, SRAM), even when it consists of several
5091physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk2729af92004-05-03 20:45:30 +00005093U-Boot is installed in the first 128 kB of the first Flash bank (on
5094TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5095booting and sizing and initializing DRAM, the code relocates itself
5096to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005097memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005098configuration setting]. Below that, a structure with global Board
5099Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005100
wdenk2729af92004-05-03 20:45:30 +00005101Additionally, some exception handler code is copied to the low 8 kB
5102of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk2729af92004-05-03 20:45:30 +00005104So a typical memory configuration with 16 MB of DRAM could look like
5105this:
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk2729af92004-05-03 20:45:30 +00005107 0x0000 0000 Exception Vector code
5108 :
5109 0x0000 1FFF
5110 0x0000 2000 Free for Application Use
5111 :
5112 :
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk2729af92004-05-03 20:45:30 +00005114 :
5115 :
5116 0x00FB FF20 Monitor Stack (Growing downward)
5117 0x00FB FFAC Board Info Data and permanent copy of global data
5118 0x00FC 0000 Malloc Arena
5119 :
5120 0x00FD FFFF
5121 0x00FE 0000 RAM Copy of Monitor Code
5122 ... eventually: LCD or video framebuffer
5123 ... eventually: pRAM (Protected RAM - unchanged by reset)
5124 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005125
5126
wdenk2729af92004-05-03 20:45:30 +00005127System Initialization:
5128----------------------
wdenkc6097192002-11-03 00:24:07 +00005129
wdenk2729af92004-05-03 20:45:30 +00005130In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005131(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005132configuration for CS0# this is a mirror of the onboard Flash memory.
5133To be able to re-map memory U-Boot then jumps to its link address.
5134To be able to implement the initialization code in C, a (small!)
5135initial stack is set up in the internal Dual Ported RAM (in case CPUs
5136which provide such a feature like MPC8xx or MPC8260), or in a locked
5137part of the data cache. After that, U-Boot initializes the CPU core,
5138the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk2729af92004-05-03 20:45:30 +00005140Next, all (potentially) available memory banks are mapped using a
5141preliminary mapping. For example, we put them on 512 MB boundaries
5142(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5143on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5144programmed for SDRAM access. Using the temporary configuration, a
5145simple memory test is run that determines the size of the SDRAM
5146banks.
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148When there is more than one SDRAM bank, and the banks are of
5149different size, the largest is mapped first. For equal size, the first
5150bank (CS2#) is mapped first. The first mapping is always for address
51510x00000000, with any additional banks following immediately to create
5152contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk2729af92004-05-03 20:45:30 +00005154Then, the monitor installs itself at the upper end of the SDRAM area
5155and allocates memory for use by malloc() and for the global Board
5156Info data; also, the exception vector code is copied to the low RAM
5157pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159Only after this relocation will you have a "normal" C environment;
5160until that you are restricted in several ways, mostly because you are
5161running from ROM, and because the code will have to be relocated to a
5162new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005163
5164
wdenk2729af92004-05-03 20:45:30 +00005165U-Boot Porting Guide:
5166----------------------
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk2729af92004-05-03 20:45:30 +00005168[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5169list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005170
5171
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005172int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005173{
5174 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005175
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005176 signal(SIGALRM, no_more_time);
5177 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk2729af92004-05-03 20:45:30 +00005179 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005180 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005181 return 0;
5182 }
5183
wdenk2729af92004-05-03 20:45:30 +00005184 Download latest U-Boot source;
5185
Wolfgang Denk06682362008-12-30 22:56:11 +01005186 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005187
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005188 if (clueless)
5189 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk2729af92004-05-03 20:45:30 +00005191 while (learning) {
5192 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005193 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5194 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005195 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005196 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005197 }
wdenkc6097192002-11-03 00:24:07 +00005198
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005199 if (available_money > toLocalCurrency ($2500))
5200 Buy a BDI3000;
5201 else
wdenk2729af92004-05-03 20:45:30 +00005202 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005203
5204 if (a similar board exists) { /* hopefully... */
5205 cp -a board/<similar> board/<myboard>
5206 cp include/configs/<similar>.h include/configs/<myboard>.h
5207 } else {
5208 Create your own board support subdirectory;
5209 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005210 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005211 Edit new board/<myboard> files
5212 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005213
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005214 while (!accepted) {
5215 while (!running) {
5216 do {
5217 Add / modify source code;
5218 } until (compiles);
5219 Debug;
5220 if (clueless)
5221 email("Hi, I am having problems...");
5222 }
5223 Send patch file to the U-Boot email list;
5224 if (reasonable critiques)
5225 Incorporate improvements from email list code review;
5226 else
5227 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005228 }
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230 return 0;
5231}
5232
5233void no_more_time (int sig)
5234{
5235 hire_a_guru();
5236}
wdenkc6097192002-11-03 00:24:07 +00005237
5238
wdenk2729af92004-05-03 20:45:30 +00005239Coding Standards:
5240-----------------
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk2729af92004-05-03 20:45:30 +00005242All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005243coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005244"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005245
Detlev Zundel2c051652006-09-01 15:39:02 +02005246Source files originating from a different project (for example the
5247MTD subsystem) are generally exempt from these guidelines and are not
5248reformated to ease subsequent migration to newer versions of those
5249sources.
5250
5251Please note that U-Boot is implemented in C (and to some small parts in
5252Assembler); no C++ is used, so please do not use C++ style comments (//)
5253in your code.
wdenk2729af92004-05-03 20:45:30 +00005254
5255Please also stick to the following formatting rules:
5256- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005257- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005258- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005259- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005260- do not add trailing empty lines to source files
5261
5262Submissions which do not conform to the standards may be returned
5263with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005264
5265
wdenk2729af92004-05-03 20:45:30 +00005266Submitting Patches:
5267-------------------
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269Since the number of patches for U-Boot is growing, we need to
5270establish some rules. Submissions which do not conform to these rules
5271may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005272
Magnus Lilja0d28f342008-08-06 19:32:33 +02005273Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005274
Wolfgang Denk06682362008-12-30 22:56:11 +01005275Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5276see http://lists.denx.de/mailman/listinfo/u-boot
5277
wdenk2729af92004-05-03 20:45:30 +00005278When you send a patch, please include the following information with
5279it:
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk2729af92004-05-03 20:45:30 +00005281* For bug fixes: a description of the bug and how your patch fixes
5282 this bug. Please try to include a way of demonstrating that the
5283 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk2729af92004-05-03 20:45:30 +00005285* For new features: a description of the feature and your
5286 implementation.
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk2729af92004-05-03 20:45:30 +00005288* A CHANGELOG entry as plaintext (separate from the patch)
5289
5290* For major contributions, your entry to the CREDITS file
5291
5292* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005293 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005294
5295* If your patch adds new configuration options, don't forget to
5296 document these in the README file.
5297
Wolfgang Denk218ca722008-03-26 10:40:12 +01005298* The patch itself. If you are using git (which is *strongly*
5299 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005300 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005301 the U-Boot mailing list, you will avoid most of the common problems
5302 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005303
Wolfgang Denk218ca722008-03-26 10:40:12 +01005304 If you cannot use git, use "diff -purN OLD NEW". If your version of
5305 diff does not support these options, then get the latest version of
5306 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005307
Wolfgang Denk218ca722008-03-26 10:40:12 +01005308 The current directory when running this command shall be the parent
5309 directory of the U-Boot source tree (i. e. please make sure that
5310 your patch includes sufficient directory information for the
5311 affected files).
5312
5313 We prefer patches as plain text. MIME attachments are discouraged,
5314 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005315
5316* If one logical set of modifications affects or creates several
5317 files, all these changes shall be submitted in a SINGLE patch file.
5318
5319* Changesets that contain different, unrelated modifications shall be
5320 submitted as SEPARATE patches, one patch per changeset.
5321
5322
5323Notes:
5324
5325* Before sending the patch, run the MAKEALL script on your patched
5326 source tree and make sure that no errors or warnings are reported
5327 for any of the boards.
5328
5329* Keep your modifications to the necessary minimum: A patch
5330 containing several unrelated changes or arbitrary reformats will be
5331 returned with a request to re-formatting / split it.
5332
5333* If you modify existing code, make sure that your new code does not
5334 add to the memory footprint of the code ;-) Small is beautiful!
5335 When adding new features, these should compile conditionally only
5336 (using #ifdef), and the resulting code with the new feature
5337 disabled must not need more memory than the old code without your
5338 modification.
wdenk90dc6702005-05-03 14:12:25 +00005339
Wolfgang Denk06682362008-12-30 22:56:11 +01005340* Remember that there is a size limit of 100 kB per message on the
5341 u-boot mailing list. Bigger patches will be moderated. If they are
5342 reasonable and not too big, they will be acknowledged. But patches
5343 bigger than the size limit should be avoided.