blob: 5105e64a388d257c625d0480879203889af7f712 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk8c831282012-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
wdenkce4832c2004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denkb240aef2008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Day974ed2f2012-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 Tyser8804a612008-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 Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschin08337f32008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000126
wdenk24ee89b2002-11-03 17:56:27 +0000127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
129
wdenkc6097192002-11-03 00:24:07 +0000130
wdenk7474aca2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000140
Thomas Webere89e6282010-09-28 08:06:25 +0200141Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-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
wdenk7474aca2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tysere4d1abc2010-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ßmannd9a9d562011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-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 Russcbfce1d2011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-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 Schwierzeckd52a6232011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Lin1cac36e2011-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 Tysere4d1abc2010-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 Roese88fbf932010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-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-VILLARD03836942008-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 Ziswilerabd8dcb2008-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500297- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000298
Kim Phillips203fee32007-08-10 13:28:25 -0500299- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200300
301- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200322 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000323 a "rotator" |\-/|\-/
324
wdenk2bb11052003-07-17 23:16:40 +0000325- Board flavour: (if CONFIG_MPC8260ADS is defined)
326 CONFIG_ADSTYPE
327 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-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
wdenk2bb11052003-07-17 23:16:40 +0000332
Lei Wen20014762011-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)
wdenk9b7f3842003-10-09 20:09:04 +0000339 Define exactly one of
340 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000341
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200342- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000343 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
344 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000345 e.g. if there is no 32KHz
346 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000350- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200351 CONFIG_SYS_8xx_CPUCLK_MIN
352 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000353 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000354 See doc/README.MPC866
355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200356 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000357
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200363 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000364
Heiko Schocher734f0272009-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 Galaf4fb90f2011-02-18 05:40:54 -0600370- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Kushwahaa6a30622012-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 Wood80806962012-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 Schwierzeckd8a49ca2012-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 Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100428- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200429 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-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-VILLARD03836942008-10-16 15:01:15 +0200435 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200436
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100437 Defines the Monahans turbo mode to oscillator
438 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200439 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100440 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200441
Daniel Schwierzeckd52a6232011-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 Riesch48c2d6d2012-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 Vb8e40802012-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
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000502 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
503
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200504 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400508 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200509
510 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500517 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400518
Marcel Ziswilerb29bc712009-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 Denk27a5b0b2005-10-13 01:45:54 +0200523 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600524 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200525
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200526 boards with QUICC Engines require OF_QE to set UCC MAC
527 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500528
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000533
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500534 CONFIG_OF_BOOT_CPU
535
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200536 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500537 param header, the default value is zero if undefined.
538
Heiko Schocherffb293a2009-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 Grinberg06890672011-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 Giger0ab978d2008-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 V960f5c02011-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 V686a0752011-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
wdenkda04a8b2004-08-02 23:22:59 +0000587- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200588 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000589
590 Define this if you want support for Amba PrimeCell PL010 UARTs.
591
Andreas Engel0813b122008-09-08 14:30:53 +0200592 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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 Rigby34e21ee2011-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
wdenkda04a8b2004-08-02 23:22:59 +0000619
wdenkc6097192002-11-03 00:24:07 +0000620- Console Interface:
wdenk4a5c8a72003-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 Denkf6e50a42011-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)
wdenk544e9732004-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)
wdenk544e9732004-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-VILLARD03836942008-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 Loeligerc1da5c92007-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
wdenk9dd2b882002-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200666 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000667 the logo
668
Pali Rohár4a57da32012-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
wdenk4a5c8a72003-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
wdenk1ebf41e2004-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.
wdenk3da587e2003-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-VILLARD03836942008-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 Schocher327480a2009-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 Schocher362447f2009-02-10 09:31:47 +0100691 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-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 Russ3c28f482011-09-01 00:48:27 +0000696- Pre-Console Buffer:
Wolfgang Denkd590fb12011-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 Denk23f78482011-10-09 21:06:34 +0200704 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200705 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000706
Wolfgang Denkd590fb12011-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 Russ3c28f482011-09-01 00:48:27 +0000709
Sonny Raocd55bde2011-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 Hershberger96ccaf32012-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
wdenk4a5c8a72003-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
wdenk4a5c8a72003-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 Ziswilerabd8dcb2008-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 Loeligerc1da5c92007-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-VILLARD03836942008-10-16 15:01:15 +0200784 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000785
786- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500787 Monitor commands can be included or excluded
788 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000789 <config_cmd_all.h> and #undef'ing unwanted
790 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500791 and augmenting with additional #define's
792 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000793
Jon Loeligerc1da5c92007-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 Loeligerc1da5c92007-06-11 19:03:39 -0500797 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-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 Frysinger321ab9e2010-12-21 14:19:51 -0500805 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-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 Tyser15258042008-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 Loeligerc1da5c92007-06-11 19:03:39 -0500813 CONFIG_CMD_DTT * Digital Therm and Thermostat
814 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500815 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500816 CONFIG_CMD_EEPROM * EEPROM read/write support
817 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600818 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600819 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500820 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000821 CONFIG_CMD_EXT2 * ext2 command support
822 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500823 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500824 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000825 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 CONFIG_CMD_FDOS * Dos diskette Support
827 CONFIG_CMD_FLASH flinfo, erase, protect
828 CONFIG_CMD_FPGA FPGA device initialization support
Anton Staafd1390c82012-12-05 14:46:29 +0000829 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500830 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000831 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000832 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
834 CONFIG_CMD_I2C * I2C serial bus support
835 CONFIG_CMD_IDE * IDE harddisk support
836 CONFIG_CMD_IMI iminfo
837 CONFIG_CMD_IMLS List all found images
838 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500839 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000840 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_IRQ * irqinfo
842 CONFIG_CMD_ITEST Integer/string test of 2 values
843 CONFIG_CMD_JFFS2 * JFFS2 Support
844 CONFIG_CMD_KGDB * kgdb
Mike Frysingerfc6508a2010-12-26 12:34:49 -0500845 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000846 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
847 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500848 CONFIG_CMD_LOADB loadb
849 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400850 CONFIG_CMD_MD5SUM print md5 message digest
851 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
853 loop, loopw, mtest
854 CONFIG_CMD_MISC Misc functions like sleep etc
855 CONFIG_CMD_MMC * MMC memory mapped support
856 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100857 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500858 CONFIG_CMD_NAND * NAND support
859 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600860 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000861 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_PCI * pciinfo
863 CONFIG_CMD_PCMCIA * PCMCIA support
864 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
865 host
866 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000867 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500868 CONFIG_CMD_REGINFO * Register dump
869 CONFIG_CMD_RUN run command in env variable
870 CONFIG_CMD_SAVES * save S record dump
871 CONFIG_CMD_SCSI * SCSI Support
872 CONFIG_CMD_SDRAM * print SDRAM configuration information
873 (requires CONFIG_CMD_I2C)
874 CONFIG_CMD_SETGETDCR Support for DCR Register access
875 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700876 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Holler37ef5392011-01-18 09:48:08 +0100877 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400878 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200879 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500880 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000881 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000882 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000883 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
884 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500886 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000887 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000888
wdenkc6097192002-11-03 00:24:07 +0000889
890 EXAMPLE: If you want all functions except of network
891 support you can write:
892
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500893 #include "config_cmd_all.h"
894 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000895
Gerald Van Barend6abef42007-03-31 12:23:51 -0400896 Other Commands:
897 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000898
899 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500900 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000901 what you (and your U-Boot users) are doing. Data
902 cache cannot be enabled on systems like the 8xx or
903 8260 (where accesses to the IMMR region must be
904 uncached), and it cannot be disabled on all other
905 systems where we (mis-) use the data cache to hold an
906 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000907
908
909 XXX - this list needs to get updated!
910
Simon Glass3d686442011-10-15 05:48:20 +0000911- Device tree:
912 CONFIG_OF_CONTROL
913 If this variable is defined, U-Boot will use a device tree
914 to configure its devices, instead of relying on statically
915 compiled #defines in the board file. This option is
916 experimental and only available on a few boards. The device
917 tree is available in the global data as gd->fdt_blob.
918
Simon Glass5cb34db2011-10-24 19:15:31 +0000919 U-Boot needs to get its device tree from somewhere. This can
920 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000921
922 CONFIG_OF_EMBED
923 If this variable is defined, U-Boot will embed a device tree
924 binary in its image. This device tree file should be in the
925 board directory and called <soc>-<board>.dts. The binary file
926 is then picked up in board_init_f() and made available through
927 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000928
Simon Glass5cb34db2011-10-24 19:15:31 +0000929 CONFIG_OF_SEPARATE
930 If this variable is defined, U-Boot will build a device tree
931 binary. It will be called u-boot.dtb. Architecture-specific
932 code will locate it at run-time. Generally this works by:
933
934 cat u-boot.bin u-boot.dtb >image.bin
935
936 and in fact, U-Boot does this for you, creating a file called
937 u-boot-dtb.bin which is useful in the common case. You can
938 still use the individual files if you need something more
939 exotic.
940
wdenkc6097192002-11-03 00:24:07 +0000941- Watchdog:
942 CONFIG_WATCHDOG
943 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000944 support for the SoC. There must be support in the SoC
945 specific code for a watchdog. For the 8xx and 8260
946 CPUs, the SIU Watchdog feature is enabled in the SYPCR
947 register. When supported for a specific SoC is
948 available, then no further board specific code should
949 be needed to use it.
950
951 CONFIG_HW_WATCHDOG
952 When using a watchdog circuitry external to the used
953 SoC, then define this variable and provide board
954 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000955
stroeseb9c17c52003-04-04 15:53:41 +0000956- U-Boot Version:
957 CONFIG_VERSION_VARIABLE
958 If this variable is defined, an environment variable
959 named "ver" is created by U-Boot showing the U-Boot
960 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200961 Any change to this variable will be reverted at the
962 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000963
wdenkc6097192002-11-03 00:24:07 +0000964- Real-Time Clock:
965
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500966 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000967 has to be selected, too. Define exactly one of the
968 following options:
969
970 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
971 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000972 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000973 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000974 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000975 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000976 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000977 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100978 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000979 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200980 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200981 CONFIG_SYS_RV3029_TCR - enable trickle charger on
982 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000983
wdenkb9bbd242003-06-30 16:24:52 +0000984 Note that if the RTC uses I2C, then the I2C interface
985 must also be configured. See I2C Support, below.
986
Peter Tyser9902e422008-12-17 16:36:21 -0600987- GPIO Support:
988 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
989 CONFIG_PCA953X_INFO - enable pca953x info command
990
Chris Packham9b383202010-12-19 10:12:13 +0000991 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
992 chip-ngpio pairs that tell the PCA953X driver the number of
993 pins supported by a particular chip.
994
Peter Tyser9902e422008-12-17 16:36:21 -0600995 Note that if the GPIO device uses I2C, then the I2C interface
996 must also be configured. See I2C Support, below.
997
wdenkc6097192002-11-03 00:24:07 +0000998- Timestamp Support:
999
wdenk4a5c8a72003-03-06 00:02:04 +00001000 When CONFIG_TIMESTAMP is selected, the timestamp
1001 (date and time) of an image is printed by image
1002 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001003 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001004
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001005- Partition Labels (disklabels) Supported:
1006 Zero or more of the following:
1007 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1008 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1009 Intel architecture, USB sticks, etc.
1010 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1011 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1012 bootloader. Note 2TB partition limit; see
1013 disk/part_efi.c
1014 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001015
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001016 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1017 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001018 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001019
1020- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001021 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1022 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001023
wdenk369d43d2004-03-14 14:09:05 +00001024 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1025 be performed by calling the function
1026 ide_set_reset(int reset)
1027 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001028
1029- ATAPI Support:
1030 CONFIG_ATAPI
1031
1032 Set this to enable ATAPI support.
1033
wdenkf602aa02004-03-13 23:29:43 +00001034- LBA48 Support
1035 CONFIG_LBA48
1036
1037 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001038 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001039 Whithout these , LBA48 support uses 32bit variables and will 'only'
1040 support disks up to 2.1TB.
1041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001042 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001043 When enabled, makes the IDE subsystem use 64bit sector addresses.
1044 Default is 32bit.
1045
wdenkc6097192002-11-03 00:24:07 +00001046- SCSI Support:
1047 At the moment only there is only support for the
1048 SYM53C8XX SCSI controller; define
1049 CONFIG_SCSI_SYM53C8XX to enable it.
1050
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001051 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1052 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1053 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001054 maximum numbers of LUNs, SCSI ID's and target
1055 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001056 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001057
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001058 The environment variable 'scsidevs' is set to the number of
1059 SCSI devices found during the last scan.
1060
wdenkc6097192002-11-03 00:24:07 +00001061- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001062 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001063 Support for Intel 8254x/8257x gigabit chips.
1064
1065 CONFIG_E1000_SPI
1066 Utility code for direct access to the SPI bus on Intel 8257x.
1067 This does not do anything useful unless you set at least one
1068 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1069
1070 CONFIG_E1000_SPI_GENERIC
1071 Allow generic access to the SPI bus on the Intel 8257x, for
1072 example with the "sspi" command.
1073
1074 CONFIG_CMD_E1000
1075 Management command for E1000 devices. When used on devices
1076 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001077
Andre Schwarz68c2a302008-03-06 16:45:44 +01001078 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001079 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001080
wdenkc6097192002-11-03 00:24:07 +00001081 CONFIG_EEPRO100
1082 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001083 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001084 write routine for first time initialisation.
1085
1086 CONFIG_TULIP
1087 Support for Digital 2114x chips.
1088 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1089 modem chip initialisation (KS8761/QS6611).
1090
1091 CONFIG_NATSEMI
1092 Support for National dp83815 chips.
1093
1094 CONFIG_NS8382X
1095 Support for National dp8382[01] gigabit chips.
1096
wdenkaa603362003-05-12 21:50:16 +00001097- NETWORK Support (other):
1098
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001099 CONFIG_DRIVER_AT91EMAC
1100 Support for AT91RM9200 EMAC.
1101
1102 CONFIG_RMII
1103 Define this to use reduced MII inteface
1104
1105 CONFIG_DRIVER_AT91EMAC_QUIET
1106 If this defined, the driver is quiet.
1107 The driver doen't show link status messages.
1108
Rob Herringc9830dc2011-12-15 11:15:49 +00001109 CONFIG_CALXEDA_XGMAC
1110 Support for the Calxeda XGMAC device
1111
Ashok93fb8722012-10-15 06:20:47 +00001112 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001113 Support for SMSC's LAN91C96 chips.
1114
1115 CONFIG_LAN91C96_BASE
1116 Define this to hold the physical address
1117 of the LAN91C96's I/O space
1118
1119 CONFIG_LAN91C96_USE_32_BIT
1120 Define this to enable 32 bit addressing
1121
Ashok93fb8722012-10-15 06:20:47 +00001122 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001123 Support for SMSC's LAN91C111 chip
1124
1125 CONFIG_SMC91111_BASE
1126 Define this to hold the physical address
1127 of the device (I/O space)
1128
1129 CONFIG_SMC_USE_32_BIT
1130 Define this if data bus is 32 bits
1131
1132 CONFIG_SMC_USE_IOFUNCS
1133 Define this to use i/o functions instead of macros
1134 (some hardware wont work with macros)
1135
Heiko Schocher7d037f72011-11-15 10:00:04 -05001136 CONFIG_DRIVER_TI_EMAC
1137 Support for davinci emac
1138
1139 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1140 Define this if you have more then 3 PHYs.
1141
Macpaul Lin199c6252010-12-21 16:59:46 +08001142 CONFIG_FTGMAC100
1143 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1144
1145 CONFIG_FTGMAC100_EGIGA
1146 Define this to use GE link update with gigabit PHY.
1147 Define this if FTGMAC100 is connected to gigabit PHY.
1148 If your system has 10/100 PHY only, it might not occur
1149 wrong behavior. Because PHY usually return timeout or
1150 useless data when polling gigabit status and gigabit
1151 control registers. This behavior won't affect the
1152 correctnessof 10/100 link speed update.
1153
Mike Rapoportf4761af2009-11-11 10:03:03 +02001154 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001155 Support for SMSC's LAN911x and LAN921x chips
1156
Mike Rapoportf4761af2009-11-11 10:03:03 +02001157 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001158 Define this to hold the physical address
1159 of the device (I/O space)
1160
Mike Rapoportf4761af2009-11-11 10:03:03 +02001161 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001162 Define this if data bus is 32 bits
1163
Mike Rapoportf4761af2009-11-11 10:03:03 +02001164 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001165 Define this if data bus is 16 bits. If your processor
1166 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001167 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001168
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001169 CONFIG_SH_ETHER
1170 Support for Renesas on-chip Ethernet controller
1171
1172 CONFIG_SH_ETHER_USE_PORT
1173 Define the number of ports to be used
1174
1175 CONFIG_SH_ETHER_PHY_ADDR
1176 Define the ETH PHY's address
1177
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001178 CONFIG_SH_ETHER_CACHE_WRITEBACK
1179 If this option is set, the driver enables cache flush.
1180
Vadim Bendeburydac69642011-10-17 08:36:14 +00001181- TPM Support:
1182 CONFIG_GENERIC_LPC_TPM
1183 Support for generic parallel port TPM devices. Only one device
1184 per system is supported at this time.
1185
1186 CONFIG_TPM_TIS_BASE_ADDRESS
1187 Base address where the generic TPM device is mapped
1188 to. Contemporary x86 systems usually map it at
1189 0xfed40000.
1190
wdenkc6097192002-11-03 00:24:07 +00001191- USB Support:
1192 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001193 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001194 CONFIG_USB_UHCI to enable it.
1195 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001196 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001197 storage devices.
1198 Note:
1199 Supported are USB Keyboards and USB Floppy drives
1200 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001201 MPC5200 USB requires additional defines:
1202 CONFIG_USB_CLOCK
1203 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001204 CONFIG_PSC3_USB
1205 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001206 CONFIG_USB_CONFIG
1207 for differential drivers: 0x00001000
1208 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001209 for differential drivers on PSC3: 0x00000100
1210 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001211 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001212 May be defined to allow interrupt polling
1213 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001214
Simon Glass5978cdb2012-02-27 10:52:47 +00001215 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1216 txfilltuning field in the EHCI controller on reset.
1217
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001218- USB Device:
1219 Define the below if you wish to use the USB console.
1220 Once firmware is rebuilt from a serial console issue the
1221 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001222 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001223 it has found a new device. The environment variable usbtty
1224 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001225 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001226 Common Device Class Abstract Control Model serial device.
1227 If you select usbtty = gserial you should be able to enumerate
1228 a Linux host by
1229 # modprobe usbserial vendor=0xVendorID product=0xProductID
1230 else if using cdc_acm, simply setting the environment
1231 variable usbtty to be cdc_acm should suffice. The following
1232 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001233
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001234 CONFIG_USB_DEVICE
1235 Define this to build a UDC device
1236
1237 CONFIG_USB_TTY
1238 Define this to have a tty type of device available to
1239 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001240
Vipin KUMARbdb17702012-03-26 15:38:06 +05301241 CONFIG_USBD_HS
1242 Define this to enable the high speed support for usb
1243 device and usbtty. If this feature is enabled, a routine
1244 int is_usbd_high_speed(void)
1245 also needs to be defined by the driver to dynamically poll
1246 whether the enumeration has succeded at high speed or full
1247 speed.
1248
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001249 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001250 Define this if you want stdin, stdout &/or stderr to
1251 be set to usbtty.
1252
1253 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001254 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001255 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001256 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001258 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001259 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001260 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001261
Wolfgang Denke2601822006-06-14 18:14:56 +02001262 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001263 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001264 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001265 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1266 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1267 should pretend to be a Linux device to it's target host.
1268
1269 CONFIG_USBD_MANUFACTURER
1270 Define this string as the name of your company for
1271 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001272
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001273 CONFIG_USBD_PRODUCT_NAME
1274 Define this string as the name of your product
1275 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001276
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001277 CONFIG_USBD_VENDORID
1278 Define this as your assigned Vendor ID from the USB
1279 Implementors Forum. This *must* be a genuine Vendor ID
1280 to avoid polluting the USB namespace.
1281 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001282
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001283 CONFIG_USBD_PRODUCTID
1284 Define this as the unique Product ID
1285 for your device
1286 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001287
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001288- ULPI Layer Support:
1289 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1290 the generic ULPI layer. The generic layer accesses the ULPI PHY
1291 via the platform viewport, so you need both the genric layer and
1292 the viewport enabled. Currently only Chipidea/ARC based
1293 viewport is supported.
1294 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1295 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001296 If your ULPI phy needs a different reference clock than the
1297 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1298 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001299
wdenk7a428cc2003-06-15 22:40:42 +00001300- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001301 The MMC controller on the Intel PXA is supported. To
1302 enable this define CONFIG_MMC. The MMC can be
1303 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001304 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001305 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1306 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001307
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001308 CONFIG_SH_MMCIF
1309 Support for Renesas on-chip MMCIF controller
1310
1311 CONFIG_SH_MMCIF_ADDR
1312 Define the base address of MMCIF registers
1313
1314 CONFIG_SH_MMCIF_CLK
1315 Define the clock frequency for MMCIF
1316
wdenkda04a8b2004-08-02 23:22:59 +00001317- Journaling Flash filesystem support:
1318 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1319 CONFIG_JFFS2_NAND_DEV
1320 Define these for a default partition on a NAND device
1321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001322 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1323 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001324 Define these for a default partition on a NOR device
1325
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001326 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001327 Define this to create an own partition. You have to provide a
1328 function struct part_info* jffs2_part_info(int part_num)
1329
1330 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001331 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001332 to disable the command chpart. This is the default when you
1333 have not defined a custom partition
1334
Donggeun Kim8f814002011-10-24 21:15:28 +00001335- FAT(File Allocation Table) filesystem write function support:
1336 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001337
1338 Define this to enable support for saving memory data as a
1339 file in FAT formatted partition.
1340
1341 This will also enable the command "fatwrite" enabling the
1342 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001343
Gabe Black7f8574c2012-10-12 14:26:11 +00001344CBFS (Coreboot Filesystem) support
1345 CONFIG_CMD_CBFS
1346
1347 Define this to enable support for reading from a Coreboot
1348 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1349 and cbfsload.
1350
wdenkc6097192002-11-03 00:24:07 +00001351- Keyboard Support:
1352 CONFIG_ISA_KEYBOARD
1353
1354 Define this to enable standard (PC-Style) keyboard
1355 support
1356
1357 CONFIG_I8042_KBD
1358 Standard PC keyboard driver with US (is default) and
1359 GERMAN key layout (switch via environment 'keymap=de') support.
1360 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1361 for cfb_console. Supports cursor blinking.
1362
1363- Video support:
1364 CONFIG_VIDEO
1365
1366 Define this to enable video support (for output to
1367 video).
1368
1369 CONFIG_VIDEO_CT69000
1370
1371 Enable Chips & Technologies 69000 Video chip
1372
1373 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001374 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001375 video output is selected via environment 'videoout'
1376 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1377 assumed.
wdenkc6097192002-11-03 00:24:07 +00001378
wdenkd3602132004-03-25 15:14:43 +00001379 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001380 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001381 are possible:
1382 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001383 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001384
1385 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1386 -------------+---------------------------------------------
1387 8 bits | 0x301* 0x303 0x305 0x161 0x307
1388 15 bits | 0x310 0x313 0x316 0x162 0x319
1389 16 bits | 0x311 0x314 0x317 0x163 0x31A
1390 24 bits | 0x312 0x315 0x318 ? 0x31B
1391 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001392 (i.e. setenv videomode 317; saveenv; reset;)
1393
wdenkd3602132004-03-25 15:14:43 +00001394 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001395 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001396
1397
stroeseb9c17c52003-04-04 15:53:41 +00001398 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001399 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001400 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1401 or CONFIG_VIDEO_SED13806_16BPP
1402
Timur Tabi020edd22011-02-15 17:09:19 -06001403 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001404 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001405 SOCs that have a DIU should define this macro to enable DIU
1406 support, and should also define these other macros:
1407
1408 CONFIG_SYS_DIU_ADDR
1409 CONFIG_VIDEO
1410 CONFIG_CMD_BMP
1411 CONFIG_CFB_CONSOLE
1412 CONFIG_VIDEO_SW_CURSOR
1413 CONFIG_VGA_AS_SINGLE_DEVICE
1414 CONFIG_VIDEO_LOGO
1415 CONFIG_VIDEO_BMP_LOGO
1416
Timur Tabi32f709e2011-04-11 14:18:22 -05001417 The DIU driver will look for the 'video-mode' environment
1418 variable, and if defined, enable the DIU as a console during
1419 boot. See the documentation file README.video for a
1420 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001421
Simon Glass54df8ce2012-12-03 13:59:47 +00001422 CONFIG_VIDEO_VGA
1423
1424 Enable the VGA video / BIOS for x86. The alternative if you
1425 are using coreboot is to use the coreboot frame buffer
1426 driver.
1427
1428
wdenk4e112c12003-06-03 23:54:09 +00001429- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001430 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001431
wdenk57b2d802003-06-27 21:31:46 +00001432 Define this to enable a custom keyboard support.
1433 This simply calls drv_keyboard_init() which must be
1434 defined in your board-specific files.
1435 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001436
wdenkc6097192002-11-03 00:24:07 +00001437- LCD Support: CONFIG_LCD
1438
1439 Define this to enable LCD support (for output to LCD
1440 display); also select one of the supported displays
1441 by defining one of these:
1442
Stelian Popf6f86652008-05-09 21:57:18 +02001443 CONFIG_ATMEL_LCD:
1444
1445 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1446
wdenkc0d54ae2003-11-25 16:55:19 +00001447 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001448
wdenkc0d54ae2003-11-25 16:55:19 +00001449 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001450
wdenkc0d54ae2003-11-25 16:55:19 +00001451 CONFIG_NEC_NL6448BC20
1452
1453 NEC NL6448BC20-08. 6.5", 640x480.
1454 Active, color, single scan.
1455
1456 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001457
wdenkc0d54ae2003-11-25 16:55:19 +00001458 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001459 Active, color, single scan.
1460
1461 CONFIG_SHARP_16x9
1462
1463 Sharp 320x240. Active, color, single scan.
1464 It isn't 16x9, and I am not sure what it is.
1465
1466 CONFIG_SHARP_LQ64D341
1467
1468 Sharp LQ64D341 display, 640x480.
1469 Active, color, single scan.
1470
1471 CONFIG_HLD1045
1472
1473 HLD1045 display, 640x480.
1474 Active, color, single scan.
1475
1476 CONFIG_OPTREX_BW
1477
1478 Optrex CBL50840-2 NF-FW 99 22 M5
1479 or
1480 Hitachi LMG6912RPFC-00T
1481 or
1482 Hitachi SP14Q002
1483
1484 320x240. Black & white.
1485
1486 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001487 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001488
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001489 CONFIG_LCD_BMP_RLE8
1490
1491 Support drawing of RLE8-compressed bitmaps on the LCD.
1492
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001493 CONFIG_I2C_EDID
1494
1495 Enables an 'i2c edid' command which can read EDID
1496 information over I2C from an attached LCD display.
1497
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001498
wdenkeb20ad32003-09-05 23:19:14 +00001499- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001500
wdenk57b2d802003-06-27 21:31:46 +00001501 If this option is set, the environment is checked for
1502 a variable "splashimage". If found, the usual display
1503 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001504 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001505 specified in "splashimage" is loaded instead. The
1506 console is redirected to the "nulldev", too. This
1507 allows for a "silent" boot where a splash screen is
1508 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001509
Matthias Weisser53884182009-07-09 16:07:30 +02001510 CONFIG_SPLASH_SCREEN_ALIGN
1511
1512 If this option is set the splash image can be freely positioned
1513 on the screen. Environment variable "splashpos" specifies the
1514 position as "x,y". If a positive number is given it is used as
1515 number of pixel from left/top. If a negative number is given it
1516 is used as number of pixel from right/bottom. You can also
1517 specify 'm' for centering the image.
1518
1519 Example:
1520 setenv splashpos m,m
1521 => image at center of screen
1522
1523 setenv splashpos 30,20
1524 => image at x = 30 and y = 20
1525
1526 setenv splashpos -10,m
1527 => vertically centered image
1528 at x = dspWidth - bmpWidth - 9
1529
Stefan Roesed9d97742005-09-22 09:04:17 +02001530- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1531
1532 If this option is set, additionally to standard BMP
1533 images, gzipped BMP images can be displayed via the
1534 splashscreen support or the bmp command.
1535
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001536- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1537
1538 If this option is set, 8-bit RLE compressed BMP images
1539 can be displayed via the splashscreen support or the
1540 bmp command.
1541
Lei Wene4e248d2012-09-28 04:26:47 +00001542- Do compresssing for memory range:
1543 CONFIG_CMD_ZIP
1544
1545 If this option is set, it would use zlib deflate method
1546 to compress the specified memory at its best effort.
1547
wdenk710e3502003-08-29 20:57:53 +00001548- Compression support:
1549 CONFIG_BZIP2
1550
1551 If this option is set, support for bzip2 compressed
1552 images is included. If not, only uncompressed and gzip
1553 compressed images are supported.
1554
wdenk9c53f402003-10-15 23:53:47 +00001555 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001556 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001557 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001558
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001559 CONFIG_LZMA
1560
1561 If this option is set, support for lzma compressed
1562 images is included.
1563
1564 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1565 requires an amount of dynamic memory that is given by the
1566 formula:
1567
1568 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1569
1570 Where lc and lp stand for, respectively, Literal context bits
1571 and Literal pos bits.
1572
1573 This value is upper-bounded by 14MB in the worst case. Anyway,
1574 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1575 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1576 a very small buffer.
1577
1578 Use the lzmainfo tool to determinate the lc and lp values and
1579 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001580 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001581
wdenk0e2bd9c2004-06-06 21:51:03 +00001582- MII/PHY support:
1583 CONFIG_PHY_ADDR
1584
1585 The address of PHY on MII bus.
1586
1587 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1588
1589 The clock frequency of the MII bus
1590
1591 CONFIG_PHY_GIGE
1592
1593 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001594 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001595
1596 CONFIG_PHY_RESET_DELAY
1597
1598 Some PHY like Intel LXT971A need extra delay after
1599 reset before any MII register access is possible.
1600 For such PHY, set this option to the usec delay
1601 required. (minimum 300usec for LXT971A)
1602
1603 CONFIG_PHY_CMD_DELAY (ppc4xx)
1604
1605 Some PHY like Intel LXT971A need extra delay after
1606 command issued before MII status register can be read
1607
wdenkc6097192002-11-03 00:24:07 +00001608- Ethernet address:
1609 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001610 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001611 CONFIG_ETH2ADDR
1612 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001613 CONFIG_ETH4ADDR
1614 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001615
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001616 Define a default value for Ethernet address to use
1617 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001618 is not determined automatically.
1619
1620- IP address:
1621 CONFIG_IPADDR
1622
1623 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001624 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001625 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001626 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001627
1628- Server IP address:
1629 CONFIG_SERVERIP
1630
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001631 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001632 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001633 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001634
Robin Getz470a6d42009-07-21 12:15:28 -04001635 CONFIG_KEEP_SERVERADDR
1636
1637 Keeps the server's MAC address, in the env 'serveraddr'
1638 for passing to bootargs (like Linux's netconsole option)
1639
Wolfgang Denk26da2992011-10-26 10:21:22 +00001640- Gateway IP address:
1641 CONFIG_GATEWAYIP
1642
1643 Defines a default value for the IP address of the
1644 default router where packets to other networks are
1645 sent to.
1646 (Environment variable "gatewayip")
1647
1648- Subnet mask:
1649 CONFIG_NETMASK
1650
1651 Defines a default value for the subnet mask (or
1652 routing prefix) which is used to determine if an IP
1653 address belongs to the local subnet or needs to be
1654 forwarded through a router.
1655 (Environment variable "netmask")
1656
David Updegraff7280da72007-06-11 10:41:07 -05001657- Multicast TFTP Mode:
1658 CONFIG_MCAST_TFTP
1659
1660 Defines whether you want to support multicast TFTP as per
1661 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001662 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001663 driver in use must provide a function: mcast() to join/leave a
1664 multicast group.
1665
wdenkc6097192002-11-03 00:24:07 +00001666- BOOTP Recovery Mode:
1667 CONFIG_BOOTP_RANDOM_DELAY
1668
1669 If you have many targets in a network that try to
1670 boot using BOOTP, you may want to avoid that all
1671 systems send out BOOTP requests at precisely the same
1672 moment (which would happen for instance at recovery
1673 from a power failure, when all systems will try to
1674 boot, thus flooding the BOOTP server. Defining
1675 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1676 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001677 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001678
1679 1st BOOTP request: delay 0 ... 1 sec
1680 2nd BOOTP request: delay 0 ... 2 sec
1681 3rd BOOTP request: delay 0 ... 4 sec
1682 4th and following
1683 BOOTP requests: delay 0 ... 8 sec
1684
stroesee0aadfb2003-08-28 14:17:32 +00001685- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001686 You can fine tune the DHCP functionality by defining
1687 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001688
Jon Loeliger5336a762007-07-09 22:08:34 -05001689 CONFIG_BOOTP_SUBNETMASK
1690 CONFIG_BOOTP_GATEWAY
1691 CONFIG_BOOTP_HOSTNAME
1692 CONFIG_BOOTP_NISDOMAIN
1693 CONFIG_BOOTP_BOOTPATH
1694 CONFIG_BOOTP_BOOTFILESIZE
1695 CONFIG_BOOTP_DNS
1696 CONFIG_BOOTP_DNS2
1697 CONFIG_BOOTP_SEND_HOSTNAME
1698 CONFIG_BOOTP_NTPSERVER
1699 CONFIG_BOOTP_TIMEOFFSET
1700 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001701 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001702
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001703 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1704 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001705
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001706 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1707 after the configured retry count, the call will fail
1708 instead of starting over. This can be used to fail over
1709 to Link-local IP address configuration if the DHCP server
1710 is not available.
1711
stroesee0aadfb2003-08-28 14:17:32 +00001712 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1713 serverip from a DHCP server, it is possible that more
1714 than one DNS serverip is offered to the client.
1715 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1716 serverip will be stored in the additional environment
1717 variable "dnsip2". The first DNS serverip is always
1718 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001719 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001720
1721 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1722 to do a dynamic update of a DNS server. To do this, they
1723 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001724 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001725 of the "hostname" environment variable is passed as
1726 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001727
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001728 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1729
1730 A 32bit value in microseconds for a delay between
1731 receiving a "DHCP Offer" and sending the "DHCP Request".
1732 This fixes a problem with certain DHCP servers that don't
1733 respond 100% of the time to a "DHCP request". E.g. On an
1734 AT91RM9200 processor running at 180MHz, this delay needed
1735 to be *at least* 15,000 usec before a Windows Server 2003
1736 DHCP server would reply 100% of the time. I recommend at
1737 least 50,000 usec to be safe. The alternative is to hope
1738 that one of the retries will be successful but note that
1739 the DHCP timeout and retry process takes a longer than
1740 this delay.
1741
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001742 - Link-local IP address negotiation:
1743 Negotiate with other link-local clients on the local network
1744 for an address that doesn't require explicit configuration.
1745 This is especially useful if a DHCP server cannot be guaranteed
1746 to exist in all environments that the device must operate.
1747
1748 See doc/README.link-local for more information.
1749
wdenk145d2c12004-04-15 21:48:45 +00001750 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001751 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001752
1753 The device id used in CDP trigger frames.
1754
1755 CONFIG_CDP_DEVICE_ID_PREFIX
1756
1757 A two character string which is prefixed to the MAC address
1758 of the device.
1759
1760 CONFIG_CDP_PORT_ID
1761
1762 A printf format string which contains the ascii name of
1763 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001764 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001765
1766 CONFIG_CDP_CAPABILITIES
1767
1768 A 32bit integer which indicates the device capabilities;
1769 0x00000010 for a normal host which does not forwards.
1770
1771 CONFIG_CDP_VERSION
1772
1773 An ascii string containing the version of the software.
1774
1775 CONFIG_CDP_PLATFORM
1776
1777 An ascii string containing the name of the platform.
1778
1779 CONFIG_CDP_TRIGGER
1780
1781 A 32bit integer sent on the trigger.
1782
1783 CONFIG_CDP_POWER_CONSUMPTION
1784
1785 A 16bit integer containing the power consumption of the
1786 device in .1 of milliwatts.
1787
1788 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1789
1790 A byte containing the id of the VLAN.
1791
wdenkc6097192002-11-03 00:24:07 +00001792- Status LED: CONFIG_STATUS_LED
1793
1794 Several configurations allow to display the current
1795 status using a LED. For instance, the LED will blink
1796 fast while running U-Boot code, stop blinking as
1797 soon as a reply to a BOOTP request was received, and
1798 start blinking slow once the Linux kernel is running
1799 (supported by a status LED driver in the Linux
1800 kernel). Defining CONFIG_STATUS_LED enables this
1801 feature in U-Boot.
1802
1803- CAN Support: CONFIG_CAN_DRIVER
1804
1805 Defining CONFIG_CAN_DRIVER enables CAN driver support
1806 on those systems that support this (optional)
1807 feature, like the TQM8xxL modules.
1808
1809- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1810
wdenkb9bbd242003-06-30 16:24:52 +00001811 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001812 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001813 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001814
wdenk21136db2003-07-16 21:53:01 +00001815 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001816 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001817 CONFIG_COMMANDS) and communicate with i2c based realtime
1818 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001819 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001820
Ben Warren45657152006-09-07 16:50:54 -04001821 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001822
wdenk21136db2003-07-16 21:53:01 +00001823 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001824 bit-banging) driver instead of CPM or similar hardware
1825 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001826
wdenk21136db2003-07-16 21:53:01 +00001827 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001828 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001829
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001830 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001831 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001832 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001833 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001834
Peter Tysere4d1abc2010-04-12 22:28:21 -05001835 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001836 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001837 and so its address should therefore be cleared to 0 (See,
1838 eg, MPC823e User's Manual p.16-473). So, set
1839 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001840
Eric Millbrandt12990a42009-09-03 08:09:44 -05001841 CONFIG_SYS_I2C_INIT_MPC5XXX
1842
1843 When a board is reset during an i2c bus transfer
1844 chips might think that the current transfer is still
1845 in progress. Reset the slave devices by sending start
1846 commands until the slave device responds.
1847
wdenk21136db2003-07-16 21:53:01 +00001848 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001849
wdenkb9bbd242003-06-30 16:24:52 +00001850 If you use the software i2c interface (CONFIG_SOFT_I2C)
1851 then the following macros need to be defined (examples are
1852 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001853
1854 I2C_INIT
1855
wdenkb9bbd242003-06-30 16:24:52 +00001856 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001857 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001858
wdenk544e9732004-02-06 23:19:44 +00001859 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001860
wdenkc6097192002-11-03 00:24:07 +00001861 I2C_PORT
1862
wdenk4a5c8a72003-03-06 00:02:04 +00001863 (Only for MPC8260 CPU). The I/O port to use (the code
1864 assumes both bits are on the same port). Valid values
1865 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001866
1867 I2C_ACTIVE
1868
1869 The code necessary to make the I2C data line active
1870 (driven). If the data line is open collector, this
1871 define can be null.
1872
wdenkb9bbd242003-06-30 16:24:52 +00001873 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1874
wdenkc6097192002-11-03 00:24:07 +00001875 I2C_TRISTATE
1876
1877 The code necessary to make the I2C data line tri-stated
1878 (inactive). If the data line is open collector, this
1879 define can be null.
1880
wdenkb9bbd242003-06-30 16:24:52 +00001881 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1882
wdenkc6097192002-11-03 00:24:07 +00001883 I2C_READ
1884
1885 Code that returns TRUE if the I2C data line is high,
1886 FALSE if it is low.
1887
wdenkb9bbd242003-06-30 16:24:52 +00001888 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1889
wdenkc6097192002-11-03 00:24:07 +00001890 I2C_SDA(bit)
1891
1892 If <bit> is TRUE, sets the I2C data line high. If it
1893 is FALSE, it clears it (low).
1894
wdenkb9bbd242003-06-30 16:24:52 +00001895 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001896 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001897 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001898
wdenkc6097192002-11-03 00:24:07 +00001899 I2C_SCL(bit)
1900
1901 If <bit> is TRUE, sets the I2C clock line high. If it
1902 is FALSE, it clears it (low).
1903
wdenkb9bbd242003-06-30 16:24:52 +00001904 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001905 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001906 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001907
wdenkc6097192002-11-03 00:24:07 +00001908 I2C_DELAY
1909
1910 This delay is invoked four times per clock cycle so this
1911 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001912 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001913 like:
1914
wdenkb9bbd242003-06-30 16:24:52 +00001915 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001916
Mike Frysingeree12d542010-07-21 13:38:02 -04001917 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1918
1919 If your arch supports the generic GPIO framework (asm/gpio.h),
1920 then you may alternatively define the two GPIOs that are to be
1921 used as SCL / SDA. Any of the previous I2C_xxx macros will
1922 have GPIO-based defaults assigned to them as appropriate.
1923
1924 You should define these to the GPIO value as given directly to
1925 the generic GPIO functions.
1926
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001927 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001928
wdenk57b2d802003-06-27 21:31:46 +00001929 When a board is reset during an i2c bus transfer
1930 chips might think that the current transfer is still
1931 in progress. On some boards it is possible to access
1932 the i2c SCLK line directly, either by using the
1933 processor pin as a GPIO or by having a second pin
1934 connected to the bus. If this option is defined a
1935 custom i2c_init_board() routine in boards/xxx/board.c
1936 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001937
Richard Retanubundf0149c2010-04-12 15:08:17 -04001938 CONFIG_SYS_I2C_BOARD_LATE_INIT
1939
1940 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1941 defined a custom i2c_board_late_init() routine in
1942 boards/xxx/board.c is run AFTER the operations in i2c_init()
1943 is completed. This callpoint can be used to unreset i2c bus
1944 using CPU i2c controller register accesses for CPUs whose i2c
1945 controller provide such a method. It is called at the end of
1946 i2c_init() to allow i2c_init operations to setup the i2c bus
1947 controller on the CPU (e.g. setting bus speed & slave address).
1948
wdenk0e2bd9c2004-06-06 21:51:03 +00001949 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1950
1951 This option enables configuration of bi_iic_fast[] flags
1952 in u-boot bd_info structure based on u-boot environment
1953 variable "i2cfast". (see also i2cfast)
1954
Ben Warren45657152006-09-07 16:50:54 -04001955 CONFIG_I2C_MULTI_BUS
1956
1957 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001958 must have a controller. At any point in time, only one bus is
1959 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001960 Note that bus numbering is zero-based.
1961
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001962 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001963
1964 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001965 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001966 is set, specify a list of bus-device pairs. Otherwise, specify
1967 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001968
1969 e.g.
1970 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001971 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001972
1973 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1974
Wolfgang Denk092ae952011-10-26 10:21:21 +00001975 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001976 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001977
1978 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1979
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001980 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001981
1982 If defined, then this indicates the I2C bus number for DDR SPD.
1983 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1984
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001985 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001986
1987 If defined, then this indicates the I2C bus number for the RTC.
1988 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001990 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001991
1992 If defined, then this indicates the I2C bus number for the DTT.
1993 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1994
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001995 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001996
1997 If defined, specifies the I2C address of the DTT device.
1998 If not defined, then U-Boot uses predefined value for
1999 specified DTT device.
2000
Timur Tabiab347542006-11-03 19:15:00 -06002001 CONFIG_FSL_I2C
2002
2003 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002004 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002005
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002006 CONFIG_I2C_MUX
2007
2008 Define this option if you have I2C devices reached over 1 .. n
2009 I2C Muxes like the pca9544a. This option addes a new I2C
2010 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2011 new I2C Bus to the existing I2C Busses. If you select the
2012 new Bus with "i2c dev", u-bbot sends first the commandos for
2013 the muxes to activate this new "bus".
2014
2015 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2016 feature!
2017
2018 Example:
2019 Adding a new I2C Bus reached over 2 pca9544a muxes
2020 The First mux with address 70 and channel 6
2021 The Second mux with address 71 and channel 4
2022
2023 => i2c bus pca9544a:70:6:pca9544a:71:4
2024
2025 Use the "i2c bus" command without parameter, to get a list
2026 of I2C Busses with muxes:
2027
2028 => i2c bus
2029 Busses reached over muxes:
2030 Bus ID: 2
2031 reached over Mux(es):
2032 pca9544a@70 ch: 4
2033 Bus ID: 3
2034 reached over Mux(es):
2035 pca9544a@70 ch: 6
2036 pca9544a@71 ch: 4
2037 =>
2038
2039 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002040 u-boot first sends the command to the mux@70 to enable
2041 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002042 the channel 4.
2043
2044 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002045 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002046 the 2 muxes.
2047
2048 This option is actually implemented for the bitbanging
2049 algorithm in common/soft_i2c.c and for the Hardware I2C
2050 Bus on the MPC8260. But it should be not so difficult
2051 to add this option to other architectures.
2052
Andrew Dyer58c41f92008-12-29 17:36:01 -06002053 CONFIG_SOFT_I2C_READ_REPEATED_START
2054
2055 defining this will force the i2c_read() function in
2056 the soft_i2c driver to perform an I2C repeated start
2057 between writing the address pointer and reading the
2058 data. If this define is omitted the default behaviour
2059 of doing a stop-start sequence will be used. Most I2C
2060 devices can use either method, but some require one or
2061 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002062
wdenkc6097192002-11-03 00:24:07 +00002063- SPI Support: CONFIG_SPI
2064
2065 Enables SPI driver (so far only tested with
2066 SPI EEPROM, also an instance works with Crystal A/D and
2067 D/As on the SACSng board)
2068
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002069 CONFIG_SH_SPI
2070
2071 Enables the driver for SPI controller on SuperH. Currently
2072 only SH7757 is supported.
2073
wdenkc6097192002-11-03 00:24:07 +00002074 CONFIG_SPI_X
2075
2076 Enables extended (16-bit) SPI EEPROM addressing.
2077 (symmetrical to CONFIG_I2C_X)
2078
2079 CONFIG_SOFT_SPI
2080
wdenk4a5c8a72003-03-06 00:02:04 +00002081 Enables a software (bit-bang) SPI driver rather than
2082 using hardware support. This is a general purpose
2083 driver that only requires three general I/O port pins
2084 (two outputs, one input) to function. If this is
2085 defined, the board configuration must define several
2086 SPI configuration items (port pins to use, etc). For
2087 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002088
Ben Warren7efe9272008-01-16 22:37:35 -05002089 CONFIG_HARD_SPI
2090
2091 Enables a hardware SPI driver for general-purpose reads
2092 and writes. As with CONFIG_SOFT_SPI, the board configuration
2093 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002094 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002095 example, see include/configs/mpc8349emds.h.
2096
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002097 CONFIG_MXC_SPI
2098
2099 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002100 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002101
Matthias Fuchsa4400872007-12-27 17:12:34 +01002102- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002103
Matthias Fuchsa4400872007-12-27 17:12:34 +01002104 Enables FPGA subsystem.
2105
2106 CONFIG_FPGA_<vendor>
2107
2108 Enables support for specific chip vendors.
2109 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002110
Matthias Fuchsa4400872007-12-27 17:12:34 +01002111 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002112
Matthias Fuchsa4400872007-12-27 17:12:34 +01002113 Enables support for FPGA family.
2114 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2115
2116 CONFIG_FPGA_COUNT
2117
2118 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002120 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002121
wdenk57b2d802003-06-27 21:31:46 +00002122 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002124 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002125
wdenk4a5c8a72003-03-06 00:02:04 +00002126 Enable checks on FPGA configuration interface busy
2127 status by the configuration function. This option
2128 will require a board or device specific function to
2129 be written.
wdenkc6097192002-11-03 00:24:07 +00002130
2131 CONFIG_FPGA_DELAY
2132
2133 If defined, a function that provides delays in the FPGA
2134 configuration driver.
2135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002136 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002137 Allow Control-C to interrupt FPGA configuration
2138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002139 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002140
wdenk4a5c8a72003-03-06 00:02:04 +00002141 Check for configuration errors during FPGA bitfile
2142 loading. For example, abort during Virtex II
2143 configuration if the INIT_B line goes low (which
2144 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002146 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002147
wdenk4a5c8a72003-03-06 00:02:04 +00002148 Maximum time to wait for the INIT_B line to deassert
2149 after PROB_B has been deasserted during a Virtex II
2150 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002151 ms.
wdenkc6097192002-11-03 00:24:07 +00002152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002153 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002154
wdenk4a5c8a72003-03-06 00:02:04 +00002155 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002156 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002158 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002159
wdenk4a5c8a72003-03-06 00:02:04 +00002160 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002161 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002162
2163- Configuration Management:
2164 CONFIG_IDENT_STRING
2165
wdenk4a5c8a72003-03-06 00:02:04 +00002166 If defined, this string will be added to the U-Boot
2167 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002168
2169- Vendor Parameter Protection:
2170
wdenk4a5c8a72003-03-06 00:02:04 +00002171 U-Boot considers the values of the environment
2172 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002173 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002174 are set once by the board vendor / manufacturer, and
2175 protects these variables from casual modification by
2176 the user. Once set, these variables are read-only,
2177 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002178 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002179
2180 If CONFIG_ENV_OVERWRITE is #defined in your config
2181 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002182 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002183 these parameters.
2184
2185 Alternatively, if you #define _both_ CONFIG_ETHADDR
2186 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002187 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002188 which can be changed exactly ONCE by the user. [The
2189 serial# is unaffected by this, i. e. it remains
2190 read-only.]
2191
Joe Hershberger71497d02012-12-11 22:16:31 -06002192 The same can be accomplished in a more flexible way
2193 for any variable by configuring the type of access
2194 to allow for those variables in the ".flags" variable
2195 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2196
wdenkc6097192002-11-03 00:24:07 +00002197- Protected RAM:
2198 CONFIG_PRAM
2199
2200 Define this variable to enable the reservation of
2201 "protected RAM", i. e. RAM which is not overwritten
2202 by U-Boot. Define CONFIG_PRAM to hold the number of
2203 kB you want to reserve for pRAM. You can overwrite
2204 this default value by defining an environment
2205 variable "pram" to the number of kB you want to
2206 reserve. Note that the board info structure will
2207 still show the full amount of RAM. If pRAM is
2208 reserved, a new environment variable "mem" will
2209 automatically be defined to hold the amount of
2210 remaining RAM in a form that can be passed as boot
2211 argument to Linux, for instance like that:
2212
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002213 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002214 saveenv
2215
2216 This way you can tell Linux not to use this memory,
2217 either, which results in a memory region that will
2218 not be affected by reboots.
2219
2220 *WARNING* If your board configuration uses automatic
2221 detection of the RAM size, you must make sure that
2222 this memory test is non-destructive. So far, the
2223 following board configurations are known to be
2224 "pRAM-clean":
2225
Wolfgang Denk90326762012-10-24 02:36:15 +00002226 IVMS8, IVML24, SPD8xx, TQM8xxL,
2227 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002228 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002229
Gabe Blacka2f3a932012-12-02 04:55:18 +00002230- Access to physical memory region (> 4GB)
2231 Some basic support is provided for operations on memory not
2232 normally accessible to U-Boot - e.g. some architectures
2233 support access to more than 4GB of memory on 32-bit
2234 machines using physical address extension or similar.
2235 Define CONFIG_PHYSMEM to access this basic support, which
2236 currently only supports clearing the memory.
2237
wdenkc6097192002-11-03 00:24:07 +00002238- Error Recovery:
2239 CONFIG_PANIC_HANG
2240
2241 Define this variable to stop the system in case of a
2242 fatal error, so that you have to reset it manually.
2243 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002244 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002245 automatically as fast as possible, but it may be
2246 useful during development since you can try to debug
2247 the conditions that lead to the situation.
2248
2249 CONFIG_NET_RETRY_COUNT
2250
wdenk4a5c8a72003-03-06 00:02:04 +00002251 This variable defines the number of retries for
2252 network operations like ARP, RARP, TFTP, or BOOTP
2253 before giving up the operation. If not defined, a
2254 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002255
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002256 CONFIG_ARP_TIMEOUT
2257
2258 Timeout waiting for an ARP reply in milliseconds.
2259
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002260 CONFIG_NFS_TIMEOUT
2261
2262 Timeout in milliseconds used in NFS protocol.
2263 If you encounter "ERROR: Cannot umount" in nfs command,
2264 try longer timeout such as
2265 #define CONFIG_NFS_TIMEOUT 10000UL
2266
wdenkc6097192002-11-03 00:24:07 +00002267- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002268 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002269
2270 Enable auto completion of commands using TAB.
2271
Wolfgang Denk018147d2006-11-27 15:32:42 +01002272 Note that this feature has NOT been implemented yet
2273 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002274
2275
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002276 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002277
2278 Define this variable to enable the "hush" shell (from
2279 Busybox) as command line interpreter, thus enabling
2280 powerful command line syntax like
2281 if...then...else...fi conditionals or `&&' and '||'
2282 constructs ("shell scripts").
2283
2284 If undefined, you get the old, much simpler behaviour
2285 with a somewhat smaller memory footprint.
2286
2287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002288 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002289
2290 This defines the secondary prompt string, which is
2291 printed when the command interpreter needs more input
2292 to complete a command. Usually "> ".
2293
2294 Note:
2295
wdenk57b2d802003-06-27 21:31:46 +00002296 In the current implementation, the local variables
2297 space and global environment variables space are
2298 separated. Local variables are those you define by
2299 simply typing `name=value'. To access a local
2300 variable later on, you have write `$name' or
2301 `${name}'; to execute the contents of a variable
2302 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002303
wdenk4a5c8a72003-03-06 00:02:04 +00002304 Global environment variables are those you use
2305 setenv/printenv to work with. To run a command stored
2306 in such a variable, you need to use the run command,
2307 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002308
2309 To store commands and special characters in a
2310 variable, please use double quotation marks
2311 surrounding the whole text of the variable, instead
2312 of the backslashes before semicolons and special
2313 symbols.
2314
Wolfgang Denk2039a072006-07-21 11:35:21 +02002315- Commandline Editing and History:
2316 CONFIG_CMDLINE_EDITING
2317
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002318 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002319 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002320
wdenkc0aa5c52003-12-06 19:49:23 +00002321- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002322 CONFIG_EXTRA_ENV_SETTINGS
2323
wdenk4a5c8a72003-03-06 00:02:04 +00002324 Define this to contain any number of null terminated
2325 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002326 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002327
wdenk4a5c8a72003-03-06 00:02:04 +00002328 For example, place something like this in your
2329 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002330
2331 #define CONFIG_EXTRA_ENV_SETTINGS \
2332 "myvar1=value1\0" \
2333 "myvar2=value2\0"
2334
wdenk4a5c8a72003-03-06 00:02:04 +00002335 Warning: This method is based on knowledge about the
2336 internal format how the environment is stored by the
2337 U-Boot code. This is NOT an official, exported
2338 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002339 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002340 You better know what you are doing here.
2341
wdenk4a5c8a72003-03-06 00:02:04 +00002342 Note: overly (ab)use of the default environment is
2343 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002344 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002345 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002346
Stephen Warren1465d5f2012-05-22 09:21:54 +00002347 CONFIG_ENV_VARS_UBOOT_CONFIG
2348
2349 Define this in order to add variables describing the
2350 U-Boot build configuration to the default environment.
2351 These will be named arch, cpu, board, vendor, and soc.
2352
2353 Enabling this option will cause the following to be defined:
2354
2355 - CONFIG_SYS_ARCH
2356 - CONFIG_SYS_CPU
2357 - CONFIG_SYS_BOARD
2358 - CONFIG_SYS_VENDOR
2359 - CONFIG_SYS_SOC
2360
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002361 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2362
2363 Define this in order to add variables describing certain
2364 run-time determined information about the hardware to the
2365 environment. These will be named board_name, board_rev.
2366
wdenkc0aa5c52003-12-06 19:49:23 +00002367- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002368 CONFIG_HAS_DATAFLASH
2369
wdenk57b2d802003-06-27 21:31:46 +00002370 Defining this option enables DataFlash features and
2371 allows to read/write in Dataflash via the standard
2372 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002373
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002374- Serial Flash support
2375 CONFIG_CMD_SF
2376
2377 Defining this option enables SPI flash commands
2378 'sf probe/read/write/erase/update'.
2379
2380 Usage requires an initial 'probe' to define the serial
2381 flash parameters, followed by read/write/erase/update
2382 commands.
2383
2384 The following defaults may be provided by the platform
2385 to handle the common case when only a single serial
2386 flash is present on the system.
2387
2388 CONFIG_SF_DEFAULT_BUS Bus identifier
2389 CONFIG_SF_DEFAULT_CS Chip-select
2390 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2391 CONFIG_SF_DEFAULT_SPEED in Hz
2392
wdenkef893942004-02-23 16:11:30 +00002393- SystemACE Support:
2394 CONFIG_SYSTEMACE
2395
2396 Adding this option adds support for Xilinx SystemACE
2397 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002398 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002399 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002400
2401 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002402 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002403
2404 When SystemACE support is added, the "ace" device type
2405 becomes available to the fat commands, i.e. fatls.
2406
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002407- TFTP Fixed UDP Port:
2408 CONFIG_TFTP_PORT
2409
Wolfgang Denk227b5192005-09-24 23:25:46 +02002410 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002411 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002412 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002413 number generator is used.
2414
Wolfgang Denk227b5192005-09-24 23:25:46 +02002415 Also, the environment variable tftpdstp is used to supply
2416 the TFTP UDP destination port value. If tftpdstp isn't
2417 defined, the normal port 69 is used.
2418
2419 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002420 blindly start the TFTP transfer using the pre-configured
2421 target IP address and UDP port. This has the effect of
2422 "punching through" the (Windows XP) firewall, allowing
2423 the remainder of the TFTP transfer to proceed normally.
2424 A better solution is to properly configure the firewall,
2425 but sometimes that is not allowed.
2426
Simon Glass058bb8d2012-12-05 14:46:38 +00002427- Hashing support:
2428 CONFIG_CMD_HASH
2429
2430 This enables a generic 'hash' command which can produce
2431 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2432
2433 CONFIG_HASH_VERIFY
2434
2435 Enable the hash verify command (hash -v). This adds to code
2436 size a little.
2437
2438 CONFIG_SHA1 - support SHA1 hashing
2439 CONFIG_SHA256 - support SHA256 hashing
2440
2441 Note: There is also a sha1sum command, which should perhaps
2442 be deprecated in favour of 'hash sha1'.
2443
wdenkc0aa5c52003-12-06 19:49:23 +00002444- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002445 CONFIG_SHOW_BOOT_PROGRESS
2446
wdenk4a5c8a72003-03-06 00:02:04 +00002447 Defining this option allows to add some board-
2448 specific code (calling a user-provided function
2449 "show_boot_progress(int)") that enables you to show
2450 the system's boot progress on some display (for
2451 example, some LED's) on your board. At the moment,
2452 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002453
Simon Glass31a870e2012-02-13 13:51:19 +00002454- Detailed boot stage timing
2455 CONFIG_BOOTSTAGE
2456 Define this option to get detailed timing of each stage
2457 of the boot process.
2458
2459 CONFIG_BOOTSTAGE_USER_COUNT
2460 This is the number of available user bootstage records.
2461 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2462 a new ID will be allocated from this stash. If you exceed
2463 the limit, recording will stop.
2464
2465 CONFIG_BOOTSTAGE_REPORT
2466 Define this to print a report before boot, similar to this:
2467
2468 Timer summary in microseconds:
2469 Mark Elapsed Stage
2470 0 0 reset
2471 3,575,678 3,575,678 board_init_f start
2472 3,575,695 17 arch_cpu_init A9
2473 3,575,777 82 arch_cpu_init done
2474 3,659,598 83,821 board_init_r start
2475 3,910,375 250,777 main_loop
2476 29,916,167 26,005,792 bootm_start
2477 30,361,327 445,160 start_kernel
2478
Simon Glass4afd88e2012-09-28 08:56:39 +00002479 CONFIG_CMD_BOOTSTAGE
2480 Add a 'bootstage' command which supports printing a report
2481 and un/stashing of bootstage data.
2482
Simon Glass0fa36a42012-09-28 08:56:37 +00002483 CONFIG_BOOTSTAGE_FDT
2484 Stash the bootstage information in the FDT. A root 'bootstage'
2485 node is created with each bootstage id as a child. Each child
2486 has a 'name' property and either 'mark' containing the
2487 mark time in microsecond, or 'accum' containing the
2488 accumulated time for that bootstage id in microseconds.
2489 For example:
2490
2491 bootstage {
2492 154 {
2493 name = "board_init_f";
2494 mark = <3575678>;
2495 };
2496 170 {
2497 name = "lcd";
2498 accum = <33482>;
2499 };
2500 };
2501
2502 Code in the Linux kernel can find this in /proc/devicetree.
2503
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002504Legacy uImage format:
2505
wdenkc6097192002-11-03 00:24:07 +00002506 Arg Where When
2507 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002508 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002509 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002510 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002511 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002512 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002513 4 common/cmd_bootm.c Image data has correct checksum
2514 -4 common/cmd_bootm.c Image is for unsupported architecture
2515 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002516 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002517 6 common/cmd_bootm.c Image Type check OK
2518 -6 common/cmd_bootm.c gunzip uncompression error
2519 -7 common/cmd_bootm.c Unimplemented compression type
2520 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002521 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002522 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002523
2524 9 common/image.c Start initial ramdisk verification
2525 -10 common/image.c Ramdisk header has bad magic number
2526 -11 common/image.c Ramdisk header has bad checksum
2527 10 common/image.c Ramdisk header is OK
2528 -12 common/image.c Ramdisk data has bad checksum
2529 11 common/image.c Ramdisk data has correct checksum
2530 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002531 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002532 13 common/image.c Start multifile image verification
2533 14 common/image.c No initial ramdisk, no multifile, continue.
2534
Wolfgang Denk092ae952011-10-26 10:21:21 +00002535 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002536
Stefan Roese88fbf932010-04-15 16:07:28 +02002537 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002538 -31 post/post.c POST test failed, detected by post_output_backlog()
2539 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002540
Heiko Schocher633e03a2007-06-22 19:11:54 +02002541 34 common/cmd_doc.c before loading a Image from a DOC device
2542 -35 common/cmd_doc.c Bad usage of "doc" command
2543 35 common/cmd_doc.c correct usage of "doc" command
2544 -36 common/cmd_doc.c No boot device
2545 36 common/cmd_doc.c correct boot device
2546 -37 common/cmd_doc.c Unknown Chip ID on boot device
2547 37 common/cmd_doc.c correct chip ID found, device available
2548 -38 common/cmd_doc.c Read Error on boot device
2549 38 common/cmd_doc.c reading Image header from DOC device OK
2550 -39 common/cmd_doc.c Image header has bad magic number
2551 39 common/cmd_doc.c Image header has correct magic number
2552 -40 common/cmd_doc.c Error reading Image from DOC device
2553 40 common/cmd_doc.c Image header has correct magic number
2554 41 common/cmd_ide.c before loading a Image from a IDE device
2555 -42 common/cmd_ide.c Bad usage of "ide" command
2556 42 common/cmd_ide.c correct usage of "ide" command
2557 -43 common/cmd_ide.c No boot device
2558 43 common/cmd_ide.c boot device found
2559 -44 common/cmd_ide.c Device not available
2560 44 common/cmd_ide.c Device available
2561 -45 common/cmd_ide.c wrong partition selected
2562 45 common/cmd_ide.c partition selected
2563 -46 common/cmd_ide.c Unknown partition table
2564 46 common/cmd_ide.c valid partition table found
2565 -47 common/cmd_ide.c Invalid partition type
2566 47 common/cmd_ide.c correct partition type
2567 -48 common/cmd_ide.c Error reading Image Header on boot device
2568 48 common/cmd_ide.c reading Image Header from IDE device OK
2569 -49 common/cmd_ide.c Image header has bad magic number
2570 49 common/cmd_ide.c Image header has correct magic number
2571 -50 common/cmd_ide.c Image header has bad checksum
2572 50 common/cmd_ide.c Image header has correct checksum
2573 -51 common/cmd_ide.c Error reading Image from IDE device
2574 51 common/cmd_ide.c reading Image from IDE device OK
2575 52 common/cmd_nand.c before loading a Image from a NAND device
2576 -53 common/cmd_nand.c Bad usage of "nand" command
2577 53 common/cmd_nand.c correct usage of "nand" command
2578 -54 common/cmd_nand.c No boot device
2579 54 common/cmd_nand.c boot device found
2580 -55 common/cmd_nand.c Unknown Chip ID on boot device
2581 55 common/cmd_nand.c correct chip ID found, device available
2582 -56 common/cmd_nand.c Error reading Image Header on boot device
2583 56 common/cmd_nand.c reading Image Header from NAND device OK
2584 -57 common/cmd_nand.c Image header has bad magic number
2585 57 common/cmd_nand.c Image header has correct magic number
2586 -58 common/cmd_nand.c Error reading Image from NAND device
2587 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002588
Heiko Schocher633e03a2007-06-22 19:11:54 +02002589 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002590
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002591 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002592 -64 net/eth.c no Ethernet found.
2593 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002594
Heiko Schocher633e03a2007-06-22 19:11:54 +02002595 -80 common/cmd_net.c usage wrong
2596 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002597 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002598 81 common/cmd_net.c NetLoop() back without error
2599 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2600 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002601 83 common/cmd_net.c running "source" command
2602 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002603 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002604
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002605FIT uImage format:
2606
2607 Arg Where When
2608 100 common/cmd_bootm.c Kernel FIT Image has correct format
2609 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2610 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2611 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2612 102 common/cmd_bootm.c Kernel unit name specified
2613 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002614 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002615 104 common/cmd_bootm.c Got kernel subimage node offset
2616 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2617 105 common/cmd_bootm.c Kernel subimage hash verification OK
2618 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2619 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002620 -106 common/cmd_bootm.c Kernel subimage has wrong type
2621 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002622 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2623 108 common/cmd_bootm.c Got kernel subimage data/size
2624 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2625 -109 common/cmd_bootm.c Can't get kernel subimage type
2626 -110 common/cmd_bootm.c Can't get kernel subimage comp
2627 -111 common/cmd_bootm.c Can't get kernel subimage os
2628 -112 common/cmd_bootm.c Can't get kernel subimage load address
2629 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2630
2631 120 common/image.c Start initial ramdisk verification
2632 -120 common/image.c Ramdisk FIT image has incorrect format
2633 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002634 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002635 -122 common/image.c Can't get configuration for ramdisk subimage
2636 123 common/image.c Ramdisk unit name specified
2637 -124 common/image.c Can't get ramdisk subimage node offset
2638 125 common/image.c Got ramdisk subimage node offset
2639 -125 common/image.c Ramdisk subimage hash verification failed
2640 126 common/image.c Ramdisk subimage hash verification OK
2641 -126 common/image.c Ramdisk subimage for unsupported architecture
2642 127 common/image.c Architecture check OK
2643 -127 common/image.c Can't get ramdisk subimage data/size
2644 128 common/image.c Got ramdisk subimage data/size
2645 129 common/image.c Can't get ramdisk load address
2646 -129 common/image.c Got ramdisk load address
2647
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002648 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002649 131 common/cmd_doc.c FIT image format OK
2650
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002651 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002652 141 common/cmd_ide.c FIT image format OK
2653
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002654 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002655 151 common/cmd_nand.c FIT image format OK
2656
Gabe Blackd572e162012-10-25 16:31:10 +00002657- FIT image support:
2658 CONFIG_FIT
2659 Enable support for the FIT uImage format.
2660
2661 CONFIG_FIT_BEST_MATCH
2662 When no configuration is explicitly selected, default to the
2663 one whose fdt's compatibility field best matches that of
2664 U-Boot itself. A match is considered "best" if it matches the
2665 most specific compatibility entry of U-Boot's fdt's root node.
2666 The order of entries in the configuration's fdt is ignored.
2667
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002668- Standalone program support:
2669 CONFIG_STANDALONE_LOAD_ADDR
2670
Wolfgang Denk23f78482011-10-09 21:06:34 +02002671 This option defines a board specific value for the
2672 address where standalone program gets loaded, thus
2673 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002674 settings.
2675
2676- Frame Buffer Address:
2677 CONFIG_FB_ADDR
2678
2679 Define CONFIG_FB_ADDR if you want to use specific
2680 address for frame buffer.
2681 Then system will reserve the frame buffer address to
2682 defined address instead of lcd_setmem (this function
Wolfgang Denk23f78482011-10-09 21:06:34 +02002683 grabs the memory for frame buffer by panel's size).
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002684
2685 Please see board_init_f function.
2686
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002687- Automatic software updates via TFTP server
2688 CONFIG_UPDATE_TFTP
2689 CONFIG_UPDATE_TFTP_CNT_MAX
2690 CONFIG_UPDATE_TFTP_MSEC_MAX
2691
2692 These options enable and control the auto-update feature;
2693 for a more detailed description refer to doc/README.update.
2694
2695- MTD Support (mtdparts command, UBI support)
2696 CONFIG_MTD_DEVICE
2697
2698 Adds the MTD device infrastructure from the Linux kernel.
2699 Needed for mtdparts command support.
2700
2701 CONFIG_MTD_PARTITIONS
2702
2703 Adds the MTD partitioning infrastructure from the Linux
2704 kernel. Needed for UBI support.
2705
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002706- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002707 CONFIG_SPL
2708 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002709
Tom Rini36853852012-02-14 07:29:40 +00002710 CONFIG_SPL_LDSCRIPT
2711 LDSCRIPT for linking the SPL binary.
2712
2713 CONFIG_SPL_MAX_SIZE
2714 Maximum binary size (text, data and rodata) of the SPL binary.
2715
Wolfgang Denk825223d2011-09-11 21:24:09 +02002716 CONFIG_SPL_TEXT_BASE
2717 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002718
Scott Woodc4f0d002012-09-20 19:05:12 -05002719 CONFIG_SPL_RELOC_TEXT_BASE
2720 Address to relocate to. If unspecified, this is equal to
2721 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2722
Tom Rini36853852012-02-14 07:29:40 +00002723 CONFIG_SPL_BSS_START_ADDR
2724 Link address for the BSS within the SPL binary.
2725
2726 CONFIG_SPL_BSS_MAX_SIZE
2727 Maximum binary size of the BSS section of the SPL binary.
2728
2729 CONFIG_SPL_STACK
2730 Adress of the start of the stack SPL will use
2731
Scott Woodc4f0d002012-09-20 19:05:12 -05002732 CONFIG_SPL_RELOC_STACK
2733 Adress of the start of the stack SPL will use after
2734 relocation. If unspecified, this is equal to
2735 CONFIG_SPL_STACK.
2736
Tom Rini36853852012-02-14 07:29:40 +00002737 CONFIG_SYS_SPL_MALLOC_START
2738 Starting address of the malloc pool used in SPL.
2739
2740 CONFIG_SYS_SPL_MALLOC_SIZE
2741 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002742
Tom Rini28591df2012-08-13 12:03:19 -07002743 CONFIG_SPL_FRAMEWORK
2744 Enable the SPL framework under common/. This framework
2745 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2746 NAND loading of the Linux Kernel.
2747
Tom Rinife3b0c72012-08-13 11:37:56 -07002748 CONFIG_SPL_DISPLAY_PRINT
2749 For ARM, enable an optional function to print more information
2750 about the running system.
2751
Scott Wood7c810902012-09-20 16:35:21 -05002752 CONFIG_SPL_INIT_MINIMAL
2753 Arch init code should be built for a very small image
2754
Wolfgang Denk825223d2011-09-11 21:24:09 +02002755 CONFIG_SPL_LIBCOMMON_SUPPORT
2756 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002757
Wolfgang Denk825223d2011-09-11 21:24:09 +02002758 CONFIG_SPL_LIBDISK_SUPPORT
2759 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002760
Wolfgang Denk825223d2011-09-11 21:24:09 +02002761 CONFIG_SPL_I2C_SUPPORT
2762 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002763
Wolfgang Denk825223d2011-09-11 21:24:09 +02002764 CONFIG_SPL_GPIO_SUPPORT
2765 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002766
Wolfgang Denk825223d2011-09-11 21:24:09 +02002767 CONFIG_SPL_MMC_SUPPORT
2768 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002769
Tom Rini36853852012-02-14 07:29:40 +00002770 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2771 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2772 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2773 Address, size and partition on the MMC to load U-Boot from
2774 when the MMC is being used in raw mode.
2775
2776 CONFIG_SPL_FAT_SUPPORT
2777 Support for fs/fat/libfat.o in SPL binary
2778
2779 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2780 Filename to read to load U-Boot when reading from FAT
2781
Scott Woodc352a0c2012-09-20 19:09:07 -05002782 CONFIG_SPL_NAND_BASE
2783 Include nand_base.c in the SPL. Requires
2784 CONFIG_SPL_NAND_DRIVERS.
2785
2786 CONFIG_SPL_NAND_DRIVERS
2787 SPL uses normal NAND drivers, not minimal drivers.
2788
2789 CONFIG_SPL_NAND_ECC
2790 Include standard software ECC in the SPL
2791
Tom Rini36853852012-02-14 07:29:40 +00002792 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002793 Support for NAND boot using simple NAND drivers that
2794 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002795
2796 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2797 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2798 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2799 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2800 CONFIG_SYS_NAND_ECCBYTES
2801 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002802 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002803
2804 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002805 Location in NAND to read U-Boot from
2806
2807 CONFIG_SYS_NAND_U_BOOT_DST
2808 Location in memory to load U-Boot to
2809
2810 CONFIG_SYS_NAND_U_BOOT_SIZE
2811 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002812
2813 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002814 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002815
2816 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2817 Define this if you need to first read the OOB and then the
2818 data. This is used for example on davinci plattforms.
2819
2820 CONFIG_SPL_OMAP3_ID_NAND
2821 Support for an OMAP3-specific set of functions to return the
2822 ID and MFR of the first attached NAND chip, if present.
2823
Wolfgang Denk825223d2011-09-11 21:24:09 +02002824 CONFIG_SPL_SERIAL_SUPPORT
2825 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002826
Wolfgang Denk825223d2011-09-11 21:24:09 +02002827 CONFIG_SPL_SPI_FLASH_SUPPORT
2828 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002829
Wolfgang Denk825223d2011-09-11 21:24:09 +02002830 CONFIG_SPL_SPI_SUPPORT
2831 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002832
Pavel Machekde997252012-08-30 22:42:11 +02002833 CONFIG_SPL_RAM_DEVICE
2834 Support for running image already present in ram, in SPL binary
2835
Wolfgang Denk825223d2011-09-11 21:24:09 +02002836 CONFIG_SPL_LIBGENERIC_SUPPORT
2837 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002838
Scott Woodeb7bd972012-12-06 13:33:16 +00002839 CONFIG_SPL_PAD_TO
2840 Linker address to which the SPL should be padded before
2841 appending the SPL payload.
2842
Scott Woodf147eb72012-09-21 16:27:32 -05002843 CONFIG_SPL_TARGET
2844 Final target image containing SPL and payload. Some SPLs
2845 use an arch-specific makefile fragment instead, for
2846 example if more than one image needs to be produced.
2847
wdenkc6097192002-11-03 00:24:07 +00002848Modem Support:
2849--------------
2850
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002851[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002852
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002853- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002854 CONFIG_MODEM_SUPPORT
2855
2856- RTS/CTS Flow control enable:
2857 CONFIG_HWFLOW
2858
2859- Modem debug support:
2860 CONFIG_MODEM_SUPPORT_DEBUG
2861
wdenk4a5c8a72003-03-06 00:02:04 +00002862 Enables debugging stuff (char screen[1024], dbg())
2863 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002864
wdenkc0aa5c52003-12-06 19:49:23 +00002865- Interrupt support (PPC):
2866
wdenk1ebf41e2004-01-02 14:00:00 +00002867 There are common interrupt_init() and timer_interrupt()
2868 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002869 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002870 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002871 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002872 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002873 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002874 specific handling. If board has watchdog / status_led
2875 / other_activity_monitor it works automatically from
2876 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002877
wdenkc6097192002-11-03 00:24:07 +00002878- General:
2879
wdenk4a5c8a72003-03-06 00:02:04 +00002880 In the target system modem support is enabled when a
2881 specific key (key combination) is pressed during
2882 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002883 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002884 board_init(). Currently key_pressed() is a dummy
2885 function, returning 1 and thus enabling modem
2886 initialization.
wdenkc6097192002-11-03 00:24:07 +00002887
wdenk4a5c8a72003-03-06 00:02:04 +00002888 If there are no modem init strings in the
2889 environment, U-Boot proceed to autoboot; the
2890 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002891 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002892
2893 See also: doc/README.Modem
2894
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002895Board initialization settings:
2896------------------------------
2897
2898During Initialization u-boot calls a number of board specific functions
2899to allow the preparation of board specific prerequisites, e.g. pin setup
2900before drivers are initialized. To enable these callbacks the
2901following configuration macros have to be defined. Currently this is
2902architecture specific, so please check arch/your_architecture/lib/board.c
2903typically in board_init_f() and board_init_r().
2904
2905- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2906- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2907- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2908- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002909
wdenkc6097192002-11-03 00:24:07 +00002910Configuration Settings:
2911-----------------------
2912
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002913- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002914 undefine this when you're short of memory.
2915
Peter Tyserdfb72b82009-01-27 18:03:12 -06002916- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2917 width of the commands listed in the 'help' command output.
2918
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002919- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002920 prompt for user input.
2921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002922- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002924- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002925
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002926- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002928- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002929 the application (usually a Linux kernel) when it is
2930 booted
2931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002932- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002933 List of legal baudrate settings for this board.
2934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002935- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002936 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002937
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002938- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002939 If the board specific function
2940 extern int overwrite_console (void);
2941 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002942 serial port, else the settings in the environment are used.
2943
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002944- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002945 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002946
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002947- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002948 Enable overwrite of previous console environment settings.
2949
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002950- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002951 Begin and End addresses of the area used by the
2952 simple memory test.
2953
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002954- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002955 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002956
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002957- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002958 Scratch address used by the alternate memory test
2959 You only need to set this if address zero isn't writeable
2960
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002961- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2962 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002963 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002964 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002965 fixing up gd->ram_size the Linux kernel should gets passed
2966 the now "corrected" memory size and won't touch it either.
2967 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002968 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002969 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002970 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002971
2972 This option can be used as a workaround for the 440EPx/GRx
2973 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2974 be touched.
2975
2976 WARNING: Please make sure that this value is a multiple of
2977 the Linux page size (normally 4k). If this is not the case,
2978 then the end address of the Linux memory will be located at a
2979 non page size aligned address and this could cause major
2980 problems.
2981
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002982- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002983 Default load address for network file downloads
2984
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002985- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002986 Enable temporary baudrate change while serial download
2987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002988- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002989 Physical start address of SDRAM. _Must_ be 0 here.
2990
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002991- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002992 Physical start address of Motherboard I/O (if using a
2993 Cogent motherboard)
2994
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002995- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002996 Physical start address of Flash memory.
2997
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002998- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002999 Physical start address of boot monitor code (set by
3000 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003001 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003002 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003003
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003004- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003005 Size of memory reserved for monitor code, used to
3006 determine _at_compile_time_ (!) if the environment is
3007 embedded within the U-Boot image, or in a separate
3008 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003009
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003010- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003011 Size of DRAM reserved for malloc() use.
3012
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003013- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003014 Normally compressed uImages are limited to an
3015 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003016 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003017 to adjust this setting to your needs.
3018
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003019- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003020 Maximum size of memory mapped by the startup code of
3021 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003022 the Linux kernel (bd_info, boot arguments, FDT blob if
3023 used) must be put below this limit, unless "bootm_low"
3024 enviroment variable is defined and non-zero. In such case
3025 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003026 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003027 variable "bootm_mapsize" will override the value of
3028 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3029 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003030
John Rigbyeea8e692010-10-13 13:57:35 -06003031- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3032 Enable initrd_high functionality. If defined then the
3033 initrd_high feature is enabled and the bootm ramdisk subcommand
3034 is enabled.
3035
3036- CONFIG_SYS_BOOT_GET_CMDLINE:
3037 Enables allocating and saving kernel cmdline in space between
3038 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3039
3040- CONFIG_SYS_BOOT_GET_KBD:
3041 Enables allocating and saving a kernel copy of the bd_info in
3042 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3043
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003044- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003045 Max number of Flash memory banks
3046
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003047- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003048 Max number of sectors on a Flash chip
3049
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003050- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003051 Timeout for Flash erase operations (in ms)
3052
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003053- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003054 Timeout for Flash write operations (in ms)
3055
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003056- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003057 Timeout for Flash set sector lock bit operation (in ms)
3058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003059- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003060 Timeout for Flash clear lock bits operation (in ms)
3061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003062- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003063 If defined, hardware flash sectors protection is used
3064 instead of U-Boot software protection.
3065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003066- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003067
3068 Enable TFTP transfers directly to flash memory;
3069 without this option such a download has to be
3070 performed in two steps: (1) download to RAM, and (2)
3071 copy from RAM to flash.
3072
3073 The two-step approach is usually more reliable, since
3074 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003075 the flash, but in some situations (when system RAM is
3076 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003077 downloaded image) this option may be very useful.
3078
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003079- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003080 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003081 common flash structure for storing flash geometry.
3082
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003083- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003084 This option also enables the building of the cfi_flash driver
3085 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003086
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003087- CONFIG_FLASH_CFI_MTD
3088 This option enables the building of the cfi_mtd driver
3089 in the drivers directory. The driver exports CFI flash
3090 to the MTD layer.
3091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003092- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003093 Use buffered writes to flash.
3094
3095- CONFIG_FLASH_SPANSION_S29WS_N
3096 s29ws-n MirrorBit flash has non-standard addresses for buffered
3097 write commands.
3098
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003099- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003100 If this option is defined, the common CFI flash doesn't
3101 print it's warning upon not recognized FLASH banks. This
3102 is useful, if some of the configured banks are only
3103 optionally available.
3104
Jerry Van Barenaae73572008-03-08 13:48:01 -05003105- CONFIG_FLASH_SHOW_PROGRESS
3106 If defined (must be an integer), print out countdown
3107 digits and dots. Recommended value: 45 (9..1) for 80
3108 column displays, 15 (3..1) for 40 column displays.
3109
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003110- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003111 Defines the number of Ethernet receive buffers. On some
3112 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003113 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3114 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003115 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003116 Defaults to 4 if not defined.
3117
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003118- CONFIG_ENV_MAX_ENTRIES
3119
Wolfgang Denk1136f692010-10-27 22:48:30 +02003120 Maximum number of entries in the hash table that is used
3121 internally to store the environment settings. The default
3122 setting is supposed to be generous and should work in most
3123 cases. This setting can be used to tune behaviour; see
3124 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003125
Joe Hershberger71497d02012-12-11 22:16:31 -06003126- CONFIG_ENV_FLAGS_LIST_DEFAULT
3127- CONFIG_ENV_FLAGS_LIST_STATIC
3128 Enable validation of the values given to enviroment variables when
3129 calling env set. Variables can be restricted to only decimal,
3130 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3131 the variables can also be restricted to IP address or MAC address.
3132
3133 The format of the list is:
3134 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003135 access_atribute = [a|r|o|c]
3136 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003137 entry = variable_name[:attributes]
3138 list = entry[,list]
3139
3140 The type attributes are:
3141 s - String (default)
3142 d - Decimal
3143 x - Hexadecimal
3144 b - Boolean ([1yYtT|0nNfF])
3145 i - IP address
3146 m - MAC address
3147
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003148 The access attributes are:
3149 a - Any (default)
3150 r - Read-only
3151 o - Write-once
3152 c - Change-default
3153
Joe Hershberger71497d02012-12-11 22:16:31 -06003154 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3155 Define this to a list (string) to define the ".flags"
3156 envirnoment variable in the default or embedded environment.
3157
3158 - CONFIG_ENV_FLAGS_LIST_STATIC
3159 Define this to a list (string) to define validation that
3160 should be done if an entry is not found in the ".flags"
3161 environment variable. To override a setting in the static
3162 list, simply add an entry for the same variable name to the
3163 ".flags" variable.
3164
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003165- CONFIG_ENV_ACCESS_IGNORE_FORCE
3166 If defined, don't allow the -f switch to env set override variable
3167 access flags.
3168
wdenkc6097192002-11-03 00:24:07 +00003169The following definitions that deal with the placement and management
3170of environment data (variable area); in general, we support the
3171following configurations:
3172
Mike Frysinger63b8f122011-07-08 10:44:25 +00003173- CONFIG_BUILD_ENVCRC:
3174
3175 Builds up envcrc with the target environment so that external utils
3176 may easily extract it and embed it in final U-Boot images.
3177
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003178- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003179
3180 Define this if the environment is in flash memory.
3181
3182 a) The environment occupies one whole flash sector, which is
3183 "embedded" in the text segment with the U-Boot code. This
3184 happens usually with "bottom boot sector" or "top boot
3185 sector" type flash chips, which have several smaller
3186 sectors at the start or the end. For instance, such a
3187 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3188 such a case you would place the environment in one of the
3189 4 kB sectors - with U-Boot code before and after it. With
3190 "top boot sector" type flash chips, you would put the
3191 environment in one of the last sectors, leaving a gap
3192 between U-Boot and the environment.
3193
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003194 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003195
3196 Offset of environment data (variable area) to the
3197 beginning of flash memory; for instance, with bottom boot
3198 type flash chips the second sector can be used: the offset
3199 for this sector is given here.
3200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003201 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003202
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003203 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003204
3205 This is just another way to specify the start address of
3206 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003207 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003208
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003209 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003210
3211 Size of the sector containing the environment.
3212
3213
3214 b) Sometimes flash chips have few, equal sized, BIG sectors.
3215 In such a case you don't want to spend a whole sector for
3216 the environment.
3217
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003218 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003219
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003220 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003221 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003222 of this flash sector for the environment. This saves
3223 memory for the RAM copy of the environment.
3224
3225 It may also save flash memory if you decide to use this
3226 when your environment is "embedded" within U-Boot code,
3227 since then the remainder of the flash sector could be used
3228 for U-Boot code. It should be pointed out that this is
3229 STRONGLY DISCOURAGED from a robustness point of view:
3230 updating the environment in flash makes it always
3231 necessary to erase the WHOLE sector. If something goes
3232 wrong before the contents has been restored from a copy in
3233 RAM, your target system will be dead.
3234
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003235 - CONFIG_ENV_ADDR_REDUND
3236 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk4a5c8a72003-03-06 00:02:04 +00003238 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003239 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003240 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003241 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003242
3243BE CAREFUL! Any changes to the flash layout, and some changes to the
3244source code will make it necessary to adapt <board>/u-boot.lds*
3245accordingly!
3246
3247
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003248- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003249
3250 Define this if you have some non-volatile memory device
3251 (NVRAM, battery buffered SRAM) which you want to use for the
3252 environment.
3253
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003254 - CONFIG_ENV_ADDR:
3255 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003256
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003257 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003258 want to use for environment. It is assumed that this memory
3259 can just be read and written to, without any special
3260 provision.
3261
3262BE CAREFUL! The first access to the environment happens quite early
3263in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003264console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003265U-Boot will hang.
3266
3267Please note that even with NVRAM we still use a copy of the
3268environment in RAM: we could work on NVRAM directly, but we want to
3269keep settings there always unmodified except somebody uses "saveenv"
3270to save the current settings.
3271
3272
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003273- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003274
3275 Use this if you have an EEPROM or similar serial access
3276 device and a driver for it.
3277
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003278 - CONFIG_ENV_OFFSET:
3279 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003280
3281 These two #defines specify the offset and size of the
3282 environment area within the total memory of your EEPROM.
3283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003284 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003285 If defined, specified the chip address of the EEPROM device.
3286 The default address is zero.
3287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003288 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003289 If defined, the number of bits used to address bytes in a
3290 single page in the EEPROM device. A 64 byte page, for example
3291 would require six bits.
3292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003293 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003294 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003295 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003298 The length in bytes of the EEPROM memory array address. Note
3299 that this is NOT the chip address length!
3300
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003301 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003302 EEPROM chips that implement "address overflow" are ones
3303 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3304 address and the extra bits end up in the "chip address" bit
3305 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3306 byte chips.
3307
3308 Note that we consider the length of the address field to
3309 still be one byte because the extra address bits are hidden
3310 in the chip address.
3311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003312 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003313 The size in bytes of the EEPROM device.
3314
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003315 - CONFIG_ENV_EEPROM_IS_ON_I2C
3316 define this, if you have I2C and SPI activated, and your
3317 EEPROM, which holds the environment, is on the I2C bus.
3318
3319 - CONFIG_I2C_ENV_EEPROM_BUS
3320 if you have an Environment on an EEPROM reached over
3321 I2C muxes, you can define here, how to reach this
3322 EEPROM. For example:
3323
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003324 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003325
3326 EEPROM which holds the environment, is reached over
3327 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003328
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003329- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003330
wdenk1ebf41e2004-01-02 14:00:00 +00003331 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003332 want to use for the environment.
3333
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003334 - CONFIG_ENV_OFFSET:
3335 - CONFIG_ENV_ADDR:
3336 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003337
3338 These three #defines specify the offset and size of the
3339 environment area within the total memory of your DataFlash placed
3340 at the specified address.
3341
Liu Gang85bcd732012-03-08 00:33:20 +00003342- CONFIG_ENV_IS_IN_REMOTE:
3343
3344 Define this if you have a remote memory space which you
3345 want to use for the local device's environment.
3346
3347 - CONFIG_ENV_ADDR:
3348 - CONFIG_ENV_SIZE:
3349
3350 These two #defines specify the address and size of the
3351 environment area within the remote memory space. The
3352 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003353 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003354
3355BE CAREFUL! For some special cases, the local device can not use
3356"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003357environment stored in a remote NOR flash by SRIO or PCIE link,
3358but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003359
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003360- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003361
3362 Define this if you have a NAND device which you want to use
3363 for the environment.
3364
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003365 - CONFIG_ENV_OFFSET:
3366 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003367
3368 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003369 area within the first NAND device. CONFIG_ENV_OFFSET must be
3370 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003371
Scott Wood08239322010-09-17 14:38:37 -05003372 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003373
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003374 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003375 size used to hold a redundant copy of the environment data, so
3376 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003377 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003378 aligned to an erase block boundary.
3379
3380 - CONFIG_ENV_RANGE (optional):
3381
3382 Specifies the length of the region in which the environment
3383 can be written. This should be a multiple of the NAND device's
3384 block size. Specifying a range with more erase blocks than
3385 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3386 the range to be avoided.
3387
3388 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003389
Scott Wood08239322010-09-17 14:38:37 -05003390 Enables support for dynamically retrieving the offset of the
3391 environment from block zero's out-of-band data. The
3392 "nand env.oob" command can be used to record this offset.
3393 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3394 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003395
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003396- CONFIG_NAND_ENV_DST
3397
3398 Defines address in RAM to which the nand_spl code should copy the
3399 environment. If redundant environment is used, it will be copied to
3400 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3401
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003402- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003403
3404 Defines offset to the initial SPI buffer area in DPRAM. The
3405 area is used at an early stage (ROM part) if the environment
3406 is configured to reside in the SPI EEPROM: We need a 520 byte
3407 scratch DPRAM area. It is used between the two initialization
3408 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3409 to be a good choice since it makes it far enough from the
3410 start of the data area as well as from the stack pointer.
3411
Bruce Adleredecc942007-11-02 13:15:42 -07003412Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003413has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003414created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003415until then to read environment variables.
3416
wdenk8dba0502003-03-31 16:34:49 +00003417The environment is protected by a CRC32 checksum. Before the monitor
3418is relocated into RAM, as a result of a bad CRC you will be working
3419with the compiled-in default environment - *silently*!!! [This is
3420necessary, because the first environment variable we need is the
3421"baudrate" setting for the console - if we have a bad CRC, we don't
3422have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003423
3424Note: once the monitor has been relocated, then it will complain if
3425the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003426use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003427
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003428- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003429 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003430
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003431 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003432 also needs to be defined.
3433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003434- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003435 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003436
Ron Madriddfa028a2009-02-18 14:30:44 -08003437- CONFIG_NS16550_MIN_FUNCTIONS:
3438 Define this if you desire to only have use of the NS16550_init
3439 and NS16550_putc functions for the serial driver located at
3440 drivers/serial/ns16550.c. This option is useful for saving
3441 space for already greatly restricted images, including but not
3442 limited to NAND_SPL configurations.
3443
wdenkc6097192002-11-03 00:24:07 +00003444Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003445---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003447- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003448 Cache Line Size of the CPU.
3449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003450- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003451 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003452
wdenk9c53f402003-10-15 23:53:47 +00003453 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3454 and RPXsuper) to be able to adjust the position of
3455 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003456
Timur Tabid8f341c2011-08-04 18:03:41 -05003457- CONFIG_SYS_CCSRBAR_DEFAULT:
3458 Default (power-on reset) physical address of CCSR on Freescale
3459 PowerPC SOCs.
3460
3461- CONFIG_SYS_CCSRBAR:
3462 Virtual address of CCSR. On a 32-bit build, this is typically
3463 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3464
3465 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3466 for cross-platform code that uses that macro instead.
3467
3468- CONFIG_SYS_CCSRBAR_PHYS:
3469 Physical address of CCSR. CCSR can be relocated to a new
3470 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003471 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003472 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3473 is typically relocated on 36-bit builds. It is recommended
3474 that this macro be defined via the _HIGH and _LOW macros:
3475
3476 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3477 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3478
3479- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003480 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3481 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003482 used in assembly code, so it must not contain typecasts or
3483 integer size suffixes (e.g. "ULL").
3484
3485- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3486 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3487 used in assembly code, so it must not contain typecasts or
3488 integer size suffixes (e.g. "ULL").
3489
3490- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3491 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3492 forced to a value that ensures that CCSR is not relocated.
3493
wdenk1272e232002-11-10 22:06:23 +00003494- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003495 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003496
3497 the default drive number (default value 0)
3498
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003499 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003501 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003502 (default value 1)
3503
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003504 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003505
wdenk4a5c8a72003-03-06 00:02:04 +00003506 defines the offset of register from address. It
3507 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003508 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003510 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3511 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003512 default value.
wdenk1272e232002-11-10 22:06:23 +00003513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003514 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003515 fdc_hw_init() is called at the beginning of the FDC
3516 setup. fdc_hw_init() must be provided by the board
3517 source code. It is used to make hardware dependant
3518 initializations.
wdenk1272e232002-11-10 22:06:23 +00003519
Macpaul Lind1e49942011-04-11 20:45:32 +00003520- CONFIG_IDE_AHB:
3521 Most IDE controllers were designed to be connected with PCI
3522 interface. Only few of them were designed for AHB interface.
3523 When software is doing ATA command and data transfer to
3524 IDE devices through IDE-AHB controller, some additional
3525 registers accessing to these kind of IDE-AHB controller
3526 is requierd.
3527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003528- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003529 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003530 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003531
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003532- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003533
wdenkeb20ad32003-09-05 23:19:14 +00003534 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003535 initial data and stack; please note that this must be
3536 writable memory that is working WITHOUT special
3537 initialization, i. e. you CANNOT use normal RAM which
3538 will become available only after programming the
3539 memory controller and running certain initialization
3540 sequences.
3541
3542 U-Boot uses the following memory types:
3543 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3544 - MPC824X: data cache
3545 - PPC4xx: data cache
3546
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003547- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003548
3549 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003550 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3551 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003552 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003553 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003554 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3555 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3556 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003557
3558 Note:
3559 On the MPC824X (or other systems that use the data
3560 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003561 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003562 point to an otherwise UNUSED address space between
3563 the top of RAM and the start of the PCI space.
3564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003565- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003567- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003569- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003571- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003573- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003574
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003575- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003577- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003578 SDRAM timing
3579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003581 periodic timer for refresh
3582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003583- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003584
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003585- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3586 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3587 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3588 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003589 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3590
3591- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003592 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3593 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003594 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003596- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3597 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003598 Machine Mode Register and Memory Periodic Timer
3599 Prescaler definitions (SDRAM timing)
3600
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003601- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003602 enable I2C microcode relocation patch (MPC8xx);
3603 define relocation offset in DPRAM [DSP2]
3604
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003605- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003606 enable SMC microcode relocation patch (MPC8xx);
3607 define relocation offset in DPRAM [SMC1]
3608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003609- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003610 enable SPI microcode relocation patch (MPC8xx);
3611 define relocation offset in DPRAM [SCC4]
3612
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003613- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003614 Use OSCM clock mode on MBX8xx board. Be careful,
3615 wrong setting might damage your board. Read
3616 doc/README.MBX before setting this variable!
3617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003618- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003619 Offset of the bootmode word in DPRAM used by post
3620 (Power On Self Tests). This definition overrides
3621 #define'd default value in commproc.h resp.
3622 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003623
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003624- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3625 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3626 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3627 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3628 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3629 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3630 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3631 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003632 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003633
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003634- CONFIG_PCI_DISABLE_PCIE:
3635 Disable PCI-Express on systems where it is supported but not
3636 required.
3637
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003638- CONFIG_PCI_ENUM_ONLY
3639 Only scan through and get the devices on the busses.
3640 Don't do any setup work, presumably because someone or
3641 something has already done it, and we don't need to do it
3642 a second time. Useful for platforms that are pre-booted
3643 by coreboot or similar.
3644
Kumar Gala8975d7a2010-12-30 12:09:53 -06003645- CONFIG_SYS_SRIO:
3646 Chip has SRIO or not
3647
3648- CONFIG_SRIO1:
3649 Board has SRIO 1 port available
3650
3651- CONFIG_SRIO2:
3652 Board has SRIO 2 port available
3653
3654- CONFIG_SYS_SRIOn_MEM_VIRT:
3655 Virtual Address of SRIO port 'n' memory region
3656
3657- CONFIG_SYS_SRIOn_MEM_PHYS:
3658 Physical Address of SRIO port 'n' memory region
3659
3660- CONFIG_SYS_SRIOn_MEM_SIZE:
3661 Size of SRIO port 'n' memory region
3662
Alex Watermancd6aae32011-05-19 15:08:36 -04003663- CONFIG_SYS_NDFC_16
3664 Defined to tell the NDFC that the NAND chip is using a
3665 16 bit bus.
3666
3667- CONFIG_SYS_NDFC_EBC0_CFG
3668 Sets the EBC0_CFG register for the NDFC. If not defined
3669 a default value will be used.
3670
Ben Warren45657152006-09-07 16:50:54 -04003671- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003672 Get DDR timing information from an I2C EEPROM. Common
3673 with pluggable memory modules such as SODIMMs
3674
Ben Warren45657152006-09-07 16:50:54 -04003675 SPD_EEPROM_ADDRESS
3676 I2C address of the SPD EEPROM
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003679 If SPD EEPROM is on an I2C bus other than the first
3680 one, specify here. Note that the value must resolve
3681 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003682
York Sune73cc042011-06-07 09:42:16 +08003683- CONFIG_SYS_DDR_RAW_TIMING
3684 Get DDR timing information from other than SPD. Common with
3685 soldered DDR chips onboard without SPD. DDR raw timing
3686 parameters are extracted from datasheet and hard-coded into
3687 header files or board specific files.
3688
York Sunbd495cf2011-09-16 13:21:35 -07003689- CONFIG_FSL_DDR_INTERACTIVE
3690 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3691
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003692- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003693 Only for 83xx systems. If specified, then DDR should
3694 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003695
wdenk6203e402004-04-18 10:13:26 +00003696- CONFIG_ETHER_ON_FEC[12]
3697 Define to enable FEC[12] on a 8xx series processor.
3698
3699- CONFIG_FEC[12]_PHY
3700 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003701 to the given FEC; i. e.
3702 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003703 means that the PHY with address 4 is connected to FEC1
3704
3705 When set to -1, means to probe for first available.
3706
3707- CONFIG_FEC[12]_PHY_NORXERR
3708 The PHY does not have a RXERR line (RMII only).
3709 (so program the FEC to ignore it).
3710
3711- CONFIG_RMII
3712 Enable RMII mode for all FECs.
3713 Note that this is a global option, we can't
3714 have one FEC in standard MII mode and another in RMII mode.
3715
wdenk20c98a62004-04-23 20:32:05 +00003716- CONFIG_CRC32_VERIFY
3717 Add a verify option to the crc32 command.
3718 The syntax is:
3719
3720 => crc32 -v <address> <count> <crc32>
3721
3722 Where address/count indicate a memory area
3723 and crc32 is the correct crc32 which the
3724 area should have.
3725
wdenk64519362004-07-11 17:40:54 +00003726- CONFIG_LOOPW
3727 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003728 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003729
stroesecc3af832004-12-16 18:46:55 +00003730- CONFIG_MX_CYCLIC
3731 Add the "mdc" and "mwc" memory commands. These are cyclic
3732 "md/mw" commands.
3733 Examples:
3734
wdenk07d7e6b2004-12-16 21:44:03 +00003735 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003736 This command will print 4 bytes (10,11,12,13) each 500 ms.
3737
wdenk07d7e6b2004-12-16 21:44:03 +00003738 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003739 This command will write 12345678 to address 100 all 10 ms.
3740
wdenk07d7e6b2004-12-16 21:44:03 +00003741 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003742 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003743
wdenk3d3d99f2005-04-04 12:44:11 +00003744- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003745 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003746 low level initializations (like setting up the memory
3747 controller) are omitted and/or U-Boot does not
3748 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003749
Wolfgang Denk302141d2010-11-27 23:30:56 +01003750 Normally this variable MUST NOT be defined. The only
3751 exception is when U-Boot is loaded (to RAM) by some
3752 other boot loader or by a debugger which performs
3753 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003754
Aneesh V552a3192011-07-13 05:11:07 +00003755- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003756 Modifies the behaviour of start.S when compiling a loader
3757 that is executed before the actual U-Boot. E.g. when
3758 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003759
Matthias Weisser93416c12011-03-10 21:36:32 +00003760- CONFIG_USE_ARCH_MEMCPY
3761 CONFIG_USE_ARCH_MEMSET
3762 If these options are used a optimized version of memcpy/memset will
3763 be used if available. These functions may be faster under some
3764 conditions but may increase the binary size.
3765
Gabe Black14f82462012-11-27 21:08:06 +00003766- CONFIG_X86_NO_RESET_VECTOR
3767 If defined, the x86 reset vector code is excluded. You will need
3768 to do this when U-Boot is running from Coreboot.
3769
Gabe Black76ce2492012-11-29 16:23:41 +00003770- CONFIG_X86_NO_REAL_MODE
3771 If defined, x86 real mode code is omitted. This assumes a
3772 32-bit environment where such code is not needed. You will
3773 need to do this when U-Boot is running from Coreboot.
3774
3775
Timur Tabi275f4bb2011-11-22 09:21:25 -06003776Freescale QE/FMAN Firmware Support:
3777-----------------------------------
3778
3779The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3780loading of "firmware", which is encoded in the QE firmware binary format.
3781This firmware often needs to be loaded during U-Boot booting, so macros
3782are used to identify the storage device (NOR flash, SPI, etc) and the address
3783within that device.
3784
3785- CONFIG_SYS_QE_FMAN_FW_ADDR
3786 The address in the storage device where the firmware is located. The
3787 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3788 is also specified.
3789
3790- CONFIG_SYS_QE_FMAN_FW_LENGTH
3791 The maximum possible size of the firmware. The firmware binary format
3792 has a field that specifies the actual size of the firmware, but it
3793 might not be possible to read any part of the firmware unless some
3794 local storage is allocated to hold the entire firmware first.
3795
3796- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3797 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3798 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3799 virtual address in NOR flash.
3800
3801- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3802 Specifies that QE/FMAN firmware is located in NAND flash.
3803 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3804
3805- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3806 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3807 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3808
3809- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3810 Specifies that QE/FMAN firmware is located on the primary SPI
3811 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3812
Liu Gang1e084582012-03-08 00:33:18 +00003813- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3814 Specifies that QE/FMAN firmware is located in the remote (master)
3815 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003816 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3817 window->master inbound window->master LAW->the ucode address in
3818 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003819
wdenkc6097192002-11-03 00:24:07 +00003820Building the Software:
3821======================
3822
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003823Building U-Boot has been tested in several native build environments
3824and in many different cross environments. Of course we cannot support
3825all possibly existing versions of cross development tools in all
3826(potentially obsolete) versions. In case of tool chain problems we
3827recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3828which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003829
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003830If you are not using a native environment, it is assumed that you
3831have GNU cross compiling tools available in your path. In this case,
3832you must set the environment variable CROSS_COMPILE in your shell.
3833Note that no changes to the Makefile or any other source files are
3834necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003835
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003836 $ CROSS_COMPILE=ppc_4xx-
3837 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003838
Peter Tyserb06976d2009-03-13 18:54:51 -05003839Note: If you wish to generate Windows versions of the utilities in
3840 the tools directory you can use the MinGW toolchain
3841 (http://www.mingw.org). Set your HOST tools to the MinGW
3842 toolchain and execute 'make tools'. For example:
3843
3844 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3845
3846 Binaries such as tools/mkimage.exe will be created which can
3847 be executed on computers running Windows.
3848
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003849U-Boot is intended to be simple to build. After installing the
3850sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003851is done by typing:
3852
3853 make NAME_config
3854
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003855where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003856rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003857
wdenk6c59edc2004-05-03 20:45:30 +00003858Note: for some board special configuration names may exist; check if
3859 additional information is available from the board vendor; for
3860 instance, the TQM823L systems are available without (standard)
3861 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003862 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk6c59edc2004-05-03 20:45:30 +00003864 make TQM823L_config
3865 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk6c59edc2004-05-03 20:45:30 +00003867 make TQM823L_LCD_config
3868 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk6c59edc2004-05-03 20:45:30 +00003870 etc.
wdenkc6097192002-11-03 00:24:07 +00003871
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk6c59edc2004-05-03 20:45:30 +00003873Finally, type "make all", and you should get some working U-Boot
3874images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk6c59edc2004-05-03 20:45:30 +00003876- "u-boot.bin" is a raw binary image
3877- "u-boot" is an image in ELF binary format
3878- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003879
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003880By default the build is performed locally and the objects are saved
3881in the source directory. One of the two methods can be used to change
3882this behavior and build U-Boot to some external directory:
3883
38841. Add O= to the make command line invocations:
3885
3886 make O=/tmp/build distclean
3887 make O=/tmp/build NAME_config
3888 make O=/tmp/build all
3889
38902. Set environment variable BUILD_DIR to point to the desired location:
3891
3892 export BUILD_DIR=/tmp/build
3893 make distclean
3894 make NAME_config
3895 make all
3896
3897Note that the command line "O=" setting overrides the BUILD_DIR environment
3898variable.
3899
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk6c59edc2004-05-03 20:45:30 +00003901Please be aware that the Makefiles assume you are using GNU make, so
3902for instance on NetBSD you might need to use "gmake" instead of
3903native "make".
wdenkc6097192002-11-03 00:24:07 +00003904
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk6c59edc2004-05-03 20:45:30 +00003906If the system board that you have is not listed, then you will need
3907to port U-Boot to your hardware platform. To do this, follow these
3908steps:
wdenkc6097192002-11-03 00:24:07 +00003909
wdenk6c59edc2004-05-03 20:45:30 +000039101. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003911 "boards.cfg" file, using the existing entries as examples.
3912 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000039132. Create a new directory to hold your board specific code. Add any
3914 files you need. In your board directory, you will need at least
3915 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
39163. Create a new configuration file "include/configs/<board>.h" for
3917 your board
39183. If you're porting U-Boot to a new CPU, then also create a new
3919 directory to hold your CPU specific code. Add any files you need.
39204. Run "make <board>_config" with your new name.
39215. Type "make", and you should get a working "u-boot.srec" file
3922 to be installed on your target system.
39236. Debug and solve any problems that might arise.
3924 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003925
wdenkc6097192002-11-03 00:24:07 +00003926
wdenk6c59edc2004-05-03 20:45:30 +00003927Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3928==============================================================
wdenkc6097192002-11-03 00:24:07 +00003929
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003930If you have modified U-Boot sources (for instance added a new board
3931or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003932provide feedback to the other developers. The feedback normally takes
3933the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003934official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003935
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003936But before you submit such a patch, please verify that your modifi-
3937cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00003938the supported boards compile WITHOUT ANY compiler warnings. To do so,
3939just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003940for ALL supported system. Be warned, this will take a while. You can
3941select which (cross) compiler to use by passing a `CROSS_COMPILE'
3942environment variable to the script, i. e. to use the ELDK cross tools
3943you can type
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk6c59edc2004-05-03 20:45:30 +00003945 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk6c59edc2004-05-03 20:45:30 +00003947or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003948
wdenk6c59edc2004-05-03 20:45:30 +00003949 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003950
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003951When using the MAKEALL script, the default behaviour is to build
3952U-Boot in the source directory. This location can be changed by
3953setting the BUILD_DIR environment variable. Also, for each target
3954built, the MAKEALL script saves two log files (<target>.ERR and
3955<target>.MAKEALL) in the <source dir>/LOG directory. This default
3956location can be changed by setting the MAKEALL_LOGDIR environment
3957variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003958
3959 export BUILD_DIR=/tmp/build
3960 export MAKEALL_LOGDIR=/tmp/log
3961 CROSS_COMPILE=ppc_8xx- MAKEALL
3962
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003963With the above settings build objects are saved in the /tmp/build,
3964log files are saved in the /tmp/log and the source tree remains clean
3965during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003966
3967
wdenk6c59edc2004-05-03 20:45:30 +00003968See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003969
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk6c59edc2004-05-03 20:45:30 +00003971Monitor Commands - Overview:
3972============================
wdenkc6097192002-11-03 00:24:07 +00003973
wdenk6c59edc2004-05-03 20:45:30 +00003974go - start application at address 'addr'
3975run - run commands in an environment variable
3976bootm - boot application image from memory
3977bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003978bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00003979tftpboot- boot image via network using TFTP protocol
3980 and env variables "ipaddr" and "serverip"
3981 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00003982tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00003983rarpboot- boot image via network using RARP/TFTP protocol
3984diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3985loads - load S-Record file over serial line
3986loadb - load binary file over serial line (kermit mode)
3987md - memory display
3988mm - memory modify (auto-incrementing)
3989nm - memory modify (constant address)
3990mw - memory write (fill)
3991cp - memory copy
3992cmp - memory compare
3993crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05003994i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00003995sspi - SPI utility commands
3996base - print or set address offset
3997printenv- print environment variables
3998setenv - set environment variables
3999saveenv - save environment variables to persistent storage
4000protect - enable or disable FLASH write protection
4001erase - erase FLASH memory
4002flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004003nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004004bdinfo - print Board Info structure
4005iminfo - print header information for application image
4006coninfo - print console devices and informations
4007ide - IDE sub-system
4008loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004009loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004010mtest - simple RAM test
4011icache - enable or disable instruction cache
4012dcache - enable or disable data cache
4013reset - Perform RESET of the CPU
4014echo - echo args to console
4015version - print monitor version
4016help - print online help
4017? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004018
wdenkc6097192002-11-03 00:24:07 +00004019
wdenk6c59edc2004-05-03 20:45:30 +00004020Monitor Commands - Detailed Description:
4021========================================
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk6c59edc2004-05-03 20:45:30 +00004023TODO.
wdenkc6097192002-11-03 00:24:07 +00004024
wdenk6c59edc2004-05-03 20:45:30 +00004025For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004026
4027
wdenk6c59edc2004-05-03 20:45:30 +00004028Environment Variables:
4029======================
wdenkc6097192002-11-03 00:24:07 +00004030
wdenk6c59edc2004-05-03 20:45:30 +00004031U-Boot supports user configuration using Environment Variables which
4032can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk6c59edc2004-05-03 20:45:30 +00004034Environment Variables are set using "setenv", printed using
4035"printenv", and saved to Flash using "saveenv". Using "setenv"
4036without a value can be used to delete a variable from the
4037environment. As long as you don't save the environment you are
4038working with an in-memory copy. In case the Flash area containing the
4039environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004040
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004041Some configuration options can be set using Environment Variables.
4042
4043List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004044
wdenk6c59edc2004-05-03 20:45:30 +00004045 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004046
wdenk6c59edc2004-05-03 20:45:30 +00004047 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004048
wdenk6c59edc2004-05-03 20:45:30 +00004049 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk6c59edc2004-05-03 20:45:30 +00004051 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004052
wdenk6c59edc2004-05-03 20:45:30 +00004053 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004054
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004055 bootm_low - Memory range available for image processing in the bootm
4056 command can be restricted. This variable is given as
4057 a hexadecimal number and defines lowest address allowed
4058 for use by the bootm command. See also "bootm_size"
4059 environment variable. Address defined by "bootm_low" is
4060 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004061 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4062 bootm_mapsize.
4063
Wolfgang Denk092ae952011-10-26 10:21:21 +00004064 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004065 This variable is given as a hexadecimal number and it
4066 defines the size of the memory region starting at base
4067 address bootm_low that is accessible by the Linux kernel
4068 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4069 as the default value if it is defined, and bootm_size is
4070 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004071
4072 bootm_size - Memory range available for image processing in the bootm
4073 command can be restricted. This variable is given as
4074 a hexadecimal number and defines the size of the region
4075 allowed for use by the bootm command. See also "bootm_low"
4076 environment variable.
4077
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004078 updatefile - Location of the software update file on a TFTP server, used
4079 by the automatic software update feature. Please refer to
4080 documentation in doc/README.update for more details.
4081
wdenk6c59edc2004-05-03 20:45:30 +00004082 autoload - if set to "no" (any string beginning with 'n'),
4083 "bootp" will just load perform a lookup of the
4084 configuration from the BOOTP server, but not try to
4085 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk6c59edc2004-05-03 20:45:30 +00004087 autostart - if set to "yes", an image loaded using the "bootp",
4088 "rarpboot", "tftpboot" or "diskboot" commands will
4089 be automatically started (by internally calling
4090 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk6c59edc2004-05-03 20:45:30 +00004092 If set to "no", a standalone image passed to the
4093 "bootm" command will be copied to the load address
4094 (and eventually uncompressed), but NOT be started.
4095 This can be used to load and uncompress arbitrary
4096 data.
wdenkc6097192002-11-03 00:24:07 +00004097
David A. Longd558a4e2011-07-09 16:40:19 -04004098 fdt_high - if set this restricts the maximum address that the
4099 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004100 For example, if you have a system with 1 GB memory
4101 at physical address 0x10000000, while Linux kernel
4102 only recognizes the first 704 MB as low memory, you
4103 may need to set fdt_high as 0x3C000000 to have the
4104 device tree blob be copied to the maximum address
4105 of the 704 MB low memory, so that Linux kernel can
4106 access it during the boot procedure.
4107
David A. Longd558a4e2011-07-09 16:40:19 -04004108 If this is set to the special value 0xFFFFFFFF then
4109 the fdt will not be copied at all on boot. For this
4110 to work it must reside in writable memory, have
4111 sufficient padding on the end of it for u-boot to
4112 add the information it needs into it, and the memory
4113 must be accessible by the kernel.
4114
Simon Glassdc6fa642011-10-24 19:15:34 +00004115 fdtcontroladdr- if set this is the address of the control flattened
4116 device tree used by U-Boot when CONFIG_OF_CONTROL is
4117 defined.
4118
wdenk0e2bd9c2004-06-06 21:51:03 +00004119 i2cfast - (PPC405GP|PPC405EP only)
4120 if set to 'y' configures Linux I2C driver for fast
4121 mode (400kHZ). This environment variable is used in
4122 initialization code. So, for changes to be effective
4123 it must be saved and board must be reset.
4124
wdenk6c59edc2004-05-03 20:45:30 +00004125 initrd_high - restrict positioning of initrd images:
4126 If this variable is not set, initrd images will be
4127 copied to the highest possible address in RAM; this
4128 is usually what you want since it allows for
4129 maximum initrd size. If for some reason you want to
4130 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004131 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004132 variable to a value of "no" or "off" or "0".
4133 Alternatively, you can set it to a maximum upper
4134 address to use (U-Boot will still check that it
4135 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk6c59edc2004-05-03 20:45:30 +00004137 For instance, when you have a system with 16 MB
4138 RAM, and want to reserve 4 MB from use by Linux,
4139 you can do this by adding "mem=12M" to the value of
4140 the "bootargs" variable. However, now you must make
4141 sure that the initrd image is placed in the first
4142 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004143
wdenk6c59edc2004-05-03 20:45:30 +00004144 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk6c59edc2004-05-03 20:45:30 +00004146 If you set initrd_high to 0xFFFFFFFF, this is an
4147 indication to U-Boot that all addresses are legal
4148 for the Linux kernel, including addresses in flash
4149 memory. In this case U-Boot will NOT COPY the
4150 ramdisk at all. This may be useful to reduce the
4151 boot time on your system, but requires that this
4152 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004153
wdenk6c59edc2004-05-03 20:45:30 +00004154 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk6c59edc2004-05-03 20:45:30 +00004156 loadaddr - Default load address for commands like "bootp",
4157 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk6c59edc2004-05-03 20:45:30 +00004159 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004160
wdenk6c59edc2004-05-03 20:45:30 +00004161 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004162
wdenk6c59edc2004-05-03 20:45:30 +00004163 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004164
wdenk6c59edc2004-05-03 20:45:30 +00004165 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004166
wdenk6c59edc2004-05-03 20:45:30 +00004167 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004168
Mike Frysingera23230c2011-10-02 10:01:27 +00004169 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004170
Mike Frysingera23230c2011-10-02 10:01:27 +00004171 ethact - controls which interface is currently active.
4172 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004173
Heiko Schocherc5e84052010-07-20 17:45:02 +02004174 => setenv ethact FEC
4175 => ping 192.168.0.1 # traffic sent on FEC
4176 => setenv ethact SCC
4177 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004178
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004179 ethrotate - When set to "no" U-Boot does not go through all
4180 available network interfaces.
4181 It just stays at the currently selected interface.
4182
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004183 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004184 either succeed or fail without retrying.
4185 When set to "once" the network operation will
4186 fail when all the available network interfaces
4187 are tried once without success.
4188 Useful on scripts which control the retry operation
4189 themselves.
wdenkc6097192002-11-03 00:24:07 +00004190
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004191 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004192
Wolfgang Denk227b5192005-09-24 23:25:46 +02004193 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004194 UDP source port.
4195
Wolfgang Denk227b5192005-09-24 23:25:46 +02004196 tftpdstport - If this is set, the value is used for TFTP's UDP
4197 destination port instead of the Well Know Port 69.
4198
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004199 tftpblocksize - Block size to use for TFTP transfers; if not set,
4200 we use the TFTP server's default block size
4201
4202 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4203 seconds, minimum value is 1000 = 1 second). Defines
4204 when a packet is considered to be lost so it has to
4205 be retransmitted. The default is 5000 = 5 seconds.
4206 Lowering this value may make downloads succeed
4207 faster in networks with high packet loss rates or
4208 with unreliable TFTP servers.
4209
4210 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004211 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004212 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004213
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004214The following image location variables contain the location of images
4215used in booting. The "Image" column gives the role of the image and is
4216not an environment variable name. The other columns are environment
4217variable names. "File Name" gives the name of the file on a TFTP
4218server, "RAM Address" gives the location in RAM the image will be
4219loaded to, and "Flash Location" gives the image's address in NOR
4220flash or offset in NAND flash.
4221
4222*Note* - these variables don't have to be defined for all boards, some
4223boards currenlty use other variables for these purposes, and some
4224boards use these variables for other purposes.
4225
Wolfgang Denk092ae952011-10-26 10:21:21 +00004226Image File Name RAM Address Flash Location
4227----- --------- ----------- --------------
4228u-boot u-boot u-boot_addr_r u-boot_addr
4229Linux kernel bootfile kernel_addr_r kernel_addr
4230device tree blob fdtfile fdt_addr_r fdt_addr
4231ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004232
wdenk6c59edc2004-05-03 20:45:30 +00004233The following environment variables may be used and automatically
4234updated by the network boot commands ("bootp" and "rarpboot"),
4235depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004236
wdenk6c59edc2004-05-03 20:45:30 +00004237 bootfile - see above
4238 dnsip - IP address of your Domain Name Server
4239 dnsip2 - IP address of your secondary Domain Name Server
4240 gatewayip - IP address of the Gateway (Router) to use
4241 hostname - Target hostname
4242 ipaddr - see above
4243 netmask - Subnet Mask
4244 rootpath - Pathname of the root filesystem on the NFS server
4245 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004246
wdenk145d2c12004-04-15 21:48:45 +00004247
wdenk6c59edc2004-05-03 20:45:30 +00004248There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk6c59edc2004-05-03 20:45:30 +00004250 serial# - contains hardware identification information such
4251 as type string and/or serial number
4252 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004253
wdenk6c59edc2004-05-03 20:45:30 +00004254These variables can be set only once (usually during manufacturing of
4255the board). U-Boot refuses to delete or overwrite these variables
4256once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004257
4258
wdenk6c59edc2004-05-03 20:45:30 +00004259Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk6c59edc2004-05-03 20:45:30 +00004261 ver - Contains the U-Boot version string as printed
4262 with the "version" command. This variable is
4263 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004264
wdenkc6097192002-11-03 00:24:07 +00004265
wdenk6c59edc2004-05-03 20:45:30 +00004266Please note that changes to some configuration parameters may take
4267only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004268
stroeseb9c17c52003-04-04 15:53:41 +00004269
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004270Callback functions for environment variables:
4271---------------------------------------------
4272
4273For some environment variables, the behavior of u-boot needs to change
4274when their values are changed. This functionailty allows functions to
4275be associated with arbitrary variables. On creation, overwrite, or
4276deletion, the callback will provide the opportunity for some side
4277effect to happen or for the change to be rejected.
4278
4279The callbacks are named and associated with a function using the
4280U_BOOT_ENV_CALLBACK macro in your board or driver code.
4281
4282These callbacks are associated with variables in one of two ways. The
4283static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4284in the board configuration to a string that defines a list of
4285associations. The list must be in the following format:
4286
4287 entry = variable_name[:callback_name]
4288 list = entry[,list]
4289
4290If the callback name is not specified, then the callback is deleted.
4291Spaces are also allowed anywhere in the list.
4292
4293Callbacks can also be associated by defining the ".callbacks" variable
4294with the same list format above. Any association in ".callbacks" will
4295override any association in the static list. You can define
4296CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4297".callbacks" envirnoment variable in the default or embedded environment.
4298
4299
wdenk6c59edc2004-05-03 20:45:30 +00004300Command Line Parsing:
4301=====================
stroeseb9c17c52003-04-04 15:53:41 +00004302
wdenk6c59edc2004-05-03 20:45:30 +00004303There are two different command line parsers available with U-Boot:
4304the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk6c59edc2004-05-03 20:45:30 +00004306Old, simple command line parser:
4307--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004308
wdenk6c59edc2004-05-03 20:45:30 +00004309- supports environment variables (through setenv / saveenv commands)
4310- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004311- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004312- special characters ('$', ';') can be escaped by prefixing with '\',
4313 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004314 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004315- You can also escape text by enclosing in single apostrophes, for example:
4316 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004317
wdenk6c59edc2004-05-03 20:45:30 +00004318Hush shell:
4319-----------
wdenkf4688a22003-05-28 08:06:31 +00004320
wdenk6c59edc2004-05-03 20:45:30 +00004321- similar to Bourne shell, with control structures like
4322 if...then...else...fi, for...do...done; while...do...done,
4323 until...do...done, ...
4324- supports environment ("global") variables (through setenv / saveenv
4325 commands) and local shell variables (through standard shell syntax
4326 "name=value"); only environment variables can be used with "run"
4327 command
wdenkf4688a22003-05-28 08:06:31 +00004328
wdenk6c59edc2004-05-03 20:45:30 +00004329General rules:
4330--------------
wdenkf4688a22003-05-28 08:06:31 +00004331
wdenk6c59edc2004-05-03 20:45:30 +00004332(1) If a command line (or an environment variable executed by a "run"
4333 command) contains several commands separated by semicolon, and
4334 one of these commands fails, then the remaining commands will be
4335 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004336
wdenk6c59edc2004-05-03 20:45:30 +00004337(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004338 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004339 command will cause "run" to terminate, i. e. the remaining
4340 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004341
wdenk6c59edc2004-05-03 20:45:30 +00004342Note for Redundant Ethernet Interfaces:
4343=======================================
wdenkf4688a22003-05-28 08:06:31 +00004344
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004345Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004346such configurations and is capable of automatic selection of a
4347"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004348
wdenk6c59edc2004-05-03 20:45:30 +00004349Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4350MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4351"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004352
wdenk6c59edc2004-05-03 20:45:30 +00004353If the network interface stores some valid MAC address (for instance
4354in SROM), this is used as default address if there is NO correspon-
4355ding setting in the environment; if the corresponding environment
4356variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004357
wdenk6c59edc2004-05-03 20:45:30 +00004358o If the SROM has a valid MAC address, and there is no address in the
4359 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004360
wdenk6c59edc2004-05-03 20:45:30 +00004361o If there is no valid address in the SROM, and a definition in the
4362 environment exists, then the value from the environment variable is
4363 used.
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk6c59edc2004-05-03 20:45:30 +00004365o If both the SROM and the environment contain a MAC address, and
4366 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004367
wdenk6c59edc2004-05-03 20:45:30 +00004368o If both the SROM and the environment contain a MAC address, and the
4369 addresses differ, the value from the environment is used and a
4370 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk6c59edc2004-05-03 20:45:30 +00004372o If neither SROM nor the environment contain a MAC address, an error
4373 is raised.
wdenkc6097192002-11-03 00:24:07 +00004374
Ben Warren6db991a2010-04-26 11:11:46 -07004375If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004376will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004377may be skipped by setting the appropriate 'ethmacskip' environment variable.
4378The naming convention is as follows:
4379"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk6c59edc2004-05-03 20:45:30 +00004381Image Formats:
4382==============
wdenkc6097192002-11-03 00:24:07 +00004383
Marian Balakowicz18710b82008-03-12 12:13:13 +01004384U-Boot is capable of booting (and performing other auxiliary operations on)
4385images in two formats:
4386
4387New uImage format (FIT)
4388-----------------------
4389
4390Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4391to Flattened Device Tree). It allows the use of images with multiple
4392components (several kernels, ramdisks, etc.), with contents protected by
4393SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4394
4395
4396Old uImage format
4397-----------------
4398
4399Old image format is based on binary files which can be basically anything,
4400preceded by a special header; see the definitions in include/image.h for
4401details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk6c59edc2004-05-03 20:45:30 +00004403* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4404 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004405 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4406 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4407 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004408* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004409 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4410 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004411* Compression Type (uncompressed, gzip, bzip2)
4412* Load Address
4413* Entry Point
4414* Image Name
4415* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004416
wdenk6c59edc2004-05-03 20:45:30 +00004417The header is marked by a special Magic Number, and both the header
4418and the data portions of the image are secured against corruption by
4419CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004420
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk6c59edc2004-05-03 20:45:30 +00004422Linux Support:
4423==============
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425Although U-Boot should support any OS or standalone application
4426easily, the main focus has always been on Linux during the design of
4427U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk6c59edc2004-05-03 20:45:30 +00004429U-Boot includes many features that so far have been part of some
4430special "boot loader" code within the Linux kernel. Also, any
4431"initrd" images to be used are no longer part of one big Linux image;
4432instead, kernel and "initrd" are separate images. This implementation
4433serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004434
wdenk6c59edc2004-05-03 20:45:30 +00004435- the same features can be used for other OS or standalone
4436 applications (for instance: using compressed images to reduce the
4437 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk6c59edc2004-05-03 20:45:30 +00004439- it becomes much easier to port new Linux kernel versions because
4440 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk6c59edc2004-05-03 20:45:30 +00004442- the same Linux kernel image can now be used with different "initrd"
4443 images; of course this also means that different kernel images can
4444 be run with the same "initrd". This makes testing easier (you don't
4445 have to build a new "zImage.initrd" Linux image when you just
4446 change a file in your "initrd"). Also, a field-upgrade of the
4447 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004448
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk6c59edc2004-05-03 20:45:30 +00004450Linux HOWTO:
4451============
wdenkc6097192002-11-03 00:24:07 +00004452
wdenk6c59edc2004-05-03 20:45:30 +00004453Porting Linux to U-Boot based systems:
4454---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004455
wdenk6c59edc2004-05-03 20:45:30 +00004456U-Boot cannot save you from doing all the necessary modifications to
4457configure the Linux device drivers for use with your target hardware
4458(no, we don't intend to provide a full virtual machine interface to
4459Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004460
Stefan Roese88fbf932010-04-15 16:07:28 +02004461But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004462
wdenk6c59edc2004-05-03 20:45:30 +00004463Just make sure your machine specific header file (for instance
4464include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004465Information structure as we define in include/asm-<arch>/u-boot.h,
4466and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004467as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004468
wdenkc6097192002-11-03 00:24:07 +00004469
wdenk6c59edc2004-05-03 20:45:30 +00004470Configuring the Linux kernel:
4471-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk6c59edc2004-05-03 20:45:30 +00004473No specific requirements for U-Boot. Make sure you have some root
4474device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004475
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk6c59edc2004-05-03 20:45:30 +00004477Building a Linux Image:
4478-----------------------
wdenkc6097192002-11-03 00:24:07 +00004479
wdenk6c59edc2004-05-03 20:45:30 +00004480With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4481not used. If you use recent kernel source, a new build target
4482"uImage" will exist which automatically builds an image usable by
4483U-Boot. Most older kernels also have support for a "pImage" target,
4484which was introduced for our predecessor project PPCBoot and uses a
4485100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk6c59edc2004-05-03 20:45:30 +00004487Example:
wdenkc6097192002-11-03 00:24:07 +00004488
wdenk6c59edc2004-05-03 20:45:30 +00004489 make TQM850L_config
4490 make oldconfig
4491 make dep
4492 make uImage
wdenkc6097192002-11-03 00:24:07 +00004493
wdenk6c59edc2004-05-03 20:45:30 +00004494The "uImage" build target uses a special tool (in 'tools/mkimage') to
4495encapsulate a compressed Linux kernel image with header information,
4496CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004497
wdenk6c59edc2004-05-03 20:45:30 +00004498* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004499
wdenk6c59edc2004-05-03 20:45:30 +00004500* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk6c59edc2004-05-03 20:45:30 +00004502 ${CROSS_COMPILE}-objcopy -O binary \
4503 -R .note -R .comment \
4504 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004505
wdenk6c59edc2004-05-03 20:45:30 +00004506* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004507
wdenk6c59edc2004-05-03 20:45:30 +00004508 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004509
wdenk6c59edc2004-05-03 20:45:30 +00004510* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004511
wdenk6c59edc2004-05-03 20:45:30 +00004512 mkimage -A ppc -O linux -T kernel -C gzip \
4513 -a 0 -e 0 -n "Linux Kernel Image" \
4514 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004515
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517The "mkimage" tool can also be used to create ramdisk images for use
4518with U-Boot, either separated from the Linux kernel image, or
4519combined into one file. "mkimage" encapsulates the images with a 64
4520byte header containing information about target architecture,
4521operating system, image type, compression method, entry points, time
4522stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk6c59edc2004-05-03 20:45:30 +00004524"mkimage" can be called in two ways: to verify existing images and
4525print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004526
wdenk6c59edc2004-05-03 20:45:30 +00004527In the first form (with "-l" option) mkimage lists the information
4528contained in the header of an existing U-Boot image; this includes
4529checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004530
wdenk6c59edc2004-05-03 20:45:30 +00004531 tools/mkimage -l image
4532 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004533
wdenk6c59edc2004-05-03 20:45:30 +00004534The second form (with "-d" option) is used to build a U-Boot image
4535from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004536
wdenk6c59edc2004-05-03 20:45:30 +00004537 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4538 -n name -d data_file image
4539 -A ==> set architecture to 'arch'
4540 -O ==> set operating system to 'os'
4541 -T ==> set image type to 'type'
4542 -C ==> set compression type 'comp'
4543 -a ==> set load address to 'addr' (hex)
4544 -e ==> set entry point to 'ep' (hex)
4545 -n ==> set image name to 'name'
4546 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004547
wdenkcd914452004-05-29 16:53:29 +00004548Right now, all Linux kernels for PowerPC systems use the same load
4549address (0x00000000), but the entry point address depends on the
4550kernel version:
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk6c59edc2004-05-03 20:45:30 +00004552- 2.2.x kernels have the entry point at 0x0000000C,
4553- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk6c59edc2004-05-03 20:45:30 +00004555So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004556
wdenk6c59edc2004-05-03 20:45:30 +00004557 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4558 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004559 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004560 > examples/uImage.TQM850L
4561 Image Name: 2.4.4 kernel for TQM850L
4562 Created: Wed Jul 19 02:34:59 2000
4563 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4564 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4565 Load Address: 0x00000000
4566 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004567
wdenk6c59edc2004-05-03 20:45:30 +00004568To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004569
wdenk6c59edc2004-05-03 20:45:30 +00004570 -> tools/mkimage -l examples/uImage.TQM850L
4571 Image Name: 2.4.4 kernel for TQM850L
4572 Created: Wed Jul 19 02:34:59 2000
4573 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4574 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4575 Load Address: 0x00000000
4576 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004577
wdenk6c59edc2004-05-03 20:45:30 +00004578NOTE: for embedded systems where boot time is critical you can trade
4579speed for memory and install an UNCOMPRESSED image instead: this
4580needs more space in Flash, but boots much faster since it does not
4581need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004582
Stefan Roese88fbf932010-04-15 16:07:28 +02004583 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004584 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4585 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004586 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004587 > examples/uImage.TQM850L-uncompressed
4588 Image Name: 2.4.4 kernel for TQM850L
4589 Created: Wed Jul 19 02:34:59 2000
4590 Image Type: PowerPC Linux Kernel Image (uncompressed)
4591 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4592 Load Address: 0x00000000
4593 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004594
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk6c59edc2004-05-03 20:45:30 +00004596Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4597when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004598
wdenk6c59edc2004-05-03 20:45:30 +00004599 -> tools/mkimage -n 'Simple Ramdisk Image' \
4600 > -A ppc -O linux -T ramdisk -C gzip \
4601 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4602 Image Name: Simple Ramdisk Image
4603 Created: Wed Jan 12 14:01:50 2000
4604 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4605 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4606 Load Address: 0x00000000
4607 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004608
wdenkc6097192002-11-03 00:24:07 +00004609
wdenk6c59edc2004-05-03 20:45:30 +00004610Installing a Linux Image:
4611-------------------------
wdenkc6097192002-11-03 00:24:07 +00004612
wdenk6c59edc2004-05-03 20:45:30 +00004613To downloading a U-Boot image over the serial (console) interface,
4614you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk6c59edc2004-05-03 20:45:30 +00004616 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004617
wdenk6c59edc2004-05-03 20:45:30 +00004618The 'objcopy' does not understand the information in the U-Boot
4619image header, so the resulting S-Record file will be relative to
4620address 0x00000000. To load it to a given address, you need to
4621specify the target address as 'offset' parameter with the 'loads'
4622command.
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk6c59edc2004-05-03 20:45:30 +00004624Example: install the image to address 0x40100000 (which on the
4625TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004626
wdenk6c59edc2004-05-03 20:45:30 +00004627 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004628
wdenk6c59edc2004-05-03 20:45:30 +00004629 .......... done
4630 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004631
wdenk6c59edc2004-05-03 20:45:30 +00004632 => loads 40100000
4633 ## Ready for S-Record download ...
4634 ~>examples/image.srec
4635 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4636 ...
4637 15989 15990 15991 15992
4638 [file transfer complete]
4639 [connected]
4640 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004641
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004644this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004645corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004646
wdenk6c59edc2004-05-03 20:45:30 +00004647 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004648
wdenk6c59edc2004-05-03 20:45:30 +00004649 ## Checking Image at 40100000 ...
4650 Image Name: 2.2.13 for initrd on TQM850L
4651 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4652 Data Size: 335725 Bytes = 327 kB = 0 MB
4653 Load Address: 00000000
4654 Entry Point: 0000000c
4655 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004656
4657
wdenk6c59edc2004-05-03 20:45:30 +00004658Boot Linux:
4659-----------
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661The "bootm" command is used to boot an application that is stored in
4662memory (RAM or Flash). In case of a Linux kernel image, the contents
4663of the "bootargs" environment variable is passed to the kernel as
4664parameters. You can check and modify this variable using the
4665"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004666
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668 => printenv bootargs
4669 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004670
wdenk6c59edc2004-05-03 20:45:30 +00004671 => 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 +00004672
wdenk6c59edc2004-05-03 20:45:30 +00004673 => printenv bootargs
4674 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 +00004675
wdenk6c59edc2004-05-03 20:45:30 +00004676 => bootm 40020000
4677 ## Booting Linux kernel at 40020000 ...
4678 Image Name: 2.2.13 for NFS on TQM850L
4679 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4680 Data Size: 381681 Bytes = 372 kB = 0 MB
4681 Load Address: 00000000
4682 Entry Point: 0000000c
4683 Verifying Checksum ... OK
4684 Uncompressing Kernel Image ... OK
4685 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
4686 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4687 time_init: decrementer frequency = 187500000/60
4688 Calibrating delay loop... 49.77 BogoMIPS
4689 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4690 ...
wdenkc6097192002-11-03 00:24:07 +00004691
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004692If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004693the memory addresses of both the kernel and the initrd image (PPBCOOT
4694format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698 ## Checking Image at 40100000 ...
4699 Image Name: 2.2.13 for initrd on TQM850L
4700 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4701 Data Size: 335725 Bytes = 327 kB = 0 MB
4702 Load Address: 00000000
4703 Entry Point: 0000000c
4704 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004705
wdenk6c59edc2004-05-03 20:45:30 +00004706 ## Checking Image at 40200000 ...
4707 Image Name: Simple Ramdisk Image
4708 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4709 Data Size: 566530 Bytes = 553 kB = 0 MB
4710 Load Address: 00000000
4711 Entry Point: 00000000
4712 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714 => bootm 40100000 40200000
4715 ## Booting Linux kernel at 40100000 ...
4716 Image Name: 2.2.13 for initrd on TQM850L
4717 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4718 Data Size: 335725 Bytes = 327 kB = 0 MB
4719 Load Address: 00000000
4720 Entry Point: 0000000c
4721 Verifying Checksum ... OK
4722 Uncompressing Kernel Image ... OK
4723 ## Loading RAMDisk Image at 40200000 ...
4724 Image Name: Simple Ramdisk Image
4725 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4726 Data Size: 566530 Bytes = 553 kB = 0 MB
4727 Load Address: 00000000
4728 Entry Point: 00000000
4729 Verifying Checksum ... OK
4730 Loading Ramdisk ... OK
4731 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
4732 Boot arguments: root=/dev/ram
4733 time_init: decrementer frequency = 187500000/60
4734 Calibrating delay loop... 49.77 BogoMIPS
4735 ...
4736 RAMDISK: Compressed image found at block 0
4737 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk6c59edc2004-05-03 20:45:30 +00004739 bash#
wdenkc6097192002-11-03 00:24:07 +00004740
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004741Boot Linux and pass a flat device tree:
4742-----------
4743
4744First, U-Boot must be compiled with the appropriate defines. See the section
4745titled "Linux Kernel Interface" above for a more in depth explanation. The
4746following is an example of how to start a kernel and pass an updated
4747flat device tree:
4748
4749=> print oftaddr
4750oftaddr=0x300000
4751=> print oft
4752oft=oftrees/mpc8540ads.dtb
4753=> tftp $oftaddr $oft
4754Speed: 1000, full duplex
4755Using TSEC0 device
4756TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4757Filename 'oftrees/mpc8540ads.dtb'.
4758Load address: 0x300000
4759Loading: #
4760done
4761Bytes transferred = 4106 (100a hex)
4762=> tftp $loadaddr $bootfile
4763Speed: 1000, full duplex
4764Using TSEC0 device
4765TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4766Filename 'uImage'.
4767Load address: 0x200000
4768Loading:############
4769done
4770Bytes transferred = 1029407 (fb51f hex)
4771=> print loadaddr
4772loadaddr=200000
4773=> print oftaddr
4774oftaddr=0x300000
4775=> bootm $loadaddr - $oftaddr
4776## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004777 Image Name: Linux-2.6.17-dirty
4778 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4779 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004780 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004781 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004782 Verifying Checksum ... OK
4783 Uncompressing Kernel Image ... OK
4784Booting using flat device tree at 0x300000
4785Using MPC85xx ADS machine description
4786Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4787[snip]
4788
4789
wdenk6c59edc2004-05-03 20:45:30 +00004790More About U-Boot Image Types:
4791------------------------------
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk6c59edc2004-05-03 20:45:30 +00004793U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004794
wdenk6c59edc2004-05-03 20:45:30 +00004795 "Standalone Programs" are directly runnable in the environment
4796 provided by U-Boot; it is expected that (if they behave
4797 well) you can continue to work in U-Boot after return from
4798 the Standalone Program.
4799 "OS Kernel Images" are usually images of some Embedded OS which
4800 will take over control completely. Usually these programs
4801 will install their own set of exception handlers, device
4802 drivers, set up the MMU, etc. - this means, that you cannot
4803 expect to re-enter U-Boot except by resetting the CPU.
4804 "RAMDisk Images" are more or less just data blocks, and their
4805 parameters (address, size) are passed to an OS kernel that is
4806 being started.
4807 "Multi-File Images" contain several images, typically an OS
4808 (Linux) kernel image and one or more data images like
4809 RAMDisks. This construct is useful for instance when you want
4810 to boot over the network using BOOTP etc., where the boot
4811 server provides just a single image file, but you want to get
4812 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004813
wdenk6c59edc2004-05-03 20:45:30 +00004814 "Multi-File Images" start with a list of image sizes, each
4815 image size (in bytes) specified by an "uint32_t" in network
4816 byte order. This list is terminated by an "(uint32_t)0".
4817 Immediately after the terminating 0 follow the images, one by
4818 one, all aligned on "uint32_t" boundaries (size rounded up to
4819 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004820
wdenk6c59edc2004-05-03 20:45:30 +00004821 "Firmware Images" are binary images containing firmware (like
4822 U-Boot or FPGA images) which usually will be programmed to
4823 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004824
wdenk6c59edc2004-05-03 20:45:30 +00004825 "Script files" are command sequences that will be executed by
4826 U-Boot's command interpreter; this feature is especially
4827 useful when you configure U-Boot to use a real shell (hush)
4828 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004829
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004830Booting the Linux zImage:
4831-------------------------
4832
4833On some platforms, it's possible to boot Linux zImage. This is done
4834using the "bootz" command. The syntax of "bootz" command is the same
4835as the syntax of "bootm" command.
4836
Marek Vasut28850d02012-03-18 11:47:58 +00004837Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4838kernel with raw initrd images. The syntax is slightly different, the
4839address of the initrd must be augmented by it's size, in the following
4840format: "<initrd addres>:<initrd size>".
4841
stroeseb9c17c52003-04-04 15:53:41 +00004842
wdenk6c59edc2004-05-03 20:45:30 +00004843Standalone HOWTO:
4844=================
stroeseb9c17c52003-04-04 15:53:41 +00004845
wdenk6c59edc2004-05-03 20:45:30 +00004846One of the features of U-Boot is that you can dynamically load and
4847run "standalone" applications, which can use some resources of
4848U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004849
wdenk6c59edc2004-05-03 20:45:30 +00004850Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004851
wdenk6c59edc2004-05-03 20:45:30 +00004852"Hello World" Demo:
4853-------------------
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk6c59edc2004-05-03 20:45:30 +00004855'examples/hello_world.c' contains a small "Hello World" Demo
4856application; it is automatically compiled when you build U-Boot.
4857It's configured to run at address 0x00040004, so you can play with it
4858like that:
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk6c59edc2004-05-03 20:45:30 +00004860 => loads
4861 ## Ready for S-Record download ...
4862 ~>examples/hello_world.srec
4863 1 2 3 4 5 6 7 8 9 10 11 ...
4864 [file transfer complete]
4865 [connected]
4866 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868 => go 40004 Hello World! This is a test.
4869 ## Starting application at 0x00040004 ...
4870 Hello World
4871 argc = 7
4872 argv[0] = "40004"
4873 argv[1] = "Hello"
4874 argv[2] = "World!"
4875 argv[3] = "This"
4876 argv[4] = "is"
4877 argv[5] = "a"
4878 argv[6] = "test."
4879 argv[7] = "<NULL>"
4880 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk6c59edc2004-05-03 20:45:30 +00004882 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk6c59edc2004-05-03 20:45:30 +00004884Another example, which demonstrates how to register a CPM interrupt
4885handler with the U-Boot code, can be found in 'examples/timer.c'.
4886Here, a CPM timer is set up to generate an interrupt every second.
4887The interrupt service routine is trivial, just printing a '.'
4888character, but this is just a demo program. The application can be
4889controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004890
wdenk6c59edc2004-05-03 20:45:30 +00004891 ? - print current values og the CPM Timer registers
4892 b - enable interrupts and start timer
4893 e - stop timer and disable interrupts
4894 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk6c59edc2004-05-03 20:45:30 +00004896 => loads
4897 ## Ready for S-Record download ...
4898 ~>examples/timer.srec
4899 1 2 3 4 5 6 7 8 9 10 11 ...
4900 [file transfer complete]
4901 [connected]
4902 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904 => go 40004
4905 ## Starting application at 0x00040004 ...
4906 TIMERS=0xfff00980
4907 Using timer 1
4908 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910Hit 'b':
4911 [q, b, e, ?] Set interval 1000000 us
4912 Enabling timer
4913Hit '?':
4914 [q, b, e, ?] ........
4915 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4916Hit '?':
4917 [q, b, e, ?] .
4918 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4919Hit '?':
4920 [q, b, e, ?] .
4921 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4922Hit '?':
4923 [q, b, e, ?] .
4924 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4925Hit 'e':
4926 [q, b, e, ?] ...Stopping timer
4927Hit 'q':
4928 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004929
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk6c59edc2004-05-03 20:45:30 +00004931Minicom warning:
4932================
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk6c59edc2004-05-03 20:45:30 +00004934Over time, many people have reported problems when trying to use the
4935"minicom" terminal emulation program for serial download. I (wd)
4936consider minicom to be broken, and recommend not to use it. Under
4937Unix, I recommend to use C-Kermit for general purpose use (and
4938especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00004939use "cu" for S-Record download ("loads" command). See
4940http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4941for help with kermit.
4942
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk6c59edc2004-05-03 20:45:30 +00004944Nevertheless, if you absolutely want to use it try adding this
4945configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk6c59edc2004-05-03 20:45:30 +00004947 Name Program Name U/D FullScr IO-Red. Multi
4948 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4949 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00004950
wdenk8dba0502003-03-31 16:34:49 +00004951
wdenk6c59edc2004-05-03 20:45:30 +00004952NetBSD Notes:
4953=============
wdenkc6097192002-11-03 00:24:07 +00004954
wdenk6c59edc2004-05-03 20:45:30 +00004955Starting at version 0.9.2, U-Boot supports NetBSD both as host
4956(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00004957
wdenk6c59edc2004-05-03 20:45:30 +00004958Building requires a cross environment; it is known to work on
4959NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4960need gmake since the Makefiles are not compatible with BSD make).
4961Note that the cross-powerpc package does not install include files;
4962attempting to build U-Boot will fail because <machine/ansi.h> is
4963missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00004964
wdenk6c59edc2004-05-03 20:45:30 +00004965 # cd /usr/pkg/cross/powerpc-netbsd/include
4966 # mkdir powerpc
4967 # ln -s powerpc machine
4968 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4969 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971Native builds *don't* work due to incompatibilities between native
4972and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk6c59edc2004-05-03 20:45:30 +00004974Booting assumes that (the first part of) the image booted is a
4975stage-2 loader which in turn loads and then invokes the kernel
4976proper. Loader sources will eventually appear in the NetBSD source
4977tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00004978meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004979
wdenkc6097192002-11-03 00:24:07 +00004980
wdenk6c59edc2004-05-03 20:45:30 +00004981Implementation Internals:
4982=========================
wdenkc6097192002-11-03 00:24:07 +00004983
wdenk6c59edc2004-05-03 20:45:30 +00004984The following is not intended to be a complete description of every
4985implementation detail. However, it should help to understand the
4986inner workings of U-Boot and make it easier to port it to custom
4987hardware.
wdenkc6097192002-11-03 00:24:07 +00004988
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990Initial Stack, Global Data:
4991---------------------------
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk6c59edc2004-05-03 20:45:30 +00004993The implementation of U-Boot is complicated by the fact that U-Boot
4994starts running out of ROM (flash memory), usually without access to
4995system RAM (because the memory controller is not initialized yet).
4996This means that we don't have writable Data or BSS segments, and BSS
4997is not initialized as zero. To be able to get a C environment working
4998at all, we have to allocate at least a minimal stack. Implementation
4999options for this are defined and restricted by the CPU used: Some CPU
5000models provide on-chip memory (like the IMMR area on MPC8xx and
5001MPC826x processors), on others (parts of) the data cache can be
5002locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005003
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005004 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005005 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk6c59edc2004-05-03 20:45:30 +00005007 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5008 From: "Chris Hallinan" <clh@net1plus.com>
5009 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5010 ...
wdenkc6097192002-11-03 00:24:07 +00005011
wdenk6c59edc2004-05-03 20:45:30 +00005012 Correct me if I'm wrong, folks, but the way I understand it
5013 is this: Using DCACHE as initial RAM for Stack, etc, does not
5014 require any physical RAM backing up the cache. The cleverness
5015 is that the cache is being used as a temporary supply of
5016 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005017 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005018 can see how this works by studying the cache architecture and
5019 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005020
wdenk6c59edc2004-05-03 20:45:30 +00005021 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5022 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005023 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005024 option should work for you. Using CS 4 should be fine if your
5025 board designers haven't used it for something that would
5026 cause you grief during the initial boot! It is frequently not
5027 used.
wdenkc6097192002-11-03 00:24:07 +00005028
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005029 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005030 with your processor/board/system design. The default value
5031 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005032 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005033 than your SDRAM module. If you have a 64MB SDRAM module, set
5034 it above 400_0000. Just make sure your board has no resources
5035 that are supposed to respond to that address! That code in
5036 start.S has been around a while and should work as is when
5037 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005038
wdenk6c59edc2004-05-03 20:45:30 +00005039 -Chris Hallinan
5040 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005041
wdenk6c59edc2004-05-03 20:45:30 +00005042It is essential to remember this, since it has some impact on the C
5043code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005044
wdenk6c59edc2004-05-03 20:45:30 +00005045* Initialized global data (data segment) is read-only. Do not attempt
5046 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005047
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005048* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005049 as zero data - BSS segment) at all - this is undefined, initiali-
5050 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052* Stack space is very limited. Avoid big data buffers or things like
5053 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005054
wdenk6c59edc2004-05-03 20:45:30 +00005055Having only the stack as writable memory limits means we cannot use
5056normal global data to share information beween the code. But it
5057turned out that the implementation of U-Boot can be greatly
5058simplified by making a global data structure (gd_t) available to all
5059functions. We could pass a pointer to this data as argument to _all_
5060functions, but this would bloat the code. Instead we use a feature of
5061the GCC compiler (Global Register Variables) to share the data: we
5062place a pointer (gd) to the global data into a register which we
5063reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk6c59edc2004-05-03 20:45:30 +00005065When choosing a register for such a purpose we are restricted by the
5066relevant (E)ABI specifications for the current architecture, and by
5067GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069For PowerPC, the following registers have specific use:
5070 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005071 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005072 R3-R4: parameter passing and return values
5073 R5-R10: parameter passing
5074 R13: small data area pointer
5075 R30: GOT pointer
5076 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005077
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005078 (U-Boot also uses R12 as internal GOT pointer. r12
5079 is a volatile register so r12 needs to be reset when
5080 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005081
Wolfgang Denk69c09642008-02-14 22:43:22 +01005082 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005083
wdenk6c59edc2004-05-03 20:45:30 +00005084 Note: on PPC, we could use a static initializer (since the
5085 address of the global data structure is known at compile time),
5086 but it turned out that reserving a register results in somewhat
5087 smaller code - although the code savings are not that big (on
5088 average for all boards 752 bytes for the whole U-Boot image,
5089 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005090
Robin Getz2773d5f2009-08-17 15:23:02 +00005091On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005092 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5093
Robin Getz2773d5f2009-08-17 15:23:02 +00005094 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005095
wdenk6c59edc2004-05-03 20:45:30 +00005096On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk6c59edc2004-05-03 20:45:30 +00005098 R0: function argument word/integer result
5099 R1-R3: function argument word
5100 R9: GOT pointer
5101 R10: stack limit (used only if stack checking if enabled)
5102 R11: argument (frame) pointer
5103 R12: temporary workspace
5104 R13: stack pointer
5105 R14: link register
5106 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005107
wdenk6c59edc2004-05-03 20:45:30 +00005108 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005109
Thomas Chou8fa38582010-05-21 11:08:03 +08005110On Nios II, the ABI is documented here:
5111 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5112
5113 ==> U-Boot will use gp to hold a pointer to the global data
5114
5115 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5116 to access small data sections, so gp is free.
5117
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005118On NDS32, the following registers are used:
5119
5120 R0-R1: argument/return
5121 R2-R5: argument
5122 R15: temporary register for assembler
5123 R16: trampoline register
5124 R28: frame pointer (FP)
5125 R29: global pointer (GP)
5126 R30: link register (LP)
5127 R31: stack pointer (SP)
5128 PC: program counter (PC)
5129
5130 ==> U-Boot will use R10 to hold a pointer to the global data
5131
Wolfgang Denk6405a152006-03-31 18:32:53 +02005132NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5133or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005134
wdenk6c59edc2004-05-03 20:45:30 +00005135Memory Management:
5136------------------
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk6c59edc2004-05-03 20:45:30 +00005138U-Boot runs in system state and uses physical addresses, i.e. the
5139MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005140
wdenk6c59edc2004-05-03 20:45:30 +00005141The available memory is mapped to fixed addresses using the memory
5142controller. In this process, a contiguous block is formed for each
5143memory type (Flash, SDRAM, SRAM), even when it consists of several
5144physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005145
wdenk6c59edc2004-05-03 20:45:30 +00005146U-Boot is installed in the first 128 kB of the first Flash bank (on
5147TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5148booting and sizing and initializing DRAM, the code relocates itself
5149to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005150memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005151configuration setting]. Below that, a structure with global Board
5152Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005153
wdenk6c59edc2004-05-03 20:45:30 +00005154Additionally, some exception handler code is copied to the low 8 kB
5155of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005156
wdenk6c59edc2004-05-03 20:45:30 +00005157So a typical memory configuration with 16 MB of DRAM could look like
5158this:
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk6c59edc2004-05-03 20:45:30 +00005160 0x0000 0000 Exception Vector code
5161 :
5162 0x0000 1FFF
5163 0x0000 2000 Free for Application Use
5164 :
5165 :
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167 :
5168 :
5169 0x00FB FF20 Monitor Stack (Growing downward)
5170 0x00FB FFAC Board Info Data and permanent copy of global data
5171 0x00FC 0000 Malloc Arena
5172 :
5173 0x00FD FFFF
5174 0x00FE 0000 RAM Copy of Monitor Code
5175 ... eventually: LCD or video framebuffer
5176 ... eventually: pRAM (Protected RAM - unchanged by reset)
5177 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005178
wdenkc6097192002-11-03 00:24:07 +00005179
wdenk6c59edc2004-05-03 20:45:30 +00005180System Initialization:
5181----------------------
wdenkc6097192002-11-03 00:24:07 +00005182
wdenk6c59edc2004-05-03 20:45:30 +00005183In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005184(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005185configuration for CS0# this is a mirror of the onboard Flash memory.
5186To be able to re-map memory U-Boot then jumps to its link address.
5187To be able to implement the initialization code in C, a (small!)
5188initial stack is set up in the internal Dual Ported RAM (in case CPUs
5189which provide such a feature like MPC8xx or MPC8260), or in a locked
5190part of the data cache. After that, U-Boot initializes the CPU core,
5191the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk6c59edc2004-05-03 20:45:30 +00005193Next, all (potentially) available memory banks are mapped using a
5194preliminary mapping. For example, we put them on 512 MB boundaries
5195(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5196on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5197programmed for SDRAM access. Using the temporary configuration, a
5198simple memory test is run that determines the size of the SDRAM
5199banks.
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk6c59edc2004-05-03 20:45:30 +00005201When there is more than one SDRAM bank, and the banks are of
5202different size, the largest is mapped first. For equal size, the first
5203bank (CS2#) is mapped first. The first mapping is always for address
52040x00000000, with any additional banks following immediately to create
5205contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk6c59edc2004-05-03 20:45:30 +00005207Then, the monitor installs itself at the upper end of the SDRAM area
5208and allocates memory for use by malloc() and for the global Board
5209Info data; also, the exception vector code is copied to the low RAM
5210pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212Only after this relocation will you have a "normal" C environment;
5213until that you are restricted in several ways, mostly because you are
5214running from ROM, and because the code will have to be relocated to a
5215new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005216
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218U-Boot Porting Guide:
5219----------------------
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5222list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005223
wdenkc6097192002-11-03 00:24:07 +00005224
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005225int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005226{
5227 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005228
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005229 signal(SIGALRM, no_more_time);
5230 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005233 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005234 return 0;
5235 }
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk6c59edc2004-05-03 20:45:30 +00005237 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005238
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005239 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005240
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005241 if (clueless)
5242 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244 while (learning) {
5245 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005246 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5247 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005248 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005249 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005250 }
wdenkc6097192002-11-03 00:24:07 +00005251
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005252 if (available_money > toLocalCurrency ($2500))
5253 Buy a BDI3000;
5254 else
wdenk6c59edc2004-05-03 20:45:30 +00005255 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005256
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005257 if (a similar board exists) { /* hopefully... */
5258 cp -a board/<similar> board/<myboard>
5259 cp include/configs/<similar>.h include/configs/<myboard>.h
5260 } else {
5261 Create your own board support subdirectory;
5262 Create your own board include/configs/<myboard>.h file;
5263 }
5264 Edit new board/<myboard> files
5265 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005266
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005267 while (!accepted) {
5268 while (!running) {
5269 do {
5270 Add / modify source code;
5271 } until (compiles);
5272 Debug;
5273 if (clueless)
5274 email("Hi, I am having problems...");
5275 }
5276 Send patch file to the U-Boot email list;
5277 if (reasonable critiques)
5278 Incorporate improvements from email list code review;
5279 else
5280 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005281 }
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk6c59edc2004-05-03 20:45:30 +00005283 return 0;
5284}
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk6c59edc2004-05-03 20:45:30 +00005286void no_more_time (int sig)
5287{
5288 hire_a_guru();
5289}
wdenkc6097192002-11-03 00:24:07 +00005290
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292Coding Standards:
5293-----------------
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005296coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005297"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005298
5299Source files originating from a different project (for example the
5300MTD subsystem) are generally exempt from these guidelines and are not
5301reformated to ease subsequent migration to newer versions of those
5302sources.
wdenkc6097192002-11-03 00:24:07 +00005303
Detlev Zundelaa63d482006-09-01 15:39:02 +02005304Please note that U-Boot is implemented in C (and to some small parts in
5305Assembler); no C++ is used, so please do not use C++ style comments (//)
5306in your code.
wdenkad276f22004-01-04 16:28:35 +00005307
wdenk6c59edc2004-05-03 20:45:30 +00005308Please also stick to the following formatting rules:
5309- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005310- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005311- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005312- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005313- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk6c59edc2004-05-03 20:45:30 +00005315Submissions which do not conform to the standards may be returned
5316with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005317
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk6c59edc2004-05-03 20:45:30 +00005319Submitting Patches:
5320-------------------
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk6c59edc2004-05-03 20:45:30 +00005322Since the number of patches for U-Boot is growing, we need to
5323establish some rules. Submissions which do not conform to these rules
5324may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005325
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005326Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005327
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005328Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5329see http://lists.denx.de/mailman/listinfo/u-boot
5330
wdenk6c59edc2004-05-03 20:45:30 +00005331When you send a patch, please include the following information with
5332it:
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334* For bug fixes: a description of the bug and how your patch fixes
5335 this bug. Please try to include a way of demonstrating that the
5336 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005337
wdenk6c59edc2004-05-03 20:45:30 +00005338* For new features: a description of the feature and your
5339 implementation.
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk6c59edc2004-05-03 20:45:30 +00005341* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005346 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk6c59edc2004-05-03 20:45:30 +00005348* If your patch adds new configuration options, don't forget to
5349 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005350
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005351* The patch itself. If you are using git (which is *strongly*
5352 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005353 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005354 the U-Boot mailing list, you will avoid most of the common problems
5355 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005356
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005357 If you cannot use git, use "diff -purN OLD NEW". If your version of
5358 diff does not support these options, then get the latest version of
5359 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005360
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005361 The current directory when running this command shall be the parent
5362 directory of the U-Boot source tree (i. e. please make sure that
5363 your patch includes sufficient directory information for the
5364 affected files).
5365
5366 We prefer patches as plain text. MIME attachments are discouraged,
5367 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005368
wdenk6c59edc2004-05-03 20:45:30 +00005369* If one logical set of modifications affects or creates several
5370 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372* Changesets that contain different, unrelated modifications shall be
5373 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005374
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk6c59edc2004-05-03 20:45:30 +00005376Notes:
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378* Before sending the patch, run the MAKEALL script on your patched
5379 source tree and make sure that no errors or warnings are reported
5380 for any of the boards.
5381
5382* Keep your modifications to the necessary minimum: A patch
5383 containing several unrelated changes or arbitrary reformats will be
5384 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005385
wdenk6c59edc2004-05-03 20:45:30 +00005386* If you modify existing code, make sure that your new code does not
5387 add to the memory footprint of the code ;-) Small is beautiful!
5388 When adding new features, these should compile conditionally only
5389 (using #ifdef), and the resulting code with the new feature
5390 disabled must not need more memory than the old code without your
5391 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005392
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005393* Remember that there is a size limit of 100 kB per message on the
5394 u-boot mailing list. Bigger patches will be moderated. If they are
5395 reasonable and not too big, they will be acknowledged. But patches
5396 bigger than the size limit should be avoided.