blob: 398d70d67c2ff6b24e7d927b84b80202a7e13743 [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
Javier Martinez Canillas141e0112013-01-07 01:35:20 +0000619 CONFIG_SYS_NS16550_BROKEN_TEMT
620
621 16550 UART set the Transmitter Empty (TEMT) Bit when all output
622 has finished and the transmitter is totally empty. U-Boot waits
623 for this bit to be set to initialize the serial console. On some
624 broken platforms this bit is not set in SPL making U-Boot to
625 hang while waiting for TEMT. Define this option to avoid it.
626
wdenkda04a8b2004-08-02 23:22:59 +0000627
wdenkc6097192002-11-03 00:24:07 +0000628- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000629 Depending on board, define exactly one serial port
630 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
631 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
632 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000633
634 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
635 port routines must be defined elsewhere
636 (i.e. serial_init(), serial_getc(), ...)
637
638 CONFIG_CFB_CONSOLE
639 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000640 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000641 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
642 (default big endian)
643 VIDEO_HW_RECTFILL graphic chip supports
644 rectangle fill
645 (cf. smiLynxEM)
646 VIDEO_HW_BITBLT graphic chip supports
647 bit-blit (cf. smiLynxEM)
648 VIDEO_VISIBLE_COLS visible pixel columns
649 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000650 VIDEO_VISIBLE_ROWS visible pixel rows
651 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000652 VIDEO_DATA_FORMAT graphic data format
653 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000654 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000655 VIDEO_KBD_INIT_FCT keyboard int fct
656 (i.e. i8042_kbd_init())
657 VIDEO_TSTC_FCT test char fct
658 (i.e. i8042_tstc)
659 VIDEO_GETC_FCT get char fct
660 (i.e. i8042_getc)
661 CONFIG_CONSOLE_CURSOR cursor drawing on/off
662 (requires blink timer
663 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200664 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000665 CONFIG_CONSOLE_TIME display time/date info in
666 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500667 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000668 CONFIG_VIDEO_LOGO display Linux logo in
669 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000670 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
671 linux_logo.h for logo.
672 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000673 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200674 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000675 the logo
676
Pali Rohár4a57da32012-10-19 13:30:09 +0000677 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
678 a limited number of ANSI escape sequences (cursor control,
679 erase functions and limited graphics rendition control).
680
wdenk4a5c8a72003-03-06 00:02:04 +0000681 When CONFIG_CFB_CONSOLE is defined, video console is
682 default i/o. Serial console can be forced with
683 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000684
wdenk1ebf41e2004-01-02 14:00:00 +0000685 When CONFIG_SILENT_CONSOLE is defined, all console
686 messages (by U-Boot and Linux!) can be silenced with
687 the "silent" environment variable. See
688 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000689
wdenkc6097192002-11-03 00:24:07 +0000690- Console Baudrate:
691 CONFIG_BAUDRATE - in bps
692 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200693 CONFIG_SYS_BAUDRATE_TABLE, see below.
694 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000695
Heiko Schocher327480a2009-01-30 12:55:38 +0100696- Console Rx buffer length
697 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
698 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100699 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100700 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
701 must be defined, to setup the maximum idle timeout for
702 the SMC.
703
Graeme Russ3c28f482011-09-01 00:48:27 +0000704- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200705 Prior to the console being initialised (i.e. serial UART
706 initialised etc) all console output is silently discarded.
707 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
708 buffer any console messages prior to the console being
709 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
710 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
711 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200712 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200713 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000714
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200715 'Sane' compilers will generate smaller code if
716 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000717
Sonny Raocd55bde2011-11-02 09:52:08 +0000718- Safe printf() functions
719 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
720 the printf() functions. These are defined in
721 include/vsprintf.h and include snprintf(), vsnprintf() and
722 so on. Code size increase is approximately 300-500 bytes.
723 If this option is not given then these functions will
724 silently discard their buffer size argument - this means
725 you are not getting any overflow checking in this case.
726
wdenkc6097192002-11-03 00:24:07 +0000727- Boot Delay: CONFIG_BOOTDELAY - in seconds
728 Delay before automatically booting the default image;
729 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000730 set to -2 to autoboot with no delay and not check for abort
731 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000732
733 See doc/README.autoboot for these options that
734 work with CONFIG_BOOTDELAY. None are required.
735 CONFIG_BOOT_RETRY_TIME
736 CONFIG_BOOT_RETRY_MIN
737 CONFIG_AUTOBOOT_KEYED
738 CONFIG_AUTOBOOT_PROMPT
739 CONFIG_AUTOBOOT_DELAY_STR
740 CONFIG_AUTOBOOT_STOP_STR
741 CONFIG_AUTOBOOT_DELAY_STR2
742 CONFIG_AUTOBOOT_STOP_STR2
743 CONFIG_ZERO_BOOTDELAY_CHECK
744 CONFIG_RESET_TO_RETRY
745
746- Autoboot Command:
747 CONFIG_BOOTCOMMAND
748 Only needed when CONFIG_BOOTDELAY is enabled;
749 define a command string that is automatically executed
750 when no character is read on the console interface
751 within "Boot Delay" after reset.
752
753 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000754 This can be used to pass arguments to the bootm
755 command. The value of CONFIG_BOOTARGS goes into the
756 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000757
758 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000759 The value of these goes into the environment as
760 "ramboot" and "nfsboot" respectively, and can be used
761 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200762 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000763
764- Pre-Boot Commands:
765 CONFIG_PREBOOT
766
767 When this option is #defined, the existence of the
768 environment variable "preboot" will be checked
769 immediately before starting the CONFIG_BOOTDELAY
770 countdown and/or running the auto-boot command resp.
771 entering interactive mode.
772
773 This feature is especially useful when "preboot" is
774 automatically generated or modified. For an example
775 see the LWMON board specific code: here "preboot" is
776 modified when the user holds down a certain
777 combination of keys on the (special) keyboard when
778 booting the systems
779
780- Serial Download Echo Mode:
781 CONFIG_LOADS_ECHO
782 If defined to 1, all characters received during a
783 serial download (using the "loads" command) are
784 echoed back. This might be needed by some terminal
785 emulations (like "cu"), but may as well just take
786 time on others. This setting #define's the initial
787 value of the "loads_echo" environment variable.
788
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500789- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000790 CONFIG_KGDB_BAUDRATE
791 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200792 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000793
794- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500795 Monitor commands can be included or excluded
796 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000797 <config_cmd_all.h> and #undef'ing unwanted
798 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500799 and augmenting with additional #define's
800 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000801
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500802 The default command configuration includes all commands
803 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000804
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500805 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500806 CONFIG_CMD_BDI bdinfo
807 CONFIG_CMD_BEDBUG * Include BedBug Debugger
808 CONFIG_CMD_BMP * BMP support
809 CONFIG_CMD_BSP * Board specific commands
810 CONFIG_CMD_BOOTD bootd
811 CONFIG_CMD_CACHE * icache, dcache
812 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500813 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500814 CONFIG_CMD_DATE * support for RTC, date/time...
815 CONFIG_CMD_DHCP * DHCP support
816 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600817 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
818 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
819 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
820 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500821 CONFIG_CMD_DTT * Digital Therm and Thermostat
822 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500823 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500824 CONFIG_CMD_EEPROM * EEPROM read/write support
825 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600826 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600827 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500828 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000829 CONFIG_CMD_EXT2 * ext2 command support
830 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500831 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500832 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000833 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500834 CONFIG_CMD_FDOS * Dos diskette Support
835 CONFIG_CMD_FLASH flinfo, erase, protect
836 CONFIG_CMD_FPGA FPGA device initialization support
Anton Staafd1390c82012-12-05 14:46:29 +0000837 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500838 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000839 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000840 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
842 CONFIG_CMD_I2C * I2C serial bus support
843 CONFIG_CMD_IDE * IDE harddisk support
844 CONFIG_CMD_IMI iminfo
845 CONFIG_CMD_IMLS List all found images
846 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500847 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000848 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500849 CONFIG_CMD_IRQ * irqinfo
850 CONFIG_CMD_ITEST Integer/string test of 2 values
851 CONFIG_CMD_JFFS2 * JFFS2 Support
852 CONFIG_CMD_KGDB * kgdb
Mike Frysingerfc6508a2010-12-26 12:34:49 -0500853 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000854 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
855 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500856 CONFIG_CMD_LOADB loadb
857 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400858 CONFIG_CMD_MD5SUM print md5 message digest
859 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000860 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500861 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
862 loop, loopw, mtest
863 CONFIG_CMD_MISC Misc functions like sleep etc
864 CONFIG_CMD_MMC * MMC memory mapped support
865 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100866 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_NAND * NAND support
868 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600869 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000870 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500871 CONFIG_CMD_PCI * pciinfo
872 CONFIG_CMD_PCMCIA * PCMCIA support
873 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
874 host
875 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000876 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500877 CONFIG_CMD_REGINFO * Register dump
878 CONFIG_CMD_RUN run command in env variable
879 CONFIG_CMD_SAVES * save S record dump
880 CONFIG_CMD_SCSI * SCSI Support
881 CONFIG_CMD_SDRAM * print SDRAM configuration information
882 (requires CONFIG_CMD_I2C)
883 CONFIG_CMD_SETGETDCR Support for DCR Register access
884 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700885 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Holler37ef5392011-01-18 09:48:08 +0100886 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400887 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200888 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500889 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000890 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000891 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000892 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
893 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500894 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500895 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000896 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000897
wdenkc6097192002-11-03 00:24:07 +0000898
899 EXAMPLE: If you want all functions except of network
900 support you can write:
901
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500902 #include "config_cmd_all.h"
903 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000904
Gerald Van Barend6abef42007-03-31 12:23:51 -0400905 Other Commands:
906 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000907
908 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500909 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000910 what you (and your U-Boot users) are doing. Data
911 cache cannot be enabled on systems like the 8xx or
912 8260 (where accesses to the IMMR region must be
913 uncached), and it cannot be disabled on all other
914 systems where we (mis-) use the data cache to hold an
915 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000916
917
918 XXX - this list needs to get updated!
919
Simon Glass3d686442011-10-15 05:48:20 +0000920- Device tree:
921 CONFIG_OF_CONTROL
922 If this variable is defined, U-Boot will use a device tree
923 to configure its devices, instead of relying on statically
924 compiled #defines in the board file. This option is
925 experimental and only available on a few boards. The device
926 tree is available in the global data as gd->fdt_blob.
927
Simon Glass5cb34db2011-10-24 19:15:31 +0000928 U-Boot needs to get its device tree from somewhere. This can
929 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000930
931 CONFIG_OF_EMBED
932 If this variable is defined, U-Boot will embed a device tree
933 binary in its image. This device tree file should be in the
934 board directory and called <soc>-<board>.dts. The binary file
935 is then picked up in board_init_f() and made available through
936 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000937
Simon Glass5cb34db2011-10-24 19:15:31 +0000938 CONFIG_OF_SEPARATE
939 If this variable is defined, U-Boot will build a device tree
940 binary. It will be called u-boot.dtb. Architecture-specific
941 code will locate it at run-time. Generally this works by:
942
943 cat u-boot.bin u-boot.dtb >image.bin
944
945 and in fact, U-Boot does this for you, creating a file called
946 u-boot-dtb.bin which is useful in the common case. You can
947 still use the individual files if you need something more
948 exotic.
949
wdenkc6097192002-11-03 00:24:07 +0000950- Watchdog:
951 CONFIG_WATCHDOG
952 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000953 support for the SoC. There must be support in the SoC
954 specific code for a watchdog. For the 8xx and 8260
955 CPUs, the SIU Watchdog feature is enabled in the SYPCR
956 register. When supported for a specific SoC is
957 available, then no further board specific code should
958 be needed to use it.
959
960 CONFIG_HW_WATCHDOG
961 When using a watchdog circuitry external to the used
962 SoC, then define this variable and provide board
963 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000964
stroeseb9c17c52003-04-04 15:53:41 +0000965- U-Boot Version:
966 CONFIG_VERSION_VARIABLE
967 If this variable is defined, an environment variable
968 named "ver" is created by U-Boot showing the U-Boot
969 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200970 Any change to this variable will be reverted at the
971 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000972
wdenkc6097192002-11-03 00:24:07 +0000973- Real-Time Clock:
974
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500975 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000976 has to be selected, too. Define exactly one of the
977 following options:
978
979 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
980 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000981 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000982 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000983 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000984 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000985 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000986 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100987 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000988 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200989 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200990 CONFIG_SYS_RV3029_TCR - enable trickle charger on
991 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000992
wdenkb9bbd242003-06-30 16:24:52 +0000993 Note that if the RTC uses I2C, then the I2C interface
994 must also be configured. See I2C Support, below.
995
Peter Tyser9902e422008-12-17 16:36:21 -0600996- GPIO Support:
997 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
998 CONFIG_PCA953X_INFO - enable pca953x info command
999
Chris Packham9b383202010-12-19 10:12:13 +00001000 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1001 chip-ngpio pairs that tell the PCA953X driver the number of
1002 pins supported by a particular chip.
1003
Peter Tyser9902e422008-12-17 16:36:21 -06001004 Note that if the GPIO device uses I2C, then the I2C interface
1005 must also be configured. See I2C Support, below.
1006
wdenkc6097192002-11-03 00:24:07 +00001007- Timestamp Support:
1008
wdenk4a5c8a72003-03-06 00:02:04 +00001009 When CONFIG_TIMESTAMP is selected, the timestamp
1010 (date and time) of an image is printed by image
1011 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001012 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001013
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001014- Partition Labels (disklabels) Supported:
1015 Zero or more of the following:
1016 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1017 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1018 Intel architecture, USB sticks, etc.
1019 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1020 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1021 bootloader. Note 2TB partition limit; see
1022 disk/part_efi.c
1023 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001024
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001025 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1026 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001027 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001028
1029- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001030 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1031 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001032
wdenk369d43d2004-03-14 14:09:05 +00001033 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1034 be performed by calling the function
1035 ide_set_reset(int reset)
1036 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001037
1038- ATAPI Support:
1039 CONFIG_ATAPI
1040
1041 Set this to enable ATAPI support.
1042
wdenkf602aa02004-03-13 23:29:43 +00001043- LBA48 Support
1044 CONFIG_LBA48
1045
1046 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001047 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001048 Whithout these , LBA48 support uses 32bit variables and will 'only'
1049 support disks up to 2.1TB.
1050
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001051 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001052 When enabled, makes the IDE subsystem use 64bit sector addresses.
1053 Default is 32bit.
1054
wdenkc6097192002-11-03 00:24:07 +00001055- SCSI Support:
1056 At the moment only there is only support for the
1057 SYM53C8XX SCSI controller; define
1058 CONFIG_SCSI_SYM53C8XX to enable it.
1059
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001060 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1061 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1062 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001063 maximum numbers of LUNs, SCSI ID's and target
1064 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001065 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001066
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001067 The environment variable 'scsidevs' is set to the number of
1068 SCSI devices found during the last scan.
1069
wdenkc6097192002-11-03 00:24:07 +00001070- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001071 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001072 Support for Intel 8254x/8257x gigabit chips.
1073
1074 CONFIG_E1000_SPI
1075 Utility code for direct access to the SPI bus on Intel 8257x.
1076 This does not do anything useful unless you set at least one
1077 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1078
1079 CONFIG_E1000_SPI_GENERIC
1080 Allow generic access to the SPI bus on the Intel 8257x, for
1081 example with the "sspi" command.
1082
1083 CONFIG_CMD_E1000
1084 Management command for E1000 devices. When used on devices
1085 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001086
Andre Schwarz68c2a302008-03-06 16:45:44 +01001087 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001088 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001089
wdenkc6097192002-11-03 00:24:07 +00001090 CONFIG_EEPRO100
1091 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001092 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001093 write routine for first time initialisation.
1094
1095 CONFIG_TULIP
1096 Support for Digital 2114x chips.
1097 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1098 modem chip initialisation (KS8761/QS6611).
1099
1100 CONFIG_NATSEMI
1101 Support for National dp83815 chips.
1102
1103 CONFIG_NS8382X
1104 Support for National dp8382[01] gigabit chips.
1105
wdenkaa603362003-05-12 21:50:16 +00001106- NETWORK Support (other):
1107
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001108 CONFIG_DRIVER_AT91EMAC
1109 Support for AT91RM9200 EMAC.
1110
1111 CONFIG_RMII
1112 Define this to use reduced MII inteface
1113
1114 CONFIG_DRIVER_AT91EMAC_QUIET
1115 If this defined, the driver is quiet.
1116 The driver doen't show link status messages.
1117
Rob Herringc9830dc2011-12-15 11:15:49 +00001118 CONFIG_CALXEDA_XGMAC
1119 Support for the Calxeda XGMAC device
1120
Ashok93fb8722012-10-15 06:20:47 +00001121 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001122 Support for SMSC's LAN91C96 chips.
1123
1124 CONFIG_LAN91C96_BASE
1125 Define this to hold the physical address
1126 of the LAN91C96's I/O space
1127
1128 CONFIG_LAN91C96_USE_32_BIT
1129 Define this to enable 32 bit addressing
1130
Ashok93fb8722012-10-15 06:20:47 +00001131 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001132 Support for SMSC's LAN91C111 chip
1133
1134 CONFIG_SMC91111_BASE
1135 Define this to hold the physical address
1136 of the device (I/O space)
1137
1138 CONFIG_SMC_USE_32_BIT
1139 Define this if data bus is 32 bits
1140
1141 CONFIG_SMC_USE_IOFUNCS
1142 Define this to use i/o functions instead of macros
1143 (some hardware wont work with macros)
1144
Heiko Schocher7d037f72011-11-15 10:00:04 -05001145 CONFIG_DRIVER_TI_EMAC
1146 Support for davinci emac
1147
1148 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1149 Define this if you have more then 3 PHYs.
1150
Macpaul Lin199c6252010-12-21 16:59:46 +08001151 CONFIG_FTGMAC100
1152 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1153
1154 CONFIG_FTGMAC100_EGIGA
1155 Define this to use GE link update with gigabit PHY.
1156 Define this if FTGMAC100 is connected to gigabit PHY.
1157 If your system has 10/100 PHY only, it might not occur
1158 wrong behavior. Because PHY usually return timeout or
1159 useless data when polling gigabit status and gigabit
1160 control registers. This behavior won't affect the
1161 correctnessof 10/100 link speed update.
1162
Mike Rapoportf4761af2009-11-11 10:03:03 +02001163 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001164 Support for SMSC's LAN911x and LAN921x chips
1165
Mike Rapoportf4761af2009-11-11 10:03:03 +02001166 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001167 Define this to hold the physical address
1168 of the device (I/O space)
1169
Mike Rapoportf4761af2009-11-11 10:03:03 +02001170 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001171 Define this if data bus is 32 bits
1172
Mike Rapoportf4761af2009-11-11 10:03:03 +02001173 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001174 Define this if data bus is 16 bits. If your processor
1175 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001176 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001177
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001178 CONFIG_SH_ETHER
1179 Support for Renesas on-chip Ethernet controller
1180
1181 CONFIG_SH_ETHER_USE_PORT
1182 Define the number of ports to be used
1183
1184 CONFIG_SH_ETHER_PHY_ADDR
1185 Define the ETH PHY's address
1186
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001187 CONFIG_SH_ETHER_CACHE_WRITEBACK
1188 If this option is set, the driver enables cache flush.
1189
Vadim Bendeburydac69642011-10-17 08:36:14 +00001190- TPM Support:
1191 CONFIG_GENERIC_LPC_TPM
1192 Support for generic parallel port TPM devices. Only one device
1193 per system is supported at this time.
1194
1195 CONFIG_TPM_TIS_BASE_ADDRESS
1196 Base address where the generic TPM device is mapped
1197 to. Contemporary x86 systems usually map it at
1198 0xfed40000.
1199
wdenkc6097192002-11-03 00:24:07 +00001200- USB Support:
1201 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001202 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001203 CONFIG_USB_UHCI to enable it.
1204 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001205 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001206 storage devices.
1207 Note:
1208 Supported are USB Keyboards and USB Floppy drives
1209 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001210 MPC5200 USB requires additional defines:
1211 CONFIG_USB_CLOCK
1212 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001213 CONFIG_PSC3_USB
1214 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001215 CONFIG_USB_CONFIG
1216 for differential drivers: 0x00001000
1217 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001218 for differential drivers on PSC3: 0x00000100
1219 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001220 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001221 May be defined to allow interrupt polling
1222 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001223
Simon Glass5978cdb2012-02-27 10:52:47 +00001224 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1225 txfilltuning field in the EHCI controller on reset.
1226
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001227- USB Device:
1228 Define the below if you wish to use the USB console.
1229 Once firmware is rebuilt from a serial console issue the
1230 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001231 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001232 it has found a new device. The environment variable usbtty
1233 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001234 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001235 Common Device Class Abstract Control Model serial device.
1236 If you select usbtty = gserial you should be able to enumerate
1237 a Linux host by
1238 # modprobe usbserial vendor=0xVendorID product=0xProductID
1239 else if using cdc_acm, simply setting the environment
1240 variable usbtty to be cdc_acm should suffice. The following
1241 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001242
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001243 CONFIG_USB_DEVICE
1244 Define this to build a UDC device
1245
1246 CONFIG_USB_TTY
1247 Define this to have a tty type of device available to
1248 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001249
Vipin KUMARbdb17702012-03-26 15:38:06 +05301250 CONFIG_USBD_HS
1251 Define this to enable the high speed support for usb
1252 device and usbtty. If this feature is enabled, a routine
1253 int is_usbd_high_speed(void)
1254 also needs to be defined by the driver to dynamically poll
1255 whether the enumeration has succeded at high speed or full
1256 speed.
1257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001258 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001259 Define this if you want stdin, stdout &/or stderr to
1260 be set to usbtty.
1261
1262 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001263 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001264 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001265 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001266
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001267 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001268 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001269 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001270
Wolfgang Denke2601822006-06-14 18:14:56 +02001271 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001272 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001273 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001274 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1275 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1276 should pretend to be a Linux device to it's target host.
1277
1278 CONFIG_USBD_MANUFACTURER
1279 Define this string as the name of your company for
1280 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001281
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001282 CONFIG_USBD_PRODUCT_NAME
1283 Define this string as the name of your product
1284 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001285
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001286 CONFIG_USBD_VENDORID
1287 Define this as your assigned Vendor ID from the USB
1288 Implementors Forum. This *must* be a genuine Vendor ID
1289 to avoid polluting the USB namespace.
1290 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001291
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001292 CONFIG_USBD_PRODUCTID
1293 Define this as the unique Product ID
1294 for your device
1295 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001296
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001297- ULPI Layer Support:
1298 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1299 the generic ULPI layer. The generic layer accesses the ULPI PHY
1300 via the platform viewport, so you need both the genric layer and
1301 the viewport enabled. Currently only Chipidea/ARC based
1302 viewport is supported.
1303 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1304 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001305 If your ULPI phy needs a different reference clock than the
1306 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1307 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001308
wdenk7a428cc2003-06-15 22:40:42 +00001309- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001310 The MMC controller on the Intel PXA is supported. To
1311 enable this define CONFIG_MMC. The MMC can be
1312 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001313 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001314 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1315 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001316
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001317 CONFIG_SH_MMCIF
1318 Support for Renesas on-chip MMCIF controller
1319
1320 CONFIG_SH_MMCIF_ADDR
1321 Define the base address of MMCIF registers
1322
1323 CONFIG_SH_MMCIF_CLK
1324 Define the clock frequency for MMCIF
1325
wdenkda04a8b2004-08-02 23:22:59 +00001326- Journaling Flash filesystem support:
1327 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1328 CONFIG_JFFS2_NAND_DEV
1329 Define these for a default partition on a NAND device
1330
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001331 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1332 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001333 Define these for a default partition on a NOR device
1334
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001335 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001336 Define this to create an own partition. You have to provide a
1337 function struct part_info* jffs2_part_info(int part_num)
1338
1339 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001340 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001341 to disable the command chpart. This is the default when you
1342 have not defined a custom partition
1343
Donggeun Kim8f814002011-10-24 21:15:28 +00001344- FAT(File Allocation Table) filesystem write function support:
1345 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001346
1347 Define this to enable support for saving memory data as a
1348 file in FAT formatted partition.
1349
1350 This will also enable the command "fatwrite" enabling the
1351 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001352
Gabe Black7f8574c2012-10-12 14:26:11 +00001353CBFS (Coreboot Filesystem) support
1354 CONFIG_CMD_CBFS
1355
1356 Define this to enable support for reading from a Coreboot
1357 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1358 and cbfsload.
1359
wdenkc6097192002-11-03 00:24:07 +00001360- Keyboard Support:
1361 CONFIG_ISA_KEYBOARD
1362
1363 Define this to enable standard (PC-Style) keyboard
1364 support
1365
1366 CONFIG_I8042_KBD
1367 Standard PC keyboard driver with US (is default) and
1368 GERMAN key layout (switch via environment 'keymap=de') support.
1369 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1370 for cfb_console. Supports cursor blinking.
1371
1372- Video support:
1373 CONFIG_VIDEO
1374
1375 Define this to enable video support (for output to
1376 video).
1377
1378 CONFIG_VIDEO_CT69000
1379
1380 Enable Chips & Technologies 69000 Video chip
1381
1382 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001383 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001384 video output is selected via environment 'videoout'
1385 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1386 assumed.
wdenkc6097192002-11-03 00:24:07 +00001387
wdenkd3602132004-03-25 15:14:43 +00001388 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001389 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001390 are possible:
1391 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001392 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001393
1394 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1395 -------------+---------------------------------------------
1396 8 bits | 0x301* 0x303 0x305 0x161 0x307
1397 15 bits | 0x310 0x313 0x316 0x162 0x319
1398 16 bits | 0x311 0x314 0x317 0x163 0x31A
1399 24 bits | 0x312 0x315 0x318 ? 0x31B
1400 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001401 (i.e. setenv videomode 317; saveenv; reset;)
1402
wdenkd3602132004-03-25 15:14:43 +00001403 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001404 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001405
1406
stroeseb9c17c52003-04-04 15:53:41 +00001407 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001408 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001409 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1410 or CONFIG_VIDEO_SED13806_16BPP
1411
Timur Tabi020edd22011-02-15 17:09:19 -06001412 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001413 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001414 SOCs that have a DIU should define this macro to enable DIU
1415 support, and should also define these other macros:
1416
1417 CONFIG_SYS_DIU_ADDR
1418 CONFIG_VIDEO
1419 CONFIG_CMD_BMP
1420 CONFIG_CFB_CONSOLE
1421 CONFIG_VIDEO_SW_CURSOR
1422 CONFIG_VGA_AS_SINGLE_DEVICE
1423 CONFIG_VIDEO_LOGO
1424 CONFIG_VIDEO_BMP_LOGO
1425
Timur Tabi32f709e2011-04-11 14:18:22 -05001426 The DIU driver will look for the 'video-mode' environment
1427 variable, and if defined, enable the DIU as a console during
1428 boot. See the documentation file README.video for a
1429 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001430
Simon Glass54df8ce2012-12-03 13:59:47 +00001431 CONFIG_VIDEO_VGA
1432
1433 Enable the VGA video / BIOS for x86. The alternative if you
1434 are using coreboot is to use the coreboot frame buffer
1435 driver.
1436
1437
wdenk4e112c12003-06-03 23:54:09 +00001438- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001439 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001440
wdenk57b2d802003-06-27 21:31:46 +00001441 Define this to enable a custom keyboard support.
1442 This simply calls drv_keyboard_init() which must be
1443 defined in your board-specific files.
1444 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001445
wdenkc6097192002-11-03 00:24:07 +00001446- LCD Support: CONFIG_LCD
1447
1448 Define this to enable LCD support (for output to LCD
1449 display); also select one of the supported displays
1450 by defining one of these:
1451
Stelian Popf6f86652008-05-09 21:57:18 +02001452 CONFIG_ATMEL_LCD:
1453
1454 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1455
wdenkc0d54ae2003-11-25 16:55:19 +00001456 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001457
wdenkc0d54ae2003-11-25 16:55:19 +00001458 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001459
wdenkc0d54ae2003-11-25 16:55:19 +00001460 CONFIG_NEC_NL6448BC20
1461
1462 NEC NL6448BC20-08. 6.5", 640x480.
1463 Active, color, single scan.
1464
1465 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001466
wdenkc0d54ae2003-11-25 16:55:19 +00001467 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001468 Active, color, single scan.
1469
1470 CONFIG_SHARP_16x9
1471
1472 Sharp 320x240. Active, color, single scan.
1473 It isn't 16x9, and I am not sure what it is.
1474
1475 CONFIG_SHARP_LQ64D341
1476
1477 Sharp LQ64D341 display, 640x480.
1478 Active, color, single scan.
1479
1480 CONFIG_HLD1045
1481
1482 HLD1045 display, 640x480.
1483 Active, color, single scan.
1484
1485 CONFIG_OPTREX_BW
1486
1487 Optrex CBL50840-2 NF-FW 99 22 M5
1488 or
1489 Hitachi LMG6912RPFC-00T
1490 or
1491 Hitachi SP14Q002
1492
1493 320x240. Black & white.
1494
1495 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001496 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001497
Simon Glass599a4df2012-10-17 13:24:54 +00001498 CONFIG_LCD_ALIGNMENT
1499
1500 Normally the LCD is page-aligned (tyically 4KB). If this is
1501 defined then the LCD will be aligned to this value instead.
1502 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1503 here, since it is cheaper to change data cache settings on
1504 a per-section basis.
1505
Simon Glassaf3e2802012-10-17 13:24:59 +00001506 CONFIG_CONSOLE_SCROLL_LINES
1507
1508 When the console need to be scrolled, this is the number of
1509 lines to scroll by. It defaults to 1. Increasing this makes
1510 the console jump but can help speed up operation when scrolling
1511 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001512
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001513 CONFIG_LCD_BMP_RLE8
1514
1515 Support drawing of RLE8-compressed bitmaps on the LCD.
1516
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001517 CONFIG_I2C_EDID
1518
1519 Enables an 'i2c edid' command which can read EDID
1520 information over I2C from an attached LCD display.
1521
wdenkeb20ad32003-09-05 23:19:14 +00001522- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001523
wdenk57b2d802003-06-27 21:31:46 +00001524 If this option is set, the environment is checked for
1525 a variable "splashimage". If found, the usual display
1526 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001527 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001528 specified in "splashimage" is loaded instead. The
1529 console is redirected to the "nulldev", too. This
1530 allows for a "silent" boot where a splash screen is
1531 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001532
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001533 CONFIG_SPLASHIMAGE_GUARD
1534
1535 If this option is set, then U-Boot will prevent the environment
1536 variable "splashimage" from being set to a problematic address
1537 (see README.displaying-bmps and README.arm-unaligned-accesses).
1538 This option is useful for targets where, due to alignment
1539 restrictions, an improperly aligned BMP image will cause a data
1540 abort. If you think you will not have problems with unaligned
1541 accesses (for example because your toolchain prevents them)
1542 there is no need to set this option.
1543
Matthias Weisser53884182009-07-09 16:07:30 +02001544 CONFIG_SPLASH_SCREEN_ALIGN
1545
1546 If this option is set the splash image can be freely positioned
1547 on the screen. Environment variable "splashpos" specifies the
1548 position as "x,y". If a positive number is given it is used as
1549 number of pixel from left/top. If a negative number is given it
1550 is used as number of pixel from right/bottom. You can also
1551 specify 'm' for centering the image.
1552
1553 Example:
1554 setenv splashpos m,m
1555 => image at center of screen
1556
1557 setenv splashpos 30,20
1558 => image at x = 30 and y = 20
1559
1560 setenv splashpos -10,m
1561 => vertically centered image
1562 at x = dspWidth - bmpWidth - 9
1563
Nikita Kiryanove0eba1f2013-01-30 21:39:57 +00001564 CONFIG_SPLASH_SCREEN_PREPARE
1565
1566 If this option is set then the board_splash_screen_prepare()
1567 function, which must be defined in your code, is called as part
1568 of the splash screen display sequence. It gives the board an
1569 opportunity to prepare the splash image data before it is
1570 processed and sent to the frame buffer by U-Boot.
1571
Stefan Roesed9d97742005-09-22 09:04:17 +02001572- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1573
1574 If this option is set, additionally to standard BMP
1575 images, gzipped BMP images can be displayed via the
1576 splashscreen support or the bmp command.
1577
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001578- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1579
1580 If this option is set, 8-bit RLE compressed BMP images
1581 can be displayed via the splashscreen support or the
1582 bmp command.
1583
Lei Wene4e248d2012-09-28 04:26:47 +00001584- Do compresssing for memory range:
1585 CONFIG_CMD_ZIP
1586
1587 If this option is set, it would use zlib deflate method
1588 to compress the specified memory at its best effort.
1589
wdenk710e3502003-08-29 20:57:53 +00001590- Compression support:
1591 CONFIG_BZIP2
1592
1593 If this option is set, support for bzip2 compressed
1594 images is included. If not, only uncompressed and gzip
1595 compressed images are supported.
1596
wdenk9c53f402003-10-15 23:53:47 +00001597 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001598 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001599 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001600
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001601 CONFIG_LZMA
1602
1603 If this option is set, support for lzma compressed
1604 images is included.
1605
1606 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1607 requires an amount of dynamic memory that is given by the
1608 formula:
1609
1610 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1611
1612 Where lc and lp stand for, respectively, Literal context bits
1613 and Literal pos bits.
1614
1615 This value is upper-bounded by 14MB in the worst case. Anyway,
1616 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1617 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1618 a very small buffer.
1619
1620 Use the lzmainfo tool to determinate the lc and lp values and
1621 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001622 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001623
wdenk0e2bd9c2004-06-06 21:51:03 +00001624- MII/PHY support:
1625 CONFIG_PHY_ADDR
1626
1627 The address of PHY on MII bus.
1628
1629 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1630
1631 The clock frequency of the MII bus
1632
1633 CONFIG_PHY_GIGE
1634
1635 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001636 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001637
1638 CONFIG_PHY_RESET_DELAY
1639
1640 Some PHY like Intel LXT971A need extra delay after
1641 reset before any MII register access is possible.
1642 For such PHY, set this option to the usec delay
1643 required. (minimum 300usec for LXT971A)
1644
1645 CONFIG_PHY_CMD_DELAY (ppc4xx)
1646
1647 Some PHY like Intel LXT971A need extra delay after
1648 command issued before MII status register can be read
1649
wdenkc6097192002-11-03 00:24:07 +00001650- Ethernet address:
1651 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001652 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001653 CONFIG_ETH2ADDR
1654 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001655 CONFIG_ETH4ADDR
1656 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001657
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001658 Define a default value for Ethernet address to use
1659 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001660 is not determined automatically.
1661
1662- IP address:
1663 CONFIG_IPADDR
1664
1665 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001666 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001667 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001668 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001669
1670- Server IP address:
1671 CONFIG_SERVERIP
1672
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001673 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001674 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001675 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001676
Robin Getz470a6d42009-07-21 12:15:28 -04001677 CONFIG_KEEP_SERVERADDR
1678
1679 Keeps the server's MAC address, in the env 'serveraddr'
1680 for passing to bootargs (like Linux's netconsole option)
1681
Wolfgang Denk26da2992011-10-26 10:21:22 +00001682- Gateway IP address:
1683 CONFIG_GATEWAYIP
1684
1685 Defines a default value for the IP address of the
1686 default router where packets to other networks are
1687 sent to.
1688 (Environment variable "gatewayip")
1689
1690- Subnet mask:
1691 CONFIG_NETMASK
1692
1693 Defines a default value for the subnet mask (or
1694 routing prefix) which is used to determine if an IP
1695 address belongs to the local subnet or needs to be
1696 forwarded through a router.
1697 (Environment variable "netmask")
1698
David Updegraff7280da72007-06-11 10:41:07 -05001699- Multicast TFTP Mode:
1700 CONFIG_MCAST_TFTP
1701
1702 Defines whether you want to support multicast TFTP as per
1703 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001704 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001705 driver in use must provide a function: mcast() to join/leave a
1706 multicast group.
1707
wdenkc6097192002-11-03 00:24:07 +00001708- BOOTP Recovery Mode:
1709 CONFIG_BOOTP_RANDOM_DELAY
1710
1711 If you have many targets in a network that try to
1712 boot using BOOTP, you may want to avoid that all
1713 systems send out BOOTP requests at precisely the same
1714 moment (which would happen for instance at recovery
1715 from a power failure, when all systems will try to
1716 boot, thus flooding the BOOTP server. Defining
1717 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1718 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001719 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001720
1721 1st BOOTP request: delay 0 ... 1 sec
1722 2nd BOOTP request: delay 0 ... 2 sec
1723 3rd BOOTP request: delay 0 ... 4 sec
1724 4th and following
1725 BOOTP requests: delay 0 ... 8 sec
1726
stroesee0aadfb2003-08-28 14:17:32 +00001727- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001728 You can fine tune the DHCP functionality by defining
1729 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001730
Jon Loeliger5336a762007-07-09 22:08:34 -05001731 CONFIG_BOOTP_SUBNETMASK
1732 CONFIG_BOOTP_GATEWAY
1733 CONFIG_BOOTP_HOSTNAME
1734 CONFIG_BOOTP_NISDOMAIN
1735 CONFIG_BOOTP_BOOTPATH
1736 CONFIG_BOOTP_BOOTFILESIZE
1737 CONFIG_BOOTP_DNS
1738 CONFIG_BOOTP_DNS2
1739 CONFIG_BOOTP_SEND_HOSTNAME
1740 CONFIG_BOOTP_NTPSERVER
1741 CONFIG_BOOTP_TIMEOFFSET
1742 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001743 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001744
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001745 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1746 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001747
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001748 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1749 after the configured retry count, the call will fail
1750 instead of starting over. This can be used to fail over
1751 to Link-local IP address configuration if the DHCP server
1752 is not available.
1753
stroesee0aadfb2003-08-28 14:17:32 +00001754 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1755 serverip from a DHCP server, it is possible that more
1756 than one DNS serverip is offered to the client.
1757 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1758 serverip will be stored in the additional environment
1759 variable "dnsip2". The first DNS serverip is always
1760 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001761 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001762
1763 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1764 to do a dynamic update of a DNS server. To do this, they
1765 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001766 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001767 of the "hostname" environment variable is passed as
1768 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001769
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001770 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1771
1772 A 32bit value in microseconds for a delay between
1773 receiving a "DHCP Offer" and sending the "DHCP Request".
1774 This fixes a problem with certain DHCP servers that don't
1775 respond 100% of the time to a "DHCP request". E.g. On an
1776 AT91RM9200 processor running at 180MHz, this delay needed
1777 to be *at least* 15,000 usec before a Windows Server 2003
1778 DHCP server would reply 100% of the time. I recommend at
1779 least 50,000 usec to be safe. The alternative is to hope
1780 that one of the retries will be successful but note that
1781 the DHCP timeout and retry process takes a longer than
1782 this delay.
1783
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001784 - Link-local IP address negotiation:
1785 Negotiate with other link-local clients on the local network
1786 for an address that doesn't require explicit configuration.
1787 This is especially useful if a DHCP server cannot be guaranteed
1788 to exist in all environments that the device must operate.
1789
1790 See doc/README.link-local for more information.
1791
wdenk145d2c12004-04-15 21:48:45 +00001792 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001793 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001794
1795 The device id used in CDP trigger frames.
1796
1797 CONFIG_CDP_DEVICE_ID_PREFIX
1798
1799 A two character string which is prefixed to the MAC address
1800 of the device.
1801
1802 CONFIG_CDP_PORT_ID
1803
1804 A printf format string which contains the ascii name of
1805 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001806 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001807
1808 CONFIG_CDP_CAPABILITIES
1809
1810 A 32bit integer which indicates the device capabilities;
1811 0x00000010 for a normal host which does not forwards.
1812
1813 CONFIG_CDP_VERSION
1814
1815 An ascii string containing the version of the software.
1816
1817 CONFIG_CDP_PLATFORM
1818
1819 An ascii string containing the name of the platform.
1820
1821 CONFIG_CDP_TRIGGER
1822
1823 A 32bit integer sent on the trigger.
1824
1825 CONFIG_CDP_POWER_CONSUMPTION
1826
1827 A 16bit integer containing the power consumption of the
1828 device in .1 of milliwatts.
1829
1830 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1831
1832 A byte containing the id of the VLAN.
1833
wdenkc6097192002-11-03 00:24:07 +00001834- Status LED: CONFIG_STATUS_LED
1835
1836 Several configurations allow to display the current
1837 status using a LED. For instance, the LED will blink
1838 fast while running U-Boot code, stop blinking as
1839 soon as a reply to a BOOTP request was received, and
1840 start blinking slow once the Linux kernel is running
1841 (supported by a status LED driver in the Linux
1842 kernel). Defining CONFIG_STATUS_LED enables this
1843 feature in U-Boot.
1844
1845- CAN Support: CONFIG_CAN_DRIVER
1846
1847 Defining CONFIG_CAN_DRIVER enables CAN driver support
1848 on those systems that support this (optional)
1849 feature, like the TQM8xxL modules.
1850
1851- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1852
wdenkb9bbd242003-06-30 16:24:52 +00001853 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001854 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001855 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001856
wdenk21136db2003-07-16 21:53:01 +00001857 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001858 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001859 CONFIG_COMMANDS) and communicate with i2c based realtime
1860 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001861 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001862
Ben Warren45657152006-09-07 16:50:54 -04001863 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001864
wdenk21136db2003-07-16 21:53:01 +00001865 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001866 bit-banging) driver instead of CPM or similar hardware
1867 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001868
wdenk21136db2003-07-16 21:53:01 +00001869 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001870 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001872 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001873 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001874 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001875 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001876
Peter Tysere4d1abc2010-04-12 22:28:21 -05001877 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001878 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001879 and so its address should therefore be cleared to 0 (See,
1880 eg, MPC823e User's Manual p.16-473). So, set
1881 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001882
Eric Millbrandt12990a42009-09-03 08:09:44 -05001883 CONFIG_SYS_I2C_INIT_MPC5XXX
1884
1885 When a board is reset during an i2c bus transfer
1886 chips might think that the current transfer is still
1887 in progress. Reset the slave devices by sending start
1888 commands until the slave device responds.
1889
wdenk21136db2003-07-16 21:53:01 +00001890 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001891
wdenkb9bbd242003-06-30 16:24:52 +00001892 If you use the software i2c interface (CONFIG_SOFT_I2C)
1893 then the following macros need to be defined (examples are
1894 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001895
1896 I2C_INIT
1897
wdenkb9bbd242003-06-30 16:24:52 +00001898 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001899 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001900
wdenk544e9732004-02-06 23:19:44 +00001901 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001902
wdenkc6097192002-11-03 00:24:07 +00001903 I2C_PORT
1904
wdenk4a5c8a72003-03-06 00:02:04 +00001905 (Only for MPC8260 CPU). The I/O port to use (the code
1906 assumes both bits are on the same port). Valid values
1907 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001908
1909 I2C_ACTIVE
1910
1911 The code necessary to make the I2C data line active
1912 (driven). If the data line is open collector, this
1913 define can be null.
1914
wdenkb9bbd242003-06-30 16:24:52 +00001915 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1916
wdenkc6097192002-11-03 00:24:07 +00001917 I2C_TRISTATE
1918
1919 The code necessary to make the I2C data line tri-stated
1920 (inactive). If the data line is open collector, this
1921 define can be null.
1922
wdenkb9bbd242003-06-30 16:24:52 +00001923 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1924
wdenkc6097192002-11-03 00:24:07 +00001925 I2C_READ
1926
1927 Code that returns TRUE if the I2C data line is high,
1928 FALSE if it is low.
1929
wdenkb9bbd242003-06-30 16:24:52 +00001930 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1931
wdenkc6097192002-11-03 00:24:07 +00001932 I2C_SDA(bit)
1933
1934 If <bit> is TRUE, sets the I2C data line high. If it
1935 is FALSE, it clears it (low).
1936
wdenkb9bbd242003-06-30 16:24:52 +00001937 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001938 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001939 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001940
wdenkc6097192002-11-03 00:24:07 +00001941 I2C_SCL(bit)
1942
1943 If <bit> is TRUE, sets the I2C clock line high. If it
1944 is FALSE, it clears it (low).
1945
wdenkb9bbd242003-06-30 16:24:52 +00001946 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001947 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001948 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001949
wdenkc6097192002-11-03 00:24:07 +00001950 I2C_DELAY
1951
1952 This delay is invoked four times per clock cycle so this
1953 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001954 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001955 like:
1956
wdenkb9bbd242003-06-30 16:24:52 +00001957 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001958
Mike Frysingeree12d542010-07-21 13:38:02 -04001959 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1960
1961 If your arch supports the generic GPIO framework (asm/gpio.h),
1962 then you may alternatively define the two GPIOs that are to be
1963 used as SCL / SDA. Any of the previous I2C_xxx macros will
1964 have GPIO-based defaults assigned to them as appropriate.
1965
1966 You should define these to the GPIO value as given directly to
1967 the generic GPIO functions.
1968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001969 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001970
wdenk57b2d802003-06-27 21:31:46 +00001971 When a board is reset during an i2c bus transfer
1972 chips might think that the current transfer is still
1973 in progress. On some boards it is possible to access
1974 the i2c SCLK line directly, either by using the
1975 processor pin as a GPIO or by having a second pin
1976 connected to the bus. If this option is defined a
1977 custom i2c_init_board() routine in boards/xxx/board.c
1978 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001979
Richard Retanubundf0149c2010-04-12 15:08:17 -04001980 CONFIG_SYS_I2C_BOARD_LATE_INIT
1981
1982 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1983 defined a custom i2c_board_late_init() routine in
1984 boards/xxx/board.c is run AFTER the operations in i2c_init()
1985 is completed. This callpoint can be used to unreset i2c bus
1986 using CPU i2c controller register accesses for CPUs whose i2c
1987 controller provide such a method. It is called at the end of
1988 i2c_init() to allow i2c_init operations to setup the i2c bus
1989 controller on the CPU (e.g. setting bus speed & slave address).
1990
wdenk0e2bd9c2004-06-06 21:51:03 +00001991 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1992
1993 This option enables configuration of bi_iic_fast[] flags
1994 in u-boot bd_info structure based on u-boot environment
1995 variable "i2cfast". (see also i2cfast)
1996
Ben Warren45657152006-09-07 16:50:54 -04001997 CONFIG_I2C_MULTI_BUS
1998
1999 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002000 must have a controller. At any point in time, only one bus is
2001 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002002 Note that bus numbering is zero-based.
2003
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002004 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002005
2006 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002007 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002008 is set, specify a list of bus-device pairs. Otherwise, specify
2009 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002010
2011 e.g.
2012 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002013 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002014
2015 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2016
Wolfgang Denk092ae952011-10-26 10:21:21 +00002017 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002018 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002019
2020 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002022 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002023
2024 If defined, then this indicates the I2C bus number for DDR SPD.
2025 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2026
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002027 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002028
2029 If defined, then this indicates the I2C bus number for the RTC.
2030 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2031
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002032 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002033
2034 If defined, then this indicates the I2C bus number for the DTT.
2035 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2036
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002037 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002038
2039 If defined, specifies the I2C address of the DTT device.
2040 If not defined, then U-Boot uses predefined value for
2041 specified DTT device.
2042
Timur Tabiab347542006-11-03 19:15:00 -06002043 CONFIG_FSL_I2C
2044
2045 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002046 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002047
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002048 CONFIG_I2C_MUX
2049
2050 Define this option if you have I2C devices reached over 1 .. n
2051 I2C Muxes like the pca9544a. This option addes a new I2C
2052 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2053 new I2C Bus to the existing I2C Busses. If you select the
2054 new Bus with "i2c dev", u-bbot sends first the commandos for
2055 the muxes to activate this new "bus".
2056
2057 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2058 feature!
2059
2060 Example:
2061 Adding a new I2C Bus reached over 2 pca9544a muxes
2062 The First mux with address 70 and channel 6
2063 The Second mux with address 71 and channel 4
2064
2065 => i2c bus pca9544a:70:6:pca9544a:71:4
2066
2067 Use the "i2c bus" command without parameter, to get a list
2068 of I2C Busses with muxes:
2069
2070 => i2c bus
2071 Busses reached over muxes:
2072 Bus ID: 2
2073 reached over Mux(es):
2074 pca9544a@70 ch: 4
2075 Bus ID: 3
2076 reached over Mux(es):
2077 pca9544a@70 ch: 6
2078 pca9544a@71 ch: 4
2079 =>
2080
2081 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002082 u-boot first sends the command to the mux@70 to enable
2083 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002084 the channel 4.
2085
2086 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002087 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002088 the 2 muxes.
2089
2090 This option is actually implemented for the bitbanging
2091 algorithm in common/soft_i2c.c and for the Hardware I2C
2092 Bus on the MPC8260. But it should be not so difficult
2093 to add this option to other architectures.
2094
Andrew Dyer58c41f92008-12-29 17:36:01 -06002095 CONFIG_SOFT_I2C_READ_REPEATED_START
2096
2097 defining this will force the i2c_read() function in
2098 the soft_i2c driver to perform an I2C repeated start
2099 between writing the address pointer and reading the
2100 data. If this define is omitted the default behaviour
2101 of doing a stop-start sequence will be used. Most I2C
2102 devices can use either method, but some require one or
2103 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002104
wdenkc6097192002-11-03 00:24:07 +00002105- SPI Support: CONFIG_SPI
2106
2107 Enables SPI driver (so far only tested with
2108 SPI EEPROM, also an instance works with Crystal A/D and
2109 D/As on the SACSng board)
2110
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002111 CONFIG_SH_SPI
2112
2113 Enables the driver for SPI controller on SuperH. Currently
2114 only SH7757 is supported.
2115
wdenkc6097192002-11-03 00:24:07 +00002116 CONFIG_SPI_X
2117
2118 Enables extended (16-bit) SPI EEPROM addressing.
2119 (symmetrical to CONFIG_I2C_X)
2120
2121 CONFIG_SOFT_SPI
2122
wdenk4a5c8a72003-03-06 00:02:04 +00002123 Enables a software (bit-bang) SPI driver rather than
2124 using hardware support. This is a general purpose
2125 driver that only requires three general I/O port pins
2126 (two outputs, one input) to function. If this is
2127 defined, the board configuration must define several
2128 SPI configuration items (port pins to use, etc). For
2129 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002130
Ben Warren7efe9272008-01-16 22:37:35 -05002131 CONFIG_HARD_SPI
2132
2133 Enables a hardware SPI driver for general-purpose reads
2134 and writes. As with CONFIG_SOFT_SPI, the board configuration
2135 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002136 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002137 example, see include/configs/mpc8349emds.h.
2138
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002139 CONFIG_MXC_SPI
2140
2141 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002142 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002143
Matthias Fuchsa4400872007-12-27 17:12:34 +01002144- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002145
Matthias Fuchsa4400872007-12-27 17:12:34 +01002146 Enables FPGA subsystem.
2147
2148 CONFIG_FPGA_<vendor>
2149
2150 Enables support for specific chip vendors.
2151 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002152
Matthias Fuchsa4400872007-12-27 17:12:34 +01002153 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002154
Matthias Fuchsa4400872007-12-27 17:12:34 +01002155 Enables support for FPGA family.
2156 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2157
2158 CONFIG_FPGA_COUNT
2159
2160 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002162 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002163
wdenk57b2d802003-06-27 21:31:46 +00002164 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002165
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002166 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002167
wdenk4a5c8a72003-03-06 00:02:04 +00002168 Enable checks on FPGA configuration interface busy
2169 status by the configuration function. This option
2170 will require a board or device specific function to
2171 be written.
wdenkc6097192002-11-03 00:24:07 +00002172
2173 CONFIG_FPGA_DELAY
2174
2175 If defined, a function that provides delays in the FPGA
2176 configuration driver.
2177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002178 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002179 Allow Control-C to interrupt FPGA configuration
2180
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002181 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002182
wdenk4a5c8a72003-03-06 00:02:04 +00002183 Check for configuration errors during FPGA bitfile
2184 loading. For example, abort during Virtex II
2185 configuration if the INIT_B line goes low (which
2186 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002188 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002189
wdenk4a5c8a72003-03-06 00:02:04 +00002190 Maximum time to wait for the INIT_B line to deassert
2191 after PROB_B has been deasserted during a Virtex II
2192 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002193 ms.
wdenkc6097192002-11-03 00:24:07 +00002194
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002195 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002196
wdenk4a5c8a72003-03-06 00:02:04 +00002197 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002198 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002200 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002201
wdenk4a5c8a72003-03-06 00:02:04 +00002202 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002203 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002204
2205- Configuration Management:
2206 CONFIG_IDENT_STRING
2207
wdenk4a5c8a72003-03-06 00:02:04 +00002208 If defined, this string will be added to the U-Boot
2209 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002210
2211- Vendor Parameter Protection:
2212
wdenk4a5c8a72003-03-06 00:02:04 +00002213 U-Boot considers the values of the environment
2214 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002215 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002216 are set once by the board vendor / manufacturer, and
2217 protects these variables from casual modification by
2218 the user. Once set, these variables are read-only,
2219 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002220 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002221
2222 If CONFIG_ENV_OVERWRITE is #defined in your config
2223 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002224 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002225 these parameters.
2226
2227 Alternatively, if you #define _both_ CONFIG_ETHADDR
2228 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002229 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002230 which can be changed exactly ONCE by the user. [The
2231 serial# is unaffected by this, i. e. it remains
2232 read-only.]
2233
Joe Hershberger71497d02012-12-11 22:16:31 -06002234 The same can be accomplished in a more flexible way
2235 for any variable by configuring the type of access
2236 to allow for those variables in the ".flags" variable
2237 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2238
wdenkc6097192002-11-03 00:24:07 +00002239- Protected RAM:
2240 CONFIG_PRAM
2241
2242 Define this variable to enable the reservation of
2243 "protected RAM", i. e. RAM which is not overwritten
2244 by U-Boot. Define CONFIG_PRAM to hold the number of
2245 kB you want to reserve for pRAM. You can overwrite
2246 this default value by defining an environment
2247 variable "pram" to the number of kB you want to
2248 reserve. Note that the board info structure will
2249 still show the full amount of RAM. If pRAM is
2250 reserved, a new environment variable "mem" will
2251 automatically be defined to hold the amount of
2252 remaining RAM in a form that can be passed as boot
2253 argument to Linux, for instance like that:
2254
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002255 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002256 saveenv
2257
2258 This way you can tell Linux not to use this memory,
2259 either, which results in a memory region that will
2260 not be affected by reboots.
2261
2262 *WARNING* If your board configuration uses automatic
2263 detection of the RAM size, you must make sure that
2264 this memory test is non-destructive. So far, the
2265 following board configurations are known to be
2266 "pRAM-clean":
2267
Wolfgang Denk90326762012-10-24 02:36:15 +00002268 IVMS8, IVML24, SPD8xx, TQM8xxL,
2269 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002270 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002271
Gabe Blacka2f3a932012-12-02 04:55:18 +00002272- Access to physical memory region (> 4GB)
2273 Some basic support is provided for operations on memory not
2274 normally accessible to U-Boot - e.g. some architectures
2275 support access to more than 4GB of memory on 32-bit
2276 machines using physical address extension or similar.
2277 Define CONFIG_PHYSMEM to access this basic support, which
2278 currently only supports clearing the memory.
2279
wdenkc6097192002-11-03 00:24:07 +00002280- Error Recovery:
2281 CONFIG_PANIC_HANG
2282
2283 Define this variable to stop the system in case of a
2284 fatal error, so that you have to reset it manually.
2285 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002287 automatically as fast as possible, but it may be
2288 useful during development since you can try to debug
2289 the conditions that lead to the situation.
2290
2291 CONFIG_NET_RETRY_COUNT
2292
wdenk4a5c8a72003-03-06 00:02:04 +00002293 This variable defines the number of retries for
2294 network operations like ARP, RARP, TFTP, or BOOTP
2295 before giving up the operation. If not defined, a
2296 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002297
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002298 CONFIG_ARP_TIMEOUT
2299
2300 Timeout waiting for an ARP reply in milliseconds.
2301
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002302 CONFIG_NFS_TIMEOUT
2303
2304 Timeout in milliseconds used in NFS protocol.
2305 If you encounter "ERROR: Cannot umount" in nfs command,
2306 try longer timeout such as
2307 #define CONFIG_NFS_TIMEOUT 10000UL
2308
wdenkc6097192002-11-03 00:24:07 +00002309- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002310 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002311
2312 Enable auto completion of commands using TAB.
2313
Wolfgang Denk018147d2006-11-27 15:32:42 +01002314 Note that this feature has NOT been implemented yet
2315 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002316
2317
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002318 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002319
2320 Define this variable to enable the "hush" shell (from
2321 Busybox) as command line interpreter, thus enabling
2322 powerful command line syntax like
2323 if...then...else...fi conditionals or `&&' and '||'
2324 constructs ("shell scripts").
2325
2326 If undefined, you get the old, much simpler behaviour
2327 with a somewhat smaller memory footprint.
2328
2329
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002330 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002331
2332 This defines the secondary prompt string, which is
2333 printed when the command interpreter needs more input
2334 to complete a command. Usually "> ".
2335
2336 Note:
2337
wdenk57b2d802003-06-27 21:31:46 +00002338 In the current implementation, the local variables
2339 space and global environment variables space are
2340 separated. Local variables are those you define by
2341 simply typing `name=value'. To access a local
2342 variable later on, you have write `$name' or
2343 `${name}'; to execute the contents of a variable
2344 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002345
wdenk4a5c8a72003-03-06 00:02:04 +00002346 Global environment variables are those you use
2347 setenv/printenv to work with. To run a command stored
2348 in such a variable, you need to use the run command,
2349 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002350
2351 To store commands and special characters in a
2352 variable, please use double quotation marks
2353 surrounding the whole text of the variable, instead
2354 of the backslashes before semicolons and special
2355 symbols.
2356
Wolfgang Denk2039a072006-07-21 11:35:21 +02002357- Commandline Editing and History:
2358 CONFIG_CMDLINE_EDITING
2359
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002360 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002361 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002362
wdenkc0aa5c52003-12-06 19:49:23 +00002363- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002364 CONFIG_EXTRA_ENV_SETTINGS
2365
wdenk4a5c8a72003-03-06 00:02:04 +00002366 Define this to contain any number of null terminated
2367 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002368 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002369
wdenk4a5c8a72003-03-06 00:02:04 +00002370 For example, place something like this in your
2371 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002372
2373 #define CONFIG_EXTRA_ENV_SETTINGS \
2374 "myvar1=value1\0" \
2375 "myvar2=value2\0"
2376
wdenk4a5c8a72003-03-06 00:02:04 +00002377 Warning: This method is based on knowledge about the
2378 internal format how the environment is stored by the
2379 U-Boot code. This is NOT an official, exported
2380 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002381 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002382 You better know what you are doing here.
2383
wdenk4a5c8a72003-03-06 00:02:04 +00002384 Note: overly (ab)use of the default environment is
2385 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002386 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002387 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002388
Stephen Warren1465d5f2012-05-22 09:21:54 +00002389 CONFIG_ENV_VARS_UBOOT_CONFIG
2390
2391 Define this in order to add variables describing the
2392 U-Boot build configuration to the default environment.
2393 These will be named arch, cpu, board, vendor, and soc.
2394
2395 Enabling this option will cause the following to be defined:
2396
2397 - CONFIG_SYS_ARCH
2398 - CONFIG_SYS_CPU
2399 - CONFIG_SYS_BOARD
2400 - CONFIG_SYS_VENDOR
2401 - CONFIG_SYS_SOC
2402
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002403 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2404
2405 Define this in order to add variables describing certain
2406 run-time determined information about the hardware to the
2407 environment. These will be named board_name, board_rev.
2408
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002409 CONFIG_DELAY_ENVIRONMENT
2410
2411 Normally the environment is loaded when the board is
2412 intialised so that it is available to U-Boot. This inhibits
2413 that so that the environment is not available until
2414 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2415 this is instead controlled by the value of
2416 /config/load-environment.
2417
wdenkc0aa5c52003-12-06 19:49:23 +00002418- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002419 CONFIG_HAS_DATAFLASH
2420
wdenk57b2d802003-06-27 21:31:46 +00002421 Defining this option enables DataFlash features and
2422 allows to read/write in Dataflash via the standard
2423 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002424
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002425- Serial Flash support
2426 CONFIG_CMD_SF
2427
2428 Defining this option enables SPI flash commands
2429 'sf probe/read/write/erase/update'.
2430
2431 Usage requires an initial 'probe' to define the serial
2432 flash parameters, followed by read/write/erase/update
2433 commands.
2434
2435 The following defaults may be provided by the platform
2436 to handle the common case when only a single serial
2437 flash is present on the system.
2438
2439 CONFIG_SF_DEFAULT_BUS Bus identifier
2440 CONFIG_SF_DEFAULT_CS Chip-select
2441 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2442 CONFIG_SF_DEFAULT_SPEED in Hz
2443
Simon Glass4b5545e2012-10-08 13:16:02 +00002444 CONFIG_CMD_SF_TEST
2445
2446 Define this option to include a destructive SPI flash
2447 test ('sf test').
2448
wdenkef893942004-02-23 16:11:30 +00002449- SystemACE Support:
2450 CONFIG_SYSTEMACE
2451
2452 Adding this option adds support for Xilinx SystemACE
2453 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002454 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002455 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002456
2457 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002458 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002459
2460 When SystemACE support is added, the "ace" device type
2461 becomes available to the fat commands, i.e. fatls.
2462
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002463- TFTP Fixed UDP Port:
2464 CONFIG_TFTP_PORT
2465
Wolfgang Denk227b5192005-09-24 23:25:46 +02002466 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002467 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002468 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002469 number generator is used.
2470
Wolfgang Denk227b5192005-09-24 23:25:46 +02002471 Also, the environment variable tftpdstp is used to supply
2472 the TFTP UDP destination port value. If tftpdstp isn't
2473 defined, the normal port 69 is used.
2474
2475 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002476 blindly start the TFTP transfer using the pre-configured
2477 target IP address and UDP port. This has the effect of
2478 "punching through" the (Windows XP) firewall, allowing
2479 the remainder of the TFTP transfer to proceed normally.
2480 A better solution is to properly configure the firewall,
2481 but sometimes that is not allowed.
2482
Simon Glass058bb8d2012-12-05 14:46:38 +00002483- Hashing support:
2484 CONFIG_CMD_HASH
2485
2486 This enables a generic 'hash' command which can produce
2487 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2488
2489 CONFIG_HASH_VERIFY
2490
2491 Enable the hash verify command (hash -v). This adds to code
2492 size a little.
2493
2494 CONFIG_SHA1 - support SHA1 hashing
2495 CONFIG_SHA256 - support SHA256 hashing
2496
2497 Note: There is also a sha1sum command, which should perhaps
2498 be deprecated in favour of 'hash sha1'.
2499
wdenkc0aa5c52003-12-06 19:49:23 +00002500- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002501 CONFIG_SHOW_BOOT_PROGRESS
2502
wdenk4a5c8a72003-03-06 00:02:04 +00002503 Defining this option allows to add some board-
2504 specific code (calling a user-provided function
2505 "show_boot_progress(int)") that enables you to show
2506 the system's boot progress on some display (for
2507 example, some LED's) on your board. At the moment,
2508 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002509
Simon Glass31a870e2012-02-13 13:51:19 +00002510- Detailed boot stage timing
2511 CONFIG_BOOTSTAGE
2512 Define this option to get detailed timing of each stage
2513 of the boot process.
2514
2515 CONFIG_BOOTSTAGE_USER_COUNT
2516 This is the number of available user bootstage records.
2517 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2518 a new ID will be allocated from this stash. If you exceed
2519 the limit, recording will stop.
2520
2521 CONFIG_BOOTSTAGE_REPORT
2522 Define this to print a report before boot, similar to this:
2523
2524 Timer summary in microseconds:
2525 Mark Elapsed Stage
2526 0 0 reset
2527 3,575,678 3,575,678 board_init_f start
2528 3,575,695 17 arch_cpu_init A9
2529 3,575,777 82 arch_cpu_init done
2530 3,659,598 83,821 board_init_r start
2531 3,910,375 250,777 main_loop
2532 29,916,167 26,005,792 bootm_start
2533 30,361,327 445,160 start_kernel
2534
Simon Glass4afd88e2012-09-28 08:56:39 +00002535 CONFIG_CMD_BOOTSTAGE
2536 Add a 'bootstage' command which supports printing a report
2537 and un/stashing of bootstage data.
2538
Simon Glass0fa36a42012-09-28 08:56:37 +00002539 CONFIG_BOOTSTAGE_FDT
2540 Stash the bootstage information in the FDT. A root 'bootstage'
2541 node is created with each bootstage id as a child. Each child
2542 has a 'name' property and either 'mark' containing the
2543 mark time in microsecond, or 'accum' containing the
2544 accumulated time for that bootstage id in microseconds.
2545 For example:
2546
2547 bootstage {
2548 154 {
2549 name = "board_init_f";
2550 mark = <3575678>;
2551 };
2552 170 {
2553 name = "lcd";
2554 accum = <33482>;
2555 };
2556 };
2557
2558 Code in the Linux kernel can find this in /proc/devicetree.
2559
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002560Legacy uImage format:
2561
wdenkc6097192002-11-03 00:24:07 +00002562 Arg Where When
2563 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002564 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002565 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002566 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002567 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002568 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002569 4 common/cmd_bootm.c Image data has correct checksum
2570 -4 common/cmd_bootm.c Image is for unsupported architecture
2571 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002572 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002573 6 common/cmd_bootm.c Image Type check OK
2574 -6 common/cmd_bootm.c gunzip uncompression error
2575 -7 common/cmd_bootm.c Unimplemented compression type
2576 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002577 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002578 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002579
2580 9 common/image.c Start initial ramdisk verification
2581 -10 common/image.c Ramdisk header has bad magic number
2582 -11 common/image.c Ramdisk header has bad checksum
2583 10 common/image.c Ramdisk header is OK
2584 -12 common/image.c Ramdisk data has bad checksum
2585 11 common/image.c Ramdisk data has correct checksum
2586 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002587 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002588 13 common/image.c Start multifile image verification
2589 14 common/image.c No initial ramdisk, no multifile, continue.
2590
Wolfgang Denk092ae952011-10-26 10:21:21 +00002591 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002592
Stefan Roese88fbf932010-04-15 16:07:28 +02002593 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002594 -31 post/post.c POST test failed, detected by post_output_backlog()
2595 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002596
Heiko Schocher633e03a2007-06-22 19:11:54 +02002597 34 common/cmd_doc.c before loading a Image from a DOC device
2598 -35 common/cmd_doc.c Bad usage of "doc" command
2599 35 common/cmd_doc.c correct usage of "doc" command
2600 -36 common/cmd_doc.c No boot device
2601 36 common/cmd_doc.c correct boot device
2602 -37 common/cmd_doc.c Unknown Chip ID on boot device
2603 37 common/cmd_doc.c correct chip ID found, device available
2604 -38 common/cmd_doc.c Read Error on boot device
2605 38 common/cmd_doc.c reading Image header from DOC device OK
2606 -39 common/cmd_doc.c Image header has bad magic number
2607 39 common/cmd_doc.c Image header has correct magic number
2608 -40 common/cmd_doc.c Error reading Image from DOC device
2609 40 common/cmd_doc.c Image header has correct magic number
2610 41 common/cmd_ide.c before loading a Image from a IDE device
2611 -42 common/cmd_ide.c Bad usage of "ide" command
2612 42 common/cmd_ide.c correct usage of "ide" command
2613 -43 common/cmd_ide.c No boot device
2614 43 common/cmd_ide.c boot device found
2615 -44 common/cmd_ide.c Device not available
2616 44 common/cmd_ide.c Device available
2617 -45 common/cmd_ide.c wrong partition selected
2618 45 common/cmd_ide.c partition selected
2619 -46 common/cmd_ide.c Unknown partition table
2620 46 common/cmd_ide.c valid partition table found
2621 -47 common/cmd_ide.c Invalid partition type
2622 47 common/cmd_ide.c correct partition type
2623 -48 common/cmd_ide.c Error reading Image Header on boot device
2624 48 common/cmd_ide.c reading Image Header from IDE device OK
2625 -49 common/cmd_ide.c Image header has bad magic number
2626 49 common/cmd_ide.c Image header has correct magic number
2627 -50 common/cmd_ide.c Image header has bad checksum
2628 50 common/cmd_ide.c Image header has correct checksum
2629 -51 common/cmd_ide.c Error reading Image from IDE device
2630 51 common/cmd_ide.c reading Image from IDE device OK
2631 52 common/cmd_nand.c before loading a Image from a NAND device
2632 -53 common/cmd_nand.c Bad usage of "nand" command
2633 53 common/cmd_nand.c correct usage of "nand" command
2634 -54 common/cmd_nand.c No boot device
2635 54 common/cmd_nand.c boot device found
2636 -55 common/cmd_nand.c Unknown Chip ID on boot device
2637 55 common/cmd_nand.c correct chip ID found, device available
2638 -56 common/cmd_nand.c Error reading Image Header on boot device
2639 56 common/cmd_nand.c reading Image Header from NAND device OK
2640 -57 common/cmd_nand.c Image header has bad magic number
2641 57 common/cmd_nand.c Image header has correct magic number
2642 -58 common/cmd_nand.c Error reading Image from NAND device
2643 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002644
Heiko Schocher633e03a2007-06-22 19:11:54 +02002645 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002646
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002647 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002648 -64 net/eth.c no Ethernet found.
2649 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002650
Heiko Schocher633e03a2007-06-22 19:11:54 +02002651 -80 common/cmd_net.c usage wrong
2652 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002653 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002654 81 common/cmd_net.c NetLoop() back without error
2655 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2656 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002657 83 common/cmd_net.c running "source" command
2658 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002659 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002660
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002661FIT uImage format:
2662
2663 Arg Where When
2664 100 common/cmd_bootm.c Kernel FIT Image has correct format
2665 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2666 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2667 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2668 102 common/cmd_bootm.c Kernel unit name specified
2669 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002670 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002671 104 common/cmd_bootm.c Got kernel subimage node offset
2672 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2673 105 common/cmd_bootm.c Kernel subimage hash verification OK
2674 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2675 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002676 -106 common/cmd_bootm.c Kernel subimage has wrong type
2677 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002678 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2679 108 common/cmd_bootm.c Got kernel subimage data/size
2680 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2681 -109 common/cmd_bootm.c Can't get kernel subimage type
2682 -110 common/cmd_bootm.c Can't get kernel subimage comp
2683 -111 common/cmd_bootm.c Can't get kernel subimage os
2684 -112 common/cmd_bootm.c Can't get kernel subimage load address
2685 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2686
2687 120 common/image.c Start initial ramdisk verification
2688 -120 common/image.c Ramdisk FIT image has incorrect format
2689 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002690 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002691 -122 common/image.c Can't get configuration for ramdisk subimage
2692 123 common/image.c Ramdisk unit name specified
2693 -124 common/image.c Can't get ramdisk subimage node offset
2694 125 common/image.c Got ramdisk subimage node offset
2695 -125 common/image.c Ramdisk subimage hash verification failed
2696 126 common/image.c Ramdisk subimage hash verification OK
2697 -126 common/image.c Ramdisk subimage for unsupported architecture
2698 127 common/image.c Architecture check OK
2699 -127 common/image.c Can't get ramdisk subimage data/size
2700 128 common/image.c Got ramdisk subimage data/size
2701 129 common/image.c Can't get ramdisk load address
2702 -129 common/image.c Got ramdisk load address
2703
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002704 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002705 131 common/cmd_doc.c FIT image format OK
2706
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002707 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002708 141 common/cmd_ide.c FIT image format OK
2709
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002710 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002711 151 common/cmd_nand.c FIT image format OK
2712
Gabe Blackd572e162012-10-25 16:31:10 +00002713- FIT image support:
2714 CONFIG_FIT
2715 Enable support for the FIT uImage format.
2716
2717 CONFIG_FIT_BEST_MATCH
2718 When no configuration is explicitly selected, default to the
2719 one whose fdt's compatibility field best matches that of
2720 U-Boot itself. A match is considered "best" if it matches the
2721 most specific compatibility entry of U-Boot's fdt's root node.
2722 The order of entries in the configuration's fdt is ignored.
2723
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002724- Standalone program support:
2725 CONFIG_STANDALONE_LOAD_ADDR
2726
Wolfgang Denk23f78482011-10-09 21:06:34 +02002727 This option defines a board specific value for the
2728 address where standalone program gets loaded, thus
2729 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002730 settings.
2731
2732- Frame Buffer Address:
2733 CONFIG_FB_ADDR
2734
2735 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002736 address for frame buffer. This is typically the case
2737 when using a graphics controller has separate video
2738 memory. U-Boot will then place the frame buffer at
2739 the given address instead of dynamically reserving it
2740 in system RAM by calling lcd_setmem(), which grabs
2741 the memory for the frame buffer depending on the
2742 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002743
2744 Please see board_init_f function.
2745
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002746- Automatic software updates via TFTP server
2747 CONFIG_UPDATE_TFTP
2748 CONFIG_UPDATE_TFTP_CNT_MAX
2749 CONFIG_UPDATE_TFTP_MSEC_MAX
2750
2751 These options enable and control the auto-update feature;
2752 for a more detailed description refer to doc/README.update.
2753
2754- MTD Support (mtdparts command, UBI support)
2755 CONFIG_MTD_DEVICE
2756
2757 Adds the MTD device infrastructure from the Linux kernel.
2758 Needed for mtdparts command support.
2759
2760 CONFIG_MTD_PARTITIONS
2761
2762 Adds the MTD partitioning infrastructure from the Linux
2763 kernel. Needed for UBI support.
2764
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002765- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002766 CONFIG_SPL
2767 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002768
Tom Rini36853852012-02-14 07:29:40 +00002769 CONFIG_SPL_LDSCRIPT
2770 LDSCRIPT for linking the SPL binary.
2771
2772 CONFIG_SPL_MAX_SIZE
2773 Maximum binary size (text, data and rodata) of the SPL binary.
2774
Wolfgang Denk825223d2011-09-11 21:24:09 +02002775 CONFIG_SPL_TEXT_BASE
2776 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002777
Scott Woodc4f0d002012-09-20 19:05:12 -05002778 CONFIG_SPL_RELOC_TEXT_BASE
2779 Address to relocate to. If unspecified, this is equal to
2780 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2781
Tom Rini36853852012-02-14 07:29:40 +00002782 CONFIG_SPL_BSS_START_ADDR
2783 Link address for the BSS within the SPL binary.
2784
2785 CONFIG_SPL_BSS_MAX_SIZE
2786 Maximum binary size of the BSS section of the SPL binary.
2787
2788 CONFIG_SPL_STACK
2789 Adress of the start of the stack SPL will use
2790
Scott Woodc4f0d002012-09-20 19:05:12 -05002791 CONFIG_SPL_RELOC_STACK
2792 Adress of the start of the stack SPL will use after
2793 relocation. If unspecified, this is equal to
2794 CONFIG_SPL_STACK.
2795
Tom Rini36853852012-02-14 07:29:40 +00002796 CONFIG_SYS_SPL_MALLOC_START
2797 Starting address of the malloc pool used in SPL.
2798
2799 CONFIG_SYS_SPL_MALLOC_SIZE
2800 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002801
Tom Rini28591df2012-08-13 12:03:19 -07002802 CONFIG_SPL_FRAMEWORK
2803 Enable the SPL framework under common/. This framework
2804 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2805 NAND loading of the Linux Kernel.
2806
Tom Rinife3b0c72012-08-13 11:37:56 -07002807 CONFIG_SPL_DISPLAY_PRINT
2808 For ARM, enable an optional function to print more information
2809 about the running system.
2810
Scott Wood7c810902012-09-20 16:35:21 -05002811 CONFIG_SPL_INIT_MINIMAL
2812 Arch init code should be built for a very small image
2813
Wolfgang Denk825223d2011-09-11 21:24:09 +02002814 CONFIG_SPL_LIBCOMMON_SUPPORT
2815 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002816
Wolfgang Denk825223d2011-09-11 21:24:09 +02002817 CONFIG_SPL_LIBDISK_SUPPORT
2818 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002819
Wolfgang Denk825223d2011-09-11 21:24:09 +02002820 CONFIG_SPL_I2C_SUPPORT
2821 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002822
Wolfgang Denk825223d2011-09-11 21:24:09 +02002823 CONFIG_SPL_GPIO_SUPPORT
2824 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002825
Wolfgang Denk825223d2011-09-11 21:24:09 +02002826 CONFIG_SPL_MMC_SUPPORT
2827 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002828
Tom Rini36853852012-02-14 07:29:40 +00002829 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2830 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2831 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2832 Address, size and partition on the MMC to load U-Boot from
2833 when the MMC is being used in raw mode.
2834
2835 CONFIG_SPL_FAT_SUPPORT
2836 Support for fs/fat/libfat.o in SPL binary
2837
2838 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2839 Filename to read to load U-Boot when reading from FAT
2840
Scott Wood2b36fbb2012-12-06 13:33:17 +00002841 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2842 Set this for NAND SPL on PPC mpc83xx targets, so that
2843 start.S waits for the rest of the SPL to load before
2844 continuing (the hardware starts execution after just
2845 loading the first page rather than the full 4K).
2846
Scott Woodc352a0c2012-09-20 19:09:07 -05002847 CONFIG_SPL_NAND_BASE
2848 Include nand_base.c in the SPL. Requires
2849 CONFIG_SPL_NAND_DRIVERS.
2850
2851 CONFIG_SPL_NAND_DRIVERS
2852 SPL uses normal NAND drivers, not minimal drivers.
2853
2854 CONFIG_SPL_NAND_ECC
2855 Include standard software ECC in the SPL
2856
Tom Rini36853852012-02-14 07:29:40 +00002857 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002858 Support for NAND boot using simple NAND drivers that
2859 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002860
2861 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2862 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2863 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2864 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2865 CONFIG_SYS_NAND_ECCBYTES
2866 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002867 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002868
2869 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002870 Location in NAND to read U-Boot from
2871
2872 CONFIG_SYS_NAND_U_BOOT_DST
2873 Location in memory to load U-Boot to
2874
2875 CONFIG_SYS_NAND_U_BOOT_SIZE
2876 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002877
2878 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002879 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002880
2881 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2882 Define this if you need to first read the OOB and then the
2883 data. This is used for example on davinci plattforms.
2884
2885 CONFIG_SPL_OMAP3_ID_NAND
2886 Support for an OMAP3-specific set of functions to return the
2887 ID and MFR of the first attached NAND chip, if present.
2888
Wolfgang Denk825223d2011-09-11 21:24:09 +02002889 CONFIG_SPL_SERIAL_SUPPORT
2890 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002891
Wolfgang Denk825223d2011-09-11 21:24:09 +02002892 CONFIG_SPL_SPI_FLASH_SUPPORT
2893 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002894
Wolfgang Denk825223d2011-09-11 21:24:09 +02002895 CONFIG_SPL_SPI_SUPPORT
2896 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002897
Pavel Machekde997252012-08-30 22:42:11 +02002898 CONFIG_SPL_RAM_DEVICE
2899 Support for running image already present in ram, in SPL binary
2900
Wolfgang Denk825223d2011-09-11 21:24:09 +02002901 CONFIG_SPL_LIBGENERIC_SUPPORT
2902 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002903
Scott Woodeb7bd972012-12-06 13:33:16 +00002904 CONFIG_SPL_PAD_TO
2905 Linker address to which the SPL should be padded before
2906 appending the SPL payload.
2907
Scott Woodf147eb72012-09-21 16:27:32 -05002908 CONFIG_SPL_TARGET
2909 Final target image containing SPL and payload. Some SPLs
2910 use an arch-specific makefile fragment instead, for
2911 example if more than one image needs to be produced.
2912
wdenkc6097192002-11-03 00:24:07 +00002913Modem Support:
2914--------------
2915
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002916[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002917
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002918- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002919 CONFIG_MODEM_SUPPORT
2920
2921- RTS/CTS Flow control enable:
2922 CONFIG_HWFLOW
2923
2924- Modem debug support:
2925 CONFIG_MODEM_SUPPORT_DEBUG
2926
wdenk4a5c8a72003-03-06 00:02:04 +00002927 Enables debugging stuff (char screen[1024], dbg())
2928 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002929
wdenkc0aa5c52003-12-06 19:49:23 +00002930- Interrupt support (PPC):
2931
wdenk1ebf41e2004-01-02 14:00:00 +00002932 There are common interrupt_init() and timer_interrupt()
2933 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002934 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002935 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002936 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002937 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002938 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002939 specific handling. If board has watchdog / status_led
2940 / other_activity_monitor it works automatically from
2941 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002942
wdenkc6097192002-11-03 00:24:07 +00002943- General:
2944
wdenk4a5c8a72003-03-06 00:02:04 +00002945 In the target system modem support is enabled when a
2946 specific key (key combination) is pressed during
2947 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002948 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002949 board_init(). Currently key_pressed() is a dummy
2950 function, returning 1 and thus enabling modem
2951 initialization.
wdenkc6097192002-11-03 00:24:07 +00002952
wdenk4a5c8a72003-03-06 00:02:04 +00002953 If there are no modem init strings in the
2954 environment, U-Boot proceed to autoboot; the
2955 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002956 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002957
2958 See also: doc/README.Modem
2959
Helmut Raigerd5a184b2011-10-20 04:19:47 +00002960Board initialization settings:
2961------------------------------
2962
2963During Initialization u-boot calls a number of board specific functions
2964to allow the preparation of board specific prerequisites, e.g. pin setup
2965before drivers are initialized. To enable these callbacks the
2966following configuration macros have to be defined. Currently this is
2967architecture specific, so please check arch/your_architecture/lib/board.c
2968typically in board_init_f() and board_init_r().
2969
2970- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2971- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2972- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2973- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002974
wdenkc6097192002-11-03 00:24:07 +00002975Configuration Settings:
2976-----------------------
2977
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002978- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002979 undefine this when you're short of memory.
2980
Peter Tyserdfb72b82009-01-27 18:03:12 -06002981- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2982 width of the commands listed in the 'help' command output.
2983
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002984- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002985 prompt for user input.
2986
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002987- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002988
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002989- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002990
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002991- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002992
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002993- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002994 the application (usually a Linux kernel) when it is
2995 booted
2996
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002997- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002998 List of legal baudrate settings for this board.
2999
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003000- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003001 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003003- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003004 If the board specific function
3005 extern int overwrite_console (void);
3006 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003007 serial port, else the settings in the environment are used.
3008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003009- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003010 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003011
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003012- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003013 Enable overwrite of previous console environment settings.
3014
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003015- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003016 Begin and End addresses of the area used by the
3017 simple memory test.
3018
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003019- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003020 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003022- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003023 Scratch address used by the alternate memory test
3024 You only need to set this if address zero isn't writeable
3025
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003026- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3027 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003028 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003029 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003030 fixing up gd->ram_size the Linux kernel should gets passed
3031 the now "corrected" memory size and won't touch it either.
3032 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003033 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003034 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003035 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003036
3037 This option can be used as a workaround for the 440EPx/GRx
3038 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3039 be touched.
3040
3041 WARNING: Please make sure that this value is a multiple of
3042 the Linux page size (normally 4k). If this is not the case,
3043 then the end address of the Linux memory will be located at a
3044 non page size aligned address and this could cause major
3045 problems.
3046
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003047- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003048 Enable temporary baudrate change while serial download
3049
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003050- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003051 Physical start address of SDRAM. _Must_ be 0 here.
3052
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003053- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003054 Physical start address of Motherboard I/O (if using a
3055 Cogent motherboard)
3056
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003057- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003058 Physical start address of Flash memory.
3059
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003060- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003061 Physical start address of boot monitor code (set by
3062 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003063 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003064 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003066- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003067 Size of memory reserved for monitor code, used to
3068 determine _at_compile_time_ (!) if the environment is
3069 embedded within the U-Boot image, or in a separate
3070 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003072- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003073 Size of DRAM reserved for malloc() use.
3074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003075- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003076 Normally compressed uImages are limited to an
3077 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003078 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003079 to adjust this setting to your needs.
3080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003081- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003082 Maximum size of memory mapped by the startup code of
3083 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003084 the Linux kernel (bd_info, boot arguments, FDT blob if
3085 used) must be put below this limit, unless "bootm_low"
3086 enviroment variable is defined and non-zero. In such case
3087 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003088 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003089 variable "bootm_mapsize" will override the value of
3090 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3091 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003092
John Rigbyeea8e692010-10-13 13:57:35 -06003093- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3094 Enable initrd_high functionality. If defined then the
3095 initrd_high feature is enabled and the bootm ramdisk subcommand
3096 is enabled.
3097
3098- CONFIG_SYS_BOOT_GET_CMDLINE:
3099 Enables allocating and saving kernel cmdline in space between
3100 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3101
3102- CONFIG_SYS_BOOT_GET_KBD:
3103 Enables allocating and saving a kernel copy of the bd_info in
3104 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003106- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003107 Max number of Flash memory banks
3108
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003109- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003110 Max number of sectors on a Flash chip
3111
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003112- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003113 Timeout for Flash erase operations (in ms)
3114
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003115- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003116 Timeout for Flash write operations (in ms)
3117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003118- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003119 Timeout for Flash set sector lock bit operation (in ms)
3120
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003121- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003122 Timeout for Flash clear lock bits operation (in ms)
3123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003124- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003125 If defined, hardware flash sectors protection is used
3126 instead of U-Boot software protection.
3127
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003128- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003129
3130 Enable TFTP transfers directly to flash memory;
3131 without this option such a download has to be
3132 performed in two steps: (1) download to RAM, and (2)
3133 copy from RAM to flash.
3134
3135 The two-step approach is usually more reliable, since
3136 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003137 the flash, but in some situations (when system RAM is
3138 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003139 downloaded image) this option may be very useful.
3140
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003141- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003142 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003143 common flash structure for storing flash geometry.
3144
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003145- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003146 This option also enables the building of the cfi_flash driver
3147 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003148
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003149- CONFIG_FLASH_CFI_MTD
3150 This option enables the building of the cfi_mtd driver
3151 in the drivers directory. The driver exports CFI flash
3152 to the MTD layer.
3153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003154- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003155 Use buffered writes to flash.
3156
3157- CONFIG_FLASH_SPANSION_S29WS_N
3158 s29ws-n MirrorBit flash has non-standard addresses for buffered
3159 write commands.
3160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003161- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003162 If this option is defined, the common CFI flash doesn't
3163 print it's warning upon not recognized FLASH banks. This
3164 is useful, if some of the configured banks are only
3165 optionally available.
3166
Jerry Van Barenaae73572008-03-08 13:48:01 -05003167- CONFIG_FLASH_SHOW_PROGRESS
3168 If defined (must be an integer), print out countdown
3169 digits and dots. Recommended value: 45 (9..1) for 80
3170 column displays, 15 (3..1) for 40 column displays.
3171
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003172- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003173 Defines the number of Ethernet receive buffers. On some
3174 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003175 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3176 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003177 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003178 Defaults to 4 if not defined.
3179
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003180- CONFIG_ENV_MAX_ENTRIES
3181
Wolfgang Denk1136f692010-10-27 22:48:30 +02003182 Maximum number of entries in the hash table that is used
3183 internally to store the environment settings. The default
3184 setting is supposed to be generous and should work in most
3185 cases. This setting can be used to tune behaviour; see
3186 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003187
Joe Hershberger71497d02012-12-11 22:16:31 -06003188- CONFIG_ENV_FLAGS_LIST_DEFAULT
3189- CONFIG_ENV_FLAGS_LIST_STATIC
3190 Enable validation of the values given to enviroment variables when
3191 calling env set. Variables can be restricted to only decimal,
3192 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3193 the variables can also be restricted to IP address or MAC address.
3194
3195 The format of the list is:
3196 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003197 access_atribute = [a|r|o|c]
3198 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003199 entry = variable_name[:attributes]
3200 list = entry[,list]
3201
3202 The type attributes are:
3203 s - String (default)
3204 d - Decimal
3205 x - Hexadecimal
3206 b - Boolean ([1yYtT|0nNfF])
3207 i - IP address
3208 m - MAC address
3209
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003210 The access attributes are:
3211 a - Any (default)
3212 r - Read-only
3213 o - Write-once
3214 c - Change-default
3215
Joe Hershberger71497d02012-12-11 22:16:31 -06003216 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3217 Define this to a list (string) to define the ".flags"
3218 envirnoment variable in the default or embedded environment.
3219
3220 - CONFIG_ENV_FLAGS_LIST_STATIC
3221 Define this to a list (string) to define validation that
3222 should be done if an entry is not found in the ".flags"
3223 environment variable. To override a setting in the static
3224 list, simply add an entry for the same variable name to the
3225 ".flags" variable.
3226
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003227- CONFIG_ENV_ACCESS_IGNORE_FORCE
3228 If defined, don't allow the -f switch to env set override variable
3229 access flags.
3230
wdenkc6097192002-11-03 00:24:07 +00003231The following definitions that deal with the placement and management
3232of environment data (variable area); in general, we support the
3233following configurations:
3234
Mike Frysinger63b8f122011-07-08 10:44:25 +00003235- CONFIG_BUILD_ENVCRC:
3236
3237 Builds up envcrc with the target environment so that external utils
3238 may easily extract it and embed it in final U-Boot images.
3239
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003240- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003241
3242 Define this if the environment is in flash memory.
3243
3244 a) The environment occupies one whole flash sector, which is
3245 "embedded" in the text segment with the U-Boot code. This
3246 happens usually with "bottom boot sector" or "top boot
3247 sector" type flash chips, which have several smaller
3248 sectors at the start or the end. For instance, such a
3249 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3250 such a case you would place the environment in one of the
3251 4 kB sectors - with U-Boot code before and after it. With
3252 "top boot sector" type flash chips, you would put the
3253 environment in one of the last sectors, leaving a gap
3254 between U-Boot and the environment.
3255
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003256 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003257
3258 Offset of environment data (variable area) to the
3259 beginning of flash memory; for instance, with bottom boot
3260 type flash chips the second sector can be used: the offset
3261 for this sector is given here.
3262
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003263 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003264
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003265 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003266
3267 This is just another way to specify the start address of
3268 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003269 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003270
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003271 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003272
3273 Size of the sector containing the environment.
3274
3275
3276 b) Sometimes flash chips have few, equal sized, BIG sectors.
3277 In such a case you don't want to spend a whole sector for
3278 the environment.
3279
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003280 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003281
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003282 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003283 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003284 of this flash sector for the environment. This saves
3285 memory for the RAM copy of the environment.
3286
3287 It may also save flash memory if you decide to use this
3288 when your environment is "embedded" within U-Boot code,
3289 since then the remainder of the flash sector could be used
3290 for U-Boot code. It should be pointed out that this is
3291 STRONGLY DISCOURAGED from a robustness point of view:
3292 updating the environment in flash makes it always
3293 necessary to erase the WHOLE sector. If something goes
3294 wrong before the contents has been restored from a copy in
3295 RAM, your target system will be dead.
3296
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003297 - CONFIG_ENV_ADDR_REDUND
3298 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003299
wdenk4a5c8a72003-03-06 00:02:04 +00003300 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003301 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003302 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003303 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003304
3305BE CAREFUL! Any changes to the flash layout, and some changes to the
3306source code will make it necessary to adapt <board>/u-boot.lds*
3307accordingly!
3308
3309
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003310- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003311
3312 Define this if you have some non-volatile memory device
3313 (NVRAM, battery buffered SRAM) which you want to use for the
3314 environment.
3315
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003316 - CONFIG_ENV_ADDR:
3317 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003318
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003319 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003320 want to use for environment. It is assumed that this memory
3321 can just be read and written to, without any special
3322 provision.
3323
3324BE CAREFUL! The first access to the environment happens quite early
3325in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003326console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003327U-Boot will hang.
3328
3329Please note that even with NVRAM we still use a copy of the
3330environment in RAM: we could work on NVRAM directly, but we want to
3331keep settings there always unmodified except somebody uses "saveenv"
3332to save the current settings.
3333
3334
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003335- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003336
3337 Use this if you have an EEPROM or similar serial access
3338 device and a driver for it.
3339
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003340 - CONFIG_ENV_OFFSET:
3341 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003342
3343 These two #defines specify the offset and size of the
3344 environment area within the total memory of your EEPROM.
3345
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003346 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003347 If defined, specified the chip address of the EEPROM device.
3348 The default address is zero.
3349
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003350 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003351 If defined, the number of bits used to address bytes in a
3352 single page in the EEPROM device. A 64 byte page, for example
3353 would require six bits.
3354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003355 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003356 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003357 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003358
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003359 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003360 The length in bytes of the EEPROM memory array address. Note
3361 that this is NOT the chip address length!
3362
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003363 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003364 EEPROM chips that implement "address overflow" are ones
3365 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3366 address and the extra bits end up in the "chip address" bit
3367 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3368 byte chips.
3369
3370 Note that we consider the length of the address field to
3371 still be one byte because the extra address bits are hidden
3372 in the chip address.
3373
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003374 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003375 The size in bytes of the EEPROM device.
3376
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003377 - CONFIG_ENV_EEPROM_IS_ON_I2C
3378 define this, if you have I2C and SPI activated, and your
3379 EEPROM, which holds the environment, is on the I2C bus.
3380
3381 - CONFIG_I2C_ENV_EEPROM_BUS
3382 if you have an Environment on an EEPROM reached over
3383 I2C muxes, you can define here, how to reach this
3384 EEPROM. For example:
3385
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003386 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003387
3388 EEPROM which holds the environment, is reached over
3389 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003390
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003391- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003392
wdenk1ebf41e2004-01-02 14:00:00 +00003393 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003394 want to use for the environment.
3395
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003396 - CONFIG_ENV_OFFSET:
3397 - CONFIG_ENV_ADDR:
3398 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003399
3400 These three #defines specify the offset and size of the
3401 environment area within the total memory of your DataFlash placed
3402 at the specified address.
3403
Liu Gang85bcd732012-03-08 00:33:20 +00003404- CONFIG_ENV_IS_IN_REMOTE:
3405
3406 Define this if you have a remote memory space which you
3407 want to use for the local device's environment.
3408
3409 - CONFIG_ENV_ADDR:
3410 - CONFIG_ENV_SIZE:
3411
3412 These two #defines specify the address and size of the
3413 environment area within the remote memory space. The
3414 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003415 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003416
3417BE CAREFUL! For some special cases, the local device can not use
3418"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003419environment stored in a remote NOR flash by SRIO or PCIE link,
3420but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003421
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003422- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003423
3424 Define this if you have a NAND device which you want to use
3425 for the environment.
3426
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003427 - CONFIG_ENV_OFFSET:
3428 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003429
3430 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003431 area within the first NAND device. CONFIG_ENV_OFFSET must be
3432 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003433
Scott Wood08239322010-09-17 14:38:37 -05003434 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003435
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003436 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003437 size used to hold a redundant copy of the environment data, so
3438 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003439 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003440 aligned to an erase block boundary.
3441
3442 - CONFIG_ENV_RANGE (optional):
3443
3444 Specifies the length of the region in which the environment
3445 can be written. This should be a multiple of the NAND device's
3446 block size. Specifying a range with more erase blocks than
3447 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3448 the range to be avoided.
3449
3450 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003451
Scott Wood08239322010-09-17 14:38:37 -05003452 Enables support for dynamically retrieving the offset of the
3453 environment from block zero's out-of-band data. The
3454 "nand env.oob" command can be used to record this offset.
3455 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3456 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003457
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003458- CONFIG_NAND_ENV_DST
3459
3460 Defines address in RAM to which the nand_spl code should copy the
3461 environment. If redundant environment is used, it will be copied to
3462 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003464- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003465
3466 Defines offset to the initial SPI buffer area in DPRAM. The
3467 area is used at an early stage (ROM part) if the environment
3468 is configured to reside in the SPI EEPROM: We need a 520 byte
3469 scratch DPRAM area. It is used between the two initialization
3470 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3471 to be a good choice since it makes it far enough from the
3472 start of the data area as well as from the stack pointer.
3473
Bruce Adleredecc942007-11-02 13:15:42 -07003474Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003475has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003476created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003477until then to read environment variables.
3478
wdenk8dba0502003-03-31 16:34:49 +00003479The environment is protected by a CRC32 checksum. Before the monitor
3480is relocated into RAM, as a result of a bad CRC you will be working
3481with the compiled-in default environment - *silently*!!! [This is
3482necessary, because the first environment variable we need is the
3483"baudrate" setting for the console - if we have a bad CRC, we don't
3484have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003485
3486Note: once the monitor has been relocated, then it will complain if
3487the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003488use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003489
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003490- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003491 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003492
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003493 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003494 also needs to be defined.
3495
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003496- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003497 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003498
Ron Madriddfa028a2009-02-18 14:30:44 -08003499- CONFIG_NS16550_MIN_FUNCTIONS:
3500 Define this if you desire to only have use of the NS16550_init
3501 and NS16550_putc functions for the serial driver located at
3502 drivers/serial/ns16550.c. This option is useful for saving
3503 space for already greatly restricted images, including but not
3504 limited to NAND_SPL configurations.
3505
Simon Glass28a9e332012-11-30 13:01:18 +00003506- CONFIG_DISPLAY_BOARDINFO
3507 Display information about the board that U-Boot is running on
3508 when U-Boot starts up. The board function checkboard() is called
3509 to do this.
3510
Simon Glasse8822012012-11-30 13:01:19 +00003511- CONFIG_DISPLAY_BOARDINFO_LATE
3512 Similar to the previous option, but display this information
3513 later, once stdio is running and output goes to the LCD, if
3514 present.
3515
wdenkc6097192002-11-03 00:24:07 +00003516Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003517---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003519- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003520 Cache Line Size of the CPU.
3521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003522- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003523 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003524
wdenk9c53f402003-10-15 23:53:47 +00003525 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3526 and RPXsuper) to be able to adjust the position of
3527 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003528
Timur Tabid8f341c2011-08-04 18:03:41 -05003529- CONFIG_SYS_CCSRBAR_DEFAULT:
3530 Default (power-on reset) physical address of CCSR on Freescale
3531 PowerPC SOCs.
3532
3533- CONFIG_SYS_CCSRBAR:
3534 Virtual address of CCSR. On a 32-bit build, this is typically
3535 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3536
3537 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3538 for cross-platform code that uses that macro instead.
3539
3540- CONFIG_SYS_CCSRBAR_PHYS:
3541 Physical address of CCSR. CCSR can be relocated to a new
3542 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003543 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003544 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3545 is typically relocated on 36-bit builds. It is recommended
3546 that this macro be defined via the _HIGH and _LOW macros:
3547
3548 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3549 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3550
3551- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003552 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3553 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003554 used in assembly code, so it must not contain typecasts or
3555 integer size suffixes (e.g. "ULL").
3556
3557- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3558 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3559 used in assembly code, so it must not contain typecasts or
3560 integer size suffixes (e.g. "ULL").
3561
3562- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3563 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3564 forced to a value that ensures that CCSR is not relocated.
3565
wdenk1272e232002-11-10 22:06:23 +00003566- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003567 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003568
3569 the default drive number (default value 0)
3570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003571 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003572
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003573 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003574 (default value 1)
3575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003576 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003577
wdenk4a5c8a72003-03-06 00:02:04 +00003578 defines the offset of register from address. It
3579 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003580 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003581
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003582 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3583 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003584 default value.
wdenk1272e232002-11-10 22:06:23 +00003585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003586 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003587 fdc_hw_init() is called at the beginning of the FDC
3588 setup. fdc_hw_init() must be provided by the board
3589 source code. It is used to make hardware dependant
3590 initializations.
wdenk1272e232002-11-10 22:06:23 +00003591
Macpaul Lind1e49942011-04-11 20:45:32 +00003592- CONFIG_IDE_AHB:
3593 Most IDE controllers were designed to be connected with PCI
3594 interface. Only few of them were designed for AHB interface.
3595 When software is doing ATA command and data transfer to
3596 IDE devices through IDE-AHB controller, some additional
3597 registers accessing to these kind of IDE-AHB controller
3598 is requierd.
3599
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003600- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003601 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003602 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003603
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003604- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003605
wdenkeb20ad32003-09-05 23:19:14 +00003606 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003607 initial data and stack; please note that this must be
3608 writable memory that is working WITHOUT special
3609 initialization, i. e. you CANNOT use normal RAM which
3610 will become available only after programming the
3611 memory controller and running certain initialization
3612 sequences.
3613
3614 U-Boot uses the following memory types:
3615 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3616 - MPC824X: data cache
3617 - PPC4xx: data cache
3618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003619- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003620
3621 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003622 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3623 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003624 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003625 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003626 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3627 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3628 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003629
3630 Note:
3631 On the MPC824X (or other systems that use the data
3632 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003633 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003634 point to an otherwise UNUSED address space between
3635 the top of RAM and the start of the PCI space.
3636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003637- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003638
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003639- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003641- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003643- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003644
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003645- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003647- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003648
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003649- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003650 SDRAM timing
3651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003652- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003653 periodic timer for refresh
3654
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003655- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003656
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003657- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3658 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3659 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3660 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003661 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3662
3663- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003664 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3665 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003666 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3667
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003668- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3669 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003670 Machine Mode Register and Memory Periodic Timer
3671 Prescaler definitions (SDRAM timing)
3672
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003673- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003674 enable I2C microcode relocation patch (MPC8xx);
3675 define relocation offset in DPRAM [DSP2]
3676
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003677- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003678 enable SMC microcode relocation patch (MPC8xx);
3679 define relocation offset in DPRAM [SMC1]
3680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003681- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003682 enable SPI microcode relocation patch (MPC8xx);
3683 define relocation offset in DPRAM [SCC4]
3684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003685- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003686 Use OSCM clock mode on MBX8xx board. Be careful,
3687 wrong setting might damage your board. Read
3688 doc/README.MBX before setting this variable!
3689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003690- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003691 Offset of the bootmode word in DPRAM used by post
3692 (Power On Self Tests). This definition overrides
3693 #define'd default value in commproc.h resp.
3694 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003695
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003696- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3697 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3698 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3699 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3700 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3701 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3702 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3703 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003704 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003705
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003706- CONFIG_PCI_DISABLE_PCIE:
3707 Disable PCI-Express on systems where it is supported but not
3708 required.
3709
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003710- CONFIG_PCI_ENUM_ONLY
3711 Only scan through and get the devices on the busses.
3712 Don't do any setup work, presumably because someone or
3713 something has already done it, and we don't need to do it
3714 a second time. Useful for platforms that are pre-booted
3715 by coreboot or similar.
3716
Kumar Gala8975d7a2010-12-30 12:09:53 -06003717- CONFIG_SYS_SRIO:
3718 Chip has SRIO or not
3719
3720- CONFIG_SRIO1:
3721 Board has SRIO 1 port available
3722
3723- CONFIG_SRIO2:
3724 Board has SRIO 2 port available
3725
3726- CONFIG_SYS_SRIOn_MEM_VIRT:
3727 Virtual Address of SRIO port 'n' memory region
3728
3729- CONFIG_SYS_SRIOn_MEM_PHYS:
3730 Physical Address of SRIO port 'n' memory region
3731
3732- CONFIG_SYS_SRIOn_MEM_SIZE:
3733 Size of SRIO port 'n' memory region
3734
Alex Watermancd6aae32011-05-19 15:08:36 -04003735- CONFIG_SYS_NDFC_16
3736 Defined to tell the NDFC that the NAND chip is using a
3737 16 bit bus.
3738
3739- CONFIG_SYS_NDFC_EBC0_CFG
3740 Sets the EBC0_CFG register for the NDFC. If not defined
3741 a default value will be used.
3742
Ben Warren45657152006-09-07 16:50:54 -04003743- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003744 Get DDR timing information from an I2C EEPROM. Common
3745 with pluggable memory modules such as SODIMMs
3746
Ben Warren45657152006-09-07 16:50:54 -04003747 SPD_EEPROM_ADDRESS
3748 I2C address of the SPD EEPROM
3749
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003750- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003751 If SPD EEPROM is on an I2C bus other than the first
3752 one, specify here. Note that the value must resolve
3753 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003754
York Sune73cc042011-06-07 09:42:16 +08003755- CONFIG_SYS_DDR_RAW_TIMING
3756 Get DDR timing information from other than SPD. Common with
3757 soldered DDR chips onboard without SPD. DDR raw timing
3758 parameters are extracted from datasheet and hard-coded into
3759 header files or board specific files.
3760
York Sunbd495cf2011-09-16 13:21:35 -07003761- CONFIG_FSL_DDR_INTERACTIVE
3762 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3763
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003764- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003765 Only for 83xx systems. If specified, then DDR should
3766 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003767
wdenk6203e402004-04-18 10:13:26 +00003768- CONFIG_ETHER_ON_FEC[12]
3769 Define to enable FEC[12] on a 8xx series processor.
3770
3771- CONFIG_FEC[12]_PHY
3772 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003773 to the given FEC; i. e.
3774 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003775 means that the PHY with address 4 is connected to FEC1
3776
3777 When set to -1, means to probe for first available.
3778
3779- CONFIG_FEC[12]_PHY_NORXERR
3780 The PHY does not have a RXERR line (RMII only).
3781 (so program the FEC to ignore it).
3782
3783- CONFIG_RMII
3784 Enable RMII mode for all FECs.
3785 Note that this is a global option, we can't
3786 have one FEC in standard MII mode and another in RMII mode.
3787
wdenk20c98a62004-04-23 20:32:05 +00003788- CONFIG_CRC32_VERIFY
3789 Add a verify option to the crc32 command.
3790 The syntax is:
3791
3792 => crc32 -v <address> <count> <crc32>
3793
3794 Where address/count indicate a memory area
3795 and crc32 is the correct crc32 which the
3796 area should have.
3797
wdenk64519362004-07-11 17:40:54 +00003798- CONFIG_LOOPW
3799 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003800 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003801
stroesecc3af832004-12-16 18:46:55 +00003802- CONFIG_MX_CYCLIC
3803 Add the "mdc" and "mwc" memory commands. These are cyclic
3804 "md/mw" commands.
3805 Examples:
3806
wdenk07d7e6b2004-12-16 21:44:03 +00003807 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003808 This command will print 4 bytes (10,11,12,13) each 500 ms.
3809
wdenk07d7e6b2004-12-16 21:44:03 +00003810 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003811 This command will write 12345678 to address 100 all 10 ms.
3812
wdenk07d7e6b2004-12-16 21:44:03 +00003813 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003814 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003815
wdenk3d3d99f2005-04-04 12:44:11 +00003816- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003817 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003818 low level initializations (like setting up the memory
3819 controller) are omitted and/or U-Boot does not
3820 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003821
Wolfgang Denk302141d2010-11-27 23:30:56 +01003822 Normally this variable MUST NOT be defined. The only
3823 exception is when U-Boot is loaded (to RAM) by some
3824 other boot loader or by a debugger which performs
3825 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003826
Aneesh V552a3192011-07-13 05:11:07 +00003827- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003828 Modifies the behaviour of start.S when compiling a loader
3829 that is executed before the actual U-Boot. E.g. when
3830 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003831
Matthias Weisser93416c12011-03-10 21:36:32 +00003832- CONFIG_USE_ARCH_MEMCPY
3833 CONFIG_USE_ARCH_MEMSET
3834 If these options are used a optimized version of memcpy/memset will
3835 be used if available. These functions may be faster under some
3836 conditions but may increase the binary size.
3837
Simon Glassbfb59802013-02-14 04:18:54 +00003838- CONFIG_X86_RESET_VECTOR
3839 If defined, the x86 reset vector code is included. This is not
3840 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003841
Gabe Black76ce2492012-11-29 16:23:41 +00003842
Timur Tabi275f4bb2011-11-22 09:21:25 -06003843Freescale QE/FMAN Firmware Support:
3844-----------------------------------
3845
3846The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3847loading of "firmware", which is encoded in the QE firmware binary format.
3848This firmware often needs to be loaded during U-Boot booting, so macros
3849are used to identify the storage device (NOR flash, SPI, etc) and the address
3850within that device.
3851
3852- CONFIG_SYS_QE_FMAN_FW_ADDR
3853 The address in the storage device where the firmware is located. The
3854 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3855 is also specified.
3856
3857- CONFIG_SYS_QE_FMAN_FW_LENGTH
3858 The maximum possible size of the firmware. The firmware binary format
3859 has a field that specifies the actual size of the firmware, but it
3860 might not be possible to read any part of the firmware unless some
3861 local storage is allocated to hold the entire firmware first.
3862
3863- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3864 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3865 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3866 virtual address in NOR flash.
3867
3868- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3869 Specifies that QE/FMAN firmware is located in NAND flash.
3870 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3871
3872- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3873 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3874 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3875
3876- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3877 Specifies that QE/FMAN firmware is located on the primary SPI
3878 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3879
Liu Gang1e084582012-03-08 00:33:18 +00003880- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3881 Specifies that QE/FMAN firmware is located in the remote (master)
3882 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00003883 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3884 window->master inbound window->master LAW->the ucode address in
3885 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06003886
wdenkc6097192002-11-03 00:24:07 +00003887Building the Software:
3888======================
3889
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003890Building U-Boot has been tested in several native build environments
3891and in many different cross environments. Of course we cannot support
3892all possibly existing versions of cross development tools in all
3893(potentially obsolete) versions. In case of tool chain problems we
3894recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3895which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003896
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003897If you are not using a native environment, it is assumed that you
3898have GNU cross compiling tools available in your path. In this case,
3899you must set the environment variable CROSS_COMPILE in your shell.
3900Note that no changes to the Makefile or any other source files are
3901necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003902
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003903 $ CROSS_COMPILE=ppc_4xx-
3904 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003905
Peter Tyserb06976d2009-03-13 18:54:51 -05003906Note: If you wish to generate Windows versions of the utilities in
3907 the tools directory you can use the MinGW toolchain
3908 (http://www.mingw.org). Set your HOST tools to the MinGW
3909 toolchain and execute 'make tools'. For example:
3910
3911 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3912
3913 Binaries such as tools/mkimage.exe will be created which can
3914 be executed on computers running Windows.
3915
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003916U-Boot is intended to be simple to build. After installing the
3917sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003918is done by typing:
3919
3920 make NAME_config
3921
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003922where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003923rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00003924
wdenk6c59edc2004-05-03 20:45:30 +00003925Note: for some board special configuration names may exist; check if
3926 additional information is available from the board vendor; for
3927 instance, the TQM823L systems are available without (standard)
3928 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003929 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk6c59edc2004-05-03 20:45:30 +00003931 make TQM823L_config
3932 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003933
wdenk6c59edc2004-05-03 20:45:30 +00003934 make TQM823L_LCD_config
3935 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk6c59edc2004-05-03 20:45:30 +00003937 etc.
wdenkc6097192002-11-03 00:24:07 +00003938
wdenkc6097192002-11-03 00:24:07 +00003939
wdenk6c59edc2004-05-03 20:45:30 +00003940Finally, type "make all", and you should get some working U-Boot
3941images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk6c59edc2004-05-03 20:45:30 +00003943- "u-boot.bin" is a raw binary image
3944- "u-boot" is an image in ELF binary format
3945- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003946
Marian Balakowiczefe063f2006-09-07 17:25:40 +02003947By default the build is performed locally and the objects are saved
3948in the source directory. One of the two methods can be used to change
3949this behavior and build U-Boot to some external directory:
3950
39511. Add O= to the make command line invocations:
3952
3953 make O=/tmp/build distclean
3954 make O=/tmp/build NAME_config
3955 make O=/tmp/build all
3956
39572. Set environment variable BUILD_DIR to point to the desired location:
3958
3959 export BUILD_DIR=/tmp/build
3960 make distclean
3961 make NAME_config
3962 make all
3963
3964Note that the command line "O=" setting overrides the BUILD_DIR environment
3965variable.
3966
wdenkc6097192002-11-03 00:24:07 +00003967
wdenk6c59edc2004-05-03 20:45:30 +00003968Please be aware that the Makefiles assume you are using GNU make, so
3969for instance on NetBSD you might need to use "gmake" instead of
3970native "make".
wdenkc6097192002-11-03 00:24:07 +00003971
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk6c59edc2004-05-03 20:45:30 +00003973If the system board that you have is not listed, then you will need
3974to port U-Boot to your hardware platform. To do this, follow these
3975steps:
wdenkc6097192002-11-03 00:24:07 +00003976
wdenk6c59edc2004-05-03 20:45:30 +000039771. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00003978 "boards.cfg" file, using the existing entries as examples.
3979 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000039802. Create a new directory to hold your board specific code. Add any
3981 files you need. In your board directory, you will need at least
3982 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
39833. Create a new configuration file "include/configs/<board>.h" for
3984 your board
39853. If you're porting U-Boot to a new CPU, then also create a new
3986 directory to hold your CPU specific code. Add any files you need.
39874. Run "make <board>_config" with your new name.
39885. Type "make", and you should get a working "u-boot.srec" file
3989 to be installed on your target system.
39906. Debug and solve any problems that might arise.
3991 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003992
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk6c59edc2004-05-03 20:45:30 +00003994Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3995==============================================================
wdenkc6097192002-11-03 00:24:07 +00003996
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003997If you have modified U-Boot sources (for instance added a new board
3998or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00003999provide feedback to the other developers. The feedback normally takes
4000the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004001official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004002
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004003But before you submit such a patch, please verify that your modifi-
4004cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004005the supported boards compile WITHOUT ANY compiler warnings. To do so,
4006just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004007for ALL supported system. Be warned, this will take a while. You can
4008select which (cross) compiler to use by passing a `CROSS_COMPILE'
4009environment variable to the script, i. e. to use the ELDK cross tools
4010you can type
wdenkc6097192002-11-03 00:24:07 +00004011
wdenk6c59edc2004-05-03 20:45:30 +00004012 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004013
wdenk6c59edc2004-05-03 20:45:30 +00004014or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk6c59edc2004-05-03 20:45:30 +00004016 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004017
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004018When using the MAKEALL script, the default behaviour is to build
4019U-Boot in the source directory. This location can be changed by
4020setting the BUILD_DIR environment variable. Also, for each target
4021built, the MAKEALL script saves two log files (<target>.ERR and
4022<target>.MAKEALL) in the <source dir>/LOG directory. This default
4023location can be changed by setting the MAKEALL_LOGDIR environment
4024variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004025
4026 export BUILD_DIR=/tmp/build
4027 export MAKEALL_LOGDIR=/tmp/log
4028 CROSS_COMPILE=ppc_8xx- MAKEALL
4029
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004030With the above settings build objects are saved in the /tmp/build,
4031log files are saved in the /tmp/log and the source tree remains clean
4032during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004033
4034
wdenk6c59edc2004-05-03 20:45:30 +00004035See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004036
wdenkc6097192002-11-03 00:24:07 +00004037
wdenk6c59edc2004-05-03 20:45:30 +00004038Monitor Commands - Overview:
4039============================
wdenkc6097192002-11-03 00:24:07 +00004040
wdenk6c59edc2004-05-03 20:45:30 +00004041go - start application at address 'addr'
4042run - run commands in an environment variable
4043bootm - boot application image from memory
4044bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004045bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004046tftpboot- boot image via network using TFTP protocol
4047 and env variables "ipaddr" and "serverip"
4048 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004049tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004050rarpboot- boot image via network using RARP/TFTP protocol
4051diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4052loads - load S-Record file over serial line
4053loadb - load binary file over serial line (kermit mode)
4054md - memory display
4055mm - memory modify (auto-incrementing)
4056nm - memory modify (constant address)
4057mw - memory write (fill)
4058cp - memory copy
4059cmp - memory compare
4060crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004061i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004062sspi - SPI utility commands
4063base - print or set address offset
4064printenv- print environment variables
4065setenv - set environment variables
4066saveenv - save environment variables to persistent storage
4067protect - enable or disable FLASH write protection
4068erase - erase FLASH memory
4069flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004070nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004071bdinfo - print Board Info structure
4072iminfo - print header information for application image
4073coninfo - print console devices and informations
4074ide - IDE sub-system
4075loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004076loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004077mtest - simple RAM test
4078icache - enable or disable instruction cache
4079dcache - enable or disable data cache
4080reset - Perform RESET of the CPU
4081echo - echo args to console
4082version - print monitor version
4083help - print online help
4084? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004085
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk6c59edc2004-05-03 20:45:30 +00004087Monitor Commands - Detailed Description:
4088========================================
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk6c59edc2004-05-03 20:45:30 +00004090TODO.
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk6c59edc2004-05-03 20:45:30 +00004092For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004093
4094
wdenk6c59edc2004-05-03 20:45:30 +00004095Environment Variables:
4096======================
wdenkc6097192002-11-03 00:24:07 +00004097
wdenk6c59edc2004-05-03 20:45:30 +00004098U-Boot supports user configuration using Environment Variables which
4099can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004100
wdenk6c59edc2004-05-03 20:45:30 +00004101Environment Variables are set using "setenv", printed using
4102"printenv", and saved to Flash using "saveenv". Using "setenv"
4103without a value can be used to delete a variable from the
4104environment. As long as you don't save the environment you are
4105working with an in-memory copy. In case the Flash area containing the
4106environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004107
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004108Some configuration options can be set using Environment Variables.
4109
4110List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004111
wdenk6c59edc2004-05-03 20:45:30 +00004112 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk6c59edc2004-05-03 20:45:30 +00004114 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004115
wdenk6c59edc2004-05-03 20:45:30 +00004116 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk6c59edc2004-05-03 20:45:30 +00004118 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004119
wdenk6c59edc2004-05-03 20:45:30 +00004120 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004121
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004122 bootm_low - Memory range available for image processing in the bootm
4123 command can be restricted. This variable is given as
4124 a hexadecimal number and defines lowest address allowed
4125 for use by the bootm command. See also "bootm_size"
4126 environment variable. Address defined by "bootm_low" is
4127 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004128 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4129 bootm_mapsize.
4130
Wolfgang Denk092ae952011-10-26 10:21:21 +00004131 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004132 This variable is given as a hexadecimal number and it
4133 defines the size of the memory region starting at base
4134 address bootm_low that is accessible by the Linux kernel
4135 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4136 as the default value if it is defined, and bootm_size is
4137 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004138
4139 bootm_size - Memory range available for image processing in the bootm
4140 command can be restricted. This variable is given as
4141 a hexadecimal number and defines the size of the region
4142 allowed for use by the bootm command. See also "bootm_low"
4143 environment variable.
4144
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004145 updatefile - Location of the software update file on a TFTP server, used
4146 by the automatic software update feature. Please refer to
4147 documentation in doc/README.update for more details.
4148
wdenk6c59edc2004-05-03 20:45:30 +00004149 autoload - if set to "no" (any string beginning with 'n'),
4150 "bootp" will just load perform a lookup of the
4151 configuration from the BOOTP server, but not try to
4152 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004153
wdenk6c59edc2004-05-03 20:45:30 +00004154 autostart - if set to "yes", an image loaded using the "bootp",
4155 "rarpboot", "tftpboot" or "diskboot" commands will
4156 be automatically started (by internally calling
4157 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk6c59edc2004-05-03 20:45:30 +00004159 If set to "no", a standalone image passed to the
4160 "bootm" command will be copied to the load address
4161 (and eventually uncompressed), but NOT be started.
4162 This can be used to load and uncompress arbitrary
4163 data.
wdenkc6097192002-11-03 00:24:07 +00004164
David A. Longd558a4e2011-07-09 16:40:19 -04004165 fdt_high - if set this restricts the maximum address that the
4166 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004167 For example, if you have a system with 1 GB memory
4168 at physical address 0x10000000, while Linux kernel
4169 only recognizes the first 704 MB as low memory, you
4170 may need to set fdt_high as 0x3C000000 to have the
4171 device tree blob be copied to the maximum address
4172 of the 704 MB low memory, so that Linux kernel can
4173 access it during the boot procedure.
4174
David A. Longd558a4e2011-07-09 16:40:19 -04004175 If this is set to the special value 0xFFFFFFFF then
4176 the fdt will not be copied at all on boot. For this
4177 to work it must reside in writable memory, have
4178 sufficient padding on the end of it for u-boot to
4179 add the information it needs into it, and the memory
4180 must be accessible by the kernel.
4181
Simon Glassdc6fa642011-10-24 19:15:34 +00004182 fdtcontroladdr- if set this is the address of the control flattened
4183 device tree used by U-Boot when CONFIG_OF_CONTROL is
4184 defined.
4185
wdenk0e2bd9c2004-06-06 21:51:03 +00004186 i2cfast - (PPC405GP|PPC405EP only)
4187 if set to 'y' configures Linux I2C driver for fast
4188 mode (400kHZ). This environment variable is used in
4189 initialization code. So, for changes to be effective
4190 it must be saved and board must be reset.
4191
wdenk6c59edc2004-05-03 20:45:30 +00004192 initrd_high - restrict positioning of initrd images:
4193 If this variable is not set, initrd images will be
4194 copied to the highest possible address in RAM; this
4195 is usually what you want since it allows for
4196 maximum initrd size. If for some reason you want to
4197 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004198 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004199 variable to a value of "no" or "off" or "0".
4200 Alternatively, you can set it to a maximum upper
4201 address to use (U-Boot will still check that it
4202 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004203
wdenk6c59edc2004-05-03 20:45:30 +00004204 For instance, when you have a system with 16 MB
4205 RAM, and want to reserve 4 MB from use by Linux,
4206 you can do this by adding "mem=12M" to the value of
4207 the "bootargs" variable. However, now you must make
4208 sure that the initrd image is placed in the first
4209 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk6c59edc2004-05-03 20:45:30 +00004211 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004212
wdenk6c59edc2004-05-03 20:45:30 +00004213 If you set initrd_high to 0xFFFFFFFF, this is an
4214 indication to U-Boot that all addresses are legal
4215 for the Linux kernel, including addresses in flash
4216 memory. In this case U-Boot will NOT COPY the
4217 ramdisk at all. This may be useful to reduce the
4218 boot time on your system, but requires that this
4219 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004220
wdenk6c59edc2004-05-03 20:45:30 +00004221 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004222
wdenk6c59edc2004-05-03 20:45:30 +00004223 loadaddr - Default load address for commands like "bootp",
4224 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004225
wdenk6c59edc2004-05-03 20:45:30 +00004226 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk6c59edc2004-05-03 20:45:30 +00004228 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004229
wdenk6c59edc2004-05-03 20:45:30 +00004230 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk6c59edc2004-05-03 20:45:30 +00004232 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004233
wdenk6c59edc2004-05-03 20:45:30 +00004234 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004235
Mike Frysingera23230c2011-10-02 10:01:27 +00004236 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004237
Mike Frysingera23230c2011-10-02 10:01:27 +00004238 ethact - controls which interface is currently active.
4239 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004240
Heiko Schocherc5e84052010-07-20 17:45:02 +02004241 => setenv ethact FEC
4242 => ping 192.168.0.1 # traffic sent on FEC
4243 => setenv ethact SCC
4244 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004245
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004246 ethrotate - When set to "no" U-Boot does not go through all
4247 available network interfaces.
4248 It just stays at the currently selected interface.
4249
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004250 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004251 either succeed or fail without retrying.
4252 When set to "once" the network operation will
4253 fail when all the available network interfaces
4254 are tried once without success.
4255 Useful on scripts which control the retry operation
4256 themselves.
wdenkc6097192002-11-03 00:24:07 +00004257
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004258 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004259
Wolfgang Denk227b5192005-09-24 23:25:46 +02004260 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004261 UDP source port.
4262
Wolfgang Denk227b5192005-09-24 23:25:46 +02004263 tftpdstport - If this is set, the value is used for TFTP's UDP
4264 destination port instead of the Well Know Port 69.
4265
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004266 tftpblocksize - Block size to use for TFTP transfers; if not set,
4267 we use the TFTP server's default block size
4268
4269 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4270 seconds, minimum value is 1000 = 1 second). Defines
4271 when a packet is considered to be lost so it has to
4272 be retransmitted. The default is 5000 = 5 seconds.
4273 Lowering this value may make downloads succeed
4274 faster in networks with high packet loss rates or
4275 with unreliable TFTP servers.
4276
4277 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004278 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004279 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004280
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004281The following image location variables contain the location of images
4282used in booting. The "Image" column gives the role of the image and is
4283not an environment variable name. The other columns are environment
4284variable names. "File Name" gives the name of the file on a TFTP
4285server, "RAM Address" gives the location in RAM the image will be
4286loaded to, and "Flash Location" gives the image's address in NOR
4287flash or offset in NAND flash.
4288
4289*Note* - these variables don't have to be defined for all boards, some
4290boards currenlty use other variables for these purposes, and some
4291boards use these variables for other purposes.
4292
Wolfgang Denk092ae952011-10-26 10:21:21 +00004293Image File Name RAM Address Flash Location
4294----- --------- ----------- --------------
4295u-boot u-boot u-boot_addr_r u-boot_addr
4296Linux kernel bootfile kernel_addr_r kernel_addr
4297device tree blob fdtfile fdt_addr_r fdt_addr
4298ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004299
wdenk6c59edc2004-05-03 20:45:30 +00004300The following environment variables may be used and automatically
4301updated by the network boot commands ("bootp" and "rarpboot"),
4302depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004303
wdenk6c59edc2004-05-03 20:45:30 +00004304 bootfile - see above
4305 dnsip - IP address of your Domain Name Server
4306 dnsip2 - IP address of your secondary Domain Name Server
4307 gatewayip - IP address of the Gateway (Router) to use
4308 hostname - Target hostname
4309 ipaddr - see above
4310 netmask - Subnet Mask
4311 rootpath - Pathname of the root filesystem on the NFS server
4312 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004313
wdenk145d2c12004-04-15 21:48:45 +00004314
wdenk6c59edc2004-05-03 20:45:30 +00004315There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk6c59edc2004-05-03 20:45:30 +00004317 serial# - contains hardware identification information such
4318 as type string and/or serial number
4319 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004320
wdenk6c59edc2004-05-03 20:45:30 +00004321These variables can be set only once (usually during manufacturing of
4322the board). U-Boot refuses to delete or overwrite these variables
4323once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004324
4325
wdenk6c59edc2004-05-03 20:45:30 +00004326Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk6c59edc2004-05-03 20:45:30 +00004328 ver - Contains the U-Boot version string as printed
4329 with the "version" command. This variable is
4330 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004331
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk6c59edc2004-05-03 20:45:30 +00004333Please note that changes to some configuration parameters may take
4334only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004335
stroeseb9c17c52003-04-04 15:53:41 +00004336
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004337Callback functions for environment variables:
4338---------------------------------------------
4339
4340For some environment variables, the behavior of u-boot needs to change
4341when their values are changed. This functionailty allows functions to
4342be associated with arbitrary variables. On creation, overwrite, or
4343deletion, the callback will provide the opportunity for some side
4344effect to happen or for the change to be rejected.
4345
4346The callbacks are named and associated with a function using the
4347U_BOOT_ENV_CALLBACK macro in your board or driver code.
4348
4349These callbacks are associated with variables in one of two ways. The
4350static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4351in the board configuration to a string that defines a list of
4352associations. The list must be in the following format:
4353
4354 entry = variable_name[:callback_name]
4355 list = entry[,list]
4356
4357If the callback name is not specified, then the callback is deleted.
4358Spaces are also allowed anywhere in the list.
4359
4360Callbacks can also be associated by defining the ".callbacks" variable
4361with the same list format above. Any association in ".callbacks" will
4362override any association in the static list. You can define
4363CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4364".callbacks" envirnoment variable in the default or embedded environment.
4365
4366
wdenk6c59edc2004-05-03 20:45:30 +00004367Command Line Parsing:
4368=====================
stroeseb9c17c52003-04-04 15:53:41 +00004369
wdenk6c59edc2004-05-03 20:45:30 +00004370There are two different command line parsers available with U-Boot:
4371the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004372
wdenk6c59edc2004-05-03 20:45:30 +00004373Old, simple command line parser:
4374--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk6c59edc2004-05-03 20:45:30 +00004376- supports environment variables (through setenv / saveenv commands)
4377- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004378- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004379- special characters ('$', ';') can be escaped by prefixing with '\',
4380 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004381 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004382- You can also escape text by enclosing in single apostrophes, for example:
4383 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004384
wdenk6c59edc2004-05-03 20:45:30 +00004385Hush shell:
4386-----------
wdenkf4688a22003-05-28 08:06:31 +00004387
wdenk6c59edc2004-05-03 20:45:30 +00004388- similar to Bourne shell, with control structures like
4389 if...then...else...fi, for...do...done; while...do...done,
4390 until...do...done, ...
4391- supports environment ("global") variables (through setenv / saveenv
4392 commands) and local shell variables (through standard shell syntax
4393 "name=value"); only environment variables can be used with "run"
4394 command
wdenkf4688a22003-05-28 08:06:31 +00004395
wdenk6c59edc2004-05-03 20:45:30 +00004396General rules:
4397--------------
wdenkf4688a22003-05-28 08:06:31 +00004398
wdenk6c59edc2004-05-03 20:45:30 +00004399(1) If a command line (or an environment variable executed by a "run"
4400 command) contains several commands separated by semicolon, and
4401 one of these commands fails, then the remaining commands will be
4402 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004403
wdenk6c59edc2004-05-03 20:45:30 +00004404(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004405 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004406 command will cause "run" to terminate, i. e. the remaining
4407 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004408
wdenk6c59edc2004-05-03 20:45:30 +00004409Note for Redundant Ethernet Interfaces:
4410=======================================
wdenkf4688a22003-05-28 08:06:31 +00004411
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004412Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004413such configurations and is capable of automatic selection of a
4414"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004415
wdenk6c59edc2004-05-03 20:45:30 +00004416Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4417MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4418"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004419
wdenk6c59edc2004-05-03 20:45:30 +00004420If the network interface stores some valid MAC address (for instance
4421in SROM), this is used as default address if there is NO correspon-
4422ding setting in the environment; if the corresponding environment
4423variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425o If the SROM has a valid MAC address, and there is no address in the
4426 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004427
wdenk6c59edc2004-05-03 20:45:30 +00004428o If there is no valid address in the SROM, and a definition in the
4429 environment exists, then the value from the environment variable is
4430 used.
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk6c59edc2004-05-03 20:45:30 +00004432o If both the SROM and the environment contain a MAC address, and
4433 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004434
wdenk6c59edc2004-05-03 20:45:30 +00004435o If both the SROM and the environment contain a MAC address, and the
4436 addresses differ, the value from the environment is used and a
4437 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk6c59edc2004-05-03 20:45:30 +00004439o If neither SROM nor the environment contain a MAC address, an error
4440 is raised.
wdenkc6097192002-11-03 00:24:07 +00004441
Ben Warren6db991a2010-04-26 11:11:46 -07004442If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004443will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004444may be skipped by setting the appropriate 'ethmacskip' environment variable.
4445The naming convention is as follows:
4446"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448Image Formats:
4449==============
wdenkc6097192002-11-03 00:24:07 +00004450
Marian Balakowicz18710b82008-03-12 12:13:13 +01004451U-Boot is capable of booting (and performing other auxiliary operations on)
4452images in two formats:
4453
4454New uImage format (FIT)
4455-----------------------
4456
4457Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4458to Flattened Device Tree). It allows the use of images with multiple
4459components (several kernels, ramdisks, etc.), with contents protected by
4460SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4461
4462
4463Old uImage format
4464-----------------
4465
4466Old image format is based on binary files which can be basically anything,
4467preceded by a special header; see the definitions in include/image.h for
4468details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004469
wdenk6c59edc2004-05-03 20:45:30 +00004470* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4471 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004472 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4473 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4474 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004475* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004476 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4477 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004478* Compression Type (uncompressed, gzip, bzip2)
4479* Load Address
4480* Entry Point
4481* Image Name
4482* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004483
wdenk6c59edc2004-05-03 20:45:30 +00004484The header is marked by a special Magic Number, and both the header
4485and the data portions of the image are secured against corruption by
4486CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004487
wdenkc6097192002-11-03 00:24:07 +00004488
wdenk6c59edc2004-05-03 20:45:30 +00004489Linux Support:
4490==============
wdenkc6097192002-11-03 00:24:07 +00004491
wdenk6c59edc2004-05-03 20:45:30 +00004492Although U-Boot should support any OS or standalone application
4493easily, the main focus has always been on Linux during the design of
4494U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk6c59edc2004-05-03 20:45:30 +00004496U-Boot includes many features that so far have been part of some
4497special "boot loader" code within the Linux kernel. Also, any
4498"initrd" images to be used are no longer part of one big Linux image;
4499instead, kernel and "initrd" are separate images. This implementation
4500serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk6c59edc2004-05-03 20:45:30 +00004502- the same features can be used for other OS or standalone
4503 applications (for instance: using compressed images to reduce the
4504 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk6c59edc2004-05-03 20:45:30 +00004506- it becomes much easier to port new Linux kernel versions because
4507 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509- the same Linux kernel image can now be used with different "initrd"
4510 images; of course this also means that different kernel images can
4511 be run with the same "initrd". This makes testing easier (you don't
4512 have to build a new "zImage.initrd" Linux image when you just
4513 change a file in your "initrd"). Also, a field-upgrade of the
4514 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004515
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517Linux HOWTO:
4518============
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk6c59edc2004-05-03 20:45:30 +00004520Porting Linux to U-Boot based systems:
4521---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004522
wdenk6c59edc2004-05-03 20:45:30 +00004523U-Boot cannot save you from doing all the necessary modifications to
4524configure the Linux device drivers for use with your target hardware
4525(no, we don't intend to provide a full virtual machine interface to
4526Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004527
Stefan Roese88fbf932010-04-15 16:07:28 +02004528But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004529
wdenk6c59edc2004-05-03 20:45:30 +00004530Just make sure your machine specific header file (for instance
4531include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004532Information structure as we define in include/asm-<arch>/u-boot.h,
4533and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004534as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004535
wdenkc6097192002-11-03 00:24:07 +00004536
wdenk6c59edc2004-05-03 20:45:30 +00004537Configuring the Linux kernel:
4538-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540No specific requirements for U-Boot. Make sure you have some root
4541device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004542
wdenkc6097192002-11-03 00:24:07 +00004543
wdenk6c59edc2004-05-03 20:45:30 +00004544Building a Linux Image:
4545-----------------------
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4548not used. If you use recent kernel source, a new build target
4549"uImage" will exist which automatically builds an image usable by
4550U-Boot. Most older kernels also have support for a "pImage" target,
4551which was introduced for our predecessor project PPCBoot and uses a
4552100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004553
wdenk6c59edc2004-05-03 20:45:30 +00004554Example:
wdenkc6097192002-11-03 00:24:07 +00004555
wdenk6c59edc2004-05-03 20:45:30 +00004556 make TQM850L_config
4557 make oldconfig
4558 make dep
4559 make uImage
wdenkc6097192002-11-03 00:24:07 +00004560
wdenk6c59edc2004-05-03 20:45:30 +00004561The "uImage" build target uses a special tool (in 'tools/mkimage') to
4562encapsulate a compressed Linux kernel image with header information,
4563CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk6c59edc2004-05-03 20:45:30 +00004565* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004566
wdenk6c59edc2004-05-03 20:45:30 +00004567* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk6c59edc2004-05-03 20:45:30 +00004569 ${CROSS_COMPILE}-objcopy -O binary \
4570 -R .note -R .comment \
4571 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004572
wdenk6c59edc2004-05-03 20:45:30 +00004573* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004574
wdenk6c59edc2004-05-03 20:45:30 +00004575 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004576
wdenk6c59edc2004-05-03 20:45:30 +00004577* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004578
wdenk6c59edc2004-05-03 20:45:30 +00004579 mkimage -A ppc -O linux -T kernel -C gzip \
4580 -a 0 -e 0 -n "Linux Kernel Image" \
4581 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004582
wdenkc6097192002-11-03 00:24:07 +00004583
wdenk6c59edc2004-05-03 20:45:30 +00004584The "mkimage" tool can also be used to create ramdisk images for use
4585with U-Boot, either separated from the Linux kernel image, or
4586combined into one file. "mkimage" encapsulates the images with a 64
4587byte header containing information about target architecture,
4588operating system, image type, compression method, entry points, time
4589stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004590
wdenk6c59edc2004-05-03 20:45:30 +00004591"mkimage" can be called in two ways: to verify existing images and
4592print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004593
wdenk6c59edc2004-05-03 20:45:30 +00004594In the first form (with "-l" option) mkimage lists the information
4595contained in the header of an existing U-Boot image; this includes
4596checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004597
wdenk6c59edc2004-05-03 20:45:30 +00004598 tools/mkimage -l image
4599 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004600
wdenk6c59edc2004-05-03 20:45:30 +00004601The second form (with "-d" option) is used to build a U-Boot image
4602from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004603
wdenk6c59edc2004-05-03 20:45:30 +00004604 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4605 -n name -d data_file image
4606 -A ==> set architecture to 'arch'
4607 -O ==> set operating system to 'os'
4608 -T ==> set image type to 'type'
4609 -C ==> set compression type 'comp'
4610 -a ==> set load address to 'addr' (hex)
4611 -e ==> set entry point to 'ep' (hex)
4612 -n ==> set image name to 'name'
4613 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004614
wdenkcd914452004-05-29 16:53:29 +00004615Right now, all Linux kernels for PowerPC systems use the same load
4616address (0x00000000), but the entry point address depends on the
4617kernel version:
wdenkc6097192002-11-03 00:24:07 +00004618
wdenk6c59edc2004-05-03 20:45:30 +00004619- 2.2.x kernels have the entry point at 0x0000000C,
4620- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004621
wdenk6c59edc2004-05-03 20:45:30 +00004622So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk6c59edc2004-05-03 20:45:30 +00004624 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4625 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004626 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004627 > examples/uImage.TQM850L
4628 Image Name: 2.4.4 kernel for TQM850L
4629 Created: Wed Jul 19 02:34:59 2000
4630 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4631 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4632 Load Address: 0x00000000
4633 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637 -> tools/mkimage -l examples/uImage.TQM850L
4638 Image Name: 2.4.4 kernel for TQM850L
4639 Created: Wed Jul 19 02:34:59 2000
4640 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4641 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4642 Load Address: 0x00000000
4643 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk6c59edc2004-05-03 20:45:30 +00004645NOTE: for embedded systems where boot time is critical you can trade
4646speed for memory and install an UNCOMPRESSED image instead: this
4647needs more space in Flash, but boots much faster since it does not
4648need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004649
Stefan Roese88fbf932010-04-15 16:07:28 +02004650 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004651 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4652 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004653 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004654 > examples/uImage.TQM850L-uncompressed
4655 Image Name: 2.4.4 kernel for TQM850L
4656 Created: Wed Jul 19 02:34:59 2000
4657 Image Type: PowerPC Linux Kernel Image (uncompressed)
4658 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4659 Load Address: 0x00000000
4660 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004661
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk6c59edc2004-05-03 20:45:30 +00004663Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4664when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666 -> tools/mkimage -n 'Simple Ramdisk Image' \
4667 > -A ppc -O linux -T ramdisk -C gzip \
4668 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4669 Image Name: Simple Ramdisk Image
4670 Created: Wed Jan 12 14:01:50 2000
4671 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4672 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4673 Load Address: 0x00000000
4674 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004675
wdenkc6097192002-11-03 00:24:07 +00004676
wdenk6c59edc2004-05-03 20:45:30 +00004677Installing a Linux Image:
4678-------------------------
wdenkc6097192002-11-03 00:24:07 +00004679
wdenk6c59edc2004-05-03 20:45:30 +00004680To downloading a U-Boot image over the serial (console) interface,
4681you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004682
wdenk6c59edc2004-05-03 20:45:30 +00004683 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685The 'objcopy' does not understand the information in the U-Boot
4686image header, so the resulting S-Record file will be relative to
4687address 0x00000000. To load it to a given address, you need to
4688specify the target address as 'offset' parameter with the 'loads'
4689command.
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk6c59edc2004-05-03 20:45:30 +00004691Example: install the image to address 0x40100000 (which on the
4692TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk6c59edc2004-05-03 20:45:30 +00004694 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696 .......... done
4697 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk6c59edc2004-05-03 20:45:30 +00004699 => loads 40100000
4700 ## Ready for S-Record download ...
4701 ~>examples/image.srec
4702 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4703 ...
4704 15989 15990 15991 15992
4705 [file transfer complete]
4706 [connected]
4707 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004708
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004711this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004712corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004715
wdenk6c59edc2004-05-03 20:45:30 +00004716 ## Checking Image at 40100000 ...
4717 Image Name: 2.2.13 for initrd on TQM850L
4718 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4719 Data Size: 335725 Bytes = 327 kB = 0 MB
4720 Load Address: 00000000
4721 Entry Point: 0000000c
4722 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004723
4724
wdenk6c59edc2004-05-03 20:45:30 +00004725Boot Linux:
4726-----------
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk6c59edc2004-05-03 20:45:30 +00004728The "bootm" command is used to boot an application that is stored in
4729memory (RAM or Flash). In case of a Linux kernel image, the contents
4730of the "bootargs" environment variable is passed to the kernel as
4731parameters. You can check and modify this variable using the
4732"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004733
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk6c59edc2004-05-03 20:45:30 +00004735 => printenv bootargs
4736 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk6c59edc2004-05-03 20:45:30 +00004738 => 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 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740 => printenv bootargs
4741 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 +00004742
wdenk6c59edc2004-05-03 20:45:30 +00004743 => bootm 40020000
4744 ## Booting Linux kernel at 40020000 ...
4745 Image Name: 2.2.13 for NFS on TQM850L
4746 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4747 Data Size: 381681 Bytes = 372 kB = 0 MB
4748 Load Address: 00000000
4749 Entry Point: 0000000c
4750 Verifying Checksum ... OK
4751 Uncompressing Kernel Image ... OK
4752 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
4753 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4754 time_init: decrementer frequency = 187500000/60
4755 Calibrating delay loop... 49.77 BogoMIPS
4756 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4757 ...
wdenkc6097192002-11-03 00:24:07 +00004758
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004759If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004760the memory addresses of both the kernel and the initrd image (PPBCOOT
4761format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004762
wdenk6c59edc2004-05-03 20:45:30 +00004763 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk6c59edc2004-05-03 20:45:30 +00004765 ## Checking Image at 40100000 ...
4766 Image Name: 2.2.13 for initrd on TQM850L
4767 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4768 Data Size: 335725 Bytes = 327 kB = 0 MB
4769 Load Address: 00000000
4770 Entry Point: 0000000c
4771 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004772
wdenk6c59edc2004-05-03 20:45:30 +00004773 ## Checking Image at 40200000 ...
4774 Image Name: Simple Ramdisk Image
4775 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4776 Data Size: 566530 Bytes = 553 kB = 0 MB
4777 Load Address: 00000000
4778 Entry Point: 00000000
4779 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk6c59edc2004-05-03 20:45:30 +00004781 => bootm 40100000 40200000
4782 ## Booting Linux kernel at 40100000 ...
4783 Image Name: 2.2.13 for initrd on TQM850L
4784 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4785 Data Size: 335725 Bytes = 327 kB = 0 MB
4786 Load Address: 00000000
4787 Entry Point: 0000000c
4788 Verifying Checksum ... OK
4789 Uncompressing Kernel Image ... OK
4790 ## Loading RAMDisk Image at 40200000 ...
4791 Image Name: Simple Ramdisk Image
4792 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4793 Data Size: 566530 Bytes = 553 kB = 0 MB
4794 Load Address: 00000000
4795 Entry Point: 00000000
4796 Verifying Checksum ... OK
4797 Loading Ramdisk ... OK
4798 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
4799 Boot arguments: root=/dev/ram
4800 time_init: decrementer frequency = 187500000/60
4801 Calibrating delay loop... 49.77 BogoMIPS
4802 ...
4803 RAMDISK: Compressed image found at block 0
4804 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk6c59edc2004-05-03 20:45:30 +00004806 bash#
wdenkc6097192002-11-03 00:24:07 +00004807
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004808Boot Linux and pass a flat device tree:
4809-----------
4810
4811First, U-Boot must be compiled with the appropriate defines. See the section
4812titled "Linux Kernel Interface" above for a more in depth explanation. The
4813following is an example of how to start a kernel and pass an updated
4814flat device tree:
4815
4816=> print oftaddr
4817oftaddr=0x300000
4818=> print oft
4819oft=oftrees/mpc8540ads.dtb
4820=> tftp $oftaddr $oft
4821Speed: 1000, full duplex
4822Using TSEC0 device
4823TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4824Filename 'oftrees/mpc8540ads.dtb'.
4825Load address: 0x300000
4826Loading: #
4827done
4828Bytes transferred = 4106 (100a hex)
4829=> tftp $loadaddr $bootfile
4830Speed: 1000, full duplex
4831Using TSEC0 device
4832TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4833Filename 'uImage'.
4834Load address: 0x200000
4835Loading:############
4836done
4837Bytes transferred = 1029407 (fb51f hex)
4838=> print loadaddr
4839loadaddr=200000
4840=> print oftaddr
4841oftaddr=0x300000
4842=> bootm $loadaddr - $oftaddr
4843## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004844 Image Name: Linux-2.6.17-dirty
4845 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4846 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004847 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004848 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004849 Verifying Checksum ... OK
4850 Uncompressing Kernel Image ... OK
4851Booting using flat device tree at 0x300000
4852Using MPC85xx ADS machine description
4853Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4854[snip]
4855
4856
wdenk6c59edc2004-05-03 20:45:30 +00004857More About U-Boot Image Types:
4858------------------------------
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk6c59edc2004-05-03 20:45:30 +00004860U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk6c59edc2004-05-03 20:45:30 +00004862 "Standalone Programs" are directly runnable in the environment
4863 provided by U-Boot; it is expected that (if they behave
4864 well) you can continue to work in U-Boot after return from
4865 the Standalone Program.
4866 "OS Kernel Images" are usually images of some Embedded OS which
4867 will take over control completely. Usually these programs
4868 will install their own set of exception handlers, device
4869 drivers, set up the MMU, etc. - this means, that you cannot
4870 expect to re-enter U-Boot except by resetting the CPU.
4871 "RAMDisk Images" are more or less just data blocks, and their
4872 parameters (address, size) are passed to an OS kernel that is
4873 being started.
4874 "Multi-File Images" contain several images, typically an OS
4875 (Linux) kernel image and one or more data images like
4876 RAMDisks. This construct is useful for instance when you want
4877 to boot over the network using BOOTP etc., where the boot
4878 server provides just a single image file, but you want to get
4879 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881 "Multi-File Images" start with a list of image sizes, each
4882 image size (in bytes) specified by an "uint32_t" in network
4883 byte order. This list is terminated by an "(uint32_t)0".
4884 Immediately after the terminating 0 follow the images, one by
4885 one, all aligned on "uint32_t" boundaries (size rounded up to
4886 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00004887
wdenk6c59edc2004-05-03 20:45:30 +00004888 "Firmware Images" are binary images containing firmware (like
4889 U-Boot or FPGA images) which usually will be programmed to
4890 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00004891
wdenk6c59edc2004-05-03 20:45:30 +00004892 "Script files" are command sequences that will be executed by
4893 U-Boot's command interpreter; this feature is especially
4894 useful when you configure U-Boot to use a real shell (hush)
4895 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00004896
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004897Booting the Linux zImage:
4898-------------------------
4899
4900On some platforms, it's possible to boot Linux zImage. This is done
4901using the "bootz" command. The syntax of "bootz" command is the same
4902as the syntax of "bootm" command.
4903
Marek Vasut28850d02012-03-18 11:47:58 +00004904Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4905kernel with raw initrd images. The syntax is slightly different, the
4906address of the initrd must be augmented by it's size, in the following
4907format: "<initrd addres>:<initrd size>".
4908
stroeseb9c17c52003-04-04 15:53:41 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910Standalone HOWTO:
4911=================
stroeseb9c17c52003-04-04 15:53:41 +00004912
wdenk6c59edc2004-05-03 20:45:30 +00004913One of the features of U-Boot is that you can dynamically load and
4914run "standalone" applications, which can use some resources of
4915U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00004916
wdenk6c59edc2004-05-03 20:45:30 +00004917Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00004918
wdenk6c59edc2004-05-03 20:45:30 +00004919"Hello World" Demo:
4920-------------------
wdenkc6097192002-11-03 00:24:07 +00004921
wdenk6c59edc2004-05-03 20:45:30 +00004922'examples/hello_world.c' contains a small "Hello World" Demo
4923application; it is automatically compiled when you build U-Boot.
4924It's configured to run at address 0x00040004, so you can play with it
4925like that:
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk6c59edc2004-05-03 20:45:30 +00004927 => loads
4928 ## Ready for S-Record download ...
4929 ~>examples/hello_world.srec
4930 1 2 3 4 5 6 7 8 9 10 11 ...
4931 [file transfer complete]
4932 [connected]
4933 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk6c59edc2004-05-03 20:45:30 +00004935 => go 40004 Hello World! This is a test.
4936 ## Starting application at 0x00040004 ...
4937 Hello World
4938 argc = 7
4939 argv[0] = "40004"
4940 argv[1] = "Hello"
4941 argv[2] = "World!"
4942 argv[3] = "This"
4943 argv[4] = "is"
4944 argv[5] = "a"
4945 argv[6] = "test."
4946 argv[7] = "<NULL>"
4947 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004948
wdenk6c59edc2004-05-03 20:45:30 +00004949 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk6c59edc2004-05-03 20:45:30 +00004951Another example, which demonstrates how to register a CPM interrupt
4952handler with the U-Boot code, can be found in 'examples/timer.c'.
4953Here, a CPM timer is set up to generate an interrupt every second.
4954The interrupt service routine is trivial, just printing a '.'
4955character, but this is just a demo program. The application can be
4956controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk6c59edc2004-05-03 20:45:30 +00004958 ? - print current values og the CPM Timer registers
4959 b - enable interrupts and start timer
4960 e - stop timer and disable interrupts
4961 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004962
wdenk6c59edc2004-05-03 20:45:30 +00004963 => loads
4964 ## Ready for S-Record download ...
4965 ~>examples/timer.srec
4966 1 2 3 4 5 6 7 8 9 10 11 ...
4967 [file transfer complete]
4968 [connected]
4969 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971 => go 40004
4972 ## Starting application at 0x00040004 ...
4973 TIMERS=0xfff00980
4974 Using timer 1
4975 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk6c59edc2004-05-03 20:45:30 +00004977Hit 'b':
4978 [q, b, e, ?] Set interval 1000000 us
4979 Enabling timer
4980Hit '?':
4981 [q, b, e, ?] ........
4982 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4983Hit '?':
4984 [q, b, e, ?] .
4985 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4986Hit '?':
4987 [q, b, e, ?] .
4988 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4989Hit '?':
4990 [q, b, e, ?] .
4991 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4992Hit 'e':
4993 [q, b, e, ?] ...Stopping timer
4994Hit 'q':
4995 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004996
wdenkc6097192002-11-03 00:24:07 +00004997
wdenk6c59edc2004-05-03 20:45:30 +00004998Minicom warning:
4999================
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001Over time, many people have reported problems when trying to use the
5002"minicom" terminal emulation program for serial download. I (wd)
5003consider minicom to be broken, and recommend not to use it. Under
5004Unix, I recommend to use C-Kermit for general purpose use (and
5005especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005006use "cu" for S-Record download ("loads" command). See
5007http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5008for help with kermit.
5009
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk6c59edc2004-05-03 20:45:30 +00005011Nevertheless, if you absolutely want to use it try adding this
5012configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk6c59edc2004-05-03 20:45:30 +00005014 Name Program Name U/D FullScr IO-Red. Multi
5015 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5016 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005017
wdenk8dba0502003-03-31 16:34:49 +00005018
wdenk6c59edc2004-05-03 20:45:30 +00005019NetBSD Notes:
5020=============
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk6c59edc2004-05-03 20:45:30 +00005022Starting at version 0.9.2, U-Boot supports NetBSD both as host
5023(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005024
wdenk6c59edc2004-05-03 20:45:30 +00005025Building requires a cross environment; it is known to work on
5026NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5027need gmake since the Makefiles are not compatible with BSD make).
5028Note that the cross-powerpc package does not install include files;
5029attempting to build U-Boot will fail because <machine/ansi.h> is
5030missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005031
wdenk6c59edc2004-05-03 20:45:30 +00005032 # cd /usr/pkg/cross/powerpc-netbsd/include
5033 # mkdir powerpc
5034 # ln -s powerpc machine
5035 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5036 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005037
wdenk6c59edc2004-05-03 20:45:30 +00005038Native builds *don't* work due to incompatibilities between native
5039and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005040
wdenk6c59edc2004-05-03 20:45:30 +00005041Booting assumes that (the first part of) the image booted is a
5042stage-2 loader which in turn loads and then invokes the kernel
5043proper. Loader sources will eventually appear in the NetBSD source
5044tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005045meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005046
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048Implementation Internals:
5049=========================
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051The following is not intended to be a complete description of every
5052implementation detail. However, it should help to understand the
5053inner workings of U-Boot and make it easier to port it to custom
5054hardware.
wdenkc6097192002-11-03 00:24:07 +00005055
wdenkc6097192002-11-03 00:24:07 +00005056
wdenk6c59edc2004-05-03 20:45:30 +00005057Initial Stack, Global Data:
5058---------------------------
wdenkc6097192002-11-03 00:24:07 +00005059
wdenk6c59edc2004-05-03 20:45:30 +00005060The implementation of U-Boot is complicated by the fact that U-Boot
5061starts running out of ROM (flash memory), usually without access to
5062system RAM (because the memory controller is not initialized yet).
5063This means that we don't have writable Data or BSS segments, and BSS
5064is not initialized as zero. To be able to get a C environment working
5065at all, we have to allocate at least a minimal stack. Implementation
5066options for this are defined and restricted by the CPU used: Some CPU
5067models provide on-chip memory (like the IMMR area on MPC8xx and
5068MPC826x processors), on others (parts of) the data cache can be
5069locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005070
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005071 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005072 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005073
wdenk6c59edc2004-05-03 20:45:30 +00005074 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5075 From: "Chris Hallinan" <clh@net1plus.com>
5076 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5077 ...
wdenkc6097192002-11-03 00:24:07 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079 Correct me if I'm wrong, folks, but the way I understand it
5080 is this: Using DCACHE as initial RAM for Stack, etc, does not
5081 require any physical RAM backing up the cache. The cleverness
5082 is that the cache is being used as a temporary supply of
5083 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005084 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005085 can see how this works by studying the cache architecture and
5086 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk6c59edc2004-05-03 20:45:30 +00005088 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5089 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005090 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005091 option should work for you. Using CS 4 should be fine if your
5092 board designers haven't used it for something that would
5093 cause you grief during the initial boot! It is frequently not
5094 used.
wdenkc6097192002-11-03 00:24:07 +00005095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005096 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005097 with your processor/board/system design. The default value
5098 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005099 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005100 than your SDRAM module. If you have a 64MB SDRAM module, set
5101 it above 400_0000. Just make sure your board has no resources
5102 that are supposed to respond to that address! That code in
5103 start.S has been around a while and should work as is when
5104 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005105
wdenk6c59edc2004-05-03 20:45:30 +00005106 -Chris Hallinan
5107 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005108
wdenk6c59edc2004-05-03 20:45:30 +00005109It is essential to remember this, since it has some impact on the C
5110code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005111
wdenk6c59edc2004-05-03 20:45:30 +00005112* Initialized global data (data segment) is read-only. Do not attempt
5113 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005114
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005115* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005116 as zero data - BSS segment) at all - this is undefined, initiali-
5117 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005118
wdenk6c59edc2004-05-03 20:45:30 +00005119* Stack space is very limited. Avoid big data buffers or things like
5120 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005121
wdenk6c59edc2004-05-03 20:45:30 +00005122Having only the stack as writable memory limits means we cannot use
5123normal global data to share information beween the code. But it
5124turned out that the implementation of U-Boot can be greatly
5125simplified by making a global data structure (gd_t) available to all
5126functions. We could pass a pointer to this data as argument to _all_
5127functions, but this would bloat the code. Instead we use a feature of
5128the GCC compiler (Global Register Variables) to share the data: we
5129place a pointer (gd) to the global data into a register which we
5130reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk6c59edc2004-05-03 20:45:30 +00005132When choosing a register for such a purpose we are restricted by the
5133relevant (E)ABI specifications for the current architecture, and by
5134GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136For PowerPC, the following registers have specific use:
5137 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005138 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005139 R3-R4: parameter passing and return values
5140 R5-R10: parameter passing
5141 R13: small data area pointer
5142 R30: GOT pointer
5143 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005144
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005145 (U-Boot also uses R12 as internal GOT pointer. r12
5146 is a volatile register so r12 needs to be reset when
5147 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005148
Wolfgang Denk69c09642008-02-14 22:43:22 +01005149 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151 Note: on PPC, we could use a static initializer (since the
5152 address of the global data structure is known at compile time),
5153 but it turned out that reserving a register results in somewhat
5154 smaller code - although the code savings are not that big (on
5155 average for all boards 752 bytes for the whole U-Boot image,
5156 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005157
Robin Getz2773d5f2009-08-17 15:23:02 +00005158On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005159 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5160
Robin Getz2773d5f2009-08-17 15:23:02 +00005161 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005162
wdenk6c59edc2004-05-03 20:45:30 +00005163On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165 R0: function argument word/integer result
5166 R1-R3: function argument word
5167 R9: GOT pointer
5168 R10: stack limit (used only if stack checking if enabled)
5169 R11: argument (frame) pointer
5170 R12: temporary workspace
5171 R13: stack pointer
5172 R14: link register
5173 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk6c59edc2004-05-03 20:45:30 +00005175 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005176
Thomas Chou8fa38582010-05-21 11:08:03 +08005177On Nios II, the ABI is documented here:
5178 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5179
5180 ==> U-Boot will use gp to hold a pointer to the global data
5181
5182 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5183 to access small data sections, so gp is free.
5184
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005185On NDS32, the following registers are used:
5186
5187 R0-R1: argument/return
5188 R2-R5: argument
5189 R15: temporary register for assembler
5190 R16: trampoline register
5191 R28: frame pointer (FP)
5192 R29: global pointer (GP)
5193 R30: link register (LP)
5194 R31: stack pointer (SP)
5195 PC: program counter (PC)
5196
5197 ==> U-Boot will use R10 to hold a pointer to the global data
5198
Wolfgang Denk6405a152006-03-31 18:32:53 +02005199NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5200or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005201
wdenk6c59edc2004-05-03 20:45:30 +00005202Memory Management:
5203------------------
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205U-Boot runs in system state and uses physical addresses, i.e. the
5206MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208The available memory is mapped to fixed addresses using the memory
5209controller. In this process, a contiguous block is formed for each
5210memory type (Flash, SDRAM, SRAM), even when it consists of several
5211physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213U-Boot is installed in the first 128 kB of the first Flash bank (on
5214TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5215booting and sizing and initializing DRAM, the code relocates itself
5216to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005217memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005218configuration setting]. Below that, a structure with global Board
5219Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221Additionally, some exception handler code is copied to the low 8 kB
5222of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk6c59edc2004-05-03 20:45:30 +00005224So a typical memory configuration with 16 MB of DRAM could look like
5225this:
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227 0x0000 0000 Exception Vector code
5228 :
5229 0x0000 1FFF
5230 0x0000 2000 Free for Application Use
5231 :
5232 :
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk6c59edc2004-05-03 20:45:30 +00005234 :
5235 :
5236 0x00FB FF20 Monitor Stack (Growing downward)
5237 0x00FB FFAC Board Info Data and permanent copy of global data
5238 0x00FC 0000 Malloc Arena
5239 :
5240 0x00FD FFFF
5241 0x00FE 0000 RAM Copy of Monitor Code
5242 ... eventually: LCD or video framebuffer
5243 ... eventually: pRAM (Protected RAM - unchanged by reset)
5244 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005245
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247System Initialization:
5248----------------------
wdenkc6097192002-11-03 00:24:07 +00005249
wdenk6c59edc2004-05-03 20:45:30 +00005250In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005251(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005252configuration for CS0# this is a mirror of the onboard Flash memory.
5253To be able to re-map memory U-Boot then jumps to its link address.
5254To be able to implement the initialization code in C, a (small!)
5255initial stack is set up in the internal Dual Ported RAM (in case CPUs
5256which provide such a feature like MPC8xx or MPC8260), or in a locked
5257part of the data cache. After that, U-Boot initializes the CPU core,
5258the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005259
wdenk6c59edc2004-05-03 20:45:30 +00005260Next, all (potentially) available memory banks are mapped using a
5261preliminary mapping. For example, we put them on 512 MB boundaries
5262(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5263on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5264programmed for SDRAM access. Using the temporary configuration, a
5265simple memory test is run that determines the size of the SDRAM
5266banks.
wdenkc6097192002-11-03 00:24:07 +00005267
wdenk6c59edc2004-05-03 20:45:30 +00005268When there is more than one SDRAM bank, and the banks are of
5269different size, the largest is mapped first. For equal size, the first
5270bank (CS2#) is mapped first. The first mapping is always for address
52710x00000000, with any additional banks following immediately to create
5272contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005273
wdenk6c59edc2004-05-03 20:45:30 +00005274Then, the monitor installs itself at the upper end of the SDRAM area
5275and allocates memory for use by malloc() and for the global Board
5276Info data; also, the exception vector code is copied to the low RAM
5277pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279Only after this relocation will you have a "normal" C environment;
5280until that you are restricted in several ways, mostly because you are
5281running from ROM, and because the code will have to be relocated to a
5282new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005283
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk6c59edc2004-05-03 20:45:30 +00005285U-Boot Porting Guide:
5286----------------------
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk6c59edc2004-05-03 20:45:30 +00005288[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5289list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005290
wdenkc6097192002-11-03 00:24:07 +00005291
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005292int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005293{
5294 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005295
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005296 signal(SIGALRM, no_more_time);
5297 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk6c59edc2004-05-03 20:45:30 +00005299 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005300 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005301 return 0;
5302 }
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk6c59edc2004-05-03 20:45:30 +00005304 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005305
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005306 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005307
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005308 if (clueless)
5309 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311 while (learning) {
5312 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005313 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5314 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005315 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005316 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005317 }
wdenkc6097192002-11-03 00:24:07 +00005318
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005319 if (available_money > toLocalCurrency ($2500))
5320 Buy a BDI3000;
5321 else
wdenk6c59edc2004-05-03 20:45:30 +00005322 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005323
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005324 if (a similar board exists) { /* hopefully... */
5325 cp -a board/<similar> board/<myboard>
5326 cp include/configs/<similar>.h include/configs/<myboard>.h
5327 } else {
5328 Create your own board support subdirectory;
5329 Create your own board include/configs/<myboard>.h file;
5330 }
5331 Edit new board/<myboard> files
5332 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005333
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005334 while (!accepted) {
5335 while (!running) {
5336 do {
5337 Add / modify source code;
5338 } until (compiles);
5339 Debug;
5340 if (clueless)
5341 email("Hi, I am having problems...");
5342 }
5343 Send patch file to the U-Boot email list;
5344 if (reasonable critiques)
5345 Incorporate improvements from email list code review;
5346 else
5347 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005348 }
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350 return 0;
5351}
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk6c59edc2004-05-03 20:45:30 +00005353void no_more_time (int sig)
5354{
5355 hire_a_guru();
5356}
wdenkc6097192002-11-03 00:24:07 +00005357
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk6c59edc2004-05-03 20:45:30 +00005359Coding Standards:
5360-----------------
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005363coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005364"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005365
5366Source files originating from a different project (for example the
5367MTD subsystem) are generally exempt from these guidelines and are not
5368reformated to ease subsequent migration to newer versions of those
5369sources.
wdenkc6097192002-11-03 00:24:07 +00005370
Detlev Zundelaa63d482006-09-01 15:39:02 +02005371Please note that U-Boot is implemented in C (and to some small parts in
5372Assembler); no C++ is used, so please do not use C++ style comments (//)
5373in your code.
wdenkad276f22004-01-04 16:28:35 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375Please also stick to the following formatting rules:
5376- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005377- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005378- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005379- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005380- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005381
wdenk6c59edc2004-05-03 20:45:30 +00005382Submissions which do not conform to the standards may be returned
5383with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005384
wdenkc6097192002-11-03 00:24:07 +00005385
wdenk6c59edc2004-05-03 20:45:30 +00005386Submitting Patches:
5387-------------------
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389Since the number of patches for U-Boot is growing, we need to
5390establish some rules. Submissions which do not conform to these rules
5391may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005392
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005393Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005394
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005395Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5396see http://lists.denx.de/mailman/listinfo/u-boot
5397
wdenk6c59edc2004-05-03 20:45:30 +00005398When you send a patch, please include the following information with
5399it:
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401* For bug fixes: a description of the bug and how your patch fixes
5402 this bug. Please try to include a way of demonstrating that the
5403 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk6c59edc2004-05-03 20:45:30 +00005405* For new features: a description of the feature and your
5406 implementation.
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk6c59edc2004-05-03 20:45:30 +00005408* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005413 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk6c59edc2004-05-03 20:45:30 +00005415* If your patch adds new configuration options, don't forget to
5416 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005417
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005418* The patch itself. If you are using git (which is *strongly*
5419 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005420 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005421 the U-Boot mailing list, you will avoid most of the common problems
5422 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005423
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005424 If you cannot use git, use "diff -purN OLD NEW". If your version of
5425 diff does not support these options, then get the latest version of
5426 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005427
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005428 The current directory when running this command shall be the parent
5429 directory of the U-Boot source tree (i. e. please make sure that
5430 your patch includes sufficient directory information for the
5431 affected files).
5432
5433 We prefer patches as plain text. MIME attachments are discouraged,
5434 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005435
wdenk6c59edc2004-05-03 20:45:30 +00005436* If one logical set of modifications affects or creates several
5437 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005438
wdenk6c59edc2004-05-03 20:45:30 +00005439* Changesets that contain different, unrelated modifications shall be
5440 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005441
wdenkc6097192002-11-03 00:24:07 +00005442
wdenk6c59edc2004-05-03 20:45:30 +00005443Notes:
wdenkc6097192002-11-03 00:24:07 +00005444
wdenk6c59edc2004-05-03 20:45:30 +00005445* Before sending the patch, run the MAKEALL script on your patched
5446 source tree and make sure that no errors or warnings are reported
5447 for any of the boards.
5448
5449* Keep your modifications to the necessary minimum: A patch
5450 containing several unrelated changes or arbitrary reformats will be
5451 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005452
wdenk6c59edc2004-05-03 20:45:30 +00005453* If you modify existing code, make sure that your new code does not
5454 add to the memory footprint of the code ;-) Small is beautiful!
5455 When adding new features, these should compile conditionally only
5456 (using #ifdef), and the resulting code with the new feature
5457 disabled must not need more memory than the old code without your
5458 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005459
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005460* Remember that there is a size limit of 100 kB per message on the
5461 u-boot mailing list. Bigger patches will be moderated. If they are
5462 reasonable and not too big, they will be acknowledged. But patches
5463 bigger than the size limit should be avoided.