xref: /openbmc/u-boot/README (revision 1d71efbb0345ff3a8ac45e62bef36813abe1703e)
1 c609719bSwdenk#
2 eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3 c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 c609719bSwdenk#
5 eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6 c609719bSwdenk#
7 c609719bSwdenk
8 c609719bSwdenkSummary:
9 c609719bSwdenk========
10 c609719bSwdenk
11 24ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12 e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13 e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14 e86e5a07Swdenkinitialize and test the hardware or to download and run application
15 e86e5a07Swdenkcode.
16 c609719bSwdenk
17 c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
18 24ee89b9Swdenkthe source code originate in the Linux source tree, we have some
19 24ee89b9Swdenkheader files in common, and special provision has been made to
20 c609719bSwdenksupport booting of Linux images.
21 c609719bSwdenk
22 c609719bSwdenkSome attention has been paid to make this software easily
23 c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24 c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25 c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26 c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27 c609719bSwdenkload and run it dynamically.
28 c609719bSwdenk
29 c609719bSwdenk
30 c609719bSwdenkStatus:
31 c609719bSwdenk=======
32 c609719bSwdenk
33 c609719bSwdenkIn general, all boards for which a configuration option exists in the
34 c609719bSwdenkMakefile have been tested to some extent and can be considered
35 c609719bSwdenk"working". In fact, many of them are used in production systems.
36 c609719bSwdenk
37 c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
38 27af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39 218ca724SWolfgang Denkmaintainers.
40 c609719bSwdenk
41 adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42 adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43 adb9d851SRobert P. J. Day
44 adb9d851SRobert P. J. Day	make CHANGELOG
45 adb9d851SRobert P. J. Day
46 c609719bSwdenk
47 c609719bSwdenkWhere to get help:
48 c609719bSwdenk==================
49 c609719bSwdenk
50 c609719bSwdenkIn case you have questions about, problems with or contributions for
51 c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
52 0c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
53 0c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
54 0c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
55 0c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56 c609719bSwdenk
57 c609719bSwdenk
58 218ca724SWolfgang DenkWhere to get source code:
59 218ca724SWolfgang Denk=========================
60 218ca724SWolfgang Denk
61 218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62 218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63 218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64 218ca724SWolfgang Denk
65 218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
66 11ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67 218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68 218ca724SWolfgang Denkdirectory.
69 218ca724SWolfgang Denk
70 d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71 218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72 218ca724SWolfgang Denk
73 218ca724SWolfgang Denk
74 c609719bSwdenkWhere we come from:
75 c609719bSwdenk===================
76 c609719bSwdenk
77 c609719bSwdenk- start from 8xxrom sources
78 24ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79 c609719bSwdenk- clean up code
80 c609719bSwdenk- make it easier to add custom boards
81 c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82 c609719bSwdenk- extend functions, especially:
83 c609719bSwdenk  * Provide extended interface to Linux boot loader
84 c609719bSwdenk  * S-Record download
85 c609719bSwdenk  * network boot
86 11ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87 24ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88 c609719bSwdenk- add other CPU families (starting with ARM)
89 24ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
90 0d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
91 24ee89b9Swdenk
92 24ee89b9Swdenk
93 24ee89b9SwdenkNames and Spelling:
94 24ee89b9Swdenk===================
95 24ee89b9Swdenk
96 24ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
97 24ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
98 24ee89b9Swdenkin source files etc.). Example:
99 24ee89b9Swdenk
100 24ee89b9Swdenk	This is the README file for the U-Boot project.
101 24ee89b9Swdenk
102 24ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
103 24ee89b9Swdenk
104 24ee89b9Swdenk	include/asm-ppc/u-boot.h
105 24ee89b9Swdenk
106 24ee89b9Swdenk	#include <asm/u-boot.h>
107 24ee89b9Swdenk
108 24ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
109 24ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
110 24ee89b9Swdenk
111 24ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
112 24ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113 c609719bSwdenk
114 c609719bSwdenk
115 93f19cc0SwdenkVersioning:
116 93f19cc0Swdenk===========
117 93f19cc0Swdenk
118 360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119 360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120 360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121 360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122 360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123 360d883aSThomas Weberreleases in "stable" maintenance trees.
124 93f19cc0Swdenk
125 360d883aSThomas WeberExamples:
126 360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127 360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128 360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
129 93f19cc0Swdenk
130 93f19cc0Swdenk
131 c609719bSwdenkDirectory Hierarchy:
132 c609719bSwdenk====================
133 c609719bSwdenk
134 8d321b81SPeter Tyser/arch			Architecture specific files
135 6eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
136 6eae68e4SMasahiro Yamada    /cpu		CPU specific files
137 6eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
138 6eae68e4SMasahiro Yamada    /lib		Architecture specific library files
139 8d321b81SPeter Tyser  /arm			Files generic to ARM architecture
140 8d321b81SPeter Tyser    /cpu		CPU specific files
141 8d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
142 8d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
143 6eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
144 8d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
145 8d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
146 8d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
147 8d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
148 8d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
149 8d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
150 8d321b81SPeter Tyser    /lib		Architecture specific library files
151 8d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
152 8d321b81SPeter Tyser    /cpu		CPU specific files
153 8d321b81SPeter Tyser    /lib		Architecture specific library files
154 8d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
155 8d321b81SPeter Tyser    /cpu		CPU specific files
156 8d321b81SPeter Tyser    /lib		Architecture specific library files
157 8d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
158 8d321b81SPeter Tyser    /cpu		CPU specific files
159 8d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
160 8d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
161 8d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
162 8d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
163 8d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
164 8d321b81SPeter Tyser    /lib		Architecture specific library files
165 8d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
166 8d321b81SPeter Tyser    /cpu		CPU specific files
167 8d321b81SPeter Tyser    /lib		Architecture specific library files
168 8d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
169 8d321b81SPeter Tyser    /cpu		CPU specific files
170 92bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
171 6eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
172 8d321b81SPeter Tyser    /lib		Architecture specific library files
173 afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174 afc1ce82SMacpaul Lin    /cpu		CPU specific files
175 afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176 afc1ce82SMacpaul Lin    /lib		Architecture specific library files
177 8d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
178 8d321b81SPeter Tyser    /cpu		CPU specific files
179 8d321b81SPeter Tyser    /lib		Architecture specific library files
180 33c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
181 33c7731bSRobert P. J. Day    /cpu		CPU specific files
182 33c7731bSRobert P. J. Day    /lib		Architecture specific library files
183 a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
184 8d321b81SPeter Tyser    /cpu		CPU specific files
185 8d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
186 8d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
187 8d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
188 8d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
189 8d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
190 8d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
191 8d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
192 8d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
193 8d321b81SPeter Tyser    /lib		Architecture specific library files
194 8d321b81SPeter Tyser  /sh			Files generic to SH architecture
195 8d321b81SPeter Tyser    /cpu		CPU specific files
196 8d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
197 8d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
198 8d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
199 8d321b81SPeter Tyser    /lib		Architecture specific library files
200 8d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
201 8d321b81SPeter Tyser    /cpu		CPU specific files
202 8d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
203 8d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
204 8d321b81SPeter Tyser    /lib		Architecture specific library files
205 33c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
206 33c7731bSRobert P. J. Day    /cpu		CPU specific files
207 33c7731bSRobert P. J. Day    /lib		Architecture specific library files
208 8d321b81SPeter Tyser/api			Machine/arch independent API for external apps
209 8d321b81SPeter Tyser/board			Board dependent files
210 8d321b81SPeter Tyser/common			Misc architecture independent functions
211 8d321b81SPeter Tyser/disk			Code for disk drive partition handling
212 8d321b81SPeter Tyser/doc			Documentation (don't expect too much)
213 8d321b81SPeter Tyser/drivers		Commonly used device drivers
214 33c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
215 8d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
216 8d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
217 8d321b81SPeter Tyser/include		Header Files
218 8d321b81SPeter Tyser/lib			Files generic to all architectures
219 8d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
220 8d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
221 8d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
222 8d321b81SPeter Tyser/net			Networking code
223 8d321b81SPeter Tyser/post			Power On Self Test
224 33c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
225 8d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
226 c609719bSwdenk
227 c609719bSwdenkSoftware Configuration:
228 c609719bSwdenk=======================
229 c609719bSwdenk
230 c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
231 c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
232 c609719bSwdenk
233 c609719bSwdenkThere are two classes of configuration variables:
234 c609719bSwdenk
235 c609719bSwdenk* Configuration _OPTIONS_:
236 c609719bSwdenk  These are selectable by the user and have names beginning with
237 c609719bSwdenk  "CONFIG_".
238 c609719bSwdenk
239 c609719bSwdenk* Configuration _SETTINGS_:
240 c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
241 c609719bSwdenk  you don't know what you're doing; they have names beginning with
242 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
243 c609719bSwdenk
244 c609719bSwdenkLater we will add a configuration tool - probably similar to or even
245 c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
246 c609719bSwdenkdo the configuration by hand, which means creating some symbolic
247 c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
248 c609719bSwdenkas an example here.
249 c609719bSwdenk
250 c609719bSwdenk
251 c609719bSwdenkSelection of Processor Architecture and Board Type:
252 c609719bSwdenk---------------------------------------------------
253 c609719bSwdenk
254 c609719bSwdenkFor all supported boards there are ready-to-use default
255 ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
256 c609719bSwdenk
257 c609719bSwdenkExample: For a TQM823L module type:
258 c609719bSwdenk
259 c609719bSwdenk	cd u-boot
260 ab584d67SHolger Freyther	make TQM823L_defconfig
261 c609719bSwdenk
262 11ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
263 ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
264 c609719bSwdenkdirectory according to the instructions in cogent/README.
265 c609719bSwdenk
266 c609719bSwdenk
267 75b3c3aaSSimon GlassSandbox Environment:
268 75b3c3aaSSimon Glass--------------------
269 75b3c3aaSSimon Glass
270 75b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
271 75b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
272 75b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
273 75b3c3aaSSimon Glassrun some of U-Boot's tests.
274 75b3c3aaSSimon Glass
275 6b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
276 75b3c3aaSSimon Glass
277 75b3c3aaSSimon Glass
278 c609719bSwdenkConfiguration Options:
279 c609719bSwdenk----------------------
280 c609719bSwdenk
281 c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
282 c609719bSwdenksuch information is kept in a configuration file
283 c609719bSwdenk"include/configs/<board_name>.h".
284 c609719bSwdenk
285 c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
286 c609719bSwdenk"include/configs/TQM823L.h".
287 c609719bSwdenk
288 c609719bSwdenk
289 7f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
290 7f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
291 7f6c2cbcSwdenkbuild a config tool - later.
292 7f6c2cbcSwdenk
293 7f6c2cbcSwdenk
294 c609719bSwdenkThe following options need to be configured:
295 c609719bSwdenk
296 2628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
297 c609719bSwdenk
298 2628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
299 6ccec449SWolfgang Denk
300 6ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
301 09ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
302 c609719bSwdenk
303 c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
304 c609719bSwdenk		Define exactly one of
305 c609719bSwdenk		CONFIG_CMA286_60_OLD
306 c609719bSwdenk--- FIXME --- not tested yet:
307 c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
309 c609719bSwdenk
310 c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
311 c609719bSwdenk		Define exactly one of
312 c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
313 c609719bSwdenk
314 c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 c609719bSwdenk		Define one or more of
316 c609719bSwdenk		CONFIG_CMA302
317 c609719bSwdenk
318 c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 c609719bSwdenk		Define one or more of
320 c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
321 11ccc33fSMarcel Ziswiler					  the LCD display every second with
322 c609719bSwdenk					  a "rotator" |\-/|\-/
323 c609719bSwdenk
324 cf946c6dSLei Wen- Marvell Family Member
325 cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
326 cf946c6dSLei Wen					  multiple fs option at one time
327 cf946c6dSLei Wen					  for marvell soc family
328 cf946c6dSLei Wen
329 c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
330 c609719bSwdenk		Define exactly one of
331 c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
332 c609719bSwdenk
333 11ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
334 66ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
335 66ca92a5Swdenk					  get_gclk_freq() cannot work
336 5da627a4Swdenk					  e.g. if there is no 32KHz
337 5da627a4Swdenk					  reference PIT/RTC clock
338 66ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
339 66ca92a5Swdenk					  or XTAL/EXTAL)
340 c609719bSwdenk
341 66ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
342 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
343 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
344 66ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
345 75d1ea7fSwdenk			See doc/README.MPC866
346 75d1ea7fSwdenk
347 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
348 75d1ea7fSwdenk
349 75d1ea7fSwdenk		Define this to measure the actual CPU clock instead
350 75d1ea7fSwdenk		of relying on the correctness of the configured
351 75d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
352 75d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
353 75d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
354 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
355 75d1ea7fSwdenk
356 506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
357 506f3918SHeiko Schocher
358 506f3918SHeiko Schocher		Define this option if you want to enable the
359 506f3918SHeiko Schocher		ICache only when Code runs from RAM.
360 506f3918SHeiko Schocher
361 66412c63SKumar Gala- 85xx CPU Options:
362 ffd06e02SYork Sun		CONFIG_SYS_PPC64
363 ffd06e02SYork Sun
364 ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
365 ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
366 ffd06e02SYork Sun		compliance, among other possible reasons.
367 ffd06e02SYork Sun
368 66412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
369 66412c63SKumar Gala
370 66412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
371 66412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
372 66412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
373 66412c63SKumar Gala
374 8f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
375 8f29084aSKumar Gala
376 8f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
377 8f29084aSKumar Gala		tree nodes for the given platform.
378 8f29084aSKumar Gala
379 afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
380 afa6b551SPrabhakar Kushwaha
381 afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
382 afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
383 afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
384 afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
385 afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
386 afa6b551SPrabhakar Kushwaha		purpose.
387 afa6b551SPrabhakar Kushwaha
388 33eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
389 33eee330SScott Wood
390 33eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
391 33eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 33eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393 33eee330SScott Wood
394 33eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 33eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396 33eee330SScott Wood
397 33eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
398 33eee330SScott Wood		for which the A004510 workaround should be applied.
399 33eee330SScott Wood
400 33eee330SScott Wood		The rest of SVR is either not relevant to the decision
401 33eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
402 33eee330SScott Wood		p2041) or is implied by the build target, which controls
403 33eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404 33eee330SScott Wood
405 33eee330SScott Wood		See Freescale App Note 4493 for more information about
406 33eee330SScott Wood		this erratum.
407 33eee330SScott Wood
408 74fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
409 74fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
410 74fa22edSPrabhakar Kushwaha		requred during NOR boot.
411 74fa22edSPrabhakar Kushwaha
412 33eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413 33eee330SScott Wood
414 33eee330SScott Wood		This is the value to write into CCSR offset 0x18600
415 33eee330SScott Wood		according to the A004510 workaround.
416 33eee330SScott Wood
417 64501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
418 64501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
419 64501c66SPriyanka Jain		connected exclusively to the DSP cores.
420 64501c66SPriyanka Jain
421 765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
423 765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
424 765b0bdbSPriyanka Jain
425 64501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 64501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
427 64501c66SPriyanka Jain		connected to the DSP core.
428 64501c66SPriyanka Jain
429 765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
431 765b0bdbSPriyanka Jain
432 b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
434 b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
435 b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
436 b135991aSPriyanka Jain
437 fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
438 fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
439 fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
440 fb4a2409SAneesh Bansal
441 aade2004STang Yuantian		CONFIG_DEEP_SLEEP
442 aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
443 aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
444 aade2004STang Yuantian
445 6cb461b4SDaniel Schwierzeck- Generic CPU options:
446 2a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
447 2a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
448 2a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
449 2a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
450 2a1680e3SYork Sun		should initialize global data before calling board_init_f().
451 2a1680e3SYork Sun
452 6cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453 6cb461b4SDaniel Schwierzeck
454 6cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
455 6cb461b4SDaniel Schwierzeck		values is arch specific.
456 6cb461b4SDaniel Schwierzeck
457 5614e71bSYork Sun		CONFIG_SYS_FSL_DDR
458 5614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
459 5614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 5614e71bSYork Sun		SoCs.
461 5614e71bSYork Sun
462 5614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
463 5614e71bSYork Sun		Freescale DDR memory-mapped register base.
464 5614e71bSYork Sun
465 5614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
466 5614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
467 5614e71bSYork Sun		deskew training are not available.
468 5614e71bSYork Sun
469 5614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
470 5614e71bSYork Sun		Freescale DDR1 controller.
471 5614e71bSYork Sun
472 5614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
473 5614e71bSYork Sun		Freescale DDR2 controller.
474 5614e71bSYork Sun
475 5614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
476 5614e71bSYork Sun		Freescale DDR3 controller.
477 5614e71bSYork Sun
478 34e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
479 34e026f9SYork Sun		Freescale DDR4 controller.
480 34e026f9SYork Sun
481 9ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 9ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
483 9ac4ffbdSYork Sun
484 5614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
485 5614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
486 5614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
487 5614e71bSYork Sun		implemetation.
488 5614e71bSYork Sun
489 5614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
490 5614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
491 5614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
492 5614e71bSYork Sun		implementation.
493 5614e71bSYork Sun
494 5614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
495 5614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
496 34e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
497 34e026f9SYork Sun
498 34e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
499 34e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
500 34e026f9SYork Sun		DDR3L controllers.
501 34e026f9SYork Sun
502 34e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
503 34e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
504 34e026f9SYork Sun		DDR4 controllers.
505 5614e71bSYork Sun
506 1b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
507 1b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
508 1b4175d6SPrabhakar Kushwaha
509 1b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
510 1b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
511 1b4175d6SPrabhakar Kushwaha
512 690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
513 690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
514 690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
515 690e4258SPrabhakar Kushwaha
516 690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
517 690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
518 690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
519 690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
520 690e4258SPrabhakar Kushwaha
521 89ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
522 89ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
523 89ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
524 89ad7be8SPrabhakar Kushwaha
525 4e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
526 4e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
527 4e5b1bd0SYork Sun
528 4e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
529 4e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
530 4e5b1bd0SYork Sun
531 6b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 6b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
533 6b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
534 6b9e309aSYork Sun		it could be different for ARM SoCs.
535 6b9e309aSYork Sun
536 6b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
537 6b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
538 6b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
539 6b1e1254SYork Sun		SoCs with ARM core.
540 6b1e1254SYork Sun
541 *1d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
542 *1d71efbbSYork Sun		Number of controllers used as main memory.
543 *1d71efbbSYork Sun
544 *1d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
545 *1d71efbbSYork Sun		Number of controllers used for other than main memory.
546 *1d71efbbSYork Sun
547 0b953ffcSMarkus Klotzbuecher- Intel Monahans options:
548 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
549 0b953ffcSMarkus Klotzbuecher
550 0b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
551 0b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
552 0b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
553 0b953ffcSMarkus Klotzbuecher
554 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
555 0b953ffcSMarkus Klotzbuecher
556 0b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
557 0b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
558 0b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
559 0b953ffcSMarkus Klotzbuecher		by this value.
560 0b953ffcSMarkus Klotzbuecher
561 92bbd64eSDaniel Schwierzeck- MIPS CPU options:
562 92bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
563 92bbd64eSDaniel Schwierzeck
564 92bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
565 92bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
566 92bbd64eSDaniel Schwierzeck		relocation.
567 92bbd64eSDaniel Schwierzeck
568 92bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
569 92bbd64eSDaniel Schwierzeck
570 92bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
571 92bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
572 92bbd64eSDaniel Schwierzeck		Possible values are:
573 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
574 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
575 92bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
576 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
577 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
578 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
579 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
580 92bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
581 92bbd64eSDaniel Schwierzeck
582 92bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
583 92bbd64eSDaniel Schwierzeck
584 92bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
585 92bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
586 92bbd64eSDaniel Schwierzeck
587 92bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
588 92bbd64eSDaniel Schwierzeck
589 92bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
590 92bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
591 92bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
592 92bbd64eSDaniel Schwierzeck
593 b67d8816SChristian Riesch- ARM options:
594 b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
595 b67d8816SChristian Riesch
596 b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
597 b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
598 b67d8816SChristian Riesch
599 5356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
600 5356f545SAneesh V
601 5356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
602 5356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
603 5356f545SAneesh V		better code density. For ARM architectures that support
604 5356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
605 5356f545SAneesh V		GCC.
606 5356f545SAneesh V
607 c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
608 0678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
609 0678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
610 0678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
611 f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
612 b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
613 0678587fSStephen Warren
614 0678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
615 0678587fSStephen Warren		during U-Boot startup. Note that these options force the
616 0678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
617 0678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
618 0678587fSStephen Warren		set these options unless they apply!
619 0678587fSStephen Warren
620 795659dcSStephen Warren- CPU timer options:
621 795659dcSStephen Warren		CONFIG_SYS_HZ
622 795659dcSStephen Warren
623 795659dcSStephen Warren		The frequency of the timer returned by get_timer().
624 795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
625 795659dcSStephen Warren		option must be set to 1000.
626 795659dcSStephen Warren
627 5da627a4Swdenk- Linux Kernel Interface:
628 c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
629 c609719bSwdenk
630 c609719bSwdenk		U-Boot stores all clock information in Hz
631 c609719bSwdenk		internally. For binary compatibility with older Linux
632 c609719bSwdenk		kernels (which expect the clocks passed in the
633 c609719bSwdenk		bd_info data to be in MHz) the environment variable
634 c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
635 c609719bSwdenk		converts clock data to MHZ before passing it to the
636 c609719bSwdenk		Linux kernel.
637 c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
638 c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
639 c609719bSwdenk		default environment.
640 c609719bSwdenk
641 5da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
642 5da627a4Swdenk
643 11ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
644 5da627a4Swdenk		expect it to be in bytes, others in MB.
645 5da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
646 5da627a4Swdenk
647 fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
648 f57f70aaSWolfgang Denk
649 f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
650 213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
651 213bf8c8SGerald Van Baren		concepts).
652 213bf8c8SGerald Van Baren
653 213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
654 213bf8c8SGerald Van Baren		 * New libfdt-based support
655 213bf8c8SGerald Van Baren		 * Adds the "fdt" command
656 3bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
657 213bf8c8SGerald Van Baren
658 b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
659 b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
660 b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
661 b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
662 f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
663 c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
664 f57f70aaSWolfgang Denk
665 11ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
666 11ccc33fSMarcel Ziswiler		addresses
667 3bb342fcSKim Phillips
668 4e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
669 4e253137SKumar Gala
670 4e253137SKumar Gala		Board code has addition modification that it wants to make
671 4e253137SKumar Gala		to the flat device tree before handing it off to the kernel
672 6705d81eSwdenk
673 0267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
674 0267768eSMatthew McClintock
675 11ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
676 0267768eSMatthew McClintock		param header, the default value is zero if undefined.
677 0267768eSMatthew McClintock
678 3887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
679 3887c3fbSHeiko Schocher
680 3887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
681 3887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
682 3887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
683 3887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
684 3887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
685 3887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
686 3887c3fbSHeiko Schocher
687 7eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
688 7eb29398SIgor Grinberg
689 7eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
690 7eb29398SIgor Grinberg		machine type and must be used to specify the machine type
691 7eb29398SIgor Grinberg		number as it appears in the ARM machine registry
692 7eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
693 7eb29398SIgor Grinberg		Only boards that have multiple machine types supported
694 7eb29398SIgor Grinberg		in a single configuration file and the machine type is
695 7eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
696 7eb29398SIgor Grinberg
697 0b2f4ecaSNiklaus Giger- vxWorks boot parameters:
698 0b2f4ecaSNiklaus Giger
699 0b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
700 0b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
701 0b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
702 0b2f4ecaSNiklaus Giger
703 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
704 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
705 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
706 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
707 0b2f4ecaSNiklaus Giger
708 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
709 0b2f4ecaSNiklaus Giger
710 0b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
711 0b2f4ecaSNiklaus Giger
712 0b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
713 0b2f4ecaSNiklaus Giger		the defaults discussed just above.
714 0b2f4ecaSNiklaus Giger
715 2c451f78SAneesh V- Cache Configuration:
716 2c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
717 2c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
718 2c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
719 2c451f78SAneesh V
720 93bc2193SAneesh V- Cache Configuration for ARM:
721 93bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
722 93bc2193SAneesh V				      controller
723 93bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
724 93bc2193SAneesh V					controller register space
725 93bc2193SAneesh V
726 6705d81eSwdenk- Serial Ports:
727 48d0192fSAndreas Engel		CONFIG_PL010_SERIAL
728 6705d81eSwdenk
729 6705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
730 6705d81eSwdenk
731 48d0192fSAndreas Engel		CONFIG_PL011_SERIAL
732 6705d81eSwdenk
733 6705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
734 6705d81eSwdenk
735 6705d81eSwdenk		CONFIG_PL011_CLOCK
736 6705d81eSwdenk
737 6705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
738 6705d81eSwdenk		the clock speed of the UARTs.
739 6705d81eSwdenk
740 6705d81eSwdenk		CONFIG_PL01x_PORTS
741 6705d81eSwdenk
742 6705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
743 6705d81eSwdenk		define this to a list of base addresses for each (supported)
744 6705d81eSwdenk		port. See e.g. include/configs/versatile.h
745 6705d81eSwdenk
746 910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
747 910f1ae3SJohn Rigby
748 910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
749 910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
750 910f1ae3SJohn Rigby		this variable to initialize the extra register.
751 910f1ae3SJohn Rigby
752 910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
753 910f1ae3SJohn Rigby
754 910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
755 910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
756 910f1ae3SJohn Rigby		variable to flush the UART at init time.
757 910f1ae3SJohn Rigby
758 d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
759 d57dee57SKaricheri, Muralidharan
760 d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
761 d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
762 6705d81eSwdenk
763 c609719bSwdenk- Console Interface:
764 c609719bSwdenk		Depending on board, define exactly one serial port
765 c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
766 c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
767 c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
768 c609719bSwdenk
769 c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
770 c609719bSwdenk		port routines must be defined elsewhere
771 c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
772 c609719bSwdenk
773 c609719bSwdenk		CONFIG_CFB_CONSOLE
774 c609719bSwdenk		Enables console device for a color framebuffer. Needs following
775 c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
776 c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
777 c609719bSwdenk						(default big endian)
778 c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
779 c609719bSwdenk						rectangle fill
780 c609719bSwdenk						(cf. smiLynxEM)
781 c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
782 c609719bSwdenk						bit-blit (cf. smiLynxEM)
783 c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
784 c609719bSwdenk						(cols=pitch)
785 c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
786 c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
787 c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
788 c609719bSwdenk						(0-5, cf. cfb_console.c)
789 c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
790 c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
791 c609719bSwdenk						(i.e. i8042_kbd_init())
792 c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
793 c609719bSwdenk						(i.e. i8042_tstc)
794 c609719bSwdenk			VIDEO_GETC_FCT		get char fct
795 c609719bSwdenk						(i.e. i8042_getc)
796 c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
797 c609719bSwdenk						(requires blink timer
798 c609719bSwdenk						cf. i8042.c)
799 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
800 c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
801 c609719bSwdenk						upper right corner
802 602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
803 c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
804 c609719bSwdenk						upper left corner
805 a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
806 a6c7ad2fSwdenk						linux_logo.h for logo.
807 a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
808 c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
809 11ccc33fSMarcel Ziswiler						additional board info beside
810 c609719bSwdenk						the logo
811 c609719bSwdenk
812 33a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
813 33a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
814 33a35bbbSPali Rohár		erase functions and limited graphics rendition control).
815 33a35bbbSPali Rohár
816 c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
817 c609719bSwdenk		default i/o. Serial console can be forced with
818 c609719bSwdenk		environment 'console=serial'.
819 c609719bSwdenk
820 a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
821 a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
822 a3ad8e26Swdenk		the "silent" environment variable. See
823 a3ad8e26Swdenk		doc/README.silent for more information.
824 a3ad8e26Swdenk
825 45ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
826 45ae2546SHeiko Schocher			is 0x00.
827 45ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
828 45ae2546SHeiko Schocher			is 0xa0.
829 45ae2546SHeiko Schocher
830 c609719bSwdenk- Console Baudrate:
831 c609719bSwdenk		CONFIG_BAUDRATE - in bps
832 c609719bSwdenk		Select one of the baudrates listed in
833 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
834 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
835 c609719bSwdenk
836 c92fac91SHeiko Schocher- Console Rx buffer length
837 c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
838 c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
839 2b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
840 c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
841 c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
842 c92fac91SHeiko Schocher		the SMC.
843 c92fac91SHeiko Schocher
844 9558b48aSGraeme Russ- Pre-Console Buffer:
845 9558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
846 9558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
847 9558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
848 9558b48aSGraeme Russ		buffer any console messages prior to the console being
849 9558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
850 9558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
851 9558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
852 9558b48aSGraeme Russ		bytes are output before the console is initialised, the
853 9558b48aSGraeme Russ		earlier bytes are discarded.
854 9558b48aSGraeme Russ
855 9558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
856 9558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
857 9558b48aSGraeme Russ
858 046a37bdSSonny Rao- Safe printf() functions
859 046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
860 046a37bdSSonny Rao		the printf() functions. These are defined in
861 046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
862 046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
863 046a37bdSSonny Rao		If this option is not given then these functions will
864 046a37bdSSonny Rao		silently discard their buffer size argument - this means
865 046a37bdSSonny Rao		you are not getting any overflow checking in this case.
866 046a37bdSSonny Rao
867 c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
868 c609719bSwdenk		Delay before automatically booting the default image;
869 c609719bSwdenk		set to -1 to disable autoboot.
870 93d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
871 93d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
872 c609719bSwdenk
873 c609719bSwdenk		See doc/README.autoboot for these options that
874 c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
875 c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
876 c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
877 c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
878 c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
879 c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
880 c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
881 c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
882 c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
883 c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
884 c609719bSwdenk		CONFIG_RESET_TO_RETRY
885 c609719bSwdenk
886 c609719bSwdenk- Autoboot Command:
887 c609719bSwdenk		CONFIG_BOOTCOMMAND
888 c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
889 c609719bSwdenk		define a command string that is automatically executed
890 c609719bSwdenk		when no character is read on the console interface
891 c609719bSwdenk		within "Boot Delay" after reset.
892 c609719bSwdenk
893 c609719bSwdenk		CONFIG_BOOTARGS
894 c609719bSwdenk		This can be used to pass arguments to the bootm
895 c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
896 c609719bSwdenk		environment value "bootargs".
897 c609719bSwdenk
898 c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
899 c609719bSwdenk		The value of these goes into the environment as
900 c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
901 c609719bSwdenk		as a convenience, when switching between booting from
902 11ccc33fSMarcel Ziswiler		RAM and NFS.
903 c609719bSwdenk
904 eda0ba38SHeiko Schocher- Bootcount:
905 eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
906 eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
907 eda0ba38SHeiko Schocher		cycle, see:
908 eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
909 eda0ba38SHeiko Schocher
910 eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
911 eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
912 eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
913 eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
914 eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
915 eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
916 eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
917 eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
918 eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
919 eda0ba38SHeiko Schocher
920 c609719bSwdenk- Pre-Boot Commands:
921 c609719bSwdenk		CONFIG_PREBOOT
922 c609719bSwdenk
923 c609719bSwdenk		When this option is #defined, the existence of the
924 c609719bSwdenk		environment variable "preboot" will be checked
925 c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
926 c609719bSwdenk		countdown and/or running the auto-boot command resp.
927 c609719bSwdenk		entering interactive mode.
928 c609719bSwdenk
929 c609719bSwdenk		This feature is especially useful when "preboot" is
930 c609719bSwdenk		automatically generated or modified. For an example
931 c609719bSwdenk		see the LWMON board specific code: here "preboot" is
932 c609719bSwdenk		modified when the user holds down a certain
933 c609719bSwdenk		combination of keys on the (special) keyboard when
934 c609719bSwdenk		booting the systems
935 c609719bSwdenk
936 c609719bSwdenk- Serial Download Echo Mode:
937 c609719bSwdenk		CONFIG_LOADS_ECHO
938 c609719bSwdenk		If defined to 1, all characters received during a
939 c609719bSwdenk		serial download (using the "loads" command) are
940 c609719bSwdenk		echoed back. This might be needed by some terminal
941 c609719bSwdenk		emulations (like "cu"), but may as well just take
942 c609719bSwdenk		time on others. This setting #define's the initial
943 c609719bSwdenk		value of the "loads_echo" environment variable.
944 c609719bSwdenk
945 602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
946 c609719bSwdenk		CONFIG_KGDB_BAUDRATE
947 c609719bSwdenk		Select one of the baudrates listed in
948 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
949 c609719bSwdenk
950 c609719bSwdenk- Monitor Functions:
951 602ad3b3SJon Loeliger		Monitor commands can be included or excluded
952 602ad3b3SJon Loeliger		from the build by using the #include files
953 c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
954 c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
955 602ad3b3SJon Loeliger		and augmenting with additional #define's
956 602ad3b3SJon Loeliger		for wanted commands.
957 c609719bSwdenk
958 602ad3b3SJon Loeliger		The default command configuration includes all commands
959 602ad3b3SJon Loeliger		except those marked below with a "*".
960 602ad3b3SJon Loeliger
961 b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
962 602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
963 602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
964 602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
965 602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
966 602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
967 602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
968 d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
969 602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
970 08d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
971 602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
972 710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
973 602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
974 602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
975 602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
976 a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
977 a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
978 a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
979 a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
980 602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
981 602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
982 246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
983 602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
984 602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
985 5e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
986 fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
987 88733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
988 0c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
989 03e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
990 03e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
991 16f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
992 16f4d933SStephen Warren					  that work for multiple fs types
993 bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
994 602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
995 03e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
996 602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
997 602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
998 4d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
999 53fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1000 a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1001 a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1002 bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1003 602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1004 602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1005 602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1006 602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
1007 8fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
1008 4d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1009 602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1010 aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
1011 0c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1012 c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1013 602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1014 602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1015 602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1016 602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
1017 4d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1018 d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1019 d22c338eSJoe Hershberger					  (169.254.*.*)
1020 602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1021 602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
1022 4d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
1023 02c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
1024 15a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1025 602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1026 a2681707SWolfgang Denk					  loop, loopw
1027 4d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1028 602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1029 602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1030 602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
1031 68d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1032 602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1033 602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
1034 4d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1035 e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1036 e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1037 602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1038 602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1039 602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1040 602ad3b3SJon Loeliger					  host
1041 602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1042 ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1043 602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1044 602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1045 d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1046 602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1047 602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1048 602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1049 602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1050 602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1051 602ad3b3SJon Loeliger					  (4xx only)
1052 f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
1053 4d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
1054 02c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
1055 7d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
1056 74de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1057 602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
1058 7a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
1059 1fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1060 da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1061 da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1062 602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1063 602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1064 c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
1065 4d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
1066 89c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1067 c609719bSwdenk
1068 c609719bSwdenk		EXAMPLE: If you want all functions except of network
1069 c609719bSwdenk		support you can write:
1070 c609719bSwdenk
1071 602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1072 602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1073 c609719bSwdenk
1074 213bf8c8SGerald Van Baren	Other Commands:
1075 213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1076 c609719bSwdenk
1077 c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1078 602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1079 c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1080 c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1081 c609719bSwdenk		8260 (where accesses to the IMMR region must be
1082 c609719bSwdenk		uncached), and it cannot be disabled on all other
1083 c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1084 c609719bSwdenk		initial stack and some data.
1085 c609719bSwdenk
1086 c609719bSwdenk
1087 c609719bSwdenk		XXX - this list needs to get updated!
1088 c609719bSwdenk
1089 a5ecbe62SWolfgang Denk- Regular expression support:
1090 a5ecbe62SWolfgang Denk		CONFIG_REGEX
1091 a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1092 a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1093 a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1094 a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1095 a5ecbe62SWolfgang Denk
1096 45ba8077SSimon Glass- Device tree:
1097 45ba8077SSimon Glass		CONFIG_OF_CONTROL
1098 45ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
1099 45ba8077SSimon Glass		to configure its devices, instead of relying on statically
1100 45ba8077SSimon Glass		compiled #defines in the board file. This option is
1101 45ba8077SSimon Glass		experimental and only available on a few boards. The device
1102 45ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
1103 45ba8077SSimon Glass
1104 2c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
1105 2c0f79e4SSimon Glass		be done using one of the two options below:
1106 bbb0b128SSimon Glass
1107 bbb0b128SSimon Glass		CONFIG_OF_EMBED
1108 bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1109 bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1110 bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1111 bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1112 bbb0b128SSimon Glass		the global data structure as gd->blob.
1113 45ba8077SSimon Glass
1114 2c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
1115 2c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
1116 2c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
1117 2c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
1118 2c0f79e4SSimon Glass
1119 2c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
1120 2c0f79e4SSimon Glass
1121 2c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
1122 2c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
1123 2c0f79e4SSimon Glass		still use the individual files if you need something more
1124 2c0f79e4SSimon Glass		exotic.
1125 2c0f79e4SSimon Glass
1126 c609719bSwdenk- Watchdog:
1127 c609719bSwdenk		CONFIG_WATCHDOG
1128 c609719bSwdenk		If this variable is defined, it enables watchdog
1129 6abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
1130 6abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
1131 6abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
1132 6abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
1133 6abe6fb6SDetlev Zundel		available, then no further board specific code should
1134 6abe6fb6SDetlev Zundel		be needed to use it.
1135 6abe6fb6SDetlev Zundel
1136 6abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
1137 6abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
1138 6abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
1139 6abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1140 c609719bSwdenk
1141 c1551ea8Sstroese- U-Boot Version:
1142 c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1143 c1551ea8Sstroese		If this variable is defined, an environment variable
1144 c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1145 c1551ea8Sstroese		version as printed by the "version" command.
1146 a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1147 a1ea8e51SBenoît Thébaudeau		next reset.
1148 c1551ea8Sstroese
1149 c609719bSwdenk- Real-Time Clock:
1150 c609719bSwdenk
1151 602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1152 c609719bSwdenk		has to be selected, too. Define exactly one of the
1153 c609719bSwdenk		following options:
1154 c609719bSwdenk
1155 c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1156 c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
1157 4e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1158 c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
1159 1cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1160 c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
1161 7f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1162 412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
1163 3bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
1164 9536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
1165 4c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
1166 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
1167 71d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
1168 71d19f30SHeiko Schocher					  RV3029 RTC.
1169 c609719bSwdenk
1170 b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1171 b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1172 b37c7e5eSwdenk
1173 e92739d3SPeter Tyser- GPIO Support:
1174 e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1175 e92739d3SPeter Tyser
1176 5dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1177 5dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
1178 5dec49caSChris Packham		pins supported by a particular chip.
1179 5dec49caSChris Packham
1180 e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1181 e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1182 e92739d3SPeter Tyser
1183 aa53233aSSimon Glass- I/O tracing:
1184 aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1185 aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1186 aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1187 aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1188 aa53233aSSimon Glass		the driver behaves the same way before and after a code
1189 aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1190 aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1191 aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1192 aa53233aSSimon Glass
1193 aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1194 aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1195 aa53233aSSimon Glass		still continue to operate.
1196 aa53233aSSimon Glass
1197 aa53233aSSimon Glass			iotrace is enabled
1198 aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1199 aa53233aSSimon Glass			Size:   00010000	(buffer size)
1200 aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1201 aa53233aSSimon Glass			Output: 10000120	(start + offset)
1202 aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1203 aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1204 aa53233aSSimon Glass
1205 c609719bSwdenk- Timestamp Support:
1206 c609719bSwdenk
1207 c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1208 c609719bSwdenk		(date and time) of an image is printed by image
1209 c609719bSwdenk		commands like bootm or iminfo. This option is
1210 602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1211 c609719bSwdenk
1212 923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1213 923c46f9SKarl O. Pinc		Zero or more of the following:
1214 923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1215 923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1216 923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1217 923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1218 923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1219 923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1220 923c46f9SKarl O. Pinc				       disk/part_efi.c
1221 923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1222 c609719bSwdenk
1223 602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1224 218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1225 923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1226 c609719bSwdenk
1227 c609719bSwdenk- IDE Reset method:
1228 4d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
1229 4d13cbadSwdenk		board configurations files but used nowhere!
1230 c609719bSwdenk
1231 4d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
1232 4d13cbadSwdenk		be performed by calling the function
1233 4d13cbadSwdenk			ide_set_reset(int reset)
1234 4d13cbadSwdenk		which has to be defined in a board specific file
1235 c609719bSwdenk
1236 c609719bSwdenk- ATAPI Support:
1237 c609719bSwdenk		CONFIG_ATAPI
1238 c609719bSwdenk
1239 c609719bSwdenk		Set this to enable ATAPI support.
1240 c609719bSwdenk
1241 c40b2956Swdenk- LBA48 Support
1242 c40b2956Swdenk		CONFIG_LBA48
1243 c40b2956Swdenk
1244 c40b2956Swdenk		Set this to enable support for disks larger than 137GB
1245 4b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1246 c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1247 c40b2956Swdenk		support disks up to 2.1TB.
1248 c40b2956Swdenk
1249 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1250 c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1251 c40b2956Swdenk			Default is 32bit.
1252 c40b2956Swdenk
1253 c609719bSwdenk- SCSI Support:
1254 c609719bSwdenk		At the moment only there is only support for the
1255 c609719bSwdenk		SYM53C8XX SCSI controller; define
1256 c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1257 c609719bSwdenk
1258 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1259 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1260 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1261 c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1262 c609719bSwdenk		devices.
1263 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1264 c609719bSwdenk
1265 447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1266 447c031bSStefan Reinauer		SCSI devices found during the last scan.
1267 447c031bSStefan Reinauer
1268 c609719bSwdenk- NETWORK Support (PCI):
1269 682011ffSwdenk		CONFIG_E1000
1270 ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1271 ce5207e1SKyle Moffett
1272 ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1273 ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1274 ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1275 ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1276 ce5207e1SKyle Moffett
1277 ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1278 ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1279 ce5207e1SKyle Moffett		example with the "sspi" command.
1280 ce5207e1SKyle Moffett
1281 ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1282 ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1283 ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1284 682011ffSwdenk
1285 ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
1286 11ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1287 ac3315c2SAndre Schwarz
1288 c609719bSwdenk		CONFIG_EEPRO100
1289 c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
1290 11ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1291 c609719bSwdenk		write routine for first time initialisation.
1292 c609719bSwdenk
1293 c609719bSwdenk		CONFIG_TULIP
1294 c609719bSwdenk		Support for Digital 2114x chips.
1295 c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1296 c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1297 c609719bSwdenk
1298 c609719bSwdenk		CONFIG_NATSEMI
1299 c609719bSwdenk		Support for National dp83815 chips.
1300 c609719bSwdenk
1301 c609719bSwdenk		CONFIG_NS8382X
1302 c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1303 c609719bSwdenk
1304 45219c46Swdenk- NETWORK Support (other):
1305 45219c46Swdenk
1306 c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1307 c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1308 c041e9d2SJens Scharsig
1309 c041e9d2SJens Scharsig			CONFIG_RMII
1310 c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1311 c041e9d2SJens Scharsig
1312 c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1313 c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1314 c041e9d2SJens Scharsig			The driver doen't show link status messages.
1315 c041e9d2SJens Scharsig
1316 efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1317 efdd7319SRob Herring		Support for the Calxeda XGMAC device
1318 efdd7319SRob Herring
1319 3bb46d23SAshok		CONFIG_LAN91C96
1320 45219c46Swdenk		Support for SMSC's LAN91C96 chips.
1321 45219c46Swdenk
1322 45219c46Swdenk			CONFIG_LAN91C96_BASE
1323 45219c46Swdenk			Define this to hold the physical address
1324 45219c46Swdenk			of the LAN91C96's I/O space
1325 45219c46Swdenk
1326 45219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
1327 45219c46Swdenk			Define this to enable 32 bit addressing
1328 45219c46Swdenk
1329 3bb46d23SAshok		CONFIG_SMC91111
1330 f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1331 f39748aeSwdenk
1332 f39748aeSwdenk			CONFIG_SMC91111_BASE
1333 f39748aeSwdenk			Define this to hold the physical address
1334 f39748aeSwdenk			of the device (I/O space)
1335 f39748aeSwdenk
1336 f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1337 f39748aeSwdenk			Define this if data bus is 32 bits
1338 f39748aeSwdenk
1339 f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1340 f39748aeSwdenk			Define this to use i/o functions instead of macros
1341 f39748aeSwdenk			(some hardware wont work with macros)
1342 f39748aeSwdenk
1343 dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1344 dc02badaSHeiko Schocher		Support for davinci emac
1345 dc02badaSHeiko Schocher
1346 dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1347 dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1348 dc02badaSHeiko Schocher
1349 b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1350 b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1351 b3dbf4a5SMacpaul Lin
1352 b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1353 b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1354 b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1355 b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1356 b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1357 b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1358 b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1359 b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1360 b3dbf4a5SMacpaul Lin
1361 c2fff331SMike Rapoport		CONFIG_SMC911X
1362 557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1363 557b377dSJens Gehrlein
1364 c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1365 557b377dSJens Gehrlein			Define this to hold the physical address
1366 557b377dSJens Gehrlein			of the device (I/O space)
1367 557b377dSJens Gehrlein
1368 c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1369 557b377dSJens Gehrlein			Define this if data bus is 32 bits
1370 557b377dSJens Gehrlein
1371 c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1372 557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1373 557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1374 c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1375 557b377dSJens Gehrlein
1376 3d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
1377 3d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
1378 3d0075faSYoshihiro Shimoda
1379 3d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
1380 3d0075faSYoshihiro Shimoda			Define the number of ports to be used
1381 3d0075faSYoshihiro Shimoda
1382 3d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
1383 3d0075faSYoshihiro Shimoda			Define the ETH PHY's address
1384 3d0075faSYoshihiro Shimoda
1385 68260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
1386 68260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
1387 68260aabSYoshihiro Shimoda
1388 b2f97cf2SHeiko Schocher- PWM Support:
1389 b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1390 b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1391 b2f97cf2SHeiko Schocher
1392 5e124724SVadim Bendebury- TPM Support:
1393 90899cc0SChe-liang Chiou		CONFIG_TPM
1394 90899cc0SChe-liang Chiou		Support TPM devices.
1395 90899cc0SChe-liang Chiou
1396 1b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
1397 1b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
1398 1b393db5STom Wai-Hong Tam		per system is supported at this time.
1399 1b393db5STom Wai-Hong Tam
1400 1b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
1401 1b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
1402 1b393db5STom Wai-Hong Tam
1403 1b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1404 1b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
1405 1b393db5STom Wai-Hong Tam
1406 1b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1407 1b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
1408 1b393db5STom Wai-Hong Tam
1409 c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1410 c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1411 c01939c7SDirk Eibach
1412 90899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
1413 5e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
1414 5e124724SVadim Bendebury		per system is supported at this time.
1415 5e124724SVadim Bendebury
1416 5e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
1417 5e124724SVadim Bendebury			Base address where the generic TPM device is mapped
1418 5e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
1419 5e124724SVadim Bendebury			0xfed40000.
1420 5e124724SVadim Bendebury
1421 be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1422 be6c1529SReinhard Pfau		Add tpm monitor functions.
1423 be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1424 be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1425 be6c1529SReinhard Pfau
1426 be6c1529SReinhard Pfau		CONFIG_TPM
1427 be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1428 be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1429 be6c1529SReinhard Pfau		Requires support for a TPM device.
1430 be6c1529SReinhard Pfau
1431 be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1432 be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1433 be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1434 be6c1529SReinhard Pfau
1435 c609719bSwdenk- USB Support:
1436 c609719bSwdenk		At the moment only the UHCI host controller is
1437 4d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1438 c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1439 c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1440 30d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1441 c609719bSwdenk		storage devices.
1442 c609719bSwdenk		Note:
1443 c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1444 c609719bSwdenk		(TEAC FD-05PUB).
1445 4d13cbadSwdenk		MPC5200 USB requires additional defines:
1446 4d13cbadSwdenk			CONFIG_USB_CLOCK
1447 4d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1448 307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1449 307ecb6dSEric Millbrandt				for USB on PSC3
1450 4d13cbadSwdenk			CONFIG_USB_CONFIG
1451 4d13cbadSwdenk				for differential drivers: 0x00001000
1452 4d13cbadSwdenk				for single ended drivers: 0x00005000
1453 307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1454 307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
1455 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1456 fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1457 fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
1458 4d13cbadSwdenk
1459 9ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1460 9ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
1461 9ab4ce22SSimon Glass
1462 16c8d5e7SWolfgang Denk- USB Device:
1463 16c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
1464 16c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
1465 16c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
1466 11ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
1467 16c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
1468 16c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
1469 16c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
1470 16c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
1471 16c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
1472 16c8d5e7SWolfgang Denk		a Linux host by
1473 16c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
1474 16c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
1475 16c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
1476 16c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
1477 16c8d5e7SWolfgang Denk
1478 16c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
1479 16c8d5e7SWolfgang Denk			Define this to build a UDC device
1480 16c8d5e7SWolfgang Denk
1481 16c8d5e7SWolfgang Denk			CONFIG_USB_TTY
1482 16c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
1483 16c8d5e7SWolfgang Denk			talk to the UDC device
1484 16c8d5e7SWolfgang Denk
1485 f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1486 f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1487 f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1488 f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1489 f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1490 f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1491 f9da0f89SVipin KUMAR			speed.
1492 f9da0f89SVipin KUMAR
1493 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
1494 16c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
1495 16c8d5e7SWolfgang Denk			be set to usbtty.
1496 16c8d5e7SWolfgang Denk
1497 16c8d5e7SWolfgang Denk			mpc8xx:
1498 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1499 16c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
1500 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
1501 16c8d5e7SWolfgang Denk
1502 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
1503 16c8d5e7SWolfgang Denk				Derive USB clock from brgclk
1504 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
1505 16c8d5e7SWolfgang Denk
1506 16c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
1507 16c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
1508 16c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
1509 16c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1510 16c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1511 16c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
1512 16c8d5e7SWolfgang Denk
1513 16c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
1514 16c8d5e7SWolfgang Denk			Define this string as the name of your company for
1515 16c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
1516 16c8d5e7SWolfgang Denk
1517 16c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
1518 16c8d5e7SWolfgang Denk			Define this string as the name of your product
1519 16c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
1520 16c8d5e7SWolfgang Denk
1521 16c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
1522 16c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
1523 16c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
1524 16c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
1525 16c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
1526 16c8d5e7SWolfgang Denk
1527 16c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
1528 16c8d5e7SWolfgang Denk			Define this as the unique Product ID
1529 16c8d5e7SWolfgang Denk			for your device
1530 16c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1531 c609719bSwdenk
1532 d70a560fSIgor Grinberg- ULPI Layer Support:
1533 d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1534 d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1535 d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1536 d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1537 d70a560fSIgor Grinberg		viewport is supported.
1538 d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1539 d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1540 6d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
1541 6d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1542 6d365ea0SLucas Stach		the appropriate value in Hz.
1543 c609719bSwdenk
1544 c609719bSwdenk- MMC Support:
1545 c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1546 c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1547 c609719bSwdenk		accessed from the boot prompt by mapping the device
1548 c609719bSwdenk		to physical memory similar to flash. Command line is
1549 602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1550 602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1551 c609719bSwdenk
1552 afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1553 afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1554 afb35666SYoshihiro Shimoda
1555 afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1556 afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1557 afb35666SYoshihiro Shimoda
1558 afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1559 afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1560 afb35666SYoshihiro Shimoda
1561 1fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
1562 1fd93c6eSPierre Aubert		Enable the generic MMC driver
1563 1fd93c6eSPierre Aubert
1564 1fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
1565 1fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
1566 1fd93c6eSPierre Aubert
1567 1fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
1568 1fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
1569 1fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
1570 1fd93c6eSPierre Aubert
1571 b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1572 b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1573 b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1574 b3ba6e94STom Rini
1575 b3ba6e94STom Rini		CONFIG_CMD_DFU
1576 b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1577 b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1578 b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1579 b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1580 b3ba6e94STom Rini
1581 b3ba6e94STom Rini		CONFIG_DFU_MMC
1582 b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1583 b3ba6e94STom Rini
1584 c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1585 c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1586 c6631764SPantelis Antoniou
1587 a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1588 a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1589 a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1590 a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1591 a9479f04SAfzal Mohammed		one that would help mostly the developer.
1592 a9479f04SAfzal Mohammed
1593 e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1594 e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1595 e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1596 e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1597 e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1598 e7e75c70SHeiko Schocher
1599 ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1600 ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1601 ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1602 ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1603 ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1604 ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1605 ea2453d5SPantelis Antoniou
1606 001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1607 001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1608 001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1609 001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1610 001a8319SHeiko Schocher
1611 001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1612 001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1613 001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1614 001a8319SHeiko Schocher		sending again an USB request to the device.
1615 001a8319SHeiko Schocher
1616 3aab70afSSebastian Siewior- USB Device Android Fastboot support:
1617 3aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
1618 3aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
1619 3aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
1620 3aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
1621 3aab70afSSebastian Siewior		used on Android devices.
1622 3aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
1623 3aab70afSSebastian Siewior
1624 3aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
1625 3aab70afSSebastian Siewior		This enables support for booting images which use the Android
1626 3aab70afSSebastian Siewior		image format header.
1627 3aab70afSSebastian Siewior
1628 3aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
1629 3aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
1630 3aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
1631 3aab70afSSebastian Siewior		downloaded images.
1632 3aab70afSSebastian Siewior
1633 3aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
1634 3aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
1635 3aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
1636 3aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
1637 3aab70afSSebastian Siewior
1638 6705d81eSwdenk- Journaling Flash filesystem support:
1639 6705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1640 6705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
1641 6705d81eSwdenk		Define these for a default partition on a NAND device
1642 6705d81eSwdenk
1643 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
1644 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1645 6705d81eSwdenk		Define these for a default partition on a NOR device
1646 6705d81eSwdenk
1647 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
1648 6705d81eSwdenk		Define this to create an own partition. You have to provide a
1649 6705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
1650 6705d81eSwdenk
1651 6705d81eSwdenk		If you define only one JFFS2 partition you may also want to
1652 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
1653 6705d81eSwdenk		to disable the command chpart. This is the default when you
1654 6705d81eSwdenk		have not defined a custom partition
1655 6705d81eSwdenk
1656 c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1657 c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1658 656f4c65SDonggeun Kim
1659 656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1660 656f4c65SDonggeun Kim		file in FAT formatted partition.
1661 656f4c65SDonggeun Kim
1662 656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1663 656f4c65SDonggeun Kim		user to write files to FAT.
1664 c30a15e5SDonggeun Kim
1665 84cd9327SGabe BlackCBFS (Coreboot Filesystem) support
1666 84cd9327SGabe Black		CONFIG_CMD_CBFS
1667 84cd9327SGabe Black
1668 84cd9327SGabe Black		Define this to enable support for reading from a Coreboot
1669 84cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1670 84cd9327SGabe Black		and cbfsload.
1671 84cd9327SGabe Black
1672 4f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
1673 4f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
1674 4f0d1a2aSSiva Durga Prasad Paladugu
1675 4f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
1676 4f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
1677 4f0d1a2aSSiva Durga Prasad Paladugu
1678 c609719bSwdenk- Keyboard Support:
1679 c609719bSwdenk		CONFIG_ISA_KEYBOARD
1680 c609719bSwdenk
1681 c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1682 c609719bSwdenk		support
1683 c609719bSwdenk
1684 c609719bSwdenk		CONFIG_I8042_KBD
1685 c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1686 c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1687 c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1688 c609719bSwdenk		for cfb_console. Supports cursor blinking.
1689 c609719bSwdenk
1690 713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1691 713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1692 713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1693 713cb680SHung-ying Tyan		which provides key scans on request.
1694 713cb680SHung-ying Tyan
1695 c609719bSwdenk- Video support:
1696 c609719bSwdenk		CONFIG_VIDEO
1697 c609719bSwdenk
1698 c609719bSwdenk		Define this to enable video support (for output to
1699 c609719bSwdenk		video).
1700 c609719bSwdenk
1701 c609719bSwdenk		CONFIG_VIDEO_CT69000
1702 c609719bSwdenk
1703 c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1704 c609719bSwdenk
1705 c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1706 eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1707 eeb1b77bSwdenk		video output is selected via environment 'videoout'
1708 eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1709 eeb1b77bSwdenk		assumed.
1710 c609719bSwdenk
1711 eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
1712 11ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1713 eeb1b77bSwdenk		are possible:
1714 eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1715 eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1716 eeb1b77bSwdenk
1717 eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1718 eeb1b77bSwdenk		-------------+---------------------------------------------
1719 eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1720 eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1721 eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1722 eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1723 eeb1b77bSwdenk		-------------+---------------------------------------------
1724 c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1725 c609719bSwdenk
1726 eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
1727 7817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1728 eeb1b77bSwdenk
1729 eeb1b77bSwdenk
1730 a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1731 a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1732 a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1733 a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1734 a6c7ad2fSwdenk
1735 7d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
1736 7d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
1737 7d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
1738 7d3053fbSTimur Tabi		support, and should also define these other macros:
1739 7d3053fbSTimur Tabi
1740 7d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
1741 7d3053fbSTimur Tabi			CONFIG_VIDEO
1742 7d3053fbSTimur Tabi			CONFIG_CMD_BMP
1743 7d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
1744 7d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
1745 7d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
1746 7d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
1747 7d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
1748 7d3053fbSTimur Tabi
1749 ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1750 ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1751 ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1752 ba8e76bdSTimur Tabi		description of this variable.
1753 7d3053fbSTimur Tabi
1754 058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1755 058d59b0SSimon Glass
1756 058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1757 058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1758 058d59b0SSimon Glass		driver.
1759 058d59b0SSimon Glass
1760 058d59b0SSimon Glass
1761 682011ffSwdenk- Keyboard Support:
1762 682011ffSwdenk		CONFIG_KEYBOARD
1763 682011ffSwdenk
1764 682011ffSwdenk		Define this to enable a custom keyboard support.
1765 682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1766 682011ffSwdenk		defined in your board-specific files.
1767 682011ffSwdenk		The only board using this so far is RBC823.
1768 a6c7ad2fSwdenk
1769 c609719bSwdenk- LCD Support:	CONFIG_LCD
1770 c609719bSwdenk
1771 c609719bSwdenk		Define this to enable LCD support (for output to LCD
1772 c609719bSwdenk		display); also select one of the supported displays
1773 c609719bSwdenk		by defining one of these:
1774 c609719bSwdenk
1775 39cf4804SStelian Pop		CONFIG_ATMEL_LCD:
1776 39cf4804SStelian Pop
1777 39cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
1778 39cf4804SStelian Pop
1779 fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1780 c609719bSwdenk
1781 fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1782 c609719bSwdenk
1783 fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1784 c609719bSwdenk
1785 fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1786 fd3103bbSwdenk			Active, color, single scan.
1787 fd3103bbSwdenk
1788 fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1789 fd3103bbSwdenk
1790 fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1791 c609719bSwdenk			Active, color, single scan.
1792 c609719bSwdenk
1793 c609719bSwdenk		CONFIG_SHARP_16x9
1794 c609719bSwdenk
1795 c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1796 c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1797 c609719bSwdenk
1798 c609719bSwdenk		CONFIG_SHARP_LQ64D341
1799 c609719bSwdenk
1800 c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1801 c609719bSwdenk			Active, color, single scan.
1802 c609719bSwdenk
1803 c609719bSwdenk		CONFIG_HLD1045
1804 c609719bSwdenk
1805 c609719bSwdenk			HLD1045 display, 640x480.
1806 c609719bSwdenk			Active, color, single scan.
1807 c609719bSwdenk
1808 c609719bSwdenk		CONFIG_OPTREX_BW
1809 c609719bSwdenk
1810 c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1811 c609719bSwdenk			or
1812 c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1813 c609719bSwdenk			or
1814 c609719bSwdenk			Hitachi	 SP14Q002
1815 c609719bSwdenk
1816 c609719bSwdenk			320x240. Black & white.
1817 c609719bSwdenk
1818 c609719bSwdenk		Normally display is black on white background; define
1819 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1820 c609719bSwdenk
1821 676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1822 676d319eSSimon Glass
1823 676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1824 676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1825 676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1826 676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1827 676d319eSSimon Glass		a per-section basis.
1828 676d319eSSimon Glass
1829 0d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
1830 0d89efefSSimon Glass
1831 0d89efefSSimon Glass		When the console need to be scrolled, this is the number of
1832 0d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
1833 0d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
1834 0d89efefSSimon Glass		is slow.
1835 676d319eSSimon Glass
1836 45d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
1837 45d7f525STom Wai-Hong Tam
1838 45d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
1839 45d7f525STom Wai-Hong Tam
1840 735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1841 735987c5STom Wai-Hong Tam
1842 735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1843 735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1844 735987c5STom Wai-Hong Tam
1845 7152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1846 d791b1dcSwdenk
1847 d791b1dcSwdenk		If this option is set, the environment is checked for
1848 d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1849 d791b1dcSwdenk		of logo, copyright and system information on the LCD
1850 e94d2cd9Swdenk		is suppressed and the BMP image at the address
1851 d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1852 d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1853 d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1854 d791b1dcSwdenk		loaded very quickly after power-on.
1855 d791b1dcSwdenk
1856 c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1857 c0880485SNikita Kiryanov
1858 c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1859 c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1860 1551df35STom Rini		(see README.displaying-bmps).
1861 c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1862 c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1863 c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1864 c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1865 c0880485SNikita Kiryanov		there is no need to set this option.
1866 c0880485SNikita Kiryanov
1867 1ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
1868 1ca298ceSMatthias Weisser
1869 1ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
1870 1ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
1871 1ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
1872 1ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
1873 1ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
1874 1ca298ceSMatthias Weisser		specify 'm' for centering the image.
1875 1ca298ceSMatthias Weisser
1876 1ca298ceSMatthias Weisser		Example:
1877 1ca298ceSMatthias Weisser		setenv splashpos m,m
1878 1ca298ceSMatthias Weisser			=> image at center of screen
1879 1ca298ceSMatthias Weisser
1880 1ca298ceSMatthias Weisser		setenv splashpos 30,20
1881 1ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
1882 1ca298ceSMatthias Weisser
1883 1ca298ceSMatthias Weisser		setenv splashpos -10,m
1884 1ca298ceSMatthias Weisser			=> vertically centered image
1885 1ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
1886 1ca298ceSMatthias Weisser
1887 98f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1888 98f4a3dfSStefan Roese
1889 98f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
1890 98f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
1891 98f4a3dfSStefan Roese		splashscreen support or the bmp command.
1892 98f4a3dfSStefan Roese
1893 d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1894 d5011762SAnatolij Gustschin
1895 d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1896 d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1897 d5011762SAnatolij Gustschin		bmp command.
1898 d5011762SAnatolij Gustschin
1899 f2b96dfbSLei Wen- Do compresssing for memory range:
1900 f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1901 f2b96dfbSLei Wen
1902 f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1903 f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1904 f2b96dfbSLei Wen
1905 c29fdfc1Swdenk- Compression support:
1906 8ef70478SKees Cook		CONFIG_GZIP
1907 8ef70478SKees Cook
1908 8ef70478SKees Cook		Enabled by default to support gzip compressed images.
1909 8ef70478SKees Cook
1910 c29fdfc1Swdenk		CONFIG_BZIP2
1911 c29fdfc1Swdenk
1912 c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1913 c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1914 c29fdfc1Swdenk		compressed images are supported.
1915 c29fdfc1Swdenk
1916 c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1917 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1918 c29fdfc1Swdenk		be at least 4MB.
1919 d791b1dcSwdenk
1920 fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1921 fc9c1727SLuigi 'Comio' Mantellini
1922 fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1923 fc9c1727SLuigi 'Comio' Mantellini		images is included.
1924 fc9c1727SLuigi 'Comio' Mantellini
1925 fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1926 fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1927 fc9c1727SLuigi 'Comio' Mantellini		formula:
1928 fc9c1727SLuigi 'Comio' Mantellini
1929 fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1930 fc9c1727SLuigi 'Comio' Mantellini
1931 fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1932 fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1933 fc9c1727SLuigi 'Comio' Mantellini
1934 fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1935 fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1936 fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1937 fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1938 fc9c1727SLuigi 'Comio' Mantellini
1939 fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1940 fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
1941 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1942 fc9c1727SLuigi 'Comio' Mantellini
1943 8ef70478SKees Cook		CONFIG_LZO
1944 8ef70478SKees Cook
1945 8ef70478SKees Cook		If this option is set, support for LZO compressed images
1946 8ef70478SKees Cook		is included.
1947 8ef70478SKees Cook
1948 17ea1177Swdenk- MII/PHY support:
1949 17ea1177Swdenk		CONFIG_PHY_ADDR
1950 17ea1177Swdenk
1951 17ea1177Swdenk		The address of PHY on MII bus.
1952 17ea1177Swdenk
1953 17ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1954 17ea1177Swdenk
1955 17ea1177Swdenk		The clock frequency of the MII bus
1956 17ea1177Swdenk
1957 17ea1177Swdenk		CONFIG_PHY_GIGE
1958 17ea1177Swdenk
1959 17ea1177Swdenk		If this option is set, support for speed/duplex
1960 11ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
1961 17ea1177Swdenk
1962 17ea1177Swdenk		CONFIG_PHY_RESET_DELAY
1963 17ea1177Swdenk
1964 17ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
1965 17ea1177Swdenk		reset before any MII register access is possible.
1966 17ea1177Swdenk		For such PHY, set this option to the usec delay
1967 17ea1177Swdenk		required. (minimum 300usec for LXT971A)
1968 17ea1177Swdenk
1969 17ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
1970 17ea1177Swdenk
1971 17ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
1972 17ea1177Swdenk		command issued before MII status register can be read
1973 17ea1177Swdenk
1974 c609719bSwdenk- Ethernet address:
1975 c609719bSwdenk		CONFIG_ETHADDR
1976 c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1977 c609719bSwdenk		CONFIG_ETH2ADDR
1978 c609719bSwdenk		CONFIG_ETH3ADDR
1979 c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1980 c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1981 c609719bSwdenk
1982 11ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
1983 11ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1984 c609719bSwdenk		is not determined automatically.
1985 c609719bSwdenk
1986 c609719bSwdenk- IP address:
1987 c609719bSwdenk		CONFIG_IPADDR
1988 c609719bSwdenk
1989 c609719bSwdenk		Define a default value for the IP address to use for
1990 11ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1991 c609719bSwdenk		determined through e.g. bootp.
1992 1ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1993 c609719bSwdenk
1994 c609719bSwdenk- Server IP address:
1995 c609719bSwdenk		CONFIG_SERVERIP
1996 c609719bSwdenk
1997 c609719bSwdenk		Defines a default value for the IP address of a TFTP
1998 c609719bSwdenk		server to contact when using the "tftboot" command.
1999 1ebcd654SWolfgang Denk		(Environment variable "serverip")
2000 c609719bSwdenk
2001 97cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
2002 97cfe861SRobin Getz
2003 97cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
2004 97cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
2005 97cfe861SRobin Getz
2006 1ebcd654SWolfgang Denk- Gateway IP address:
2007 1ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
2008 1ebcd654SWolfgang Denk
2009 1ebcd654SWolfgang Denk		Defines a default value for the IP address of the
2010 1ebcd654SWolfgang Denk		default router where packets to other networks are
2011 1ebcd654SWolfgang Denk		sent to.
2012 1ebcd654SWolfgang Denk		(Environment variable "gatewayip")
2013 1ebcd654SWolfgang Denk
2014 1ebcd654SWolfgang Denk- Subnet mask:
2015 1ebcd654SWolfgang Denk		CONFIG_NETMASK
2016 1ebcd654SWolfgang Denk
2017 1ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
2018 1ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
2019 1ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
2020 1ebcd654SWolfgang Denk		forwarded through a router.
2021 1ebcd654SWolfgang Denk		(Environment variable "netmask")
2022 1ebcd654SWolfgang Denk
2023 53a5c424SDavid Updegraff- Multicast TFTP Mode:
2024 53a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
2025 53a5c424SDavid Updegraff
2026 53a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
2027 53a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
2028 11ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
2029 53a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
2030 53a5c424SDavid Updegraff		multicast group.
2031 53a5c424SDavid Updegraff
2032 c609719bSwdenk- BOOTP Recovery Mode:
2033 c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2034 c609719bSwdenk
2035 c609719bSwdenk		If you have many targets in a network that try to
2036 c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2037 c609719bSwdenk		systems send out BOOTP requests at precisely the same
2038 c609719bSwdenk		moment (which would happen for instance at recovery
2039 c609719bSwdenk		from a power failure, when all systems will try to
2040 c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2041 c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2042 c609719bSwdenk		inserted before sending out BOOTP requests. The
2043 6c33c785SWolfgang Denk		following delays are inserted then:
2044 c609719bSwdenk
2045 c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2046 c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2047 c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2048 c609719bSwdenk		4th and following
2049 c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2050 c609719bSwdenk
2051 92ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
2052 92ac8accSThierry Reding
2053 92ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
2054 92ac8accSThierry Reding		server will copy the ID from client requests to responses and
2055 92ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
2056 92ac8accSThierry Reding		an incoming response. Some servers will check that addresses
2057 92ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
2058 92ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
2059 92ac8accSThierry Reding		respond. Network congestion may also influence the time it
2060 92ac8accSThierry Reding		takes for a response to make it back to the client. If that
2061 92ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
2062 92ac8accSThierry Reding		to allow earlier responses to still be accepted after these
2063 92ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
2064 92ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2065 92ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
2066 92ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
2067 92ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
2068 92ac8accSThierry Reding
2069 fe389a82Sstroese- DHCP Advanced Options:
2070 1fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
2071 1fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2072 fe389a82Sstroese
2073 1fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
2074 1fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
2075 1fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
2076 1fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
2077 1fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
2078 1fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
2079 1fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
2080 1fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
2081 1fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
2082 1fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
2083 1fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
2084 1fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
2085 2c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2086 fe389a82Sstroese
2087 5d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2088 5d110f0aSWilson Callan		environment variable, not the BOOTP server.
2089 fe389a82Sstroese
2090 2c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2091 2c00e099SJoe Hershberger		after the configured retry count, the call will fail
2092 2c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
2093 2c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
2094 2c00e099SJoe Hershberger		is not available.
2095 2c00e099SJoe Hershberger
2096 fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2097 fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2098 fe389a82Sstroese		than one DNS serverip is offered to the client.
2099 fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2100 fe389a82Sstroese		serverip will be stored in the additional environment
2101 fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2102 fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
2103 1fe80d79SJon Loeliger		is defined.
2104 fe389a82Sstroese
2105 fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2106 fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2107 fe389a82Sstroese		need the hostname of the DHCP requester.
2108 5d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
2109 1fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
2110 1fe80d79SJon Loeliger		option 12 to the DHCP server.
2111 fe389a82Sstroese
2112 d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2113 d9a2f416SAras Vaichas
2114 d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2115 d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2116 d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2117 d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2118 d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2119 d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2120 d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2121 d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2122 d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2123 d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2124 d9a2f416SAras Vaichas		this delay.
2125 d9a2f416SAras Vaichas
2126 d22c338eSJoe Hershberger - Link-local IP address negotiation:
2127 d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2128 d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2129 d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2130 d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2131 d22c338eSJoe Hershberger
2132 d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2133 d22c338eSJoe Hershberger
2134 a3d991bdSwdenk - CDP Options:
2135 a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2136 a3d991bdSwdenk
2137 a3d991bdSwdenk		The device id used in CDP trigger frames.
2138 a3d991bdSwdenk
2139 a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2140 a3d991bdSwdenk
2141 a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2142 a3d991bdSwdenk		of the device.
2143 a3d991bdSwdenk
2144 a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2145 a3d991bdSwdenk
2146 a3d991bdSwdenk		A printf format string which contains the ascii name of
2147 a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
2148 11ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2149 a3d991bdSwdenk
2150 a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2151 a3d991bdSwdenk
2152 a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2153 a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2154 a3d991bdSwdenk
2155 a3d991bdSwdenk		CONFIG_CDP_VERSION
2156 a3d991bdSwdenk
2157 a3d991bdSwdenk		An ascii string containing the version of the software.
2158 a3d991bdSwdenk
2159 a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2160 a3d991bdSwdenk
2161 a3d991bdSwdenk		An ascii string containing the name of the platform.
2162 a3d991bdSwdenk
2163 a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2164 a3d991bdSwdenk
2165 a3d991bdSwdenk		A 32bit integer sent on the trigger.
2166 a3d991bdSwdenk
2167 a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2168 a3d991bdSwdenk
2169 a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2170 a3d991bdSwdenk		device in .1 of milliwatts.
2171 a3d991bdSwdenk
2172 a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2173 a3d991bdSwdenk
2174 a3d991bdSwdenk		A byte containing the id of the VLAN.
2175 a3d991bdSwdenk
2176 c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2177 c609719bSwdenk
2178 c609719bSwdenk		Several configurations allow to display the current
2179 c609719bSwdenk		status using a LED. For instance, the LED will blink
2180 c609719bSwdenk		fast while running U-Boot code, stop blinking as
2181 c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2182 c609719bSwdenk		start blinking slow once the Linux kernel is running
2183 c609719bSwdenk		(supported by a status LED driver in the Linux
2184 c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2185 c609719bSwdenk		feature in U-Boot.
2186 c609719bSwdenk
2187 1df7bbbaSIgor Grinberg		Additional options:
2188 1df7bbbaSIgor Grinberg
2189 1df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
2190 1df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
2191 1df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
2192 1df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
2193 1df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
2194 1df7bbbaSIgor Grinberg
2195 9dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
2196 9dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
2197 9dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
2198 9dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
2199 9dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2200 9dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
2201 9dfdcdfeSIgor Grinberg
2202 c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2203 c609719bSwdenk
2204 c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2205 c609719bSwdenk		on those systems that support this (optional)
2206 c609719bSwdenk		feature, like the TQM8xxL modules.
2207 c609719bSwdenk
2208 3f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2209 c609719bSwdenk
2210 3f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
2211 3f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
2212 3f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2213 3f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
2214 3f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
2215 3f4978c7SHeiko Schocher		interface.
2216 3f4978c7SHeiko Schocher
2217 3f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2218 ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2219 ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2220 ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2221 ea818dbbSHeiko Schocher		    for defining speed and slave address
2222 ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2223 ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2224 ea818dbbSHeiko Schocher		    for defining speed and slave address
2225 ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2226 ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2227 ea818dbbSHeiko Schocher		    for defining speed and slave address
2228 ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2229 ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2230 ea818dbbSHeiko Schocher		    for defining speed and slave address
2231 3f4978c7SHeiko Schocher
2232 00f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
2233 00f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
2234 00f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2235 00f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2236 00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2237 00f792e0SHeiko Schocher		    bus.
2238 00f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
2239 00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2240 00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2241 00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2242 00f792e0SHeiko Schocher		    second bus.
2243 00f792e0SHeiko Schocher
2244 1f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
2245 1f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
2246 1f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
2247 1f2ba722SSimon Glass		    100000 and the slave addr 0!
2248 1f2ba722SSimon Glass
2249 880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2250 880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2251 880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2252 880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2253 880540deSDirk Eibach
2254 fac96408Strem		- drivers/i2c/i2c_mxc.c
2255 fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2256 fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2257 fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2258 fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2259 fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2260 fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2261 fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2262 fac96408Strem		If thoses defines are not set, default value is 100000
2263 fac96408Strem		for speed, and 0 for slave.
2264 fac96408Strem
2265 1086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
2266 1086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
2267 1086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
2268 1086bfa9SNobuhiro Iwamatsu
2269 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2270 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2271 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2272 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2273 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2274 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2275 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2276 1086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2277 1086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2278 1086bfa9SNobuhiro Iwamatsu
2279 2035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
2280 2035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
2281 2035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
2282 2035d77dSNobuhiro Iwamatsu
2283 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2284 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2285 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2286 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2287 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2288 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2289 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2290 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2291 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2292 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2293 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2294 2035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2295 2035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2296 2035d77dSNobuhiro Iwamatsu
2297 6789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
2298 6789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2299 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2300 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2301 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2302 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2303 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2304 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2305 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2306 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2307 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2308 6789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2309 6789e84eSHeiko Schocher
2310 0bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
2311 0bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
2312 0bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2313 0bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2314 0bdffe71SHeiko Schocher
2315 e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2316 e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2317 e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2318 e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2319 e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2320 e717fc6dSNaveen Krishna Ch
2321 b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2322 b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2323 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2324 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2325 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2326 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2327 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2328 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2329 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2330 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2331 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2332 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2333 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2334 b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2335 b46226bdSDirk Eibach
2336 3f4978c7SHeiko Schocher		additional defines:
2337 3f4978c7SHeiko Schocher
2338 3f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2339 3f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
2340 3f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
2341 3f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2342 3f4978c7SHeiko Schocher		omit this define.
2343 3f4978c7SHeiko Schocher
2344 3f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
2345 3f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
2346 3f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2347 3f4978c7SHeiko Schocher		omit this define.
2348 3f4978c7SHeiko Schocher
2349 3f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
2350 3f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
2351 3f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
2352 3f4978c7SHeiko Schocher		define.
2353 3f4978c7SHeiko Schocher
2354 3f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2355 3f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
2356 3f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2357 3f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2358 3f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
2359 3f4978c7SHeiko Schocher
2360 3f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
2361 3f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2362 3f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2363 3f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2364 3f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2365 3f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2366 3f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
2367 3f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2368 3f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2369 3f4978c7SHeiko Schocher					}
2370 3f4978c7SHeiko Schocher
2371 3f4978c7SHeiko Schocher		which defines
2372 3f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2373 ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2374 ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2375 ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2376 ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2377 ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2378 3f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2379 ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2380 ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2381 3f4978c7SHeiko Schocher
2382 3f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
2383 3f4978c7SHeiko Schocher
2384 ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
2385 3f4978c7SHeiko Schocher
2386 3f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2387 3f4978c7SHeiko Schocher		provides the following compelling advantages:
2388 3f4978c7SHeiko Schocher
2389 3f4978c7SHeiko Schocher		- more than one i2c adapter is usable
2390 3f4978c7SHeiko Schocher		- approved multibus support
2391 3f4978c7SHeiko Schocher		- better i2c mux support
2392 3f4978c7SHeiko Schocher
2393 3f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
2394 3f4978c7SHeiko Schocher
2395 ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2396 ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2397 ea818dbbSHeiko Schocher		for the selected CPU.
2398 c609719bSwdenk
2399 b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2400 602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2401 b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2402 b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2403 c609719bSwdenk		command line interface.
2404 c609719bSwdenk
2405 bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2406 c609719bSwdenk
2407 b37c7e5eSwdenk		There are several other quantities that must also be
2408 ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2409 c609719bSwdenk
2410 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2411 b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
2412 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2413 11ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2414 c609719bSwdenk
2415 8d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2416 a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2417 8d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
2418 8d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
2419 8d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2420 b37c7e5eSwdenk
2421 5da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
2422 5da71efaSEric Millbrandt
2423 5da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
2424 5da71efaSEric Millbrandt		chips might think that the current transfer is still
2425 5da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
2426 5da71efaSEric Millbrandt		commands until the slave device responds.
2427 5da71efaSEric Millbrandt
2428 b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2429 b37c7e5eSwdenk
2430 ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2431 b37c7e5eSwdenk		then the following macros need to be defined (examples are
2432 b37c7e5eSwdenk		from include/configs/lwmon.h):
2433 c609719bSwdenk
2434 c609719bSwdenk		I2C_INIT
2435 c609719bSwdenk
2436 b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2437 c609719bSwdenk		controller or configure ports.
2438 c609719bSwdenk
2439 b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2440 b37c7e5eSwdenk
2441 c609719bSwdenk		I2C_PORT
2442 c609719bSwdenk
2443 c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2444 c609719bSwdenk		assumes both bits are on the same port). Valid values
2445 c609719bSwdenk		are 0..3 for ports A..D.
2446 c609719bSwdenk
2447 c609719bSwdenk		I2C_ACTIVE
2448 c609719bSwdenk
2449 c609719bSwdenk		The code necessary to make the I2C data line active
2450 c609719bSwdenk		(driven).  If the data line is open collector, this
2451 c609719bSwdenk		define can be null.
2452 c609719bSwdenk
2453 b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2454 b37c7e5eSwdenk
2455 c609719bSwdenk		I2C_TRISTATE
2456 c609719bSwdenk
2457 c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2458 c609719bSwdenk		(inactive).  If the data line is open collector, this
2459 c609719bSwdenk		define can be null.
2460 c609719bSwdenk
2461 b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2462 b37c7e5eSwdenk
2463 c609719bSwdenk		I2C_READ
2464 c609719bSwdenk
2465 472d5460SYork Sun		Code that returns true if the I2C data line is high,
2466 472d5460SYork Sun		false if it is low.
2467 c609719bSwdenk
2468 b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2469 b37c7e5eSwdenk
2470 c609719bSwdenk		I2C_SDA(bit)
2471 c609719bSwdenk
2472 472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2473 472d5460SYork Sun		is false, it clears it (low).
2474 c609719bSwdenk
2475 b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2476 b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2477 b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2478 b37c7e5eSwdenk
2479 c609719bSwdenk		I2C_SCL(bit)
2480 c609719bSwdenk
2481 472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2482 472d5460SYork Sun		is false, it clears it (low).
2483 c609719bSwdenk
2484 b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2485 b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2486 b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2487 b37c7e5eSwdenk
2488 c609719bSwdenk		I2C_DELAY
2489 c609719bSwdenk
2490 c609719bSwdenk		This delay is invoked four times per clock cycle so this
2491 c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2492 b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2493 b37c7e5eSwdenk		like:
2494 b37c7e5eSwdenk
2495 b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2496 c609719bSwdenk
2497 793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2498 793b5726SMike Frysinger
2499 793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2500 793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2501 793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2502 793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2503 793b5726SMike Frysinger
2504 793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2505 793b5726SMike Frysinger		the generic GPIO functions.
2506 793b5726SMike Frysinger
2507 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
2508 47cd00faSwdenk
2509 47cd00faSwdenk		When a board is reset during an i2c bus transfer
2510 47cd00faSwdenk		chips might think that the current transfer is still
2511 47cd00faSwdenk		in progress. On some boards it is possible to access
2512 47cd00faSwdenk		the i2c SCLK line directly, either by using the
2513 47cd00faSwdenk		processor pin as a GPIO or by having a second pin
2514 47cd00faSwdenk		connected to the bus. If this option is defined a
2515 47cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
2516 47cd00faSwdenk		is run early in the boot sequence.
2517 47cd00faSwdenk
2518 26a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
2519 26a33504SRichard Retanubun
2520 26a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2521 26a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
2522 26a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
2523 26a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
2524 26a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
2525 26a33504SRichard Retanubun		controller provide such a method. It is called at the end of
2526 26a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
2527 26a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
2528 26a33504SRichard Retanubun
2529 17ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2530 17ea1177Swdenk
2531 17ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
2532 17ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
2533 17ea1177Swdenk		variable "i2cfast". (see also i2cfast)
2534 17ea1177Swdenk
2535 bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2536 bb99ad6dSBen Warren
2537 bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2538 bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2539 bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2540 bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2541 bb99ad6dSBen Warren
2542 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2543 bb99ad6dSBen Warren
2544 bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
2545 0f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
2546 0f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
2547 0f89c54bSPeter Tyser		a 1D array of device addresses
2548 bb99ad6dSBen Warren
2549 bb99ad6dSBen Warren		e.g.
2550 bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
2551 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2552 bb99ad6dSBen Warren
2553 bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2554 bb99ad6dSBen Warren
2555 bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2556 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2557 bb99ad6dSBen Warren
2558 bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2559 bb99ad6dSBen Warren
2560 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2561 be5e6181STimur Tabi
2562 be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2563 be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2564 be5e6181STimur Tabi
2565 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
2566 0dc018ecSStefan Roese
2567 0dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
2568 0dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2569 0dc018ecSStefan Roese
2570 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
2571 0dc018ecSStefan Roese
2572 0dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
2573 0dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2574 0dc018ecSStefan Roese
2575 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
2576 9ebbb54fSVictor Gallardo
2577 9ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
2578 9ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
2579 9ebbb54fSVictor Gallardo		specified DTT device.
2580 9ebbb54fSVictor Gallardo
2581 2ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
2582 2ac6985aSAndrew Dyer
2583 2ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
2584 2ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
2585 2ac6985aSAndrew Dyer		between writing the address pointer and reading the
2586 2ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
2587 2ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
2588 2ac6985aSAndrew Dyer		devices can use either method, but some require one or
2589 2ac6985aSAndrew Dyer		the other.
2590 be5e6181STimur Tabi
2591 c609719bSwdenk- SPI Support:	CONFIG_SPI
2592 c609719bSwdenk
2593 c609719bSwdenk		Enables SPI driver (so far only tested with
2594 c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2595 c609719bSwdenk		D/As on the SACSng board)
2596 c609719bSwdenk
2597 6639562eSYoshihiro Shimoda		CONFIG_SH_SPI
2598 6639562eSYoshihiro Shimoda
2599 6639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
2600 6639562eSYoshihiro Shimoda		only SH7757 is supported.
2601 6639562eSYoshihiro Shimoda
2602 c609719bSwdenk		CONFIG_SPI_X
2603 c609719bSwdenk
2604 c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2605 c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2606 c609719bSwdenk
2607 c609719bSwdenk		CONFIG_SOFT_SPI
2608 c609719bSwdenk
2609 c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2610 c609719bSwdenk		using hardware support. This is a general purpose
2611 c609719bSwdenk		driver that only requires three general I/O port pins
2612 c609719bSwdenk		(two outputs, one input) to function. If this is
2613 c609719bSwdenk		defined, the board configuration must define several
2614 c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2615 c609719bSwdenk		an example, see include/configs/sacsng.h.
2616 c609719bSwdenk
2617 04a9e118SBen Warren		CONFIG_HARD_SPI
2618 04a9e118SBen Warren
2619 04a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
2620 04a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
2621 04a9e118SBen Warren		must define a list of chip-select function pointers.
2622 04a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
2623 04a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
2624 04a9e118SBen Warren
2625 38254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
2626 38254f45SGuennadi Liakhovetski
2627 38254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
2628 2e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
2629 38254f45SGuennadi Liakhovetski
2630 f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2631 f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2632 f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2633 f659b573SHeiko Schocher
2634 0133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
2635 0133502eSMatthias Fuchs
2636 0133502eSMatthias Fuchs		Enables FPGA subsystem.
2637 0133502eSMatthias Fuchs
2638 0133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
2639 0133502eSMatthias Fuchs
2640 0133502eSMatthias Fuchs		Enables support for specific chip vendors.
2641 0133502eSMatthias Fuchs		(ALTERA, XILINX)
2642 0133502eSMatthias Fuchs
2643 0133502eSMatthias Fuchs		CONFIG_FPGA_<family>
2644 0133502eSMatthias Fuchs
2645 0133502eSMatthias Fuchs		Enables support for FPGA family.
2646 0133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2647 0133502eSMatthias Fuchs
2648 0133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2649 c609719bSwdenk
2650 c609719bSwdenk		Specify the number of FPGA devices to support.
2651 c609719bSwdenk
2652 64e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
2653 64e809afSSiva Durga Prasad Paladugu
2654 64e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
2655 64e809afSSiva Durga Prasad Paladugu
2656 67193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
2657 67193864SMichal Simek
2658 67193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
2659 67193864SMichal Simek
2660 67193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
2661 67193864SMichal Simek
2662 67193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
2663 67193864SMichal Simek		(Xilinx only)
2664 67193864SMichal Simek
2665 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2666 c609719bSwdenk
2667 c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2668 c609719bSwdenk
2669 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2670 c609719bSwdenk
2671 c609719bSwdenk		Enable checks on FPGA configuration interface busy
2672 c609719bSwdenk		status by the configuration function. This option
2673 c609719bSwdenk		will require a board or device specific function to
2674 c609719bSwdenk		be written.
2675 c609719bSwdenk
2676 c609719bSwdenk		CONFIG_FPGA_DELAY
2677 c609719bSwdenk
2678 c609719bSwdenk		If defined, a function that provides delays in the FPGA
2679 c609719bSwdenk		configuration driver.
2680 c609719bSwdenk
2681 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2682 c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2683 c609719bSwdenk
2684 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2685 c609719bSwdenk
2686 c609719bSwdenk		Check for configuration errors during FPGA bitfile
2687 c609719bSwdenk		loading. For example, abort during Virtex II
2688 c609719bSwdenk		configuration if the INIT_B line goes low (which
2689 c609719bSwdenk		indicated a CRC error).
2690 c609719bSwdenk
2691 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2692 c609719bSwdenk
2693 c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2694 c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2695 c609719bSwdenk		FPGA configuration sequence. The default time is 500
2696 11ccc33fSMarcel Ziswiler		ms.
2697 c609719bSwdenk
2698 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2699 c609719bSwdenk
2700 c609719bSwdenk		Maximum time to wait for BUSY to deassert during
2701 11ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2702 c609719bSwdenk
2703 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2704 c609719bSwdenk
2705 c609719bSwdenk		Time to wait after FPGA configuration. The default is
2706 11ccc33fSMarcel Ziswiler		200 ms.
2707 c609719bSwdenk
2708 c609719bSwdenk- Configuration Management:
2709 c609719bSwdenk		CONFIG_IDENT_STRING
2710 c609719bSwdenk
2711 c609719bSwdenk		If defined, this string will be added to the U-Boot
2712 c609719bSwdenk		version information (U_BOOT_VERSION)
2713 c609719bSwdenk
2714 c609719bSwdenk- Vendor Parameter Protection:
2715 c609719bSwdenk
2716 c609719bSwdenk		U-Boot considers the values of the environment
2717 c609719bSwdenk		variables "serial#" (Board Serial Number) and
2718 7152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2719 c609719bSwdenk		are set once by the board vendor / manufacturer, and
2720 c609719bSwdenk		protects these variables from casual modification by
2721 c609719bSwdenk		the user. Once set, these variables are read-only,
2722 c609719bSwdenk		and write or delete attempts are rejected. You can
2723 11ccc33fSMarcel Ziswiler		change this behaviour:
2724 c609719bSwdenk
2725 c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2726 c609719bSwdenk		file, the write protection for vendor parameters is
2727 47cd00faSwdenk		completely disabled. Anybody can change or delete
2728 c609719bSwdenk		these parameters.
2729 c609719bSwdenk
2730 c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2731 c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2732 11ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2733 c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2734 c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2735 c609719bSwdenk		read-only.]
2736 c609719bSwdenk
2737 2598090bSJoe Hershberger		The same can be accomplished in a more flexible way
2738 2598090bSJoe Hershberger		for any variable by configuring the type of access
2739 2598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
2740 2598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
2741 2598090bSJoe Hershberger
2742 c609719bSwdenk- Protected RAM:
2743 c609719bSwdenk		CONFIG_PRAM
2744 c609719bSwdenk
2745 c609719bSwdenk		Define this variable to enable the reservation of
2746 c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2747 c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2748 c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2749 c609719bSwdenk		this default value by defining an environment
2750 c609719bSwdenk		variable "pram" to the number of kB you want to
2751 c609719bSwdenk		reserve. Note that the board info structure will
2752 c609719bSwdenk		still show the full amount of RAM. If pRAM is
2753 c609719bSwdenk		reserved, a new environment variable "mem" will
2754 c609719bSwdenk		automatically be defined to hold the amount of
2755 c609719bSwdenk		remaining RAM in a form that can be passed as boot
2756 c609719bSwdenk		argument to Linux, for instance like that:
2757 c609719bSwdenk
2758 fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2759 c609719bSwdenk			saveenv
2760 c609719bSwdenk
2761 c609719bSwdenk		This way you can tell Linux not to use this memory,
2762 c609719bSwdenk		either, which results in a memory region that will
2763 c609719bSwdenk		not be affected by reboots.
2764 c609719bSwdenk
2765 c609719bSwdenk		*WARNING* If your board configuration uses automatic
2766 c609719bSwdenk		detection of the RAM size, you must make sure that
2767 c609719bSwdenk		this memory test is non-destructive. So far, the
2768 c609719bSwdenk		following board configurations are known to be
2769 c609719bSwdenk		"pRAM-clean":
2770 c609719bSwdenk
2771 1b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
2772 1b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2773 544d97e9SWolfgang Denk			FLAGADM, TQM8260
2774 c609719bSwdenk
2775 40fef049SGabe Black- Access to physical memory region (> 4GB)
2776 40fef049SGabe Black		Some basic support is provided for operations on memory not
2777 40fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
2778 40fef049SGabe Black		support access to more than 4GB of memory on 32-bit
2779 40fef049SGabe Black		machines using physical address extension or similar.
2780 40fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
2781 40fef049SGabe Black		currently only supports clearing the memory.
2782 40fef049SGabe Black
2783 c609719bSwdenk- Error Recovery:
2784 c609719bSwdenk		CONFIG_PANIC_HANG
2785 c609719bSwdenk
2786 c609719bSwdenk		Define this variable to stop the system in case of a
2787 c609719bSwdenk		fatal error, so that you have to reset it manually.
2788 c609719bSwdenk		This is probably NOT a good idea for an embedded
2789 11ccc33fSMarcel Ziswiler		system where you want the system to reboot
2790 c609719bSwdenk		automatically as fast as possible, but it may be
2791 c609719bSwdenk		useful during development since you can try to debug
2792 c609719bSwdenk		the conditions that lead to the situation.
2793 c609719bSwdenk
2794 c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2795 c609719bSwdenk
2796 c609719bSwdenk		This variable defines the number of retries for
2797 c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2798 c609719bSwdenk		before giving up the operation. If not defined, a
2799 c609719bSwdenk		default value of 5 is used.
2800 c609719bSwdenk
2801 40cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
2802 40cb90eeSGuennadi Liakhovetski
2803 40cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
2804 40cb90eeSGuennadi Liakhovetski
2805 48a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
2806 48a3e999STetsuyuki Kobayashi
2807 48a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
2808 48a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
2809 48a3e999STetsuyuki Kobayashi		try longer timeout such as
2810 48a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
2811 48a3e999STetsuyuki Kobayashi
2812 c609719bSwdenk- Command Interpreter:
2813 8078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
2814 04a85b3bSwdenk
2815 04a85b3bSwdenk		Enable auto completion of commands using TAB.
2816 04a85b3bSwdenk
2817 8078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
2818 8078f1a5SWolfgang Denk		for the "hush" shell.
2819 8078f1a5SWolfgang Denk
2820 8078f1a5SWolfgang Denk
2821 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2822 c609719bSwdenk
2823 c609719bSwdenk		Define this variable to enable the "hush" shell (from
2824 c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2825 c609719bSwdenk		powerful command line syntax like
2826 c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2827 c609719bSwdenk		constructs ("shell scripts").
2828 c609719bSwdenk
2829 c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2830 c609719bSwdenk		with a somewhat smaller memory footprint.
2831 c609719bSwdenk
2832 c609719bSwdenk
2833 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2834 c609719bSwdenk
2835 c609719bSwdenk		This defines the secondary prompt string, which is
2836 c609719bSwdenk		printed when the command interpreter needs more input
2837 c609719bSwdenk		to complete a command. Usually "> ".
2838 c609719bSwdenk
2839 c609719bSwdenk	Note:
2840 c609719bSwdenk
2841 c609719bSwdenk		In the current implementation, the local variables
2842 c609719bSwdenk		space and global environment variables space are
2843 c609719bSwdenk		separated. Local variables are those you define by
2844 3b57fe0aSwdenk		simply typing `name=value'. To access a local
2845 c609719bSwdenk		variable later on, you have write `$name' or
2846 3b57fe0aSwdenk		`${name}'; to execute the contents of a variable
2847 3b57fe0aSwdenk		directly type `$name' at the command prompt.
2848 c609719bSwdenk
2849 c609719bSwdenk		Global environment variables are those you use
2850 c609719bSwdenk		setenv/printenv to work with. To run a command stored
2851 c609719bSwdenk		in such a variable, you need to use the run command,
2852 c609719bSwdenk		and you must not use the '$' sign to access them.
2853 c609719bSwdenk
2854 c609719bSwdenk		To store commands and special characters in a
2855 c609719bSwdenk		variable, please use double quotation marks
2856 c609719bSwdenk		surrounding the whole text of the variable, instead
2857 c609719bSwdenk		of the backslashes before semicolons and special
2858 c609719bSwdenk		symbols.
2859 c609719bSwdenk
2860 aa0c71acSWolfgang Denk- Commandline Editing and History:
2861 aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2862 aa0c71acSWolfgang Denk
2863 11ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2864 aa0c71acSWolfgang Denk		commandline input operations
2865 aa0c71acSWolfgang Denk
2866 a8c7c708Swdenk- Default Environment:
2867 c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2868 c609719bSwdenk
2869 c609719bSwdenk		Define this to contain any number of null terminated
2870 c609719bSwdenk		strings (variable = value pairs) that will be part of
2871 7152b1d0Swdenk		the default environment compiled into the boot image.
2872 2262cfeeSwdenk
2873 c609719bSwdenk		For example, place something like this in your
2874 c609719bSwdenk		board's config file:
2875 c609719bSwdenk
2876 c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2877 c609719bSwdenk			"myvar1=value1\0" \
2878 c609719bSwdenk			"myvar2=value2\0"
2879 c609719bSwdenk
2880 c609719bSwdenk		Warning: This method is based on knowledge about the
2881 c609719bSwdenk		internal format how the environment is stored by the
2882 2262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2883 c609719bSwdenk		interface! Although it is unlikely that this format
2884 7152b1d0Swdenk		will change soon, there is no guarantee either.
2885 c609719bSwdenk		You better know what you are doing here.
2886 c609719bSwdenk
2887 c609719bSwdenk		Note: overly (ab)use of the default environment is
2888 c609719bSwdenk		discouraged. Make sure to check other ways to preset
2889 74de7aefSWolfgang Denk		the environment like the "source" command or the
2890 c609719bSwdenk		boot command first.
2891 c609719bSwdenk
2892 5e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
2893 5e724ca2SStephen Warren
2894 5e724ca2SStephen Warren		Define this in order to add variables describing the
2895 5e724ca2SStephen Warren		U-Boot build configuration to the default environment.
2896 5e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
2897 5e724ca2SStephen Warren
2898 5e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
2899 5e724ca2SStephen Warren
2900 5e724ca2SStephen Warren		- CONFIG_SYS_ARCH
2901 5e724ca2SStephen Warren		- CONFIG_SYS_CPU
2902 5e724ca2SStephen Warren		- CONFIG_SYS_BOARD
2903 5e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
2904 5e724ca2SStephen Warren		- CONFIG_SYS_SOC
2905 5e724ca2SStephen Warren
2906 7e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2907 7e27f89fSTom Rini
2908 7e27f89fSTom Rini		Define this in order to add variables describing certain
2909 7e27f89fSTom Rini		run-time determined information about the hardware to the
2910 7e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
2911 7e27f89fSTom Rini
2912 06fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
2913 06fd8538SSimon Glass
2914 06fd8538SSimon Glass		Normally the environment is loaded when the board is
2915 06fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
2916 06fd8538SSimon Glass		that so that the environment is not available until
2917 06fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2918 06fd8538SSimon Glass		this is instead controlled by the value of
2919 06fd8538SSimon Glass		/config/load-environment.
2920 06fd8538SSimon Glass
2921 a8c7c708Swdenk- DataFlash Support:
2922 2abbe075Swdenk		CONFIG_HAS_DATAFLASH
2923 2abbe075Swdenk
2924 2abbe075Swdenk		Defining this option enables DataFlash features and
2925 2abbe075Swdenk		allows to read/write in Dataflash via the standard
2926 2abbe075Swdenk		commands cp, md...
2927 2abbe075Swdenk
2928 f61ec45eSEric Nelson- Serial Flash support
2929 f61ec45eSEric Nelson		CONFIG_CMD_SF
2930 f61ec45eSEric Nelson
2931 f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2932 f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2933 f61ec45eSEric Nelson
2934 f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2935 f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2936 f61ec45eSEric Nelson		commands.
2937 f61ec45eSEric Nelson
2938 f61ec45eSEric Nelson		The following defaults may be provided by the platform
2939 f61ec45eSEric Nelson		to handle the common case when only a single serial
2940 f61ec45eSEric Nelson		flash is present on the system.
2941 f61ec45eSEric Nelson
2942 f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2943 f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2944 f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2945 f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2946 f61ec45eSEric Nelson
2947 24007273SSimon Glass		CONFIG_CMD_SF_TEST
2948 24007273SSimon Glass
2949 24007273SSimon Glass		Define this option to include a destructive SPI flash
2950 24007273SSimon Glass		test ('sf test').
2951 24007273SSimon Glass
2952 1dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
2953 1dcd6d03SJagannadha Sutradharudu Teki
2954 1dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
2955 1dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
2956 1dcd6d03SJagannadha Sutradharudu Teki
2957 b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2958 b902e07cSJagannadha Sutradharudu Teki
2959 b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2960 b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2961 b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2962 b902e07cSJagannadha Sutradharudu Teki
2963 562f8df1SHeiko Schocher		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2964 562f8df1SHeiko Schocher		enable the W#/Vpp signal to disable writing to the status
2965 562f8df1SHeiko Schocher		register on ST MICRON flashes like the N25Q128.
2966 562f8df1SHeiko Schocher		The status register write enable/disable bit, combined with
2967 562f8df1SHeiko Schocher		the W#/VPP signal provides hardware data protection for the
2968 562f8df1SHeiko Schocher		device as follows: When the enable/disable bit is set to 1,
2969 562f8df1SHeiko Schocher		and the W#/VPP signal is driven LOW, the status register
2970 562f8df1SHeiko Schocher		nonvolatile bits become read-only and the WRITE STATUS REGISTER
2971 562f8df1SHeiko Schocher		operation will not execute. The only way to exit this
2972 562f8df1SHeiko Schocher		hardware-protected mode is to drive W#/VPP HIGH.
2973 562f8df1SHeiko Schocher
2974 3f85ce27Swdenk- SystemACE Support:
2975 3f85ce27Swdenk		CONFIG_SYSTEMACE
2976 3f85ce27Swdenk
2977 3f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
2978 3f85ce27Swdenk		chips attached via some sort of local bus. The address
2979 11ccc33fSMarcel Ziswiler		of the chip must also be defined in the
2980 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2981 3f85ce27Swdenk
2982 3f85ce27Swdenk		#define CONFIG_SYSTEMACE
2983 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2984 3f85ce27Swdenk
2985 3f85ce27Swdenk		When SystemACE support is added, the "ace" device type
2986 3f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
2987 3f85ce27Swdenk
2988 ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2989 ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2990 ecb0ccd9SWolfgang Denk
2991 28cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2992 ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
2993 28cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2994 ecb0ccd9SWolfgang Denk		number generator is used.
2995 ecb0ccd9SWolfgang Denk
2996 28cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
2997 28cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
2998 28cb9375SWolfgang Denk		defined, the normal port 69 is used.
2999 28cb9375SWolfgang Denk
3000 28cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3001 ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3002 ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3003 ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3004 ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3005 ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3006 ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3007 ecb0ccd9SWolfgang Denk
3008 bf36c5d5SSimon Glass- Hashing support:
3009 bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3010 bf36c5d5SSimon Glass
3011 bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3012 bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3013 bf36c5d5SSimon Glass
3014 bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3015 bf36c5d5SSimon Glass
3016 bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3017 bf36c5d5SSimon Glass		size a little.
3018 bf36c5d5SSimon Glass
3019 bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
3020 bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
3021 bf36c5d5SSimon Glass
3022 bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3023 bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3024 bf36c5d5SSimon Glass
3025 a11f1873SRobert Winkler- Freescale i.MX specific commands:
3026 a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3027 a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3028 a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3029 a11f1873SRobert Winkler
3030 a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3031 a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3032 a11f1873SRobert Winkler		a boot from specific media.
3033 a11f1873SRobert Winkler
3034 a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3035 a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3036 a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3037 a11f1873SRobert Winkler		will set it back to normal.  This command currently
3038 a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3039 a11f1873SRobert Winkler
3040 19c402afSSimon Glass- Signing support:
3041 19c402afSSimon Glass		CONFIG_RSA
3042 19c402afSSimon Glass
3043 19c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
3044 8bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
3045 19c402afSSimon Glass
3046 19c402afSSimon Glass		The signing part is build into mkimage regardless of this
3047 19c402afSSimon Glass		option.
3048 19c402afSSimon Glass
3049 9e50c406SHeiko Schocher- bootcount support:
3050 9e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
3051 9e50c406SHeiko Schocher
3052 9e50c406SHeiko Schocher		This enables the bootcounter support, see:
3053 9e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
3054 9e50c406SHeiko Schocher
3055 9e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
3056 9e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
3057 9e50c406SHeiko Schocher		CONFIG_BLACKFIN
3058 9e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
3059 9e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
3060 9e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
3061 9e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
3062 9e50c406SHeiko Schocher		enable support for the bootcounter in RAM
3063 9e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
3064 9e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
3065 9e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3066 9e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3067 9e50c406SHeiko Schocher						    the bootcounter.
3068 9e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
3069 19c402afSSimon Glass
3070 a8c7c708Swdenk- Show boot progress:
3071 c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3072 c609719bSwdenk
3073 c609719bSwdenk		Defining this option allows to add some board-
3074 c609719bSwdenk		specific code (calling a user-provided function
3075 c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3076 c609719bSwdenk		the system's boot progress on some display (for
3077 c609719bSwdenk		example, some LED's) on your board. At the moment,
3078 c609719bSwdenk		the following checkpoints are implemented:
3079 c609719bSwdenk
3080 3a608ca0SSimon Glass- Detailed boot stage timing
3081 3a608ca0SSimon Glass		CONFIG_BOOTSTAGE
3082 3a608ca0SSimon Glass		Define this option to get detailed timing of each stage
3083 3a608ca0SSimon Glass		of the boot process.
3084 3a608ca0SSimon Glass
3085 3a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
3086 3a608ca0SSimon Glass		This is the number of available user bootstage records.
3087 3a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3088 3a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
3089 3a608ca0SSimon Glass		the limit, recording will stop.
3090 3a608ca0SSimon Glass
3091 3a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
3092 3a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
3093 3a608ca0SSimon Glass
3094 3a608ca0SSimon Glass		Timer summary in microseconds:
3095 3a608ca0SSimon Glass		       Mark    Elapsed  Stage
3096 3a608ca0SSimon Glass			  0          0  reset
3097 3a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
3098 3a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
3099 3a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
3100 3a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
3101 3a608ca0SSimon Glass		  3,910,375    250,777  main_loop
3102 3a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
3103 3a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
3104 3a608ca0SSimon Glass
3105 2eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
3106 2eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
3107 2eba38cfSSimon Glass		and un/stashing of bootstage data.
3108 2eba38cfSSimon Glass
3109 94fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
3110 94fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
3111 94fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
3112 94fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
3113 94fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
3114 94fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
3115 94fd1316SSimon Glass		For example:
3116 94fd1316SSimon Glass
3117 94fd1316SSimon Glass		bootstage {
3118 94fd1316SSimon Glass			154 {
3119 94fd1316SSimon Glass				name = "board_init_f";
3120 94fd1316SSimon Glass				mark = <3575678>;
3121 94fd1316SSimon Glass			};
3122 94fd1316SSimon Glass			170 {
3123 94fd1316SSimon Glass				name = "lcd";
3124 94fd1316SSimon Glass				accum = <33482>;
3125 94fd1316SSimon Glass			};
3126 94fd1316SSimon Glass		};
3127 94fd1316SSimon Glass
3128 94fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
3129 94fd1316SSimon Glass
3130 1372cce2SMarian BalakowiczLegacy uImage format:
3131 1372cce2SMarian Balakowicz
3132 c609719bSwdenk  Arg	Where			When
3133 c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3134 c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3135 c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3136 c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3137 c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3138 c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3139 c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3140 c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3141 c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
3142 1372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3143 c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3144 c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3145 c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3146 c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
3147 1372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3148 c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
3149 1372cce2SMarian Balakowicz
3150 1372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
3151 1372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
3152 1372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
3153 1372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
3154 1372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
3155 1372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
3156 1372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
3157 11ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
3158 1372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
3159 1372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
3160 1372cce2SMarian Balakowicz
3161 ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3162 c609719bSwdenk
3163 a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
3164 63e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
3165 63e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
3166 63e73c9aSwdenk
3167 566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3168 566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3169 566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3170 566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3171 566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3172 566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3173 566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3174 566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3175 566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3176 566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3177 566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3178 566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3179 566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3180 566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3181 566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3182 566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3183 566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3184 566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3185 566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3186 566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3187 566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3188 566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3189 566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3190 566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3191 566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3192 566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3193 566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3194 566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3195 566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3196 566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3197 566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3198 566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3199 566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3200 566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3201 566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3202 566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3203 566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3204 566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3205 566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3206 566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3207 566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3208 566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3209 566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3210 566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3211 566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3212 566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3213 566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3214 c609719bSwdenk
3215 566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3216 c609719bSwdenk
3217 566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3218 566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3219 566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3220 206c60cbSwdenk
3221 566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3222 566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
3223 11ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3224 566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3225 566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3226 566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
3227 74de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
3228 74de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3229 566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3230 c609719bSwdenk
3231 1372cce2SMarian BalakowiczFIT uImage format:
3232 1372cce2SMarian Balakowicz
3233 1372cce2SMarian Balakowicz  Arg	Where			When
3234 1372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
3235 1372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
3236 1372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
3237 1372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
3238 1372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
3239 1372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3240 f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
3241 1372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
3242 1372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
3243 1372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
3244 1372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
3245 1372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
3246 11ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
3247 11ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
3248 1372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
3249 1372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
3250 1372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
3251 1372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
3252 1372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
3253 1372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
3254 1372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
3255 1372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
3256 1372cce2SMarian Balakowicz
3257 1372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
3258 1372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
3259 1372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
3260 11ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
3261 1372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
3262 1372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
3263 1372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
3264 1372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
3265 1372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
3266 1372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
3267 1372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
3268 1372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
3269 1372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
3270 1372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
3271 1372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
3272 1372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
3273 1372cce2SMarian Balakowicz
3274 11ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
3275 1372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
3276 1372cce2SMarian Balakowicz
3277 11ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
3278 1372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
3279 1372cce2SMarian Balakowicz
3280 11ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
3281 1372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
3282 1372cce2SMarian Balakowicz
3283 21d29f7fSHeiko Schocher- legacy image format:
3284 21d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
3285 21d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
3286 21d29f7fSHeiko Schocher
3287 21d29f7fSHeiko Schocher		Default:
3288 21d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
3289 21d29f7fSHeiko Schocher
3290 21d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
3291 21d29f7fSHeiko Schocher		disable the legacy image format
3292 21d29f7fSHeiko Schocher
3293 21d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
3294 21d29f7fSHeiko Schocher		enabled per default for backward compatibility.
3295 21d29f7fSHeiko Schocher
3296 d95f6ec7SGabe Black- FIT image support:
3297 d95f6ec7SGabe Black		CONFIG_FIT
3298 d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3299 d95f6ec7SGabe Black
3300 d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3301 d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3302 d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3303 d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3304 d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3305 d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3306 d95f6ec7SGabe Black
3307 3e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
3308 3e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
3309 3e569a6bSSimon Glass		using a hash signed and verified using RSA. See
3310 3e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
3311 3e569a6bSSimon Glass
3312 21d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
3313 21d29f7fSHeiko Schocher		signature check the legacy image format is default
3314 21d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
3315 21d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
3316 21d29f7fSHeiko Schocher
3317 9a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
3318 9a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
3319 9a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
3320 9a4f479bSDirk Eibach		with this option.
3321 9a4f479bSDirk Eibach
3322 4cf2609bSWolfgang Denk- Standalone program support:
3323 4cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
3324 4cf2609bSWolfgang Denk
3325 6feff899SWolfgang Denk		This option defines a board specific value for the
3326 6feff899SWolfgang Denk		address where standalone program gets loaded, thus
3327 6feff899SWolfgang Denk		overwriting the architecture dependent default
3328 4cf2609bSWolfgang Denk		settings.
3329 4cf2609bSWolfgang Denk
3330 4cf2609bSWolfgang Denk- Frame Buffer Address:
3331 4cf2609bSWolfgang Denk		CONFIG_FB_ADDR
3332 4cf2609bSWolfgang Denk
3333 4cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
3334 44a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
3335 44a53b57SWolfgang Denk		when using a graphics controller has separate video
3336 44a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
3337 44a53b57SWolfgang Denk		the given address instead of dynamically reserving it
3338 44a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
3339 44a53b57SWolfgang Denk		the memory for the frame buffer depending on the
3340 44a53b57SWolfgang Denk		configured panel size.
3341 4cf2609bSWolfgang Denk
3342 4cf2609bSWolfgang Denk		Please see board_init_f function.
3343 4cf2609bSWolfgang Denk
3344 cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3345 cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3346 cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3347 cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3348 cccfc2abSDetlev Zundel
3349 cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3350 cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3351 cccfc2abSDetlev Zundel
3352 cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3353 cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3354 cccfc2abSDetlev Zundel
3355 cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3356 cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3357 cccfc2abSDetlev Zundel
3358 cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3359 cccfc2abSDetlev Zundel
3360 cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3361 cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3362 cccfc2abSDetlev Zundel
3363 ff94bc40SHeiko Schocher		CONFIG_MTD_NAND_VERIFY_WRITE
3364 ff94bc40SHeiko Schocher		verify if the written data is correct reread.
3365 ff94bc40SHeiko Schocher
3366 70c219cdSJoe Hershberger- UBI support
3367 70c219cdSJoe Hershberger		CONFIG_CMD_UBI
3368 70c219cdSJoe Hershberger
3369 70c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
3370 70c219cdSJoe Hershberger		with the UBI flash translation layer
3371 70c219cdSJoe Hershberger
3372 70c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
3373 70c219cdSJoe Hershberger
3374 147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3375 147162daSJoe Hershberger
3376 147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3377 147162daSJoe Hershberger		warnings and errors enabled.
3378 147162daSJoe Hershberger
3379 ff94bc40SHeiko Schocher
3380 ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3381 ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3382 ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3383 ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3384 ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3385 ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3386 ff94bc40SHeiko Schocher
3387 ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3388 ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3389 ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3390 ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3391 ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3392 ff94bc40SHeiko Schocher
3393 ff94bc40SHeiko Schocher		default: 4096
3394 ff94bc40SHeiko Schocher
3395 ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3396 ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3397 ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3398 ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3399 ff94bc40SHeiko Schocher		flash), this value is ignored.
3400 ff94bc40SHeiko Schocher
3401 ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3402 ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3403 ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3404 ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3405 ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3406 ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3407 ff94bc40SHeiko Schocher
3408 ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3409 ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3410 ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3411 ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3412 ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3413 ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3414 ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3415 ff94bc40SHeiko Schocher		partition.
3416 ff94bc40SHeiko Schocher
3417 ff94bc40SHeiko Schocher		default: 20
3418 ff94bc40SHeiko Schocher
3419 ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3420 ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3421 ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3422 ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3423 ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3424 ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3425 ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3426 ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3427 ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3428 ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3429 ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3430 ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3431 ff94bc40SHeiko Schocher
3432 ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3433 ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3434 ff94bc40SHeiko Schocher		without a fastmap.
3435 ff94bc40SHeiko Schocher		default: 0
3436 ff94bc40SHeiko Schocher
3437 70c219cdSJoe Hershberger- UBIFS support
3438 70c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
3439 70c219cdSJoe Hershberger
3440 70c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
3441 70c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
3442 70c219cdSJoe Hershberger
3443 70c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
3444 70c219cdSJoe Hershberger
3445 147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3446 147162daSJoe Hershberger
3447 147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3448 147162daSJoe Hershberger		warnings and errors enabled.
3449 147162daSJoe Hershberger
3450 6a11cf48SDaniel Schwierzeck- SPL framework
3451 6a11cf48SDaniel Schwierzeck		CONFIG_SPL
3452 6a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
3453 6a11cf48SDaniel Schwierzeck
3454 95579793STom Rini		CONFIG_SPL_LDSCRIPT
3455 95579793STom Rini		LDSCRIPT for linking the SPL binary.
3456 95579793STom Rini
3457 6ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
3458 6ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
3459 6ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
3460 6ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
3461 8960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3462 6ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
3463 6ebc3461SAlbert ARIBAUD
3464 95579793STom Rini		CONFIG_SPL_MAX_SIZE
3465 6ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
3466 6ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
3467 6ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
3468 6ebc3461SAlbert ARIBAUD		not exceed it.
3469 95579793STom Rini
3470 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
3471 6a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
3472 6a11cf48SDaniel Schwierzeck
3473 94a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
3474 94a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
3475 94a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3476 94a45bb1SScott Wood
3477 95579793STom Rini		CONFIG_SPL_BSS_START_ADDR
3478 95579793STom Rini		Link address for the BSS within the SPL binary.
3479 95579793STom Rini
3480 95579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
3481 6ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
3482 6ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
3483 6ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
3484 8960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3485 6ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
3486 95579793STom Rini
3487 95579793STom Rini		CONFIG_SPL_STACK
3488 95579793STom Rini		Adress of the start of the stack SPL will use
3489 95579793STom Rini
3490 94a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
3491 94a45bb1SScott Wood		Adress of the start of the stack SPL will use after
3492 94a45bb1SScott Wood		relocation.  If unspecified, this is equal to
3493 94a45bb1SScott Wood		CONFIG_SPL_STACK.
3494 94a45bb1SScott Wood
3495 95579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
3496 95579793STom Rini		Starting address of the malloc pool used in SPL.
3497 95579793STom Rini
3498 95579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
3499 95579793STom Rini		The size of the malloc pool used in SPL.
3500 6a11cf48SDaniel Schwierzeck
3501 47f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
3502 47f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
3503 47f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
3504 47f7bcaeSTom Rini		NAND loading of the Linux Kernel.
3505 47f7bcaeSTom Rini
3506 9607faf2STom Rini		CONFIG_SPL_OS_BOOT
3507 9607faf2STom Rini		Enable booting directly to an OS from SPL.
3508 9607faf2STom Rini		See also: doc/README.falcon
3509 9607faf2STom Rini
3510 861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3511 861a86f4STom Rini		For ARM, enable an optional function to print more information
3512 861a86f4STom Rini		about the running system.
3513 861a86f4STom Rini
3514 4b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
3515 4b919725SScott Wood		Arch init code should be built for a very small image
3516 4b919725SScott Wood
3517 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
3518 6a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
3519 6a11cf48SDaniel Schwierzeck
3520 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
3521 6a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
3522 6a11cf48SDaniel Schwierzeck
3523 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
3524 6a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
3525 6a11cf48SDaniel Schwierzeck
3526 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
3527 6a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
3528 6a11cf48SDaniel Schwierzeck
3529 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
3530 6a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
3531 6a11cf48SDaniel Schwierzeck
3532 95579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3533 95579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3534 95579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3535 95579793STom Rini		Address, size and partition on the MMC to load U-Boot from
3536 95579793STom Rini		when the MMC is being used in raw mode.
3537 95579793STom Rini
3538 2b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3539 2b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
3540 2b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
3541 2b75b0adSPeter Korsgaard
3542 2b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3543 2b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3544 2b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
3545 2b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
3546 2b75b0adSPeter Korsgaard		(for falcon mode)
3547 2b75b0adSPeter Korsgaard
3548 95579793STom Rini		CONFIG_SPL_FAT_SUPPORT
3549 95579793STom Rini		Support for fs/fat/libfat.o in SPL binary
3550 95579793STom Rini
3551 95579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3552 95579793STom Rini		Filename to read to load U-Boot when reading from FAT
3553 95579793STom Rini
3554 7ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3555 7ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3556 7ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
3557 7ad2cc79SPeter Korsgaard
3558 7ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
3559 7ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3560 7ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
3561 7ad2cc79SPeter Korsgaard
3562 06f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3563 06f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
3564 06f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
3565 06f60ae3SScott Wood		continuing (the hardware starts execution after just
3566 06f60ae3SScott Wood		loading the first page rather than the full 4K).
3567 06f60ae3SScott Wood
3568 651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3569 651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3570 651fcf60SPrabhakar Kushwaha
3571 6f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
3572 6f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
3573 6f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
3574 6f2f01b9SScott Wood
3575 6f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
3576 6f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
3577 6f2f01b9SScott Wood
3578 6f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
3579 6f2f01b9SScott Wood		Include standard software ECC in the SPL
3580 6f2f01b9SScott Wood
3581 95579793STom Rini		CONFIG_SPL_NAND_SIMPLE
3582 7d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
3583 7d4b7955SScott Wood		expose the cmd_ctrl() interface.
3584 95579793STom Rini
3585 6dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
3586 6dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
3587 6dd3b566STom Rini		environment on NAND support within SPL.
3588 6dd3b566STom Rini
3589 bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3590 bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
3591 5614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3592 bb0dc108SYing Zhang
3593 7c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
3594 7c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
3595 7c8eea59SYing Zhang		SPL binary.
3596 7c8eea59SYing Zhang
3597 95579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3598 95579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3599 95579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3600 95579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3601 95579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
3602 95579793STom Rini		Defines the size and behavior of the NAND that SPL uses
3603 7d4b7955SScott Wood		to read U-Boot
3604 95579793STom Rini
3605 fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3606 fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3607 fbe76ae4SPrabhakar Kushwaha
3608 95579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
3609 7d4b7955SScott Wood		Location in NAND to read U-Boot from
3610 7d4b7955SScott Wood
3611 7d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
3612 7d4b7955SScott Wood		Location in memory to load U-Boot to
3613 7d4b7955SScott Wood
3614 7d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
3615 7d4b7955SScott Wood		Size of image to load
3616 95579793STom Rini
3617 95579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
3618 7d4b7955SScott Wood		Entry point in loaded image to jump to
3619 95579793STom Rini
3620 95579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3621 95579793STom Rini		Define this if you need to first read the OOB and then the
3622 95579793STom Rini		data. This is used for example on davinci plattforms.
3623 95579793STom Rini
3624 95579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
3625 95579793STom Rini		Support for an OMAP3-specific set of functions to return the
3626 95579793STom Rini		ID and MFR of the first attached NAND chip, if present.
3627 95579793STom Rini
3628 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
3629 6a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
3630 6a11cf48SDaniel Schwierzeck
3631 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
3632 6a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
3633 6a11cf48SDaniel Schwierzeck
3634 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
3635 6a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
3636 6a11cf48SDaniel Schwierzeck
3637 c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3638 c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3639 c57b953dSPavel Machek
3640 6a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
3641 6a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
3642 1372cce2SMarian Balakowicz
3643 ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3644 ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3645 ba1bee43SYing Zhang
3646 ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3647 ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3648 ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3649 ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3650 ba1bee43SYing Zhang
3651 74752baaSScott Wood		CONFIG_SPL_PAD_TO
3652 6113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
3653 6113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
3654 6113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3655 6113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3656 6113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3657 74752baaSScott Wood
3658 ca2fca22SScott Wood		CONFIG_SPL_TARGET
3659 ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3660 ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3661 ca2fca22SScott Wood		example if more than one image needs to be produced.
3662 ca2fca22SScott Wood
3663 87ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
3664 87ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
3665 87ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
3666 87ebee39SSimon Glass		option to re-enable it. This will affect the output of the
3667 87ebee39SSimon Glass		bootm command when booting a FIT image.
3668 87ebee39SSimon Glass
3669 3aa29de0SYing Zhang- TPL framework
3670 3aa29de0SYing Zhang		CONFIG_TPL
3671 3aa29de0SYing Zhang		Enable building of TPL globally.
3672 3aa29de0SYing Zhang
3673 3aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
3674 3aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
3675 3aa29de0SYing Zhang		the TPL payload. By default, this is defined as
3676 3aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3677 3aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3678 3aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3679 3aa29de0SYing Zhang
3680 c609719bSwdenkModem Support:
3681 c609719bSwdenk--------------
3682 c609719bSwdenk
3683 566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3684 c609719bSwdenk
3685 11ccc33fSMarcel Ziswiler- Modem support enable:
3686 c609719bSwdenk		CONFIG_MODEM_SUPPORT
3687 c609719bSwdenk
3688 c609719bSwdenk- RTS/CTS Flow control enable:
3689 c609719bSwdenk		CONFIG_HWFLOW
3690 c609719bSwdenk
3691 c609719bSwdenk- Modem debug support:
3692 c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3693 c609719bSwdenk
3694 c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3695 c609719bSwdenk		for modem support. Useful only with BDI2000.
3696 c609719bSwdenk
3697 a8c7c708Swdenk- Interrupt support (PPC):
3698 a8c7c708Swdenk
3699 a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3700 a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
3701 11ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3702 a8c7c708Swdenk		should set decrementer_count to appropriate value. If
3703 11ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3704 a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
3705 11ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3706 a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3707 a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3708 a8c7c708Swdenk		general timer_interrupt().
3709 a8c7c708Swdenk
3710 c609719bSwdenk- General:
3711 c609719bSwdenk
3712 c609719bSwdenk		In the target system modem support is enabled when a
3713 c609719bSwdenk		specific key (key combination) is pressed during
3714 c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
3715 11ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3716 c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3717 c609719bSwdenk		function, returning 1 and thus enabling modem
3718 c609719bSwdenk		initialization.
3719 c609719bSwdenk
3720 c609719bSwdenk		If there are no modem init strings in the
3721 c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3722 c609719bSwdenk		previous output (banner, info printfs) will be
3723 11ccc33fSMarcel Ziswiler		suppressed, though.
3724 c609719bSwdenk
3725 c609719bSwdenk		See also: doc/README.Modem
3726 c609719bSwdenk
3727 9660e442SHelmut RaigerBoard initialization settings:
3728 9660e442SHelmut Raiger------------------------------
3729 9660e442SHelmut Raiger
3730 9660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
3731 9660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
3732 9660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
3733 9660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
3734 9660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
3735 9660e442SHelmut Raigertypically in board_init_f() and board_init_r().
3736 9660e442SHelmut Raiger
3737 9660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3738 9660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3739 9660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3740 9660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3741 c609719bSwdenk
3742 c609719bSwdenkConfiguration Settings:
3743 c609719bSwdenk-----------------------
3744 c609719bSwdenk
3745 4d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3746 4d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
3747 4d1fd7f1SYork Sun
3748 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3749 c609719bSwdenk		undefine this when you're short of memory.
3750 c609719bSwdenk
3751 2fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3752 2fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
3753 2fb2604dSPeter Tyser
3754 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3755 c609719bSwdenk		prompt for user input.
3756 c609719bSwdenk
3757 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3758 c609719bSwdenk
3759 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3760 c609719bSwdenk
3761 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3762 c609719bSwdenk
3763 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3764 c609719bSwdenk		the application (usually a Linux kernel) when it is
3765 c609719bSwdenk		booted
3766 c609719bSwdenk
3767 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3768 c609719bSwdenk		List of legal baudrate settings for this board.
3769 c609719bSwdenk
3770 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3771 c609719bSwdenk		Suppress display of console information at boot.
3772 c609719bSwdenk
3773 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3774 c609719bSwdenk		If the board specific function
3775 c609719bSwdenk			extern int overwrite_console (void);
3776 c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3777 c609719bSwdenk		serial port, else the settings in the environment are used.
3778 c609719bSwdenk
3779 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3780 c609719bSwdenk		Enable the call to overwrite_console().
3781 c609719bSwdenk
3782 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3783 c609719bSwdenk		Enable overwrite of previous console environment settings.
3784 c609719bSwdenk
3785 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3786 c609719bSwdenk		Begin and End addresses of the area used by the
3787 c609719bSwdenk		simple memory test.
3788 c609719bSwdenk
3789 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3790 c609719bSwdenk		Enable an alternate, more extensive memory test.
3791 c609719bSwdenk
3792 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
3793 5f535fe1Swdenk		Scratch address used by the alternate memory test
3794 5f535fe1Swdenk		You only need to set this if address zero isn't writeable
3795 5f535fe1Swdenk
3796 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3797 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3798 14f73ca6SStefan Roese		this specified memory area will get subtracted from the top
3799 11ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
3800 14f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
3801 14f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
3802 14f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
3803 5e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
3804 14f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
3805 5e12e75dSStefan Roese		will have to get fixed in Linux additionally.
3806 14f73ca6SStefan Roese
3807 14f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
3808 14f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3809 14f73ca6SStefan Roese		be touched.
3810 14f73ca6SStefan Roese
3811 14f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
3812 14f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
3813 14f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
3814 14f73ca6SStefan Roese		non page size aligned address and this could cause major
3815 14f73ca6SStefan Roese		problems.
3816 14f73ca6SStefan Roese
3817 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3818 c609719bSwdenk		Enable temporary baudrate change while serial download
3819 c609719bSwdenk
3820 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3821 c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3822 c609719bSwdenk
3823 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3824 c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3825 c609719bSwdenk		Cogent motherboard)
3826 c609719bSwdenk
3827 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3828 c609719bSwdenk		Physical start address of Flash memory.
3829 c609719bSwdenk
3830 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3831 c609719bSwdenk		Physical start address of boot monitor code (set by
3832 c609719bSwdenk		make config files to be same as the text base address
3833 14d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
3834 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3835 c609719bSwdenk
3836 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
3837 3b57fe0aSwdenk		Size of memory reserved for monitor code, used to
3838 3b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
3839 3b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
3840 3b57fe0aSwdenk		flash sector.
3841 c609719bSwdenk
3842 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3843 c609719bSwdenk		Size of DRAM reserved for malloc() use.
3844 c609719bSwdenk
3845 d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3846 d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3847 d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3848 d59476b6SSimon Glass		will become available before relocation. The address is just
3849 d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3850 d59476b6SSimon Glass		space.
3851 d59476b6SSimon Glass
3852 d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3853 d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3854 d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3855 d59476b6SSimon Glass		The memory will be freed (or in fact just forgotton) when
3856 d59476b6SSimon Glass		U-Boot relocates itself.
3857 d59476b6SSimon Glass
3858 e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
3859 29afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
3860 29afe9e6SSimon Glass
3861 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
3862 15940c9aSStefan Roese		Normally compressed uImages are limited to an
3863 15940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
3864 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
3865 15940c9aSStefan Roese		to adjust this setting to your needs.
3866 c609719bSwdenk
3867 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3868 c609719bSwdenk		Maximum size of memory mapped by the startup code of
3869 c609719bSwdenk		the Linux kernel; all data that must be processed by
3870 7d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
3871 7d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
3872 1bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
3873 7d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3874 c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3875 c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3876 c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3877 c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3878 c609719bSwdenk
3879 fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3880 fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3881 fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3882 fca43cc8SJohn Rigby		is enabled.
3883 fca43cc8SJohn Rigby
3884 fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3885 fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3886 fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3887 fca43cc8SJohn Rigby
3888 fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3889 fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3890 fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3891 fca43cc8SJohn Rigby
3892 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3893 c609719bSwdenk		Max number of Flash memory banks
3894 c609719bSwdenk
3895 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3896 c609719bSwdenk		Max number of sectors on a Flash chip
3897 c609719bSwdenk
3898 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3899 c609719bSwdenk		Timeout for Flash erase operations (in ms)
3900 c609719bSwdenk
3901 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3902 c609719bSwdenk		Timeout for Flash write operations (in ms)
3903 c609719bSwdenk
3904 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
3905 8564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
3906 8564acf9Swdenk
3907 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
3908 8564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
3909 8564acf9Swdenk
3910 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
3911 8564acf9Swdenk		If defined, hardware flash sectors protection is used
3912 8564acf9Swdenk		instead of U-Boot software protection.
3913 8564acf9Swdenk
3914 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3915 c609719bSwdenk
3916 c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3917 c609719bSwdenk		without this option such a download has to be
3918 c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3919 c609719bSwdenk		copy from RAM to flash.
3920 c609719bSwdenk
3921 c609719bSwdenk		The two-step approach is usually more reliable, since
3922 c609719bSwdenk		you can check if the download worked before you erase
3923 11ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
3924 11ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3925 c609719bSwdenk		downloaded image) this option may be very useful.
3926 c609719bSwdenk
3927 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3928 c609719bSwdenk		Define if the flash driver uses extra elements in the
3929 5653fc33Swdenk		common flash structure for storing flash geometry.
3930 5653fc33Swdenk
3931 00b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
3932 5653fc33Swdenk		This option also enables the building of the cfi_flash driver
3933 5653fc33Swdenk		in the drivers directory
3934 53cf9435Sstroese
3935 91809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
3936 91809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
3937 91809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
3938 91809ed5SPiotr Ziecik		to the MTD layer.
3939 91809ed5SPiotr Ziecik
3940 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3941 96ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
3942 96ef831fSGuennadi Liakhovetski
3943 96ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
3944 96ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
3945 96ef831fSGuennadi Liakhovetski		write commands.
3946 96ef831fSGuennadi Liakhovetski
3947 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
3948 5568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
3949 5568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
3950 5568e613SStefan Roese		is useful, if some of the configured banks are only
3951 5568e613SStefan Roese		optionally available.
3952 5568e613SStefan Roese
3953 9a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
3954 9a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
3955 9a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
3956 9a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
3957 9a042e9cSJerry Van Baren
3958 352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3959 352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3960 352ef3f1SStefan Roese		against the source after the write operation. An error message
3961 352ef3f1SStefan Roese		will be printed when the contents are not identical.
3962 352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3963 352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3964 352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3965 352ef3f1SStefan Roese		this option if you really know what you are doing.
3966 352ef3f1SStefan Roese
3967 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
3968 11ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
3969 11ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
3970 53cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
3971 53cf9435Sstroese		buffers can be full shortly after enabling the interface
3972 11ccc33fSMarcel Ziswiler		on high Ethernet traffic.
3973 53cf9435Sstroese		Defaults to 4 if not defined.
3974 c609719bSwdenk
3975 ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3976 ea882bafSWolfgang Denk
3977 ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3978 ea882bafSWolfgang Denk	internally to store the environment settings. The default
3979 ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3980 ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3981 ea882bafSWolfgang Denk	lib/hashtable.c for details.
3982 ea882bafSWolfgang Denk
3983 2598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
3984 2598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
3985 1bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
3986 2598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
3987 2598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
3988 2598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
3989 2598090bSJoe Hershberger
3990 2598090bSJoe Hershberger	The format of the list is:
3991 2598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3992 267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3993 267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
3994 2598090bSJoe Hershberger		entry = variable_name[:attributes]
3995 2598090bSJoe Hershberger		list = entry[,list]
3996 2598090bSJoe Hershberger
3997 2598090bSJoe Hershberger	The type attributes are:
3998 2598090bSJoe Hershberger		s - String (default)
3999 2598090bSJoe Hershberger		d - Decimal
4000 2598090bSJoe Hershberger		x - Hexadecimal
4001 2598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
4002 2598090bSJoe Hershberger		i - IP address
4003 2598090bSJoe Hershberger		m - MAC address
4004 2598090bSJoe Hershberger
4005 267541f7SJoe Hershberger	The access attributes are:
4006 267541f7SJoe Hershberger		a - Any (default)
4007 267541f7SJoe Hershberger		r - Read-only
4008 267541f7SJoe Hershberger		o - Write-once
4009 267541f7SJoe Hershberger		c - Change-default
4010 267541f7SJoe Hershberger
4011 2598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
4012 2598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
4013 2598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
4014 2598090bSJoe Hershberger
4015 2598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
4016 2598090bSJoe Hershberger		Define this to a list (string) to define validation that
4017 2598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
4018 2598090bSJoe Hershberger		environment variable.  To override a setting in the static
4019 2598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
4020 2598090bSJoe Hershberger		".flags" variable.
4021 2598090bSJoe Hershberger
4022 267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4023 267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4024 267541f7SJoe Hershberger	access flags.
4025 267541f7SJoe Hershberger
4026 5c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
4027 5c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
4028 5c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
4029 5c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
4030 5c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
4031 5c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
4032 5c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4033 5c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
4034 5c1a7ea6SSimon Glass	your board please report the problem and send patches!
4035 5c1a7ea6SSimon Glass
4036 0b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4037 0b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
4038 0b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4039 0b1b60c7SLokesh Vutla	the value can be calulated on a given board.
4040 632efa74SSimon Glass
4041 c609719bSwdenkThe following definitions that deal with the placement and management
4042 c609719bSwdenkof environment data (variable area); in general, we support the
4043 c609719bSwdenkfollowing configurations:
4044 c609719bSwdenk
4045 c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4046 c3eb3fe4SMike Frysinger
4047 c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4048 c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4049 c3eb3fe4SMike Frysinger
4050 5a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4051 c609719bSwdenk
4052 c609719bSwdenk	Define this if the environment is in flash memory.
4053 c609719bSwdenk
4054 c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4055 c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4056 c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4057 c609719bSwdenk	   sector" type flash chips, which have several smaller
4058 c609719bSwdenk	   sectors at the start or the end. For instance, such a
4059 c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4060 c609719bSwdenk	   such a case you would place the environment in one of the
4061 c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4062 c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4063 c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4064 c609719bSwdenk	   between U-Boot and the environment.
4065 c609719bSwdenk
4066 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4067 c609719bSwdenk
4068 c609719bSwdenk	   Offset of environment data (variable area) to the
4069 c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4070 c609719bSwdenk	   type flash chips the second sector can be used: the offset
4071 c609719bSwdenk	   for this sector is given here.
4072 c609719bSwdenk
4073 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4074 c609719bSwdenk
4075 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4076 c609719bSwdenk
4077 c609719bSwdenk	   This is just another way to specify the start address of
4078 c609719bSwdenk	   the flash sector containing the environment (instead of
4079 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4080 c609719bSwdenk
4081 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4082 c609719bSwdenk
4083 c609719bSwdenk	   Size of the sector containing the environment.
4084 c609719bSwdenk
4085 c609719bSwdenk
4086 c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4087 c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4088 c609719bSwdenk	   the environment.
4089 c609719bSwdenk
4090 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4091 c609719bSwdenk
4092 5a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
4093 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4094 c609719bSwdenk	   of this flash sector for the environment. This saves
4095 c609719bSwdenk	   memory for the RAM copy of the environment.
4096 c609719bSwdenk
4097 c609719bSwdenk	   It may also save flash memory if you decide to use this
4098 c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4099 c609719bSwdenk	   since then the remainder of the flash sector could be used
4100 c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4101 c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4102 c609719bSwdenk	   updating the environment in flash makes it always
4103 c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4104 c609719bSwdenk	   wrong before the contents has been restored from a copy in
4105 c609719bSwdenk	   RAM, your target system will be dead.
4106 c609719bSwdenk
4107 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
4108 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4109 c609719bSwdenk
4110 c609719bSwdenk	   These settings describe a second storage area used to hold
4111 11ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
4112 3e38691eSwdenk	   a valid backup copy in case there is a power failure during
4113 c609719bSwdenk	   a "saveenv" operation.
4114 c609719bSwdenk
4115 c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4116 c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4117 c609719bSwdenkaccordingly!
4118 c609719bSwdenk
4119 c609719bSwdenk
4120 9314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4121 c609719bSwdenk
4122 c609719bSwdenk	Define this if you have some non-volatile memory device
4123 c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4124 c609719bSwdenk	environment.
4125 c609719bSwdenk
4126 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4127 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4128 c609719bSwdenk
4129 11ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4130 c609719bSwdenk	  want to use for environment. It is assumed that this memory
4131 c609719bSwdenk	  can just be read and written to, without any special
4132 c609719bSwdenk	  provision.
4133 c609719bSwdenk
4134 c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4135 c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
4136 11ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4137 c609719bSwdenkU-Boot will hang.
4138 c609719bSwdenk
4139 c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4140 c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4141 c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4142 c609719bSwdenkto save the current settings.
4143 c609719bSwdenk
4144 c609719bSwdenk
4145 bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4146 c609719bSwdenk
4147 c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4148 c609719bSwdenk	device and a driver for it.
4149 c609719bSwdenk
4150 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4151 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4152 c609719bSwdenk
4153 c609719bSwdenk	  These two #defines specify the offset and size of the
4154 c609719bSwdenk	  environment area within the total memory of your EEPROM.
4155 c609719bSwdenk
4156 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4157 c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4158 c609719bSwdenk	  The default address is zero.
4159 c609719bSwdenk
4160 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4161 c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4162 c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4163 c609719bSwdenk	  would require six bits.
4164 c609719bSwdenk
4165 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4166 c609719bSwdenk	  If defined, the number of milliseconds to delay between
4167 c609719bSwdenk	  page writes.	The default is zero milliseconds.
4168 c609719bSwdenk
4169 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4170 c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4171 c609719bSwdenk	  that this is NOT the chip address length!
4172 c609719bSwdenk
4173 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
4174 5cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
4175 5cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4176 5cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
4177 5cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4178 5cf91d6bSwdenk	  byte chips.
4179 5cf91d6bSwdenk
4180 5cf91d6bSwdenk	  Note that we consider the length of the address field to
4181 5cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
4182 5cf91d6bSwdenk	  in the chip address.
4183 5cf91d6bSwdenk
4184 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4185 c609719bSwdenk	  The size in bytes of the EEPROM device.
4186 c609719bSwdenk
4187 548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4188 548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4189 548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4190 548738b4SHeiko Schocher
4191 548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4192 548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4193 548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4194 548738b4SHeiko Schocher	  EEPROM. For example:
4195 548738b4SHeiko Schocher
4196 ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4197 548738b4SHeiko Schocher
4198 548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4199 548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4200 c609719bSwdenk
4201 057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
4202 5779d8d9Swdenk
4203 5779d8d9Swdenk	Define this if you have a DataFlash memory device which you
4204 5779d8d9Swdenk	want to use for the environment.
4205 5779d8d9Swdenk
4206 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4207 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4208 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4209 5779d8d9Swdenk
4210 5779d8d9Swdenk	  These three #defines specify the offset and size of the
4211 5779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
4212 5779d8d9Swdenk	  at the specified address.
4213 5779d8d9Swdenk
4214 bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4215 bd83b592SWu, Josh
4216 bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4217 bd83b592SWu, Josh	want to use for the environment.
4218 bd83b592SWu, Josh
4219 bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4220 bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4221 bd83b592SWu, Josh
4222 bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4223 bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4224 bd83b592SWu, Josh	  aligned to an erase sector boundary.
4225 bd83b592SWu, Josh
4226 bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4227 bd83b592SWu, Josh
4228 bd83b592SWu, Josh	  Define the SPI flash's sector size.
4229 bd83b592SWu, Josh
4230 bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4231 bd83b592SWu, Josh
4232 bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4233 bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4234 bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4235 bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4236 bd83b592SWu, Josh	  aligned to an erase sector boundary.
4237 bd83b592SWu, Josh
4238 bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4239 bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4240 bd83b592SWu, Josh
4241 bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4242 bd83b592SWu, Josh
4243 bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4244 bd83b592SWu, Josh
4245 bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4246 bd83b592SWu, Josh
4247 bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4248 bd83b592SWu, Josh
4249 bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4250 bd83b592SWu, Josh
4251 0a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
4252 0a85a9e7SLiu Gang
4253 0a85a9e7SLiu Gang	Define this if you have a remote memory space which you
4254 0a85a9e7SLiu Gang	want to use for the local device's environment.
4255 0a85a9e7SLiu Gang
4256 0a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
4257 0a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
4258 0a85a9e7SLiu Gang
4259 0a85a9e7SLiu Gang	  These two #defines specify the address and size of the
4260 0a85a9e7SLiu Gang	  environment area within the remote memory space. The
4261 0a85a9e7SLiu Gang	  local device can get the environment from remote memory
4262 fc54c7faSLiu Gang	  space by SRIO or PCIE links.
4263 0a85a9e7SLiu Gang
4264 0a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
4265 0a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4266 fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4267 fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
4268 0a85a9e7SLiu Gang
4269 51bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
4270 13a5695bSwdenk
4271 13a5695bSwdenk	Define this if you have a NAND device which you want to use
4272 13a5695bSwdenk	for the environment.
4273 13a5695bSwdenk
4274 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4275 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4276 13a5695bSwdenk
4277 13a5695bSwdenk	  These two #defines specify the offset and size of the environment
4278 fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4279 fdd813deSScott Wood	  aligned to an erase block boundary.
4280 5779d8d9Swdenk
4281 fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4282 e443c944SMarkus Klotzbuecher
4283 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4284 fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4285 fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4286 fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4287 fdd813deSScott Wood	  aligned to an erase block boundary.
4288 e443c944SMarkus Klotzbuecher
4289 fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4290 fdd813deSScott Wood
4291 fdd813deSScott Wood	  Specifies the length of the region in which the environment
4292 fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4293 fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4294 fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4295 fdd813deSScott Wood	  the range to be avoided.
4296 fdd813deSScott Wood
4297 fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4298 fdd813deSScott Wood
4299 fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4300 fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4301 fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4302 fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4303 fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4304 e443c944SMarkus Klotzbuecher
4305 b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4306 b74ab737SGuennadi Liakhovetski
4307 b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4308 b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4309 b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4310 b74ab737SGuennadi Liakhovetski
4311 2b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
4312 2b74433fSJoe Hershberger
4313 2b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
4314 2b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
4315 2b74433fSJoe Hershberger	accesses, which is important on NAND.
4316 2b74433fSJoe Hershberger
4317 2b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
4318 2b74433fSJoe Hershberger
4319 2b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
4320 2b74433fSJoe Hershberger
4321 2b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
4322 2b74433fSJoe Hershberger
4323 2b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
4324 2b74433fSJoe Hershberger	  environment in.
4325 2b74433fSJoe Hershberger
4326 785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4327 785881f7SJoe Hershberger
4328 785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4329 785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4330 785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4331 785881f7SJoe Hershberger
4332 2b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
4333 2b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
4334 2b74433fSJoe Hershberger
4335 2b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
4336 2b74433fSJoe Hershberger	  when storing the env in UBI.
4337 2b74433fSJoe Hershberger
4338 d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4339 d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4340 d1db76f1SWu, Josh
4341 d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4342 d1db76f1SWu, Josh
4343 d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4344 d1db76f1SWu, Josh
4345 d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4346 d1db76f1SWu, Josh
4347 d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4348 d1db76f1SWu, Josh         be as following:
4349 d1db76f1SWu, Josh
4350 d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4351 d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4352 d1db76f1SWu, Josh                        partition table.
4353 d1db76f1SWu, Josh               - "D:0": device D.
4354 d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4355 d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4356 d1db76f1SWu, Josh                              table.
4357 d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4358 d1db76f1SWu, Josh                           If none, first valid paratition in device D. If no
4359 d1db76f1SWu, Josh                           partition table then means device D.
4360 d1db76f1SWu, Josh
4361 d1db76f1SWu, Josh       - FAT_ENV_FILE:
4362 d1db76f1SWu, Josh
4363 d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4364 d1db76f1SWu, Josh         envrionment.
4365 d1db76f1SWu, Josh
4366 d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4367 d1db76f1SWu, Josh         This should be defined. Otherwise it cannot save the envrionment file.
4368 d1db76f1SWu, Josh
4369 06e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
4370 06e4ae5fSStephen Warren
4371 06e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
4372 06e4ae5fSStephen Warren	environment.
4373 06e4ae5fSStephen Warren
4374 06e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
4375 06e4ae5fSStephen Warren
4376 06e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
4377 06e4ae5fSStephen Warren
4378 06e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
4379 06e4ae5fSStephen Warren
4380 06e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
4381 06e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
4382 06e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
4383 06e4ae5fSStephen Warren
4384 06e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
4385 06e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
4386 06e4ae5fSStephen Warren
4387 06e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
4388 06e4ae5fSStephen Warren	  area within the specified MMC device.
4389 06e4ae5fSStephen Warren
4390 5c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
4391 5c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
4392 5c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
4393 5c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
4394 5c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
4395 5c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
4396 5c088ee8SStephen Warren	  maximum possible space before it, to store other data.
4397 5c088ee8SStephen Warren
4398 06e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
4399 06e4ae5fSStephen Warren	  MMC sector boundary.
4400 06e4ae5fSStephen Warren
4401 06e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
4402 06e4ae5fSStephen Warren
4403 06e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4404 06e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
4405 06e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
4406 06e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
4407 06e4ae5fSStephen Warren
4408 5c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
4409 5c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
4410 5c088ee8SStephen Warren
4411 06e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
4412 06e4ae5fSStephen Warren	  an MMC sector boundary.
4413 06e4ae5fSStephen Warren
4414 06e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
4415 06e4ae5fSStephen Warren
4416 06e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4417 06e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
4418 06e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
4419 06e4ae5fSStephen Warren
4420 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4421 c609719bSwdenk
4422 c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4423 c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4424 c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4425 c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4426 c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4427 c609719bSwdenk	to be a good choice since it makes it far enough from the
4428 c609719bSwdenk	start of the data area as well as from the stack pointer.
4429 c609719bSwdenk
4430 e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4431 c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4432 cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4433 c609719bSwdenkuntil then to read environment variables.
4434 c609719bSwdenk
4435 85ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
4436 85ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
4437 85ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
4438 85ec0bccSwdenknecessary, because the first environment variable we need is the
4439 85ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
4440 85ec0bccSwdenkhave any device yet where we could complain.]
4441 c609719bSwdenk
4442 c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4443 c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
4444 85ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4445 c609719bSwdenk
4446 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4447 fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4448 fc3e2165Swdenk
4449 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4450 fc3e2165Swdenk		      also needs to be defined.
4451 fc3e2165Swdenk
4452 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4453 fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4454 c609719bSwdenk
4455 f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4456 f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4457 f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4458 f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4459 f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4460 f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4461 f5675aa5SRon Madrid
4462 b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4463 b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4464 b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4465 b2b92f53SSimon Glass		to do this.
4466 b2b92f53SSimon Glass
4467 e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4468 e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4469 e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4470 e2e3e2b1SSimon Glass		present.
4471 e2e3e2b1SSimon Glass
4472 feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4473 feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4474 feb85801SSascha Silbe		build system checks that the actual size does not
4475 feb85801SSascha Silbe		exceed it.
4476 feb85801SSascha Silbe
4477 c609719bSwdenkLow Level (hardware related) configuration options:
4478 dc7c9a1aSwdenk---------------------------------------------------
4479 c609719bSwdenk
4480 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4481 c609719bSwdenk		Cache Line Size of the CPU.
4482 c609719bSwdenk
4483 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4484 c609719bSwdenk		Default address of the IMMR after system reset.
4485 2535d602Swdenk
4486 2535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4487 2535d602Swdenk		and RPXsuper) to be able to adjust the position of
4488 2535d602Swdenk		the IMMR register after a reset.
4489 c609719bSwdenk
4490 e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4491 e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4492 e46fedfeSTimur Tabi		PowerPC SOCs.
4493 e46fedfeSTimur Tabi
4494 e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4495 e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4496 e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4497 e46fedfeSTimur Tabi
4498 e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4499 e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4500 e46fedfeSTimur Tabi
4501 e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4502 e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4503 e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4504 e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4505 e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4506 e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4507 e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4508 e46fedfeSTimur Tabi
4509 e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4510 e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4511 e46fedfeSTimur Tabi
4512 e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4513 e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4514 e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4515 e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4516 e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4517 e46fedfeSTimur Tabi
4518 e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4519 e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4520 e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4521 e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4522 e46fedfeSTimur Tabi
4523 e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4524 e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4525 e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4526 e46fedfeSTimur Tabi
4527 7f6c2cbcSwdenk- Floppy Disk Support:
4528 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
4529 7f6c2cbcSwdenk
4530 7f6c2cbcSwdenk		the default drive number (default value 0)
4531 7f6c2cbcSwdenk
4532 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
4533 7f6c2cbcSwdenk
4534 11ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
4535 7f6c2cbcSwdenk		(default value 1)
4536 7f6c2cbcSwdenk
4537 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
4538 7f6c2cbcSwdenk
4539 7f6c2cbcSwdenk		defines the offset of register from address. It
4540 7f6c2cbcSwdenk		depends on which part of the data bus is connected to
4541 11ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
4542 7f6c2cbcSwdenk
4543 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4544 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
4545 7f6c2cbcSwdenk		default value.
4546 7f6c2cbcSwdenk
4547 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
4548 7f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
4549 7f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4550 7f6c2cbcSwdenk		source code. It is used to make hardware dependant
4551 7f6c2cbcSwdenk		initializations.
4552 7f6c2cbcSwdenk
4553 0abddf82SMacpaul Lin- CONFIG_IDE_AHB:
4554 0abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
4555 0abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
4556 0abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
4557 0abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
4558 0abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4559 0abddf82SMacpaul Lin		is requierd.
4560 0abddf82SMacpaul Lin
4561 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
4562 25d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
4563 25d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4564 c609719bSwdenk
4565 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4566 c609719bSwdenk
4567 7152b1d0Swdenk		Start address of memory area that can be used for
4568 c609719bSwdenk		initial data and stack; please note that this must be
4569 c609719bSwdenk		writable memory that is working WITHOUT special
4570 c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4571 c609719bSwdenk		will become available only after programming the
4572 c609719bSwdenk		memory controller and running certain initialization
4573 c609719bSwdenk		sequences.
4574 c609719bSwdenk
4575 c609719bSwdenk		U-Boot uses the following memory types:
4576 c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4577 c609719bSwdenk		- MPC824X: data cache
4578 c609719bSwdenk		- PPC4xx:  data cache
4579 c609719bSwdenk
4580 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4581 c609719bSwdenk
4582 c609719bSwdenk		Offset of the initial data structure in the memory
4583 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4584 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4585 c609719bSwdenk		data is located at the end of the available space
4586 553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4587 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4588 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4589 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4590 c609719bSwdenk
4591 c609719bSwdenk	Note:
4592 c609719bSwdenk		On the MPC824X (or other systems that use the data
4593 c609719bSwdenk		cache for initial memory) the address chosen for
4594 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4595 c609719bSwdenk		point to an otherwise UNUSED address space between
4596 c609719bSwdenk		the top of RAM and the start of the PCI space.
4597 c609719bSwdenk
4598 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4599 c609719bSwdenk
4600 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4601 c609719bSwdenk
4602 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4603 c609719bSwdenk
4604 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4605 c609719bSwdenk
4606 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4607 c609719bSwdenk
4608 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4609 c609719bSwdenk
4610 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4611 c609719bSwdenk		SDRAM timing
4612 c609719bSwdenk
4613 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4614 c609719bSwdenk		periodic timer for refresh
4615 c609719bSwdenk
4616 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4617 c609719bSwdenk
4618 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4619 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4620 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4621 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4622 c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4623 c609719bSwdenk
4624 c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4625 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4626 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4627 c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4628 c609719bSwdenk
4629 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4630 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4631 c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4632 c609719bSwdenk		Prescaler definitions (SDRAM timing)
4633 c609719bSwdenk
4634 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4635 c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4636 c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4637 c609719bSwdenk
4638 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4639 b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4640 b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4641 b423d055SHeiko Schocher
4642 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4643 c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4644 c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4645 c609719bSwdenk
4646 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4647 c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4648 c609719bSwdenk		wrong setting might damage your board. Read
4649 c609719bSwdenk		doc/README.MBX before setting this variable!
4650 c609719bSwdenk
4651 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4652 ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4653 ea909b76Swdenk		(Power On Self Tests). This definition overrides
4654 ea909b76Swdenk		#define'd default value in commproc.h resp.
4655 ea909b76Swdenk		cpm_8260.h.
4656 ea909b76Swdenk
4657 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4658 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4659 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4660 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4661 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4662 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4663 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4664 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4665 a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
4666 5d232d0eSwdenk
4667 9cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
4668 9cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
4669 9cacf4fcSDirk Eibach		required.
4670 9cacf4fcSDirk Eibach
4671 69fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4672 69fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
4673 69fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
4674 69fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
4675 69fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
4676 69fd2d3bSAndrew Sharp		by coreboot or similar.
4677 69fd2d3bSAndrew Sharp
4678 842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4679 842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4680 842033e6SGabor Juhos
4681 a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4682 a09b9b68SKumar Gala		Chip has SRIO or not
4683 a09b9b68SKumar Gala
4684 a09b9b68SKumar Gala- CONFIG_SRIO1:
4685 a09b9b68SKumar Gala		Board has SRIO 1 port available
4686 a09b9b68SKumar Gala
4687 a09b9b68SKumar Gala- CONFIG_SRIO2:
4688 a09b9b68SKumar Gala		Board has SRIO 2 port available
4689 a09b9b68SKumar Gala
4690 c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4691 c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4692 c8b28152SLiu Gang
4693 a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4694 a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4695 a09b9b68SKumar Gala
4696 a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4697 a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4698 a09b9b68SKumar Gala
4699 a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4700 a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4701 a09b9b68SKumar Gala
4702 66bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4703 66bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
4704 66bd1846SFabio Estevam		a 16 bit bus.
4705 66bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4706 a430e916SFabio Estevam		Example of drivers that use it:
4707 66bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4708 a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4709 eced4626SAlex Waterman
4710 eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4711 eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4712 eced4626SAlex Waterman		a default value will be used.
4713 eced4626SAlex Waterman
4714 bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4715 218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4716 218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4717 218ca724SWolfgang Denk
4718 bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4719 bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4720 bb99ad6dSBen Warren
4721 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4722 218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4723 218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4724 218ca724SWolfgang Denk		to something your driver can deal with.
4725 bb99ad6dSBen Warren
4726 1b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
4727 1b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
4728 1b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
4729 1b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
4730 1b3e3c4fSYork Sun		header files or board specific files.
4731 1b3e3c4fSYork Sun
4732 6f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
4733 6f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
4734 6f5e1dc5SYork Sun
4735 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4736 218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4737 218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
4738 2ad6b513STimur Tabi
4739 c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4740 c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4741 c26e454dSwdenk
4742 c26e454dSwdenk- CONFIG_FEC[12]_PHY
4743 c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
4744 6e592385Swdenk		to the given FEC; i. e.
4745 c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4746 c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4747 c26e454dSwdenk
4748 c26e454dSwdenk		When set to -1, means to probe for first available.
4749 c26e454dSwdenk
4750 c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4751 c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4752 c26e454dSwdenk		(so program the FEC to ignore it).
4753 c26e454dSwdenk
4754 c26e454dSwdenk- CONFIG_RMII
4755 c26e454dSwdenk		Enable RMII mode for all FECs.
4756 c26e454dSwdenk		Note that this is a global option, we can't
4757 c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4758 c26e454dSwdenk
4759 5cf91d6bSwdenk- CONFIG_CRC32_VERIFY
4760 5cf91d6bSwdenk		Add a verify option to the crc32 command.
4761 5cf91d6bSwdenk		The syntax is:
4762 5cf91d6bSwdenk
4763 5cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
4764 5cf91d6bSwdenk
4765 5cf91d6bSwdenk		Where address/count indicate a memory area
4766 5cf91d6bSwdenk		and crc32 is the correct crc32 which the
4767 5cf91d6bSwdenk		area should have.
4768 5cf91d6bSwdenk
4769 56523f12Swdenk- CONFIG_LOOPW
4770 56523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4771 602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
4772 56523f12Swdenk
4773 7b466641Sstroese- CONFIG_MX_CYCLIC
4774 7b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
4775 7b466641Sstroese		"md/mw" commands.
4776 7b466641Sstroese		Examples:
4777 7b466641Sstroese
4778 7b466641Sstroese		=> mdc.b 10 4 500
4779 7b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
4780 7b466641Sstroese
4781 7b466641Sstroese		=> mwc.l 100 12345678 10
4782 7b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
4783 7b466641Sstroese
4784 7b466641Sstroese		This only takes effect if the memory commands are activated
4785 602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
4786 7b466641Sstroese
4787 8aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4788 afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4789 e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4790 e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4791 e03f3169SWolfgang Denk		relocate itself into RAM.
4792 8aa1a2d1Swdenk
4793 e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4794 e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4795 e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4796 e03f3169SWolfgang Denk		these initializations itself.
4797 8aa1a2d1Swdenk
4798 401bb30bSAneesh V- CONFIG_SPL_BUILD
4799 df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4800 df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4801 df81238bSMagnus Lilja		compiling a NAND SPL.
4802 400558b5Swdenk
4803 3aa29de0SYing Zhang- CONFIG_TPL_BUILD
4804 3aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
4805 3aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
4806 3aa29de0SYing Zhang		It is loaded by the SPL.
4807 3aa29de0SYing Zhang
4808 5df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
4809 5df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
4810 5df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
4811 5df572f0SYing Zhang		previous 4k of the .text section.
4812 5df572f0SYing Zhang
4813 4213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
4814 4213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
4815 4213fc29SSimon Glass		effective address. It is therefore not necessary to regard
4816 4213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
4817 4213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
4818 4213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
4819 4213fc29SSimon Glass		addressable memory. This option causes some memory accesses
4820 4213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
4821 4213fc29SSimon Glass
4822 d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4823 d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4824 d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4825 d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4826 d8834a13SMatthias Weisser		conditions but may increase the binary size.
4827 d8834a13SMatthias Weisser
4828 588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4829 588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4830 588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4831 b16f521aSGabe Black
4832 fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4833 fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4834 fc33705eSMark Jackson
4835 fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
4836 5b5ece9eSGabe Black
4837 16678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4838 16678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
4839 16678eb4SHeiko Schocher
4840 999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4841 999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4842 999d7d32SKaricheri, Muralidharan		driver that uses this:
4843 999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4844 999d7d32SKaricheri, Muralidharan
4845 f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4846 f2717b47STimur Tabi-----------------------------------
4847 f2717b47STimur Tabi
4848 f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4849 f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4850 f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4851 f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4852 f2717b47STimur Tabiwithin that device.
4853 f2717b47STimur Tabi
4854 dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4855 dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4856 dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4857 dcf1d774SZhao Qiang	is also specified.
4858 dcf1d774SZhao Qiang
4859 dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4860 dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4861 f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4862 f2717b47STimur Tabi	is also specified.
4863 f2717b47STimur Tabi
4864 f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4865 f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4866 f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4867 f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4868 f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4869 f2717b47STimur Tabi
4870 f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4871 f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4872 f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4873 f2717b47STimur Tabi	virtual address in NOR flash.
4874 f2717b47STimur Tabi
4875 f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4876 f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4877 f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4878 f2717b47STimur Tabi
4879 f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4880 f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4881 f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4882 f2717b47STimur Tabi
4883 f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4884 f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4885 f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4886 f2717b47STimur Tabi
4887 292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4888 292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4889 292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4890 fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4891 fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4892 fc54c7faSLiu Gang	master's memory space.
4893 f2717b47STimur Tabi
4894 b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4895 b940ca64SJ. German Rivera---------------------------------------------------------
4896 b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4897 b940ca64SJ. German Rivera"firmware".
4898 b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4899 b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4900 b940ca64SJ. German Riverawithin that device.
4901 b940ca64SJ. German Rivera
4902 b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4903 b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4904 b940ca64SJ. German Rivera
4905 b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
4906 b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
4907 b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4908 b940ca64SJ. German Rivera	is also specified.
4909 b940ca64SJ. German Rivera
4910 b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
4911 b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
4912 b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
4913 b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
4914 b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
4915 b940ca64SJ. German Rivera
4916 b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
4917 b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
4918 b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4919 b940ca64SJ. German Rivera	virtual address in NOR flash.
4920 b940ca64SJ. German Rivera
4921 c609719bSwdenkBuilding the Software:
4922 c609719bSwdenk======================
4923 c609719bSwdenk
4924 218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4925 218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4926 218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4927 218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4928 218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4929 218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4930 c609719bSwdenk
4931 218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4932 218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4933 218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4934 218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4935 218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4936 c609719bSwdenk
4937 218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4938 218ca724SWolfgang Denk	$ export CROSS_COMPILE
4939 c609719bSwdenk
4940 2f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
4941 2f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
4942 2f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
4943 2f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
4944 2f8d396bSPeter Tyser
4945 2f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4946 2f8d396bSPeter Tyser
4947 2f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
4948 2f8d396bSPeter Tyser      be executed on computers running Windows.
4949 2f8d396bSPeter Tyser
4950 c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4951 c609719bSwdenksources you must configure U-Boot for one specific board type. This
4952 c609719bSwdenkis done by typing:
4953 c609719bSwdenk
4954 ab584d67SHolger Freyther	make NAME_defconfig
4955 c609719bSwdenk
4956 ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
4957 4d675ae6SMichael Jonesrations; see boards.cfg for supported names.
4958 54387ac9Swdenk
4959 c609719bSwdenkNote: for some board special configuration names may exist; check if
4960 c609719bSwdenk      additional information is available from the board vendor; for
4961 2729af9dSwdenk      instance, the TQM823L systems are available without (standard)
4962 2729af9dSwdenk      or with LCD support. You can select such additional "features"
4963 11ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4964 c609719bSwdenk
4965 ab584d67SHolger Freyther      make TQM823L_defconfig
4966 2729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4967 c609719bSwdenk
4968 ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4969 c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4970 c609719bSwdenk
4971 c609719bSwdenk      etc.
4972 c609719bSwdenk
4973 c609719bSwdenk
4974 c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
4975 7152b1d0Swdenkimages ready for download to / installation on your system:
4976 c609719bSwdenk
4977 c609719bSwdenk- "u-boot.bin" is a raw binary image
4978 c609719bSwdenk- "u-boot" is an image in ELF binary format
4979 c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4980 c609719bSwdenk
4981 baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4982 baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4983 baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4984 baf31249SMarian Balakowicz
4985 baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4986 baf31249SMarian Balakowicz
4987 baf31249SMarian Balakowicz	make O=/tmp/build distclean
4988 ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4989 baf31249SMarian Balakowicz	make O=/tmp/build all
4990 baf31249SMarian Balakowicz
4991 baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4992 baf31249SMarian Balakowicz
4993 baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4994 baf31249SMarian Balakowicz	make distclean
4995 ab584d67SHolger Freyther	make NAME_defconfig
4996 baf31249SMarian Balakowicz	make all
4997 baf31249SMarian Balakowicz
4998 baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4999 baf31249SMarian Balakowiczvariable.
5000 baf31249SMarian Balakowicz
5001 c609719bSwdenk
5002 c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5003 c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5004 c609719bSwdenknative "make".
5005 c609719bSwdenk
5006 c609719bSwdenk
5007 c609719bSwdenkIf the system board that you have is not listed, then you will need
5008 c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5009 c609719bSwdenksteps:
5010 c609719bSwdenk
5011 c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
5012 4d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
5013 4d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5014 c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
5015 85ec0bccSwdenk    files you need. In your board directory, you will need at least
5016 85ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
5017 85ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
5018 85ec0bccSwdenk    your board
5019 c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5020 c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5021 ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5022 c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5023 c609719bSwdenk    to be installed on your target system.
5024 85ec0bccSwdenk6.  Debug and solve any problems that might arise.
5025 c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5026 c609719bSwdenk
5027 c609719bSwdenk
5028 c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5029 c609719bSwdenk==============================================================
5030 c609719bSwdenk
5031 c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5032 c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5033 c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5034 c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5035 218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5036 c609719bSwdenk
5037 c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5038 c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5039 c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5040 c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5041 c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
5042 7152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5043 218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5044 218ca724SWolfgang Denkyou can type
5045 c609719bSwdenk
5046 c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5047 c609719bSwdenk
5048 c609719bSwdenkor to build on a native PowerPC system you can type
5049 c609719bSwdenk
5050 c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5051 c609719bSwdenk
5052 218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5053 218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5054 218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5055 218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5056 218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5057 218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5058 218ca724SWolfgang Denkvariable. For example:
5059 baf31249SMarian Balakowicz
5060 baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5061 baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5062 baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5063 baf31249SMarian Balakowicz
5064 218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5065 218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5066 218ca724SWolfgang Denkduring the whole build process.
5067 baf31249SMarian Balakowicz
5068 baf31249SMarian Balakowicz
5069 c609719bSwdenkSee also "U-Boot Porting Guide" below.
5070 c609719bSwdenk
5071 c609719bSwdenk
5072 c609719bSwdenkMonitor Commands - Overview:
5073 c609719bSwdenk============================
5074 c609719bSwdenk
5075 c609719bSwdenkgo	- start application at address 'addr'
5076 c609719bSwdenkrun	- run commands in an environment variable
5077 c609719bSwdenkbootm	- boot application image from memory
5078 c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
5079 44f074c7SMarek Vasutbootz   - boot zImage from memory
5080 c609719bSwdenktftpboot- boot image via network using TFTP protocol
5081 c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5082 c609719bSwdenk	       (and eventually "gatewayip")
5083 1fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5084 c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5085 c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5086 c609719bSwdenkloads	- load S-Record file over serial line
5087 c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5088 c609719bSwdenkmd	- memory display
5089 c609719bSwdenkmm	- memory modify (auto-incrementing)
5090 c609719bSwdenknm	- memory modify (constant address)
5091 c609719bSwdenkmw	- memory write (fill)
5092 c609719bSwdenkcp	- memory copy
5093 c609719bSwdenkcmp	- memory compare
5094 c609719bSwdenkcrc32	- checksum calculation
5095 0f89c54bSPeter Tyseri2c	- I2C sub-system
5096 c609719bSwdenksspi	- SPI utility commands
5097 c609719bSwdenkbase	- print or set address offset
5098 c609719bSwdenkprintenv- print environment variables
5099 c609719bSwdenksetenv	- set environment variables
5100 c609719bSwdenksaveenv - save environment variables to persistent storage
5101 c609719bSwdenkprotect - enable or disable FLASH write protection
5102 c609719bSwdenkerase	- erase FLASH memory
5103 c609719bSwdenkflinfo	- print FLASH memory information
5104 10635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5105 c609719bSwdenkbdinfo	- print Board Info structure
5106 c609719bSwdenkiminfo	- print header information for application image
5107 c609719bSwdenkconinfo - print console devices and informations
5108 c609719bSwdenkide	- IDE sub-system
5109 c609719bSwdenkloop	- infinite loop on address range
5110 56523f12Swdenkloopw	- infinite write loop on address range
5111 c609719bSwdenkmtest	- simple RAM test
5112 c609719bSwdenkicache	- enable or disable instruction cache
5113 c609719bSwdenkdcache	- enable or disable data cache
5114 c609719bSwdenkreset	- Perform RESET of the CPU
5115 c609719bSwdenkecho	- echo args to console
5116 c609719bSwdenkversion - print monitor version
5117 c609719bSwdenkhelp	- print online help
5118 c609719bSwdenk?	- alias for 'help'
5119 c609719bSwdenk
5120 c609719bSwdenk
5121 c609719bSwdenkMonitor Commands - Detailed Description:
5122 c609719bSwdenk========================================
5123 c609719bSwdenk
5124 c609719bSwdenkTODO.
5125 c609719bSwdenk
5126 c609719bSwdenkFor now: just type "help <command>".
5127 c609719bSwdenk
5128 c609719bSwdenk
5129 c609719bSwdenkEnvironment Variables:
5130 c609719bSwdenk======================
5131 c609719bSwdenk
5132 c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5133 c609719bSwdenkcan be made persistent by saving to Flash memory.
5134 c609719bSwdenk
5135 c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5136 c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5137 c609719bSwdenkwithout a value can be used to delete a variable from the
5138 c609719bSwdenkenvironment. As long as you don't save the environment you are
5139 c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5140 c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5141 c609719bSwdenk
5142 c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5143 c96f86eeSWolfgang Denk
5144 c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5145 c609719bSwdenk
5146 c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5147 c609719bSwdenk
5148 c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5149 c609719bSwdenk
5150 c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5151 c609719bSwdenk
5152 c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5153 c609719bSwdenk
5154 c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5155 c609719bSwdenk
5156 7d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
5157 7d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
5158 7d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
5159 7d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
5160 7d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
5161 7d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5162 c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5163 c3624e6eSGrant Likely		  bootm_mapsize.
5164 c3624e6eSGrant Likely
5165 c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5166 c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5167 c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5168 c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5169 c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5170 c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5171 c3624e6eSGrant Likely		  used otherwise.
5172 7d721e34SBartlomiej Sieka
5173 7d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
5174 7d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
5175 7d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
5176 7d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
5177 7d721e34SBartlomiej Sieka		  environment variable.
5178 7d721e34SBartlomiej Sieka
5179 4bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
5180 4bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
5181 4bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
5182 4bae9090SBartlomiej Sieka
5183 c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5184 c609719bSwdenk		  "bootp" will just load perform a lookup of the
5185 c609719bSwdenk		  configuration from the BOOTP server, but not try to
5186 c609719bSwdenk		  load any image using TFTP
5187 c609719bSwdenk
5188 c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5189 c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5190 c609719bSwdenk		  be automatically started (by internally calling
5191 c609719bSwdenk		  "bootm")
5192 c609719bSwdenk
5193 4a6fd34bSwdenk		  If set to "no", a standalone image passed to the
5194 4a6fd34bSwdenk		  "bootm" command will be copied to the load address
5195 4a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
5196 4a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
5197 4a6fd34bSwdenk		  data.
5198 4a6fd34bSwdenk
5199 a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5200 a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5201 fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5202 fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5203 fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5204 fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5205 fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5206 fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5207 fa34f6b2SShawn Guo		  access it during the boot procedure.
5208 fa34f6b2SShawn Guo
5209 a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5210 a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5211 a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5212 a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5213 a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5214 a28afca5SDavid A. Long		  must be accessible by the kernel.
5215 a28afca5SDavid A. Long
5216 eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5217 eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5218 eea63e05SSimon Glass		  defined.
5219 eea63e05SSimon Glass
5220 17ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
5221 17ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
5222 17ea1177Swdenk		  mode (400kHZ). This environment variable is used in
5223 17ea1177Swdenk		  initialization code. So, for changes to be effective
5224 17ea1177Swdenk		  it must be saved and board must be reset.
5225 17ea1177Swdenk
5226 c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5227 c609719bSwdenk		  If this variable is not set, initrd images will be
5228 c609719bSwdenk		  copied to the highest possible address in RAM; this
5229 c609719bSwdenk		  is usually what you want since it allows for
5230 c609719bSwdenk		  maximum initrd size. If for some reason you want to
5231 c609719bSwdenk		  make sure that the initrd image is loaded below the
5232 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5233 c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5234 c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5235 c609719bSwdenk		  address to use (U-Boot will still check that it
5236 c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5237 c609719bSwdenk
5238 c609719bSwdenk		  For instance, when you have a system with 16 MB
5239 7152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5240 c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5241 c609719bSwdenk		  the "bootargs" variable. However, now you must make
5242 7152b1d0Swdenk		  sure that the initrd image is placed in the first
5243 c609719bSwdenk		  12 MB as well - this can be done with
5244 c609719bSwdenk
5245 c609719bSwdenk		  setenv initrd_high 00c00000
5246 c609719bSwdenk
5247 38b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
5248 38b99261Swdenk		  indication to U-Boot that all addresses are legal
5249 38b99261Swdenk		  for the Linux kernel, including addresses in flash
5250 38b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
5251 38b99261Swdenk		  ramdisk at all. This may be useful to reduce the
5252 38b99261Swdenk		  boot time on your system, but requires that this
5253 38b99261Swdenk		  feature is supported by your Linux kernel.
5254 38b99261Swdenk
5255 c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5256 c609719bSwdenk
5257 c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5258 dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5259 c609719bSwdenk
5260 c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5261 c609719bSwdenk
5262 c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5263 c609719bSwdenk
5264 c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5265 c609719bSwdenk
5266 c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5267 c609719bSwdenk
5268 c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5269 c609719bSwdenk
5270 e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5271 a3d991bdSwdenk
5272 e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5273 e2a53458SMike Frysinger		  For example you can do the following
5274 a3d991bdSwdenk
5275 48690d80SHeiko Schocher		  => setenv ethact FEC
5276 48690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
5277 48690d80SHeiko Schocher		  => setenv ethact SCC
5278 48690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5279 a3d991bdSwdenk
5280 e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5281 e1692577SMatthias Fuchs		  available network interfaces.
5282 e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5283 e1692577SMatthias Fuchs
5284 a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5285 a3d991bdSwdenk		  either succeed or fail without retrying.
5286 6e592385Swdenk		  When set to "once" the network operation will
5287 6e592385Swdenk		  fail when all the available network interfaces
5288 6e592385Swdenk		  are tried once without success.
5289 a3d991bdSwdenk		  Useful on scripts which control the retry operation
5290 a3d991bdSwdenk		  themselves.
5291 a3d991bdSwdenk
5292 b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5293 a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5294 8d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
5295 8d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
5296 8d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
5297 8d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
5298 8d51aacdSSimon Glass		  is silent.
5299 8d51aacdSSimon Glass
5300 28cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5301 ecb0ccd9SWolfgang Denk		  UDP source port.
5302 ecb0ccd9SWolfgang Denk
5303 28cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
5304 28cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
5305 28cb9375SWolfgang Denk
5306 c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5307 c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5308 c96f86eeSWolfgang Denk
5309 c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5310 c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5311 c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5312 c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5313 c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5314 c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5315 c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5316 c96f86eeSWolfgang Denk
5317 a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
5318 11ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5319 a3d991bdSwdenk		  VLAN tagged frames.
5320 c609719bSwdenk
5321 dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5322 dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5323 dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5324 dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5325 dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5326 dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5327 dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5328 dc0b7b0eSJason Hobbs
5329 dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5330 dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5331 dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5332 dc0b7b0eSJason Hobbs
5333 dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5334 dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5335 dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5336 dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5337 dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5338 dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5339 dc0b7b0eSJason Hobbs
5340 c609719bSwdenkThe following environment variables may be used and automatically
5341 c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5342 c609719bSwdenkdepending the information provided by your boot server:
5343 c609719bSwdenk
5344 c609719bSwdenk  bootfile	- see above
5345 c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5346 fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5347 c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5348 c609719bSwdenk  hostname	- Target hostname
5349 c609719bSwdenk  ipaddr	- see above
5350 c609719bSwdenk  netmask	- Subnet Mask
5351 c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5352 c609719bSwdenk  serverip	- see above
5353 c609719bSwdenk
5354 c609719bSwdenk
5355 c609719bSwdenkThere are two special Environment Variables:
5356 c609719bSwdenk
5357 c609719bSwdenk  serial#	- contains hardware identification information such
5358 c609719bSwdenk		  as type string and/or serial number
5359 c609719bSwdenk  ethaddr	- Ethernet address
5360 c609719bSwdenk
5361 c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5362 c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5363 c609719bSwdenkonce they have been set once.
5364 c609719bSwdenk
5365 c609719bSwdenk
5366 c1551ea8SstroeseFurther special Environment Variables:
5367 c1551ea8Sstroese
5368 c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5369 c1551ea8Sstroese		  with the "version" command. This variable is
5370 c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5371 c1551ea8Sstroese
5372 c1551ea8Sstroese
5373 c609719bSwdenkPlease note that changes to some configuration parameters may take
5374 c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5375 c609719bSwdenk
5376 c609719bSwdenk
5377 170ab110SJoe HershbergerCallback functions for environment variables:
5378 170ab110SJoe Hershberger---------------------------------------------
5379 170ab110SJoe Hershberger
5380 170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5381 170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5382 170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5383 170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5384 170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5385 170ab110SJoe Hershberger
5386 170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5387 170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5388 170ab110SJoe Hershberger
5389 170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5390 170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5391 170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5392 170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5393 170ab110SJoe Hershberger
5394 170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5395 170ab110SJoe Hershberger	list = entry[,list]
5396 170ab110SJoe Hershberger
5397 170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5398 170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5399 170ab110SJoe Hershberger
5400 170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5401 170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5402 170ab110SJoe Hershbergeroverride any association in the static list. You can define
5403 170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5404 170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5405 170ab110SJoe Hershberger
5406 170ab110SJoe Hershberger
5407 f07771ccSwdenkCommand Line Parsing:
5408 f07771ccSwdenk=====================
5409 f07771ccSwdenk
5410 f07771ccSwdenkThere are two different command line parsers available with U-Boot:
5411 7152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5412 f07771ccSwdenk
5413 f07771ccSwdenkOld, simple command line parser:
5414 f07771ccSwdenk--------------------------------
5415 f07771ccSwdenk
5416 f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5417 f07771ccSwdenk- several commands on one line, separated by ';'
5418 fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5419 f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5420 f07771ccSwdenk  for example:
5421 fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5422 f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5423 f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5424 f07771ccSwdenk
5425 f07771ccSwdenkHush shell:
5426 f07771ccSwdenk-----------
5427 f07771ccSwdenk
5428 f07771ccSwdenk- similar to Bourne shell, with control structures like
5429 f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5430 f07771ccSwdenk  until...do...done, ...
5431 f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5432 f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5433 f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5434 f07771ccSwdenk  command
5435 f07771ccSwdenk
5436 f07771ccSwdenkGeneral rules:
5437 f07771ccSwdenk--------------
5438 f07771ccSwdenk
5439 f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5440 f07771ccSwdenk    command) contains several commands separated by semicolon, and
5441 f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5442 f07771ccSwdenk    executed anyway.
5443 f07771ccSwdenk
5444 f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
5445 11ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5446 f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5447 f07771ccSwdenk    variables are not executed.
5448 f07771ccSwdenk
5449 c609719bSwdenkNote for Redundant Ethernet Interfaces:
5450 c609719bSwdenk=======================================
5451 c609719bSwdenk
5452 11ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5453 c609719bSwdenksuch configurations and is capable of automatic selection of a
5454 7152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5455 c609719bSwdenk
5456 c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5457 c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5458 c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5459 c609719bSwdenk
5460 c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5461 c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5462 c609719bSwdenkding setting in the environment; if the corresponding environment
5463 c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5464 c609719bSwdenk
5465 c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5466 c609719bSwdenk  environment, the SROM's address is used.
5467 c609719bSwdenk
5468 c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5469 c609719bSwdenk  environment exists, then the value from the environment variable is
5470 c609719bSwdenk  used.
5471 c609719bSwdenk
5472 c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5473 c609719bSwdenk  both addresses are the same, this MAC address is used.
5474 c609719bSwdenk
5475 c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5476 c609719bSwdenk  addresses differ, the value from the environment is used and a
5477 c609719bSwdenk  warning is printed.
5478 c609719bSwdenk
5479 c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5480 c609719bSwdenk  is raised.
5481 c609719bSwdenk
5482 ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5483 ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5484 ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5485 ecee9324SBen WarrenThe naming convention is as follows:
5486 ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5487 c609719bSwdenk
5488 c609719bSwdenkImage Formats:
5489 c609719bSwdenk==============
5490 c609719bSwdenk
5491 3310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
5492 3310c549SMarian Balakowiczimages in two formats:
5493 3310c549SMarian Balakowicz
5494 3310c549SMarian BalakowiczNew uImage format (FIT)
5495 3310c549SMarian Balakowicz-----------------------
5496 3310c549SMarian Balakowicz
5497 3310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
5498 3310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
5499 3310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
5500 3310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5501 3310c549SMarian Balakowicz
5502 3310c549SMarian Balakowicz
5503 3310c549SMarian BalakowiczOld uImage format
5504 3310c549SMarian Balakowicz-----------------
5505 3310c549SMarian Balakowicz
5506 3310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
5507 3310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
5508 3310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5509 c609719bSwdenk
5510 c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5511 c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5512 f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5513 f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5514 f5ed9e39SPeter Tyser  INTEGRITY).
5515 7b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5516 afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5517 afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5518 c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5519 c609719bSwdenk* Load Address
5520 c609719bSwdenk* Entry Point
5521 c609719bSwdenk* Image Name
5522 c609719bSwdenk* Image Timestamp
5523 c609719bSwdenk
5524 c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5525 c609719bSwdenkand the data portions of the image are secured against corruption by
5526 c609719bSwdenkCRC32 checksums.
5527 c609719bSwdenk
5528 c609719bSwdenk
5529 c609719bSwdenkLinux Support:
5530 c609719bSwdenk==============
5531 c609719bSwdenk
5532 c609719bSwdenkAlthough U-Boot should support any OS or standalone application
5533 7152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5534 c609719bSwdenkU-Boot.
5535 c609719bSwdenk
5536 c609719bSwdenkU-Boot includes many features that so far have been part of some
5537 c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5538 c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5539 c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
5540 7152b1d0Swdenkserves several purposes:
5541 c609719bSwdenk
5542 c609719bSwdenk- the same features can be used for other OS or standalone
5543 c609719bSwdenk  applications (for instance: using compressed images to reduce the
5544 c609719bSwdenk  Flash memory footprint)
5545 c609719bSwdenk
5546 c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
5547 7152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5548 c609719bSwdenk
5549 c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5550 c609719bSwdenk  images; of course this also means that different kernel images can
5551 c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5552 c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5553 c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5554 c609719bSwdenk  software is easier now.
5555 c609719bSwdenk
5556 c609719bSwdenk
5557 c609719bSwdenkLinux HOWTO:
5558 c609719bSwdenk============
5559 c609719bSwdenk
5560 c609719bSwdenkPorting Linux to U-Boot based systems:
5561 c609719bSwdenk---------------------------------------
5562 c609719bSwdenk
5563 c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5564 c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5565 c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5566 c609719bSwdenkLinux :-).
5567 c609719bSwdenk
5568 a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5569 c609719bSwdenk
5570 c609719bSwdenkJust make sure your machine specific header file (for instance
5571 c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
5572 1dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
5573 1dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
5574 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5575 c609719bSwdenk
5576 2eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
5577 2eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
5578 2eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
5579 2eb31b13SSimon Glassdoc/driver-model.
5580 2eb31b13SSimon Glass
5581 c609719bSwdenk
5582 c609719bSwdenkConfiguring the Linux kernel:
5583 c609719bSwdenk-----------------------------
5584 c609719bSwdenk
5585 c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5586 c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5587 c609719bSwdenk
5588 c609719bSwdenk
5589 c609719bSwdenkBuilding a Linux Image:
5590 c609719bSwdenk-----------------------
5591 c609719bSwdenk
5592 24ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
5593 24ee89b9Swdenknot used. If you use recent kernel source, a new build target
5594 24ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
5595 24ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
5596 24ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
5597 24ee89b9Swdenk100% compatible format.
5598 c609719bSwdenk
5599 c609719bSwdenkExample:
5600 c609719bSwdenk
5601 ab584d67SHolger Freyther	make TQM850L_defconfig
5602 c609719bSwdenk	make oldconfig
5603 c609719bSwdenk	make dep
5604 24ee89b9Swdenk	make uImage
5605 c609719bSwdenk
5606 24ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
5607 24ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
5608 24ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5609 c609719bSwdenk
5610 24ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
5611 24ee89b9Swdenk
5612 24ee89b9Swdenk* convert the kernel into a raw binary image:
5613 24ee89b9Swdenk
5614 24ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
5615 24ee89b9Swdenk				 -R .note -R .comment \
5616 24ee89b9Swdenk				 -S vmlinux linux.bin
5617 24ee89b9Swdenk
5618 24ee89b9Swdenk* compress the binary image:
5619 24ee89b9Swdenk
5620 24ee89b9Swdenk	gzip -9 linux.bin
5621 24ee89b9Swdenk
5622 24ee89b9Swdenk* package compressed binary image for U-Boot:
5623 24ee89b9Swdenk
5624 24ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
5625 24ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
5626 24ee89b9Swdenk		-d linux.bin.gz uImage
5627 24ee89b9Swdenk
5628 24ee89b9Swdenk
5629 24ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
5630 24ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
5631 24ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
5632 24ee89b9Swdenkbyte header containing information about target architecture,
5633 24ee89b9Swdenkoperating system, image type, compression method, entry points, time
5634 24ee89b9Swdenkstamp, CRC32 checksums, etc.
5635 24ee89b9Swdenk
5636 24ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
5637 24ee89b9Swdenkprint the header information, or to build new images.
5638 c609719bSwdenk
5639 c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5640 c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5641 c609719bSwdenkchecksum verification:
5642 c609719bSwdenk
5643 c609719bSwdenk	tools/mkimage -l image
5644 c609719bSwdenk	  -l ==> list image header information
5645 c609719bSwdenk
5646 c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5647 c609719bSwdenkfrom a "data file" which is used as image payload:
5648 c609719bSwdenk
5649 c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5650 c609719bSwdenk		      -n name -d data_file image
5651 c609719bSwdenk	  -A ==> set architecture to 'arch'
5652 c609719bSwdenk	  -O ==> set operating system to 'os'
5653 c609719bSwdenk	  -T ==> set image type to 'type'
5654 c609719bSwdenk	  -C ==> set compression type 'comp'
5655 c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5656 c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5657 c609719bSwdenk	  -n ==> set image name to 'name'
5658 c609719bSwdenk	  -d ==> use image data from 'datafile'
5659 c609719bSwdenk
5660 69459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
5661 69459791Swdenkaddress (0x00000000), but the entry point address depends on the
5662 69459791Swdenkkernel version:
5663 c609719bSwdenk
5664 c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
5665 24ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5666 c609719bSwdenk
5667 c609719bSwdenkSo a typical call to build a U-Boot image would read:
5668 c609719bSwdenk
5669 24ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5670 24ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5671 a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
5672 24ee89b9Swdenk	> examples/uImage.TQM850L
5673 24ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5674 c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5675 c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5676 c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5677 c609719bSwdenk	Load Address: 0x00000000
5678 24ee89b9Swdenk	Entry Point:  0x00000000
5679 c609719bSwdenk
5680 c609719bSwdenkTo verify the contents of the image (or check for corruption):
5681 c609719bSwdenk
5682 24ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
5683 24ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5684 c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5685 c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5686 c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5687 c609719bSwdenk	Load Address: 0x00000000
5688 24ee89b9Swdenk	Entry Point:  0x00000000
5689 c609719bSwdenk
5690 c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5691 c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5692 c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5693 c609719bSwdenkneed to be uncompressed:
5694 c609719bSwdenk
5695 a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
5696 24ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5697 24ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5698 a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
5699 24ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
5700 24ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5701 c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5702 c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5703 c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5704 c609719bSwdenk	Load Address: 0x00000000
5705 24ee89b9Swdenk	Entry Point:  0x00000000
5706 c609719bSwdenk
5707 c609719bSwdenk
5708 c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5709 c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5710 c609719bSwdenk
5711 c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5712 c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5713 c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5714 c609719bSwdenk	Image Name:   Simple Ramdisk Image
5715 c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5716 c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5717 c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5718 c609719bSwdenk	Load Address: 0x00000000
5719 c609719bSwdenk	Entry Point:  0x00000000
5720 c609719bSwdenk
5721 a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5722 a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5723 a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5724 a804b5ceSGuilherme Maciel Ferreirafrom the image:
5725 a804b5ceSGuilherme Maciel Ferreira
5726 a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5727 a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5728 a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5729 a804b5ceSGuilherme Maciel Ferreira
5730 c609719bSwdenk
5731 c609719bSwdenkInstalling a Linux Image:
5732 c609719bSwdenk-------------------------
5733 c609719bSwdenk
5734 c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5735 c609719bSwdenkyou must convert the image to S-Record format:
5736 c609719bSwdenk
5737 c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5738 c609719bSwdenk
5739 c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5740 c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5741 c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5742 c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5743 c609719bSwdenkcommand.
5744 c609719bSwdenk
5745 c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5746 c609719bSwdenkTQM8xxL is in the first Flash bank):
5747 c609719bSwdenk
5748 c609719bSwdenk	=> erase 40100000 401FFFFF
5749 c609719bSwdenk
5750 c609719bSwdenk	.......... done
5751 c609719bSwdenk	Erased 8 sectors
5752 c609719bSwdenk
5753 c609719bSwdenk	=> loads 40100000
5754 c609719bSwdenk	## Ready for S-Record download ...
5755 c609719bSwdenk	~>examples/image.srec
5756 c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5757 c609719bSwdenk	...
5758 c609719bSwdenk	15989 15990 15991 15992
5759 c609719bSwdenk	[file transfer complete]
5760 c609719bSwdenk	[connected]
5761 c609719bSwdenk	## Start Addr = 0x00000000
5762 c609719bSwdenk
5763 c609719bSwdenk
5764 c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5765 c609719bSwdenkthis includes a checksum verification so you can be sure no data
5766 c609719bSwdenkcorruption happened:
5767 c609719bSwdenk
5768 c609719bSwdenk	=> imi 40100000
5769 c609719bSwdenk
5770 c609719bSwdenk	## Checking Image at 40100000 ...
5771 c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5772 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5773 c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5774 c609719bSwdenk	   Load Address: 00000000
5775 c609719bSwdenk	   Entry Point:	 0000000c
5776 c609719bSwdenk	   Verifying Checksum ... OK
5777 c609719bSwdenk
5778 c609719bSwdenk
5779 c609719bSwdenkBoot Linux:
5780 c609719bSwdenk-----------
5781 c609719bSwdenk
5782 c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5783 c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5784 c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5785 c609719bSwdenkparameters. You can check and modify this variable using the
5786 c609719bSwdenk"printenv" and "setenv" commands:
5787 c609719bSwdenk
5788 c609719bSwdenk
5789 c609719bSwdenk	=> printenv bootargs
5790 c609719bSwdenk	bootargs=root=/dev/ram
5791 c609719bSwdenk
5792 c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5793 c609719bSwdenk
5794 c609719bSwdenk	=> printenv bootargs
5795 c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5796 c609719bSwdenk
5797 c609719bSwdenk	=> bootm 40020000
5798 c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5799 c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5800 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5801 c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5802 c609719bSwdenk	   Load Address: 00000000
5803 c609719bSwdenk	   Entry Point:	 0000000c
5804 c609719bSwdenk	   Verifying Checksum ... OK
5805 c609719bSwdenk	   Uncompressing Kernel Image ... OK
5806 c609719bSwdenk	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
5807 c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5808 c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5809 c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5810 c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5811 c609719bSwdenk	...
5812 c609719bSwdenk
5813 11ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
5814 7152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5815 c609719bSwdenkformat!) to the "bootm" command:
5816 c609719bSwdenk
5817 c609719bSwdenk	=> imi 40100000 40200000
5818 c609719bSwdenk
5819 c609719bSwdenk	## Checking Image at 40100000 ...
5820 c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5821 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5822 c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5823 c609719bSwdenk	   Load Address: 00000000
5824 c609719bSwdenk	   Entry Point:	 0000000c
5825 c609719bSwdenk	   Verifying Checksum ... OK
5826 c609719bSwdenk
5827 c609719bSwdenk	## Checking Image at 40200000 ...
5828 c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5829 c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5830 c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5831 c609719bSwdenk	   Load Address: 00000000
5832 c609719bSwdenk	   Entry Point:	 00000000
5833 c609719bSwdenk	   Verifying Checksum ... OK
5834 c609719bSwdenk
5835 c609719bSwdenk	=> bootm 40100000 40200000
5836 c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5837 c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5838 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5839 c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5840 c609719bSwdenk	   Load Address: 00000000
5841 c609719bSwdenk	   Entry Point:	 0000000c
5842 c609719bSwdenk	   Verifying Checksum ... OK
5843 c609719bSwdenk	   Uncompressing Kernel Image ... OK
5844 c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5845 c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5846 c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5847 c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5848 c609719bSwdenk	   Load Address: 00000000
5849 c609719bSwdenk	   Entry Point:	 00000000
5850 c609719bSwdenk	   Verifying Checksum ... OK
5851 c609719bSwdenk	   Loading Ramdisk ... OK
5852 c609719bSwdenk	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
5853 c609719bSwdenk	Boot arguments: root=/dev/ram
5854 c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5855 c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5856 c609719bSwdenk	...
5857 c609719bSwdenk	RAMDISK: Compressed image found at block 0
5858 c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5859 c609719bSwdenk
5860 c609719bSwdenk	bash#
5861 c609719bSwdenk
5862 0267768eSMatthew McClintockBoot Linux and pass a flat device tree:
5863 0267768eSMatthew McClintock-----------
5864 0267768eSMatthew McClintock
5865 0267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
5866 0267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
5867 0267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
5868 0267768eSMatthew McClintockflat device tree:
5869 0267768eSMatthew McClintock
5870 0267768eSMatthew McClintock=> print oftaddr
5871 0267768eSMatthew McClintockoftaddr=0x300000
5872 0267768eSMatthew McClintock=> print oft
5873 0267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
5874 0267768eSMatthew McClintock=> tftp $oftaddr $oft
5875 0267768eSMatthew McClintockSpeed: 1000, full duplex
5876 0267768eSMatthew McClintockUsing TSEC0 device
5877 0267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
5878 0267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
5879 0267768eSMatthew McClintockLoad address: 0x300000
5880 0267768eSMatthew McClintockLoading: #
5881 0267768eSMatthew McClintockdone
5882 0267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
5883 0267768eSMatthew McClintock=> tftp $loadaddr $bootfile
5884 0267768eSMatthew McClintockSpeed: 1000, full duplex
5885 0267768eSMatthew McClintockUsing TSEC0 device
5886 0267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
5887 0267768eSMatthew McClintockFilename 'uImage'.
5888 0267768eSMatthew McClintockLoad address: 0x200000
5889 0267768eSMatthew McClintockLoading:############
5890 0267768eSMatthew McClintockdone
5891 0267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
5892 0267768eSMatthew McClintock=> print loadaddr
5893 0267768eSMatthew McClintockloadaddr=200000
5894 0267768eSMatthew McClintock=> print oftaddr
5895 0267768eSMatthew McClintockoftaddr=0x300000
5896 0267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
5897 0267768eSMatthew McClintock## Booting image at 00200000 ...
5898 0267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
5899 0267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5900 0267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
5901 0267768eSMatthew McClintock   Load Address: 00000000
5902 0267768eSMatthew McClintock   Entry Point:	 00000000
5903 0267768eSMatthew McClintock   Verifying Checksum ... OK
5904 0267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
5905 0267768eSMatthew McClintockBooting using flat device tree at 0x300000
5906 0267768eSMatthew McClintockUsing MPC85xx ADS machine description
5907 0267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5908 0267768eSMatthew McClintock[snip]
5909 0267768eSMatthew McClintock
5910 0267768eSMatthew McClintock
5911 6069ff26SwdenkMore About U-Boot Image Types:
5912 6069ff26Swdenk------------------------------
5913 6069ff26Swdenk
5914 6069ff26SwdenkU-Boot supports the following image types:
5915 6069ff26Swdenk
5916 6069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
5917 6069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
5918 6069ff26Swdenk	well) you can continue to work in U-Boot after return from
5919 6069ff26Swdenk	the Standalone Program.
5920 6069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
5921 6069ff26Swdenk	will take over control completely. Usually these programs
5922 6069ff26Swdenk	will install their own set of exception handlers, device
5923 6069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
5924 6069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
5925 6069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
5926 6069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
5927 6069ff26Swdenk	being started.
5928 6069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
5929 6069ff26Swdenk	(Linux) kernel image and one or more data images like
5930 6069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
5931 6069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
5932 6069ff26Swdenk	server provides just a single image file, but you want to get
5933 6069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
5934 6069ff26Swdenk
5935 6069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
5936 6069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
5937 6069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
5938 6069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
5939 6069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
5940 6069ff26Swdenk	a multiple of 4 bytes).
5941 6069ff26Swdenk
5942 6069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
5943 6069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
5944 6069ff26Swdenk	flash memory.
5945 6069ff26Swdenk
5946 6069ff26Swdenk   "Script files" are command sequences that will be executed by
5947 6069ff26Swdenk	U-Boot's command interpreter; this feature is especially
5948 6069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
5949 6069ff26Swdenk	as command interpreter.
5950 6069ff26Swdenk
5951 44f074c7SMarek VasutBooting the Linux zImage:
5952 44f074c7SMarek Vasut-------------------------
5953 44f074c7SMarek Vasut
5954 44f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
5955 44f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
5956 44f074c7SMarek Vasutas the syntax of "bootm" command.
5957 44f074c7SMarek Vasut
5958 8ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5959 017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5960 017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5961 017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5962 017e1f3fSMarek Vasut
5963 c609719bSwdenk
5964 c609719bSwdenkStandalone HOWTO:
5965 c609719bSwdenk=================
5966 c609719bSwdenk
5967 c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5968 c609719bSwdenkrun "standalone" applications, which can use some resources of
5969 c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5970 c609719bSwdenk
5971 c609719bSwdenkTwo simple examples are included with the sources:
5972 c609719bSwdenk
5973 c609719bSwdenk"Hello World" Demo:
5974 c609719bSwdenk-------------------
5975 c609719bSwdenk
5976 c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5977 c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5978 c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5979 c609719bSwdenklike that:
5980 c609719bSwdenk
5981 c609719bSwdenk	=> loads
5982 c609719bSwdenk	## Ready for S-Record download ...
5983 c609719bSwdenk	~>examples/hello_world.srec
5984 c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5985 c609719bSwdenk	[file transfer complete]
5986 c609719bSwdenk	[connected]
5987 c609719bSwdenk	## Start Addr = 0x00040004
5988 c609719bSwdenk
5989 c609719bSwdenk	=> go 40004 Hello World! This is a test.
5990 c609719bSwdenk	## Starting application at 0x00040004 ...
5991 c609719bSwdenk	Hello World
5992 c609719bSwdenk	argc = 7
5993 c609719bSwdenk	argv[0] = "40004"
5994 c609719bSwdenk	argv[1] = "Hello"
5995 c609719bSwdenk	argv[2] = "World!"
5996 c609719bSwdenk	argv[3] = "This"
5997 c609719bSwdenk	argv[4] = "is"
5998 c609719bSwdenk	argv[5] = "a"
5999 c609719bSwdenk	argv[6] = "test."
6000 c609719bSwdenk	argv[7] = "<NULL>"
6001 c609719bSwdenk	Hit any key to exit ...
6002 c609719bSwdenk
6003 c609719bSwdenk	## Application terminated, rc = 0x0
6004 c609719bSwdenk
6005 c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6006 c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6007 c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6008 c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6009 c609719bSwdenkcharacter, but this is just a demo program. The application can be
6010 c609719bSwdenkcontrolled by the following keys:
6011 c609719bSwdenk
6012 c609719bSwdenk	? - print current values og the CPM Timer registers
6013 c609719bSwdenk	b - enable interrupts and start timer
6014 c609719bSwdenk	e - stop timer and disable interrupts
6015 c609719bSwdenk	q - quit application
6016 c609719bSwdenk
6017 c609719bSwdenk	=> loads
6018 c609719bSwdenk	## Ready for S-Record download ...
6019 c609719bSwdenk	~>examples/timer.srec
6020 c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6021 c609719bSwdenk	[file transfer complete]
6022 c609719bSwdenk	[connected]
6023 c609719bSwdenk	## Start Addr = 0x00040004
6024 c609719bSwdenk
6025 c609719bSwdenk	=> go 40004
6026 c609719bSwdenk	## Starting application at 0x00040004 ...
6027 c609719bSwdenk	TIMERS=0xfff00980
6028 c609719bSwdenk	Using timer 1
6029 c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6030 c609719bSwdenk
6031 c609719bSwdenkHit 'b':
6032 c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6033 c609719bSwdenk	Enabling timer
6034 c609719bSwdenkHit '?':
6035 c609719bSwdenk	[q, b, e, ?] ........
6036 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6037 c609719bSwdenkHit '?':
6038 c609719bSwdenk	[q, b, e, ?] .
6039 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6040 c609719bSwdenkHit '?':
6041 c609719bSwdenk	[q, b, e, ?] .
6042 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6043 c609719bSwdenkHit '?':
6044 c609719bSwdenk	[q, b, e, ?] .
6045 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6046 c609719bSwdenkHit 'e':
6047 c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6048 c609719bSwdenkHit 'q':
6049 c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6050 c609719bSwdenk
6051 c609719bSwdenk
6052 85ec0bccSwdenkMinicom warning:
6053 85ec0bccSwdenk================
6054 85ec0bccSwdenk
6055 7152b1d0SwdenkOver time, many people have reported problems when trying to use the
6056 85ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
6057 85ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6058 f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
6059 85ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6060 e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6061 e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6062 e53515a2SKarl O. Pincfor help with kermit.
6063 e53515a2SKarl O. Pinc
6064 85ec0bccSwdenk
6065 52f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
6066 52f52c14Swdenkconfiguration to your "File transfer protocols" section:
6067 52f52c14Swdenk
6068 52f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
6069 52f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
6070 52f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
6071 52f52c14Swdenk
6072 52f52c14Swdenk
6073 c609719bSwdenkNetBSD Notes:
6074 c609719bSwdenk=============
6075 c609719bSwdenk
6076 c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6077 c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6078 c609719bSwdenk
6079 c609719bSwdenkBuilding requires a cross environment; it is known to work on
6080 c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6081 c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6082 c609719bSwdenkNote that the cross-powerpc package does not install include files;
6083 c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6084 c609719bSwdenkmissing.  This file has to be installed and patched manually:
6085 c609719bSwdenk
6086 c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6087 c609719bSwdenk	# mkdir powerpc
6088 c609719bSwdenk	# ln -s powerpc machine
6089 c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6090 c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6091 c609719bSwdenk
6092 c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6093 c609719bSwdenkand U-Boot include files.
6094 c609719bSwdenk
6095 c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6096 c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6097 c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6098 c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
6099 2a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6100 c609719bSwdenk
6101 c609719bSwdenk
6102 c609719bSwdenkImplementation Internals:
6103 c609719bSwdenk=========================
6104 c609719bSwdenk
6105 c609719bSwdenkThe following is not intended to be a complete description of every
6106 c609719bSwdenkimplementation detail. However, it should help to understand the
6107 c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6108 c609719bSwdenkhardware.
6109 c609719bSwdenk
6110 c609719bSwdenk
6111 c609719bSwdenkInitial Stack, Global Data:
6112 c609719bSwdenk---------------------------
6113 c609719bSwdenk
6114 c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6115 c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6116 c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6117 c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6118 c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6119 c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6120 c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6121 c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6122 c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6123 c609719bSwdenklocked as (mis-) used as memory, etc.
6124 c609719bSwdenk
6125 7152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
6126 0668236bSWolfgang Denk	U-Boot mailing list:
6127 43d9616cSwdenk
6128 43d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6129 43d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
6130 43d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6131 43d9616cSwdenk	...
6132 43d9616cSwdenk
6133 43d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
6134 43d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
6135 43d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
6136 43d9616cSwdenk	is that the cache is being used as a temporary supply of
6137 43d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
6138 11ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
6139 43d9616cSwdenk	can see how this works by studying the cache architecture and
6140 43d9616cSwdenk	operation in the architecture and processor-specific manuals.
6141 43d9616cSwdenk
6142 43d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
6143 43d9616cSwdenk	is another option for the system designer to use as an
6144 11ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
6145 43d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
6146 43d9616cSwdenk	board designers haven't used it for something that would
6147 43d9616cSwdenk	cause you grief during the initial boot! It is frequently not
6148 43d9616cSwdenk	used.
6149 43d9616cSwdenk
6150 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
6151 43d9616cSwdenk	with your processor/board/system design. The default value
6152 43d9616cSwdenk	you will find in any recent u-boot distribution in
6153 8a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
6154 43d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
6155 43d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
6156 43d9616cSwdenk	that are supposed to respond to that address! That code in
6157 43d9616cSwdenk	start.S has been around a while and should work as is when
6158 43d9616cSwdenk	you get the config right.
6159 43d9616cSwdenk
6160 43d9616cSwdenk	-Chris Hallinan
6161 43d9616cSwdenk	DS4.COM, Inc.
6162 43d9616cSwdenk
6163 c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6164 c609719bSwdenkcode for the initialization procedures:
6165 c609719bSwdenk
6166 c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6167 c609719bSwdenk  to write it.
6168 c609719bSwdenk
6169 11ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
6170 c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
6171 7152b1d0Swdenk  zation is performed later (when relocating to RAM).
6172 c609719bSwdenk
6173 c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6174 c609719bSwdenk  that.
6175 c609719bSwdenk
6176 c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6177 c609719bSwdenknormal global data to share information beween the code. But it
6178 c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6179 c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6180 c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6181 c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6182 c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6183 c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6184 c609719bSwdenkreserve for this purpose.
6185 c609719bSwdenk
6186 7152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6187 c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6188 c609719bSwdenkGCC's implementation.
6189 c609719bSwdenk
6190 c609719bSwdenkFor PowerPC, the following registers have specific use:
6191 c609719bSwdenk	R1:	stack pointer
6192 e7670f6cSWolfgang Denk	R2:	reserved for system use
6193 c609719bSwdenk	R3-R4:	parameter passing and return values
6194 c609719bSwdenk	R5-R10: parameter passing
6195 c609719bSwdenk	R13:	small data area pointer
6196 c609719bSwdenk	R30:	GOT pointer
6197 c609719bSwdenk	R31:	frame pointer
6198 c609719bSwdenk
6199 e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6200 e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6201 e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6202 c609719bSwdenk
6203 e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6204 c609719bSwdenk
6205 c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6206 c609719bSwdenk    address of the global data structure is known at compile time),
6207 c609719bSwdenk    but it turned out that reserving a register results in somewhat
6208 c609719bSwdenk    smaller code - although the code savings are not that big (on
6209 c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6210 c609719bSwdenk    624 text + 127 data).
6211 c609719bSwdenk
6212 c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
6213 4c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6214 4c58eb55SMike Frysinger
6215 c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
6216 4c58eb55SMike Frysinger
6217 c609719bSwdenkOn ARM, the following registers are used:
6218 c609719bSwdenk
6219 c609719bSwdenk	R0:	function argument word/integer result
6220 c609719bSwdenk	R1-R3:	function argument word
6221 12eba1b4SJeroen Hofstee	R9:	platform specific
6222 12eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6223 c609719bSwdenk	R11:	argument (frame) pointer
6224 c609719bSwdenk	R12:	temporary workspace
6225 c609719bSwdenk	R13:	stack pointer
6226 c609719bSwdenk	R14:	link register
6227 c609719bSwdenk	R15:	program counter
6228 c609719bSwdenk
6229 12eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
6230 12eba1b4SJeroen Hofstee
6231 12eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6232 c609719bSwdenk
6233 0df01fd3SThomas ChouOn Nios II, the ABI is documented here:
6234 0df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6235 0df01fd3SThomas Chou
6236 0df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
6237 0df01fd3SThomas Chou
6238 0df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
6239 0df01fd3SThomas Chou    to access small data sections, so gp is free.
6240 0df01fd3SThomas Chou
6241 afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6242 afc1ce82SMacpaul Lin
6243 afc1ce82SMacpaul Lin	R0-R1:	argument/return
6244 afc1ce82SMacpaul Lin	R2-R5:	argument
6245 afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6246 afc1ce82SMacpaul Lin	R16:	trampoline register
6247 afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6248 afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6249 afc1ce82SMacpaul Lin	R30:	link register (LP)
6250 afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6251 afc1ce82SMacpaul Lin	PC:	program counter (PC)
6252 afc1ce82SMacpaul Lin
6253 afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6254 afc1ce82SMacpaul Lin
6255 d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6256 d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6257 c609719bSwdenk
6258 c609719bSwdenkMemory Management:
6259 c609719bSwdenk------------------
6260 c609719bSwdenk
6261 c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6262 c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6263 c609719bSwdenk
6264 c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6265 c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6266 c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6267 c609719bSwdenkphysical memory banks.
6268 c609719bSwdenk
6269 c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6270 c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6271 c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6272 c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
6273 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6274 c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6275 c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6276 c609719bSwdenk
6277 c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6278 c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6279 c609719bSwdenk
6280 c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6281 c609719bSwdenkthis:
6282 c609719bSwdenk
6283 c609719bSwdenk	0x0000 0000	Exception Vector code
6284 c609719bSwdenk	      :
6285 c609719bSwdenk	0x0000 1FFF
6286 c609719bSwdenk	0x0000 2000	Free for Application Use
6287 c609719bSwdenk	      :
6288 c609719bSwdenk	      :
6289 c609719bSwdenk
6290 c609719bSwdenk	      :
6291 c609719bSwdenk	      :
6292 c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6293 c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6294 c609719bSwdenk	0x00FC 0000	Malloc Arena
6295 c609719bSwdenk	      :
6296 c609719bSwdenk	0x00FD FFFF
6297 c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6298 c609719bSwdenk	...		eventually: LCD or video framebuffer
6299 c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6300 c609719bSwdenk	0x00FF FFFF	[End of RAM]
6301 c609719bSwdenk
6302 c609719bSwdenk
6303 c609719bSwdenkSystem Initialization:
6304 c609719bSwdenk----------------------
6305 c609719bSwdenk
6306 c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
6307 11ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6308 c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
6309 7152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6310 c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6311 c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6312 c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6313 c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6314 c609719bSwdenkthe caches and the SIU.
6315 c609719bSwdenk
6316 c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6317 c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6318 c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6319 c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6320 c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6321 c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6322 c609719bSwdenkbanks.
6323 c609719bSwdenk
6324 c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
6325 7152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6326 c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6327 c609719bSwdenk0x00000000, with any additional banks following immediately to create
6328 c609719bSwdenkcontiguous memory starting from 0.
6329 c609719bSwdenk
6330 c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6331 c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6332 c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6333 c609719bSwdenkpages, and the final stack is set up.
6334 c609719bSwdenk
6335 c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6336 c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6337 c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6338 c609719bSwdenknew address in RAM.
6339 c609719bSwdenk
6340 c609719bSwdenk
6341 c609719bSwdenkU-Boot Porting Guide:
6342 c609719bSwdenk----------------------
6343 c609719bSwdenk
6344 c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6345 6aff3115Swdenklist, October 2002]
6346 c609719bSwdenk
6347 c609719bSwdenk
6348 c609719bSwdenkint main(int argc, char *argv[])
6349 c609719bSwdenk{
6350 c609719bSwdenk	sighandler_t no_more_time;
6351 c609719bSwdenk
6352 c609719bSwdenk	signal(SIGALRM, no_more_time);
6353 c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6354 c609719bSwdenk
6355 c609719bSwdenk	if (available_money > available_manpower) {
6356 6c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6357 c609719bSwdenk		return 0;
6358 c609719bSwdenk	}
6359 c609719bSwdenk
6360 c609719bSwdenk	Download latest U-Boot source;
6361 c609719bSwdenk
6362 0668236bSWolfgang Denk	Subscribe to u-boot mailing list;
6363 6aff3115Swdenk
6364 6c3fef28SJerry Van Baren	if (clueless)
6365 c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6366 c609719bSwdenk
6367 c609719bSwdenk	while (learning) {
6368 c609719bSwdenk		Read the README file in the top level directory;
6369 7cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6370 6c3fef28SJerry Van Baren		Read applicable doc/*.README;
6371 c609719bSwdenk		Read the source, Luke;
6372 6c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6373 c609719bSwdenk	}
6374 c609719bSwdenk
6375 6c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
6376 6c3fef28SJerry Van Baren		Buy a BDI3000;
6377 6c3fef28SJerry Van Baren	else
6378 c609719bSwdenk		Add a lot of aggravation and time;
6379 c609719bSwdenk
6380 6c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
6381 6c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
6382 6c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
6383 6c3fef28SJerry Van Baren	} else {
6384 c609719bSwdenk		Create your own board support subdirectory;
6385 6c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
6386 6c3fef28SJerry Van Baren	}
6387 6c3fef28SJerry Van Baren	Edit new board/<myboard> files
6388 6c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6389 c609719bSwdenk
6390 6c3fef28SJerry Van Baren	while (!accepted) {
6391 c609719bSwdenk		while (!running) {
6392 c609719bSwdenk			do {
6393 c609719bSwdenk				Add / modify source code;
6394 c609719bSwdenk			} until (compiles);
6395 c609719bSwdenk			Debug;
6396 c609719bSwdenk			if (clueless)
6397 c609719bSwdenk				email("Hi, I am having problems...");
6398 c609719bSwdenk		}
6399 6c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
6400 6c3fef28SJerry Van Baren		if (reasonable critiques)
6401 6c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
6402 6c3fef28SJerry Van Baren		else
6403 6c3fef28SJerry Van Baren			Defend code as written;
6404 6c3fef28SJerry Van Baren	}
6405 c609719bSwdenk
6406 c609719bSwdenk	return 0;
6407 c609719bSwdenk}
6408 c609719bSwdenk
6409 c609719bSwdenkvoid no_more_time (int sig)
6410 c609719bSwdenk{
6411 c609719bSwdenk      hire_a_guru();
6412 c609719bSwdenk}
6413 c609719bSwdenk
6414 c609719bSwdenk
6415 c609719bSwdenkCoding Standards:
6416 c609719bSwdenk-----------------
6417 c609719bSwdenk
6418 c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
6419 2c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
6420 7ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6421 c609719bSwdenk
6422 2c051651SDetlev ZundelSource files originating from a different project (for example the
6423 2c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6424 2c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
6425 2c051651SDetlev Zundelsources.
6426 2c051651SDetlev Zundel
6427 2c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
6428 2c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
6429 2c051651SDetlev Zundelin your code.
6430 c609719bSwdenk
6431 c178d3daSwdenkPlease also stick to the following formatting rules:
6432 180d3f74Swdenk- remove any trailing white space
6433 7ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6434 180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
6435 7ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6436 180d3f74Swdenk- do not add trailing empty lines to source files
6437 180d3f74Swdenk
6438 c609719bSwdenkSubmissions which do not conform to the standards may be returned
6439 c609719bSwdenkwith a request to reformat the changes.
6440 c609719bSwdenk
6441 c609719bSwdenk
6442 c609719bSwdenkSubmitting Patches:
6443 c609719bSwdenk-------------------
6444 c609719bSwdenk
6445 c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6446 c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6447 c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6448 c609719bSwdenk
6449 0d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6450 218ca724SWolfgang Denk
6451 0668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6452 0668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
6453 0668236bSWolfgang Denk
6454 c609719bSwdenkWhen you send a patch, please include the following information with
6455 c609719bSwdenkit:
6456 c609719bSwdenk
6457 c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6458 c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6459 c609719bSwdenk  patch actually fixes something.
6460 c609719bSwdenk
6461 c609719bSwdenk* For new features: a description of the feature and your
6462 c609719bSwdenk  implementation.
6463 c609719bSwdenk
6464 c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6465 c609719bSwdenk
6466 c609719bSwdenk* For major contributions, your entry to the CREDITS file
6467 c609719bSwdenk
6468 27af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
6469 27af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6470 c609719bSwdenk
6471 c609719bSwdenk* If your patch adds new configuration options, don't forget to
6472 c609719bSwdenk  document these in the README file.
6473 c609719bSwdenk
6474 218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6475 218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
6476 7ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6477 218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6478 218ca724SWolfgang Denk  with some other mail clients.
6479 c609719bSwdenk
6480 218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6481 218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6482 218ca724SWolfgang Denk  GNU diff.
6483 6dff5529Swdenk
6484 218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6485 218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6486 218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6487 218ca724SWolfgang Denk  affected files).
6488 218ca724SWolfgang Denk
6489 218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6490 218ca724SWolfgang Denk  and compressed attachments must not be used.
6491 c609719bSwdenk
6492 52f52c14Swdenk* If one logical set of modifications affects or creates several
6493 52f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
6494 52f52c14Swdenk
6495 52f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
6496 52f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
6497 52f52c14Swdenk
6498 52f52c14Swdenk
6499 c609719bSwdenkNotes:
6500 c609719bSwdenk
6501 c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6502 c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6503 c609719bSwdenk  for any of the boards.
6504 c609719bSwdenk
6505 c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6506 c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6507 c609719bSwdenk  returned with a request to re-formatting / split it.
6508 c609719bSwdenk
6509 c609719bSwdenk* If you modify existing code, make sure that your new code does not
6510 c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6511 c609719bSwdenk  When adding new features, these should compile conditionally only
6512 c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6513 c609719bSwdenk  disabled must not need more memory than the old code without your
6514 c609719bSwdenk  modification.
6515 90dc6704Swdenk
6516 0668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
6517 0668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
6518 0668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
6519 0668236bSWolfgang Denk  bigger than the size limit should be avoided.
6520