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