blob: 2e81ccc37c782d65aee6e82283d76bff44515d13 [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
York Sun77a10972015-03-20 19:28:08 -0700693 COUNTER_FREQUENCY
694 Generic timer clock source frequency.
695
696 COUNTER_FREQUENCY_REAL
697 Generic timer clock source frequency if the real clock is
698 different from COUNTER_FREQUENCY, and can only be determined
699 at run time.
700
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500701 NOTE: The following can be machine specific errata. These
702 do have ability to provide rudimentary version and machine
703 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500704 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500705 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500706 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500707 CONFIG_ARM_ERRATA_798870
708
Stephen Warren8d1fb312015-01-19 16:25:52 -0700709- Tegra SoC options:
710 CONFIG_TEGRA_SUPPORT_NON_SECURE
711
712 Support executing U-Boot in non-secure (NS) mode. Certain
713 impossible actions will be skipped if the CPU is in NS mode,
714 such as ARM architectural timer initialization.
715
wdenk9b7f3842003-10-09 20:09:04 +0000716- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000717 CONFIG_CLOCKS_IN_MHZ
718
719 U-Boot stores all clock information in Hz
720 internally. For binary compatibility with older Linux
721 kernels (which expect the clocks passed in the
722 bd_info data to be in MHz) the environment variable
723 "clocks_in_mhz" can be defined so that U-Boot
724 converts clock data to MHZ before passing it to the
725 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000726 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100727 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000728 default environment.
729
wdenk9b7f3842003-10-09 20:09:04 +0000730 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
731
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800732 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000733 expect it to be in bytes, others in MB.
734 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
735
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400736 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200737
738 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400739 passed using flattened device trees (based on open firmware
740 concepts).
741
742 CONFIG_OF_LIBFDT
743 * New libfdt-based support
744 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500745 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400746
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200747 OF_CPU - The proper name of the cpus node (only required for
748 MPC512X and MPC5xxx based boards).
749 OF_SOC - The proper name of the soc node (only required for
750 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200751 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600752 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200753
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200754 boards with QUICC Engines require OF_QE to set UCC MAC
755 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500756
Kumar Gala1e26aa52006-01-11 13:54:17 -0600757 CONFIG_OF_BOARD_SETUP
758
759 Board code has addition modification that it wants to make
760 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000761
Simon Glass6c0be912014-10-23 18:58:54 -0600762 CONFIG_OF_SYSTEM_SETUP
763
764 Other code has addition modification that it wants to make
765 to the flat device tree before handing it off to the kernel.
766 This causes ft_system_setup() to be called before booting
767 the kernel.
768
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500769 CONFIG_OF_BOOT_CPU
770
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200771 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500772 param header, the default value is zero if undefined.
773
Heiko Schocherffb293a2009-09-23 07:56:08 +0200774 CONFIG_OF_IDE_FIXUP
775
776 U-Boot can detect if an IDE device is present or not.
777 If not, and this new config option is activated, U-Boot
778 removes the ATA node from the DTS before booting Linux,
779 so the Linux IDE driver does not probe the device and
780 crash. This is needed for buggy hardware (uc101) where
781 no pull down resistor is connected to the signal IDE5V_DD7.
782
Igor Grinberg06890672011-07-14 05:45:07 +0000783 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
784
785 This setting is mandatory for all boards that have only one
786 machine type and must be used to specify the machine type
787 number as it appears in the ARM machine registry
788 (see http://www.arm.linux.org.uk/developer/machines/).
789 Only boards that have multiple machine types supported
790 in a single configuration file and the machine type is
791 runtime discoverable, do not have to use this setting.
792
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100793- vxWorks boot parameters:
794
795 bootvx constructs a valid bootline using the following
796 environments variables: bootfile, ipaddr, serverip, hostname.
797 It loads the vxWorks image pointed bootfile.
798
799 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
800 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
801 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
802 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
803
804 CONFIG_SYS_VXWORKS_ADD_PARAMS
805
806 Add it at the end of the bootline. E.g "u=username pw=secret"
807
808 Note: If a "bootargs" environment is defined, it will overwride
809 the defaults discussed just above.
810
Aneesh V960f5c02011-06-16 23:30:47 +0000811- Cache Configuration:
812 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
813 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
814 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
815
Aneesh V686a0752011-06-16 23:30:51 +0000816- Cache Configuration for ARM:
817 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
818 controller
819 CONFIG_SYS_PL310_BASE - Physical base address of PL310
820 controller register space
821
wdenkda04a8b2004-08-02 23:22:59 +0000822- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200823 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000824
825 Define this if you want support for Amba PrimeCell PL010 UARTs.
826
Andreas Engel0813b122008-09-08 14:30:53 +0200827 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000828
829 Define this if you want support for Amba PrimeCell PL011 UARTs.
830
831 CONFIG_PL011_CLOCK
832
833 If you have Amba PrimeCell PL011 UARTs, set this variable to
834 the clock speed of the UARTs.
835
836 CONFIG_PL01x_PORTS
837
838 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
839 define this to a list of base addresses for each (supported)
840 port. See e.g. include/configs/versatile.h
841
John Rigby34e21ee2011-04-19 10:42:39 +0000842 CONFIG_PL011_SERIAL_RLCR
843
844 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
845 have separate receive and transmit line control registers. Set
846 this variable to initialize the extra register.
847
848 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
849
850 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
851 boot loader that has already initialized the UART. Define this
852 variable to flush the UART at init time.
853
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400854 CONFIG_SERIAL_HW_FLOW_CONTROL
855
856 Define this variable to enable hw flow control in serial driver.
857 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000858
wdenkc6097192002-11-03 00:24:07 +0000859- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000860 Depending on board, define exactly one serial port
861 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
862 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
863 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000864
865 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
866 port routines must be defined elsewhere
867 (i.e. serial_init(), serial_getc(), ...)
868
869 CONFIG_CFB_CONSOLE
870 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000871 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000872 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
873 (default big endian)
874 VIDEO_HW_RECTFILL graphic chip supports
875 rectangle fill
876 (cf. smiLynxEM)
877 VIDEO_HW_BITBLT graphic chip supports
878 bit-blit (cf. smiLynxEM)
879 VIDEO_VISIBLE_COLS visible pixel columns
880 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000881 VIDEO_VISIBLE_ROWS visible pixel rows
882 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000883 VIDEO_DATA_FORMAT graphic data format
884 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000885 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000886 VIDEO_KBD_INIT_FCT keyboard int fct
887 (i.e. i8042_kbd_init())
888 VIDEO_TSTC_FCT test char fct
889 (i.e. i8042_tstc)
890 VIDEO_GETC_FCT get char fct
891 (i.e. i8042_getc)
892 CONFIG_CONSOLE_CURSOR cursor drawing on/off
893 (requires blink timer
894 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200895 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000896 CONFIG_CONSOLE_TIME display time/date info in
897 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500898 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000899 CONFIG_VIDEO_LOGO display Linux logo in
900 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000901 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
902 linux_logo.h for logo.
903 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000904 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200905 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000906 the logo
907
Pali Rohár4a57da32012-10-19 13:30:09 +0000908 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
909 a limited number of ANSI escape sequences (cursor control,
910 erase functions and limited graphics rendition control).
911
wdenk4a5c8a72003-03-06 00:02:04 +0000912 When CONFIG_CFB_CONSOLE is defined, video console is
913 default i/o. Serial console can be forced with
914 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000915
wdenk1ebf41e2004-01-02 14:00:00 +0000916 When CONFIG_SILENT_CONSOLE is defined, all console
917 messages (by U-Boot and Linux!) can be silenced with
918 the "silent" environment variable. See
919 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000920
Heiko Schocher62759562013-10-22 11:06:06 +0200921 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
922 is 0x00.
923 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
924 is 0xa0.
925
wdenkc6097192002-11-03 00:24:07 +0000926- Console Baudrate:
927 CONFIG_BAUDRATE - in bps
928 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200929 CONFIG_SYS_BAUDRATE_TABLE, see below.
930 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000931
Heiko Schocher327480a2009-01-30 12:55:38 +0100932- Console Rx buffer length
933 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
934 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100935 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100936 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
937 must be defined, to setup the maximum idle timeout for
938 the SMC.
939
Graeme Russ3c28f482011-09-01 00:48:27 +0000940- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200941 Prior to the console being initialised (i.e. serial UART
942 initialised etc) all console output is silently discarded.
943 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
944 buffer any console messages prior to the console being
945 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
946 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
947 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200948 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200949 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000950
Hans de Goedee355da02015-05-05 13:13:36 +0200951 Note that when printing the buffer a copy is made on the
952 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
953
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200954 'Sane' compilers will generate smaller code if
955 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000956
Sonny Raocd55bde2011-11-02 09:52:08 +0000957- Safe printf() functions
958 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
959 the printf() functions. These are defined in
960 include/vsprintf.h and include snprintf(), vsnprintf() and
961 so on. Code size increase is approximately 300-500 bytes.
962 If this option is not given then these functions will
963 silently discard their buffer size argument - this means
964 you are not getting any overflow checking in this case.
965
wdenkc6097192002-11-03 00:24:07 +0000966- Boot Delay: CONFIG_BOOTDELAY - in seconds
967 Delay before automatically booting the default image;
968 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000969 set to -2 to autoboot with no delay and not check for abort
970 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000971
972 See doc/README.autoboot for these options that
973 work with CONFIG_BOOTDELAY. None are required.
974 CONFIG_BOOT_RETRY_TIME
975 CONFIG_BOOT_RETRY_MIN
976 CONFIG_AUTOBOOT_KEYED
977 CONFIG_AUTOBOOT_PROMPT
978 CONFIG_AUTOBOOT_DELAY_STR
979 CONFIG_AUTOBOOT_STOP_STR
980 CONFIG_AUTOBOOT_DELAY_STR2
981 CONFIG_AUTOBOOT_STOP_STR2
982 CONFIG_ZERO_BOOTDELAY_CHECK
983 CONFIG_RESET_TO_RETRY
984
985- Autoboot Command:
986 CONFIG_BOOTCOMMAND
987 Only needed when CONFIG_BOOTDELAY is enabled;
988 define a command string that is automatically executed
989 when no character is read on the console interface
990 within "Boot Delay" after reset.
991
992 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000993 This can be used to pass arguments to the bootm
994 command. The value of CONFIG_BOOTARGS goes into the
995 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000996
997 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000998 The value of these goes into the environment as
999 "ramboot" and "nfsboot" respectively, and can be used
1000 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001001 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001002
Heiko Schocher040c5c32013-11-04 14:04:59 +01001003- Bootcount:
1004 CONFIG_BOOTCOUNT_LIMIT
1005 Implements a mechanism for detecting a repeating reboot
1006 cycle, see:
1007 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1008
1009 CONFIG_BOOTCOUNT_ENV
1010 If no softreset save registers are found on the hardware
1011 "bootcount" is stored in the environment. To prevent a
1012 saveenv on all reboots, the environment variable
1013 "upgrade_available" is used. If "upgrade_available" is
1014 0, "bootcount" is always 0, if "upgrade_available" is
1015 1 "bootcount" is incremented in the environment.
1016 So the Userspace Applikation must set the "upgrade_available"
1017 and "bootcount" variable to 0, if a boot was successfully.
1018
wdenkc6097192002-11-03 00:24:07 +00001019- Pre-Boot Commands:
1020 CONFIG_PREBOOT
1021
1022 When this option is #defined, the existence of the
1023 environment variable "preboot" will be checked
1024 immediately before starting the CONFIG_BOOTDELAY
1025 countdown and/or running the auto-boot command resp.
1026 entering interactive mode.
1027
1028 This feature is especially useful when "preboot" is
1029 automatically generated or modified. For an example
1030 see the LWMON board specific code: here "preboot" is
1031 modified when the user holds down a certain
1032 combination of keys on the (special) keyboard when
1033 booting the systems
1034
1035- Serial Download Echo Mode:
1036 CONFIG_LOADS_ECHO
1037 If defined to 1, all characters received during a
1038 serial download (using the "loads" command) are
1039 echoed back. This might be needed by some terminal
1040 emulations (like "cu"), but may as well just take
1041 time on others. This setting #define's the initial
1042 value of the "loads_echo" environment variable.
1043
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001044- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001045 CONFIG_KGDB_BAUDRATE
1046 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001047 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001048
1049- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001050 Monitor commands can be included or excluded
1051 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001052 <config_cmd_all.h> and #undef'ing unwanted
1053 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001054 and augmenting with additional #define's
1055 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001056
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001057 The default command configuration includes all commands
1058 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001059
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001060 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001061 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001062 CONFIG_CMD_BDI bdinfo
1063 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1064 CONFIG_CMD_BMP * BMP support
1065 CONFIG_CMD_BSP * Board specific commands
1066 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001067 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001068 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001069 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001070 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001071 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001072 CONFIG_CMD_DATE * support for RTC, date/time...
1073 CONFIG_CMD_DHCP * DHCP support
1074 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001075 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1076 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1077 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1078 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001079 CONFIG_CMD_DTT * Digital Therm and Thermostat
1080 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001081 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001082 CONFIG_CMD_EEPROM * EEPROM read/write support
1083 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001084 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001085 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001086 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001087 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001088 CONFIG_CMD_EXT2 * ext2 command support
1089 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001090 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1091 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001092 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001093 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001094 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001095 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001096 CONFIG_CMD_FLASH flinfo, erase, protect
1097 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001098 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001099 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001100 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001101 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001102 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001103 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1104 CONFIG_CMD_I2C * I2C serial bus support
1105 CONFIG_CMD_IDE * IDE harddisk support
1106 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001107 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001108 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001109 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001110 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001111 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001112 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001113 CONFIG_CMD_IRQ * irqinfo
1114 CONFIG_CMD_ITEST Integer/string test of 2 values
1115 CONFIG_CMD_JFFS2 * JFFS2 Support
1116 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001117 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001118 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1119 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001120 CONFIG_CMD_LOADB loadb
1121 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001122 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001123 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001124 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001125 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001126 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001127 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001128 CONFIG_CMD_MISC Misc functions like sleep etc
1129 CONFIG_CMD_MMC * MMC memory mapped support
1130 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001131 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001132 CONFIG_CMD_NAND * NAND support
1133 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001134 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001135 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001136 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001137 CONFIG_CMD_PCI * pciinfo
1138 CONFIG_CMD_PCMCIA * PCMCIA support
1139 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1140 host
1141 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001142 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001143 CONFIG_CMD_REGINFO * Register dump
1144 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001145 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001146 CONFIG_CMD_SAVES * save S record dump
1147 CONFIG_CMD_SCSI * SCSI Support
1148 CONFIG_CMD_SDRAM * print SDRAM configuration information
1149 (requires CONFIG_CMD_I2C)
1150 CONFIG_CMD_SETGETDCR Support for DCR Register access
1151 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001152 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001153 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001154 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001155 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001156 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001157 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001158 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001159 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001160 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1161 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001162 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001163 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001164 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001165 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001166 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001167
1168 EXAMPLE: If you want all functions except of network
1169 support you can write:
1170
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001171 #include "config_cmd_all.h"
1172 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001173
Gerald Van Barend6abef42007-03-31 12:23:51 -04001174 Other Commands:
1175 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001176
1177 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001178 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001179 what you (and your U-Boot users) are doing. Data
1180 cache cannot be enabled on systems like the 8xx or
1181 8260 (where accesses to the IMMR region must be
1182 uncached), and it cannot be disabled on all other
1183 systems where we (mis-) use the data cache to hold an
1184 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001185
1186
1187 XXX - this list needs to get updated!
1188
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001189- Regular expression support:
1190 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001191 If this variable is defined, U-Boot is linked against
1192 the SLRE (Super Light Regular Expression) library,
1193 which adds regex support to some commands, as for
1194 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001195
Simon Glass3d686442011-10-15 05:48:20 +00001196- Device tree:
1197 CONFIG_OF_CONTROL
1198 If this variable is defined, U-Boot will use a device tree
1199 to configure its devices, instead of relying on statically
1200 compiled #defines in the board file. This option is
1201 experimental and only available on a few boards. The device
1202 tree is available in the global data as gd->fdt_blob.
1203
Simon Glass5cb34db2011-10-24 19:15:31 +00001204 U-Boot needs to get its device tree from somewhere. This can
1205 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001206
1207 CONFIG_OF_EMBED
1208 If this variable is defined, U-Boot will embed a device tree
1209 binary in its image. This device tree file should be in the
1210 board directory and called <soc>-<board>.dts. The binary file
1211 is then picked up in board_init_f() and made available through
1212 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001213
Simon Glass5cb34db2011-10-24 19:15:31 +00001214 CONFIG_OF_SEPARATE
1215 If this variable is defined, U-Boot will build a device tree
1216 binary. It will be called u-boot.dtb. Architecture-specific
1217 code will locate it at run-time. Generally this works by:
1218
1219 cat u-boot.bin u-boot.dtb >image.bin
1220
1221 and in fact, U-Boot does this for you, creating a file called
1222 u-boot-dtb.bin which is useful in the common case. You can
1223 still use the individual files if you need something more
1224 exotic.
1225
wdenkc6097192002-11-03 00:24:07 +00001226- Watchdog:
1227 CONFIG_WATCHDOG
1228 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001229 support for the SoC. There must be support in the SoC
1230 specific code for a watchdog. For the 8xx and 8260
1231 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1232 register. When supported for a specific SoC is
1233 available, then no further board specific code should
1234 be needed to use it.
1235
1236 CONFIG_HW_WATCHDOG
1237 When using a watchdog circuitry external to the used
1238 SoC, then define this variable and provide board
1239 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001240
Heiko Schocher735326c2015-01-21 08:38:22 +01001241 CONFIG_AT91_HW_WDT_TIMEOUT
1242 specify the timeout in seconds. default 2 seconds.
1243
stroeseb9c17c52003-04-04 15:53:41 +00001244- U-Boot Version:
1245 CONFIG_VERSION_VARIABLE
1246 If this variable is defined, an environment variable
1247 named "ver" is created by U-Boot showing the U-Boot
1248 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001249 Any change to this variable will be reverted at the
1250 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001251
wdenkc6097192002-11-03 00:24:07 +00001252- Real-Time Clock:
1253
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001254 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001255 has to be selected, too. Define exactly one of the
1256 following options:
1257
1258 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1259 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001260 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001261 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001262 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001263 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001264 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001265 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001266 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001267 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001268 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001269 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001270 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1271 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001272
wdenkb9bbd242003-06-30 16:24:52 +00001273 Note that if the RTC uses I2C, then the I2C interface
1274 must also be configured. See I2C Support, below.
1275
Peter Tyser9902e422008-12-17 16:36:21 -06001276- GPIO Support:
1277 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001278
Chris Packham9b383202010-12-19 10:12:13 +00001279 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1280 chip-ngpio pairs that tell the PCA953X driver the number of
1281 pins supported by a particular chip.
1282
Peter Tyser9902e422008-12-17 16:36:21 -06001283 Note that if the GPIO device uses I2C, then the I2C interface
1284 must also be configured. See I2C Support, below.
1285
Simon Glass4dc47ca2014-06-11 23:29:41 -06001286- I/O tracing:
1287 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1288 accesses and can checksum them or write a list of them out
1289 to memory. See the 'iotrace' command for details. This is
1290 useful for testing device drivers since it can confirm that
1291 the driver behaves the same way before and after a code
1292 change. Currently this is supported on sandbox and arm. To
1293 add support for your architecture, add '#include <iotrace.h>'
1294 to the bottom of arch/<arch>/include/asm/io.h and test.
1295
1296 Example output from the 'iotrace stats' command is below.
1297 Note that if the trace buffer is exhausted, the checksum will
1298 still continue to operate.
1299
1300 iotrace is enabled
1301 Start: 10000000 (buffer start address)
1302 Size: 00010000 (buffer size)
1303 Offset: 00000120 (current buffer offset)
1304 Output: 10000120 (start + offset)
1305 Count: 00000018 (number of trace records)
1306 CRC32: 9526fb66 (CRC32 of all trace records)
1307
wdenkc6097192002-11-03 00:24:07 +00001308- Timestamp Support:
1309
wdenk4a5c8a72003-03-06 00:02:04 +00001310 When CONFIG_TIMESTAMP is selected, the timestamp
1311 (date and time) of an image is printed by image
1312 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001313 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001314
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001315- Partition Labels (disklabels) Supported:
1316 Zero or more of the following:
1317 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1318 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1319 Intel architecture, USB sticks, etc.
1320 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1321 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1322 bootloader. Note 2TB partition limit; see
1323 disk/part_efi.c
1324 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001325
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001326 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1327 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001328 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001329
1330- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001331 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1332 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001333
wdenk369d43d2004-03-14 14:09:05 +00001334 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1335 be performed by calling the function
1336 ide_set_reset(int reset)
1337 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001338
1339- ATAPI Support:
1340 CONFIG_ATAPI
1341
1342 Set this to enable ATAPI support.
1343
wdenkf602aa02004-03-13 23:29:43 +00001344- LBA48 Support
1345 CONFIG_LBA48
1346
1347 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001348 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001349 Whithout these , LBA48 support uses 32bit variables and will 'only'
1350 support disks up to 2.1TB.
1351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001352 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001353 When enabled, makes the IDE subsystem use 64bit sector addresses.
1354 Default is 32bit.
1355
wdenkc6097192002-11-03 00:24:07 +00001356- SCSI Support:
1357 At the moment only there is only support for the
1358 SYM53C8XX SCSI controller; define
1359 CONFIG_SCSI_SYM53C8XX to enable it.
1360
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001361 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1362 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1363 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001364 maximum numbers of LUNs, SCSI ID's and target
1365 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001366 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001367
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001368 The environment variable 'scsidevs' is set to the number of
1369 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001370
wdenkc6097192002-11-03 00:24:07 +00001371- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001372 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001373 Support for Intel 8254x/8257x gigabit chips.
1374
1375 CONFIG_E1000_SPI
1376 Utility code for direct access to the SPI bus on Intel 8257x.
1377 This does not do anything useful unless you set at least one
1378 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1379
1380 CONFIG_E1000_SPI_GENERIC
1381 Allow generic access to the SPI bus on the Intel 8257x, for
1382 example with the "sspi" command.
1383
1384 CONFIG_CMD_E1000
1385 Management command for E1000 devices. When used on devices
1386 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001387
Andre Schwarz68c2a302008-03-06 16:45:44 +01001388 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001389 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001390
wdenkc6097192002-11-03 00:24:07 +00001391 CONFIG_EEPRO100
1392 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001393 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001394 write routine for first time initialisation.
1395
1396 CONFIG_TULIP
1397 Support for Digital 2114x chips.
1398 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1399 modem chip initialisation (KS8761/QS6611).
1400
1401 CONFIG_NATSEMI
1402 Support for National dp83815 chips.
1403
1404 CONFIG_NS8382X
1405 Support for National dp8382[01] gigabit chips.
1406
wdenkaa603362003-05-12 21:50:16 +00001407- NETWORK Support (other):
1408
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001409 CONFIG_DRIVER_AT91EMAC
1410 Support for AT91RM9200 EMAC.
1411
1412 CONFIG_RMII
1413 Define this to use reduced MII inteface
1414
1415 CONFIG_DRIVER_AT91EMAC_QUIET
1416 If this defined, the driver is quiet.
1417 The driver doen't show link status messages.
1418
Rob Herringc9830dc2011-12-15 11:15:49 +00001419 CONFIG_CALXEDA_XGMAC
1420 Support for the Calxeda XGMAC device
1421
Ashok93fb8722012-10-15 06:20:47 +00001422 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001423 Support for SMSC's LAN91C96 chips.
1424
1425 CONFIG_LAN91C96_BASE
1426 Define this to hold the physical address
1427 of the LAN91C96's I/O space
1428
1429 CONFIG_LAN91C96_USE_32_BIT
1430 Define this to enable 32 bit addressing
1431
Ashok93fb8722012-10-15 06:20:47 +00001432 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001433 Support for SMSC's LAN91C111 chip
1434
1435 CONFIG_SMC91111_BASE
1436 Define this to hold the physical address
1437 of the device (I/O space)
1438
1439 CONFIG_SMC_USE_32_BIT
1440 Define this if data bus is 32 bits
1441
1442 CONFIG_SMC_USE_IOFUNCS
1443 Define this to use i/o functions instead of macros
1444 (some hardware wont work with macros)
1445
Heiko Schocher7d037f72011-11-15 10:00:04 -05001446 CONFIG_DRIVER_TI_EMAC
1447 Support for davinci emac
1448
1449 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1450 Define this if you have more then 3 PHYs.
1451
Macpaul Lin199c6252010-12-21 16:59:46 +08001452 CONFIG_FTGMAC100
1453 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1454
1455 CONFIG_FTGMAC100_EGIGA
1456 Define this to use GE link update with gigabit PHY.
1457 Define this if FTGMAC100 is connected to gigabit PHY.
1458 If your system has 10/100 PHY only, it might not occur
1459 wrong behavior. Because PHY usually return timeout or
1460 useless data when polling gigabit status and gigabit
1461 control registers. This behavior won't affect the
1462 correctnessof 10/100 link speed update.
1463
Mike Rapoportf4761af2009-11-11 10:03:03 +02001464 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001465 Support for SMSC's LAN911x and LAN921x chips
1466
Mike Rapoportf4761af2009-11-11 10:03:03 +02001467 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001468 Define this to hold the physical address
1469 of the device (I/O space)
1470
Mike Rapoportf4761af2009-11-11 10:03:03 +02001471 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001472 Define this if data bus is 32 bits
1473
Mike Rapoportf4761af2009-11-11 10:03:03 +02001474 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001475 Define this if data bus is 16 bits. If your processor
1476 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001477 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001478
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001479 CONFIG_SH_ETHER
1480 Support for Renesas on-chip Ethernet controller
1481
1482 CONFIG_SH_ETHER_USE_PORT
1483 Define the number of ports to be used
1484
1485 CONFIG_SH_ETHER_PHY_ADDR
1486 Define the ETH PHY's address
1487
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001488 CONFIG_SH_ETHER_CACHE_WRITEBACK
1489 If this option is set, the driver enables cache flush.
1490
Heiko Schocher2b387762014-07-18 06:07:19 +02001491- PWM Support:
1492 CONFIG_PWM_IMX
1493 Support for PWM modul on the imx6.
1494
Vadim Bendeburydac69642011-10-17 08:36:14 +00001495- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001496 CONFIG_TPM
1497 Support TPM devices.
1498
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001499 CONFIG_TPM_TIS_I2C
1500 Support for i2c bus TPM devices. Only one device
1501 per system is supported at this time.
1502
1503 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1504 Define the the i2c bus number for the TPM device
1505
1506 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1507 Define the TPM's address on the i2c bus
1508
1509 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1510 Define the burst count bytes upper limit
1511
Dirk Eibach20489092013-06-26 15:55:15 +02001512 CONFIG_TPM_ATMEL_TWI
1513 Support for Atmel TWI TPM device. Requires I2C support.
1514
Che-liang Chiouacea5702013-04-12 11:04:34 +00001515 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001516 Support for generic parallel port TPM devices. Only one device
1517 per system is supported at this time.
1518
1519 CONFIG_TPM_TIS_BASE_ADDRESS
1520 Base address where the generic TPM device is mapped
1521 to. Contemporary x86 systems usually map it at
1522 0xfed40000.
1523
Reinhard Pfau4fece432013-06-26 15:55:13 +02001524 CONFIG_CMD_TPM
1525 Add tpm monitor functions.
1526 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1527 provides monitor access to authorized functions.
1528
1529 CONFIG_TPM
1530 Define this to enable the TPM support library which provides
1531 functional interfaces to some TPM commands.
1532 Requires support for a TPM device.
1533
1534 CONFIG_TPM_AUTH_SESSIONS
1535 Define this to enable authorized functions in the TPM library.
1536 Requires CONFIG_TPM and CONFIG_SHA1.
1537
wdenkc6097192002-11-03 00:24:07 +00001538- USB Support:
1539 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001540 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001541 CONFIG_USB_UHCI to enable it.
1542 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001543 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001544 storage devices.
1545 Note:
1546 Supported are USB Keyboards and USB Floppy drives
1547 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001548 MPC5200 USB requires additional defines:
1549 CONFIG_USB_CLOCK
1550 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001551 CONFIG_PSC3_USB
1552 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001553 CONFIG_USB_CONFIG
1554 for differential drivers: 0x00001000
1555 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001556 for differential drivers on PSC3: 0x00000100
1557 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001558 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001559 May be defined to allow interrupt polling
1560 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001561
Simon Glass5978cdb2012-02-27 10:52:47 +00001562 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1563 txfilltuning field in the EHCI controller on reset.
1564
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001565 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1566 HW module registers.
1567
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001568- USB Device:
1569 Define the below if you wish to use the USB console.
1570 Once firmware is rebuilt from a serial console issue the
1571 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001572 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001573 it has found a new device. The environment variable usbtty
1574 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001575 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001576 Common Device Class Abstract Control Model serial device.
1577 If you select usbtty = gserial you should be able to enumerate
1578 a Linux host by
1579 # modprobe usbserial vendor=0xVendorID product=0xProductID
1580 else if using cdc_acm, simply setting the environment
1581 variable usbtty to be cdc_acm should suffice. The following
1582 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001583
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001584 CONFIG_USB_DEVICE
1585 Define this to build a UDC device
1586
1587 CONFIG_USB_TTY
1588 Define this to have a tty type of device available to
1589 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001590
Vipin KUMARbdb17702012-03-26 15:38:06 +05301591 CONFIG_USBD_HS
1592 Define this to enable the high speed support for usb
1593 device and usbtty. If this feature is enabled, a routine
1594 int is_usbd_high_speed(void)
1595 also needs to be defined by the driver to dynamically poll
1596 whether the enumeration has succeded at high speed or full
1597 speed.
1598
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001599 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001600 Define this if you want stdin, stdout &/or stderr to
1601 be set to usbtty.
1602
1603 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001604 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001605 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001606 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001607
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001608 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001609 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001610 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001611
Wolfgang Denke2601822006-06-14 18:14:56 +02001612 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001613 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001614 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001615 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1616 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1617 should pretend to be a Linux device to it's target host.
1618
1619 CONFIG_USBD_MANUFACTURER
1620 Define this string as the name of your company for
1621 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001622
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001623 CONFIG_USBD_PRODUCT_NAME
1624 Define this string as the name of your product
1625 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001626
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001627 CONFIG_USBD_VENDORID
1628 Define this as your assigned Vendor ID from the USB
1629 Implementors Forum. This *must* be a genuine Vendor ID
1630 to avoid polluting the USB namespace.
1631 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001632
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001633 CONFIG_USBD_PRODUCTID
1634 Define this as the unique Product ID
1635 for your device
1636 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001637
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001638- ULPI Layer Support:
1639 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1640 the generic ULPI layer. The generic layer accesses the ULPI PHY
1641 via the platform viewport, so you need both the genric layer and
1642 the viewport enabled. Currently only Chipidea/ARC based
1643 viewport is supported.
1644 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1645 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001646 If your ULPI phy needs a different reference clock than the
1647 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1648 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001649
wdenk7a428cc2003-06-15 22:40:42 +00001650- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001651 The MMC controller on the Intel PXA is supported. To
1652 enable this define CONFIG_MMC. The MMC can be
1653 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001654 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001655 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1656 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001657
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001658 CONFIG_SH_MMCIF
1659 Support for Renesas on-chip MMCIF controller
1660
1661 CONFIG_SH_MMCIF_ADDR
1662 Define the base address of MMCIF registers
1663
1664 CONFIG_SH_MMCIF_CLK
1665 Define the clock frequency for MMCIF
1666
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001667 CONFIG_GENERIC_MMC
1668 Enable the generic MMC driver
1669
1670 CONFIG_SUPPORT_EMMC_BOOT
1671 Enable some additional features of the eMMC boot partitions.
1672
1673 CONFIG_SUPPORT_EMMC_RPMB
1674 Enable the commands for reading, writing and programming the
1675 key for the Replay Protection Memory Block partition in eMMC.
1676
Tom Rini58a8d322013-03-14 05:32:47 +00001677- USB Device Firmware Update (DFU) class support:
1678 CONFIG_DFU_FUNCTION
1679 This enables the USB portion of the DFU USB class
1680
1681 CONFIG_CMD_DFU
1682 This enables the command "dfu" which is used to have
1683 U-Boot create a DFU class device via USB. This command
1684 requires that the "dfu_alt_info" environment variable be
1685 set and define the alt settings to expose to the host.
1686
1687 CONFIG_DFU_MMC
1688 This enables support for exposing (e)MMC devices via DFU.
1689
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001690 CONFIG_DFU_NAND
1691 This enables support for exposing NAND devices via DFU.
1692
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301693 CONFIG_DFU_RAM
1694 This enables support for exposing RAM via DFU.
1695 Note: DFU spec refer to non-volatile memory usage, but
1696 allow usages beyond the scope of spec - here RAM usage,
1697 one that would help mostly the developer.
1698
Heiko Schochera2f831e2013-06-12 06:05:51 +02001699 CONFIG_SYS_DFU_DATA_BUF_SIZE
1700 Dfu transfer uses a buffer before writing data to the
1701 raw storage device. Make the size (in bytes) of this buffer
1702 configurable. The size of this buffer is also configurable
1703 through the "dfu_bufsiz" environment variable.
1704
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001705 CONFIG_SYS_DFU_MAX_FILE_SIZE
1706 When updating files rather than the raw storage device,
1707 we use a static buffer to copy the file into and then write
1708 the buffer once we've been given the whole file. Define
1709 this to the maximum filesize (in bytes) for the buffer.
1710 Default is 4 MiB if undefined.
1711
Heiko Schochere1ba1512014-03-18 08:09:56 +01001712 DFU_DEFAULT_POLL_TIMEOUT
1713 Poll timeout [ms], is the timeout a device can send to the
1714 host. The host must wait for this timeout before sending
1715 a subsequent DFU_GET_STATUS request to the device.
1716
1717 DFU_MANIFEST_POLL_TIMEOUT
1718 Poll timeout [ms], which the device sends to the host when
1719 entering dfuMANIFEST state. Host waits this timeout, before
1720 sending again an USB request to the device.
1721
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001722- USB Device Android Fastboot support:
1723 CONFIG_CMD_FASTBOOT
1724 This enables the command "fastboot" which enables the Android
1725 fastboot mode for the platform's USB device. Fastboot is a USB
1726 protocol for downloading images, flashing and device control
1727 used on Android devices.
1728 See doc/README.android-fastboot for more information.
1729
1730 CONFIG_ANDROID_BOOT_IMAGE
1731 This enables support for booting images which use the Android
1732 image format header.
1733
1734 CONFIG_USB_FASTBOOT_BUF_ADDR
1735 The fastboot protocol requires a large memory buffer for
1736 downloads. Define this to the starting RAM address to use for
1737 downloaded images.
1738
1739 CONFIG_USB_FASTBOOT_BUF_SIZE
1740 The fastboot protocol requires a large memory buffer for
1741 downloads. This buffer should be as large as possible for a
1742 platform. Define this to the size available RAM for fastboot.
1743
Steve Raebfb9ba42014-08-26 11:47:28 -07001744 CONFIG_FASTBOOT_FLASH
1745 The fastboot protocol includes a "flash" command for writing
1746 the downloaded image to a non-volatile storage device. Define
1747 this to enable the "fastboot flash" command.
1748
1749 CONFIG_FASTBOOT_FLASH_MMC_DEV
1750 The fastboot "flash" command requires additional information
1751 regarding the non-volatile storage device. Define this to
1752 the eMMC device that fastboot should use to store the image.
1753
Steve Rae7d059342014-12-12 15:51:54 -08001754 CONFIG_FASTBOOT_GPT_NAME
1755 The fastboot "flash" command supports writing the downloaded
1756 image to the Protective MBR and the Primary GUID Partition
1757 Table. (Additionally, this downloaded image is post-processed
1758 to generate and write the Backup GUID Partition Table.)
1759 This occurs when the specified "partition name" on the
1760 "fastboot flash" command line matches this value.
1761 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1762
wdenkda04a8b2004-08-02 23:22:59 +00001763- Journaling Flash filesystem support:
1764 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1765 CONFIG_JFFS2_NAND_DEV
1766 Define these for a default partition on a NAND device
1767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001768 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1769 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001770 Define these for a default partition on a NOR device
1771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001772 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001773 Define this to create an own partition. You have to provide a
1774 function struct part_info* jffs2_part_info(int part_num)
1775
1776 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001777 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001778 to disable the command chpart. This is the default when you
1779 have not defined a custom partition
1780
Donggeun Kim8f814002011-10-24 21:15:28 +00001781- FAT(File Allocation Table) filesystem write function support:
1782 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001783
1784 Define this to enable support for saving memory data as a
1785 file in FAT formatted partition.
1786
1787 This will also enable the command "fatwrite" enabling the
1788 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001789
Gabe Black7f8574c2012-10-12 14:26:11 +00001790CBFS (Coreboot Filesystem) support
1791 CONFIG_CMD_CBFS
1792
1793 Define this to enable support for reading from a Coreboot
1794 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1795 and cbfsload.
1796
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301797- FAT(File Allocation Table) filesystem cluster size:
1798 CONFIG_FS_FAT_MAX_CLUSTSIZE
1799
1800 Define the max cluster size for fat operations else
1801 a default value of 65536 will be defined.
1802
wdenkc6097192002-11-03 00:24:07 +00001803- Keyboard Support:
1804 CONFIG_ISA_KEYBOARD
1805
1806 Define this to enable standard (PC-Style) keyboard
1807 support
1808
1809 CONFIG_I8042_KBD
1810 Standard PC keyboard driver with US (is default) and
1811 GERMAN key layout (switch via environment 'keymap=de') support.
1812 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1813 for cfb_console. Supports cursor blinking.
1814
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001815 CONFIG_CROS_EC_KEYB
1816 Enables a Chrome OS keyboard using the CROS_EC interface.
1817 This uses CROS_EC to communicate with a second microcontroller
1818 which provides key scans on request.
1819
wdenkc6097192002-11-03 00:24:07 +00001820- Video support:
1821 CONFIG_VIDEO
1822
1823 Define this to enable video support (for output to
1824 video).
1825
1826 CONFIG_VIDEO_CT69000
1827
1828 Enable Chips & Technologies 69000 Video chip
1829
1830 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001831 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001832 video output is selected via environment 'videoout'
1833 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1834 assumed.
wdenkc6097192002-11-03 00:24:07 +00001835
wdenkd3602132004-03-25 15:14:43 +00001836 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001837 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001838 are possible:
1839 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001840 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001841
1842 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1843 -------------+---------------------------------------------
1844 8 bits | 0x301* 0x303 0x305 0x161 0x307
1845 15 bits | 0x310 0x313 0x316 0x162 0x319
1846 16 bits | 0x311 0x314 0x317 0x163 0x31A
1847 24 bits | 0x312 0x315 0x318 ? 0x31B
1848 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001849 (i.e. setenv videomode 317; saveenv; reset;)
1850
wdenkd3602132004-03-25 15:14:43 +00001851 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001852 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001853
1854
stroeseb9c17c52003-04-04 15:53:41 +00001855 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001856 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001857 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1858 or CONFIG_VIDEO_SED13806_16BPP
1859
Timur Tabi020edd22011-02-15 17:09:19 -06001860 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001861 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001862 SOCs that have a DIU should define this macro to enable DIU
1863 support, and should also define these other macros:
1864
1865 CONFIG_SYS_DIU_ADDR
1866 CONFIG_VIDEO
1867 CONFIG_CMD_BMP
1868 CONFIG_CFB_CONSOLE
1869 CONFIG_VIDEO_SW_CURSOR
1870 CONFIG_VGA_AS_SINGLE_DEVICE
1871 CONFIG_VIDEO_LOGO
1872 CONFIG_VIDEO_BMP_LOGO
1873
Timur Tabi32f709e2011-04-11 14:18:22 -05001874 The DIU driver will look for the 'video-mode' environment
1875 variable, and if defined, enable the DIU as a console during
1876 boot. See the documentation file README.video for a
1877 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001878
Simon Glass54df8ce2012-12-03 13:59:47 +00001879
wdenk4e112c12003-06-03 23:54:09 +00001880- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001881 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001882
wdenk57b2d802003-06-27 21:31:46 +00001883 Define this to enable a custom keyboard support.
1884 This simply calls drv_keyboard_init() which must be
1885 defined in your board-specific files.
1886 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001887
wdenkc6097192002-11-03 00:24:07 +00001888- LCD Support: CONFIG_LCD
1889
1890 Define this to enable LCD support (for output to LCD
1891 display); also select one of the supported displays
1892 by defining one of these:
1893
Stelian Popf6f86652008-05-09 21:57:18 +02001894 CONFIG_ATMEL_LCD:
1895
1896 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1897
wdenkc0d54ae2003-11-25 16:55:19 +00001898 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001899
wdenkc0d54ae2003-11-25 16:55:19 +00001900 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001901
wdenkc0d54ae2003-11-25 16:55:19 +00001902 CONFIG_NEC_NL6448BC20
1903
1904 NEC NL6448BC20-08. 6.5", 640x480.
1905 Active, color, single scan.
1906
1907 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001908
wdenkc0d54ae2003-11-25 16:55:19 +00001909 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001910 Active, color, single scan.
1911
1912 CONFIG_SHARP_16x9
1913
1914 Sharp 320x240. Active, color, single scan.
1915 It isn't 16x9, and I am not sure what it is.
1916
1917 CONFIG_SHARP_LQ64D341
1918
1919 Sharp LQ64D341 display, 640x480.
1920 Active, color, single scan.
1921
1922 CONFIG_HLD1045
1923
1924 HLD1045 display, 640x480.
1925 Active, color, single scan.
1926
1927 CONFIG_OPTREX_BW
1928
1929 Optrex CBL50840-2 NF-FW 99 22 M5
1930 or
1931 Hitachi LMG6912RPFC-00T
1932 or
1933 Hitachi SP14Q002
1934
1935 320x240. Black & white.
1936
1937 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001938 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001939
Simon Glass599a4df2012-10-17 13:24:54 +00001940 CONFIG_LCD_ALIGNMENT
1941
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001942 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001943 defined then the LCD will be aligned to this value instead.
1944 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1945 here, since it is cheaper to change data cache settings on
1946 a per-section basis.
1947
Simon Glassaf3e2802012-10-17 13:24:59 +00001948 CONFIG_CONSOLE_SCROLL_LINES
1949
1950 When the console need to be scrolled, this is the number of
1951 lines to scroll by. It defaults to 1. Increasing this makes
1952 the console jump but can help speed up operation when scrolling
1953 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001954
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001955 CONFIG_LCD_ROTATION
1956
1957 Sometimes, for example if the display is mounted in portrait
1958 mode or even if it's mounted landscape but rotated by 180degree,
1959 we need to rotate our content of the display relative to the
1960 framebuffer, so that user can read the messages which are
1961 printed out.
1962 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1963 initialized with a given rotation from "vl_rot" out of
1964 "vidinfo_t" which is provided by the board specific code.
1965 The value for vl_rot is coded as following (matching to
1966 fbcon=rotate:<n> linux-kernel commandline):
1967 0 = no rotation respectively 0 degree
1968 1 = 90 degree rotation
1969 2 = 180 degree rotation
1970 3 = 270 degree rotation
1971
1972 If CONFIG_LCD_ROTATION is not defined, the console will be
1973 initialized with 0degree rotation.
1974
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001975 CONFIG_LCD_BMP_RLE8
1976
1977 Support drawing of RLE8-compressed bitmaps on the LCD.
1978
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001979 CONFIG_I2C_EDID
1980
1981 Enables an 'i2c edid' command which can read EDID
1982 information over I2C from an attached LCD display.
1983
wdenkeb20ad32003-09-05 23:19:14 +00001984- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001985
wdenk57b2d802003-06-27 21:31:46 +00001986 If this option is set, the environment is checked for
1987 a variable "splashimage". If found, the usual display
1988 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001989 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001990 specified in "splashimage" is loaded instead. The
1991 console is redirected to the "nulldev", too. This
1992 allows for a "silent" boot where a splash screen is
1993 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001994
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001995 CONFIG_SPLASHIMAGE_GUARD
1996
1997 If this option is set, then U-Boot will prevent the environment
1998 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001999 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002000 This option is useful for targets where, due to alignment
2001 restrictions, an improperly aligned BMP image will cause a data
2002 abort. If you think you will not have problems with unaligned
2003 accesses (for example because your toolchain prevents them)
2004 there is no need to set this option.
2005
Matthias Weisser53884182009-07-09 16:07:30 +02002006 CONFIG_SPLASH_SCREEN_ALIGN
2007
2008 If this option is set the splash image can be freely positioned
2009 on the screen. Environment variable "splashpos" specifies the
2010 position as "x,y". If a positive number is given it is used as
2011 number of pixel from left/top. If a negative number is given it
2012 is used as number of pixel from right/bottom. You can also
2013 specify 'm' for centering the image.
2014
2015 Example:
2016 setenv splashpos m,m
2017 => image at center of screen
2018
2019 setenv splashpos 30,20
2020 => image at x = 30 and y = 20
2021
2022 setenv splashpos -10,m
2023 => vertically centered image
2024 at x = dspWidth - bmpWidth - 9
2025
Stefan Roesed9d97742005-09-22 09:04:17 +02002026- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2027
2028 If this option is set, additionally to standard BMP
2029 images, gzipped BMP images can be displayed via the
2030 splashscreen support or the bmp command.
2031
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002032- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2033
2034 If this option is set, 8-bit RLE compressed BMP images
2035 can be displayed via the splashscreen support or the
2036 bmp command.
2037
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002038- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002039 CONFIG_CMD_ZIP
2040
2041 If this option is set, it would use zlib deflate method
2042 to compress the specified memory at its best effort.
2043
wdenk710e3502003-08-29 20:57:53 +00002044- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002045 CONFIG_GZIP
2046
2047 Enabled by default to support gzip compressed images.
2048
wdenk710e3502003-08-29 20:57:53 +00002049 CONFIG_BZIP2
2050
2051 If this option is set, support for bzip2 compressed
2052 images is included. If not, only uncompressed and gzip
2053 compressed images are supported.
2054
wdenk9c53f402003-10-15 23:53:47 +00002055 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002056 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002057 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002058
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002059 CONFIG_LZMA
2060
2061 If this option is set, support for lzma compressed
2062 images is included.
2063
2064 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2065 requires an amount of dynamic memory that is given by the
2066 formula:
2067
2068 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2069
2070 Where lc and lp stand for, respectively, Literal context bits
2071 and Literal pos bits.
2072
2073 This value is upper-bounded by 14MB in the worst case. Anyway,
2074 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2075 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2076 a very small buffer.
2077
2078 Use the lzmainfo tool to determinate the lc and lp values and
2079 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002080 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002081
Kees Cook5b06e642013-08-16 07:59:12 -07002082 CONFIG_LZO
2083
2084 If this option is set, support for LZO compressed images
2085 is included.
2086
wdenk0e2bd9c2004-06-06 21:51:03 +00002087- MII/PHY support:
2088 CONFIG_PHY_ADDR
2089
2090 The address of PHY on MII bus.
2091
2092 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2093
2094 The clock frequency of the MII bus
2095
2096 CONFIG_PHY_GIGE
2097
2098 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002099 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002100
2101 CONFIG_PHY_RESET_DELAY
2102
2103 Some PHY like Intel LXT971A need extra delay after
2104 reset before any MII register access is possible.
2105 For such PHY, set this option to the usec delay
2106 required. (minimum 300usec for LXT971A)
2107
2108 CONFIG_PHY_CMD_DELAY (ppc4xx)
2109
2110 Some PHY like Intel LXT971A need extra delay after
2111 command issued before MII status register can be read
2112
wdenkc6097192002-11-03 00:24:07 +00002113- Ethernet address:
2114 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04002115 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002116 CONFIG_ETH2ADDR
2117 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04002118 CONFIG_ETH4ADDR
2119 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002120
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002121 Define a default value for Ethernet address to use
2122 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002123 is not determined automatically.
2124
2125- IP address:
2126 CONFIG_IPADDR
2127
2128 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002129 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002130 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002131 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002132
2133- Server IP address:
2134 CONFIG_SERVERIP
2135
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002136 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002137 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002138 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002139
Robin Getz470a6d42009-07-21 12:15:28 -04002140 CONFIG_KEEP_SERVERADDR
2141
2142 Keeps the server's MAC address, in the env 'serveraddr'
2143 for passing to bootargs (like Linux's netconsole option)
2144
Wolfgang Denk26da2992011-10-26 10:21:22 +00002145- Gateway IP address:
2146 CONFIG_GATEWAYIP
2147
2148 Defines a default value for the IP address of the
2149 default router where packets to other networks are
2150 sent to.
2151 (Environment variable "gatewayip")
2152
2153- Subnet mask:
2154 CONFIG_NETMASK
2155
2156 Defines a default value for the subnet mask (or
2157 routing prefix) which is used to determine if an IP
2158 address belongs to the local subnet or needs to be
2159 forwarded through a router.
2160 (Environment variable "netmask")
2161
David Updegraff7280da72007-06-11 10:41:07 -05002162- Multicast TFTP Mode:
2163 CONFIG_MCAST_TFTP
2164
2165 Defines whether you want to support multicast TFTP as per
2166 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002167 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002168 driver in use must provide a function: mcast() to join/leave a
2169 multicast group.
2170
wdenkc6097192002-11-03 00:24:07 +00002171- BOOTP Recovery Mode:
2172 CONFIG_BOOTP_RANDOM_DELAY
2173
2174 If you have many targets in a network that try to
2175 boot using BOOTP, you may want to avoid that all
2176 systems send out BOOTP requests at precisely the same
2177 moment (which would happen for instance at recovery
2178 from a power failure, when all systems will try to
2179 boot, thus flooding the BOOTP server. Defining
2180 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2181 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002182 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002183
2184 1st BOOTP request: delay 0 ... 1 sec
2185 2nd BOOTP request: delay 0 ... 2 sec
2186 3rd BOOTP request: delay 0 ... 4 sec
2187 4th and following
2188 BOOTP requests: delay 0 ... 8 sec
2189
Thierry Reding8977cda2014-08-19 10:21:24 +02002190 CONFIG_BOOTP_ID_CACHE_SIZE
2191
2192 BOOTP packets are uniquely identified using a 32-bit ID. The
2193 server will copy the ID from client requests to responses and
2194 U-Boot will use this to determine if it is the destination of
2195 an incoming response. Some servers will check that addresses
2196 aren't in use before handing them out (usually using an ARP
2197 ping) and therefore take up to a few hundred milliseconds to
2198 respond. Network congestion may also influence the time it
2199 takes for a response to make it back to the client. If that
2200 time is too long, U-Boot will retransmit requests. In order
2201 to allow earlier responses to still be accepted after these
2202 retransmissions, U-Boot's BOOTP client keeps a small cache of
2203 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2204 cache. The default is to keep IDs for up to four outstanding
2205 requests. Increasing this will allow U-Boot to accept offers
2206 from a BOOTP client in networks with unusually high latency.
2207
stroesee0aadfb2003-08-28 14:17:32 +00002208- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002209 You can fine tune the DHCP functionality by defining
2210 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002211
Jon Loeliger5336a762007-07-09 22:08:34 -05002212 CONFIG_BOOTP_SUBNETMASK
2213 CONFIG_BOOTP_GATEWAY
2214 CONFIG_BOOTP_HOSTNAME
2215 CONFIG_BOOTP_NISDOMAIN
2216 CONFIG_BOOTP_BOOTPATH
2217 CONFIG_BOOTP_BOOTFILESIZE
2218 CONFIG_BOOTP_DNS
2219 CONFIG_BOOTP_DNS2
2220 CONFIG_BOOTP_SEND_HOSTNAME
2221 CONFIG_BOOTP_NTPSERVER
2222 CONFIG_BOOTP_TIMEOFFSET
2223 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002224 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002225
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002226 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2227 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002228
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002229 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2230 after the configured retry count, the call will fail
2231 instead of starting over. This can be used to fail over
2232 to Link-local IP address configuration if the DHCP server
2233 is not available.
2234
stroesee0aadfb2003-08-28 14:17:32 +00002235 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2236 serverip from a DHCP server, it is possible that more
2237 than one DNS serverip is offered to the client.
2238 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2239 serverip will be stored in the additional environment
2240 variable "dnsip2". The first DNS serverip is always
2241 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002242 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002243
2244 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2245 to do a dynamic update of a DNS server. To do this, they
2246 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002247 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002248 of the "hostname" environment variable is passed as
2249 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002250
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002251 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2252
2253 A 32bit value in microseconds for a delay between
2254 receiving a "DHCP Offer" and sending the "DHCP Request".
2255 This fixes a problem with certain DHCP servers that don't
2256 respond 100% of the time to a "DHCP request". E.g. On an
2257 AT91RM9200 processor running at 180MHz, this delay needed
2258 to be *at least* 15,000 usec before a Windows Server 2003
2259 DHCP server would reply 100% of the time. I recommend at
2260 least 50,000 usec to be safe. The alternative is to hope
2261 that one of the retries will be successful but note that
2262 the DHCP timeout and retry process takes a longer than
2263 this delay.
2264
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002265 - Link-local IP address negotiation:
2266 Negotiate with other link-local clients on the local network
2267 for an address that doesn't require explicit configuration.
2268 This is especially useful if a DHCP server cannot be guaranteed
2269 to exist in all environments that the device must operate.
2270
2271 See doc/README.link-local for more information.
2272
wdenk145d2c12004-04-15 21:48:45 +00002273 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002274 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002275
2276 The device id used in CDP trigger frames.
2277
2278 CONFIG_CDP_DEVICE_ID_PREFIX
2279
2280 A two character string which is prefixed to the MAC address
2281 of the device.
2282
2283 CONFIG_CDP_PORT_ID
2284
2285 A printf format string which contains the ascii name of
2286 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002287 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002288
2289 CONFIG_CDP_CAPABILITIES
2290
2291 A 32bit integer which indicates the device capabilities;
2292 0x00000010 for a normal host which does not forwards.
2293
2294 CONFIG_CDP_VERSION
2295
2296 An ascii string containing the version of the software.
2297
2298 CONFIG_CDP_PLATFORM
2299
2300 An ascii string containing the name of the platform.
2301
2302 CONFIG_CDP_TRIGGER
2303
2304 A 32bit integer sent on the trigger.
2305
2306 CONFIG_CDP_POWER_CONSUMPTION
2307
2308 A 16bit integer containing the power consumption of the
2309 device in .1 of milliwatts.
2310
2311 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2312
2313 A byte containing the id of the VLAN.
2314
wdenkc6097192002-11-03 00:24:07 +00002315- Status LED: CONFIG_STATUS_LED
2316
2317 Several configurations allow to display the current
2318 status using a LED. For instance, the LED will blink
2319 fast while running U-Boot code, stop blinking as
2320 soon as a reply to a BOOTP request was received, and
2321 start blinking slow once the Linux kernel is running
2322 (supported by a status LED driver in the Linux
2323 kernel). Defining CONFIG_STATUS_LED enables this
2324 feature in U-Boot.
2325
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002326 Additional options:
2327
2328 CONFIG_GPIO_LED
2329 The status LED can be connected to a GPIO pin.
2330 In such cases, the gpio_led driver can be used as a
2331 status LED backend implementation. Define CONFIG_GPIO_LED
2332 to include the gpio_led driver in the U-Boot binary.
2333
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002334 CONFIG_GPIO_LED_INVERTED_TABLE
2335 Some GPIO connected LEDs may have inverted polarity in which
2336 case the GPIO high value corresponds to LED off state and
2337 GPIO low value corresponds to LED on state.
2338 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2339 with a list of GPIO LEDs that have inverted polarity.
2340
wdenkc6097192002-11-03 00:24:07 +00002341- CAN Support: CONFIG_CAN_DRIVER
2342
2343 Defining CONFIG_CAN_DRIVER enables CAN driver support
2344 on those systems that support this (optional)
2345 feature, like the TQM8xxL modules.
2346
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002347- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002348
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002349 This enable the NEW i2c subsystem, and will allow you to use
2350 i2c commands at the u-boot command line (as long as you set
2351 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2352 based realtime clock chips or other i2c devices. See
2353 common/cmd_i2c.c for a description of the command line
2354 interface.
2355
2356 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002357 - drivers/i2c/soft_i2c.c:
2358 - activate first bus with CONFIG_SYS_I2C_SOFT define
2359 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2360 for defining speed and slave address
2361 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2362 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2363 for defining speed and slave address
2364 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2365 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2366 for defining speed and slave address
2367 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2368 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2369 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002370
Heiko Schocherf2850742012-10-24 13:48:22 +02002371 - drivers/i2c/fsl_i2c.c:
2372 - activate i2c driver with CONFIG_SYS_I2C_FSL
2373 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2374 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2375 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2376 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002377 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002378 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2379 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2380 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2381 second bus.
2382
Simon Glass026fefb2012-10-30 07:28:53 +00002383 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002384 - activate this driver with CONFIG_SYS_I2C_TEGRA
2385 - This driver adds 4 i2c buses with a fix speed from
2386 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002387
Dirk Eibach42b204f2013-04-25 02:40:01 +00002388 - drivers/i2c/ppc4xx_i2c.c
2389 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2390 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2391 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2392
trema49f40a2013-09-21 18:13:35 +02002393 - drivers/i2c/i2c_mxc.c
2394 - activate this driver with CONFIG_SYS_I2C_MXC
2395 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2396 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2397 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2398 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2399 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2400 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002401 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002402 for speed, and 0 for slave.
York Sunf1a52162015-03-20 10:20:40 -07002403 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2404 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002405
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002406 - drivers/i2c/rcar_i2c.c:
2407 - activate this driver with CONFIG_SYS_I2C_RCAR
2408 - This driver adds 4 i2c buses
2409
2410 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2411 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2412 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2413 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2414 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2415 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2416 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2417 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2418 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2419
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002420 - drivers/i2c/sh_i2c.c:
2421 - activate this driver with CONFIG_SYS_I2C_SH
2422 - This driver adds from 2 to 5 i2c buses
2423
2424 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2425 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2426 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2427 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2428 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2429 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2430 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2431 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2432 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2433 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2434 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2435 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002436 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002437
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002438 - drivers/i2c/omap24xx_i2c.c
2439 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2440 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2441 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2442 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2443 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2444 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2445 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2446 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2447 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2448 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2449 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2450
Heiko Schocher465819a2013-11-08 07:30:53 +01002451 - drivers/i2c/zynq_i2c.c
2452 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2453 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2454 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2455
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302456 - drivers/i2c/s3c24x0_i2c.c:
2457 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2458 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2459 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2460 with a fix speed from 100000 and the slave addr 0!
2461
Dirk Eibachb9577432014-07-03 09:28:18 +02002462 - drivers/i2c/ihs_i2c.c
2463 - activate this driver with CONFIG_SYS_I2C_IHS
2464 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2465 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2466 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2467 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2468 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2469 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2470 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2471 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2472 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2473 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2474 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2475 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2476
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002477 additional defines:
2478
2479 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002480 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002481 don't use/have i2c muxes on your i2c bus, this
2482 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2483 omit this define.
2484
2485 CONFIG_SYS_I2C_DIRECT_BUS
2486 define this, if you don't use i2c muxes on your hardware.
2487 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2488 omit this define.
2489
2490 CONFIG_SYS_I2C_MAX_HOPS
2491 define how many muxes are maximal consecutively connected
2492 on one i2c bus. If you not use i2c muxes, omit this
2493 define.
2494
2495 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002496 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002497 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2498 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2499 CONFIG_SYS_NUM_I2C_BUSES = 9:
2500
2501 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2502 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2503 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2504 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2505 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2506 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2507 {1, {I2C_NULL_HOP}}, \
2508 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2509 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2510 }
2511
2512 which defines
2513 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002514 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2515 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2516 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2517 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2518 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002519 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002520 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2521 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002522
2523 If you do not have i2c muxes on your board, omit this define.
2524
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002525- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002526
2527 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2528 provides the following compelling advantages:
2529
2530 - more than one i2c adapter is usable
2531 - approved multibus support
2532 - better i2c mux support
2533
2534 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002535
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002536 These enable legacy I2C serial bus commands. Defining
2537 CONFIG_HARD_I2C will include the appropriate I2C driver
2538 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002539
wdenk21136db2003-07-16 21:53:01 +00002540 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002541 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002542 CONFIG_COMMANDS) and communicate with i2c based realtime
2543 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002544 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002545
Ben Warren45657152006-09-07 16:50:54 -04002546 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002547
wdenk21136db2003-07-16 21:53:01 +00002548 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002549 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002550
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002551 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002552 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002553 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002554 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002555
Peter Tysere4d1abc2010-04-12 22:28:21 -05002556 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002557 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002558 and so its address should therefore be cleared to 0 (See,
2559 eg, MPC823e User's Manual p.16-473). So, set
2560 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002561
Eric Millbrandt12990a42009-09-03 08:09:44 -05002562 CONFIG_SYS_I2C_INIT_MPC5XXX
2563
2564 When a board is reset during an i2c bus transfer
2565 chips might think that the current transfer is still
2566 in progress. Reset the slave devices by sending start
2567 commands until the slave device responds.
2568
wdenk21136db2003-07-16 21:53:01 +00002569 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002570
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002571 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002572 then the following macros need to be defined (examples are
2573 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002574
2575 I2C_INIT
2576
wdenkb9bbd242003-06-30 16:24:52 +00002577 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002578 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002579
wdenk544e9732004-02-06 23:19:44 +00002580 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002581
wdenkc6097192002-11-03 00:24:07 +00002582 I2C_PORT
2583
wdenk4a5c8a72003-03-06 00:02:04 +00002584 (Only for MPC8260 CPU). The I/O port to use (the code
2585 assumes both bits are on the same port). Valid values
2586 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002587
2588 I2C_ACTIVE
2589
2590 The code necessary to make the I2C data line active
2591 (driven). If the data line is open collector, this
2592 define can be null.
2593
wdenkb9bbd242003-06-30 16:24:52 +00002594 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2595
wdenkc6097192002-11-03 00:24:07 +00002596 I2C_TRISTATE
2597
2598 The code necessary to make the I2C data line tri-stated
2599 (inactive). If the data line is open collector, this
2600 define can be null.
2601
wdenkb9bbd242003-06-30 16:24:52 +00002602 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2603
wdenkc6097192002-11-03 00:24:07 +00002604 I2C_READ
2605
York Sun4a598092013-04-01 11:29:11 -07002606 Code that returns true if the I2C data line is high,
2607 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002608
wdenkb9bbd242003-06-30 16:24:52 +00002609 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2610
wdenkc6097192002-11-03 00:24:07 +00002611 I2C_SDA(bit)
2612
York Sun4a598092013-04-01 11:29:11 -07002613 If <bit> is true, sets the I2C data line high. If it
2614 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002615
wdenkb9bbd242003-06-30 16:24:52 +00002616 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002617 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002618 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002619
wdenkc6097192002-11-03 00:24:07 +00002620 I2C_SCL(bit)
2621
York Sun4a598092013-04-01 11:29:11 -07002622 If <bit> is true, sets the I2C clock line high. If it
2623 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002624
wdenkb9bbd242003-06-30 16:24:52 +00002625 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002626 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002627 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002628
wdenkc6097192002-11-03 00:24:07 +00002629 I2C_DELAY
2630
2631 This delay is invoked four times per clock cycle so this
2632 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002633 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002634 like:
2635
wdenkb9bbd242003-06-30 16:24:52 +00002636 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002637
Mike Frysingeree12d542010-07-21 13:38:02 -04002638 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2639
2640 If your arch supports the generic GPIO framework (asm/gpio.h),
2641 then you may alternatively define the two GPIOs that are to be
2642 used as SCL / SDA. Any of the previous I2C_xxx macros will
2643 have GPIO-based defaults assigned to them as appropriate.
2644
2645 You should define these to the GPIO value as given directly to
2646 the generic GPIO functions.
2647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002648 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002649
wdenk57b2d802003-06-27 21:31:46 +00002650 When a board is reset during an i2c bus transfer
2651 chips might think that the current transfer is still
2652 in progress. On some boards it is possible to access
2653 the i2c SCLK line directly, either by using the
2654 processor pin as a GPIO or by having a second pin
2655 connected to the bus. If this option is defined a
2656 custom i2c_init_board() routine in boards/xxx/board.c
2657 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002658
Richard Retanubundf0149c2010-04-12 15:08:17 -04002659 CONFIG_SYS_I2C_BOARD_LATE_INIT
2660
2661 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2662 defined a custom i2c_board_late_init() routine in
2663 boards/xxx/board.c is run AFTER the operations in i2c_init()
2664 is completed. This callpoint can be used to unreset i2c bus
2665 using CPU i2c controller register accesses for CPUs whose i2c
2666 controller provide such a method. It is called at the end of
2667 i2c_init() to allow i2c_init operations to setup the i2c bus
2668 controller on the CPU (e.g. setting bus speed & slave address).
2669
wdenk0e2bd9c2004-06-06 21:51:03 +00002670 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2671
2672 This option enables configuration of bi_iic_fast[] flags
2673 in u-boot bd_info structure based on u-boot environment
2674 variable "i2cfast". (see also i2cfast)
2675
Ben Warren45657152006-09-07 16:50:54 -04002676 CONFIG_I2C_MULTI_BUS
2677
2678 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002679 must have a controller. At any point in time, only one bus is
2680 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002681 Note that bus numbering is zero-based.
2682
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002683 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002684
2685 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002686 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002687 is set, specify a list of bus-device pairs. Otherwise, specify
2688 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002689
2690 e.g.
2691 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002692 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002693
2694 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2695
Wolfgang Denk092ae952011-10-26 10:21:21 +00002696 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002697 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002698
2699 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002701 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002702
2703 If defined, then this indicates the I2C bus number for DDR SPD.
2704 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2705
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002706 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002707
2708 If defined, then this indicates the I2C bus number for the RTC.
2709 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2710
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002711 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002712
2713 If defined, then this indicates the I2C bus number for the DTT.
2714 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2715
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002716 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002717
2718 If defined, specifies the I2C address of the DTT device.
2719 If not defined, then U-Boot uses predefined value for
2720 specified DTT device.
2721
Andrew Dyer58c41f92008-12-29 17:36:01 -06002722 CONFIG_SOFT_I2C_READ_REPEATED_START
2723
2724 defining this will force the i2c_read() function in
2725 the soft_i2c driver to perform an I2C repeated start
2726 between writing the address pointer and reading the
2727 data. If this define is omitted the default behaviour
2728 of doing a stop-start sequence will be used. Most I2C
2729 devices can use either method, but some require one or
2730 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002731
wdenkc6097192002-11-03 00:24:07 +00002732- SPI Support: CONFIG_SPI
2733
2734 Enables SPI driver (so far only tested with
2735 SPI EEPROM, also an instance works with Crystal A/D and
2736 D/As on the SACSng board)
2737
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002738 CONFIG_SH_SPI
2739
2740 Enables the driver for SPI controller on SuperH. Currently
2741 only SH7757 is supported.
2742
wdenkc6097192002-11-03 00:24:07 +00002743 CONFIG_SPI_X
2744
2745 Enables extended (16-bit) SPI EEPROM addressing.
2746 (symmetrical to CONFIG_I2C_X)
2747
2748 CONFIG_SOFT_SPI
2749
wdenk4a5c8a72003-03-06 00:02:04 +00002750 Enables a software (bit-bang) SPI driver rather than
2751 using hardware support. This is a general purpose
2752 driver that only requires three general I/O port pins
2753 (two outputs, one input) to function. If this is
2754 defined, the board configuration must define several
2755 SPI configuration items (port pins to use, etc). For
2756 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002757
Ben Warren7efe9272008-01-16 22:37:35 -05002758 CONFIG_HARD_SPI
2759
2760 Enables a hardware SPI driver for general-purpose reads
2761 and writes. As with CONFIG_SOFT_SPI, the board configuration
2762 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002763 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002764 example, see include/configs/mpc8349emds.h.
2765
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002766 CONFIG_MXC_SPI
2767
2768 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002769 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002770
Heiko Schocherb77c8882014-07-14 10:22:11 +02002771 CONFIG_SYS_SPI_MXC_WAIT
2772 Timeout for waiting until spi transfer completed.
2773 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2774
Matthias Fuchsa4400872007-12-27 17:12:34 +01002775- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002776
Matthias Fuchsa4400872007-12-27 17:12:34 +01002777 Enables FPGA subsystem.
2778
2779 CONFIG_FPGA_<vendor>
2780
2781 Enables support for specific chip vendors.
2782 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002783
Matthias Fuchsa4400872007-12-27 17:12:34 +01002784 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002785
Matthias Fuchsa4400872007-12-27 17:12:34 +01002786 Enables support for FPGA family.
2787 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2788
2789 CONFIG_FPGA_COUNT
2790
2791 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002792
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302793 CONFIG_CMD_FPGA_LOADMK
2794
2795 Enable support for fpga loadmk command
2796
Michal Simek64c70982014-05-02 13:43:39 +02002797 CONFIG_CMD_FPGA_LOADP
2798
2799 Enable support for fpga loadp command - load partial bitstream
2800
2801 CONFIG_CMD_FPGA_LOADBP
2802
2803 Enable support for fpga loadbp command - load partial bitstream
2804 (Xilinx only)
2805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002806 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002807
wdenk57b2d802003-06-27 21:31:46 +00002808 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002809
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002810 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002811
wdenk4a5c8a72003-03-06 00:02:04 +00002812 Enable checks on FPGA configuration interface busy
2813 status by the configuration function. This option
2814 will require a board or device specific function to
2815 be written.
wdenkc6097192002-11-03 00:24:07 +00002816
2817 CONFIG_FPGA_DELAY
2818
2819 If defined, a function that provides delays in the FPGA
2820 configuration driver.
2821
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002822 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002823 Allow Control-C to interrupt FPGA configuration
2824
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002825 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk4a5c8a72003-03-06 00:02:04 +00002827 Check for configuration errors during FPGA bitfile
2828 loading. For example, abort during Virtex II
2829 configuration if the INIT_B line goes low (which
2830 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002831
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002832 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002833
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002834 Maximum time to wait for the INIT_B line to de-assert
2835 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002836 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002837 ms.
wdenkc6097192002-11-03 00:24:07 +00002838
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002839 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002840
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002841 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002842 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002843
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002844 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002845
wdenk4a5c8a72003-03-06 00:02:04 +00002846 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002847 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002848
2849- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002850 CONFIG_BUILD_TARGET
2851
2852 Some SoCs need special image types (e.g. U-Boot binary
2853 with a special header) as build targets. By defining
2854 CONFIG_BUILD_TARGET in the SoC / board header, this
2855 special image will be automatically built upon calling
2856 make / MAKEALL.
2857
wdenkc6097192002-11-03 00:24:07 +00002858 CONFIG_IDENT_STRING
2859
wdenk4a5c8a72003-03-06 00:02:04 +00002860 If defined, this string will be added to the U-Boot
2861 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002862
2863- Vendor Parameter Protection:
2864
wdenk4a5c8a72003-03-06 00:02:04 +00002865 U-Boot considers the values of the environment
2866 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002867 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002868 are set once by the board vendor / manufacturer, and
2869 protects these variables from casual modification by
2870 the user. Once set, these variables are read-only,
2871 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002872 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002873
2874 If CONFIG_ENV_OVERWRITE is #defined in your config
2875 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002876 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002877 these parameters.
2878
2879 Alternatively, if you #define _both_ CONFIG_ETHADDR
2880 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002881 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002882 which can be changed exactly ONCE by the user. [The
2883 serial# is unaffected by this, i. e. it remains
2884 read-only.]
2885
Joe Hershberger71497d02012-12-11 22:16:31 -06002886 The same can be accomplished in a more flexible way
2887 for any variable by configuring the type of access
2888 to allow for those variables in the ".flags" variable
2889 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2890
wdenkc6097192002-11-03 00:24:07 +00002891- Protected RAM:
2892 CONFIG_PRAM
2893
2894 Define this variable to enable the reservation of
2895 "protected RAM", i. e. RAM which is not overwritten
2896 by U-Boot. Define CONFIG_PRAM to hold the number of
2897 kB you want to reserve for pRAM. You can overwrite
2898 this default value by defining an environment
2899 variable "pram" to the number of kB you want to
2900 reserve. Note that the board info structure will
2901 still show the full amount of RAM. If pRAM is
2902 reserved, a new environment variable "mem" will
2903 automatically be defined to hold the amount of
2904 remaining RAM in a form that can be passed as boot
2905 argument to Linux, for instance like that:
2906
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002907 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002908 saveenv
2909
2910 This way you can tell Linux not to use this memory,
2911 either, which results in a memory region that will
2912 not be affected by reboots.
2913
2914 *WARNING* If your board configuration uses automatic
2915 detection of the RAM size, you must make sure that
2916 this memory test is non-destructive. So far, the
2917 following board configurations are known to be
2918 "pRAM-clean":
2919
Wolfgang Denk90326762012-10-24 02:36:15 +00002920 IVMS8, IVML24, SPD8xx, TQM8xxL,
2921 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002922 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002923
Gabe Blacka2f3a932012-12-02 04:55:18 +00002924- Access to physical memory region (> 4GB)
2925 Some basic support is provided for operations on memory not
2926 normally accessible to U-Boot - e.g. some architectures
2927 support access to more than 4GB of memory on 32-bit
2928 machines using physical address extension or similar.
2929 Define CONFIG_PHYSMEM to access this basic support, which
2930 currently only supports clearing the memory.
2931
wdenkc6097192002-11-03 00:24:07 +00002932- Error Recovery:
2933 CONFIG_PANIC_HANG
2934
2935 Define this variable to stop the system in case of a
2936 fatal error, so that you have to reset it manually.
2937 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002938 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002939 automatically as fast as possible, but it may be
2940 useful during development since you can try to debug
2941 the conditions that lead to the situation.
2942
2943 CONFIG_NET_RETRY_COUNT
2944
wdenk4a5c8a72003-03-06 00:02:04 +00002945 This variable defines the number of retries for
2946 network operations like ARP, RARP, TFTP, or BOOTP
2947 before giving up the operation. If not defined, a
2948 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002949
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002950 CONFIG_ARP_TIMEOUT
2951
2952 Timeout waiting for an ARP reply in milliseconds.
2953
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002954 CONFIG_NFS_TIMEOUT
2955
2956 Timeout in milliseconds used in NFS protocol.
2957 If you encounter "ERROR: Cannot umount" in nfs command,
2958 try longer timeout such as
2959 #define CONFIG_NFS_TIMEOUT 10000UL
2960
wdenkc6097192002-11-03 00:24:07 +00002961- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002962 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002963
2964 Enable auto completion of commands using TAB.
2965
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002966 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002967
2968 This defines the secondary prompt string, which is
2969 printed when the command interpreter needs more input
2970 to complete a command. Usually "> ".
2971
2972 Note:
2973
wdenk57b2d802003-06-27 21:31:46 +00002974 In the current implementation, the local variables
2975 space and global environment variables space are
2976 separated. Local variables are those you define by
2977 simply typing `name=value'. To access a local
2978 variable later on, you have write `$name' or
2979 `${name}'; to execute the contents of a variable
2980 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002981
wdenk4a5c8a72003-03-06 00:02:04 +00002982 Global environment variables are those you use
2983 setenv/printenv to work with. To run a command stored
2984 in such a variable, you need to use the run command,
2985 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002986
2987 To store commands and special characters in a
2988 variable, please use double quotation marks
2989 surrounding the whole text of the variable, instead
2990 of the backslashes before semicolons and special
2991 symbols.
2992
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002993- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002994 CONFIG_CMDLINE_EDITING
2995
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002996 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002997 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002998
wdenkc0aa5c52003-12-06 19:49:23 +00002999- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003000 CONFIG_EXTRA_ENV_SETTINGS
3001
wdenk4a5c8a72003-03-06 00:02:04 +00003002 Define this to contain any number of null terminated
3003 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00003004 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00003005
wdenk4a5c8a72003-03-06 00:02:04 +00003006 For example, place something like this in your
3007 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003008
3009 #define CONFIG_EXTRA_ENV_SETTINGS \
3010 "myvar1=value1\0" \
3011 "myvar2=value2\0"
3012
wdenk4a5c8a72003-03-06 00:02:04 +00003013 Warning: This method is based on knowledge about the
3014 internal format how the environment is stored by the
3015 U-Boot code. This is NOT an official, exported
3016 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003017 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003018 You better know what you are doing here.
3019
wdenk4a5c8a72003-03-06 00:02:04 +00003020 Note: overly (ab)use of the default environment is
3021 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003022 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003023 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003024
Stephen Warren1465d5f2012-05-22 09:21:54 +00003025 CONFIG_ENV_VARS_UBOOT_CONFIG
3026
3027 Define this in order to add variables describing the
3028 U-Boot build configuration to the default environment.
3029 These will be named arch, cpu, board, vendor, and soc.
3030
3031 Enabling this option will cause the following to be defined:
3032
3033 - CONFIG_SYS_ARCH
3034 - CONFIG_SYS_CPU
3035 - CONFIG_SYS_BOARD
3036 - CONFIG_SYS_VENDOR
3037 - CONFIG_SYS_SOC
3038
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003039 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3040
3041 Define this in order to add variables describing certain
3042 run-time determined information about the hardware to the
3043 environment. These will be named board_name, board_rev.
3044
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003045 CONFIG_DELAY_ENVIRONMENT
3046
3047 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003048 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003049 that so that the environment is not available until
3050 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3051 this is instead controlled by the value of
3052 /config/load-environment.
3053
wdenkc0aa5c52003-12-06 19:49:23 +00003054- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003055 CONFIG_HAS_DATAFLASH
3056
wdenk57b2d802003-06-27 21:31:46 +00003057 Defining this option enables DataFlash features and
3058 allows to read/write in Dataflash via the standard
3059 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003060
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003061- Serial Flash support
3062 CONFIG_CMD_SF
3063
3064 Defining this option enables SPI flash commands
3065 'sf probe/read/write/erase/update'.
3066
3067 Usage requires an initial 'probe' to define the serial
3068 flash parameters, followed by read/write/erase/update
3069 commands.
3070
3071 The following defaults may be provided by the platform
3072 to handle the common case when only a single serial
3073 flash is present on the system.
3074
3075 CONFIG_SF_DEFAULT_BUS Bus identifier
3076 CONFIG_SF_DEFAULT_CS Chip-select
3077 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3078 CONFIG_SF_DEFAULT_SPEED in Hz
3079
Simon Glass4b5545e2012-10-08 13:16:02 +00003080 CONFIG_CMD_SF_TEST
3081
3082 Define this option to include a destructive SPI flash
3083 test ('sf test').
3084
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05303085 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3086
3087 Define this option to use the Bank addr/Extended addr
3088 support on SPI flashes which has size > 16Mbytes.
3089
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303090 CONFIG_SF_DUAL_FLASH Dual flash memories
3091
3092 Define this option to use dual flash support where two flash
3093 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003094 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303095
wdenkef893942004-02-23 16:11:30 +00003096- SystemACE Support:
3097 CONFIG_SYSTEMACE
3098
3099 Adding this option adds support for Xilinx SystemACE
3100 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003101 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003102 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003103
3104 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003106
3107 When SystemACE support is added, the "ace" device type
3108 becomes available to the fat commands, i.e. fatls.
3109
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003110- TFTP Fixed UDP Port:
3111 CONFIG_TFTP_PORT
3112
Wolfgang Denk227b5192005-09-24 23:25:46 +02003113 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003114 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003115 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003116 number generator is used.
3117
Wolfgang Denk227b5192005-09-24 23:25:46 +02003118 Also, the environment variable tftpdstp is used to supply
3119 the TFTP UDP destination port value. If tftpdstp isn't
3120 defined, the normal port 69 is used.
3121
3122 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003123 blindly start the TFTP transfer using the pre-configured
3124 target IP address and UDP port. This has the effect of
3125 "punching through" the (Windows XP) firewall, allowing
3126 the remainder of the TFTP transfer to proceed normally.
3127 A better solution is to properly configure the firewall,
3128 but sometimes that is not allowed.
3129
Simon Glass058bb8d2012-12-05 14:46:38 +00003130- Hashing support:
3131 CONFIG_CMD_HASH
3132
3133 This enables a generic 'hash' command which can produce
3134 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3135
3136 CONFIG_HASH_VERIFY
3137
3138 Enable the hash verify command (hash -v). This adds to code
3139 size a little.
3140
gaurav ranaef201592015-02-20 12:51:46 +05303141 CONFIG_SHA1 - This option enables support of hashing using SHA1
3142 algorithm. The hash is calculated in software.
3143 CONFIG_SHA256 - This option enables support of hashing using
3144 SHA256 algorithm. The hash is calculated in software.
3145 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3146 for SHA1/SHA256 hashing.
3147 This affects the 'hash' command and also the
3148 hash_lookup_algo() function.
3149 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3150 hardware-acceleration for SHA1/SHA256 progressive hashing.
3151 Data can be streamed in a block at a time and the hashing
3152 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003153
3154 Note: There is also a sha1sum command, which should perhaps
3155 be deprecated in favour of 'hash sha1'.
3156
Robert Winkler765ccf42013-07-24 17:57:06 -07003157- Freescale i.MX specific commands:
3158 CONFIG_CMD_HDMIDETECT
3159 This enables 'hdmidet' command which returns true if an
3160 HDMI monitor is detected. This command is i.MX 6 specific.
3161
3162 CONFIG_CMD_BMODE
3163 This enables the 'bmode' (bootmode) command for forcing
3164 a boot from specific media.
3165
3166 This is useful for forcing the ROM's usb downloader to
3167 activate upon a watchdog reset which is nice when iterating
3168 on U-Boot. Using the reset button or running bmode normal
3169 will set it back to normal. This command currently
3170 supports i.MX53 and i.MX6.
3171
Simon Glass35191a32013-06-13 15:10:02 -07003172- Signing support:
3173 CONFIG_RSA
3174
3175 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003176 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003177
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303178 The Modular Exponentiation algorithm in RSA is implemented using
3179 driver model. So CONFIG_DM needs to be enabled by default for this
3180 library to function.
3181
Simon Glass35191a32013-06-13 15:10:02 -07003182 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303183 option. The software based modular exponentiation is built into
3184 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003185
Heiko Schocher443ca402014-01-25 07:27:13 +01003186- bootcount support:
3187 CONFIG_BOOTCOUNT_LIMIT
3188
3189 This enables the bootcounter support, see:
3190 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3191
3192 CONFIG_AT91SAM9XE
3193 enable special bootcounter support on at91sam9xe based boards.
3194 CONFIG_BLACKFIN
3195 enable special bootcounter support on blackfin based boards.
3196 CONFIG_SOC_DA8XX
3197 enable special bootcounter support on da850 based boards.
3198 CONFIG_BOOTCOUNT_RAM
3199 enable support for the bootcounter in RAM
3200 CONFIG_BOOTCOUNT_I2C
3201 enable support for the bootcounter on an i2c (like RTC) device.
3202 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3203 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3204 the bootcounter.
3205 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003206
wdenkc0aa5c52003-12-06 19:49:23 +00003207- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003208 CONFIG_SHOW_BOOT_PROGRESS
3209
wdenk4a5c8a72003-03-06 00:02:04 +00003210 Defining this option allows to add some board-
3211 specific code (calling a user-provided function
3212 "show_boot_progress(int)") that enables you to show
3213 the system's boot progress on some display (for
3214 example, some LED's) on your board. At the moment,
3215 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003216
Simon Glass0fa36a42012-09-28 08:56:37 +00003217
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003218Legacy uImage format:
3219
wdenkc6097192002-11-03 00:24:07 +00003220 Arg Where When
3221 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003222 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003223 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003224 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003225 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003226 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003227 4 common/cmd_bootm.c Image data has correct checksum
3228 -4 common/cmd_bootm.c Image is for unsupported architecture
3229 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003230 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003231 6 common/cmd_bootm.c Image Type check OK
3232 -6 common/cmd_bootm.c gunzip uncompression error
3233 -7 common/cmd_bootm.c Unimplemented compression type
3234 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003235 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003236 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003237
3238 9 common/image.c Start initial ramdisk verification
3239 -10 common/image.c Ramdisk header has bad magic number
3240 -11 common/image.c Ramdisk header has bad checksum
3241 10 common/image.c Ramdisk header is OK
3242 -12 common/image.c Ramdisk data has bad checksum
3243 11 common/image.c Ramdisk data has correct checksum
3244 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003245 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003246 13 common/image.c Start multifile image verification
3247 14 common/image.c No initial ramdisk, no multifile, continue.
3248
Wolfgang Denk092ae952011-10-26 10:21:21 +00003249 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003250
Stefan Roese88fbf932010-04-15 16:07:28 +02003251 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003252 -31 post/post.c POST test failed, detected by post_output_backlog()
3253 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003254
Heiko Schocher633e03a2007-06-22 19:11:54 +02003255 34 common/cmd_doc.c before loading a Image from a DOC device
3256 -35 common/cmd_doc.c Bad usage of "doc" command
3257 35 common/cmd_doc.c correct usage of "doc" command
3258 -36 common/cmd_doc.c No boot device
3259 36 common/cmd_doc.c correct boot device
3260 -37 common/cmd_doc.c Unknown Chip ID on boot device
3261 37 common/cmd_doc.c correct chip ID found, device available
3262 -38 common/cmd_doc.c Read Error on boot device
3263 38 common/cmd_doc.c reading Image header from DOC device OK
3264 -39 common/cmd_doc.c Image header has bad magic number
3265 39 common/cmd_doc.c Image header has correct magic number
3266 -40 common/cmd_doc.c Error reading Image from DOC device
3267 40 common/cmd_doc.c Image header has correct magic number
3268 41 common/cmd_ide.c before loading a Image from a IDE device
3269 -42 common/cmd_ide.c Bad usage of "ide" command
3270 42 common/cmd_ide.c correct usage of "ide" command
3271 -43 common/cmd_ide.c No boot device
3272 43 common/cmd_ide.c boot device found
3273 -44 common/cmd_ide.c Device not available
3274 44 common/cmd_ide.c Device available
3275 -45 common/cmd_ide.c wrong partition selected
3276 45 common/cmd_ide.c partition selected
3277 -46 common/cmd_ide.c Unknown partition table
3278 46 common/cmd_ide.c valid partition table found
3279 -47 common/cmd_ide.c Invalid partition type
3280 47 common/cmd_ide.c correct partition type
3281 -48 common/cmd_ide.c Error reading Image Header on boot device
3282 48 common/cmd_ide.c reading Image Header from IDE device OK
3283 -49 common/cmd_ide.c Image header has bad magic number
3284 49 common/cmd_ide.c Image header has correct magic number
3285 -50 common/cmd_ide.c Image header has bad checksum
3286 50 common/cmd_ide.c Image header has correct checksum
3287 -51 common/cmd_ide.c Error reading Image from IDE device
3288 51 common/cmd_ide.c reading Image from IDE device OK
3289 52 common/cmd_nand.c before loading a Image from a NAND device
3290 -53 common/cmd_nand.c Bad usage of "nand" command
3291 53 common/cmd_nand.c correct usage of "nand" command
3292 -54 common/cmd_nand.c No boot device
3293 54 common/cmd_nand.c boot device found
3294 -55 common/cmd_nand.c Unknown Chip ID on boot device
3295 55 common/cmd_nand.c correct chip ID found, device available
3296 -56 common/cmd_nand.c Error reading Image Header on boot device
3297 56 common/cmd_nand.c reading Image Header from NAND device OK
3298 -57 common/cmd_nand.c Image header has bad magic number
3299 57 common/cmd_nand.c Image header has correct magic number
3300 -58 common/cmd_nand.c Error reading Image from NAND device
3301 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003302
Heiko Schocher633e03a2007-06-22 19:11:54 +02003303 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003304
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003305 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003306 -64 net/eth.c no Ethernet found.
3307 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003308
Heiko Schocher633e03a2007-06-22 19:11:54 +02003309 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003310 80 common/cmd_net.c before calling net_loop()
3311 -81 common/cmd_net.c some error in net_loop() occurred
3312 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003313 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3314 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003315 83 common/cmd_net.c running "source" command
3316 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003317 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003318
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003319FIT uImage format:
3320
3321 Arg Where When
3322 100 common/cmd_bootm.c Kernel FIT Image has correct format
3323 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3324 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3325 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3326 102 common/cmd_bootm.c Kernel unit name specified
3327 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003328 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003329 104 common/cmd_bootm.c Got kernel subimage node offset
3330 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3331 105 common/cmd_bootm.c Kernel subimage hash verification OK
3332 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3333 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003334 -106 common/cmd_bootm.c Kernel subimage has wrong type
3335 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003336 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3337 108 common/cmd_bootm.c Got kernel subimage data/size
3338 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3339 -109 common/cmd_bootm.c Can't get kernel subimage type
3340 -110 common/cmd_bootm.c Can't get kernel subimage comp
3341 -111 common/cmd_bootm.c Can't get kernel subimage os
3342 -112 common/cmd_bootm.c Can't get kernel subimage load address
3343 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3344
3345 120 common/image.c Start initial ramdisk verification
3346 -120 common/image.c Ramdisk FIT image has incorrect format
3347 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003348 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003349 -122 common/image.c Can't get configuration for ramdisk subimage
3350 123 common/image.c Ramdisk unit name specified
3351 -124 common/image.c Can't get ramdisk subimage node offset
3352 125 common/image.c Got ramdisk subimage node offset
3353 -125 common/image.c Ramdisk subimage hash verification failed
3354 126 common/image.c Ramdisk subimage hash verification OK
3355 -126 common/image.c Ramdisk subimage for unsupported architecture
3356 127 common/image.c Architecture check OK
3357 -127 common/image.c Can't get ramdisk subimage data/size
3358 128 common/image.c Got ramdisk subimage data/size
3359 129 common/image.c Can't get ramdisk load address
3360 -129 common/image.c Got ramdisk load address
3361
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003362 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003363 131 common/cmd_doc.c FIT image format OK
3364
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003365 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003366 141 common/cmd_ide.c FIT image format OK
3367
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003368 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003369 151 common/cmd_nand.c FIT image format OK
3370
Heiko Schocher515eb122014-05-28 11:33:33 +02003371- legacy image format:
3372 CONFIG_IMAGE_FORMAT_LEGACY
3373 enables the legacy image format support in U-Boot.
3374
3375 Default:
3376 enabled if CONFIG_FIT_SIGNATURE is not defined.
3377
3378 CONFIG_DISABLE_IMAGE_LEGACY
3379 disable the legacy image format
3380
3381 This define is introduced, as the legacy image format is
3382 enabled per default for backward compatibility.
3383
Gabe Blackd572e162012-10-25 16:31:10 +00003384- FIT image support:
3385 CONFIG_FIT
3386 Enable support for the FIT uImage format.
3387
3388 CONFIG_FIT_BEST_MATCH
3389 When no configuration is explicitly selected, default to the
3390 one whose fdt's compatibility field best matches that of
3391 U-Boot itself. A match is considered "best" if it matches the
3392 most specific compatibility entry of U-Boot's fdt's root node.
3393 The order of entries in the configuration's fdt is ignored.
3394
Simon Glass58fe7e52013-06-13 15:10:00 -07003395 CONFIG_FIT_SIGNATURE
3396 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303397 using a hash signed and verified using RSA. If
3398 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3399 hashing is available using hardware, RSA library will use it.
3400 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003401
Heiko Schocher515eb122014-05-28 11:33:33 +02003402 WARNING: When relying on signed FIT images with required
3403 signature check the legacy image format is default
3404 disabled. If a board need legacy image format support
3405 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3406
Dirk Eibach88919ca2014-07-03 09:28:26 +02003407 CONFIG_FIT_DISABLE_SHA256
3408 Supporting SHA256 hashes has quite an impact on binary size.
3409 For constrained systems sha256 hash support can be disabled
3410 with this option.
3411
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003412- Standalone program support:
3413 CONFIG_STANDALONE_LOAD_ADDR
3414
Wolfgang Denk23f78482011-10-09 21:06:34 +02003415 This option defines a board specific value for the
3416 address where standalone program gets loaded, thus
3417 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003418 settings.
3419
3420- Frame Buffer Address:
3421 CONFIG_FB_ADDR
3422
3423 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003424 address for frame buffer. This is typically the case
3425 when using a graphics controller has separate video
3426 memory. U-Boot will then place the frame buffer at
3427 the given address instead of dynamically reserving it
3428 in system RAM by calling lcd_setmem(), which grabs
3429 the memory for the frame buffer depending on the
3430 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003431
3432 Please see board_init_f function.
3433
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003434- Automatic software updates via TFTP server
3435 CONFIG_UPDATE_TFTP
3436 CONFIG_UPDATE_TFTP_CNT_MAX
3437 CONFIG_UPDATE_TFTP_MSEC_MAX
3438
3439 These options enable and control the auto-update feature;
3440 for a more detailed description refer to doc/README.update.
3441
3442- MTD Support (mtdparts command, UBI support)
3443 CONFIG_MTD_DEVICE
3444
3445 Adds the MTD device infrastructure from the Linux kernel.
3446 Needed for mtdparts command support.
3447
3448 CONFIG_MTD_PARTITIONS
3449
3450 Adds the MTD partitioning infrastructure from the Linux
3451 kernel. Needed for UBI support.
3452
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003453- UBI support
3454 CONFIG_CMD_UBI
3455
3456 Adds commands for interacting with MTD partitions formatted
3457 with the UBI flash translation layer
3458
3459 Requires also defining CONFIG_RBTREE
3460
Joe Hershberger47550fc2013-04-08 10:32:49 +00003461 CONFIG_UBI_SILENCE_MSG
3462
3463 Make the verbose messages from UBI stop printing. This leaves
3464 warnings and errors enabled.
3465
Heiko Schocherf5895d12014-06-24 10:10:04 +02003466
3467 CONFIG_MTD_UBI_WL_THRESHOLD
3468 This parameter defines the maximum difference between the highest
3469 erase counter value and the lowest erase counter value of eraseblocks
3470 of UBI devices. When this threshold is exceeded, UBI starts performing
3471 wear leveling by means of moving data from eraseblock with low erase
3472 counter to eraseblocks with high erase counter.
3473
3474 The default value should be OK for SLC NAND flashes, NOR flashes and
3475 other flashes which have eraseblock life-cycle 100000 or more.
3476 However, in case of MLC NAND flashes which typically have eraseblock
3477 life-cycle less than 10000, the threshold should be lessened (e.g.,
3478 to 128 or 256, although it does not have to be power of 2).
3479
3480 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003481
Heiko Schocherf5895d12014-06-24 10:10:04 +02003482 CONFIG_MTD_UBI_BEB_LIMIT
3483 This option specifies the maximum bad physical eraseblocks UBI
3484 expects on the MTD device (per 1024 eraseblocks). If the
3485 underlying flash does not admit of bad eraseblocks (e.g. NOR
3486 flash), this value is ignored.
3487
3488 NAND datasheets often specify the minimum and maximum NVM
3489 (Number of Valid Blocks) for the flashes' endurance lifetime.
3490 The maximum expected bad eraseblocks per 1024 eraseblocks
3491 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3492 which gives 20 for most NANDs (MaxNVB is basically the total
3493 count of eraseblocks on the chip).
3494
3495 To put it differently, if this value is 20, UBI will try to
3496 reserve about 1.9% of physical eraseblocks for bad blocks
3497 handling. And that will be 1.9% of eraseblocks on the entire
3498 NAND chip, not just the MTD partition UBI attaches. This means
3499 that if you have, say, a NAND flash chip admits maximum 40 bad
3500 eraseblocks, and it is split on two MTD partitions of the same
3501 size, UBI will reserve 40 eraseblocks when attaching a
3502 partition.
3503
3504 default: 20
3505
3506 CONFIG_MTD_UBI_FASTMAP
3507 Fastmap is a mechanism which allows attaching an UBI device
3508 in nearly constant time. Instead of scanning the whole MTD device it
3509 only has to locate a checkpoint (called fastmap) on the device.
3510 The on-flash fastmap contains all information needed to attach
3511 the device. Using fastmap makes only sense on large devices where
3512 attaching by scanning takes long. UBI will not automatically install
3513 a fastmap on old images, but you can set the UBI parameter
3514 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3515 that fastmap-enabled images are still usable with UBI implementations
3516 without fastmap support. On typical flash devices the whole fastmap
3517 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3518
3519 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3520 Set this parameter to enable fastmap automatically on images
3521 without a fastmap.
3522 default: 0
3523
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003524- UBIFS support
3525 CONFIG_CMD_UBIFS
3526
3527 Adds commands for interacting with UBI volumes formatted as
3528 UBIFS. UBIFS is read-only in u-boot.
3529
3530 Requires UBI support as well as CONFIG_LZO
3531
Joe Hershberger47550fc2013-04-08 10:32:49 +00003532 CONFIG_UBIFS_SILENCE_MSG
3533
3534 Make the verbose messages from UBIFS stop printing. This leaves
3535 warnings and errors enabled.
3536
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003537- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003538 CONFIG_SPL
3539 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003540
Tom Rini36853852012-02-14 07:29:40 +00003541 CONFIG_SPL_LDSCRIPT
3542 LDSCRIPT for linking the SPL binary.
3543
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003544 CONFIG_SPL_MAX_FOOTPRINT
3545 Maximum size in memory allocated to the SPL, BSS included.
3546 When defined, the linker checks that the actual memory
3547 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003548 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003549 must not be both defined at the same time.
3550
Tom Rini36853852012-02-14 07:29:40 +00003551 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003552 Maximum size of the SPL image (text, data, rodata, and
3553 linker lists sections), BSS excluded.
3554 When defined, the linker checks that the actual size does
3555 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003556
Wolfgang Denk825223d2011-09-11 21:24:09 +02003557 CONFIG_SPL_TEXT_BASE
3558 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003559
Scott Woodc4f0d002012-09-20 19:05:12 -05003560 CONFIG_SPL_RELOC_TEXT_BASE
3561 Address to relocate to. If unspecified, this is equal to
3562 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3563
Tom Rini36853852012-02-14 07:29:40 +00003564 CONFIG_SPL_BSS_START_ADDR
3565 Link address for the BSS within the SPL binary.
3566
3567 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003568 Maximum size in memory allocated to the SPL BSS.
3569 When defined, the linker checks that the actual memory used
3570 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003571 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003572 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003573
3574 CONFIG_SPL_STACK
3575 Adress of the start of the stack SPL will use
3576
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003577 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3578 When defined, SPL will panic() if the image it has
3579 loaded does not have a signature.
3580 Defining this is useful when code which loads images
3581 in SPL cannot guarantee that absolutely all read errors
3582 will be caught.
3583 An example is the LPC32XX MLC NAND driver, which will
3584 consider that a completely unreadable NAND block is bad,
3585 and thus should be skipped silently.
3586
Scott Woodc4f0d002012-09-20 19:05:12 -05003587 CONFIG_SPL_RELOC_STACK
3588 Adress of the start of the stack SPL will use after
3589 relocation. If unspecified, this is equal to
3590 CONFIG_SPL_STACK.
3591
Tom Rini36853852012-02-14 07:29:40 +00003592 CONFIG_SYS_SPL_MALLOC_START
3593 Starting address of the malloc pool used in SPL.
3594
3595 CONFIG_SYS_SPL_MALLOC_SIZE
3596 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003597
Tom Rini28591df2012-08-13 12:03:19 -07003598 CONFIG_SPL_FRAMEWORK
3599 Enable the SPL framework under common/. This framework
3600 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3601 NAND loading of the Linux Kernel.
3602
Tom Rinic2b76002014-03-28 12:03:39 -04003603 CONFIG_SPL_OS_BOOT
3604 Enable booting directly to an OS from SPL.
3605 See also: doc/README.falcon
3606
Tom Rinife3b0c72012-08-13 11:37:56 -07003607 CONFIG_SPL_DISPLAY_PRINT
3608 For ARM, enable an optional function to print more information
3609 about the running system.
3610
Scott Wood7c810902012-09-20 16:35:21 -05003611 CONFIG_SPL_INIT_MINIMAL
3612 Arch init code should be built for a very small image
3613
Wolfgang Denk825223d2011-09-11 21:24:09 +02003614 CONFIG_SPL_LIBCOMMON_SUPPORT
3615 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003616
Wolfgang Denk825223d2011-09-11 21:24:09 +02003617 CONFIG_SPL_LIBDISK_SUPPORT
3618 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003619
Wolfgang Denk825223d2011-09-11 21:24:09 +02003620 CONFIG_SPL_I2C_SUPPORT
3621 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003622
Wolfgang Denk825223d2011-09-11 21:24:09 +02003623 CONFIG_SPL_GPIO_SUPPORT
3624 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003625
Wolfgang Denk825223d2011-09-11 21:24:09 +02003626 CONFIG_SPL_MMC_SUPPORT
3627 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003628
Tom Rini36853852012-02-14 07:29:40 +00003629 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3630 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003631 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003632 when the MMC is being used in raw mode.
3633
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003634 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3635 Partition on the MMC to load U-Boot from when the MMC is being
3636 used in raw mode
3637
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003638 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3639 Sector to load kernel uImage from when MMC is being
3640 used in raw mode (for Falcon mode)
3641
3642 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3643 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3644 Sector and number of sectors to load kernel argument
3645 parameters from when MMC is being used in raw mode
3646 (for falcon mode)
3647
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003648 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3649 Partition on the MMC to load U-Boot from when the MMC is being
3650 used in fs mode
3651
Tom Rini36853852012-02-14 07:29:40 +00003652 CONFIG_SPL_FAT_SUPPORT
3653 Support for fs/fat/libfat.o in SPL binary
3654
Guillaume GARDET5065b712014-10-15 17:53:13 +02003655 CONFIG_SPL_EXT_SUPPORT
3656 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003657
Guillaume GARDET5065b712014-10-15 17:53:13 +02003658 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3659 Filename to read to load U-Boot when reading from filesystem
3660
3661 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003662 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003663 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003664
Guillaume GARDET5065b712014-10-15 17:53:13 +02003665 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003666 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003667 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003668
Scott Wood2b36fbb2012-12-06 13:33:17 +00003669 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3670 Set this for NAND SPL on PPC mpc83xx targets, so that
3671 start.S waits for the rest of the SPL to load before
3672 continuing (the hardware starts execution after just
3673 loading the first page rather than the full 4K).
3674
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303675 CONFIG_SPL_SKIP_RELOCATE
3676 Avoid SPL relocation
3677
Scott Woodc352a0c2012-09-20 19:09:07 -05003678 CONFIG_SPL_NAND_BASE
3679 Include nand_base.c in the SPL. Requires
3680 CONFIG_SPL_NAND_DRIVERS.
3681
3682 CONFIG_SPL_NAND_DRIVERS
3683 SPL uses normal NAND drivers, not minimal drivers.
3684
3685 CONFIG_SPL_NAND_ECC
3686 Include standard software ECC in the SPL
3687
Tom Rini36853852012-02-14 07:29:40 +00003688 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003689 Support for NAND boot using simple NAND drivers that
3690 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003691
Tom Rini543c9f12014-03-28 12:03:36 -04003692 CONFIG_SPL_MTD_SUPPORT
3693 Support for the MTD subsystem within SPL. Useful for
3694 environment on NAND support within SPL.
3695
Heiko Schochercf000272014-10-31 08:31:00 +01003696 CONFIG_SPL_NAND_RAW_ONLY
3697 Support to boot only raw u-boot.bin images. Use this only
3698 if you need to save space.
3699
Ying Zhang9ff70262013-08-16 15:16:11 +08003700 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3701 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003702 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003703
Ying Zhangdfb2b152013-08-16 15:16:12 +08003704 CONFIG_SPL_COMMON_INIT_DDR
3705 Set for common ddr init with serial presence detect in
3706 SPL binary.
3707
Tom Rini36853852012-02-14 07:29:40 +00003708 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3709 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3710 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3711 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3712 CONFIG_SYS_NAND_ECCBYTES
3713 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003714 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003715
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303716 CONFIG_SPL_NAND_BOOT
3717 Add support NAND boot
3718
Tom Rini36853852012-02-14 07:29:40 +00003719 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003720 Location in NAND to read U-Boot from
3721
3722 CONFIG_SYS_NAND_U_BOOT_DST
3723 Location in memory to load U-Boot to
3724
3725 CONFIG_SYS_NAND_U_BOOT_SIZE
3726 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003727
3728 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003729 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003730
3731 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3732 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003733 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003734
3735 CONFIG_SPL_OMAP3_ID_NAND
3736 Support for an OMAP3-specific set of functions to return the
3737 ID and MFR of the first attached NAND chip, if present.
3738
Wolfgang Denk825223d2011-09-11 21:24:09 +02003739 CONFIG_SPL_SERIAL_SUPPORT
3740 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003741
Wolfgang Denk825223d2011-09-11 21:24:09 +02003742 CONFIG_SPL_SPI_FLASH_SUPPORT
3743 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003744
Wolfgang Denk825223d2011-09-11 21:24:09 +02003745 CONFIG_SPL_SPI_SUPPORT
3746 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003747
Pavel Machekde997252012-08-30 22:42:11 +02003748 CONFIG_SPL_RAM_DEVICE
3749 Support for running image already present in ram, in SPL binary
3750
Wolfgang Denk825223d2011-09-11 21:24:09 +02003751 CONFIG_SPL_LIBGENERIC_SUPPORT
3752 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003753
Ying Zhang602f7d32013-05-20 14:07:25 +08003754 CONFIG_SPL_ENV_SUPPORT
3755 Support for the environment operating in SPL binary
3756
3757 CONFIG_SPL_NET_SUPPORT
3758 Support for the net/libnet.o in SPL binary.
3759 It conflicts with SPL env from storage medium specified by
3760 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3761
Scott Woodeb7bd972012-12-06 13:33:16 +00003762 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003763 Image offset to which the SPL should be padded before appending
3764 the SPL payload. By default, this is defined as
3765 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3766 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3767 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003768
Scott Woodf147eb72012-09-21 16:27:32 -05003769 CONFIG_SPL_TARGET
3770 Final target image containing SPL and payload. Some SPLs
3771 use an arch-specific makefile fragment instead, for
3772 example if more than one image needs to be produced.
3773
Simon Glass82d94532013-05-08 08:05:59 +00003774 CONFIG_FIT_SPL_PRINT
3775 Printing information about a FIT image adds quite a bit of
3776 code to SPL. So this is normally disabled in SPL. Use this
3777 option to re-enable it. This will affect the output of the
3778 bootm command when booting a FIT image.
3779
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003780- TPL framework
3781 CONFIG_TPL
3782 Enable building of TPL globally.
3783
3784 CONFIG_TPL_PAD_TO
3785 Image offset to which the TPL should be padded before appending
3786 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003787 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3788 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3789 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003790
wdenkc6097192002-11-03 00:24:07 +00003791Modem Support:
3792--------------
3793
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003794[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003795
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003796- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003797 CONFIG_MODEM_SUPPORT
3798
3799- RTS/CTS Flow control enable:
3800 CONFIG_HWFLOW
3801
3802- Modem debug support:
3803 CONFIG_MODEM_SUPPORT_DEBUG
3804
wdenk4a5c8a72003-03-06 00:02:04 +00003805 Enables debugging stuff (char screen[1024], dbg())
3806 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003807
wdenkc0aa5c52003-12-06 19:49:23 +00003808- Interrupt support (PPC):
3809
wdenk1ebf41e2004-01-02 14:00:00 +00003810 There are common interrupt_init() and timer_interrupt()
3811 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003812 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003813 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003814 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003815 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003816 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003817 specific handling. If board has watchdog / status_led
3818 / other_activity_monitor it works automatically from
3819 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003820
wdenkc6097192002-11-03 00:24:07 +00003821- General:
3822
wdenk4a5c8a72003-03-06 00:02:04 +00003823 In the target system modem support is enabled when a
3824 specific key (key combination) is pressed during
3825 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003826 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003827 board_init(). Currently key_pressed() is a dummy
3828 function, returning 1 and thus enabling modem
3829 initialization.
wdenkc6097192002-11-03 00:24:07 +00003830
wdenk4a5c8a72003-03-06 00:02:04 +00003831 If there are no modem init strings in the
3832 environment, U-Boot proceed to autoboot; the
3833 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003834 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003835
3836 See also: doc/README.Modem
3837
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003838Board initialization settings:
3839------------------------------
3840
3841During Initialization u-boot calls a number of board specific functions
3842to allow the preparation of board specific prerequisites, e.g. pin setup
3843before drivers are initialized. To enable these callbacks the
3844following configuration macros have to be defined. Currently this is
3845architecture specific, so please check arch/your_architecture/lib/board.c
3846typically in board_init_f() and board_init_r().
3847
3848- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3849- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3850- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3851- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003852
wdenkc6097192002-11-03 00:24:07 +00003853Configuration Settings:
3854-----------------------
3855
York Sun6c480012014-02-26 17:03:19 -08003856- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3857 Optionally it can be defined to support 64-bit memory commands.
3858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003859- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003860 undefine this when you're short of memory.
3861
Peter Tyserdfb72b82009-01-27 18:03:12 -06003862- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3863 width of the commands listed in the 'help' command output.
3864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003865- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003866 prompt for user input.
3867
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003868- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003870- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003872- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003874- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003875 the application (usually a Linux kernel) when it is
3876 booted
3877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003878- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003879 List of legal baudrate settings for this board.
3880
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003881- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003882 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003884- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003885 If the board specific function
3886 extern int overwrite_console (void);
3887 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003888 serial port, else the settings in the environment are used.
3889
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003890- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003891 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003892
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003893- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003894 Enable overwrite of previous console environment settings.
3895
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003896- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003897 Begin and End addresses of the area used by the
3898 simple memory test.
3899
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003900- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003901 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003903- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003904 Scratch address used by the alternate memory test
3905 You only need to set this if address zero isn't writeable
3906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003907- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3908 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003909 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003910 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003911 fixing up gd->ram_size the Linux kernel should gets passed
3912 the now "corrected" memory size and won't touch it either.
3913 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003914 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003915 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003916 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003917
3918 This option can be used as a workaround for the 440EPx/GRx
3919 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3920 be touched.
3921
3922 WARNING: Please make sure that this value is a multiple of
3923 the Linux page size (normally 4k). If this is not the case,
3924 then the end address of the Linux memory will be located at a
3925 non page size aligned address and this could cause major
3926 problems.
3927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003928- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003929 Enable temporary baudrate change while serial download
3930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003931- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003932 Physical start address of SDRAM. _Must_ be 0 here.
3933
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003934- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003935 Physical start address of Motherboard I/O (if using a
3936 Cogent motherboard)
3937
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003938- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003939 Physical start address of Flash memory.
3940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003941- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003942 Physical start address of boot monitor code (set by
3943 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003944 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003945 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003946
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003947- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003948 Size of memory reserved for monitor code, used to
3949 determine _at_compile_time_ (!) if the environment is
3950 embedded within the U-Boot image, or in a separate
3951 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003953- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003954 Size of DRAM reserved for malloc() use.
3955
Simon Glass863e4042014-07-10 22:23:28 -06003956- CONFIG_SYS_MALLOC_F_LEN
3957 Size of the malloc() pool for use before relocation. If
3958 this is defined, then a very simple malloc() implementation
3959 will become available before relocation. The address is just
3960 below the global data, and the stack is moved down to make
3961 space.
3962
3963 This feature allocates regions with increasing addresses
3964 within the region. calloc() is supported, but realloc()
3965 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003966 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003967 U-Boot relocates itself.
3968
Simon Glasse997f752014-09-15 06:33:18 -06003969 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003970 at present but is fairly easy to enable for other archs.
3971
Simon Glass9fa901b2014-11-10 17:16:54 -07003972- CONFIG_SYS_MALLOC_SIMPLE
3973 Provides a simple and small malloc() and calloc() for those
3974 boards which do not use the full malloc in SPL (which is
3975 enabled with CONFIG_SYS_SPL_MALLOC_START).
3976
Thierry Redingc97d9742014-12-09 22:25:22 -07003977- CONFIG_SYS_NONCACHED_MEMORY:
3978 Size of non-cached memory area. This area of memory will be
3979 typically located right below the malloc() area and mapped
3980 uncached in the MMU. This is useful for drivers that would
3981 otherwise require a lot of explicit cache maintenance. For
3982 some drivers it's also impossible to properly maintain the
3983 cache. For example if the regions that need to be flushed
3984 are not a multiple of the cache-line size, *and* padding
3985 cannot be allocated between the regions to align them (i.e.
3986 if the HW requires a contiguous array of regions, and the
3987 size of each region is not cache-aligned), then a flush of
3988 one region may result in overwriting data that hardware has
3989 written to another region in the same cache-line. This can
3990 happen for example in network drivers where descriptors for
3991 buffers are typically smaller than the CPU cache-line (e.g.
3992 16 bytes vs. 32 or 64 bytes).
3993
3994 Non-cached memory is only supported on 32-bit ARM at present.
3995
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003996- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003997 Normally compressed uImages are limited to an
3998 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003999 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01004000 to adjust this setting to your needs.
4001
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004002- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004003 Maximum size of memory mapped by the startup code of
4004 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004005 the Linux kernel (bd_info, boot arguments, FDT blob if
4006 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004007 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004008 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004009 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004010 variable "bootm_mapsize" will override the value of
4011 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4012 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004013
John Rigbyeea8e692010-10-13 13:57:35 -06004014- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4015 Enable initrd_high functionality. If defined then the
4016 initrd_high feature is enabled and the bootm ramdisk subcommand
4017 is enabled.
4018
4019- CONFIG_SYS_BOOT_GET_CMDLINE:
4020 Enables allocating and saving kernel cmdline in space between
4021 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4022
4023- CONFIG_SYS_BOOT_GET_KBD:
4024 Enables allocating and saving a kernel copy of the bd_info in
4025 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4026
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004027- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004028 Max number of Flash memory banks
4029
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004030- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004031 Max number of sectors on a Flash chip
4032
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004033- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004034 Timeout for Flash erase operations (in ms)
4035
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004036- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004037 Timeout for Flash write operations (in ms)
4038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004039- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004040 Timeout for Flash set sector lock bit operation (in ms)
4041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004042- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004043 Timeout for Flash clear lock bits operation (in ms)
4044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004045- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004046 If defined, hardware flash sectors protection is used
4047 instead of U-Boot software protection.
4048
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004049- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004050
4051 Enable TFTP transfers directly to flash memory;
4052 without this option such a download has to be
4053 performed in two steps: (1) download to RAM, and (2)
4054 copy from RAM to flash.
4055
4056 The two-step approach is usually more reliable, since
4057 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004058 the flash, but in some situations (when system RAM is
4059 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004060 downloaded image) this option may be very useful.
4061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004062- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004063 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004064 common flash structure for storing flash geometry.
4065
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004066- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004067 This option also enables the building of the cfi_flash driver
4068 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004069
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004070- CONFIG_FLASH_CFI_MTD
4071 This option enables the building of the cfi_mtd driver
4072 in the drivers directory. The driver exports CFI flash
4073 to the MTD layer.
4074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004075- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004076 Use buffered writes to flash.
4077
4078- CONFIG_FLASH_SPANSION_S29WS_N
4079 s29ws-n MirrorBit flash has non-standard addresses for buffered
4080 write commands.
4081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004082- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004083 If this option is defined, the common CFI flash doesn't
4084 print it's warning upon not recognized FLASH banks. This
4085 is useful, if some of the configured banks are only
4086 optionally available.
4087
Jerry Van Barenaae73572008-03-08 13:48:01 -05004088- CONFIG_FLASH_SHOW_PROGRESS
4089 If defined (must be an integer), print out countdown
4090 digits and dots. Recommended value: 45 (9..1) for 80
4091 column displays, 15 (3..1) for 40 column displays.
4092
Stefan Roesed20cba52013-04-04 15:53:14 +02004093- CONFIG_FLASH_VERIFY
4094 If defined, the content of the flash (destination) is compared
4095 against the source after the write operation. An error message
4096 will be printed when the contents are not identical.
4097 Please note that this option is useless in nearly all cases,
4098 since such flash programming errors usually are detected earlier
4099 while unprotecting/erasing/programming. Please only enable
4100 this option if you really know what you are doing.
4101
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004102- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004103 Defines the number of Ethernet receive buffers. On some
4104 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004105 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4106 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004107 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004108 Defaults to 4 if not defined.
4109
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004110- CONFIG_ENV_MAX_ENTRIES
4111
Wolfgang Denk1136f692010-10-27 22:48:30 +02004112 Maximum number of entries in the hash table that is used
4113 internally to store the environment settings. The default
4114 setting is supposed to be generous and should work in most
4115 cases. This setting can be used to tune behaviour; see
4116 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004117
Joe Hershberger71497d02012-12-11 22:16:31 -06004118- CONFIG_ENV_FLAGS_LIST_DEFAULT
4119- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004120 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004121 calling env set. Variables can be restricted to only decimal,
4122 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4123 the variables can also be restricted to IP address or MAC address.
4124
4125 The format of the list is:
4126 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004127 access_attribute = [a|r|o|c]
4128 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004129 entry = variable_name[:attributes]
4130 list = entry[,list]
4131
4132 The type attributes are:
4133 s - String (default)
4134 d - Decimal
4135 x - Hexadecimal
4136 b - Boolean ([1yYtT|0nNfF])
4137 i - IP address
4138 m - MAC address
4139
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004140 The access attributes are:
4141 a - Any (default)
4142 r - Read-only
4143 o - Write-once
4144 c - Change-default
4145
Joe Hershberger71497d02012-12-11 22:16:31 -06004146 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4147 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004148 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004149
4150 - CONFIG_ENV_FLAGS_LIST_STATIC
4151 Define this to a list (string) to define validation that
4152 should be done if an entry is not found in the ".flags"
4153 environment variable. To override a setting in the static
4154 list, simply add an entry for the same variable name to the
4155 ".flags" variable.
4156
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004157- CONFIG_ENV_ACCESS_IGNORE_FORCE
4158 If defined, don't allow the -f switch to env set override variable
4159 access flags.
4160
Simon Glass66828322013-03-08 13:45:27 +00004161- CONFIG_SYS_GENERIC_BOARD
4162 This selects the architecture-generic board system instead of the
4163 architecture-specific board files. It is intended to move boards
4164 to this new framework over time. Defining this will disable the
4165 arch/foo/lib/board.c file and use common/board_f.c and
4166 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004167 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4168 If you find problems enabling this option on your board please report
4169 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004170
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004171- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4172 This is set by OMAP boards for the max time that reset should
4173 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004174 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004175
Gabe Black3687fe42014-10-15 04:38:30 -06004176- CONFIG_USE_STDINT
4177 If stdint.h is available with your toolchain you can define this
4178 option to enable it. You can provide option 'USE_STDINT=1' when
4179 building U-Boot to enable this.
4180
wdenkc6097192002-11-03 00:24:07 +00004181The following definitions that deal with the placement and management
4182of environment data (variable area); in general, we support the
4183following configurations:
4184
Mike Frysinger63b8f122011-07-08 10:44:25 +00004185- CONFIG_BUILD_ENVCRC:
4186
4187 Builds up envcrc with the target environment so that external utils
4188 may easily extract it and embed it in final U-Boot images.
4189
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004190- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004191
4192 Define this if the environment is in flash memory.
4193
4194 a) The environment occupies one whole flash sector, which is
4195 "embedded" in the text segment with the U-Boot code. This
4196 happens usually with "bottom boot sector" or "top boot
4197 sector" type flash chips, which have several smaller
4198 sectors at the start or the end. For instance, such a
4199 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4200 such a case you would place the environment in one of the
4201 4 kB sectors - with U-Boot code before and after it. With
4202 "top boot sector" type flash chips, you would put the
4203 environment in one of the last sectors, leaving a gap
4204 between U-Boot and the environment.
4205
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004206 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004207
4208 Offset of environment data (variable area) to the
4209 beginning of flash memory; for instance, with bottom boot
4210 type flash chips the second sector can be used: the offset
4211 for this sector is given here.
4212
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004213 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004214
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004215 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004216
4217 This is just another way to specify the start address of
4218 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004219 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004220
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004221 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004222
4223 Size of the sector containing the environment.
4224
4225
4226 b) Sometimes flash chips have few, equal sized, BIG sectors.
4227 In such a case you don't want to spend a whole sector for
4228 the environment.
4229
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004230 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004231
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004232 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004233 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004234 of this flash sector for the environment. This saves
4235 memory for the RAM copy of the environment.
4236
4237 It may also save flash memory if you decide to use this
4238 when your environment is "embedded" within U-Boot code,
4239 since then the remainder of the flash sector could be used
4240 for U-Boot code. It should be pointed out that this is
4241 STRONGLY DISCOURAGED from a robustness point of view:
4242 updating the environment in flash makes it always
4243 necessary to erase the WHOLE sector. If something goes
4244 wrong before the contents has been restored from a copy in
4245 RAM, your target system will be dead.
4246
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004247 - CONFIG_ENV_ADDR_REDUND
4248 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk4a5c8a72003-03-06 00:02:04 +00004250 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004251 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004252 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004253 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004254
4255BE CAREFUL! Any changes to the flash layout, and some changes to the
4256source code will make it necessary to adapt <board>/u-boot.lds*
4257accordingly!
4258
4259
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004260- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004261
4262 Define this if you have some non-volatile memory device
4263 (NVRAM, battery buffered SRAM) which you want to use for the
4264 environment.
4265
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004266 - CONFIG_ENV_ADDR:
4267 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004268
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004269 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004270 want to use for environment. It is assumed that this memory
4271 can just be read and written to, without any special
4272 provision.
4273
4274BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004275in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004276console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004277U-Boot will hang.
4278
4279Please note that even with NVRAM we still use a copy of the
4280environment in RAM: we could work on NVRAM directly, but we want to
4281keep settings there always unmodified except somebody uses "saveenv"
4282to save the current settings.
4283
4284
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004285- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004286
4287 Use this if you have an EEPROM or similar serial access
4288 device and a driver for it.
4289
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004290 - CONFIG_ENV_OFFSET:
4291 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004292
4293 These two #defines specify the offset and size of the
4294 environment area within the total memory of your EEPROM.
4295
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004296 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004297 If defined, specified the chip address of the EEPROM device.
4298 The default address is zero.
4299
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004300 - CONFIG_SYS_I2C_EEPROM_BUS:
4301 If defined, specified the i2c bus of the EEPROM device.
4302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004303 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004304 If defined, the number of bits used to address bytes in a
4305 single page in the EEPROM device. A 64 byte page, for example
4306 would require six bits.
4307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004308 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004309 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004310 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004312 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004313 The length in bytes of the EEPROM memory array address. Note
4314 that this is NOT the chip address length!
4315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004316 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004317 EEPROM chips that implement "address overflow" are ones
4318 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4319 address and the extra bits end up in the "chip address" bit
4320 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4321 byte chips.
4322
4323 Note that we consider the length of the address field to
4324 still be one byte because the extra address bits are hidden
4325 in the chip address.
4326
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004327 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004328 The size in bytes of the EEPROM device.
4329
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004330 - CONFIG_ENV_EEPROM_IS_ON_I2C
4331 define this, if you have I2C and SPI activated, and your
4332 EEPROM, which holds the environment, is on the I2C bus.
4333
4334 - CONFIG_I2C_ENV_EEPROM_BUS
4335 if you have an Environment on an EEPROM reached over
4336 I2C muxes, you can define here, how to reach this
4337 EEPROM. For example:
4338
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004339 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004340
4341 EEPROM which holds the environment, is reached over
4342 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004343
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004344- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004345
wdenk1ebf41e2004-01-02 14:00:00 +00004346 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004347 want to use for the environment.
4348
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004349 - CONFIG_ENV_OFFSET:
4350 - CONFIG_ENV_ADDR:
4351 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004352
4353 These three #defines specify the offset and size of the
4354 environment area within the total memory of your DataFlash placed
4355 at the specified address.
4356
Wu, Josh76db7bf2014-07-01 19:30:13 +08004357- CONFIG_ENV_IS_IN_SPI_FLASH:
4358
4359 Define this if you have a SPI Flash memory device which you
4360 want to use for the environment.
4361
4362 - CONFIG_ENV_OFFSET:
4363 - CONFIG_ENV_SIZE:
4364
4365 These two #defines specify the offset and size of the
4366 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4367 aligned to an erase sector boundary.
4368
4369 - CONFIG_ENV_SECT_SIZE:
4370
4371 Define the SPI flash's sector size.
4372
4373 - CONFIG_ENV_OFFSET_REDUND (optional):
4374
4375 This setting describes a second storage area of CONFIG_ENV_SIZE
4376 size used to hold a redundant copy of the environment data, so
4377 that there is a valid backup copy in case there is a power failure
4378 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4379 aligned to an erase sector boundary.
4380
4381 - CONFIG_ENV_SPI_BUS (optional):
4382 - CONFIG_ENV_SPI_CS (optional):
4383
4384 Define the SPI bus and chip select. If not defined they will be 0.
4385
4386 - CONFIG_ENV_SPI_MAX_HZ (optional):
4387
4388 Define the SPI max work clock. If not defined then use 1MHz.
4389
4390 - CONFIG_ENV_SPI_MODE (optional):
4391
4392 Define the SPI work mode. If not defined then use SPI_MODE_3.
4393
Liu Gang85bcd732012-03-08 00:33:20 +00004394- CONFIG_ENV_IS_IN_REMOTE:
4395
4396 Define this if you have a remote memory space which you
4397 want to use for the local device's environment.
4398
4399 - CONFIG_ENV_ADDR:
4400 - CONFIG_ENV_SIZE:
4401
4402 These two #defines specify the address and size of the
4403 environment area within the remote memory space. The
4404 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004405 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004406
4407BE CAREFUL! For some special cases, the local device can not use
4408"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004409environment stored in a remote NOR flash by SRIO or PCIE link,
4410but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004411
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004412- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004413
4414 Define this if you have a NAND device which you want to use
4415 for the environment.
4416
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004417 - CONFIG_ENV_OFFSET:
4418 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004419
4420 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004421 area within the first NAND device. CONFIG_ENV_OFFSET must be
4422 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004423
Scott Wood08239322010-09-17 14:38:37 -05004424 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004425
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004426 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004427 size used to hold a redundant copy of the environment data, so
4428 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004429 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004430 aligned to an erase block boundary.
4431
4432 - CONFIG_ENV_RANGE (optional):
4433
4434 Specifies the length of the region in which the environment
4435 can be written. This should be a multiple of the NAND device's
4436 block size. Specifying a range with more erase blocks than
4437 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4438 the range to be avoided.
4439
4440 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004441
Scott Wood08239322010-09-17 14:38:37 -05004442 Enables support for dynamically retrieving the offset of the
4443 environment from block zero's out-of-band data. The
4444 "nand env.oob" command can be used to record this offset.
4445 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4446 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004447
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004448- CONFIG_NAND_ENV_DST
4449
4450 Defines address in RAM to which the nand_spl code should copy the
4451 environment. If redundant environment is used, it will be copied to
4452 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4453
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004454- CONFIG_ENV_IS_IN_UBI:
4455
4456 Define this if you have an UBI volume that you want to use for the
4457 environment. This has the benefit of wear-leveling the environment
4458 accesses, which is important on NAND.
4459
4460 - CONFIG_ENV_UBI_PART:
4461
4462 Define this to a string that is the mtd partition containing the UBI.
4463
4464 - CONFIG_ENV_UBI_VOLUME:
4465
4466 Define this to the name of the volume that you want to store the
4467 environment in.
4468
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004469 - CONFIG_ENV_UBI_VOLUME_REDUND:
4470
4471 Define this to the name of another volume to store a second copy of
4472 the environment in. This will enable redundant environments in UBI.
4473 It is assumed that both volumes are in the same MTD partition.
4474
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004475 - CONFIG_UBI_SILENCE_MSG
4476 - CONFIG_UBIFS_SILENCE_MSG
4477
4478 You will probably want to define these to avoid a really noisy system
4479 when storing the env in UBI.
4480
Wu, Josha7d0c872014-06-24 17:31:03 +08004481- CONFIG_ENV_IS_IN_FAT:
4482 Define this if you want to use the FAT file system for the environment.
4483
4484 - FAT_ENV_INTERFACE:
4485
4486 Define this to a string that is the name of the block device.
4487
4488 - FAT_ENV_DEV_AND_PART:
4489
4490 Define this to a string to specify the partition of the device. It can
4491 be as following:
4492
4493 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4494 - "D:P": device D partition P. Error occurs if device D has no
4495 partition table.
4496 - "D:0": device D.
4497 - "D" or "D:": device D partition 1 if device D has partition
4498 table, or the whole device D if has no partition
4499 table.
4500 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004501 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004502 partition table then means device D.
4503
4504 - FAT_ENV_FILE:
4505
4506 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004507 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004508
4509 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004510 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004511
Stephen Warreneedcacd2013-06-11 15:14:00 -06004512- CONFIG_ENV_IS_IN_MMC:
4513
4514 Define this if you have an MMC device which you want to use for the
4515 environment.
4516
4517 - CONFIG_SYS_MMC_ENV_DEV:
4518
4519 Specifies which MMC device the environment is stored in.
4520
4521 - CONFIG_SYS_MMC_ENV_PART (optional):
4522
4523 Specifies which MMC partition the environment is stored in. If not
4524 set, defaults to partition 0, the user area. Common values might be
4525 1 (first MMC boot partition), 2 (second MMC boot partition).
4526
4527 - CONFIG_ENV_OFFSET:
4528 - CONFIG_ENV_SIZE:
4529
4530 These two #defines specify the offset and size of the environment
4531 area within the specified MMC device.
4532
Stephen Warren24dc2032013-06-11 15:14:02 -06004533 If offset is positive (the usual case), it is treated as relative to
4534 the start of the MMC partition. If offset is negative, it is treated
4535 as relative to the end of the MMC partition. This can be useful if
4536 your board may be fitted with different MMC devices, which have
4537 different sizes for the MMC partitions, and you always want the
4538 environment placed at the very end of the partition, to leave the
4539 maximum possible space before it, to store other data.
4540
Stephen Warreneedcacd2013-06-11 15:14:00 -06004541 These two values are in units of bytes, but must be aligned to an
4542 MMC sector boundary.
4543
4544 - CONFIG_ENV_OFFSET_REDUND (optional):
4545
4546 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4547 hold a redundant copy of the environment data. This provides a
4548 valid backup copy in case the other copy is corrupted, e.g. due
4549 to a power failure during a "saveenv" operation.
4550
Stephen Warren24dc2032013-06-11 15:14:02 -06004551 This value may also be positive or negative; this is handled in the
4552 same way as CONFIG_ENV_OFFSET.
4553
Stephen Warreneedcacd2013-06-11 15:14:00 -06004554 This value is also in units of bytes, but must also be aligned to
4555 an MMC sector boundary.
4556
4557 - CONFIG_ENV_SIZE_REDUND (optional):
4558
4559 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4560 set. If this value is set, it must be set to the same value as
4561 CONFIG_ENV_SIZE.
4562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004563- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004564
4565 Defines offset to the initial SPI buffer area in DPRAM. The
4566 area is used at an early stage (ROM part) if the environment
4567 is configured to reside in the SPI EEPROM: We need a 520 byte
4568 scratch DPRAM area. It is used between the two initialization
4569 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4570 to be a good choice since it makes it far enough from the
4571 start of the data area as well as from the stack pointer.
4572
Bruce Adleredecc942007-11-02 13:15:42 -07004573Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004574has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004575created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004576until then to read environment variables.
4577
wdenk8dba0502003-03-31 16:34:49 +00004578The environment is protected by a CRC32 checksum. Before the monitor
4579is relocated into RAM, as a result of a bad CRC you will be working
4580with the compiled-in default environment - *silently*!!! [This is
4581necessary, because the first environment variable we need is the
4582"baudrate" setting for the console - if we have a bad CRC, we don't
4583have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004584
4585Note: once the monitor has been relocated, then it will complain if
4586the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004587use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004589- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004590 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004592 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004593 also needs to be defined.
4594
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004595- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004596 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004597
Ron Madriddfa028a2009-02-18 14:30:44 -08004598- CONFIG_NS16550_MIN_FUNCTIONS:
4599 Define this if you desire to only have use of the NS16550_init
4600 and NS16550_putc functions for the serial driver located at
4601 drivers/serial/ns16550.c. This option is useful for saving
4602 space for already greatly restricted images, including but not
4603 limited to NAND_SPL configurations.
4604
Simon Glass28a9e332012-11-30 13:01:18 +00004605- CONFIG_DISPLAY_BOARDINFO
4606 Display information about the board that U-Boot is running on
4607 when U-Boot starts up. The board function checkboard() is called
4608 to do this.
4609
Simon Glasse8822012012-11-30 13:01:19 +00004610- CONFIG_DISPLAY_BOARDINFO_LATE
4611 Similar to the previous option, but display this information
4612 later, once stdio is running and output goes to the LCD, if
4613 present.
4614
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004615- CONFIG_BOARD_SIZE_LIMIT:
4616 Maximum size of the U-Boot image. When defined, the
4617 build system checks that the actual size does not
4618 exceed it.
4619
wdenkc6097192002-11-03 00:24:07 +00004620Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004621---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004623- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004624 Cache Line Size of the CPU.
4625
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004626- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004627 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004628
wdenk9c53f402003-10-15 23:53:47 +00004629 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4630 and RPXsuper) to be able to adjust the position of
4631 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004632
Timur Tabid8f341c2011-08-04 18:03:41 -05004633- CONFIG_SYS_CCSRBAR_DEFAULT:
4634 Default (power-on reset) physical address of CCSR on Freescale
4635 PowerPC SOCs.
4636
4637- CONFIG_SYS_CCSRBAR:
4638 Virtual address of CCSR. On a 32-bit build, this is typically
4639 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4640
4641 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4642 for cross-platform code that uses that macro instead.
4643
4644- CONFIG_SYS_CCSRBAR_PHYS:
4645 Physical address of CCSR. CCSR can be relocated to a new
4646 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004647 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004648 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4649 is typically relocated on 36-bit builds. It is recommended
4650 that this macro be defined via the _HIGH and _LOW macros:
4651
4652 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4653 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4654
4655- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004656 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4657 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004658 used in assembly code, so it must not contain typecasts or
4659 integer size suffixes (e.g. "ULL").
4660
4661- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4662 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4663 used in assembly code, so it must not contain typecasts or
4664 integer size suffixes (e.g. "ULL").
4665
4666- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4667 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4668 forced to a value that ensures that CCSR is not relocated.
4669
wdenk1272e232002-11-10 22:06:23 +00004670- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004671 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004672
4673 the default drive number (default value 0)
4674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004675 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004676
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004677 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004678 (default value 1)
4679
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004680 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004681
wdenk4a5c8a72003-03-06 00:02:04 +00004682 defines the offset of register from address. It
4683 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004684 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004685
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004686 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4687 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004688 default value.
wdenk1272e232002-11-10 22:06:23 +00004689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004690 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004691 fdc_hw_init() is called at the beginning of the FDC
4692 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004693 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004694 initializations.
wdenk1272e232002-11-10 22:06:23 +00004695
Macpaul Lind1e49942011-04-11 20:45:32 +00004696- CONFIG_IDE_AHB:
4697 Most IDE controllers were designed to be connected with PCI
4698 interface. Only few of them were designed for AHB interface.
4699 When software is doing ATA command and data transfer to
4700 IDE devices through IDE-AHB controller, some additional
4701 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004702 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004705 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004706 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004707
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004708- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004709
wdenkeb20ad32003-09-05 23:19:14 +00004710 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004711 initial data and stack; please note that this must be
4712 writable memory that is working WITHOUT special
4713 initialization, i. e. you CANNOT use normal RAM which
4714 will become available only after programming the
4715 memory controller and running certain initialization
4716 sequences.
4717
4718 U-Boot uses the following memory types:
4719 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4720 - MPC824X: data cache
4721 - PPC4xx: data cache
4722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004723- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004724
4725 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004726 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4727 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004728 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004729 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004730 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4731 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4732 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004733
4734 Note:
4735 On the MPC824X (or other systems that use the data
4736 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004737 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004738 point to an otherwise UNUSED address space between
4739 the top of RAM and the start of the PCI space.
4740
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004741- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004743- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004744
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004745- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004746
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004747- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004748
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004749- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004750
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004751- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004753- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004754 SDRAM timing
4755
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004756- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004757 periodic timer for refresh
4758
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004759- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004761- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4762 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4763 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4764 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004765 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4766
4767- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004768 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4769 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004770 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004772- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4773 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004774 Machine Mode Register and Memory Periodic Timer
4775 Prescaler definitions (SDRAM timing)
4776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004777- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004778 enable I2C microcode relocation patch (MPC8xx);
4779 define relocation offset in DPRAM [DSP2]
4780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004781- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004782 enable SMC microcode relocation patch (MPC8xx);
4783 define relocation offset in DPRAM [SMC1]
4784
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004785- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004786 enable SPI microcode relocation patch (MPC8xx);
4787 define relocation offset in DPRAM [SCC4]
4788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004789- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004790 Use OSCM clock mode on MBX8xx board. Be careful,
4791 wrong setting might damage your board. Read
4792 doc/README.MBX before setting this variable!
4793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004794- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004795 Offset of the bootmode word in DPRAM used by post
4796 (Power On Self Tests). This definition overrides
4797 #define'd default value in commproc.h resp.
4798 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004800- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4801 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4802 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4803 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4804 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4805 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4806 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4807 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004808 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004809
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004810- CONFIG_PCI_DISABLE_PCIE:
4811 Disable PCI-Express on systems where it is supported but not
4812 required.
4813
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004814- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004815 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004816 Don't do any setup work, presumably because someone or
4817 something has already done it, and we don't need to do it
4818 a second time. Useful for platforms that are pre-booted
4819 by coreboot or similar.
4820
Gabor Juhosb4458732013-05-30 07:06:12 +00004821- CONFIG_PCI_INDIRECT_BRIDGE:
4822 Enable support for indirect PCI bridges.
4823
Kumar Gala8975d7a2010-12-30 12:09:53 -06004824- CONFIG_SYS_SRIO:
4825 Chip has SRIO or not
4826
4827- CONFIG_SRIO1:
4828 Board has SRIO 1 port available
4829
4830- CONFIG_SRIO2:
4831 Board has SRIO 2 port available
4832
Liu Gang27afb9c2013-05-07 16:30:46 +08004833- CONFIG_SRIO_PCIE_BOOT_MASTER
4834 Board can support master function for Boot from SRIO and PCIE
4835
Kumar Gala8975d7a2010-12-30 12:09:53 -06004836- CONFIG_SYS_SRIOn_MEM_VIRT:
4837 Virtual Address of SRIO port 'n' memory region
4838
4839- CONFIG_SYS_SRIOn_MEM_PHYS:
4840 Physical Address of SRIO port 'n' memory region
4841
4842- CONFIG_SYS_SRIOn_MEM_SIZE:
4843 Size of SRIO port 'n' memory region
4844
Fabio Estevamf17e8782013-04-11 09:35:34 +00004845- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4846 Defined to tell the NAND controller that the NAND chip is using
4847 a 16 bit bus.
4848 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004849 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004850 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004851 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004852
4853- CONFIG_SYS_NDFC_EBC0_CFG
4854 Sets the EBC0_CFG register for the NDFC. If not defined
4855 a default value will be used.
4856
Ben Warren45657152006-09-07 16:50:54 -04004857- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004858 Get DDR timing information from an I2C EEPROM. Common
4859 with pluggable memory modules such as SODIMMs
4860
Ben Warren45657152006-09-07 16:50:54 -04004861 SPD_EEPROM_ADDRESS
4862 I2C address of the SPD EEPROM
4863
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004864- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004865 If SPD EEPROM is on an I2C bus other than the first
4866 one, specify here. Note that the value must resolve
4867 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004868
York Sune73cc042011-06-07 09:42:16 +08004869- CONFIG_SYS_DDR_RAW_TIMING
4870 Get DDR timing information from other than SPD. Common with
4871 soldered DDR chips onboard without SPD. DDR raw timing
4872 parameters are extracted from datasheet and hard-coded into
4873 header files or board specific files.
4874
York Sunbd495cf2011-09-16 13:21:35 -07004875- CONFIG_FSL_DDR_INTERACTIVE
4876 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4877
York Sun8ced0502015-01-06 13:18:55 -08004878- CONFIG_FSL_DDR_SYNC_REFRESH
4879 Enable sync of refresh for multiple controllers.
4880
York Sunb6a35f82015-03-19 09:30:28 -07004881- CONFIG_FSL_DDR_BIST
4882 Enable built-in memory test for Freescale DDR controllers.
4883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004884- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004885 Only for 83xx systems. If specified, then DDR should
4886 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004887
wdenk6203e402004-04-18 10:13:26 +00004888- CONFIG_ETHER_ON_FEC[12]
4889 Define to enable FEC[12] on a 8xx series processor.
4890
4891- CONFIG_FEC[12]_PHY
4892 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004893 to the given FEC; i. e.
4894 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004895 means that the PHY with address 4 is connected to FEC1
4896
4897 When set to -1, means to probe for first available.
4898
4899- CONFIG_FEC[12]_PHY_NORXERR
4900 The PHY does not have a RXERR line (RMII only).
4901 (so program the FEC to ignore it).
4902
4903- CONFIG_RMII
4904 Enable RMII mode for all FECs.
4905 Note that this is a global option, we can't
4906 have one FEC in standard MII mode and another in RMII mode.
4907
wdenk20c98a62004-04-23 20:32:05 +00004908- CONFIG_CRC32_VERIFY
4909 Add a verify option to the crc32 command.
4910 The syntax is:
4911
4912 => crc32 -v <address> <count> <crc32>
4913
4914 Where address/count indicate a memory area
4915 and crc32 is the correct crc32 which the
4916 area should have.
4917
wdenk64519362004-07-11 17:40:54 +00004918- CONFIG_LOOPW
4919 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004920 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004921
stroesecc3af832004-12-16 18:46:55 +00004922- CONFIG_MX_CYCLIC
4923 Add the "mdc" and "mwc" memory commands. These are cyclic
4924 "md/mw" commands.
4925 Examples:
4926
wdenk07d7e6b2004-12-16 21:44:03 +00004927 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004928 This command will print 4 bytes (10,11,12,13) each 500 ms.
4929
wdenk07d7e6b2004-12-16 21:44:03 +00004930 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004931 This command will write 12345678 to address 100 all 10 ms.
4932
wdenk07d7e6b2004-12-16 21:44:03 +00004933 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004934 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004935
wdenk3d3d99f2005-04-04 12:44:11 +00004936- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004937 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004938 low level initializations (like setting up the memory
4939 controller) are omitted and/or U-Boot does not
4940 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004941
Wolfgang Denk302141d2010-11-27 23:30:56 +01004942 Normally this variable MUST NOT be defined. The only
4943 exception is when U-Boot is loaded (to RAM) by some
4944 other boot loader or by a debugger which performs
4945 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004946
Aneesh V552a3192011-07-13 05:11:07 +00004947- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004948 Modifies the behaviour of start.S when compiling a loader
4949 that is executed before the actual U-Boot. E.g. when
4950 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004951
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004952- CONFIG_TPL_BUILD
4953 Modifies the behaviour of start.S when compiling a loader
4954 that is executed after the SPL and before the actual U-Boot.
4955 It is loaded by the SPL.
4956
Ying Zhang0d4f5442013-05-20 14:07:23 +08004957- CONFIG_SYS_MPC85XX_NO_RESETVEC
4958 Only for 85xx systems. If this variable is specified, the section
4959 .resetvec is not kept and the section .bootpg is placed in the
4960 previous 4k of the .text section.
4961
Simon Glass17dabf02013-02-24 17:33:14 +00004962- CONFIG_ARCH_MAP_SYSMEM
4963 Generally U-Boot (and in particular the md command) uses
4964 effective address. It is therefore not necessary to regard
4965 U-Boot address as virtual addresses that need to be translated
4966 to physical addresses. However, sandbox requires this, since
4967 it maintains its own little RAM buffer which contains all
4968 addressable memory. This option causes some memory accesses
4969 to be mapped through map_sysmem() / unmap_sysmem().
4970
Matthias Weisser93416c12011-03-10 21:36:32 +00004971- CONFIG_USE_ARCH_MEMCPY
4972 CONFIG_USE_ARCH_MEMSET
4973 If these options are used a optimized version of memcpy/memset will
4974 be used if available. These functions may be faster under some
4975 conditions but may increase the binary size.
4976
Simon Glassbfb59802013-02-14 04:18:54 +00004977- CONFIG_X86_RESET_VECTOR
4978 If defined, the x86 reset vector code is included. This is not
4979 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004980
Mark Jackson52b003c2013-03-04 01:27:20 +00004981- CONFIG_SYS_MPUCLK
4982 Defines the MPU clock speed (in MHz).
4983
4984 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004985
Heiko Schocher2233e462013-11-04 14:05:00 +01004986- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4987 Enables the RTC32K OSC on AM33xx based plattforms
4988
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004989- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4990 Option to disable subpage write in NAND driver
4991 driver that uses this:
4992 drivers/mtd/nand/davinci_nand.c
4993
Timur Tabi275f4bb2011-11-22 09:21:25 -06004994Freescale QE/FMAN Firmware Support:
4995-----------------------------------
4996
4997The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4998loading of "firmware", which is encoded in the QE firmware binary format.
4999This firmware often needs to be loaded during U-Boot booting, so macros
5000are used to identify the storage device (NOR flash, SPI, etc) and the address
5001within that device.
5002
Zhao Qiang83a90842014-03-21 16:21:44 +08005003- CONFIG_SYS_FMAN_FW_ADDR
5004 The address in the storage device where the FMAN microcode is located. The
5005 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5006 is also specified.
5007
5008- CONFIG_SYS_QE_FW_ADDR
5009 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005010 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5011 is also specified.
5012
5013- CONFIG_SYS_QE_FMAN_FW_LENGTH
5014 The maximum possible size of the firmware. The firmware binary format
5015 has a field that specifies the actual size of the firmware, but it
5016 might not be possible to read any part of the firmware unless some
5017 local storage is allocated to hold the entire firmware first.
5018
5019- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5020 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5021 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5022 virtual address in NOR flash.
5023
5024- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5025 Specifies that QE/FMAN firmware is located in NAND flash.
5026 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5027
5028- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5029 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5030 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5031
5032- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5033 Specifies that QE/FMAN firmware is located on the primary SPI
5034 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5035
Liu Gang1e084582012-03-08 00:33:18 +00005036- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5037 Specifies that QE/FMAN firmware is located in the remote (master)
5038 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005039 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5040 window->master inbound window->master LAW->the ucode address in
5041 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005042
J. German Rivera8ff14b72014-06-23 15:15:55 -07005043Freescale Layerscape Management Complex Firmware Support:
5044---------------------------------------------------------
5045The Freescale Layerscape Management Complex (MC) supports the loading of
5046"firmware".
5047This firmware often needs to be loaded during U-Boot booting, so macros
5048are used to identify the storage device (NOR flash, SPI, etc) and the address
5049within that device.
5050
5051- CONFIG_FSL_MC_ENET
5052 Enable the MC driver for Layerscape SoCs.
5053
5054- CONFIG_SYS_LS_MC_FW_ADDR
5055 The address in the storage device where the firmware is located. The
5056 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5057 is also specified.
5058
5059- CONFIG_SYS_LS_MC_FW_LENGTH
5060 The maximum possible size of the firmware. The firmware binary format
5061 has a field that specifies the actual size of the firmware, but it
5062 might not be possible to read any part of the firmware unless some
5063 local storage is allocated to hold the entire firmware first.
5064
5065- CONFIG_SYS_LS_MC_FW_IN_NOR
5066 Specifies that MC firmware is located in NOR flash, mapped as
5067 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5068 virtual address in NOR flash.
5069
wdenkc6097192002-11-03 00:24:07 +00005070Building the Software:
5071======================
5072
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005073Building U-Boot has been tested in several native build environments
5074and in many different cross environments. Of course we cannot support
5075all possibly existing versions of cross development tools in all
5076(potentially obsolete) versions. In case of tool chain problems we
5077recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5078which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005079
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005080If you are not using a native environment, it is assumed that you
5081have GNU cross compiling tools available in your path. In this case,
5082you must set the environment variable CROSS_COMPILE in your shell.
5083Note that no changes to the Makefile or any other source files are
5084necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005085
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005086 $ CROSS_COMPILE=ppc_4xx-
5087 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005088
Peter Tyserb06976d2009-03-13 18:54:51 -05005089Note: If you wish to generate Windows versions of the utilities in
5090 the tools directory you can use the MinGW toolchain
5091 (http://www.mingw.org). Set your HOST tools to the MinGW
5092 toolchain and execute 'make tools'. For example:
5093
5094 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5095
5096 Binaries such as tools/mkimage.exe will be created which can
5097 be executed on computers running Windows.
5098
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005099U-Boot is intended to be simple to build. After installing the
5100sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005101is done by typing:
5102
Holger Freyther7ba4e572014-08-04 09:26:05 +02005103 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005104
Holger Freyther7ba4e572014-08-04 09:26:05 +02005105where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005106rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005107
wdenk6c59edc2004-05-03 20:45:30 +00005108Note: for some board special configuration names may exist; check if
5109 additional information is available from the board vendor; for
5110 instance, the TQM823L systems are available without (standard)
5111 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005112 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005113
Holger Freyther7ba4e572014-08-04 09:26:05 +02005114 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005115 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005116
Holger Freyther7ba4e572014-08-04 09:26:05 +02005117 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005118 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk6c59edc2004-05-03 20:45:30 +00005120 etc.
wdenkc6097192002-11-03 00:24:07 +00005121
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123Finally, type "make all", and you should get some working U-Boot
5124images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk6c59edc2004-05-03 20:45:30 +00005126- "u-boot.bin" is a raw binary image
5127- "u-boot" is an image in ELF binary format
5128- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005129
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005130By default the build is performed locally and the objects are saved
5131in the source directory. One of the two methods can be used to change
5132this behavior and build U-Boot to some external directory:
5133
51341. Add O= to the make command line invocations:
5135
5136 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005137 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005138 make O=/tmp/build all
5139
Timo Ketolac8c67602014-11-06 14:39:05 +020051402. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005141
Timo Ketolac8c67602014-11-06 14:39:05 +02005142 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005143 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005144 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005145 make all
5146
Timo Ketolac8c67602014-11-06 14:39:05 +02005147Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005148variable.
5149
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151Please be aware that the Makefiles assume you are using GNU make, so
5152for instance on NetBSD you might need to use "gmake" instead of
5153native "make".
wdenkc6097192002-11-03 00:24:07 +00005154
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk6c59edc2004-05-03 20:45:30 +00005156If the system board that you have is not listed, then you will need
5157to port U-Boot to your hardware platform. To do this, follow these
5158steps:
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk6c59edc2004-05-03 20:45:30 +000051601. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005161 "boards.cfg" file, using the existing entries as examples.
5162 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000051632. Create a new directory to hold your board specific code. Add any
5164 files you need. In your board directory, you will need at least
5165 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51663. Create a new configuration file "include/configs/<board>.h" for
5167 your board
51683. If you're porting U-Boot to a new CPU, then also create a new
5169 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051704. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051715. Type "make", and you should get a working "u-boot.srec" file
5172 to be installed on your target system.
51736. Debug and solve any problems that might arise.
5174 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005175
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk6c59edc2004-05-03 20:45:30 +00005177Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5178==============================================================
wdenkc6097192002-11-03 00:24:07 +00005179
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005180If you have modified U-Boot sources (for instance added a new board
5181or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005182provide feedback to the other developers. The feedback normally takes
5183the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005184official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005185
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005186But before you submit such a patch, please verify that your modifi-
5187cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005188the supported boards compile WITHOUT ANY compiler warnings. To do so,
5189just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005190for ALL supported system. Be warned, this will take a while. You can
5191select which (cross) compiler to use by passing a `CROSS_COMPILE'
5192environment variable to the script, i. e. to use the ELDK cross tools
5193you can type
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005198
wdenk6c59edc2004-05-03 20:45:30 +00005199 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005200
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005201When using the MAKEALL script, the default behaviour is to build
5202U-Boot in the source directory. This location can be changed by
5203setting the BUILD_DIR environment variable. Also, for each target
5204built, the MAKEALL script saves two log files (<target>.ERR and
5205<target>.MAKEALL) in the <source dir>/LOG directory. This default
5206location can be changed by setting the MAKEALL_LOGDIR environment
5207variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005208
5209 export BUILD_DIR=/tmp/build
5210 export MAKEALL_LOGDIR=/tmp/log
5211 CROSS_COMPILE=ppc_8xx- MAKEALL
5212
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005213With the above settings build objects are saved in the /tmp/build,
5214log files are saved in the /tmp/log and the source tree remains clean
5215during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005216
5217
wdenk6c59edc2004-05-03 20:45:30 +00005218See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005219
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221Monitor Commands - Overview:
5222============================
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk6c59edc2004-05-03 20:45:30 +00005224go - start application at address 'addr'
5225run - run commands in an environment variable
5226bootm - boot application image from memory
5227bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005228bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005229tftpboot- boot image via network using TFTP protocol
5230 and env variables "ipaddr" and "serverip"
5231 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005232tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005233rarpboot- boot image via network using RARP/TFTP protocol
5234diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5235loads - load S-Record file over serial line
5236loadb - load binary file over serial line (kermit mode)
5237md - memory display
5238mm - memory modify (auto-incrementing)
5239nm - memory modify (constant address)
5240mw - memory write (fill)
5241cp - memory copy
5242cmp - memory compare
5243crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005244i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005245sspi - SPI utility commands
5246base - print or set address offset
5247printenv- print environment variables
5248setenv - set environment variables
5249saveenv - save environment variables to persistent storage
5250protect - enable or disable FLASH write protection
5251erase - erase FLASH memory
5252flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005253nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005254bdinfo - print Board Info structure
5255iminfo - print header information for application image
5256coninfo - print console devices and informations
5257ide - IDE sub-system
5258loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005259loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005260mtest - simple RAM test
5261icache - enable or disable instruction cache
5262dcache - enable or disable data cache
5263reset - Perform RESET of the CPU
5264echo - echo args to console
5265version - print monitor version
5266help - print online help
5267? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005268
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270Monitor Commands - Detailed Description:
5271========================================
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk6c59edc2004-05-03 20:45:30 +00005273TODO.
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005276
5277
wdenk6c59edc2004-05-03 20:45:30 +00005278Environment Variables:
5279======================
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281U-Boot supports user configuration using Environment Variables which
5282can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284Environment Variables are set using "setenv", printed using
5285"printenv", and saved to Flash using "saveenv". Using "setenv"
5286without a value can be used to delete a variable from the
5287environment. As long as you don't save the environment you are
5288working with an in-memory copy. In case the Flash area containing the
5289environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005290
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005291Some configuration options can be set using Environment Variables.
5292
5293List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk6c59edc2004-05-03 20:45:30 +00005297 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk6c59edc2004-05-03 20:45:30 +00005299 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk6c59edc2004-05-03 20:45:30 +00005301 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk6c59edc2004-05-03 20:45:30 +00005303 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005304
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005305 bootm_low - Memory range available for image processing in the bootm
5306 command can be restricted. This variable is given as
5307 a hexadecimal number and defines lowest address allowed
5308 for use by the bootm command. See also "bootm_size"
5309 environment variable. Address defined by "bootm_low" is
5310 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005311 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5312 bootm_mapsize.
5313
Wolfgang Denk092ae952011-10-26 10:21:21 +00005314 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005315 This variable is given as a hexadecimal number and it
5316 defines the size of the memory region starting at base
5317 address bootm_low that is accessible by the Linux kernel
5318 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5319 as the default value if it is defined, and bootm_size is
5320 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005321
5322 bootm_size - Memory range available for image processing in the bootm
5323 command can be restricted. This variable is given as
5324 a hexadecimal number and defines the size of the region
5325 allowed for use by the bootm command. See also "bootm_low"
5326 environment variable.
5327
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005328 updatefile - Location of the software update file on a TFTP server, used
5329 by the automatic software update feature. Please refer to
5330 documentation in doc/README.update for more details.
5331
wdenk6c59edc2004-05-03 20:45:30 +00005332 autoload - if set to "no" (any string beginning with 'n'),
5333 "bootp" will just load perform a lookup of the
5334 configuration from the BOOTP server, but not try to
5335 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337 autostart - if set to "yes", an image loaded using the "bootp",
5338 "rarpboot", "tftpboot" or "diskboot" commands will
5339 be automatically started (by internally calling
5340 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005341
wdenk6c59edc2004-05-03 20:45:30 +00005342 If set to "no", a standalone image passed to the
5343 "bootm" command will be copied to the load address
5344 (and eventually uncompressed), but NOT be started.
5345 This can be used to load and uncompress arbitrary
5346 data.
wdenkc6097192002-11-03 00:24:07 +00005347
David A. Longd558a4e2011-07-09 16:40:19 -04005348 fdt_high - if set this restricts the maximum address that the
5349 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005350 For example, if you have a system with 1 GB memory
5351 at physical address 0x10000000, while Linux kernel
5352 only recognizes the first 704 MB as low memory, you
5353 may need to set fdt_high as 0x3C000000 to have the
5354 device tree blob be copied to the maximum address
5355 of the 704 MB low memory, so that Linux kernel can
5356 access it during the boot procedure.
5357
David A. Longd558a4e2011-07-09 16:40:19 -04005358 If this is set to the special value 0xFFFFFFFF then
5359 the fdt will not be copied at all on boot. For this
5360 to work it must reside in writable memory, have
5361 sufficient padding on the end of it for u-boot to
5362 add the information it needs into it, and the memory
5363 must be accessible by the kernel.
5364
Simon Glassdc6fa642011-10-24 19:15:34 +00005365 fdtcontroladdr- if set this is the address of the control flattened
5366 device tree used by U-Boot when CONFIG_OF_CONTROL is
5367 defined.
5368
wdenk0e2bd9c2004-06-06 21:51:03 +00005369 i2cfast - (PPC405GP|PPC405EP only)
5370 if set to 'y' configures Linux I2C driver for fast
5371 mode (400kHZ). This environment variable is used in
5372 initialization code. So, for changes to be effective
5373 it must be saved and board must be reset.
5374
wdenk6c59edc2004-05-03 20:45:30 +00005375 initrd_high - restrict positioning of initrd images:
5376 If this variable is not set, initrd images will be
5377 copied to the highest possible address in RAM; this
5378 is usually what you want since it allows for
5379 maximum initrd size. If for some reason you want to
5380 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005381 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005382 variable to a value of "no" or "off" or "0".
5383 Alternatively, you can set it to a maximum upper
5384 address to use (U-Boot will still check that it
5385 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk6c59edc2004-05-03 20:45:30 +00005387 For instance, when you have a system with 16 MB
5388 RAM, and want to reserve 4 MB from use by Linux,
5389 you can do this by adding "mem=12M" to the value of
5390 the "bootargs" variable. However, now you must make
5391 sure that the initrd image is placed in the first
5392 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005395
wdenk6c59edc2004-05-03 20:45:30 +00005396 If you set initrd_high to 0xFFFFFFFF, this is an
5397 indication to U-Boot that all addresses are legal
5398 for the Linux kernel, including addresses in flash
5399 memory. In this case U-Boot will NOT COPY the
5400 ramdisk at all. This may be useful to reduce the
5401 boot time on your system, but requires that this
5402 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005405
wdenk6c59edc2004-05-03 20:45:30 +00005406 loadaddr - Default load address for commands like "bootp",
5407 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005412
wdenk6c59edc2004-05-03 20:45:30 +00005413 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk6c59edc2004-05-03 20:45:30 +00005415 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005418
Mike Frysingera23230c2011-10-02 10:01:27 +00005419 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005420
Mike Frysingera23230c2011-10-02 10:01:27 +00005421 ethact - controls which interface is currently active.
5422 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005423
Heiko Schocherc5e84052010-07-20 17:45:02 +02005424 => setenv ethact FEC
5425 => ping 192.168.0.1 # traffic sent on FEC
5426 => setenv ethact SCC
5427 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005428
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005429 ethrotate - When set to "no" U-Boot does not go through all
5430 available network interfaces.
5431 It just stays at the currently selected interface.
5432
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005433 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005434 either succeed or fail without retrying.
5435 When set to "once" the network operation will
5436 fail when all the available network interfaces
5437 are tried once without success.
5438 Useful on scripts which control the retry operation
5439 themselves.
wdenkc6097192002-11-03 00:24:07 +00005440
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005441 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005442
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005443 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005444 changing the console to be empty. If "yes" it will be
5445 made silent. If "no" it will not be made silent. If
5446 unset, then it will be made silent if the U-Boot console
5447 is silent.
5448
Wolfgang Denk227b5192005-09-24 23:25:46 +02005449 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005450 UDP source port.
5451
Wolfgang Denk227b5192005-09-24 23:25:46 +02005452 tftpdstport - If this is set, the value is used for TFTP's UDP
5453 destination port instead of the Well Know Port 69.
5454
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005455 tftpblocksize - Block size to use for TFTP transfers; if not set,
5456 we use the TFTP server's default block size
5457
5458 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5459 seconds, minimum value is 1000 = 1 second). Defines
5460 when a packet is considered to be lost so it has to
5461 be retransmitted. The default is 5000 = 5 seconds.
5462 Lowering this value may make downloads succeed
5463 faster in networks with high packet loss rates or
5464 with unreliable TFTP servers.
5465
5466 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005467 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005468 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005469
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005470The following image location variables contain the location of images
5471used in booting. The "Image" column gives the role of the image and is
5472not an environment variable name. The other columns are environment
5473variable names. "File Name" gives the name of the file on a TFTP
5474server, "RAM Address" gives the location in RAM the image will be
5475loaded to, and "Flash Location" gives the image's address in NOR
5476flash or offset in NAND flash.
5477
5478*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005479boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005480boards use these variables for other purposes.
5481
Wolfgang Denk092ae952011-10-26 10:21:21 +00005482Image File Name RAM Address Flash Location
5483----- --------- ----------- --------------
5484u-boot u-boot u-boot_addr_r u-boot_addr
5485Linux kernel bootfile kernel_addr_r kernel_addr
5486device tree blob fdtfile fdt_addr_r fdt_addr
5487ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005488
wdenk6c59edc2004-05-03 20:45:30 +00005489The following environment variables may be used and automatically
5490updated by the network boot commands ("bootp" and "rarpboot"),
5491depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005492
wdenk6c59edc2004-05-03 20:45:30 +00005493 bootfile - see above
5494 dnsip - IP address of your Domain Name Server
5495 dnsip2 - IP address of your secondary Domain Name Server
5496 gatewayip - IP address of the Gateway (Router) to use
5497 hostname - Target hostname
5498 ipaddr - see above
5499 netmask - Subnet Mask
5500 rootpath - Pathname of the root filesystem on the NFS server
5501 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005502
wdenk145d2c12004-04-15 21:48:45 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk6c59edc2004-05-03 20:45:30 +00005506 serial# - contains hardware identification information such
5507 as type string and/or serial number
5508 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005509
wdenk6c59edc2004-05-03 20:45:30 +00005510These variables can be set only once (usually during manufacturing of
5511the board). U-Boot refuses to delete or overwrite these variables
5512once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005513
5514
wdenk6c59edc2004-05-03 20:45:30 +00005515Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517 ver - Contains the U-Boot version string as printed
5518 with the "version" command. This variable is
5519 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005520
wdenkc6097192002-11-03 00:24:07 +00005521
wdenk6c59edc2004-05-03 20:45:30 +00005522Please note that changes to some configuration parameters may take
5523only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005524
stroeseb9c17c52003-04-04 15:53:41 +00005525
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005526Callback functions for environment variables:
5527---------------------------------------------
5528
5529For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005530when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005531be associated with arbitrary variables. On creation, overwrite, or
5532deletion, the callback will provide the opportunity for some side
5533effect to happen or for the change to be rejected.
5534
5535The callbacks are named and associated with a function using the
5536U_BOOT_ENV_CALLBACK macro in your board or driver code.
5537
5538These callbacks are associated with variables in one of two ways. The
5539static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5540in the board configuration to a string that defines a list of
5541associations. The list must be in the following format:
5542
5543 entry = variable_name[:callback_name]
5544 list = entry[,list]
5545
5546If the callback name is not specified, then the callback is deleted.
5547Spaces are also allowed anywhere in the list.
5548
5549Callbacks can also be associated by defining the ".callbacks" variable
5550with the same list format above. Any association in ".callbacks" will
5551override any association in the static list. You can define
5552CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005553".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005554
5555
wdenk6c59edc2004-05-03 20:45:30 +00005556Command Line Parsing:
5557=====================
stroeseb9c17c52003-04-04 15:53:41 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559There are two different command line parsers available with U-Boot:
5560the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk6c59edc2004-05-03 20:45:30 +00005562Old, simple command line parser:
5563--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk6c59edc2004-05-03 20:45:30 +00005565- supports environment variables (through setenv / saveenv commands)
5566- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005567- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005568- special characters ('$', ';') can be escaped by prefixing with '\',
5569 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005570 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005571- You can also escape text by enclosing in single apostrophes, for example:
5572 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574Hush shell:
5575-----------
wdenkf4688a22003-05-28 08:06:31 +00005576
wdenk6c59edc2004-05-03 20:45:30 +00005577- similar to Bourne shell, with control structures like
5578 if...then...else...fi, for...do...done; while...do...done,
5579 until...do...done, ...
5580- supports environment ("global") variables (through setenv / saveenv
5581 commands) and local shell variables (through standard shell syntax
5582 "name=value"); only environment variables can be used with "run"
5583 command
wdenkf4688a22003-05-28 08:06:31 +00005584
wdenk6c59edc2004-05-03 20:45:30 +00005585General rules:
5586--------------
wdenkf4688a22003-05-28 08:06:31 +00005587
wdenk6c59edc2004-05-03 20:45:30 +00005588(1) If a command line (or an environment variable executed by a "run"
5589 command) contains several commands separated by semicolon, and
5590 one of these commands fails, then the remaining commands will be
5591 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005592
wdenk6c59edc2004-05-03 20:45:30 +00005593(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005594 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005595 command will cause "run" to terminate, i. e. the remaining
5596 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005597
wdenk6c59edc2004-05-03 20:45:30 +00005598Note for Redundant Ethernet Interfaces:
5599=======================================
wdenkf4688a22003-05-28 08:06:31 +00005600
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005601Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005602such configurations and is capable of automatic selection of a
5603"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5606MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5607"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005608
wdenk6c59edc2004-05-03 20:45:30 +00005609If the network interface stores some valid MAC address (for instance
5610in SROM), this is used as default address if there is NO correspon-
5611ding setting in the environment; if the corresponding environment
5612variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614o If the SROM has a valid MAC address, and there is no address in the
5615 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617o If there is no valid address in the SROM, and a definition in the
5618 environment exists, then the value from the environment variable is
5619 used.
wdenkc6097192002-11-03 00:24:07 +00005620
wdenk6c59edc2004-05-03 20:45:30 +00005621o If both the SROM and the environment contain a MAC address, and
5622 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624o If both the SROM and the environment contain a MAC address, and the
5625 addresses differ, the value from the environment is used and a
5626 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628o If neither SROM nor the environment contain a MAC address, an error
5629 is raised.
wdenkc6097192002-11-03 00:24:07 +00005630
Ben Warren6db991a2010-04-26 11:11:46 -07005631If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005632will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005633may be skipped by setting the appropriate 'ethmacskip' environment variable.
5634The naming convention is as follows:
5635"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637Image Formats:
5638==============
wdenkc6097192002-11-03 00:24:07 +00005639
Marian Balakowicz18710b82008-03-12 12:13:13 +01005640U-Boot is capable of booting (and performing other auxiliary operations on)
5641images in two formats:
5642
5643New uImage format (FIT)
5644-----------------------
5645
5646Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5647to Flattened Device Tree). It allows the use of images with multiple
5648components (several kernels, ramdisks, etc.), with contents protected by
5649SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5650
5651
5652Old uImage format
5653-----------------
5654
5655Old image format is based on binary files which can be basically anything,
5656preceded by a special header; see the definitions in include/image.h for
5657details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk6c59edc2004-05-03 20:45:30 +00005659* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5660 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005661 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5662 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5663 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005664* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005665 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5666 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005667* Compression Type (uncompressed, gzip, bzip2)
5668* Load Address
5669* Entry Point
5670* Image Name
5671* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005672
wdenk6c59edc2004-05-03 20:45:30 +00005673The header is marked by a special Magic Number, and both the header
5674and the data portions of the image are secured against corruption by
5675CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005676
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678Linux Support:
5679==============
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk6c59edc2004-05-03 20:45:30 +00005681Although U-Boot should support any OS or standalone application
5682easily, the main focus has always been on Linux during the design of
5683U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk6c59edc2004-05-03 20:45:30 +00005685U-Boot includes many features that so far have been part of some
5686special "boot loader" code within the Linux kernel. Also, any
5687"initrd" images to be used are no longer part of one big Linux image;
5688instead, kernel and "initrd" are separate images. This implementation
5689serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005690
wdenk6c59edc2004-05-03 20:45:30 +00005691- the same features can be used for other OS or standalone
5692 applications (for instance: using compressed images to reduce the
5693 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk6c59edc2004-05-03 20:45:30 +00005695- it becomes much easier to port new Linux kernel versions because
5696 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk6c59edc2004-05-03 20:45:30 +00005698- the same Linux kernel image can now be used with different "initrd"
5699 images; of course this also means that different kernel images can
5700 be run with the same "initrd". This makes testing easier (you don't
5701 have to build a new "zImage.initrd" Linux image when you just
5702 change a file in your "initrd"). Also, a field-upgrade of the
5703 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005704
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706Linux HOWTO:
5707============
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709Porting Linux to U-Boot based systems:
5710---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk6c59edc2004-05-03 20:45:30 +00005712U-Boot cannot save you from doing all the necessary modifications to
5713configure the Linux device drivers for use with your target hardware
5714(no, we don't intend to provide a full virtual machine interface to
5715Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005716
Stefan Roese88fbf932010-04-15 16:07:28 +02005717But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk6c59edc2004-05-03 20:45:30 +00005719Just make sure your machine specific header file (for instance
5720include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005721Information structure as we define in include/asm-<arch>/u-boot.h,
5722and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005723as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005724
Simon Glassd097e592014-06-11 23:29:46 -06005725Note that U-Boot now has a driver model, a unified model for drivers.
5726If you are adding a new driver, plumb it into driver model. If there
5727is no uclass available, you are encouraged to create one. See
5728doc/driver-model.
5729
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk6c59edc2004-05-03 20:45:30 +00005731Configuring the Linux kernel:
5732-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734No specific requirements for U-Boot. Make sure you have some root
5735device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005736
wdenkc6097192002-11-03 00:24:07 +00005737
wdenk6c59edc2004-05-03 20:45:30 +00005738Building a Linux Image:
5739-----------------------
wdenkc6097192002-11-03 00:24:07 +00005740
wdenk6c59edc2004-05-03 20:45:30 +00005741With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5742not used. If you use recent kernel source, a new build target
5743"uImage" will exist which automatically builds an image usable by
5744U-Boot. Most older kernels also have support for a "pImage" target,
5745which was introduced for our predecessor project PPCBoot and uses a
5746100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748Example:
wdenkc6097192002-11-03 00:24:07 +00005749
Holger Freyther7ba4e572014-08-04 09:26:05 +02005750 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005751 make oldconfig
5752 make dep
5753 make uImage
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755The "uImage" build target uses a special tool (in 'tools/mkimage') to
5756encapsulate a compressed Linux kernel image with header information,
5757CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005758
wdenk6c59edc2004-05-03 20:45:30 +00005759* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005760
wdenk6c59edc2004-05-03 20:45:30 +00005761* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763 ${CROSS_COMPILE}-objcopy -O binary \
5764 -R .note -R .comment \
5765 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005770
wdenk6c59edc2004-05-03 20:45:30 +00005771* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005772
wdenk6c59edc2004-05-03 20:45:30 +00005773 mkimage -A ppc -O linux -T kernel -C gzip \
5774 -a 0 -e 0 -n "Linux Kernel Image" \
5775 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005776
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk6c59edc2004-05-03 20:45:30 +00005778The "mkimage" tool can also be used to create ramdisk images for use
5779with U-Boot, either separated from the Linux kernel image, or
5780combined into one file. "mkimage" encapsulates the images with a 64
5781byte header containing information about target architecture,
5782operating system, image type, compression method, entry points, time
5783stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk6c59edc2004-05-03 20:45:30 +00005785"mkimage" can be called in two ways: to verify existing images and
5786print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005787
wdenk6c59edc2004-05-03 20:45:30 +00005788In the first form (with "-l" option) mkimage lists the information
5789contained in the header of an existing U-Boot image; this includes
5790checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792 tools/mkimage -l image
5793 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005794
wdenk6c59edc2004-05-03 20:45:30 +00005795The second form (with "-d" option) is used to build a U-Boot image
5796from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005797
wdenk6c59edc2004-05-03 20:45:30 +00005798 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5799 -n name -d data_file image
5800 -A ==> set architecture to 'arch'
5801 -O ==> set operating system to 'os'
5802 -T ==> set image type to 'type'
5803 -C ==> set compression type 'comp'
5804 -a ==> set load address to 'addr' (hex)
5805 -e ==> set entry point to 'ep' (hex)
5806 -n ==> set image name to 'name'
5807 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005808
wdenkcd914452004-05-29 16:53:29 +00005809Right now, all Linux kernels for PowerPC systems use the same load
5810address (0x00000000), but the entry point address depends on the
5811kernel version:
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813- 2.2.x kernels have the entry point at 0x0000000C,
5814- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005817
wdenk6c59edc2004-05-03 20:45:30 +00005818 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5819 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005820 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005821 > examples/uImage.TQM850L
5822 Image Name: 2.4.4 kernel for TQM850L
5823 Created: Wed Jul 19 02:34:59 2000
5824 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5825 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5826 Load Address: 0x00000000
5827 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005828
wdenk6c59edc2004-05-03 20:45:30 +00005829To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831 -> tools/mkimage -l examples/uImage.TQM850L
5832 Image Name: 2.4.4 kernel for TQM850L
5833 Created: Wed Jul 19 02:34:59 2000
5834 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5835 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5836 Load Address: 0x00000000
5837 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005838
wdenk6c59edc2004-05-03 20:45:30 +00005839NOTE: for embedded systems where boot time is critical you can trade
5840speed for memory and install an UNCOMPRESSED image instead: this
5841needs more space in Flash, but boots much faster since it does not
5842need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005843
Stefan Roese88fbf932010-04-15 16:07:28 +02005844 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005845 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5846 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005847 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005848 > examples/uImage.TQM850L-uncompressed
5849 Image Name: 2.4.4 kernel for TQM850L
5850 Created: Wed Jul 19 02:34:59 2000
5851 Image Type: PowerPC Linux Kernel Image (uncompressed)
5852 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5853 Load Address: 0x00000000
5854 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005855
wdenkc6097192002-11-03 00:24:07 +00005856
wdenk6c59edc2004-05-03 20:45:30 +00005857Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5858when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005859
wdenk6c59edc2004-05-03 20:45:30 +00005860 -> tools/mkimage -n 'Simple Ramdisk Image' \
5861 > -A ppc -O linux -T ramdisk -C gzip \
5862 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5863 Image Name: Simple Ramdisk Image
5864 Created: Wed Jan 12 14:01:50 2000
5865 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5866 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5867 Load Address: 0x00000000
5868 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005869
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005870The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5871option performs the converse operation of the mkimage's second form (the "-d"
5872option). Given an image built by mkimage, the dumpimage extracts a "data file"
5873from the image:
5874
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005875 tools/dumpimage -i image -T type -p position data_file
5876 -i ==> extract from the 'image' a specific 'data_file'
5877 -T ==> set image type to 'type'
5878 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005879
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881Installing a Linux Image:
5882-------------------------
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk6c59edc2004-05-03 20:45:30 +00005884To downloading a U-Boot image over the serial (console) interface,
5885you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005886
wdenk6c59edc2004-05-03 20:45:30 +00005887 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005888
wdenk6c59edc2004-05-03 20:45:30 +00005889The 'objcopy' does not understand the information in the U-Boot
5890image header, so the resulting S-Record file will be relative to
5891address 0x00000000. To load it to a given address, you need to
5892specify the target address as 'offset' parameter with the 'loads'
5893command.
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk6c59edc2004-05-03 20:45:30 +00005895Example: install the image to address 0x40100000 (which on the
5896TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005897
wdenk6c59edc2004-05-03 20:45:30 +00005898 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk6c59edc2004-05-03 20:45:30 +00005900 .......... done
5901 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005902
wdenk6c59edc2004-05-03 20:45:30 +00005903 => loads 40100000
5904 ## Ready for S-Record download ...
5905 ~>examples/image.srec
5906 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5907 ...
5908 15989 15990 15991 15992
5909 [file transfer complete]
5910 [connected]
5911 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005912
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005915this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005916corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005917
wdenk6c59edc2004-05-03 20:45:30 +00005918 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005919
wdenk6c59edc2004-05-03 20:45:30 +00005920 ## Checking Image at 40100000 ...
5921 Image Name: 2.2.13 for initrd on TQM850L
5922 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5923 Data Size: 335725 Bytes = 327 kB = 0 MB
5924 Load Address: 00000000
5925 Entry Point: 0000000c
5926 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005927
5928
wdenk6c59edc2004-05-03 20:45:30 +00005929Boot Linux:
5930-----------
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932The "bootm" command is used to boot an application that is stored in
5933memory (RAM or Flash). In case of a Linux kernel image, the contents
5934of the "bootargs" environment variable is passed to the kernel as
5935parameters. You can check and modify this variable using the
5936"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005937
wdenkc6097192002-11-03 00:24:07 +00005938
wdenk6c59edc2004-05-03 20:45:30 +00005939 => printenv bootargs
5940 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005941
wdenk6c59edc2004-05-03 20:45:30 +00005942 => 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 +00005943
wdenk6c59edc2004-05-03 20:45:30 +00005944 => printenv bootargs
5945 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 +00005946
wdenk6c59edc2004-05-03 20:45:30 +00005947 => bootm 40020000
5948 ## Booting Linux kernel at 40020000 ...
5949 Image Name: 2.2.13 for NFS on TQM850L
5950 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5951 Data Size: 381681 Bytes = 372 kB = 0 MB
5952 Load Address: 00000000
5953 Entry Point: 0000000c
5954 Verifying Checksum ... OK
5955 Uncompressing Kernel Image ... OK
5956 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
5957 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5958 time_init: decrementer frequency = 187500000/60
5959 Calibrating delay loop... 49.77 BogoMIPS
5960 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5961 ...
wdenkc6097192002-11-03 00:24:07 +00005962
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005963If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005964the memory addresses of both the kernel and the initrd image (PPBCOOT
5965format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005966
wdenk6c59edc2004-05-03 20:45:30 +00005967 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005968
wdenk6c59edc2004-05-03 20:45:30 +00005969 ## Checking Image at 40100000 ...
5970 Image Name: 2.2.13 for initrd on TQM850L
5971 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5972 Data Size: 335725 Bytes = 327 kB = 0 MB
5973 Load Address: 00000000
5974 Entry Point: 0000000c
5975 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005976
wdenk6c59edc2004-05-03 20:45:30 +00005977 ## Checking Image at 40200000 ...
5978 Image Name: Simple Ramdisk Image
5979 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5980 Data Size: 566530 Bytes = 553 kB = 0 MB
5981 Load Address: 00000000
5982 Entry Point: 00000000
5983 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk6c59edc2004-05-03 20:45:30 +00005985 => bootm 40100000 40200000
5986 ## Booting Linux kernel at 40100000 ...
5987 Image Name: 2.2.13 for initrd on TQM850L
5988 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5989 Data Size: 335725 Bytes = 327 kB = 0 MB
5990 Load Address: 00000000
5991 Entry Point: 0000000c
5992 Verifying Checksum ... OK
5993 Uncompressing Kernel Image ... OK
5994 ## Loading RAMDisk Image at 40200000 ...
5995 Image Name: Simple Ramdisk Image
5996 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5997 Data Size: 566530 Bytes = 553 kB = 0 MB
5998 Load Address: 00000000
5999 Entry Point: 00000000
6000 Verifying Checksum ... OK
6001 Loading Ramdisk ... OK
6002 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
6003 Boot arguments: root=/dev/ram
6004 time_init: decrementer frequency = 187500000/60
6005 Calibrating delay loop... 49.77 BogoMIPS
6006 ...
6007 RAMDISK: Compressed image found at block 0
6008 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006009
wdenk6c59edc2004-05-03 20:45:30 +00006010 bash#
wdenkc6097192002-11-03 00:24:07 +00006011
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006012Boot Linux and pass a flat device tree:
6013-----------
6014
6015First, U-Boot must be compiled with the appropriate defines. See the section
6016titled "Linux Kernel Interface" above for a more in depth explanation. The
6017following is an example of how to start a kernel and pass an updated
6018flat device tree:
6019
6020=> print oftaddr
6021oftaddr=0x300000
6022=> print oft
6023oft=oftrees/mpc8540ads.dtb
6024=> tftp $oftaddr $oft
6025Speed: 1000, full duplex
6026Using TSEC0 device
6027TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6028Filename 'oftrees/mpc8540ads.dtb'.
6029Load address: 0x300000
6030Loading: #
6031done
6032Bytes transferred = 4106 (100a hex)
6033=> tftp $loadaddr $bootfile
6034Speed: 1000, full duplex
6035Using TSEC0 device
6036TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6037Filename 'uImage'.
6038Load address: 0x200000
6039Loading:############
6040done
6041Bytes transferred = 1029407 (fb51f hex)
6042=> print loadaddr
6043loadaddr=200000
6044=> print oftaddr
6045oftaddr=0x300000
6046=> bootm $loadaddr - $oftaddr
6047## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006048 Image Name: Linux-2.6.17-dirty
6049 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6050 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006051 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006052 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006053 Verifying Checksum ... OK
6054 Uncompressing Kernel Image ... OK
6055Booting using flat device tree at 0x300000
6056Using MPC85xx ADS machine description
6057Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6058[snip]
6059
6060
wdenk6c59edc2004-05-03 20:45:30 +00006061More About U-Boot Image Types:
6062------------------------------
wdenkc6097192002-11-03 00:24:07 +00006063
wdenk6c59edc2004-05-03 20:45:30 +00006064U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006065
wdenk6c59edc2004-05-03 20:45:30 +00006066 "Standalone Programs" are directly runnable in the environment
6067 provided by U-Boot; it is expected that (if they behave
6068 well) you can continue to work in U-Boot after return from
6069 the Standalone Program.
6070 "OS Kernel Images" are usually images of some Embedded OS which
6071 will take over control completely. Usually these programs
6072 will install their own set of exception handlers, device
6073 drivers, set up the MMU, etc. - this means, that you cannot
6074 expect to re-enter U-Boot except by resetting the CPU.
6075 "RAMDisk Images" are more or less just data blocks, and their
6076 parameters (address, size) are passed to an OS kernel that is
6077 being started.
6078 "Multi-File Images" contain several images, typically an OS
6079 (Linux) kernel image and one or more data images like
6080 RAMDisks. This construct is useful for instance when you want
6081 to boot over the network using BOOTP etc., where the boot
6082 server provides just a single image file, but you want to get
6083 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006084
wdenk6c59edc2004-05-03 20:45:30 +00006085 "Multi-File Images" start with a list of image sizes, each
6086 image size (in bytes) specified by an "uint32_t" in network
6087 byte order. This list is terminated by an "(uint32_t)0".
6088 Immediately after the terminating 0 follow the images, one by
6089 one, all aligned on "uint32_t" boundaries (size rounded up to
6090 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006091
wdenk6c59edc2004-05-03 20:45:30 +00006092 "Firmware Images" are binary images containing firmware (like
6093 U-Boot or FPGA images) which usually will be programmed to
6094 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006095
wdenk6c59edc2004-05-03 20:45:30 +00006096 "Script files" are command sequences that will be executed by
6097 U-Boot's command interpreter; this feature is especially
6098 useful when you configure U-Boot to use a real shell (hush)
6099 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006100
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006101Booting the Linux zImage:
6102-------------------------
6103
6104On some platforms, it's possible to boot Linux zImage. This is done
6105using the "bootz" command. The syntax of "bootz" command is the same
6106as the syntax of "bootm" command.
6107
Tom Rini45f46d12013-05-16 11:40:11 -04006108Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006109kernel with raw initrd images. The syntax is slightly different, the
6110address of the initrd must be augmented by it's size, in the following
6111format: "<initrd addres>:<initrd size>".
6112
stroeseb9c17c52003-04-04 15:53:41 +00006113
wdenk6c59edc2004-05-03 20:45:30 +00006114Standalone HOWTO:
6115=================
stroeseb9c17c52003-04-04 15:53:41 +00006116
wdenk6c59edc2004-05-03 20:45:30 +00006117One of the features of U-Boot is that you can dynamically load and
6118run "standalone" applications, which can use some resources of
6119U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006120
wdenk6c59edc2004-05-03 20:45:30 +00006121Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006122
wdenk6c59edc2004-05-03 20:45:30 +00006123"Hello World" Demo:
6124-------------------
wdenkc6097192002-11-03 00:24:07 +00006125
wdenk6c59edc2004-05-03 20:45:30 +00006126'examples/hello_world.c' contains a small "Hello World" Demo
6127application; it is automatically compiled when you build U-Boot.
6128It's configured to run at address 0x00040004, so you can play with it
6129like that:
wdenkc6097192002-11-03 00:24:07 +00006130
wdenk6c59edc2004-05-03 20:45:30 +00006131 => loads
6132 ## Ready for S-Record download ...
6133 ~>examples/hello_world.srec
6134 1 2 3 4 5 6 7 8 9 10 11 ...
6135 [file transfer complete]
6136 [connected]
6137 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006138
wdenk6c59edc2004-05-03 20:45:30 +00006139 => go 40004 Hello World! This is a test.
6140 ## Starting application at 0x00040004 ...
6141 Hello World
6142 argc = 7
6143 argv[0] = "40004"
6144 argv[1] = "Hello"
6145 argv[2] = "World!"
6146 argv[3] = "This"
6147 argv[4] = "is"
6148 argv[5] = "a"
6149 argv[6] = "test."
6150 argv[7] = "<NULL>"
6151 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006152
wdenk6c59edc2004-05-03 20:45:30 +00006153 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006154
wdenk6c59edc2004-05-03 20:45:30 +00006155Another example, which demonstrates how to register a CPM interrupt
6156handler with the U-Boot code, can be found in 'examples/timer.c'.
6157Here, a CPM timer is set up to generate an interrupt every second.
6158The interrupt service routine is trivial, just printing a '.'
6159character, but this is just a demo program. The application can be
6160controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006161
wdenk6c59edc2004-05-03 20:45:30 +00006162 ? - print current values og the CPM Timer registers
6163 b - enable interrupts and start timer
6164 e - stop timer and disable interrupts
6165 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006166
wdenk6c59edc2004-05-03 20:45:30 +00006167 => loads
6168 ## Ready for S-Record download ...
6169 ~>examples/timer.srec
6170 1 2 3 4 5 6 7 8 9 10 11 ...
6171 [file transfer complete]
6172 [connected]
6173 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006174
wdenk6c59edc2004-05-03 20:45:30 +00006175 => go 40004
6176 ## Starting application at 0x00040004 ...
6177 TIMERS=0xfff00980
6178 Using timer 1
6179 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006180
wdenk6c59edc2004-05-03 20:45:30 +00006181Hit 'b':
6182 [q, b, e, ?] Set interval 1000000 us
6183 Enabling timer
6184Hit '?':
6185 [q, b, e, ?] ........
6186 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6187Hit '?':
6188 [q, b, e, ?] .
6189 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6190Hit '?':
6191 [q, b, e, ?] .
6192 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6193Hit '?':
6194 [q, b, e, ?] .
6195 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6196Hit 'e':
6197 [q, b, e, ?] ...Stopping timer
6198Hit 'q':
6199 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006200
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk6c59edc2004-05-03 20:45:30 +00006202Minicom warning:
6203================
wdenkc6097192002-11-03 00:24:07 +00006204
wdenk6c59edc2004-05-03 20:45:30 +00006205Over time, many people have reported problems when trying to use the
6206"minicom" terminal emulation program for serial download. I (wd)
6207consider minicom to be broken, and recommend not to use it. Under
6208Unix, I recommend to use C-Kermit for general purpose use (and
6209especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006210use "cu" for S-Record download ("loads" command). See
6211http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6212for help with kermit.
6213
wdenkc6097192002-11-03 00:24:07 +00006214
wdenk6c59edc2004-05-03 20:45:30 +00006215Nevertheless, if you absolutely want to use it try adding this
6216configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006217
wdenk6c59edc2004-05-03 20:45:30 +00006218 Name Program Name U/D FullScr IO-Red. Multi
6219 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6220 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006221
wdenk8dba0502003-03-31 16:34:49 +00006222
wdenk6c59edc2004-05-03 20:45:30 +00006223NetBSD Notes:
6224=============
wdenkc6097192002-11-03 00:24:07 +00006225
wdenk6c59edc2004-05-03 20:45:30 +00006226Starting at version 0.9.2, U-Boot supports NetBSD both as host
6227(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006228
wdenk6c59edc2004-05-03 20:45:30 +00006229Building requires a cross environment; it is known to work on
6230NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6231need gmake since the Makefiles are not compatible with BSD make).
6232Note that the cross-powerpc package does not install include files;
6233attempting to build U-Boot will fail because <machine/ansi.h> is
6234missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006235
wdenk6c59edc2004-05-03 20:45:30 +00006236 # cd /usr/pkg/cross/powerpc-netbsd/include
6237 # mkdir powerpc
6238 # ln -s powerpc machine
6239 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6240 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006241
wdenk6c59edc2004-05-03 20:45:30 +00006242Native builds *don't* work due to incompatibilities between native
6243and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006244
wdenk6c59edc2004-05-03 20:45:30 +00006245Booting assumes that (the first part of) the image booted is a
6246stage-2 loader which in turn loads and then invokes the kernel
6247proper. Loader sources will eventually appear in the NetBSD source
6248tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006249meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006250
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk6c59edc2004-05-03 20:45:30 +00006252Implementation Internals:
6253=========================
wdenkc6097192002-11-03 00:24:07 +00006254
wdenk6c59edc2004-05-03 20:45:30 +00006255The following is not intended to be a complete description of every
6256implementation detail. However, it should help to understand the
6257inner workings of U-Boot and make it easier to port it to custom
6258hardware.
wdenkc6097192002-11-03 00:24:07 +00006259
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk6c59edc2004-05-03 20:45:30 +00006261Initial Stack, Global Data:
6262---------------------------
wdenkc6097192002-11-03 00:24:07 +00006263
wdenk6c59edc2004-05-03 20:45:30 +00006264The implementation of U-Boot is complicated by the fact that U-Boot
6265starts running out of ROM (flash memory), usually without access to
6266system RAM (because the memory controller is not initialized yet).
6267This means that we don't have writable Data or BSS segments, and BSS
6268is not initialized as zero. To be able to get a C environment working
6269at all, we have to allocate at least a minimal stack. Implementation
6270options for this are defined and restricted by the CPU used: Some CPU
6271models provide on-chip memory (like the IMMR area on MPC8xx and
6272MPC826x processors), on others (parts of) the data cache can be
6273locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006274
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006275 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006276 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006277
wdenk6c59edc2004-05-03 20:45:30 +00006278 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6279 From: "Chris Hallinan" <clh@net1plus.com>
6280 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6281 ...
wdenkc6097192002-11-03 00:24:07 +00006282
wdenk6c59edc2004-05-03 20:45:30 +00006283 Correct me if I'm wrong, folks, but the way I understand it
6284 is this: Using DCACHE as initial RAM for Stack, etc, does not
6285 require any physical RAM backing up the cache. The cleverness
6286 is that the cache is being used as a temporary supply of
6287 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006288 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006289 can see how this works by studying the cache architecture and
6290 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006291
wdenk6c59edc2004-05-03 20:45:30 +00006292 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6293 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006294 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006295 option should work for you. Using CS 4 should be fine if your
6296 board designers haven't used it for something that would
6297 cause you grief during the initial boot! It is frequently not
6298 used.
wdenkc6097192002-11-03 00:24:07 +00006299
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006300 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006301 with your processor/board/system design. The default value
6302 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006303 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006304 than your SDRAM module. If you have a 64MB SDRAM module, set
6305 it above 400_0000. Just make sure your board has no resources
6306 that are supposed to respond to that address! That code in
6307 start.S has been around a while and should work as is when
6308 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006309
wdenk6c59edc2004-05-03 20:45:30 +00006310 -Chris Hallinan
6311 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006312
wdenk6c59edc2004-05-03 20:45:30 +00006313It is essential to remember this, since it has some impact on the C
6314code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006315
wdenk6c59edc2004-05-03 20:45:30 +00006316* Initialized global data (data segment) is read-only. Do not attempt
6317 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006318
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006319* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006320 as zero data - BSS segment) at all - this is undefined, initiali-
6321 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006322
wdenk6c59edc2004-05-03 20:45:30 +00006323* Stack space is very limited. Avoid big data buffers or things like
6324 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006325
wdenk6c59edc2004-05-03 20:45:30 +00006326Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006327normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006328turned out that the implementation of U-Boot can be greatly
6329simplified by making a global data structure (gd_t) available to all
6330functions. We could pass a pointer to this data as argument to _all_
6331functions, but this would bloat the code. Instead we use a feature of
6332the GCC compiler (Global Register Variables) to share the data: we
6333place a pointer (gd) to the global data into a register which we
6334reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006335
wdenk6c59edc2004-05-03 20:45:30 +00006336When choosing a register for such a purpose we are restricted by the
6337relevant (E)ABI specifications for the current architecture, and by
6338GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006339
wdenk6c59edc2004-05-03 20:45:30 +00006340For PowerPC, the following registers have specific use:
6341 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006342 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006343 R3-R4: parameter passing and return values
6344 R5-R10: parameter passing
6345 R13: small data area pointer
6346 R30: GOT pointer
6347 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006348
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006349 (U-Boot also uses R12 as internal GOT pointer. r12
6350 is a volatile register so r12 needs to be reset when
6351 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006352
Wolfgang Denk69c09642008-02-14 22:43:22 +01006353 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006354
wdenk6c59edc2004-05-03 20:45:30 +00006355 Note: on PPC, we could use a static initializer (since the
6356 address of the global data structure is known at compile time),
6357 but it turned out that reserving a register results in somewhat
6358 smaller code - although the code savings are not that big (on
6359 average for all boards 752 bytes for the whole U-Boot image,
6360 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006361
Robin Getz2773d5f2009-08-17 15:23:02 +00006362On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006363 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6364
Robin Getz2773d5f2009-08-17 15:23:02 +00006365 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006366
wdenk6c59edc2004-05-03 20:45:30 +00006367On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006368
wdenk6c59edc2004-05-03 20:45:30 +00006369 R0: function argument word/integer result
6370 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006371 R9: platform specific
6372 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006373 R11: argument (frame) pointer
6374 R12: temporary workspace
6375 R13: stack pointer
6376 R14: link register
6377 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006378
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006379 ==> U-Boot will use R9 to hold a pointer to the global data
6380
6381 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006382
Thomas Chou8fa38582010-05-21 11:08:03 +08006383On Nios II, the ABI is documented here:
6384 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6385
6386 ==> U-Boot will use gp to hold a pointer to the global data
6387
6388 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6389 to access small data sections, so gp is free.
6390
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006391On NDS32, the following registers are used:
6392
6393 R0-R1: argument/return
6394 R2-R5: argument
6395 R15: temporary register for assembler
6396 R16: trampoline register
6397 R28: frame pointer (FP)
6398 R29: global pointer (GP)
6399 R30: link register (LP)
6400 R31: stack pointer (SP)
6401 PC: program counter (PC)
6402
6403 ==> U-Boot will use R10 to hold a pointer to the global data
6404
Wolfgang Denk6405a152006-03-31 18:32:53 +02006405NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6406or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006407
wdenk6c59edc2004-05-03 20:45:30 +00006408Memory Management:
6409------------------
wdenkc6097192002-11-03 00:24:07 +00006410
wdenk6c59edc2004-05-03 20:45:30 +00006411U-Boot runs in system state and uses physical addresses, i.e. the
6412MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006413
wdenk6c59edc2004-05-03 20:45:30 +00006414The available memory is mapped to fixed addresses using the memory
6415controller. In this process, a contiguous block is formed for each
6416memory type (Flash, SDRAM, SRAM), even when it consists of several
6417physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006418
wdenk6c59edc2004-05-03 20:45:30 +00006419U-Boot is installed in the first 128 kB of the first Flash bank (on
6420TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6421booting and sizing and initializing DRAM, the code relocates itself
6422to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006423memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006424configuration setting]. Below that, a structure with global Board
6425Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006426
wdenk6c59edc2004-05-03 20:45:30 +00006427Additionally, some exception handler code is copied to the low 8 kB
6428of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006429
wdenk6c59edc2004-05-03 20:45:30 +00006430So a typical memory configuration with 16 MB of DRAM could look like
6431this:
wdenkc6097192002-11-03 00:24:07 +00006432
wdenk6c59edc2004-05-03 20:45:30 +00006433 0x0000 0000 Exception Vector code
6434 :
6435 0x0000 1FFF
6436 0x0000 2000 Free for Application Use
6437 :
6438 :
wdenkc6097192002-11-03 00:24:07 +00006439
wdenk6c59edc2004-05-03 20:45:30 +00006440 :
6441 :
6442 0x00FB FF20 Monitor Stack (Growing downward)
6443 0x00FB FFAC Board Info Data and permanent copy of global data
6444 0x00FC 0000 Malloc Arena
6445 :
6446 0x00FD FFFF
6447 0x00FE 0000 RAM Copy of Monitor Code
6448 ... eventually: LCD or video framebuffer
6449 ... eventually: pRAM (Protected RAM - unchanged by reset)
6450 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006451
wdenkc6097192002-11-03 00:24:07 +00006452
wdenk6c59edc2004-05-03 20:45:30 +00006453System Initialization:
6454----------------------
wdenkc6097192002-11-03 00:24:07 +00006455
wdenk6c59edc2004-05-03 20:45:30 +00006456In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006457(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006458configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006459To be able to re-map memory U-Boot then jumps to its link address.
6460To be able to implement the initialization code in C, a (small!)
6461initial stack is set up in the internal Dual Ported RAM (in case CPUs
6462which provide such a feature like MPC8xx or MPC8260), or in a locked
6463part of the data cache. After that, U-Boot initializes the CPU core,
6464the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006465
wdenk6c59edc2004-05-03 20:45:30 +00006466Next, all (potentially) available memory banks are mapped using a
6467preliminary mapping. For example, we put them on 512 MB boundaries
6468(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6469on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6470programmed for SDRAM access. Using the temporary configuration, a
6471simple memory test is run that determines the size of the SDRAM
6472banks.
wdenkc6097192002-11-03 00:24:07 +00006473
wdenk6c59edc2004-05-03 20:45:30 +00006474When there is more than one SDRAM bank, and the banks are of
6475different size, the largest is mapped first. For equal size, the first
6476bank (CS2#) is mapped first. The first mapping is always for address
64770x00000000, with any additional banks following immediately to create
6478contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006479
wdenk6c59edc2004-05-03 20:45:30 +00006480Then, the monitor installs itself at the upper end of the SDRAM area
6481and allocates memory for use by malloc() and for the global Board
6482Info data; also, the exception vector code is copied to the low RAM
6483pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006484
wdenk6c59edc2004-05-03 20:45:30 +00006485Only after this relocation will you have a "normal" C environment;
6486until that you are restricted in several ways, mostly because you are
6487running from ROM, and because the code will have to be relocated to a
6488new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006489
wdenkc6097192002-11-03 00:24:07 +00006490
wdenk6c59edc2004-05-03 20:45:30 +00006491U-Boot Porting Guide:
6492----------------------
wdenkc6097192002-11-03 00:24:07 +00006493
wdenk6c59edc2004-05-03 20:45:30 +00006494[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6495list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006496
wdenkc6097192002-11-03 00:24:07 +00006497
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006498int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006499{
6500 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006501
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006502 signal(SIGALRM, no_more_time);
6503 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006504
wdenk6c59edc2004-05-03 20:45:30 +00006505 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006506 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006507 return 0;
6508 }
wdenkc6097192002-11-03 00:24:07 +00006509
wdenk6c59edc2004-05-03 20:45:30 +00006510 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006511
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006512 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006513
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006514 if (clueless)
6515 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006516
wdenk6c59edc2004-05-03 20:45:30 +00006517 while (learning) {
6518 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006519 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6520 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006521 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006522 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006523 }
wdenkc6097192002-11-03 00:24:07 +00006524
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006525 if (available_money > toLocalCurrency ($2500))
6526 Buy a BDI3000;
6527 else
wdenk6c59edc2004-05-03 20:45:30 +00006528 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006529
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006530 if (a similar board exists) { /* hopefully... */
6531 cp -a board/<similar> board/<myboard>
6532 cp include/configs/<similar>.h include/configs/<myboard>.h
6533 } else {
6534 Create your own board support subdirectory;
6535 Create your own board include/configs/<myboard>.h file;
6536 }
6537 Edit new board/<myboard> files
6538 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006539
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006540 while (!accepted) {
6541 while (!running) {
6542 do {
6543 Add / modify source code;
6544 } until (compiles);
6545 Debug;
6546 if (clueless)
6547 email("Hi, I am having problems...");
6548 }
6549 Send patch file to the U-Boot email list;
6550 if (reasonable critiques)
6551 Incorporate improvements from email list code review;
6552 else
6553 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006554 }
wdenkc6097192002-11-03 00:24:07 +00006555
wdenk6c59edc2004-05-03 20:45:30 +00006556 return 0;
6557}
wdenkc6097192002-11-03 00:24:07 +00006558
wdenk6c59edc2004-05-03 20:45:30 +00006559void no_more_time (int sig)
6560{
6561 hire_a_guru();
6562}
wdenkc6097192002-11-03 00:24:07 +00006563
wdenkc6097192002-11-03 00:24:07 +00006564
wdenk6c59edc2004-05-03 20:45:30 +00006565Coding Standards:
6566-----------------
wdenkc6097192002-11-03 00:24:07 +00006567
wdenk6c59edc2004-05-03 20:45:30 +00006568All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006569coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006570"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006571
6572Source files originating from a different project (for example the
6573MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006574reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006575sources.
wdenkc6097192002-11-03 00:24:07 +00006576
Detlev Zundelaa63d482006-09-01 15:39:02 +02006577Please note that U-Boot is implemented in C (and to some small parts in
6578Assembler); no C++ is used, so please do not use C++ style comments (//)
6579in your code.
wdenkad276f22004-01-04 16:28:35 +00006580
wdenk6c59edc2004-05-03 20:45:30 +00006581Please also stick to the following formatting rules:
6582- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006583- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006584- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006585- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006586- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006587
wdenk6c59edc2004-05-03 20:45:30 +00006588Submissions which do not conform to the standards may be returned
6589with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006590
wdenkc6097192002-11-03 00:24:07 +00006591
wdenk6c59edc2004-05-03 20:45:30 +00006592Submitting Patches:
6593-------------------
wdenkc6097192002-11-03 00:24:07 +00006594
wdenk6c59edc2004-05-03 20:45:30 +00006595Since the number of patches for U-Boot is growing, we need to
6596establish some rules. Submissions which do not conform to these rules
6597may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006598
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006599Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006600
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006601Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6602see http://lists.denx.de/mailman/listinfo/u-boot
6603
wdenk6c59edc2004-05-03 20:45:30 +00006604When you send a patch, please include the following information with
6605it:
wdenkc6097192002-11-03 00:24:07 +00006606
wdenk6c59edc2004-05-03 20:45:30 +00006607* For bug fixes: a description of the bug and how your patch fixes
6608 this bug. Please try to include a way of demonstrating that the
6609 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006610
wdenk6c59edc2004-05-03 20:45:30 +00006611* For new features: a description of the feature and your
6612 implementation.
wdenkc6097192002-11-03 00:24:07 +00006613
wdenk6c59edc2004-05-03 20:45:30 +00006614* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006615
wdenk6c59edc2004-05-03 20:45:30 +00006616* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006617
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006618* When you add support for a new board, don't forget to add a
6619 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006620
wdenk6c59edc2004-05-03 20:45:30 +00006621* If your patch adds new configuration options, don't forget to
6622 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006623
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006624* The patch itself. If you are using git (which is *strongly*
6625 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006626 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006627 the U-Boot mailing list, you will avoid most of the common problems
6628 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006629
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006630 If you cannot use git, use "diff -purN OLD NEW". If your version of
6631 diff does not support these options, then get the latest version of
6632 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006633
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006634 The current directory when running this command shall be the parent
6635 directory of the U-Boot source tree (i. e. please make sure that
6636 your patch includes sufficient directory information for the
6637 affected files).
6638
6639 We prefer patches as plain text. MIME attachments are discouraged,
6640 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006641
wdenk6c59edc2004-05-03 20:45:30 +00006642* If one logical set of modifications affects or creates several
6643 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006644
wdenk6c59edc2004-05-03 20:45:30 +00006645* Changesets that contain different, unrelated modifications shall be
6646 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006647
wdenkc6097192002-11-03 00:24:07 +00006648
wdenk6c59edc2004-05-03 20:45:30 +00006649Notes:
wdenkc6097192002-11-03 00:24:07 +00006650
wdenk6c59edc2004-05-03 20:45:30 +00006651* Before sending the patch, run the MAKEALL script on your patched
6652 source tree and make sure that no errors or warnings are reported
6653 for any of the boards.
6654
6655* Keep your modifications to the necessary minimum: A patch
6656 containing several unrelated changes or arbitrary reformats will be
6657 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006658
wdenk6c59edc2004-05-03 20:45:30 +00006659* If you modify existing code, make sure that your new code does not
6660 add to the memory footprint of the code ;-) Small is beautiful!
6661 When adding new features, these should compile conditionally only
6662 (using #ifdef), and the resulting code with the new feature
6663 disabled must not need more memory than the old code without your
6664 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006665
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006666* Remember that there is a size limit of 100 kB per message on the
6667 u-boot mailing list. Bigger patches will be moderated. If they are
6668 reasonable and not too big, they will be acknowledged. But patches
6669 bigger than the size limit should be avoided.