blob: 3547ead07adeca20b023cd60f85d3ebbcc732ab2 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD48e910f2013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denkb240aef2008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denkb240aef2008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmannd9a9d562011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500184 /cpu CPU specific files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
Robert P. J. Daya269c932013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-04-12 22:28:21 -0500223/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000224
wdenkc6097192002-11-03 00:24:07 +0000225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200240 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200253configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000254
255Example: For a TQM823L module type:
256
257 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freyther7ba4e572014-08-04 09:26:05 +0200261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000262directory according to the instructions in cogent/README.
263
264
Simon Glass53552c92014-03-22 17:12:59 -0600265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600274
275
Simon Glassd8711af2015-03-03 08:03:00 -0700276Board Initialisation Flow:
277--------------------------
278
279This is the intended start-up flow for boards. This should apply for both
280SPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281mostly uses a separate code path, but the funtion names and roles of each
282function are the same. Some boards or architectures may not conform to this.
283At least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284
285Execution starts with start.S with three functions called during init after
286that. The purpose and limitations of each is described below.
287
288lowlevel_init():
289 - purpose: essential init to permit execution to reach board_init_f()
290 - no global_data or BSS
291 - there is no stack (ARMv7 may have one but it will soon be removed)
292 - must not set up SDRAM or use console
293 - must only do the bare minimum to allow execution to continue to
294 board_init_f()
295 - this is almost never needed
296 - return normally from this function
297
298board_init_f():
299 - purpose: set up the machine ready for running board_init_r():
300 i.e. SDRAM and serial UART
301 - global_data is available
302 - stack is in SRAM
303 - BSS is not available, so you cannot use global/static variables,
304 only stack variables and global_data
305
306 Non-SPL-specific notes:
307 - dram_init() is called to set up DRAM. If already done in SPL this
308 can do nothing
309
310 SPL-specific notes:
311 - you can override the entire board_init_f() function with your own
312 version as needed.
313 - preloader_console_init() can be called here in extremis
314 - should set up SDRAM, and anything needed to make the UART work
315 - these is no need to clear BSS, it will be done by crt0.S
316 - must return normally from this function (don't call board_init_r()
317 directly)
318
319Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320this point the stack and global_data are relocated to below
321CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322memory.
323
324board_init_r():
325 - purpose: main execution, common code
326 - global_data is available
327 - SDRAM is available
328 - BSS is available, all static/global variables can be used
329 - execution eventually continues to main_loop()
330
331 Non-SPL-specific notes:
332 - U-Boot is relocated to the top of memory and is now running from
333 there.
334
335 SPL-specific notes:
336 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337 CONFIG_SPL_STACK_R_ADDR points into SDRAM
338 - preloader_console_init() can be called here - typically this is
339 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340 spl_board_init() function containing this call
341 - loads U-Boot or (in falcon mode) Linux
342
343
344
wdenkc6097192002-11-03 00:24:07 +0000345Configuration Options:
346----------------------
347
348Configuration depends on the combination of board and CPU type; all
349such information is kept in a configuration file
350"include/configs/<board_name>.h".
351
352Example: For a TQM823L module, all configuration settings are in
353"include/configs/TQM823L.h".
354
355
wdenk1272e232002-11-10 22:06:23 +0000356Many of the options are named exactly as the corresponding Linux
357kernel configuration options. The intention is to make it easier to
358build a config tool - later.
359
360
wdenkc6097192002-11-03 00:24:07 +0000361The following options need to be configured:
362
Kim Phillips203fee32007-08-10 13:28:25 -0500363- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000364
Kim Phillips203fee32007-08-10 13:28:25 -0500365- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200366
367- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100368 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000369
370- CPU Module Type: (if CONFIG_COGENT is defined)
371 Define exactly one of
372 CONFIG_CMA286_60_OLD
373--- FIXME --- not tested yet:
374 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375 CONFIG_CMA287_23, CONFIG_CMA287_50
376
377- Motherboard Type: (if CONFIG_COGENT is defined)
378 Define exactly one of
379 CONFIG_CMA101, CONFIG_CMA102
380
381- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382 Define one or more of
383 CONFIG_CMA302
384
385- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386 Define one or more of
387 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200388 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000389 a "rotator" |\-/|\-/
390
Lei Wen20014762011-02-09 18:06:58 +0530391- Marvell Family Member
392 CONFIG_SYS_MVFS - define it if you want to enable
393 multiple fs option at one time
394 for marvell soc family
395
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200396- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000397 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
398 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000399 e.g. if there is no 32KHz
400 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000401 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
402 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000403
wdenk20bddb32004-09-28 17:59:53 +0000404- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200405 CONFIG_SYS_8xx_CPUCLK_MIN
406 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000407 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000408 See doc/README.MPC866
409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200410 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000411
wdenk544e9732004-02-06 23:19:44 +0000412 Define this to measure the actual CPU clock instead
413 of relying on the correctness of the configured
414 values. Mostly useful for board bringup to make sure
415 the PLL is locked at the intended frequency. Note
416 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200417 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000418
Heiko Schocher734f0272009-03-12 07:37:15 +0100419 CONFIG_SYS_DELAYED_ICACHE
420
421 Define this option if you want to enable the
422 ICache only when Code runs from RAM.
423
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600424- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000425 CONFIG_SYS_PPC64
426
427 Specifies that the core is a 64-bit PowerPC implementation (implements
428 the "64" category of the Power ISA). This is necessary for ePAPR
429 compliance, among other possible reasons.
430
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600431 CONFIG_SYS_FSL_TBCLK_DIV
432
433 Defines the core time base clock divider ratio compared to the
434 system clock. On most PQ3 devices this is 8, on newer QorIQ
435 devices it can be 16 or 32. The ratio varies from SoC to Soc.
436
Kumar Gala179b1b22011-05-20 00:39:21 -0500437 CONFIG_SYS_FSL_PCIE_COMPAT
438
439 Defines the string to utilize when trying to match PCIe device
440 tree nodes for the given platform.
441
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000442 CONFIG_SYS_PPC_E500_DEBUG_TLB
443
444 Enables a temporary TLB entry to be used during boot to work
445 around limitations in e500v1 and e500v2 external debugger
446 support. This reduces the portions of the boot code where
447 breakpoints and single stepping do not work. The value of this
448 symbol should be set to the TLB1 entry to be used for this
449 purpose.
450
Scott Wood80806962012-08-14 10:14:53 +0000451 CONFIG_SYS_FSL_ERRATUM_A004510
452
453 Enables a workaround for erratum A004510. If set,
454 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
455 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
456
457 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
458 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
459
460 Defines one or two SoC revisions (low 8 bits of SVR)
461 for which the A004510 workaround should be applied.
462
463 The rest of SVR is either not relevant to the decision
464 of whether the erratum is present (e.g. p2040 versus
465 p2041) or is implied by the build target, which controls
466 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
467
468 See Freescale App Note 4493 for more information about
469 this erratum.
470
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530471 CONFIG_A003399_NOR_WORKAROUND
472 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800473 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530474
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530475 CONFIG_A008044_WORKAROUND
476 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800477 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530478
Scott Wood80806962012-08-14 10:14:53 +0000479 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
480
481 This is the value to write into CCSR offset 0x18600
482 according to the A004510 workaround.
483
Priyanka Jainc73b9032013-07-02 09:21:04 +0530484 CONFIG_SYS_FSL_DSP_DDR_ADDR
485 This value denotes start offset of DDR memory which is
486 connected exclusively to the DSP cores.
487
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530488 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489 This value denotes start offset of M2 memory
490 which is directly connected to the DSP core.
491
Priyanka Jainc73b9032013-07-02 09:21:04 +0530492 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
493 This value denotes start offset of M3 memory which is directly
494 connected to the DSP core.
495
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530496 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497 This value denotes start offset of DSP CCSR space.
498
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530499 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500 Single Source Clock is clocking mode present in some of FSL SoC's.
501 In this mode, a single differential clock is used to supply
502 clocks to the sysclock, ddrclock and usbclock.
503
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530504 CONFIG_SYS_CPC_REINIT_F
505 This CONFIG is defined when the CPC is configured as SRAM at the
506 time of U-boot entry and is required to be re-initialized.
507
Tang Yuantiana7364af2014-04-17 15:33:46 +0800508 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800509 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800510 supported, core will start to execute uboot when wakes up.
511
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000512- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700513 CONFIG_SYS_GENERIC_GLOBAL_DATA
514 Defines global data is initialized in generic board board_init_f().
515 If this macro is defined, global data is created and cleared in
516 generic board board_init_f(). Without this macro, architecture/board
517 should initialize global data before calling board_init_f().
518
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000519 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
520
521 Defines the endianess of the CPU. Implementation of those
522 values is arch specific.
523
York Sunf0626592013-09-30 09:22:09 -0700524 CONFIG_SYS_FSL_DDR
525 Freescale DDR driver in use. This type of DDR controller is
526 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
527 SoCs.
528
529 CONFIG_SYS_FSL_DDR_ADDR
530 Freescale DDR memory-mapped register base.
531
532 CONFIG_SYS_FSL_DDR_EMU
533 Specify emulator support for DDR. Some DDR features such as
534 deskew training are not available.
535
536 CONFIG_SYS_FSL_DDRC_GEN1
537 Freescale DDR1 controller.
538
539 CONFIG_SYS_FSL_DDRC_GEN2
540 Freescale DDR2 controller.
541
542 CONFIG_SYS_FSL_DDRC_GEN3
543 Freescale DDR3 controller.
544
York Sun2896cb72014-03-27 17:54:47 -0700545 CONFIG_SYS_FSL_DDRC_GEN4
546 Freescale DDR4 controller.
547
York Sun461c9392013-09-30 14:20:51 -0700548 CONFIG_SYS_FSL_DDRC_ARM_GEN3
549 Freescale DDR3 controller for ARM-based SoCs.
550
York Sunf0626592013-09-30 09:22:09 -0700551 CONFIG_SYS_FSL_DDR1
552 Board config to use DDR1. It can be enabled for SoCs with
553 Freescale DDR1 or DDR2 controllers, depending on the board
554 implemetation.
555
556 CONFIG_SYS_FSL_DDR2
557 Board config to use DDR2. It can be eanbeld for SoCs with
558 Freescale DDR2 or DDR3 controllers, depending on the board
559 implementation.
560
561 CONFIG_SYS_FSL_DDR3
562 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700563 Freescale DDR3 or DDR3L controllers.
564
565 CONFIG_SYS_FSL_DDR3L
566 Board config to use DDR3L. It can be enabled for SoCs with
567 DDR3L controllers.
568
569 CONFIG_SYS_FSL_DDR4
570 Board config to use DDR4. It can be enabled for SoCs with
571 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700572
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530573 CONFIG_SYS_FSL_IFC_BE
574 Defines the IFC controller register space as Big Endian
575
576 CONFIG_SYS_FSL_IFC_LE
577 Defines the IFC controller register space as Little Endian
578
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530579 CONFIG_SYS_FSL_PBL_PBI
580 It enables addition of RCW (Power on reset configuration) in built image.
581 Please refer doc/README.pblimage for more details
582
583 CONFIG_SYS_FSL_PBL_RCW
584 It adds PBI(pre-boot instructions) commands in u-boot build image.
585 PBI commands can be used to configure SoC before it starts the execution.
586 Please refer doc/README.pblimage for more details
587
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530588 CONFIG_SPL_FSL_PBL
589 It adds a target to create boot binary having SPL binary in PBI format
590 concatenated with u-boot binary.
591
York Sun29647ab2014-02-10 13:59:42 -0800592 CONFIG_SYS_FSL_DDR_BE
593 Defines the DDR controller register space as Big Endian
594
595 CONFIG_SYS_FSL_DDR_LE
596 Defines the DDR controller register space as Little Endian
597
York Sun3a0916d2014-02-10 13:59:43 -0800598 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
599 Physical address from the view of DDR controllers. It is the
600 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
601 it could be different for ARM SoCs.
602
York Sunc459ae62014-02-10 13:59:44 -0800603 CONFIG_SYS_FSL_DDR_INTLV_256B
604 DDR controller interleaving on 256-byte. This is a special
605 interleaving mode, handled by Dickens for Freescale layerscape
606 SoCs with ARM core.
607
York Sun79a779b2014-08-01 15:51:00 -0700608 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
609 Number of controllers used as main memory.
610
611 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
612 Number of controllers used for other than main memory.
613
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530614 CONFIG_SYS_FSL_SEC_BE
615 Defines the SEC controller register space as Big Endian
616
617 CONFIG_SYS_FSL_SEC_LE
618 Defines the SEC controller register space as Little Endian
619
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100620- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200621 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100622
623 Defines the Monahans run mode to oscillator
624 ratio. Valid values are 8, 16, 24, 31. The core
625 frequency is this value multiplied by 13 MHz.
626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200627 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200628
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100629 Defines the Monahans turbo mode to oscillator
630 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200631 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100632 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200633
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200634- MIPS CPU options:
635 CONFIG_SYS_INIT_SP_OFFSET
636
637 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
638 pointer. This is needed for the temporary stack before
639 relocation.
640
641 CONFIG_SYS_MIPS_CACHE_MODE
642
643 Cache operation mode for the MIPS CPU.
644 See also arch/mips/include/asm/mipsregs.h.
645 Possible values are:
646 CONF_CM_CACHABLE_NO_WA
647 CONF_CM_CACHABLE_WA
648 CONF_CM_UNCACHED
649 CONF_CM_CACHABLE_NONCOHERENT
650 CONF_CM_CACHABLE_CE
651 CONF_CM_CACHABLE_COW
652 CONF_CM_CACHABLE_CUW
653 CONF_CM_CACHABLE_ACCELERATED
654
655 CONFIG_SYS_XWAY_EBU_BOOTCFG
656
657 Special option for Lantiq XWAY SoCs for booting from NOR flash.
658 See also arch/mips/cpu/mips32/start.S.
659
660 CONFIG_XWAY_SWAP_BYTES
661
662 Enable compilation of tools/xway-swap-bytes needed for Lantiq
663 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
664 be swapped if a flash programmer is used.
665
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000666- ARM options:
667 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668
669 Select high exception vectors of the ARM core, e.g., do not
670 clear the V bit of the c1 register of CP15.
671
Aneesh Vb8e40802012-03-08 07:20:19 +0000672 CONFIG_SYS_THUMB_BUILD
673
674 Use this flag to build U-Boot using the Thumb instruction
675 set for ARM architectures. Thumb instruction set provides
676 better code density. For ARM architectures that support
677 Thumb2 this flag will result in Thumb2 code generated by
678 GCC.
679
Stephen Warrenc63c3502013-03-04 13:29:40 +0000680 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000681 CONFIG_ARM_ERRATA_742230
682 CONFIG_ARM_ERRATA_743622
683 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500684 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500685 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000686
687 If set, the workarounds for these ARM errata are applied early
688 during U-Boot startup. Note that these options force the
689 workarounds to be applied; no CPU-type/version detection
690 exists, unlike the similar options in the Linux kernel. Do not
691 set these options unless they apply!
692
Simon Glass9fa901b2014-11-10 17:16:54 -0700693- Driver Model
694 Driver model is a new framework for devices in U-Boot
695 introduced in early 2014. U-Boot is being progressively
696 moved over to this. It offers a consistent device structure,
697 supports grouping devices into classes and has built-in
698 handling of platform data and device tree.
699
700 To enable transition to driver model in a relatively
701 painful fashion, each subsystem can be independently
702 switched between the legacy/ad-hoc approach and the new
703 driver model using the options below. Also, many uclass
704 interfaces include compatibility features which may be
705 removed once the conversion of that subsystem is complete.
706 As a result, the API provided by the subsystem may in fact
707 not change with driver model.
708
709 See doc/driver-model/README.txt for more information.
710
711 CONFIG_DM
712
713 Enable driver model. This brings in the core support,
714 including scanning of platform data on start-up. If
715 CONFIG_OF_CONTROL is enabled, the device tree will be
716 scanned also when available.
717
718 CONFIG_CMD_DM
719
720 Enable driver model test commands. These allow you to print
721 out the driver model tree and the uclasses.
722
723 CONFIG_DM_DEMO
724
725 Enable some demo devices and the 'demo' command. These are
726 really only useful for playing around while trying to
727 understand driver model in sandbox.
728
729 CONFIG_SPL_DM
730
731 Enable driver model in SPL. You will need to provide a
732 suitable malloc() implementation. If you are not using the
733 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
734 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
735 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
736 In most cases driver model will only allocate a few uclasses
737 and devices in SPL, so 1KB should be enable. See
738 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
739 it.
740
741 CONFIG_DM_SERIAL
742
743 Enable driver model for serial. This replaces
744 drivers/serial/serial.c with the serial uclass, which
745 implements serial_putc() etc. The uclass interface is
746 defined in include/serial.h.
747
748 CONFIG_DM_GPIO
749
750 Enable driver model for GPIO access. The standard GPIO
751 interface (gpio_get_value(), etc.) is then implemented by
752 the GPIO uclass. Drivers provide methods to query the
753 particular GPIOs that they provide. The uclass interface
754 is defined in include/asm-generic/gpio.h.
755
756 CONFIG_DM_SPI
757
758 Enable driver model for SPI. The SPI slave interface
759 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
760 the SPI uclass. Drivers provide methods to access the SPI
761 buses that they control. The uclass interface is defined in
762 include/spi.h. The existing spi_slave structure is attached
763 as 'parent data' to every slave on each bus. Slaves
764 typically use driver-private data instead of extending the
765 spi_slave structure.
766
767 CONFIG_DM_SPI_FLASH
768
769 Enable driver model for SPI flash. This SPI flash interface
770 (spi_flash_probe(), spi_flash_write(), etc.) is then
771 implemented by the SPI flash uclass. There is one standard
772 SPI flash driver which knows how to probe most chips
773 supported by U-Boot. The uclass interface is defined in
774 include/spi_flash.h, but is currently fully compatible
775 with the old interface to avoid confusion and duplication
776 during the transition parent. SPI and SPI flash must be
777 enabled together (it is not possible to use driver model
778 for one and not the other).
779
780 CONFIG_DM_CROS_EC
781
782 Enable driver model for the Chrome OS EC interface. This
783 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
784 but otherwise makes few changes. Since cros_ec also supports
785 I2C and LPC (which don't support driver model yet), a full
786 conversion is not yet possible.
787
788
789 ** Code size options: The following options are enabled by
790 default except in SPL. Enable them explicitly to get these
791 features in SPL.
792
793 CONFIG_DM_WARN
794
795 Enable the dm_warn() function. This can use up quite a bit
796 of space for its strings.
797
798 CONFIG_DM_STDIO
799
800 Enable registering a serial device with the stdio library.
801
802 CONFIG_DM_DEVICE_REMOVE
803
804 Enable removing of devices.
805
806
wdenk9b7f3842003-10-09 20:09:04 +0000807- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000808 CONFIG_CLOCKS_IN_MHZ
809
810 U-Boot stores all clock information in Hz
811 internally. For binary compatibility with older Linux
812 kernels (which expect the clocks passed in the
813 bd_info data to be in MHz) the environment variable
814 "clocks_in_mhz" can be defined so that U-Boot
815 converts clock data to MHZ before passing it to the
816 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000817 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100818 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000819 default environment.
820
wdenk9b7f3842003-10-09 20:09:04 +0000821 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
822
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800823 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000824 expect it to be in bytes, others in MB.
825 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
826
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400827 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200828
829 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400830 passed using flattened device trees (based on open firmware
831 concepts).
832
833 CONFIG_OF_LIBFDT
834 * New libfdt-based support
835 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500836 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400837
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200838 OF_CPU - The proper name of the cpus node (only required for
839 MPC512X and MPC5xxx based boards).
840 OF_SOC - The proper name of the soc node (only required for
841 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200842 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600843 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200844
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200845 boards with QUICC Engines require OF_QE to set UCC MAC
846 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500847
Kumar Gala1e26aa52006-01-11 13:54:17 -0600848 CONFIG_OF_BOARD_SETUP
849
850 Board code has addition modification that it wants to make
851 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000852
Simon Glass6c0be912014-10-23 18:58:54 -0600853 CONFIG_OF_SYSTEM_SETUP
854
855 Other code has addition modification that it wants to make
856 to the flat device tree before handing it off to the kernel.
857 This causes ft_system_setup() to be called before booting
858 the kernel.
859
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500860 CONFIG_OF_BOOT_CPU
861
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200862 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500863 param header, the default value is zero if undefined.
864
Heiko Schocherffb293a2009-09-23 07:56:08 +0200865 CONFIG_OF_IDE_FIXUP
866
867 U-Boot can detect if an IDE device is present or not.
868 If not, and this new config option is activated, U-Boot
869 removes the ATA node from the DTS before booting Linux,
870 so the Linux IDE driver does not probe the device and
871 crash. This is needed for buggy hardware (uc101) where
872 no pull down resistor is connected to the signal IDE5V_DD7.
873
Igor Grinberg06890672011-07-14 05:45:07 +0000874 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
875
876 This setting is mandatory for all boards that have only one
877 machine type and must be used to specify the machine type
878 number as it appears in the ARM machine registry
879 (see http://www.arm.linux.org.uk/developer/machines/).
880 Only boards that have multiple machine types supported
881 in a single configuration file and the machine type is
882 runtime discoverable, do not have to use this setting.
883
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100884- vxWorks boot parameters:
885
886 bootvx constructs a valid bootline using the following
887 environments variables: bootfile, ipaddr, serverip, hostname.
888 It loads the vxWorks image pointed bootfile.
889
890 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
891 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
892 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
893 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
894
895 CONFIG_SYS_VXWORKS_ADD_PARAMS
896
897 Add it at the end of the bootline. E.g "u=username pw=secret"
898
899 Note: If a "bootargs" environment is defined, it will overwride
900 the defaults discussed just above.
901
Aneesh V960f5c02011-06-16 23:30:47 +0000902- Cache Configuration:
903 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
904 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
905 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
906
Aneesh V686a0752011-06-16 23:30:51 +0000907- Cache Configuration for ARM:
908 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
909 controller
910 CONFIG_SYS_PL310_BASE - Physical base address of PL310
911 controller register space
912
wdenkda04a8b2004-08-02 23:22:59 +0000913- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200914 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000915
916 Define this if you want support for Amba PrimeCell PL010 UARTs.
917
Andreas Engel0813b122008-09-08 14:30:53 +0200918 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000919
920 Define this if you want support for Amba PrimeCell PL011 UARTs.
921
922 CONFIG_PL011_CLOCK
923
924 If you have Amba PrimeCell PL011 UARTs, set this variable to
925 the clock speed of the UARTs.
926
927 CONFIG_PL01x_PORTS
928
929 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
930 define this to a list of base addresses for each (supported)
931 port. See e.g. include/configs/versatile.h
932
John Rigby34e21ee2011-04-19 10:42:39 +0000933 CONFIG_PL011_SERIAL_RLCR
934
935 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
936 have separate receive and transmit line control registers. Set
937 this variable to initialize the extra register.
938
939 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
940
941 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
942 boot loader that has already initialized the UART. Define this
943 variable to flush the UART at init time.
944
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400945 CONFIG_SERIAL_HW_FLOW_CONTROL
946
947 Define this variable to enable hw flow control in serial driver.
948 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000949
wdenkc6097192002-11-03 00:24:07 +0000950- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000951 Depending on board, define exactly one serial port
952 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
953 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
954 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000955
956 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
957 port routines must be defined elsewhere
958 (i.e. serial_init(), serial_getc(), ...)
959
960 CONFIG_CFB_CONSOLE
961 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000962 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000963 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
964 (default big endian)
965 VIDEO_HW_RECTFILL graphic chip supports
966 rectangle fill
967 (cf. smiLynxEM)
968 VIDEO_HW_BITBLT graphic chip supports
969 bit-blit (cf. smiLynxEM)
970 VIDEO_VISIBLE_COLS visible pixel columns
971 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000972 VIDEO_VISIBLE_ROWS visible pixel rows
973 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000974 VIDEO_DATA_FORMAT graphic data format
975 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000976 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000977 VIDEO_KBD_INIT_FCT keyboard int fct
978 (i.e. i8042_kbd_init())
979 VIDEO_TSTC_FCT test char fct
980 (i.e. i8042_tstc)
981 VIDEO_GETC_FCT get char fct
982 (i.e. i8042_getc)
983 CONFIG_CONSOLE_CURSOR cursor drawing on/off
984 (requires blink timer
985 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200986 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000987 CONFIG_CONSOLE_TIME display time/date info in
988 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500989 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000990 CONFIG_VIDEO_LOGO display Linux logo in
991 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000992 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
993 linux_logo.h for logo.
994 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000995 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200996 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000997 the logo
998
Pali Rohár4a57da32012-10-19 13:30:09 +0000999 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
1000 a limited number of ANSI escape sequences (cursor control,
1001 erase functions and limited graphics rendition control).
1002
wdenk4a5c8a72003-03-06 00:02:04 +00001003 When CONFIG_CFB_CONSOLE is defined, video console is
1004 default i/o. Serial console can be forced with
1005 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +00001006
wdenk1ebf41e2004-01-02 14:00:00 +00001007 When CONFIG_SILENT_CONSOLE is defined, all console
1008 messages (by U-Boot and Linux!) can be silenced with
1009 the "silent" environment variable. See
1010 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +00001011
Heiko Schocher62759562013-10-22 11:06:06 +02001012 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
1013 is 0x00.
1014 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
1015 is 0xa0.
1016
wdenkc6097192002-11-03 00:24:07 +00001017- Console Baudrate:
1018 CONFIG_BAUDRATE - in bps
1019 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001020 CONFIG_SYS_BAUDRATE_TABLE, see below.
1021 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +00001022
Heiko Schocher327480a2009-01-30 12:55:38 +01001023- Console Rx buffer length
1024 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
1025 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +01001026 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +01001027 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
1028 must be defined, to setup the maximum idle timeout for
1029 the SMC.
1030
Graeme Russ3c28f482011-09-01 00:48:27 +00001031- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001032 Prior to the console being initialised (i.e. serial UART
1033 initialised etc) all console output is silently discarded.
1034 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
1035 buffer any console messages prior to the console being
1036 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
1037 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
1038 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +02001039 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001040 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +00001041
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001042 'Sane' compilers will generate smaller code if
1043 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +00001044
Sonny Raocd55bde2011-11-02 09:52:08 +00001045- Safe printf() functions
1046 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
1047 the printf() functions. These are defined in
1048 include/vsprintf.h and include snprintf(), vsnprintf() and
1049 so on. Code size increase is approximately 300-500 bytes.
1050 If this option is not given then these functions will
1051 silently discard their buffer size argument - this means
1052 you are not getting any overflow checking in this case.
1053
wdenkc6097192002-11-03 00:24:07 +00001054- Boot Delay: CONFIG_BOOTDELAY - in seconds
1055 Delay before automatically booting the default image;
1056 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +00001057 set to -2 to autoboot with no delay and not check for abort
1058 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +00001059
1060 See doc/README.autoboot for these options that
1061 work with CONFIG_BOOTDELAY. None are required.
1062 CONFIG_BOOT_RETRY_TIME
1063 CONFIG_BOOT_RETRY_MIN
1064 CONFIG_AUTOBOOT_KEYED
1065 CONFIG_AUTOBOOT_PROMPT
1066 CONFIG_AUTOBOOT_DELAY_STR
1067 CONFIG_AUTOBOOT_STOP_STR
1068 CONFIG_AUTOBOOT_DELAY_STR2
1069 CONFIG_AUTOBOOT_STOP_STR2
1070 CONFIG_ZERO_BOOTDELAY_CHECK
1071 CONFIG_RESET_TO_RETRY
1072
1073- Autoboot Command:
1074 CONFIG_BOOTCOMMAND
1075 Only needed when CONFIG_BOOTDELAY is enabled;
1076 define a command string that is automatically executed
1077 when no character is read on the console interface
1078 within "Boot Delay" after reset.
1079
1080 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +00001081 This can be used to pass arguments to the bootm
1082 command. The value of CONFIG_BOOTARGS goes into the
1083 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001084
1085 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +00001086 The value of these goes into the environment as
1087 "ramboot" and "nfsboot" respectively, and can be used
1088 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001089 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001090
Heiko Schocher040c5c32013-11-04 14:04:59 +01001091- Bootcount:
1092 CONFIG_BOOTCOUNT_LIMIT
1093 Implements a mechanism for detecting a repeating reboot
1094 cycle, see:
1095 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1096
1097 CONFIG_BOOTCOUNT_ENV
1098 If no softreset save registers are found on the hardware
1099 "bootcount" is stored in the environment. To prevent a
1100 saveenv on all reboots, the environment variable
1101 "upgrade_available" is used. If "upgrade_available" is
1102 0, "bootcount" is always 0, if "upgrade_available" is
1103 1 "bootcount" is incremented in the environment.
1104 So the Userspace Applikation must set the "upgrade_available"
1105 and "bootcount" variable to 0, if a boot was successfully.
1106
wdenkc6097192002-11-03 00:24:07 +00001107- Pre-Boot Commands:
1108 CONFIG_PREBOOT
1109
1110 When this option is #defined, the existence of the
1111 environment variable "preboot" will be checked
1112 immediately before starting the CONFIG_BOOTDELAY
1113 countdown and/or running the auto-boot command resp.
1114 entering interactive mode.
1115
1116 This feature is especially useful when "preboot" is
1117 automatically generated or modified. For an example
1118 see the LWMON board specific code: here "preboot" is
1119 modified when the user holds down a certain
1120 combination of keys on the (special) keyboard when
1121 booting the systems
1122
1123- Serial Download Echo Mode:
1124 CONFIG_LOADS_ECHO
1125 If defined to 1, all characters received during a
1126 serial download (using the "loads" command) are
1127 echoed back. This might be needed by some terminal
1128 emulations (like "cu"), but may as well just take
1129 time on others. This setting #define's the initial
1130 value of the "loads_echo" environment variable.
1131
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001132- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001133 CONFIG_KGDB_BAUDRATE
1134 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001135 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001136
1137- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001138 Monitor commands can be included or excluded
1139 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001140 <config_cmd_all.h> and #undef'ing unwanted
1141 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001142 and augmenting with additional #define's
1143 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001144
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001145 The default command configuration includes all commands
1146 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001147
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001148 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001149 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001150 CONFIG_CMD_BDI bdinfo
1151 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1152 CONFIG_CMD_BMP * BMP support
1153 CONFIG_CMD_BSP * Board specific commands
1154 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001155 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001156 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001157 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001158 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001159 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001160 CONFIG_CMD_DATE * support for RTC, date/time...
1161 CONFIG_CMD_DHCP * DHCP support
1162 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001163 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1164 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1165 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1166 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001167 CONFIG_CMD_DTT * Digital Therm and Thermostat
1168 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001169 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001170 CONFIG_CMD_EEPROM * EEPROM read/write support
1171 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001172 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001173 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001174 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001175 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001176 CONFIG_CMD_EXT2 * ext2 command support
1177 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001178 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1179 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001180 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001181 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001182 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001183 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001184 CONFIG_CMD_FLASH flinfo, erase, protect
1185 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001186 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001187 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001188 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001189 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001190 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001191 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1192 CONFIG_CMD_I2C * I2C serial bus support
1193 CONFIG_CMD_IDE * IDE harddisk support
1194 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001195 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001196 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001197 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001198 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001199 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001200 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001201 CONFIG_CMD_IRQ * irqinfo
1202 CONFIG_CMD_ITEST Integer/string test of 2 values
1203 CONFIG_CMD_JFFS2 * JFFS2 Support
1204 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001205 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001206 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1207 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001208 CONFIG_CMD_LOADB loadb
1209 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001210 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001211 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001212 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001213 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001214 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001215 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001216 CONFIG_CMD_MISC Misc functions like sleep etc
1217 CONFIG_CMD_MMC * MMC memory mapped support
1218 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001219 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001220 CONFIG_CMD_NAND * NAND support
1221 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001222 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001223 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001224 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001225 CONFIG_CMD_PCI * pciinfo
1226 CONFIG_CMD_PCMCIA * PCMCIA support
1227 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1228 host
1229 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001230 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001231 CONFIG_CMD_REGINFO * Register dump
1232 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001233 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001234 CONFIG_CMD_SAVES * save S record dump
1235 CONFIG_CMD_SCSI * SCSI Support
1236 CONFIG_CMD_SDRAM * print SDRAM configuration information
1237 (requires CONFIG_CMD_I2C)
1238 CONFIG_CMD_SETGETDCR Support for DCR Register access
1239 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001240 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001241 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001242 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001243 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001244 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001245 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001246 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001247 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001248 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1249 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001250 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001251 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001252 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001253 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001254 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001255
1256 EXAMPLE: If you want all functions except of network
1257 support you can write:
1258
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001259 #include "config_cmd_all.h"
1260 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001261
Gerald Van Barend6abef42007-03-31 12:23:51 -04001262 Other Commands:
1263 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001264
1265 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001266 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001267 what you (and your U-Boot users) are doing. Data
1268 cache cannot be enabled on systems like the 8xx or
1269 8260 (where accesses to the IMMR region must be
1270 uncached), and it cannot be disabled on all other
1271 systems where we (mis-) use the data cache to hold an
1272 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001273
1274
1275 XXX - this list needs to get updated!
1276
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001277- Regular expression support:
1278 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001279 If this variable is defined, U-Boot is linked against
1280 the SLRE (Super Light Regular Expression) library,
1281 which adds regex support to some commands, as for
1282 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001283
Simon Glass3d686442011-10-15 05:48:20 +00001284- Device tree:
1285 CONFIG_OF_CONTROL
1286 If this variable is defined, U-Boot will use a device tree
1287 to configure its devices, instead of relying on statically
1288 compiled #defines in the board file. This option is
1289 experimental and only available on a few boards. The device
1290 tree is available in the global data as gd->fdt_blob.
1291
Simon Glass5cb34db2011-10-24 19:15:31 +00001292 U-Boot needs to get its device tree from somewhere. This can
1293 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001294
1295 CONFIG_OF_EMBED
1296 If this variable is defined, U-Boot will embed a device tree
1297 binary in its image. This device tree file should be in the
1298 board directory and called <soc>-<board>.dts. The binary file
1299 is then picked up in board_init_f() and made available through
1300 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001301
Simon Glass5cb34db2011-10-24 19:15:31 +00001302 CONFIG_OF_SEPARATE
1303 If this variable is defined, U-Boot will build a device tree
1304 binary. It will be called u-boot.dtb. Architecture-specific
1305 code will locate it at run-time. Generally this works by:
1306
1307 cat u-boot.bin u-boot.dtb >image.bin
1308
1309 and in fact, U-Boot does this for you, creating a file called
1310 u-boot-dtb.bin which is useful in the common case. You can
1311 still use the individual files if you need something more
1312 exotic.
1313
wdenkc6097192002-11-03 00:24:07 +00001314- Watchdog:
1315 CONFIG_WATCHDOG
1316 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001317 support for the SoC. There must be support in the SoC
1318 specific code for a watchdog. For the 8xx and 8260
1319 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1320 register. When supported for a specific SoC is
1321 available, then no further board specific code should
1322 be needed to use it.
1323
1324 CONFIG_HW_WATCHDOG
1325 When using a watchdog circuitry external to the used
1326 SoC, then define this variable and provide board
1327 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001328
Heiko Schocher735326c2015-01-21 08:38:22 +01001329 CONFIG_AT91_HW_WDT_TIMEOUT
1330 specify the timeout in seconds. default 2 seconds.
1331
stroeseb9c17c52003-04-04 15:53:41 +00001332- U-Boot Version:
1333 CONFIG_VERSION_VARIABLE
1334 If this variable is defined, an environment variable
1335 named "ver" is created by U-Boot showing the U-Boot
1336 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001337 Any change to this variable will be reverted at the
1338 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001339
wdenkc6097192002-11-03 00:24:07 +00001340- Real-Time Clock:
1341
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001342 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001343 has to be selected, too. Define exactly one of the
1344 following options:
1345
1346 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1347 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001348 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001349 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001350 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001351 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001352 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001353 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001354 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001355 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001356 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001357 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001358 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1359 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001360
wdenkb9bbd242003-06-30 16:24:52 +00001361 Note that if the RTC uses I2C, then the I2C interface
1362 must also be configured. See I2C Support, below.
1363
Peter Tyser9902e422008-12-17 16:36:21 -06001364- GPIO Support:
1365 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001366
Chris Packham9b383202010-12-19 10:12:13 +00001367 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1368 chip-ngpio pairs that tell the PCA953X driver the number of
1369 pins supported by a particular chip.
1370
Peter Tyser9902e422008-12-17 16:36:21 -06001371 Note that if the GPIO device uses I2C, then the I2C interface
1372 must also be configured. See I2C Support, below.
1373
Simon Glass4dc47ca2014-06-11 23:29:41 -06001374- I/O tracing:
1375 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1376 accesses and can checksum them or write a list of them out
1377 to memory. See the 'iotrace' command for details. This is
1378 useful for testing device drivers since it can confirm that
1379 the driver behaves the same way before and after a code
1380 change. Currently this is supported on sandbox and arm. To
1381 add support for your architecture, add '#include <iotrace.h>'
1382 to the bottom of arch/<arch>/include/asm/io.h and test.
1383
1384 Example output from the 'iotrace stats' command is below.
1385 Note that if the trace buffer is exhausted, the checksum will
1386 still continue to operate.
1387
1388 iotrace is enabled
1389 Start: 10000000 (buffer start address)
1390 Size: 00010000 (buffer size)
1391 Offset: 00000120 (current buffer offset)
1392 Output: 10000120 (start + offset)
1393 Count: 00000018 (number of trace records)
1394 CRC32: 9526fb66 (CRC32 of all trace records)
1395
wdenkc6097192002-11-03 00:24:07 +00001396- Timestamp Support:
1397
wdenk4a5c8a72003-03-06 00:02:04 +00001398 When CONFIG_TIMESTAMP is selected, the timestamp
1399 (date and time) of an image is printed by image
1400 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001401 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001402
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001403- Partition Labels (disklabels) Supported:
1404 Zero or more of the following:
1405 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1406 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1407 Intel architecture, USB sticks, etc.
1408 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1409 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1410 bootloader. Note 2TB partition limit; see
1411 disk/part_efi.c
1412 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001413
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001414 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1415 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001416 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001417
1418- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001419 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1420 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001421
wdenk369d43d2004-03-14 14:09:05 +00001422 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1423 be performed by calling the function
1424 ide_set_reset(int reset)
1425 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001426
1427- ATAPI Support:
1428 CONFIG_ATAPI
1429
1430 Set this to enable ATAPI support.
1431
wdenkf602aa02004-03-13 23:29:43 +00001432- LBA48 Support
1433 CONFIG_LBA48
1434
1435 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001436 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001437 Whithout these , LBA48 support uses 32bit variables and will 'only'
1438 support disks up to 2.1TB.
1439
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001440 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001441 When enabled, makes the IDE subsystem use 64bit sector addresses.
1442 Default is 32bit.
1443
wdenkc6097192002-11-03 00:24:07 +00001444- SCSI Support:
1445 At the moment only there is only support for the
1446 SYM53C8XX SCSI controller; define
1447 CONFIG_SCSI_SYM53C8XX to enable it.
1448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001449 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1450 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1451 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001452 maximum numbers of LUNs, SCSI ID's and target
1453 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001454 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001455
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001456 The environment variable 'scsidevs' is set to the number of
1457 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001458
wdenkc6097192002-11-03 00:24:07 +00001459- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001460 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001461 Support for Intel 8254x/8257x gigabit chips.
1462
1463 CONFIG_E1000_SPI
1464 Utility code for direct access to the SPI bus on Intel 8257x.
1465 This does not do anything useful unless you set at least one
1466 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1467
1468 CONFIG_E1000_SPI_GENERIC
1469 Allow generic access to the SPI bus on the Intel 8257x, for
1470 example with the "sspi" command.
1471
1472 CONFIG_CMD_E1000
1473 Management command for E1000 devices. When used on devices
1474 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001475
Andre Schwarz68c2a302008-03-06 16:45:44 +01001476 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001477 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001478
wdenkc6097192002-11-03 00:24:07 +00001479 CONFIG_EEPRO100
1480 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001481 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001482 write routine for first time initialisation.
1483
1484 CONFIG_TULIP
1485 Support for Digital 2114x chips.
1486 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1487 modem chip initialisation (KS8761/QS6611).
1488
1489 CONFIG_NATSEMI
1490 Support for National dp83815 chips.
1491
1492 CONFIG_NS8382X
1493 Support for National dp8382[01] gigabit chips.
1494
wdenkaa603362003-05-12 21:50:16 +00001495- NETWORK Support (other):
1496
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001497 CONFIG_DRIVER_AT91EMAC
1498 Support for AT91RM9200 EMAC.
1499
1500 CONFIG_RMII
1501 Define this to use reduced MII inteface
1502
1503 CONFIG_DRIVER_AT91EMAC_QUIET
1504 If this defined, the driver is quiet.
1505 The driver doen't show link status messages.
1506
Rob Herringc9830dc2011-12-15 11:15:49 +00001507 CONFIG_CALXEDA_XGMAC
1508 Support for the Calxeda XGMAC device
1509
Ashok93fb8722012-10-15 06:20:47 +00001510 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001511 Support for SMSC's LAN91C96 chips.
1512
1513 CONFIG_LAN91C96_BASE
1514 Define this to hold the physical address
1515 of the LAN91C96's I/O space
1516
1517 CONFIG_LAN91C96_USE_32_BIT
1518 Define this to enable 32 bit addressing
1519
Ashok93fb8722012-10-15 06:20:47 +00001520 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001521 Support for SMSC's LAN91C111 chip
1522
1523 CONFIG_SMC91111_BASE
1524 Define this to hold the physical address
1525 of the device (I/O space)
1526
1527 CONFIG_SMC_USE_32_BIT
1528 Define this if data bus is 32 bits
1529
1530 CONFIG_SMC_USE_IOFUNCS
1531 Define this to use i/o functions instead of macros
1532 (some hardware wont work with macros)
1533
Heiko Schocher7d037f72011-11-15 10:00:04 -05001534 CONFIG_DRIVER_TI_EMAC
1535 Support for davinci emac
1536
1537 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1538 Define this if you have more then 3 PHYs.
1539
Macpaul Lin199c6252010-12-21 16:59:46 +08001540 CONFIG_FTGMAC100
1541 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1542
1543 CONFIG_FTGMAC100_EGIGA
1544 Define this to use GE link update with gigabit PHY.
1545 Define this if FTGMAC100 is connected to gigabit PHY.
1546 If your system has 10/100 PHY only, it might not occur
1547 wrong behavior. Because PHY usually return timeout or
1548 useless data when polling gigabit status and gigabit
1549 control registers. This behavior won't affect the
1550 correctnessof 10/100 link speed update.
1551
Mike Rapoportf4761af2009-11-11 10:03:03 +02001552 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001553 Support for SMSC's LAN911x and LAN921x chips
1554
Mike Rapoportf4761af2009-11-11 10:03:03 +02001555 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001556 Define this to hold the physical address
1557 of the device (I/O space)
1558
Mike Rapoportf4761af2009-11-11 10:03:03 +02001559 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001560 Define this if data bus is 32 bits
1561
Mike Rapoportf4761af2009-11-11 10:03:03 +02001562 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001563 Define this if data bus is 16 bits. If your processor
1564 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001565 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001566
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001567 CONFIG_SH_ETHER
1568 Support for Renesas on-chip Ethernet controller
1569
1570 CONFIG_SH_ETHER_USE_PORT
1571 Define the number of ports to be used
1572
1573 CONFIG_SH_ETHER_PHY_ADDR
1574 Define the ETH PHY's address
1575
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001576 CONFIG_SH_ETHER_CACHE_WRITEBACK
1577 If this option is set, the driver enables cache flush.
1578
Heiko Schocher2b387762014-07-18 06:07:19 +02001579- PWM Support:
1580 CONFIG_PWM_IMX
1581 Support for PWM modul on the imx6.
1582
Vadim Bendeburydac69642011-10-17 08:36:14 +00001583- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001584 CONFIG_TPM
1585 Support TPM devices.
1586
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001587 CONFIG_TPM_TIS_I2C
1588 Support for i2c bus TPM devices. Only one device
1589 per system is supported at this time.
1590
1591 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1592 Define the the i2c bus number for the TPM device
1593
1594 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1595 Define the TPM's address on the i2c bus
1596
1597 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1598 Define the burst count bytes upper limit
1599
Dirk Eibach20489092013-06-26 15:55:15 +02001600 CONFIG_TPM_ATMEL_TWI
1601 Support for Atmel TWI TPM device. Requires I2C support.
1602
Che-liang Chiouacea5702013-04-12 11:04:34 +00001603 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001604 Support for generic parallel port TPM devices. Only one device
1605 per system is supported at this time.
1606
1607 CONFIG_TPM_TIS_BASE_ADDRESS
1608 Base address where the generic TPM device is mapped
1609 to. Contemporary x86 systems usually map it at
1610 0xfed40000.
1611
Reinhard Pfau4fece432013-06-26 15:55:13 +02001612 CONFIG_CMD_TPM
1613 Add tpm monitor functions.
1614 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1615 provides monitor access to authorized functions.
1616
1617 CONFIG_TPM
1618 Define this to enable the TPM support library which provides
1619 functional interfaces to some TPM commands.
1620 Requires support for a TPM device.
1621
1622 CONFIG_TPM_AUTH_SESSIONS
1623 Define this to enable authorized functions in the TPM library.
1624 Requires CONFIG_TPM and CONFIG_SHA1.
1625
wdenkc6097192002-11-03 00:24:07 +00001626- USB Support:
1627 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001628 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001629 CONFIG_USB_UHCI to enable it.
1630 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001631 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001632 storage devices.
1633 Note:
1634 Supported are USB Keyboards and USB Floppy drives
1635 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001636 MPC5200 USB requires additional defines:
1637 CONFIG_USB_CLOCK
1638 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001639 CONFIG_PSC3_USB
1640 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001641 CONFIG_USB_CONFIG
1642 for differential drivers: 0x00001000
1643 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001644 for differential drivers on PSC3: 0x00000100
1645 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001646 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001647 May be defined to allow interrupt polling
1648 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001649
Simon Glass5978cdb2012-02-27 10:52:47 +00001650 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1651 txfilltuning field in the EHCI controller on reset.
1652
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001653 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1654 HW module registers.
1655
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001656- USB Device:
1657 Define the below if you wish to use the USB console.
1658 Once firmware is rebuilt from a serial console issue the
1659 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001660 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001661 it has found a new device. The environment variable usbtty
1662 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001663 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001664 Common Device Class Abstract Control Model serial device.
1665 If you select usbtty = gserial you should be able to enumerate
1666 a Linux host by
1667 # modprobe usbserial vendor=0xVendorID product=0xProductID
1668 else if using cdc_acm, simply setting the environment
1669 variable usbtty to be cdc_acm should suffice. The following
1670 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001671
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001672 CONFIG_USB_DEVICE
1673 Define this to build a UDC device
1674
1675 CONFIG_USB_TTY
1676 Define this to have a tty type of device available to
1677 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001678
Vipin KUMARbdb17702012-03-26 15:38:06 +05301679 CONFIG_USBD_HS
1680 Define this to enable the high speed support for usb
1681 device and usbtty. If this feature is enabled, a routine
1682 int is_usbd_high_speed(void)
1683 also needs to be defined by the driver to dynamically poll
1684 whether the enumeration has succeded at high speed or full
1685 speed.
1686
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001687 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001688 Define this if you want stdin, stdout &/or stderr to
1689 be set to usbtty.
1690
1691 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001692 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001693 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001694 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001695
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001696 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001697 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001698 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001699
Wolfgang Denke2601822006-06-14 18:14:56 +02001700 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001701 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001702 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001703 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1704 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1705 should pretend to be a Linux device to it's target host.
1706
1707 CONFIG_USBD_MANUFACTURER
1708 Define this string as the name of your company for
1709 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001710
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001711 CONFIG_USBD_PRODUCT_NAME
1712 Define this string as the name of your product
1713 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001714
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001715 CONFIG_USBD_VENDORID
1716 Define this as your assigned Vendor ID from the USB
1717 Implementors Forum. This *must* be a genuine Vendor ID
1718 to avoid polluting the USB namespace.
1719 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001720
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001721 CONFIG_USBD_PRODUCTID
1722 Define this as the unique Product ID
1723 for your device
1724 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001725
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001726- ULPI Layer Support:
1727 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1728 the generic ULPI layer. The generic layer accesses the ULPI PHY
1729 via the platform viewport, so you need both the genric layer and
1730 the viewport enabled. Currently only Chipidea/ARC based
1731 viewport is supported.
1732 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1733 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001734 If your ULPI phy needs a different reference clock than the
1735 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1736 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001737
wdenk7a428cc2003-06-15 22:40:42 +00001738- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001739 The MMC controller on the Intel PXA is supported. To
1740 enable this define CONFIG_MMC. The MMC can be
1741 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001742 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001743 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1744 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001745
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001746 CONFIG_SH_MMCIF
1747 Support for Renesas on-chip MMCIF controller
1748
1749 CONFIG_SH_MMCIF_ADDR
1750 Define the base address of MMCIF registers
1751
1752 CONFIG_SH_MMCIF_CLK
1753 Define the clock frequency for MMCIF
1754
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001755 CONFIG_GENERIC_MMC
1756 Enable the generic MMC driver
1757
1758 CONFIG_SUPPORT_EMMC_BOOT
1759 Enable some additional features of the eMMC boot partitions.
1760
1761 CONFIG_SUPPORT_EMMC_RPMB
1762 Enable the commands for reading, writing and programming the
1763 key for the Replay Protection Memory Block partition in eMMC.
1764
Tom Rini58a8d322013-03-14 05:32:47 +00001765- USB Device Firmware Update (DFU) class support:
1766 CONFIG_DFU_FUNCTION
1767 This enables the USB portion of the DFU USB class
1768
1769 CONFIG_CMD_DFU
1770 This enables the command "dfu" which is used to have
1771 U-Boot create a DFU class device via USB. This command
1772 requires that the "dfu_alt_info" environment variable be
1773 set and define the alt settings to expose to the host.
1774
1775 CONFIG_DFU_MMC
1776 This enables support for exposing (e)MMC devices via DFU.
1777
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001778 CONFIG_DFU_NAND
1779 This enables support for exposing NAND devices via DFU.
1780
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301781 CONFIG_DFU_RAM
1782 This enables support for exposing RAM via DFU.
1783 Note: DFU spec refer to non-volatile memory usage, but
1784 allow usages beyond the scope of spec - here RAM usage,
1785 one that would help mostly the developer.
1786
Heiko Schochera2f831e2013-06-12 06:05:51 +02001787 CONFIG_SYS_DFU_DATA_BUF_SIZE
1788 Dfu transfer uses a buffer before writing data to the
1789 raw storage device. Make the size (in bytes) of this buffer
1790 configurable. The size of this buffer is also configurable
1791 through the "dfu_bufsiz" environment variable.
1792
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001793 CONFIG_SYS_DFU_MAX_FILE_SIZE
1794 When updating files rather than the raw storage device,
1795 we use a static buffer to copy the file into and then write
1796 the buffer once we've been given the whole file. Define
1797 this to the maximum filesize (in bytes) for the buffer.
1798 Default is 4 MiB if undefined.
1799
Heiko Schochere1ba1512014-03-18 08:09:56 +01001800 DFU_DEFAULT_POLL_TIMEOUT
1801 Poll timeout [ms], is the timeout a device can send to the
1802 host. The host must wait for this timeout before sending
1803 a subsequent DFU_GET_STATUS request to the device.
1804
1805 DFU_MANIFEST_POLL_TIMEOUT
1806 Poll timeout [ms], which the device sends to the host when
1807 entering dfuMANIFEST state. Host waits this timeout, before
1808 sending again an USB request to the device.
1809
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001810- USB Device Android Fastboot support:
1811 CONFIG_CMD_FASTBOOT
1812 This enables the command "fastboot" which enables the Android
1813 fastboot mode for the platform's USB device. Fastboot is a USB
1814 protocol for downloading images, flashing and device control
1815 used on Android devices.
1816 See doc/README.android-fastboot for more information.
1817
1818 CONFIG_ANDROID_BOOT_IMAGE
1819 This enables support for booting images which use the Android
1820 image format header.
1821
1822 CONFIG_USB_FASTBOOT_BUF_ADDR
1823 The fastboot protocol requires a large memory buffer for
1824 downloads. Define this to the starting RAM address to use for
1825 downloaded images.
1826
1827 CONFIG_USB_FASTBOOT_BUF_SIZE
1828 The fastboot protocol requires a large memory buffer for
1829 downloads. This buffer should be as large as possible for a
1830 platform. Define this to the size available RAM for fastboot.
1831
Steve Raebfb9ba42014-08-26 11:47:28 -07001832 CONFIG_FASTBOOT_FLASH
1833 The fastboot protocol includes a "flash" command for writing
1834 the downloaded image to a non-volatile storage device. Define
1835 this to enable the "fastboot flash" command.
1836
1837 CONFIG_FASTBOOT_FLASH_MMC_DEV
1838 The fastboot "flash" command requires additional information
1839 regarding the non-volatile storage device. Define this to
1840 the eMMC device that fastboot should use to store the image.
1841
Steve Rae7d059342014-12-12 15:51:54 -08001842 CONFIG_FASTBOOT_GPT_NAME
1843 The fastboot "flash" command supports writing the downloaded
1844 image to the Protective MBR and the Primary GUID Partition
1845 Table. (Additionally, this downloaded image is post-processed
1846 to generate and write the Backup GUID Partition Table.)
1847 This occurs when the specified "partition name" on the
1848 "fastboot flash" command line matches this value.
1849 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1850
wdenkda04a8b2004-08-02 23:22:59 +00001851- Journaling Flash filesystem support:
1852 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1853 CONFIG_JFFS2_NAND_DEV
1854 Define these for a default partition on a NAND device
1855
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001856 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1857 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001858 Define these for a default partition on a NOR device
1859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001860 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001861 Define this to create an own partition. You have to provide a
1862 function struct part_info* jffs2_part_info(int part_num)
1863
1864 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001865 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001866 to disable the command chpart. This is the default when you
1867 have not defined a custom partition
1868
Donggeun Kim8f814002011-10-24 21:15:28 +00001869- FAT(File Allocation Table) filesystem write function support:
1870 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001871
1872 Define this to enable support for saving memory data as a
1873 file in FAT formatted partition.
1874
1875 This will also enable the command "fatwrite" enabling the
1876 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001877
Gabe Black7f8574c2012-10-12 14:26:11 +00001878CBFS (Coreboot Filesystem) support
1879 CONFIG_CMD_CBFS
1880
1881 Define this to enable support for reading from a Coreboot
1882 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1883 and cbfsload.
1884
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301885- FAT(File Allocation Table) filesystem cluster size:
1886 CONFIG_FS_FAT_MAX_CLUSTSIZE
1887
1888 Define the max cluster size for fat operations else
1889 a default value of 65536 will be defined.
1890
wdenkc6097192002-11-03 00:24:07 +00001891- Keyboard Support:
1892 CONFIG_ISA_KEYBOARD
1893
1894 Define this to enable standard (PC-Style) keyboard
1895 support
1896
1897 CONFIG_I8042_KBD
1898 Standard PC keyboard driver with US (is default) and
1899 GERMAN key layout (switch via environment 'keymap=de') support.
1900 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1901 for cfb_console. Supports cursor blinking.
1902
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001903 CONFIG_CROS_EC_KEYB
1904 Enables a Chrome OS keyboard using the CROS_EC interface.
1905 This uses CROS_EC to communicate with a second microcontroller
1906 which provides key scans on request.
1907
wdenkc6097192002-11-03 00:24:07 +00001908- Video support:
1909 CONFIG_VIDEO
1910
1911 Define this to enable video support (for output to
1912 video).
1913
1914 CONFIG_VIDEO_CT69000
1915
1916 Enable Chips & Technologies 69000 Video chip
1917
1918 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001919 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001920 video output is selected via environment 'videoout'
1921 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1922 assumed.
wdenkc6097192002-11-03 00:24:07 +00001923
wdenkd3602132004-03-25 15:14:43 +00001924 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001925 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001926 are possible:
1927 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001928 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001929
1930 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1931 -------------+---------------------------------------------
1932 8 bits | 0x301* 0x303 0x305 0x161 0x307
1933 15 bits | 0x310 0x313 0x316 0x162 0x319
1934 16 bits | 0x311 0x314 0x317 0x163 0x31A
1935 24 bits | 0x312 0x315 0x318 ? 0x31B
1936 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001937 (i.e. setenv videomode 317; saveenv; reset;)
1938
wdenkd3602132004-03-25 15:14:43 +00001939 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001940 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001941
1942
stroeseb9c17c52003-04-04 15:53:41 +00001943 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001944 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001945 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1946 or CONFIG_VIDEO_SED13806_16BPP
1947
Timur Tabi020edd22011-02-15 17:09:19 -06001948 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001949 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001950 SOCs that have a DIU should define this macro to enable DIU
1951 support, and should also define these other macros:
1952
1953 CONFIG_SYS_DIU_ADDR
1954 CONFIG_VIDEO
1955 CONFIG_CMD_BMP
1956 CONFIG_CFB_CONSOLE
1957 CONFIG_VIDEO_SW_CURSOR
1958 CONFIG_VGA_AS_SINGLE_DEVICE
1959 CONFIG_VIDEO_LOGO
1960 CONFIG_VIDEO_BMP_LOGO
1961
Timur Tabi32f709e2011-04-11 14:18:22 -05001962 The DIU driver will look for the 'video-mode' environment
1963 variable, and if defined, enable the DIU as a console during
1964 boot. See the documentation file README.video for a
1965 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001966
Simon Glass54df8ce2012-12-03 13:59:47 +00001967 CONFIG_VIDEO_VGA
1968
1969 Enable the VGA video / BIOS for x86. The alternative if you
1970 are using coreboot is to use the coreboot frame buffer
1971 driver.
1972
1973
wdenk4e112c12003-06-03 23:54:09 +00001974- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001975 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001976
wdenk57b2d802003-06-27 21:31:46 +00001977 Define this to enable a custom keyboard support.
1978 This simply calls drv_keyboard_init() which must be
1979 defined in your board-specific files.
1980 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001981
wdenkc6097192002-11-03 00:24:07 +00001982- LCD Support: CONFIG_LCD
1983
1984 Define this to enable LCD support (for output to LCD
1985 display); also select one of the supported displays
1986 by defining one of these:
1987
Stelian Popf6f86652008-05-09 21:57:18 +02001988 CONFIG_ATMEL_LCD:
1989
1990 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1991
wdenkc0d54ae2003-11-25 16:55:19 +00001992 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001993
wdenkc0d54ae2003-11-25 16:55:19 +00001994 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001995
wdenkc0d54ae2003-11-25 16:55:19 +00001996 CONFIG_NEC_NL6448BC20
1997
1998 NEC NL6448BC20-08. 6.5", 640x480.
1999 Active, color, single scan.
2000
2001 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00002002
wdenkc0d54ae2003-11-25 16:55:19 +00002003 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00002004 Active, color, single scan.
2005
2006 CONFIG_SHARP_16x9
2007
2008 Sharp 320x240. Active, color, single scan.
2009 It isn't 16x9, and I am not sure what it is.
2010
2011 CONFIG_SHARP_LQ64D341
2012
2013 Sharp LQ64D341 display, 640x480.
2014 Active, color, single scan.
2015
2016 CONFIG_HLD1045
2017
2018 HLD1045 display, 640x480.
2019 Active, color, single scan.
2020
2021 CONFIG_OPTREX_BW
2022
2023 Optrex CBL50840-2 NF-FW 99 22 M5
2024 or
2025 Hitachi LMG6912RPFC-00T
2026 or
2027 Hitachi SP14Q002
2028
2029 320x240. Black & white.
2030
2031 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002032 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00002033
Simon Glass599a4df2012-10-17 13:24:54 +00002034 CONFIG_LCD_ALIGNMENT
2035
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002036 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00002037 defined then the LCD will be aligned to this value instead.
2038 For ARM it is sometimes useful to use MMU_SECTION_SIZE
2039 here, since it is cheaper to change data cache settings on
2040 a per-section basis.
2041
Simon Glassaf3e2802012-10-17 13:24:59 +00002042 CONFIG_CONSOLE_SCROLL_LINES
2043
2044 When the console need to be scrolled, this is the number of
2045 lines to scroll by. It defaults to 1. Increasing this makes
2046 the console jump but can help speed up operation when scrolling
2047 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00002048
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00002049 CONFIG_LCD_BMP_RLE8
2050
2051 Support drawing of RLE8-compressed bitmaps on the LCD.
2052
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00002053 CONFIG_I2C_EDID
2054
2055 Enables an 'i2c edid' command which can read EDID
2056 information over I2C from an attached LCD display.
2057
wdenkeb20ad32003-09-05 23:19:14 +00002058- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00002059
wdenk57b2d802003-06-27 21:31:46 +00002060 If this option is set, the environment is checked for
2061 a variable "splashimage". If found, the usual display
2062 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00002063 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00002064 specified in "splashimage" is loaded instead. The
2065 console is redirected to the "nulldev", too. This
2066 allows for a "silent" boot where a splash screen is
2067 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00002068
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002069 CONFIG_SPLASHIMAGE_GUARD
2070
2071 If this option is set, then U-Boot will prevent the environment
2072 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05002073 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002074 This option is useful for targets where, due to alignment
2075 restrictions, an improperly aligned BMP image will cause a data
2076 abort. If you think you will not have problems with unaligned
2077 accesses (for example because your toolchain prevents them)
2078 there is no need to set this option.
2079
Matthias Weisser53884182009-07-09 16:07:30 +02002080 CONFIG_SPLASH_SCREEN_ALIGN
2081
2082 If this option is set the splash image can be freely positioned
2083 on the screen. Environment variable "splashpos" specifies the
2084 position as "x,y". If a positive number is given it is used as
2085 number of pixel from left/top. If a negative number is given it
2086 is used as number of pixel from right/bottom. You can also
2087 specify 'm' for centering the image.
2088
2089 Example:
2090 setenv splashpos m,m
2091 => image at center of screen
2092
2093 setenv splashpos 30,20
2094 => image at x = 30 and y = 20
2095
2096 setenv splashpos -10,m
2097 => vertically centered image
2098 at x = dspWidth - bmpWidth - 9
2099
Stefan Roesed9d97742005-09-22 09:04:17 +02002100- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2101
2102 If this option is set, additionally to standard BMP
2103 images, gzipped BMP images can be displayed via the
2104 splashscreen support or the bmp command.
2105
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002106- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2107
2108 If this option is set, 8-bit RLE compressed BMP images
2109 can be displayed via the splashscreen support or the
2110 bmp command.
2111
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002112- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002113 CONFIG_CMD_ZIP
2114
2115 If this option is set, it would use zlib deflate method
2116 to compress the specified memory at its best effort.
2117
wdenk710e3502003-08-29 20:57:53 +00002118- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002119 CONFIG_GZIP
2120
2121 Enabled by default to support gzip compressed images.
2122
wdenk710e3502003-08-29 20:57:53 +00002123 CONFIG_BZIP2
2124
2125 If this option is set, support for bzip2 compressed
2126 images is included. If not, only uncompressed and gzip
2127 compressed images are supported.
2128
wdenk9c53f402003-10-15 23:53:47 +00002129 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002130 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002131 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002132
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002133 CONFIG_LZMA
2134
2135 If this option is set, support for lzma compressed
2136 images is included.
2137
2138 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2139 requires an amount of dynamic memory that is given by the
2140 formula:
2141
2142 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2143
2144 Where lc and lp stand for, respectively, Literal context bits
2145 and Literal pos bits.
2146
2147 This value is upper-bounded by 14MB in the worst case. Anyway,
2148 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2149 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2150 a very small buffer.
2151
2152 Use the lzmainfo tool to determinate the lc and lp values and
2153 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002154 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002155
Kees Cook5b06e642013-08-16 07:59:12 -07002156 CONFIG_LZO
2157
2158 If this option is set, support for LZO compressed images
2159 is included.
2160
wdenk0e2bd9c2004-06-06 21:51:03 +00002161- MII/PHY support:
2162 CONFIG_PHY_ADDR
2163
2164 The address of PHY on MII bus.
2165
2166 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2167
2168 The clock frequency of the MII bus
2169
2170 CONFIG_PHY_GIGE
2171
2172 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002173 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002174
2175 CONFIG_PHY_RESET_DELAY
2176
2177 Some PHY like Intel LXT971A need extra delay after
2178 reset before any MII register access is possible.
2179 For such PHY, set this option to the usec delay
2180 required. (minimum 300usec for LXT971A)
2181
2182 CONFIG_PHY_CMD_DELAY (ppc4xx)
2183
2184 Some PHY like Intel LXT971A need extra delay after
2185 command issued before MII status register can be read
2186
wdenkc6097192002-11-03 00:24:07 +00002187- Ethernet address:
2188 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04002189 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002190 CONFIG_ETH2ADDR
2191 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04002192 CONFIG_ETH4ADDR
2193 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002194
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002195 Define a default value for Ethernet address to use
2196 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002197 is not determined automatically.
2198
2199- IP address:
2200 CONFIG_IPADDR
2201
2202 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002203 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002204 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002205 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002206
2207- Server IP address:
2208 CONFIG_SERVERIP
2209
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002210 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002211 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002212 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002213
Robin Getz470a6d42009-07-21 12:15:28 -04002214 CONFIG_KEEP_SERVERADDR
2215
2216 Keeps the server's MAC address, in the env 'serveraddr'
2217 for passing to bootargs (like Linux's netconsole option)
2218
Wolfgang Denk26da2992011-10-26 10:21:22 +00002219- Gateway IP address:
2220 CONFIG_GATEWAYIP
2221
2222 Defines a default value for the IP address of the
2223 default router where packets to other networks are
2224 sent to.
2225 (Environment variable "gatewayip")
2226
2227- Subnet mask:
2228 CONFIG_NETMASK
2229
2230 Defines a default value for the subnet mask (or
2231 routing prefix) which is used to determine if an IP
2232 address belongs to the local subnet or needs to be
2233 forwarded through a router.
2234 (Environment variable "netmask")
2235
David Updegraff7280da72007-06-11 10:41:07 -05002236- Multicast TFTP Mode:
2237 CONFIG_MCAST_TFTP
2238
2239 Defines whether you want to support multicast TFTP as per
2240 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002241 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002242 driver in use must provide a function: mcast() to join/leave a
2243 multicast group.
2244
wdenkc6097192002-11-03 00:24:07 +00002245- BOOTP Recovery Mode:
2246 CONFIG_BOOTP_RANDOM_DELAY
2247
2248 If you have many targets in a network that try to
2249 boot using BOOTP, you may want to avoid that all
2250 systems send out BOOTP requests at precisely the same
2251 moment (which would happen for instance at recovery
2252 from a power failure, when all systems will try to
2253 boot, thus flooding the BOOTP server. Defining
2254 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2255 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002256 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002257
2258 1st BOOTP request: delay 0 ... 1 sec
2259 2nd BOOTP request: delay 0 ... 2 sec
2260 3rd BOOTP request: delay 0 ... 4 sec
2261 4th and following
2262 BOOTP requests: delay 0 ... 8 sec
2263
Thierry Reding8977cda2014-08-19 10:21:24 +02002264 CONFIG_BOOTP_ID_CACHE_SIZE
2265
2266 BOOTP packets are uniquely identified using a 32-bit ID. The
2267 server will copy the ID from client requests to responses and
2268 U-Boot will use this to determine if it is the destination of
2269 an incoming response. Some servers will check that addresses
2270 aren't in use before handing them out (usually using an ARP
2271 ping) and therefore take up to a few hundred milliseconds to
2272 respond. Network congestion may also influence the time it
2273 takes for a response to make it back to the client. If that
2274 time is too long, U-Boot will retransmit requests. In order
2275 to allow earlier responses to still be accepted after these
2276 retransmissions, U-Boot's BOOTP client keeps a small cache of
2277 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2278 cache. The default is to keep IDs for up to four outstanding
2279 requests. Increasing this will allow U-Boot to accept offers
2280 from a BOOTP client in networks with unusually high latency.
2281
stroesee0aadfb2003-08-28 14:17:32 +00002282- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002283 You can fine tune the DHCP functionality by defining
2284 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002285
Jon Loeliger5336a762007-07-09 22:08:34 -05002286 CONFIG_BOOTP_SUBNETMASK
2287 CONFIG_BOOTP_GATEWAY
2288 CONFIG_BOOTP_HOSTNAME
2289 CONFIG_BOOTP_NISDOMAIN
2290 CONFIG_BOOTP_BOOTPATH
2291 CONFIG_BOOTP_BOOTFILESIZE
2292 CONFIG_BOOTP_DNS
2293 CONFIG_BOOTP_DNS2
2294 CONFIG_BOOTP_SEND_HOSTNAME
2295 CONFIG_BOOTP_NTPSERVER
2296 CONFIG_BOOTP_TIMEOFFSET
2297 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002298 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002299
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002300 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2301 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002302
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002303 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2304 after the configured retry count, the call will fail
2305 instead of starting over. This can be used to fail over
2306 to Link-local IP address configuration if the DHCP server
2307 is not available.
2308
stroesee0aadfb2003-08-28 14:17:32 +00002309 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2310 serverip from a DHCP server, it is possible that more
2311 than one DNS serverip is offered to the client.
2312 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2313 serverip will be stored in the additional environment
2314 variable "dnsip2". The first DNS serverip is always
2315 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002316 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002317
2318 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2319 to do a dynamic update of a DNS server. To do this, they
2320 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002321 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002322 of the "hostname" environment variable is passed as
2323 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002324
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002325 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2326
2327 A 32bit value in microseconds for a delay between
2328 receiving a "DHCP Offer" and sending the "DHCP Request".
2329 This fixes a problem with certain DHCP servers that don't
2330 respond 100% of the time to a "DHCP request". E.g. On an
2331 AT91RM9200 processor running at 180MHz, this delay needed
2332 to be *at least* 15,000 usec before a Windows Server 2003
2333 DHCP server would reply 100% of the time. I recommend at
2334 least 50,000 usec to be safe. The alternative is to hope
2335 that one of the retries will be successful but note that
2336 the DHCP timeout and retry process takes a longer than
2337 this delay.
2338
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002339 - Link-local IP address negotiation:
2340 Negotiate with other link-local clients on the local network
2341 for an address that doesn't require explicit configuration.
2342 This is especially useful if a DHCP server cannot be guaranteed
2343 to exist in all environments that the device must operate.
2344
2345 See doc/README.link-local for more information.
2346
wdenk145d2c12004-04-15 21:48:45 +00002347 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002348 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002349
2350 The device id used in CDP trigger frames.
2351
2352 CONFIG_CDP_DEVICE_ID_PREFIX
2353
2354 A two character string which is prefixed to the MAC address
2355 of the device.
2356
2357 CONFIG_CDP_PORT_ID
2358
2359 A printf format string which contains the ascii name of
2360 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002361 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002362
2363 CONFIG_CDP_CAPABILITIES
2364
2365 A 32bit integer which indicates the device capabilities;
2366 0x00000010 for a normal host which does not forwards.
2367
2368 CONFIG_CDP_VERSION
2369
2370 An ascii string containing the version of the software.
2371
2372 CONFIG_CDP_PLATFORM
2373
2374 An ascii string containing the name of the platform.
2375
2376 CONFIG_CDP_TRIGGER
2377
2378 A 32bit integer sent on the trigger.
2379
2380 CONFIG_CDP_POWER_CONSUMPTION
2381
2382 A 16bit integer containing the power consumption of the
2383 device in .1 of milliwatts.
2384
2385 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2386
2387 A byte containing the id of the VLAN.
2388
wdenkc6097192002-11-03 00:24:07 +00002389- Status LED: CONFIG_STATUS_LED
2390
2391 Several configurations allow to display the current
2392 status using a LED. For instance, the LED will blink
2393 fast while running U-Boot code, stop blinking as
2394 soon as a reply to a BOOTP request was received, and
2395 start blinking slow once the Linux kernel is running
2396 (supported by a status LED driver in the Linux
2397 kernel). Defining CONFIG_STATUS_LED enables this
2398 feature in U-Boot.
2399
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002400 Additional options:
2401
2402 CONFIG_GPIO_LED
2403 The status LED can be connected to a GPIO pin.
2404 In such cases, the gpio_led driver can be used as a
2405 status LED backend implementation. Define CONFIG_GPIO_LED
2406 to include the gpio_led driver in the U-Boot binary.
2407
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002408 CONFIG_GPIO_LED_INVERTED_TABLE
2409 Some GPIO connected LEDs may have inverted polarity in which
2410 case the GPIO high value corresponds to LED off state and
2411 GPIO low value corresponds to LED on state.
2412 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2413 with a list of GPIO LEDs that have inverted polarity.
2414
wdenkc6097192002-11-03 00:24:07 +00002415- CAN Support: CONFIG_CAN_DRIVER
2416
2417 Defining CONFIG_CAN_DRIVER enables CAN driver support
2418 on those systems that support this (optional)
2419 feature, like the TQM8xxL modules.
2420
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002421- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002422
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002423 This enable the NEW i2c subsystem, and will allow you to use
2424 i2c commands at the u-boot command line (as long as you set
2425 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2426 based realtime clock chips or other i2c devices. See
2427 common/cmd_i2c.c for a description of the command line
2428 interface.
2429
2430 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002431 - drivers/i2c/soft_i2c.c:
2432 - activate first bus with CONFIG_SYS_I2C_SOFT define
2433 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2434 for defining speed and slave address
2435 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2436 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2437 for defining speed and slave address
2438 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2439 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2440 for defining speed and slave address
2441 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2442 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2443 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002444
Heiko Schocherf2850742012-10-24 13:48:22 +02002445 - drivers/i2c/fsl_i2c.c:
2446 - activate i2c driver with CONFIG_SYS_I2C_FSL
2447 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2448 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2449 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2450 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002451 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002452 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2453 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2454 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2455 second bus.
2456
Simon Glass026fefb2012-10-30 07:28:53 +00002457 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002458 - activate this driver with CONFIG_SYS_I2C_TEGRA
2459 - This driver adds 4 i2c buses with a fix speed from
2460 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002461
Dirk Eibach42b204f2013-04-25 02:40:01 +00002462 - drivers/i2c/ppc4xx_i2c.c
2463 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2464 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2465 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2466
trema49f40a2013-09-21 18:13:35 +02002467 - drivers/i2c/i2c_mxc.c
2468 - activate this driver with CONFIG_SYS_I2C_MXC
2469 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2470 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2471 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2472 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2473 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2474 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002475 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002476 for speed, and 0 for slave.
2477
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002478 - drivers/i2c/rcar_i2c.c:
2479 - activate this driver with CONFIG_SYS_I2C_RCAR
2480 - This driver adds 4 i2c buses
2481
2482 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2483 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2484 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2485 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2486 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2487 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2488 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2489 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2490 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2491
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002492 - drivers/i2c/sh_i2c.c:
2493 - activate this driver with CONFIG_SYS_I2C_SH
2494 - This driver adds from 2 to 5 i2c buses
2495
2496 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2497 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2498 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2499 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2500 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2501 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2502 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2503 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2504 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2505 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2506 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2507 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002508 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002509
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002510 - drivers/i2c/omap24xx_i2c.c
2511 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2512 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2513 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2514 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2515 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2516 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2517 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2518 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2519 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2520 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2521 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2522
Heiko Schocher465819a2013-11-08 07:30:53 +01002523 - drivers/i2c/zynq_i2c.c
2524 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2525 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2526 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2527
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302528 - drivers/i2c/s3c24x0_i2c.c:
2529 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2530 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2531 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2532 with a fix speed from 100000 and the slave addr 0!
2533
Dirk Eibachb9577432014-07-03 09:28:18 +02002534 - drivers/i2c/ihs_i2c.c
2535 - activate this driver with CONFIG_SYS_I2C_IHS
2536 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2537 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2538 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2539 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2540 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2541 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2542 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2543 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2544 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2545 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2546 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2547 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2548
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002549 additional defines:
2550
2551 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002552 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002553 don't use/have i2c muxes on your i2c bus, this
2554 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2555 omit this define.
2556
2557 CONFIG_SYS_I2C_DIRECT_BUS
2558 define this, if you don't use i2c muxes on your hardware.
2559 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2560 omit this define.
2561
2562 CONFIG_SYS_I2C_MAX_HOPS
2563 define how many muxes are maximal consecutively connected
2564 on one i2c bus. If you not use i2c muxes, omit this
2565 define.
2566
2567 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002568 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002569 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2570 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2571 CONFIG_SYS_NUM_I2C_BUSES = 9:
2572
2573 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2574 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2575 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2576 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2577 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2578 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2579 {1, {I2C_NULL_HOP}}, \
2580 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2581 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2582 }
2583
2584 which defines
2585 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002586 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2587 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2588 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2589 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2590 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002591 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002592 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2593 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002594
2595 If you do not have i2c muxes on your board, omit this define.
2596
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002597- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002598
2599 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2600 provides the following compelling advantages:
2601
2602 - more than one i2c adapter is usable
2603 - approved multibus support
2604 - better i2c mux support
2605
2606 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002607
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002608 These enable legacy I2C serial bus commands. Defining
2609 CONFIG_HARD_I2C will include the appropriate I2C driver
2610 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002611
wdenk21136db2003-07-16 21:53:01 +00002612 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002613 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002614 CONFIG_COMMANDS) and communicate with i2c based realtime
2615 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002616 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002617
Ben Warren45657152006-09-07 16:50:54 -04002618 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002619
wdenk21136db2003-07-16 21:53:01 +00002620 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002621 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002623 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002624 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002625 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002626 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002627
Peter Tysere4d1abc2010-04-12 22:28:21 -05002628 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002629 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002630 and so its address should therefore be cleared to 0 (See,
2631 eg, MPC823e User's Manual p.16-473). So, set
2632 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002633
Eric Millbrandt12990a42009-09-03 08:09:44 -05002634 CONFIG_SYS_I2C_INIT_MPC5XXX
2635
2636 When a board is reset during an i2c bus transfer
2637 chips might think that the current transfer is still
2638 in progress. Reset the slave devices by sending start
2639 commands until the slave device responds.
2640
wdenk21136db2003-07-16 21:53:01 +00002641 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002642
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002643 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002644 then the following macros need to be defined (examples are
2645 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002646
2647 I2C_INIT
2648
wdenkb9bbd242003-06-30 16:24:52 +00002649 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002650 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002651
wdenk544e9732004-02-06 23:19:44 +00002652 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002653
wdenkc6097192002-11-03 00:24:07 +00002654 I2C_PORT
2655
wdenk4a5c8a72003-03-06 00:02:04 +00002656 (Only for MPC8260 CPU). The I/O port to use (the code
2657 assumes both bits are on the same port). Valid values
2658 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002659
2660 I2C_ACTIVE
2661
2662 The code necessary to make the I2C data line active
2663 (driven). If the data line is open collector, this
2664 define can be null.
2665
wdenkb9bbd242003-06-30 16:24:52 +00002666 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2667
wdenkc6097192002-11-03 00:24:07 +00002668 I2C_TRISTATE
2669
2670 The code necessary to make the I2C data line tri-stated
2671 (inactive). If the data line is open collector, this
2672 define can be null.
2673
wdenkb9bbd242003-06-30 16:24:52 +00002674 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2675
wdenkc6097192002-11-03 00:24:07 +00002676 I2C_READ
2677
York Sun4a598092013-04-01 11:29:11 -07002678 Code that returns true if the I2C data line is high,
2679 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002680
wdenkb9bbd242003-06-30 16:24:52 +00002681 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2682
wdenkc6097192002-11-03 00:24:07 +00002683 I2C_SDA(bit)
2684
York Sun4a598092013-04-01 11:29:11 -07002685 If <bit> is true, sets the I2C data line high. If it
2686 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002687
wdenkb9bbd242003-06-30 16:24:52 +00002688 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002689 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002690 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002691
wdenkc6097192002-11-03 00:24:07 +00002692 I2C_SCL(bit)
2693
York Sun4a598092013-04-01 11:29:11 -07002694 If <bit> is true, sets the I2C clock line high. If it
2695 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002696
wdenkb9bbd242003-06-30 16:24:52 +00002697 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002698 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002699 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002700
wdenkc6097192002-11-03 00:24:07 +00002701 I2C_DELAY
2702
2703 This delay is invoked four times per clock cycle so this
2704 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002705 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002706 like:
2707
wdenkb9bbd242003-06-30 16:24:52 +00002708 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002709
Mike Frysingeree12d542010-07-21 13:38:02 -04002710 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2711
2712 If your arch supports the generic GPIO framework (asm/gpio.h),
2713 then you may alternatively define the two GPIOs that are to be
2714 used as SCL / SDA. Any of the previous I2C_xxx macros will
2715 have GPIO-based defaults assigned to them as appropriate.
2716
2717 You should define these to the GPIO value as given directly to
2718 the generic GPIO functions.
2719
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002720 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002721
wdenk57b2d802003-06-27 21:31:46 +00002722 When a board is reset during an i2c bus transfer
2723 chips might think that the current transfer is still
2724 in progress. On some boards it is possible to access
2725 the i2c SCLK line directly, either by using the
2726 processor pin as a GPIO or by having a second pin
2727 connected to the bus. If this option is defined a
2728 custom i2c_init_board() routine in boards/xxx/board.c
2729 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002730
Richard Retanubundf0149c2010-04-12 15:08:17 -04002731 CONFIG_SYS_I2C_BOARD_LATE_INIT
2732
2733 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2734 defined a custom i2c_board_late_init() routine in
2735 boards/xxx/board.c is run AFTER the operations in i2c_init()
2736 is completed. This callpoint can be used to unreset i2c bus
2737 using CPU i2c controller register accesses for CPUs whose i2c
2738 controller provide such a method. It is called at the end of
2739 i2c_init() to allow i2c_init operations to setup the i2c bus
2740 controller on the CPU (e.g. setting bus speed & slave address).
2741
wdenk0e2bd9c2004-06-06 21:51:03 +00002742 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2743
2744 This option enables configuration of bi_iic_fast[] flags
2745 in u-boot bd_info structure based on u-boot environment
2746 variable "i2cfast". (see also i2cfast)
2747
Ben Warren45657152006-09-07 16:50:54 -04002748 CONFIG_I2C_MULTI_BUS
2749
2750 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002751 must have a controller. At any point in time, only one bus is
2752 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002753 Note that bus numbering is zero-based.
2754
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002755 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002756
2757 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002758 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002759 is set, specify a list of bus-device pairs. Otherwise, specify
2760 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002761
2762 e.g.
2763 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002764 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002765
2766 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2767
Wolfgang Denk092ae952011-10-26 10:21:21 +00002768 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002769 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002770
2771 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2772
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002773 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002774
2775 If defined, then this indicates the I2C bus number for DDR SPD.
2776 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2777
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002778 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002779
2780 If defined, then this indicates the I2C bus number for the RTC.
2781 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2782
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002783 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002784
2785 If defined, then this indicates the I2C bus number for the DTT.
2786 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2787
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002788 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002789
2790 If defined, specifies the I2C address of the DTT device.
2791 If not defined, then U-Boot uses predefined value for
2792 specified DTT device.
2793
Andrew Dyer58c41f92008-12-29 17:36:01 -06002794 CONFIG_SOFT_I2C_READ_REPEATED_START
2795
2796 defining this will force the i2c_read() function in
2797 the soft_i2c driver to perform an I2C repeated start
2798 between writing the address pointer and reading the
2799 data. If this define is omitted the default behaviour
2800 of doing a stop-start sequence will be used. Most I2C
2801 devices can use either method, but some require one or
2802 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002803
wdenkc6097192002-11-03 00:24:07 +00002804- SPI Support: CONFIG_SPI
2805
2806 Enables SPI driver (so far only tested with
2807 SPI EEPROM, also an instance works with Crystal A/D and
2808 D/As on the SACSng board)
2809
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002810 CONFIG_SH_SPI
2811
2812 Enables the driver for SPI controller on SuperH. Currently
2813 only SH7757 is supported.
2814
wdenkc6097192002-11-03 00:24:07 +00002815 CONFIG_SPI_X
2816
2817 Enables extended (16-bit) SPI EEPROM addressing.
2818 (symmetrical to CONFIG_I2C_X)
2819
2820 CONFIG_SOFT_SPI
2821
wdenk4a5c8a72003-03-06 00:02:04 +00002822 Enables a software (bit-bang) SPI driver rather than
2823 using hardware support. This is a general purpose
2824 driver that only requires three general I/O port pins
2825 (two outputs, one input) to function. If this is
2826 defined, the board configuration must define several
2827 SPI configuration items (port pins to use, etc). For
2828 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002829
Ben Warren7efe9272008-01-16 22:37:35 -05002830 CONFIG_HARD_SPI
2831
2832 Enables a hardware SPI driver for general-purpose reads
2833 and writes. As with CONFIG_SOFT_SPI, the board configuration
2834 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002835 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002836 example, see include/configs/mpc8349emds.h.
2837
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002838 CONFIG_MXC_SPI
2839
2840 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002841 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002842
Heiko Schocherb77c8882014-07-14 10:22:11 +02002843 CONFIG_SYS_SPI_MXC_WAIT
2844 Timeout for waiting until spi transfer completed.
2845 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2846
Matthias Fuchsa4400872007-12-27 17:12:34 +01002847- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002848
Matthias Fuchsa4400872007-12-27 17:12:34 +01002849 Enables FPGA subsystem.
2850
2851 CONFIG_FPGA_<vendor>
2852
2853 Enables support for specific chip vendors.
2854 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002855
Matthias Fuchsa4400872007-12-27 17:12:34 +01002856 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002857
Matthias Fuchsa4400872007-12-27 17:12:34 +01002858 Enables support for FPGA family.
2859 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2860
2861 CONFIG_FPGA_COUNT
2862
2863 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002864
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302865 CONFIG_CMD_FPGA_LOADMK
2866
2867 Enable support for fpga loadmk command
2868
Michal Simek64c70982014-05-02 13:43:39 +02002869 CONFIG_CMD_FPGA_LOADP
2870
2871 Enable support for fpga loadp command - load partial bitstream
2872
2873 CONFIG_CMD_FPGA_LOADBP
2874
2875 Enable support for fpga loadbp command - load partial bitstream
2876 (Xilinx only)
2877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002878 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002879
wdenk57b2d802003-06-27 21:31:46 +00002880 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002882 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002883
wdenk4a5c8a72003-03-06 00:02:04 +00002884 Enable checks on FPGA configuration interface busy
2885 status by the configuration function. This option
2886 will require a board or device specific function to
2887 be written.
wdenkc6097192002-11-03 00:24:07 +00002888
2889 CONFIG_FPGA_DELAY
2890
2891 If defined, a function that provides delays in the FPGA
2892 configuration driver.
2893
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002894 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002895 Allow Control-C to interrupt FPGA configuration
2896
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002897 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002898
wdenk4a5c8a72003-03-06 00:02:04 +00002899 Check for configuration errors during FPGA bitfile
2900 loading. For example, abort during Virtex II
2901 configuration if the INIT_B line goes low (which
2902 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002903
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002904 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002905
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002906 Maximum time to wait for the INIT_B line to de-assert
2907 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002908 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002909 ms.
wdenkc6097192002-11-03 00:24:07 +00002910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002911 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002912
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002913 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002914 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002916 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002917
wdenk4a5c8a72003-03-06 00:02:04 +00002918 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002919 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002920
2921- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002922 CONFIG_BUILD_TARGET
2923
2924 Some SoCs need special image types (e.g. U-Boot binary
2925 with a special header) as build targets. By defining
2926 CONFIG_BUILD_TARGET in the SoC / board header, this
2927 special image will be automatically built upon calling
2928 make / MAKEALL.
2929
wdenkc6097192002-11-03 00:24:07 +00002930 CONFIG_IDENT_STRING
2931
wdenk4a5c8a72003-03-06 00:02:04 +00002932 If defined, this string will be added to the U-Boot
2933 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002934
2935- Vendor Parameter Protection:
2936
wdenk4a5c8a72003-03-06 00:02:04 +00002937 U-Boot considers the values of the environment
2938 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002939 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002940 are set once by the board vendor / manufacturer, and
2941 protects these variables from casual modification by
2942 the user. Once set, these variables are read-only,
2943 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002944 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002945
2946 If CONFIG_ENV_OVERWRITE is #defined in your config
2947 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002948 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002949 these parameters.
2950
2951 Alternatively, if you #define _both_ CONFIG_ETHADDR
2952 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002953 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002954 which can be changed exactly ONCE by the user. [The
2955 serial# is unaffected by this, i. e. it remains
2956 read-only.]
2957
Joe Hershberger71497d02012-12-11 22:16:31 -06002958 The same can be accomplished in a more flexible way
2959 for any variable by configuring the type of access
2960 to allow for those variables in the ".flags" variable
2961 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2962
wdenkc6097192002-11-03 00:24:07 +00002963- Protected RAM:
2964 CONFIG_PRAM
2965
2966 Define this variable to enable the reservation of
2967 "protected RAM", i. e. RAM which is not overwritten
2968 by U-Boot. Define CONFIG_PRAM to hold the number of
2969 kB you want to reserve for pRAM. You can overwrite
2970 this default value by defining an environment
2971 variable "pram" to the number of kB you want to
2972 reserve. Note that the board info structure will
2973 still show the full amount of RAM. If pRAM is
2974 reserved, a new environment variable "mem" will
2975 automatically be defined to hold the amount of
2976 remaining RAM in a form that can be passed as boot
2977 argument to Linux, for instance like that:
2978
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002979 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002980 saveenv
2981
2982 This way you can tell Linux not to use this memory,
2983 either, which results in a memory region that will
2984 not be affected by reboots.
2985
2986 *WARNING* If your board configuration uses automatic
2987 detection of the RAM size, you must make sure that
2988 this memory test is non-destructive. So far, the
2989 following board configurations are known to be
2990 "pRAM-clean":
2991
Wolfgang Denk90326762012-10-24 02:36:15 +00002992 IVMS8, IVML24, SPD8xx, TQM8xxL,
2993 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002994 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002995
Gabe Blacka2f3a932012-12-02 04:55:18 +00002996- Access to physical memory region (> 4GB)
2997 Some basic support is provided for operations on memory not
2998 normally accessible to U-Boot - e.g. some architectures
2999 support access to more than 4GB of memory on 32-bit
3000 machines using physical address extension or similar.
3001 Define CONFIG_PHYSMEM to access this basic support, which
3002 currently only supports clearing the memory.
3003
wdenkc6097192002-11-03 00:24:07 +00003004- Error Recovery:
3005 CONFIG_PANIC_HANG
3006
3007 Define this variable to stop the system in case of a
3008 fatal error, so that you have to reset it manually.
3009 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003010 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00003011 automatically as fast as possible, but it may be
3012 useful during development since you can try to debug
3013 the conditions that lead to the situation.
3014
3015 CONFIG_NET_RETRY_COUNT
3016
wdenk4a5c8a72003-03-06 00:02:04 +00003017 This variable defines the number of retries for
3018 network operations like ARP, RARP, TFTP, or BOOTP
3019 before giving up the operation. If not defined, a
3020 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00003021
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02003022 CONFIG_ARP_TIMEOUT
3023
3024 Timeout waiting for an ARP reply in milliseconds.
3025
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00003026 CONFIG_NFS_TIMEOUT
3027
3028 Timeout in milliseconds used in NFS protocol.
3029 If you encounter "ERROR: Cannot umount" in nfs command,
3030 try longer timeout such as
3031 #define CONFIG_NFS_TIMEOUT 10000UL
3032
wdenkc6097192002-11-03 00:24:07 +00003033- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02003034 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00003035
3036 Enable auto completion of commands using TAB.
3037
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003038 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00003039
3040 This defines the secondary prompt string, which is
3041 printed when the command interpreter needs more input
3042 to complete a command. Usually "> ".
3043
3044 Note:
3045
wdenk57b2d802003-06-27 21:31:46 +00003046 In the current implementation, the local variables
3047 space and global environment variables space are
3048 separated. Local variables are those you define by
3049 simply typing `name=value'. To access a local
3050 variable later on, you have write `$name' or
3051 `${name}'; to execute the contents of a variable
3052 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00003053
wdenk4a5c8a72003-03-06 00:02:04 +00003054 Global environment variables are those you use
3055 setenv/printenv to work with. To run a command stored
3056 in such a variable, you need to use the run command,
3057 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00003058
3059 To store commands and special characters in a
3060 variable, please use double quotation marks
3061 surrounding the whole text of the variable, instead
3062 of the backslashes before semicolons and special
3063 symbols.
3064
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003065- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02003066 CONFIG_CMDLINE_EDITING
3067
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003068 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003069 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02003070
wdenkc0aa5c52003-12-06 19:49:23 +00003071- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003072 CONFIG_EXTRA_ENV_SETTINGS
3073
wdenk4a5c8a72003-03-06 00:02:04 +00003074 Define this to contain any number of null terminated
3075 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00003076 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00003077
wdenk4a5c8a72003-03-06 00:02:04 +00003078 For example, place something like this in your
3079 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003080
3081 #define CONFIG_EXTRA_ENV_SETTINGS \
3082 "myvar1=value1\0" \
3083 "myvar2=value2\0"
3084
wdenk4a5c8a72003-03-06 00:02:04 +00003085 Warning: This method is based on knowledge about the
3086 internal format how the environment is stored by the
3087 U-Boot code. This is NOT an official, exported
3088 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003089 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003090 You better know what you are doing here.
3091
wdenk4a5c8a72003-03-06 00:02:04 +00003092 Note: overly (ab)use of the default environment is
3093 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003094 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003095 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003096
Stephen Warren1465d5f2012-05-22 09:21:54 +00003097 CONFIG_ENV_VARS_UBOOT_CONFIG
3098
3099 Define this in order to add variables describing the
3100 U-Boot build configuration to the default environment.
3101 These will be named arch, cpu, board, vendor, and soc.
3102
3103 Enabling this option will cause the following to be defined:
3104
3105 - CONFIG_SYS_ARCH
3106 - CONFIG_SYS_CPU
3107 - CONFIG_SYS_BOARD
3108 - CONFIG_SYS_VENDOR
3109 - CONFIG_SYS_SOC
3110
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003111 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3112
3113 Define this in order to add variables describing certain
3114 run-time determined information about the hardware to the
3115 environment. These will be named board_name, board_rev.
3116
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003117 CONFIG_DELAY_ENVIRONMENT
3118
3119 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003120 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003121 that so that the environment is not available until
3122 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3123 this is instead controlled by the value of
3124 /config/load-environment.
3125
wdenkc0aa5c52003-12-06 19:49:23 +00003126- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003127 CONFIG_HAS_DATAFLASH
3128
wdenk57b2d802003-06-27 21:31:46 +00003129 Defining this option enables DataFlash features and
3130 allows to read/write in Dataflash via the standard
3131 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003132
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003133- Serial Flash support
3134 CONFIG_CMD_SF
3135
3136 Defining this option enables SPI flash commands
3137 'sf probe/read/write/erase/update'.
3138
3139 Usage requires an initial 'probe' to define the serial
3140 flash parameters, followed by read/write/erase/update
3141 commands.
3142
3143 The following defaults may be provided by the platform
3144 to handle the common case when only a single serial
3145 flash is present on the system.
3146
3147 CONFIG_SF_DEFAULT_BUS Bus identifier
3148 CONFIG_SF_DEFAULT_CS Chip-select
3149 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3150 CONFIG_SF_DEFAULT_SPEED in Hz
3151
Simon Glass4b5545e2012-10-08 13:16:02 +00003152 CONFIG_CMD_SF_TEST
3153
3154 Define this option to include a destructive SPI flash
3155 test ('sf test').
3156
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05303157 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3158
3159 Define this option to use the Bank addr/Extended addr
3160 support on SPI flashes which has size > 16Mbytes.
3161
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303162 CONFIG_SF_DUAL_FLASH Dual flash memories
3163
3164 Define this option to use dual flash support where two flash
3165 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003166 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303167
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02003168 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3169 enable the W#/Vpp signal to disable writing to the status
3170 register on ST MICRON flashes like the N25Q128.
3171 The status register write enable/disable bit, combined with
3172 the W#/VPP signal provides hardware data protection for the
3173 device as follows: When the enable/disable bit is set to 1,
3174 and the W#/VPP signal is driven LOW, the status register
3175 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3176 operation will not execute. The only way to exit this
3177 hardware-protected mode is to drive W#/VPP HIGH.
3178
wdenkef893942004-02-23 16:11:30 +00003179- SystemACE Support:
3180 CONFIG_SYSTEMACE
3181
3182 Adding this option adds support for Xilinx SystemACE
3183 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003184 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003185 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003186
3187 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003188 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003189
3190 When SystemACE support is added, the "ace" device type
3191 becomes available to the fat commands, i.e. fatls.
3192
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003193- TFTP Fixed UDP Port:
3194 CONFIG_TFTP_PORT
3195
Wolfgang Denk227b5192005-09-24 23:25:46 +02003196 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003197 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003198 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003199 number generator is used.
3200
Wolfgang Denk227b5192005-09-24 23:25:46 +02003201 Also, the environment variable tftpdstp is used to supply
3202 the TFTP UDP destination port value. If tftpdstp isn't
3203 defined, the normal port 69 is used.
3204
3205 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003206 blindly start the TFTP transfer using the pre-configured
3207 target IP address and UDP port. This has the effect of
3208 "punching through" the (Windows XP) firewall, allowing
3209 the remainder of the TFTP transfer to proceed normally.
3210 A better solution is to properly configure the firewall,
3211 but sometimes that is not allowed.
3212
Simon Glass058bb8d2012-12-05 14:46:38 +00003213- Hashing support:
3214 CONFIG_CMD_HASH
3215
3216 This enables a generic 'hash' command which can produce
3217 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3218
3219 CONFIG_HASH_VERIFY
3220
3221 Enable the hash verify command (hash -v). This adds to code
3222 size a little.
3223
gaurav ranaef201592015-02-20 12:51:46 +05303224 CONFIG_SHA1 - This option enables support of hashing using SHA1
3225 algorithm. The hash is calculated in software.
3226 CONFIG_SHA256 - This option enables support of hashing using
3227 SHA256 algorithm. The hash is calculated in software.
3228 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3229 for SHA1/SHA256 hashing.
3230 This affects the 'hash' command and also the
3231 hash_lookup_algo() function.
3232 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3233 hardware-acceleration for SHA1/SHA256 progressive hashing.
3234 Data can be streamed in a block at a time and the hashing
3235 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003236
3237 Note: There is also a sha1sum command, which should perhaps
3238 be deprecated in favour of 'hash sha1'.
3239
Robert Winkler765ccf42013-07-24 17:57:06 -07003240- Freescale i.MX specific commands:
3241 CONFIG_CMD_HDMIDETECT
3242 This enables 'hdmidet' command which returns true if an
3243 HDMI monitor is detected. This command is i.MX 6 specific.
3244
3245 CONFIG_CMD_BMODE
3246 This enables the 'bmode' (bootmode) command for forcing
3247 a boot from specific media.
3248
3249 This is useful for forcing the ROM's usb downloader to
3250 activate upon a watchdog reset which is nice when iterating
3251 on U-Boot. Using the reset button or running bmode normal
3252 will set it back to normal. This command currently
3253 supports i.MX53 and i.MX6.
3254
Simon Glass35191a32013-06-13 15:10:02 -07003255- Signing support:
3256 CONFIG_RSA
3257
3258 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003259 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003260
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303261 The Modular Exponentiation algorithm in RSA is implemented using
3262 driver model. So CONFIG_DM needs to be enabled by default for this
3263 library to function.
3264
Simon Glass35191a32013-06-13 15:10:02 -07003265 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303266 option. The software based modular exponentiation is built into
3267 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003268
Heiko Schocher443ca402014-01-25 07:27:13 +01003269- bootcount support:
3270 CONFIG_BOOTCOUNT_LIMIT
3271
3272 This enables the bootcounter support, see:
3273 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3274
3275 CONFIG_AT91SAM9XE
3276 enable special bootcounter support on at91sam9xe based boards.
3277 CONFIG_BLACKFIN
3278 enable special bootcounter support on blackfin based boards.
3279 CONFIG_SOC_DA8XX
3280 enable special bootcounter support on da850 based boards.
3281 CONFIG_BOOTCOUNT_RAM
3282 enable support for the bootcounter in RAM
3283 CONFIG_BOOTCOUNT_I2C
3284 enable support for the bootcounter on an i2c (like RTC) device.
3285 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3286 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3287 the bootcounter.
3288 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003289
wdenkc0aa5c52003-12-06 19:49:23 +00003290- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003291 CONFIG_SHOW_BOOT_PROGRESS
3292
wdenk4a5c8a72003-03-06 00:02:04 +00003293 Defining this option allows to add some board-
3294 specific code (calling a user-provided function
3295 "show_boot_progress(int)") that enables you to show
3296 the system's boot progress on some display (for
3297 example, some LED's) on your board. At the moment,
3298 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003299
Simon Glass31a870e2012-02-13 13:51:19 +00003300- Detailed boot stage timing
3301 CONFIG_BOOTSTAGE
3302 Define this option to get detailed timing of each stage
3303 of the boot process.
3304
3305 CONFIG_BOOTSTAGE_USER_COUNT
3306 This is the number of available user bootstage records.
3307 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3308 a new ID will be allocated from this stash. If you exceed
3309 the limit, recording will stop.
3310
3311 CONFIG_BOOTSTAGE_REPORT
3312 Define this to print a report before boot, similar to this:
3313
3314 Timer summary in microseconds:
3315 Mark Elapsed Stage
3316 0 0 reset
3317 3,575,678 3,575,678 board_init_f start
3318 3,575,695 17 arch_cpu_init A9
3319 3,575,777 82 arch_cpu_init done
3320 3,659,598 83,821 board_init_r start
3321 3,910,375 250,777 main_loop
3322 29,916,167 26,005,792 bootm_start
3323 30,361,327 445,160 start_kernel
3324
Simon Glass4afd88e2012-09-28 08:56:39 +00003325 CONFIG_CMD_BOOTSTAGE
3326 Add a 'bootstage' command which supports printing a report
3327 and un/stashing of bootstage data.
3328
Simon Glass0fa36a42012-09-28 08:56:37 +00003329 CONFIG_BOOTSTAGE_FDT
3330 Stash the bootstage information in the FDT. A root 'bootstage'
3331 node is created with each bootstage id as a child. Each child
3332 has a 'name' property and either 'mark' containing the
3333 mark time in microsecond, or 'accum' containing the
3334 accumulated time for that bootstage id in microseconds.
3335 For example:
3336
3337 bootstage {
3338 154 {
3339 name = "board_init_f";
3340 mark = <3575678>;
3341 };
3342 170 {
3343 name = "lcd";
3344 accum = <33482>;
3345 };
3346 };
3347
3348 Code in the Linux kernel can find this in /proc/devicetree.
3349
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003350Legacy uImage format:
3351
wdenkc6097192002-11-03 00:24:07 +00003352 Arg Where When
3353 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003354 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003355 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003356 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003357 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003358 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003359 4 common/cmd_bootm.c Image data has correct checksum
3360 -4 common/cmd_bootm.c Image is for unsupported architecture
3361 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003362 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003363 6 common/cmd_bootm.c Image Type check OK
3364 -6 common/cmd_bootm.c gunzip uncompression error
3365 -7 common/cmd_bootm.c Unimplemented compression type
3366 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003367 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003368 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003369
3370 9 common/image.c Start initial ramdisk verification
3371 -10 common/image.c Ramdisk header has bad magic number
3372 -11 common/image.c Ramdisk header has bad checksum
3373 10 common/image.c Ramdisk header is OK
3374 -12 common/image.c Ramdisk data has bad checksum
3375 11 common/image.c Ramdisk data has correct checksum
3376 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003377 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003378 13 common/image.c Start multifile image verification
3379 14 common/image.c No initial ramdisk, no multifile, continue.
3380
Wolfgang Denk092ae952011-10-26 10:21:21 +00003381 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003382
Stefan Roese88fbf932010-04-15 16:07:28 +02003383 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003384 -31 post/post.c POST test failed, detected by post_output_backlog()
3385 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003386
Heiko Schocher633e03a2007-06-22 19:11:54 +02003387 34 common/cmd_doc.c before loading a Image from a DOC device
3388 -35 common/cmd_doc.c Bad usage of "doc" command
3389 35 common/cmd_doc.c correct usage of "doc" command
3390 -36 common/cmd_doc.c No boot device
3391 36 common/cmd_doc.c correct boot device
3392 -37 common/cmd_doc.c Unknown Chip ID on boot device
3393 37 common/cmd_doc.c correct chip ID found, device available
3394 -38 common/cmd_doc.c Read Error on boot device
3395 38 common/cmd_doc.c reading Image header from DOC device OK
3396 -39 common/cmd_doc.c Image header has bad magic number
3397 39 common/cmd_doc.c Image header has correct magic number
3398 -40 common/cmd_doc.c Error reading Image from DOC device
3399 40 common/cmd_doc.c Image header has correct magic number
3400 41 common/cmd_ide.c before loading a Image from a IDE device
3401 -42 common/cmd_ide.c Bad usage of "ide" command
3402 42 common/cmd_ide.c correct usage of "ide" command
3403 -43 common/cmd_ide.c No boot device
3404 43 common/cmd_ide.c boot device found
3405 -44 common/cmd_ide.c Device not available
3406 44 common/cmd_ide.c Device available
3407 -45 common/cmd_ide.c wrong partition selected
3408 45 common/cmd_ide.c partition selected
3409 -46 common/cmd_ide.c Unknown partition table
3410 46 common/cmd_ide.c valid partition table found
3411 -47 common/cmd_ide.c Invalid partition type
3412 47 common/cmd_ide.c correct partition type
3413 -48 common/cmd_ide.c Error reading Image Header on boot device
3414 48 common/cmd_ide.c reading Image Header from IDE device OK
3415 -49 common/cmd_ide.c Image header has bad magic number
3416 49 common/cmd_ide.c Image header has correct magic number
3417 -50 common/cmd_ide.c Image header has bad checksum
3418 50 common/cmd_ide.c Image header has correct checksum
3419 -51 common/cmd_ide.c Error reading Image from IDE device
3420 51 common/cmd_ide.c reading Image from IDE device OK
3421 52 common/cmd_nand.c before loading a Image from a NAND device
3422 -53 common/cmd_nand.c Bad usage of "nand" command
3423 53 common/cmd_nand.c correct usage of "nand" command
3424 -54 common/cmd_nand.c No boot device
3425 54 common/cmd_nand.c boot device found
3426 -55 common/cmd_nand.c Unknown Chip ID on boot device
3427 55 common/cmd_nand.c correct chip ID found, device available
3428 -56 common/cmd_nand.c Error reading Image Header on boot device
3429 56 common/cmd_nand.c reading Image Header from NAND device OK
3430 -57 common/cmd_nand.c Image header has bad magic number
3431 57 common/cmd_nand.c Image header has correct magic number
3432 -58 common/cmd_nand.c Error reading Image from NAND device
3433 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003434
Heiko Schocher633e03a2007-06-22 19:11:54 +02003435 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003436
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003437 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003438 -64 net/eth.c no Ethernet found.
3439 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003440
Heiko Schocher633e03a2007-06-22 19:11:54 +02003441 -80 common/cmd_net.c usage wrong
3442 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003443 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003444 81 common/cmd_net.c NetLoop() back without error
3445 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3446 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003447 83 common/cmd_net.c running "source" command
3448 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003449 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003450
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003451FIT uImage format:
3452
3453 Arg Where When
3454 100 common/cmd_bootm.c Kernel FIT Image has correct format
3455 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3456 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3457 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3458 102 common/cmd_bootm.c Kernel unit name specified
3459 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003460 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003461 104 common/cmd_bootm.c Got kernel subimage node offset
3462 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3463 105 common/cmd_bootm.c Kernel subimage hash verification OK
3464 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3465 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003466 -106 common/cmd_bootm.c Kernel subimage has wrong type
3467 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003468 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3469 108 common/cmd_bootm.c Got kernel subimage data/size
3470 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3471 -109 common/cmd_bootm.c Can't get kernel subimage type
3472 -110 common/cmd_bootm.c Can't get kernel subimage comp
3473 -111 common/cmd_bootm.c Can't get kernel subimage os
3474 -112 common/cmd_bootm.c Can't get kernel subimage load address
3475 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3476
3477 120 common/image.c Start initial ramdisk verification
3478 -120 common/image.c Ramdisk FIT image has incorrect format
3479 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003480 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003481 -122 common/image.c Can't get configuration for ramdisk subimage
3482 123 common/image.c Ramdisk unit name specified
3483 -124 common/image.c Can't get ramdisk subimage node offset
3484 125 common/image.c Got ramdisk subimage node offset
3485 -125 common/image.c Ramdisk subimage hash verification failed
3486 126 common/image.c Ramdisk subimage hash verification OK
3487 -126 common/image.c Ramdisk subimage for unsupported architecture
3488 127 common/image.c Architecture check OK
3489 -127 common/image.c Can't get ramdisk subimage data/size
3490 128 common/image.c Got ramdisk subimage data/size
3491 129 common/image.c Can't get ramdisk load address
3492 -129 common/image.c Got ramdisk load address
3493
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003494 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003495 131 common/cmd_doc.c FIT image format OK
3496
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003497 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003498 141 common/cmd_ide.c FIT image format OK
3499
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003500 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003501 151 common/cmd_nand.c FIT image format OK
3502
Heiko Schocher515eb122014-05-28 11:33:33 +02003503- legacy image format:
3504 CONFIG_IMAGE_FORMAT_LEGACY
3505 enables the legacy image format support in U-Boot.
3506
3507 Default:
3508 enabled if CONFIG_FIT_SIGNATURE is not defined.
3509
3510 CONFIG_DISABLE_IMAGE_LEGACY
3511 disable the legacy image format
3512
3513 This define is introduced, as the legacy image format is
3514 enabled per default for backward compatibility.
3515
Gabe Blackd572e162012-10-25 16:31:10 +00003516- FIT image support:
3517 CONFIG_FIT
3518 Enable support for the FIT uImage format.
3519
3520 CONFIG_FIT_BEST_MATCH
3521 When no configuration is explicitly selected, default to the
3522 one whose fdt's compatibility field best matches that of
3523 U-Boot itself. A match is considered "best" if it matches the
3524 most specific compatibility entry of U-Boot's fdt's root node.
3525 The order of entries in the configuration's fdt is ignored.
3526
Simon Glass58fe7e52013-06-13 15:10:00 -07003527 CONFIG_FIT_SIGNATURE
3528 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303529 using a hash signed and verified using RSA. If
3530 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3531 hashing is available using hardware, RSA library will use it.
3532 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003533
Heiko Schocher515eb122014-05-28 11:33:33 +02003534 WARNING: When relying on signed FIT images with required
3535 signature check the legacy image format is default
3536 disabled. If a board need legacy image format support
3537 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3538
Dirk Eibach88919ca2014-07-03 09:28:26 +02003539 CONFIG_FIT_DISABLE_SHA256
3540 Supporting SHA256 hashes has quite an impact on binary size.
3541 For constrained systems sha256 hash support can be disabled
3542 with this option.
3543
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003544- Standalone program support:
3545 CONFIG_STANDALONE_LOAD_ADDR
3546
Wolfgang Denk23f78482011-10-09 21:06:34 +02003547 This option defines a board specific value for the
3548 address where standalone program gets loaded, thus
3549 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003550 settings.
3551
3552- Frame Buffer Address:
3553 CONFIG_FB_ADDR
3554
3555 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003556 address for frame buffer. This is typically the case
3557 when using a graphics controller has separate video
3558 memory. U-Boot will then place the frame buffer at
3559 the given address instead of dynamically reserving it
3560 in system RAM by calling lcd_setmem(), which grabs
3561 the memory for the frame buffer depending on the
3562 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003563
3564 Please see board_init_f function.
3565
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003566- Automatic software updates via TFTP server
3567 CONFIG_UPDATE_TFTP
3568 CONFIG_UPDATE_TFTP_CNT_MAX
3569 CONFIG_UPDATE_TFTP_MSEC_MAX
3570
3571 These options enable and control the auto-update feature;
3572 for a more detailed description refer to doc/README.update.
3573
3574- MTD Support (mtdparts command, UBI support)
3575 CONFIG_MTD_DEVICE
3576
3577 Adds the MTD device infrastructure from the Linux kernel.
3578 Needed for mtdparts command support.
3579
3580 CONFIG_MTD_PARTITIONS
3581
3582 Adds the MTD partitioning infrastructure from the Linux
3583 kernel. Needed for UBI support.
3584
Heiko Schocherf5895d12014-06-24 10:10:04 +02003585 CONFIG_MTD_NAND_VERIFY_WRITE
3586 verify if the written data is correct reread.
3587
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003588- UBI support
3589 CONFIG_CMD_UBI
3590
3591 Adds commands for interacting with MTD partitions formatted
3592 with the UBI flash translation layer
3593
3594 Requires also defining CONFIG_RBTREE
3595
Joe Hershberger47550fc2013-04-08 10:32:49 +00003596 CONFIG_UBI_SILENCE_MSG
3597
3598 Make the verbose messages from UBI stop printing. This leaves
3599 warnings and errors enabled.
3600
Heiko Schocherf5895d12014-06-24 10:10:04 +02003601
3602 CONFIG_MTD_UBI_WL_THRESHOLD
3603 This parameter defines the maximum difference between the highest
3604 erase counter value and the lowest erase counter value of eraseblocks
3605 of UBI devices. When this threshold is exceeded, UBI starts performing
3606 wear leveling by means of moving data from eraseblock with low erase
3607 counter to eraseblocks with high erase counter.
3608
3609 The default value should be OK for SLC NAND flashes, NOR flashes and
3610 other flashes which have eraseblock life-cycle 100000 or more.
3611 However, in case of MLC NAND flashes which typically have eraseblock
3612 life-cycle less than 10000, the threshold should be lessened (e.g.,
3613 to 128 or 256, although it does not have to be power of 2).
3614
3615 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003616
Heiko Schocherf5895d12014-06-24 10:10:04 +02003617 CONFIG_MTD_UBI_BEB_LIMIT
3618 This option specifies the maximum bad physical eraseblocks UBI
3619 expects on the MTD device (per 1024 eraseblocks). If the
3620 underlying flash does not admit of bad eraseblocks (e.g. NOR
3621 flash), this value is ignored.
3622
3623 NAND datasheets often specify the minimum and maximum NVM
3624 (Number of Valid Blocks) for the flashes' endurance lifetime.
3625 The maximum expected bad eraseblocks per 1024 eraseblocks
3626 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3627 which gives 20 for most NANDs (MaxNVB is basically the total
3628 count of eraseblocks on the chip).
3629
3630 To put it differently, if this value is 20, UBI will try to
3631 reserve about 1.9% of physical eraseblocks for bad blocks
3632 handling. And that will be 1.9% of eraseblocks on the entire
3633 NAND chip, not just the MTD partition UBI attaches. This means
3634 that if you have, say, a NAND flash chip admits maximum 40 bad
3635 eraseblocks, and it is split on two MTD partitions of the same
3636 size, UBI will reserve 40 eraseblocks when attaching a
3637 partition.
3638
3639 default: 20
3640
3641 CONFIG_MTD_UBI_FASTMAP
3642 Fastmap is a mechanism which allows attaching an UBI device
3643 in nearly constant time. Instead of scanning the whole MTD device it
3644 only has to locate a checkpoint (called fastmap) on the device.
3645 The on-flash fastmap contains all information needed to attach
3646 the device. Using fastmap makes only sense on large devices where
3647 attaching by scanning takes long. UBI will not automatically install
3648 a fastmap on old images, but you can set the UBI parameter
3649 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3650 that fastmap-enabled images are still usable with UBI implementations
3651 without fastmap support. On typical flash devices the whole fastmap
3652 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3653
3654 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3655 Set this parameter to enable fastmap automatically on images
3656 without a fastmap.
3657 default: 0
3658
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003659- UBIFS support
3660 CONFIG_CMD_UBIFS
3661
3662 Adds commands for interacting with UBI volumes formatted as
3663 UBIFS. UBIFS is read-only in u-boot.
3664
3665 Requires UBI support as well as CONFIG_LZO
3666
Joe Hershberger47550fc2013-04-08 10:32:49 +00003667 CONFIG_UBIFS_SILENCE_MSG
3668
3669 Make the verbose messages from UBIFS stop printing. This leaves
3670 warnings and errors enabled.
3671
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003672- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003673 CONFIG_SPL
3674 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003675
Tom Rini36853852012-02-14 07:29:40 +00003676 CONFIG_SPL_LDSCRIPT
3677 LDSCRIPT for linking the SPL binary.
3678
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003679 CONFIG_SPL_MAX_FOOTPRINT
3680 Maximum size in memory allocated to the SPL, BSS included.
3681 When defined, the linker checks that the actual memory
3682 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003683 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003684 must not be both defined at the same time.
3685
Tom Rini36853852012-02-14 07:29:40 +00003686 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003687 Maximum size of the SPL image (text, data, rodata, and
3688 linker lists sections), BSS excluded.
3689 When defined, the linker checks that the actual size does
3690 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003691
Wolfgang Denk825223d2011-09-11 21:24:09 +02003692 CONFIG_SPL_TEXT_BASE
3693 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003694
Scott Woodc4f0d002012-09-20 19:05:12 -05003695 CONFIG_SPL_RELOC_TEXT_BASE
3696 Address to relocate to. If unspecified, this is equal to
3697 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3698
Tom Rini36853852012-02-14 07:29:40 +00003699 CONFIG_SPL_BSS_START_ADDR
3700 Link address for the BSS within the SPL binary.
3701
3702 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003703 Maximum size in memory allocated to the SPL BSS.
3704 When defined, the linker checks that the actual memory used
3705 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003706 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003707 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003708
3709 CONFIG_SPL_STACK
3710 Adress of the start of the stack SPL will use
3711
Scott Woodc4f0d002012-09-20 19:05:12 -05003712 CONFIG_SPL_RELOC_STACK
3713 Adress of the start of the stack SPL will use after
3714 relocation. If unspecified, this is equal to
3715 CONFIG_SPL_STACK.
3716
Tom Rini36853852012-02-14 07:29:40 +00003717 CONFIG_SYS_SPL_MALLOC_START
3718 Starting address of the malloc pool used in SPL.
3719
3720 CONFIG_SYS_SPL_MALLOC_SIZE
3721 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003722
Tom Rini28591df2012-08-13 12:03:19 -07003723 CONFIG_SPL_FRAMEWORK
3724 Enable the SPL framework under common/. This framework
3725 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3726 NAND loading of the Linux Kernel.
3727
Tom Rinic2b76002014-03-28 12:03:39 -04003728 CONFIG_SPL_OS_BOOT
3729 Enable booting directly to an OS from SPL.
3730 See also: doc/README.falcon
3731
Tom Rinife3b0c72012-08-13 11:37:56 -07003732 CONFIG_SPL_DISPLAY_PRINT
3733 For ARM, enable an optional function to print more information
3734 about the running system.
3735
Scott Wood7c810902012-09-20 16:35:21 -05003736 CONFIG_SPL_INIT_MINIMAL
3737 Arch init code should be built for a very small image
3738
Wolfgang Denk825223d2011-09-11 21:24:09 +02003739 CONFIG_SPL_LIBCOMMON_SUPPORT
3740 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003741
Wolfgang Denk825223d2011-09-11 21:24:09 +02003742 CONFIG_SPL_LIBDISK_SUPPORT
3743 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003744
Wolfgang Denk825223d2011-09-11 21:24:09 +02003745 CONFIG_SPL_I2C_SUPPORT
3746 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003747
Wolfgang Denk825223d2011-09-11 21:24:09 +02003748 CONFIG_SPL_GPIO_SUPPORT
3749 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003750
Wolfgang Denk825223d2011-09-11 21:24:09 +02003751 CONFIG_SPL_MMC_SUPPORT
3752 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003753
Tom Rini36853852012-02-14 07:29:40 +00003754 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3755 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003756 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003757 when the MMC is being used in raw mode.
3758
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003759 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3760 Partition on the MMC to load U-Boot from when the MMC is being
3761 used in raw mode
3762
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003763 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3764 Sector to load kernel uImage from when MMC is being
3765 used in raw mode (for Falcon mode)
3766
3767 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3768 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3769 Sector and number of sectors to load kernel argument
3770 parameters from when MMC is being used in raw mode
3771 (for falcon mode)
3772
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003773 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3774 Partition on the MMC to load U-Boot from when the MMC is being
3775 used in fs mode
3776
Tom Rini36853852012-02-14 07:29:40 +00003777 CONFIG_SPL_FAT_SUPPORT
3778 Support for fs/fat/libfat.o in SPL binary
3779
Guillaume GARDET5065b712014-10-15 17:53:13 +02003780 CONFIG_SPL_EXT_SUPPORT
3781 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003782
Guillaume GARDET5065b712014-10-15 17:53:13 +02003783 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3784 Filename to read to load U-Boot when reading from filesystem
3785
3786 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003787 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003788 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003789
Guillaume GARDET5065b712014-10-15 17:53:13 +02003790 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003791 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003792 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003793
Scott Wood2b36fbb2012-12-06 13:33:17 +00003794 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3795 Set this for NAND SPL on PPC mpc83xx targets, so that
3796 start.S waits for the rest of the SPL to load before
3797 continuing (the hardware starts execution after just
3798 loading the first page rather than the full 4K).
3799
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303800 CONFIG_SPL_SKIP_RELOCATE
3801 Avoid SPL relocation
3802
Scott Woodc352a0c2012-09-20 19:09:07 -05003803 CONFIG_SPL_NAND_BASE
3804 Include nand_base.c in the SPL. Requires
3805 CONFIG_SPL_NAND_DRIVERS.
3806
3807 CONFIG_SPL_NAND_DRIVERS
3808 SPL uses normal NAND drivers, not minimal drivers.
3809
3810 CONFIG_SPL_NAND_ECC
3811 Include standard software ECC in the SPL
3812
Tom Rini36853852012-02-14 07:29:40 +00003813 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003814 Support for NAND boot using simple NAND drivers that
3815 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003816
Tom Rini543c9f12014-03-28 12:03:36 -04003817 CONFIG_SPL_MTD_SUPPORT
3818 Support for the MTD subsystem within SPL. Useful for
3819 environment on NAND support within SPL.
3820
Heiko Schochercf000272014-10-31 08:31:00 +01003821 CONFIG_SPL_NAND_RAW_ONLY
3822 Support to boot only raw u-boot.bin images. Use this only
3823 if you need to save space.
3824
Ying Zhang9ff70262013-08-16 15:16:11 +08003825 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3826 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003827 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003828
Ying Zhangdfb2b152013-08-16 15:16:12 +08003829 CONFIG_SPL_COMMON_INIT_DDR
3830 Set for common ddr init with serial presence detect in
3831 SPL binary.
3832
Tom Rini36853852012-02-14 07:29:40 +00003833 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3834 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3835 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3836 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3837 CONFIG_SYS_NAND_ECCBYTES
3838 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003839 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003840
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303841 CONFIG_SPL_NAND_BOOT
3842 Add support NAND boot
3843
Tom Rini36853852012-02-14 07:29:40 +00003844 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003845 Location in NAND to read U-Boot from
3846
3847 CONFIG_SYS_NAND_U_BOOT_DST
3848 Location in memory to load U-Boot to
3849
3850 CONFIG_SYS_NAND_U_BOOT_SIZE
3851 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003852
3853 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003854 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003855
3856 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3857 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003858 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003859
3860 CONFIG_SPL_OMAP3_ID_NAND
3861 Support for an OMAP3-specific set of functions to return the
3862 ID and MFR of the first attached NAND chip, if present.
3863
Wolfgang Denk825223d2011-09-11 21:24:09 +02003864 CONFIG_SPL_SERIAL_SUPPORT
3865 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003866
Wolfgang Denk825223d2011-09-11 21:24:09 +02003867 CONFIG_SPL_SPI_FLASH_SUPPORT
3868 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003869
Wolfgang Denk825223d2011-09-11 21:24:09 +02003870 CONFIG_SPL_SPI_SUPPORT
3871 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003872
Pavel Machekde997252012-08-30 22:42:11 +02003873 CONFIG_SPL_RAM_DEVICE
3874 Support for running image already present in ram, in SPL binary
3875
Wolfgang Denk825223d2011-09-11 21:24:09 +02003876 CONFIG_SPL_LIBGENERIC_SUPPORT
3877 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003878
Ying Zhang602f7d32013-05-20 14:07:25 +08003879 CONFIG_SPL_ENV_SUPPORT
3880 Support for the environment operating in SPL binary
3881
3882 CONFIG_SPL_NET_SUPPORT
3883 Support for the net/libnet.o in SPL binary.
3884 It conflicts with SPL env from storage medium specified by
3885 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3886
Scott Woodeb7bd972012-12-06 13:33:16 +00003887 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003888 Image offset to which the SPL should be padded before appending
3889 the SPL payload. By default, this is defined as
3890 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3891 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3892 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003893
Scott Woodf147eb72012-09-21 16:27:32 -05003894 CONFIG_SPL_TARGET
3895 Final target image containing SPL and payload. Some SPLs
3896 use an arch-specific makefile fragment instead, for
3897 example if more than one image needs to be produced.
3898
Simon Glass82d94532013-05-08 08:05:59 +00003899 CONFIG_FIT_SPL_PRINT
3900 Printing information about a FIT image adds quite a bit of
3901 code to SPL. So this is normally disabled in SPL. Use this
3902 option to re-enable it. This will affect the output of the
3903 bootm command when booting a FIT image.
3904
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003905- TPL framework
3906 CONFIG_TPL
3907 Enable building of TPL globally.
3908
3909 CONFIG_TPL_PAD_TO
3910 Image offset to which the TPL should be padded before appending
3911 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003912 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3913 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3914 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003915
wdenkc6097192002-11-03 00:24:07 +00003916Modem Support:
3917--------------
3918
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003919[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003920
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003921- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003922 CONFIG_MODEM_SUPPORT
3923
3924- RTS/CTS Flow control enable:
3925 CONFIG_HWFLOW
3926
3927- Modem debug support:
3928 CONFIG_MODEM_SUPPORT_DEBUG
3929
wdenk4a5c8a72003-03-06 00:02:04 +00003930 Enables debugging stuff (char screen[1024], dbg())
3931 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003932
wdenkc0aa5c52003-12-06 19:49:23 +00003933- Interrupt support (PPC):
3934
wdenk1ebf41e2004-01-02 14:00:00 +00003935 There are common interrupt_init() and timer_interrupt()
3936 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003937 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003938 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003939 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003940 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003941 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003942 specific handling. If board has watchdog / status_led
3943 / other_activity_monitor it works automatically from
3944 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003945
wdenkc6097192002-11-03 00:24:07 +00003946- General:
3947
wdenk4a5c8a72003-03-06 00:02:04 +00003948 In the target system modem support is enabled when a
3949 specific key (key combination) is pressed during
3950 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003951 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003952 board_init(). Currently key_pressed() is a dummy
3953 function, returning 1 and thus enabling modem
3954 initialization.
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk4a5c8a72003-03-06 00:02:04 +00003956 If there are no modem init strings in the
3957 environment, U-Boot proceed to autoboot; the
3958 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003959 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003960
3961 See also: doc/README.Modem
3962
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003963Board initialization settings:
3964------------------------------
3965
3966During Initialization u-boot calls a number of board specific functions
3967to allow the preparation of board specific prerequisites, e.g. pin setup
3968before drivers are initialized. To enable these callbacks the
3969following configuration macros have to be defined. Currently this is
3970architecture specific, so please check arch/your_architecture/lib/board.c
3971typically in board_init_f() and board_init_r().
3972
3973- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3974- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3975- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3976- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003977
wdenkc6097192002-11-03 00:24:07 +00003978Configuration Settings:
3979-----------------------
3980
York Sun6c480012014-02-26 17:03:19 -08003981- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3982 Optionally it can be defined to support 64-bit memory commands.
3983
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003984- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003985 undefine this when you're short of memory.
3986
Peter Tyserdfb72b82009-01-27 18:03:12 -06003987- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3988 width of the commands listed in the 'help' command output.
3989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003990- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003991 prompt for user input.
3992
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003993- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003994
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003995- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003996
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003997- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003998
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003999- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00004000 the application (usually a Linux kernel) when it is
4001 booted
4002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004003- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00004004 List of legal baudrate settings for this board.
4005
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004006- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00004007 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00004008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004009- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00004010 If the board specific function
4011 extern int overwrite_console (void);
4012 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00004013 serial port, else the settings in the environment are used.
4014
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004015- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00004016 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00004017
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004018- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00004019 Enable overwrite of previous console environment settings.
4020
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004021- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00004022 Begin and End addresses of the area used by the
4023 simple memory test.
4024
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004025- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00004026 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00004027
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004028- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00004029 Scratch address used by the alternate memory test
4030 You only need to set this if address zero isn't writeable
4031
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004032- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
4033 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01004034 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004035 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01004036 fixing up gd->ram_size the Linux kernel should gets passed
4037 the now "corrected" memory size and won't touch it either.
4038 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01004039 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01004040 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01004041 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01004042
4043 This option can be used as a workaround for the 440EPx/GRx
4044 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
4045 be touched.
4046
4047 WARNING: Please make sure that this value is a multiple of
4048 the Linux page size (normally 4k). If this is not the case,
4049 then the end address of the Linux memory will be located at a
4050 non page size aligned address and this could cause major
4051 problems.
4052
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004053- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00004054 Enable temporary baudrate change while serial download
4055
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004056- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00004057 Physical start address of SDRAM. _Must_ be 0 here.
4058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004059- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00004060 Physical start address of Motherboard I/O (if using a
4061 Cogent motherboard)
4062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004063- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00004064 Physical start address of Flash memory.
4065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004066- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00004067 Physical start address of boot monitor code (set by
4068 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02004069 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004070 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00004071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004072- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00004073 Size of memory reserved for monitor code, used to
4074 determine _at_compile_time_ (!) if the environment is
4075 embedded within the U-Boot image, or in a separate
4076 flash sector.
wdenkc6097192002-11-03 00:24:07 +00004077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004078- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00004079 Size of DRAM reserved for malloc() use.
4080
Simon Glass863e4042014-07-10 22:23:28 -06004081- CONFIG_SYS_MALLOC_F_LEN
4082 Size of the malloc() pool for use before relocation. If
4083 this is defined, then a very simple malloc() implementation
4084 will become available before relocation. The address is just
4085 below the global data, and the stack is moved down to make
4086 space.
4087
4088 This feature allocates regions with increasing addresses
4089 within the region. calloc() is supported, but realloc()
4090 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004091 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06004092 U-Boot relocates itself.
4093
Simon Glasse997f752014-09-15 06:33:18 -06004094 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06004095 at present but is fairly easy to enable for other archs.
4096
Simon Glass9fa901b2014-11-10 17:16:54 -07004097- CONFIG_SYS_MALLOC_SIMPLE
4098 Provides a simple and small malloc() and calloc() for those
4099 boards which do not use the full malloc in SPL (which is
4100 enabled with CONFIG_SYS_SPL_MALLOC_START).
4101
Thierry Redingc97d9742014-12-09 22:25:22 -07004102- CONFIG_SYS_NONCACHED_MEMORY:
4103 Size of non-cached memory area. This area of memory will be
4104 typically located right below the malloc() area and mapped
4105 uncached in the MMU. This is useful for drivers that would
4106 otherwise require a lot of explicit cache maintenance. For
4107 some drivers it's also impossible to properly maintain the
4108 cache. For example if the regions that need to be flushed
4109 are not a multiple of the cache-line size, *and* padding
4110 cannot be allocated between the regions to align them (i.e.
4111 if the HW requires a contiguous array of regions, and the
4112 size of each region is not cache-aligned), then a flush of
4113 one region may result in overwriting data that hardware has
4114 written to another region in the same cache-line. This can
4115 happen for example in network drivers where descriptors for
4116 buffers are typically smaller than the CPU cache-line (e.g.
4117 16 bytes vs. 32 or 64 bytes).
4118
4119 Non-cached memory is only supported on 32-bit ARM at present.
4120
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004121- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01004122 Normally compressed uImages are limited to an
4123 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004124 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01004125 to adjust this setting to your needs.
4126
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004127- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004128 Maximum size of memory mapped by the startup code of
4129 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004130 the Linux kernel (bd_info, boot arguments, FDT blob if
4131 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004132 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004133 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004134 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004135 variable "bootm_mapsize" will override the value of
4136 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4137 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004138
John Rigbyeea8e692010-10-13 13:57:35 -06004139- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4140 Enable initrd_high functionality. If defined then the
4141 initrd_high feature is enabled and the bootm ramdisk subcommand
4142 is enabled.
4143
4144- CONFIG_SYS_BOOT_GET_CMDLINE:
4145 Enables allocating and saving kernel cmdline in space between
4146 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4147
4148- CONFIG_SYS_BOOT_GET_KBD:
4149 Enables allocating and saving a kernel copy of the bd_info in
4150 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4151
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004152- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004153 Max number of Flash memory banks
4154
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004155- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004156 Max number of sectors on a Flash chip
4157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004158- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004159 Timeout for Flash erase operations (in ms)
4160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004161- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004162 Timeout for Flash write operations (in ms)
4163
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004164- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004165 Timeout for Flash set sector lock bit operation (in ms)
4166
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004167- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004168 Timeout for Flash clear lock bits operation (in ms)
4169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004170- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004171 If defined, hardware flash sectors protection is used
4172 instead of U-Boot software protection.
4173
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004174- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004175
4176 Enable TFTP transfers directly to flash memory;
4177 without this option such a download has to be
4178 performed in two steps: (1) download to RAM, and (2)
4179 copy from RAM to flash.
4180
4181 The two-step approach is usually more reliable, since
4182 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004183 the flash, but in some situations (when system RAM is
4184 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004185 downloaded image) this option may be very useful.
4186
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004187- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004188 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004189 common flash structure for storing flash geometry.
4190
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004191- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004192 This option also enables the building of the cfi_flash driver
4193 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004194
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004195- CONFIG_FLASH_CFI_MTD
4196 This option enables the building of the cfi_mtd driver
4197 in the drivers directory. The driver exports CFI flash
4198 to the MTD layer.
4199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004200- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004201 Use buffered writes to flash.
4202
4203- CONFIG_FLASH_SPANSION_S29WS_N
4204 s29ws-n MirrorBit flash has non-standard addresses for buffered
4205 write commands.
4206
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004207- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004208 If this option is defined, the common CFI flash doesn't
4209 print it's warning upon not recognized FLASH banks. This
4210 is useful, if some of the configured banks are only
4211 optionally available.
4212
Jerry Van Barenaae73572008-03-08 13:48:01 -05004213- CONFIG_FLASH_SHOW_PROGRESS
4214 If defined (must be an integer), print out countdown
4215 digits and dots. Recommended value: 45 (9..1) for 80
4216 column displays, 15 (3..1) for 40 column displays.
4217
Stefan Roesed20cba52013-04-04 15:53:14 +02004218- CONFIG_FLASH_VERIFY
4219 If defined, the content of the flash (destination) is compared
4220 against the source after the write operation. An error message
4221 will be printed when the contents are not identical.
4222 Please note that this option is useless in nearly all cases,
4223 since such flash programming errors usually are detected earlier
4224 while unprotecting/erasing/programming. Please only enable
4225 this option if you really know what you are doing.
4226
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004227- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004228 Defines the number of Ethernet receive buffers. On some
4229 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004230 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4231 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004232 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004233 Defaults to 4 if not defined.
4234
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004235- CONFIG_ENV_MAX_ENTRIES
4236
Wolfgang Denk1136f692010-10-27 22:48:30 +02004237 Maximum number of entries in the hash table that is used
4238 internally to store the environment settings. The default
4239 setting is supposed to be generous and should work in most
4240 cases. This setting can be used to tune behaviour; see
4241 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004242
Joe Hershberger71497d02012-12-11 22:16:31 -06004243- CONFIG_ENV_FLAGS_LIST_DEFAULT
4244- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004245 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004246 calling env set. Variables can be restricted to only decimal,
4247 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4248 the variables can also be restricted to IP address or MAC address.
4249
4250 The format of the list is:
4251 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004252 access_attribute = [a|r|o|c]
4253 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004254 entry = variable_name[:attributes]
4255 list = entry[,list]
4256
4257 The type attributes are:
4258 s - String (default)
4259 d - Decimal
4260 x - Hexadecimal
4261 b - Boolean ([1yYtT|0nNfF])
4262 i - IP address
4263 m - MAC address
4264
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004265 The access attributes are:
4266 a - Any (default)
4267 r - Read-only
4268 o - Write-once
4269 c - Change-default
4270
Joe Hershberger71497d02012-12-11 22:16:31 -06004271 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4272 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004273 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004274
4275 - CONFIG_ENV_FLAGS_LIST_STATIC
4276 Define this to a list (string) to define validation that
4277 should be done if an entry is not found in the ".flags"
4278 environment variable. To override a setting in the static
4279 list, simply add an entry for the same variable name to the
4280 ".flags" variable.
4281
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004282- CONFIG_ENV_ACCESS_IGNORE_FORCE
4283 If defined, don't allow the -f switch to env set override variable
4284 access flags.
4285
Simon Glass66828322013-03-08 13:45:27 +00004286- CONFIG_SYS_GENERIC_BOARD
4287 This selects the architecture-generic board system instead of the
4288 architecture-specific board files. It is intended to move boards
4289 to this new framework over time. Defining this will disable the
4290 arch/foo/lib/board.c file and use common/board_f.c and
4291 common/board_r.c instead. To use this option your architecture
4292 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4293 its config.mk file). If you find problems enabling this option on
4294 your board please report the problem and send patches!
4295
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004296- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4297 This is set by OMAP boards for the max time that reset should
4298 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004299 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004300
Gabe Black3687fe42014-10-15 04:38:30 -06004301- CONFIG_USE_STDINT
4302 If stdint.h is available with your toolchain you can define this
4303 option to enable it. You can provide option 'USE_STDINT=1' when
4304 building U-Boot to enable this.
4305
wdenkc6097192002-11-03 00:24:07 +00004306The following definitions that deal with the placement and management
4307of environment data (variable area); in general, we support the
4308following configurations:
4309
Mike Frysinger63b8f122011-07-08 10:44:25 +00004310- CONFIG_BUILD_ENVCRC:
4311
4312 Builds up envcrc with the target environment so that external utils
4313 may easily extract it and embed it in final U-Boot images.
4314
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004315- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004316
4317 Define this if the environment is in flash memory.
4318
4319 a) The environment occupies one whole flash sector, which is
4320 "embedded" in the text segment with the U-Boot code. This
4321 happens usually with "bottom boot sector" or "top boot
4322 sector" type flash chips, which have several smaller
4323 sectors at the start or the end. For instance, such a
4324 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4325 such a case you would place the environment in one of the
4326 4 kB sectors - with U-Boot code before and after it. With
4327 "top boot sector" type flash chips, you would put the
4328 environment in one of the last sectors, leaving a gap
4329 between U-Boot and the environment.
4330
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004331 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004332
4333 Offset of environment data (variable area) to the
4334 beginning of flash memory; for instance, with bottom boot
4335 type flash chips the second sector can be used: the offset
4336 for this sector is given here.
4337
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004338 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004339
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004340 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004341
4342 This is just another way to specify the start address of
4343 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004344 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004345
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004346 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004347
4348 Size of the sector containing the environment.
4349
4350
4351 b) Sometimes flash chips have few, equal sized, BIG sectors.
4352 In such a case you don't want to spend a whole sector for
4353 the environment.
4354
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004355 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004356
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004357 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004358 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004359 of this flash sector for the environment. This saves
4360 memory for the RAM copy of the environment.
4361
4362 It may also save flash memory if you decide to use this
4363 when your environment is "embedded" within U-Boot code,
4364 since then the remainder of the flash sector could be used
4365 for U-Boot code. It should be pointed out that this is
4366 STRONGLY DISCOURAGED from a robustness point of view:
4367 updating the environment in flash makes it always
4368 necessary to erase the WHOLE sector. If something goes
4369 wrong before the contents has been restored from a copy in
4370 RAM, your target system will be dead.
4371
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004372 - CONFIG_ENV_ADDR_REDUND
4373 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk4a5c8a72003-03-06 00:02:04 +00004375 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004376 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004377 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004378 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004379
4380BE CAREFUL! Any changes to the flash layout, and some changes to the
4381source code will make it necessary to adapt <board>/u-boot.lds*
4382accordingly!
4383
4384
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004385- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004386
4387 Define this if you have some non-volatile memory device
4388 (NVRAM, battery buffered SRAM) which you want to use for the
4389 environment.
4390
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004391 - CONFIG_ENV_ADDR:
4392 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004393
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004394 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004395 want to use for environment. It is assumed that this memory
4396 can just be read and written to, without any special
4397 provision.
4398
4399BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004400in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004401console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004402U-Boot will hang.
4403
4404Please note that even with NVRAM we still use a copy of the
4405environment in RAM: we could work on NVRAM directly, but we want to
4406keep settings there always unmodified except somebody uses "saveenv"
4407to save the current settings.
4408
4409
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004410- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004411
4412 Use this if you have an EEPROM or similar serial access
4413 device and a driver for it.
4414
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004415 - CONFIG_ENV_OFFSET:
4416 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004417
4418 These two #defines specify the offset and size of the
4419 environment area within the total memory of your EEPROM.
4420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004421 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004422 If defined, specified the chip address of the EEPROM device.
4423 The default address is zero.
4424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004425 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004426 If defined, the number of bits used to address bytes in a
4427 single page in the EEPROM device. A 64 byte page, for example
4428 would require six bits.
4429
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004430 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004431 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004432 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004434 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004435 The length in bytes of the EEPROM memory array address. Note
4436 that this is NOT the chip address length!
4437
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004438 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004439 EEPROM chips that implement "address overflow" are ones
4440 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4441 address and the extra bits end up in the "chip address" bit
4442 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4443 byte chips.
4444
4445 Note that we consider the length of the address field to
4446 still be one byte because the extra address bits are hidden
4447 in the chip address.
4448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004449 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004450 The size in bytes of the EEPROM device.
4451
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004452 - CONFIG_ENV_EEPROM_IS_ON_I2C
4453 define this, if you have I2C and SPI activated, and your
4454 EEPROM, which holds the environment, is on the I2C bus.
4455
4456 - CONFIG_I2C_ENV_EEPROM_BUS
4457 if you have an Environment on an EEPROM reached over
4458 I2C muxes, you can define here, how to reach this
4459 EEPROM. For example:
4460
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004461 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004462
4463 EEPROM which holds the environment, is reached over
4464 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004465
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004466- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004467
wdenk1ebf41e2004-01-02 14:00:00 +00004468 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004469 want to use for the environment.
4470
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004471 - CONFIG_ENV_OFFSET:
4472 - CONFIG_ENV_ADDR:
4473 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004474
4475 These three #defines specify the offset and size of the
4476 environment area within the total memory of your DataFlash placed
4477 at the specified address.
4478
Wu, Josh76db7bf2014-07-01 19:30:13 +08004479- CONFIG_ENV_IS_IN_SPI_FLASH:
4480
4481 Define this if you have a SPI Flash memory device which you
4482 want to use for the environment.
4483
4484 - CONFIG_ENV_OFFSET:
4485 - CONFIG_ENV_SIZE:
4486
4487 These two #defines specify the offset and size of the
4488 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4489 aligned to an erase sector boundary.
4490
4491 - CONFIG_ENV_SECT_SIZE:
4492
4493 Define the SPI flash's sector size.
4494
4495 - CONFIG_ENV_OFFSET_REDUND (optional):
4496
4497 This setting describes a second storage area of CONFIG_ENV_SIZE
4498 size used to hold a redundant copy of the environment data, so
4499 that there is a valid backup copy in case there is a power failure
4500 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4501 aligned to an erase sector boundary.
4502
4503 - CONFIG_ENV_SPI_BUS (optional):
4504 - CONFIG_ENV_SPI_CS (optional):
4505
4506 Define the SPI bus and chip select. If not defined they will be 0.
4507
4508 - CONFIG_ENV_SPI_MAX_HZ (optional):
4509
4510 Define the SPI max work clock. If not defined then use 1MHz.
4511
4512 - CONFIG_ENV_SPI_MODE (optional):
4513
4514 Define the SPI work mode. If not defined then use SPI_MODE_3.
4515
Liu Gang85bcd732012-03-08 00:33:20 +00004516- CONFIG_ENV_IS_IN_REMOTE:
4517
4518 Define this if you have a remote memory space which you
4519 want to use for the local device's environment.
4520
4521 - CONFIG_ENV_ADDR:
4522 - CONFIG_ENV_SIZE:
4523
4524 These two #defines specify the address and size of the
4525 environment area within the remote memory space. The
4526 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004527 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004528
4529BE CAREFUL! For some special cases, the local device can not use
4530"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004531environment stored in a remote NOR flash by SRIO or PCIE link,
4532but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004533
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004534- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004535
4536 Define this if you have a NAND device which you want to use
4537 for the environment.
4538
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004539 - CONFIG_ENV_OFFSET:
4540 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004541
4542 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004543 area within the first NAND device. CONFIG_ENV_OFFSET must be
4544 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004545
Scott Wood08239322010-09-17 14:38:37 -05004546 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004547
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004548 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004549 size used to hold a redundant copy of the environment data, so
4550 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004551 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004552 aligned to an erase block boundary.
4553
4554 - CONFIG_ENV_RANGE (optional):
4555
4556 Specifies the length of the region in which the environment
4557 can be written. This should be a multiple of the NAND device's
4558 block size. Specifying a range with more erase blocks than
4559 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4560 the range to be avoided.
4561
4562 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004563
Scott Wood08239322010-09-17 14:38:37 -05004564 Enables support for dynamically retrieving the offset of the
4565 environment from block zero's out-of-band data. The
4566 "nand env.oob" command can be used to record this offset.
4567 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4568 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004569
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004570- CONFIG_NAND_ENV_DST
4571
4572 Defines address in RAM to which the nand_spl code should copy the
4573 environment. If redundant environment is used, it will be copied to
4574 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4575
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004576- CONFIG_ENV_IS_IN_UBI:
4577
4578 Define this if you have an UBI volume that you want to use for the
4579 environment. This has the benefit of wear-leveling the environment
4580 accesses, which is important on NAND.
4581
4582 - CONFIG_ENV_UBI_PART:
4583
4584 Define this to a string that is the mtd partition containing the UBI.
4585
4586 - CONFIG_ENV_UBI_VOLUME:
4587
4588 Define this to the name of the volume that you want to store the
4589 environment in.
4590
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004591 - CONFIG_ENV_UBI_VOLUME_REDUND:
4592
4593 Define this to the name of another volume to store a second copy of
4594 the environment in. This will enable redundant environments in UBI.
4595 It is assumed that both volumes are in the same MTD partition.
4596
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004597 - CONFIG_UBI_SILENCE_MSG
4598 - CONFIG_UBIFS_SILENCE_MSG
4599
4600 You will probably want to define these to avoid a really noisy system
4601 when storing the env in UBI.
4602
Wu, Josha7d0c872014-06-24 17:31:03 +08004603- CONFIG_ENV_IS_IN_FAT:
4604 Define this if you want to use the FAT file system for the environment.
4605
4606 - FAT_ENV_INTERFACE:
4607
4608 Define this to a string that is the name of the block device.
4609
4610 - FAT_ENV_DEV_AND_PART:
4611
4612 Define this to a string to specify the partition of the device. It can
4613 be as following:
4614
4615 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4616 - "D:P": device D partition P. Error occurs if device D has no
4617 partition table.
4618 - "D:0": device D.
4619 - "D" or "D:": device D partition 1 if device D has partition
4620 table, or the whole device D if has no partition
4621 table.
4622 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004623 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004624 partition table then means device D.
4625
4626 - FAT_ENV_FILE:
4627
4628 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004629 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004630
4631 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004632 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004633
Stephen Warreneedcacd2013-06-11 15:14:00 -06004634- CONFIG_ENV_IS_IN_MMC:
4635
4636 Define this if you have an MMC device which you want to use for the
4637 environment.
4638
4639 - CONFIG_SYS_MMC_ENV_DEV:
4640
4641 Specifies which MMC device the environment is stored in.
4642
4643 - CONFIG_SYS_MMC_ENV_PART (optional):
4644
4645 Specifies which MMC partition the environment is stored in. If not
4646 set, defaults to partition 0, the user area. Common values might be
4647 1 (first MMC boot partition), 2 (second MMC boot partition).
4648
4649 - CONFIG_ENV_OFFSET:
4650 - CONFIG_ENV_SIZE:
4651
4652 These two #defines specify the offset and size of the environment
4653 area within the specified MMC device.
4654
Stephen Warren24dc2032013-06-11 15:14:02 -06004655 If offset is positive (the usual case), it is treated as relative to
4656 the start of the MMC partition. If offset is negative, it is treated
4657 as relative to the end of the MMC partition. This can be useful if
4658 your board may be fitted with different MMC devices, which have
4659 different sizes for the MMC partitions, and you always want the
4660 environment placed at the very end of the partition, to leave the
4661 maximum possible space before it, to store other data.
4662
Stephen Warreneedcacd2013-06-11 15:14:00 -06004663 These two values are in units of bytes, but must be aligned to an
4664 MMC sector boundary.
4665
4666 - CONFIG_ENV_OFFSET_REDUND (optional):
4667
4668 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4669 hold a redundant copy of the environment data. This provides a
4670 valid backup copy in case the other copy is corrupted, e.g. due
4671 to a power failure during a "saveenv" operation.
4672
Stephen Warren24dc2032013-06-11 15:14:02 -06004673 This value may also be positive or negative; this is handled in the
4674 same way as CONFIG_ENV_OFFSET.
4675
Stephen Warreneedcacd2013-06-11 15:14:00 -06004676 This value is also in units of bytes, but must also be aligned to
4677 an MMC sector boundary.
4678
4679 - CONFIG_ENV_SIZE_REDUND (optional):
4680
4681 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4682 set. If this value is set, it must be set to the same value as
4683 CONFIG_ENV_SIZE.
4684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004685- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004686
4687 Defines offset to the initial SPI buffer area in DPRAM. The
4688 area is used at an early stage (ROM part) if the environment
4689 is configured to reside in the SPI EEPROM: We need a 520 byte
4690 scratch DPRAM area. It is used between the two initialization
4691 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4692 to be a good choice since it makes it far enough from the
4693 start of the data area as well as from the stack pointer.
4694
Bruce Adleredecc942007-11-02 13:15:42 -07004695Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004696has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004697created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004698until then to read environment variables.
4699
wdenk8dba0502003-03-31 16:34:49 +00004700The environment is protected by a CRC32 checksum. Before the monitor
4701is relocated into RAM, as a result of a bad CRC you will be working
4702with the compiled-in default environment - *silently*!!! [This is
4703necessary, because the first environment variable we need is the
4704"baudrate" setting for the console - if we have a bad CRC, we don't
4705have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004706
4707Note: once the monitor has been relocated, then it will complain if
4708the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004709use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004710
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004711- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004712 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004713
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004714 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004715 also needs to be defined.
4716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004717- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004718 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004719
Ron Madriddfa028a2009-02-18 14:30:44 -08004720- CONFIG_NS16550_MIN_FUNCTIONS:
4721 Define this if you desire to only have use of the NS16550_init
4722 and NS16550_putc functions for the serial driver located at
4723 drivers/serial/ns16550.c. This option is useful for saving
4724 space for already greatly restricted images, including but not
4725 limited to NAND_SPL configurations.
4726
Simon Glass28a9e332012-11-30 13:01:18 +00004727- CONFIG_DISPLAY_BOARDINFO
4728 Display information about the board that U-Boot is running on
4729 when U-Boot starts up. The board function checkboard() is called
4730 to do this.
4731
Simon Glasse8822012012-11-30 13:01:19 +00004732- CONFIG_DISPLAY_BOARDINFO_LATE
4733 Similar to the previous option, but display this information
4734 later, once stdio is running and output goes to the LCD, if
4735 present.
4736
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004737- CONFIG_BOARD_SIZE_LIMIT:
4738 Maximum size of the U-Boot image. When defined, the
4739 build system checks that the actual size does not
4740 exceed it.
4741
wdenkc6097192002-11-03 00:24:07 +00004742Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004743---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004744
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004745- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004746 Cache Line Size of the CPU.
4747
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004748- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004749 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004750
wdenk9c53f402003-10-15 23:53:47 +00004751 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4752 and RPXsuper) to be able to adjust the position of
4753 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004754
Timur Tabid8f341c2011-08-04 18:03:41 -05004755- CONFIG_SYS_CCSRBAR_DEFAULT:
4756 Default (power-on reset) physical address of CCSR on Freescale
4757 PowerPC SOCs.
4758
4759- CONFIG_SYS_CCSRBAR:
4760 Virtual address of CCSR. On a 32-bit build, this is typically
4761 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4762
4763 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4764 for cross-platform code that uses that macro instead.
4765
4766- CONFIG_SYS_CCSRBAR_PHYS:
4767 Physical address of CCSR. CCSR can be relocated to a new
4768 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004769 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004770 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4771 is typically relocated on 36-bit builds. It is recommended
4772 that this macro be defined via the _HIGH and _LOW macros:
4773
4774 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4775 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4776
4777- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004778 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4779 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004780 used in assembly code, so it must not contain typecasts or
4781 integer size suffixes (e.g. "ULL").
4782
4783- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4784 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4785 used in assembly code, so it must not contain typecasts or
4786 integer size suffixes (e.g. "ULL").
4787
4788- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4789 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4790 forced to a value that ensures that CCSR is not relocated.
4791
wdenk1272e232002-11-10 22:06:23 +00004792- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004793 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004794
4795 the default drive number (default value 0)
4796
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004797 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004798
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004799 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004800 (default value 1)
4801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004802 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004803
wdenk4a5c8a72003-03-06 00:02:04 +00004804 defines the offset of register from address. It
4805 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004806 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004808 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4809 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004810 default value.
wdenk1272e232002-11-10 22:06:23 +00004811
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004812 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004813 fdc_hw_init() is called at the beginning of the FDC
4814 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004815 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004816 initializations.
wdenk1272e232002-11-10 22:06:23 +00004817
Macpaul Lind1e49942011-04-11 20:45:32 +00004818- CONFIG_IDE_AHB:
4819 Most IDE controllers were designed to be connected with PCI
4820 interface. Only few of them were designed for AHB interface.
4821 When software is doing ATA command and data transfer to
4822 IDE devices through IDE-AHB controller, some additional
4823 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004824 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004825
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004826- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004827 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004828 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004829
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004830- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004831
wdenkeb20ad32003-09-05 23:19:14 +00004832 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004833 initial data and stack; please note that this must be
4834 writable memory that is working WITHOUT special
4835 initialization, i. e. you CANNOT use normal RAM which
4836 will become available only after programming the
4837 memory controller and running certain initialization
4838 sequences.
4839
4840 U-Boot uses the following memory types:
4841 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4842 - MPC824X: data cache
4843 - PPC4xx: data cache
4844
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004845- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004846
4847 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004848 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4849 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004850 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004851 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004852 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4853 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4854 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004855
4856 Note:
4857 On the MPC824X (or other systems that use the data
4858 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004859 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004860 point to an otherwise UNUSED address space between
4861 the top of RAM and the start of the PCI space.
4862
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004863- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004865- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004866
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004867- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004868
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004869- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004870
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004871- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004872
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004873- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004874
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004875- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004876 SDRAM timing
4877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004878- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004879 periodic timer for refresh
4880
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004881- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004882
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004883- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4884 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4885 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4886 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004887 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4888
4889- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004890 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4891 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004892 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4893
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004894- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4895 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004896 Machine Mode Register and Memory Periodic Timer
4897 Prescaler definitions (SDRAM timing)
4898
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004899- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004900 enable I2C microcode relocation patch (MPC8xx);
4901 define relocation offset in DPRAM [DSP2]
4902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004903- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004904 enable SMC microcode relocation patch (MPC8xx);
4905 define relocation offset in DPRAM [SMC1]
4906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004907- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004908 enable SPI microcode relocation patch (MPC8xx);
4909 define relocation offset in DPRAM [SCC4]
4910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004911- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004912 Use OSCM clock mode on MBX8xx board. Be careful,
4913 wrong setting might damage your board. Read
4914 doc/README.MBX before setting this variable!
4915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004916- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004917 Offset of the bootmode word in DPRAM used by post
4918 (Power On Self Tests). This definition overrides
4919 #define'd default value in commproc.h resp.
4920 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004922- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4923 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4924 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4925 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4926 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4927 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4928 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4929 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004930 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004931
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004932- CONFIG_PCI_DISABLE_PCIE:
4933 Disable PCI-Express on systems where it is supported but not
4934 required.
4935
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004936- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004937 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004938 Don't do any setup work, presumably because someone or
4939 something has already done it, and we don't need to do it
4940 a second time. Useful for platforms that are pre-booted
4941 by coreboot or similar.
4942
Gabor Juhosb4458732013-05-30 07:06:12 +00004943- CONFIG_PCI_INDIRECT_BRIDGE:
4944 Enable support for indirect PCI bridges.
4945
Kumar Gala8975d7a2010-12-30 12:09:53 -06004946- CONFIG_SYS_SRIO:
4947 Chip has SRIO or not
4948
4949- CONFIG_SRIO1:
4950 Board has SRIO 1 port available
4951
4952- CONFIG_SRIO2:
4953 Board has SRIO 2 port available
4954
Liu Gang27afb9c2013-05-07 16:30:46 +08004955- CONFIG_SRIO_PCIE_BOOT_MASTER
4956 Board can support master function for Boot from SRIO and PCIE
4957
Kumar Gala8975d7a2010-12-30 12:09:53 -06004958- CONFIG_SYS_SRIOn_MEM_VIRT:
4959 Virtual Address of SRIO port 'n' memory region
4960
4961- CONFIG_SYS_SRIOn_MEM_PHYS:
4962 Physical Address of SRIO port 'n' memory region
4963
4964- CONFIG_SYS_SRIOn_MEM_SIZE:
4965 Size of SRIO port 'n' memory region
4966
Fabio Estevamf17e8782013-04-11 09:35:34 +00004967- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4968 Defined to tell the NAND controller that the NAND chip is using
4969 a 16 bit bus.
4970 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004971 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004972 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004973 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004974
4975- CONFIG_SYS_NDFC_EBC0_CFG
4976 Sets the EBC0_CFG register for the NDFC. If not defined
4977 a default value will be used.
4978
Ben Warren45657152006-09-07 16:50:54 -04004979- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004980 Get DDR timing information from an I2C EEPROM. Common
4981 with pluggable memory modules such as SODIMMs
4982
Ben Warren45657152006-09-07 16:50:54 -04004983 SPD_EEPROM_ADDRESS
4984 I2C address of the SPD EEPROM
4985
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004986- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004987 If SPD EEPROM is on an I2C bus other than the first
4988 one, specify here. Note that the value must resolve
4989 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004990
York Sune73cc042011-06-07 09:42:16 +08004991- CONFIG_SYS_DDR_RAW_TIMING
4992 Get DDR timing information from other than SPD. Common with
4993 soldered DDR chips onboard without SPD. DDR raw timing
4994 parameters are extracted from datasheet and hard-coded into
4995 header files or board specific files.
4996
York Sunbd495cf2011-09-16 13:21:35 -07004997- CONFIG_FSL_DDR_INTERACTIVE
4998 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4999
York Sun8ced0502015-01-06 13:18:55 -08005000- CONFIG_FSL_DDR_SYNC_REFRESH
5001 Enable sync of refresh for multiple controllers.
5002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005003- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005004 Only for 83xx systems. If specified, then DDR should
5005 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06005006
wdenk6203e402004-04-18 10:13:26 +00005007- CONFIG_ETHER_ON_FEC[12]
5008 Define to enable FEC[12] on a 8xx series processor.
5009
5010- CONFIG_FEC[12]_PHY
5011 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00005012 to the given FEC; i. e.
5013 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00005014 means that the PHY with address 4 is connected to FEC1
5015
5016 When set to -1, means to probe for first available.
5017
5018- CONFIG_FEC[12]_PHY_NORXERR
5019 The PHY does not have a RXERR line (RMII only).
5020 (so program the FEC to ignore it).
5021
5022- CONFIG_RMII
5023 Enable RMII mode for all FECs.
5024 Note that this is a global option, we can't
5025 have one FEC in standard MII mode and another in RMII mode.
5026
wdenk20c98a62004-04-23 20:32:05 +00005027- CONFIG_CRC32_VERIFY
5028 Add a verify option to the crc32 command.
5029 The syntax is:
5030
5031 => crc32 -v <address> <count> <crc32>
5032
5033 Where address/count indicate a memory area
5034 and crc32 is the correct crc32 which the
5035 area should have.
5036
wdenk64519362004-07-11 17:40:54 +00005037- CONFIG_LOOPW
5038 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05005039 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00005040
stroesecc3af832004-12-16 18:46:55 +00005041- CONFIG_MX_CYCLIC
5042 Add the "mdc" and "mwc" memory commands. These are cyclic
5043 "md/mw" commands.
5044 Examples:
5045
wdenk07d7e6b2004-12-16 21:44:03 +00005046 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00005047 This command will print 4 bytes (10,11,12,13) each 500 ms.
5048
wdenk07d7e6b2004-12-16 21:44:03 +00005049 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00005050 This command will write 12345678 to address 100 all 10 ms.
5051
wdenk07d7e6b2004-12-16 21:44:03 +00005052 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05005053 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00005054
wdenk3d3d99f2005-04-04 12:44:11 +00005055- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005056 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01005057 low level initializations (like setting up the memory
5058 controller) are omitted and/or U-Boot does not
5059 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00005060
Wolfgang Denk302141d2010-11-27 23:30:56 +01005061 Normally this variable MUST NOT be defined. The only
5062 exception is when U-Boot is loaded (to RAM) by some
5063 other boot loader or by a debugger which performs
5064 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00005065
Aneesh V552a3192011-07-13 05:11:07 +00005066- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02005067 Modifies the behaviour of start.S when compiling a loader
5068 that is executed before the actual U-Boot. E.g. when
5069 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00005070
Ying Zhang2d2e3b62013-08-16 15:16:15 +08005071- CONFIG_TPL_BUILD
5072 Modifies the behaviour of start.S when compiling a loader
5073 that is executed after the SPL and before the actual U-Boot.
5074 It is loaded by the SPL.
5075
Ying Zhang0d4f5442013-05-20 14:07:23 +08005076- CONFIG_SYS_MPC85XX_NO_RESETVEC
5077 Only for 85xx systems. If this variable is specified, the section
5078 .resetvec is not kept and the section .bootpg is placed in the
5079 previous 4k of the .text section.
5080
Simon Glass17dabf02013-02-24 17:33:14 +00005081- CONFIG_ARCH_MAP_SYSMEM
5082 Generally U-Boot (and in particular the md command) uses
5083 effective address. It is therefore not necessary to regard
5084 U-Boot address as virtual addresses that need to be translated
5085 to physical addresses. However, sandbox requires this, since
5086 it maintains its own little RAM buffer which contains all
5087 addressable memory. This option causes some memory accesses
5088 to be mapped through map_sysmem() / unmap_sysmem().
5089
Matthias Weisser93416c12011-03-10 21:36:32 +00005090- CONFIG_USE_ARCH_MEMCPY
5091 CONFIG_USE_ARCH_MEMSET
5092 If these options are used a optimized version of memcpy/memset will
5093 be used if available. These functions may be faster under some
5094 conditions but may increase the binary size.
5095
Simon Glassbfb59802013-02-14 04:18:54 +00005096- CONFIG_X86_RESET_VECTOR
5097 If defined, the x86 reset vector code is included. This is not
5098 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00005099
Mark Jackson52b003c2013-03-04 01:27:20 +00005100- CONFIG_SYS_MPUCLK
5101 Defines the MPU clock speed (in MHz).
5102
5103 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00005104
Heiko Schocher2233e462013-11-04 14:05:00 +01005105- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5106 Enables the RTC32K OSC on AM33xx based plattforms
5107
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04005108- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5109 Option to disable subpage write in NAND driver
5110 driver that uses this:
5111 drivers/mtd/nand/davinci_nand.c
5112
Timur Tabi275f4bb2011-11-22 09:21:25 -06005113Freescale QE/FMAN Firmware Support:
5114-----------------------------------
5115
5116The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5117loading of "firmware", which is encoded in the QE firmware binary format.
5118This firmware often needs to be loaded during U-Boot booting, so macros
5119are used to identify the storage device (NOR flash, SPI, etc) and the address
5120within that device.
5121
Zhao Qiang83a90842014-03-21 16:21:44 +08005122- CONFIG_SYS_FMAN_FW_ADDR
5123 The address in the storage device where the FMAN microcode is located. The
5124 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5125 is also specified.
5126
5127- CONFIG_SYS_QE_FW_ADDR
5128 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005129 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5130 is also specified.
5131
5132- CONFIG_SYS_QE_FMAN_FW_LENGTH
5133 The maximum possible size of the firmware. The firmware binary format
5134 has a field that specifies the actual size of the firmware, but it
5135 might not be possible to read any part of the firmware unless some
5136 local storage is allocated to hold the entire firmware first.
5137
5138- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5139 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5140 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5141 virtual address in NOR flash.
5142
5143- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5144 Specifies that QE/FMAN firmware is located in NAND flash.
5145 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5146
5147- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5148 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5149 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5150
5151- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5152 Specifies that QE/FMAN firmware is located on the primary SPI
5153 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5154
Liu Gang1e084582012-03-08 00:33:18 +00005155- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5156 Specifies that QE/FMAN firmware is located in the remote (master)
5157 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005158 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5159 window->master inbound window->master LAW->the ucode address in
5160 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005161
J. German Rivera8ff14b72014-06-23 15:15:55 -07005162Freescale Layerscape Management Complex Firmware Support:
5163---------------------------------------------------------
5164The Freescale Layerscape Management Complex (MC) supports the loading of
5165"firmware".
5166This firmware often needs to be loaded during U-Boot booting, so macros
5167are used to identify the storage device (NOR flash, SPI, etc) and the address
5168within that device.
5169
5170- CONFIG_FSL_MC_ENET
5171 Enable the MC driver for Layerscape SoCs.
5172
5173- CONFIG_SYS_LS_MC_FW_ADDR
5174 The address in the storage device where the firmware is located. The
5175 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5176 is also specified.
5177
5178- CONFIG_SYS_LS_MC_FW_LENGTH
5179 The maximum possible size of the firmware. The firmware binary format
5180 has a field that specifies the actual size of the firmware, but it
5181 might not be possible to read any part of the firmware unless some
5182 local storage is allocated to hold the entire firmware first.
5183
5184- CONFIG_SYS_LS_MC_FW_IN_NOR
5185 Specifies that MC firmware is located in NOR flash, mapped as
5186 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5187 virtual address in NOR flash.
5188
wdenkc6097192002-11-03 00:24:07 +00005189Building the Software:
5190======================
5191
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005192Building U-Boot has been tested in several native build environments
5193and in many different cross environments. Of course we cannot support
5194all possibly existing versions of cross development tools in all
5195(potentially obsolete) versions. In case of tool chain problems we
5196recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5197which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005198
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005199If you are not using a native environment, it is assumed that you
5200have GNU cross compiling tools available in your path. In this case,
5201you must set the environment variable CROSS_COMPILE in your shell.
5202Note that no changes to the Makefile or any other source files are
5203necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005204
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005205 $ CROSS_COMPILE=ppc_4xx-
5206 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005207
Peter Tyserb06976d2009-03-13 18:54:51 -05005208Note: If you wish to generate Windows versions of the utilities in
5209 the tools directory you can use the MinGW toolchain
5210 (http://www.mingw.org). Set your HOST tools to the MinGW
5211 toolchain and execute 'make tools'. For example:
5212
5213 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5214
5215 Binaries such as tools/mkimage.exe will be created which can
5216 be executed on computers running Windows.
5217
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005218U-Boot is intended to be simple to build. After installing the
5219sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005220is done by typing:
5221
Holger Freyther7ba4e572014-08-04 09:26:05 +02005222 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005223
Holger Freyther7ba4e572014-08-04 09:26:05 +02005224where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005225rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227Note: for some board special configuration names may exist; check if
5228 additional information is available from the board vendor; for
5229 instance, the TQM823L systems are available without (standard)
5230 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005231 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005232
Holger Freyther7ba4e572014-08-04 09:26:05 +02005233 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005234 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005235
Holger Freyther7ba4e572014-08-04 09:26:05 +02005236 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005237 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk6c59edc2004-05-03 20:45:30 +00005239 etc.
wdenkc6097192002-11-03 00:24:07 +00005240
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242Finally, type "make all", and you should get some working U-Boot
5243images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk6c59edc2004-05-03 20:45:30 +00005245- "u-boot.bin" is a raw binary image
5246- "u-boot" is an image in ELF binary format
5247- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005248
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005249By default the build is performed locally and the objects are saved
5250in the source directory. One of the two methods can be used to change
5251this behavior and build U-Boot to some external directory:
5252
52531. Add O= to the make command line invocations:
5254
5255 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005256 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005257 make O=/tmp/build all
5258
Timo Ketolac8c67602014-11-06 14:39:05 +020052592. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005260
Timo Ketolac8c67602014-11-06 14:39:05 +02005261 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005262 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005263 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005264 make all
5265
Timo Ketolac8c67602014-11-06 14:39:05 +02005266Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005267variable.
5268
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270Please be aware that the Makefiles assume you are using GNU make, so
5271for instance on NetBSD you might need to use "gmake" instead of
5272native "make".
wdenkc6097192002-11-03 00:24:07 +00005273
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275If the system board that you have is not listed, then you will need
5276to port U-Boot to your hardware platform. To do this, follow these
5277steps:
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +000052791. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005280 "boards.cfg" file, using the existing entries as examples.
5281 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000052822. Create a new directory to hold your board specific code. Add any
5283 files you need. In your board directory, you will need at least
5284 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
52853. Create a new configuration file "include/configs/<board>.h" for
5286 your board
52873. If you're porting U-Boot to a new CPU, then also create a new
5288 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020052894. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000052905. Type "make", and you should get a working "u-boot.srec" file
5291 to be installed on your target system.
52926. Debug and solve any problems that might arise.
5293 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005294
wdenkc6097192002-11-03 00:24:07 +00005295
wdenk6c59edc2004-05-03 20:45:30 +00005296Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5297==============================================================
wdenkc6097192002-11-03 00:24:07 +00005298
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005299If you have modified U-Boot sources (for instance added a new board
5300or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005301provide feedback to the other developers. The feedback normally takes
5302the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005303official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005304
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005305But before you submit such a patch, please verify that your modifi-
5306cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005307the supported boards compile WITHOUT ANY compiler warnings. To do so,
5308just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005309for ALL supported system. Be warned, this will take a while. You can
5310select which (cross) compiler to use by passing a `CROSS_COMPILE'
5311environment variable to the script, i. e. to use the ELDK cross tools
5312you can type
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk6c59edc2004-05-03 20:45:30 +00005314 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk6c59edc2004-05-03 20:45:30 +00005316or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005317
wdenk6c59edc2004-05-03 20:45:30 +00005318 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005319
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005320When using the MAKEALL script, the default behaviour is to build
5321U-Boot in the source directory. This location can be changed by
5322setting the BUILD_DIR environment variable. Also, for each target
5323built, the MAKEALL script saves two log files (<target>.ERR and
5324<target>.MAKEALL) in the <source dir>/LOG directory. This default
5325location can be changed by setting the MAKEALL_LOGDIR environment
5326variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005327
5328 export BUILD_DIR=/tmp/build
5329 export MAKEALL_LOGDIR=/tmp/log
5330 CROSS_COMPILE=ppc_8xx- MAKEALL
5331
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005332With the above settings build objects are saved in the /tmp/build,
5333log files are saved in the /tmp/log and the source tree remains clean
5334during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005335
5336
wdenk6c59edc2004-05-03 20:45:30 +00005337See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005338
wdenkc6097192002-11-03 00:24:07 +00005339
wdenk6c59edc2004-05-03 20:45:30 +00005340Monitor Commands - Overview:
5341============================
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343go - start application at address 'addr'
5344run - run commands in an environment variable
5345bootm - boot application image from memory
5346bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005347bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005348tftpboot- boot image via network using TFTP protocol
5349 and env variables "ipaddr" and "serverip"
5350 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005351tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005352rarpboot- boot image via network using RARP/TFTP protocol
5353diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5354loads - load S-Record file over serial line
5355loadb - load binary file over serial line (kermit mode)
5356md - memory display
5357mm - memory modify (auto-incrementing)
5358nm - memory modify (constant address)
5359mw - memory write (fill)
5360cp - memory copy
5361cmp - memory compare
5362crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005363i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005364sspi - SPI utility commands
5365base - print or set address offset
5366printenv- print environment variables
5367setenv - set environment variables
5368saveenv - save environment variables to persistent storage
5369protect - enable or disable FLASH write protection
5370erase - erase FLASH memory
5371flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005372nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005373bdinfo - print Board Info structure
5374iminfo - print header information for application image
5375coninfo - print console devices and informations
5376ide - IDE sub-system
5377loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005378loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005379mtest - simple RAM test
5380icache - enable or disable instruction cache
5381dcache - enable or disable data cache
5382reset - Perform RESET of the CPU
5383echo - echo args to console
5384version - print monitor version
5385help - print online help
5386? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005387
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389Monitor Commands - Detailed Description:
5390========================================
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392TODO.
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005395
5396
wdenk6c59edc2004-05-03 20:45:30 +00005397Environment Variables:
5398======================
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk6c59edc2004-05-03 20:45:30 +00005400U-Boot supports user configuration using Environment Variables which
5401can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005402
wdenk6c59edc2004-05-03 20:45:30 +00005403Environment Variables are set using "setenv", printed using
5404"printenv", and saved to Flash using "saveenv". Using "setenv"
5405without a value can be used to delete a variable from the
5406environment. As long as you don't save the environment you are
5407working with an in-memory copy. In case the Flash area containing the
5408environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005409
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005410Some configuration options can be set using Environment Variables.
5411
5412List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk6c59edc2004-05-03 20:45:30 +00005414 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005415
wdenk6c59edc2004-05-03 20:45:30 +00005416 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk6c59edc2004-05-03 20:45:30 +00005422 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005423
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005424 bootm_low - Memory range available for image processing in the bootm
5425 command can be restricted. This variable is given as
5426 a hexadecimal number and defines lowest address allowed
5427 for use by the bootm command. See also "bootm_size"
5428 environment variable. Address defined by "bootm_low" is
5429 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005430 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5431 bootm_mapsize.
5432
Wolfgang Denk092ae952011-10-26 10:21:21 +00005433 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005434 This variable is given as a hexadecimal number and it
5435 defines the size of the memory region starting at base
5436 address bootm_low that is accessible by the Linux kernel
5437 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5438 as the default value if it is defined, and bootm_size is
5439 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005440
5441 bootm_size - Memory range available for image processing in the bootm
5442 command can be restricted. This variable is given as
5443 a hexadecimal number and defines the size of the region
5444 allowed for use by the bootm command. See also "bootm_low"
5445 environment variable.
5446
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005447 updatefile - Location of the software update file on a TFTP server, used
5448 by the automatic software update feature. Please refer to
5449 documentation in doc/README.update for more details.
5450
wdenk6c59edc2004-05-03 20:45:30 +00005451 autoload - if set to "no" (any string beginning with 'n'),
5452 "bootp" will just load perform a lookup of the
5453 configuration from the BOOTP server, but not try to
5454 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005455
wdenk6c59edc2004-05-03 20:45:30 +00005456 autostart - if set to "yes", an image loaded using the "bootp",
5457 "rarpboot", "tftpboot" or "diskboot" commands will
5458 be automatically started (by internally calling
5459 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461 If set to "no", a standalone image passed to the
5462 "bootm" command will be copied to the load address
5463 (and eventually uncompressed), but NOT be started.
5464 This can be used to load and uncompress arbitrary
5465 data.
wdenkc6097192002-11-03 00:24:07 +00005466
David A. Longd558a4e2011-07-09 16:40:19 -04005467 fdt_high - if set this restricts the maximum address that the
5468 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005469 For example, if you have a system with 1 GB memory
5470 at physical address 0x10000000, while Linux kernel
5471 only recognizes the first 704 MB as low memory, you
5472 may need to set fdt_high as 0x3C000000 to have the
5473 device tree blob be copied to the maximum address
5474 of the 704 MB low memory, so that Linux kernel can
5475 access it during the boot procedure.
5476
David A. Longd558a4e2011-07-09 16:40:19 -04005477 If this is set to the special value 0xFFFFFFFF then
5478 the fdt will not be copied at all on boot. For this
5479 to work it must reside in writable memory, have
5480 sufficient padding on the end of it for u-boot to
5481 add the information it needs into it, and the memory
5482 must be accessible by the kernel.
5483
Simon Glassdc6fa642011-10-24 19:15:34 +00005484 fdtcontroladdr- if set this is the address of the control flattened
5485 device tree used by U-Boot when CONFIG_OF_CONTROL is
5486 defined.
5487
wdenk0e2bd9c2004-06-06 21:51:03 +00005488 i2cfast - (PPC405GP|PPC405EP only)
5489 if set to 'y' configures Linux I2C driver for fast
5490 mode (400kHZ). This environment variable is used in
5491 initialization code. So, for changes to be effective
5492 it must be saved and board must be reset.
5493
wdenk6c59edc2004-05-03 20:45:30 +00005494 initrd_high - restrict positioning of initrd images:
5495 If this variable is not set, initrd images will be
5496 copied to the highest possible address in RAM; this
5497 is usually what you want since it allows for
5498 maximum initrd size. If for some reason you want to
5499 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005500 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005501 variable to a value of "no" or "off" or "0".
5502 Alternatively, you can set it to a maximum upper
5503 address to use (U-Boot will still check that it
5504 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk6c59edc2004-05-03 20:45:30 +00005506 For instance, when you have a system with 16 MB
5507 RAM, and want to reserve 4 MB from use by Linux,
5508 you can do this by adding "mem=12M" to the value of
5509 the "bootargs" variable. However, now you must make
5510 sure that the initrd image is placed in the first
5511 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005512
wdenk6c59edc2004-05-03 20:45:30 +00005513 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005514
wdenk6c59edc2004-05-03 20:45:30 +00005515 If you set initrd_high to 0xFFFFFFFF, this is an
5516 indication to U-Boot that all addresses are legal
5517 for the Linux kernel, including addresses in flash
5518 memory. In this case U-Boot will NOT COPY the
5519 ramdisk at all. This may be useful to reduce the
5520 boot time on your system, but requires that this
5521 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005524
wdenk6c59edc2004-05-03 20:45:30 +00005525 loadaddr - Default load address for commands like "bootp",
5526 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005527
wdenk6c59edc2004-05-03 20:45:30 +00005528 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005531
wdenk6c59edc2004-05-03 20:45:30 +00005532 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk6c59edc2004-05-03 20:45:30 +00005534 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk6c59edc2004-05-03 20:45:30 +00005536 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005537
Mike Frysingera23230c2011-10-02 10:01:27 +00005538 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005539
Mike Frysingera23230c2011-10-02 10:01:27 +00005540 ethact - controls which interface is currently active.
5541 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005542
Heiko Schocherc5e84052010-07-20 17:45:02 +02005543 => setenv ethact FEC
5544 => ping 192.168.0.1 # traffic sent on FEC
5545 => setenv ethact SCC
5546 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005547
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005548 ethrotate - When set to "no" U-Boot does not go through all
5549 available network interfaces.
5550 It just stays at the currently selected interface.
5551
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005552 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005553 either succeed or fail without retrying.
5554 When set to "once" the network operation will
5555 fail when all the available network interfaces
5556 are tried once without success.
5557 Useful on scripts which control the retry operation
5558 themselves.
wdenkc6097192002-11-03 00:24:07 +00005559
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005560 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005561
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005562 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005563 changing the console to be empty. If "yes" it will be
5564 made silent. If "no" it will not be made silent. If
5565 unset, then it will be made silent if the U-Boot console
5566 is silent.
5567
Wolfgang Denk227b5192005-09-24 23:25:46 +02005568 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005569 UDP source port.
5570
Wolfgang Denk227b5192005-09-24 23:25:46 +02005571 tftpdstport - If this is set, the value is used for TFTP's UDP
5572 destination port instead of the Well Know Port 69.
5573
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005574 tftpblocksize - Block size to use for TFTP transfers; if not set,
5575 we use the TFTP server's default block size
5576
5577 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5578 seconds, minimum value is 1000 = 1 second). Defines
5579 when a packet is considered to be lost so it has to
5580 be retransmitted. The default is 5000 = 5 seconds.
5581 Lowering this value may make downloads succeed
5582 faster in networks with high packet loss rates or
5583 with unreliable TFTP servers.
5584
5585 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005586 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005587 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005588
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005589The following image location variables contain the location of images
5590used in booting. The "Image" column gives the role of the image and is
5591not an environment variable name. The other columns are environment
5592variable names. "File Name" gives the name of the file on a TFTP
5593server, "RAM Address" gives the location in RAM the image will be
5594loaded to, and "Flash Location" gives the image's address in NOR
5595flash or offset in NAND flash.
5596
5597*Note* - these variables don't have to be defined for all boards, some
5598boards currenlty use other variables for these purposes, and some
5599boards use these variables for other purposes.
5600
Wolfgang Denk092ae952011-10-26 10:21:21 +00005601Image File Name RAM Address Flash Location
5602----- --------- ----------- --------------
5603u-boot u-boot u-boot_addr_r u-boot_addr
5604Linux kernel bootfile kernel_addr_r kernel_addr
5605device tree blob fdtfile fdt_addr_r fdt_addr
5606ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608The following environment variables may be used and automatically
5609updated by the network boot commands ("bootp" and "rarpboot"),
5610depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612 bootfile - see above
5613 dnsip - IP address of your Domain Name Server
5614 dnsip2 - IP address of your secondary Domain Name Server
5615 gatewayip - IP address of the Gateway (Router) to use
5616 hostname - Target hostname
5617 ipaddr - see above
5618 netmask - Subnet Mask
5619 rootpath - Pathname of the root filesystem on the NFS server
5620 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005621
wdenk145d2c12004-04-15 21:48:45 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625 serial# - contains hardware identification information such
5626 as type string and/or serial number
5627 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629These variables can be set only once (usually during manufacturing of
5630the board). U-Boot refuses to delete or overwrite these variables
5631once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005632
5633
wdenk6c59edc2004-05-03 20:45:30 +00005634Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636 ver - Contains the U-Boot version string as printed
5637 with the "version" command. This variable is
5638 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005639
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641Please note that changes to some configuration parameters may take
5642only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005643
stroeseb9c17c52003-04-04 15:53:41 +00005644
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005645Callback functions for environment variables:
5646---------------------------------------------
5647
5648For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005649when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005650be associated with arbitrary variables. On creation, overwrite, or
5651deletion, the callback will provide the opportunity for some side
5652effect to happen or for the change to be rejected.
5653
5654The callbacks are named and associated with a function using the
5655U_BOOT_ENV_CALLBACK macro in your board or driver code.
5656
5657These callbacks are associated with variables in one of two ways. The
5658static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5659in the board configuration to a string that defines a list of
5660associations. The list must be in the following format:
5661
5662 entry = variable_name[:callback_name]
5663 list = entry[,list]
5664
5665If the callback name is not specified, then the callback is deleted.
5666Spaces are also allowed anywhere in the list.
5667
5668Callbacks can also be associated by defining the ".callbacks" variable
5669with the same list format above. Any association in ".callbacks" will
5670override any association in the static list. You can define
5671CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005672".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005673
5674
wdenk6c59edc2004-05-03 20:45:30 +00005675Command Line Parsing:
5676=====================
stroeseb9c17c52003-04-04 15:53:41 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678There are two different command line parsers available with U-Boot:
5679the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk6c59edc2004-05-03 20:45:30 +00005681Old, simple command line parser:
5682--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk6c59edc2004-05-03 20:45:30 +00005684- supports environment variables (through setenv / saveenv commands)
5685- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005686- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005687- special characters ('$', ';') can be escaped by prefixing with '\',
5688 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005689 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005690- You can also escape text by enclosing in single apostrophes, for example:
5691 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005692
wdenk6c59edc2004-05-03 20:45:30 +00005693Hush shell:
5694-----------
wdenkf4688a22003-05-28 08:06:31 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696- similar to Bourne shell, with control structures like
5697 if...then...else...fi, for...do...done; while...do...done,
5698 until...do...done, ...
5699- supports environment ("global") variables (through setenv / saveenv
5700 commands) and local shell variables (through standard shell syntax
5701 "name=value"); only environment variables can be used with "run"
5702 command
wdenkf4688a22003-05-28 08:06:31 +00005703
wdenk6c59edc2004-05-03 20:45:30 +00005704General rules:
5705--------------
wdenkf4688a22003-05-28 08:06:31 +00005706
wdenk6c59edc2004-05-03 20:45:30 +00005707(1) If a command line (or an environment variable executed by a "run"
5708 command) contains several commands separated by semicolon, and
5709 one of these commands fails, then the remaining commands will be
5710 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005711
wdenk6c59edc2004-05-03 20:45:30 +00005712(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005713 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005714 command will cause "run" to terminate, i. e. the remaining
5715 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717Note for Redundant Ethernet Interfaces:
5718=======================================
wdenkf4688a22003-05-28 08:06:31 +00005719
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005720Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005721such configurations and is capable of automatic selection of a
5722"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005723
wdenk6c59edc2004-05-03 20:45:30 +00005724Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5725MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5726"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728If the network interface stores some valid MAC address (for instance
5729in SROM), this is used as default address if there is NO correspon-
5730ding setting in the environment; if the corresponding environment
5731variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733o If the SROM has a valid MAC address, and there is no address in the
5734 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736o If there is no valid address in the SROM, and a definition in the
5737 environment exists, then the value from the environment variable is
5738 used.
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk6c59edc2004-05-03 20:45:30 +00005740o If both the SROM and the environment contain a MAC address, and
5741 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743o If both the SROM and the environment contain a MAC address, and the
5744 addresses differ, the value from the environment is used and a
5745 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk6c59edc2004-05-03 20:45:30 +00005747o If neither SROM nor the environment contain a MAC address, an error
5748 is raised.
wdenkc6097192002-11-03 00:24:07 +00005749
Ben Warren6db991a2010-04-26 11:11:46 -07005750If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005751will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005752may be skipped by setting the appropriate 'ethmacskip' environment variable.
5753The naming convention is as follows:
5754"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756Image Formats:
5757==============
wdenkc6097192002-11-03 00:24:07 +00005758
Marian Balakowicz18710b82008-03-12 12:13:13 +01005759U-Boot is capable of booting (and performing other auxiliary operations on)
5760images in two formats:
5761
5762New uImage format (FIT)
5763-----------------------
5764
5765Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5766to Flattened Device Tree). It allows the use of images with multiple
5767components (several kernels, ramdisks, etc.), with contents protected by
5768SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5769
5770
5771Old uImage format
5772-----------------
5773
5774Old image format is based on binary files which can be basically anything,
5775preceded by a special header; see the definitions in include/image.h for
5776details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk6c59edc2004-05-03 20:45:30 +00005778* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5779 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005780 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5781 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5782 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005783* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005784 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5785 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005786* Compression Type (uncompressed, gzip, bzip2)
5787* Load Address
5788* Entry Point
5789* Image Name
5790* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792The header is marked by a special Magic Number, and both the header
5793and the data portions of the image are secured against corruption by
5794CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005795
wdenkc6097192002-11-03 00:24:07 +00005796
wdenk6c59edc2004-05-03 20:45:30 +00005797Linux Support:
5798==============
wdenkc6097192002-11-03 00:24:07 +00005799
wdenk6c59edc2004-05-03 20:45:30 +00005800Although U-Boot should support any OS or standalone application
5801easily, the main focus has always been on Linux during the design of
5802U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804U-Boot includes many features that so far have been part of some
5805special "boot loader" code within the Linux kernel. Also, any
5806"initrd" images to be used are no longer part of one big Linux image;
5807instead, kernel and "initrd" are separate images. This implementation
5808serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005809
wdenk6c59edc2004-05-03 20:45:30 +00005810- the same features can be used for other OS or standalone
5811 applications (for instance: using compressed images to reduce the
5812 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814- it becomes much easier to port new Linux kernel versions because
5815 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817- the same Linux kernel image can now be used with different "initrd"
5818 images; of course this also means that different kernel images can
5819 be run with the same "initrd". This makes testing easier (you don't
5820 have to build a new "zImage.initrd" Linux image when you just
5821 change a file in your "initrd"). Also, a field-upgrade of the
5822 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005823
wdenkc6097192002-11-03 00:24:07 +00005824
wdenk6c59edc2004-05-03 20:45:30 +00005825Linux HOWTO:
5826============
wdenkc6097192002-11-03 00:24:07 +00005827
wdenk6c59edc2004-05-03 20:45:30 +00005828Porting Linux to U-Boot based systems:
5829---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831U-Boot cannot save you from doing all the necessary modifications to
5832configure the Linux device drivers for use with your target hardware
5833(no, we don't intend to provide a full virtual machine interface to
5834Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005835
Stefan Roese88fbf932010-04-15 16:07:28 +02005836But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005837
wdenk6c59edc2004-05-03 20:45:30 +00005838Just make sure your machine specific header file (for instance
5839include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005840Information structure as we define in include/asm-<arch>/u-boot.h,
5841and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005842as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005843
Simon Glassd097e592014-06-11 23:29:46 -06005844Note that U-Boot now has a driver model, a unified model for drivers.
5845If you are adding a new driver, plumb it into driver model. If there
5846is no uclass available, you are encouraged to create one. See
5847doc/driver-model.
5848
wdenkc6097192002-11-03 00:24:07 +00005849
wdenk6c59edc2004-05-03 20:45:30 +00005850Configuring the Linux kernel:
5851-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853No specific requirements for U-Boot. Make sure you have some root
5854device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005855
wdenkc6097192002-11-03 00:24:07 +00005856
wdenk6c59edc2004-05-03 20:45:30 +00005857Building a Linux Image:
5858-----------------------
wdenkc6097192002-11-03 00:24:07 +00005859
wdenk6c59edc2004-05-03 20:45:30 +00005860With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5861not used. If you use recent kernel source, a new build target
5862"uImage" will exist which automatically builds an image usable by
5863U-Boot. Most older kernels also have support for a "pImage" target,
5864which was introduced for our predecessor project PPCBoot and uses a
5865100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk6c59edc2004-05-03 20:45:30 +00005867Example:
wdenkc6097192002-11-03 00:24:07 +00005868
Holger Freyther7ba4e572014-08-04 09:26:05 +02005869 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005870 make oldconfig
5871 make dep
5872 make uImage
wdenkc6097192002-11-03 00:24:07 +00005873
wdenk6c59edc2004-05-03 20:45:30 +00005874The "uImage" build target uses a special tool (in 'tools/mkimage') to
5875encapsulate a compressed Linux kernel image with header information,
5876CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005877
wdenk6c59edc2004-05-03 20:45:30 +00005878* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005879
wdenk6c59edc2004-05-03 20:45:30 +00005880* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005881
wdenk6c59edc2004-05-03 20:45:30 +00005882 ${CROSS_COMPILE}-objcopy -O binary \
5883 -R .note -R .comment \
5884 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005885
wdenk6c59edc2004-05-03 20:45:30 +00005886* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005887
wdenk6c59edc2004-05-03 20:45:30 +00005888 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005889
wdenk6c59edc2004-05-03 20:45:30 +00005890* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005891
wdenk6c59edc2004-05-03 20:45:30 +00005892 mkimage -A ppc -O linux -T kernel -C gzip \
5893 -a 0 -e 0 -n "Linux Kernel Image" \
5894 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005895
wdenkc6097192002-11-03 00:24:07 +00005896
wdenk6c59edc2004-05-03 20:45:30 +00005897The "mkimage" tool can also be used to create ramdisk images for use
5898with U-Boot, either separated from the Linux kernel image, or
5899combined into one file. "mkimage" encapsulates the images with a 64
5900byte header containing information about target architecture,
5901operating system, image type, compression method, entry points, time
5902stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005903
wdenk6c59edc2004-05-03 20:45:30 +00005904"mkimage" can be called in two ways: to verify existing images and
5905print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005906
wdenk6c59edc2004-05-03 20:45:30 +00005907In the first form (with "-l" option) mkimage lists the information
5908contained in the header of an existing U-Boot image; this includes
5909checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911 tools/mkimage -l image
5912 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914The second form (with "-d" option) is used to build a U-Boot image
5915from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005916
wdenk6c59edc2004-05-03 20:45:30 +00005917 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5918 -n name -d data_file image
5919 -A ==> set architecture to 'arch'
5920 -O ==> set operating system to 'os'
5921 -T ==> set image type to 'type'
5922 -C ==> set compression type 'comp'
5923 -a ==> set load address to 'addr' (hex)
5924 -e ==> set entry point to 'ep' (hex)
5925 -n ==> set image name to 'name'
5926 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005927
wdenkcd914452004-05-29 16:53:29 +00005928Right now, all Linux kernels for PowerPC systems use the same load
5929address (0x00000000), but the entry point address depends on the
5930kernel version:
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932- 2.2.x kernels have the entry point at 0x0000000C,
5933- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk6c59edc2004-05-03 20:45:30 +00005935So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5938 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005939 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005940 > examples/uImage.TQM850L
5941 Image Name: 2.4.4 kernel for TQM850L
5942 Created: Wed Jul 19 02:34:59 2000
5943 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5944 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5945 Load Address: 0x00000000
5946 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005947
wdenk6c59edc2004-05-03 20:45:30 +00005948To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005949
wdenk6c59edc2004-05-03 20:45:30 +00005950 -> tools/mkimage -l examples/uImage.TQM850L
5951 Image Name: 2.4.4 kernel for TQM850L
5952 Created: Wed Jul 19 02:34:59 2000
5953 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5954 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5955 Load Address: 0x00000000
5956 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005957
wdenk6c59edc2004-05-03 20:45:30 +00005958NOTE: for embedded systems where boot time is critical you can trade
5959speed for memory and install an UNCOMPRESSED image instead: this
5960needs more space in Flash, but boots much faster since it does not
5961need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005962
Stefan Roese88fbf932010-04-15 16:07:28 +02005963 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005964 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5965 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005966 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005967 > examples/uImage.TQM850L-uncompressed
5968 Image Name: 2.4.4 kernel for TQM850L
5969 Created: Wed Jul 19 02:34:59 2000
5970 Image Type: PowerPC Linux Kernel Image (uncompressed)
5971 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5972 Load Address: 0x00000000
5973 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005974
wdenkc6097192002-11-03 00:24:07 +00005975
wdenk6c59edc2004-05-03 20:45:30 +00005976Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5977when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005978
wdenk6c59edc2004-05-03 20:45:30 +00005979 -> tools/mkimage -n 'Simple Ramdisk Image' \
5980 > -A ppc -O linux -T ramdisk -C gzip \
5981 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5982 Image Name: Simple Ramdisk Image
5983 Created: Wed Jan 12 14:01:50 2000
5984 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5985 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5986 Load Address: 0x00000000
5987 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005988
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005989The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5990option performs the converse operation of the mkimage's second form (the "-d"
5991option). Given an image built by mkimage, the dumpimage extracts a "data file"
5992from the image:
5993
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005994 tools/dumpimage -i image -T type -p position data_file
5995 -i ==> extract from the 'image' a specific 'data_file'
5996 -T ==> set image type to 'type'
5997 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005998
wdenkc6097192002-11-03 00:24:07 +00005999
wdenk6c59edc2004-05-03 20:45:30 +00006000Installing a Linux Image:
6001-------------------------
wdenkc6097192002-11-03 00:24:07 +00006002
wdenk6c59edc2004-05-03 20:45:30 +00006003To downloading a U-Boot image over the serial (console) interface,
6004you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00006005
wdenk6c59edc2004-05-03 20:45:30 +00006006 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk6c59edc2004-05-03 20:45:30 +00006008The 'objcopy' does not understand the information in the U-Boot
6009image header, so the resulting S-Record file will be relative to
6010address 0x00000000. To load it to a given address, you need to
6011specify the target address as 'offset' parameter with the 'loads'
6012command.
wdenkc6097192002-11-03 00:24:07 +00006013
wdenk6c59edc2004-05-03 20:45:30 +00006014Example: install the image to address 0x40100000 (which on the
6015TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00006016
wdenk6c59edc2004-05-03 20:45:30 +00006017 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00006018
wdenk6c59edc2004-05-03 20:45:30 +00006019 .......... done
6020 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00006021
wdenk6c59edc2004-05-03 20:45:30 +00006022 => loads 40100000
6023 ## Ready for S-Record download ...
6024 ~>examples/image.srec
6025 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
6026 ...
6027 15989 15990 15991 15992
6028 [file transfer complete]
6029 [connected]
6030 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00006031
wdenkc6097192002-11-03 00:24:07 +00006032
wdenk6c59edc2004-05-03 20:45:30 +00006033You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006034this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00006035corruption happened:
wdenkc6097192002-11-03 00:24:07 +00006036
wdenk6c59edc2004-05-03 20:45:30 +00006037 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk6c59edc2004-05-03 20:45:30 +00006039 ## Checking Image at 40100000 ...
6040 Image Name: 2.2.13 for initrd on TQM850L
6041 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6042 Data Size: 335725 Bytes = 327 kB = 0 MB
6043 Load Address: 00000000
6044 Entry Point: 0000000c
6045 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006046
6047
wdenk6c59edc2004-05-03 20:45:30 +00006048Boot Linux:
6049-----------
wdenkc6097192002-11-03 00:24:07 +00006050
wdenk6c59edc2004-05-03 20:45:30 +00006051The "bootm" command is used to boot an application that is stored in
6052memory (RAM or Flash). In case of a Linux kernel image, the contents
6053of the "bootargs" environment variable is passed to the kernel as
6054parameters. You can check and modify this variable using the
6055"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00006056
wdenkc6097192002-11-03 00:24:07 +00006057
wdenk6c59edc2004-05-03 20:45:30 +00006058 => printenv bootargs
6059 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00006060
wdenk6c59edc2004-05-03 20:45:30 +00006061 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00006062
wdenk6c59edc2004-05-03 20:45:30 +00006063 => printenv bootargs
6064 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00006065
wdenk6c59edc2004-05-03 20:45:30 +00006066 => bootm 40020000
6067 ## Booting Linux kernel at 40020000 ...
6068 Image Name: 2.2.13 for NFS on TQM850L
6069 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6070 Data Size: 381681 Bytes = 372 kB = 0 MB
6071 Load Address: 00000000
6072 Entry Point: 0000000c
6073 Verifying Checksum ... OK
6074 Uncompressing Kernel Image ... OK
6075 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
6076 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6077 time_init: decrementer frequency = 187500000/60
6078 Calibrating delay loop... 49.77 BogoMIPS
6079 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6080 ...
wdenkc6097192002-11-03 00:24:07 +00006081
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006082If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00006083the memory addresses of both the kernel and the initrd image (PPBCOOT
6084format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk6c59edc2004-05-03 20:45:30 +00006086 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006087
wdenk6c59edc2004-05-03 20:45:30 +00006088 ## Checking Image at 40100000 ...
6089 Image Name: 2.2.13 for initrd on TQM850L
6090 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6091 Data Size: 335725 Bytes = 327 kB = 0 MB
6092 Load Address: 00000000
6093 Entry Point: 0000000c
6094 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006095
wdenk6c59edc2004-05-03 20:45:30 +00006096 ## Checking Image at 40200000 ...
6097 Image Name: Simple Ramdisk Image
6098 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6099 Data Size: 566530 Bytes = 553 kB = 0 MB
6100 Load Address: 00000000
6101 Entry Point: 00000000
6102 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006103
wdenk6c59edc2004-05-03 20:45:30 +00006104 => bootm 40100000 40200000
6105 ## Booting Linux kernel at 40100000 ...
6106 Image Name: 2.2.13 for initrd on TQM850L
6107 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6108 Data Size: 335725 Bytes = 327 kB = 0 MB
6109 Load Address: 00000000
6110 Entry Point: 0000000c
6111 Verifying Checksum ... OK
6112 Uncompressing Kernel Image ... OK
6113 ## Loading RAMDisk Image at 40200000 ...
6114 Image Name: Simple Ramdisk Image
6115 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6116 Data Size: 566530 Bytes = 553 kB = 0 MB
6117 Load Address: 00000000
6118 Entry Point: 00000000
6119 Verifying Checksum ... OK
6120 Loading Ramdisk ... OK
6121 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
6122 Boot arguments: root=/dev/ram
6123 time_init: decrementer frequency = 187500000/60
6124 Calibrating delay loop... 49.77 BogoMIPS
6125 ...
6126 RAMDISK: Compressed image found at block 0
6127 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006128
wdenk6c59edc2004-05-03 20:45:30 +00006129 bash#
wdenkc6097192002-11-03 00:24:07 +00006130
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006131Boot Linux and pass a flat device tree:
6132-----------
6133
6134First, U-Boot must be compiled with the appropriate defines. See the section
6135titled "Linux Kernel Interface" above for a more in depth explanation. The
6136following is an example of how to start a kernel and pass an updated
6137flat device tree:
6138
6139=> print oftaddr
6140oftaddr=0x300000
6141=> print oft
6142oft=oftrees/mpc8540ads.dtb
6143=> tftp $oftaddr $oft
6144Speed: 1000, full duplex
6145Using TSEC0 device
6146TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6147Filename 'oftrees/mpc8540ads.dtb'.
6148Load address: 0x300000
6149Loading: #
6150done
6151Bytes transferred = 4106 (100a hex)
6152=> tftp $loadaddr $bootfile
6153Speed: 1000, full duplex
6154Using TSEC0 device
6155TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6156Filename 'uImage'.
6157Load address: 0x200000
6158Loading:############
6159done
6160Bytes transferred = 1029407 (fb51f hex)
6161=> print loadaddr
6162loadaddr=200000
6163=> print oftaddr
6164oftaddr=0x300000
6165=> bootm $loadaddr - $oftaddr
6166## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006167 Image Name: Linux-2.6.17-dirty
6168 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6169 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006170 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006171 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006172 Verifying Checksum ... OK
6173 Uncompressing Kernel Image ... OK
6174Booting using flat device tree at 0x300000
6175Using MPC85xx ADS machine description
6176Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6177[snip]
6178
6179
wdenk6c59edc2004-05-03 20:45:30 +00006180More About U-Boot Image Types:
6181------------------------------
wdenkc6097192002-11-03 00:24:07 +00006182
wdenk6c59edc2004-05-03 20:45:30 +00006183U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006184
wdenk6c59edc2004-05-03 20:45:30 +00006185 "Standalone Programs" are directly runnable in the environment
6186 provided by U-Boot; it is expected that (if they behave
6187 well) you can continue to work in U-Boot after return from
6188 the Standalone Program.
6189 "OS Kernel Images" are usually images of some Embedded OS which
6190 will take over control completely. Usually these programs
6191 will install their own set of exception handlers, device
6192 drivers, set up the MMU, etc. - this means, that you cannot
6193 expect to re-enter U-Boot except by resetting the CPU.
6194 "RAMDisk Images" are more or less just data blocks, and their
6195 parameters (address, size) are passed to an OS kernel that is
6196 being started.
6197 "Multi-File Images" contain several images, typically an OS
6198 (Linux) kernel image and one or more data images like
6199 RAMDisks. This construct is useful for instance when you want
6200 to boot over the network using BOOTP etc., where the boot
6201 server provides just a single image file, but you want to get
6202 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006203
wdenk6c59edc2004-05-03 20:45:30 +00006204 "Multi-File Images" start with a list of image sizes, each
6205 image size (in bytes) specified by an "uint32_t" in network
6206 byte order. This list is terminated by an "(uint32_t)0".
6207 Immediately after the terminating 0 follow the images, one by
6208 one, all aligned on "uint32_t" boundaries (size rounded up to
6209 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211 "Firmware Images" are binary images containing firmware (like
6212 U-Boot or FPGA images) which usually will be programmed to
6213 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006214
wdenk6c59edc2004-05-03 20:45:30 +00006215 "Script files" are command sequences that will be executed by
6216 U-Boot's command interpreter; this feature is especially
6217 useful when you configure U-Boot to use a real shell (hush)
6218 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006219
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006220Booting the Linux zImage:
6221-------------------------
6222
6223On some platforms, it's possible to boot Linux zImage. This is done
6224using the "bootz" command. The syntax of "bootz" command is the same
6225as the syntax of "bootm" command.
6226
Tom Rini45f46d12013-05-16 11:40:11 -04006227Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006228kernel with raw initrd images. The syntax is slightly different, the
6229address of the initrd must be augmented by it's size, in the following
6230format: "<initrd addres>:<initrd size>".
6231
stroeseb9c17c52003-04-04 15:53:41 +00006232
wdenk6c59edc2004-05-03 20:45:30 +00006233Standalone HOWTO:
6234=================
stroeseb9c17c52003-04-04 15:53:41 +00006235
wdenk6c59edc2004-05-03 20:45:30 +00006236One of the features of U-Boot is that you can dynamically load and
6237run "standalone" applications, which can use some resources of
6238U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006239
wdenk6c59edc2004-05-03 20:45:30 +00006240Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006241
wdenk6c59edc2004-05-03 20:45:30 +00006242"Hello World" Demo:
6243-------------------
wdenkc6097192002-11-03 00:24:07 +00006244
wdenk6c59edc2004-05-03 20:45:30 +00006245'examples/hello_world.c' contains a small "Hello World" Demo
6246application; it is automatically compiled when you build U-Boot.
6247It's configured to run at address 0x00040004, so you can play with it
6248like that:
wdenkc6097192002-11-03 00:24:07 +00006249
wdenk6c59edc2004-05-03 20:45:30 +00006250 => loads
6251 ## Ready for S-Record download ...
6252 ~>examples/hello_world.srec
6253 1 2 3 4 5 6 7 8 9 10 11 ...
6254 [file transfer complete]
6255 [connected]
6256 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006257
wdenk6c59edc2004-05-03 20:45:30 +00006258 => go 40004 Hello World! This is a test.
6259 ## Starting application at 0x00040004 ...
6260 Hello World
6261 argc = 7
6262 argv[0] = "40004"
6263 argv[1] = "Hello"
6264 argv[2] = "World!"
6265 argv[3] = "This"
6266 argv[4] = "is"
6267 argv[5] = "a"
6268 argv[6] = "test."
6269 argv[7] = "<NULL>"
6270 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006271
wdenk6c59edc2004-05-03 20:45:30 +00006272 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006273
wdenk6c59edc2004-05-03 20:45:30 +00006274Another example, which demonstrates how to register a CPM interrupt
6275handler with the U-Boot code, can be found in 'examples/timer.c'.
6276Here, a CPM timer is set up to generate an interrupt every second.
6277The interrupt service routine is trivial, just printing a '.'
6278character, but this is just a demo program. The application can be
6279controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006280
wdenk6c59edc2004-05-03 20:45:30 +00006281 ? - print current values og the CPM Timer registers
6282 b - enable interrupts and start timer
6283 e - stop timer and disable interrupts
6284 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006285
wdenk6c59edc2004-05-03 20:45:30 +00006286 => loads
6287 ## Ready for S-Record download ...
6288 ~>examples/timer.srec
6289 1 2 3 4 5 6 7 8 9 10 11 ...
6290 [file transfer complete]
6291 [connected]
6292 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006293
wdenk6c59edc2004-05-03 20:45:30 +00006294 => go 40004
6295 ## Starting application at 0x00040004 ...
6296 TIMERS=0xfff00980
6297 Using timer 1
6298 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006299
wdenk6c59edc2004-05-03 20:45:30 +00006300Hit 'b':
6301 [q, b, e, ?] Set interval 1000000 us
6302 Enabling timer
6303Hit '?':
6304 [q, b, e, ?] ........
6305 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6306Hit '?':
6307 [q, b, e, ?] .
6308 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6309Hit '?':
6310 [q, b, e, ?] .
6311 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6312Hit '?':
6313 [q, b, e, ?] .
6314 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6315Hit 'e':
6316 [q, b, e, ?] ...Stopping timer
6317Hit 'q':
6318 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006319
wdenkc6097192002-11-03 00:24:07 +00006320
wdenk6c59edc2004-05-03 20:45:30 +00006321Minicom warning:
6322================
wdenkc6097192002-11-03 00:24:07 +00006323
wdenk6c59edc2004-05-03 20:45:30 +00006324Over time, many people have reported problems when trying to use the
6325"minicom" terminal emulation program for serial download. I (wd)
6326consider minicom to be broken, and recommend not to use it. Under
6327Unix, I recommend to use C-Kermit for general purpose use (and
6328especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006329use "cu" for S-Record download ("loads" command). See
6330http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6331for help with kermit.
6332
wdenkc6097192002-11-03 00:24:07 +00006333
wdenk6c59edc2004-05-03 20:45:30 +00006334Nevertheless, if you absolutely want to use it try adding this
6335configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006336
wdenk6c59edc2004-05-03 20:45:30 +00006337 Name Program Name U/D FullScr IO-Red. Multi
6338 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6339 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006340
wdenk8dba0502003-03-31 16:34:49 +00006341
wdenk6c59edc2004-05-03 20:45:30 +00006342NetBSD Notes:
6343=============
wdenkc6097192002-11-03 00:24:07 +00006344
wdenk6c59edc2004-05-03 20:45:30 +00006345Starting at version 0.9.2, U-Boot supports NetBSD both as host
6346(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006347
wdenk6c59edc2004-05-03 20:45:30 +00006348Building requires a cross environment; it is known to work on
6349NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6350need gmake since the Makefiles are not compatible with BSD make).
6351Note that the cross-powerpc package does not install include files;
6352attempting to build U-Boot will fail because <machine/ansi.h> is
6353missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006354
wdenk6c59edc2004-05-03 20:45:30 +00006355 # cd /usr/pkg/cross/powerpc-netbsd/include
6356 # mkdir powerpc
6357 # ln -s powerpc machine
6358 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6359 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006360
wdenk6c59edc2004-05-03 20:45:30 +00006361Native builds *don't* work due to incompatibilities between native
6362and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006363
wdenk6c59edc2004-05-03 20:45:30 +00006364Booting assumes that (the first part of) the image booted is a
6365stage-2 loader which in turn loads and then invokes the kernel
6366proper. Loader sources will eventually appear in the NetBSD source
6367tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006368meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006369
wdenkc6097192002-11-03 00:24:07 +00006370
wdenk6c59edc2004-05-03 20:45:30 +00006371Implementation Internals:
6372=========================
wdenkc6097192002-11-03 00:24:07 +00006373
wdenk6c59edc2004-05-03 20:45:30 +00006374The following is not intended to be a complete description of every
6375implementation detail. However, it should help to understand the
6376inner workings of U-Boot and make it easier to port it to custom
6377hardware.
wdenkc6097192002-11-03 00:24:07 +00006378
wdenkc6097192002-11-03 00:24:07 +00006379
wdenk6c59edc2004-05-03 20:45:30 +00006380Initial Stack, Global Data:
6381---------------------------
wdenkc6097192002-11-03 00:24:07 +00006382
wdenk6c59edc2004-05-03 20:45:30 +00006383The implementation of U-Boot is complicated by the fact that U-Boot
6384starts running out of ROM (flash memory), usually without access to
6385system RAM (because the memory controller is not initialized yet).
6386This means that we don't have writable Data or BSS segments, and BSS
6387is not initialized as zero. To be able to get a C environment working
6388at all, we have to allocate at least a minimal stack. Implementation
6389options for this are defined and restricted by the CPU used: Some CPU
6390models provide on-chip memory (like the IMMR area on MPC8xx and
6391MPC826x processors), on others (parts of) the data cache can be
6392locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006393
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006394 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006395 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006396
wdenk6c59edc2004-05-03 20:45:30 +00006397 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6398 From: "Chris Hallinan" <clh@net1plus.com>
6399 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6400 ...
wdenkc6097192002-11-03 00:24:07 +00006401
wdenk6c59edc2004-05-03 20:45:30 +00006402 Correct me if I'm wrong, folks, but the way I understand it
6403 is this: Using DCACHE as initial RAM for Stack, etc, does not
6404 require any physical RAM backing up the cache. The cleverness
6405 is that the cache is being used as a temporary supply of
6406 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006407 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006408 can see how this works by studying the cache architecture and
6409 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006410
wdenk6c59edc2004-05-03 20:45:30 +00006411 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6412 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006413 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006414 option should work for you. Using CS 4 should be fine if your
6415 board designers haven't used it for something that would
6416 cause you grief during the initial boot! It is frequently not
6417 used.
wdenkc6097192002-11-03 00:24:07 +00006418
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006419 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006420 with your processor/board/system design. The default value
6421 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006422 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006423 than your SDRAM module. If you have a 64MB SDRAM module, set
6424 it above 400_0000. Just make sure your board has no resources
6425 that are supposed to respond to that address! That code in
6426 start.S has been around a while and should work as is when
6427 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006428
wdenk6c59edc2004-05-03 20:45:30 +00006429 -Chris Hallinan
6430 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006431
wdenk6c59edc2004-05-03 20:45:30 +00006432It is essential to remember this, since it has some impact on the C
6433code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006434
wdenk6c59edc2004-05-03 20:45:30 +00006435* Initialized global data (data segment) is read-only. Do not attempt
6436 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006437
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006438* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006439 as zero data - BSS segment) at all - this is undefined, initiali-
6440 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006441
wdenk6c59edc2004-05-03 20:45:30 +00006442* Stack space is very limited. Avoid big data buffers or things like
6443 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006444
wdenk6c59edc2004-05-03 20:45:30 +00006445Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006446normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006447turned out that the implementation of U-Boot can be greatly
6448simplified by making a global data structure (gd_t) available to all
6449functions. We could pass a pointer to this data as argument to _all_
6450functions, but this would bloat the code. Instead we use a feature of
6451the GCC compiler (Global Register Variables) to share the data: we
6452place a pointer (gd) to the global data into a register which we
6453reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006454
wdenk6c59edc2004-05-03 20:45:30 +00006455When choosing a register for such a purpose we are restricted by the
6456relevant (E)ABI specifications for the current architecture, and by
6457GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006458
wdenk6c59edc2004-05-03 20:45:30 +00006459For PowerPC, the following registers have specific use:
6460 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006461 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006462 R3-R4: parameter passing and return values
6463 R5-R10: parameter passing
6464 R13: small data area pointer
6465 R30: GOT pointer
6466 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006467
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006468 (U-Boot also uses R12 as internal GOT pointer. r12
6469 is a volatile register so r12 needs to be reset when
6470 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006471
Wolfgang Denk69c09642008-02-14 22:43:22 +01006472 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006473
wdenk6c59edc2004-05-03 20:45:30 +00006474 Note: on PPC, we could use a static initializer (since the
6475 address of the global data structure is known at compile time),
6476 but it turned out that reserving a register results in somewhat
6477 smaller code - although the code savings are not that big (on
6478 average for all boards 752 bytes for the whole U-Boot image,
6479 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006480
Robin Getz2773d5f2009-08-17 15:23:02 +00006481On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006482 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6483
Robin Getz2773d5f2009-08-17 15:23:02 +00006484 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006485
wdenk6c59edc2004-05-03 20:45:30 +00006486On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006487
wdenk6c59edc2004-05-03 20:45:30 +00006488 R0: function argument word/integer result
6489 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006490 R9: platform specific
6491 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006492 R11: argument (frame) pointer
6493 R12: temporary workspace
6494 R13: stack pointer
6495 R14: link register
6496 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006497
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006498 ==> U-Boot will use R9 to hold a pointer to the global data
6499
6500 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006501
Thomas Chou8fa38582010-05-21 11:08:03 +08006502On Nios II, the ABI is documented here:
6503 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6504
6505 ==> U-Boot will use gp to hold a pointer to the global data
6506
6507 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6508 to access small data sections, so gp is free.
6509
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006510On NDS32, the following registers are used:
6511
6512 R0-R1: argument/return
6513 R2-R5: argument
6514 R15: temporary register for assembler
6515 R16: trampoline register
6516 R28: frame pointer (FP)
6517 R29: global pointer (GP)
6518 R30: link register (LP)
6519 R31: stack pointer (SP)
6520 PC: program counter (PC)
6521
6522 ==> U-Boot will use R10 to hold a pointer to the global data
6523
Wolfgang Denk6405a152006-03-31 18:32:53 +02006524NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6525or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006526
wdenk6c59edc2004-05-03 20:45:30 +00006527Memory Management:
6528------------------
wdenkc6097192002-11-03 00:24:07 +00006529
wdenk6c59edc2004-05-03 20:45:30 +00006530U-Boot runs in system state and uses physical addresses, i.e. the
6531MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006532
wdenk6c59edc2004-05-03 20:45:30 +00006533The available memory is mapped to fixed addresses using the memory
6534controller. In this process, a contiguous block is formed for each
6535memory type (Flash, SDRAM, SRAM), even when it consists of several
6536physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006537
wdenk6c59edc2004-05-03 20:45:30 +00006538U-Boot is installed in the first 128 kB of the first Flash bank (on
6539TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6540booting and sizing and initializing DRAM, the code relocates itself
6541to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006542memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006543configuration setting]. Below that, a structure with global Board
6544Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006545
wdenk6c59edc2004-05-03 20:45:30 +00006546Additionally, some exception handler code is copied to the low 8 kB
6547of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006548
wdenk6c59edc2004-05-03 20:45:30 +00006549So a typical memory configuration with 16 MB of DRAM could look like
6550this:
wdenkc6097192002-11-03 00:24:07 +00006551
wdenk6c59edc2004-05-03 20:45:30 +00006552 0x0000 0000 Exception Vector code
6553 :
6554 0x0000 1FFF
6555 0x0000 2000 Free for Application Use
6556 :
6557 :
wdenkc6097192002-11-03 00:24:07 +00006558
wdenk6c59edc2004-05-03 20:45:30 +00006559 :
6560 :
6561 0x00FB FF20 Monitor Stack (Growing downward)
6562 0x00FB FFAC Board Info Data and permanent copy of global data
6563 0x00FC 0000 Malloc Arena
6564 :
6565 0x00FD FFFF
6566 0x00FE 0000 RAM Copy of Monitor Code
6567 ... eventually: LCD or video framebuffer
6568 ... eventually: pRAM (Protected RAM - unchanged by reset)
6569 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006570
wdenkc6097192002-11-03 00:24:07 +00006571
wdenk6c59edc2004-05-03 20:45:30 +00006572System Initialization:
6573----------------------
wdenkc6097192002-11-03 00:24:07 +00006574
wdenk6c59edc2004-05-03 20:45:30 +00006575In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006576(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006577configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006578To be able to re-map memory U-Boot then jumps to its link address.
6579To be able to implement the initialization code in C, a (small!)
6580initial stack is set up in the internal Dual Ported RAM (in case CPUs
6581which provide such a feature like MPC8xx or MPC8260), or in a locked
6582part of the data cache. After that, U-Boot initializes the CPU core,
6583the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006584
wdenk6c59edc2004-05-03 20:45:30 +00006585Next, all (potentially) available memory banks are mapped using a
6586preliminary mapping. For example, we put them on 512 MB boundaries
6587(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6588on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6589programmed for SDRAM access. Using the temporary configuration, a
6590simple memory test is run that determines the size of the SDRAM
6591banks.
wdenkc6097192002-11-03 00:24:07 +00006592
wdenk6c59edc2004-05-03 20:45:30 +00006593When there is more than one SDRAM bank, and the banks are of
6594different size, the largest is mapped first. For equal size, the first
6595bank (CS2#) is mapped first. The first mapping is always for address
65960x00000000, with any additional banks following immediately to create
6597contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006598
wdenk6c59edc2004-05-03 20:45:30 +00006599Then, the monitor installs itself at the upper end of the SDRAM area
6600and allocates memory for use by malloc() and for the global Board
6601Info data; also, the exception vector code is copied to the low RAM
6602pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006603
wdenk6c59edc2004-05-03 20:45:30 +00006604Only after this relocation will you have a "normal" C environment;
6605until that you are restricted in several ways, mostly because you are
6606running from ROM, and because the code will have to be relocated to a
6607new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006608
wdenkc6097192002-11-03 00:24:07 +00006609
wdenk6c59edc2004-05-03 20:45:30 +00006610U-Boot Porting Guide:
6611----------------------
wdenkc6097192002-11-03 00:24:07 +00006612
wdenk6c59edc2004-05-03 20:45:30 +00006613[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6614list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006615
wdenkc6097192002-11-03 00:24:07 +00006616
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006617int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006618{
6619 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006620
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006621 signal(SIGALRM, no_more_time);
6622 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006623
wdenk6c59edc2004-05-03 20:45:30 +00006624 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006625 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006626 return 0;
6627 }
wdenkc6097192002-11-03 00:24:07 +00006628
wdenk6c59edc2004-05-03 20:45:30 +00006629 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006630
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006631 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006632
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006633 if (clueless)
6634 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006635
wdenk6c59edc2004-05-03 20:45:30 +00006636 while (learning) {
6637 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006638 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6639 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006640 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006641 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006642 }
wdenkc6097192002-11-03 00:24:07 +00006643
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006644 if (available_money > toLocalCurrency ($2500))
6645 Buy a BDI3000;
6646 else
wdenk6c59edc2004-05-03 20:45:30 +00006647 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006648
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006649 if (a similar board exists) { /* hopefully... */
6650 cp -a board/<similar> board/<myboard>
6651 cp include/configs/<similar>.h include/configs/<myboard>.h
6652 } else {
6653 Create your own board support subdirectory;
6654 Create your own board include/configs/<myboard>.h file;
6655 }
6656 Edit new board/<myboard> files
6657 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006658
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006659 while (!accepted) {
6660 while (!running) {
6661 do {
6662 Add / modify source code;
6663 } until (compiles);
6664 Debug;
6665 if (clueless)
6666 email("Hi, I am having problems...");
6667 }
6668 Send patch file to the U-Boot email list;
6669 if (reasonable critiques)
6670 Incorporate improvements from email list code review;
6671 else
6672 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006673 }
wdenkc6097192002-11-03 00:24:07 +00006674
wdenk6c59edc2004-05-03 20:45:30 +00006675 return 0;
6676}
wdenkc6097192002-11-03 00:24:07 +00006677
wdenk6c59edc2004-05-03 20:45:30 +00006678void no_more_time (int sig)
6679{
6680 hire_a_guru();
6681}
wdenkc6097192002-11-03 00:24:07 +00006682
wdenkc6097192002-11-03 00:24:07 +00006683
wdenk6c59edc2004-05-03 20:45:30 +00006684Coding Standards:
6685-----------------
wdenkc6097192002-11-03 00:24:07 +00006686
wdenk6c59edc2004-05-03 20:45:30 +00006687All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006688coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006689"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006690
6691Source files originating from a different project (for example the
6692MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006693reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006694sources.
wdenkc6097192002-11-03 00:24:07 +00006695
Detlev Zundelaa63d482006-09-01 15:39:02 +02006696Please note that U-Boot is implemented in C (and to some small parts in
6697Assembler); no C++ is used, so please do not use C++ style comments (//)
6698in your code.
wdenkad276f22004-01-04 16:28:35 +00006699
wdenk6c59edc2004-05-03 20:45:30 +00006700Please also stick to the following formatting rules:
6701- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006702- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006703- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006704- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006705- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006706
wdenk6c59edc2004-05-03 20:45:30 +00006707Submissions which do not conform to the standards may be returned
6708with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006709
wdenkc6097192002-11-03 00:24:07 +00006710
wdenk6c59edc2004-05-03 20:45:30 +00006711Submitting Patches:
6712-------------------
wdenkc6097192002-11-03 00:24:07 +00006713
wdenk6c59edc2004-05-03 20:45:30 +00006714Since the number of patches for U-Boot is growing, we need to
6715establish some rules. Submissions which do not conform to these rules
6716may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006717
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006718Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006719
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006720Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6721see http://lists.denx.de/mailman/listinfo/u-boot
6722
wdenk6c59edc2004-05-03 20:45:30 +00006723When you send a patch, please include the following information with
6724it:
wdenkc6097192002-11-03 00:24:07 +00006725
wdenk6c59edc2004-05-03 20:45:30 +00006726* For bug fixes: a description of the bug and how your patch fixes
6727 this bug. Please try to include a way of demonstrating that the
6728 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006729
wdenk6c59edc2004-05-03 20:45:30 +00006730* For new features: a description of the feature and your
6731 implementation.
wdenkc6097192002-11-03 00:24:07 +00006732
wdenk6c59edc2004-05-03 20:45:30 +00006733* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006734
wdenk6c59edc2004-05-03 20:45:30 +00006735* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006736
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006737* When you add support for a new board, don't forget to add a
6738 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006739
wdenk6c59edc2004-05-03 20:45:30 +00006740* If your patch adds new configuration options, don't forget to
6741 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006742
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006743* The patch itself. If you are using git (which is *strongly*
6744 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006745 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006746 the U-Boot mailing list, you will avoid most of the common problems
6747 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006748
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006749 If you cannot use git, use "diff -purN OLD NEW". If your version of
6750 diff does not support these options, then get the latest version of
6751 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006752
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006753 The current directory when running this command shall be the parent
6754 directory of the U-Boot source tree (i. e. please make sure that
6755 your patch includes sufficient directory information for the
6756 affected files).
6757
6758 We prefer patches as plain text. MIME attachments are discouraged,
6759 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006760
wdenk6c59edc2004-05-03 20:45:30 +00006761* If one logical set of modifications affects or creates several
6762 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006763
wdenk6c59edc2004-05-03 20:45:30 +00006764* Changesets that contain different, unrelated modifications shall be
6765 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006766
wdenkc6097192002-11-03 00:24:07 +00006767
wdenk6c59edc2004-05-03 20:45:30 +00006768Notes:
wdenkc6097192002-11-03 00:24:07 +00006769
wdenk6c59edc2004-05-03 20:45:30 +00006770* Before sending the patch, run the MAKEALL script on your patched
6771 source tree and make sure that no errors or warnings are reported
6772 for any of the boards.
6773
6774* Keep your modifications to the necessary minimum: A patch
6775 containing several unrelated changes or arbitrary reformats will be
6776 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006777
wdenk6c59edc2004-05-03 20:45:30 +00006778* If you modify existing code, make sure that your new code does not
6779 add to the memory footprint of the code ;-) Small is beautiful!
6780 When adding new features, these should compile conditionally only
6781 (using #ifdef), and the resulting code with the new feature
6782 disabled must not need more memory than the old code without your
6783 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006784
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006785* Remember that there is a size limit of 100 kB per message on the
6786 u-boot mailing list. Bigger patches will be moderated. If they are
6787 reasonable and not too big, they will be acknowledged. But patches
6788 bigger than the size limit should be avoided.