blob: 57426e55eae5ae16c0581f0ba923cafaa7ad50f7 [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
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500693 NOTE: The following can be machine specific errata. These
694 do have ability to provide rudimentary version and machine
695 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500696 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500697 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500698 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500699 CONFIG_ARM_ERRATA_798870
700
Stephen Warren8d1fb312015-01-19 16:25:52 -0700701- Tegra SoC options:
702 CONFIG_TEGRA_SUPPORT_NON_SECURE
703
704 Support executing U-Boot in non-secure (NS) mode. Certain
705 impossible actions will be skipped if the CPU is in NS mode,
706 such as ARM architectural timer initialization.
707
Simon Glass9fa901b2014-11-10 17:16:54 -0700708- Driver Model
709 Driver model is a new framework for devices in U-Boot
710 introduced in early 2014. U-Boot is being progressively
711 moved over to this. It offers a consistent device structure,
712 supports grouping devices into classes and has built-in
713 handling of platform data and device tree.
714
715 To enable transition to driver model in a relatively
716 painful fashion, each subsystem can be independently
717 switched between the legacy/ad-hoc approach and the new
718 driver model using the options below. Also, many uclass
719 interfaces include compatibility features which may be
720 removed once the conversion of that subsystem is complete.
721 As a result, the API provided by the subsystem may in fact
722 not change with driver model.
723
724 See doc/driver-model/README.txt for more information.
725
726 CONFIG_DM
727
728 Enable driver model. This brings in the core support,
729 including scanning of platform data on start-up. If
730 CONFIG_OF_CONTROL is enabled, the device tree will be
731 scanned also when available.
732
733 CONFIG_CMD_DM
734
735 Enable driver model test commands. These allow you to print
736 out the driver model tree and the uclasses.
737
738 CONFIG_DM_DEMO
739
740 Enable some demo devices and the 'demo' command. These are
741 really only useful for playing around while trying to
742 understand driver model in sandbox.
743
744 CONFIG_SPL_DM
745
746 Enable driver model in SPL. You will need to provide a
747 suitable malloc() implementation. If you are not using the
748 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
749 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
750 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
751 In most cases driver model will only allocate a few uclasses
752 and devices in SPL, so 1KB should be enable. See
753 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
754 it.
755
756 CONFIG_DM_SERIAL
757
758 Enable driver model for serial. This replaces
759 drivers/serial/serial.c with the serial uclass, which
760 implements serial_putc() etc. The uclass interface is
761 defined in include/serial.h.
762
763 CONFIG_DM_GPIO
764
765 Enable driver model for GPIO access. The standard GPIO
766 interface (gpio_get_value(), etc.) is then implemented by
767 the GPIO uclass. Drivers provide methods to query the
768 particular GPIOs that they provide. The uclass interface
769 is defined in include/asm-generic/gpio.h.
770
771 CONFIG_DM_SPI
772
773 Enable driver model for SPI. The SPI slave interface
774 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
775 the SPI uclass. Drivers provide methods to access the SPI
776 buses that they control. The uclass interface is defined in
777 include/spi.h. The existing spi_slave structure is attached
778 as 'parent data' to every slave on each bus. Slaves
779 typically use driver-private data instead of extending the
780 spi_slave structure.
781
782 CONFIG_DM_SPI_FLASH
783
784 Enable driver model for SPI flash. This SPI flash interface
785 (spi_flash_probe(), spi_flash_write(), etc.) is then
786 implemented by the SPI flash uclass. There is one standard
787 SPI flash driver which knows how to probe most chips
788 supported by U-Boot. The uclass interface is defined in
789 include/spi_flash.h, but is currently fully compatible
790 with the old interface to avoid confusion and duplication
791 during the transition parent. SPI and SPI flash must be
792 enabled together (it is not possible to use driver model
793 for one and not the other).
794
795 CONFIG_DM_CROS_EC
796
797 Enable driver model for the Chrome OS EC interface. This
798 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
799 but otherwise makes few changes. Since cros_ec also supports
800 I2C and LPC (which don't support driver model yet), a full
801 conversion is not yet possible.
802
803
804 ** Code size options: The following options are enabled by
805 default except in SPL. Enable them explicitly to get these
806 features in SPL.
807
808 CONFIG_DM_WARN
809
810 Enable the dm_warn() function. This can use up quite a bit
811 of space for its strings.
812
813 CONFIG_DM_STDIO
814
815 Enable registering a serial device with the stdio library.
816
817 CONFIG_DM_DEVICE_REMOVE
818
819 Enable removing of devices.
Simon Glass9fa901b2014-11-10 17:16:54 -0700820
wdenk9b7f3842003-10-09 20:09:04 +0000821- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000822 CONFIG_CLOCKS_IN_MHZ
823
824 U-Boot stores all clock information in Hz
825 internally. For binary compatibility with older Linux
826 kernels (which expect the clocks passed in the
827 bd_info data to be in MHz) the environment variable
828 "clocks_in_mhz" can be defined so that U-Boot
829 converts clock data to MHZ before passing it to the
830 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000831 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100832 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000833 default environment.
834
wdenk9b7f3842003-10-09 20:09:04 +0000835 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
836
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800837 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000838 expect it to be in bytes, others in MB.
839 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
840
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400841 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200842
843 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400844 passed using flattened device trees (based on open firmware
845 concepts).
846
847 CONFIG_OF_LIBFDT
848 * New libfdt-based support
849 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500850 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400851
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200852 OF_CPU - The proper name of the cpus node (only required for
853 MPC512X and MPC5xxx based boards).
854 OF_SOC - The proper name of the soc node (only required for
855 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200856 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600857 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200858
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200859 boards with QUICC Engines require OF_QE to set UCC MAC
860 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500861
Kumar Gala1e26aa52006-01-11 13:54:17 -0600862 CONFIG_OF_BOARD_SETUP
863
864 Board code has addition modification that it wants to make
865 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000866
Simon Glass6c0be912014-10-23 18:58:54 -0600867 CONFIG_OF_SYSTEM_SETUP
868
869 Other code has addition modification that it wants to make
870 to the flat device tree before handing it off to the kernel.
871 This causes ft_system_setup() to be called before booting
872 the kernel.
873
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500874 CONFIG_OF_BOOT_CPU
875
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200876 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500877 param header, the default value is zero if undefined.
878
Heiko Schocherffb293a2009-09-23 07:56:08 +0200879 CONFIG_OF_IDE_FIXUP
880
881 U-Boot can detect if an IDE device is present or not.
882 If not, and this new config option is activated, U-Boot
883 removes the ATA node from the DTS before booting Linux,
884 so the Linux IDE driver does not probe the device and
885 crash. This is needed for buggy hardware (uc101) where
886 no pull down resistor is connected to the signal IDE5V_DD7.
887
Igor Grinberg06890672011-07-14 05:45:07 +0000888 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
889
890 This setting is mandatory for all boards that have only one
891 machine type and must be used to specify the machine type
892 number as it appears in the ARM machine registry
893 (see http://www.arm.linux.org.uk/developer/machines/).
894 Only boards that have multiple machine types supported
895 in a single configuration file and the machine type is
896 runtime discoverable, do not have to use this setting.
897
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100898- vxWorks boot parameters:
899
900 bootvx constructs a valid bootline using the following
901 environments variables: bootfile, ipaddr, serverip, hostname.
902 It loads the vxWorks image pointed bootfile.
903
904 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
905 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
906 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
907 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
908
909 CONFIG_SYS_VXWORKS_ADD_PARAMS
910
911 Add it at the end of the bootline. E.g "u=username pw=secret"
912
913 Note: If a "bootargs" environment is defined, it will overwride
914 the defaults discussed just above.
915
Aneesh V960f5c02011-06-16 23:30:47 +0000916- Cache Configuration:
917 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
918 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
919 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
920
Aneesh V686a0752011-06-16 23:30:51 +0000921- Cache Configuration for ARM:
922 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
923 controller
924 CONFIG_SYS_PL310_BASE - Physical base address of PL310
925 controller register space
926
wdenkda04a8b2004-08-02 23:22:59 +0000927- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200928 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000929
930 Define this if you want support for Amba PrimeCell PL010 UARTs.
931
Andreas Engel0813b122008-09-08 14:30:53 +0200932 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000933
934 Define this if you want support for Amba PrimeCell PL011 UARTs.
935
936 CONFIG_PL011_CLOCK
937
938 If you have Amba PrimeCell PL011 UARTs, set this variable to
939 the clock speed of the UARTs.
940
941 CONFIG_PL01x_PORTS
942
943 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
944 define this to a list of base addresses for each (supported)
945 port. See e.g. include/configs/versatile.h
946
John Rigby34e21ee2011-04-19 10:42:39 +0000947 CONFIG_PL011_SERIAL_RLCR
948
949 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
950 have separate receive and transmit line control registers. Set
951 this variable to initialize the extra register.
952
953 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
954
955 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
956 boot loader that has already initialized the UART. Define this
957 variable to flush the UART at init time.
958
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400959 CONFIG_SERIAL_HW_FLOW_CONTROL
960
961 Define this variable to enable hw flow control in serial driver.
962 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000963
wdenkc6097192002-11-03 00:24:07 +0000964- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000965 Depending on board, define exactly one serial port
966 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
967 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
968 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000969
970 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
971 port routines must be defined elsewhere
972 (i.e. serial_init(), serial_getc(), ...)
973
974 CONFIG_CFB_CONSOLE
975 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000976 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000977 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
978 (default big endian)
979 VIDEO_HW_RECTFILL graphic chip supports
980 rectangle fill
981 (cf. smiLynxEM)
982 VIDEO_HW_BITBLT graphic chip supports
983 bit-blit (cf. smiLynxEM)
984 VIDEO_VISIBLE_COLS visible pixel columns
985 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000986 VIDEO_VISIBLE_ROWS visible pixel rows
987 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000988 VIDEO_DATA_FORMAT graphic data format
989 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000990 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000991 VIDEO_KBD_INIT_FCT keyboard int fct
992 (i.e. i8042_kbd_init())
993 VIDEO_TSTC_FCT test char fct
994 (i.e. i8042_tstc)
995 VIDEO_GETC_FCT get char fct
996 (i.e. i8042_getc)
997 CONFIG_CONSOLE_CURSOR cursor drawing on/off
998 (requires blink timer
999 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001000 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +00001001 CONFIG_CONSOLE_TIME display time/date info in
1002 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001003 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +00001004 CONFIG_VIDEO_LOGO display Linux logo in
1005 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +00001006 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
1007 linux_logo.h for logo.
1008 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +00001009 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001010 additional board info beside
wdenkc6097192002-11-03 00:24:07 +00001011 the logo
1012
Pali Rohár4a57da32012-10-19 13:30:09 +00001013 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
1014 a limited number of ANSI escape sequences (cursor control,
1015 erase functions and limited graphics rendition control).
1016
wdenk4a5c8a72003-03-06 00:02:04 +00001017 When CONFIG_CFB_CONSOLE is defined, video console is
1018 default i/o. Serial console can be forced with
1019 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +00001020
wdenk1ebf41e2004-01-02 14:00:00 +00001021 When CONFIG_SILENT_CONSOLE is defined, all console
1022 messages (by U-Boot and Linux!) can be silenced with
1023 the "silent" environment variable. See
1024 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +00001025
Heiko Schocher62759562013-10-22 11:06:06 +02001026 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
1027 is 0x00.
1028 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
1029 is 0xa0.
1030
wdenkc6097192002-11-03 00:24:07 +00001031- Console Baudrate:
1032 CONFIG_BAUDRATE - in bps
1033 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001034 CONFIG_SYS_BAUDRATE_TABLE, see below.
1035 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +00001036
Heiko Schocher327480a2009-01-30 12:55:38 +01001037- Console Rx buffer length
1038 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
1039 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +01001040 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +01001041 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
1042 must be defined, to setup the maximum idle timeout for
1043 the SMC.
1044
Graeme Russ3c28f482011-09-01 00:48:27 +00001045- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001046 Prior to the console being initialised (i.e. serial UART
1047 initialised etc) all console output is silently discarded.
1048 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
1049 buffer any console messages prior to the console being
1050 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
1051 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
1052 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +02001053 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001054 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +00001055
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001056 'Sane' compilers will generate smaller code if
1057 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +00001058
Sonny Raocd55bde2011-11-02 09:52:08 +00001059- Safe printf() functions
1060 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
1061 the printf() functions. These are defined in
1062 include/vsprintf.h and include snprintf(), vsnprintf() and
1063 so on. Code size increase is approximately 300-500 bytes.
1064 If this option is not given then these functions will
1065 silently discard their buffer size argument - this means
1066 you are not getting any overflow checking in this case.
1067
wdenkc6097192002-11-03 00:24:07 +00001068- Boot Delay: CONFIG_BOOTDELAY - in seconds
1069 Delay before automatically booting the default image;
1070 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +00001071 set to -2 to autoboot with no delay and not check for abort
1072 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +00001073
1074 See doc/README.autoboot for these options that
1075 work with CONFIG_BOOTDELAY. None are required.
1076 CONFIG_BOOT_RETRY_TIME
1077 CONFIG_BOOT_RETRY_MIN
1078 CONFIG_AUTOBOOT_KEYED
1079 CONFIG_AUTOBOOT_PROMPT
1080 CONFIG_AUTOBOOT_DELAY_STR
1081 CONFIG_AUTOBOOT_STOP_STR
1082 CONFIG_AUTOBOOT_DELAY_STR2
1083 CONFIG_AUTOBOOT_STOP_STR2
1084 CONFIG_ZERO_BOOTDELAY_CHECK
1085 CONFIG_RESET_TO_RETRY
1086
1087- Autoboot Command:
1088 CONFIG_BOOTCOMMAND
1089 Only needed when CONFIG_BOOTDELAY is enabled;
1090 define a command string that is automatically executed
1091 when no character is read on the console interface
1092 within "Boot Delay" after reset.
1093
1094 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +00001095 This can be used to pass arguments to the bootm
1096 command. The value of CONFIG_BOOTARGS goes into the
1097 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001098
1099 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +00001100 The value of these goes into the environment as
1101 "ramboot" and "nfsboot" respectively, and can be used
1102 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001103 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001104
Heiko Schocher040c5c32013-11-04 14:04:59 +01001105- Bootcount:
1106 CONFIG_BOOTCOUNT_LIMIT
1107 Implements a mechanism for detecting a repeating reboot
1108 cycle, see:
1109 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1110
1111 CONFIG_BOOTCOUNT_ENV
1112 If no softreset save registers are found on the hardware
1113 "bootcount" is stored in the environment. To prevent a
1114 saveenv on all reboots, the environment variable
1115 "upgrade_available" is used. If "upgrade_available" is
1116 0, "bootcount" is always 0, if "upgrade_available" is
1117 1 "bootcount" is incremented in the environment.
1118 So the Userspace Applikation must set the "upgrade_available"
1119 and "bootcount" variable to 0, if a boot was successfully.
1120
wdenkc6097192002-11-03 00:24:07 +00001121- Pre-Boot Commands:
1122 CONFIG_PREBOOT
1123
1124 When this option is #defined, the existence of the
1125 environment variable "preboot" will be checked
1126 immediately before starting the CONFIG_BOOTDELAY
1127 countdown and/or running the auto-boot command resp.
1128 entering interactive mode.
1129
1130 This feature is especially useful when "preboot" is
1131 automatically generated or modified. For an example
1132 see the LWMON board specific code: here "preboot" is
1133 modified when the user holds down a certain
1134 combination of keys on the (special) keyboard when
1135 booting the systems
1136
1137- Serial Download Echo Mode:
1138 CONFIG_LOADS_ECHO
1139 If defined to 1, all characters received during a
1140 serial download (using the "loads" command) are
1141 echoed back. This might be needed by some terminal
1142 emulations (like "cu"), but may as well just take
1143 time on others. This setting #define's the initial
1144 value of the "loads_echo" environment variable.
1145
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001146- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001147 CONFIG_KGDB_BAUDRATE
1148 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001149 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001150
1151- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001152 Monitor commands can be included or excluded
1153 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +00001154 <config_cmd_all.h> and #undef'ing unwanted
1155 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001156 and augmenting with additional #define's
1157 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001158
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001159 The default command configuration includes all commands
1160 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001161
Marek Vasutc4d8a1b2014-03-05 19:58:39 +01001162 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001163 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001164 CONFIG_CMD_BDI bdinfo
1165 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1166 CONFIG_CMD_BMP * BMP support
1167 CONFIG_CMD_BSP * Board specific commands
1168 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -04001169 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001170 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -08001171 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001172 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -05001173 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001174 CONFIG_CMD_DATE * support for RTC, date/time...
1175 CONFIG_CMD_DHCP * DHCP support
1176 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -06001177 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1178 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1179 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1180 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001181 CONFIG_CMD_DTT * Digital Therm and Thermostat
1182 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001183 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001184 CONFIG_CMD_EEPROM * EEPROM read/write support
1185 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001186 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001187 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001188 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001189 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001190 CONFIG_CMD_EXT2 * ext2 command support
1191 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001192 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1193 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001194 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001195 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001196 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001197 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001198 CONFIG_CMD_FLASH flinfo, erase, protect
1199 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001200 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001201 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001202 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001203 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001204 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001205 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1206 CONFIG_CMD_I2C * I2C serial bus support
1207 CONFIG_CMD_IDE * IDE harddisk support
1208 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001209 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001210 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001211 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001212 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001213 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001214 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001215 CONFIG_CMD_IRQ * irqinfo
1216 CONFIG_CMD_ITEST Integer/string test of 2 values
1217 CONFIG_CMD_JFFS2 * JFFS2 Support
1218 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001219 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001220 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1221 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001222 CONFIG_CMD_LOADB loadb
1223 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001224 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001225 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001226 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001227 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001228 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001229 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001230 CONFIG_CMD_MISC Misc functions like sleep etc
1231 CONFIG_CMD_MMC * MMC memory mapped support
1232 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001233 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001234 CONFIG_CMD_NAND * NAND support
1235 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001236 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001237 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001238 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001239 CONFIG_CMD_PCI * pciinfo
1240 CONFIG_CMD_PCMCIA * PCMCIA support
1241 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1242 host
1243 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001244 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001245 CONFIG_CMD_REGINFO * Register dump
1246 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001247 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001248 CONFIG_CMD_SAVES * save S record dump
1249 CONFIG_CMD_SCSI * SCSI Support
1250 CONFIG_CMD_SDRAM * print SDRAM configuration information
1251 (requires CONFIG_CMD_I2C)
1252 CONFIG_CMD_SETGETDCR Support for DCR Register access
1253 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001254 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001255 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001256 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001257 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001258 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001259 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001260 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001261 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001262 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1263 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001264 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001265 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001266 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001267 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001268 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001269
1270 EXAMPLE: If you want all functions except of network
1271 support you can write:
1272
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001273 #include "config_cmd_all.h"
1274 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001275
Gerald Van Barend6abef42007-03-31 12:23:51 -04001276 Other Commands:
1277 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001278
1279 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001280 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001281 what you (and your U-Boot users) are doing. Data
1282 cache cannot be enabled on systems like the 8xx or
1283 8260 (where accesses to the IMMR region must be
1284 uncached), and it cannot be disabled on all other
1285 systems where we (mis-) use the data cache to hold an
1286 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001287
1288
1289 XXX - this list needs to get updated!
1290
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001291- Regular expression support:
1292 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001293 If this variable is defined, U-Boot is linked against
1294 the SLRE (Super Light Regular Expression) library,
1295 which adds regex support to some commands, as for
1296 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001297
Simon Glass3d686442011-10-15 05:48:20 +00001298- Device tree:
1299 CONFIG_OF_CONTROL
1300 If this variable is defined, U-Boot will use a device tree
1301 to configure its devices, instead of relying on statically
1302 compiled #defines in the board file. This option is
1303 experimental and only available on a few boards. The device
1304 tree is available in the global data as gd->fdt_blob.
1305
Simon Glass5cb34db2011-10-24 19:15:31 +00001306 U-Boot needs to get its device tree from somewhere. This can
1307 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001308
1309 CONFIG_OF_EMBED
1310 If this variable is defined, U-Boot will embed a device tree
1311 binary in its image. This device tree file should be in the
1312 board directory and called <soc>-<board>.dts. The binary file
1313 is then picked up in board_init_f() and made available through
1314 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001315
Simon Glass5cb34db2011-10-24 19:15:31 +00001316 CONFIG_OF_SEPARATE
1317 If this variable is defined, U-Boot will build a device tree
1318 binary. It will be called u-boot.dtb. Architecture-specific
1319 code will locate it at run-time. Generally this works by:
1320
1321 cat u-boot.bin u-boot.dtb >image.bin
1322
1323 and in fact, U-Boot does this for you, creating a file called
1324 u-boot-dtb.bin which is useful in the common case. You can
1325 still use the individual files if you need something more
1326 exotic.
1327
wdenkc6097192002-11-03 00:24:07 +00001328- Watchdog:
1329 CONFIG_WATCHDOG
1330 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001331 support for the SoC. There must be support in the SoC
1332 specific code for a watchdog. For the 8xx and 8260
1333 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1334 register. When supported for a specific SoC is
1335 available, then no further board specific code should
1336 be needed to use it.
1337
1338 CONFIG_HW_WATCHDOG
1339 When using a watchdog circuitry external to the used
1340 SoC, then define this variable and provide board
1341 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001342
Heiko Schocher735326c2015-01-21 08:38:22 +01001343 CONFIG_AT91_HW_WDT_TIMEOUT
1344 specify the timeout in seconds. default 2 seconds.
1345
stroeseb9c17c52003-04-04 15:53:41 +00001346- U-Boot Version:
1347 CONFIG_VERSION_VARIABLE
1348 If this variable is defined, an environment variable
1349 named "ver" is created by U-Boot showing the U-Boot
1350 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001351 Any change to this variable will be reverted at the
1352 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001353
wdenkc6097192002-11-03 00:24:07 +00001354- Real-Time Clock:
1355
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001356 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001357 has to be selected, too. Define exactly one of the
1358 following options:
1359
1360 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1361 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001362 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001363 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001364 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001365 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001366 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001367 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001368 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001369 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001370 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001371 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001372 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1373 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001374
wdenkb9bbd242003-06-30 16:24:52 +00001375 Note that if the RTC uses I2C, then the I2C interface
1376 must also be configured. See I2C Support, below.
1377
Peter Tyser9902e422008-12-17 16:36:21 -06001378- GPIO Support:
1379 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001380
Chris Packham9b383202010-12-19 10:12:13 +00001381 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1382 chip-ngpio pairs that tell the PCA953X driver the number of
1383 pins supported by a particular chip.
1384
Peter Tyser9902e422008-12-17 16:36:21 -06001385 Note that if the GPIO device uses I2C, then the I2C interface
1386 must also be configured. See I2C Support, below.
1387
Simon Glass4dc47ca2014-06-11 23:29:41 -06001388- I/O tracing:
1389 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1390 accesses and can checksum them or write a list of them out
1391 to memory. See the 'iotrace' command for details. This is
1392 useful for testing device drivers since it can confirm that
1393 the driver behaves the same way before and after a code
1394 change. Currently this is supported on sandbox and arm. To
1395 add support for your architecture, add '#include <iotrace.h>'
1396 to the bottom of arch/<arch>/include/asm/io.h and test.
1397
1398 Example output from the 'iotrace stats' command is below.
1399 Note that if the trace buffer is exhausted, the checksum will
1400 still continue to operate.
1401
1402 iotrace is enabled
1403 Start: 10000000 (buffer start address)
1404 Size: 00010000 (buffer size)
1405 Offset: 00000120 (current buffer offset)
1406 Output: 10000120 (start + offset)
1407 Count: 00000018 (number of trace records)
1408 CRC32: 9526fb66 (CRC32 of all trace records)
1409
wdenkc6097192002-11-03 00:24:07 +00001410- Timestamp Support:
1411
wdenk4a5c8a72003-03-06 00:02:04 +00001412 When CONFIG_TIMESTAMP is selected, the timestamp
1413 (date and time) of an image is printed by image
1414 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001415 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001416
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001417- Partition Labels (disklabels) Supported:
1418 Zero or more of the following:
1419 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1420 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1421 Intel architecture, USB sticks, etc.
1422 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1423 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1424 bootloader. Note 2TB partition limit; see
1425 disk/part_efi.c
1426 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001427
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001428 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1429 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001430 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001431
1432- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001433 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1434 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001435
wdenk369d43d2004-03-14 14:09:05 +00001436 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1437 be performed by calling the function
1438 ide_set_reset(int reset)
1439 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001440
1441- ATAPI Support:
1442 CONFIG_ATAPI
1443
1444 Set this to enable ATAPI support.
1445
wdenkf602aa02004-03-13 23:29:43 +00001446- LBA48 Support
1447 CONFIG_LBA48
1448
1449 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001450 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001451 Whithout these , LBA48 support uses 32bit variables and will 'only'
1452 support disks up to 2.1TB.
1453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001454 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001455 When enabled, makes the IDE subsystem use 64bit sector addresses.
1456 Default is 32bit.
1457
wdenkc6097192002-11-03 00:24:07 +00001458- SCSI Support:
1459 At the moment only there is only support for the
1460 SYM53C8XX SCSI controller; define
1461 CONFIG_SCSI_SYM53C8XX to enable it.
1462
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001463 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1464 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1465 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001466 maximum numbers of LUNs, SCSI ID's and target
1467 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001468 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001469
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001470 The environment variable 'scsidevs' is set to the number of
1471 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001472
wdenkc6097192002-11-03 00:24:07 +00001473- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001474 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001475 Support for Intel 8254x/8257x gigabit chips.
1476
1477 CONFIG_E1000_SPI
1478 Utility code for direct access to the SPI bus on Intel 8257x.
1479 This does not do anything useful unless you set at least one
1480 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1481
1482 CONFIG_E1000_SPI_GENERIC
1483 Allow generic access to the SPI bus on the Intel 8257x, for
1484 example with the "sspi" command.
1485
1486 CONFIG_CMD_E1000
1487 Management command for E1000 devices. When used on devices
1488 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001489
Andre Schwarz68c2a302008-03-06 16:45:44 +01001490 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001491 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001492
wdenkc6097192002-11-03 00:24:07 +00001493 CONFIG_EEPRO100
1494 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001495 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001496 write routine for first time initialisation.
1497
1498 CONFIG_TULIP
1499 Support for Digital 2114x chips.
1500 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1501 modem chip initialisation (KS8761/QS6611).
1502
1503 CONFIG_NATSEMI
1504 Support for National dp83815 chips.
1505
1506 CONFIG_NS8382X
1507 Support for National dp8382[01] gigabit chips.
1508
wdenkaa603362003-05-12 21:50:16 +00001509- NETWORK Support (other):
1510
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001511 CONFIG_DRIVER_AT91EMAC
1512 Support for AT91RM9200 EMAC.
1513
1514 CONFIG_RMII
1515 Define this to use reduced MII inteface
1516
1517 CONFIG_DRIVER_AT91EMAC_QUIET
1518 If this defined, the driver is quiet.
1519 The driver doen't show link status messages.
1520
Rob Herringc9830dc2011-12-15 11:15:49 +00001521 CONFIG_CALXEDA_XGMAC
1522 Support for the Calxeda XGMAC device
1523
Ashok93fb8722012-10-15 06:20:47 +00001524 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001525 Support for SMSC's LAN91C96 chips.
1526
1527 CONFIG_LAN91C96_BASE
1528 Define this to hold the physical address
1529 of the LAN91C96's I/O space
1530
1531 CONFIG_LAN91C96_USE_32_BIT
1532 Define this to enable 32 bit addressing
1533
Ashok93fb8722012-10-15 06:20:47 +00001534 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001535 Support for SMSC's LAN91C111 chip
1536
1537 CONFIG_SMC91111_BASE
1538 Define this to hold the physical address
1539 of the device (I/O space)
1540
1541 CONFIG_SMC_USE_32_BIT
1542 Define this if data bus is 32 bits
1543
1544 CONFIG_SMC_USE_IOFUNCS
1545 Define this to use i/o functions instead of macros
1546 (some hardware wont work with macros)
1547
Heiko Schocher7d037f72011-11-15 10:00:04 -05001548 CONFIG_DRIVER_TI_EMAC
1549 Support for davinci emac
1550
1551 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1552 Define this if you have more then 3 PHYs.
1553
Macpaul Lin199c6252010-12-21 16:59:46 +08001554 CONFIG_FTGMAC100
1555 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1556
1557 CONFIG_FTGMAC100_EGIGA
1558 Define this to use GE link update with gigabit PHY.
1559 Define this if FTGMAC100 is connected to gigabit PHY.
1560 If your system has 10/100 PHY only, it might not occur
1561 wrong behavior. Because PHY usually return timeout or
1562 useless data when polling gigabit status and gigabit
1563 control registers. This behavior won't affect the
1564 correctnessof 10/100 link speed update.
1565
Mike Rapoportf4761af2009-11-11 10:03:03 +02001566 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001567 Support for SMSC's LAN911x and LAN921x chips
1568
Mike Rapoportf4761af2009-11-11 10:03:03 +02001569 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001570 Define this to hold the physical address
1571 of the device (I/O space)
1572
Mike Rapoportf4761af2009-11-11 10:03:03 +02001573 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001574 Define this if data bus is 32 bits
1575
Mike Rapoportf4761af2009-11-11 10:03:03 +02001576 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001577 Define this if data bus is 16 bits. If your processor
1578 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001579 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001580
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001581 CONFIG_SH_ETHER
1582 Support for Renesas on-chip Ethernet controller
1583
1584 CONFIG_SH_ETHER_USE_PORT
1585 Define the number of ports to be used
1586
1587 CONFIG_SH_ETHER_PHY_ADDR
1588 Define the ETH PHY's address
1589
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001590 CONFIG_SH_ETHER_CACHE_WRITEBACK
1591 If this option is set, the driver enables cache flush.
1592
Heiko Schocher2b387762014-07-18 06:07:19 +02001593- PWM Support:
1594 CONFIG_PWM_IMX
1595 Support for PWM modul on the imx6.
1596
Vadim Bendeburydac69642011-10-17 08:36:14 +00001597- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001598 CONFIG_TPM
1599 Support TPM devices.
1600
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001601 CONFIG_TPM_TIS_I2C
1602 Support for i2c bus TPM devices. Only one device
1603 per system is supported at this time.
1604
1605 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1606 Define the the i2c bus number for the TPM device
1607
1608 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1609 Define the TPM's address on the i2c bus
1610
1611 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1612 Define the burst count bytes upper limit
1613
Dirk Eibach20489092013-06-26 15:55:15 +02001614 CONFIG_TPM_ATMEL_TWI
1615 Support for Atmel TWI TPM device. Requires I2C support.
1616
Che-liang Chiouacea5702013-04-12 11:04:34 +00001617 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001618 Support for generic parallel port TPM devices. Only one device
1619 per system is supported at this time.
1620
1621 CONFIG_TPM_TIS_BASE_ADDRESS
1622 Base address where the generic TPM device is mapped
1623 to. Contemporary x86 systems usually map it at
1624 0xfed40000.
1625
Reinhard Pfau4fece432013-06-26 15:55:13 +02001626 CONFIG_CMD_TPM
1627 Add tpm monitor functions.
1628 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1629 provides monitor access to authorized functions.
1630
1631 CONFIG_TPM
1632 Define this to enable the TPM support library which provides
1633 functional interfaces to some TPM commands.
1634 Requires support for a TPM device.
1635
1636 CONFIG_TPM_AUTH_SESSIONS
1637 Define this to enable authorized functions in the TPM library.
1638 Requires CONFIG_TPM and CONFIG_SHA1.
1639
wdenkc6097192002-11-03 00:24:07 +00001640- USB Support:
1641 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001642 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001643 CONFIG_USB_UHCI to enable it.
1644 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001645 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001646 storage devices.
1647 Note:
1648 Supported are USB Keyboards and USB Floppy drives
1649 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001650 MPC5200 USB requires additional defines:
1651 CONFIG_USB_CLOCK
1652 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001653 CONFIG_PSC3_USB
1654 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001655 CONFIG_USB_CONFIG
1656 for differential drivers: 0x00001000
1657 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001658 for differential drivers on PSC3: 0x00000100
1659 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001660 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001661 May be defined to allow interrupt polling
1662 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001663
Simon Glass5978cdb2012-02-27 10:52:47 +00001664 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1665 txfilltuning field in the EHCI controller on reset.
1666
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001667 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1668 HW module registers.
1669
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001670- USB Device:
1671 Define the below if you wish to use the USB console.
1672 Once firmware is rebuilt from a serial console issue the
1673 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001674 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001675 it has found a new device. The environment variable usbtty
1676 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001677 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001678 Common Device Class Abstract Control Model serial device.
1679 If you select usbtty = gserial you should be able to enumerate
1680 a Linux host by
1681 # modprobe usbserial vendor=0xVendorID product=0xProductID
1682 else if using cdc_acm, simply setting the environment
1683 variable usbtty to be cdc_acm should suffice. The following
1684 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001685
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001686 CONFIG_USB_DEVICE
1687 Define this to build a UDC device
1688
1689 CONFIG_USB_TTY
1690 Define this to have a tty type of device available to
1691 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001692
Vipin KUMARbdb17702012-03-26 15:38:06 +05301693 CONFIG_USBD_HS
1694 Define this to enable the high speed support for usb
1695 device and usbtty. If this feature is enabled, a routine
1696 int is_usbd_high_speed(void)
1697 also needs to be defined by the driver to dynamically poll
1698 whether the enumeration has succeded at high speed or full
1699 speed.
1700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001701 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001702 Define this if you want stdin, stdout &/or stderr to
1703 be set to usbtty.
1704
1705 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001706 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001707 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001708 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001710 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001711 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001712 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001713
Wolfgang Denke2601822006-06-14 18:14:56 +02001714 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001715 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001716 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001717 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1718 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1719 should pretend to be a Linux device to it's target host.
1720
1721 CONFIG_USBD_MANUFACTURER
1722 Define this string as the name of your company for
1723 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001724
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001725 CONFIG_USBD_PRODUCT_NAME
1726 Define this string as the name of your product
1727 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001728
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001729 CONFIG_USBD_VENDORID
1730 Define this as your assigned Vendor ID from the USB
1731 Implementors Forum. This *must* be a genuine Vendor ID
1732 to avoid polluting the USB namespace.
1733 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001734
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001735 CONFIG_USBD_PRODUCTID
1736 Define this as the unique Product ID
1737 for your device
1738 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001739
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001740- ULPI Layer Support:
1741 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1742 the generic ULPI layer. The generic layer accesses the ULPI PHY
1743 via the platform viewport, so you need both the genric layer and
1744 the viewport enabled. Currently only Chipidea/ARC based
1745 viewport is supported.
1746 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1747 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001748 If your ULPI phy needs a different reference clock than the
1749 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1750 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001751
wdenk7a428cc2003-06-15 22:40:42 +00001752- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001753 The MMC controller on the Intel PXA is supported. To
1754 enable this define CONFIG_MMC. The MMC can be
1755 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001756 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001757 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1758 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001759
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001760 CONFIG_SH_MMCIF
1761 Support for Renesas on-chip MMCIF controller
1762
1763 CONFIG_SH_MMCIF_ADDR
1764 Define the base address of MMCIF registers
1765
1766 CONFIG_SH_MMCIF_CLK
1767 Define the clock frequency for MMCIF
1768
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001769 CONFIG_GENERIC_MMC
1770 Enable the generic MMC driver
1771
1772 CONFIG_SUPPORT_EMMC_BOOT
1773 Enable some additional features of the eMMC boot partitions.
1774
1775 CONFIG_SUPPORT_EMMC_RPMB
1776 Enable the commands for reading, writing and programming the
1777 key for the Replay Protection Memory Block partition in eMMC.
1778
Tom Rini58a8d322013-03-14 05:32:47 +00001779- USB Device Firmware Update (DFU) class support:
1780 CONFIG_DFU_FUNCTION
1781 This enables the USB portion of the DFU USB class
1782
1783 CONFIG_CMD_DFU
1784 This enables the command "dfu" which is used to have
1785 U-Boot create a DFU class device via USB. This command
1786 requires that the "dfu_alt_info" environment variable be
1787 set and define the alt settings to expose to the host.
1788
1789 CONFIG_DFU_MMC
1790 This enables support for exposing (e)MMC devices via DFU.
1791
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001792 CONFIG_DFU_NAND
1793 This enables support for exposing NAND devices via DFU.
1794
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301795 CONFIG_DFU_RAM
1796 This enables support for exposing RAM via DFU.
1797 Note: DFU spec refer to non-volatile memory usage, but
1798 allow usages beyond the scope of spec - here RAM usage,
1799 one that would help mostly the developer.
1800
Heiko Schochera2f831e2013-06-12 06:05:51 +02001801 CONFIG_SYS_DFU_DATA_BUF_SIZE
1802 Dfu transfer uses a buffer before writing data to the
1803 raw storage device. Make the size (in bytes) of this buffer
1804 configurable. The size of this buffer is also configurable
1805 through the "dfu_bufsiz" environment variable.
1806
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001807 CONFIG_SYS_DFU_MAX_FILE_SIZE
1808 When updating files rather than the raw storage device,
1809 we use a static buffer to copy the file into and then write
1810 the buffer once we've been given the whole file. Define
1811 this to the maximum filesize (in bytes) for the buffer.
1812 Default is 4 MiB if undefined.
1813
Heiko Schochere1ba1512014-03-18 08:09:56 +01001814 DFU_DEFAULT_POLL_TIMEOUT
1815 Poll timeout [ms], is the timeout a device can send to the
1816 host. The host must wait for this timeout before sending
1817 a subsequent DFU_GET_STATUS request to the device.
1818
1819 DFU_MANIFEST_POLL_TIMEOUT
1820 Poll timeout [ms], which the device sends to the host when
1821 entering dfuMANIFEST state. Host waits this timeout, before
1822 sending again an USB request to the device.
1823
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001824- USB Device Android Fastboot support:
1825 CONFIG_CMD_FASTBOOT
1826 This enables the command "fastboot" which enables the Android
1827 fastboot mode for the platform's USB device. Fastboot is a USB
1828 protocol for downloading images, flashing and device control
1829 used on Android devices.
1830 See doc/README.android-fastboot for more information.
1831
1832 CONFIG_ANDROID_BOOT_IMAGE
1833 This enables support for booting images which use the Android
1834 image format header.
1835
1836 CONFIG_USB_FASTBOOT_BUF_ADDR
1837 The fastboot protocol requires a large memory buffer for
1838 downloads. Define this to the starting RAM address to use for
1839 downloaded images.
1840
1841 CONFIG_USB_FASTBOOT_BUF_SIZE
1842 The fastboot protocol requires a large memory buffer for
1843 downloads. This buffer should be as large as possible for a
1844 platform. Define this to the size available RAM for fastboot.
1845
Steve Raebfb9ba42014-08-26 11:47:28 -07001846 CONFIG_FASTBOOT_FLASH
1847 The fastboot protocol includes a "flash" command for writing
1848 the downloaded image to a non-volatile storage device. Define
1849 this to enable the "fastboot flash" command.
1850
1851 CONFIG_FASTBOOT_FLASH_MMC_DEV
1852 The fastboot "flash" command requires additional information
1853 regarding the non-volatile storage device. Define this to
1854 the eMMC device that fastboot should use to store the image.
1855
Steve Rae7d059342014-12-12 15:51:54 -08001856 CONFIG_FASTBOOT_GPT_NAME
1857 The fastboot "flash" command supports writing the downloaded
1858 image to the Protective MBR and the Primary GUID Partition
1859 Table. (Additionally, this downloaded image is post-processed
1860 to generate and write the Backup GUID Partition Table.)
1861 This occurs when the specified "partition name" on the
1862 "fastboot flash" command line matches this value.
1863 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1864
wdenkda04a8b2004-08-02 23:22:59 +00001865- Journaling Flash filesystem support:
1866 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1867 CONFIG_JFFS2_NAND_DEV
1868 Define these for a default partition on a NAND device
1869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001870 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1871 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001872 Define these for a default partition on a NOR device
1873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001874 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001875 Define this to create an own partition. You have to provide a
1876 function struct part_info* jffs2_part_info(int part_num)
1877
1878 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001879 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001880 to disable the command chpart. This is the default when you
1881 have not defined a custom partition
1882
Donggeun Kim8f814002011-10-24 21:15:28 +00001883- FAT(File Allocation Table) filesystem write function support:
1884 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001885
1886 Define this to enable support for saving memory data as a
1887 file in FAT formatted partition.
1888
1889 This will also enable the command "fatwrite" enabling the
1890 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001891
Gabe Black7f8574c2012-10-12 14:26:11 +00001892CBFS (Coreboot Filesystem) support
1893 CONFIG_CMD_CBFS
1894
1895 Define this to enable support for reading from a Coreboot
1896 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1897 and cbfsload.
1898
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301899- FAT(File Allocation Table) filesystem cluster size:
1900 CONFIG_FS_FAT_MAX_CLUSTSIZE
1901
1902 Define the max cluster size for fat operations else
1903 a default value of 65536 will be defined.
1904
wdenkc6097192002-11-03 00:24:07 +00001905- Keyboard Support:
1906 CONFIG_ISA_KEYBOARD
1907
1908 Define this to enable standard (PC-Style) keyboard
1909 support
1910
1911 CONFIG_I8042_KBD
1912 Standard PC keyboard driver with US (is default) and
1913 GERMAN key layout (switch via environment 'keymap=de') support.
1914 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1915 for cfb_console. Supports cursor blinking.
1916
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001917 CONFIG_CROS_EC_KEYB
1918 Enables a Chrome OS keyboard using the CROS_EC interface.
1919 This uses CROS_EC to communicate with a second microcontroller
1920 which provides key scans on request.
1921
wdenkc6097192002-11-03 00:24:07 +00001922- Video support:
1923 CONFIG_VIDEO
1924
1925 Define this to enable video support (for output to
1926 video).
1927
1928 CONFIG_VIDEO_CT69000
1929
1930 Enable Chips & Technologies 69000 Video chip
1931
1932 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001933 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001934 video output is selected via environment 'videoout'
1935 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1936 assumed.
wdenkc6097192002-11-03 00:24:07 +00001937
wdenkd3602132004-03-25 15:14:43 +00001938 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001939 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001940 are possible:
1941 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001942 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001943
1944 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1945 -------------+---------------------------------------------
1946 8 bits | 0x301* 0x303 0x305 0x161 0x307
1947 15 bits | 0x310 0x313 0x316 0x162 0x319
1948 16 bits | 0x311 0x314 0x317 0x163 0x31A
1949 24 bits | 0x312 0x315 0x318 ? 0x31B
1950 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001951 (i.e. setenv videomode 317; saveenv; reset;)
1952
wdenkd3602132004-03-25 15:14:43 +00001953 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001954 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001955
1956
stroeseb9c17c52003-04-04 15:53:41 +00001957 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001958 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001959 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1960 or CONFIG_VIDEO_SED13806_16BPP
1961
Timur Tabi020edd22011-02-15 17:09:19 -06001962 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001963 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001964 SOCs that have a DIU should define this macro to enable DIU
1965 support, and should also define these other macros:
1966
1967 CONFIG_SYS_DIU_ADDR
1968 CONFIG_VIDEO
1969 CONFIG_CMD_BMP
1970 CONFIG_CFB_CONSOLE
1971 CONFIG_VIDEO_SW_CURSOR
1972 CONFIG_VGA_AS_SINGLE_DEVICE
1973 CONFIG_VIDEO_LOGO
1974 CONFIG_VIDEO_BMP_LOGO
1975
Timur Tabi32f709e2011-04-11 14:18:22 -05001976 The DIU driver will look for the 'video-mode' environment
1977 variable, and if defined, enable the DIU as a console during
1978 boot. See the documentation file README.video for a
1979 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001980
Simon Glass54df8ce2012-12-03 13:59:47 +00001981 CONFIG_VIDEO_VGA
1982
1983 Enable the VGA video / BIOS for x86. The alternative if you
1984 are using coreboot is to use the coreboot frame buffer
1985 driver.
1986
1987
wdenk4e112c12003-06-03 23:54:09 +00001988- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001989 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001990
wdenk57b2d802003-06-27 21:31:46 +00001991 Define this to enable a custom keyboard support.
1992 This simply calls drv_keyboard_init() which must be
1993 defined in your board-specific files.
1994 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001995
wdenkc6097192002-11-03 00:24:07 +00001996- LCD Support: CONFIG_LCD
1997
1998 Define this to enable LCD support (for output to LCD
1999 display); also select one of the supported displays
2000 by defining one of these:
2001
Stelian Popf6f86652008-05-09 21:57:18 +02002002 CONFIG_ATMEL_LCD:
2003
2004 HITACHI TX09D70VM1CCA, 3.5", 240x320.
2005
wdenkc0d54ae2003-11-25 16:55:19 +00002006 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00002007
wdenkc0d54ae2003-11-25 16:55:19 +00002008 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00002009
wdenkc0d54ae2003-11-25 16:55:19 +00002010 CONFIG_NEC_NL6448BC20
2011
2012 NEC NL6448BC20-08. 6.5", 640x480.
2013 Active, color, single scan.
2014
2015 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00002016
wdenkc0d54ae2003-11-25 16:55:19 +00002017 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00002018 Active, color, single scan.
2019
2020 CONFIG_SHARP_16x9
2021
2022 Sharp 320x240. Active, color, single scan.
2023 It isn't 16x9, and I am not sure what it is.
2024
2025 CONFIG_SHARP_LQ64D341
2026
2027 Sharp LQ64D341 display, 640x480.
2028 Active, color, single scan.
2029
2030 CONFIG_HLD1045
2031
2032 HLD1045 display, 640x480.
2033 Active, color, single scan.
2034
2035 CONFIG_OPTREX_BW
2036
2037 Optrex CBL50840-2 NF-FW 99 22 M5
2038 or
2039 Hitachi LMG6912RPFC-00T
2040 or
2041 Hitachi SP14Q002
2042
2043 320x240. Black & white.
2044
2045 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002046 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00002047
Simon Glass599a4df2012-10-17 13:24:54 +00002048 CONFIG_LCD_ALIGNMENT
2049
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002050 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00002051 defined then the LCD will be aligned to this value instead.
2052 For ARM it is sometimes useful to use MMU_SECTION_SIZE
2053 here, since it is cheaper to change data cache settings on
2054 a per-section basis.
2055
Simon Glassaf3e2802012-10-17 13:24:59 +00002056 CONFIG_CONSOLE_SCROLL_LINES
2057
2058 When the console need to be scrolled, this is the number of
2059 lines to scroll by. It defaults to 1. Increasing this makes
2060 the console jump but can help speed up operation when scrolling
2061 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00002062
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00002063 CONFIG_LCD_BMP_RLE8
2064
2065 Support drawing of RLE8-compressed bitmaps on the LCD.
2066
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00002067 CONFIG_I2C_EDID
2068
2069 Enables an 'i2c edid' command which can read EDID
2070 information over I2C from an attached LCD display.
2071
wdenkeb20ad32003-09-05 23:19:14 +00002072- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00002073
wdenk57b2d802003-06-27 21:31:46 +00002074 If this option is set, the environment is checked for
2075 a variable "splashimage". If found, the usual display
2076 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00002077 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00002078 specified in "splashimage" is loaded instead. The
2079 console is redirected to the "nulldev", too. This
2080 allows for a "silent" boot where a splash screen is
2081 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00002082
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002083 CONFIG_SPLASHIMAGE_GUARD
2084
2085 If this option is set, then U-Boot will prevent the environment
2086 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05002087 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00002088 This option is useful for targets where, due to alignment
2089 restrictions, an improperly aligned BMP image will cause a data
2090 abort. If you think you will not have problems with unaligned
2091 accesses (for example because your toolchain prevents them)
2092 there is no need to set this option.
2093
Matthias Weisser53884182009-07-09 16:07:30 +02002094 CONFIG_SPLASH_SCREEN_ALIGN
2095
2096 If this option is set the splash image can be freely positioned
2097 on the screen. Environment variable "splashpos" specifies the
2098 position as "x,y". If a positive number is given it is used as
2099 number of pixel from left/top. If a negative number is given it
2100 is used as number of pixel from right/bottom. You can also
2101 specify 'm' for centering the image.
2102
2103 Example:
2104 setenv splashpos m,m
2105 => image at center of screen
2106
2107 setenv splashpos 30,20
2108 => image at x = 30 and y = 20
2109
2110 setenv splashpos -10,m
2111 => vertically centered image
2112 at x = dspWidth - bmpWidth - 9
2113
Stefan Roesed9d97742005-09-22 09:04:17 +02002114- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2115
2116 If this option is set, additionally to standard BMP
2117 images, gzipped BMP images can be displayed via the
2118 splashscreen support or the bmp command.
2119
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01002120- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2121
2122 If this option is set, 8-bit RLE compressed BMP images
2123 can be displayed via the splashscreen support or the
2124 bmp command.
2125
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002126- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00002127 CONFIG_CMD_ZIP
2128
2129 If this option is set, it would use zlib deflate method
2130 to compress the specified memory at its best effort.
2131
wdenk710e3502003-08-29 20:57:53 +00002132- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07002133 CONFIG_GZIP
2134
2135 Enabled by default to support gzip compressed images.
2136
wdenk710e3502003-08-29 20:57:53 +00002137 CONFIG_BZIP2
2138
2139 If this option is set, support for bzip2 compressed
2140 images is included. If not, only uncompressed and gzip
2141 compressed images are supported.
2142
wdenk9c53f402003-10-15 23:53:47 +00002143 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002144 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00002145 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00002146
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002147 CONFIG_LZMA
2148
2149 If this option is set, support for lzma compressed
2150 images is included.
2151
2152 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2153 requires an amount of dynamic memory that is given by the
2154 formula:
2155
2156 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2157
2158 Where lc and lp stand for, respectively, Literal context bits
2159 and Literal pos bits.
2160
2161 This value is upper-bounded by 14MB in the worst case. Anyway,
2162 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2163 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2164 a very small buffer.
2165
2166 Use the lzmainfo tool to determinate the lc and lp values and
2167 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002168 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002169
Kees Cook5b06e642013-08-16 07:59:12 -07002170 CONFIG_LZO
2171
2172 If this option is set, support for LZO compressed images
2173 is included.
2174
wdenk0e2bd9c2004-06-06 21:51:03 +00002175- MII/PHY support:
2176 CONFIG_PHY_ADDR
2177
2178 The address of PHY on MII bus.
2179
2180 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2181
2182 The clock frequency of the MII bus
2183
2184 CONFIG_PHY_GIGE
2185
2186 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002187 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002188
2189 CONFIG_PHY_RESET_DELAY
2190
2191 Some PHY like Intel LXT971A need extra delay after
2192 reset before any MII register access is possible.
2193 For such PHY, set this option to the usec delay
2194 required. (minimum 300usec for LXT971A)
2195
2196 CONFIG_PHY_CMD_DELAY (ppc4xx)
2197
2198 Some PHY like Intel LXT971A need extra delay after
2199 command issued before MII status register can be read
2200
wdenkc6097192002-11-03 00:24:07 +00002201- Ethernet address:
2202 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04002203 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002204 CONFIG_ETH2ADDR
2205 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04002206 CONFIG_ETH4ADDR
2207 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002208
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002209 Define a default value for Ethernet address to use
2210 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002211 is not determined automatically.
2212
2213- IP address:
2214 CONFIG_IPADDR
2215
2216 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002217 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002218 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002219 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002220
2221- Server IP address:
2222 CONFIG_SERVERIP
2223
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002224 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002225 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002226 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002227
Robin Getz470a6d42009-07-21 12:15:28 -04002228 CONFIG_KEEP_SERVERADDR
2229
2230 Keeps the server's MAC address, in the env 'serveraddr'
2231 for passing to bootargs (like Linux's netconsole option)
2232
Wolfgang Denk26da2992011-10-26 10:21:22 +00002233- Gateway IP address:
2234 CONFIG_GATEWAYIP
2235
2236 Defines a default value for the IP address of the
2237 default router where packets to other networks are
2238 sent to.
2239 (Environment variable "gatewayip")
2240
2241- Subnet mask:
2242 CONFIG_NETMASK
2243
2244 Defines a default value for the subnet mask (or
2245 routing prefix) which is used to determine if an IP
2246 address belongs to the local subnet or needs to be
2247 forwarded through a router.
2248 (Environment variable "netmask")
2249
David Updegraff7280da72007-06-11 10:41:07 -05002250- Multicast TFTP Mode:
2251 CONFIG_MCAST_TFTP
2252
2253 Defines whether you want to support multicast TFTP as per
2254 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002255 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002256 driver in use must provide a function: mcast() to join/leave a
2257 multicast group.
2258
wdenkc6097192002-11-03 00:24:07 +00002259- BOOTP Recovery Mode:
2260 CONFIG_BOOTP_RANDOM_DELAY
2261
2262 If you have many targets in a network that try to
2263 boot using BOOTP, you may want to avoid that all
2264 systems send out BOOTP requests at precisely the same
2265 moment (which would happen for instance at recovery
2266 from a power failure, when all systems will try to
2267 boot, thus flooding the BOOTP server. Defining
2268 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2269 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002270 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002271
2272 1st BOOTP request: delay 0 ... 1 sec
2273 2nd BOOTP request: delay 0 ... 2 sec
2274 3rd BOOTP request: delay 0 ... 4 sec
2275 4th and following
2276 BOOTP requests: delay 0 ... 8 sec
2277
Thierry Reding8977cda2014-08-19 10:21:24 +02002278 CONFIG_BOOTP_ID_CACHE_SIZE
2279
2280 BOOTP packets are uniquely identified using a 32-bit ID. The
2281 server will copy the ID from client requests to responses and
2282 U-Boot will use this to determine if it is the destination of
2283 an incoming response. Some servers will check that addresses
2284 aren't in use before handing them out (usually using an ARP
2285 ping) and therefore take up to a few hundred milliseconds to
2286 respond. Network congestion may also influence the time it
2287 takes for a response to make it back to the client. If that
2288 time is too long, U-Boot will retransmit requests. In order
2289 to allow earlier responses to still be accepted after these
2290 retransmissions, U-Boot's BOOTP client keeps a small cache of
2291 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2292 cache. The default is to keep IDs for up to four outstanding
2293 requests. Increasing this will allow U-Boot to accept offers
2294 from a BOOTP client in networks with unusually high latency.
2295
stroesee0aadfb2003-08-28 14:17:32 +00002296- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002297 You can fine tune the DHCP functionality by defining
2298 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002299
Jon Loeliger5336a762007-07-09 22:08:34 -05002300 CONFIG_BOOTP_SUBNETMASK
2301 CONFIG_BOOTP_GATEWAY
2302 CONFIG_BOOTP_HOSTNAME
2303 CONFIG_BOOTP_NISDOMAIN
2304 CONFIG_BOOTP_BOOTPATH
2305 CONFIG_BOOTP_BOOTFILESIZE
2306 CONFIG_BOOTP_DNS
2307 CONFIG_BOOTP_DNS2
2308 CONFIG_BOOTP_SEND_HOSTNAME
2309 CONFIG_BOOTP_NTPSERVER
2310 CONFIG_BOOTP_TIMEOFFSET
2311 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002312 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002313
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002314 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2315 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002316
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002317 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2318 after the configured retry count, the call will fail
2319 instead of starting over. This can be used to fail over
2320 to Link-local IP address configuration if the DHCP server
2321 is not available.
2322
stroesee0aadfb2003-08-28 14:17:32 +00002323 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2324 serverip from a DHCP server, it is possible that more
2325 than one DNS serverip is offered to the client.
2326 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2327 serverip will be stored in the additional environment
2328 variable "dnsip2". The first DNS serverip is always
2329 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002330 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002331
2332 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2333 to do a dynamic update of a DNS server. To do this, they
2334 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002335 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002336 of the "hostname" environment variable is passed as
2337 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002338
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002339 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2340
2341 A 32bit value in microseconds for a delay between
2342 receiving a "DHCP Offer" and sending the "DHCP Request".
2343 This fixes a problem with certain DHCP servers that don't
2344 respond 100% of the time to a "DHCP request". E.g. On an
2345 AT91RM9200 processor running at 180MHz, this delay needed
2346 to be *at least* 15,000 usec before a Windows Server 2003
2347 DHCP server would reply 100% of the time. I recommend at
2348 least 50,000 usec to be safe. The alternative is to hope
2349 that one of the retries will be successful but note that
2350 the DHCP timeout and retry process takes a longer than
2351 this delay.
2352
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002353 - Link-local IP address negotiation:
2354 Negotiate with other link-local clients on the local network
2355 for an address that doesn't require explicit configuration.
2356 This is especially useful if a DHCP server cannot be guaranteed
2357 to exist in all environments that the device must operate.
2358
2359 See doc/README.link-local for more information.
2360
wdenk145d2c12004-04-15 21:48:45 +00002361 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002362 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002363
2364 The device id used in CDP trigger frames.
2365
2366 CONFIG_CDP_DEVICE_ID_PREFIX
2367
2368 A two character string which is prefixed to the MAC address
2369 of the device.
2370
2371 CONFIG_CDP_PORT_ID
2372
2373 A printf format string which contains the ascii name of
2374 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002375 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002376
2377 CONFIG_CDP_CAPABILITIES
2378
2379 A 32bit integer which indicates the device capabilities;
2380 0x00000010 for a normal host which does not forwards.
2381
2382 CONFIG_CDP_VERSION
2383
2384 An ascii string containing the version of the software.
2385
2386 CONFIG_CDP_PLATFORM
2387
2388 An ascii string containing the name of the platform.
2389
2390 CONFIG_CDP_TRIGGER
2391
2392 A 32bit integer sent on the trigger.
2393
2394 CONFIG_CDP_POWER_CONSUMPTION
2395
2396 A 16bit integer containing the power consumption of the
2397 device in .1 of milliwatts.
2398
2399 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2400
2401 A byte containing the id of the VLAN.
2402
wdenkc6097192002-11-03 00:24:07 +00002403- Status LED: CONFIG_STATUS_LED
2404
2405 Several configurations allow to display the current
2406 status using a LED. For instance, the LED will blink
2407 fast while running U-Boot code, stop blinking as
2408 soon as a reply to a BOOTP request was received, and
2409 start blinking slow once the Linux kernel is running
2410 (supported by a status LED driver in the Linux
2411 kernel). Defining CONFIG_STATUS_LED enables this
2412 feature in U-Boot.
2413
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002414 Additional options:
2415
2416 CONFIG_GPIO_LED
2417 The status LED can be connected to a GPIO pin.
2418 In such cases, the gpio_led driver can be used as a
2419 status LED backend implementation. Define CONFIG_GPIO_LED
2420 to include the gpio_led driver in the U-Boot binary.
2421
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002422 CONFIG_GPIO_LED_INVERTED_TABLE
2423 Some GPIO connected LEDs may have inverted polarity in which
2424 case the GPIO high value corresponds to LED off state and
2425 GPIO low value corresponds to LED on state.
2426 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2427 with a list of GPIO LEDs that have inverted polarity.
2428
wdenkc6097192002-11-03 00:24:07 +00002429- CAN Support: CONFIG_CAN_DRIVER
2430
2431 Defining CONFIG_CAN_DRIVER enables CAN driver support
2432 on those systems that support this (optional)
2433 feature, like the TQM8xxL modules.
2434
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002435- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002436
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002437 This enable the NEW i2c subsystem, and will allow you to use
2438 i2c commands at the u-boot command line (as long as you set
2439 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2440 based realtime clock chips or other i2c devices. See
2441 common/cmd_i2c.c for a description of the command line
2442 interface.
2443
2444 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002445 - drivers/i2c/soft_i2c.c:
2446 - activate first bus with CONFIG_SYS_I2C_SOFT define
2447 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2448 for defining speed and slave address
2449 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2450 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2451 for defining speed and slave address
2452 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2453 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2454 for defining speed and slave address
2455 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2456 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2457 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002458
Heiko Schocherf2850742012-10-24 13:48:22 +02002459 - drivers/i2c/fsl_i2c.c:
2460 - activate i2c driver with CONFIG_SYS_I2C_FSL
2461 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2462 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2463 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2464 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002465 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002466 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2467 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2468 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2469 second bus.
2470
Simon Glass026fefb2012-10-30 07:28:53 +00002471 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002472 - activate this driver with CONFIG_SYS_I2C_TEGRA
2473 - This driver adds 4 i2c buses with a fix speed from
2474 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002475
Dirk Eibach42b204f2013-04-25 02:40:01 +00002476 - drivers/i2c/ppc4xx_i2c.c
2477 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2478 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2479 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2480
trema49f40a2013-09-21 18:13:35 +02002481 - drivers/i2c/i2c_mxc.c
2482 - activate this driver with CONFIG_SYS_I2C_MXC
2483 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2484 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2485 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2486 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2487 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2488 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002489 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002490 for speed, and 0 for slave.
2491
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002492 - drivers/i2c/rcar_i2c.c:
2493 - activate this driver with CONFIG_SYS_I2C_RCAR
2494 - This driver adds 4 i2c buses
2495
2496 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2497 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2498 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2499 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2500 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2501 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2502 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2503 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2504 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2505
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002506 - drivers/i2c/sh_i2c.c:
2507 - activate this driver with CONFIG_SYS_I2C_SH
2508 - This driver adds from 2 to 5 i2c buses
2509
2510 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2511 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2512 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2513 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2514 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2515 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2516 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2517 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2518 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2519 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2520 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2521 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002522 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002523
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002524 - drivers/i2c/omap24xx_i2c.c
2525 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2526 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2527 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2528 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2529 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2530 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2531 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2532 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2533 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2534 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2535 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2536
Heiko Schocher465819a2013-11-08 07:30:53 +01002537 - drivers/i2c/zynq_i2c.c
2538 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2539 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2540 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2541
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302542 - drivers/i2c/s3c24x0_i2c.c:
2543 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2544 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2545 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2546 with a fix speed from 100000 and the slave addr 0!
2547
Dirk Eibachb9577432014-07-03 09:28:18 +02002548 - drivers/i2c/ihs_i2c.c
2549 - activate this driver with CONFIG_SYS_I2C_IHS
2550 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2551 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2552 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2553 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2554 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2555 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2556 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2557 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2558 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2559 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2560 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2561 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2562
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002563 additional defines:
2564
2565 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002566 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002567 don't use/have i2c muxes on your i2c bus, this
2568 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2569 omit this define.
2570
2571 CONFIG_SYS_I2C_DIRECT_BUS
2572 define this, if you don't use i2c muxes on your hardware.
2573 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2574 omit this define.
2575
2576 CONFIG_SYS_I2C_MAX_HOPS
2577 define how many muxes are maximal consecutively connected
2578 on one i2c bus. If you not use i2c muxes, omit this
2579 define.
2580
2581 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002582 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002583 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2584 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2585 CONFIG_SYS_NUM_I2C_BUSES = 9:
2586
2587 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2588 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2589 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2590 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2591 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2592 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2593 {1, {I2C_NULL_HOP}}, \
2594 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2595 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2596 }
2597
2598 which defines
2599 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002600 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2601 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2602 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2603 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2604 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002605 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002606 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2607 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002608
2609 If you do not have i2c muxes on your board, omit this define.
2610
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002611- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002612
2613 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2614 provides the following compelling advantages:
2615
2616 - more than one i2c adapter is usable
2617 - approved multibus support
2618 - better i2c mux support
2619
2620 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002621
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002622 These enable legacy I2C serial bus commands. Defining
2623 CONFIG_HARD_I2C will include the appropriate I2C driver
2624 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002625
wdenk21136db2003-07-16 21:53:01 +00002626 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002627 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002628 CONFIG_COMMANDS) and communicate with i2c based realtime
2629 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002630 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002631
Ben Warren45657152006-09-07 16:50:54 -04002632 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002633
wdenk21136db2003-07-16 21:53:01 +00002634 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002635 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002637 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002638 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002639 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002640 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002641
Peter Tysere4d1abc2010-04-12 22:28:21 -05002642 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002643 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002644 and so its address should therefore be cleared to 0 (See,
2645 eg, MPC823e User's Manual p.16-473). So, set
2646 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002647
Eric Millbrandt12990a42009-09-03 08:09:44 -05002648 CONFIG_SYS_I2C_INIT_MPC5XXX
2649
2650 When a board is reset during an i2c bus transfer
2651 chips might think that the current transfer is still
2652 in progress. Reset the slave devices by sending start
2653 commands until the slave device responds.
2654
wdenk21136db2003-07-16 21:53:01 +00002655 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002656
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002657 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002658 then the following macros need to be defined (examples are
2659 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002660
2661 I2C_INIT
2662
wdenkb9bbd242003-06-30 16:24:52 +00002663 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002664 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002665
wdenk544e9732004-02-06 23:19:44 +00002666 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002667
wdenkc6097192002-11-03 00:24:07 +00002668 I2C_PORT
2669
wdenk4a5c8a72003-03-06 00:02:04 +00002670 (Only for MPC8260 CPU). The I/O port to use (the code
2671 assumes both bits are on the same port). Valid values
2672 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002673
2674 I2C_ACTIVE
2675
2676 The code necessary to make the I2C data line active
2677 (driven). If the data line is open collector, this
2678 define can be null.
2679
wdenkb9bbd242003-06-30 16:24:52 +00002680 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2681
wdenkc6097192002-11-03 00:24:07 +00002682 I2C_TRISTATE
2683
2684 The code necessary to make the I2C data line tri-stated
2685 (inactive). If the data line is open collector, this
2686 define can be null.
2687
wdenkb9bbd242003-06-30 16:24:52 +00002688 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2689
wdenkc6097192002-11-03 00:24:07 +00002690 I2C_READ
2691
York Sun4a598092013-04-01 11:29:11 -07002692 Code that returns true if the I2C data line is high,
2693 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002694
wdenkb9bbd242003-06-30 16:24:52 +00002695 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2696
wdenkc6097192002-11-03 00:24:07 +00002697 I2C_SDA(bit)
2698
York Sun4a598092013-04-01 11:29:11 -07002699 If <bit> is true, sets the I2C data line high. If it
2700 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002701
wdenkb9bbd242003-06-30 16:24:52 +00002702 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002703 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002704 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002705
wdenkc6097192002-11-03 00:24:07 +00002706 I2C_SCL(bit)
2707
York Sun4a598092013-04-01 11:29:11 -07002708 If <bit> is true, sets the I2C clock line high. If it
2709 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002710
wdenkb9bbd242003-06-30 16:24:52 +00002711 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002712 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002713 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002714
wdenkc6097192002-11-03 00:24:07 +00002715 I2C_DELAY
2716
2717 This delay is invoked four times per clock cycle so this
2718 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002719 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002720 like:
2721
wdenkb9bbd242003-06-30 16:24:52 +00002722 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002723
Mike Frysingeree12d542010-07-21 13:38:02 -04002724 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2725
2726 If your arch supports the generic GPIO framework (asm/gpio.h),
2727 then you may alternatively define the two GPIOs that are to be
2728 used as SCL / SDA. Any of the previous I2C_xxx macros will
2729 have GPIO-based defaults assigned to them as appropriate.
2730
2731 You should define these to the GPIO value as given directly to
2732 the generic GPIO functions.
2733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002734 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002735
wdenk57b2d802003-06-27 21:31:46 +00002736 When a board is reset during an i2c bus transfer
2737 chips might think that the current transfer is still
2738 in progress. On some boards it is possible to access
2739 the i2c SCLK line directly, either by using the
2740 processor pin as a GPIO or by having a second pin
2741 connected to the bus. If this option is defined a
2742 custom i2c_init_board() routine in boards/xxx/board.c
2743 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002744
Richard Retanubundf0149c2010-04-12 15:08:17 -04002745 CONFIG_SYS_I2C_BOARD_LATE_INIT
2746
2747 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2748 defined a custom i2c_board_late_init() routine in
2749 boards/xxx/board.c is run AFTER the operations in i2c_init()
2750 is completed. This callpoint can be used to unreset i2c bus
2751 using CPU i2c controller register accesses for CPUs whose i2c
2752 controller provide such a method. It is called at the end of
2753 i2c_init() to allow i2c_init operations to setup the i2c bus
2754 controller on the CPU (e.g. setting bus speed & slave address).
2755
wdenk0e2bd9c2004-06-06 21:51:03 +00002756 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2757
2758 This option enables configuration of bi_iic_fast[] flags
2759 in u-boot bd_info structure based on u-boot environment
2760 variable "i2cfast". (see also i2cfast)
2761
Ben Warren45657152006-09-07 16:50:54 -04002762 CONFIG_I2C_MULTI_BUS
2763
2764 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002765 must have a controller. At any point in time, only one bus is
2766 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002767 Note that bus numbering is zero-based.
2768
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002769 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002770
2771 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002772 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002773 is set, specify a list of bus-device pairs. Otherwise, specify
2774 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002775
2776 e.g.
2777 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002778 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002779
2780 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2781
Wolfgang Denk092ae952011-10-26 10:21:21 +00002782 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002783 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002784
2785 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2786
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002787 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002788
2789 If defined, then this indicates the I2C bus number for DDR SPD.
2790 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002792 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002793
2794 If defined, then this indicates the I2C bus number for the RTC.
2795 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2796
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002797 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002798
2799 If defined, then this indicates the I2C bus number for the DTT.
2800 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002802 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002803
2804 If defined, specifies the I2C address of the DTT device.
2805 If not defined, then U-Boot uses predefined value for
2806 specified DTT device.
2807
Andrew Dyer58c41f92008-12-29 17:36:01 -06002808 CONFIG_SOFT_I2C_READ_REPEATED_START
2809
2810 defining this will force the i2c_read() function in
2811 the soft_i2c driver to perform an I2C repeated start
2812 between writing the address pointer and reading the
2813 data. If this define is omitted the default behaviour
2814 of doing a stop-start sequence will be used. Most I2C
2815 devices can use either method, but some require one or
2816 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002817
wdenkc6097192002-11-03 00:24:07 +00002818- SPI Support: CONFIG_SPI
2819
2820 Enables SPI driver (so far only tested with
2821 SPI EEPROM, also an instance works with Crystal A/D and
2822 D/As on the SACSng board)
2823
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002824 CONFIG_SH_SPI
2825
2826 Enables the driver for SPI controller on SuperH. Currently
2827 only SH7757 is supported.
2828
wdenkc6097192002-11-03 00:24:07 +00002829 CONFIG_SPI_X
2830
2831 Enables extended (16-bit) SPI EEPROM addressing.
2832 (symmetrical to CONFIG_I2C_X)
2833
2834 CONFIG_SOFT_SPI
2835
wdenk4a5c8a72003-03-06 00:02:04 +00002836 Enables a software (bit-bang) SPI driver rather than
2837 using hardware support. This is a general purpose
2838 driver that only requires three general I/O port pins
2839 (two outputs, one input) to function. If this is
2840 defined, the board configuration must define several
2841 SPI configuration items (port pins to use, etc). For
2842 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002843
Ben Warren7efe9272008-01-16 22:37:35 -05002844 CONFIG_HARD_SPI
2845
2846 Enables a hardware SPI driver for general-purpose reads
2847 and writes. As with CONFIG_SOFT_SPI, the board configuration
2848 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002849 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002850 example, see include/configs/mpc8349emds.h.
2851
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002852 CONFIG_MXC_SPI
2853
2854 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002855 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002856
Heiko Schocherb77c8882014-07-14 10:22:11 +02002857 CONFIG_SYS_SPI_MXC_WAIT
2858 Timeout for waiting until spi transfer completed.
2859 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2860
Matthias Fuchsa4400872007-12-27 17:12:34 +01002861- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002862
Matthias Fuchsa4400872007-12-27 17:12:34 +01002863 Enables FPGA subsystem.
2864
2865 CONFIG_FPGA_<vendor>
2866
2867 Enables support for specific chip vendors.
2868 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002869
Matthias Fuchsa4400872007-12-27 17:12:34 +01002870 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002871
Matthias Fuchsa4400872007-12-27 17:12:34 +01002872 Enables support for FPGA family.
2873 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2874
2875 CONFIG_FPGA_COUNT
2876
2877 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002878
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302879 CONFIG_CMD_FPGA_LOADMK
2880
2881 Enable support for fpga loadmk command
2882
Michal Simek64c70982014-05-02 13:43:39 +02002883 CONFIG_CMD_FPGA_LOADP
2884
2885 Enable support for fpga loadp command - load partial bitstream
2886
2887 CONFIG_CMD_FPGA_LOADBP
2888
2889 Enable support for fpga loadbp command - load partial bitstream
2890 (Xilinx only)
2891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002892 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002893
wdenk57b2d802003-06-27 21:31:46 +00002894 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002895
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002896 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002897
wdenk4a5c8a72003-03-06 00:02:04 +00002898 Enable checks on FPGA configuration interface busy
2899 status by the configuration function. This option
2900 will require a board or device specific function to
2901 be written.
wdenkc6097192002-11-03 00:24:07 +00002902
2903 CONFIG_FPGA_DELAY
2904
2905 If defined, a function that provides delays in the FPGA
2906 configuration driver.
2907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002908 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002909 Allow Control-C to interrupt FPGA configuration
2910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002911 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002912
wdenk4a5c8a72003-03-06 00:02:04 +00002913 Check for configuration errors during FPGA bitfile
2914 loading. For example, abort during Virtex II
2915 configuration if the INIT_B line goes low (which
2916 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002918 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002919
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002920 Maximum time to wait for the INIT_B line to de-assert
2921 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002922 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002923 ms.
wdenkc6097192002-11-03 00:24:07 +00002924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002925 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002926
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002927 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002928 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002930 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002931
wdenk4a5c8a72003-03-06 00:02:04 +00002932 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002933 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002934
2935- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002936 CONFIG_BUILD_TARGET
2937
2938 Some SoCs need special image types (e.g. U-Boot binary
2939 with a special header) as build targets. By defining
2940 CONFIG_BUILD_TARGET in the SoC / board header, this
2941 special image will be automatically built upon calling
2942 make / MAKEALL.
2943
wdenkc6097192002-11-03 00:24:07 +00002944 CONFIG_IDENT_STRING
2945
wdenk4a5c8a72003-03-06 00:02:04 +00002946 If defined, this string will be added to the U-Boot
2947 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002948
2949- Vendor Parameter Protection:
2950
wdenk4a5c8a72003-03-06 00:02:04 +00002951 U-Boot considers the values of the environment
2952 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002953 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002954 are set once by the board vendor / manufacturer, and
2955 protects these variables from casual modification by
2956 the user. Once set, these variables are read-only,
2957 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002958 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002959
2960 If CONFIG_ENV_OVERWRITE is #defined in your config
2961 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002962 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002963 these parameters.
2964
2965 Alternatively, if you #define _both_ CONFIG_ETHADDR
2966 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002967 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002968 which can be changed exactly ONCE by the user. [The
2969 serial# is unaffected by this, i. e. it remains
2970 read-only.]
2971
Joe Hershberger71497d02012-12-11 22:16:31 -06002972 The same can be accomplished in a more flexible way
2973 for any variable by configuring the type of access
2974 to allow for those variables in the ".flags" variable
2975 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2976
wdenkc6097192002-11-03 00:24:07 +00002977- Protected RAM:
2978 CONFIG_PRAM
2979
2980 Define this variable to enable the reservation of
2981 "protected RAM", i. e. RAM which is not overwritten
2982 by U-Boot. Define CONFIG_PRAM to hold the number of
2983 kB you want to reserve for pRAM. You can overwrite
2984 this default value by defining an environment
2985 variable "pram" to the number of kB you want to
2986 reserve. Note that the board info structure will
2987 still show the full amount of RAM. If pRAM is
2988 reserved, a new environment variable "mem" will
2989 automatically be defined to hold the amount of
2990 remaining RAM in a form that can be passed as boot
2991 argument to Linux, for instance like that:
2992
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002993 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002994 saveenv
2995
2996 This way you can tell Linux not to use this memory,
2997 either, which results in a memory region that will
2998 not be affected by reboots.
2999
3000 *WARNING* If your board configuration uses automatic
3001 detection of the RAM size, you must make sure that
3002 this memory test is non-destructive. So far, the
3003 following board configurations are known to be
3004 "pRAM-clean":
3005
Wolfgang Denk90326762012-10-24 02:36:15 +00003006 IVMS8, IVML24, SPD8xx, TQM8xxL,
3007 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02003008 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00003009
Gabe Blacka2f3a932012-12-02 04:55:18 +00003010- Access to physical memory region (> 4GB)
3011 Some basic support is provided for operations on memory not
3012 normally accessible to U-Boot - e.g. some architectures
3013 support access to more than 4GB of memory on 32-bit
3014 machines using physical address extension or similar.
3015 Define CONFIG_PHYSMEM to access this basic support, which
3016 currently only supports clearing the memory.
3017
wdenkc6097192002-11-03 00:24:07 +00003018- Error Recovery:
3019 CONFIG_PANIC_HANG
3020
3021 Define this variable to stop the system in case of a
3022 fatal error, so that you have to reset it manually.
3023 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003024 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00003025 automatically as fast as possible, but it may be
3026 useful during development since you can try to debug
3027 the conditions that lead to the situation.
3028
3029 CONFIG_NET_RETRY_COUNT
3030
wdenk4a5c8a72003-03-06 00:02:04 +00003031 This variable defines the number of retries for
3032 network operations like ARP, RARP, TFTP, or BOOTP
3033 before giving up the operation. If not defined, a
3034 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00003035
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02003036 CONFIG_ARP_TIMEOUT
3037
3038 Timeout waiting for an ARP reply in milliseconds.
3039
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00003040 CONFIG_NFS_TIMEOUT
3041
3042 Timeout in milliseconds used in NFS protocol.
3043 If you encounter "ERROR: Cannot umount" in nfs command,
3044 try longer timeout such as
3045 #define CONFIG_NFS_TIMEOUT 10000UL
3046
wdenkc6097192002-11-03 00:24:07 +00003047- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02003048 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00003049
3050 Enable auto completion of commands using TAB.
3051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003052 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00003053
3054 This defines the secondary prompt string, which is
3055 printed when the command interpreter needs more input
3056 to complete a command. Usually "> ".
3057
3058 Note:
3059
wdenk57b2d802003-06-27 21:31:46 +00003060 In the current implementation, the local variables
3061 space and global environment variables space are
3062 separated. Local variables are those you define by
3063 simply typing `name=value'. To access a local
3064 variable later on, you have write `$name' or
3065 `${name}'; to execute the contents of a variable
3066 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk4a5c8a72003-03-06 00:02:04 +00003068 Global environment variables are those you use
3069 setenv/printenv to work with. To run a command stored
3070 in such a variable, you need to use the run command,
3071 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00003072
3073 To store commands and special characters in a
3074 variable, please use double quotation marks
3075 surrounding the whole text of the variable, instead
3076 of the backslashes before semicolons and special
3077 symbols.
3078
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003079- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02003080 CONFIG_CMDLINE_EDITING
3081
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003082 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003083 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02003084
wdenkc0aa5c52003-12-06 19:49:23 +00003085- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003086 CONFIG_EXTRA_ENV_SETTINGS
3087
wdenk4a5c8a72003-03-06 00:02:04 +00003088 Define this to contain any number of null terminated
3089 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00003090 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00003091
wdenk4a5c8a72003-03-06 00:02:04 +00003092 For example, place something like this in your
3093 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003094
3095 #define CONFIG_EXTRA_ENV_SETTINGS \
3096 "myvar1=value1\0" \
3097 "myvar2=value2\0"
3098
wdenk4a5c8a72003-03-06 00:02:04 +00003099 Warning: This method is based on knowledge about the
3100 internal format how the environment is stored by the
3101 U-Boot code. This is NOT an official, exported
3102 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00003103 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003104 You better know what you are doing here.
3105
wdenk4a5c8a72003-03-06 00:02:04 +00003106 Note: overly (ab)use of the default environment is
3107 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003108 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00003109 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003110
Stephen Warren1465d5f2012-05-22 09:21:54 +00003111 CONFIG_ENV_VARS_UBOOT_CONFIG
3112
3113 Define this in order to add variables describing the
3114 U-Boot build configuration to the default environment.
3115 These will be named arch, cpu, board, vendor, and soc.
3116
3117 Enabling this option will cause the following to be defined:
3118
3119 - CONFIG_SYS_ARCH
3120 - CONFIG_SYS_CPU
3121 - CONFIG_SYS_BOARD
3122 - CONFIG_SYS_VENDOR
3123 - CONFIG_SYS_SOC
3124
Tom Rini4c8cc9b2012-10-24 07:28:16 +00003125 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3126
3127 Define this in order to add variables describing certain
3128 run-time determined information about the hardware to the
3129 environment. These will be named board_name, board_rev.
3130
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003131 CONFIG_DELAY_ENVIRONMENT
3132
3133 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003134 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00003135 that so that the environment is not available until
3136 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3137 this is instead controlled by the value of
3138 /config/load-environment.
3139
wdenkc0aa5c52003-12-06 19:49:23 +00003140- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00003141 CONFIG_HAS_DATAFLASH
3142
wdenk57b2d802003-06-27 21:31:46 +00003143 Defining this option enables DataFlash features and
3144 allows to read/write in Dataflash via the standard
3145 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00003146
Eric Nelson97f5f8f2012-01-31 10:52:08 -07003147- Serial Flash support
3148 CONFIG_CMD_SF
3149
3150 Defining this option enables SPI flash commands
3151 'sf probe/read/write/erase/update'.
3152
3153 Usage requires an initial 'probe' to define the serial
3154 flash parameters, followed by read/write/erase/update
3155 commands.
3156
3157 The following defaults may be provided by the platform
3158 to handle the common case when only a single serial
3159 flash is present on the system.
3160
3161 CONFIG_SF_DEFAULT_BUS Bus identifier
3162 CONFIG_SF_DEFAULT_CS Chip-select
3163 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3164 CONFIG_SF_DEFAULT_SPEED in Hz
3165
Simon Glass4b5545e2012-10-08 13:16:02 +00003166 CONFIG_CMD_SF_TEST
3167
3168 Define this option to include a destructive SPI flash
3169 test ('sf test').
3170
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05303171 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3172
3173 Define this option to use the Bank addr/Extended addr
3174 support on SPI flashes which has size > 16Mbytes.
3175
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303176 CONFIG_SF_DUAL_FLASH Dual flash memories
3177
3178 Define this option to use dual flash support where two flash
3179 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003180 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303181
Heiko Schocherd73b7ec2014-07-18 06:07:21 +02003182 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3183 enable the W#/Vpp signal to disable writing to the status
3184 register on ST MICRON flashes like the N25Q128.
3185 The status register write enable/disable bit, combined with
3186 the W#/VPP signal provides hardware data protection for the
3187 device as follows: When the enable/disable bit is set to 1,
3188 and the W#/VPP signal is driven LOW, the status register
3189 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3190 operation will not execute. The only way to exit this
3191 hardware-protected mode is to drive W#/VPP HIGH.
3192
wdenkef893942004-02-23 16:11:30 +00003193- SystemACE Support:
3194 CONFIG_SYSTEMACE
3195
3196 Adding this option adds support for Xilinx SystemACE
3197 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003198 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003199 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003200
3201 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003202 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003203
3204 When SystemACE support is added, the "ace" device type
3205 becomes available to the fat commands, i.e. fatls.
3206
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003207- TFTP Fixed UDP Port:
3208 CONFIG_TFTP_PORT
3209
Wolfgang Denk227b5192005-09-24 23:25:46 +02003210 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003211 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003212 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003213 number generator is used.
3214
Wolfgang Denk227b5192005-09-24 23:25:46 +02003215 Also, the environment variable tftpdstp is used to supply
3216 the TFTP UDP destination port value. If tftpdstp isn't
3217 defined, the normal port 69 is used.
3218
3219 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003220 blindly start the TFTP transfer using the pre-configured
3221 target IP address and UDP port. This has the effect of
3222 "punching through" the (Windows XP) firewall, allowing
3223 the remainder of the TFTP transfer to proceed normally.
3224 A better solution is to properly configure the firewall,
3225 but sometimes that is not allowed.
3226
Simon Glass058bb8d2012-12-05 14:46:38 +00003227- Hashing support:
3228 CONFIG_CMD_HASH
3229
3230 This enables a generic 'hash' command which can produce
3231 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3232
3233 CONFIG_HASH_VERIFY
3234
3235 Enable the hash verify command (hash -v). This adds to code
3236 size a little.
3237
gaurav ranaef201592015-02-20 12:51:46 +05303238 CONFIG_SHA1 - This option enables support of hashing using SHA1
3239 algorithm. The hash is calculated in software.
3240 CONFIG_SHA256 - This option enables support of hashing using
3241 SHA256 algorithm. The hash is calculated in software.
3242 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3243 for SHA1/SHA256 hashing.
3244 This affects the 'hash' command and also the
3245 hash_lookup_algo() function.
3246 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3247 hardware-acceleration for SHA1/SHA256 progressive hashing.
3248 Data can be streamed in a block at a time and the hashing
3249 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003250
3251 Note: There is also a sha1sum command, which should perhaps
3252 be deprecated in favour of 'hash sha1'.
3253
Robert Winkler765ccf42013-07-24 17:57:06 -07003254- Freescale i.MX specific commands:
3255 CONFIG_CMD_HDMIDETECT
3256 This enables 'hdmidet' command which returns true if an
3257 HDMI monitor is detected. This command is i.MX 6 specific.
3258
3259 CONFIG_CMD_BMODE
3260 This enables the 'bmode' (bootmode) command for forcing
3261 a boot from specific media.
3262
3263 This is useful for forcing the ROM's usb downloader to
3264 activate upon a watchdog reset which is nice when iterating
3265 on U-Boot. Using the reset button or running bmode normal
3266 will set it back to normal. This command currently
3267 supports i.MX53 and i.MX6.
3268
Simon Glass35191a32013-06-13 15:10:02 -07003269- Signing support:
3270 CONFIG_RSA
3271
3272 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003273 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003274
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303275 The Modular Exponentiation algorithm in RSA is implemented using
3276 driver model. So CONFIG_DM needs to be enabled by default for this
3277 library to function.
3278
Simon Glass35191a32013-06-13 15:10:02 -07003279 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303280 option. The software based modular exponentiation is built into
3281 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003282
Heiko Schocher443ca402014-01-25 07:27:13 +01003283- bootcount support:
3284 CONFIG_BOOTCOUNT_LIMIT
3285
3286 This enables the bootcounter support, see:
3287 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3288
3289 CONFIG_AT91SAM9XE
3290 enable special bootcounter support on at91sam9xe based boards.
3291 CONFIG_BLACKFIN
3292 enable special bootcounter support on blackfin based boards.
3293 CONFIG_SOC_DA8XX
3294 enable special bootcounter support on da850 based boards.
3295 CONFIG_BOOTCOUNT_RAM
3296 enable support for the bootcounter in RAM
3297 CONFIG_BOOTCOUNT_I2C
3298 enable support for the bootcounter on an i2c (like RTC) device.
3299 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3300 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3301 the bootcounter.
3302 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003303
wdenkc0aa5c52003-12-06 19:49:23 +00003304- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003305 CONFIG_SHOW_BOOT_PROGRESS
3306
wdenk4a5c8a72003-03-06 00:02:04 +00003307 Defining this option allows to add some board-
3308 specific code (calling a user-provided function
3309 "show_boot_progress(int)") that enables you to show
3310 the system's boot progress on some display (for
3311 example, some LED's) on your board. At the moment,
3312 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003313
Simon Glass31a870e2012-02-13 13:51:19 +00003314- Detailed boot stage timing
3315 CONFIG_BOOTSTAGE
3316 Define this option to get detailed timing of each stage
3317 of the boot process.
3318
3319 CONFIG_BOOTSTAGE_USER_COUNT
3320 This is the number of available user bootstage records.
3321 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3322 a new ID will be allocated from this stash. If you exceed
3323 the limit, recording will stop.
3324
3325 CONFIG_BOOTSTAGE_REPORT
3326 Define this to print a report before boot, similar to this:
3327
3328 Timer summary in microseconds:
3329 Mark Elapsed Stage
3330 0 0 reset
3331 3,575,678 3,575,678 board_init_f start
3332 3,575,695 17 arch_cpu_init A9
3333 3,575,777 82 arch_cpu_init done
3334 3,659,598 83,821 board_init_r start
3335 3,910,375 250,777 main_loop
3336 29,916,167 26,005,792 bootm_start
3337 30,361,327 445,160 start_kernel
3338
Simon Glass4afd88e2012-09-28 08:56:39 +00003339 CONFIG_CMD_BOOTSTAGE
3340 Add a 'bootstage' command which supports printing a report
3341 and un/stashing of bootstage data.
3342
Simon Glass0fa36a42012-09-28 08:56:37 +00003343 CONFIG_BOOTSTAGE_FDT
3344 Stash the bootstage information in the FDT. A root 'bootstage'
3345 node is created with each bootstage id as a child. Each child
3346 has a 'name' property and either 'mark' containing the
3347 mark time in microsecond, or 'accum' containing the
3348 accumulated time for that bootstage id in microseconds.
3349 For example:
3350
3351 bootstage {
3352 154 {
3353 name = "board_init_f";
3354 mark = <3575678>;
3355 };
3356 170 {
3357 name = "lcd";
3358 accum = <33482>;
3359 };
3360 };
3361
3362 Code in the Linux kernel can find this in /proc/devicetree.
3363
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003364Legacy uImage format:
3365
wdenkc6097192002-11-03 00:24:07 +00003366 Arg Where When
3367 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003368 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003369 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003370 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003371 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003372 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003373 4 common/cmd_bootm.c Image data has correct checksum
3374 -4 common/cmd_bootm.c Image is for unsupported architecture
3375 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003376 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003377 6 common/cmd_bootm.c Image Type check OK
3378 -6 common/cmd_bootm.c gunzip uncompression error
3379 -7 common/cmd_bootm.c Unimplemented compression type
3380 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003381 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003382 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003383
3384 9 common/image.c Start initial ramdisk verification
3385 -10 common/image.c Ramdisk header has bad magic number
3386 -11 common/image.c Ramdisk header has bad checksum
3387 10 common/image.c Ramdisk header is OK
3388 -12 common/image.c Ramdisk data has bad checksum
3389 11 common/image.c Ramdisk data has correct checksum
3390 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003391 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003392 13 common/image.c Start multifile image verification
3393 14 common/image.c No initial ramdisk, no multifile, continue.
3394
Wolfgang Denk092ae952011-10-26 10:21:21 +00003395 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003396
Stefan Roese88fbf932010-04-15 16:07:28 +02003397 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003398 -31 post/post.c POST test failed, detected by post_output_backlog()
3399 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003400
Heiko Schocher633e03a2007-06-22 19:11:54 +02003401 34 common/cmd_doc.c before loading a Image from a DOC device
3402 -35 common/cmd_doc.c Bad usage of "doc" command
3403 35 common/cmd_doc.c correct usage of "doc" command
3404 -36 common/cmd_doc.c No boot device
3405 36 common/cmd_doc.c correct boot device
3406 -37 common/cmd_doc.c Unknown Chip ID on boot device
3407 37 common/cmd_doc.c correct chip ID found, device available
3408 -38 common/cmd_doc.c Read Error on boot device
3409 38 common/cmd_doc.c reading Image header from DOC device OK
3410 -39 common/cmd_doc.c Image header has bad magic number
3411 39 common/cmd_doc.c Image header has correct magic number
3412 -40 common/cmd_doc.c Error reading Image from DOC device
3413 40 common/cmd_doc.c Image header has correct magic number
3414 41 common/cmd_ide.c before loading a Image from a IDE device
3415 -42 common/cmd_ide.c Bad usage of "ide" command
3416 42 common/cmd_ide.c correct usage of "ide" command
3417 -43 common/cmd_ide.c No boot device
3418 43 common/cmd_ide.c boot device found
3419 -44 common/cmd_ide.c Device not available
3420 44 common/cmd_ide.c Device available
3421 -45 common/cmd_ide.c wrong partition selected
3422 45 common/cmd_ide.c partition selected
3423 -46 common/cmd_ide.c Unknown partition table
3424 46 common/cmd_ide.c valid partition table found
3425 -47 common/cmd_ide.c Invalid partition type
3426 47 common/cmd_ide.c correct partition type
3427 -48 common/cmd_ide.c Error reading Image Header on boot device
3428 48 common/cmd_ide.c reading Image Header from IDE device OK
3429 -49 common/cmd_ide.c Image header has bad magic number
3430 49 common/cmd_ide.c Image header has correct magic number
3431 -50 common/cmd_ide.c Image header has bad checksum
3432 50 common/cmd_ide.c Image header has correct checksum
3433 -51 common/cmd_ide.c Error reading Image from IDE device
3434 51 common/cmd_ide.c reading Image from IDE device OK
3435 52 common/cmd_nand.c before loading a Image from a NAND device
3436 -53 common/cmd_nand.c Bad usage of "nand" command
3437 53 common/cmd_nand.c correct usage of "nand" command
3438 -54 common/cmd_nand.c No boot device
3439 54 common/cmd_nand.c boot device found
3440 -55 common/cmd_nand.c Unknown Chip ID on boot device
3441 55 common/cmd_nand.c correct chip ID found, device available
3442 -56 common/cmd_nand.c Error reading Image Header on boot device
3443 56 common/cmd_nand.c reading Image Header from NAND device OK
3444 -57 common/cmd_nand.c Image header has bad magic number
3445 57 common/cmd_nand.c Image header has correct magic number
3446 -58 common/cmd_nand.c Error reading Image from NAND device
3447 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003448
Heiko Schocher633e03a2007-06-22 19:11:54 +02003449 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003450
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003451 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003452 -64 net/eth.c no Ethernet found.
3453 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003454
Heiko Schocher633e03a2007-06-22 19:11:54 +02003455 -80 common/cmd_net.c usage wrong
3456 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003457 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003458 81 common/cmd_net.c NetLoop() back without error
3459 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3460 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003461 83 common/cmd_net.c running "source" command
3462 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003463 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003464
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003465FIT uImage format:
3466
3467 Arg Where When
3468 100 common/cmd_bootm.c Kernel FIT Image has correct format
3469 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3470 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3471 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3472 102 common/cmd_bootm.c Kernel unit name specified
3473 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003474 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003475 104 common/cmd_bootm.c Got kernel subimage node offset
3476 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3477 105 common/cmd_bootm.c Kernel subimage hash verification OK
3478 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3479 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003480 -106 common/cmd_bootm.c Kernel subimage has wrong type
3481 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003482 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3483 108 common/cmd_bootm.c Got kernel subimage data/size
3484 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3485 -109 common/cmd_bootm.c Can't get kernel subimage type
3486 -110 common/cmd_bootm.c Can't get kernel subimage comp
3487 -111 common/cmd_bootm.c Can't get kernel subimage os
3488 -112 common/cmd_bootm.c Can't get kernel subimage load address
3489 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3490
3491 120 common/image.c Start initial ramdisk verification
3492 -120 common/image.c Ramdisk FIT image has incorrect format
3493 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003494 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003495 -122 common/image.c Can't get configuration for ramdisk subimage
3496 123 common/image.c Ramdisk unit name specified
3497 -124 common/image.c Can't get ramdisk subimage node offset
3498 125 common/image.c Got ramdisk subimage node offset
3499 -125 common/image.c Ramdisk subimage hash verification failed
3500 126 common/image.c Ramdisk subimage hash verification OK
3501 -126 common/image.c Ramdisk subimage for unsupported architecture
3502 127 common/image.c Architecture check OK
3503 -127 common/image.c Can't get ramdisk subimage data/size
3504 128 common/image.c Got ramdisk subimage data/size
3505 129 common/image.c Can't get ramdisk load address
3506 -129 common/image.c Got ramdisk load address
3507
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003508 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003509 131 common/cmd_doc.c FIT image format OK
3510
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003511 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003512 141 common/cmd_ide.c FIT image format OK
3513
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003514 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003515 151 common/cmd_nand.c FIT image format OK
3516
Heiko Schocher515eb122014-05-28 11:33:33 +02003517- legacy image format:
3518 CONFIG_IMAGE_FORMAT_LEGACY
3519 enables the legacy image format support in U-Boot.
3520
3521 Default:
3522 enabled if CONFIG_FIT_SIGNATURE is not defined.
3523
3524 CONFIG_DISABLE_IMAGE_LEGACY
3525 disable the legacy image format
3526
3527 This define is introduced, as the legacy image format is
3528 enabled per default for backward compatibility.
3529
Gabe Blackd572e162012-10-25 16:31:10 +00003530- FIT image support:
3531 CONFIG_FIT
3532 Enable support for the FIT uImage format.
3533
3534 CONFIG_FIT_BEST_MATCH
3535 When no configuration is explicitly selected, default to the
3536 one whose fdt's compatibility field best matches that of
3537 U-Boot itself. A match is considered "best" if it matches the
3538 most specific compatibility entry of U-Boot's fdt's root node.
3539 The order of entries in the configuration's fdt is ignored.
3540
Simon Glass58fe7e52013-06-13 15:10:00 -07003541 CONFIG_FIT_SIGNATURE
3542 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303543 using a hash signed and verified using RSA. If
3544 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3545 hashing is available using hardware, RSA library will use it.
3546 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003547
Heiko Schocher515eb122014-05-28 11:33:33 +02003548 WARNING: When relying on signed FIT images with required
3549 signature check the legacy image format is default
3550 disabled. If a board need legacy image format support
3551 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3552
Dirk Eibach88919ca2014-07-03 09:28:26 +02003553 CONFIG_FIT_DISABLE_SHA256
3554 Supporting SHA256 hashes has quite an impact on binary size.
3555 For constrained systems sha256 hash support can be disabled
3556 with this option.
3557
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003558- Standalone program support:
3559 CONFIG_STANDALONE_LOAD_ADDR
3560
Wolfgang Denk23f78482011-10-09 21:06:34 +02003561 This option defines a board specific value for the
3562 address where standalone program gets loaded, thus
3563 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003564 settings.
3565
3566- Frame Buffer Address:
3567 CONFIG_FB_ADDR
3568
3569 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003570 address for frame buffer. This is typically the case
3571 when using a graphics controller has separate video
3572 memory. U-Boot will then place the frame buffer at
3573 the given address instead of dynamically reserving it
3574 in system RAM by calling lcd_setmem(), which grabs
3575 the memory for the frame buffer depending on the
3576 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003577
3578 Please see board_init_f function.
3579
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003580- Automatic software updates via TFTP server
3581 CONFIG_UPDATE_TFTP
3582 CONFIG_UPDATE_TFTP_CNT_MAX
3583 CONFIG_UPDATE_TFTP_MSEC_MAX
3584
3585 These options enable and control the auto-update feature;
3586 for a more detailed description refer to doc/README.update.
3587
3588- MTD Support (mtdparts command, UBI support)
3589 CONFIG_MTD_DEVICE
3590
3591 Adds the MTD device infrastructure from the Linux kernel.
3592 Needed for mtdparts command support.
3593
3594 CONFIG_MTD_PARTITIONS
3595
3596 Adds the MTD partitioning infrastructure from the Linux
3597 kernel. Needed for UBI support.
3598
Heiko Schocherf5895d12014-06-24 10:10:04 +02003599 CONFIG_MTD_NAND_VERIFY_WRITE
3600 verify if the written data is correct reread.
3601
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003602- UBI support
3603 CONFIG_CMD_UBI
3604
3605 Adds commands for interacting with MTD partitions formatted
3606 with the UBI flash translation layer
3607
3608 Requires also defining CONFIG_RBTREE
3609
Joe Hershberger47550fc2013-04-08 10:32:49 +00003610 CONFIG_UBI_SILENCE_MSG
3611
3612 Make the verbose messages from UBI stop printing. This leaves
3613 warnings and errors enabled.
3614
Heiko Schocherf5895d12014-06-24 10:10:04 +02003615
3616 CONFIG_MTD_UBI_WL_THRESHOLD
3617 This parameter defines the maximum difference between the highest
3618 erase counter value and the lowest erase counter value of eraseblocks
3619 of UBI devices. When this threshold is exceeded, UBI starts performing
3620 wear leveling by means of moving data from eraseblock with low erase
3621 counter to eraseblocks with high erase counter.
3622
3623 The default value should be OK for SLC NAND flashes, NOR flashes and
3624 other flashes which have eraseblock life-cycle 100000 or more.
3625 However, in case of MLC NAND flashes which typically have eraseblock
3626 life-cycle less than 10000, the threshold should be lessened (e.g.,
3627 to 128 or 256, although it does not have to be power of 2).
3628
3629 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003630
Heiko Schocherf5895d12014-06-24 10:10:04 +02003631 CONFIG_MTD_UBI_BEB_LIMIT
3632 This option specifies the maximum bad physical eraseblocks UBI
3633 expects on the MTD device (per 1024 eraseblocks). If the
3634 underlying flash does not admit of bad eraseblocks (e.g. NOR
3635 flash), this value is ignored.
3636
3637 NAND datasheets often specify the minimum and maximum NVM
3638 (Number of Valid Blocks) for the flashes' endurance lifetime.
3639 The maximum expected bad eraseblocks per 1024 eraseblocks
3640 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3641 which gives 20 for most NANDs (MaxNVB is basically the total
3642 count of eraseblocks on the chip).
3643
3644 To put it differently, if this value is 20, UBI will try to
3645 reserve about 1.9% of physical eraseblocks for bad blocks
3646 handling. And that will be 1.9% of eraseblocks on the entire
3647 NAND chip, not just the MTD partition UBI attaches. This means
3648 that if you have, say, a NAND flash chip admits maximum 40 bad
3649 eraseblocks, and it is split on two MTD partitions of the same
3650 size, UBI will reserve 40 eraseblocks when attaching a
3651 partition.
3652
3653 default: 20
3654
3655 CONFIG_MTD_UBI_FASTMAP
3656 Fastmap is a mechanism which allows attaching an UBI device
3657 in nearly constant time. Instead of scanning the whole MTD device it
3658 only has to locate a checkpoint (called fastmap) on the device.
3659 The on-flash fastmap contains all information needed to attach
3660 the device. Using fastmap makes only sense on large devices where
3661 attaching by scanning takes long. UBI will not automatically install
3662 a fastmap on old images, but you can set the UBI parameter
3663 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3664 that fastmap-enabled images are still usable with UBI implementations
3665 without fastmap support. On typical flash devices the whole fastmap
3666 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3667
3668 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3669 Set this parameter to enable fastmap automatically on images
3670 without a fastmap.
3671 default: 0
3672
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003673- UBIFS support
3674 CONFIG_CMD_UBIFS
3675
3676 Adds commands for interacting with UBI volumes formatted as
3677 UBIFS. UBIFS is read-only in u-boot.
3678
3679 Requires UBI support as well as CONFIG_LZO
3680
Joe Hershberger47550fc2013-04-08 10:32:49 +00003681 CONFIG_UBIFS_SILENCE_MSG
3682
3683 Make the verbose messages from UBIFS stop printing. This leaves
3684 warnings and errors enabled.
3685
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003686- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003687 CONFIG_SPL
3688 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003689
Tom Rini36853852012-02-14 07:29:40 +00003690 CONFIG_SPL_LDSCRIPT
3691 LDSCRIPT for linking the SPL binary.
3692
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003693 CONFIG_SPL_MAX_FOOTPRINT
3694 Maximum size in memory allocated to the SPL, BSS included.
3695 When defined, the linker checks that the actual memory
3696 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003697 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003698 must not be both defined at the same time.
3699
Tom Rini36853852012-02-14 07:29:40 +00003700 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003701 Maximum size of the SPL image (text, data, rodata, and
3702 linker lists sections), BSS excluded.
3703 When defined, the linker checks that the actual size does
3704 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003705
Wolfgang Denk825223d2011-09-11 21:24:09 +02003706 CONFIG_SPL_TEXT_BASE
3707 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003708
Scott Woodc4f0d002012-09-20 19:05:12 -05003709 CONFIG_SPL_RELOC_TEXT_BASE
3710 Address to relocate to. If unspecified, this is equal to
3711 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3712
Tom Rini36853852012-02-14 07:29:40 +00003713 CONFIG_SPL_BSS_START_ADDR
3714 Link address for the BSS within the SPL binary.
3715
3716 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003717 Maximum size in memory allocated to the SPL BSS.
3718 When defined, the linker checks that the actual memory used
3719 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003720 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003721 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003722
3723 CONFIG_SPL_STACK
3724 Adress of the start of the stack SPL will use
3725
Scott Woodc4f0d002012-09-20 19:05:12 -05003726 CONFIG_SPL_RELOC_STACK
3727 Adress of the start of the stack SPL will use after
3728 relocation. If unspecified, this is equal to
3729 CONFIG_SPL_STACK.
3730
Tom Rini36853852012-02-14 07:29:40 +00003731 CONFIG_SYS_SPL_MALLOC_START
3732 Starting address of the malloc pool used in SPL.
3733
3734 CONFIG_SYS_SPL_MALLOC_SIZE
3735 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003736
Tom Rini28591df2012-08-13 12:03:19 -07003737 CONFIG_SPL_FRAMEWORK
3738 Enable the SPL framework under common/. This framework
3739 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3740 NAND loading of the Linux Kernel.
3741
Tom Rinic2b76002014-03-28 12:03:39 -04003742 CONFIG_SPL_OS_BOOT
3743 Enable booting directly to an OS from SPL.
3744 See also: doc/README.falcon
3745
Tom Rinife3b0c72012-08-13 11:37:56 -07003746 CONFIG_SPL_DISPLAY_PRINT
3747 For ARM, enable an optional function to print more information
3748 about the running system.
3749
Scott Wood7c810902012-09-20 16:35:21 -05003750 CONFIG_SPL_INIT_MINIMAL
3751 Arch init code should be built for a very small image
3752
Wolfgang Denk825223d2011-09-11 21:24:09 +02003753 CONFIG_SPL_LIBCOMMON_SUPPORT
3754 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003755
Wolfgang Denk825223d2011-09-11 21:24:09 +02003756 CONFIG_SPL_LIBDISK_SUPPORT
3757 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003758
Wolfgang Denk825223d2011-09-11 21:24:09 +02003759 CONFIG_SPL_I2C_SUPPORT
3760 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003761
Wolfgang Denk825223d2011-09-11 21:24:09 +02003762 CONFIG_SPL_GPIO_SUPPORT
3763 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003764
Wolfgang Denk825223d2011-09-11 21:24:09 +02003765 CONFIG_SPL_MMC_SUPPORT
3766 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003767
Tom Rini36853852012-02-14 07:29:40 +00003768 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3769 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003770 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003771 when the MMC is being used in raw mode.
3772
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003773 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3774 Partition on the MMC to load U-Boot from when the MMC is being
3775 used in raw mode
3776
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003777 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3778 Sector to load kernel uImage from when MMC is being
3779 used in raw mode (for Falcon mode)
3780
3781 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3782 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3783 Sector and number of sectors to load kernel argument
3784 parameters from when MMC is being used in raw mode
3785 (for falcon mode)
3786
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003787 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3788 Partition on the MMC to load U-Boot from when the MMC is being
3789 used in fs mode
3790
Tom Rini36853852012-02-14 07:29:40 +00003791 CONFIG_SPL_FAT_SUPPORT
3792 Support for fs/fat/libfat.o in SPL binary
3793
Guillaume GARDET5065b712014-10-15 17:53:13 +02003794 CONFIG_SPL_EXT_SUPPORT
3795 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003796
Guillaume GARDET5065b712014-10-15 17:53:13 +02003797 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3798 Filename to read to load U-Boot when reading from filesystem
3799
3800 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003801 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003802 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003803
Guillaume GARDET5065b712014-10-15 17:53:13 +02003804 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003805 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003806 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003807
Scott Wood2b36fbb2012-12-06 13:33:17 +00003808 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3809 Set this for NAND SPL on PPC mpc83xx targets, so that
3810 start.S waits for the rest of the SPL to load before
3811 continuing (the hardware starts execution after just
3812 loading the first page rather than the full 4K).
3813
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303814 CONFIG_SPL_SKIP_RELOCATE
3815 Avoid SPL relocation
3816
Scott Woodc352a0c2012-09-20 19:09:07 -05003817 CONFIG_SPL_NAND_BASE
3818 Include nand_base.c in the SPL. Requires
3819 CONFIG_SPL_NAND_DRIVERS.
3820
3821 CONFIG_SPL_NAND_DRIVERS
3822 SPL uses normal NAND drivers, not minimal drivers.
3823
3824 CONFIG_SPL_NAND_ECC
3825 Include standard software ECC in the SPL
3826
Tom Rini36853852012-02-14 07:29:40 +00003827 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003828 Support for NAND boot using simple NAND drivers that
3829 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003830
Tom Rini543c9f12014-03-28 12:03:36 -04003831 CONFIG_SPL_MTD_SUPPORT
3832 Support for the MTD subsystem within SPL. Useful for
3833 environment on NAND support within SPL.
3834
Heiko Schochercf000272014-10-31 08:31:00 +01003835 CONFIG_SPL_NAND_RAW_ONLY
3836 Support to boot only raw u-boot.bin images. Use this only
3837 if you need to save space.
3838
Ying Zhang9ff70262013-08-16 15:16:11 +08003839 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3840 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003841 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003842
Ying Zhangdfb2b152013-08-16 15:16:12 +08003843 CONFIG_SPL_COMMON_INIT_DDR
3844 Set for common ddr init with serial presence detect in
3845 SPL binary.
3846
Tom Rini36853852012-02-14 07:29:40 +00003847 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3848 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3849 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3850 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3851 CONFIG_SYS_NAND_ECCBYTES
3852 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003853 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003854
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303855 CONFIG_SPL_NAND_BOOT
3856 Add support NAND boot
3857
Tom Rini36853852012-02-14 07:29:40 +00003858 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003859 Location in NAND to read U-Boot from
3860
3861 CONFIG_SYS_NAND_U_BOOT_DST
3862 Location in memory to load U-Boot to
3863
3864 CONFIG_SYS_NAND_U_BOOT_SIZE
3865 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003866
3867 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003868 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003869
3870 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3871 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003872 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003873
3874 CONFIG_SPL_OMAP3_ID_NAND
3875 Support for an OMAP3-specific set of functions to return the
3876 ID and MFR of the first attached NAND chip, if present.
3877
Wolfgang Denk825223d2011-09-11 21:24:09 +02003878 CONFIG_SPL_SERIAL_SUPPORT
3879 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003880
Wolfgang Denk825223d2011-09-11 21:24:09 +02003881 CONFIG_SPL_SPI_FLASH_SUPPORT
3882 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003883
Wolfgang Denk825223d2011-09-11 21:24:09 +02003884 CONFIG_SPL_SPI_SUPPORT
3885 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003886
Pavel Machekde997252012-08-30 22:42:11 +02003887 CONFIG_SPL_RAM_DEVICE
3888 Support for running image already present in ram, in SPL binary
3889
Wolfgang Denk825223d2011-09-11 21:24:09 +02003890 CONFIG_SPL_LIBGENERIC_SUPPORT
3891 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003892
Ying Zhang602f7d32013-05-20 14:07:25 +08003893 CONFIG_SPL_ENV_SUPPORT
3894 Support for the environment operating in SPL binary
3895
3896 CONFIG_SPL_NET_SUPPORT
3897 Support for the net/libnet.o in SPL binary.
3898 It conflicts with SPL env from storage medium specified by
3899 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3900
Scott Woodeb7bd972012-12-06 13:33:16 +00003901 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003902 Image offset to which the SPL should be padded before appending
3903 the SPL payload. By default, this is defined as
3904 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3905 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3906 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003907
Scott Woodf147eb72012-09-21 16:27:32 -05003908 CONFIG_SPL_TARGET
3909 Final target image containing SPL and payload. Some SPLs
3910 use an arch-specific makefile fragment instead, for
3911 example if more than one image needs to be produced.
3912
Simon Glass82d94532013-05-08 08:05:59 +00003913 CONFIG_FIT_SPL_PRINT
3914 Printing information about a FIT image adds quite a bit of
3915 code to SPL. So this is normally disabled in SPL. Use this
3916 option to re-enable it. This will affect the output of the
3917 bootm command when booting a FIT image.
3918
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003919- TPL framework
3920 CONFIG_TPL
3921 Enable building of TPL globally.
3922
3923 CONFIG_TPL_PAD_TO
3924 Image offset to which the TPL should be padded before appending
3925 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003926 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3927 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3928 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003929
wdenkc6097192002-11-03 00:24:07 +00003930Modem Support:
3931--------------
3932
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003933[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003934
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003935- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003936 CONFIG_MODEM_SUPPORT
3937
3938- RTS/CTS Flow control enable:
3939 CONFIG_HWFLOW
3940
3941- Modem debug support:
3942 CONFIG_MODEM_SUPPORT_DEBUG
3943
wdenk4a5c8a72003-03-06 00:02:04 +00003944 Enables debugging stuff (char screen[1024], dbg())
3945 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003946
wdenkc0aa5c52003-12-06 19:49:23 +00003947- Interrupt support (PPC):
3948
wdenk1ebf41e2004-01-02 14:00:00 +00003949 There are common interrupt_init() and timer_interrupt()
3950 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003951 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003952 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003953 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003954 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003955 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003956 specific handling. If board has watchdog / status_led
3957 / other_activity_monitor it works automatically from
3958 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003959
wdenkc6097192002-11-03 00:24:07 +00003960- General:
3961
wdenk4a5c8a72003-03-06 00:02:04 +00003962 In the target system modem support is enabled when a
3963 specific key (key combination) is pressed during
3964 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003965 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003966 board_init(). Currently key_pressed() is a dummy
3967 function, returning 1 and thus enabling modem
3968 initialization.
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk4a5c8a72003-03-06 00:02:04 +00003970 If there are no modem init strings in the
3971 environment, U-Boot proceed to autoboot; the
3972 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003973 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003974
3975 See also: doc/README.Modem
3976
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003977Board initialization settings:
3978------------------------------
3979
3980During Initialization u-boot calls a number of board specific functions
3981to allow the preparation of board specific prerequisites, e.g. pin setup
3982before drivers are initialized. To enable these callbacks the
3983following configuration macros have to be defined. Currently this is
3984architecture specific, so please check arch/your_architecture/lib/board.c
3985typically in board_init_f() and board_init_r().
3986
3987- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3988- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3989- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3990- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003991
wdenkc6097192002-11-03 00:24:07 +00003992Configuration Settings:
3993-----------------------
3994
York Sun6c480012014-02-26 17:03:19 -08003995- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3996 Optionally it can be defined to support 64-bit memory commands.
3997
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003998- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003999 undefine this when you're short of memory.
4000
Peter Tyserdfb72b82009-01-27 18:03:12 -06004001- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
4002 width of the commands listed in the 'help' command output.
4003
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004004- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00004005 prompt for user input.
4006
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004007- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00004008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004009- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00004010
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004011- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00004012
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004013- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00004014 the application (usually a Linux kernel) when it is
4015 booted
4016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004017- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00004018 List of legal baudrate settings for this board.
4019
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004020- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00004021 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00004022
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004023- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00004024 If the board specific function
4025 extern int overwrite_console (void);
4026 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00004027 serial port, else the settings in the environment are used.
4028
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004029- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00004030 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00004031
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004032- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00004033 Enable overwrite of previous console environment settings.
4034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004035- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00004036 Begin and End addresses of the area used by the
4037 simple memory test.
4038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004039- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00004040 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00004041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004042- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00004043 Scratch address used by the alternate memory test
4044 You only need to set this if address zero isn't writeable
4045
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004046- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
4047 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01004048 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004049 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01004050 fixing up gd->ram_size the Linux kernel should gets passed
4051 the now "corrected" memory size and won't touch it either.
4052 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01004053 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01004054 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01004055 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01004056
4057 This option can be used as a workaround for the 440EPx/GRx
4058 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
4059 be touched.
4060
4061 WARNING: Please make sure that this value is a multiple of
4062 the Linux page size (normally 4k). If this is not the case,
4063 then the end address of the Linux memory will be located at a
4064 non page size aligned address and this could cause major
4065 problems.
4066
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004067- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00004068 Enable temporary baudrate change while serial download
4069
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004070- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00004071 Physical start address of SDRAM. _Must_ be 0 here.
4072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004073- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00004074 Physical start address of Motherboard I/O (if using a
4075 Cogent motherboard)
4076
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004077- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00004078 Physical start address of Flash memory.
4079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004080- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00004081 Physical start address of boot monitor code (set by
4082 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02004083 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004084 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00004085
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004086- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00004087 Size of memory reserved for monitor code, used to
4088 determine _at_compile_time_ (!) if the environment is
4089 embedded within the U-Boot image, or in a separate
4090 flash sector.
wdenkc6097192002-11-03 00:24:07 +00004091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004092- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00004093 Size of DRAM reserved for malloc() use.
4094
Simon Glass863e4042014-07-10 22:23:28 -06004095- CONFIG_SYS_MALLOC_F_LEN
4096 Size of the malloc() pool for use before relocation. If
4097 this is defined, then a very simple malloc() implementation
4098 will become available before relocation. The address is just
4099 below the global data, and the stack is moved down to make
4100 space.
4101
4102 This feature allocates regions with increasing addresses
4103 within the region. calloc() is supported, but realloc()
4104 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004105 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06004106 U-Boot relocates itself.
4107
Simon Glasse997f752014-09-15 06:33:18 -06004108 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06004109 at present but is fairly easy to enable for other archs.
4110
Simon Glass9fa901b2014-11-10 17:16:54 -07004111- CONFIG_SYS_MALLOC_SIMPLE
4112 Provides a simple and small malloc() and calloc() for those
4113 boards which do not use the full malloc in SPL (which is
4114 enabled with CONFIG_SYS_SPL_MALLOC_START).
4115
Thierry Redingc97d9742014-12-09 22:25:22 -07004116- CONFIG_SYS_NONCACHED_MEMORY:
4117 Size of non-cached memory area. This area of memory will be
4118 typically located right below the malloc() area and mapped
4119 uncached in the MMU. This is useful for drivers that would
4120 otherwise require a lot of explicit cache maintenance. For
4121 some drivers it's also impossible to properly maintain the
4122 cache. For example if the regions that need to be flushed
4123 are not a multiple of the cache-line size, *and* padding
4124 cannot be allocated between the regions to align them (i.e.
4125 if the HW requires a contiguous array of regions, and the
4126 size of each region is not cache-aligned), then a flush of
4127 one region may result in overwriting data that hardware has
4128 written to another region in the same cache-line. This can
4129 happen for example in network drivers where descriptors for
4130 buffers are typically smaller than the CPU cache-line (e.g.
4131 16 bytes vs. 32 or 64 bytes).
4132
4133 Non-cached memory is only supported on 32-bit ARM at present.
4134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004135- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01004136 Normally compressed uImages are limited to an
4137 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004138 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01004139 to adjust this setting to your needs.
4140
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004141- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004142 Maximum size of memory mapped by the startup code of
4143 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004144 the Linux kernel (bd_info, boot arguments, FDT blob if
4145 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004146 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004147 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00004148 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00004149 variable "bootm_mapsize" will override the value of
4150 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4151 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004152
John Rigbyeea8e692010-10-13 13:57:35 -06004153- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4154 Enable initrd_high functionality. If defined then the
4155 initrd_high feature is enabled and the bootm ramdisk subcommand
4156 is enabled.
4157
4158- CONFIG_SYS_BOOT_GET_CMDLINE:
4159 Enables allocating and saving kernel cmdline in space between
4160 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4161
4162- CONFIG_SYS_BOOT_GET_KBD:
4163 Enables allocating and saving a kernel copy of the bd_info in
4164 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4165
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004166- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004167 Max number of Flash memory banks
4168
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004169- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004170 Max number of sectors on a Flash chip
4171
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004172- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004173 Timeout for Flash erase operations (in ms)
4174
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004175- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004176 Timeout for Flash write operations (in ms)
4177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004178- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004179 Timeout for Flash set sector lock bit operation (in ms)
4180
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004181- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00004182 Timeout for Flash clear lock bits operation (in ms)
4183
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004184- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00004185 If defined, hardware flash sectors protection is used
4186 instead of U-Boot software protection.
4187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004188- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004189
4190 Enable TFTP transfers directly to flash memory;
4191 without this option such a download has to be
4192 performed in two steps: (1) download to RAM, and (2)
4193 copy from RAM to flash.
4194
4195 The two-step approach is usually more reliable, since
4196 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004197 the flash, but in some situations (when system RAM is
4198 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004199 downloaded image) this option may be very useful.
4200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004201- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00004202 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00004203 common flash structure for storing flash geometry.
4204
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02004205- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00004206 This option also enables the building of the cfi_flash driver
4207 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004208
Piotr Ziecik3e939e92008-11-17 15:57:58 +01004209- CONFIG_FLASH_CFI_MTD
4210 This option enables the building of the cfi_mtd driver
4211 in the drivers directory. The driver exports CFI flash
4212 to the MTD layer.
4213
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004214- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02004215 Use buffered writes to flash.
4216
4217- CONFIG_FLASH_SPANSION_S29WS_N
4218 s29ws-n MirrorBit flash has non-standard addresses for buffered
4219 write commands.
4220
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004221- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01004222 If this option is defined, the common CFI flash doesn't
4223 print it's warning upon not recognized FLASH banks. This
4224 is useful, if some of the configured banks are only
4225 optionally available.
4226
Jerry Van Barenaae73572008-03-08 13:48:01 -05004227- CONFIG_FLASH_SHOW_PROGRESS
4228 If defined (must be an integer), print out countdown
4229 digits and dots. Recommended value: 45 (9..1) for 80
4230 column displays, 15 (3..1) for 40 column displays.
4231
Stefan Roesed20cba52013-04-04 15:53:14 +02004232- CONFIG_FLASH_VERIFY
4233 If defined, the content of the flash (destination) is compared
4234 against the source after the write operation. An error message
4235 will be printed when the contents are not identical.
4236 Please note that this option is useless in nearly all cases,
4237 since such flash programming errors usually are detected earlier
4238 while unprotecting/erasing/programming. Please only enable
4239 this option if you really know what you are doing.
4240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004241- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004242 Defines the number of Ethernet receive buffers. On some
4243 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004244 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4245 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004246 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004247 Defaults to 4 if not defined.
4248
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004249- CONFIG_ENV_MAX_ENTRIES
4250
Wolfgang Denk1136f692010-10-27 22:48:30 +02004251 Maximum number of entries in the hash table that is used
4252 internally to store the environment settings. The default
4253 setting is supposed to be generous and should work in most
4254 cases. This setting can be used to tune behaviour; see
4255 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004256
Joe Hershberger71497d02012-12-11 22:16:31 -06004257- CONFIG_ENV_FLAGS_LIST_DEFAULT
4258- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004259 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004260 calling env set. Variables can be restricted to only decimal,
4261 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4262 the variables can also be restricted to IP address or MAC address.
4263
4264 The format of the list is:
4265 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004266 access_attribute = [a|r|o|c]
4267 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004268 entry = variable_name[:attributes]
4269 list = entry[,list]
4270
4271 The type attributes are:
4272 s - String (default)
4273 d - Decimal
4274 x - Hexadecimal
4275 b - Boolean ([1yYtT|0nNfF])
4276 i - IP address
4277 m - MAC address
4278
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004279 The access attributes are:
4280 a - Any (default)
4281 r - Read-only
4282 o - Write-once
4283 c - Change-default
4284
Joe Hershberger71497d02012-12-11 22:16:31 -06004285 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4286 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004287 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004288
4289 - CONFIG_ENV_FLAGS_LIST_STATIC
4290 Define this to a list (string) to define validation that
4291 should be done if an entry is not found in the ".flags"
4292 environment variable. To override a setting in the static
4293 list, simply add an entry for the same variable name to the
4294 ".flags" variable.
4295
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004296- CONFIG_ENV_ACCESS_IGNORE_FORCE
4297 If defined, don't allow the -f switch to env set override variable
4298 access flags.
4299
Simon Glass66828322013-03-08 13:45:27 +00004300- CONFIG_SYS_GENERIC_BOARD
4301 This selects the architecture-generic board system instead of the
4302 architecture-specific board files. It is intended to move boards
4303 to this new framework over time. Defining this will disable the
4304 arch/foo/lib/board.c file and use common/board_f.c and
4305 common/board_r.c instead. To use this option your architecture
4306 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4307 its config.mk file). If you find problems enabling this option on
4308 your board please report the problem and send patches!
4309
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004310- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4311 This is set by OMAP boards for the max time that reset should
4312 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004313 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004314
Gabe Black3687fe42014-10-15 04:38:30 -06004315- CONFIG_USE_STDINT
4316 If stdint.h is available with your toolchain you can define this
4317 option to enable it. You can provide option 'USE_STDINT=1' when
4318 building U-Boot to enable this.
4319
wdenkc6097192002-11-03 00:24:07 +00004320The following definitions that deal with the placement and management
4321of environment data (variable area); in general, we support the
4322following configurations:
4323
Mike Frysinger63b8f122011-07-08 10:44:25 +00004324- CONFIG_BUILD_ENVCRC:
4325
4326 Builds up envcrc with the target environment so that external utils
4327 may easily extract it and embed it in final U-Boot images.
4328
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004329- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004330
4331 Define this if the environment is in flash memory.
4332
4333 a) The environment occupies one whole flash sector, which is
4334 "embedded" in the text segment with the U-Boot code. This
4335 happens usually with "bottom boot sector" or "top boot
4336 sector" type flash chips, which have several smaller
4337 sectors at the start or the end. For instance, such a
4338 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4339 such a case you would place the environment in one of the
4340 4 kB sectors - with U-Boot code before and after it. With
4341 "top boot sector" type flash chips, you would put the
4342 environment in one of the last sectors, leaving a gap
4343 between U-Boot and the environment.
4344
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004345 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004346
4347 Offset of environment data (variable area) to the
4348 beginning of flash memory; for instance, with bottom boot
4349 type flash chips the second sector can be used: the offset
4350 for this sector is given here.
4351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004352 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004353
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004354 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004355
4356 This is just another way to specify the start address of
4357 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004358 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004359
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004360 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004361
4362 Size of the sector containing the environment.
4363
4364
4365 b) Sometimes flash chips have few, equal sized, BIG sectors.
4366 In such a case you don't want to spend a whole sector for
4367 the environment.
4368
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004369 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004370
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004371 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004372 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004373 of this flash sector for the environment. This saves
4374 memory for the RAM copy of the environment.
4375
4376 It may also save flash memory if you decide to use this
4377 when your environment is "embedded" within U-Boot code,
4378 since then the remainder of the flash sector could be used
4379 for U-Boot code. It should be pointed out that this is
4380 STRONGLY DISCOURAGED from a robustness point of view:
4381 updating the environment in flash makes it always
4382 necessary to erase the WHOLE sector. If something goes
4383 wrong before the contents has been restored from a copy in
4384 RAM, your target system will be dead.
4385
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004386 - CONFIG_ENV_ADDR_REDUND
4387 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk4a5c8a72003-03-06 00:02:04 +00004389 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004390 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004391 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004392 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004393
4394BE CAREFUL! Any changes to the flash layout, and some changes to the
4395source code will make it necessary to adapt <board>/u-boot.lds*
4396accordingly!
4397
4398
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004399- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004400
4401 Define this if you have some non-volatile memory device
4402 (NVRAM, battery buffered SRAM) which you want to use for the
4403 environment.
4404
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004405 - CONFIG_ENV_ADDR:
4406 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004407
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004408 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004409 want to use for environment. It is assumed that this memory
4410 can just be read and written to, without any special
4411 provision.
4412
4413BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004414in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004415console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004416U-Boot will hang.
4417
4418Please note that even with NVRAM we still use a copy of the
4419environment in RAM: we could work on NVRAM directly, but we want to
4420keep settings there always unmodified except somebody uses "saveenv"
4421to save the current settings.
4422
4423
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004424- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004425
4426 Use this if you have an EEPROM or similar serial access
4427 device and a driver for it.
4428
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004429 - CONFIG_ENV_OFFSET:
4430 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004431
4432 These two #defines specify the offset and size of the
4433 environment area within the total memory of your EEPROM.
4434
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004435 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004436 If defined, specified the chip address of the EEPROM device.
4437 The default address is zero.
4438
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004439 - CONFIG_SYS_I2C_EEPROM_BUS:
4440 If defined, specified the i2c bus of the EEPROM device.
4441
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004442 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004443 If defined, the number of bits used to address bytes in a
4444 single page in the EEPROM device. A 64 byte page, for example
4445 would require six bits.
4446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004447 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004448 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004449 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004451 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004452 The length in bytes of the EEPROM memory array address. Note
4453 that this is NOT the chip address length!
4454
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004455 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004456 EEPROM chips that implement "address overflow" are ones
4457 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4458 address and the extra bits end up in the "chip address" bit
4459 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4460 byte chips.
4461
4462 Note that we consider the length of the address field to
4463 still be one byte because the extra address bits are hidden
4464 in the chip address.
4465
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004466 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004467 The size in bytes of the EEPROM device.
4468
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004469 - CONFIG_ENV_EEPROM_IS_ON_I2C
4470 define this, if you have I2C and SPI activated, and your
4471 EEPROM, which holds the environment, is on the I2C bus.
4472
4473 - CONFIG_I2C_ENV_EEPROM_BUS
4474 if you have an Environment on an EEPROM reached over
4475 I2C muxes, you can define here, how to reach this
4476 EEPROM. For example:
4477
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004478 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004479
4480 EEPROM which holds the environment, is reached over
4481 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004482
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004483- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004484
wdenk1ebf41e2004-01-02 14:00:00 +00004485 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004486 want to use for the environment.
4487
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004488 - CONFIG_ENV_OFFSET:
4489 - CONFIG_ENV_ADDR:
4490 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004491
4492 These three #defines specify the offset and size of the
4493 environment area within the total memory of your DataFlash placed
4494 at the specified address.
4495
Wu, Josh76db7bf2014-07-01 19:30:13 +08004496- CONFIG_ENV_IS_IN_SPI_FLASH:
4497
4498 Define this if you have a SPI Flash memory device which you
4499 want to use for the environment.
4500
4501 - CONFIG_ENV_OFFSET:
4502 - CONFIG_ENV_SIZE:
4503
4504 These two #defines specify the offset and size of the
4505 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4506 aligned to an erase sector boundary.
4507
4508 - CONFIG_ENV_SECT_SIZE:
4509
4510 Define the SPI flash's sector size.
4511
4512 - CONFIG_ENV_OFFSET_REDUND (optional):
4513
4514 This setting describes a second storage area of CONFIG_ENV_SIZE
4515 size used to hold a redundant copy of the environment data, so
4516 that there is a valid backup copy in case there is a power failure
4517 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4518 aligned to an erase sector boundary.
4519
4520 - CONFIG_ENV_SPI_BUS (optional):
4521 - CONFIG_ENV_SPI_CS (optional):
4522
4523 Define the SPI bus and chip select. If not defined they will be 0.
4524
4525 - CONFIG_ENV_SPI_MAX_HZ (optional):
4526
4527 Define the SPI max work clock. If not defined then use 1MHz.
4528
4529 - CONFIG_ENV_SPI_MODE (optional):
4530
4531 Define the SPI work mode. If not defined then use SPI_MODE_3.
4532
Liu Gang85bcd732012-03-08 00:33:20 +00004533- CONFIG_ENV_IS_IN_REMOTE:
4534
4535 Define this if you have a remote memory space which you
4536 want to use for the local device's environment.
4537
4538 - CONFIG_ENV_ADDR:
4539 - CONFIG_ENV_SIZE:
4540
4541 These two #defines specify the address and size of the
4542 environment area within the remote memory space. The
4543 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004544 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004545
4546BE CAREFUL! For some special cases, the local device can not use
4547"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004548environment stored in a remote NOR flash by SRIO or PCIE link,
4549but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004550
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004551- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004552
4553 Define this if you have a NAND device which you want to use
4554 for the environment.
4555
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004556 - CONFIG_ENV_OFFSET:
4557 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004558
4559 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004560 area within the first NAND device. CONFIG_ENV_OFFSET must be
4561 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004562
Scott Wood08239322010-09-17 14:38:37 -05004563 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004564
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004565 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004566 size used to hold a redundant copy of the environment data, so
4567 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004568 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004569 aligned to an erase block boundary.
4570
4571 - CONFIG_ENV_RANGE (optional):
4572
4573 Specifies the length of the region in which the environment
4574 can be written. This should be a multiple of the NAND device's
4575 block size. Specifying a range with more erase blocks than
4576 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4577 the range to be avoided.
4578
4579 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004580
Scott Wood08239322010-09-17 14:38:37 -05004581 Enables support for dynamically retrieving the offset of the
4582 environment from block zero's out-of-band data. The
4583 "nand env.oob" command can be used to record this offset.
4584 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4585 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004586
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004587- CONFIG_NAND_ENV_DST
4588
4589 Defines address in RAM to which the nand_spl code should copy the
4590 environment. If redundant environment is used, it will be copied to
4591 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4592
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004593- CONFIG_ENV_IS_IN_UBI:
4594
4595 Define this if you have an UBI volume that you want to use for the
4596 environment. This has the benefit of wear-leveling the environment
4597 accesses, which is important on NAND.
4598
4599 - CONFIG_ENV_UBI_PART:
4600
4601 Define this to a string that is the mtd partition containing the UBI.
4602
4603 - CONFIG_ENV_UBI_VOLUME:
4604
4605 Define this to the name of the volume that you want to store the
4606 environment in.
4607
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004608 - CONFIG_ENV_UBI_VOLUME_REDUND:
4609
4610 Define this to the name of another volume to store a second copy of
4611 the environment in. This will enable redundant environments in UBI.
4612 It is assumed that both volumes are in the same MTD partition.
4613
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004614 - CONFIG_UBI_SILENCE_MSG
4615 - CONFIG_UBIFS_SILENCE_MSG
4616
4617 You will probably want to define these to avoid a really noisy system
4618 when storing the env in UBI.
4619
Wu, Josha7d0c872014-06-24 17:31:03 +08004620- CONFIG_ENV_IS_IN_FAT:
4621 Define this if you want to use the FAT file system for the environment.
4622
4623 - FAT_ENV_INTERFACE:
4624
4625 Define this to a string that is the name of the block device.
4626
4627 - FAT_ENV_DEV_AND_PART:
4628
4629 Define this to a string to specify the partition of the device. It can
4630 be as following:
4631
4632 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4633 - "D:P": device D partition P. Error occurs if device D has no
4634 partition table.
4635 - "D:0": device D.
4636 - "D" or "D:": device D partition 1 if device D has partition
4637 table, or the whole device D if has no partition
4638 table.
4639 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004640 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004641 partition table then means device D.
4642
4643 - FAT_ENV_FILE:
4644
4645 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004646 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004647
4648 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004649 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004650
Stephen Warreneedcacd2013-06-11 15:14:00 -06004651- CONFIG_ENV_IS_IN_MMC:
4652
4653 Define this if you have an MMC device which you want to use for the
4654 environment.
4655
4656 - CONFIG_SYS_MMC_ENV_DEV:
4657
4658 Specifies which MMC device the environment is stored in.
4659
4660 - CONFIG_SYS_MMC_ENV_PART (optional):
4661
4662 Specifies which MMC partition the environment is stored in. If not
4663 set, defaults to partition 0, the user area. Common values might be
4664 1 (first MMC boot partition), 2 (second MMC boot partition).
4665
4666 - CONFIG_ENV_OFFSET:
4667 - CONFIG_ENV_SIZE:
4668
4669 These two #defines specify the offset and size of the environment
4670 area within the specified MMC device.
4671
Stephen Warren24dc2032013-06-11 15:14:02 -06004672 If offset is positive (the usual case), it is treated as relative to
4673 the start of the MMC partition. If offset is negative, it is treated
4674 as relative to the end of the MMC partition. This can be useful if
4675 your board may be fitted with different MMC devices, which have
4676 different sizes for the MMC partitions, and you always want the
4677 environment placed at the very end of the partition, to leave the
4678 maximum possible space before it, to store other data.
4679
Stephen Warreneedcacd2013-06-11 15:14:00 -06004680 These two values are in units of bytes, but must be aligned to an
4681 MMC sector boundary.
4682
4683 - CONFIG_ENV_OFFSET_REDUND (optional):
4684
4685 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4686 hold a redundant copy of the environment data. This provides a
4687 valid backup copy in case the other copy is corrupted, e.g. due
4688 to a power failure during a "saveenv" operation.
4689
Stephen Warren24dc2032013-06-11 15:14:02 -06004690 This value may also be positive or negative; this is handled in the
4691 same way as CONFIG_ENV_OFFSET.
4692
Stephen Warreneedcacd2013-06-11 15:14:00 -06004693 This value is also in units of bytes, but must also be aligned to
4694 an MMC sector boundary.
4695
4696 - CONFIG_ENV_SIZE_REDUND (optional):
4697
4698 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4699 set. If this value is set, it must be set to the same value as
4700 CONFIG_ENV_SIZE.
4701
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004702- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004703
4704 Defines offset to the initial SPI buffer area in DPRAM. The
4705 area is used at an early stage (ROM part) if the environment
4706 is configured to reside in the SPI EEPROM: We need a 520 byte
4707 scratch DPRAM area. It is used between the two initialization
4708 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4709 to be a good choice since it makes it far enough from the
4710 start of the data area as well as from the stack pointer.
4711
Bruce Adleredecc942007-11-02 13:15:42 -07004712Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004713has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004714created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004715until then to read environment variables.
4716
wdenk8dba0502003-03-31 16:34:49 +00004717The environment is protected by a CRC32 checksum. Before the monitor
4718is relocated into RAM, as a result of a bad CRC you will be working
4719with the compiled-in default environment - *silently*!!! [This is
4720necessary, because the first environment variable we need is the
4721"baudrate" setting for the console - if we have a bad CRC, we don't
4722have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004723
4724Note: once the monitor has been relocated, then it will complain if
4725the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004726use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004728- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004729 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004730
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004731 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004732 also needs to be defined.
4733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004734- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004735 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004736
Ron Madriddfa028a2009-02-18 14:30:44 -08004737- CONFIG_NS16550_MIN_FUNCTIONS:
4738 Define this if you desire to only have use of the NS16550_init
4739 and NS16550_putc functions for the serial driver located at
4740 drivers/serial/ns16550.c. This option is useful for saving
4741 space for already greatly restricted images, including but not
4742 limited to NAND_SPL configurations.
4743
Simon Glass28a9e332012-11-30 13:01:18 +00004744- CONFIG_DISPLAY_BOARDINFO
4745 Display information about the board that U-Boot is running on
4746 when U-Boot starts up. The board function checkboard() is called
4747 to do this.
4748
Simon Glasse8822012012-11-30 13:01:19 +00004749- CONFIG_DISPLAY_BOARDINFO_LATE
4750 Similar to the previous option, but display this information
4751 later, once stdio is running and output goes to the LCD, if
4752 present.
4753
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004754- CONFIG_BOARD_SIZE_LIMIT:
4755 Maximum size of the U-Boot image. When defined, the
4756 build system checks that the actual size does not
4757 exceed it.
4758
wdenkc6097192002-11-03 00:24:07 +00004759Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004760---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004761
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004762- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004763 Cache Line Size of the CPU.
4764
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004765- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004766 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004767
wdenk9c53f402003-10-15 23:53:47 +00004768 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4769 and RPXsuper) to be able to adjust the position of
4770 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004771
Timur Tabid8f341c2011-08-04 18:03:41 -05004772- CONFIG_SYS_CCSRBAR_DEFAULT:
4773 Default (power-on reset) physical address of CCSR on Freescale
4774 PowerPC SOCs.
4775
4776- CONFIG_SYS_CCSRBAR:
4777 Virtual address of CCSR. On a 32-bit build, this is typically
4778 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4779
4780 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4781 for cross-platform code that uses that macro instead.
4782
4783- CONFIG_SYS_CCSRBAR_PHYS:
4784 Physical address of CCSR. CCSR can be relocated to a new
4785 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004786 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004787 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4788 is typically relocated on 36-bit builds. It is recommended
4789 that this macro be defined via the _HIGH and _LOW macros:
4790
4791 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4792 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4793
4794- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004795 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4796 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004797 used in assembly code, so it must not contain typecasts or
4798 integer size suffixes (e.g. "ULL").
4799
4800- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4801 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4802 used in assembly code, so it must not contain typecasts or
4803 integer size suffixes (e.g. "ULL").
4804
4805- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4806 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4807 forced to a value that ensures that CCSR is not relocated.
4808
wdenk1272e232002-11-10 22:06:23 +00004809- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004810 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004811
4812 the default drive number (default value 0)
4813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004814 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004815
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004816 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004817 (default value 1)
4818
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004819 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004820
wdenk4a5c8a72003-03-06 00:02:04 +00004821 defines the offset of register from address. It
4822 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004823 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004824
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004825 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4826 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004827 default value.
wdenk1272e232002-11-10 22:06:23 +00004828
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004829 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004830 fdc_hw_init() is called at the beginning of the FDC
4831 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004832 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004833 initializations.
wdenk1272e232002-11-10 22:06:23 +00004834
Macpaul Lind1e49942011-04-11 20:45:32 +00004835- CONFIG_IDE_AHB:
4836 Most IDE controllers were designed to be connected with PCI
4837 interface. Only few of them were designed for AHB interface.
4838 When software is doing ATA command and data transfer to
4839 IDE devices through IDE-AHB controller, some additional
4840 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004841 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004842
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004843- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004844 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004845 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004847- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004848
wdenkeb20ad32003-09-05 23:19:14 +00004849 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004850 initial data and stack; please note that this must be
4851 writable memory that is working WITHOUT special
4852 initialization, i. e. you CANNOT use normal RAM which
4853 will become available only after programming the
4854 memory controller and running certain initialization
4855 sequences.
4856
4857 U-Boot uses the following memory types:
4858 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4859 - MPC824X: data cache
4860 - PPC4xx: data cache
4861
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004862- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004863
4864 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004865 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4866 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004867 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004868 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004869 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4870 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4871 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004872
4873 Note:
4874 On the MPC824X (or other systems that use the data
4875 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004876 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004877 point to an otherwise UNUSED address space between
4878 the top of RAM and the start of the PCI space.
4879
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004880- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004882- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004884- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004885
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004886- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004888- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004889
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004890- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004892- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004893 SDRAM timing
4894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004895- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004896 periodic timer for refresh
4897
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004898- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004899
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004900- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4901 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4902 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4903 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004904 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4905
4906- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004907 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4908 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004909 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004911- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4912 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004913 Machine Mode Register and Memory Periodic Timer
4914 Prescaler definitions (SDRAM timing)
4915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004916- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004917 enable I2C microcode relocation patch (MPC8xx);
4918 define relocation offset in DPRAM [DSP2]
4919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004920- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004921 enable SMC microcode relocation patch (MPC8xx);
4922 define relocation offset in DPRAM [SMC1]
4923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004924- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004925 enable SPI microcode relocation patch (MPC8xx);
4926 define relocation offset in DPRAM [SCC4]
4927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004928- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004929 Use OSCM clock mode on MBX8xx board. Be careful,
4930 wrong setting might damage your board. Read
4931 doc/README.MBX before setting this variable!
4932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004933- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004934 Offset of the bootmode word in DPRAM used by post
4935 (Power On Self Tests). This definition overrides
4936 #define'd default value in commproc.h resp.
4937 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004939- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4940 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4941 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4942 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4943 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4944 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4945 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4946 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004947 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004948
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004949- CONFIG_PCI_DISABLE_PCIE:
4950 Disable PCI-Express on systems where it is supported but not
4951 required.
4952
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004953- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004954 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004955 Don't do any setup work, presumably because someone or
4956 something has already done it, and we don't need to do it
4957 a second time. Useful for platforms that are pre-booted
4958 by coreboot or similar.
4959
Gabor Juhosb4458732013-05-30 07:06:12 +00004960- CONFIG_PCI_INDIRECT_BRIDGE:
4961 Enable support for indirect PCI bridges.
4962
Kumar Gala8975d7a2010-12-30 12:09:53 -06004963- CONFIG_SYS_SRIO:
4964 Chip has SRIO or not
4965
4966- CONFIG_SRIO1:
4967 Board has SRIO 1 port available
4968
4969- CONFIG_SRIO2:
4970 Board has SRIO 2 port available
4971
Liu Gang27afb9c2013-05-07 16:30:46 +08004972- CONFIG_SRIO_PCIE_BOOT_MASTER
4973 Board can support master function for Boot from SRIO and PCIE
4974
Kumar Gala8975d7a2010-12-30 12:09:53 -06004975- CONFIG_SYS_SRIOn_MEM_VIRT:
4976 Virtual Address of SRIO port 'n' memory region
4977
4978- CONFIG_SYS_SRIOn_MEM_PHYS:
4979 Physical Address of SRIO port 'n' memory region
4980
4981- CONFIG_SYS_SRIOn_MEM_SIZE:
4982 Size of SRIO port 'n' memory region
4983
Fabio Estevamf17e8782013-04-11 09:35:34 +00004984- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4985 Defined to tell the NAND controller that the NAND chip is using
4986 a 16 bit bus.
4987 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004988 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004989 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004990 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004991
4992- CONFIG_SYS_NDFC_EBC0_CFG
4993 Sets the EBC0_CFG register for the NDFC. If not defined
4994 a default value will be used.
4995
Ben Warren45657152006-09-07 16:50:54 -04004996- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004997 Get DDR timing information from an I2C EEPROM. Common
4998 with pluggable memory modules such as SODIMMs
4999
Ben Warren45657152006-09-07 16:50:54 -04005000 SPD_EEPROM_ADDRESS
5001 I2C address of the SPD EEPROM
5002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005003- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005004 If SPD EEPROM is on an I2C bus other than the first
5005 one, specify here. Note that the value must resolve
5006 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04005007
York Sune73cc042011-06-07 09:42:16 +08005008- CONFIG_SYS_DDR_RAW_TIMING
5009 Get DDR timing information from other than SPD. Common with
5010 soldered DDR chips onboard without SPD. DDR raw timing
5011 parameters are extracted from datasheet and hard-coded into
5012 header files or board specific files.
5013
York Sunbd495cf2011-09-16 13:21:35 -07005014- CONFIG_FSL_DDR_INTERACTIVE
5015 Enable interactive DDR debugging. See doc/README.fsl-ddr.
5016
York Sun8ced0502015-01-06 13:18:55 -08005017- CONFIG_FSL_DDR_SYNC_REFRESH
5018 Enable sync of refresh for multiple controllers.
5019
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005020- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005021 Only for 83xx systems. If specified, then DDR should
5022 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06005023
wdenk6203e402004-04-18 10:13:26 +00005024- CONFIG_ETHER_ON_FEC[12]
5025 Define to enable FEC[12] on a 8xx series processor.
5026
5027- CONFIG_FEC[12]_PHY
5028 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00005029 to the given FEC; i. e.
5030 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00005031 means that the PHY with address 4 is connected to FEC1
5032
5033 When set to -1, means to probe for first available.
5034
5035- CONFIG_FEC[12]_PHY_NORXERR
5036 The PHY does not have a RXERR line (RMII only).
5037 (so program the FEC to ignore it).
5038
5039- CONFIG_RMII
5040 Enable RMII mode for all FECs.
5041 Note that this is a global option, we can't
5042 have one FEC in standard MII mode and another in RMII mode.
5043
wdenk20c98a62004-04-23 20:32:05 +00005044- CONFIG_CRC32_VERIFY
5045 Add a verify option to the crc32 command.
5046 The syntax is:
5047
5048 => crc32 -v <address> <count> <crc32>
5049
5050 Where address/count indicate a memory area
5051 and crc32 is the correct crc32 which the
5052 area should have.
5053
wdenk64519362004-07-11 17:40:54 +00005054- CONFIG_LOOPW
5055 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05005056 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00005057
stroesecc3af832004-12-16 18:46:55 +00005058- CONFIG_MX_CYCLIC
5059 Add the "mdc" and "mwc" memory commands. These are cyclic
5060 "md/mw" commands.
5061 Examples:
5062
wdenk07d7e6b2004-12-16 21:44:03 +00005063 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00005064 This command will print 4 bytes (10,11,12,13) each 500 ms.
5065
wdenk07d7e6b2004-12-16 21:44:03 +00005066 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00005067 This command will write 12345678 to address 100 all 10 ms.
5068
wdenk07d7e6b2004-12-16 21:44:03 +00005069 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05005070 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00005071
wdenk3d3d99f2005-04-04 12:44:11 +00005072- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005073 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01005074 low level initializations (like setting up the memory
5075 controller) are omitted and/or U-Boot does not
5076 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00005077
Wolfgang Denk302141d2010-11-27 23:30:56 +01005078 Normally this variable MUST NOT be defined. The only
5079 exception is when U-Boot is loaded (to RAM) by some
5080 other boot loader or by a debugger which performs
5081 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00005082
Aneesh V552a3192011-07-13 05:11:07 +00005083- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02005084 Modifies the behaviour of start.S when compiling a loader
5085 that is executed before the actual U-Boot. E.g. when
5086 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00005087
Ying Zhang2d2e3b62013-08-16 15:16:15 +08005088- CONFIG_TPL_BUILD
5089 Modifies the behaviour of start.S when compiling a loader
5090 that is executed after the SPL and before the actual U-Boot.
5091 It is loaded by the SPL.
5092
Ying Zhang0d4f5442013-05-20 14:07:23 +08005093- CONFIG_SYS_MPC85XX_NO_RESETVEC
5094 Only for 85xx systems. If this variable is specified, the section
5095 .resetvec is not kept and the section .bootpg is placed in the
5096 previous 4k of the .text section.
5097
Simon Glass17dabf02013-02-24 17:33:14 +00005098- CONFIG_ARCH_MAP_SYSMEM
5099 Generally U-Boot (and in particular the md command) uses
5100 effective address. It is therefore not necessary to regard
5101 U-Boot address as virtual addresses that need to be translated
5102 to physical addresses. However, sandbox requires this, since
5103 it maintains its own little RAM buffer which contains all
5104 addressable memory. This option causes some memory accesses
5105 to be mapped through map_sysmem() / unmap_sysmem().
5106
Matthias Weisser93416c12011-03-10 21:36:32 +00005107- CONFIG_USE_ARCH_MEMCPY
5108 CONFIG_USE_ARCH_MEMSET
5109 If these options are used a optimized version of memcpy/memset will
5110 be used if available. These functions may be faster under some
5111 conditions but may increase the binary size.
5112
Simon Glassbfb59802013-02-14 04:18:54 +00005113- CONFIG_X86_RESET_VECTOR
5114 If defined, the x86 reset vector code is included. This is not
5115 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00005116
Mark Jackson52b003c2013-03-04 01:27:20 +00005117- CONFIG_SYS_MPUCLK
5118 Defines the MPU clock speed (in MHz).
5119
5120 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00005121
Heiko Schocher2233e462013-11-04 14:05:00 +01005122- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5123 Enables the RTC32K OSC on AM33xx based plattforms
5124
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04005125- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5126 Option to disable subpage write in NAND driver
5127 driver that uses this:
5128 drivers/mtd/nand/davinci_nand.c
5129
Timur Tabi275f4bb2011-11-22 09:21:25 -06005130Freescale QE/FMAN Firmware Support:
5131-----------------------------------
5132
5133The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5134loading of "firmware", which is encoded in the QE firmware binary format.
5135This firmware often needs to be loaded during U-Boot booting, so macros
5136are used to identify the storage device (NOR flash, SPI, etc) and the address
5137within that device.
5138
Zhao Qiang83a90842014-03-21 16:21:44 +08005139- CONFIG_SYS_FMAN_FW_ADDR
5140 The address in the storage device where the FMAN microcode is located. The
5141 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5142 is also specified.
5143
5144- CONFIG_SYS_QE_FW_ADDR
5145 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06005146 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5147 is also specified.
5148
5149- CONFIG_SYS_QE_FMAN_FW_LENGTH
5150 The maximum possible size of the firmware. The firmware binary format
5151 has a field that specifies the actual size of the firmware, but it
5152 might not be possible to read any part of the firmware unless some
5153 local storage is allocated to hold the entire firmware first.
5154
5155- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5156 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5157 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5158 virtual address in NOR flash.
5159
5160- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5161 Specifies that QE/FMAN firmware is located in NAND flash.
5162 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5163
5164- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5165 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5166 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5167
5168- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5169 Specifies that QE/FMAN firmware is located on the primary SPI
5170 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5171
Liu Gang1e084582012-03-08 00:33:18 +00005172- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5173 Specifies that QE/FMAN firmware is located in the remote (master)
5174 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00005175 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5176 window->master inbound window->master LAW->the ucode address in
5177 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06005178
J. German Rivera8ff14b72014-06-23 15:15:55 -07005179Freescale Layerscape Management Complex Firmware Support:
5180---------------------------------------------------------
5181The Freescale Layerscape Management Complex (MC) supports the loading of
5182"firmware".
5183This firmware often needs to be loaded during U-Boot booting, so macros
5184are used to identify the storage device (NOR flash, SPI, etc) and the address
5185within that device.
5186
5187- CONFIG_FSL_MC_ENET
5188 Enable the MC driver for Layerscape SoCs.
5189
5190- CONFIG_SYS_LS_MC_FW_ADDR
5191 The address in the storage device where the firmware is located. The
5192 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5193 is also specified.
5194
5195- CONFIG_SYS_LS_MC_FW_LENGTH
5196 The maximum possible size of the firmware. The firmware binary format
5197 has a field that specifies the actual size of the firmware, but it
5198 might not be possible to read any part of the firmware unless some
5199 local storage is allocated to hold the entire firmware first.
5200
5201- CONFIG_SYS_LS_MC_FW_IN_NOR
5202 Specifies that MC firmware is located in NOR flash, mapped as
5203 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5204 virtual address in NOR flash.
5205
wdenkc6097192002-11-03 00:24:07 +00005206Building the Software:
5207======================
5208
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005209Building U-Boot has been tested in several native build environments
5210and in many different cross environments. Of course we cannot support
5211all possibly existing versions of cross development tools in all
5212(potentially obsolete) versions. In case of tool chain problems we
5213recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5214which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005215
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005216If you are not using a native environment, it is assumed that you
5217have GNU cross compiling tools available in your path. In this case,
5218you must set the environment variable CROSS_COMPILE in your shell.
5219Note that no changes to the Makefile or any other source files are
5220necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005221
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005222 $ CROSS_COMPILE=ppc_4xx-
5223 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005224
Peter Tyserb06976d2009-03-13 18:54:51 -05005225Note: If you wish to generate Windows versions of the utilities in
5226 the tools directory you can use the MinGW toolchain
5227 (http://www.mingw.org). Set your HOST tools to the MinGW
5228 toolchain and execute 'make tools'. For example:
5229
5230 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5231
5232 Binaries such as tools/mkimage.exe will be created which can
5233 be executed on computers running Windows.
5234
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005235U-Boot is intended to be simple to build. After installing the
5236sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005237is done by typing:
5238
Holger Freyther7ba4e572014-08-04 09:26:05 +02005239 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005240
Holger Freyther7ba4e572014-08-04 09:26:05 +02005241where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005242rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244Note: for some board special configuration names may exist; check if
5245 additional information is available from the board vendor; for
5246 instance, the TQM823L systems are available without (standard)
5247 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005248 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005249
Holger Freyther7ba4e572014-08-04 09:26:05 +02005250 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005251 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005252
Holger Freyther7ba4e572014-08-04 09:26:05 +02005253 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005254 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk6c59edc2004-05-03 20:45:30 +00005256 etc.
wdenkc6097192002-11-03 00:24:07 +00005257
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259Finally, type "make all", and you should get some working U-Boot
5260images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk6c59edc2004-05-03 20:45:30 +00005262- "u-boot.bin" is a raw binary image
5263- "u-boot" is an image in ELF binary format
5264- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005265
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005266By default the build is performed locally and the objects are saved
5267in the source directory. One of the two methods can be used to change
5268this behavior and build U-Boot to some external directory:
5269
52701. Add O= to the make command line invocations:
5271
5272 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005273 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005274 make O=/tmp/build all
5275
Timo Ketolac8c67602014-11-06 14:39:05 +020052762. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005277
Timo Ketolac8c67602014-11-06 14:39:05 +02005278 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005279 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005280 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005281 make all
5282
Timo Ketolac8c67602014-11-06 14:39:05 +02005283Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005284variable.
5285
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287Please be aware that the Makefiles assume you are using GNU make, so
5288for instance on NetBSD you might need to use "gmake" instead of
5289native "make".
wdenkc6097192002-11-03 00:24:07 +00005290
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292If the system board that you have is not listed, then you will need
5293to port U-Boot to your hardware platform. To do this, follow these
5294steps:
wdenkc6097192002-11-03 00:24:07 +00005295
wdenk6c59edc2004-05-03 20:45:30 +000052961. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005297 "boards.cfg" file, using the existing entries as examples.
5298 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000052992. Create a new directory to hold your board specific code. Add any
5300 files you need. In your board directory, you will need at least
5301 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
53023. Create a new configuration file "include/configs/<board>.h" for
5303 your board
53043. If you're porting U-Boot to a new CPU, then also create a new
5305 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020053064. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000053075. Type "make", and you should get a working "u-boot.srec" file
5308 to be installed on your target system.
53096. Debug and solve any problems that might arise.
5310 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005311
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5314==============================================================
wdenkc6097192002-11-03 00:24:07 +00005315
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005316If you have modified U-Boot sources (for instance added a new board
5317or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005318provide feedback to the other developers. The feedback normally takes
5319the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005320official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005321
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005322But before you submit such a patch, please verify that your modifi-
5323cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005324the supported boards compile WITHOUT ANY compiler warnings. To do so,
5325just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005326for ALL supported system. Be warned, this will take a while. You can
5327select which (cross) compiler to use by passing a `CROSS_COMPILE'
5328environment variable to the script, i. e. to use the ELDK cross tools
5329you can type
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk6c59edc2004-05-03 20:45:30 +00005333or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005334
wdenk6c59edc2004-05-03 20:45:30 +00005335 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005336
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005337When using the MAKEALL script, the default behaviour is to build
5338U-Boot in the source directory. This location can be changed by
5339setting the BUILD_DIR environment variable. Also, for each target
5340built, the MAKEALL script saves two log files (<target>.ERR and
5341<target>.MAKEALL) in the <source dir>/LOG directory. This default
5342location can be changed by setting the MAKEALL_LOGDIR environment
5343variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005344
5345 export BUILD_DIR=/tmp/build
5346 export MAKEALL_LOGDIR=/tmp/log
5347 CROSS_COMPILE=ppc_8xx- MAKEALL
5348
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005349With the above settings build objects are saved in the /tmp/build,
5350log files are saved in the /tmp/log and the source tree remains clean
5351during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005352
5353
wdenk6c59edc2004-05-03 20:45:30 +00005354See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005355
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk6c59edc2004-05-03 20:45:30 +00005357Monitor Commands - Overview:
5358============================
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk6c59edc2004-05-03 20:45:30 +00005360go - start application at address 'addr'
5361run - run commands in an environment variable
5362bootm - boot application image from memory
5363bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005364bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005365tftpboot- boot image via network using TFTP protocol
5366 and env variables "ipaddr" and "serverip"
5367 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005368tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005369rarpboot- boot image via network using RARP/TFTP protocol
5370diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5371loads - load S-Record file over serial line
5372loadb - load binary file over serial line (kermit mode)
5373md - memory display
5374mm - memory modify (auto-incrementing)
5375nm - memory modify (constant address)
5376mw - memory write (fill)
5377cp - memory copy
5378cmp - memory compare
5379crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005380i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005381sspi - SPI utility commands
5382base - print or set address offset
5383printenv- print environment variables
5384setenv - set environment variables
5385saveenv - save environment variables to persistent storage
5386protect - enable or disable FLASH write protection
5387erase - erase FLASH memory
5388flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005389nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005390bdinfo - print Board Info structure
5391iminfo - print header information for application image
5392coninfo - print console devices and informations
5393ide - IDE sub-system
5394loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005395loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005396mtest - simple RAM test
5397icache - enable or disable instruction cache
5398dcache - enable or disable data cache
5399reset - Perform RESET of the CPU
5400echo - echo args to console
5401version - print monitor version
5402help - print online help
5403? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005404
wdenkc6097192002-11-03 00:24:07 +00005405
wdenk6c59edc2004-05-03 20:45:30 +00005406Monitor Commands - Detailed Description:
5407========================================
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409TODO.
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005412
5413
wdenk6c59edc2004-05-03 20:45:30 +00005414Environment Variables:
5415======================
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417U-Boot supports user configuration using Environment Variables which
5418can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420Environment Variables are set using "setenv", printed using
5421"printenv", and saved to Flash using "saveenv". Using "setenv"
5422without a value can be used to delete a variable from the
5423environment. As long as you don't save the environment you are
5424working with an in-memory copy. In case the Flash area containing the
5425environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005426
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005427Some configuration options can be set using Environment Variables.
5428
5429List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005434
wdenk6c59edc2004-05-03 20:45:30 +00005435 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005436
wdenk6c59edc2004-05-03 20:45:30 +00005437 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005438
wdenk6c59edc2004-05-03 20:45:30 +00005439 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005440
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005441 bootm_low - Memory range available for image processing in the bootm
5442 command can be restricted. This variable is given as
5443 a hexadecimal number and defines lowest address allowed
5444 for use by the bootm command. See also "bootm_size"
5445 environment variable. Address defined by "bootm_low" is
5446 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005447 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5448 bootm_mapsize.
5449
Wolfgang Denk092ae952011-10-26 10:21:21 +00005450 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005451 This variable is given as a hexadecimal number and it
5452 defines the size of the memory region starting at base
5453 address bootm_low that is accessible by the Linux kernel
5454 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5455 as the default value if it is defined, and bootm_size is
5456 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005457
5458 bootm_size - Memory range available for image processing in the bootm
5459 command can be restricted. This variable is given as
5460 a hexadecimal number and defines the size of the region
5461 allowed for use by the bootm command. See also "bootm_low"
5462 environment variable.
5463
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005464 updatefile - Location of the software update file on a TFTP server, used
5465 by the automatic software update feature. Please refer to
5466 documentation in doc/README.update for more details.
5467
wdenk6c59edc2004-05-03 20:45:30 +00005468 autoload - if set to "no" (any string beginning with 'n'),
5469 "bootp" will just load perform a lookup of the
5470 configuration from the BOOTP server, but not try to
5471 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005472
wdenk6c59edc2004-05-03 20:45:30 +00005473 autostart - if set to "yes", an image loaded using the "bootp",
5474 "rarpboot", "tftpboot" or "diskboot" commands will
5475 be automatically started (by internally calling
5476 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005477
wdenk6c59edc2004-05-03 20:45:30 +00005478 If set to "no", a standalone image passed to the
5479 "bootm" command will be copied to the load address
5480 (and eventually uncompressed), but NOT be started.
5481 This can be used to load and uncompress arbitrary
5482 data.
wdenkc6097192002-11-03 00:24:07 +00005483
David A. Longd558a4e2011-07-09 16:40:19 -04005484 fdt_high - if set this restricts the maximum address that the
5485 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005486 For example, if you have a system with 1 GB memory
5487 at physical address 0x10000000, while Linux kernel
5488 only recognizes the first 704 MB as low memory, you
5489 may need to set fdt_high as 0x3C000000 to have the
5490 device tree blob be copied to the maximum address
5491 of the 704 MB low memory, so that Linux kernel can
5492 access it during the boot procedure.
5493
David A. Longd558a4e2011-07-09 16:40:19 -04005494 If this is set to the special value 0xFFFFFFFF then
5495 the fdt will not be copied at all on boot. For this
5496 to work it must reside in writable memory, have
5497 sufficient padding on the end of it for u-boot to
5498 add the information it needs into it, and the memory
5499 must be accessible by the kernel.
5500
Simon Glassdc6fa642011-10-24 19:15:34 +00005501 fdtcontroladdr- if set this is the address of the control flattened
5502 device tree used by U-Boot when CONFIG_OF_CONTROL is
5503 defined.
5504
wdenk0e2bd9c2004-06-06 21:51:03 +00005505 i2cfast - (PPC405GP|PPC405EP only)
5506 if set to 'y' configures Linux I2C driver for fast
5507 mode (400kHZ). This environment variable is used in
5508 initialization code. So, for changes to be effective
5509 it must be saved and board must be reset.
5510
wdenk6c59edc2004-05-03 20:45:30 +00005511 initrd_high - restrict positioning of initrd images:
5512 If this variable is not set, initrd images will be
5513 copied to the highest possible address in RAM; this
5514 is usually what you want since it allows for
5515 maximum initrd size. If for some reason you want to
5516 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005517 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005518 variable to a value of "no" or "off" or "0".
5519 Alternatively, you can set it to a maximum upper
5520 address to use (U-Boot will still check that it
5521 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523 For instance, when you have a system with 16 MB
5524 RAM, and want to reserve 4 MB from use by Linux,
5525 you can do this by adding "mem=12M" to the value of
5526 the "bootargs" variable. However, now you must make
5527 sure that the initrd image is placed in the first
5528 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005531
wdenk6c59edc2004-05-03 20:45:30 +00005532 If you set initrd_high to 0xFFFFFFFF, this is an
5533 indication to U-Boot that all addresses are legal
5534 for the Linux kernel, including addresses in flash
5535 memory. In this case U-Boot will NOT COPY the
5536 ramdisk at all. This may be useful to reduce the
5537 boot time on your system, but requires that this
5538 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005539
wdenk6c59edc2004-05-03 20:45:30 +00005540 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005541
wdenk6c59edc2004-05-03 20:45:30 +00005542 loadaddr - Default load address for commands like "bootp",
5543 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005546
wdenk6c59edc2004-05-03 20:45:30 +00005547 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005548
wdenk6c59edc2004-05-03 20:45:30 +00005549 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005552
wdenk6c59edc2004-05-03 20:45:30 +00005553 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005554
Mike Frysingera23230c2011-10-02 10:01:27 +00005555 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005556
Mike Frysingera23230c2011-10-02 10:01:27 +00005557 ethact - controls which interface is currently active.
5558 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005559
Heiko Schocherc5e84052010-07-20 17:45:02 +02005560 => setenv ethact FEC
5561 => ping 192.168.0.1 # traffic sent on FEC
5562 => setenv ethact SCC
5563 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005564
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005565 ethrotate - When set to "no" U-Boot does not go through all
5566 available network interfaces.
5567 It just stays at the currently selected interface.
5568
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005569 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005570 either succeed or fail without retrying.
5571 When set to "once" the network operation will
5572 fail when all the available network interfaces
5573 are tried once without success.
5574 Useful on scripts which control the retry operation
5575 themselves.
wdenkc6097192002-11-03 00:24:07 +00005576
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005577 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005578
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005579 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005580 changing the console to be empty. If "yes" it will be
5581 made silent. If "no" it will not be made silent. If
5582 unset, then it will be made silent if the U-Boot console
5583 is silent.
5584
Wolfgang Denk227b5192005-09-24 23:25:46 +02005585 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005586 UDP source port.
5587
Wolfgang Denk227b5192005-09-24 23:25:46 +02005588 tftpdstport - If this is set, the value is used for TFTP's UDP
5589 destination port instead of the Well Know Port 69.
5590
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005591 tftpblocksize - Block size to use for TFTP transfers; if not set,
5592 we use the TFTP server's default block size
5593
5594 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5595 seconds, minimum value is 1000 = 1 second). Defines
5596 when a packet is considered to be lost so it has to
5597 be retransmitted. The default is 5000 = 5 seconds.
5598 Lowering this value may make downloads succeed
5599 faster in networks with high packet loss rates or
5600 with unreliable TFTP servers.
5601
5602 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005603 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005604 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005605
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005606The following image location variables contain the location of images
5607used in booting. The "Image" column gives the role of the image and is
5608not an environment variable name. The other columns are environment
5609variable names. "File Name" gives the name of the file on a TFTP
5610server, "RAM Address" gives the location in RAM the image will be
5611loaded to, and "Flash Location" gives the image's address in NOR
5612flash or offset in NAND flash.
5613
5614*Note* - these variables don't have to be defined for all boards, some
5615boards currenlty use other variables for these purposes, and some
5616boards use these variables for other purposes.
5617
Wolfgang Denk092ae952011-10-26 10:21:21 +00005618Image File Name RAM Address Flash Location
5619----- --------- ----------- --------------
5620u-boot u-boot u-boot_addr_r u-boot_addr
5621Linux kernel bootfile kernel_addr_r kernel_addr
5622device tree blob fdtfile fdt_addr_r fdt_addr
5623ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625The following environment variables may be used and automatically
5626updated by the network boot commands ("bootp" and "rarpboot"),
5627depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629 bootfile - see above
5630 dnsip - IP address of your Domain Name Server
5631 dnsip2 - IP address of your secondary Domain Name Server
5632 gatewayip - IP address of the Gateway (Router) to use
5633 hostname - Target hostname
5634 ipaddr - see above
5635 netmask - Subnet Mask
5636 rootpath - Pathname of the root filesystem on the NFS server
5637 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005638
wdenk145d2c12004-04-15 21:48:45 +00005639
wdenk6c59edc2004-05-03 20:45:30 +00005640There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk6c59edc2004-05-03 20:45:30 +00005642 serial# - contains hardware identification information such
5643 as type string and/or serial number
5644 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005645
wdenk6c59edc2004-05-03 20:45:30 +00005646These variables can be set only once (usually during manufacturing of
5647the board). U-Boot refuses to delete or overwrite these variables
5648once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005649
5650
wdenk6c59edc2004-05-03 20:45:30 +00005651Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653 ver - Contains the U-Boot version string as printed
5654 with the "version" command. This variable is
5655 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005656
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658Please note that changes to some configuration parameters may take
5659only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005660
stroeseb9c17c52003-04-04 15:53:41 +00005661
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005662Callback functions for environment variables:
5663---------------------------------------------
5664
5665For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005666when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005667be associated with arbitrary variables. On creation, overwrite, or
5668deletion, the callback will provide the opportunity for some side
5669effect to happen or for the change to be rejected.
5670
5671The callbacks are named and associated with a function using the
5672U_BOOT_ENV_CALLBACK macro in your board or driver code.
5673
5674These callbacks are associated with variables in one of two ways. The
5675static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5676in the board configuration to a string that defines a list of
5677associations. The list must be in the following format:
5678
5679 entry = variable_name[:callback_name]
5680 list = entry[,list]
5681
5682If the callback name is not specified, then the callback is deleted.
5683Spaces are also allowed anywhere in the list.
5684
5685Callbacks can also be associated by defining the ".callbacks" variable
5686with the same list format above. Any association in ".callbacks" will
5687override any association in the static list. You can define
5688CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005689".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005690
5691
wdenk6c59edc2004-05-03 20:45:30 +00005692Command Line Parsing:
5693=====================
stroeseb9c17c52003-04-04 15:53:41 +00005694
wdenk6c59edc2004-05-03 20:45:30 +00005695There are two different command line parsers available with U-Boot:
5696the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk6c59edc2004-05-03 20:45:30 +00005698Old, simple command line parser:
5699--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005700
wdenk6c59edc2004-05-03 20:45:30 +00005701- supports environment variables (through setenv / saveenv commands)
5702- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005703- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005704- special characters ('$', ';') can be escaped by prefixing with '\',
5705 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005706 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005707- You can also escape text by enclosing in single apostrophes, for example:
5708 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005709
wdenk6c59edc2004-05-03 20:45:30 +00005710Hush shell:
5711-----------
wdenkf4688a22003-05-28 08:06:31 +00005712
wdenk6c59edc2004-05-03 20:45:30 +00005713- similar to Bourne shell, with control structures like
5714 if...then...else...fi, for...do...done; while...do...done,
5715 until...do...done, ...
5716- supports environment ("global") variables (through setenv / saveenv
5717 commands) and local shell variables (through standard shell syntax
5718 "name=value"); only environment variables can be used with "run"
5719 command
wdenkf4688a22003-05-28 08:06:31 +00005720
wdenk6c59edc2004-05-03 20:45:30 +00005721General rules:
5722--------------
wdenkf4688a22003-05-28 08:06:31 +00005723
wdenk6c59edc2004-05-03 20:45:30 +00005724(1) If a command line (or an environment variable executed by a "run"
5725 command) contains several commands separated by semicolon, and
5726 one of these commands fails, then the remaining commands will be
5727 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005728
wdenk6c59edc2004-05-03 20:45:30 +00005729(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005730 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005731 command will cause "run" to terminate, i. e. the remaining
5732 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734Note for Redundant Ethernet Interfaces:
5735=======================================
wdenkf4688a22003-05-28 08:06:31 +00005736
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005737Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005738such configurations and is capable of automatic selection of a
5739"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005740
wdenk6c59edc2004-05-03 20:45:30 +00005741Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5742MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5743"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745If the network interface stores some valid MAC address (for instance
5746in SROM), this is used as default address if there is NO correspon-
5747ding setting in the environment; if the corresponding environment
5748variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005749
wdenk6c59edc2004-05-03 20:45:30 +00005750o If the SROM has a valid MAC address, and there is no address in the
5751 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005752
wdenk6c59edc2004-05-03 20:45:30 +00005753o If there is no valid address in the SROM, and a definition in the
5754 environment exists, then the value from the environment variable is
5755 used.
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk6c59edc2004-05-03 20:45:30 +00005757o If both the SROM and the environment contain a MAC address, and
5758 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005759
wdenk6c59edc2004-05-03 20:45:30 +00005760o If both the SROM and the environment contain a MAC address, and the
5761 addresses differ, the value from the environment is used and a
5762 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764o If neither SROM nor the environment contain a MAC address, an error
5765 is raised.
wdenkc6097192002-11-03 00:24:07 +00005766
Ben Warren6db991a2010-04-26 11:11:46 -07005767If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005768will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005769may be skipped by setting the appropriate 'ethmacskip' environment variable.
5770The naming convention is as follows:
5771"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005772
wdenk6c59edc2004-05-03 20:45:30 +00005773Image Formats:
5774==============
wdenkc6097192002-11-03 00:24:07 +00005775
Marian Balakowicz18710b82008-03-12 12:13:13 +01005776U-Boot is capable of booting (and performing other auxiliary operations on)
5777images in two formats:
5778
5779New uImage format (FIT)
5780-----------------------
5781
5782Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5783to Flattened Device Tree). It allows the use of images with multiple
5784components (several kernels, ramdisks, etc.), with contents protected by
5785SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5786
5787
5788Old uImage format
5789-----------------
5790
5791Old image format is based on binary files which can be basically anything,
5792preceded by a special header; see the definitions in include/image.h for
5793details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005794
wdenk6c59edc2004-05-03 20:45:30 +00005795* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5796 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005797 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5798 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5799 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005800* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005801 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5802 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005803* Compression Type (uncompressed, gzip, bzip2)
5804* Load Address
5805* Entry Point
5806* Image Name
5807* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809The header is marked by a special Magic Number, and both the header
5810and the data portions of the image are secured against corruption by
5811CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005812
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814Linux Support:
5815==============
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817Although U-Boot should support any OS or standalone application
5818easily, the main focus has always been on Linux during the design of
5819U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005820
wdenk6c59edc2004-05-03 20:45:30 +00005821U-Boot includes many features that so far have been part of some
5822special "boot loader" code within the Linux kernel. Also, any
5823"initrd" images to be used are no longer part of one big Linux image;
5824instead, kernel and "initrd" are separate images. This implementation
5825serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk6c59edc2004-05-03 20:45:30 +00005827- the same features can be used for other OS or standalone
5828 applications (for instance: using compressed images to reduce the
5829 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831- it becomes much easier to port new Linux kernel versions because
5832 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk6c59edc2004-05-03 20:45:30 +00005834- the same Linux kernel image can now be used with different "initrd"
5835 images; of course this also means that different kernel images can
5836 be run with the same "initrd". This makes testing easier (you don't
5837 have to build a new "zImage.initrd" Linux image when you just
5838 change a file in your "initrd"). Also, a field-upgrade of the
5839 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005840
wdenkc6097192002-11-03 00:24:07 +00005841
wdenk6c59edc2004-05-03 20:45:30 +00005842Linux HOWTO:
5843============
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845Porting Linux to U-Boot based systems:
5846---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005847
wdenk6c59edc2004-05-03 20:45:30 +00005848U-Boot cannot save you from doing all the necessary modifications to
5849configure the Linux device drivers for use with your target hardware
5850(no, we don't intend to provide a full virtual machine interface to
5851Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005852
Stefan Roese88fbf932010-04-15 16:07:28 +02005853But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005854
wdenk6c59edc2004-05-03 20:45:30 +00005855Just make sure your machine specific header file (for instance
5856include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005857Information structure as we define in include/asm-<arch>/u-boot.h,
5858and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005859as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005860
Simon Glassd097e592014-06-11 23:29:46 -06005861Note that U-Boot now has a driver model, a unified model for drivers.
5862If you are adding a new driver, plumb it into driver model. If there
5863is no uclass available, you are encouraged to create one. See
5864doc/driver-model.
5865
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk6c59edc2004-05-03 20:45:30 +00005867Configuring the Linux kernel:
5868-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005869
wdenk6c59edc2004-05-03 20:45:30 +00005870No specific requirements for U-Boot. Make sure you have some root
5871device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005872
wdenkc6097192002-11-03 00:24:07 +00005873
wdenk6c59edc2004-05-03 20:45:30 +00005874Building a Linux Image:
5875-----------------------
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk6c59edc2004-05-03 20:45:30 +00005877With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5878not used. If you use recent kernel source, a new build target
5879"uImage" will exist which automatically builds an image usable by
5880U-Boot. Most older kernels also have support for a "pImage" target,
5881which was introduced for our predecessor project PPCBoot and uses a
5882100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk6c59edc2004-05-03 20:45:30 +00005884Example:
wdenkc6097192002-11-03 00:24:07 +00005885
Holger Freyther7ba4e572014-08-04 09:26:05 +02005886 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005887 make oldconfig
5888 make dep
5889 make uImage
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891The "uImage" build target uses a special tool (in 'tools/mkimage') to
5892encapsulate a compressed Linux kernel image with header information,
5893CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk6c59edc2004-05-03 20:45:30 +00005895* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005896
wdenk6c59edc2004-05-03 20:45:30 +00005897* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk6c59edc2004-05-03 20:45:30 +00005899 ${CROSS_COMPILE}-objcopy -O binary \
5900 -R .note -R .comment \
5901 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005902
wdenk6c59edc2004-05-03 20:45:30 +00005903* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005904
wdenk6c59edc2004-05-03 20:45:30 +00005905 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005906
wdenk6c59edc2004-05-03 20:45:30 +00005907* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005908
wdenk6c59edc2004-05-03 20:45:30 +00005909 mkimage -A ppc -O linux -T kernel -C gzip \
5910 -a 0 -e 0 -n "Linux Kernel Image" \
5911 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005912
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914The "mkimage" tool can also be used to create ramdisk images for use
5915with U-Boot, either separated from the Linux kernel image, or
5916combined into one file. "mkimage" encapsulates the images with a 64
5917byte header containing information about target architecture,
5918operating system, image type, compression method, entry points, time
5919stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk6c59edc2004-05-03 20:45:30 +00005921"mkimage" can be called in two ways: to verify existing images and
5922print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005923
wdenk6c59edc2004-05-03 20:45:30 +00005924In the first form (with "-l" option) mkimage lists the information
5925contained in the header of an existing U-Boot image; this includes
5926checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005927
wdenk6c59edc2004-05-03 20:45:30 +00005928 tools/mkimage -l image
5929 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005930
wdenk6c59edc2004-05-03 20:45:30 +00005931The second form (with "-d" option) is used to build a U-Boot image
5932from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005933
wdenk6c59edc2004-05-03 20:45:30 +00005934 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5935 -n name -d data_file image
5936 -A ==> set architecture to 'arch'
5937 -O ==> set operating system to 'os'
5938 -T ==> set image type to 'type'
5939 -C ==> set compression type 'comp'
5940 -a ==> set load address to 'addr' (hex)
5941 -e ==> set entry point to 'ep' (hex)
5942 -n ==> set image name to 'name'
5943 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005944
wdenkcd914452004-05-29 16:53:29 +00005945Right now, all Linux kernels for PowerPC systems use the same load
5946address (0x00000000), but the entry point address depends on the
5947kernel version:
wdenkc6097192002-11-03 00:24:07 +00005948
wdenk6c59edc2004-05-03 20:45:30 +00005949- 2.2.x kernels have the entry point at 0x0000000C,
5950- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005951
wdenk6c59edc2004-05-03 20:45:30 +00005952So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005953
wdenk6c59edc2004-05-03 20:45:30 +00005954 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5955 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005956 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005957 > examples/uImage.TQM850L
5958 Image Name: 2.4.4 kernel for TQM850L
5959 Created: Wed Jul 19 02:34:59 2000
5960 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5961 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5962 Load Address: 0x00000000
5963 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005964
wdenk6c59edc2004-05-03 20:45:30 +00005965To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005966
wdenk6c59edc2004-05-03 20:45:30 +00005967 -> tools/mkimage -l examples/uImage.TQM850L
5968 Image Name: 2.4.4 kernel for TQM850L
5969 Created: Wed Jul 19 02:34:59 2000
5970 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5971 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5972 Load Address: 0x00000000
5973 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005974
wdenk6c59edc2004-05-03 20:45:30 +00005975NOTE: for embedded systems where boot time is critical you can trade
5976speed for memory and install an UNCOMPRESSED image instead: this
5977needs more space in Flash, but boots much faster since it does not
5978need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005979
Stefan Roese88fbf932010-04-15 16:07:28 +02005980 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005981 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5982 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005983 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005984 > examples/uImage.TQM850L-uncompressed
5985 Image Name: 2.4.4 kernel for TQM850L
5986 Created: Wed Jul 19 02:34:59 2000
5987 Image Type: PowerPC Linux Kernel Image (uncompressed)
5988 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5989 Load Address: 0x00000000
5990 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005991
wdenkc6097192002-11-03 00:24:07 +00005992
wdenk6c59edc2004-05-03 20:45:30 +00005993Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5994when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk6c59edc2004-05-03 20:45:30 +00005996 -> tools/mkimage -n 'Simple Ramdisk Image' \
5997 > -A ppc -O linux -T ramdisk -C gzip \
5998 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5999 Image Name: Simple Ramdisk Image
6000 Created: Wed Jan 12 14:01:50 2000
6001 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6002 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
6003 Load Address: 0x00000000
6004 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00006005
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07006006The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
6007option performs the converse operation of the mkimage's second form (the "-d"
6008option). Given an image built by mkimage, the dumpimage extracts a "data file"
6009from the image:
6010
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02006011 tools/dumpimage -i image -T type -p position data_file
6012 -i ==> extract from the 'image' a specific 'data_file'
6013 -T ==> set image type to 'type'
6014 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07006015
wdenkc6097192002-11-03 00:24:07 +00006016
wdenk6c59edc2004-05-03 20:45:30 +00006017Installing a Linux Image:
6018-------------------------
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk6c59edc2004-05-03 20:45:30 +00006020To downloading a U-Boot image over the serial (console) interface,
6021you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00006022
wdenk6c59edc2004-05-03 20:45:30 +00006023 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00006024
wdenk6c59edc2004-05-03 20:45:30 +00006025The 'objcopy' does not understand the information in the U-Boot
6026image header, so the resulting S-Record file will be relative to
6027address 0x00000000. To load it to a given address, you need to
6028specify the target address as 'offset' parameter with the 'loads'
6029command.
wdenkc6097192002-11-03 00:24:07 +00006030
wdenk6c59edc2004-05-03 20:45:30 +00006031Example: install the image to address 0x40100000 (which on the
6032TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00006033
wdenk6c59edc2004-05-03 20:45:30 +00006034 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00006035
wdenk6c59edc2004-05-03 20:45:30 +00006036 .......... done
6037 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk6c59edc2004-05-03 20:45:30 +00006039 => loads 40100000
6040 ## Ready for S-Record download ...
6041 ~>examples/image.srec
6042 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
6043 ...
6044 15989 15990 15991 15992
6045 [file transfer complete]
6046 [connected]
6047 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00006048
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006051this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00006052corruption happened:
wdenkc6097192002-11-03 00:24:07 +00006053
wdenk6c59edc2004-05-03 20:45:30 +00006054 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00006055
wdenk6c59edc2004-05-03 20:45:30 +00006056 ## Checking Image at 40100000 ...
6057 Image Name: 2.2.13 for initrd on TQM850L
6058 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6059 Data Size: 335725 Bytes = 327 kB = 0 MB
6060 Load Address: 00000000
6061 Entry Point: 0000000c
6062 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006063
6064
wdenk6c59edc2004-05-03 20:45:30 +00006065Boot Linux:
6066-----------
wdenkc6097192002-11-03 00:24:07 +00006067
wdenk6c59edc2004-05-03 20:45:30 +00006068The "bootm" command is used to boot an application that is stored in
6069memory (RAM or Flash). In case of a Linux kernel image, the contents
6070of the "bootargs" environment variable is passed to the kernel as
6071parameters. You can check and modify this variable using the
6072"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00006073
wdenkc6097192002-11-03 00:24:07 +00006074
wdenk6c59edc2004-05-03 20:45:30 +00006075 => printenv bootargs
6076 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078 => 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 +00006079
wdenk6c59edc2004-05-03 20:45:30 +00006080 => printenv bootargs
6081 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 +00006082
wdenk6c59edc2004-05-03 20:45:30 +00006083 => bootm 40020000
6084 ## Booting Linux kernel at 40020000 ...
6085 Image Name: 2.2.13 for NFS on TQM850L
6086 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6087 Data Size: 381681 Bytes = 372 kB = 0 MB
6088 Load Address: 00000000
6089 Entry Point: 0000000c
6090 Verifying Checksum ... OK
6091 Uncompressing Kernel Image ... OK
6092 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
6093 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6094 time_init: decrementer frequency = 187500000/60
6095 Calibrating delay loop... 49.77 BogoMIPS
6096 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6097 ...
wdenkc6097192002-11-03 00:24:07 +00006098
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006099If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00006100the memory addresses of both the kernel and the initrd image (PPBCOOT
6101format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00006102
wdenk6c59edc2004-05-03 20:45:30 +00006103 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006104
wdenk6c59edc2004-05-03 20:45:30 +00006105 ## Checking Image at 40100000 ...
6106 Image Name: 2.2.13 for initrd on TQM850L
6107 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6108 Data Size: 335725 Bytes = 327 kB = 0 MB
6109 Load Address: 00000000
6110 Entry Point: 0000000c
6111 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006112
wdenk6c59edc2004-05-03 20:45:30 +00006113 ## Checking Image at 40200000 ...
6114 Image Name: Simple Ramdisk Image
6115 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6116 Data Size: 566530 Bytes = 553 kB = 0 MB
6117 Load Address: 00000000
6118 Entry Point: 00000000
6119 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006120
wdenk6c59edc2004-05-03 20:45:30 +00006121 => bootm 40100000 40200000
6122 ## Booting Linux kernel at 40100000 ...
6123 Image Name: 2.2.13 for initrd on TQM850L
6124 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6125 Data Size: 335725 Bytes = 327 kB = 0 MB
6126 Load Address: 00000000
6127 Entry Point: 0000000c
6128 Verifying Checksum ... OK
6129 Uncompressing Kernel Image ... OK
6130 ## Loading RAMDisk Image at 40200000 ...
6131 Image Name: Simple Ramdisk Image
6132 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6133 Data Size: 566530 Bytes = 553 kB = 0 MB
6134 Load Address: 00000000
6135 Entry Point: 00000000
6136 Verifying Checksum ... OK
6137 Loading Ramdisk ... OK
6138 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
6139 Boot arguments: root=/dev/ram
6140 time_init: decrementer frequency = 187500000/60
6141 Calibrating delay loop... 49.77 BogoMIPS
6142 ...
6143 RAMDISK: Compressed image found at block 0
6144 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006145
wdenk6c59edc2004-05-03 20:45:30 +00006146 bash#
wdenkc6097192002-11-03 00:24:07 +00006147
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006148Boot Linux and pass a flat device tree:
6149-----------
6150
6151First, U-Boot must be compiled with the appropriate defines. See the section
6152titled "Linux Kernel Interface" above for a more in depth explanation. The
6153following is an example of how to start a kernel and pass an updated
6154flat device tree:
6155
6156=> print oftaddr
6157oftaddr=0x300000
6158=> print oft
6159oft=oftrees/mpc8540ads.dtb
6160=> tftp $oftaddr $oft
6161Speed: 1000, full duplex
6162Using TSEC0 device
6163TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6164Filename 'oftrees/mpc8540ads.dtb'.
6165Load address: 0x300000
6166Loading: #
6167done
6168Bytes transferred = 4106 (100a hex)
6169=> tftp $loadaddr $bootfile
6170Speed: 1000, full duplex
6171Using TSEC0 device
6172TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6173Filename 'uImage'.
6174Load address: 0x200000
6175Loading:############
6176done
6177Bytes transferred = 1029407 (fb51f hex)
6178=> print loadaddr
6179loadaddr=200000
6180=> print oftaddr
6181oftaddr=0x300000
6182=> bootm $loadaddr - $oftaddr
6183## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006184 Image Name: Linux-2.6.17-dirty
6185 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6186 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006187 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006188 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006189 Verifying Checksum ... OK
6190 Uncompressing Kernel Image ... OK
6191Booting using flat device tree at 0x300000
6192Using MPC85xx ADS machine description
6193Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6194[snip]
6195
6196
wdenk6c59edc2004-05-03 20:45:30 +00006197More About U-Boot Image Types:
6198------------------------------
wdenkc6097192002-11-03 00:24:07 +00006199
wdenk6c59edc2004-05-03 20:45:30 +00006200U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk6c59edc2004-05-03 20:45:30 +00006202 "Standalone Programs" are directly runnable in the environment
6203 provided by U-Boot; it is expected that (if they behave
6204 well) you can continue to work in U-Boot after return from
6205 the Standalone Program.
6206 "OS Kernel Images" are usually images of some Embedded OS which
6207 will take over control completely. Usually these programs
6208 will install their own set of exception handlers, device
6209 drivers, set up the MMU, etc. - this means, that you cannot
6210 expect to re-enter U-Boot except by resetting the CPU.
6211 "RAMDisk Images" are more or less just data blocks, and their
6212 parameters (address, size) are passed to an OS kernel that is
6213 being started.
6214 "Multi-File Images" contain several images, typically an OS
6215 (Linux) kernel image and one or more data images like
6216 RAMDisks. This construct is useful for instance when you want
6217 to boot over the network using BOOTP etc., where the boot
6218 server provides just a single image file, but you want to get
6219 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006220
wdenk6c59edc2004-05-03 20:45:30 +00006221 "Multi-File Images" start with a list of image sizes, each
6222 image size (in bytes) specified by an "uint32_t" in network
6223 byte order. This list is terminated by an "(uint32_t)0".
6224 Immediately after the terminating 0 follow the images, one by
6225 one, all aligned on "uint32_t" boundaries (size rounded up to
6226 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006227
wdenk6c59edc2004-05-03 20:45:30 +00006228 "Firmware Images" are binary images containing firmware (like
6229 U-Boot or FPGA images) which usually will be programmed to
6230 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006231
wdenk6c59edc2004-05-03 20:45:30 +00006232 "Script files" are command sequences that will be executed by
6233 U-Boot's command interpreter; this feature is especially
6234 useful when you configure U-Boot to use a real shell (hush)
6235 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006236
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006237Booting the Linux zImage:
6238-------------------------
6239
6240On some platforms, it's possible to boot Linux zImage. This is done
6241using the "bootz" command. The syntax of "bootz" command is the same
6242as the syntax of "bootm" command.
6243
Tom Rini45f46d12013-05-16 11:40:11 -04006244Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006245kernel with raw initrd images. The syntax is slightly different, the
6246address of the initrd must be augmented by it's size, in the following
6247format: "<initrd addres>:<initrd size>".
6248
stroeseb9c17c52003-04-04 15:53:41 +00006249
wdenk6c59edc2004-05-03 20:45:30 +00006250Standalone HOWTO:
6251=================
stroeseb9c17c52003-04-04 15:53:41 +00006252
wdenk6c59edc2004-05-03 20:45:30 +00006253One of the features of U-Boot is that you can dynamically load and
6254run "standalone" applications, which can use some resources of
6255U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006256
wdenk6c59edc2004-05-03 20:45:30 +00006257Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006258
wdenk6c59edc2004-05-03 20:45:30 +00006259"Hello World" Demo:
6260-------------------
wdenkc6097192002-11-03 00:24:07 +00006261
wdenk6c59edc2004-05-03 20:45:30 +00006262'examples/hello_world.c' contains a small "Hello World" Demo
6263application; it is automatically compiled when you build U-Boot.
6264It's configured to run at address 0x00040004, so you can play with it
6265like that:
wdenkc6097192002-11-03 00:24:07 +00006266
wdenk6c59edc2004-05-03 20:45:30 +00006267 => loads
6268 ## Ready for S-Record download ...
6269 ~>examples/hello_world.srec
6270 1 2 3 4 5 6 7 8 9 10 11 ...
6271 [file transfer complete]
6272 [connected]
6273 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006274
wdenk6c59edc2004-05-03 20:45:30 +00006275 => go 40004 Hello World! This is a test.
6276 ## Starting application at 0x00040004 ...
6277 Hello World
6278 argc = 7
6279 argv[0] = "40004"
6280 argv[1] = "Hello"
6281 argv[2] = "World!"
6282 argv[3] = "This"
6283 argv[4] = "is"
6284 argv[5] = "a"
6285 argv[6] = "test."
6286 argv[7] = "<NULL>"
6287 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006288
wdenk6c59edc2004-05-03 20:45:30 +00006289 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006290
wdenk6c59edc2004-05-03 20:45:30 +00006291Another example, which demonstrates how to register a CPM interrupt
6292handler with the U-Boot code, can be found in 'examples/timer.c'.
6293Here, a CPM timer is set up to generate an interrupt every second.
6294The interrupt service routine is trivial, just printing a '.'
6295character, but this is just a demo program. The application can be
6296controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006297
wdenk6c59edc2004-05-03 20:45:30 +00006298 ? - print current values og the CPM Timer registers
6299 b - enable interrupts and start timer
6300 e - stop timer and disable interrupts
6301 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006302
wdenk6c59edc2004-05-03 20:45:30 +00006303 => loads
6304 ## Ready for S-Record download ...
6305 ~>examples/timer.srec
6306 1 2 3 4 5 6 7 8 9 10 11 ...
6307 [file transfer complete]
6308 [connected]
6309 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006310
wdenk6c59edc2004-05-03 20:45:30 +00006311 => go 40004
6312 ## Starting application at 0x00040004 ...
6313 TIMERS=0xfff00980
6314 Using timer 1
6315 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006316
wdenk6c59edc2004-05-03 20:45:30 +00006317Hit 'b':
6318 [q, b, e, ?] Set interval 1000000 us
6319 Enabling timer
6320Hit '?':
6321 [q, b, e, ?] ........
6322 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6323Hit '?':
6324 [q, b, e, ?] .
6325 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6326Hit '?':
6327 [q, b, e, ?] .
6328 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6329Hit '?':
6330 [q, b, e, ?] .
6331 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6332Hit 'e':
6333 [q, b, e, ?] ...Stopping timer
6334Hit 'q':
6335 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006336
wdenkc6097192002-11-03 00:24:07 +00006337
wdenk6c59edc2004-05-03 20:45:30 +00006338Minicom warning:
6339================
wdenkc6097192002-11-03 00:24:07 +00006340
wdenk6c59edc2004-05-03 20:45:30 +00006341Over time, many people have reported problems when trying to use the
6342"minicom" terminal emulation program for serial download. I (wd)
6343consider minicom to be broken, and recommend not to use it. Under
6344Unix, I recommend to use C-Kermit for general purpose use (and
6345especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006346use "cu" for S-Record download ("loads" command). See
6347http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6348for help with kermit.
6349
wdenkc6097192002-11-03 00:24:07 +00006350
wdenk6c59edc2004-05-03 20:45:30 +00006351Nevertheless, if you absolutely want to use it try adding this
6352configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006353
wdenk6c59edc2004-05-03 20:45:30 +00006354 Name Program Name U/D FullScr IO-Red. Multi
6355 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6356 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006357
wdenk8dba0502003-03-31 16:34:49 +00006358
wdenk6c59edc2004-05-03 20:45:30 +00006359NetBSD Notes:
6360=============
wdenkc6097192002-11-03 00:24:07 +00006361
wdenk6c59edc2004-05-03 20:45:30 +00006362Starting at version 0.9.2, U-Boot supports NetBSD both as host
6363(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006364
wdenk6c59edc2004-05-03 20:45:30 +00006365Building requires a cross environment; it is known to work on
6366NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6367need gmake since the Makefiles are not compatible with BSD make).
6368Note that the cross-powerpc package does not install include files;
6369attempting to build U-Boot will fail because <machine/ansi.h> is
6370missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006371
wdenk6c59edc2004-05-03 20:45:30 +00006372 # cd /usr/pkg/cross/powerpc-netbsd/include
6373 # mkdir powerpc
6374 # ln -s powerpc machine
6375 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6376 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006377
wdenk6c59edc2004-05-03 20:45:30 +00006378Native builds *don't* work due to incompatibilities between native
6379and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006380
wdenk6c59edc2004-05-03 20:45:30 +00006381Booting assumes that (the first part of) the image booted is a
6382stage-2 loader which in turn loads and then invokes the kernel
6383proper. Loader sources will eventually appear in the NetBSD source
6384tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006385meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006386
wdenkc6097192002-11-03 00:24:07 +00006387
wdenk6c59edc2004-05-03 20:45:30 +00006388Implementation Internals:
6389=========================
wdenkc6097192002-11-03 00:24:07 +00006390
wdenk6c59edc2004-05-03 20:45:30 +00006391The following is not intended to be a complete description of every
6392implementation detail. However, it should help to understand the
6393inner workings of U-Boot and make it easier to port it to custom
6394hardware.
wdenkc6097192002-11-03 00:24:07 +00006395
wdenkc6097192002-11-03 00:24:07 +00006396
wdenk6c59edc2004-05-03 20:45:30 +00006397Initial Stack, Global Data:
6398---------------------------
wdenkc6097192002-11-03 00:24:07 +00006399
wdenk6c59edc2004-05-03 20:45:30 +00006400The implementation of U-Boot is complicated by the fact that U-Boot
6401starts running out of ROM (flash memory), usually without access to
6402system RAM (because the memory controller is not initialized yet).
6403This means that we don't have writable Data or BSS segments, and BSS
6404is not initialized as zero. To be able to get a C environment working
6405at all, we have to allocate at least a minimal stack. Implementation
6406options for this are defined and restricted by the CPU used: Some CPU
6407models provide on-chip memory (like the IMMR area on MPC8xx and
6408MPC826x processors), on others (parts of) the data cache can be
6409locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006410
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006411 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006412 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006413
wdenk6c59edc2004-05-03 20:45:30 +00006414 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6415 From: "Chris Hallinan" <clh@net1plus.com>
6416 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6417 ...
wdenkc6097192002-11-03 00:24:07 +00006418
wdenk6c59edc2004-05-03 20:45:30 +00006419 Correct me if I'm wrong, folks, but the way I understand it
6420 is this: Using DCACHE as initial RAM for Stack, etc, does not
6421 require any physical RAM backing up the cache. The cleverness
6422 is that the cache is being used as a temporary supply of
6423 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006424 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006425 can see how this works by studying the cache architecture and
6426 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006427
wdenk6c59edc2004-05-03 20:45:30 +00006428 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6429 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006430 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006431 option should work for you. Using CS 4 should be fine if your
6432 board designers haven't used it for something that would
6433 cause you grief during the initial boot! It is frequently not
6434 used.
wdenkc6097192002-11-03 00:24:07 +00006435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006436 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006437 with your processor/board/system design. The default value
6438 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006439 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006440 than your SDRAM module. If you have a 64MB SDRAM module, set
6441 it above 400_0000. Just make sure your board has no resources
6442 that are supposed to respond to that address! That code in
6443 start.S has been around a while and should work as is when
6444 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006445
wdenk6c59edc2004-05-03 20:45:30 +00006446 -Chris Hallinan
6447 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006448
wdenk6c59edc2004-05-03 20:45:30 +00006449It is essential to remember this, since it has some impact on the C
6450code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006451
wdenk6c59edc2004-05-03 20:45:30 +00006452* Initialized global data (data segment) is read-only. Do not attempt
6453 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006454
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006455* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006456 as zero data - BSS segment) at all - this is undefined, initiali-
6457 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006458
wdenk6c59edc2004-05-03 20:45:30 +00006459* Stack space is very limited. Avoid big data buffers or things like
6460 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006461
wdenk6c59edc2004-05-03 20:45:30 +00006462Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006463normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006464turned out that the implementation of U-Boot can be greatly
6465simplified by making a global data structure (gd_t) available to all
6466functions. We could pass a pointer to this data as argument to _all_
6467functions, but this would bloat the code. Instead we use a feature of
6468the GCC compiler (Global Register Variables) to share the data: we
6469place a pointer (gd) to the global data into a register which we
6470reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006471
wdenk6c59edc2004-05-03 20:45:30 +00006472When choosing a register for such a purpose we are restricted by the
6473relevant (E)ABI specifications for the current architecture, and by
6474GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006475
wdenk6c59edc2004-05-03 20:45:30 +00006476For PowerPC, the following registers have specific use:
6477 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006478 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006479 R3-R4: parameter passing and return values
6480 R5-R10: parameter passing
6481 R13: small data area pointer
6482 R30: GOT pointer
6483 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006484
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006485 (U-Boot also uses R12 as internal GOT pointer. r12
6486 is a volatile register so r12 needs to be reset when
6487 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006488
Wolfgang Denk69c09642008-02-14 22:43:22 +01006489 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006490
wdenk6c59edc2004-05-03 20:45:30 +00006491 Note: on PPC, we could use a static initializer (since the
6492 address of the global data structure is known at compile time),
6493 but it turned out that reserving a register results in somewhat
6494 smaller code - although the code savings are not that big (on
6495 average for all boards 752 bytes for the whole U-Boot image,
6496 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006497
Robin Getz2773d5f2009-08-17 15:23:02 +00006498On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006499 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6500
Robin Getz2773d5f2009-08-17 15:23:02 +00006501 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006502
wdenk6c59edc2004-05-03 20:45:30 +00006503On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006504
wdenk6c59edc2004-05-03 20:45:30 +00006505 R0: function argument word/integer result
6506 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006507 R9: platform specific
6508 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006509 R11: argument (frame) pointer
6510 R12: temporary workspace
6511 R13: stack pointer
6512 R14: link register
6513 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006514
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006515 ==> U-Boot will use R9 to hold a pointer to the global data
6516
6517 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006518
Thomas Chou8fa38582010-05-21 11:08:03 +08006519On Nios II, the ABI is documented here:
6520 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6521
6522 ==> U-Boot will use gp to hold a pointer to the global data
6523
6524 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6525 to access small data sections, so gp is free.
6526
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006527On NDS32, the following registers are used:
6528
6529 R0-R1: argument/return
6530 R2-R5: argument
6531 R15: temporary register for assembler
6532 R16: trampoline register
6533 R28: frame pointer (FP)
6534 R29: global pointer (GP)
6535 R30: link register (LP)
6536 R31: stack pointer (SP)
6537 PC: program counter (PC)
6538
6539 ==> U-Boot will use R10 to hold a pointer to the global data
6540
Wolfgang Denk6405a152006-03-31 18:32:53 +02006541NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6542or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006543
wdenk6c59edc2004-05-03 20:45:30 +00006544Memory Management:
6545------------------
wdenkc6097192002-11-03 00:24:07 +00006546
wdenk6c59edc2004-05-03 20:45:30 +00006547U-Boot runs in system state and uses physical addresses, i.e. the
6548MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006549
wdenk6c59edc2004-05-03 20:45:30 +00006550The available memory is mapped to fixed addresses using the memory
6551controller. In this process, a contiguous block is formed for each
6552memory type (Flash, SDRAM, SRAM), even when it consists of several
6553physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006554
wdenk6c59edc2004-05-03 20:45:30 +00006555U-Boot is installed in the first 128 kB of the first Flash bank (on
6556TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6557booting and sizing and initializing DRAM, the code relocates itself
6558to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006559memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006560configuration setting]. Below that, a structure with global Board
6561Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006562
wdenk6c59edc2004-05-03 20:45:30 +00006563Additionally, some exception handler code is copied to the low 8 kB
6564of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006565
wdenk6c59edc2004-05-03 20:45:30 +00006566So a typical memory configuration with 16 MB of DRAM could look like
6567this:
wdenkc6097192002-11-03 00:24:07 +00006568
wdenk6c59edc2004-05-03 20:45:30 +00006569 0x0000 0000 Exception Vector code
6570 :
6571 0x0000 1FFF
6572 0x0000 2000 Free for Application Use
6573 :
6574 :
wdenkc6097192002-11-03 00:24:07 +00006575
wdenk6c59edc2004-05-03 20:45:30 +00006576 :
6577 :
6578 0x00FB FF20 Monitor Stack (Growing downward)
6579 0x00FB FFAC Board Info Data and permanent copy of global data
6580 0x00FC 0000 Malloc Arena
6581 :
6582 0x00FD FFFF
6583 0x00FE 0000 RAM Copy of Monitor Code
6584 ... eventually: LCD or video framebuffer
6585 ... eventually: pRAM (Protected RAM - unchanged by reset)
6586 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006587
wdenkc6097192002-11-03 00:24:07 +00006588
wdenk6c59edc2004-05-03 20:45:30 +00006589System Initialization:
6590----------------------
wdenkc6097192002-11-03 00:24:07 +00006591
wdenk6c59edc2004-05-03 20:45:30 +00006592In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006593(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006594configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006595To be able to re-map memory U-Boot then jumps to its link address.
6596To be able to implement the initialization code in C, a (small!)
6597initial stack is set up in the internal Dual Ported RAM (in case CPUs
6598which provide such a feature like MPC8xx or MPC8260), or in a locked
6599part of the data cache. After that, U-Boot initializes the CPU core,
6600the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006601
wdenk6c59edc2004-05-03 20:45:30 +00006602Next, all (potentially) available memory banks are mapped using a
6603preliminary mapping. For example, we put them on 512 MB boundaries
6604(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6605on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6606programmed for SDRAM access. Using the temporary configuration, a
6607simple memory test is run that determines the size of the SDRAM
6608banks.
wdenkc6097192002-11-03 00:24:07 +00006609
wdenk6c59edc2004-05-03 20:45:30 +00006610When there is more than one SDRAM bank, and the banks are of
6611different size, the largest is mapped first. For equal size, the first
6612bank (CS2#) is mapped first. The first mapping is always for address
66130x00000000, with any additional banks following immediately to create
6614contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006615
wdenk6c59edc2004-05-03 20:45:30 +00006616Then, the monitor installs itself at the upper end of the SDRAM area
6617and allocates memory for use by malloc() and for the global Board
6618Info data; also, the exception vector code is copied to the low RAM
6619pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006620
wdenk6c59edc2004-05-03 20:45:30 +00006621Only after this relocation will you have a "normal" C environment;
6622until that you are restricted in several ways, mostly because you are
6623running from ROM, and because the code will have to be relocated to a
6624new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006625
wdenkc6097192002-11-03 00:24:07 +00006626
wdenk6c59edc2004-05-03 20:45:30 +00006627U-Boot Porting Guide:
6628----------------------
wdenkc6097192002-11-03 00:24:07 +00006629
wdenk6c59edc2004-05-03 20:45:30 +00006630[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6631list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006632
wdenkc6097192002-11-03 00:24:07 +00006633
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006634int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006635{
6636 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006637
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006638 signal(SIGALRM, no_more_time);
6639 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006640
wdenk6c59edc2004-05-03 20:45:30 +00006641 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006642 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006643 return 0;
6644 }
wdenkc6097192002-11-03 00:24:07 +00006645
wdenk6c59edc2004-05-03 20:45:30 +00006646 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006647
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006648 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006649
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006650 if (clueless)
6651 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006652
wdenk6c59edc2004-05-03 20:45:30 +00006653 while (learning) {
6654 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006655 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6656 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006657 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006658 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006659 }
wdenkc6097192002-11-03 00:24:07 +00006660
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006661 if (available_money > toLocalCurrency ($2500))
6662 Buy a BDI3000;
6663 else
wdenk6c59edc2004-05-03 20:45:30 +00006664 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006665
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006666 if (a similar board exists) { /* hopefully... */
6667 cp -a board/<similar> board/<myboard>
6668 cp include/configs/<similar>.h include/configs/<myboard>.h
6669 } else {
6670 Create your own board support subdirectory;
6671 Create your own board include/configs/<myboard>.h file;
6672 }
6673 Edit new board/<myboard> files
6674 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006675
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006676 while (!accepted) {
6677 while (!running) {
6678 do {
6679 Add / modify source code;
6680 } until (compiles);
6681 Debug;
6682 if (clueless)
6683 email("Hi, I am having problems...");
6684 }
6685 Send patch file to the U-Boot email list;
6686 if (reasonable critiques)
6687 Incorporate improvements from email list code review;
6688 else
6689 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006690 }
wdenkc6097192002-11-03 00:24:07 +00006691
wdenk6c59edc2004-05-03 20:45:30 +00006692 return 0;
6693}
wdenkc6097192002-11-03 00:24:07 +00006694
wdenk6c59edc2004-05-03 20:45:30 +00006695void no_more_time (int sig)
6696{
6697 hire_a_guru();
6698}
wdenkc6097192002-11-03 00:24:07 +00006699
wdenkc6097192002-11-03 00:24:07 +00006700
wdenk6c59edc2004-05-03 20:45:30 +00006701Coding Standards:
6702-----------------
wdenkc6097192002-11-03 00:24:07 +00006703
wdenk6c59edc2004-05-03 20:45:30 +00006704All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006705coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006706"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006707
6708Source files originating from a different project (for example the
6709MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006710reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006711sources.
wdenkc6097192002-11-03 00:24:07 +00006712
Detlev Zundelaa63d482006-09-01 15:39:02 +02006713Please note that U-Boot is implemented in C (and to some small parts in
6714Assembler); no C++ is used, so please do not use C++ style comments (//)
6715in your code.
wdenkad276f22004-01-04 16:28:35 +00006716
wdenk6c59edc2004-05-03 20:45:30 +00006717Please also stick to the following formatting rules:
6718- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006719- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006720- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006721- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006722- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006723
wdenk6c59edc2004-05-03 20:45:30 +00006724Submissions which do not conform to the standards may be returned
6725with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006726
wdenkc6097192002-11-03 00:24:07 +00006727
wdenk6c59edc2004-05-03 20:45:30 +00006728Submitting Patches:
6729-------------------
wdenkc6097192002-11-03 00:24:07 +00006730
wdenk6c59edc2004-05-03 20:45:30 +00006731Since the number of patches for U-Boot is growing, we need to
6732establish some rules. Submissions which do not conform to these rules
6733may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006734
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006735Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006736
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006737Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6738see http://lists.denx.de/mailman/listinfo/u-boot
6739
wdenk6c59edc2004-05-03 20:45:30 +00006740When you send a patch, please include the following information with
6741it:
wdenkc6097192002-11-03 00:24:07 +00006742
wdenk6c59edc2004-05-03 20:45:30 +00006743* For bug fixes: a description of the bug and how your patch fixes
6744 this bug. Please try to include a way of demonstrating that the
6745 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006746
wdenk6c59edc2004-05-03 20:45:30 +00006747* For new features: a description of the feature and your
6748 implementation.
wdenkc6097192002-11-03 00:24:07 +00006749
wdenk6c59edc2004-05-03 20:45:30 +00006750* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006751
wdenk6c59edc2004-05-03 20:45:30 +00006752* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006753
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006754* When you add support for a new board, don't forget to add a
6755 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006756
wdenk6c59edc2004-05-03 20:45:30 +00006757* If your patch adds new configuration options, don't forget to
6758 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006759
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006760* The patch itself. If you are using git (which is *strongly*
6761 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006762 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006763 the U-Boot mailing list, you will avoid most of the common problems
6764 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006765
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006766 If you cannot use git, use "diff -purN OLD NEW". If your version of
6767 diff does not support these options, then get the latest version of
6768 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006769
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006770 The current directory when running this command shall be the parent
6771 directory of the U-Boot source tree (i. e. please make sure that
6772 your patch includes sufficient directory information for the
6773 affected files).
6774
6775 We prefer patches as plain text. MIME attachments are discouraged,
6776 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006777
wdenk6c59edc2004-05-03 20:45:30 +00006778* If one logical set of modifications affects or creates several
6779 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006780
wdenk6c59edc2004-05-03 20:45:30 +00006781* Changesets that contain different, unrelated modifications shall be
6782 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006783
wdenkc6097192002-11-03 00:24:07 +00006784
wdenk6c59edc2004-05-03 20:45:30 +00006785Notes:
wdenkc6097192002-11-03 00:24:07 +00006786
wdenk6c59edc2004-05-03 20:45:30 +00006787* Before sending the patch, run the MAKEALL script on your patched
6788 source tree and make sure that no errors or warnings are reported
6789 for any of the boards.
6790
6791* Keep your modifications to the necessary minimum: A patch
6792 containing several unrelated changes or arbitrary reformats will be
6793 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006794
wdenk6c59edc2004-05-03 20:45:30 +00006795* If you modify existing code, make sure that your new code does not
6796 add to the memory footprint of the code ;-) Small is beautiful!
6797 When adding new features, these should compile conditionally only
6798 (using #ifdef), and the resulting code with the new feature
6799 disabled must not need more memory than the old code without your
6800 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006801
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006802* Remember that there is a size limit of 100 kB per message on the
6803 u-boot mailing list. Bigger patches will be moderated. If they are
6804 reasonable and not too big, they will be acknowledged. But patches
6805 bigger than the size limit should be avoided.