blob: c13a38339bae5531787f47b987f36e4ec378bbd4 [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
wdenkc6097192002-11-03 00:24:07 +0000980 CONFIG_ZERO_BOOTDELAY_CHECK
981 CONFIG_RESET_TO_RETRY
982
983- Autoboot Command:
984 CONFIG_BOOTCOMMAND
985 Only needed when CONFIG_BOOTDELAY is enabled;
986 define a command string that is automatically executed
987 when no character is read on the console interface
988 within "Boot Delay" after reset.
989
990 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000991 This can be used to pass arguments to the bootm
992 command. The value of CONFIG_BOOTARGS goes into the
993 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000994
995 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000996 The value of these goes into the environment as
997 "ramboot" and "nfsboot" respectively, and can be used
998 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200999 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001000
Heiko Schocher040c5c32013-11-04 14:04:59 +01001001- Bootcount:
1002 CONFIG_BOOTCOUNT_LIMIT
1003 Implements a mechanism for detecting a repeating reboot
1004 cycle, see:
1005 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1006
1007 CONFIG_BOOTCOUNT_ENV
1008 If no softreset save registers are found on the hardware
1009 "bootcount" is stored in the environment. To prevent a
1010 saveenv on all reboots, the environment variable
1011 "upgrade_available" is used. If "upgrade_available" is
1012 0, "bootcount" is always 0, if "upgrade_available" is
1013 1 "bootcount" is incremented in the environment.
1014 So the Userspace Applikation must set the "upgrade_available"
1015 and "bootcount" variable to 0, if a boot was successfully.
1016
wdenkc6097192002-11-03 00:24:07 +00001017- Pre-Boot Commands:
1018 CONFIG_PREBOOT
1019
1020 When this option is #defined, the existence of the
1021 environment variable "preboot" will be checked
1022 immediately before starting the CONFIG_BOOTDELAY
1023 countdown and/or running the auto-boot command resp.
1024 entering interactive mode.
1025
1026 This feature is especially useful when "preboot" is
1027 automatically generated or modified. For an example
1028 see the LWMON board specific code: here "preboot" is
1029 modified when the user holds down a certain
1030 combination of keys on the (special) keyboard when
1031 booting the systems
1032
1033- Serial Download Echo Mode:
1034 CONFIG_LOADS_ECHO
1035 If defined to 1, all characters received during a
1036 serial download (using the "loads" command) are
1037 echoed back. This might be needed by some terminal
1038 emulations (like "cu"), but may as well just take
1039 time on others. This setting #define's the initial
1040 value of the "loads_echo" environment variable.
1041
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001042- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001043 CONFIG_KGDB_BAUDRATE
1044 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001045 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001046
1047- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001048 Monitor commands can be included or excluded
1049 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001050 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -05001051 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001052
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001053 The default command configuration includes all commands
1054 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001055
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001056 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001057 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001058 CONFIG_CMD_BDI bdinfo
1059 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1060 CONFIG_CMD_BMP * BMP support
1061 CONFIG_CMD_BSP * Board specific commands
1062 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001063 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001064 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001065 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001066 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001067 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001068 CONFIG_CMD_DATE * support for RTC, date/time...
1069 CONFIG_CMD_DHCP * DHCP support
1070 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001071 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1072 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1073 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1074 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001075 CONFIG_CMD_DTT * Digital Therm and Thermostat
1076 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001077 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001078 CONFIG_CMD_EEPROM * EEPROM read/write support
1079 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001080 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001081 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001082 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001083 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001084 CONFIG_CMD_EXT2 * ext2 command support
1085 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001086 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1087 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001088 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001089 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001090 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001091 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001092 CONFIG_CMD_FLASH flinfo, erase, protect
1093 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001094 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001095 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001096 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001097 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001098 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001099 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1100 CONFIG_CMD_I2C * I2C serial bus support
1101 CONFIG_CMD_IDE * IDE harddisk support
1102 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001103 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001104 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001105 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001106 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001107 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001108 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001109 CONFIG_CMD_IRQ * irqinfo
1110 CONFIG_CMD_ITEST Integer/string test of 2 values
1111 CONFIG_CMD_JFFS2 * JFFS2 Support
1112 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001113 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001114 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1115 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001116 CONFIG_CMD_LOADB loadb
1117 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001118 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001119 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001120 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001121 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001122 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001123 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001124 CONFIG_CMD_MISC Misc functions like sleep etc
1125 CONFIG_CMD_MMC * MMC memory mapped support
1126 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001127 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001128 CONFIG_CMD_NAND * NAND support
1129 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001130 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001131 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001132 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001133 CONFIG_CMD_PCI * pciinfo
1134 CONFIG_CMD_PCMCIA * PCMCIA support
1135 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1136 host
1137 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001138 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001139 CONFIG_CMD_REGINFO * Register dump
1140 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001141 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001142 CONFIG_CMD_SAVES * save S record dump
1143 CONFIG_CMD_SCSI * SCSI Support
1144 CONFIG_CMD_SDRAM * print SDRAM configuration information
1145 (requires CONFIG_CMD_I2C)
1146 CONFIG_CMD_SETGETDCR Support for DCR Register access
1147 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001148 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001149 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001150 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001151 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001152 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001153 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001154 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001155 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001156 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1157 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001158 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001159 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001160 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001161 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001162 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001163
1164 EXAMPLE: If you want all functions except of network
1165 support you can write:
1166
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001167 #include "config_cmd_all.h"
1168 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001169
Gerald Van Barend6abef42007-03-31 12:23:51 -04001170 Other Commands:
1171 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001172
1173 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001174 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001175 what you (and your U-Boot users) are doing. Data
1176 cache cannot be enabled on systems like the 8xx or
1177 8260 (where accesses to the IMMR region must be
1178 uncached), and it cannot be disabled on all other
1179 systems where we (mis-) use the data cache to hold an
1180 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001181
1182
1183 XXX - this list needs to get updated!
1184
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001185- Regular expression support:
1186 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001187 If this variable is defined, U-Boot is linked against
1188 the SLRE (Super Light Regular Expression) library,
1189 which adds regex support to some commands, as for
1190 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001191
Simon Glass3d686442011-10-15 05:48:20 +00001192- Device tree:
1193 CONFIG_OF_CONTROL
1194 If this variable is defined, U-Boot will use a device tree
1195 to configure its devices, instead of relying on statically
1196 compiled #defines in the board file. This option is
1197 experimental and only available on a few boards. The device
1198 tree is available in the global data as gd->fdt_blob.
1199
Simon Glass5cb34db2011-10-24 19:15:31 +00001200 U-Boot needs to get its device tree from somewhere. This can
1201 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001202
1203 CONFIG_OF_EMBED
1204 If this variable is defined, U-Boot will embed a device tree
1205 binary in its image. This device tree file should be in the
1206 board directory and called <soc>-<board>.dts. The binary file
1207 is then picked up in board_init_f() and made available through
1208 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001209
Simon Glass5cb34db2011-10-24 19:15:31 +00001210 CONFIG_OF_SEPARATE
1211 If this variable is defined, U-Boot will build a device tree
1212 binary. It will be called u-boot.dtb. Architecture-specific
1213 code will locate it at run-time. Generally this works by:
1214
1215 cat u-boot.bin u-boot.dtb >image.bin
1216
1217 and in fact, U-Boot does this for you, creating a file called
1218 u-boot-dtb.bin which is useful in the common case. You can
1219 still use the individual files if you need something more
1220 exotic.
1221
wdenkc6097192002-11-03 00:24:07 +00001222- Watchdog:
1223 CONFIG_WATCHDOG
1224 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001225 support for the SoC. There must be support in the SoC
1226 specific code for a watchdog. For the 8xx and 8260
1227 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1228 register. When supported for a specific SoC is
1229 available, then no further board specific code should
1230 be needed to use it.
1231
1232 CONFIG_HW_WATCHDOG
1233 When using a watchdog circuitry external to the used
1234 SoC, then define this variable and provide board
1235 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001236
Heiko Schocher735326c2015-01-21 08:38:22 +01001237 CONFIG_AT91_HW_WDT_TIMEOUT
1238 specify the timeout in seconds. default 2 seconds.
1239
stroeseb9c17c52003-04-04 15:53:41 +00001240- U-Boot Version:
1241 CONFIG_VERSION_VARIABLE
1242 If this variable is defined, an environment variable
1243 named "ver" is created by U-Boot showing the U-Boot
1244 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001245 Any change to this variable will be reverted at the
1246 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001247
wdenkc6097192002-11-03 00:24:07 +00001248- Real-Time Clock:
1249
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001250 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001251 has to be selected, too. Define exactly one of the
1252 following options:
1253
1254 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1255 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001256 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001257 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001258 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001259 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001260 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001261 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001262 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001263 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001264 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001265 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001266 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1267 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001268
wdenkb9bbd242003-06-30 16:24:52 +00001269 Note that if the RTC uses I2C, then the I2C interface
1270 must also be configured. See I2C Support, below.
1271
Peter Tyser9902e422008-12-17 16:36:21 -06001272- GPIO Support:
1273 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001274
Chris Packham9b383202010-12-19 10:12:13 +00001275 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1276 chip-ngpio pairs that tell the PCA953X driver the number of
1277 pins supported by a particular chip.
1278
Peter Tyser9902e422008-12-17 16:36:21 -06001279 Note that if the GPIO device uses I2C, then the I2C interface
1280 must also be configured. See I2C Support, below.
1281
Simon Glass4dc47ca2014-06-11 23:29:41 -06001282- I/O tracing:
1283 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1284 accesses and can checksum them or write a list of them out
1285 to memory. See the 'iotrace' command for details. This is
1286 useful for testing device drivers since it can confirm that
1287 the driver behaves the same way before and after a code
1288 change. Currently this is supported on sandbox and arm. To
1289 add support for your architecture, add '#include <iotrace.h>'
1290 to the bottom of arch/<arch>/include/asm/io.h and test.
1291
1292 Example output from the 'iotrace stats' command is below.
1293 Note that if the trace buffer is exhausted, the checksum will
1294 still continue to operate.
1295
1296 iotrace is enabled
1297 Start: 10000000 (buffer start address)
1298 Size: 00010000 (buffer size)
1299 Offset: 00000120 (current buffer offset)
1300 Output: 10000120 (start + offset)
1301 Count: 00000018 (number of trace records)
1302 CRC32: 9526fb66 (CRC32 of all trace records)
1303
wdenkc6097192002-11-03 00:24:07 +00001304- Timestamp Support:
1305
wdenk4a5c8a72003-03-06 00:02:04 +00001306 When CONFIG_TIMESTAMP is selected, the timestamp
1307 (date and time) of an image is printed by image
1308 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001309 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001310
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001311- Partition Labels (disklabels) Supported:
1312 Zero or more of the following:
1313 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1314 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1315 Intel architecture, USB sticks, etc.
1316 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1317 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1318 bootloader. Note 2TB partition limit; see
1319 disk/part_efi.c
1320 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001321
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001322 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1323 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001324 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001325
1326- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001327 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1328 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001329
wdenk369d43d2004-03-14 14:09:05 +00001330 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1331 be performed by calling the function
1332 ide_set_reset(int reset)
1333 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001334
1335- ATAPI Support:
1336 CONFIG_ATAPI
1337
1338 Set this to enable ATAPI support.
1339
wdenkf602aa02004-03-13 23:29:43 +00001340- LBA48 Support
1341 CONFIG_LBA48
1342
1343 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001344 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001345 Whithout these , LBA48 support uses 32bit variables and will 'only'
1346 support disks up to 2.1TB.
1347
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001348 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001349 When enabled, makes the IDE subsystem use 64bit sector addresses.
1350 Default is 32bit.
1351
wdenkc6097192002-11-03 00:24:07 +00001352- SCSI Support:
1353 At the moment only there is only support for the
1354 SYM53C8XX SCSI controller; define
1355 CONFIG_SCSI_SYM53C8XX to enable it.
1356
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001357 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1358 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1359 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001360 maximum numbers of LUNs, SCSI ID's and target
1361 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001362 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001363
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001364 The environment variable 'scsidevs' is set to the number of
1365 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001366
wdenkc6097192002-11-03 00:24:07 +00001367- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001368 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001369 Support for Intel 8254x/8257x gigabit chips.
1370
1371 CONFIG_E1000_SPI
1372 Utility code for direct access to the SPI bus on Intel 8257x.
1373 This does not do anything useful unless you set at least one
1374 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1375
1376 CONFIG_E1000_SPI_GENERIC
1377 Allow generic access to the SPI bus on the Intel 8257x, for
1378 example with the "sspi" command.
1379
1380 CONFIG_CMD_E1000
1381 Management command for E1000 devices. When used on devices
1382 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001383
Andre Schwarz68c2a302008-03-06 16:45:44 +01001384 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001385 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001386
wdenkc6097192002-11-03 00:24:07 +00001387 CONFIG_EEPRO100
1388 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001389 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001390 write routine for first time initialisation.
1391
1392 CONFIG_TULIP
1393 Support for Digital 2114x chips.
1394 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1395 modem chip initialisation (KS8761/QS6611).
1396
1397 CONFIG_NATSEMI
1398 Support for National dp83815 chips.
1399
1400 CONFIG_NS8382X
1401 Support for National dp8382[01] gigabit chips.
1402
wdenkaa603362003-05-12 21:50:16 +00001403- NETWORK Support (other):
1404
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001405 CONFIG_DRIVER_AT91EMAC
1406 Support for AT91RM9200 EMAC.
1407
1408 CONFIG_RMII
1409 Define this to use reduced MII inteface
1410
1411 CONFIG_DRIVER_AT91EMAC_QUIET
1412 If this defined, the driver is quiet.
1413 The driver doen't show link status messages.
1414
Rob Herringc9830dc2011-12-15 11:15:49 +00001415 CONFIG_CALXEDA_XGMAC
1416 Support for the Calxeda XGMAC device
1417
Ashok93fb8722012-10-15 06:20:47 +00001418 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001419 Support for SMSC's LAN91C96 chips.
1420
1421 CONFIG_LAN91C96_BASE
1422 Define this to hold the physical address
1423 of the LAN91C96's I/O space
1424
1425 CONFIG_LAN91C96_USE_32_BIT
1426 Define this to enable 32 bit addressing
1427
Ashok93fb8722012-10-15 06:20:47 +00001428 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001429 Support for SMSC's LAN91C111 chip
1430
1431 CONFIG_SMC91111_BASE
1432 Define this to hold the physical address
1433 of the device (I/O space)
1434
1435 CONFIG_SMC_USE_32_BIT
1436 Define this if data bus is 32 bits
1437
1438 CONFIG_SMC_USE_IOFUNCS
1439 Define this to use i/o functions instead of macros
1440 (some hardware wont work with macros)
1441
Heiko Schocher7d037f72011-11-15 10:00:04 -05001442 CONFIG_DRIVER_TI_EMAC
1443 Support for davinci emac
1444
1445 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1446 Define this if you have more then 3 PHYs.
1447
Macpaul Lin199c6252010-12-21 16:59:46 +08001448 CONFIG_FTGMAC100
1449 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1450
1451 CONFIG_FTGMAC100_EGIGA
1452 Define this to use GE link update with gigabit PHY.
1453 Define this if FTGMAC100 is connected to gigabit PHY.
1454 If your system has 10/100 PHY only, it might not occur
1455 wrong behavior. Because PHY usually return timeout or
1456 useless data when polling gigabit status and gigabit
1457 control registers. This behavior won't affect the
1458 correctnessof 10/100 link speed update.
1459
Mike Rapoportf4761af2009-11-11 10:03:03 +02001460 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001461 Support for SMSC's LAN911x and LAN921x chips
1462
Mike Rapoportf4761af2009-11-11 10:03:03 +02001463 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001464 Define this to hold the physical address
1465 of the device (I/O space)
1466
Mike Rapoportf4761af2009-11-11 10:03:03 +02001467 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001468 Define this if data bus is 32 bits
1469
Mike Rapoportf4761af2009-11-11 10:03:03 +02001470 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001471 Define this if data bus is 16 bits. If your processor
1472 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001473 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001474
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001475 CONFIG_SH_ETHER
1476 Support for Renesas on-chip Ethernet controller
1477
1478 CONFIG_SH_ETHER_USE_PORT
1479 Define the number of ports to be used
1480
1481 CONFIG_SH_ETHER_PHY_ADDR
1482 Define the ETH PHY's address
1483
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001484 CONFIG_SH_ETHER_CACHE_WRITEBACK
1485 If this option is set, the driver enables cache flush.
1486
Heiko Schocher2b387762014-07-18 06:07:19 +02001487- PWM Support:
1488 CONFIG_PWM_IMX
1489 Support for PWM modul on the imx6.
1490
Vadim Bendeburydac69642011-10-17 08:36:14 +00001491- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001492 CONFIG_TPM
1493 Support TPM devices.
1494
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001495 CONFIG_TPM_TIS_I2C
1496 Support for i2c bus TPM devices. Only one device
1497 per system is supported at this time.
1498
1499 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1500 Define the the i2c bus number for the TPM device
1501
1502 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1503 Define the TPM's address on the i2c bus
1504
1505 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1506 Define the burst count bytes upper limit
1507
Dirk Eibach20489092013-06-26 15:55:15 +02001508 CONFIG_TPM_ATMEL_TWI
1509 Support for Atmel TWI TPM device. Requires I2C support.
1510
Che-liang Chiouacea5702013-04-12 11:04:34 +00001511 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001512 Support for generic parallel port TPM devices. Only one device
1513 per system is supported at this time.
1514
1515 CONFIG_TPM_TIS_BASE_ADDRESS
1516 Base address where the generic TPM device is mapped
1517 to. Contemporary x86 systems usually map it at
1518 0xfed40000.
1519
Reinhard Pfau4fece432013-06-26 15:55:13 +02001520 CONFIG_CMD_TPM
1521 Add tpm monitor functions.
1522 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1523 provides monitor access to authorized functions.
1524
1525 CONFIG_TPM
1526 Define this to enable the TPM support library which provides
1527 functional interfaces to some TPM commands.
1528 Requires support for a TPM device.
1529
1530 CONFIG_TPM_AUTH_SESSIONS
1531 Define this to enable authorized functions in the TPM library.
1532 Requires CONFIG_TPM and CONFIG_SHA1.
1533
wdenkc6097192002-11-03 00:24:07 +00001534- USB Support:
1535 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001536 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001537 CONFIG_USB_UHCI to enable it.
1538 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001539 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001540 storage devices.
1541 Note:
1542 Supported are USB Keyboards and USB Floppy drives
1543 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001544 MPC5200 USB requires additional defines:
1545 CONFIG_USB_CLOCK
1546 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001547 CONFIG_PSC3_USB
1548 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001549 CONFIG_USB_CONFIG
1550 for differential drivers: 0x00001000
1551 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001552 for differential drivers on PSC3: 0x00000100
1553 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001554 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001555 May be defined to allow interrupt polling
1556 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001557
Simon Glass5978cdb2012-02-27 10:52:47 +00001558 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1559 txfilltuning field in the EHCI controller on reset.
1560
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001561 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1562 HW module registers.
1563
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001564- USB Device:
1565 Define the below if you wish to use the USB console.
1566 Once firmware is rebuilt from a serial console issue the
1567 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001568 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001569 it has found a new device. The environment variable usbtty
1570 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001571 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001572 Common Device Class Abstract Control Model serial device.
1573 If you select usbtty = gserial you should be able to enumerate
1574 a Linux host by
1575 # modprobe usbserial vendor=0xVendorID product=0xProductID
1576 else if using cdc_acm, simply setting the environment
1577 variable usbtty to be cdc_acm should suffice. The following
1578 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001579
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001580 CONFIG_USB_DEVICE
1581 Define this to build a UDC device
1582
1583 CONFIG_USB_TTY
1584 Define this to have a tty type of device available to
1585 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001586
Vipin KUMARbdb17702012-03-26 15:38:06 +05301587 CONFIG_USBD_HS
1588 Define this to enable the high speed support for usb
1589 device and usbtty. If this feature is enabled, a routine
1590 int is_usbd_high_speed(void)
1591 also needs to be defined by the driver to dynamically poll
1592 whether the enumeration has succeded at high speed or full
1593 speed.
1594
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001595 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001596 Define this if you want stdin, stdout &/or stderr to
1597 be set to usbtty.
1598
1599 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001600 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001601 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001602 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001603
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001604 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001605 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001606 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001607
Wolfgang Denke2601822006-06-14 18:14:56 +02001608 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001609 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001610 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001611 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1612 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1613 should pretend to be a Linux device to it's target host.
1614
1615 CONFIG_USBD_MANUFACTURER
1616 Define this string as the name of your company for
1617 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001618
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001619 CONFIG_USBD_PRODUCT_NAME
1620 Define this string as the name of your product
1621 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001622
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001623 CONFIG_USBD_VENDORID
1624 Define this as your assigned Vendor ID from the USB
1625 Implementors Forum. This *must* be a genuine Vendor ID
1626 to avoid polluting the USB namespace.
1627 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001628
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001629 CONFIG_USBD_PRODUCTID
1630 Define this as the unique Product ID
1631 for your device
1632 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001633
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001634- ULPI Layer Support:
1635 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1636 the generic ULPI layer. The generic layer accesses the ULPI PHY
1637 via the platform viewport, so you need both the genric layer and
1638 the viewport enabled. Currently only Chipidea/ARC based
1639 viewport is supported.
1640 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1641 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001642 If your ULPI phy needs a different reference clock than the
1643 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1644 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001645
wdenk7a428cc2003-06-15 22:40:42 +00001646- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001647 The MMC controller on the Intel PXA is supported. To
1648 enable this define CONFIG_MMC. The MMC can be
1649 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001650 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001651 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1652 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001653
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001654 CONFIG_SH_MMCIF
1655 Support for Renesas on-chip MMCIF controller
1656
1657 CONFIG_SH_MMCIF_ADDR
1658 Define the base address of MMCIF registers
1659
1660 CONFIG_SH_MMCIF_CLK
1661 Define the clock frequency for MMCIF
1662
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001663 CONFIG_GENERIC_MMC
1664 Enable the generic MMC driver
1665
1666 CONFIG_SUPPORT_EMMC_BOOT
1667 Enable some additional features of the eMMC boot partitions.
1668
1669 CONFIG_SUPPORT_EMMC_RPMB
1670 Enable the commands for reading, writing and programming the
1671 key for the Replay Protection Memory Block partition in eMMC.
1672
Tom Rini58a8d322013-03-14 05:32:47 +00001673- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001674 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001675 This enables the USB portion of the DFU USB class
1676
1677 CONFIG_CMD_DFU
1678 This enables the command "dfu" which is used to have
1679 U-Boot create a DFU class device via USB. This command
1680 requires that the "dfu_alt_info" environment variable be
1681 set and define the alt settings to expose to the host.
1682
1683 CONFIG_DFU_MMC
1684 This enables support for exposing (e)MMC devices via DFU.
1685
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001686 CONFIG_DFU_NAND
1687 This enables support for exposing NAND devices via DFU.
1688
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301689 CONFIG_DFU_RAM
1690 This enables support for exposing RAM via DFU.
1691 Note: DFU spec refer to non-volatile memory usage, but
1692 allow usages beyond the scope of spec - here RAM usage,
1693 one that would help mostly the developer.
1694
Heiko Schochera2f831e2013-06-12 06:05:51 +02001695 CONFIG_SYS_DFU_DATA_BUF_SIZE
1696 Dfu transfer uses a buffer before writing data to the
1697 raw storage device. Make the size (in bytes) of this buffer
1698 configurable. The size of this buffer is also configurable
1699 through the "dfu_bufsiz" environment variable.
1700
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001701 CONFIG_SYS_DFU_MAX_FILE_SIZE
1702 When updating files rather than the raw storage device,
1703 we use a static buffer to copy the file into and then write
1704 the buffer once we've been given the whole file. Define
1705 this to the maximum filesize (in bytes) for the buffer.
1706 Default is 4 MiB if undefined.
1707
Heiko Schochere1ba1512014-03-18 08:09:56 +01001708 DFU_DEFAULT_POLL_TIMEOUT
1709 Poll timeout [ms], is the timeout a device can send to the
1710 host. The host must wait for this timeout before sending
1711 a subsequent DFU_GET_STATUS request to the device.
1712
1713 DFU_MANIFEST_POLL_TIMEOUT
1714 Poll timeout [ms], which the device sends to the host when
1715 entering dfuMANIFEST state. Host waits this timeout, before
1716 sending again an USB request to the device.
1717
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001718- USB Device Android Fastboot support:
1719 CONFIG_CMD_FASTBOOT
1720 This enables the command "fastboot" which enables the Android
1721 fastboot mode for the platform's USB device. Fastboot is a USB
1722 protocol for downloading images, flashing and device control
1723 used on Android devices.
1724 See doc/README.android-fastboot for more information.
1725
1726 CONFIG_ANDROID_BOOT_IMAGE
1727 This enables support for booting images which use the Android
1728 image format header.
1729
1730 CONFIG_USB_FASTBOOT_BUF_ADDR
1731 The fastboot protocol requires a large memory buffer for
1732 downloads. Define this to the starting RAM address to use for
1733 downloaded images.
1734
1735 CONFIG_USB_FASTBOOT_BUF_SIZE
1736 The fastboot protocol requires a large memory buffer for
1737 downloads. This buffer should be as large as possible for a
1738 platform. Define this to the size available RAM for fastboot.
1739
Steve Raebfb9ba42014-08-26 11:47:28 -07001740 CONFIG_FASTBOOT_FLASH
1741 The fastboot protocol includes a "flash" command for writing
1742 the downloaded image to a non-volatile storage device. Define
1743 this to enable the "fastboot flash" command.
1744
1745 CONFIG_FASTBOOT_FLASH_MMC_DEV
1746 The fastboot "flash" command requires additional information
1747 regarding the non-volatile storage device. Define this to
1748 the eMMC device that fastboot should use to store the image.
1749
Steve Rae7d059342014-12-12 15:51:54 -08001750 CONFIG_FASTBOOT_GPT_NAME
1751 The fastboot "flash" command supports writing the downloaded
1752 image to the Protective MBR and the Primary GUID Partition
1753 Table. (Additionally, this downloaded image is post-processed
1754 to generate and write the Backup GUID Partition Table.)
1755 This occurs when the specified "partition name" on the
1756 "fastboot flash" command line matches this value.
1757 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1758
wdenkda04a8b2004-08-02 23:22:59 +00001759- Journaling Flash filesystem support:
1760 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1761 CONFIG_JFFS2_NAND_DEV
1762 Define these for a default partition on a NAND device
1763
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001764 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1765 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001766 Define these for a default partition on a NOR device
1767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001768 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001769 Define this to create an own partition. You have to provide a
1770 function struct part_info* jffs2_part_info(int part_num)
1771
1772 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001773 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001774 to disable the command chpart. This is the default when you
1775 have not defined a custom partition
1776
Donggeun Kim8f814002011-10-24 21:15:28 +00001777- FAT(File Allocation Table) filesystem write function support:
1778 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001779
1780 Define this to enable support for saving memory data as a
1781 file in FAT formatted partition.
1782
1783 This will also enable the command "fatwrite" enabling the
1784 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001785
Gabe Black7f8574c2012-10-12 14:26:11 +00001786CBFS (Coreboot Filesystem) support
1787 CONFIG_CMD_CBFS
1788
1789 Define this to enable support for reading from a Coreboot
1790 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1791 and cbfsload.
1792
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301793- FAT(File Allocation Table) filesystem cluster size:
1794 CONFIG_FS_FAT_MAX_CLUSTSIZE
1795
1796 Define the max cluster size for fat operations else
1797 a default value of 65536 will be defined.
1798
wdenkc6097192002-11-03 00:24:07 +00001799- Keyboard Support:
1800 CONFIG_ISA_KEYBOARD
1801
1802 Define this to enable standard (PC-Style) keyboard
1803 support
1804
1805 CONFIG_I8042_KBD
1806 Standard PC keyboard driver with US (is default) and
1807 GERMAN key layout (switch via environment 'keymap=de') support.
1808 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1809 for cfb_console. Supports cursor blinking.
1810
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001811 CONFIG_CROS_EC_KEYB
1812 Enables a Chrome OS keyboard using the CROS_EC interface.
1813 This uses CROS_EC to communicate with a second microcontroller
1814 which provides key scans on request.
1815
wdenkc6097192002-11-03 00:24:07 +00001816- Video support:
1817 CONFIG_VIDEO
1818
1819 Define this to enable video support (for output to
1820 video).
1821
1822 CONFIG_VIDEO_CT69000
1823
1824 Enable Chips & Technologies 69000 Video chip
1825
1826 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001827 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001828 video output is selected via environment 'videoout'
1829 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1830 assumed.
wdenkc6097192002-11-03 00:24:07 +00001831
wdenkd3602132004-03-25 15:14:43 +00001832 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001833 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001834 are possible:
1835 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001836 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001837
1838 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1839 -------------+---------------------------------------------
1840 8 bits | 0x301* 0x303 0x305 0x161 0x307
1841 15 bits | 0x310 0x313 0x316 0x162 0x319
1842 16 bits | 0x311 0x314 0x317 0x163 0x31A
1843 24 bits | 0x312 0x315 0x318 ? 0x31B
1844 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001845 (i.e. setenv videomode 317; saveenv; reset;)
1846
wdenkd3602132004-03-25 15:14:43 +00001847 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001848 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001849
1850
stroeseb9c17c52003-04-04 15:53:41 +00001851 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001852 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001853 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1854 or CONFIG_VIDEO_SED13806_16BPP
1855
Timur Tabi020edd22011-02-15 17:09:19 -06001856 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001857 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001858 SOCs that have a DIU should define this macro to enable DIU
1859 support, and should also define these other macros:
1860
1861 CONFIG_SYS_DIU_ADDR
1862 CONFIG_VIDEO
1863 CONFIG_CMD_BMP
1864 CONFIG_CFB_CONSOLE
1865 CONFIG_VIDEO_SW_CURSOR
1866 CONFIG_VGA_AS_SINGLE_DEVICE
1867 CONFIG_VIDEO_LOGO
1868 CONFIG_VIDEO_BMP_LOGO
1869
Timur Tabi32f709e2011-04-11 14:18:22 -05001870 The DIU driver will look for the 'video-mode' environment
1871 variable, and if defined, enable the DIU as a console during
1872 boot. See the documentation file README.video for a
1873 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001874
Simon Glass54df8ce2012-12-03 13:59:47 +00001875
wdenk4e112c12003-06-03 23:54:09 +00001876- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001877 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001878
wdenk57b2d802003-06-27 21:31:46 +00001879 Define this to enable a custom keyboard support.
1880 This simply calls drv_keyboard_init() which must be
1881 defined in your board-specific files.
1882 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001883
wdenkc6097192002-11-03 00:24:07 +00001884- LCD Support: CONFIG_LCD
1885
1886 Define this to enable LCD support (for output to LCD
1887 display); also select one of the supported displays
1888 by defining one of these:
1889
Stelian Popf6f86652008-05-09 21:57:18 +02001890 CONFIG_ATMEL_LCD:
1891
1892 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1893
wdenkc0d54ae2003-11-25 16:55:19 +00001894 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001895
wdenkc0d54ae2003-11-25 16:55:19 +00001896 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001897
wdenkc0d54ae2003-11-25 16:55:19 +00001898 CONFIG_NEC_NL6448BC20
1899
1900 NEC NL6448BC20-08. 6.5", 640x480.
1901 Active, color, single scan.
1902
1903 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001904
wdenkc0d54ae2003-11-25 16:55:19 +00001905 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001906 Active, color, single scan.
1907
1908 CONFIG_SHARP_16x9
1909
1910 Sharp 320x240. Active, color, single scan.
1911 It isn't 16x9, and I am not sure what it is.
1912
1913 CONFIG_SHARP_LQ64D341
1914
1915 Sharp LQ64D341 display, 640x480.
1916 Active, color, single scan.
1917
1918 CONFIG_HLD1045
1919
1920 HLD1045 display, 640x480.
1921 Active, color, single scan.
1922
1923 CONFIG_OPTREX_BW
1924
1925 Optrex CBL50840-2 NF-FW 99 22 M5
1926 or
1927 Hitachi LMG6912RPFC-00T
1928 or
1929 Hitachi SP14Q002
1930
1931 320x240. Black & white.
1932
1933 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001934 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001935
Simon Glass599a4df2012-10-17 13:24:54 +00001936 CONFIG_LCD_ALIGNMENT
1937
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001938 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001939 defined then the LCD will be aligned to this value instead.
1940 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1941 here, since it is cheaper to change data cache settings on
1942 a per-section basis.
1943
Simon Glassaf3e2802012-10-17 13:24:59 +00001944 CONFIG_CONSOLE_SCROLL_LINES
1945
1946 When the console need to be scrolled, this is the number of
1947 lines to scroll by. It defaults to 1. Increasing this makes
1948 the console jump but can help speed up operation when scrolling
1949 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001950
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001951 CONFIG_LCD_ROTATION
1952
1953 Sometimes, for example if the display is mounted in portrait
1954 mode or even if it's mounted landscape but rotated by 180degree,
1955 we need to rotate our content of the display relative to the
1956 framebuffer, so that user can read the messages which are
1957 printed out.
1958 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1959 initialized with a given rotation from "vl_rot" out of
1960 "vidinfo_t" which is provided by the board specific code.
1961 The value for vl_rot is coded as following (matching to
1962 fbcon=rotate:<n> linux-kernel commandline):
1963 0 = no rotation respectively 0 degree
1964 1 = 90 degree rotation
1965 2 = 180 degree rotation
1966 3 = 270 degree rotation
1967
1968 If CONFIG_LCD_ROTATION is not defined, the console will be
1969 initialized with 0degree rotation.
1970
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001971 CONFIG_LCD_BMP_RLE8
1972
1973 Support drawing of RLE8-compressed bitmaps on the LCD.
1974
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001975 CONFIG_I2C_EDID
1976
1977 Enables an 'i2c edid' command which can read EDID
1978 information over I2C from an attached LCD display.
1979
wdenkeb20ad32003-09-05 23:19:14 +00001980- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001981
wdenk57b2d802003-06-27 21:31:46 +00001982 If this option is set, the environment is checked for
1983 a variable "splashimage". If found, the usual display
1984 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001985 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001986 specified in "splashimage" is loaded instead. The
1987 console is redirected to the "nulldev", too. This
1988 allows for a "silent" boot where a splash screen is
1989 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001990
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001991 CONFIG_SPLASHIMAGE_GUARD
1992
1993 If this option is set, then U-Boot will prevent the environment
1994 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001995 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001996 This option is useful for targets where, due to alignment
1997 restrictions, an improperly aligned BMP image will cause a data
1998 abort. If you think you will not have problems with unaligned
1999 accesses (for example because your toolchain prevents them)
2000 there is no need to set this option.
2001
Matthias Weisser53884182009-07-09 16:07:30 +02002002 CONFIG_SPLASH_SCREEN_ALIGN
2003
2004 If this option is set the splash image can be freely positioned
2005 on the screen. Environment variable "splashpos" specifies the
2006 position as "x,y". If a positive number is given it is used as
2007 number of pixel from left/top. If a negative number is given it
2008 is used as number of pixel from right/bottom. You can also
2009 specify 'm' for centering the image.
2010
2011 Example:
2012 setenv splashpos m,m
2013 => image at center of screen
2014
2015 setenv splashpos 30,20
2016 => image at x = 30 and y = 20
2017
2018 setenv splashpos -10,m
2019 => vertically centered image
2020 at x = dspWidth - bmpWidth - 9
2021
Stefan Roesed9d97742005-09-22 09:04:17 +02002022- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2023
2024 If this option is set, additionally to standard BMP
2025 images, gzipped BMP images can be displayed via the
2026 splashscreen support or the bmp command.
2027
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002028- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2029
2030 If this option is set, 8-bit RLE compressed BMP images
2031 can be displayed via the splashscreen support or the
2032 bmp command.
2033
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002034- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002035 CONFIG_CMD_ZIP
2036
2037 If this option is set, it would use zlib deflate method
2038 to compress the specified memory at its best effort.
2039
wdenk710e3502003-08-29 20:57:53 +00002040- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002041 CONFIG_GZIP
2042
2043 Enabled by default to support gzip compressed images.
2044
wdenk710e3502003-08-29 20:57:53 +00002045 CONFIG_BZIP2
2046
2047 If this option is set, support for bzip2 compressed
2048 images is included. If not, only uncompressed and gzip
2049 compressed images are supported.
2050
wdenk9c53f402003-10-15 23:53:47 +00002051 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002052 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002053 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002054
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002055 CONFIG_LZMA
2056
2057 If this option is set, support for lzma compressed
2058 images is included.
2059
2060 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2061 requires an amount of dynamic memory that is given by the
2062 formula:
2063
2064 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2065
2066 Where lc and lp stand for, respectively, Literal context bits
2067 and Literal pos bits.
2068
2069 This value is upper-bounded by 14MB in the worst case. Anyway,
2070 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2071 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2072 a very small buffer.
2073
2074 Use the lzmainfo tool to determinate the lc and lp values and
2075 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002076 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002077
Kees Cook5b06e642013-08-16 07:59:12 -07002078 CONFIG_LZO
2079
2080 If this option is set, support for LZO compressed images
2081 is included.
2082
wdenk0e2bd9c2004-06-06 21:51:03 +00002083- MII/PHY support:
2084 CONFIG_PHY_ADDR
2085
2086 The address of PHY on MII bus.
2087
2088 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2089
2090 The clock frequency of the MII bus
2091
2092 CONFIG_PHY_GIGE
2093
2094 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002095 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002096
2097 CONFIG_PHY_RESET_DELAY
2098
2099 Some PHY like Intel LXT971A need extra delay after
2100 reset before any MII register access is possible.
2101 For such PHY, set this option to the usec delay
2102 required. (minimum 300usec for LXT971A)
2103
2104 CONFIG_PHY_CMD_DELAY (ppc4xx)
2105
2106 Some PHY like Intel LXT971A need extra delay after
2107 command issued before MII status register can be read
2108
wdenkc6097192002-11-03 00:24:07 +00002109- IP address:
2110 CONFIG_IPADDR
2111
2112 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002113 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002114 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002115 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002116
2117- Server IP address:
2118 CONFIG_SERVERIP
2119
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002120 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002121 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002122 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002123
Robin Getz470a6d42009-07-21 12:15:28 -04002124 CONFIG_KEEP_SERVERADDR
2125
2126 Keeps the server's MAC address, in the env 'serveraddr'
2127 for passing to bootargs (like Linux's netconsole option)
2128
Wolfgang Denk26da2992011-10-26 10:21:22 +00002129- Gateway IP address:
2130 CONFIG_GATEWAYIP
2131
2132 Defines a default value for the IP address of the
2133 default router where packets to other networks are
2134 sent to.
2135 (Environment variable "gatewayip")
2136
2137- Subnet mask:
2138 CONFIG_NETMASK
2139
2140 Defines a default value for the subnet mask (or
2141 routing prefix) which is used to determine if an IP
2142 address belongs to the local subnet or needs to be
2143 forwarded through a router.
2144 (Environment variable "netmask")
2145
David Updegraff7280da72007-06-11 10:41:07 -05002146- Multicast TFTP Mode:
2147 CONFIG_MCAST_TFTP
2148
2149 Defines whether you want to support multicast TFTP as per
2150 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002151 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002152 driver in use must provide a function: mcast() to join/leave a
2153 multicast group.
2154
wdenkc6097192002-11-03 00:24:07 +00002155- BOOTP Recovery Mode:
2156 CONFIG_BOOTP_RANDOM_DELAY
2157
2158 If you have many targets in a network that try to
2159 boot using BOOTP, you may want to avoid that all
2160 systems send out BOOTP requests at precisely the same
2161 moment (which would happen for instance at recovery
2162 from a power failure, when all systems will try to
2163 boot, thus flooding the BOOTP server. Defining
2164 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2165 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002166 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002167
2168 1st BOOTP request: delay 0 ... 1 sec
2169 2nd BOOTP request: delay 0 ... 2 sec
2170 3rd BOOTP request: delay 0 ... 4 sec
2171 4th and following
2172 BOOTP requests: delay 0 ... 8 sec
2173
Thierry Reding8977cda2014-08-19 10:21:24 +02002174 CONFIG_BOOTP_ID_CACHE_SIZE
2175
2176 BOOTP packets are uniquely identified using a 32-bit ID. The
2177 server will copy the ID from client requests to responses and
2178 U-Boot will use this to determine if it is the destination of
2179 an incoming response. Some servers will check that addresses
2180 aren't in use before handing them out (usually using an ARP
2181 ping) and therefore take up to a few hundred milliseconds to
2182 respond. Network congestion may also influence the time it
2183 takes for a response to make it back to the client. If that
2184 time is too long, U-Boot will retransmit requests. In order
2185 to allow earlier responses to still be accepted after these
2186 retransmissions, U-Boot's BOOTP client keeps a small cache of
2187 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2188 cache. The default is to keep IDs for up to four outstanding
2189 requests. Increasing this will allow U-Boot to accept offers
2190 from a BOOTP client in networks with unusually high latency.
2191
stroesee0aadfb2003-08-28 14:17:32 +00002192- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002193 You can fine tune the DHCP functionality by defining
2194 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002195
Jon Loeliger5336a762007-07-09 22:08:34 -05002196 CONFIG_BOOTP_SUBNETMASK
2197 CONFIG_BOOTP_GATEWAY
2198 CONFIG_BOOTP_HOSTNAME
2199 CONFIG_BOOTP_NISDOMAIN
2200 CONFIG_BOOTP_BOOTPATH
2201 CONFIG_BOOTP_BOOTFILESIZE
2202 CONFIG_BOOTP_DNS
2203 CONFIG_BOOTP_DNS2
2204 CONFIG_BOOTP_SEND_HOSTNAME
2205 CONFIG_BOOTP_NTPSERVER
2206 CONFIG_BOOTP_TIMEOFFSET
2207 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002208 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002209
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002210 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2211 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002212
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002213 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2214 after the configured retry count, the call will fail
2215 instead of starting over. This can be used to fail over
2216 to Link-local IP address configuration if the DHCP server
2217 is not available.
2218
stroesee0aadfb2003-08-28 14:17:32 +00002219 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2220 serverip from a DHCP server, it is possible that more
2221 than one DNS serverip is offered to the client.
2222 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2223 serverip will be stored in the additional environment
2224 variable "dnsip2". The first DNS serverip is always
2225 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002226 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002227
2228 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2229 to do a dynamic update of a DNS server. To do this, they
2230 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002231 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002232 of the "hostname" environment variable is passed as
2233 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002234
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002235 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2236
2237 A 32bit value in microseconds for a delay between
2238 receiving a "DHCP Offer" and sending the "DHCP Request".
2239 This fixes a problem with certain DHCP servers that don't
2240 respond 100% of the time to a "DHCP request". E.g. On an
2241 AT91RM9200 processor running at 180MHz, this delay needed
2242 to be *at least* 15,000 usec before a Windows Server 2003
2243 DHCP server would reply 100% of the time. I recommend at
2244 least 50,000 usec to be safe. The alternative is to hope
2245 that one of the retries will be successful but note that
2246 the DHCP timeout and retry process takes a longer than
2247 this delay.
2248
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002249 - Link-local IP address negotiation:
2250 Negotiate with other link-local clients on the local network
2251 for an address that doesn't require explicit configuration.
2252 This is especially useful if a DHCP server cannot be guaranteed
2253 to exist in all environments that the device must operate.
2254
2255 See doc/README.link-local for more information.
2256
wdenk145d2c12004-04-15 21:48:45 +00002257 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002258 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002259
2260 The device id used in CDP trigger frames.
2261
2262 CONFIG_CDP_DEVICE_ID_PREFIX
2263
2264 A two character string which is prefixed to the MAC address
2265 of the device.
2266
2267 CONFIG_CDP_PORT_ID
2268
2269 A printf format string which contains the ascii name of
2270 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002271 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002272
2273 CONFIG_CDP_CAPABILITIES
2274
2275 A 32bit integer which indicates the device capabilities;
2276 0x00000010 for a normal host which does not forwards.
2277
2278 CONFIG_CDP_VERSION
2279
2280 An ascii string containing the version of the software.
2281
2282 CONFIG_CDP_PLATFORM
2283
2284 An ascii string containing the name of the platform.
2285
2286 CONFIG_CDP_TRIGGER
2287
2288 A 32bit integer sent on the trigger.
2289
2290 CONFIG_CDP_POWER_CONSUMPTION
2291
2292 A 16bit integer containing the power consumption of the
2293 device in .1 of milliwatts.
2294
2295 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2296
2297 A byte containing the id of the VLAN.
2298
wdenkc6097192002-11-03 00:24:07 +00002299- Status LED: CONFIG_STATUS_LED
2300
2301 Several configurations allow to display the current
2302 status using a LED. For instance, the LED will blink
2303 fast while running U-Boot code, stop blinking as
2304 soon as a reply to a BOOTP request was received, and
2305 start blinking slow once the Linux kernel is running
2306 (supported by a status LED driver in the Linux
2307 kernel). Defining CONFIG_STATUS_LED enables this
2308 feature in U-Boot.
2309
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002310 Additional options:
2311
2312 CONFIG_GPIO_LED
2313 The status LED can be connected to a GPIO pin.
2314 In such cases, the gpio_led driver can be used as a
2315 status LED backend implementation. Define CONFIG_GPIO_LED
2316 to include the gpio_led driver in the U-Boot binary.
2317
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002318 CONFIG_GPIO_LED_INVERTED_TABLE
2319 Some GPIO connected LEDs may have inverted polarity in which
2320 case the GPIO high value corresponds to LED off state and
2321 GPIO low value corresponds to LED on state.
2322 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2323 with a list of GPIO LEDs that have inverted polarity.
2324
wdenkc6097192002-11-03 00:24:07 +00002325- CAN Support: CONFIG_CAN_DRIVER
2326
2327 Defining CONFIG_CAN_DRIVER enables CAN driver support
2328 on those systems that support this (optional)
2329 feature, like the TQM8xxL modules.
2330
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002331- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002332
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002333 This enable the NEW i2c subsystem, and will allow you to use
2334 i2c commands at the u-boot command line (as long as you set
2335 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2336 based realtime clock chips or other i2c devices. See
2337 common/cmd_i2c.c for a description of the command line
2338 interface.
2339
2340 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002341 - drivers/i2c/soft_i2c.c:
2342 - activate first bus with CONFIG_SYS_I2C_SOFT define
2343 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2344 for defining speed and slave address
2345 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2346 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2347 for defining speed and slave address
2348 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2349 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2350 for defining speed and slave address
2351 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2352 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2353 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002354
Heiko Schocherf2850742012-10-24 13:48:22 +02002355 - drivers/i2c/fsl_i2c.c:
2356 - activate i2c driver with CONFIG_SYS_I2C_FSL
2357 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2358 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2359 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2360 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002361 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002362 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2363 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2364 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2365 second bus.
2366
Simon Glass026fefb2012-10-30 07:28:53 +00002367 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002368 - activate this driver with CONFIG_SYS_I2C_TEGRA
2369 - This driver adds 4 i2c buses with a fix speed from
2370 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002371
Dirk Eibach42b204f2013-04-25 02:40:01 +00002372 - drivers/i2c/ppc4xx_i2c.c
2373 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2374 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2375 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2376
trema49f40a2013-09-21 18:13:35 +02002377 - drivers/i2c/i2c_mxc.c
2378 - activate this driver with CONFIG_SYS_I2C_MXC
2379 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2380 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2381 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2382 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2383 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2384 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002385 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002386 for speed, and 0 for slave.
York Sunf1a52162015-03-20 10:20:40 -07002387 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2388 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002389
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002390 - drivers/i2c/rcar_i2c.c:
2391 - activate this driver with CONFIG_SYS_I2C_RCAR
2392 - This driver adds 4 i2c buses
2393
2394 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2395 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2396 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2397 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2398 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2399 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2400 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2401 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2402 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2403
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002404 - drivers/i2c/sh_i2c.c:
2405 - activate this driver with CONFIG_SYS_I2C_SH
2406 - This driver adds from 2 to 5 i2c buses
2407
2408 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2409 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2410 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2411 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2412 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2413 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2414 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2415 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2416 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2417 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2418 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2419 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002420 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002421
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002422 - drivers/i2c/omap24xx_i2c.c
2423 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2424 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2425 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2426 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2427 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2428 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2429 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2430 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2431 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2432 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2433 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2434
Heiko Schocher465819a2013-11-08 07:30:53 +01002435 - drivers/i2c/zynq_i2c.c
2436 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2437 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2438 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2439
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302440 - drivers/i2c/s3c24x0_i2c.c:
2441 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2442 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2443 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2444 with a fix speed from 100000 and the slave addr 0!
2445
Dirk Eibachb9577432014-07-03 09:28:18 +02002446 - drivers/i2c/ihs_i2c.c
2447 - activate this driver with CONFIG_SYS_I2C_IHS
2448 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2449 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2450 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2451 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2452 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2453 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2454 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2455 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2456 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2457 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2458 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2459 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2460
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002461 additional defines:
2462
2463 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002464 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002465 don't use/have i2c muxes on your i2c bus, this
2466 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2467 omit this define.
2468
2469 CONFIG_SYS_I2C_DIRECT_BUS
2470 define this, if you don't use i2c muxes on your hardware.
2471 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2472 omit this define.
2473
2474 CONFIG_SYS_I2C_MAX_HOPS
2475 define how many muxes are maximal consecutively connected
2476 on one i2c bus. If you not use i2c muxes, omit this
2477 define.
2478
2479 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002480 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002481 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2482 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2483 CONFIG_SYS_NUM_I2C_BUSES = 9:
2484
2485 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2486 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2487 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2488 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2489 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2490 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2491 {1, {I2C_NULL_HOP}}, \
2492 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2493 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2494 }
2495
2496 which defines
2497 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002498 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2499 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2500 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2501 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2502 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002503 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002504 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2505 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002506
2507 If you do not have i2c muxes on your board, omit this define.
2508
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002509- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002510
2511 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2512 provides the following compelling advantages:
2513
2514 - more than one i2c adapter is usable
2515 - approved multibus support
2516 - better i2c mux support
2517
2518 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002519
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002520 These enable legacy I2C serial bus commands. Defining
2521 CONFIG_HARD_I2C will include the appropriate I2C driver
2522 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002523
wdenk21136db2003-07-16 21:53:01 +00002524 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002525 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002526 CONFIG_COMMANDS) and communicate with i2c based realtime
2527 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002528 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002529
Ben Warren45657152006-09-07 16:50:54 -04002530 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002531
wdenk21136db2003-07-16 21:53:01 +00002532 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002533 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002536 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002537 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002538 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002539
Peter Tysere4d1abc2010-04-12 22:28:21 -05002540 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002541 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002542 and so its address should therefore be cleared to 0 (See,
2543 eg, MPC823e User's Manual p.16-473). So, set
2544 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002545
Eric Millbrandt12990a42009-09-03 08:09:44 -05002546 CONFIG_SYS_I2C_INIT_MPC5XXX
2547
2548 When a board is reset during an i2c bus transfer
2549 chips might think that the current transfer is still
2550 in progress. Reset the slave devices by sending start
2551 commands until the slave device responds.
2552
wdenk21136db2003-07-16 21:53:01 +00002553 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002554
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002555 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002556 then the following macros need to be defined (examples are
2557 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002558
2559 I2C_INIT
2560
wdenkb9bbd242003-06-30 16:24:52 +00002561 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002562 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002563
wdenk544e9732004-02-06 23:19:44 +00002564 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002565
wdenkc6097192002-11-03 00:24:07 +00002566 I2C_PORT
2567
wdenk4a5c8a72003-03-06 00:02:04 +00002568 (Only for MPC8260 CPU). The I/O port to use (the code
2569 assumes both bits are on the same port). Valid values
2570 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002571
2572 I2C_ACTIVE
2573
2574 The code necessary to make the I2C data line active
2575 (driven). If the data line is open collector, this
2576 define can be null.
2577
wdenkb9bbd242003-06-30 16:24:52 +00002578 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2579
wdenkc6097192002-11-03 00:24:07 +00002580 I2C_TRISTATE
2581
2582 The code necessary to make the I2C data line tri-stated
2583 (inactive). If the data line is open collector, this
2584 define can be null.
2585
wdenkb9bbd242003-06-30 16:24:52 +00002586 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2587
wdenkc6097192002-11-03 00:24:07 +00002588 I2C_READ
2589
York Sun4a598092013-04-01 11:29:11 -07002590 Code that returns true if the I2C data line is high,
2591 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002592
wdenkb9bbd242003-06-30 16:24:52 +00002593 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2594
wdenkc6097192002-11-03 00:24:07 +00002595 I2C_SDA(bit)
2596
York Sun4a598092013-04-01 11:29:11 -07002597 If <bit> is true, sets the I2C data line high. If it
2598 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002599
wdenkb9bbd242003-06-30 16:24:52 +00002600 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002601 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002602 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002603
wdenkc6097192002-11-03 00:24:07 +00002604 I2C_SCL(bit)
2605
York Sun4a598092013-04-01 11:29:11 -07002606 If <bit> is true, sets the I2C clock line high. If it
2607 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002608
wdenkb9bbd242003-06-30 16:24:52 +00002609 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002610 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002611 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002612
wdenkc6097192002-11-03 00:24:07 +00002613 I2C_DELAY
2614
2615 This delay is invoked four times per clock cycle so this
2616 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002617 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002618 like:
2619
wdenkb9bbd242003-06-30 16:24:52 +00002620 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002621
Mike Frysingeree12d542010-07-21 13:38:02 -04002622 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2623
2624 If your arch supports the generic GPIO framework (asm/gpio.h),
2625 then you may alternatively define the two GPIOs that are to be
2626 used as SCL / SDA. Any of the previous I2C_xxx macros will
2627 have GPIO-based defaults assigned to them as appropriate.
2628
2629 You should define these to the GPIO value as given directly to
2630 the generic GPIO functions.
2631
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002632 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002633
wdenk57b2d802003-06-27 21:31:46 +00002634 When a board is reset during an i2c bus transfer
2635 chips might think that the current transfer is still
2636 in progress. On some boards it is possible to access
2637 the i2c SCLK line directly, either by using the
2638 processor pin as a GPIO or by having a second pin
2639 connected to the bus. If this option is defined a
2640 custom i2c_init_board() routine in boards/xxx/board.c
2641 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002642
Richard Retanubundf0149c2010-04-12 15:08:17 -04002643 CONFIG_SYS_I2C_BOARD_LATE_INIT
2644
2645 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2646 defined a custom i2c_board_late_init() routine in
2647 boards/xxx/board.c is run AFTER the operations in i2c_init()
2648 is completed. This callpoint can be used to unreset i2c bus
2649 using CPU i2c controller register accesses for CPUs whose i2c
2650 controller provide such a method. It is called at the end of
2651 i2c_init() to allow i2c_init operations to setup the i2c bus
2652 controller on the CPU (e.g. setting bus speed & slave address).
2653
wdenk0e2bd9c2004-06-06 21:51:03 +00002654 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2655
2656 This option enables configuration of bi_iic_fast[] flags
2657 in u-boot bd_info structure based on u-boot environment
2658 variable "i2cfast". (see also i2cfast)
2659
Ben Warren45657152006-09-07 16:50:54 -04002660 CONFIG_I2C_MULTI_BUS
2661
2662 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002663 must have a controller. At any point in time, only one bus is
2664 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002665 Note that bus numbering is zero-based.
2666
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002667 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002668
2669 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002670 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002671 is set, specify a list of bus-device pairs. Otherwise, specify
2672 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002673
2674 e.g.
2675 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002676 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002677
2678 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2679
Wolfgang Denk092ae952011-10-26 10:21:21 +00002680 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002681 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002682
2683 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002685 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002686
2687 If defined, then this indicates the I2C bus number for DDR SPD.
2688 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002690 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002691
2692 If defined, then this indicates the I2C bus number for the RTC.
2693 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002695 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002696
2697 If defined, then this indicates the I2C bus number for the DTT.
2698 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002700 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002701
2702 If defined, specifies the I2C address of the DTT device.
2703 If not defined, then U-Boot uses predefined value for
2704 specified DTT device.
2705
Andrew Dyer58c41f92008-12-29 17:36:01 -06002706 CONFIG_SOFT_I2C_READ_REPEATED_START
2707
2708 defining this will force the i2c_read() function in
2709 the soft_i2c driver to perform an I2C repeated start
2710 between writing the address pointer and reading the
2711 data. If this define is omitted the default behaviour
2712 of doing a stop-start sequence will be used. Most I2C
2713 devices can use either method, but some require one or
2714 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002715
wdenkc6097192002-11-03 00:24:07 +00002716- SPI Support: CONFIG_SPI
2717
2718 Enables SPI driver (so far only tested with
2719 SPI EEPROM, also an instance works with Crystal A/D and
2720 D/As on the SACSng board)
2721
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002722 CONFIG_SH_SPI
2723
2724 Enables the driver for SPI controller on SuperH. Currently
2725 only SH7757 is supported.
2726
wdenkc6097192002-11-03 00:24:07 +00002727 CONFIG_SPI_X
2728
2729 Enables extended (16-bit) SPI EEPROM addressing.
2730 (symmetrical to CONFIG_I2C_X)
2731
2732 CONFIG_SOFT_SPI
2733
wdenk4a5c8a72003-03-06 00:02:04 +00002734 Enables a software (bit-bang) SPI driver rather than
2735 using hardware support. This is a general purpose
2736 driver that only requires three general I/O port pins
2737 (two outputs, one input) to function. If this is
2738 defined, the board configuration must define several
2739 SPI configuration items (port pins to use, etc). For
2740 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002741
Ben Warren7efe9272008-01-16 22:37:35 -05002742 CONFIG_HARD_SPI
2743
2744 Enables a hardware SPI driver for general-purpose reads
2745 and writes. As with CONFIG_SOFT_SPI, the board configuration
2746 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002747 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002748 example, see include/configs/mpc8349emds.h.
2749
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002750 CONFIG_MXC_SPI
2751
2752 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002753 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002754
Heiko Schocherb77c8882014-07-14 10:22:11 +02002755 CONFIG_SYS_SPI_MXC_WAIT
2756 Timeout for waiting until spi transfer completed.
2757 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2758
Matthias Fuchsa4400872007-12-27 17:12:34 +01002759- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002760
Matthias Fuchsa4400872007-12-27 17:12:34 +01002761 Enables FPGA subsystem.
2762
2763 CONFIG_FPGA_<vendor>
2764
2765 Enables support for specific chip vendors.
2766 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002767
Matthias Fuchsa4400872007-12-27 17:12:34 +01002768 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002769
Matthias Fuchsa4400872007-12-27 17:12:34 +01002770 Enables support for FPGA family.
2771 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2772
2773 CONFIG_FPGA_COUNT
2774
2775 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002776
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302777 CONFIG_CMD_FPGA_LOADMK
2778
2779 Enable support for fpga loadmk command
2780
Michal Simek64c70982014-05-02 13:43:39 +02002781 CONFIG_CMD_FPGA_LOADP
2782
2783 Enable support for fpga loadp command - load partial bitstream
2784
2785 CONFIG_CMD_FPGA_LOADBP
2786
2787 Enable support for fpga loadbp command - load partial bitstream
2788 (Xilinx only)
2789
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002790 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002791
wdenk57b2d802003-06-27 21:31:46 +00002792 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002794 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002795
wdenk4a5c8a72003-03-06 00:02:04 +00002796 Enable checks on FPGA configuration interface busy
2797 status by the configuration function. This option
2798 will require a board or device specific function to
2799 be written.
wdenkc6097192002-11-03 00:24:07 +00002800
2801 CONFIG_FPGA_DELAY
2802
2803 If defined, a function that provides delays in the FPGA
2804 configuration driver.
2805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002806 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002807 Allow Control-C to interrupt FPGA configuration
2808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002809 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002810
wdenk4a5c8a72003-03-06 00:02:04 +00002811 Check for configuration errors during FPGA bitfile
2812 loading. For example, abort during Virtex II
2813 configuration if the INIT_B line goes low (which
2814 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002815
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002816 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002817
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002818 Maximum time to wait for the INIT_B line to de-assert
2819 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002820 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002821 ms.
wdenkc6097192002-11-03 00:24:07 +00002822
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002823 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002824
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002825 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002826 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002827
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002828 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk4a5c8a72003-03-06 00:02:04 +00002830 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002831 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002832
2833- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002834 CONFIG_BUILD_TARGET
2835
2836 Some SoCs need special image types (e.g. U-Boot binary
2837 with a special header) as build targets. By defining
2838 CONFIG_BUILD_TARGET in the SoC / board header, this
2839 special image will be automatically built upon calling
2840 make / MAKEALL.
2841
wdenkc6097192002-11-03 00:24:07 +00002842 CONFIG_IDENT_STRING
2843
wdenk4a5c8a72003-03-06 00:02:04 +00002844 If defined, this string will be added to the U-Boot
2845 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002846
2847- Vendor Parameter Protection:
2848
wdenk4a5c8a72003-03-06 00:02:04 +00002849 U-Boot considers the values of the environment
2850 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002851 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002852 are set once by the board vendor / manufacturer, and
2853 protects these variables from casual modification by
2854 the user. Once set, these variables are read-only,
2855 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002856 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002857
2858 If CONFIG_ENV_OVERWRITE is #defined in your config
2859 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002860 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002861 these parameters.
2862
Joe Hershberger76f353e2015-05-04 14:55:14 -05002863 Alternatively, if you define _both_ an ethaddr in the
2864 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002865 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002866 which can be changed exactly ONCE by the user. [The
2867 serial# is unaffected by this, i. e. it remains
2868 read-only.]
2869
Joe Hershberger71497d02012-12-11 22:16:31 -06002870 The same can be accomplished in a more flexible way
2871 for any variable by configuring the type of access
2872 to allow for those variables in the ".flags" variable
2873 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2874
wdenkc6097192002-11-03 00:24:07 +00002875- Protected RAM:
2876 CONFIG_PRAM
2877
2878 Define this variable to enable the reservation of
2879 "protected RAM", i. e. RAM which is not overwritten
2880 by U-Boot. Define CONFIG_PRAM to hold the number of
2881 kB you want to reserve for pRAM. You can overwrite
2882 this default value by defining an environment
2883 variable "pram" to the number of kB you want to
2884 reserve. Note that the board info structure will
2885 still show the full amount of RAM. If pRAM is
2886 reserved, a new environment variable "mem" will
2887 automatically be defined to hold the amount of
2888 remaining RAM in a form that can be passed as boot
2889 argument to Linux, for instance like that:
2890
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002891 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002892 saveenv
2893
2894 This way you can tell Linux not to use this memory,
2895 either, which results in a memory region that will
2896 not be affected by reboots.
2897
2898 *WARNING* If your board configuration uses automatic
2899 detection of the RAM size, you must make sure that
2900 this memory test is non-destructive. So far, the
2901 following board configurations are known to be
2902 "pRAM-clean":
2903
Wolfgang Denk90326762012-10-24 02:36:15 +00002904 IVMS8, IVML24, SPD8xx, TQM8xxL,
2905 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002906 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002907
Gabe Blacka2f3a932012-12-02 04:55:18 +00002908- Access to physical memory region (> 4GB)
2909 Some basic support is provided for operations on memory not
2910 normally accessible to U-Boot - e.g. some architectures
2911 support access to more than 4GB of memory on 32-bit
2912 machines using physical address extension or similar.
2913 Define CONFIG_PHYSMEM to access this basic support, which
2914 currently only supports clearing the memory.
2915
wdenkc6097192002-11-03 00:24:07 +00002916- Error Recovery:
2917 CONFIG_PANIC_HANG
2918
2919 Define this variable to stop the system in case of a
2920 fatal error, so that you have to reset it manually.
2921 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002922 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002923 automatically as fast as possible, but it may be
2924 useful during development since you can try to debug
2925 the conditions that lead to the situation.
2926
2927 CONFIG_NET_RETRY_COUNT
2928
wdenk4a5c8a72003-03-06 00:02:04 +00002929 This variable defines the number of retries for
2930 network operations like ARP, RARP, TFTP, or BOOTP
2931 before giving up the operation. If not defined, a
2932 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002933
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002934 CONFIG_ARP_TIMEOUT
2935
2936 Timeout waiting for an ARP reply in milliseconds.
2937
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002938 CONFIG_NFS_TIMEOUT
2939
2940 Timeout in milliseconds used in NFS protocol.
2941 If you encounter "ERROR: Cannot umount" in nfs command,
2942 try longer timeout such as
2943 #define CONFIG_NFS_TIMEOUT 10000UL
2944
wdenkc6097192002-11-03 00:24:07 +00002945- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002946 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002947
2948 Enable auto completion of commands using TAB.
2949
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002950 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002951
2952 This defines the secondary prompt string, which is
2953 printed when the command interpreter needs more input
2954 to complete a command. Usually "> ".
2955
2956 Note:
2957
wdenk57b2d802003-06-27 21:31:46 +00002958 In the current implementation, the local variables
2959 space and global environment variables space are
2960 separated. Local variables are those you define by
2961 simply typing `name=value'. To access a local
2962 variable later on, you have write `$name' or
2963 `${name}'; to execute the contents of a variable
2964 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002965
wdenk4a5c8a72003-03-06 00:02:04 +00002966 Global environment variables are those you use
2967 setenv/printenv to work with. To run a command stored
2968 in such a variable, you need to use the run command,
2969 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002970
2971 To store commands and special characters in a
2972 variable, please use double quotation marks
2973 surrounding the whole text of the variable, instead
2974 of the backslashes before semicolons and special
2975 symbols.
2976
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002977- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002978 CONFIG_CMDLINE_EDITING
2979
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002980 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002981 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002982
wdenkc0aa5c52003-12-06 19:49:23 +00002983- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002984 CONFIG_EXTRA_ENV_SETTINGS
2985
wdenk4a5c8a72003-03-06 00:02:04 +00002986 Define this to contain any number of null terminated
2987 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002988 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002989
wdenk4a5c8a72003-03-06 00:02:04 +00002990 For example, place something like this in your
2991 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002992
2993 #define CONFIG_EXTRA_ENV_SETTINGS \
2994 "myvar1=value1\0" \
2995 "myvar2=value2\0"
2996
wdenk4a5c8a72003-03-06 00:02:04 +00002997 Warning: This method is based on knowledge about the
2998 internal format how the environment is stored by the
2999 U-Boot code. This is NOT an official, exported
3000 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003001 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003002 You better know what you are doing here.
3003
wdenk4a5c8a72003-03-06 00:02:04 +00003004 Note: overly (ab)use of the default environment is
3005 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003006 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003007 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003008
Stephen Warren1465d5f2012-05-22 09:21:54 +00003009 CONFIG_ENV_VARS_UBOOT_CONFIG
3010
3011 Define this in order to add variables describing the
3012 U-Boot build configuration to the default environment.
3013 These will be named arch, cpu, board, vendor, and soc.
3014
3015 Enabling this option will cause the following to be defined:
3016
3017 - CONFIG_SYS_ARCH
3018 - CONFIG_SYS_CPU
3019 - CONFIG_SYS_BOARD
3020 - CONFIG_SYS_VENDOR
3021 - CONFIG_SYS_SOC
3022
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003023 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3024
3025 Define this in order to add variables describing certain
3026 run-time determined information about the hardware to the
3027 environment. These will be named board_name, board_rev.
3028
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003029 CONFIG_DELAY_ENVIRONMENT
3030
3031 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003032 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003033 that so that the environment is not available until
3034 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3035 this is instead controlled by the value of
3036 /config/load-environment.
3037
Chris Packham2216ddb2015-06-19 20:25:59 +12003038- Parallel Flash support:
3039 CONFIG_SYS_NO_FLASH
3040
3041 Traditionally U-boot was run on systems with parallel NOR
3042 flash. This option is used to disable support for parallel NOR
3043 flash. This option should be defined if the board does not have
3044 parallel flash.
3045
3046 If this option is not defined one of the generic flash drivers
3047 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
3048 selected or the board must provide an implementation of the
3049 flash API (see include/flash.h).
3050
wdenkc0aa5c52003-12-06 19:49:23 +00003051- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003052 CONFIG_HAS_DATAFLASH
3053
wdenk57b2d802003-06-27 21:31:46 +00003054 Defining this option enables DataFlash features and
3055 allows to read/write in Dataflash via the standard
3056 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003057
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003058- Serial Flash support
3059 CONFIG_CMD_SF
3060
3061 Defining this option enables SPI flash commands
3062 'sf probe/read/write/erase/update'.
3063
3064 Usage requires an initial 'probe' to define the serial
3065 flash parameters, followed by read/write/erase/update
3066 commands.
3067
3068 The following defaults may be provided by the platform
3069 to handle the common case when only a single serial
3070 flash is present on the system.
3071
3072 CONFIG_SF_DEFAULT_BUS Bus identifier
3073 CONFIG_SF_DEFAULT_CS Chip-select
3074 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3075 CONFIG_SF_DEFAULT_SPEED in Hz
3076
Simon Glass4b5545e2012-10-08 13:16:02 +00003077 CONFIG_CMD_SF_TEST
3078
3079 Define this option to include a destructive SPI flash
3080 test ('sf test').
3081
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303082 CONFIG_SF_DUAL_FLASH Dual flash memories
3083
3084 Define this option to use dual flash support where two flash
3085 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003086 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303087
wdenkef893942004-02-23 16:11:30 +00003088- SystemACE Support:
3089 CONFIG_SYSTEMACE
3090
3091 Adding this option adds support for Xilinx SystemACE
3092 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003093 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003094 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003095
3096 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003097 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003098
3099 When SystemACE support is added, the "ace" device type
3100 becomes available to the fat commands, i.e. fatls.
3101
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003102- TFTP Fixed UDP Port:
3103 CONFIG_TFTP_PORT
3104
Wolfgang Denk227b5192005-09-24 23:25:46 +02003105 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003106 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003107 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003108 number generator is used.
3109
Wolfgang Denk227b5192005-09-24 23:25:46 +02003110 Also, the environment variable tftpdstp is used to supply
3111 the TFTP UDP destination port value. If tftpdstp isn't
3112 defined, the normal port 69 is used.
3113
3114 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003115 blindly start the TFTP transfer using the pre-configured
3116 target IP address and UDP port. This has the effect of
3117 "punching through" the (Windows XP) firewall, allowing
3118 the remainder of the TFTP transfer to proceed normally.
3119 A better solution is to properly configure the firewall,
3120 but sometimes that is not allowed.
3121
Simon Glass058bb8d2012-12-05 14:46:38 +00003122- Hashing support:
3123 CONFIG_CMD_HASH
3124
3125 This enables a generic 'hash' command which can produce
3126 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3127
3128 CONFIG_HASH_VERIFY
3129
3130 Enable the hash verify command (hash -v). This adds to code
3131 size a little.
3132
gaurav ranaef201592015-02-20 12:51:46 +05303133 CONFIG_SHA1 - This option enables support of hashing using SHA1
3134 algorithm. The hash is calculated in software.
3135 CONFIG_SHA256 - This option enables support of hashing using
3136 SHA256 algorithm. The hash is calculated in software.
3137 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3138 for SHA1/SHA256 hashing.
3139 This affects the 'hash' command and also the
3140 hash_lookup_algo() function.
3141 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3142 hardware-acceleration for SHA1/SHA256 progressive hashing.
3143 Data can be streamed in a block at a time and the hashing
3144 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003145
3146 Note: There is also a sha1sum command, which should perhaps
3147 be deprecated in favour of 'hash sha1'.
3148
Robert Winkler765ccf42013-07-24 17:57:06 -07003149- Freescale i.MX specific commands:
3150 CONFIG_CMD_HDMIDETECT
3151 This enables 'hdmidet' command which returns true if an
3152 HDMI monitor is detected. This command is i.MX 6 specific.
3153
3154 CONFIG_CMD_BMODE
3155 This enables the 'bmode' (bootmode) command for forcing
3156 a boot from specific media.
3157
3158 This is useful for forcing the ROM's usb downloader to
3159 activate upon a watchdog reset which is nice when iterating
3160 on U-Boot. Using the reset button or running bmode normal
3161 will set it back to normal. This command currently
3162 supports i.MX53 and i.MX6.
3163
Simon Glass35191a32013-06-13 15:10:02 -07003164- Signing support:
3165 CONFIG_RSA
3166
3167 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003168 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003169
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303170 The Modular Exponentiation algorithm in RSA is implemented using
3171 driver model. So CONFIG_DM needs to be enabled by default for this
3172 library to function.
3173
Simon Glass35191a32013-06-13 15:10:02 -07003174 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303175 option. The software based modular exponentiation is built into
3176 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003177
Heiko Schocher443ca402014-01-25 07:27:13 +01003178- bootcount support:
3179 CONFIG_BOOTCOUNT_LIMIT
3180
3181 This enables the bootcounter support, see:
3182 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3183
3184 CONFIG_AT91SAM9XE
3185 enable special bootcounter support on at91sam9xe based boards.
3186 CONFIG_BLACKFIN
3187 enable special bootcounter support on blackfin based boards.
3188 CONFIG_SOC_DA8XX
3189 enable special bootcounter support on da850 based boards.
3190 CONFIG_BOOTCOUNT_RAM
3191 enable support for the bootcounter in RAM
3192 CONFIG_BOOTCOUNT_I2C
3193 enable support for the bootcounter on an i2c (like RTC) device.
3194 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3195 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3196 the bootcounter.
3197 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003198
wdenkc0aa5c52003-12-06 19:49:23 +00003199- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003200 CONFIG_SHOW_BOOT_PROGRESS
3201
wdenk4a5c8a72003-03-06 00:02:04 +00003202 Defining this option allows to add some board-
3203 specific code (calling a user-provided function
3204 "show_boot_progress(int)") that enables you to show
3205 the system's boot progress on some display (for
3206 example, some LED's) on your board. At the moment,
3207 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003208
Simon Glass0fa36a42012-09-28 08:56:37 +00003209
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003210Legacy uImage format:
3211
wdenkc6097192002-11-03 00:24:07 +00003212 Arg Where When
3213 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003214 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003215 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003216 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003217 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003218 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003219 4 common/cmd_bootm.c Image data has correct checksum
3220 -4 common/cmd_bootm.c Image is for unsupported architecture
3221 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003222 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003223 6 common/cmd_bootm.c Image Type check OK
3224 -6 common/cmd_bootm.c gunzip uncompression error
3225 -7 common/cmd_bootm.c Unimplemented compression type
3226 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003227 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003228 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003229
3230 9 common/image.c Start initial ramdisk verification
3231 -10 common/image.c Ramdisk header has bad magic number
3232 -11 common/image.c Ramdisk header has bad checksum
3233 10 common/image.c Ramdisk header is OK
3234 -12 common/image.c Ramdisk data has bad checksum
3235 11 common/image.c Ramdisk data has correct checksum
3236 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003237 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003238 13 common/image.c Start multifile image verification
3239 14 common/image.c No initial ramdisk, no multifile, continue.
3240
Wolfgang Denk092ae952011-10-26 10:21:21 +00003241 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003242
Stefan Roese88fbf932010-04-15 16:07:28 +02003243 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003244 -31 post/post.c POST test failed, detected by post_output_backlog()
3245 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003246
Heiko Schocher633e03a2007-06-22 19:11:54 +02003247 34 common/cmd_doc.c before loading a Image from a DOC device
3248 -35 common/cmd_doc.c Bad usage of "doc" command
3249 35 common/cmd_doc.c correct usage of "doc" command
3250 -36 common/cmd_doc.c No boot device
3251 36 common/cmd_doc.c correct boot device
3252 -37 common/cmd_doc.c Unknown Chip ID on boot device
3253 37 common/cmd_doc.c correct chip ID found, device available
3254 -38 common/cmd_doc.c Read Error on boot device
3255 38 common/cmd_doc.c reading Image header from DOC device OK
3256 -39 common/cmd_doc.c Image header has bad magic number
3257 39 common/cmd_doc.c Image header has correct magic number
3258 -40 common/cmd_doc.c Error reading Image from DOC device
3259 40 common/cmd_doc.c Image header has correct magic number
3260 41 common/cmd_ide.c before loading a Image from a IDE device
3261 -42 common/cmd_ide.c Bad usage of "ide" command
3262 42 common/cmd_ide.c correct usage of "ide" command
3263 -43 common/cmd_ide.c No boot device
3264 43 common/cmd_ide.c boot device found
3265 -44 common/cmd_ide.c Device not available
3266 44 common/cmd_ide.c Device available
3267 -45 common/cmd_ide.c wrong partition selected
3268 45 common/cmd_ide.c partition selected
3269 -46 common/cmd_ide.c Unknown partition table
3270 46 common/cmd_ide.c valid partition table found
3271 -47 common/cmd_ide.c Invalid partition type
3272 47 common/cmd_ide.c correct partition type
3273 -48 common/cmd_ide.c Error reading Image Header on boot device
3274 48 common/cmd_ide.c reading Image Header from IDE device OK
3275 -49 common/cmd_ide.c Image header has bad magic number
3276 49 common/cmd_ide.c Image header has correct magic number
3277 -50 common/cmd_ide.c Image header has bad checksum
3278 50 common/cmd_ide.c Image header has correct checksum
3279 -51 common/cmd_ide.c Error reading Image from IDE device
3280 51 common/cmd_ide.c reading Image from IDE device OK
3281 52 common/cmd_nand.c before loading a Image from a NAND device
3282 -53 common/cmd_nand.c Bad usage of "nand" command
3283 53 common/cmd_nand.c correct usage of "nand" command
3284 -54 common/cmd_nand.c No boot device
3285 54 common/cmd_nand.c boot device found
3286 -55 common/cmd_nand.c Unknown Chip ID on boot device
3287 55 common/cmd_nand.c correct chip ID found, device available
3288 -56 common/cmd_nand.c Error reading Image Header on boot device
3289 56 common/cmd_nand.c reading Image Header from NAND device OK
3290 -57 common/cmd_nand.c Image header has bad magic number
3291 57 common/cmd_nand.c Image header has correct magic number
3292 -58 common/cmd_nand.c Error reading Image from NAND device
3293 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003294
Heiko Schocher633e03a2007-06-22 19:11:54 +02003295 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003296
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003297 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003298 -64 net/eth.c no Ethernet found.
3299 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003300
Heiko Schocher633e03a2007-06-22 19:11:54 +02003301 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003302 80 common/cmd_net.c before calling net_loop()
3303 -81 common/cmd_net.c some error in net_loop() occurred
3304 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003305 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3306 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003307 83 common/cmd_net.c running "source" command
3308 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003309 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003310
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003311FIT uImage format:
3312
3313 Arg Where When
3314 100 common/cmd_bootm.c Kernel FIT Image has correct format
3315 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3316 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3317 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3318 102 common/cmd_bootm.c Kernel unit name specified
3319 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003320 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003321 104 common/cmd_bootm.c Got kernel subimage node offset
3322 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3323 105 common/cmd_bootm.c Kernel subimage hash verification OK
3324 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3325 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003326 -106 common/cmd_bootm.c Kernel subimage has wrong type
3327 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003328 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3329 108 common/cmd_bootm.c Got kernel subimage data/size
3330 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3331 -109 common/cmd_bootm.c Can't get kernel subimage type
3332 -110 common/cmd_bootm.c Can't get kernel subimage comp
3333 -111 common/cmd_bootm.c Can't get kernel subimage os
3334 -112 common/cmd_bootm.c Can't get kernel subimage load address
3335 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3336
3337 120 common/image.c Start initial ramdisk verification
3338 -120 common/image.c Ramdisk FIT image has incorrect format
3339 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003340 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003341 -122 common/image.c Can't get configuration for ramdisk subimage
3342 123 common/image.c Ramdisk unit name specified
3343 -124 common/image.c Can't get ramdisk subimage node offset
3344 125 common/image.c Got ramdisk subimage node offset
3345 -125 common/image.c Ramdisk subimage hash verification failed
3346 126 common/image.c Ramdisk subimage hash verification OK
3347 -126 common/image.c Ramdisk subimage for unsupported architecture
3348 127 common/image.c Architecture check OK
3349 -127 common/image.c Can't get ramdisk subimage data/size
3350 128 common/image.c Got ramdisk subimage data/size
3351 129 common/image.c Can't get ramdisk load address
3352 -129 common/image.c Got ramdisk load address
3353
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003354 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003355 131 common/cmd_doc.c FIT image format OK
3356
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003357 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003358 141 common/cmd_ide.c FIT image format OK
3359
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003360 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003361 151 common/cmd_nand.c FIT image format OK
3362
Heiko Schocher515eb122014-05-28 11:33:33 +02003363- legacy image format:
3364 CONFIG_IMAGE_FORMAT_LEGACY
3365 enables the legacy image format support in U-Boot.
3366
3367 Default:
3368 enabled if CONFIG_FIT_SIGNATURE is not defined.
3369
3370 CONFIG_DISABLE_IMAGE_LEGACY
3371 disable the legacy image format
3372
3373 This define is introduced, as the legacy image format is
3374 enabled per default for backward compatibility.
3375
Gabe Blackd572e162012-10-25 16:31:10 +00003376- FIT image support:
3377 CONFIG_FIT
3378 Enable support for the FIT uImage format.
3379
3380 CONFIG_FIT_BEST_MATCH
3381 When no configuration is explicitly selected, default to the
3382 one whose fdt's compatibility field best matches that of
3383 U-Boot itself. A match is considered "best" if it matches the
3384 most specific compatibility entry of U-Boot's fdt's root node.
3385 The order of entries in the configuration's fdt is ignored.
3386
Simon Glass58fe7e52013-06-13 15:10:00 -07003387 CONFIG_FIT_SIGNATURE
3388 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303389 using a hash signed and verified using RSA. If
3390 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3391 hashing is available using hardware, RSA library will use it.
3392 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003393
Heiko Schocher515eb122014-05-28 11:33:33 +02003394 WARNING: When relying on signed FIT images with required
3395 signature check the legacy image format is default
3396 disabled. If a board need legacy image format support
3397 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3398
Dirk Eibach88919ca2014-07-03 09:28:26 +02003399 CONFIG_FIT_DISABLE_SHA256
3400 Supporting SHA256 hashes has quite an impact on binary size.
3401 For constrained systems sha256 hash support can be disabled
3402 with this option.
3403
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003404- Standalone program support:
3405 CONFIG_STANDALONE_LOAD_ADDR
3406
Wolfgang Denk23f78482011-10-09 21:06:34 +02003407 This option defines a board specific value for the
3408 address where standalone program gets loaded, thus
3409 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003410 settings.
3411
3412- Frame Buffer Address:
3413 CONFIG_FB_ADDR
3414
3415 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003416 address for frame buffer. This is typically the case
3417 when using a graphics controller has separate video
3418 memory. U-Boot will then place the frame buffer at
3419 the given address instead of dynamically reserving it
3420 in system RAM by calling lcd_setmem(), which grabs
3421 the memory for the frame buffer depending on the
3422 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003423
3424 Please see board_init_f function.
3425
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003426- Automatic software updates via TFTP server
3427 CONFIG_UPDATE_TFTP
3428 CONFIG_UPDATE_TFTP_CNT_MAX
3429 CONFIG_UPDATE_TFTP_MSEC_MAX
3430
3431 These options enable and control the auto-update feature;
3432 for a more detailed description refer to doc/README.update.
3433
3434- MTD Support (mtdparts command, UBI support)
3435 CONFIG_MTD_DEVICE
3436
3437 Adds the MTD device infrastructure from the Linux kernel.
3438 Needed for mtdparts command support.
3439
3440 CONFIG_MTD_PARTITIONS
3441
3442 Adds the MTD partitioning infrastructure from the Linux
3443 kernel. Needed for UBI support.
3444
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003445- UBI support
3446 CONFIG_CMD_UBI
3447
3448 Adds commands for interacting with MTD partitions formatted
3449 with the UBI flash translation layer
3450
3451 Requires also defining CONFIG_RBTREE
3452
Joe Hershberger47550fc2013-04-08 10:32:49 +00003453 CONFIG_UBI_SILENCE_MSG
3454
3455 Make the verbose messages from UBI stop printing. This leaves
3456 warnings and errors enabled.
3457
Heiko Schocherf5895d12014-06-24 10:10:04 +02003458
3459 CONFIG_MTD_UBI_WL_THRESHOLD
3460 This parameter defines the maximum difference between the highest
3461 erase counter value and the lowest erase counter value of eraseblocks
3462 of UBI devices. When this threshold is exceeded, UBI starts performing
3463 wear leveling by means of moving data from eraseblock with low erase
3464 counter to eraseblocks with high erase counter.
3465
3466 The default value should be OK for SLC NAND flashes, NOR flashes and
3467 other flashes which have eraseblock life-cycle 100000 or more.
3468 However, in case of MLC NAND flashes which typically have eraseblock
3469 life-cycle less than 10000, the threshold should be lessened (e.g.,
3470 to 128 or 256, although it does not have to be power of 2).
3471
3472 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003473
Heiko Schocherf5895d12014-06-24 10:10:04 +02003474 CONFIG_MTD_UBI_BEB_LIMIT
3475 This option specifies the maximum bad physical eraseblocks UBI
3476 expects on the MTD device (per 1024 eraseblocks). If the
3477 underlying flash does not admit of bad eraseblocks (e.g. NOR
3478 flash), this value is ignored.
3479
3480 NAND datasheets often specify the minimum and maximum NVM
3481 (Number of Valid Blocks) for the flashes' endurance lifetime.
3482 The maximum expected bad eraseblocks per 1024 eraseblocks
3483 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3484 which gives 20 for most NANDs (MaxNVB is basically the total
3485 count of eraseblocks on the chip).
3486
3487 To put it differently, if this value is 20, UBI will try to
3488 reserve about 1.9% of physical eraseblocks for bad blocks
3489 handling. And that will be 1.9% of eraseblocks on the entire
3490 NAND chip, not just the MTD partition UBI attaches. This means
3491 that if you have, say, a NAND flash chip admits maximum 40 bad
3492 eraseblocks, and it is split on two MTD partitions of the same
3493 size, UBI will reserve 40 eraseblocks when attaching a
3494 partition.
3495
3496 default: 20
3497
3498 CONFIG_MTD_UBI_FASTMAP
3499 Fastmap is a mechanism which allows attaching an UBI device
3500 in nearly constant time. Instead of scanning the whole MTD device it
3501 only has to locate a checkpoint (called fastmap) on the device.
3502 The on-flash fastmap contains all information needed to attach
3503 the device. Using fastmap makes only sense on large devices where
3504 attaching by scanning takes long. UBI will not automatically install
3505 a fastmap on old images, but you can set the UBI parameter
3506 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3507 that fastmap-enabled images are still usable with UBI implementations
3508 without fastmap support. On typical flash devices the whole fastmap
3509 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3510
3511 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3512 Set this parameter to enable fastmap automatically on images
3513 without a fastmap.
3514 default: 0
3515
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003516- UBIFS support
3517 CONFIG_CMD_UBIFS
3518
3519 Adds commands for interacting with UBI volumes formatted as
3520 UBIFS. UBIFS is read-only in u-boot.
3521
3522 Requires UBI support as well as CONFIG_LZO
3523
Joe Hershberger47550fc2013-04-08 10:32:49 +00003524 CONFIG_UBIFS_SILENCE_MSG
3525
3526 Make the verbose messages from UBIFS stop printing. This leaves
3527 warnings and errors enabled.
3528
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003529- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003530 CONFIG_SPL
3531 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003532
Tom Rini36853852012-02-14 07:29:40 +00003533 CONFIG_SPL_LDSCRIPT
3534 LDSCRIPT for linking the SPL binary.
3535
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003536 CONFIG_SPL_MAX_FOOTPRINT
3537 Maximum size in memory allocated to the SPL, BSS included.
3538 When defined, the linker checks that the actual memory
3539 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003540 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003541 must not be both defined at the same time.
3542
Tom Rini36853852012-02-14 07:29:40 +00003543 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003544 Maximum size of the SPL image (text, data, rodata, and
3545 linker lists sections), BSS excluded.
3546 When defined, the linker checks that the actual size does
3547 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003548
Wolfgang Denk825223d2011-09-11 21:24:09 +02003549 CONFIG_SPL_TEXT_BASE
3550 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003551
Scott Woodc4f0d002012-09-20 19:05:12 -05003552 CONFIG_SPL_RELOC_TEXT_BASE
3553 Address to relocate to. If unspecified, this is equal to
3554 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3555
Tom Rini36853852012-02-14 07:29:40 +00003556 CONFIG_SPL_BSS_START_ADDR
3557 Link address for the BSS within the SPL binary.
3558
3559 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003560 Maximum size in memory allocated to the SPL BSS.
3561 When defined, the linker checks that the actual memory used
3562 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003563 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003564 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003565
3566 CONFIG_SPL_STACK
3567 Adress of the start of the stack SPL will use
3568
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003569 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3570 When defined, SPL will panic() if the image it has
3571 loaded does not have a signature.
3572 Defining this is useful when code which loads images
3573 in SPL cannot guarantee that absolutely all read errors
3574 will be caught.
3575 An example is the LPC32XX MLC NAND driver, which will
3576 consider that a completely unreadable NAND block is bad,
3577 and thus should be skipped silently.
3578
Scott Woodc4f0d002012-09-20 19:05:12 -05003579 CONFIG_SPL_RELOC_STACK
3580 Adress of the start of the stack SPL will use after
3581 relocation. If unspecified, this is equal to
3582 CONFIG_SPL_STACK.
3583
Tom Rini36853852012-02-14 07:29:40 +00003584 CONFIG_SYS_SPL_MALLOC_START
3585 Starting address of the malloc pool used in SPL.
3586
3587 CONFIG_SYS_SPL_MALLOC_SIZE
3588 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003589
Tom Rini28591df2012-08-13 12:03:19 -07003590 CONFIG_SPL_FRAMEWORK
3591 Enable the SPL framework under common/. This framework
3592 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3593 NAND loading of the Linux Kernel.
3594
Tom Rinic2b76002014-03-28 12:03:39 -04003595 CONFIG_SPL_OS_BOOT
3596 Enable booting directly to an OS from SPL.
3597 See also: doc/README.falcon
3598
Tom Rinife3b0c72012-08-13 11:37:56 -07003599 CONFIG_SPL_DISPLAY_PRINT
3600 For ARM, enable an optional function to print more information
3601 about the running system.
3602
Scott Wood7c810902012-09-20 16:35:21 -05003603 CONFIG_SPL_INIT_MINIMAL
3604 Arch init code should be built for a very small image
3605
Wolfgang Denk825223d2011-09-11 21:24:09 +02003606 CONFIG_SPL_LIBCOMMON_SUPPORT
3607 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003608
Wolfgang Denk825223d2011-09-11 21:24:09 +02003609 CONFIG_SPL_LIBDISK_SUPPORT
3610 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003611
Wolfgang Denk825223d2011-09-11 21:24:09 +02003612 CONFIG_SPL_I2C_SUPPORT
3613 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003614
Wolfgang Denk825223d2011-09-11 21:24:09 +02003615 CONFIG_SPL_GPIO_SUPPORT
3616 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003617
Wolfgang Denk825223d2011-09-11 21:24:09 +02003618 CONFIG_SPL_MMC_SUPPORT
3619 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003620
Tom Rini36853852012-02-14 07:29:40 +00003621 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3622 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003623 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003624 when the MMC is being used in raw mode.
3625
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003626 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3627 Partition on the MMC to load U-Boot from when the MMC is being
3628 used in raw mode
3629
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003630 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3631 Sector to load kernel uImage from when MMC is being
3632 used in raw mode (for Falcon mode)
3633
3634 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3635 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3636 Sector and number of sectors to load kernel argument
3637 parameters from when MMC is being used in raw mode
3638 (for falcon mode)
3639
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003640 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3641 Partition on the MMC to load U-Boot from when the MMC is being
3642 used in fs mode
3643
Tom Rini36853852012-02-14 07:29:40 +00003644 CONFIG_SPL_FAT_SUPPORT
3645 Support for fs/fat/libfat.o in SPL binary
3646
Guillaume GARDET5065b712014-10-15 17:53:13 +02003647 CONFIG_SPL_EXT_SUPPORT
3648 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003649
Guillaume GARDET5065b712014-10-15 17:53:13 +02003650 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3651 Filename to read to load U-Boot when reading from filesystem
3652
3653 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003654 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003655 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003656
Guillaume GARDET5065b712014-10-15 17:53:13 +02003657 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003658 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003659 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003660
Scott Wood2b36fbb2012-12-06 13:33:17 +00003661 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3662 Set this for NAND SPL on PPC mpc83xx targets, so that
3663 start.S waits for the rest of the SPL to load before
3664 continuing (the hardware starts execution after just
3665 loading the first page rather than the full 4K).
3666
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303667 CONFIG_SPL_SKIP_RELOCATE
3668 Avoid SPL relocation
3669
Scott Woodc352a0c2012-09-20 19:09:07 -05003670 CONFIG_SPL_NAND_BASE
3671 Include nand_base.c in the SPL. Requires
3672 CONFIG_SPL_NAND_DRIVERS.
3673
3674 CONFIG_SPL_NAND_DRIVERS
3675 SPL uses normal NAND drivers, not minimal drivers.
3676
3677 CONFIG_SPL_NAND_ECC
3678 Include standard software ECC in the SPL
3679
Tom Rini36853852012-02-14 07:29:40 +00003680 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003681 Support for NAND boot using simple NAND drivers that
3682 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003683
Tom Rini543c9f12014-03-28 12:03:36 -04003684 CONFIG_SPL_MTD_SUPPORT
3685 Support for the MTD subsystem within SPL. Useful for
3686 environment on NAND support within SPL.
3687
Heiko Schochercf000272014-10-31 08:31:00 +01003688 CONFIG_SPL_NAND_RAW_ONLY
3689 Support to boot only raw u-boot.bin images. Use this only
3690 if you need to save space.
3691
Ying Zhang9ff70262013-08-16 15:16:11 +08003692 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3693 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003694 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003695
Ying Zhangdfb2b152013-08-16 15:16:12 +08003696 CONFIG_SPL_COMMON_INIT_DDR
3697 Set for common ddr init with serial presence detect in
3698 SPL binary.
3699
Tom Rini36853852012-02-14 07:29:40 +00003700 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3701 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3702 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3703 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3704 CONFIG_SYS_NAND_ECCBYTES
3705 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003706 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003707
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303708 CONFIG_SPL_NAND_BOOT
3709 Add support NAND boot
3710
Tom Rini36853852012-02-14 07:29:40 +00003711 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003712 Location in NAND to read U-Boot from
3713
3714 CONFIG_SYS_NAND_U_BOOT_DST
3715 Location in memory to load U-Boot to
3716
3717 CONFIG_SYS_NAND_U_BOOT_SIZE
3718 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003719
3720 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003721 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003722
3723 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3724 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003725 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003726
3727 CONFIG_SPL_OMAP3_ID_NAND
3728 Support for an OMAP3-specific set of functions to return the
3729 ID and MFR of the first attached NAND chip, if present.
3730
Wolfgang Denk825223d2011-09-11 21:24:09 +02003731 CONFIG_SPL_SERIAL_SUPPORT
3732 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003733
Wolfgang Denk825223d2011-09-11 21:24:09 +02003734 CONFIG_SPL_SPI_FLASH_SUPPORT
3735 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003736
Wolfgang Denk825223d2011-09-11 21:24:09 +02003737 CONFIG_SPL_SPI_SUPPORT
3738 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003739
Pavel Machekde997252012-08-30 22:42:11 +02003740 CONFIG_SPL_RAM_DEVICE
3741 Support for running image already present in ram, in SPL binary
3742
Wolfgang Denk825223d2011-09-11 21:24:09 +02003743 CONFIG_SPL_LIBGENERIC_SUPPORT
3744 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003745
Ying Zhang602f7d32013-05-20 14:07:25 +08003746 CONFIG_SPL_ENV_SUPPORT
3747 Support for the environment operating in SPL binary
3748
3749 CONFIG_SPL_NET_SUPPORT
3750 Support for the net/libnet.o in SPL binary.
3751 It conflicts with SPL env from storage medium specified by
3752 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3753
Scott Woodeb7bd972012-12-06 13:33:16 +00003754 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003755 Image offset to which the SPL should be padded before appending
3756 the SPL payload. By default, this is defined as
3757 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3758 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3759 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003760
Scott Woodf147eb72012-09-21 16:27:32 -05003761 CONFIG_SPL_TARGET
3762 Final target image containing SPL and payload. Some SPLs
3763 use an arch-specific makefile fragment instead, for
3764 example if more than one image needs to be produced.
3765
Simon Glass82d94532013-05-08 08:05:59 +00003766 CONFIG_FIT_SPL_PRINT
3767 Printing information about a FIT image adds quite a bit of
3768 code to SPL. So this is normally disabled in SPL. Use this
3769 option to re-enable it. This will affect the output of the
3770 bootm command when booting a FIT image.
3771
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003772- TPL framework
3773 CONFIG_TPL
3774 Enable building of TPL globally.
3775
3776 CONFIG_TPL_PAD_TO
3777 Image offset to which the TPL should be padded before appending
3778 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003779 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3780 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3781 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003782
wdenkc6097192002-11-03 00:24:07 +00003783Modem Support:
3784--------------
3785
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003786[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003787
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003788- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003789 CONFIG_MODEM_SUPPORT
3790
3791- RTS/CTS Flow control enable:
3792 CONFIG_HWFLOW
3793
3794- Modem debug support:
3795 CONFIG_MODEM_SUPPORT_DEBUG
3796
wdenk4a5c8a72003-03-06 00:02:04 +00003797 Enables debugging stuff (char screen[1024], dbg())
3798 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003799
wdenkc0aa5c52003-12-06 19:49:23 +00003800- Interrupt support (PPC):
3801
wdenk1ebf41e2004-01-02 14:00:00 +00003802 There are common interrupt_init() and timer_interrupt()
3803 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003804 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003805 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003806 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003807 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003808 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003809 specific handling. If board has watchdog / status_led
3810 / other_activity_monitor it works automatically from
3811 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003812
wdenkc6097192002-11-03 00:24:07 +00003813- General:
3814
wdenk4a5c8a72003-03-06 00:02:04 +00003815 In the target system modem support is enabled when a
3816 specific key (key combination) is pressed during
3817 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003818 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003819 board_init(). Currently key_pressed() is a dummy
3820 function, returning 1 and thus enabling modem
3821 initialization.
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk4a5c8a72003-03-06 00:02:04 +00003823 If there are no modem init strings in the
3824 environment, U-Boot proceed to autoboot; the
3825 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003826 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003827
3828 See also: doc/README.Modem
3829
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003830Board initialization settings:
3831------------------------------
3832
3833During Initialization u-boot calls a number of board specific functions
3834to allow the preparation of board specific prerequisites, e.g. pin setup
3835before drivers are initialized. To enable these callbacks the
3836following configuration macros have to be defined. Currently this is
3837architecture specific, so please check arch/your_architecture/lib/board.c
3838typically in board_init_f() and board_init_r().
3839
3840- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3841- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3842- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3843- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003844
wdenkc6097192002-11-03 00:24:07 +00003845Configuration Settings:
3846-----------------------
3847
York Sun6c480012014-02-26 17:03:19 -08003848- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3849 Optionally it can be defined to support 64-bit memory commands.
3850
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003851- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003852 undefine this when you're short of memory.
3853
Peter Tyserdfb72b82009-01-27 18:03:12 -06003854- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3855 width of the commands listed in the 'help' command output.
3856
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003857- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003858 prompt for user input.
3859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003860- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003861
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003862- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003863
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003864- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003865
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003866- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003867 the application (usually a Linux kernel) when it is
3868 booted
3869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003870- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003871 List of legal baudrate settings for this board.
3872
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003873- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003874 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003875
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003876- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003877 If the board specific function
3878 extern int overwrite_console (void);
3879 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003880 serial port, else the settings in the environment are used.
3881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003882- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003883 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003884
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003885- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003886 Enable overwrite of previous console environment settings.
3887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003888- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003889 Begin and End addresses of the area used by the
3890 simple memory test.
3891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003892- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003893 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003895- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003896 Scratch address used by the alternate memory test
3897 You only need to set this if address zero isn't writeable
3898
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003899- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3900 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003901 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003902 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003903 fixing up gd->ram_size the Linux kernel should gets passed
3904 the now "corrected" memory size and won't touch it either.
3905 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003906 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003907 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003908 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003909
3910 This option can be used as a workaround for the 440EPx/GRx
3911 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3912 be touched.
3913
3914 WARNING: Please make sure that this value is a multiple of
3915 the Linux page size (normally 4k). If this is not the case,
3916 then the end address of the Linux memory will be located at a
3917 non page size aligned address and this could cause major
3918 problems.
3919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003920- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003921 Enable temporary baudrate change while serial download
3922
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003923- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003924 Physical start address of SDRAM. _Must_ be 0 here.
3925
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003926- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003927 Physical start address of Motherboard I/O (if using a
3928 Cogent motherboard)
3929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003930- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003931 Physical start address of Flash memory.
3932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003933- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003934 Physical start address of boot monitor code (set by
3935 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003936 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003937 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003940 Size of memory reserved for monitor code, used to
3941 determine _at_compile_time_ (!) if the environment is
3942 embedded within the U-Boot image, or in a separate
3943 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003944
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003945- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003946 Size of DRAM reserved for malloc() use.
3947
Simon Glass863e4042014-07-10 22:23:28 -06003948- CONFIG_SYS_MALLOC_F_LEN
3949 Size of the malloc() pool for use before relocation. If
3950 this is defined, then a very simple malloc() implementation
3951 will become available before relocation. The address is just
3952 below the global data, and the stack is moved down to make
3953 space.
3954
3955 This feature allocates regions with increasing addresses
3956 within the region. calloc() is supported, but realloc()
3957 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003958 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003959 U-Boot relocates itself.
3960
Simon Glasse997f752014-09-15 06:33:18 -06003961 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003962 at present but is fairly easy to enable for other archs.
3963
Simon Glass9fa901b2014-11-10 17:16:54 -07003964- CONFIG_SYS_MALLOC_SIMPLE
3965 Provides a simple and small malloc() and calloc() for those
3966 boards which do not use the full malloc in SPL (which is
3967 enabled with CONFIG_SYS_SPL_MALLOC_START).
3968
Thierry Redingc97d9742014-12-09 22:25:22 -07003969- CONFIG_SYS_NONCACHED_MEMORY:
3970 Size of non-cached memory area. This area of memory will be
3971 typically located right below the malloc() area and mapped
3972 uncached in the MMU. This is useful for drivers that would
3973 otherwise require a lot of explicit cache maintenance. For
3974 some drivers it's also impossible to properly maintain the
3975 cache. For example if the regions that need to be flushed
3976 are not a multiple of the cache-line size, *and* padding
3977 cannot be allocated between the regions to align them (i.e.
3978 if the HW requires a contiguous array of regions, and the
3979 size of each region is not cache-aligned), then a flush of
3980 one region may result in overwriting data that hardware has
3981 written to another region in the same cache-line. This can
3982 happen for example in network drivers where descriptors for
3983 buffers are typically smaller than the CPU cache-line (e.g.
3984 16 bytes vs. 32 or 64 bytes).
3985
3986 Non-cached memory is only supported on 32-bit ARM at present.
3987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003988- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003989 Normally compressed uImages are limited to an
3990 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003991 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003992 to adjust this setting to your needs.
3993
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003994- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003995 Maximum size of memory mapped by the startup code of
3996 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003997 the Linux kernel (bd_info, boot arguments, FDT blob if
3998 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003999 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004000 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004001 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004002 variable "bootm_mapsize" will override the value of
4003 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4004 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004005
John Rigbyeea8e692010-10-13 13:57:35 -06004006- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4007 Enable initrd_high functionality. If defined then the
4008 initrd_high feature is enabled and the bootm ramdisk subcommand
4009 is enabled.
4010
4011- CONFIG_SYS_BOOT_GET_CMDLINE:
4012 Enables allocating and saving kernel cmdline in space between
4013 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4014
4015- CONFIG_SYS_BOOT_GET_KBD:
4016 Enables allocating and saving a kernel copy of the bd_info in
4017 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4018
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004019- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004020 Max number of Flash memory banks
4021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004022- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004023 Max number of sectors on a Flash chip
4024
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004025- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004026 Timeout for Flash erase operations (in ms)
4027
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004028- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004029 Timeout for Flash write operations (in ms)
4030
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004031- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004032 Timeout for Flash set sector lock bit operation (in ms)
4033
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004034- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004035 Timeout for Flash clear lock bits operation (in ms)
4036
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004037- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004038 If defined, hardware flash sectors protection is used
4039 instead of U-Boot software protection.
4040
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004041- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004042
4043 Enable TFTP transfers directly to flash memory;
4044 without this option such a download has to be
4045 performed in two steps: (1) download to RAM, and (2)
4046 copy from RAM to flash.
4047
4048 The two-step approach is usually more reliable, since
4049 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004050 the flash, but in some situations (when system RAM is
4051 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004052 downloaded image) this option may be very useful.
4053
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004054- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004055 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004056 common flash structure for storing flash geometry.
4057
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004058- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004059 This option also enables the building of the cfi_flash driver
4060 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004061
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004062- CONFIG_FLASH_CFI_MTD
4063 This option enables the building of the cfi_mtd driver
4064 in the drivers directory. The driver exports CFI flash
4065 to the MTD layer.
4066
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004067- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004068 Use buffered writes to flash.
4069
4070- CONFIG_FLASH_SPANSION_S29WS_N
4071 s29ws-n MirrorBit flash has non-standard addresses for buffered
4072 write commands.
4073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004074- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004075 If this option is defined, the common CFI flash doesn't
4076 print it's warning upon not recognized FLASH banks. This
4077 is useful, if some of the configured banks are only
4078 optionally available.
4079
Jerry Van Barenaae73572008-03-08 13:48:01 -05004080- CONFIG_FLASH_SHOW_PROGRESS
4081 If defined (must be an integer), print out countdown
4082 digits and dots. Recommended value: 45 (9..1) for 80
4083 column displays, 15 (3..1) for 40 column displays.
4084
Stefan Roesed20cba52013-04-04 15:53:14 +02004085- CONFIG_FLASH_VERIFY
4086 If defined, the content of the flash (destination) is compared
4087 against the source after the write operation. An error message
4088 will be printed when the contents are not identical.
4089 Please note that this option is useless in nearly all cases,
4090 since such flash programming errors usually are detected earlier
4091 while unprotecting/erasing/programming. Please only enable
4092 this option if you really know what you are doing.
4093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004094- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004095 Defines the number of Ethernet receive buffers. On some
4096 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004097 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4098 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004099 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004100 Defaults to 4 if not defined.
4101
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004102- CONFIG_ENV_MAX_ENTRIES
4103
Wolfgang Denk1136f692010-10-27 22:48:30 +02004104 Maximum number of entries in the hash table that is used
4105 internally to store the environment settings. The default
4106 setting is supposed to be generous and should work in most
4107 cases. This setting can be used to tune behaviour; see
4108 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004109
Joe Hershberger71497d02012-12-11 22:16:31 -06004110- CONFIG_ENV_FLAGS_LIST_DEFAULT
4111- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004112 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004113 calling env set. Variables can be restricted to only decimal,
4114 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4115 the variables can also be restricted to IP address or MAC address.
4116
4117 The format of the list is:
4118 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004119 access_attribute = [a|r|o|c]
4120 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004121 entry = variable_name[:attributes]
4122 list = entry[,list]
4123
4124 The type attributes are:
4125 s - String (default)
4126 d - Decimal
4127 x - Hexadecimal
4128 b - Boolean ([1yYtT|0nNfF])
4129 i - IP address
4130 m - MAC address
4131
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004132 The access attributes are:
4133 a - Any (default)
4134 r - Read-only
4135 o - Write-once
4136 c - Change-default
4137
Joe Hershberger71497d02012-12-11 22:16:31 -06004138 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4139 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004140 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004141
4142 - CONFIG_ENV_FLAGS_LIST_STATIC
4143 Define this to a list (string) to define validation that
4144 should be done if an entry is not found in the ".flags"
4145 environment variable. To override a setting in the static
4146 list, simply add an entry for the same variable name to the
4147 ".flags" variable.
4148
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004149 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4150 regular expression. This allows multiple variables to define the same
4151 flags without explicitly listing them for each variable.
4152
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004153- CONFIG_ENV_ACCESS_IGNORE_FORCE
4154 If defined, don't allow the -f switch to env set override variable
4155 access flags.
4156
Simon Glass66828322013-03-08 13:45:27 +00004157- CONFIG_SYS_GENERIC_BOARD
4158 This selects the architecture-generic board system instead of the
4159 architecture-specific board files. It is intended to move boards
4160 to this new framework over time. Defining this will disable the
4161 arch/foo/lib/board.c file and use common/board_f.c and
4162 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004163 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4164 If you find problems enabling this option on your board please report
4165 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004166
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004167- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4168 This is set by OMAP boards for the max time that reset should
4169 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004170 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004171
Gabe Black3687fe42014-10-15 04:38:30 -06004172- CONFIG_USE_STDINT
4173 If stdint.h is available with your toolchain you can define this
4174 option to enable it. You can provide option 'USE_STDINT=1' when
4175 building U-Boot to enable this.
4176
wdenkc6097192002-11-03 00:24:07 +00004177The following definitions that deal with the placement and management
4178of environment data (variable area); in general, we support the
4179following configurations:
4180
Mike Frysinger63b8f122011-07-08 10:44:25 +00004181- CONFIG_BUILD_ENVCRC:
4182
4183 Builds up envcrc with the target environment so that external utils
4184 may easily extract it and embed it in final U-Boot images.
4185
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004186- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004187
4188 Define this if the environment is in flash memory.
4189
4190 a) The environment occupies one whole flash sector, which is
4191 "embedded" in the text segment with the U-Boot code. This
4192 happens usually with "bottom boot sector" or "top boot
4193 sector" type flash chips, which have several smaller
4194 sectors at the start or the end. For instance, such a
4195 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4196 such a case you would place the environment in one of the
4197 4 kB sectors - with U-Boot code before and after it. With
4198 "top boot sector" type flash chips, you would put the
4199 environment in one of the last sectors, leaving a gap
4200 between U-Boot and the environment.
4201
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004202 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004203
4204 Offset of environment data (variable area) to the
4205 beginning of flash memory; for instance, with bottom boot
4206 type flash chips the second sector can be used: the offset
4207 for this sector is given here.
4208
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004209 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004210
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004211 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004212
4213 This is just another way to specify the start address of
4214 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004215 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004216
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004217 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004218
4219 Size of the sector containing the environment.
4220
4221
4222 b) Sometimes flash chips have few, equal sized, BIG sectors.
4223 In such a case you don't want to spend a whole sector for
4224 the environment.
4225
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004226 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004227
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004228 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004229 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004230 of this flash sector for the environment. This saves
4231 memory for the RAM copy of the environment.
4232
4233 It may also save flash memory if you decide to use this
4234 when your environment is "embedded" within U-Boot code,
4235 since then the remainder of the flash sector could be used
4236 for U-Boot code. It should be pointed out that this is
4237 STRONGLY DISCOURAGED from a robustness point of view:
4238 updating the environment in flash makes it always
4239 necessary to erase the WHOLE sector. If something goes
4240 wrong before the contents has been restored from a copy in
4241 RAM, your target system will be dead.
4242
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004243 - CONFIG_ENV_ADDR_REDUND
4244 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk4a5c8a72003-03-06 00:02:04 +00004246 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004247 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004248 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004249 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004250
4251BE CAREFUL! Any changes to the flash layout, and some changes to the
4252source code will make it necessary to adapt <board>/u-boot.lds*
4253accordingly!
4254
4255
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004256- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004257
4258 Define this if you have some non-volatile memory device
4259 (NVRAM, battery buffered SRAM) which you want to use for the
4260 environment.
4261
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004262 - CONFIG_ENV_ADDR:
4263 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004264
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004265 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004266 want to use for environment. It is assumed that this memory
4267 can just be read and written to, without any special
4268 provision.
4269
4270BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004271in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004272console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004273U-Boot will hang.
4274
4275Please note that even with NVRAM we still use a copy of the
4276environment in RAM: we could work on NVRAM directly, but we want to
4277keep settings there always unmodified except somebody uses "saveenv"
4278to save the current settings.
4279
4280
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004281- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004282
4283 Use this if you have an EEPROM or similar serial access
4284 device and a driver for it.
4285
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004286 - CONFIG_ENV_OFFSET:
4287 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004288
4289 These two #defines specify the offset and size of the
4290 environment area within the total memory of your EEPROM.
4291
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004292 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004293 If defined, specified the chip address of the EEPROM device.
4294 The default address is zero.
4295
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004296 - CONFIG_SYS_I2C_EEPROM_BUS:
4297 If defined, specified the i2c bus of the EEPROM device.
4298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004299 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004300 If defined, the number of bits used to address bytes in a
4301 single page in the EEPROM device. A 64 byte page, for example
4302 would require six bits.
4303
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004304 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004305 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004306 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004308 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004309 The length in bytes of the EEPROM memory array address. Note
4310 that this is NOT the chip address length!
4311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004312 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004313 EEPROM chips that implement "address overflow" are ones
4314 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4315 address and the extra bits end up in the "chip address" bit
4316 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4317 byte chips.
4318
4319 Note that we consider the length of the address field to
4320 still be one byte because the extra address bits are hidden
4321 in the chip address.
4322
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004323 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004324 The size in bytes of the EEPROM device.
4325
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004326 - CONFIG_ENV_EEPROM_IS_ON_I2C
4327 define this, if you have I2C and SPI activated, and your
4328 EEPROM, which holds the environment, is on the I2C bus.
4329
4330 - CONFIG_I2C_ENV_EEPROM_BUS
4331 if you have an Environment on an EEPROM reached over
4332 I2C muxes, you can define here, how to reach this
4333 EEPROM. For example:
4334
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004335 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004336
4337 EEPROM which holds the environment, is reached over
4338 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004339
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004340- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004341
wdenk1ebf41e2004-01-02 14:00:00 +00004342 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004343 want to use for the environment.
4344
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004345 - CONFIG_ENV_OFFSET:
4346 - CONFIG_ENV_ADDR:
4347 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004348
4349 These three #defines specify the offset and size of the
4350 environment area within the total memory of your DataFlash placed
4351 at the specified address.
4352
Wu, Josh76db7bf2014-07-01 19:30:13 +08004353- CONFIG_ENV_IS_IN_SPI_FLASH:
4354
4355 Define this if you have a SPI Flash memory device which you
4356 want to use for the environment.
4357
4358 - CONFIG_ENV_OFFSET:
4359 - CONFIG_ENV_SIZE:
4360
4361 These two #defines specify the offset and size of the
4362 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4363 aligned to an erase sector boundary.
4364
4365 - CONFIG_ENV_SECT_SIZE:
4366
4367 Define the SPI flash's sector size.
4368
4369 - CONFIG_ENV_OFFSET_REDUND (optional):
4370
4371 This setting describes a second storage area of CONFIG_ENV_SIZE
4372 size used to hold a redundant copy of the environment data, so
4373 that there is a valid backup copy in case there is a power failure
4374 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4375 aligned to an erase sector boundary.
4376
4377 - CONFIG_ENV_SPI_BUS (optional):
4378 - CONFIG_ENV_SPI_CS (optional):
4379
4380 Define the SPI bus and chip select. If not defined they will be 0.
4381
4382 - CONFIG_ENV_SPI_MAX_HZ (optional):
4383
4384 Define the SPI max work clock. If not defined then use 1MHz.
4385
4386 - CONFIG_ENV_SPI_MODE (optional):
4387
4388 Define the SPI work mode. If not defined then use SPI_MODE_3.
4389
Liu Gang85bcd732012-03-08 00:33:20 +00004390- CONFIG_ENV_IS_IN_REMOTE:
4391
4392 Define this if you have a remote memory space which you
4393 want to use for the local device's environment.
4394
4395 - CONFIG_ENV_ADDR:
4396 - CONFIG_ENV_SIZE:
4397
4398 These two #defines specify the address and size of the
4399 environment area within the remote memory space. The
4400 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004401 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004402
4403BE CAREFUL! For some special cases, the local device can not use
4404"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004405environment stored in a remote NOR flash by SRIO or PCIE link,
4406but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004407
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004408- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004409
4410 Define this if you have a NAND device which you want to use
4411 for the environment.
4412
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004413 - CONFIG_ENV_OFFSET:
4414 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004415
4416 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004417 area within the first NAND device. CONFIG_ENV_OFFSET must be
4418 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004419
Scott Wood08239322010-09-17 14:38:37 -05004420 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004421
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004422 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004423 size used to hold a redundant copy of the environment data, so
4424 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004425 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004426 aligned to an erase block boundary.
4427
4428 - CONFIG_ENV_RANGE (optional):
4429
4430 Specifies the length of the region in which the environment
4431 can be written. This should be a multiple of the NAND device's
4432 block size. Specifying a range with more erase blocks than
4433 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4434 the range to be avoided.
4435
4436 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004437
Scott Wood08239322010-09-17 14:38:37 -05004438 Enables support for dynamically retrieving the offset of the
4439 environment from block zero's out-of-band data. The
4440 "nand env.oob" command can be used to record this offset.
4441 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4442 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004443
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004444- CONFIG_NAND_ENV_DST
4445
4446 Defines address in RAM to which the nand_spl code should copy the
4447 environment. If redundant environment is used, it will be copied to
4448 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4449
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004450- CONFIG_ENV_IS_IN_UBI:
4451
4452 Define this if you have an UBI volume that you want to use for the
4453 environment. This has the benefit of wear-leveling the environment
4454 accesses, which is important on NAND.
4455
4456 - CONFIG_ENV_UBI_PART:
4457
4458 Define this to a string that is the mtd partition containing the UBI.
4459
4460 - CONFIG_ENV_UBI_VOLUME:
4461
4462 Define this to the name of the volume that you want to store the
4463 environment in.
4464
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004465 - CONFIG_ENV_UBI_VOLUME_REDUND:
4466
4467 Define this to the name of another volume to store a second copy of
4468 the environment in. This will enable redundant environments in UBI.
4469 It is assumed that both volumes are in the same MTD partition.
4470
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004471 - CONFIG_UBI_SILENCE_MSG
4472 - CONFIG_UBIFS_SILENCE_MSG
4473
4474 You will probably want to define these to avoid a really noisy system
4475 when storing the env in UBI.
4476
Wu, Josha7d0c872014-06-24 17:31:03 +08004477- CONFIG_ENV_IS_IN_FAT:
4478 Define this if you want to use the FAT file system for the environment.
4479
4480 - FAT_ENV_INTERFACE:
4481
4482 Define this to a string that is the name of the block device.
4483
4484 - FAT_ENV_DEV_AND_PART:
4485
4486 Define this to a string to specify the partition of the device. It can
4487 be as following:
4488
4489 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4490 - "D:P": device D partition P. Error occurs if device D has no
4491 partition table.
4492 - "D:0": device D.
4493 - "D" or "D:": device D partition 1 if device D has partition
4494 table, or the whole device D if has no partition
4495 table.
4496 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004497 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004498 partition table then means device D.
4499
4500 - FAT_ENV_FILE:
4501
4502 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004503 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004504
4505 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004506 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004507
Stephen Warreneedcacd2013-06-11 15:14:00 -06004508- CONFIG_ENV_IS_IN_MMC:
4509
4510 Define this if you have an MMC device which you want to use for the
4511 environment.
4512
4513 - CONFIG_SYS_MMC_ENV_DEV:
4514
4515 Specifies which MMC device the environment is stored in.
4516
4517 - CONFIG_SYS_MMC_ENV_PART (optional):
4518
4519 Specifies which MMC partition the environment is stored in. If not
4520 set, defaults to partition 0, the user area. Common values might be
4521 1 (first MMC boot partition), 2 (second MMC boot partition).
4522
4523 - CONFIG_ENV_OFFSET:
4524 - CONFIG_ENV_SIZE:
4525
4526 These two #defines specify the offset and size of the environment
4527 area within the specified MMC device.
4528
Stephen Warren24dc2032013-06-11 15:14:02 -06004529 If offset is positive (the usual case), it is treated as relative to
4530 the start of the MMC partition. If offset is negative, it is treated
4531 as relative to the end of the MMC partition. This can be useful if
4532 your board may be fitted with different MMC devices, which have
4533 different sizes for the MMC partitions, and you always want the
4534 environment placed at the very end of the partition, to leave the
4535 maximum possible space before it, to store other data.
4536
Stephen Warreneedcacd2013-06-11 15:14:00 -06004537 These two values are in units of bytes, but must be aligned to an
4538 MMC sector boundary.
4539
4540 - CONFIG_ENV_OFFSET_REDUND (optional):
4541
4542 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4543 hold a redundant copy of the environment data. This provides a
4544 valid backup copy in case the other copy is corrupted, e.g. due
4545 to a power failure during a "saveenv" operation.
4546
Stephen Warren24dc2032013-06-11 15:14:02 -06004547 This value may also be positive or negative; this is handled in the
4548 same way as CONFIG_ENV_OFFSET.
4549
Stephen Warreneedcacd2013-06-11 15:14:00 -06004550 This value is also in units of bytes, but must also be aligned to
4551 an MMC sector boundary.
4552
4553 - CONFIG_ENV_SIZE_REDUND (optional):
4554
4555 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4556 set. If this value is set, it must be set to the same value as
4557 CONFIG_ENV_SIZE.
4558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004559- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004560
4561 Defines offset to the initial SPI buffer area in DPRAM. The
4562 area is used at an early stage (ROM part) if the environment
4563 is configured to reside in the SPI EEPROM: We need a 520 byte
4564 scratch DPRAM area. It is used between the two initialization
4565 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4566 to be a good choice since it makes it far enough from the
4567 start of the data area as well as from the stack pointer.
4568
Bruce Adleredecc942007-11-02 13:15:42 -07004569Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004570has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004571created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004572until then to read environment variables.
4573
wdenk8dba0502003-03-31 16:34:49 +00004574The environment is protected by a CRC32 checksum. Before the monitor
4575is relocated into RAM, as a result of a bad CRC you will be working
4576with the compiled-in default environment - *silently*!!! [This is
4577necessary, because the first environment variable we need is the
4578"baudrate" setting for the console - if we have a bad CRC, we don't
4579have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004580
4581Note: once the monitor has been relocated, then it will complain if
4582the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004583use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004584
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004585- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004586 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004587
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004588 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004589 also needs to be defined.
4590
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004591- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004592 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004593
Ron Madriddfa028a2009-02-18 14:30:44 -08004594- CONFIG_NS16550_MIN_FUNCTIONS:
4595 Define this if you desire to only have use of the NS16550_init
4596 and NS16550_putc functions for the serial driver located at
4597 drivers/serial/ns16550.c. This option is useful for saving
4598 space for already greatly restricted images, including but not
4599 limited to NAND_SPL configurations.
4600
Simon Glass28a9e332012-11-30 13:01:18 +00004601- CONFIG_DISPLAY_BOARDINFO
4602 Display information about the board that U-Boot is running on
4603 when U-Boot starts up. The board function checkboard() is called
4604 to do this.
4605
Simon Glasse8822012012-11-30 13:01:19 +00004606- CONFIG_DISPLAY_BOARDINFO_LATE
4607 Similar to the previous option, but display this information
4608 later, once stdio is running and output goes to the LCD, if
4609 present.
4610
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004611- CONFIG_BOARD_SIZE_LIMIT:
4612 Maximum size of the U-Boot image. When defined, the
4613 build system checks that the actual size does not
4614 exceed it.
4615
wdenkc6097192002-11-03 00:24:07 +00004616Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004617---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004619- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004620 Cache Line Size of the CPU.
4621
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004622- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004623 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004624
wdenk9c53f402003-10-15 23:53:47 +00004625 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4626 and RPXsuper) to be able to adjust the position of
4627 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004628
Timur Tabid8f341c2011-08-04 18:03:41 -05004629- CONFIG_SYS_CCSRBAR_DEFAULT:
4630 Default (power-on reset) physical address of CCSR on Freescale
4631 PowerPC SOCs.
4632
4633- CONFIG_SYS_CCSRBAR:
4634 Virtual address of CCSR. On a 32-bit build, this is typically
4635 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4636
4637 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4638 for cross-platform code that uses that macro instead.
4639
4640- CONFIG_SYS_CCSRBAR_PHYS:
4641 Physical address of CCSR. CCSR can be relocated to a new
4642 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004643 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004644 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4645 is typically relocated on 36-bit builds. It is recommended
4646 that this macro be defined via the _HIGH and _LOW macros:
4647
4648 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4649 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4650
4651- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004652 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4653 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004654 used in assembly code, so it must not contain typecasts or
4655 integer size suffixes (e.g. "ULL").
4656
4657- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4658 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4659 used in assembly code, so it must not contain typecasts or
4660 integer size suffixes (e.g. "ULL").
4661
4662- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4663 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4664 forced to a value that ensures that CCSR is not relocated.
4665
wdenk1272e232002-11-10 22:06:23 +00004666- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004667 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004668
4669 the default drive number (default value 0)
4670
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004671 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004672
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004673 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004674 (default value 1)
4675
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004676 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004677
wdenk4a5c8a72003-03-06 00:02:04 +00004678 defines the offset of register from address. It
4679 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004680 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004681
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004682 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4683 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004684 default value.
wdenk1272e232002-11-10 22:06:23 +00004685
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004686 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004687 fdc_hw_init() is called at the beginning of the FDC
4688 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004689 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004690 initializations.
wdenk1272e232002-11-10 22:06:23 +00004691
Macpaul Lind1e49942011-04-11 20:45:32 +00004692- CONFIG_IDE_AHB:
4693 Most IDE controllers were designed to be connected with PCI
4694 interface. Only few of them were designed for AHB interface.
4695 When software is doing ATA command and data transfer to
4696 IDE devices through IDE-AHB controller, some additional
4697 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004698 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004700- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004701 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004702 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004705
wdenkeb20ad32003-09-05 23:19:14 +00004706 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004707 initial data and stack; please note that this must be
4708 writable memory that is working WITHOUT special
4709 initialization, i. e. you CANNOT use normal RAM which
4710 will become available only after programming the
4711 memory controller and running certain initialization
4712 sequences.
4713
4714 U-Boot uses the following memory types:
4715 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4716 - MPC824X: data cache
4717 - PPC4xx: data cache
4718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004719- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004720
4721 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004722 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4723 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004724 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004725 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004726 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4727 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4728 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004729
4730 Note:
4731 On the MPC824X (or other systems that use the data
4732 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004733 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004734 point to an otherwise UNUSED address space between
4735 the top of RAM and the start of the PCI space.
4736
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004737- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004738
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004739- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004740
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004741- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004743- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004744
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004745- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004746
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004747- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004748
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004749- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004750 SDRAM timing
4751
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004752- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004753 periodic timer for refresh
4754
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004755- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004757- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4758 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4759 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4760 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004761 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4762
4763- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004764 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4765 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004766 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004768- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4769 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004770 Machine Mode Register and Memory Periodic Timer
4771 Prescaler definitions (SDRAM timing)
4772
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004773- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004774 enable I2C microcode relocation patch (MPC8xx);
4775 define relocation offset in DPRAM [DSP2]
4776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004777- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004778 enable SMC microcode relocation patch (MPC8xx);
4779 define relocation offset in DPRAM [SMC1]
4780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004781- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004782 enable SPI microcode relocation patch (MPC8xx);
4783 define relocation offset in DPRAM [SCC4]
4784
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004785- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004786 Use OSCM clock mode on MBX8xx board. Be careful,
4787 wrong setting might damage your board. Read
4788 doc/README.MBX before setting this variable!
4789
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004790- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004791 Offset of the bootmode word in DPRAM used by post
4792 (Power On Self Tests). This definition overrides
4793 #define'd default value in commproc.h resp.
4794 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004795
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004796- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4797 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4798 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4799 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4800 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4801 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4802 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4803 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004804 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004805
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004806- CONFIG_PCI_DISABLE_PCIE:
4807 Disable PCI-Express on systems where it is supported but not
4808 required.
4809
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004810- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004811 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004812 Don't do any setup work, presumably because someone or
4813 something has already done it, and we don't need to do it
4814 a second time. Useful for platforms that are pre-booted
4815 by coreboot or similar.
4816
Gabor Juhosb4458732013-05-30 07:06:12 +00004817- CONFIG_PCI_INDIRECT_BRIDGE:
4818 Enable support for indirect PCI bridges.
4819
Kumar Gala8975d7a2010-12-30 12:09:53 -06004820- CONFIG_SYS_SRIO:
4821 Chip has SRIO or not
4822
4823- CONFIG_SRIO1:
4824 Board has SRIO 1 port available
4825
4826- CONFIG_SRIO2:
4827 Board has SRIO 2 port available
4828
Liu Gang27afb9c2013-05-07 16:30:46 +08004829- CONFIG_SRIO_PCIE_BOOT_MASTER
4830 Board can support master function for Boot from SRIO and PCIE
4831
Kumar Gala8975d7a2010-12-30 12:09:53 -06004832- CONFIG_SYS_SRIOn_MEM_VIRT:
4833 Virtual Address of SRIO port 'n' memory region
4834
4835- CONFIG_SYS_SRIOn_MEM_PHYS:
4836 Physical Address of SRIO port 'n' memory region
4837
4838- CONFIG_SYS_SRIOn_MEM_SIZE:
4839 Size of SRIO port 'n' memory region
4840
Fabio Estevamf17e8782013-04-11 09:35:34 +00004841- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4842 Defined to tell the NAND controller that the NAND chip is using
4843 a 16 bit bus.
4844 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004845 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004846 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004847 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004848
4849- CONFIG_SYS_NDFC_EBC0_CFG
4850 Sets the EBC0_CFG register for the NDFC. If not defined
4851 a default value will be used.
4852
Ben Warren45657152006-09-07 16:50:54 -04004853- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004854 Get DDR timing information from an I2C EEPROM. Common
4855 with pluggable memory modules such as SODIMMs
4856
Ben Warren45657152006-09-07 16:50:54 -04004857 SPD_EEPROM_ADDRESS
4858 I2C address of the SPD EEPROM
4859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004860- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004861 If SPD EEPROM is on an I2C bus other than the first
4862 one, specify here. Note that the value must resolve
4863 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004864
York Sune73cc042011-06-07 09:42:16 +08004865- CONFIG_SYS_DDR_RAW_TIMING
4866 Get DDR timing information from other than SPD. Common with
4867 soldered DDR chips onboard without SPD. DDR raw timing
4868 parameters are extracted from datasheet and hard-coded into
4869 header files or board specific files.
4870
York Sunbd495cf2011-09-16 13:21:35 -07004871- CONFIG_FSL_DDR_INTERACTIVE
4872 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4873
York Sun8ced0502015-01-06 13:18:55 -08004874- CONFIG_FSL_DDR_SYNC_REFRESH
4875 Enable sync of refresh for multiple controllers.
4876
York Sunb6a35f82015-03-19 09:30:28 -07004877- CONFIG_FSL_DDR_BIST
4878 Enable built-in memory test for Freescale DDR controllers.
4879
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004880- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004881 Only for 83xx systems. If specified, then DDR should
4882 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004883
wdenk6203e402004-04-18 10:13:26 +00004884- CONFIG_ETHER_ON_FEC[12]
4885 Define to enable FEC[12] on a 8xx series processor.
4886
4887- CONFIG_FEC[12]_PHY
4888 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004889 to the given FEC; i. e.
4890 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004891 means that the PHY with address 4 is connected to FEC1
4892
4893 When set to -1, means to probe for first available.
4894
4895- CONFIG_FEC[12]_PHY_NORXERR
4896 The PHY does not have a RXERR line (RMII only).
4897 (so program the FEC to ignore it).
4898
4899- CONFIG_RMII
4900 Enable RMII mode for all FECs.
4901 Note that this is a global option, we can't
4902 have one FEC in standard MII mode and another in RMII mode.
4903
wdenk20c98a62004-04-23 20:32:05 +00004904- CONFIG_CRC32_VERIFY
4905 Add a verify option to the crc32 command.
4906 The syntax is:
4907
4908 => crc32 -v <address> <count> <crc32>
4909
4910 Where address/count indicate a memory area
4911 and crc32 is the correct crc32 which the
4912 area should have.
4913
wdenk64519362004-07-11 17:40:54 +00004914- CONFIG_LOOPW
4915 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004916 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004917
stroesecc3af832004-12-16 18:46:55 +00004918- CONFIG_MX_CYCLIC
4919 Add the "mdc" and "mwc" memory commands. These are cyclic
4920 "md/mw" commands.
4921 Examples:
4922
wdenk07d7e6b2004-12-16 21:44:03 +00004923 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004924 This command will print 4 bytes (10,11,12,13) each 500 ms.
4925
wdenk07d7e6b2004-12-16 21:44:03 +00004926 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004927 This command will write 12345678 to address 100 all 10 ms.
4928
wdenk07d7e6b2004-12-16 21:44:03 +00004929 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004930 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004931
wdenk3d3d99f2005-04-04 12:44:11 +00004932- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004933 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004934 low level initializations (like setting up the memory
4935 controller) are omitted and/or U-Boot does not
4936 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004937
Wolfgang Denk302141d2010-11-27 23:30:56 +01004938 Normally this variable MUST NOT be defined. The only
4939 exception is when U-Boot is loaded (to RAM) by some
4940 other boot loader or by a debugger which performs
4941 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004942
Aneesh V552a3192011-07-13 05:11:07 +00004943- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004944 Modifies the behaviour of start.S when compiling a loader
4945 that is executed before the actual U-Boot. E.g. when
4946 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004947
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004948- CONFIG_TPL_BUILD
4949 Modifies the behaviour of start.S when compiling a loader
4950 that is executed after the SPL and before the actual U-Boot.
4951 It is loaded by the SPL.
4952
Ying Zhang0d4f5442013-05-20 14:07:23 +08004953- CONFIG_SYS_MPC85XX_NO_RESETVEC
4954 Only for 85xx systems. If this variable is specified, the section
4955 .resetvec is not kept and the section .bootpg is placed in the
4956 previous 4k of the .text section.
4957
Simon Glass17dabf02013-02-24 17:33:14 +00004958- CONFIG_ARCH_MAP_SYSMEM
4959 Generally U-Boot (and in particular the md command) uses
4960 effective address. It is therefore not necessary to regard
4961 U-Boot address as virtual addresses that need to be translated
4962 to physical addresses. However, sandbox requires this, since
4963 it maintains its own little RAM buffer which contains all
4964 addressable memory. This option causes some memory accesses
4965 to be mapped through map_sysmem() / unmap_sysmem().
4966
Matthias Weisser93416c12011-03-10 21:36:32 +00004967- CONFIG_USE_ARCH_MEMCPY
4968 CONFIG_USE_ARCH_MEMSET
4969 If these options are used a optimized version of memcpy/memset will
4970 be used if available. These functions may be faster under some
4971 conditions but may increase the binary size.
4972
Simon Glassbfb59802013-02-14 04:18:54 +00004973- CONFIG_X86_RESET_VECTOR
4974 If defined, the x86 reset vector code is included. This is not
4975 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004976
Mark Jackson52b003c2013-03-04 01:27:20 +00004977- CONFIG_SYS_MPUCLK
4978 Defines the MPU clock speed (in MHz).
4979
4980 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004981
Heiko Schocher2233e462013-11-04 14:05:00 +01004982- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4983 Enables the RTC32K OSC on AM33xx based plattforms
4984
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004985- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4986 Option to disable subpage write in NAND driver
4987 driver that uses this:
4988 drivers/mtd/nand/davinci_nand.c
4989
Timur Tabi275f4bb2011-11-22 09:21:25 -06004990Freescale QE/FMAN Firmware Support:
4991-----------------------------------
4992
4993The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4994loading of "firmware", which is encoded in the QE firmware binary format.
4995This firmware often needs to be loaded during U-Boot booting, so macros
4996are used to identify the storage device (NOR flash, SPI, etc) and the address
4997within that device.
4998
Zhao Qiang83a90842014-03-21 16:21:44 +08004999- CONFIG_SYS_FMAN_FW_ADDR
5000 The address in the storage device where the FMAN microcode is located. The
5001 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5002 is also specified.
5003
5004- CONFIG_SYS_QE_FW_ADDR
5005 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005006 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5007 is also specified.
5008
5009- CONFIG_SYS_QE_FMAN_FW_LENGTH
5010 The maximum possible size of the firmware. The firmware binary format
5011 has a field that specifies the actual size of the firmware, but it
5012 might not be possible to read any part of the firmware unless some
5013 local storage is allocated to hold the entire firmware first.
5014
5015- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5016 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5017 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5018 virtual address in NOR flash.
5019
5020- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5021 Specifies that QE/FMAN firmware is located in NAND flash.
5022 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5023
5024- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5025 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5026 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5027
5028- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5029 Specifies that QE/FMAN firmware is located on the primary SPI
5030 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5031
Liu Gang1e084582012-03-08 00:33:18 +00005032- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5033 Specifies that QE/FMAN firmware is located in the remote (master)
5034 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005035 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5036 window->master inbound window->master LAW->the ucode address in
5037 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005038
J. German Rivera8ff14b72014-06-23 15:15:55 -07005039Freescale Layerscape Management Complex Firmware Support:
5040---------------------------------------------------------
5041The Freescale Layerscape Management Complex (MC) supports the loading of
5042"firmware".
5043This firmware often needs to be loaded during U-Boot booting, so macros
5044are used to identify the storage device (NOR flash, SPI, etc) and the address
5045within that device.
5046
5047- CONFIG_FSL_MC_ENET
5048 Enable the MC driver for Layerscape SoCs.
5049
5050- CONFIG_SYS_LS_MC_FW_ADDR
5051 The address in the storage device where the firmware is located. The
5052 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5053 is also specified.
5054
5055- CONFIG_SYS_LS_MC_FW_LENGTH
5056 The maximum possible size of the firmware. The firmware binary format
5057 has a field that specifies the actual size of the firmware, but it
5058 might not be possible to read any part of the firmware unless some
5059 local storage is allocated to hold the entire firmware first.
5060
5061- CONFIG_SYS_LS_MC_FW_IN_NOR
5062 Specifies that MC firmware is located in NOR flash, mapped as
5063 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5064 virtual address in NOR flash.
5065
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05305066Freescale Layerscape Debug Server Support:
5067-------------------------------------------
5068The Freescale Layerscape Debug Server Support supports the loading of
5069"Debug Server firmware" and triggering SP boot-rom.
5070This firmware often needs to be loaded during U-Boot booting.
5071
5072- CONFIG_FSL_DEBUG_SERVER
5073 Enable the Debug Server for Layerscape SoCs.
5074
5075- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
5076 Define minimum DDR size required for debug server image
5077
5078- CONFIG_SYS_MEM_TOP_HIDE_MIN
5079 Define minimum DDR size to be hided from top of the DDR memory
5080
wdenkc6097192002-11-03 00:24:07 +00005081Building the Software:
5082======================
5083
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005084Building U-Boot has been tested in several native build environments
5085and in many different cross environments. Of course we cannot support
5086all possibly existing versions of cross development tools in all
5087(potentially obsolete) versions. In case of tool chain problems we
5088recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5089which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005090
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005091If you are not using a native environment, it is assumed that you
5092have GNU cross compiling tools available in your path. In this case,
5093you must set the environment variable CROSS_COMPILE in your shell.
5094Note that no changes to the Makefile or any other source files are
5095necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005096
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005097 $ CROSS_COMPILE=ppc_4xx-
5098 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005099
Peter Tyserb06976d2009-03-13 18:54:51 -05005100Note: If you wish to generate Windows versions of the utilities in
5101 the tools directory you can use the MinGW toolchain
5102 (http://www.mingw.org). Set your HOST tools to the MinGW
5103 toolchain and execute 'make tools'. For example:
5104
5105 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5106
5107 Binaries such as tools/mkimage.exe will be created which can
5108 be executed on computers running Windows.
5109
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005110U-Boot is intended to be simple to build. After installing the
5111sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005112is done by typing:
5113
Holger Freyther7ba4e572014-08-04 09:26:05 +02005114 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005115
Holger Freyther7ba4e572014-08-04 09:26:05 +02005116where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005117rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005118
wdenk6c59edc2004-05-03 20:45:30 +00005119Note: for some board special configuration names may exist; check if
5120 additional information is available from the board vendor; for
5121 instance, the TQM823L systems are available without (standard)
5122 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005123 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005124
Holger Freyther7ba4e572014-08-04 09:26:05 +02005125 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005126 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005127
Holger Freyther7ba4e572014-08-04 09:26:05 +02005128 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005129 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk6c59edc2004-05-03 20:45:30 +00005131 etc.
wdenkc6097192002-11-03 00:24:07 +00005132
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk6c59edc2004-05-03 20:45:30 +00005134Finally, type "make all", and you should get some working U-Boot
5135images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005136
wdenk6c59edc2004-05-03 20:45:30 +00005137- "u-boot.bin" is a raw binary image
5138- "u-boot" is an image in ELF binary format
5139- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005140
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005141By default the build is performed locally and the objects are saved
5142in the source directory. One of the two methods can be used to change
5143this behavior and build U-Boot to some external directory:
5144
51451. Add O= to the make command line invocations:
5146
5147 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005148 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005149 make O=/tmp/build all
5150
Timo Ketolac8c67602014-11-06 14:39:05 +020051512. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005152
Timo Ketolac8c67602014-11-06 14:39:05 +02005153 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005154 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005155 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005156 make all
5157
Timo Ketolac8c67602014-11-06 14:39:05 +02005158Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005159variable.
5160
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk6c59edc2004-05-03 20:45:30 +00005162Please be aware that the Makefiles assume you are using GNU make, so
5163for instance on NetBSD you might need to use "gmake" instead of
5164native "make".
wdenkc6097192002-11-03 00:24:07 +00005165
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167If the system board that you have is not listed, then you will need
5168to port U-Boot to your hardware platform. To do this, follow these
5169steps:
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk6c59edc2004-05-03 20:45:30 +000051711. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005172 "boards.cfg" file, using the existing entries as examples.
5173 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000051742. Create a new directory to hold your board specific code. Add any
5175 files you need. In your board directory, you will need at least
5176 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51773. Create a new configuration file "include/configs/<board>.h" for
5178 your board
51793. If you're porting U-Boot to a new CPU, then also create a new
5180 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051814. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051825. Type "make", and you should get a working "u-boot.srec" file
5183 to be installed on your target system.
51846. Debug and solve any problems that might arise.
5185 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005186
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5189==============================================================
wdenkc6097192002-11-03 00:24:07 +00005190
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005191If you have modified U-Boot sources (for instance added a new board
5192or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005193provide feedback to the other developers. The feedback normally takes
5194the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005195official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005196
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005197But before you submit such a patch, please verify that your modifi-
5198cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005199the supported boards compile WITHOUT ANY compiler warnings. To do so,
5200just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005201for ALL supported system. Be warned, this will take a while. You can
5202select which (cross) compiler to use by passing a `CROSS_COMPILE'
5203environment variable to the script, i. e. to use the ELDK cross tools
5204you can type
wdenkc6097192002-11-03 00:24:07 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk6c59edc2004-05-03 20:45:30 +00005210 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005211
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005212When using the MAKEALL script, the default behaviour is to build
5213U-Boot in the source directory. This location can be changed by
5214setting the BUILD_DIR environment variable. Also, for each target
5215built, the MAKEALL script saves two log files (<target>.ERR and
5216<target>.MAKEALL) in the <source dir>/LOG directory. This default
5217location can be changed by setting the MAKEALL_LOGDIR environment
5218variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005219
5220 export BUILD_DIR=/tmp/build
5221 export MAKEALL_LOGDIR=/tmp/log
5222 CROSS_COMPILE=ppc_8xx- MAKEALL
5223
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005224With the above settings build objects are saved in the /tmp/build,
5225log files are saved in the /tmp/log and the source tree remains clean
5226during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005227
5228
wdenk6c59edc2004-05-03 20:45:30 +00005229See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005230
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232Monitor Commands - Overview:
5233============================
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk6c59edc2004-05-03 20:45:30 +00005235go - start application at address 'addr'
5236run - run commands in an environment variable
5237bootm - boot application image from memory
5238bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005239bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005240tftpboot- boot image via network using TFTP protocol
5241 and env variables "ipaddr" and "serverip"
5242 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005243tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005244rarpboot- boot image via network using RARP/TFTP protocol
5245diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5246loads - load S-Record file over serial line
5247loadb - load binary file over serial line (kermit mode)
5248md - memory display
5249mm - memory modify (auto-incrementing)
5250nm - memory modify (constant address)
5251mw - memory write (fill)
5252cp - memory copy
5253cmp - memory compare
5254crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005255i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005256sspi - SPI utility commands
5257base - print or set address offset
5258printenv- print environment variables
5259setenv - set environment variables
5260saveenv - save environment variables to persistent storage
5261protect - enable or disable FLASH write protection
5262erase - erase FLASH memory
5263flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005264nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005265bdinfo - print Board Info structure
5266iminfo - print header information for application image
5267coninfo - print console devices and informations
5268ide - IDE sub-system
5269loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005270loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005271mtest - simple RAM test
5272icache - enable or disable instruction cache
5273dcache - enable or disable data cache
5274reset - Perform RESET of the CPU
5275echo - echo args to console
5276version - print monitor version
5277help - print online help
5278? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005279
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281Monitor Commands - Detailed Description:
5282========================================
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284TODO.
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk6c59edc2004-05-03 20:45:30 +00005286For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005287
5288
wdenk6c59edc2004-05-03 20:45:30 +00005289Environment Variables:
5290======================
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292U-Boot supports user configuration using Environment Variables which
5293can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295Environment Variables are set using "setenv", printed using
5296"printenv", and saved to Flash using "saveenv". Using "setenv"
5297without a value can be used to delete a variable from the
5298environment. As long as you don't save the environment you are
5299working with an in-memory copy. In case the Flash area containing the
5300environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005301
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005302Some configuration options can be set using Environment Variables.
5303
5304List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk6c59edc2004-05-03 20:45:30 +00005306 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk6c59edc2004-05-03 20:45:30 +00005308 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk6c59edc2004-05-03 20:45:30 +00005312 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk6c59edc2004-05-03 20:45:30 +00005314 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005315
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005316 bootm_low - Memory range available for image processing in the bootm
5317 command can be restricted. This variable is given as
5318 a hexadecimal number and defines lowest address allowed
5319 for use by the bootm command. See also "bootm_size"
5320 environment variable. Address defined by "bootm_low" is
5321 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005322 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5323 bootm_mapsize.
5324
Wolfgang Denk092ae952011-10-26 10:21:21 +00005325 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005326 This variable is given as a hexadecimal number and it
5327 defines the size of the memory region starting at base
5328 address bootm_low that is accessible by the Linux kernel
5329 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5330 as the default value if it is defined, and bootm_size is
5331 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005332
5333 bootm_size - Memory range available for image processing in the bootm
5334 command can be restricted. This variable is given as
5335 a hexadecimal number and defines the size of the region
5336 allowed for use by the bootm command. See also "bootm_low"
5337 environment variable.
5338
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005339 updatefile - Location of the software update file on a TFTP server, used
5340 by the automatic software update feature. Please refer to
5341 documentation in doc/README.update for more details.
5342
wdenk6c59edc2004-05-03 20:45:30 +00005343 autoload - if set to "no" (any string beginning with 'n'),
5344 "bootp" will just load perform a lookup of the
5345 configuration from the BOOTP server, but not try to
5346 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk6c59edc2004-05-03 20:45:30 +00005348 autostart - if set to "yes", an image loaded using the "bootp",
5349 "rarpboot", "tftpboot" or "diskboot" commands will
5350 be automatically started (by internally calling
5351 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk6c59edc2004-05-03 20:45:30 +00005353 If set to "no", a standalone image passed to the
5354 "bootm" command will be copied to the load address
5355 (and eventually uncompressed), but NOT be started.
5356 This can be used to load and uncompress arbitrary
5357 data.
wdenkc6097192002-11-03 00:24:07 +00005358
David A. Longd558a4e2011-07-09 16:40:19 -04005359 fdt_high - if set this restricts the maximum address that the
5360 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005361 For example, if you have a system with 1 GB memory
5362 at physical address 0x10000000, while Linux kernel
5363 only recognizes the first 704 MB as low memory, you
5364 may need to set fdt_high as 0x3C000000 to have the
5365 device tree blob be copied to the maximum address
5366 of the 704 MB low memory, so that Linux kernel can
5367 access it during the boot procedure.
5368
David A. Longd558a4e2011-07-09 16:40:19 -04005369 If this is set to the special value 0xFFFFFFFF then
5370 the fdt will not be copied at all on boot. For this
5371 to work it must reside in writable memory, have
5372 sufficient padding on the end of it for u-boot to
5373 add the information it needs into it, and the memory
5374 must be accessible by the kernel.
5375
Simon Glassdc6fa642011-10-24 19:15:34 +00005376 fdtcontroladdr- if set this is the address of the control flattened
5377 device tree used by U-Boot when CONFIG_OF_CONTROL is
5378 defined.
5379
wdenk0e2bd9c2004-06-06 21:51:03 +00005380 i2cfast - (PPC405GP|PPC405EP only)
5381 if set to 'y' configures Linux I2C driver for fast
5382 mode (400kHZ). This environment variable is used in
5383 initialization code. So, for changes to be effective
5384 it must be saved and board must be reset.
5385
wdenk6c59edc2004-05-03 20:45:30 +00005386 initrd_high - restrict positioning of initrd images:
5387 If this variable is not set, initrd images will be
5388 copied to the highest possible address in RAM; this
5389 is usually what you want since it allows for
5390 maximum initrd size. If for some reason you want to
5391 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005392 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005393 variable to a value of "no" or "off" or "0".
5394 Alternatively, you can set it to a maximum upper
5395 address to use (U-Boot will still check that it
5396 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005397
wdenk6c59edc2004-05-03 20:45:30 +00005398 For instance, when you have a system with 16 MB
5399 RAM, and want to reserve 4 MB from use by Linux,
5400 you can do this by adding "mem=12M" to the value of
5401 the "bootargs" variable. However, now you must make
5402 sure that the initrd image is placed in the first
5403 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk6c59edc2004-05-03 20:45:30 +00005405 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005406
wdenk6c59edc2004-05-03 20:45:30 +00005407 If you set initrd_high to 0xFFFFFFFF, this is an
5408 indication to U-Boot that all addresses are legal
5409 for the Linux kernel, including addresses in flash
5410 memory. In this case U-Boot will NOT COPY the
5411 ramdisk at all. This may be useful to reduce the
5412 boot time on your system, but requires that this
5413 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005414
wdenk6c59edc2004-05-03 20:45:30 +00005415 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417 loadaddr - Default load address for commands like "bootp",
5418 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk6c59edc2004-05-03 20:45:30 +00005422 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005423
wdenk6c59edc2004-05-03 20:45:30 +00005424 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005425
wdenk6c59edc2004-05-03 20:45:30 +00005426 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk6c59edc2004-05-03 20:45:30 +00005428 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005429
Mike Frysingera23230c2011-10-02 10:01:27 +00005430 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005431
Mike Frysingera23230c2011-10-02 10:01:27 +00005432 ethact - controls which interface is currently active.
5433 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005434
Heiko Schocherc5e84052010-07-20 17:45:02 +02005435 => setenv ethact FEC
5436 => ping 192.168.0.1 # traffic sent on FEC
5437 => setenv ethact SCC
5438 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005439
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005440 ethrotate - When set to "no" U-Boot does not go through all
5441 available network interfaces.
5442 It just stays at the currently selected interface.
5443
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005444 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005445 either succeed or fail without retrying.
5446 When set to "once" the network operation will
5447 fail when all the available network interfaces
5448 are tried once without success.
5449 Useful on scripts which control the retry operation
5450 themselves.
wdenkc6097192002-11-03 00:24:07 +00005451
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005452 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005453
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005454 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005455 changing the console to be empty. If "yes" it will be
5456 made silent. If "no" it will not be made silent. If
5457 unset, then it will be made silent if the U-Boot console
5458 is silent.
5459
Wolfgang Denk227b5192005-09-24 23:25:46 +02005460 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005461 UDP source port.
5462
Wolfgang Denk227b5192005-09-24 23:25:46 +02005463 tftpdstport - If this is set, the value is used for TFTP's UDP
5464 destination port instead of the Well Know Port 69.
5465
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005466 tftpblocksize - Block size to use for TFTP transfers; if not set,
5467 we use the TFTP server's default block size
5468
5469 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5470 seconds, minimum value is 1000 = 1 second). Defines
5471 when a packet is considered to be lost so it has to
5472 be retransmitted. The default is 5000 = 5 seconds.
5473 Lowering this value may make downloads succeed
5474 faster in networks with high packet loss rates or
5475 with unreliable TFTP servers.
5476
5477 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005478 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005479 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005480
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005481The following image location variables contain the location of images
5482used in booting. The "Image" column gives the role of the image and is
5483not an environment variable name. The other columns are environment
5484variable names. "File Name" gives the name of the file on a TFTP
5485server, "RAM Address" gives the location in RAM the image will be
5486loaded to, and "Flash Location" gives the image's address in NOR
5487flash or offset in NAND flash.
5488
5489*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005490boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005491boards use these variables for other purposes.
5492
Wolfgang Denk092ae952011-10-26 10:21:21 +00005493Image File Name RAM Address Flash Location
5494----- --------- ----------- --------------
5495u-boot u-boot u-boot_addr_r u-boot_addr
5496Linux kernel bootfile kernel_addr_r kernel_addr
5497device tree blob fdtfile fdt_addr_r fdt_addr
5498ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005499
wdenk6c59edc2004-05-03 20:45:30 +00005500The following environment variables may be used and automatically
5501updated by the network boot commands ("bootp" and "rarpboot"),
5502depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504 bootfile - see above
5505 dnsip - IP address of your Domain Name Server
5506 dnsip2 - IP address of your secondary Domain Name Server
5507 gatewayip - IP address of the Gateway (Router) to use
5508 hostname - Target hostname
5509 ipaddr - see above
5510 netmask - Subnet Mask
5511 rootpath - Pathname of the root filesystem on the NFS server
5512 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005513
wdenk145d2c12004-04-15 21:48:45 +00005514
wdenk6c59edc2004-05-03 20:45:30 +00005515There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517 serial# - contains hardware identification information such
5518 as type string and/or serial number
5519 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005520
wdenk6c59edc2004-05-03 20:45:30 +00005521These variables can be set only once (usually during manufacturing of
5522the board). U-Boot refuses to delete or overwrite these variables
5523once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005524
5525
wdenk6c59edc2004-05-03 20:45:30 +00005526Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005527
wdenk6c59edc2004-05-03 20:45:30 +00005528 ver - Contains the U-Boot version string as printed
5529 with the "version" command. This variable is
5530 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005531
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533Please note that changes to some configuration parameters may take
5534only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005535
stroeseb9c17c52003-04-04 15:53:41 +00005536
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005537Callback functions for environment variables:
5538---------------------------------------------
5539
5540For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005541when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005542be associated with arbitrary variables. On creation, overwrite, or
5543deletion, the callback will provide the opportunity for some side
5544effect to happen or for the change to be rejected.
5545
5546The callbacks are named and associated with a function using the
5547U_BOOT_ENV_CALLBACK macro in your board or driver code.
5548
5549These callbacks are associated with variables in one of two ways. The
5550static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5551in the board configuration to a string that defines a list of
5552associations. The list must be in the following format:
5553
5554 entry = variable_name[:callback_name]
5555 list = entry[,list]
5556
5557If the callback name is not specified, then the callback is deleted.
5558Spaces are also allowed anywhere in the list.
5559
5560Callbacks can also be associated by defining the ".callbacks" variable
5561with the same list format above. Any association in ".callbacks" will
5562override any association in the static list. You can define
5563CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005564".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005565
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005566If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5567regular expression. This allows multiple variables to be connected to
5568the same callback without explicitly listing them all out.
5569
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005570
wdenk6c59edc2004-05-03 20:45:30 +00005571Command Line Parsing:
5572=====================
stroeseb9c17c52003-04-04 15:53:41 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574There are two different command line parsers available with U-Boot:
5575the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005576
wdenk6c59edc2004-05-03 20:45:30 +00005577Old, simple command line parser:
5578--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580- supports environment variables (through setenv / saveenv commands)
5581- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005582- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005583- special characters ('$', ';') can be escaped by prefixing with '\',
5584 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005585 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005586- You can also escape text by enclosing in single apostrophes, for example:
5587 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589Hush shell:
5590-----------
wdenkf4688a22003-05-28 08:06:31 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592- similar to Bourne shell, with control structures like
5593 if...then...else...fi, for...do...done; while...do...done,
5594 until...do...done, ...
5595- supports environment ("global") variables (through setenv / saveenv
5596 commands) and local shell variables (through standard shell syntax
5597 "name=value"); only environment variables can be used with "run"
5598 command
wdenkf4688a22003-05-28 08:06:31 +00005599
wdenk6c59edc2004-05-03 20:45:30 +00005600General rules:
5601--------------
wdenkf4688a22003-05-28 08:06:31 +00005602
wdenk6c59edc2004-05-03 20:45:30 +00005603(1) If a command line (or an environment variable executed by a "run"
5604 command) contains several commands separated by semicolon, and
5605 one of these commands fails, then the remaining commands will be
5606 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005609 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005610 command will cause "run" to terminate, i. e. the remaining
5611 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613Note for Redundant Ethernet Interfaces:
5614=======================================
wdenkf4688a22003-05-28 08:06:31 +00005615
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005616Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005617such configurations and is capable of automatic selection of a
5618"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005619
wdenk6c59edc2004-05-03 20:45:30 +00005620Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5621MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5622"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624If the network interface stores some valid MAC address (for instance
5625in SROM), this is used as default address if there is NO correspon-
5626ding setting in the environment; if the corresponding environment
5627variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629o If the SROM has a valid MAC address, and there is no address in the
5630 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005631
wdenk6c59edc2004-05-03 20:45:30 +00005632o If there is no valid address in the SROM, and a definition in the
5633 environment exists, then the value from the environment variable is
5634 used.
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636o If both the SROM and the environment contain a MAC address, and
5637 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk6c59edc2004-05-03 20:45:30 +00005639o If both the SROM and the environment contain a MAC address, and the
5640 addresses differ, the value from the environment is used and a
5641 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005642
wdenk6c59edc2004-05-03 20:45:30 +00005643o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005644 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5645 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005646
Ben Warren6db991a2010-04-26 11:11:46 -07005647If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005648will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005649may be skipped by setting the appropriate 'ethmacskip' environment variable.
5650The naming convention is as follows:
5651"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653Image Formats:
5654==============
wdenkc6097192002-11-03 00:24:07 +00005655
Marian Balakowicz18710b82008-03-12 12:13:13 +01005656U-Boot is capable of booting (and performing other auxiliary operations on)
5657images in two formats:
5658
5659New uImage format (FIT)
5660-----------------------
5661
5662Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5663to Flattened Device Tree). It allows the use of images with multiple
5664components (several kernels, ramdisks, etc.), with contents protected by
5665SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5666
5667
5668Old uImage format
5669-----------------
5670
5671Old image format is based on binary files which can be basically anything,
5672preceded by a special header; see the definitions in include/image.h for
5673details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5676 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005677 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5678 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5679 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005680* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005681 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5682 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005683* Compression Type (uncompressed, gzip, bzip2)
5684* Load Address
5685* Entry Point
5686* Image Name
5687* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005688
wdenk6c59edc2004-05-03 20:45:30 +00005689The header is marked by a special Magic Number, and both the header
5690and the data portions of the image are secured against corruption by
5691CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005692
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694Linux Support:
5695==============
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697Although U-Boot should support any OS or standalone application
5698easily, the main focus has always been on Linux during the design of
5699U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005700
wdenk6c59edc2004-05-03 20:45:30 +00005701U-Boot includes many features that so far have been part of some
5702special "boot loader" code within the Linux kernel. Also, any
5703"initrd" images to be used are no longer part of one big Linux image;
5704instead, kernel and "initrd" are separate images. This implementation
5705serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005706
wdenk6c59edc2004-05-03 20:45:30 +00005707- the same features can be used for other OS or standalone
5708 applications (for instance: using compressed images to reduce the
5709 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk6c59edc2004-05-03 20:45:30 +00005711- it becomes much easier to port new Linux kernel versions because
5712 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk6c59edc2004-05-03 20:45:30 +00005714- the same Linux kernel image can now be used with different "initrd"
5715 images; of course this also means that different kernel images can
5716 be run with the same "initrd". This makes testing easier (you don't
5717 have to build a new "zImage.initrd" Linux image when you just
5718 change a file in your "initrd"). Also, a field-upgrade of the
5719 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005720
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk6c59edc2004-05-03 20:45:30 +00005722Linux HOWTO:
5723============
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725Porting Linux to U-Boot based systems:
5726---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728U-Boot cannot save you from doing all the necessary modifications to
5729configure the Linux device drivers for use with your target hardware
5730(no, we don't intend to provide a full virtual machine interface to
5731Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005732
Stefan Roese88fbf932010-04-15 16:07:28 +02005733But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk6c59edc2004-05-03 20:45:30 +00005735Just make sure your machine specific header file (for instance
5736include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005737Information structure as we define in include/asm-<arch>/u-boot.h,
5738and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005739as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005740
Simon Glassd097e592014-06-11 23:29:46 -06005741Note that U-Boot now has a driver model, a unified model for drivers.
5742If you are adding a new driver, plumb it into driver model. If there
5743is no uclass available, you are encouraged to create one. See
5744doc/driver-model.
5745
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk6c59edc2004-05-03 20:45:30 +00005747Configuring the Linux kernel:
5748-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk6c59edc2004-05-03 20:45:30 +00005750No specific requirements for U-Boot. Make sure you have some root
5751device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005752
wdenkc6097192002-11-03 00:24:07 +00005753
wdenk6c59edc2004-05-03 20:45:30 +00005754Building a Linux Image:
5755-----------------------
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk6c59edc2004-05-03 20:45:30 +00005757With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5758not used. If you use recent kernel source, a new build target
5759"uImage" will exist which automatically builds an image usable by
5760U-Boot. Most older kernels also have support for a "pImage" target,
5761which was introduced for our predecessor project PPCBoot and uses a
5762100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764Example:
wdenkc6097192002-11-03 00:24:07 +00005765
Holger Freyther7ba4e572014-08-04 09:26:05 +02005766 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005767 make oldconfig
5768 make dep
5769 make uImage
wdenkc6097192002-11-03 00:24:07 +00005770
wdenk6c59edc2004-05-03 20:45:30 +00005771The "uImage" build target uses a special tool (in 'tools/mkimage') to
5772encapsulate a compressed Linux kernel image with header information,
5773CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005774
wdenk6c59edc2004-05-03 20:45:30 +00005775* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005776
wdenk6c59edc2004-05-03 20:45:30 +00005777* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005778
wdenk6c59edc2004-05-03 20:45:30 +00005779 ${CROSS_COMPILE}-objcopy -O binary \
5780 -R .note -R .comment \
5781 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005784
wdenk6c59edc2004-05-03 20:45:30 +00005785 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789 mkimage -A ppc -O linux -T kernel -C gzip \
5790 -a 0 -e 0 -n "Linux Kernel Image" \
5791 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005792
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794The "mkimage" tool can also be used to create ramdisk images for use
5795with U-Boot, either separated from the Linux kernel image, or
5796combined into one file. "mkimage" encapsulates the images with a 64
5797byte header containing information about target architecture,
5798operating system, image type, compression method, entry points, time
5799stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801"mkimage" can be called in two ways: to verify existing images and
5802print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804In the first form (with "-l" option) mkimage lists the information
5805contained in the header of an existing U-Boot image; this includes
5806checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005807
wdenk6c59edc2004-05-03 20:45:30 +00005808 tools/mkimage -l image
5809 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005810
wdenk6c59edc2004-05-03 20:45:30 +00005811The second form (with "-d" option) is used to build a U-Boot image
5812from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5815 -n name -d data_file image
5816 -A ==> set architecture to 'arch'
5817 -O ==> set operating system to 'os'
5818 -T ==> set image type to 'type'
5819 -C ==> set compression type 'comp'
5820 -a ==> set load address to 'addr' (hex)
5821 -e ==> set entry point to 'ep' (hex)
5822 -n ==> set image name to 'name'
5823 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005824
wdenkcd914452004-05-29 16:53:29 +00005825Right now, all Linux kernels for PowerPC systems use the same load
5826address (0x00000000), but the entry point address depends on the
5827kernel version:
wdenkc6097192002-11-03 00:24:07 +00005828
wdenk6c59edc2004-05-03 20:45:30 +00005829- 2.2.x kernels have the entry point at 0x0000000C,
5830- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk6c59edc2004-05-03 20:45:30 +00005834 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5835 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005836 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005837 > examples/uImage.TQM850L
5838 Image Name: 2.4.4 kernel for TQM850L
5839 Created: Wed Jul 19 02:34:59 2000
5840 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5841 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5842 Load Address: 0x00000000
5843 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk6c59edc2004-05-03 20:45:30 +00005847 -> tools/mkimage -l examples/uImage.TQM850L
5848 Image Name: 2.4.4 kernel for TQM850L
5849 Created: Wed Jul 19 02:34:59 2000
5850 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5851 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5852 Load Address: 0x00000000
5853 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005854
wdenk6c59edc2004-05-03 20:45:30 +00005855NOTE: for embedded systems where boot time is critical you can trade
5856speed for memory and install an UNCOMPRESSED image instead: this
5857needs more space in Flash, but boots much faster since it does not
5858need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005859
Stefan Roese88fbf932010-04-15 16:07:28 +02005860 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005861 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5862 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005863 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005864 > examples/uImage.TQM850L-uncompressed
5865 Image Name: 2.4.4 kernel for TQM850L
5866 Created: Wed Jul 19 02:34:59 2000
5867 Image Type: PowerPC Linux Kernel Image (uncompressed)
5868 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5869 Load Address: 0x00000000
5870 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005871
wdenkc6097192002-11-03 00:24:07 +00005872
wdenk6c59edc2004-05-03 20:45:30 +00005873Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5874when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005875
wdenk6c59edc2004-05-03 20:45:30 +00005876 -> tools/mkimage -n 'Simple Ramdisk Image' \
5877 > -A ppc -O linux -T ramdisk -C gzip \
5878 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5879 Image Name: Simple Ramdisk Image
5880 Created: Wed Jan 12 14:01:50 2000
5881 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5882 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5883 Load Address: 0x00000000
5884 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005885
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005886The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5887option performs the converse operation of the mkimage's second form (the "-d"
5888option). Given an image built by mkimage, the dumpimage extracts a "data file"
5889from the image:
5890
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005891 tools/dumpimage -i image -T type -p position data_file
5892 -i ==> extract from the 'image' a specific 'data_file'
5893 -T ==> set image type to 'type'
5894 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005895
wdenkc6097192002-11-03 00:24:07 +00005896
wdenk6c59edc2004-05-03 20:45:30 +00005897Installing a Linux Image:
5898-------------------------
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk6c59edc2004-05-03 20:45:30 +00005900To downloading a U-Boot image over the serial (console) interface,
5901you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005902
wdenk6c59edc2004-05-03 20:45:30 +00005903 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005904
wdenk6c59edc2004-05-03 20:45:30 +00005905The 'objcopy' does not understand the information in the U-Boot
5906image header, so the resulting S-Record file will be relative to
5907address 0x00000000. To load it to a given address, you need to
5908specify the target address as 'offset' parameter with the 'loads'
5909command.
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911Example: install the image to address 0x40100000 (which on the
5912TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005915
wdenk6c59edc2004-05-03 20:45:30 +00005916 .......... done
5917 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005918
wdenk6c59edc2004-05-03 20:45:30 +00005919 => loads 40100000
5920 ## Ready for S-Record download ...
5921 ~>examples/image.srec
5922 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5923 ...
5924 15989 15990 15991 15992
5925 [file transfer complete]
5926 [connected]
5927 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005928
wdenkc6097192002-11-03 00:24:07 +00005929
wdenk6c59edc2004-05-03 20:45:30 +00005930You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005931this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005932corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005933
wdenk6c59edc2004-05-03 20:45:30 +00005934 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk6c59edc2004-05-03 20:45:30 +00005936 ## Checking Image at 40100000 ...
5937 Image Name: 2.2.13 for initrd on TQM850L
5938 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5939 Data Size: 335725 Bytes = 327 kB = 0 MB
5940 Load Address: 00000000
5941 Entry Point: 0000000c
5942 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005943
5944
wdenk6c59edc2004-05-03 20:45:30 +00005945Boot Linux:
5946-----------
wdenkc6097192002-11-03 00:24:07 +00005947
wdenk6c59edc2004-05-03 20:45:30 +00005948The "bootm" command is used to boot an application that is stored in
5949memory (RAM or Flash). In case of a Linux kernel image, the contents
5950of the "bootargs" environment variable is passed to the kernel as
5951parameters. You can check and modify this variable using the
5952"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005953
wdenkc6097192002-11-03 00:24:07 +00005954
wdenk6c59edc2004-05-03 20:45:30 +00005955 => printenv bootargs
5956 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005957
wdenk6c59edc2004-05-03 20:45:30 +00005958 => 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 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960 => printenv bootargs
5961 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 +00005962
wdenk6c59edc2004-05-03 20:45:30 +00005963 => bootm 40020000
5964 ## Booting Linux kernel at 40020000 ...
5965 Image Name: 2.2.13 for NFS on TQM850L
5966 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5967 Data Size: 381681 Bytes = 372 kB = 0 MB
5968 Load Address: 00000000
5969 Entry Point: 0000000c
5970 Verifying Checksum ... OK
5971 Uncompressing Kernel Image ... OK
5972 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
5973 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5974 time_init: decrementer frequency = 187500000/60
5975 Calibrating delay loop... 49.77 BogoMIPS
5976 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5977 ...
wdenkc6097192002-11-03 00:24:07 +00005978
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005979If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005980the memory addresses of both the kernel and the initrd image (PPBCOOT
5981format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005982
wdenk6c59edc2004-05-03 20:45:30 +00005983 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk6c59edc2004-05-03 20:45:30 +00005985 ## Checking Image at 40100000 ...
5986 Image Name: 2.2.13 for initrd on TQM850L
5987 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5988 Data Size: 335725 Bytes = 327 kB = 0 MB
5989 Load Address: 00000000
5990 Entry Point: 0000000c
5991 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005992
wdenk6c59edc2004-05-03 20:45:30 +00005993 ## Checking Image at 40200000 ...
5994 Image Name: Simple Ramdisk Image
5995 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5996 Data Size: 566530 Bytes = 553 kB = 0 MB
5997 Load Address: 00000000
5998 Entry Point: 00000000
5999 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001 => bootm 40100000 40200000
6002 ## Booting Linux kernel at 40100000 ...
6003 Image Name: 2.2.13 for initrd on TQM850L
6004 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6005 Data Size: 335725 Bytes = 327 kB = 0 MB
6006 Load Address: 00000000
6007 Entry Point: 0000000c
6008 Verifying Checksum ... OK
6009 Uncompressing Kernel Image ... OK
6010 ## Loading RAMDisk Image at 40200000 ...
6011 Image Name: Simple Ramdisk Image
6012 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6013 Data Size: 566530 Bytes = 553 kB = 0 MB
6014 Load Address: 00000000
6015 Entry Point: 00000000
6016 Verifying Checksum ... OK
6017 Loading Ramdisk ... OK
6018 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
6019 Boot arguments: root=/dev/ram
6020 time_init: decrementer frequency = 187500000/60
6021 Calibrating delay loop... 49.77 BogoMIPS
6022 ...
6023 RAMDISK: Compressed image found at block 0
6024 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006025
wdenk6c59edc2004-05-03 20:45:30 +00006026 bash#
wdenkc6097192002-11-03 00:24:07 +00006027
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006028Boot Linux and pass a flat device tree:
6029-----------
6030
6031First, U-Boot must be compiled with the appropriate defines. See the section
6032titled "Linux Kernel Interface" above for a more in depth explanation. The
6033following is an example of how to start a kernel and pass an updated
6034flat device tree:
6035
6036=> print oftaddr
6037oftaddr=0x300000
6038=> print oft
6039oft=oftrees/mpc8540ads.dtb
6040=> tftp $oftaddr $oft
6041Speed: 1000, full duplex
6042Using TSEC0 device
6043TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6044Filename 'oftrees/mpc8540ads.dtb'.
6045Load address: 0x300000
6046Loading: #
6047done
6048Bytes transferred = 4106 (100a hex)
6049=> tftp $loadaddr $bootfile
6050Speed: 1000, full duplex
6051Using TSEC0 device
6052TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6053Filename 'uImage'.
6054Load address: 0x200000
6055Loading:############
6056done
6057Bytes transferred = 1029407 (fb51f hex)
6058=> print loadaddr
6059loadaddr=200000
6060=> print oftaddr
6061oftaddr=0x300000
6062=> bootm $loadaddr - $oftaddr
6063## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006064 Image Name: Linux-2.6.17-dirty
6065 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6066 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006067 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006068 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006069 Verifying Checksum ... OK
6070 Uncompressing Kernel Image ... OK
6071Booting using flat device tree at 0x300000
6072Using MPC85xx ADS machine description
6073Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6074[snip]
6075
6076
wdenk6c59edc2004-05-03 20:45:30 +00006077More About U-Boot Image Types:
6078------------------------------
wdenkc6097192002-11-03 00:24:07 +00006079
wdenk6c59edc2004-05-03 20:45:30 +00006080U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006081
wdenk6c59edc2004-05-03 20:45:30 +00006082 "Standalone Programs" are directly runnable in the environment
6083 provided by U-Boot; it is expected that (if they behave
6084 well) you can continue to work in U-Boot after return from
6085 the Standalone Program.
6086 "OS Kernel Images" are usually images of some Embedded OS which
6087 will take over control completely. Usually these programs
6088 will install their own set of exception handlers, device
6089 drivers, set up the MMU, etc. - this means, that you cannot
6090 expect to re-enter U-Boot except by resetting the CPU.
6091 "RAMDisk Images" are more or less just data blocks, and their
6092 parameters (address, size) are passed to an OS kernel that is
6093 being started.
6094 "Multi-File Images" contain several images, typically an OS
6095 (Linux) kernel image and one or more data images like
6096 RAMDisks. This construct is useful for instance when you want
6097 to boot over the network using BOOTP etc., where the boot
6098 server provides just a single image file, but you want to get
6099 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006100
wdenk6c59edc2004-05-03 20:45:30 +00006101 "Multi-File Images" start with a list of image sizes, each
6102 image size (in bytes) specified by an "uint32_t" in network
6103 byte order. This list is terminated by an "(uint32_t)0".
6104 Immediately after the terminating 0 follow the images, one by
6105 one, all aligned on "uint32_t" boundaries (size rounded up to
6106 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006107
wdenk6c59edc2004-05-03 20:45:30 +00006108 "Firmware Images" are binary images containing firmware (like
6109 U-Boot or FPGA images) which usually will be programmed to
6110 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006111
wdenk6c59edc2004-05-03 20:45:30 +00006112 "Script files" are command sequences that will be executed by
6113 U-Boot's command interpreter; this feature is especially
6114 useful when you configure U-Boot to use a real shell (hush)
6115 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006116
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006117Booting the Linux zImage:
6118-------------------------
6119
6120On some platforms, it's possible to boot Linux zImage. This is done
6121using the "bootz" command. The syntax of "bootz" command is the same
6122as the syntax of "bootm" command.
6123
Tom Rini45f46d12013-05-16 11:40:11 -04006124Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006125kernel with raw initrd images. The syntax is slightly different, the
6126address of the initrd must be augmented by it's size, in the following
6127format: "<initrd addres>:<initrd size>".
6128
stroeseb9c17c52003-04-04 15:53:41 +00006129
wdenk6c59edc2004-05-03 20:45:30 +00006130Standalone HOWTO:
6131=================
stroeseb9c17c52003-04-04 15:53:41 +00006132
wdenk6c59edc2004-05-03 20:45:30 +00006133One of the features of U-Boot is that you can dynamically load and
6134run "standalone" applications, which can use some resources of
6135U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006136
wdenk6c59edc2004-05-03 20:45:30 +00006137Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006138
wdenk6c59edc2004-05-03 20:45:30 +00006139"Hello World" Demo:
6140-------------------
wdenkc6097192002-11-03 00:24:07 +00006141
wdenk6c59edc2004-05-03 20:45:30 +00006142'examples/hello_world.c' contains a small "Hello World" Demo
6143application; it is automatically compiled when you build U-Boot.
6144It's configured to run at address 0x00040004, so you can play with it
6145like that:
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk6c59edc2004-05-03 20:45:30 +00006147 => loads
6148 ## Ready for S-Record download ...
6149 ~>examples/hello_world.srec
6150 1 2 3 4 5 6 7 8 9 10 11 ...
6151 [file transfer complete]
6152 [connected]
6153 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006154
wdenk6c59edc2004-05-03 20:45:30 +00006155 => go 40004 Hello World! This is a test.
6156 ## Starting application at 0x00040004 ...
6157 Hello World
6158 argc = 7
6159 argv[0] = "40004"
6160 argv[1] = "Hello"
6161 argv[2] = "World!"
6162 argv[3] = "This"
6163 argv[4] = "is"
6164 argv[5] = "a"
6165 argv[6] = "test."
6166 argv[7] = "<NULL>"
6167 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006168
wdenk6c59edc2004-05-03 20:45:30 +00006169 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk6c59edc2004-05-03 20:45:30 +00006171Another example, which demonstrates how to register a CPM interrupt
6172handler with the U-Boot code, can be found in 'examples/timer.c'.
6173Here, a CPM timer is set up to generate an interrupt every second.
6174The interrupt service routine is trivial, just printing a '.'
6175character, but this is just a demo program. The application can be
6176controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006177
wdenk6c59edc2004-05-03 20:45:30 +00006178 ? - print current values og the CPM Timer registers
6179 b - enable interrupts and start timer
6180 e - stop timer and disable interrupts
6181 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006182
wdenk6c59edc2004-05-03 20:45:30 +00006183 => loads
6184 ## Ready for S-Record download ...
6185 ~>examples/timer.srec
6186 1 2 3 4 5 6 7 8 9 10 11 ...
6187 [file transfer complete]
6188 [connected]
6189 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006190
wdenk6c59edc2004-05-03 20:45:30 +00006191 => go 40004
6192 ## Starting application at 0x00040004 ...
6193 TIMERS=0xfff00980
6194 Using timer 1
6195 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006196
wdenk6c59edc2004-05-03 20:45:30 +00006197Hit 'b':
6198 [q, b, e, ?] Set interval 1000000 us
6199 Enabling timer
6200Hit '?':
6201 [q, b, e, ?] ........
6202 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6203Hit '?':
6204 [q, b, e, ?] .
6205 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6206Hit '?':
6207 [q, b, e, ?] .
6208 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6209Hit '?':
6210 [q, b, e, ?] .
6211 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6212Hit 'e':
6213 [q, b, e, ?] ...Stopping timer
6214Hit 'q':
6215 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006216
wdenkc6097192002-11-03 00:24:07 +00006217
wdenk6c59edc2004-05-03 20:45:30 +00006218Minicom warning:
6219================
wdenkc6097192002-11-03 00:24:07 +00006220
wdenk6c59edc2004-05-03 20:45:30 +00006221Over time, many people have reported problems when trying to use the
6222"minicom" terminal emulation program for serial download. I (wd)
6223consider minicom to be broken, and recommend not to use it. Under
6224Unix, I recommend to use C-Kermit for general purpose use (and
6225especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006226use "cu" for S-Record download ("loads" command). See
6227http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6228for help with kermit.
6229
wdenkc6097192002-11-03 00:24:07 +00006230
wdenk6c59edc2004-05-03 20:45:30 +00006231Nevertheless, if you absolutely want to use it try adding this
6232configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006233
wdenk6c59edc2004-05-03 20:45:30 +00006234 Name Program Name U/D FullScr IO-Red. Multi
6235 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6236 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006237
wdenk8dba0502003-03-31 16:34:49 +00006238
wdenk6c59edc2004-05-03 20:45:30 +00006239NetBSD Notes:
6240=============
wdenkc6097192002-11-03 00:24:07 +00006241
wdenk6c59edc2004-05-03 20:45:30 +00006242Starting at version 0.9.2, U-Boot supports NetBSD both as host
6243(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006244
wdenk6c59edc2004-05-03 20:45:30 +00006245Building requires a cross environment; it is known to work on
6246NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6247need gmake since the Makefiles are not compatible with BSD make).
6248Note that the cross-powerpc package does not install include files;
6249attempting to build U-Boot will fail because <machine/ansi.h> is
6250missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006251
wdenk6c59edc2004-05-03 20:45:30 +00006252 # cd /usr/pkg/cross/powerpc-netbsd/include
6253 # mkdir powerpc
6254 # ln -s powerpc machine
6255 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6256 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006257
wdenk6c59edc2004-05-03 20:45:30 +00006258Native builds *don't* work due to incompatibilities between native
6259and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk6c59edc2004-05-03 20:45:30 +00006261Booting assumes that (the first part of) the image booted is a
6262stage-2 loader which in turn loads and then invokes the kernel
6263proper. Loader sources will eventually appear in the NetBSD source
6264tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006265meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006266
wdenkc6097192002-11-03 00:24:07 +00006267
wdenk6c59edc2004-05-03 20:45:30 +00006268Implementation Internals:
6269=========================
wdenkc6097192002-11-03 00:24:07 +00006270
wdenk6c59edc2004-05-03 20:45:30 +00006271The following is not intended to be a complete description of every
6272implementation detail. However, it should help to understand the
6273inner workings of U-Boot and make it easier to port it to custom
6274hardware.
wdenkc6097192002-11-03 00:24:07 +00006275
wdenkc6097192002-11-03 00:24:07 +00006276
wdenk6c59edc2004-05-03 20:45:30 +00006277Initial Stack, Global Data:
6278---------------------------
wdenkc6097192002-11-03 00:24:07 +00006279
wdenk6c59edc2004-05-03 20:45:30 +00006280The implementation of U-Boot is complicated by the fact that U-Boot
6281starts running out of ROM (flash memory), usually without access to
6282system RAM (because the memory controller is not initialized yet).
6283This means that we don't have writable Data or BSS segments, and BSS
6284is not initialized as zero. To be able to get a C environment working
6285at all, we have to allocate at least a minimal stack. Implementation
6286options for this are defined and restricted by the CPU used: Some CPU
6287models provide on-chip memory (like the IMMR area on MPC8xx and
6288MPC826x processors), on others (parts of) the data cache can be
6289locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006290
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006291 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006292 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006293
wdenk6c59edc2004-05-03 20:45:30 +00006294 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6295 From: "Chris Hallinan" <clh@net1plus.com>
6296 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6297 ...
wdenkc6097192002-11-03 00:24:07 +00006298
wdenk6c59edc2004-05-03 20:45:30 +00006299 Correct me if I'm wrong, folks, but the way I understand it
6300 is this: Using DCACHE as initial RAM for Stack, etc, does not
6301 require any physical RAM backing up the cache. The cleverness
6302 is that the cache is being used as a temporary supply of
6303 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006304 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006305 can see how this works by studying the cache architecture and
6306 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006307
wdenk6c59edc2004-05-03 20:45:30 +00006308 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6309 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006310 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006311 option should work for you. Using CS 4 should be fine if your
6312 board designers haven't used it for something that would
6313 cause you grief during the initial boot! It is frequently not
6314 used.
wdenkc6097192002-11-03 00:24:07 +00006315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006316 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006317 with your processor/board/system design. The default value
6318 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006319 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006320 than your SDRAM module. If you have a 64MB SDRAM module, set
6321 it above 400_0000. Just make sure your board has no resources
6322 that are supposed to respond to that address! That code in
6323 start.S has been around a while and should work as is when
6324 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006325
wdenk6c59edc2004-05-03 20:45:30 +00006326 -Chris Hallinan
6327 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006328
wdenk6c59edc2004-05-03 20:45:30 +00006329It is essential to remember this, since it has some impact on the C
6330code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006331
wdenk6c59edc2004-05-03 20:45:30 +00006332* Initialized global data (data segment) is read-only. Do not attempt
6333 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006334
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006335* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006336 as zero data - BSS segment) at all - this is undefined, initiali-
6337 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006338
wdenk6c59edc2004-05-03 20:45:30 +00006339* Stack space is very limited. Avoid big data buffers or things like
6340 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006341
wdenk6c59edc2004-05-03 20:45:30 +00006342Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006343normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006344turned out that the implementation of U-Boot can be greatly
6345simplified by making a global data structure (gd_t) available to all
6346functions. We could pass a pointer to this data as argument to _all_
6347functions, but this would bloat the code. Instead we use a feature of
6348the GCC compiler (Global Register Variables) to share the data: we
6349place a pointer (gd) to the global data into a register which we
6350reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006351
wdenk6c59edc2004-05-03 20:45:30 +00006352When choosing a register for such a purpose we are restricted by the
6353relevant (E)ABI specifications for the current architecture, and by
6354GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006355
wdenk6c59edc2004-05-03 20:45:30 +00006356For PowerPC, the following registers have specific use:
6357 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006358 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006359 R3-R4: parameter passing and return values
6360 R5-R10: parameter passing
6361 R13: small data area pointer
6362 R30: GOT pointer
6363 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006364
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006365 (U-Boot also uses R12 as internal GOT pointer. r12
6366 is a volatile register so r12 needs to be reset when
6367 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006368
Wolfgang Denk69c09642008-02-14 22:43:22 +01006369 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006370
wdenk6c59edc2004-05-03 20:45:30 +00006371 Note: on PPC, we could use a static initializer (since the
6372 address of the global data structure is known at compile time),
6373 but it turned out that reserving a register results in somewhat
6374 smaller code - although the code savings are not that big (on
6375 average for all boards 752 bytes for the whole U-Boot image,
6376 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006377
Robin Getz2773d5f2009-08-17 15:23:02 +00006378On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006379 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6380
Robin Getz2773d5f2009-08-17 15:23:02 +00006381 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006382
wdenk6c59edc2004-05-03 20:45:30 +00006383On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006384
wdenk6c59edc2004-05-03 20:45:30 +00006385 R0: function argument word/integer result
6386 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006387 R9: platform specific
6388 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006389 R11: argument (frame) pointer
6390 R12: temporary workspace
6391 R13: stack pointer
6392 R14: link register
6393 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006394
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006395 ==> U-Boot will use R9 to hold a pointer to the global data
6396
6397 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006398
Thomas Chou8fa38582010-05-21 11:08:03 +08006399On Nios II, the ABI is documented here:
6400 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6401
6402 ==> U-Boot will use gp to hold a pointer to the global data
6403
6404 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6405 to access small data sections, so gp is free.
6406
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006407On NDS32, the following registers are used:
6408
6409 R0-R1: argument/return
6410 R2-R5: argument
6411 R15: temporary register for assembler
6412 R16: trampoline register
6413 R28: frame pointer (FP)
6414 R29: global pointer (GP)
6415 R30: link register (LP)
6416 R31: stack pointer (SP)
6417 PC: program counter (PC)
6418
6419 ==> U-Boot will use R10 to hold a pointer to the global data
6420
Wolfgang Denk6405a152006-03-31 18:32:53 +02006421NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6422or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006423
wdenk6c59edc2004-05-03 20:45:30 +00006424Memory Management:
6425------------------
wdenkc6097192002-11-03 00:24:07 +00006426
wdenk6c59edc2004-05-03 20:45:30 +00006427U-Boot runs in system state and uses physical addresses, i.e. the
6428MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006429
wdenk6c59edc2004-05-03 20:45:30 +00006430The available memory is mapped to fixed addresses using the memory
6431controller. In this process, a contiguous block is formed for each
6432memory type (Flash, SDRAM, SRAM), even when it consists of several
6433physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006434
wdenk6c59edc2004-05-03 20:45:30 +00006435U-Boot is installed in the first 128 kB of the first Flash bank (on
6436TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6437booting and sizing and initializing DRAM, the code relocates itself
6438to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006439memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006440configuration setting]. Below that, a structure with global Board
6441Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006442
wdenk6c59edc2004-05-03 20:45:30 +00006443Additionally, some exception handler code is copied to the low 8 kB
6444of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006445
wdenk6c59edc2004-05-03 20:45:30 +00006446So a typical memory configuration with 16 MB of DRAM could look like
6447this:
wdenkc6097192002-11-03 00:24:07 +00006448
wdenk6c59edc2004-05-03 20:45:30 +00006449 0x0000 0000 Exception Vector code
6450 :
6451 0x0000 1FFF
6452 0x0000 2000 Free for Application Use
6453 :
6454 :
wdenkc6097192002-11-03 00:24:07 +00006455
wdenk6c59edc2004-05-03 20:45:30 +00006456 :
6457 :
6458 0x00FB FF20 Monitor Stack (Growing downward)
6459 0x00FB FFAC Board Info Data and permanent copy of global data
6460 0x00FC 0000 Malloc Arena
6461 :
6462 0x00FD FFFF
6463 0x00FE 0000 RAM Copy of Monitor Code
6464 ... eventually: LCD or video framebuffer
6465 ... eventually: pRAM (Protected RAM - unchanged by reset)
6466 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006467
wdenkc6097192002-11-03 00:24:07 +00006468
wdenk6c59edc2004-05-03 20:45:30 +00006469System Initialization:
6470----------------------
wdenkc6097192002-11-03 00:24:07 +00006471
wdenk6c59edc2004-05-03 20:45:30 +00006472In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006473(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006474configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006475To be able to re-map memory U-Boot then jumps to its link address.
6476To be able to implement the initialization code in C, a (small!)
6477initial stack is set up in the internal Dual Ported RAM (in case CPUs
6478which provide such a feature like MPC8xx or MPC8260), or in a locked
6479part of the data cache. After that, U-Boot initializes the CPU core,
6480the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006481
wdenk6c59edc2004-05-03 20:45:30 +00006482Next, all (potentially) available memory banks are mapped using a
6483preliminary mapping. For example, we put them on 512 MB boundaries
6484(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6485on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6486programmed for SDRAM access. Using the temporary configuration, a
6487simple memory test is run that determines the size of the SDRAM
6488banks.
wdenkc6097192002-11-03 00:24:07 +00006489
wdenk6c59edc2004-05-03 20:45:30 +00006490When there is more than one SDRAM bank, and the banks are of
6491different size, the largest is mapped first. For equal size, the first
6492bank (CS2#) is mapped first. The first mapping is always for address
64930x00000000, with any additional banks following immediately to create
6494contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006495
wdenk6c59edc2004-05-03 20:45:30 +00006496Then, the monitor installs itself at the upper end of the SDRAM area
6497and allocates memory for use by malloc() and for the global Board
6498Info data; also, the exception vector code is copied to the low RAM
6499pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006500
wdenk6c59edc2004-05-03 20:45:30 +00006501Only after this relocation will you have a "normal" C environment;
6502until that you are restricted in several ways, mostly because you are
6503running from ROM, and because the code will have to be relocated to a
6504new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006505
wdenkc6097192002-11-03 00:24:07 +00006506
wdenk6c59edc2004-05-03 20:45:30 +00006507U-Boot Porting Guide:
6508----------------------
wdenkc6097192002-11-03 00:24:07 +00006509
wdenk6c59edc2004-05-03 20:45:30 +00006510[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6511list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006512
wdenkc6097192002-11-03 00:24:07 +00006513
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006514int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006515{
6516 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006517
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006518 signal(SIGALRM, no_more_time);
6519 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006520
wdenk6c59edc2004-05-03 20:45:30 +00006521 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006522 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006523 return 0;
6524 }
wdenkc6097192002-11-03 00:24:07 +00006525
wdenk6c59edc2004-05-03 20:45:30 +00006526 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006527
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006528 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006529
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006530 if (clueless)
6531 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006532
wdenk6c59edc2004-05-03 20:45:30 +00006533 while (learning) {
6534 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006535 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6536 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006537 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006538 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006539 }
wdenkc6097192002-11-03 00:24:07 +00006540
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006541 if (available_money > toLocalCurrency ($2500))
6542 Buy a BDI3000;
6543 else
wdenk6c59edc2004-05-03 20:45:30 +00006544 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006545
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006546 if (a similar board exists) { /* hopefully... */
6547 cp -a board/<similar> board/<myboard>
6548 cp include/configs/<similar>.h include/configs/<myboard>.h
6549 } else {
6550 Create your own board support subdirectory;
6551 Create your own board include/configs/<myboard>.h file;
6552 }
6553 Edit new board/<myboard> files
6554 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006555
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006556 while (!accepted) {
6557 while (!running) {
6558 do {
6559 Add / modify source code;
6560 } until (compiles);
6561 Debug;
6562 if (clueless)
6563 email("Hi, I am having problems...");
6564 }
6565 Send patch file to the U-Boot email list;
6566 if (reasonable critiques)
6567 Incorporate improvements from email list code review;
6568 else
6569 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006570 }
wdenkc6097192002-11-03 00:24:07 +00006571
wdenk6c59edc2004-05-03 20:45:30 +00006572 return 0;
6573}
wdenkc6097192002-11-03 00:24:07 +00006574
wdenk6c59edc2004-05-03 20:45:30 +00006575void no_more_time (int sig)
6576{
6577 hire_a_guru();
6578}
wdenkc6097192002-11-03 00:24:07 +00006579
wdenkc6097192002-11-03 00:24:07 +00006580
wdenk6c59edc2004-05-03 20:45:30 +00006581Coding Standards:
6582-----------------
wdenkc6097192002-11-03 00:24:07 +00006583
wdenk6c59edc2004-05-03 20:45:30 +00006584All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006585coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006586"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006587
6588Source files originating from a different project (for example the
6589MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006590reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006591sources.
wdenkc6097192002-11-03 00:24:07 +00006592
Detlev Zundelaa63d482006-09-01 15:39:02 +02006593Please note that U-Boot is implemented in C (and to some small parts in
6594Assembler); no C++ is used, so please do not use C++ style comments (//)
6595in your code.
wdenkad276f22004-01-04 16:28:35 +00006596
wdenk6c59edc2004-05-03 20:45:30 +00006597Please also stick to the following formatting rules:
6598- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006599- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006600- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006601- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006602- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006603
wdenk6c59edc2004-05-03 20:45:30 +00006604Submissions which do not conform to the standards may be returned
6605with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006606
wdenkc6097192002-11-03 00:24:07 +00006607
wdenk6c59edc2004-05-03 20:45:30 +00006608Submitting Patches:
6609-------------------
wdenkc6097192002-11-03 00:24:07 +00006610
wdenk6c59edc2004-05-03 20:45:30 +00006611Since the number of patches for U-Boot is growing, we need to
6612establish some rules. Submissions which do not conform to these rules
6613may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006614
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006615Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006616
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006617Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6618see http://lists.denx.de/mailman/listinfo/u-boot
6619
wdenk6c59edc2004-05-03 20:45:30 +00006620When you send a patch, please include the following information with
6621it:
wdenkc6097192002-11-03 00:24:07 +00006622
wdenk6c59edc2004-05-03 20:45:30 +00006623* For bug fixes: a description of the bug and how your patch fixes
6624 this bug. Please try to include a way of demonstrating that the
6625 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006626
wdenk6c59edc2004-05-03 20:45:30 +00006627* For new features: a description of the feature and your
6628 implementation.
wdenkc6097192002-11-03 00:24:07 +00006629
wdenk6c59edc2004-05-03 20:45:30 +00006630* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006631
wdenk6c59edc2004-05-03 20:45:30 +00006632* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006633
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006634* When you add support for a new board, don't forget to add a
6635 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006636
wdenk6c59edc2004-05-03 20:45:30 +00006637* If your patch adds new configuration options, don't forget to
6638 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006639
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006640* The patch itself. If you are using git (which is *strongly*
6641 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006642 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006643 the U-Boot mailing list, you will avoid most of the common problems
6644 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006645
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006646 If you cannot use git, use "diff -purN OLD NEW". If your version of
6647 diff does not support these options, then get the latest version of
6648 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006649
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006650 The current directory when running this command shall be the parent
6651 directory of the U-Boot source tree (i. e. please make sure that
6652 your patch includes sufficient directory information for the
6653 affected files).
6654
6655 We prefer patches as plain text. MIME attachments are discouraged,
6656 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006657
wdenk6c59edc2004-05-03 20:45:30 +00006658* If one logical set of modifications affects or creates several
6659 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006660
wdenk6c59edc2004-05-03 20:45:30 +00006661* Changesets that contain different, unrelated modifications shall be
6662 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006663
wdenkc6097192002-11-03 00:24:07 +00006664
wdenk6c59edc2004-05-03 20:45:30 +00006665Notes:
wdenkc6097192002-11-03 00:24:07 +00006666
wdenk6c59edc2004-05-03 20:45:30 +00006667* Before sending the patch, run the MAKEALL script on your patched
6668 source tree and make sure that no errors or warnings are reported
6669 for any of the boards.
6670
6671* Keep your modifications to the necessary minimum: A patch
6672 containing several unrelated changes or arbitrary reformats will be
6673 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006674
wdenk6c59edc2004-05-03 20:45:30 +00006675* If you modify existing code, make sure that your new code does not
6676 add to the memory footprint of the code ;-) Small is beautiful!
6677 When adding new features, these should compile conditionally only
6678 (using #ifdef), and the resulting code with the new feature
6679 disabled must not need more memory than the old code without your
6680 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006681
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006682* Remember that there is a size limit of 100 kB per message on the
6683 u-boot mailing list. Bigger patches will be moderated. If they are
6684 reasonable and not too big, they will be acknowledged. But patches
6685 bigger than the size limit should be avoided.