blob: 360f2a9f70b866bb83e8bb026289556d8e6657c7 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-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 Denkeca3aeb2013-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
wdenke86e5a02004-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 ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-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 Tyser0c325652008-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 Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-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
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-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 Tyser8d321b82010-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ßmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-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 Tyser8d321b82010-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 Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-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 Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
Peter Tyser8d321b82010-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 Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tyser8d321b82010-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-VILLARD6d0f6bc2008-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 Freytherab584d62014-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 Freytherab584d62014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-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 Glass75b3c3a2014-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 Teki6b1978f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600274
275
Simon Glassdb910352015-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
wdenk7f6c2cb2002-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 Phillips26281142007-08-10 13:28:25 -0500363- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000364
Kim Phillips26281142007-08-10 13:28:25 -0500365- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200366
367- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-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 Ziswiler11ccc332008-07-09 08:17:15 +0200388 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000389 a "rotator" |\-/|\-/
390
Lei Wencf946c62011-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 Ziswiler11ccc332008-07-09 08:17:15 +0200396- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000397 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
398 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000399 e.g. if there is no 32KHz
400 reference PIT/RTC clock
wdenk66ca92a2004-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
wdenk66ca92a2004-09-28 17:59:53 +0000404- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200405 CONFIG_SYS_8xx_CPUCLK_MIN
406 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000407 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000408 See doc/README.MPC866
409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200410 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000411
wdenkba56f622004-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200417 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000418
Heiko Schocher506f3912009-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 Gala66412c62011-02-18 05:40:54 -0600424- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Kushwahaafa6b552012-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 Wood33eee332012-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 Kushwaha74fa22e2013-04-16 13:27:44 +0530471 CONFIG_A003399_NOR_WORKAROUND
472 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800473 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530474
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530475 CONFIG_A008044_WORKAROUND
476 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800477 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530478
Scott Wood33eee332012-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 Jain64501c62013-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 Jain765b0bd2013-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 Jain64501c62013-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 Jain765b0bd2013-04-04 09:31:54 +0530496 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497 This value denotes start offset of DSP CCSR space.
498
Priyanka Jainb1359912013-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 Bansalfb4a2402014-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 Yuantianaade2002014-04-17 15:33:46 +0800508 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800509 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800510 supported, core will start to execute uboot when wakes up.
511
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000512- Generic CPU options:
York Sun2a1680e2014-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 Schwierzeck6cb461b2012-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 Sun5614e712013-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 Sun34e026f2014-03-27 17:54:47 -0700545 CONFIG_SYS_FSL_DDRC_GEN4
546 Freescale DDR4 controller.
547
York Sun9ac4ffb2013-09-30 14:20:51 -0700548 CONFIG_SYS_FSL_DDRC_ARM_GEN3
549 Freescale DDR3 controller for ARM-based SoCs.
550
York Sun5614e712013-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 Sun34e026f2014-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 Sun5614e712013-09-30 09:22:09 -0700572
Prabhakar Kushwaha1b4175d2014-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 Kushwaha690e4252014-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 Kushwaha89ad7be2014-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 Sun4e5b1bd2014-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 Sun6b9e3092014-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 Sun6b1e1252014-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 Sun1d71efb2014-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 Gupta028dbb82014-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 Klotzbuecher0b953ff2006-03-24 15:28:02 +0100620- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200621 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200627 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200628
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100629 Defines the Monahans turbo mode to oscillator
630 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200631 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100632 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200633
Daniel Schwierzeck92bbd642011-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 Rieschb67d8812012-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 V5356f542012-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 Warrenc5d47522013-03-04 13:29:40 +0000680 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000681 CONFIG_ARM_ERRATA_742230
682 CONFIG_ARM_ERRATA_743622
683 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500684 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500685 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-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 Menonc616a0d2015-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 Menon5902f4c2015-03-09 17:12:01 -0500696 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500697 CONFIG_ARM_ERRATA_454179
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500698 CONFIG_ARM_ERRATA_798870
699
Stephen Warren73c38932015-01-19 16:25:52 -0700700- Tegra SoC options:
701 CONFIG_TEGRA_SUPPORT_NON_SECURE
702
703 Support executing U-Boot in non-secure (NS) mode. Certain
704 impossible actions will be skipped if the CPU is in NS mode,
705 such as ARM architectural timer initialization.
706
Simon Glass38687ae2014-11-10 17:16:54 -0700707- Driver Model
708 Driver model is a new framework for devices in U-Boot
709 introduced in early 2014. U-Boot is being progressively
710 moved over to this. It offers a consistent device structure,
711 supports grouping devices into classes and has built-in
712 handling of platform data and device tree.
713
714 To enable transition to driver model in a relatively
715 painful fashion, each subsystem can be independently
716 switched between the legacy/ad-hoc approach and the new
717 driver model using the options below. Also, many uclass
718 interfaces include compatibility features which may be
719 removed once the conversion of that subsystem is complete.
720 As a result, the API provided by the subsystem may in fact
721 not change with driver model.
722
723 See doc/driver-model/README.txt for more information.
724
725 CONFIG_DM
726
727 Enable driver model. This brings in the core support,
728 including scanning of platform data on start-up. If
729 CONFIG_OF_CONTROL is enabled, the device tree will be
730 scanned also when available.
731
732 CONFIG_CMD_DM
733
734 Enable driver model test commands. These allow you to print
735 out the driver model tree and the uclasses.
736
737 CONFIG_DM_DEMO
738
739 Enable some demo devices and the 'demo' command. These are
740 really only useful for playing around while trying to
741 understand driver model in sandbox.
742
743 CONFIG_SPL_DM
744
745 Enable driver model in SPL. You will need to provide a
746 suitable malloc() implementation. If you are not using the
747 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
748 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
749 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
750 In most cases driver model will only allocate a few uclasses
751 and devices in SPL, so 1KB should be enable. See
752 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
753 it.
754
755 CONFIG_DM_SERIAL
756
757 Enable driver model for serial. This replaces
758 drivers/serial/serial.c with the serial uclass, which
759 implements serial_putc() etc. The uclass interface is
760 defined in include/serial.h.
761
762 CONFIG_DM_GPIO
763
764 Enable driver model for GPIO access. The standard GPIO
765 interface (gpio_get_value(), etc.) is then implemented by
766 the GPIO uclass. Drivers provide methods to query the
767 particular GPIOs that they provide. The uclass interface
768 is defined in include/asm-generic/gpio.h.
769
770 CONFIG_DM_SPI
771
772 Enable driver model for SPI. The SPI slave interface
773 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
774 the SPI uclass. Drivers provide methods to access the SPI
775 buses that they control. The uclass interface is defined in
776 include/spi.h. The existing spi_slave structure is attached
777 as 'parent data' to every slave on each bus. Slaves
778 typically use driver-private data instead of extending the
779 spi_slave structure.
780
781 CONFIG_DM_SPI_FLASH
782
783 Enable driver model for SPI flash. This SPI flash interface
784 (spi_flash_probe(), spi_flash_write(), etc.) is then
785 implemented by the SPI flash uclass. There is one standard
786 SPI flash driver which knows how to probe most chips
787 supported by U-Boot. The uclass interface is defined in
788 include/spi_flash.h, but is currently fully compatible
789 with the old interface to avoid confusion and duplication
790 during the transition parent. SPI and SPI flash must be
791 enabled together (it is not possible to use driver model
792 for one and not the other).
793
794 CONFIG_DM_CROS_EC
795
796 Enable driver model for the Chrome OS EC interface. This
797 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
798 but otherwise makes few changes. Since cros_ec also supports
799 I2C and LPC (which don't support driver model yet), a full
800 conversion is not yet possible.
801
802
803 ** Code size options: The following options are enabled by
804 default except in SPL. Enable them explicitly to get these
805 features in SPL.
806
807 CONFIG_DM_WARN
808
809 Enable the dm_warn() function. This can use up quite a bit
810 of space for its strings.
811
812 CONFIG_DM_STDIO
813
814 Enable registering a serial device with the stdio library.
815
816 CONFIG_DM_DEVICE_REMOVE
817
818 Enable removing of devices.
Simon Glass38687ae2014-11-10 17:16:54 -0700819
wdenk5da627a2003-10-09 20:09:04 +0000820- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000821 CONFIG_CLOCKS_IN_MHZ
822
823 U-Boot stores all clock information in Hz
824 internally. For binary compatibility with older Linux
825 kernels (which expect the clocks passed in the
826 bd_info data to be in MHz) the environment variable
827 "clocks_in_mhz" can be defined so that U-Boot
828 converts clock data to MHZ before passing it to the
829 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000830 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100831 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000832 default environment.
833
wdenk5da627a2003-10-09 20:09:04 +0000834 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
835
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800836 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000837 expect it to be in bytes, others in MB.
838 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
839
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400840 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200841
842 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400843 passed using flattened device trees (based on open firmware
844 concepts).
845
846 CONFIG_OF_LIBFDT
847 * New libfdt-based support
848 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500849 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400850
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200851 OF_CPU - The proper name of the cpus node (only required for
852 MPC512X and MPC5xxx based boards).
853 OF_SOC - The proper name of the soc node (only required for
854 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200855 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600856 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200857
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200858 boards with QUICC Engines require OF_QE to set UCC MAC
859 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500860
Kumar Gala4e253132006-01-11 13:54:17 -0600861 CONFIG_OF_BOARD_SETUP
862
863 Board code has addition modification that it wants to make
864 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000865
Simon Glassc654b512014-10-23 18:58:54 -0600866 CONFIG_OF_SYSTEM_SETUP
867
868 Other code has addition modification that it wants to make
869 to the flat device tree before handing it off to the kernel.
870 This causes ft_system_setup() to be called before booting
871 the kernel.
872
Matthew McClintock02677682006-06-28 10:41:37 -0500873 CONFIG_OF_BOOT_CPU
874
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200875 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500876 param header, the default value is zero if undefined.
877
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200878 CONFIG_OF_IDE_FIXUP
879
880 U-Boot can detect if an IDE device is present or not.
881 If not, and this new config option is activated, U-Boot
882 removes the ATA node from the DTS before booting Linux,
883 so the Linux IDE driver does not probe the device and
884 crash. This is needed for buggy hardware (uc101) where
885 no pull down resistor is connected to the signal IDE5V_DD7.
886
Igor Grinberg7eb29392011-07-14 05:45:07 +0000887 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
888
889 This setting is mandatory for all boards that have only one
890 machine type and must be used to specify the machine type
891 number as it appears in the ARM machine registry
892 (see http://www.arm.linux.org.uk/developer/machines/).
893 Only boards that have multiple machine types supported
894 in a single configuration file and the machine type is
895 runtime discoverable, do not have to use this setting.
896
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100897- vxWorks boot parameters:
898
899 bootvx constructs a valid bootline using the following
900 environments variables: bootfile, ipaddr, serverip, hostname.
901 It loads the vxWorks image pointed bootfile.
902
903 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
904 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
905 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
906 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
907
908 CONFIG_SYS_VXWORKS_ADD_PARAMS
909
910 Add it at the end of the bootline. E.g "u=username pw=secret"
911
912 Note: If a "bootargs" environment is defined, it will overwride
913 the defaults discussed just above.
914
Aneesh V2c451f72011-06-16 23:30:47 +0000915- Cache Configuration:
916 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
917 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
918 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
919
Aneesh V93bc2192011-06-16 23:30:51 +0000920- Cache Configuration for ARM:
921 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
922 controller
923 CONFIG_SYS_PL310_BASE - Physical base address of PL310
924 controller register space
925
wdenk6705d812004-08-02 23:22:59 +0000926- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200927 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000928
929 Define this if you want support for Amba PrimeCell PL010 UARTs.
930
Andreas Engel48d01922008-09-08 14:30:53 +0200931 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000932
933 Define this if you want support for Amba PrimeCell PL011 UARTs.
934
935 CONFIG_PL011_CLOCK
936
937 If you have Amba PrimeCell PL011 UARTs, set this variable to
938 the clock speed of the UARTs.
939
940 CONFIG_PL01x_PORTS
941
942 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
943 define this to a list of base addresses for each (supported)
944 port. See e.g. include/configs/versatile.h
945
John Rigby910f1ae2011-04-19 10:42:39 +0000946 CONFIG_PL011_SERIAL_RLCR
947
948 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
949 have separate receive and transmit line control registers. Set
950 this variable to initialize the extra register.
951
952 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
953
954 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
955 boot loader that has already initialized the UART. Define this
956 variable to flush the UART at init time.
957
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400958 CONFIG_SERIAL_HW_FLOW_CONTROL
959
960 Define this variable to enable hw flow control in serial driver.
961 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000962
wdenkc6097192002-11-03 00:24:07 +0000963- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000964 Depending on board, define exactly one serial port
965 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
966 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
967 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000968
969 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
970 port routines must be defined elsewhere
971 (i.e. serial_init(), serial_getc(), ...)
972
973 CONFIG_CFB_CONSOLE
974 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000975 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000976 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
977 (default big endian)
978 VIDEO_HW_RECTFILL graphic chip supports
979 rectangle fill
980 (cf. smiLynxEM)
981 VIDEO_HW_BITBLT graphic chip supports
982 bit-blit (cf. smiLynxEM)
983 VIDEO_VISIBLE_COLS visible pixel columns
984 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000985 VIDEO_VISIBLE_ROWS visible pixel rows
986 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000987 VIDEO_DATA_FORMAT graphic data format
988 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000989 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000990 VIDEO_KBD_INIT_FCT keyboard int fct
991 (i.e. i8042_kbd_init())
992 VIDEO_TSTC_FCT test char fct
993 (i.e. i8042_tstc)
994 VIDEO_GETC_FCT get char fct
995 (i.e. i8042_getc)
996 CONFIG_CONSOLE_CURSOR cursor drawing on/off
997 (requires blink timer
998 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200999 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +00001000 CONFIG_CONSOLE_TIME display time/date info in
1001 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +00001003 CONFIG_VIDEO_LOGO display Linux logo in
1004 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +00001005 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
1006 linux_logo.h for logo.
1007 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +00001008 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001009 additional board info beside
wdenkc6097192002-11-03 00:24:07 +00001010 the logo
1011
Pali Rohár33a35bb2012-10-19 13:30:09 +00001012 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
1013 a limited number of ANSI escape sequences (cursor control,
1014 erase functions and limited graphics rendition control).
1015
wdenk43d96162003-03-06 00:02:04 +00001016 When CONFIG_CFB_CONSOLE is defined, video console is
1017 default i/o. Serial console can be forced with
1018 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +00001019
wdenkd4ca31c2004-01-02 14:00:00 +00001020 When CONFIG_SILENT_CONSOLE is defined, all console
1021 messages (by U-Boot and Linux!) can be silenced with
1022 the "silent" environment variable. See
1023 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +00001024
Heiko Schocher45ae2542013-10-22 11:06:06 +02001025 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
1026 is 0x00.
1027 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
1028 is 0xa0.
1029
wdenkc6097192002-11-03 00:24:07 +00001030- Console Baudrate:
1031 CONFIG_BAUDRATE - in bps
1032 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001033 CONFIG_SYS_BAUDRATE_TABLE, see below.
1034 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +00001035
Heiko Schocherc92fac92009-01-30 12:55:38 +01001036- Console Rx buffer length
1037 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
1038 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +01001039 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +01001040 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
1041 must be defined, to setup the maximum idle timeout for
1042 the SMC.
1043
Graeme Russ9558b482011-09-01 00:48:27 +00001044- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001045 Prior to the console being initialised (i.e. serial UART
1046 initialised etc) all console output is silently discarded.
1047 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
1048 buffer any console messages prior to the console being
1049 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
1050 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
1051 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +02001052 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001053 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +00001054
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001055 'Sane' compilers will generate smaller code if
1056 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +00001057
Sonny Rao046a37b2011-11-02 09:52:08 +00001058- Safe printf() functions
1059 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
1060 the printf() functions. These are defined in
1061 include/vsprintf.h and include snprintf(), vsnprintf() and
1062 so on. Code size increase is approximately 300-500 bytes.
1063 If this option is not given then these functions will
1064 silently discard their buffer size argument - this means
1065 you are not getting any overflow checking in this case.
1066
wdenkc6097192002-11-03 00:24:07 +00001067- Boot Delay: CONFIG_BOOTDELAY - in seconds
1068 Delay before automatically booting the default image;
1069 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +00001070 set to -2 to autoboot with no delay and not check for abort
1071 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +00001072
1073 See doc/README.autoboot for these options that
1074 work with CONFIG_BOOTDELAY. None are required.
1075 CONFIG_BOOT_RETRY_TIME
1076 CONFIG_BOOT_RETRY_MIN
1077 CONFIG_AUTOBOOT_KEYED
1078 CONFIG_AUTOBOOT_PROMPT
1079 CONFIG_AUTOBOOT_DELAY_STR
1080 CONFIG_AUTOBOOT_STOP_STR
1081 CONFIG_AUTOBOOT_DELAY_STR2
1082 CONFIG_AUTOBOOT_STOP_STR2
1083 CONFIG_ZERO_BOOTDELAY_CHECK
1084 CONFIG_RESET_TO_RETRY
1085
1086- Autoboot Command:
1087 CONFIG_BOOTCOMMAND
1088 Only needed when CONFIG_BOOTDELAY is enabled;
1089 define a command string that is automatically executed
1090 when no character is read on the console interface
1091 within "Boot Delay" after reset.
1092
1093 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +00001094 This can be used to pass arguments to the bootm
1095 command. The value of CONFIG_BOOTARGS goes into the
1096 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001097
1098 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +00001099 The value of these goes into the environment as
1100 "ramboot" and "nfsboot" respectively, and can be used
1101 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001102 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001103
Heiko Schochereda0ba32013-11-04 14:04:59 +01001104- Bootcount:
1105 CONFIG_BOOTCOUNT_LIMIT
1106 Implements a mechanism for detecting a repeating reboot
1107 cycle, see:
1108 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1109
1110 CONFIG_BOOTCOUNT_ENV
1111 If no softreset save registers are found on the hardware
1112 "bootcount" is stored in the environment. To prevent a
1113 saveenv on all reboots, the environment variable
1114 "upgrade_available" is used. If "upgrade_available" is
1115 0, "bootcount" is always 0, if "upgrade_available" is
1116 1 "bootcount" is incremented in the environment.
1117 So the Userspace Applikation must set the "upgrade_available"
1118 and "bootcount" variable to 0, if a boot was successfully.
1119
wdenkc6097192002-11-03 00:24:07 +00001120- Pre-Boot Commands:
1121 CONFIG_PREBOOT
1122
1123 When this option is #defined, the existence of the
1124 environment variable "preboot" will be checked
1125 immediately before starting the CONFIG_BOOTDELAY
1126 countdown and/or running the auto-boot command resp.
1127 entering interactive mode.
1128
1129 This feature is especially useful when "preboot" is
1130 automatically generated or modified. For an example
1131 see the LWMON board specific code: here "preboot" is
1132 modified when the user holds down a certain
1133 combination of keys on the (special) keyboard when
1134 booting the systems
1135
1136- Serial Download Echo Mode:
1137 CONFIG_LOADS_ECHO
1138 If defined to 1, all characters received during a
1139 serial download (using the "loads" command) are
1140 echoed back. This might be needed by some terminal
1141 emulations (like "cu"), but may as well just take
1142 time on others. This setting #define's the initial
1143 value of the "loads_echo" environment variable.
1144
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001145- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001146 CONFIG_KGDB_BAUDRATE
1147 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001148 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001149
1150- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001151 Monitor commands can be included or excluded
1152 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001153 <config_cmd_all.h> and #undef'ing unwanted
1154 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001155 and augmenting with additional #define's
1156 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001157
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001158 The default command configuration includes all commands
1159 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001160
Marek Vasutb401b732014-03-05 19:58:39 +01001161 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001162 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001163 CONFIG_CMD_BDI bdinfo
1164 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1165 CONFIG_CMD_BMP * BMP support
1166 CONFIG_CMD_BSP * Board specific commands
1167 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001168 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001169 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001170 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001171 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001172 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001173 CONFIG_CMD_DATE * support for RTC, date/time...
1174 CONFIG_CMD_DHCP * DHCP support
1175 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001176 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1177 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1178 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1179 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001180 CONFIG_CMD_DTT * Digital Therm and Thermostat
1181 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001182 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001183 CONFIG_CMD_EEPROM * EEPROM read/write support
1184 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001185 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001186 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001187 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001188 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001189 CONFIG_CMD_EXT2 * ext2 command support
1190 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001191 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1192 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001193 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001194 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001195 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001196 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001197 CONFIG_CMD_FLASH flinfo, erase, protect
1198 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001199 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001200 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001201 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001202 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001203 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001204 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1205 CONFIG_CMD_I2C * I2C serial bus support
1206 CONFIG_CMD_IDE * IDE harddisk support
1207 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001208 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001209 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001210 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001211 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001212 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001213 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001214 CONFIG_CMD_IRQ * irqinfo
1215 CONFIG_CMD_ITEST Integer/string test of 2 values
1216 CONFIG_CMD_JFFS2 * JFFS2 Support
1217 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001218 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001219 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1220 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001221 CONFIG_CMD_LOADB loadb
1222 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001223 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001224 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001225 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001226 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001227 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001228 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001229 CONFIG_CMD_MISC Misc functions like sleep etc
1230 CONFIG_CMD_MMC * MMC memory mapped support
1231 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001232 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001233 CONFIG_CMD_NAND * NAND support
1234 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001235 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001236 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001237 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001238 CONFIG_CMD_PCI * pciinfo
1239 CONFIG_CMD_PCMCIA * PCMCIA support
1240 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1241 host
1242 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001243 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001244 CONFIG_CMD_REGINFO * Register dump
1245 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001246 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001247 CONFIG_CMD_SAVES * save S record dump
1248 CONFIG_CMD_SCSI * SCSI Support
1249 CONFIG_CMD_SDRAM * print SDRAM configuration information
1250 (requires CONFIG_CMD_I2C)
1251 CONFIG_CMD_SETGETDCR Support for DCR Register access
1252 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001253 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001254 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001255 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001256 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001257 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001258 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001259 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001260 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001261 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1262 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001263 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001264 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001265 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001266 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001267 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001268
1269 EXAMPLE: If you want all functions except of network
1270 support you can write:
1271
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001272 #include "config_cmd_all.h"
1273 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001274
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001275 Other Commands:
1276 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001277
1278 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001279 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001280 what you (and your U-Boot users) are doing. Data
1281 cache cannot be enabled on systems like the 8xx or
1282 8260 (where accesses to the IMMR region must be
1283 uncached), and it cannot be disabled on all other
1284 systems where we (mis-) use the data cache to hold an
1285 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001286
1287
1288 XXX - this list needs to get updated!
1289
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001290- Regular expression support:
1291 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001292 If this variable is defined, U-Boot is linked against
1293 the SLRE (Super Light Regular Expression) library,
1294 which adds regex support to some commands, as for
1295 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001296
Simon Glass45ba8072011-10-15 05:48:20 +00001297- Device tree:
1298 CONFIG_OF_CONTROL
1299 If this variable is defined, U-Boot will use a device tree
1300 to configure its devices, instead of relying on statically
1301 compiled #defines in the board file. This option is
1302 experimental and only available on a few boards. The device
1303 tree is available in the global data as gd->fdt_blob.
1304
Simon Glass2c0f79e2011-10-24 19:15:31 +00001305 U-Boot needs to get its device tree from somewhere. This can
1306 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001307
1308 CONFIG_OF_EMBED
1309 If this variable is defined, U-Boot will embed a device tree
1310 binary in its image. This device tree file should be in the
1311 board directory and called <soc>-<board>.dts. The binary file
1312 is then picked up in board_init_f() and made available through
1313 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001314
Simon Glass2c0f79e2011-10-24 19:15:31 +00001315 CONFIG_OF_SEPARATE
1316 If this variable is defined, U-Boot will build a device tree
1317 binary. It will be called u-boot.dtb. Architecture-specific
1318 code will locate it at run-time. Generally this works by:
1319
1320 cat u-boot.bin u-boot.dtb >image.bin
1321
1322 and in fact, U-Boot does this for you, creating a file called
1323 u-boot-dtb.bin which is useful in the common case. You can
1324 still use the individual files if you need something more
1325 exotic.
1326
wdenkc6097192002-11-03 00:24:07 +00001327- Watchdog:
1328 CONFIG_WATCHDOG
1329 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001330 support for the SoC. There must be support in the SoC
1331 specific code for a watchdog. For the 8xx and 8260
1332 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1333 register. When supported for a specific SoC is
1334 available, then no further board specific code should
1335 be needed to use it.
1336
1337 CONFIG_HW_WATCHDOG
1338 When using a watchdog circuitry external to the used
1339 SoC, then define this variable and provide board
1340 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001341
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001342 CONFIG_AT91_HW_WDT_TIMEOUT
1343 specify the timeout in seconds. default 2 seconds.
1344
stroesec1551ea2003-04-04 15:53:41 +00001345- U-Boot Version:
1346 CONFIG_VERSION_VARIABLE
1347 If this variable is defined, an environment variable
1348 named "ver" is created by U-Boot showing the U-Boot
1349 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001350 Any change to this variable will be reverted at the
1351 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001352
wdenkc6097192002-11-03 00:24:07 +00001353- Real-Time Clock:
1354
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001355 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001356 has to be selected, too. Define exactly one of the
1357 following options:
1358
1359 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1360 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001361 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001362 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001363 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001364 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001365 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001366 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001367 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001368 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001369 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001370 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001371 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1372 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001373
wdenkb37c7e52003-06-30 16:24:52 +00001374 Note that if the RTC uses I2C, then the I2C interface
1375 must also be configured. See I2C Support, below.
1376
Peter Tysere92739d2008-12-17 16:36:21 -06001377- GPIO Support:
1378 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001379
Chris Packham5dec49c2010-12-19 10:12:13 +00001380 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1381 chip-ngpio pairs that tell the PCA953X driver the number of
1382 pins supported by a particular chip.
1383
Peter Tysere92739d2008-12-17 16:36:21 -06001384 Note that if the GPIO device uses I2C, then the I2C interface
1385 must also be configured. See I2C Support, below.
1386
Simon Glassaa532332014-06-11 23:29:41 -06001387- I/O tracing:
1388 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1389 accesses and can checksum them or write a list of them out
1390 to memory. See the 'iotrace' command for details. This is
1391 useful for testing device drivers since it can confirm that
1392 the driver behaves the same way before and after a code
1393 change. Currently this is supported on sandbox and arm. To
1394 add support for your architecture, add '#include <iotrace.h>'
1395 to the bottom of arch/<arch>/include/asm/io.h and test.
1396
1397 Example output from the 'iotrace stats' command is below.
1398 Note that if the trace buffer is exhausted, the checksum will
1399 still continue to operate.
1400
1401 iotrace is enabled
1402 Start: 10000000 (buffer start address)
1403 Size: 00010000 (buffer size)
1404 Offset: 00000120 (current buffer offset)
1405 Output: 10000120 (start + offset)
1406 Count: 00000018 (number of trace records)
1407 CRC32: 9526fb66 (CRC32 of all trace records)
1408
wdenkc6097192002-11-03 00:24:07 +00001409- Timestamp Support:
1410
wdenk43d96162003-03-06 00:02:04 +00001411 When CONFIG_TIMESTAMP is selected, the timestamp
1412 (date and time) of an image is printed by image
1413 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001414 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001415
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001416- Partition Labels (disklabels) Supported:
1417 Zero or more of the following:
1418 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1419 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1420 Intel architecture, USB sticks, etc.
1421 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1422 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1423 bootloader. Note 2TB partition limit; see
1424 disk/part_efi.c
1425 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001426
Wolfgang Denk218ca722008-03-26 10:40:12 +01001427 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1428 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001429 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001430
1431- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001432 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1433 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001434
wdenk4d13cba2004-03-14 14:09:05 +00001435 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1436 be performed by calling the function
1437 ide_set_reset(int reset)
1438 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001439
1440- ATAPI Support:
1441 CONFIG_ATAPI
1442
1443 Set this to enable ATAPI support.
1444
wdenkc40b2952004-03-13 23:29:43 +00001445- LBA48 Support
1446 CONFIG_LBA48
1447
1448 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001449 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001450 Whithout these , LBA48 support uses 32bit variables and will 'only'
1451 support disks up to 2.1TB.
1452
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001453 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001454 When enabled, makes the IDE subsystem use 64bit sector addresses.
1455 Default is 32bit.
1456
wdenkc6097192002-11-03 00:24:07 +00001457- SCSI Support:
1458 At the moment only there is only support for the
1459 SYM53C8XX SCSI controller; define
1460 CONFIG_SCSI_SYM53C8XX to enable it.
1461
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001462 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1463 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1464 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001465 maximum numbers of LUNs, SCSI ID's and target
1466 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001467 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001468
Wolfgang Denk93e14592013-10-04 17:43:24 +02001469 The environment variable 'scsidevs' is set to the number of
1470 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001471
wdenkc6097192002-11-03 00:24:07 +00001472- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001473 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001474 Support for Intel 8254x/8257x gigabit chips.
1475
1476 CONFIG_E1000_SPI
1477 Utility code for direct access to the SPI bus on Intel 8257x.
1478 This does not do anything useful unless you set at least one
1479 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1480
1481 CONFIG_E1000_SPI_GENERIC
1482 Allow generic access to the SPI bus on the Intel 8257x, for
1483 example with the "sspi" command.
1484
1485 CONFIG_CMD_E1000
1486 Management command for E1000 devices. When used on devices
1487 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001488
Andre Schwarzac3315c2008-03-06 16:45:44 +01001489 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001490 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001491
wdenkc6097192002-11-03 00:24:07 +00001492 CONFIG_EEPRO100
1493 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001494 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001495 write routine for first time initialisation.
1496
1497 CONFIG_TULIP
1498 Support for Digital 2114x chips.
1499 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1500 modem chip initialisation (KS8761/QS6611).
1501
1502 CONFIG_NATSEMI
1503 Support for National dp83815 chips.
1504
1505 CONFIG_NS8382X
1506 Support for National dp8382[01] gigabit chips.
1507
wdenk45219c42003-05-12 21:50:16 +00001508- NETWORK Support (other):
1509
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001510 CONFIG_DRIVER_AT91EMAC
1511 Support for AT91RM9200 EMAC.
1512
1513 CONFIG_RMII
1514 Define this to use reduced MII inteface
1515
1516 CONFIG_DRIVER_AT91EMAC_QUIET
1517 If this defined, the driver is quiet.
1518 The driver doen't show link status messages.
1519
Rob Herringefdd7312011-12-15 11:15:49 +00001520 CONFIG_CALXEDA_XGMAC
1521 Support for the Calxeda XGMAC device
1522
Ashok3bb46d22012-10-15 06:20:47 +00001523 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001524 Support for SMSC's LAN91C96 chips.
1525
1526 CONFIG_LAN91C96_BASE
1527 Define this to hold the physical address
1528 of the LAN91C96's I/O space
1529
1530 CONFIG_LAN91C96_USE_32_BIT
1531 Define this to enable 32 bit addressing
1532
Ashok3bb46d22012-10-15 06:20:47 +00001533 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001534 Support for SMSC's LAN91C111 chip
1535
1536 CONFIG_SMC91111_BASE
1537 Define this to hold the physical address
1538 of the device (I/O space)
1539
1540 CONFIG_SMC_USE_32_BIT
1541 Define this if data bus is 32 bits
1542
1543 CONFIG_SMC_USE_IOFUNCS
1544 Define this to use i/o functions instead of macros
1545 (some hardware wont work with macros)
1546
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001547 CONFIG_DRIVER_TI_EMAC
1548 Support for davinci emac
1549
1550 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1551 Define this if you have more then 3 PHYs.
1552
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001553 CONFIG_FTGMAC100
1554 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1555
1556 CONFIG_FTGMAC100_EGIGA
1557 Define this to use GE link update with gigabit PHY.
1558 Define this if FTGMAC100 is connected to gigabit PHY.
1559 If your system has 10/100 PHY only, it might not occur
1560 wrong behavior. Because PHY usually return timeout or
1561 useless data when polling gigabit status and gigabit
1562 control registers. This behavior won't affect the
1563 correctnessof 10/100 link speed update.
1564
Mike Rapoportc2fff332009-11-11 10:03:03 +02001565 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001566 Support for SMSC's LAN911x and LAN921x chips
1567
Mike Rapoportc2fff332009-11-11 10:03:03 +02001568 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001569 Define this to hold the physical address
1570 of the device (I/O space)
1571
Mike Rapoportc2fff332009-11-11 10:03:03 +02001572 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001573 Define this if data bus is 32 bits
1574
Mike Rapoportc2fff332009-11-11 10:03:03 +02001575 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001576 Define this if data bus is 16 bits. If your processor
1577 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001578 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001579
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001580 CONFIG_SH_ETHER
1581 Support for Renesas on-chip Ethernet controller
1582
1583 CONFIG_SH_ETHER_USE_PORT
1584 Define the number of ports to be used
1585
1586 CONFIG_SH_ETHER_PHY_ADDR
1587 Define the ETH PHY's address
1588
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001589 CONFIG_SH_ETHER_CACHE_WRITEBACK
1590 If this option is set, the driver enables cache flush.
1591
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001592- PWM Support:
1593 CONFIG_PWM_IMX
1594 Support for PWM modul on the imx6.
1595
Vadim Bendebury5e124722011-10-17 08:36:14 +00001596- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001597 CONFIG_TPM
1598 Support TPM devices.
1599
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001600 CONFIG_TPM_TIS_I2C
1601 Support for i2c bus TPM devices. Only one device
1602 per system is supported at this time.
1603
1604 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1605 Define the the i2c bus number for the TPM device
1606
1607 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1608 Define the TPM's address on the i2c bus
1609
1610 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1611 Define the burst count bytes upper limit
1612
Dirk Eibachc01939c2013-06-26 15:55:15 +02001613 CONFIG_TPM_ATMEL_TWI
1614 Support for Atmel TWI TPM device. Requires I2C support.
1615
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001616 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001617 Support for generic parallel port TPM devices. Only one device
1618 per system is supported at this time.
1619
1620 CONFIG_TPM_TIS_BASE_ADDRESS
1621 Base address where the generic TPM device is mapped
1622 to. Contemporary x86 systems usually map it at
1623 0xfed40000.
1624
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001625 CONFIG_CMD_TPM
1626 Add tpm monitor functions.
1627 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1628 provides monitor access to authorized functions.
1629
1630 CONFIG_TPM
1631 Define this to enable the TPM support library which provides
1632 functional interfaces to some TPM commands.
1633 Requires support for a TPM device.
1634
1635 CONFIG_TPM_AUTH_SESSIONS
1636 Define this to enable authorized functions in the TPM library.
1637 Requires CONFIG_TPM and CONFIG_SHA1.
1638
wdenkc6097192002-11-03 00:24:07 +00001639- USB Support:
1640 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001641 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001642 CONFIG_USB_UHCI to enable it.
1643 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001644 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001645 storage devices.
1646 Note:
1647 Supported are USB Keyboards and USB Floppy drives
1648 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001649 MPC5200 USB requires additional defines:
1650 CONFIG_USB_CLOCK
1651 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001652 CONFIG_PSC3_USB
1653 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001654 CONFIG_USB_CONFIG
1655 for differential drivers: 0x00001000
1656 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001657 for differential drivers on PSC3: 0x00000100
1658 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001659 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001660 May be defined to allow interrupt polling
1661 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001662
Simon Glass9ab4ce22012-02-27 10:52:47 +00001663 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1664 txfilltuning field in the EHCI controller on reset.
1665
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001666 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1667 HW module registers.
1668
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001669- USB Device:
1670 Define the below if you wish to use the USB console.
1671 Once firmware is rebuilt from a serial console issue the
1672 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001673 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001674 it has found a new device. The environment variable usbtty
1675 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001676 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001677 Common Device Class Abstract Control Model serial device.
1678 If you select usbtty = gserial you should be able to enumerate
1679 a Linux host by
1680 # modprobe usbserial vendor=0xVendorID product=0xProductID
1681 else if using cdc_acm, simply setting the environment
1682 variable usbtty to be cdc_acm should suffice. The following
1683 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001684
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001685 CONFIG_USB_DEVICE
1686 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001687
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001688 CONFIG_USB_TTY
1689 Define this to have a tty type of device available to
1690 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001691
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301692 CONFIG_USBD_HS
1693 Define this to enable the high speed support for usb
1694 device and usbtty. If this feature is enabled, a routine
1695 int is_usbd_high_speed(void)
1696 also needs to be defined by the driver to dynamically poll
1697 whether the enumeration has succeded at high speed or full
1698 speed.
1699
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001700 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001701 Define this if you want stdin, stdout &/or stderr to
1702 be set to usbtty.
1703
1704 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001705 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001706 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001707 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001709 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001710 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001711 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001712
Wolfgang Denk386eda02006-06-14 18:14:56 +02001713 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001714 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001715 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001716 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1717 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1718 should pretend to be a Linux device to it's target host.
1719
1720 CONFIG_USBD_MANUFACTURER
1721 Define this string as the name of your company for
1722 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001723
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001724 CONFIG_USBD_PRODUCT_NAME
1725 Define this string as the name of your product
1726 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1727
1728 CONFIG_USBD_VENDORID
1729 Define this as your assigned Vendor ID from the USB
1730 Implementors Forum. This *must* be a genuine Vendor ID
1731 to avoid polluting the USB namespace.
1732 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001733
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001734 CONFIG_USBD_PRODUCTID
1735 Define this as the unique Product ID
1736 for your device
1737 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001738
Igor Grinbergd70a5602011-12-12 12:08:35 +02001739- ULPI Layer Support:
1740 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1741 the generic ULPI layer. The generic layer accesses the ULPI PHY
1742 via the platform viewport, so you need both the genric layer and
1743 the viewport enabled. Currently only Chipidea/ARC based
1744 viewport is supported.
1745 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1746 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001747 If your ULPI phy needs a different reference clock than the
1748 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1749 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001750
1751- MMC Support:
1752 The MMC controller on the Intel PXA is supported. To
1753 enable this define CONFIG_MMC. The MMC can be
1754 accessed from the boot prompt by mapping the device
1755 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001756 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1757 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001758
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001759 CONFIG_SH_MMCIF
1760 Support for Renesas on-chip MMCIF controller
1761
1762 CONFIG_SH_MMCIF_ADDR
1763 Define the base address of MMCIF registers
1764
1765 CONFIG_SH_MMCIF_CLK
1766 Define the clock frequency for MMCIF
1767
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001768 CONFIG_GENERIC_MMC
1769 Enable the generic MMC driver
1770
1771 CONFIG_SUPPORT_EMMC_BOOT
1772 Enable some additional features of the eMMC boot partitions.
1773
1774 CONFIG_SUPPORT_EMMC_RPMB
1775 Enable the commands for reading, writing and programming the
1776 key for the Replay Protection Memory Block partition in eMMC.
1777
Tom Rinib3ba6e92013-03-14 05:32:47 +00001778- USB Device Firmware Update (DFU) class support:
1779 CONFIG_DFU_FUNCTION
1780 This enables the USB portion of the DFU USB class
1781
1782 CONFIG_CMD_DFU
1783 This enables the command "dfu" which is used to have
1784 U-Boot create a DFU class device via USB. This command
1785 requires that the "dfu_alt_info" environment variable be
1786 set and define the alt settings to expose to the host.
1787
1788 CONFIG_DFU_MMC
1789 This enables support for exposing (e)MMC devices via DFU.
1790
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001791 CONFIG_DFU_NAND
1792 This enables support for exposing NAND devices via DFU.
1793
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301794 CONFIG_DFU_RAM
1795 This enables support for exposing RAM via DFU.
1796 Note: DFU spec refer to non-volatile memory usage, but
1797 allow usages beyond the scope of spec - here RAM usage,
1798 one that would help mostly the developer.
1799
Heiko Schochere7e75c72013-06-12 06:05:51 +02001800 CONFIG_SYS_DFU_DATA_BUF_SIZE
1801 Dfu transfer uses a buffer before writing data to the
1802 raw storage device. Make the size (in bytes) of this buffer
1803 configurable. The size of this buffer is also configurable
1804 through the "dfu_bufsiz" environment variable.
1805
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001806 CONFIG_SYS_DFU_MAX_FILE_SIZE
1807 When updating files rather than the raw storage device,
1808 we use a static buffer to copy the file into and then write
1809 the buffer once we've been given the whole file. Define
1810 this to the maximum filesize (in bytes) for the buffer.
1811 Default is 4 MiB if undefined.
1812
Heiko Schocher001a8312014-03-18 08:09:56 +01001813 DFU_DEFAULT_POLL_TIMEOUT
1814 Poll timeout [ms], is the timeout a device can send to the
1815 host. The host must wait for this timeout before sending
1816 a subsequent DFU_GET_STATUS request to the device.
1817
1818 DFU_MANIFEST_POLL_TIMEOUT
1819 Poll timeout [ms], which the device sends to the host when
1820 entering dfuMANIFEST state. Host waits this timeout, before
1821 sending again an USB request to the device.
1822
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001823- USB Device Android Fastboot support:
1824 CONFIG_CMD_FASTBOOT
1825 This enables the command "fastboot" which enables the Android
1826 fastboot mode for the platform's USB device. Fastboot is a USB
1827 protocol for downloading images, flashing and device control
1828 used on Android devices.
1829 See doc/README.android-fastboot for more information.
1830
1831 CONFIG_ANDROID_BOOT_IMAGE
1832 This enables support for booting images which use the Android
1833 image format header.
1834
1835 CONFIG_USB_FASTBOOT_BUF_ADDR
1836 The fastboot protocol requires a large memory buffer for
1837 downloads. Define this to the starting RAM address to use for
1838 downloaded images.
1839
1840 CONFIG_USB_FASTBOOT_BUF_SIZE
1841 The fastboot protocol requires a large memory buffer for
1842 downloads. This buffer should be as large as possible for a
1843 platform. Define this to the size available RAM for fastboot.
1844
Steve Raed1b5ed02014-08-26 11:47:28 -07001845 CONFIG_FASTBOOT_FLASH
1846 The fastboot protocol includes a "flash" command for writing
1847 the downloaded image to a non-volatile storage device. Define
1848 this to enable the "fastboot flash" command.
1849
1850 CONFIG_FASTBOOT_FLASH_MMC_DEV
1851 The fastboot "flash" command requires additional information
1852 regarding the non-volatile storage device. Define this to
1853 the eMMC device that fastboot should use to store the image.
1854
Steve Rae0ff7e582014-12-12 15:51:54 -08001855 CONFIG_FASTBOOT_GPT_NAME
1856 The fastboot "flash" command supports writing the downloaded
1857 image to the Protective MBR and the Primary GUID Partition
1858 Table. (Additionally, this downloaded image is post-processed
1859 to generate and write the Backup GUID Partition Table.)
1860 This occurs when the specified "partition name" on the
1861 "fastboot flash" command line matches this value.
1862 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1863
wdenk6705d812004-08-02 23:22:59 +00001864- Journaling Flash filesystem support:
1865 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1866 CONFIG_JFFS2_NAND_DEV
1867 Define these for a default partition on a NAND device
1868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001869 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1870 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001871 Define these for a default partition on a NOR device
1872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001873 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001874 Define this to create an own partition. You have to provide a
1875 function struct part_info* jffs2_part_info(int part_num)
1876
1877 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001878 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001879 to disable the command chpart. This is the default when you
1880 have not defined a custom partition
1881
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001882- FAT(File Allocation Table) filesystem write function support:
1883 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001884
1885 Define this to enable support for saving memory data as a
1886 file in FAT formatted partition.
1887
1888 This will also enable the command "fatwrite" enabling the
1889 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001890
Gabe Black84cd9322012-10-12 14:26:11 +00001891CBFS (Coreboot Filesystem) support
1892 CONFIG_CMD_CBFS
1893
1894 Define this to enable support for reading from a Coreboot
1895 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1896 and cbfsload.
1897
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301898- FAT(File Allocation Table) filesystem cluster size:
1899 CONFIG_FS_FAT_MAX_CLUSTSIZE
1900
1901 Define the max cluster size for fat operations else
1902 a default value of 65536 will be defined.
1903
wdenkc6097192002-11-03 00:24:07 +00001904- Keyboard Support:
1905 CONFIG_ISA_KEYBOARD
1906
1907 Define this to enable standard (PC-Style) keyboard
1908 support
1909
1910 CONFIG_I8042_KBD
1911 Standard PC keyboard driver with US (is default) and
1912 GERMAN key layout (switch via environment 'keymap=de') support.
1913 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1914 for cfb_console. Supports cursor blinking.
1915
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001916 CONFIG_CROS_EC_KEYB
1917 Enables a Chrome OS keyboard using the CROS_EC interface.
1918 This uses CROS_EC to communicate with a second microcontroller
1919 which provides key scans on request.
1920
wdenkc6097192002-11-03 00:24:07 +00001921- Video support:
1922 CONFIG_VIDEO
1923
1924 Define this to enable video support (for output to
1925 video).
1926
1927 CONFIG_VIDEO_CT69000
1928
1929 Enable Chips & Technologies 69000 Video chip
1930
1931 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001932 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001933 video output is selected via environment 'videoout'
1934 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1935 assumed.
wdenkc6097192002-11-03 00:24:07 +00001936
wdenkb79a11c2004-03-25 15:14:43 +00001937 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001938 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001939 are possible:
1940 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001941 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001942
1943 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1944 -------------+---------------------------------------------
1945 8 bits | 0x301* 0x303 0x305 0x161 0x307
1946 15 bits | 0x310 0x313 0x316 0x162 0x319
1947 16 bits | 0x311 0x314 0x317 0x163 0x31A
1948 24 bits | 0x312 0x315 0x318 ? 0x31B
1949 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001950 (i.e. setenv videomode 317; saveenv; reset;)
1951
wdenkb79a11c2004-03-25 15:14:43 +00001952 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001953 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001954
1955
stroesec1551ea2003-04-04 15:53:41 +00001956 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001957 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001958 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1959 or CONFIG_VIDEO_SED13806_16BPP
1960
Timur Tabi7d3053f2011-02-15 17:09:19 -06001961 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001962 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001963 SOCs that have a DIU should define this macro to enable DIU
1964 support, and should also define these other macros:
1965
1966 CONFIG_SYS_DIU_ADDR
1967 CONFIG_VIDEO
1968 CONFIG_CMD_BMP
1969 CONFIG_CFB_CONSOLE
1970 CONFIG_VIDEO_SW_CURSOR
1971 CONFIG_VGA_AS_SINGLE_DEVICE
1972 CONFIG_VIDEO_LOGO
1973 CONFIG_VIDEO_BMP_LOGO
1974
Timur Tabiba8e76b2011-04-11 14:18:22 -05001975 The DIU driver will look for the 'video-mode' environment
1976 variable, and if defined, enable the DIU as a console during
1977 boot. See the documentation file README.video for a
1978 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001979
Simon Glass058d59b2012-12-03 13:59:47 +00001980 CONFIG_VIDEO_VGA
1981
1982 Enable the VGA video / BIOS for x86. The alternative if you
1983 are using coreboot is to use the coreboot frame buffer
1984 driver.
1985
1986
wdenk682011f2003-06-03 23:54:09 +00001987- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001988 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001989
wdenk8bde7f72003-06-27 21:31:46 +00001990 Define this to enable a custom keyboard support.
1991 This simply calls drv_keyboard_init() which must be
1992 defined in your board-specific files.
1993 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001994
wdenkc6097192002-11-03 00:24:07 +00001995- LCD Support: CONFIG_LCD
1996
1997 Define this to enable LCD support (for output to LCD
1998 display); also select one of the supported displays
1999 by defining one of these:
2000
Stelian Pop39cf4802008-05-09 21:57:18 +02002001 CONFIG_ATMEL_LCD:
2002
2003 HITACHI TX09D70VM1CCA, 3.5", 240x320.
2004
wdenkfd3103b2003-11-25 16:55:19 +00002005 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00002006
wdenkfd3103b2003-11-25 16:55:19 +00002007 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00002008
wdenkfd3103b2003-11-25 16:55:19 +00002009 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00002010
wdenkfd3103b2003-11-25 16:55:19 +00002011 NEC NL6448BC20-08. 6.5", 640x480.
2012 Active, color, single scan.
2013
2014 CONFIG_NEC_NL6448BC33_54
2015
2016 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00002017 Active, color, single scan.
2018
2019 CONFIG_SHARP_16x9
2020
2021 Sharp 320x240. Active, color, single scan.
2022 It isn't 16x9, and I am not sure what it is.
2023
2024 CONFIG_SHARP_LQ64D341
2025
2026 Sharp LQ64D341 display, 640x480.
2027 Active, color, single scan.
2028
2029 CONFIG_HLD1045
2030
2031 HLD1045 display, 640x480.
2032 Active, color, single scan.
2033
2034 CONFIG_OPTREX_BW
2035
2036 Optrex CBL50840-2 NF-FW 99 22 M5
2037 or
2038 Hitachi LMG6912RPFC-00T
2039 or
2040 Hitachi SP14Q002
2041
2042 320x240. Black & white.
2043
2044 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002045 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00002046
Simon Glass676d3192012-10-17 13:24:54 +00002047 CONFIG_LCD_ALIGNMENT
2048
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002049 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00002050 defined then the LCD will be aligned to this value instead.
2051 For ARM it is sometimes useful to use MMU_SECTION_SIZE
2052 here, since it is cheaper to change data cache settings on
2053 a per-section basis.
2054
Simon Glass0d89efe2012-10-17 13:24:59 +00002055 CONFIG_CONSOLE_SCROLL_LINES
2056
2057 When the console need to be scrolled, this is the number of
2058 lines to scroll by. It defaults to 1. Increasing this makes
2059 the console jump but can help speed up operation when scrolling
2060 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00002061
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00002062 CONFIG_LCD_BMP_RLE8
2063
2064 Support drawing of RLE8-compressed bitmaps on the LCD.
2065
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00002066 CONFIG_I2C_EDID
2067
2068 Enables an 'i2c edid' command which can read EDID
2069 information over I2C from an attached LCD display.
2070
wdenk7152b1d2003-09-05 23:19:14 +00002071- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00002072
wdenk8bde7f72003-06-27 21:31:46 +00002073 If this option is set, the environment is checked for
2074 a variable "splashimage". If found, the usual display
2075 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00002076 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00002077 specified in "splashimage" is loaded instead. The
2078 console is redirected to the "nulldev", too. This
2079 allows for a "silent" boot where a splash screen is
2080 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00002081
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002082 CONFIG_SPLASHIMAGE_GUARD
2083
2084 If this option is set, then U-Boot will prevent the environment
2085 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05002086 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002087 This option is useful for targets where, due to alignment
2088 restrictions, an improperly aligned BMP image will cause a data
2089 abort. If you think you will not have problems with unaligned
2090 accesses (for example because your toolchain prevents them)
2091 there is no need to set this option.
2092
Matthias Weisser1ca298c2009-07-09 16:07:30 +02002093 CONFIG_SPLASH_SCREEN_ALIGN
2094
2095 If this option is set the splash image can be freely positioned
2096 on the screen. Environment variable "splashpos" specifies the
2097 position as "x,y". If a positive number is given it is used as
2098 number of pixel from left/top. If a negative number is given it
2099 is used as number of pixel from right/bottom. You can also
2100 specify 'm' for centering the image.
2101
2102 Example:
2103 setenv splashpos m,m
2104 => image at center of screen
2105
2106 setenv splashpos 30,20
2107 => image at x = 30 and y = 20
2108
2109 setenv splashpos -10,m
2110 => vertically centered image
2111 at x = dspWidth - bmpWidth - 9
2112
Stefan Roese98f4a3d2005-09-22 09:04:17 +02002113- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2114
2115 If this option is set, additionally to standard BMP
2116 images, gzipped BMP images can be displayed via the
2117 splashscreen support or the bmp command.
2118
Anatolij Gustschind5011762010-03-15 14:50:25 +01002119- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2120
2121 If this option is set, 8-bit RLE compressed BMP images
2122 can be displayed via the splashscreen support or the
2123 bmp command.
2124
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002125- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00002126 CONFIG_CMD_ZIP
2127
2128 If this option is set, it would use zlib deflate method
2129 to compress the specified memory at its best effort.
2130
wdenkc29fdfc2003-08-29 20:57:53 +00002131- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002132 CONFIG_GZIP
2133
2134 Enabled by default to support gzip compressed images.
2135
wdenkc29fdfc2003-08-29 20:57:53 +00002136 CONFIG_BZIP2
2137
2138 If this option is set, support for bzip2 compressed
2139 images is included. If not, only uncompressed and gzip
2140 compressed images are supported.
2141
wdenk42d1f032003-10-15 23:53:47 +00002142 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002143 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002144 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002145
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002146 CONFIG_LZMA
2147
2148 If this option is set, support for lzma compressed
2149 images is included.
2150
2151 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2152 requires an amount of dynamic memory that is given by the
2153 formula:
2154
2155 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2156
2157 Where lc and lp stand for, respectively, Literal context bits
2158 and Literal pos bits.
2159
2160 This value is upper-bounded by 14MB in the worst case. Anyway,
2161 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2162 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2163 a very small buffer.
2164
2165 Use the lzmainfo tool to determinate the lc and lp values and
2166 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002167 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002168
Kees Cook8ef70472013-08-16 07:59:12 -07002169 CONFIG_LZO
2170
2171 If this option is set, support for LZO compressed images
2172 is included.
2173
wdenk17ea1172004-06-06 21:51:03 +00002174- MII/PHY support:
2175 CONFIG_PHY_ADDR
2176
2177 The address of PHY on MII bus.
2178
2179 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2180
2181 The clock frequency of the MII bus
2182
2183 CONFIG_PHY_GIGE
2184
2185 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002186 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002187
2188 CONFIG_PHY_RESET_DELAY
2189
2190 Some PHY like Intel LXT971A need extra delay after
2191 reset before any MII register access is possible.
2192 For such PHY, set this option to the usec delay
2193 required. (minimum 300usec for LXT971A)
2194
2195 CONFIG_PHY_CMD_DELAY (ppc4xx)
2196
2197 Some PHY like Intel LXT971A need extra delay after
2198 command issued before MII status register can be read
2199
wdenkc6097192002-11-03 00:24:07 +00002200- Ethernet address:
2201 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002202 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002203 CONFIG_ETH2ADDR
2204 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002205 CONFIG_ETH4ADDR
2206 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002207
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002208 Define a default value for Ethernet address to use
2209 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002210 is not determined automatically.
2211
2212- IP address:
2213 CONFIG_IPADDR
2214
2215 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002216 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002217 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002218 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002219
2220- Server IP address:
2221 CONFIG_SERVERIP
2222
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002223 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002224 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002225 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002226
Robin Getz97cfe862009-07-21 12:15:28 -04002227 CONFIG_KEEP_SERVERADDR
2228
2229 Keeps the server's MAC address, in the env 'serveraddr'
2230 for passing to bootargs (like Linux's netconsole option)
2231
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002232- Gateway IP address:
2233 CONFIG_GATEWAYIP
2234
2235 Defines a default value for the IP address of the
2236 default router where packets to other networks are
2237 sent to.
2238 (Environment variable "gatewayip")
2239
2240- Subnet mask:
2241 CONFIG_NETMASK
2242
2243 Defines a default value for the subnet mask (or
2244 routing prefix) which is used to determine if an IP
2245 address belongs to the local subnet or needs to be
2246 forwarded through a router.
2247 (Environment variable "netmask")
2248
David Updegraff53a5c422007-06-11 10:41:07 -05002249- Multicast TFTP Mode:
2250 CONFIG_MCAST_TFTP
2251
2252 Defines whether you want to support multicast TFTP as per
2253 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002254 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002255 driver in use must provide a function: mcast() to join/leave a
2256 multicast group.
2257
wdenkc6097192002-11-03 00:24:07 +00002258- BOOTP Recovery Mode:
2259 CONFIG_BOOTP_RANDOM_DELAY
2260
2261 If you have many targets in a network that try to
2262 boot using BOOTP, you may want to avoid that all
2263 systems send out BOOTP requests at precisely the same
2264 moment (which would happen for instance at recovery
2265 from a power failure, when all systems will try to
2266 boot, thus flooding the BOOTP server. Defining
2267 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2268 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002269 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002270
2271 1st BOOTP request: delay 0 ... 1 sec
2272 2nd BOOTP request: delay 0 ... 2 sec
2273 3rd BOOTP request: delay 0 ... 4 sec
2274 4th and following
2275 BOOTP requests: delay 0 ... 8 sec
2276
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002277 CONFIG_BOOTP_ID_CACHE_SIZE
2278
2279 BOOTP packets are uniquely identified using a 32-bit ID. The
2280 server will copy the ID from client requests to responses and
2281 U-Boot will use this to determine if it is the destination of
2282 an incoming response. Some servers will check that addresses
2283 aren't in use before handing them out (usually using an ARP
2284 ping) and therefore take up to a few hundred milliseconds to
2285 respond. Network congestion may also influence the time it
2286 takes for a response to make it back to the client. If that
2287 time is too long, U-Boot will retransmit requests. In order
2288 to allow earlier responses to still be accepted after these
2289 retransmissions, U-Boot's BOOTP client keeps a small cache of
2290 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2291 cache. The default is to keep IDs for up to four outstanding
2292 requests. Increasing this will allow U-Boot to accept offers
2293 from a BOOTP client in networks with unusually high latency.
2294
stroesefe389a82003-08-28 14:17:32 +00002295- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002296 You can fine tune the DHCP functionality by defining
2297 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002298
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002299 CONFIG_BOOTP_SUBNETMASK
2300 CONFIG_BOOTP_GATEWAY
2301 CONFIG_BOOTP_HOSTNAME
2302 CONFIG_BOOTP_NISDOMAIN
2303 CONFIG_BOOTP_BOOTPATH
2304 CONFIG_BOOTP_BOOTFILESIZE
2305 CONFIG_BOOTP_DNS
2306 CONFIG_BOOTP_DNS2
2307 CONFIG_BOOTP_SEND_HOSTNAME
2308 CONFIG_BOOTP_NTPSERVER
2309 CONFIG_BOOTP_TIMEOFFSET
2310 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002311 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002312
Wilson Callan5d110f02007-07-28 10:56:13 -04002313 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2314 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002315
Joe Hershberger2c00e092012-05-23 07:59:19 +00002316 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2317 after the configured retry count, the call will fail
2318 instead of starting over. This can be used to fail over
2319 to Link-local IP address configuration if the DHCP server
2320 is not available.
2321
stroesefe389a82003-08-28 14:17:32 +00002322 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2323 serverip from a DHCP server, it is possible that more
2324 than one DNS serverip is offered to the client.
2325 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2326 serverip will be stored in the additional environment
2327 variable "dnsip2". The first DNS serverip is always
2328 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002329 is defined.
stroesefe389a82003-08-28 14:17:32 +00002330
2331 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2332 to do a dynamic update of a DNS server. To do this, they
2333 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002334 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002335 of the "hostname" environment variable is passed as
2336 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002337
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002338 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2339
2340 A 32bit value in microseconds for a delay between
2341 receiving a "DHCP Offer" and sending the "DHCP Request".
2342 This fixes a problem with certain DHCP servers that don't
2343 respond 100% of the time to a "DHCP request". E.g. On an
2344 AT91RM9200 processor running at 180MHz, this delay needed
2345 to be *at least* 15,000 usec before a Windows Server 2003
2346 DHCP server would reply 100% of the time. I recommend at
2347 least 50,000 usec to be safe. The alternative is to hope
2348 that one of the retries will be successful but note that
2349 the DHCP timeout and retry process takes a longer than
2350 this delay.
2351
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002352 - Link-local IP address negotiation:
2353 Negotiate with other link-local clients on the local network
2354 for an address that doesn't require explicit configuration.
2355 This is especially useful if a DHCP server cannot be guaranteed
2356 to exist in all environments that the device must operate.
2357
2358 See doc/README.link-local for more information.
2359
wdenka3d991b2004-04-15 21:48:45 +00002360 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002361 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002362
2363 The device id used in CDP trigger frames.
2364
2365 CONFIG_CDP_DEVICE_ID_PREFIX
2366
2367 A two character string which is prefixed to the MAC address
2368 of the device.
2369
2370 CONFIG_CDP_PORT_ID
2371
2372 A printf format string which contains the ascii name of
2373 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002374 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002375
2376 CONFIG_CDP_CAPABILITIES
2377
2378 A 32bit integer which indicates the device capabilities;
2379 0x00000010 for a normal host which does not forwards.
2380
2381 CONFIG_CDP_VERSION
2382
2383 An ascii string containing the version of the software.
2384
2385 CONFIG_CDP_PLATFORM
2386
2387 An ascii string containing the name of the platform.
2388
2389 CONFIG_CDP_TRIGGER
2390
2391 A 32bit integer sent on the trigger.
2392
2393 CONFIG_CDP_POWER_CONSUMPTION
2394
2395 A 16bit integer containing the power consumption of the
2396 device in .1 of milliwatts.
2397
2398 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2399
2400 A byte containing the id of the VLAN.
2401
wdenkc6097192002-11-03 00:24:07 +00002402- Status LED: CONFIG_STATUS_LED
2403
2404 Several configurations allow to display the current
2405 status using a LED. For instance, the LED will blink
2406 fast while running U-Boot code, stop blinking as
2407 soon as a reply to a BOOTP request was received, and
2408 start blinking slow once the Linux kernel is running
2409 (supported by a status LED driver in the Linux
2410 kernel). Defining CONFIG_STATUS_LED enables this
2411 feature in U-Boot.
2412
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002413 Additional options:
2414
2415 CONFIG_GPIO_LED
2416 The status LED can be connected to a GPIO pin.
2417 In such cases, the gpio_led driver can be used as a
2418 status LED backend implementation. Define CONFIG_GPIO_LED
2419 to include the gpio_led driver in the U-Boot binary.
2420
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002421 CONFIG_GPIO_LED_INVERTED_TABLE
2422 Some GPIO connected LEDs may have inverted polarity in which
2423 case the GPIO high value corresponds to LED off state and
2424 GPIO low value corresponds to LED on state.
2425 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2426 with a list of GPIO LEDs that have inverted polarity.
2427
wdenkc6097192002-11-03 00:24:07 +00002428- CAN Support: CONFIG_CAN_DRIVER
2429
2430 Defining CONFIG_CAN_DRIVER enables CAN driver support
2431 on those systems that support this (optional)
2432 feature, like the TQM8xxL modules.
2433
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002434- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002435
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002436 This enable the NEW i2c subsystem, and will allow you to use
2437 i2c commands at the u-boot command line (as long as you set
2438 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2439 based realtime clock chips or other i2c devices. See
2440 common/cmd_i2c.c for a description of the command line
2441 interface.
2442
2443 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002444 - drivers/i2c/soft_i2c.c:
2445 - activate first bus with CONFIG_SYS_I2C_SOFT define
2446 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2447 for defining speed and slave address
2448 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2449 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2450 for defining speed and slave address
2451 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2452 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2453 for defining speed and slave address
2454 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2455 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2456 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002457
Heiko Schocher00f792e2012-10-24 13:48:22 +02002458 - drivers/i2c/fsl_i2c.c:
2459 - activate i2c driver with CONFIG_SYS_I2C_FSL
2460 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2461 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2462 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2463 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002464 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002465 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2466 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2467 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2468 second bus.
2469
Simon Glass1f2ba722012-10-30 07:28:53 +00002470 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002471 - activate this driver with CONFIG_SYS_I2C_TEGRA
2472 - This driver adds 4 i2c buses with a fix speed from
2473 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002474
Dirk Eibach880540d2013-04-25 02:40:01 +00002475 - drivers/i2c/ppc4xx_i2c.c
2476 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2477 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2478 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2479
tremfac96402013-09-21 18:13:35 +02002480 - drivers/i2c/i2c_mxc.c
2481 - activate this driver with CONFIG_SYS_I2C_MXC
2482 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2483 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2484 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2485 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2486 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2487 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002488 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002489 for speed, and 0 for slave.
2490
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002491 - drivers/i2c/rcar_i2c.c:
2492 - activate this driver with CONFIG_SYS_I2C_RCAR
2493 - This driver adds 4 i2c buses
2494
2495 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2496 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2497 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2498 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2499 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2500 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2501 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2502 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2503 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2504
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002505 - drivers/i2c/sh_i2c.c:
2506 - activate this driver with CONFIG_SYS_I2C_SH
2507 - This driver adds from 2 to 5 i2c buses
2508
2509 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2510 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2511 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2512 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2513 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2514 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2515 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2516 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2517 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2518 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2519 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2520 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002521 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002522
Heiko Schocher6789e842013-10-22 11:03:18 +02002523 - drivers/i2c/omap24xx_i2c.c
2524 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2525 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2526 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2527 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2528 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2529 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2530 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2531 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2532 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2533 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2534 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2535
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002536 - drivers/i2c/zynq_i2c.c
2537 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2538 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2539 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2540
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302541 - drivers/i2c/s3c24x0_i2c.c:
2542 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2543 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2544 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2545 with a fix speed from 100000 and the slave addr 0!
2546
Dirk Eibachb46226b2014-07-03 09:28:18 +02002547 - drivers/i2c/ihs_i2c.c
2548 - activate this driver with CONFIG_SYS_I2C_IHS
2549 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2550 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2551 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2552 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2553 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2554 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2555 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2556 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2557 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2558 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2559 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2560 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2561
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002562 additional defines:
2563
2564 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002565 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002566 don't use/have i2c muxes on your i2c bus, this
2567 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2568 omit this define.
2569
2570 CONFIG_SYS_I2C_DIRECT_BUS
2571 define this, if you don't use i2c muxes on your hardware.
2572 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2573 omit this define.
2574
2575 CONFIG_SYS_I2C_MAX_HOPS
2576 define how many muxes are maximal consecutively connected
2577 on one i2c bus. If you not use i2c muxes, omit this
2578 define.
2579
2580 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002581 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002582 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2583 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2584 CONFIG_SYS_NUM_I2C_BUSES = 9:
2585
2586 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2587 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2588 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2589 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2590 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2591 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2592 {1, {I2C_NULL_HOP}}, \
2593 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2594 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2595 }
2596
2597 which defines
2598 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002599 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2600 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2601 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2602 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2603 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002604 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002605 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2606 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002607
2608 If you do not have i2c muxes on your board, omit this define.
2609
Heiko Schocherea818db2013-01-29 08:53:15 +01002610- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002611
2612 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2613 provides the following compelling advantages:
2614
2615 - more than one i2c adapter is usable
2616 - approved multibus support
2617 - better i2c mux support
2618
2619 ** Please consider updating your I2C driver now. **
2620
Heiko Schocherea818db2013-01-29 08:53:15 +01002621 These enable legacy I2C serial bus commands. Defining
2622 CONFIG_HARD_I2C will include the appropriate I2C driver
2623 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002624
wdenk945af8d2003-07-16 21:53:01 +00002625 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002626 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002627 CONFIG_COMMANDS) and communicate with i2c based realtime
2628 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002629 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002630
Ben Warrenbb99ad62006-09-07 16:50:54 -04002631 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk945af8d2003-07-16 21:53:01 +00002633 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002634 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002635
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002636 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002637 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002638 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002639 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002640
Peter Tyser8d321b82010-04-12 22:28:21 -05002641 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002642 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002643 and so its address should therefore be cleared to 0 (See,
2644 eg, MPC823e User's Manual p.16-473). So, set
2645 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002646
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002647 CONFIG_SYS_I2C_INIT_MPC5XXX
2648
2649 When a board is reset during an i2c bus transfer
2650 chips might think that the current transfer is still
2651 in progress. Reset the slave devices by sending start
2652 commands until the slave device responds.
2653
wdenk945af8d2003-07-16 21:53:01 +00002654 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002655
Heiko Schocherea818db2013-01-29 08:53:15 +01002656 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002657 then the following macros need to be defined (examples are
2658 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002659
2660 I2C_INIT
2661
wdenkb37c7e52003-06-30 16:24:52 +00002662 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002663 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002664
wdenkba56f622004-02-06 23:19:44 +00002665 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002666
wdenkc6097192002-11-03 00:24:07 +00002667 I2C_PORT
2668
wdenk43d96162003-03-06 00:02:04 +00002669 (Only for MPC8260 CPU). The I/O port to use (the code
2670 assumes both bits are on the same port). Valid values
2671 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002672
2673 I2C_ACTIVE
2674
2675 The code necessary to make the I2C data line active
2676 (driven). If the data line is open collector, this
2677 define can be null.
2678
wdenkb37c7e52003-06-30 16:24:52 +00002679 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2680
wdenkc6097192002-11-03 00:24:07 +00002681 I2C_TRISTATE
2682
2683 The code necessary to make the I2C data line tri-stated
2684 (inactive). If the data line is open collector, this
2685 define can be null.
2686
wdenkb37c7e52003-06-30 16:24:52 +00002687 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2688
wdenkc6097192002-11-03 00:24:07 +00002689 I2C_READ
2690
York Sun472d5462013-04-01 11:29:11 -07002691 Code that returns true if the I2C data line is high,
2692 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002693
wdenkb37c7e52003-06-30 16:24:52 +00002694 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2695
wdenkc6097192002-11-03 00:24:07 +00002696 I2C_SDA(bit)
2697
York Sun472d5462013-04-01 11:29:11 -07002698 If <bit> is true, sets the I2C data line high. If it
2699 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002700
wdenkb37c7e52003-06-30 16:24:52 +00002701 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002702 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002703 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002704
wdenkc6097192002-11-03 00:24:07 +00002705 I2C_SCL(bit)
2706
York Sun472d5462013-04-01 11:29:11 -07002707 If <bit> is true, sets the I2C clock line high. If it
2708 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002709
wdenkb37c7e52003-06-30 16:24:52 +00002710 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002711 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002712 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002713
wdenkc6097192002-11-03 00:24:07 +00002714 I2C_DELAY
2715
2716 This delay is invoked four times per clock cycle so this
2717 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002718 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002719 like:
2720
wdenkb37c7e52003-06-30 16:24:52 +00002721 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002722
Mike Frysinger793b5722010-07-21 13:38:02 -04002723 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2724
2725 If your arch supports the generic GPIO framework (asm/gpio.h),
2726 then you may alternatively define the two GPIOs that are to be
2727 used as SCL / SDA. Any of the previous I2C_xxx macros will
2728 have GPIO-based defaults assigned to them as appropriate.
2729
2730 You should define these to the GPIO value as given directly to
2731 the generic GPIO functions.
2732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002734
wdenk8bde7f72003-06-27 21:31:46 +00002735 When a board is reset during an i2c bus transfer
2736 chips might think that the current transfer is still
2737 in progress. On some boards it is possible to access
2738 the i2c SCLK line directly, either by using the
2739 processor pin as a GPIO or by having a second pin
2740 connected to the bus. If this option is defined a
2741 custom i2c_init_board() routine in boards/xxx/board.c
2742 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002743
Richard Retanubun26a33502010-04-12 15:08:17 -04002744 CONFIG_SYS_I2C_BOARD_LATE_INIT
2745
2746 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2747 defined a custom i2c_board_late_init() routine in
2748 boards/xxx/board.c is run AFTER the operations in i2c_init()
2749 is completed. This callpoint can be used to unreset i2c bus
2750 using CPU i2c controller register accesses for CPUs whose i2c
2751 controller provide such a method. It is called at the end of
2752 i2c_init() to allow i2c_init operations to setup the i2c bus
2753 controller on the CPU (e.g. setting bus speed & slave address).
2754
wdenk17ea1172004-06-06 21:51:03 +00002755 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2756
2757 This option enables configuration of bi_iic_fast[] flags
2758 in u-boot bd_info structure based on u-boot environment
2759 variable "i2cfast". (see also i2cfast)
2760
Ben Warrenbb99ad62006-09-07 16:50:54 -04002761 CONFIG_I2C_MULTI_BUS
2762
2763 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002764 must have a controller. At any point in time, only one bus is
2765 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002766 Note that bus numbering is zero-based.
2767
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002768 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002769
2770 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002771 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002772 is set, specify a list of bus-device pairs. Otherwise, specify
2773 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002774
2775 e.g.
2776 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002777 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002778
2779 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2780
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002781 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002782 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002783
2784 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002786 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002787
2788 If defined, then this indicates the I2C bus number for DDR SPD.
2789 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002791 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002792
2793 If defined, then this indicates the I2C bus number for the RTC.
2794 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002796 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002797
2798 If defined, then this indicates the I2C bus number for the DTT.
2799 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002801 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002802
2803 If defined, specifies the I2C address of the DTT device.
2804 If not defined, then U-Boot uses predefined value for
2805 specified DTT device.
2806
Andrew Dyer2ac69852008-12-29 17:36:01 -06002807 CONFIG_SOFT_I2C_READ_REPEATED_START
2808
2809 defining this will force the i2c_read() function in
2810 the soft_i2c driver to perform an I2C repeated start
2811 between writing the address pointer and reading the
2812 data. If this define is omitted the default behaviour
2813 of doing a stop-start sequence will be used. Most I2C
2814 devices can use either method, but some require one or
2815 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002816
wdenkc6097192002-11-03 00:24:07 +00002817- SPI Support: CONFIG_SPI
2818
2819 Enables SPI driver (so far only tested with
2820 SPI EEPROM, also an instance works with Crystal A/D and
2821 D/As on the SACSng board)
2822
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002823 CONFIG_SH_SPI
2824
2825 Enables the driver for SPI controller on SuperH. Currently
2826 only SH7757 is supported.
2827
wdenkc6097192002-11-03 00:24:07 +00002828 CONFIG_SPI_X
2829
2830 Enables extended (16-bit) SPI EEPROM addressing.
2831 (symmetrical to CONFIG_I2C_X)
2832
2833 CONFIG_SOFT_SPI
2834
wdenk43d96162003-03-06 00:02:04 +00002835 Enables a software (bit-bang) SPI driver rather than
2836 using hardware support. This is a general purpose
2837 driver that only requires three general I/O port pins
2838 (two outputs, one input) to function. If this is
2839 defined, the board configuration must define several
2840 SPI configuration items (port pins to use, etc). For
2841 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002842
Ben Warren04a9e112008-01-16 22:37:35 -05002843 CONFIG_HARD_SPI
2844
2845 Enables a hardware SPI driver for general-purpose reads
2846 and writes. As with CONFIG_SOFT_SPI, the board configuration
2847 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002848 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002849 example, see include/configs/mpc8349emds.h.
2850
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002851 CONFIG_MXC_SPI
2852
2853 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002854 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002855
Heiko Schocherf659b572014-07-14 10:22:11 +02002856 CONFIG_SYS_SPI_MXC_WAIT
2857 Timeout for waiting until spi transfer completed.
2858 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2859
Matthias Fuchs01335022007-12-27 17:12:34 +01002860- FPGA Support: CONFIG_FPGA
2861
2862 Enables FPGA subsystem.
2863
2864 CONFIG_FPGA_<vendor>
2865
2866 Enables support for specific chip vendors.
2867 (ALTERA, XILINX)
2868
2869 CONFIG_FPGA_<family>
2870
2871 Enables support for FPGA family.
2872 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2873
2874 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002875
wdenk43d96162003-03-06 00:02:04 +00002876 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002877
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302878 CONFIG_CMD_FPGA_LOADMK
2879
2880 Enable support for fpga loadmk command
2881
Michal Simek67193862014-05-02 13:43:39 +02002882 CONFIG_CMD_FPGA_LOADP
2883
2884 Enable support for fpga loadp command - load partial bitstream
2885
2886 CONFIG_CMD_FPGA_LOADBP
2887
2888 Enable support for fpga loadbp command - load partial bitstream
2889 (Xilinx only)
2890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002891 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002892
wdenk8bde7f72003-06-27 21:31:46 +00002893 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002894
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002895 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002896
wdenk43d96162003-03-06 00:02:04 +00002897 Enable checks on FPGA configuration interface busy
2898 status by the configuration function. This option
2899 will require a board or device specific function to
2900 be written.
wdenkc6097192002-11-03 00:24:07 +00002901
2902 CONFIG_FPGA_DELAY
2903
2904 If defined, a function that provides delays in the FPGA
2905 configuration driver.
2906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002907 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002908 Allow Control-C to interrupt FPGA configuration
2909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002910 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002911
wdenk43d96162003-03-06 00:02:04 +00002912 Check for configuration errors during FPGA bitfile
2913 loading. For example, abort during Virtex II
2914 configuration if the INIT_B line goes low (which
2915 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002917 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002918
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002919 Maximum time to wait for the INIT_B line to de-assert
2920 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002921 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002922 ms.
wdenkc6097192002-11-03 00:24:07 +00002923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002924 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002925
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002926 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002927 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002928
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002929 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002930
wdenk43d96162003-03-06 00:02:04 +00002931 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002932 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002933
2934- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002935 CONFIG_BUILD_TARGET
2936
2937 Some SoCs need special image types (e.g. U-Boot binary
2938 with a special header) as build targets. By defining
2939 CONFIG_BUILD_TARGET in the SoC / board header, this
2940 special image will be automatically built upon calling
2941 make / MAKEALL.
2942
wdenkc6097192002-11-03 00:24:07 +00002943 CONFIG_IDENT_STRING
2944
wdenk43d96162003-03-06 00:02:04 +00002945 If defined, this string will be added to the U-Boot
2946 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002947
2948- Vendor Parameter Protection:
2949
wdenk43d96162003-03-06 00:02:04 +00002950 U-Boot considers the values of the environment
2951 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002952 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002953 are set once by the board vendor / manufacturer, and
2954 protects these variables from casual modification by
2955 the user. Once set, these variables are read-only,
2956 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002957 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002958
2959 If CONFIG_ENV_OVERWRITE is #defined in your config
2960 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002961 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002962 these parameters.
2963
2964 Alternatively, if you #define _both_ CONFIG_ETHADDR
2965 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002966 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002967 which can be changed exactly ONCE by the user. [The
2968 serial# is unaffected by this, i. e. it remains
2969 read-only.]
2970
Joe Hershberger25980902012-12-11 22:16:31 -06002971 The same can be accomplished in a more flexible way
2972 for any variable by configuring the type of access
2973 to allow for those variables in the ".flags" variable
2974 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2975
wdenkc6097192002-11-03 00:24:07 +00002976- Protected RAM:
2977 CONFIG_PRAM
2978
2979 Define this variable to enable the reservation of
2980 "protected RAM", i. e. RAM which is not overwritten
2981 by U-Boot. Define CONFIG_PRAM to hold the number of
2982 kB you want to reserve for pRAM. You can overwrite
2983 this default value by defining an environment
2984 variable "pram" to the number of kB you want to
2985 reserve. Note that the board info structure will
2986 still show the full amount of RAM. If pRAM is
2987 reserved, a new environment variable "mem" will
2988 automatically be defined to hold the amount of
2989 remaining RAM in a form that can be passed as boot
2990 argument to Linux, for instance like that:
2991
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002992 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002993 saveenv
2994
2995 This way you can tell Linux not to use this memory,
2996 either, which results in a memory region that will
2997 not be affected by reboots.
2998
2999 *WARNING* If your board configuration uses automatic
3000 detection of the RAM size, you must make sure that
3001 this memory test is non-destructive. So far, the
3002 following board configurations are known to be
3003 "pRAM-clean":
3004
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00003005 IVMS8, IVML24, SPD8xx, TQM8xxL,
3006 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02003007 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00003008
Gabe Black40fef042012-12-02 04:55:18 +00003009- Access to physical memory region (> 4GB)
3010 Some basic support is provided for operations on memory not
3011 normally accessible to U-Boot - e.g. some architectures
3012 support access to more than 4GB of memory on 32-bit
3013 machines using physical address extension or similar.
3014 Define CONFIG_PHYSMEM to access this basic support, which
3015 currently only supports clearing the memory.
3016
wdenkc6097192002-11-03 00:24:07 +00003017- Error Recovery:
3018 CONFIG_PANIC_HANG
3019
3020 Define this variable to stop the system in case of a
3021 fatal error, so that you have to reset it manually.
3022 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003023 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00003024 automatically as fast as possible, but it may be
3025 useful during development since you can try to debug
3026 the conditions that lead to the situation.
3027
3028 CONFIG_NET_RETRY_COUNT
3029
wdenk43d96162003-03-06 00:02:04 +00003030 This variable defines the number of retries for
3031 network operations like ARP, RARP, TFTP, or BOOTP
3032 before giving up the operation. If not defined, a
3033 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00003034
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02003035 CONFIG_ARP_TIMEOUT
3036
3037 Timeout waiting for an ARP reply in milliseconds.
3038
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00003039 CONFIG_NFS_TIMEOUT
3040
3041 Timeout in milliseconds used in NFS protocol.
3042 If you encounter "ERROR: Cannot umount" in nfs command,
3043 try longer timeout such as
3044 #define CONFIG_NFS_TIMEOUT 10000UL
3045
wdenkc6097192002-11-03 00:24:07 +00003046- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02003047 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00003048
3049 Enable auto completion of commands using TAB.
3050
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003051 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00003052
3053 This defines the secondary prompt string, which is
3054 printed when the command interpreter needs more input
3055 to complete a command. Usually "> ".
3056
3057 Note:
3058
wdenk8bde7f72003-06-27 21:31:46 +00003059 In the current implementation, the local variables
3060 space and global environment variables space are
3061 separated. Local variables are those you define by
3062 simply typing `name=value'. To access a local
3063 variable later on, you have write `$name' or
3064 `${name}'; to execute the contents of a variable
3065 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00003066
wdenk43d96162003-03-06 00:02:04 +00003067 Global environment variables are those you use
3068 setenv/printenv to work with. To run a command stored
3069 in such a variable, you need to use the run command,
3070 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00003071
3072 To store commands and special characters in a
3073 variable, please use double quotation marks
3074 surrounding the whole text of the variable, instead
3075 of the backslashes before semicolons and special
3076 symbols.
3077
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003078- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02003079 CONFIG_CMDLINE_EDITING
3080
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003081 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003082 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02003083
wdenka8c7c702003-12-06 19:49:23 +00003084- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003085 CONFIG_EXTRA_ENV_SETTINGS
3086
wdenk43d96162003-03-06 00:02:04 +00003087 Define this to contain any number of null terminated
3088 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00003089 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00003090
wdenk43d96162003-03-06 00:02:04 +00003091 For example, place something like this in your
3092 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003093
3094 #define CONFIG_EXTRA_ENV_SETTINGS \
3095 "myvar1=value1\0" \
3096 "myvar2=value2\0"
3097
wdenk43d96162003-03-06 00:02:04 +00003098 Warning: This method is based on knowledge about the
3099 internal format how the environment is stored by the
3100 U-Boot code. This is NOT an official, exported
3101 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00003102 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003103 You better know what you are doing here.
3104
wdenk43d96162003-03-06 00:02:04 +00003105 Note: overly (ab)use of the default environment is
3106 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003107 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00003108 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003109
Stephen Warren5e724ca2012-05-22 09:21:54 +00003110 CONFIG_ENV_VARS_UBOOT_CONFIG
3111
3112 Define this in order to add variables describing the
3113 U-Boot build configuration to the default environment.
3114 These will be named arch, cpu, board, vendor, and soc.
3115
3116 Enabling this option will cause the following to be defined:
3117
3118 - CONFIG_SYS_ARCH
3119 - CONFIG_SYS_CPU
3120 - CONFIG_SYS_BOARD
3121 - CONFIG_SYS_VENDOR
3122 - CONFIG_SYS_SOC
3123
Tom Rini7e27f892012-10-24 07:28:16 +00003124 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3125
3126 Define this in order to add variables describing certain
3127 run-time determined information about the hardware to the
3128 environment. These will be named board_name, board_rev.
3129
Simon Glass06fd8532012-11-30 13:01:17 +00003130 CONFIG_DELAY_ENVIRONMENT
3131
3132 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003133 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00003134 that so that the environment is not available until
3135 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3136 this is instead controlled by the value of
3137 /config/load-environment.
3138
wdenka8c7c702003-12-06 19:49:23 +00003139- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003140 CONFIG_HAS_DATAFLASH
3141
wdenk8bde7f72003-06-27 21:31:46 +00003142 Defining this option enables DataFlash features and
3143 allows to read/write in Dataflash via the standard
3144 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003145
Eric Nelsonf61ec452012-01-31 10:52:08 -07003146- Serial Flash support
3147 CONFIG_CMD_SF
3148
3149 Defining this option enables SPI flash commands
3150 'sf probe/read/write/erase/update'.
3151
3152 Usage requires an initial 'probe' to define the serial
3153 flash parameters, followed by read/write/erase/update
3154 commands.
3155
3156 The following defaults may be provided by the platform
3157 to handle the common case when only a single serial
3158 flash is present on the system.
3159
3160 CONFIG_SF_DEFAULT_BUS Bus identifier
3161 CONFIG_SF_DEFAULT_CS Chip-select
3162 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3163 CONFIG_SF_DEFAULT_SPEED in Hz
3164
Simon Glass24007272012-10-08 13:16:02 +00003165 CONFIG_CMD_SF_TEST
3166
3167 Define this option to include a destructive SPI flash
3168 test ('sf test').
3169
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05303170 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3171
3172 Define this option to use the Bank addr/Extended addr
3173 support on SPI flashes which has size > 16Mbytes.
3174
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303175 CONFIG_SF_DUAL_FLASH Dual flash memories
3176
3177 Define this option to use dual flash support where two flash
3178 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003179 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303180
Heiko Schocher562f8df2014-07-18 06:07:21 +02003181 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3182 enable the W#/Vpp signal to disable writing to the status
3183 register on ST MICRON flashes like the N25Q128.
3184 The status register write enable/disable bit, combined with
3185 the W#/VPP signal provides hardware data protection for the
3186 device as follows: When the enable/disable bit is set to 1,
3187 and the W#/VPP signal is driven LOW, the status register
3188 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3189 operation will not execute. The only way to exit this
3190 hardware-protected mode is to drive W#/VPP HIGH.
3191
wdenk3f85ce22004-02-23 16:11:30 +00003192- SystemACE Support:
3193 CONFIG_SYSTEMACE
3194
3195 Adding this option adds support for Xilinx SystemACE
3196 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003197 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003198 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003199
3200 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003201 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003202
3203 When SystemACE support is added, the "ace" device type
3204 becomes available to the fat commands, i.e. fatls.
3205
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003206- TFTP Fixed UDP Port:
3207 CONFIG_TFTP_PORT
3208
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003209 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003210 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003211 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003212 number generator is used.
3213
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003214 Also, the environment variable tftpdstp is used to supply
3215 the TFTP UDP destination port value. If tftpdstp isn't
3216 defined, the normal port 69 is used.
3217
3218 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003219 blindly start the TFTP transfer using the pre-configured
3220 target IP address and UDP port. This has the effect of
3221 "punching through" the (Windows XP) firewall, allowing
3222 the remainder of the TFTP transfer to proceed normally.
3223 A better solution is to properly configure the firewall,
3224 but sometimes that is not allowed.
3225
Simon Glassbf36c5d2012-12-05 14:46:38 +00003226- Hashing support:
3227 CONFIG_CMD_HASH
3228
3229 This enables a generic 'hash' command which can produce
3230 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3231
3232 CONFIG_HASH_VERIFY
3233
3234 Enable the hash verify command (hash -v). This adds to code
3235 size a little.
3236
gaurav rana94e3c8c2015-02-20 12:51:46 +05303237 CONFIG_SHA1 - This option enables support of hashing using SHA1
3238 algorithm. The hash is calculated in software.
3239 CONFIG_SHA256 - This option enables support of hashing using
3240 SHA256 algorithm. The hash is calculated in software.
3241 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3242 for SHA1/SHA256 hashing.
3243 This affects the 'hash' command and also the
3244 hash_lookup_algo() function.
3245 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3246 hardware-acceleration for SHA1/SHA256 progressive hashing.
3247 Data can be streamed in a block at a time and the hashing
3248 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003249
3250 Note: There is also a sha1sum command, which should perhaps
3251 be deprecated in favour of 'hash sha1'.
3252
Robert Winklera11f1872013-07-24 17:57:06 -07003253- Freescale i.MX specific commands:
3254 CONFIG_CMD_HDMIDETECT
3255 This enables 'hdmidet' command which returns true if an
3256 HDMI monitor is detected. This command is i.MX 6 specific.
3257
3258 CONFIG_CMD_BMODE
3259 This enables the 'bmode' (bootmode) command for forcing
3260 a boot from specific media.
3261
3262 This is useful for forcing the ROM's usb downloader to
3263 activate upon a watchdog reset which is nice when iterating
3264 on U-Boot. Using the reset button or running bmode normal
3265 will set it back to normal. This command currently
3266 supports i.MX53 and i.MX6.
3267
Simon Glass19c402a2013-06-13 15:10:02 -07003268- Signing support:
3269 CONFIG_RSA
3270
3271 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003272 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003273
Ruchika Guptac937ff62015-01-23 16:01:54 +05303274 The Modular Exponentiation algorithm in RSA is implemented using
3275 driver model. So CONFIG_DM needs to be enabled by default for this
3276 library to function.
3277
Simon Glass19c402a2013-06-13 15:10:02 -07003278 The signing part is build into mkimage regardless of this
Ruchika Guptac937ff62015-01-23 16:01:54 +05303279 option. The software based modular exponentiation is built into
3280 mkimage irrespective of this option.
Simon Glass19c402a2013-06-13 15:10:02 -07003281
Heiko Schocher9e50c402014-01-25 07:27:13 +01003282- bootcount support:
3283 CONFIG_BOOTCOUNT_LIMIT
3284
3285 This enables the bootcounter support, see:
3286 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3287
3288 CONFIG_AT91SAM9XE
3289 enable special bootcounter support on at91sam9xe based boards.
3290 CONFIG_BLACKFIN
3291 enable special bootcounter support on blackfin based boards.
3292 CONFIG_SOC_DA8XX
3293 enable special bootcounter support on da850 based boards.
3294 CONFIG_BOOTCOUNT_RAM
3295 enable support for the bootcounter in RAM
3296 CONFIG_BOOTCOUNT_I2C
3297 enable support for the bootcounter on an i2c (like RTC) device.
3298 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3299 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3300 the bootcounter.
3301 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003302
wdenka8c7c702003-12-06 19:49:23 +00003303- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003304 CONFIG_SHOW_BOOT_PROGRESS
3305
wdenk43d96162003-03-06 00:02:04 +00003306 Defining this option allows to add some board-
3307 specific code (calling a user-provided function
3308 "show_boot_progress(int)") that enables you to show
3309 the system's boot progress on some display (for
3310 example, some LED's) on your board. At the moment,
3311 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003312
Simon Glass3a608ca2012-02-13 13:51:19 +00003313- Detailed boot stage timing
3314 CONFIG_BOOTSTAGE
3315 Define this option to get detailed timing of each stage
3316 of the boot process.
3317
3318 CONFIG_BOOTSTAGE_USER_COUNT
3319 This is the number of available user bootstage records.
3320 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3321 a new ID will be allocated from this stash. If you exceed
3322 the limit, recording will stop.
3323
3324 CONFIG_BOOTSTAGE_REPORT
3325 Define this to print a report before boot, similar to this:
3326
3327 Timer summary in microseconds:
3328 Mark Elapsed Stage
3329 0 0 reset
3330 3,575,678 3,575,678 board_init_f start
3331 3,575,695 17 arch_cpu_init A9
3332 3,575,777 82 arch_cpu_init done
3333 3,659,598 83,821 board_init_r start
3334 3,910,375 250,777 main_loop
3335 29,916,167 26,005,792 bootm_start
3336 30,361,327 445,160 start_kernel
3337
Simon Glass2eba38c2012-09-28 08:56:39 +00003338 CONFIG_CMD_BOOTSTAGE
3339 Add a 'bootstage' command which supports printing a report
3340 and un/stashing of bootstage data.
3341
Simon Glass94fd1312012-09-28 08:56:37 +00003342 CONFIG_BOOTSTAGE_FDT
3343 Stash the bootstage information in the FDT. A root 'bootstage'
3344 node is created with each bootstage id as a child. Each child
3345 has a 'name' property and either 'mark' containing the
3346 mark time in microsecond, or 'accum' containing the
3347 accumulated time for that bootstage id in microseconds.
3348 For example:
3349
3350 bootstage {
3351 154 {
3352 name = "board_init_f";
3353 mark = <3575678>;
3354 };
3355 170 {
3356 name = "lcd";
3357 accum = <33482>;
3358 };
3359 };
3360
3361 Code in the Linux kernel can find this in /proc/devicetree.
3362
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003363Legacy uImage format:
3364
wdenkc6097192002-11-03 00:24:07 +00003365 Arg Where When
3366 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003367 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003368 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003369 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003370 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003371 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003372 4 common/cmd_bootm.c Image data has correct checksum
3373 -4 common/cmd_bootm.c Image is for unsupported architecture
3374 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003375 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003376 6 common/cmd_bootm.c Image Type check OK
3377 -6 common/cmd_bootm.c gunzip uncompression error
3378 -7 common/cmd_bootm.c Unimplemented compression type
3379 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003380 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003381 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003382
3383 9 common/image.c Start initial ramdisk verification
3384 -10 common/image.c Ramdisk header has bad magic number
3385 -11 common/image.c Ramdisk header has bad checksum
3386 10 common/image.c Ramdisk header is OK
3387 -12 common/image.c Ramdisk data has bad checksum
3388 11 common/image.c Ramdisk data has correct checksum
3389 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003390 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003391 13 common/image.c Start multifile image verification
3392 14 common/image.c No initial ramdisk, no multifile, continue.
3393
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003394 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003395
Stefan Roesea47a12b2010-04-15 16:07:28 +02003396 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003397 -31 post/post.c POST test failed, detected by post_output_backlog()
3398 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003399
Heiko Schocher566a4942007-06-22 19:11:54 +02003400 34 common/cmd_doc.c before loading a Image from a DOC device
3401 -35 common/cmd_doc.c Bad usage of "doc" command
3402 35 common/cmd_doc.c correct usage of "doc" command
3403 -36 common/cmd_doc.c No boot device
3404 36 common/cmd_doc.c correct boot device
3405 -37 common/cmd_doc.c Unknown Chip ID on boot device
3406 37 common/cmd_doc.c correct chip ID found, device available
3407 -38 common/cmd_doc.c Read Error on boot device
3408 38 common/cmd_doc.c reading Image header from DOC device OK
3409 -39 common/cmd_doc.c Image header has bad magic number
3410 39 common/cmd_doc.c Image header has correct magic number
3411 -40 common/cmd_doc.c Error reading Image from DOC device
3412 40 common/cmd_doc.c Image header has correct magic number
3413 41 common/cmd_ide.c before loading a Image from a IDE device
3414 -42 common/cmd_ide.c Bad usage of "ide" command
3415 42 common/cmd_ide.c correct usage of "ide" command
3416 -43 common/cmd_ide.c No boot device
3417 43 common/cmd_ide.c boot device found
3418 -44 common/cmd_ide.c Device not available
3419 44 common/cmd_ide.c Device available
3420 -45 common/cmd_ide.c wrong partition selected
3421 45 common/cmd_ide.c partition selected
3422 -46 common/cmd_ide.c Unknown partition table
3423 46 common/cmd_ide.c valid partition table found
3424 -47 common/cmd_ide.c Invalid partition type
3425 47 common/cmd_ide.c correct partition type
3426 -48 common/cmd_ide.c Error reading Image Header on boot device
3427 48 common/cmd_ide.c reading Image Header from IDE device OK
3428 -49 common/cmd_ide.c Image header has bad magic number
3429 49 common/cmd_ide.c Image header has correct magic number
3430 -50 common/cmd_ide.c Image header has bad checksum
3431 50 common/cmd_ide.c Image header has correct checksum
3432 -51 common/cmd_ide.c Error reading Image from IDE device
3433 51 common/cmd_ide.c reading Image from IDE device OK
3434 52 common/cmd_nand.c before loading a Image from a NAND device
3435 -53 common/cmd_nand.c Bad usage of "nand" command
3436 53 common/cmd_nand.c correct usage of "nand" command
3437 -54 common/cmd_nand.c No boot device
3438 54 common/cmd_nand.c boot device found
3439 -55 common/cmd_nand.c Unknown Chip ID on boot device
3440 55 common/cmd_nand.c correct chip ID found, device available
3441 -56 common/cmd_nand.c Error reading Image Header on boot device
3442 56 common/cmd_nand.c reading Image Header from NAND device OK
3443 -57 common/cmd_nand.c Image header has bad magic number
3444 57 common/cmd_nand.c Image header has correct magic number
3445 -58 common/cmd_nand.c Error reading Image from NAND device
3446 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003447
Heiko Schocher566a4942007-06-22 19:11:54 +02003448 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003449
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003450 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003451 -64 net/eth.c no Ethernet found.
3452 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003453
Heiko Schocher566a4942007-06-22 19:11:54 +02003454 -80 common/cmd_net.c usage wrong
3455 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003456 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003457 81 common/cmd_net.c NetLoop() back without error
3458 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3459 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003460 83 common/cmd_net.c running "source" command
3461 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003462 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003463
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003464FIT uImage format:
3465
3466 Arg Where When
3467 100 common/cmd_bootm.c Kernel FIT Image has correct format
3468 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3469 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3470 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3471 102 common/cmd_bootm.c Kernel unit name specified
3472 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003473 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003474 104 common/cmd_bootm.c Got kernel subimage node offset
3475 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3476 105 common/cmd_bootm.c Kernel subimage hash verification OK
3477 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3478 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003479 -106 common/cmd_bootm.c Kernel subimage has wrong type
3480 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003481 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3482 108 common/cmd_bootm.c Got kernel subimage data/size
3483 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3484 -109 common/cmd_bootm.c Can't get kernel subimage type
3485 -110 common/cmd_bootm.c Can't get kernel subimage comp
3486 -111 common/cmd_bootm.c Can't get kernel subimage os
3487 -112 common/cmd_bootm.c Can't get kernel subimage load address
3488 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3489
3490 120 common/image.c Start initial ramdisk verification
3491 -120 common/image.c Ramdisk FIT image has incorrect format
3492 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003493 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003494 -122 common/image.c Can't get configuration for ramdisk subimage
3495 123 common/image.c Ramdisk unit name specified
3496 -124 common/image.c Can't get ramdisk subimage node offset
3497 125 common/image.c Got ramdisk subimage node offset
3498 -125 common/image.c Ramdisk subimage hash verification failed
3499 126 common/image.c Ramdisk subimage hash verification OK
3500 -126 common/image.c Ramdisk subimage for unsupported architecture
3501 127 common/image.c Architecture check OK
3502 -127 common/image.c Can't get ramdisk subimage data/size
3503 128 common/image.c Got ramdisk subimage data/size
3504 129 common/image.c Can't get ramdisk load address
3505 -129 common/image.c Got ramdisk load address
3506
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003507 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003508 131 common/cmd_doc.c FIT image format OK
3509
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003510 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003511 141 common/cmd_ide.c FIT image format OK
3512
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003513 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003514 151 common/cmd_nand.c FIT image format OK
3515
Heiko Schocher21d29f72014-05-28 11:33:33 +02003516- legacy image format:
3517 CONFIG_IMAGE_FORMAT_LEGACY
3518 enables the legacy image format support in U-Boot.
3519
3520 Default:
3521 enabled if CONFIG_FIT_SIGNATURE is not defined.
3522
3523 CONFIG_DISABLE_IMAGE_LEGACY
3524 disable the legacy image format
3525
3526 This define is introduced, as the legacy image format is
3527 enabled per default for backward compatibility.
3528
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003529- FIT image support:
3530 CONFIG_FIT
3531 Enable support for the FIT uImage format.
3532
3533 CONFIG_FIT_BEST_MATCH
3534 When no configuration is explicitly selected, default to the
3535 one whose fdt's compatibility field best matches that of
3536 U-Boot itself. A match is considered "best" if it matches the
3537 most specific compatibility entry of U-Boot's fdt's root node.
3538 The order of entries in the configuration's fdt is ignored.
3539
Simon Glass3e569a62013-06-13 15:10:00 -07003540 CONFIG_FIT_SIGNATURE
3541 This option enables signature verification of FIT uImages,
gaurav rana94e3c8c2015-02-20 12:51:46 +05303542 using a hash signed and verified using RSA. If
3543 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3544 hashing is available using hardware, RSA library will use it.
3545 See doc/uImage.FIT/signature.txt for more details.
Simon Glass3e569a62013-06-13 15:10:00 -07003546
Heiko Schocher21d29f72014-05-28 11:33:33 +02003547 WARNING: When relying on signed FIT images with required
3548 signature check the legacy image format is default
3549 disabled. If a board need legacy image format support
3550 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3551
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003552 CONFIG_FIT_DISABLE_SHA256
3553 Supporting SHA256 hashes has quite an impact on binary size.
3554 For constrained systems sha256 hash support can be disabled
3555 with this option.
3556
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003557- Standalone program support:
3558 CONFIG_STANDALONE_LOAD_ADDR
3559
Wolfgang Denk6feff892011-10-09 21:06:34 +02003560 This option defines a board specific value for the
3561 address where standalone program gets loaded, thus
3562 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003563 settings.
3564
3565- Frame Buffer Address:
3566 CONFIG_FB_ADDR
3567
3568 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003569 address for frame buffer. This is typically the case
3570 when using a graphics controller has separate video
3571 memory. U-Boot will then place the frame buffer at
3572 the given address instead of dynamically reserving it
3573 in system RAM by calling lcd_setmem(), which grabs
3574 the memory for the frame buffer depending on the
3575 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003576
3577 Please see board_init_f function.
3578
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003579- Automatic software updates via TFTP server
3580 CONFIG_UPDATE_TFTP
3581 CONFIG_UPDATE_TFTP_CNT_MAX
3582 CONFIG_UPDATE_TFTP_MSEC_MAX
3583
3584 These options enable and control the auto-update feature;
3585 for a more detailed description refer to doc/README.update.
3586
3587- MTD Support (mtdparts command, UBI support)
3588 CONFIG_MTD_DEVICE
3589
3590 Adds the MTD device infrastructure from the Linux kernel.
3591 Needed for mtdparts command support.
3592
3593 CONFIG_MTD_PARTITIONS
3594
3595 Adds the MTD partitioning infrastructure from the Linux
3596 kernel. Needed for UBI support.
3597
Heiko Schocherff94bc42014-06-24 10:10:04 +02003598 CONFIG_MTD_NAND_VERIFY_WRITE
3599 verify if the written data is correct reread.
3600
Joe Hershberger70c219c2013-04-08 10:32:48 +00003601- UBI support
3602 CONFIG_CMD_UBI
3603
3604 Adds commands for interacting with MTD partitions formatted
3605 with the UBI flash translation layer
3606
3607 Requires also defining CONFIG_RBTREE
3608
Joe Hershberger147162d2013-04-08 10:32:49 +00003609 CONFIG_UBI_SILENCE_MSG
3610
3611 Make the verbose messages from UBI stop printing. This leaves
3612 warnings and errors enabled.
3613
Heiko Schocherff94bc42014-06-24 10:10:04 +02003614
3615 CONFIG_MTD_UBI_WL_THRESHOLD
3616 This parameter defines the maximum difference between the highest
3617 erase counter value and the lowest erase counter value of eraseblocks
3618 of UBI devices. When this threshold is exceeded, UBI starts performing
3619 wear leveling by means of moving data from eraseblock with low erase
3620 counter to eraseblocks with high erase counter.
3621
3622 The default value should be OK for SLC NAND flashes, NOR flashes and
3623 other flashes which have eraseblock life-cycle 100000 or more.
3624 However, in case of MLC NAND flashes which typically have eraseblock
3625 life-cycle less than 10000, the threshold should be lessened (e.g.,
3626 to 128 or 256, although it does not have to be power of 2).
3627
3628 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003629
Heiko Schocherff94bc42014-06-24 10:10:04 +02003630 CONFIG_MTD_UBI_BEB_LIMIT
3631 This option specifies the maximum bad physical eraseblocks UBI
3632 expects on the MTD device (per 1024 eraseblocks). If the
3633 underlying flash does not admit of bad eraseblocks (e.g. NOR
3634 flash), this value is ignored.
3635
3636 NAND datasheets often specify the minimum and maximum NVM
3637 (Number of Valid Blocks) for the flashes' endurance lifetime.
3638 The maximum expected bad eraseblocks per 1024 eraseblocks
3639 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3640 which gives 20 for most NANDs (MaxNVB is basically the total
3641 count of eraseblocks on the chip).
3642
3643 To put it differently, if this value is 20, UBI will try to
3644 reserve about 1.9% of physical eraseblocks for bad blocks
3645 handling. And that will be 1.9% of eraseblocks on the entire
3646 NAND chip, not just the MTD partition UBI attaches. This means
3647 that if you have, say, a NAND flash chip admits maximum 40 bad
3648 eraseblocks, and it is split on two MTD partitions of the same
3649 size, UBI will reserve 40 eraseblocks when attaching a
3650 partition.
3651
3652 default: 20
3653
3654 CONFIG_MTD_UBI_FASTMAP
3655 Fastmap is a mechanism which allows attaching an UBI device
3656 in nearly constant time. Instead of scanning the whole MTD device it
3657 only has to locate a checkpoint (called fastmap) on the device.
3658 The on-flash fastmap contains all information needed to attach
3659 the device. Using fastmap makes only sense on large devices where
3660 attaching by scanning takes long. UBI will not automatically install
3661 a fastmap on old images, but you can set the UBI parameter
3662 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3663 that fastmap-enabled images are still usable with UBI implementations
3664 without fastmap support. On typical flash devices the whole fastmap
3665 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3666
3667 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3668 Set this parameter to enable fastmap automatically on images
3669 without a fastmap.
3670 default: 0
3671
Joe Hershberger70c219c2013-04-08 10:32:48 +00003672- UBIFS support
3673 CONFIG_CMD_UBIFS
3674
3675 Adds commands for interacting with UBI volumes formatted as
3676 UBIFS. UBIFS is read-only in u-boot.
3677
3678 Requires UBI support as well as CONFIG_LZO
3679
Joe Hershberger147162d2013-04-08 10:32:49 +00003680 CONFIG_UBIFS_SILENCE_MSG
3681
3682 Make the verbose messages from UBIFS stop printing. This leaves
3683 warnings and errors enabled.
3684
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003685- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003686 CONFIG_SPL
3687 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003688
Tom Rini95579792012-02-14 07:29:40 +00003689 CONFIG_SPL_LDSCRIPT
3690 LDSCRIPT for linking the SPL binary.
3691
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003692 CONFIG_SPL_MAX_FOOTPRINT
3693 Maximum size in memory allocated to the SPL, BSS included.
3694 When defined, the linker checks that the actual memory
3695 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003696 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003697 must not be both defined at the same time.
3698
Tom Rini95579792012-02-14 07:29:40 +00003699 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003700 Maximum size of the SPL image (text, data, rodata, and
3701 linker lists sections), BSS excluded.
3702 When defined, the linker checks that the actual size does
3703 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003704
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003705 CONFIG_SPL_TEXT_BASE
3706 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003707
Scott Wood94a45bb2012-09-20 19:05:12 -05003708 CONFIG_SPL_RELOC_TEXT_BASE
3709 Address to relocate to. If unspecified, this is equal to
3710 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3711
Tom Rini95579792012-02-14 07:29:40 +00003712 CONFIG_SPL_BSS_START_ADDR
3713 Link address for the BSS within the SPL binary.
3714
3715 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003716 Maximum size in memory allocated to the SPL BSS.
3717 When defined, the linker checks that the actual memory used
3718 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003719 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003720 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003721
3722 CONFIG_SPL_STACK
3723 Adress of the start of the stack SPL will use
3724
Scott Wood94a45bb2012-09-20 19:05:12 -05003725 CONFIG_SPL_RELOC_STACK
3726 Adress of the start of the stack SPL will use after
3727 relocation. If unspecified, this is equal to
3728 CONFIG_SPL_STACK.
3729
Tom Rini95579792012-02-14 07:29:40 +00003730 CONFIG_SYS_SPL_MALLOC_START
3731 Starting address of the malloc pool used in SPL.
3732
3733 CONFIG_SYS_SPL_MALLOC_SIZE
3734 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003735
Tom Rini47f7bca2012-08-13 12:03:19 -07003736 CONFIG_SPL_FRAMEWORK
3737 Enable the SPL framework under common/. This framework
3738 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3739 NAND loading of the Linux Kernel.
3740
Tom Rini9607faf2014-03-28 12:03:39 -04003741 CONFIG_SPL_OS_BOOT
3742 Enable booting directly to an OS from SPL.
3743 See also: doc/README.falcon
3744
Tom Rini861a86f2012-08-13 11:37:56 -07003745 CONFIG_SPL_DISPLAY_PRINT
3746 For ARM, enable an optional function to print more information
3747 about the running system.
3748
Scott Wood4b919722012-09-20 16:35:21 -05003749 CONFIG_SPL_INIT_MINIMAL
3750 Arch init code should be built for a very small image
3751
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003752 CONFIG_SPL_LIBCOMMON_SUPPORT
3753 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003754
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003755 CONFIG_SPL_LIBDISK_SUPPORT
3756 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003757
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003758 CONFIG_SPL_I2C_SUPPORT
3759 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003760
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003761 CONFIG_SPL_GPIO_SUPPORT
3762 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003763
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003764 CONFIG_SPL_MMC_SUPPORT
3765 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003766
Tom Rini95579792012-02-14 07:29:40 +00003767 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3768 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003769 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003770 when the MMC is being used in raw mode.
3771
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003772 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3773 Partition on the MMC to load U-Boot from when the MMC is being
3774 used in raw mode
3775
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003776 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3777 Sector to load kernel uImage from when MMC is being
3778 used in raw mode (for Falcon mode)
3779
3780 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3781 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3782 Sector and number of sectors to load kernel argument
3783 parameters from when MMC is being used in raw mode
3784 (for falcon mode)
3785
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003786 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3787 Partition on the MMC to load U-Boot from when the MMC is being
3788 used in fs mode
3789
Tom Rini95579792012-02-14 07:29:40 +00003790 CONFIG_SPL_FAT_SUPPORT
3791 Support for fs/fat/libfat.o in SPL binary
3792
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003793 CONFIG_SPL_EXT_SUPPORT
3794 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003795
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003796 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3797 Filename to read to load U-Boot when reading from filesystem
3798
3799 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003800 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003801 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003802
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003803 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003804 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003805 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003806
Scott Wood06f60ae2012-12-06 13:33:17 +00003807 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3808 Set this for NAND SPL on PPC mpc83xx targets, so that
3809 start.S waits for the rest of the SPL to load before
3810 continuing (the hardware starts execution after just
3811 loading the first page rather than the full 4K).
3812
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303813 CONFIG_SPL_SKIP_RELOCATE
3814 Avoid SPL relocation
3815
Scott Wood6f2f01b2012-09-20 19:09:07 -05003816 CONFIG_SPL_NAND_BASE
3817 Include nand_base.c in the SPL. Requires
3818 CONFIG_SPL_NAND_DRIVERS.
3819
3820 CONFIG_SPL_NAND_DRIVERS
3821 SPL uses normal NAND drivers, not minimal drivers.
3822
3823 CONFIG_SPL_NAND_ECC
3824 Include standard software ECC in the SPL
3825
Tom Rini95579792012-02-14 07:29:40 +00003826 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003827 Support for NAND boot using simple NAND drivers that
3828 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003829
Tom Rini6dd3b562014-03-28 12:03:36 -04003830 CONFIG_SPL_MTD_SUPPORT
3831 Support for the MTD subsystem within SPL. Useful for
3832 environment on NAND support within SPL.
3833
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003834 CONFIG_SPL_NAND_RAW_ONLY
3835 Support to boot only raw u-boot.bin images. Use this only
3836 if you need to save space.
3837
Ying Zhangbb0dc102013-08-16 15:16:11 +08003838 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3839 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003840 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003841
Ying Zhang7c8eea52013-08-16 15:16:12 +08003842 CONFIG_SPL_COMMON_INIT_DDR
3843 Set for common ddr init with serial presence detect in
3844 SPL binary.
3845
Tom Rini95579792012-02-14 07:29:40 +00003846 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3847 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3848 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3849 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3850 CONFIG_SYS_NAND_ECCBYTES
3851 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003852 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003853
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303854 CONFIG_SPL_NAND_BOOT
3855 Add support NAND boot
3856
Tom Rini95579792012-02-14 07:29:40 +00003857 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003858 Location in NAND to read U-Boot from
3859
3860 CONFIG_SYS_NAND_U_BOOT_DST
3861 Location in memory to load U-Boot to
3862
3863 CONFIG_SYS_NAND_U_BOOT_SIZE
3864 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003865
3866 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003867 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003868
3869 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3870 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003871 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003872
3873 CONFIG_SPL_OMAP3_ID_NAND
3874 Support for an OMAP3-specific set of functions to return the
3875 ID and MFR of the first attached NAND chip, if present.
3876
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003877 CONFIG_SPL_SERIAL_SUPPORT
3878 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003879
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003880 CONFIG_SPL_SPI_FLASH_SUPPORT
3881 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003882
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003883 CONFIG_SPL_SPI_SUPPORT
3884 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003885
Pavel Machekc57b9532012-08-30 22:42:11 +02003886 CONFIG_SPL_RAM_DEVICE
3887 Support for running image already present in ram, in SPL binary
3888
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003889 CONFIG_SPL_LIBGENERIC_SUPPORT
3890 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003891
Ying Zhangba1bee42013-05-20 14:07:25 +08003892 CONFIG_SPL_ENV_SUPPORT
3893 Support for the environment operating in SPL binary
3894
3895 CONFIG_SPL_NET_SUPPORT
3896 Support for the net/libnet.o in SPL binary.
3897 It conflicts with SPL env from storage medium specified by
3898 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3899
Scott Wood74752ba2012-12-06 13:33:16 +00003900 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003901 Image offset to which the SPL should be padded before appending
3902 the SPL payload. By default, this is defined as
3903 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3904 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3905 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003906
Scott Woodca2fca22012-09-21 16:27:32 -05003907 CONFIG_SPL_TARGET
3908 Final target image containing SPL and payload. Some SPLs
3909 use an arch-specific makefile fragment instead, for
3910 example if more than one image needs to be produced.
3911
Simon Glass87ebee32013-05-08 08:05:59 +00003912 CONFIG_FIT_SPL_PRINT
3913 Printing information about a FIT image adds quite a bit of
3914 code to SPL. So this is normally disabled in SPL. Use this
3915 option to re-enable it. This will affect the output of the
3916 bootm command when booting a FIT image.
3917
Ying Zhang3aa29de2013-08-16 15:16:15 +08003918- TPL framework
3919 CONFIG_TPL
3920 Enable building of TPL globally.
3921
3922 CONFIG_TPL_PAD_TO
3923 Image offset to which the TPL should be padded before appending
3924 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003925 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3926 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3927 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003928
wdenkc6097192002-11-03 00:24:07 +00003929Modem Support:
3930--------------
3931
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003932[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003933
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003934- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003935 CONFIG_MODEM_SUPPORT
3936
3937- RTS/CTS Flow control enable:
3938 CONFIG_HWFLOW
3939
3940- Modem debug support:
3941 CONFIG_MODEM_SUPPORT_DEBUG
3942
wdenk43d96162003-03-06 00:02:04 +00003943 Enables debugging stuff (char screen[1024], dbg())
3944 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003945
wdenka8c7c702003-12-06 19:49:23 +00003946- Interrupt support (PPC):
3947
wdenkd4ca31c2004-01-02 14:00:00 +00003948 There are common interrupt_init() and timer_interrupt()
3949 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003950 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003951 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003952 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003953 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003954 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003955 specific handling. If board has watchdog / status_led
3956 / other_activity_monitor it works automatically from
3957 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003958
wdenkc6097192002-11-03 00:24:07 +00003959- General:
3960
wdenk43d96162003-03-06 00:02:04 +00003961 In the target system modem support is enabled when a
3962 specific key (key combination) is pressed during
3963 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003964 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003965 board_init(). Currently key_pressed() is a dummy
3966 function, returning 1 and thus enabling modem
3967 initialization.
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk43d96162003-03-06 00:02:04 +00003969 If there are no modem init strings in the
3970 environment, U-Boot proceed to autoboot; the
3971 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003972 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003973
3974 See also: doc/README.Modem
3975
Helmut Raiger9660e442011-10-20 04:19:47 +00003976Board initialization settings:
3977------------------------------
3978
3979During Initialization u-boot calls a number of board specific functions
3980to allow the preparation of board specific prerequisites, e.g. pin setup
3981before drivers are initialized. To enable these callbacks the
3982following configuration macros have to be defined. Currently this is
3983architecture specific, so please check arch/your_architecture/lib/board.c
3984typically in board_init_f() and board_init_r().
3985
3986- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3987- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3988- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3989- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003990
wdenkc6097192002-11-03 00:24:07 +00003991Configuration Settings:
3992-----------------------
3993
York Sun4d1fd7f2014-02-26 17:03:19 -08003994- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3995 Optionally it can be defined to support 64-bit memory commands.
3996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003997- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003998 undefine this when you're short of memory.
3999
Peter Tyser2fb26042009-01-27 18:03:12 -06004000- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
4001 width of the commands listed in the 'help' command output.
4002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004003- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00004004 prompt for user input.
4005
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004006- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00004007
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004008- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00004009
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004010- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00004011
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004012- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00004013 the application (usually a Linux kernel) when it is
4014 booted
4015
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004016- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00004017 List of legal baudrate settings for this board.
4018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004019- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00004020 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00004021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004022- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00004023 If the board specific function
4024 extern int overwrite_console (void);
4025 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00004026 serial port, else the settings in the environment are used.
4027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004028- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00004029 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00004030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004031- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00004032 Enable overwrite of previous console environment settings.
4033
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004034- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00004035 Begin and End addresses of the area used by the
4036 simple memory test.
4037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004038- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00004039 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00004040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004041- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00004042 Scratch address used by the alternate memory test
4043 You only need to set this if address zero isn't writeable
4044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004045- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
4046 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01004047 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004048 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01004049 fixing up gd->ram_size the Linux kernel should gets passed
4050 the now "corrected" memory size and won't touch it either.
4051 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01004052 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01004053 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01004054 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01004055
4056 This option can be used as a workaround for the 440EPx/GRx
4057 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
4058 be touched.
4059
4060 WARNING: Please make sure that this value is a multiple of
4061 the Linux page size (normally 4k). If this is not the case,
4062 then the end address of the Linux memory will be located at a
4063 non page size aligned address and this could cause major
4064 problems.
4065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004066- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00004067 Enable temporary baudrate change while serial download
4068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004069- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00004070 Physical start address of SDRAM. _Must_ be 0 here.
4071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00004073 Physical start address of Motherboard I/O (if using a
4074 Cogent motherboard)
4075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004076- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00004077 Physical start address of Flash memory.
4078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004079- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00004080 Physical start address of boot monitor code (set by
4081 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02004082 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004083 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00004084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004085- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00004086 Size of memory reserved for monitor code, used to
4087 determine _at_compile_time_ (!) if the environment is
4088 embedded within the U-Boot image, or in a separate
4089 flash sector.
wdenkc6097192002-11-03 00:24:07 +00004090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004091- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00004092 Size of DRAM reserved for malloc() use.
4093
Simon Glassd59476b2014-07-10 22:23:28 -06004094- CONFIG_SYS_MALLOC_F_LEN
4095 Size of the malloc() pool for use before relocation. If
4096 this is defined, then a very simple malloc() implementation
4097 will become available before relocation. The address is just
4098 below the global data, and the stack is moved down to make
4099 space.
4100
4101 This feature allocates regions with increasing addresses
4102 within the region. calloc() is supported, but realloc()
4103 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004104 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06004105 U-Boot relocates itself.
4106
Simon Glasse7b14e92014-09-15 06:33:18 -06004107 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06004108 at present but is fairly easy to enable for other archs.
4109
Simon Glass38687ae2014-11-10 17:16:54 -07004110- CONFIG_SYS_MALLOC_SIMPLE
4111 Provides a simple and small malloc() and calloc() for those
4112 boards which do not use the full malloc in SPL (which is
4113 enabled with CONFIG_SYS_SPL_MALLOC_START).
4114
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07004115- CONFIG_SYS_NONCACHED_MEMORY:
4116 Size of non-cached memory area. This area of memory will be
4117 typically located right below the malloc() area and mapped
4118 uncached in the MMU. This is useful for drivers that would
4119 otherwise require a lot of explicit cache maintenance. For
4120 some drivers it's also impossible to properly maintain the
4121 cache. For example if the regions that need to be flushed
4122 are not a multiple of the cache-line size, *and* padding
4123 cannot be allocated between the regions to align them (i.e.
4124 if the HW requires a contiguous array of regions, and the
4125 size of each region is not cache-aligned), then a flush of
4126 one region may result in overwriting data that hardware has
4127 written to another region in the same cache-line. This can
4128 happen for example in network drivers where descriptors for
4129 buffers are typically smaller than the CPU cache-line (e.g.
4130 16 bytes vs. 32 or 64 bytes).
4131
4132 Non-cached memory is only supported on 32-bit ARM at present.
4133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004134- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01004135 Normally compressed uImages are limited to an
4136 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004137 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01004138 to adjust this setting to your needs.
4139
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004140- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004141 Maximum size of memory mapped by the startup code of
4142 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004143 the Linux kernel (bd_info, boot arguments, FDT blob if
4144 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004145 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004146 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004147 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00004148 variable "bootm_mapsize" will override the value of
4149 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4150 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004151
John Rigbyfca43cc2010-10-13 13:57:35 -06004152- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4153 Enable initrd_high functionality. If defined then the
4154 initrd_high feature is enabled and the bootm ramdisk subcommand
4155 is enabled.
4156
4157- CONFIG_SYS_BOOT_GET_CMDLINE:
4158 Enables allocating and saving kernel cmdline in space between
4159 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4160
4161- CONFIG_SYS_BOOT_GET_KBD:
4162 Enables allocating and saving a kernel copy of the bd_info in
4163 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004165- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004166 Max number of Flash memory banks
4167
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004168- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004169 Max number of sectors on a Flash chip
4170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004171- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004172 Timeout for Flash erase operations (in ms)
4173
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004174- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004175 Timeout for Flash write operations (in ms)
4176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004177- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004178 Timeout for Flash set sector lock bit operation (in ms)
4179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004180- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004181 Timeout for Flash clear lock bits operation (in ms)
4182
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004183- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004184 If defined, hardware flash sectors protection is used
4185 instead of U-Boot software protection.
4186
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004187- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004188
4189 Enable TFTP transfers directly to flash memory;
4190 without this option such a download has to be
4191 performed in two steps: (1) download to RAM, and (2)
4192 copy from RAM to flash.
4193
4194 The two-step approach is usually more reliable, since
4195 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004196 the flash, but in some situations (when system RAM is
4197 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004198 downloaded image) this option may be very useful.
4199
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004200- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004201 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004202 common flash structure for storing flash geometry.
4203
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004204- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004205 This option also enables the building of the cfi_flash driver
4206 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004207
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004208- CONFIG_FLASH_CFI_MTD
4209 This option enables the building of the cfi_mtd driver
4210 in the drivers directory. The driver exports CFI flash
4211 to the MTD layer.
4212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004213- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004214 Use buffered writes to flash.
4215
4216- CONFIG_FLASH_SPANSION_S29WS_N
4217 s29ws-n MirrorBit flash has non-standard addresses for buffered
4218 write commands.
4219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004220- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004221 If this option is defined, the common CFI flash doesn't
4222 print it's warning upon not recognized FLASH banks. This
4223 is useful, if some of the configured banks are only
4224 optionally available.
4225
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004226- CONFIG_FLASH_SHOW_PROGRESS
4227 If defined (must be an integer), print out countdown
4228 digits and dots. Recommended value: 45 (9..1) for 80
4229 column displays, 15 (3..1) for 40 column displays.
4230
Stefan Roese352ef3f2013-04-04 15:53:14 +02004231- CONFIG_FLASH_VERIFY
4232 If defined, the content of the flash (destination) is compared
4233 against the source after the write operation. An error message
4234 will be printed when the contents are not identical.
4235 Please note that this option is useless in nearly all cases,
4236 since such flash programming errors usually are detected earlier
4237 while unprotecting/erasing/programming. Please only enable
4238 this option if you really know what you are doing.
4239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004240- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004241 Defines the number of Ethernet receive buffers. On some
4242 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004243 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4244 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004245 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004246 Defaults to 4 if not defined.
4247
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004248- CONFIG_ENV_MAX_ENTRIES
4249
Wolfgang Denk071bc922010-10-27 22:48:30 +02004250 Maximum number of entries in the hash table that is used
4251 internally to store the environment settings. The default
4252 setting is supposed to be generous and should work in most
4253 cases. This setting can be used to tune behaviour; see
4254 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004255
Joe Hershberger25980902012-12-11 22:16:31 -06004256- CONFIG_ENV_FLAGS_LIST_DEFAULT
4257- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004258 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004259 calling env set. Variables can be restricted to only decimal,
4260 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4261 the variables can also be restricted to IP address or MAC address.
4262
4263 The format of the list is:
4264 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004265 access_attribute = [a|r|o|c]
4266 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004267 entry = variable_name[:attributes]
4268 list = entry[,list]
4269
4270 The type attributes are:
4271 s - String (default)
4272 d - Decimal
4273 x - Hexadecimal
4274 b - Boolean ([1yYtT|0nNfF])
4275 i - IP address
4276 m - MAC address
4277
Joe Hershberger267541f2012-12-11 22:16:34 -06004278 The access attributes are:
4279 a - Any (default)
4280 r - Read-only
4281 o - Write-once
4282 c - Change-default
4283
Joe Hershberger25980902012-12-11 22:16:31 -06004284 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4285 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004286 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004287
4288 - CONFIG_ENV_FLAGS_LIST_STATIC
4289 Define this to a list (string) to define validation that
4290 should be done if an entry is not found in the ".flags"
4291 environment variable. To override a setting in the static
4292 list, simply add an entry for the same variable name to the
4293 ".flags" variable.
4294
Joe Hershberger267541f2012-12-11 22:16:34 -06004295- CONFIG_ENV_ACCESS_IGNORE_FORCE
4296 If defined, don't allow the -f switch to env set override variable
4297 access flags.
4298
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004299- CONFIG_SYS_GENERIC_BOARD
4300 This selects the architecture-generic board system instead of the
4301 architecture-specific board files. It is intended to move boards
4302 to this new framework over time. Defining this will disable the
4303 arch/foo/lib/board.c file and use common/board_f.c and
4304 common/board_r.c instead. To use this option your architecture
4305 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4306 its config.mk file). If you find problems enabling this option on
4307 your board please report the problem and send patches!
4308
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004309- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4310 This is set by OMAP boards for the max time that reset should
4311 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004312 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004313
Gabe Black0d296cc2014-10-15 04:38:30 -06004314- CONFIG_USE_STDINT
4315 If stdint.h is available with your toolchain you can define this
4316 option to enable it. You can provide option 'USE_STDINT=1' when
4317 building U-Boot to enable this.
4318
wdenkc6097192002-11-03 00:24:07 +00004319The following definitions that deal with the placement and management
4320of environment data (variable area); in general, we support the
4321following configurations:
4322
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004323- CONFIG_BUILD_ENVCRC:
4324
4325 Builds up envcrc with the target environment so that external utils
4326 may easily extract it and embed it in final U-Boot images.
4327
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004328- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004329
4330 Define this if the environment is in flash memory.
4331
4332 a) The environment occupies one whole flash sector, which is
4333 "embedded" in the text segment with the U-Boot code. This
4334 happens usually with "bottom boot sector" or "top boot
4335 sector" type flash chips, which have several smaller
4336 sectors at the start or the end. For instance, such a
4337 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4338 such a case you would place the environment in one of the
4339 4 kB sectors - with U-Boot code before and after it. With
4340 "top boot sector" type flash chips, you would put the
4341 environment in one of the last sectors, leaving a gap
4342 between U-Boot and the environment.
4343
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004344 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004345
4346 Offset of environment data (variable area) to the
4347 beginning of flash memory; for instance, with bottom boot
4348 type flash chips the second sector can be used: the offset
4349 for this sector is given here.
4350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004351 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004352
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004353 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004354
4355 This is just another way to specify the start address of
4356 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004357 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004358
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004359 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004360
4361 Size of the sector containing the environment.
4362
4363
4364 b) Sometimes flash chips have few, equal sized, BIG sectors.
4365 In such a case you don't want to spend a whole sector for
4366 the environment.
4367
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004368 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004369
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004370 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004371 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004372 of this flash sector for the environment. This saves
4373 memory for the RAM copy of the environment.
4374
4375 It may also save flash memory if you decide to use this
4376 when your environment is "embedded" within U-Boot code,
4377 since then the remainder of the flash sector could be used
4378 for U-Boot code. It should be pointed out that this is
4379 STRONGLY DISCOURAGED from a robustness point of view:
4380 updating the environment in flash makes it always
4381 necessary to erase the WHOLE sector. If something goes
4382 wrong before the contents has been restored from a copy in
4383 RAM, your target system will be dead.
4384
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004385 - CONFIG_ENV_ADDR_REDUND
4386 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk43d96162003-03-06 00:02:04 +00004388 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004389 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004390 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004391 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004392
4393BE CAREFUL! Any changes to the flash layout, and some changes to the
4394source code will make it necessary to adapt <board>/u-boot.lds*
4395accordingly!
4396
4397
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004398- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004399
4400 Define this if you have some non-volatile memory device
4401 (NVRAM, battery buffered SRAM) which you want to use for the
4402 environment.
4403
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004404 - CONFIG_ENV_ADDR:
4405 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004406
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004407 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004408 want to use for environment. It is assumed that this memory
4409 can just be read and written to, without any special
4410 provision.
4411
4412BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004413in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004414console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004415U-Boot will hang.
4416
4417Please note that even with NVRAM we still use a copy of the
4418environment in RAM: we could work on NVRAM directly, but we want to
4419keep settings there always unmodified except somebody uses "saveenv"
4420to save the current settings.
4421
4422
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004423- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004424
4425 Use this if you have an EEPROM or similar serial access
4426 device and a driver for it.
4427
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004428 - CONFIG_ENV_OFFSET:
4429 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004430
4431 These two #defines specify the offset and size of the
4432 environment area within the total memory of your EEPROM.
4433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004434 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004435 If defined, specified the chip address of the EEPROM device.
4436 The default address is zero.
4437
Christian Gmeiner189d2572015-02-11 15:19:31 +01004438 - CONFIG_SYS_I2C_EEPROM_BUS:
4439 If defined, specified the i2c bus of the EEPROM device.
4440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004441 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004442 If defined, the number of bits used to address bytes in a
4443 single page in the EEPROM device. A 64 byte page, for example
4444 would require six bits.
4445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004446 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004447 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004448 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004449
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004450 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004451 The length in bytes of the EEPROM memory array address. Note
4452 that this is NOT the chip address length!
4453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004454 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004455 EEPROM chips that implement "address overflow" are ones
4456 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4457 address and the extra bits end up in the "chip address" bit
4458 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4459 byte chips.
4460
4461 Note that we consider the length of the address field to
4462 still be one byte because the extra address bits are hidden
4463 in the chip address.
4464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004465 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004466 The size in bytes of the EEPROM device.
4467
Heiko Schocher548738b2010-01-07 08:55:40 +01004468 - CONFIG_ENV_EEPROM_IS_ON_I2C
4469 define this, if you have I2C and SPI activated, and your
4470 EEPROM, which holds the environment, is on the I2C bus.
4471
4472 - CONFIG_I2C_ENV_EEPROM_BUS
4473 if you have an Environment on an EEPROM reached over
4474 I2C muxes, you can define here, how to reach this
4475 EEPROM. For example:
4476
Heiko Schocherea818db2013-01-29 08:53:15 +01004477 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004478
4479 EEPROM which holds the environment, is reached over
4480 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004481
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004482- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004483
wdenkd4ca31c2004-01-02 14:00:00 +00004484 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004485 want to use for the environment.
4486
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004487 - CONFIG_ENV_OFFSET:
4488 - CONFIG_ENV_ADDR:
4489 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004490
4491 These three #defines specify the offset and size of the
4492 environment area within the total memory of your DataFlash placed
4493 at the specified address.
4494
Wu, Joshbd83b592014-07-01 19:30:13 +08004495- CONFIG_ENV_IS_IN_SPI_FLASH:
4496
4497 Define this if you have a SPI Flash memory device which you
4498 want to use for the environment.
4499
4500 - CONFIG_ENV_OFFSET:
4501 - CONFIG_ENV_SIZE:
4502
4503 These two #defines specify the offset and size of the
4504 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4505 aligned to an erase sector boundary.
4506
4507 - CONFIG_ENV_SECT_SIZE:
4508
4509 Define the SPI flash's sector size.
4510
4511 - CONFIG_ENV_OFFSET_REDUND (optional):
4512
4513 This setting describes a second storage area of CONFIG_ENV_SIZE
4514 size used to hold a redundant copy of the environment data, so
4515 that there is a valid backup copy in case there is a power failure
4516 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4517 aligned to an erase sector boundary.
4518
4519 - CONFIG_ENV_SPI_BUS (optional):
4520 - CONFIG_ENV_SPI_CS (optional):
4521
4522 Define the SPI bus and chip select. If not defined they will be 0.
4523
4524 - CONFIG_ENV_SPI_MAX_HZ (optional):
4525
4526 Define the SPI max work clock. If not defined then use 1MHz.
4527
4528 - CONFIG_ENV_SPI_MODE (optional):
4529
4530 Define the SPI work mode. If not defined then use SPI_MODE_3.
4531
Liu Gang0a85a9e2012-03-08 00:33:20 +00004532- CONFIG_ENV_IS_IN_REMOTE:
4533
4534 Define this if you have a remote memory space which you
4535 want to use for the local device's environment.
4536
4537 - CONFIG_ENV_ADDR:
4538 - CONFIG_ENV_SIZE:
4539
4540 These two #defines specify the address and size of the
4541 environment area within the remote memory space. The
4542 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004543 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004544
4545BE CAREFUL! For some special cases, the local device can not use
4546"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004547environment stored in a remote NOR flash by SRIO or PCIE link,
4548but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004549
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004550- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004551
4552 Define this if you have a NAND device which you want to use
4553 for the environment.
4554
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004555 - CONFIG_ENV_OFFSET:
4556 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004557
4558 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004559 area within the first NAND device. CONFIG_ENV_OFFSET must be
4560 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004561
Scott Woodfdd813d2010-09-17 14:38:37 -05004562 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004563
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004564 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004565 size used to hold a redundant copy of the environment data, so
4566 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004567 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004568 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004569
Scott Woodfdd813d2010-09-17 14:38:37 -05004570 - CONFIG_ENV_RANGE (optional):
4571
4572 Specifies the length of the region in which the environment
4573 can be written. This should be a multiple of the NAND device's
4574 block size. Specifying a range with more erase blocks than
4575 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4576 the range to be avoided.
4577
4578 - CONFIG_ENV_OFFSET_OOB (optional):
4579
4580 Enables support for dynamically retrieving the offset of the
4581 environment from block zero's out-of-band data. The
4582 "nand env.oob" command can be used to record this offset.
4583 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4584 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004585
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004586- CONFIG_NAND_ENV_DST
4587
4588 Defines address in RAM to which the nand_spl code should copy the
4589 environment. If redundant environment is used, it will be copied to
4590 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4591
Joe Hershberger2b744332013-04-08 10:32:51 +00004592- CONFIG_ENV_IS_IN_UBI:
4593
4594 Define this if you have an UBI volume that you want to use for the
4595 environment. This has the benefit of wear-leveling the environment
4596 accesses, which is important on NAND.
4597
4598 - CONFIG_ENV_UBI_PART:
4599
4600 Define this to a string that is the mtd partition containing the UBI.
4601
4602 - CONFIG_ENV_UBI_VOLUME:
4603
4604 Define this to the name of the volume that you want to store the
4605 environment in.
4606
Joe Hershberger785881f2013-04-08 10:32:52 +00004607 - CONFIG_ENV_UBI_VOLUME_REDUND:
4608
4609 Define this to the name of another volume to store a second copy of
4610 the environment in. This will enable redundant environments in UBI.
4611 It is assumed that both volumes are in the same MTD partition.
4612
Joe Hershberger2b744332013-04-08 10:32:51 +00004613 - CONFIG_UBI_SILENCE_MSG
4614 - CONFIG_UBIFS_SILENCE_MSG
4615
4616 You will probably want to define these to avoid a really noisy system
4617 when storing the env in UBI.
4618
Wu, Joshd1db76f2014-06-24 17:31:03 +08004619- CONFIG_ENV_IS_IN_FAT:
4620 Define this if you want to use the FAT file system for the environment.
4621
4622 - FAT_ENV_INTERFACE:
4623
4624 Define this to a string that is the name of the block device.
4625
4626 - FAT_ENV_DEV_AND_PART:
4627
4628 Define this to a string to specify the partition of the device. It can
4629 be as following:
4630
4631 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4632 - "D:P": device D partition P. Error occurs if device D has no
4633 partition table.
4634 - "D:0": device D.
4635 - "D" or "D:": device D partition 1 if device D has partition
4636 table, or the whole device D if has no partition
4637 table.
4638 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004639 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004640 partition table then means device D.
4641
4642 - FAT_ENV_FILE:
4643
4644 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004645 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004646
4647 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004648 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004649
Stephen Warren06e4ae52013-06-11 15:14:00 -06004650- CONFIG_ENV_IS_IN_MMC:
4651
4652 Define this if you have an MMC device which you want to use for the
4653 environment.
4654
4655 - CONFIG_SYS_MMC_ENV_DEV:
4656
4657 Specifies which MMC device the environment is stored in.
4658
4659 - CONFIG_SYS_MMC_ENV_PART (optional):
4660
4661 Specifies which MMC partition the environment is stored in. If not
4662 set, defaults to partition 0, the user area. Common values might be
4663 1 (first MMC boot partition), 2 (second MMC boot partition).
4664
4665 - CONFIG_ENV_OFFSET:
4666 - CONFIG_ENV_SIZE:
4667
4668 These two #defines specify the offset and size of the environment
4669 area within the specified MMC device.
4670
Stephen Warren5c088ee2013-06-11 15:14:02 -06004671 If offset is positive (the usual case), it is treated as relative to
4672 the start of the MMC partition. If offset is negative, it is treated
4673 as relative to the end of the MMC partition. This can be useful if
4674 your board may be fitted with different MMC devices, which have
4675 different sizes for the MMC partitions, and you always want the
4676 environment placed at the very end of the partition, to leave the
4677 maximum possible space before it, to store other data.
4678
Stephen Warren06e4ae52013-06-11 15:14:00 -06004679 These two values are in units of bytes, but must be aligned to an
4680 MMC sector boundary.
4681
4682 - CONFIG_ENV_OFFSET_REDUND (optional):
4683
4684 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4685 hold a redundant copy of the environment data. This provides a
4686 valid backup copy in case the other copy is corrupted, e.g. due
4687 to a power failure during a "saveenv" operation.
4688
Stephen Warren5c088ee2013-06-11 15:14:02 -06004689 This value may also be positive or negative; this is handled in the
4690 same way as CONFIG_ENV_OFFSET.
4691
Stephen Warren06e4ae52013-06-11 15:14:00 -06004692 This value is also in units of bytes, but must also be aligned to
4693 an MMC sector boundary.
4694
4695 - CONFIG_ENV_SIZE_REDUND (optional):
4696
4697 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4698 set. If this value is set, it must be set to the same value as
4699 CONFIG_ENV_SIZE.
4700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004701- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004702
4703 Defines offset to the initial SPI buffer area in DPRAM. The
4704 area is used at an early stage (ROM part) if the environment
4705 is configured to reside in the SPI EEPROM: We need a 520 byte
4706 scratch DPRAM area. It is used between the two initialization
4707 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4708 to be a good choice since it makes it far enough from the
4709 start of the data area as well as from the stack pointer.
4710
Bruce Adlere881cb52007-11-02 13:15:42 -07004711Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004712has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004713created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004714until then to read environment variables.
4715
wdenk85ec0bc2003-03-31 16:34:49 +00004716The environment is protected by a CRC32 checksum. Before the monitor
4717is relocated into RAM, as a result of a bad CRC you will be working
4718with the compiled-in default environment - *silently*!!! [This is
4719necessary, because the first environment variable we need is the
4720"baudrate" setting for the console - if we have a bad CRC, we don't
4721have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004722
4723Note: once the monitor has been relocated, then it will complain if
4724the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004725use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004727- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004728 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004729
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004730 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004731 also needs to be defined.
4732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004733- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004734 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004735
Ron Madridf5675aa2009-02-18 14:30:44 -08004736- CONFIG_NS16550_MIN_FUNCTIONS:
4737 Define this if you desire to only have use of the NS16550_init
4738 and NS16550_putc functions for the serial driver located at
4739 drivers/serial/ns16550.c. This option is useful for saving
4740 space for already greatly restricted images, including but not
4741 limited to NAND_SPL configurations.
4742
Simon Glassb2b92f52012-11-30 13:01:18 +00004743- CONFIG_DISPLAY_BOARDINFO
4744 Display information about the board that U-Boot is running on
4745 when U-Boot starts up. The board function checkboard() is called
4746 to do this.
4747
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004748- CONFIG_DISPLAY_BOARDINFO_LATE
4749 Similar to the previous option, but display this information
4750 later, once stdio is running and output goes to the LCD, if
4751 present.
4752
Sascha Silbefeb85802013-08-11 16:40:43 +02004753- CONFIG_BOARD_SIZE_LIMIT:
4754 Maximum size of the U-Boot image. When defined, the
4755 build system checks that the actual size does not
4756 exceed it.
4757
wdenkc6097192002-11-03 00:24:07 +00004758Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004759---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004760
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004761- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004762 Cache Line Size of the CPU.
4763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004764- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004765 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004766
wdenk42d1f032003-10-15 23:53:47 +00004767 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4768 and RPXsuper) to be able to adjust the position of
4769 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004770
Timur Tabie46fedf2011-08-04 18:03:41 -05004771- CONFIG_SYS_CCSRBAR_DEFAULT:
4772 Default (power-on reset) physical address of CCSR on Freescale
4773 PowerPC SOCs.
4774
4775- CONFIG_SYS_CCSRBAR:
4776 Virtual address of CCSR. On a 32-bit build, this is typically
4777 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4778
4779 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4780 for cross-platform code that uses that macro instead.
4781
4782- CONFIG_SYS_CCSRBAR_PHYS:
4783 Physical address of CCSR. CCSR can be relocated to a new
4784 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004785 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004786 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4787 is typically relocated on 36-bit builds. It is recommended
4788 that this macro be defined via the _HIGH and _LOW macros:
4789
4790 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4791 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4792
4793- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004794 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4795 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004796 used in assembly code, so it must not contain typecasts or
4797 integer size suffixes (e.g. "ULL").
4798
4799- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4800 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4801 used in assembly code, so it must not contain typecasts or
4802 integer size suffixes (e.g. "ULL").
4803
4804- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4805 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4806 forced to a value that ensures that CCSR is not relocated.
4807
wdenk7f6c2cb2002-11-10 22:06:23 +00004808- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004809 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004810
4811 the default drive number (default value 0)
4812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004813 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004814
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004815 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004816 (default value 1)
4817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004818 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004819
wdenk43d96162003-03-06 00:02:04 +00004820 defines the offset of register from address. It
4821 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004822 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004824 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4825 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004826 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004828 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004829 fdc_hw_init() is called at the beginning of the FDC
4830 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004831 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004832 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004833
Macpaul Lin0abddf82011-04-11 20:45:32 +00004834- CONFIG_IDE_AHB:
4835 Most IDE controllers were designed to be connected with PCI
4836 interface. Only few of them were designed for AHB interface.
4837 When software is doing ATA command and data transfer to
4838 IDE devices through IDE-AHB controller, some additional
4839 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004840 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004842- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004843 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004844 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004845
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004846- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004847
wdenk7152b1d2003-09-05 23:19:14 +00004848 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004849 initial data and stack; please note that this must be
4850 writable memory that is working WITHOUT special
4851 initialization, i. e. you CANNOT use normal RAM which
4852 will become available only after programming the
4853 memory controller and running certain initialization
4854 sequences.
4855
4856 U-Boot uses the following memory types:
4857 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4858 - MPC824X: data cache
4859 - PPC4xx: data cache
4860
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004861- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004862
4863 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004864 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4865 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004866 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004867 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004868 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4869 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4870 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004871
4872 Note:
4873 On the MPC824X (or other systems that use the data
4874 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004875 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004876 point to an otherwise UNUSED address space between
4877 the top of RAM and the start of the PCI space.
4878
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004879- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004881- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004882
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004883- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004885- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004887- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004889- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004891- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004892 SDRAM timing
4893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004894- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004895 periodic timer for refresh
4896
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004897- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004899- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4900 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4901 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4902 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004903 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4904
4905- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004906 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4907 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004908 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004910- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4911 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004912 Machine Mode Register and Memory Periodic Timer
4913 Prescaler definitions (SDRAM timing)
4914
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004915- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004916 enable I2C microcode relocation patch (MPC8xx);
4917 define relocation offset in DPRAM [DSP2]
4918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004919- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004920 enable SMC microcode relocation patch (MPC8xx);
4921 define relocation offset in DPRAM [SMC1]
4922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004923- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004924 enable SPI microcode relocation patch (MPC8xx);
4925 define relocation offset in DPRAM [SCC4]
4926
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004927- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004928 Use OSCM clock mode on MBX8xx board. Be careful,
4929 wrong setting might damage your board. Read
4930 doc/README.MBX before setting this variable!
4931
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004932- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004933 Offset of the bootmode word in DPRAM used by post
4934 (Power On Self Tests). This definition overrides
4935 #define'd default value in commproc.h resp.
4936 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004937
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004938- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4939 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4940 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4941 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4942 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4943 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4944 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4945 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004946 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004947
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004948- CONFIG_PCI_DISABLE_PCIE:
4949 Disable PCI-Express on systems where it is supported but not
4950 required.
4951
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004952- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004953 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004954 Don't do any setup work, presumably because someone or
4955 something has already done it, and we don't need to do it
4956 a second time. Useful for platforms that are pre-booted
4957 by coreboot or similar.
4958
Gabor Juhos842033e2013-05-30 07:06:12 +00004959- CONFIG_PCI_INDIRECT_BRIDGE:
4960 Enable support for indirect PCI bridges.
4961
Kumar Galaa09b9b62010-12-30 12:09:53 -06004962- CONFIG_SYS_SRIO:
4963 Chip has SRIO or not
4964
4965- CONFIG_SRIO1:
4966 Board has SRIO 1 port available
4967
4968- CONFIG_SRIO2:
4969 Board has SRIO 2 port available
4970
Liu Gangc8b28152013-05-07 16:30:46 +08004971- CONFIG_SRIO_PCIE_BOOT_MASTER
4972 Board can support master function for Boot from SRIO and PCIE
4973
Kumar Galaa09b9b62010-12-30 12:09:53 -06004974- CONFIG_SYS_SRIOn_MEM_VIRT:
4975 Virtual Address of SRIO port 'n' memory region
4976
4977- CONFIG_SYS_SRIOn_MEM_PHYS:
4978 Physical Address of SRIO port 'n' memory region
4979
4980- CONFIG_SYS_SRIOn_MEM_SIZE:
4981 Size of SRIO port 'n' memory region
4982
Fabio Estevam66bd1842013-04-11 09:35:34 +00004983- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4984 Defined to tell the NAND controller that the NAND chip is using
4985 a 16 bit bus.
4986 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004987 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004988 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004989 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004990
4991- CONFIG_SYS_NDFC_EBC0_CFG
4992 Sets the EBC0_CFG register for the NDFC. If not defined
4993 a default value will be used.
4994
Ben Warrenbb99ad62006-09-07 16:50:54 -04004995- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004996 Get DDR timing information from an I2C EEPROM. Common
4997 with pluggable memory modules such as SODIMMs
4998
Ben Warrenbb99ad62006-09-07 16:50:54 -04004999 SPD_EEPROM_ADDRESS
5000 I2C address of the SPD EEPROM
5001
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005002- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01005003 If SPD EEPROM is on an I2C bus other than the first
5004 one, specify here. Note that the value must resolve
5005 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04005006
York Sun1b3e3c42011-06-07 09:42:16 +08005007- CONFIG_SYS_DDR_RAW_TIMING
5008 Get DDR timing information from other than SPD. Common with
5009 soldered DDR chips onboard without SPD. DDR raw timing
5010 parameters are extracted from datasheet and hard-coded into
5011 header files or board specific files.
5012
York Sun6f5e1dc2011-09-16 13:21:35 -07005013- CONFIG_FSL_DDR_INTERACTIVE
5014 Enable interactive DDR debugging. See doc/README.fsl-ddr.
5015
York Sune32d59a2015-01-06 13:18:55 -08005016- CONFIG_FSL_DDR_SYNC_REFRESH
5017 Enable sync of refresh for multiple controllers.
5018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005019- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01005020 Only for 83xx systems. If specified, then DDR should
5021 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06005022
wdenkc26e4542004-04-18 10:13:26 +00005023- CONFIG_ETHER_ON_FEC[12]
5024 Define to enable FEC[12] on a 8xx series processor.
5025
5026- CONFIG_FEC[12]_PHY
5027 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00005028 to the given FEC; i. e.
5029 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00005030 means that the PHY with address 4 is connected to FEC1
5031
5032 When set to -1, means to probe for first available.
5033
5034- CONFIG_FEC[12]_PHY_NORXERR
5035 The PHY does not have a RXERR line (RMII only).
5036 (so program the FEC to ignore it).
5037
5038- CONFIG_RMII
5039 Enable RMII mode for all FECs.
5040 Note that this is a global option, we can't
5041 have one FEC in standard MII mode and another in RMII mode.
5042
wdenk5cf91d62004-04-23 20:32:05 +00005043- CONFIG_CRC32_VERIFY
5044 Add a verify option to the crc32 command.
5045 The syntax is:
5046
5047 => crc32 -v <address> <count> <crc32>
5048
5049 Where address/count indicate a memory area
5050 and crc32 is the correct crc32 which the
5051 area should have.
5052
wdenk56523f12004-07-11 17:40:54 +00005053- CONFIG_LOOPW
5054 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05005055 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00005056
stroese7b466642004-12-16 18:46:55 +00005057- CONFIG_MX_CYCLIC
5058 Add the "mdc" and "mwc" memory commands. These are cyclic
5059 "md/mw" commands.
5060 Examples:
5061
wdenkefe2a4d2004-12-16 21:44:03 +00005062 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00005063 This command will print 4 bytes (10,11,12,13) each 500 ms.
5064
wdenkefe2a4d2004-12-16 21:44:03 +00005065 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00005066 This command will write 12345678 to address 100 all 10 ms.
5067
wdenkefe2a4d2004-12-16 21:44:03 +00005068 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05005069 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00005070
wdenk8aa1a2d2005-04-04 12:44:11 +00005071- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00005072 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01005073 low level initializations (like setting up the memory
5074 controller) are omitted and/or U-Boot does not
5075 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00005076
Wolfgang Denk844f07d2010-11-27 23:30:56 +01005077 Normally this variable MUST NOT be defined. The only
5078 exception is when U-Boot is loaded (to RAM) by some
5079 other boot loader or by a debugger which performs
5080 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00005081
Aneesh V401bb302011-07-13 05:11:07 +00005082- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02005083 Modifies the behaviour of start.S when compiling a loader
5084 that is executed before the actual U-Boot. E.g. when
5085 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00005086
Ying Zhang3aa29de2013-08-16 15:16:15 +08005087- CONFIG_TPL_BUILD
5088 Modifies the behaviour of start.S when compiling a loader
5089 that is executed after the SPL and before the actual U-Boot.
5090 It is loaded by the SPL.
5091
Ying Zhang5df572f2013-05-20 14:07:23 +08005092- CONFIG_SYS_MPC85XX_NO_RESETVEC
5093 Only for 85xx systems. If this variable is specified, the section
5094 .resetvec is not kept and the section .bootpg is placed in the
5095 previous 4k of the .text section.
5096
Simon Glass4213fc22013-02-24 17:33:14 +00005097- CONFIG_ARCH_MAP_SYSMEM
5098 Generally U-Boot (and in particular the md command) uses
5099 effective address. It is therefore not necessary to regard
5100 U-Boot address as virtual addresses that need to be translated
5101 to physical addresses. However, sandbox requires this, since
5102 it maintains its own little RAM buffer which contains all
5103 addressable memory. This option causes some memory accesses
5104 to be mapped through map_sysmem() / unmap_sysmem().
5105
Matthias Weisserd8834a12011-03-10 21:36:32 +00005106- CONFIG_USE_ARCH_MEMCPY
5107 CONFIG_USE_ARCH_MEMSET
5108 If these options are used a optimized version of memcpy/memset will
5109 be used if available. These functions may be faster under some
5110 conditions but may increase the binary size.
5111
Simon Glass588a13f2013-02-14 04:18:54 +00005112- CONFIG_X86_RESET_VECTOR
5113 If defined, the x86 reset vector code is included. This is not
5114 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00005115
Mark Jacksonfc337052013-03-04 01:27:20 +00005116- CONFIG_SYS_MPUCLK
5117 Defines the MPU clock speed (in MHz).
5118
5119 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00005120
Heiko Schocher16678eb2013-11-04 14:05:00 +01005121- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5122 Enables the RTC32K OSC on AM33xx based plattforms
5123
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04005124- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5125 Option to disable subpage write in NAND driver
5126 driver that uses this:
5127 drivers/mtd/nand/davinci_nand.c
5128
Timur Tabif2717b42011-11-22 09:21:25 -06005129Freescale QE/FMAN Firmware Support:
5130-----------------------------------
5131
5132The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5133loading of "firmware", which is encoded in the QE firmware binary format.
5134This firmware often needs to be loaded during U-Boot booting, so macros
5135are used to identify the storage device (NOR flash, SPI, etc) and the address
5136within that device.
5137
Zhao Qiangdcf1d772014-03-21 16:21:44 +08005138- CONFIG_SYS_FMAN_FW_ADDR
5139 The address in the storage device where the FMAN microcode is located. The
5140 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5141 is also specified.
5142
5143- CONFIG_SYS_QE_FW_ADDR
5144 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005145 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5146 is also specified.
5147
5148- CONFIG_SYS_QE_FMAN_FW_LENGTH
5149 The maximum possible size of the firmware. The firmware binary format
5150 has a field that specifies the actual size of the firmware, but it
5151 might not be possible to read any part of the firmware unless some
5152 local storage is allocated to hold the entire firmware first.
5153
5154- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5155 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5156 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5157 virtual address in NOR flash.
5158
5159- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5160 Specifies that QE/FMAN firmware is located in NAND flash.
5161 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5162
5163- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5164 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5165 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5166
5167- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5168 Specifies that QE/FMAN firmware is located on the primary SPI
5169 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5170
Liu Gang292dc6c2012-03-08 00:33:18 +00005171- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5172 Specifies that QE/FMAN firmware is located in the remote (master)
5173 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005174 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5175 window->master inbound window->master LAW->the ucode address in
5176 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005177
J. German Riverab940ca62014-06-23 15:15:55 -07005178Freescale Layerscape Management Complex Firmware Support:
5179---------------------------------------------------------
5180The Freescale Layerscape Management Complex (MC) supports the loading of
5181"firmware".
5182This firmware often needs to be loaded during U-Boot booting, so macros
5183are used to identify the storage device (NOR flash, SPI, etc) and the address
5184within that device.
5185
5186- CONFIG_FSL_MC_ENET
5187 Enable the MC driver for Layerscape SoCs.
5188
5189- CONFIG_SYS_LS_MC_FW_ADDR
5190 The address in the storage device where the firmware is located. The
5191 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5192 is also specified.
5193
5194- CONFIG_SYS_LS_MC_FW_LENGTH
5195 The maximum possible size of the firmware. The firmware binary format
5196 has a field that specifies the actual size of the firmware, but it
5197 might not be possible to read any part of the firmware unless some
5198 local storage is allocated to hold the entire firmware first.
5199
5200- CONFIG_SYS_LS_MC_FW_IN_NOR
5201 Specifies that MC firmware is located in NOR flash, mapped as
5202 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5203 virtual address in NOR flash.
5204
wdenkc6097192002-11-03 00:24:07 +00005205Building the Software:
5206======================
5207
Wolfgang Denk218ca722008-03-26 10:40:12 +01005208Building U-Boot has been tested in several native build environments
5209and in many different cross environments. Of course we cannot support
5210all possibly existing versions of cross development tools in all
5211(potentially obsolete) versions. In case of tool chain problems we
5212recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5213which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005214
Wolfgang Denk218ca722008-03-26 10:40:12 +01005215If you are not using a native environment, it is assumed that you
5216have GNU cross compiling tools available in your path. In this case,
5217you must set the environment variable CROSS_COMPILE in your shell.
5218Note that no changes to the Makefile or any other source files are
5219necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005220
Wolfgang Denk218ca722008-03-26 10:40:12 +01005221 $ CROSS_COMPILE=ppc_4xx-
5222 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005223
Peter Tyser2f8d3962009-03-13 18:54:51 -05005224Note: If you wish to generate Windows versions of the utilities in
5225 the tools directory you can use the MinGW toolchain
5226 (http://www.mingw.org). Set your HOST tools to the MinGW
5227 toolchain and execute 'make tools'. For example:
5228
5229 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5230
5231 Binaries such as tools/mkimage.exe will be created which can
5232 be executed on computers running Windows.
5233
Wolfgang Denk218ca722008-03-26 10:40:12 +01005234U-Boot is intended to be simple to build. After installing the
5235sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005236is done by typing:
5237
Holger Freytherab584d62014-08-04 09:26:05 +02005238 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005239
Holger Freytherab584d62014-08-04 09:26:05 +02005240where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005241rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005242
wdenk2729af92004-05-03 20:45:30 +00005243Note: for some board special configuration names may exist; check if
5244 additional information is available from the board vendor; for
5245 instance, the TQM823L systems are available without (standard)
5246 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005247 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005248
Holger Freytherab584d62014-08-04 09:26:05 +02005249 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005250 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005251
Holger Freytherab584d62014-08-04 09:26:05 +02005252 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005253 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005254
wdenk2729af92004-05-03 20:45:30 +00005255 etc.
wdenkc6097192002-11-03 00:24:07 +00005256
wdenkc6097192002-11-03 00:24:07 +00005257
wdenk2729af92004-05-03 20:45:30 +00005258Finally, type "make all", and you should get some working U-Boot
5259images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk2729af92004-05-03 20:45:30 +00005261- "u-boot.bin" is a raw binary image
5262- "u-boot" is an image in ELF binary format
5263- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005264
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005265By default the build is performed locally and the objects are saved
5266in the source directory. One of the two methods can be used to change
5267this behavior and build U-Boot to some external directory:
5268
52691. Add O= to the make command line invocations:
5270
5271 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005272 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005273 make O=/tmp/build all
5274
Timo Ketolaadbba992014-11-06 14:39:05 +020052752. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005276
Timo Ketolaadbba992014-11-06 14:39:05 +02005277 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005278 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005279 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005280 make all
5281
Timo Ketolaadbba992014-11-06 14:39:05 +02005282Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005283variable.
5284
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk2729af92004-05-03 20:45:30 +00005286Please be aware that the Makefiles assume you are using GNU make, so
5287for instance on NetBSD you might need to use "gmake" instead of
5288native "make".
wdenkc6097192002-11-03 00:24:07 +00005289
wdenkc6097192002-11-03 00:24:07 +00005290
wdenk2729af92004-05-03 20:45:30 +00005291If the system board that you have is not listed, then you will need
5292to port U-Boot to your hardware platform. To do this, follow these
5293steps:
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk2729af92004-05-03 20:45:30 +000052951. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005296 "boards.cfg" file, using the existing entries as examples.
5297 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000052982. Create a new directory to hold your board specific code. Add any
5299 files you need. In your board directory, you will need at least
5300 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
53013. Create a new configuration file "include/configs/<board>.h" for
5302 your board
53033. If you're porting U-Boot to a new CPU, then also create a new
5304 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020053054. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000053065. Type "make", and you should get a working "u-boot.srec" file
5307 to be installed on your target system.
53086. Debug and solve any problems that might arise.
5309 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005310
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk2729af92004-05-03 20:45:30 +00005312Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5313==============================================================
wdenkc6097192002-11-03 00:24:07 +00005314
Wolfgang Denk218ca722008-03-26 10:40:12 +01005315If you have modified U-Boot sources (for instance added a new board
5316or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005317provide feedback to the other developers. The feedback normally takes
5318the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005319official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005320
Wolfgang Denk218ca722008-03-26 10:40:12 +01005321But before you submit such a patch, please verify that your modifi-
5322cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005323the supported boards compile WITHOUT ANY compiler warnings. To do so,
5324just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005325for ALL supported system. Be warned, this will take a while. You can
5326select which (cross) compiler to use by passing a `CROSS_COMPILE'
5327environment variable to the script, i. e. to use the ELDK cross tools
5328you can type
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk2729af92004-05-03 20:45:30 +00005330 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005331
wdenk2729af92004-05-03 20:45:30 +00005332or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk2729af92004-05-03 20:45:30 +00005334 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005335
Wolfgang Denk218ca722008-03-26 10:40:12 +01005336When using the MAKEALL script, the default behaviour is to build
5337U-Boot in the source directory. This location can be changed by
5338setting the BUILD_DIR environment variable. Also, for each target
5339built, the MAKEALL script saves two log files (<target>.ERR and
5340<target>.MAKEALL) in the <source dir>/LOG directory. This default
5341location can be changed by setting the MAKEALL_LOGDIR environment
5342variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005343
5344 export BUILD_DIR=/tmp/build
5345 export MAKEALL_LOGDIR=/tmp/log
5346 CROSS_COMPILE=ppc_8xx- MAKEALL
5347
Wolfgang Denk218ca722008-03-26 10:40:12 +01005348With the above settings build objects are saved in the /tmp/build,
5349log files are saved in the /tmp/log and the source tree remains clean
5350during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005351
5352
wdenk2729af92004-05-03 20:45:30 +00005353See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005354
wdenkc6097192002-11-03 00:24:07 +00005355
wdenk2729af92004-05-03 20:45:30 +00005356Monitor Commands - Overview:
5357============================
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk2729af92004-05-03 20:45:30 +00005359go - start application at address 'addr'
5360run - run commands in an environment variable
5361bootm - boot application image from memory
5362bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005363bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005364tftpboot- boot image via network using TFTP protocol
5365 and env variables "ipaddr" and "serverip"
5366 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005367tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005368rarpboot- boot image via network using RARP/TFTP protocol
5369diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5370loads - load S-Record file over serial line
5371loadb - load binary file over serial line (kermit mode)
5372md - memory display
5373mm - memory modify (auto-incrementing)
5374nm - memory modify (constant address)
5375mw - memory write (fill)
5376cp - memory copy
5377cmp - memory compare
5378crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005379i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005380sspi - SPI utility commands
5381base - print or set address offset
5382printenv- print environment variables
5383setenv - set environment variables
5384saveenv - save environment variables to persistent storage
5385protect - enable or disable FLASH write protection
5386erase - erase FLASH memory
5387flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005388nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005389bdinfo - print Board Info structure
5390iminfo - print header information for application image
5391coninfo - print console devices and informations
5392ide - IDE sub-system
5393loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005394loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005395mtest - simple RAM test
5396icache - enable or disable instruction cache
5397dcache - enable or disable data cache
5398reset - Perform RESET of the CPU
5399echo - echo args to console
5400version - print monitor version
5401help - print online help
5402? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005403
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk2729af92004-05-03 20:45:30 +00005405Monitor Commands - Detailed Description:
5406========================================
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk2729af92004-05-03 20:45:30 +00005408TODO.
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk2729af92004-05-03 20:45:30 +00005410For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005411
5412
wdenk2729af92004-05-03 20:45:30 +00005413Environment Variables:
5414======================
wdenkc6097192002-11-03 00:24:07 +00005415
wdenk2729af92004-05-03 20:45:30 +00005416U-Boot supports user configuration using Environment Variables which
5417can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005418
wdenk2729af92004-05-03 20:45:30 +00005419Environment Variables are set using "setenv", printed using
5420"printenv", and saved to Flash using "saveenv". Using "setenv"
5421without a value can be used to delete a variable from the
5422environment. As long as you don't save the environment you are
5423working with an in-memory copy. In case the Flash area containing the
5424environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005425
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005426Some configuration options can be set using Environment Variables.
5427
5428List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk2729af92004-05-03 20:45:30 +00005430 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005431
wdenk2729af92004-05-03 20:45:30 +00005432 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005433
wdenk2729af92004-05-03 20:45:30 +00005434 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005435
wdenk2729af92004-05-03 20:45:30 +00005436 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk2729af92004-05-03 20:45:30 +00005438 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005439
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005440 bootm_low - Memory range available for image processing in the bootm
5441 command can be restricted. This variable is given as
5442 a hexadecimal number and defines lowest address allowed
5443 for use by the bootm command. See also "bootm_size"
5444 environment variable. Address defined by "bootm_low" is
5445 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005446 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5447 bootm_mapsize.
5448
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005449 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005450 This variable is given as a hexadecimal number and it
5451 defines the size of the memory region starting at base
5452 address bootm_low that is accessible by the Linux kernel
5453 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5454 as the default value if it is defined, and bootm_size is
5455 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005456
5457 bootm_size - Memory range available for image processing in the bootm
5458 command can be restricted. This variable is given as
5459 a hexadecimal number and defines the size of the region
5460 allowed for use by the bootm command. See also "bootm_low"
5461 environment variable.
5462
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005463 updatefile - Location of the software update file on a TFTP server, used
5464 by the automatic software update feature. Please refer to
5465 documentation in doc/README.update for more details.
5466
wdenk2729af92004-05-03 20:45:30 +00005467 autoload - if set to "no" (any string beginning with 'n'),
5468 "bootp" will just load perform a lookup of the
5469 configuration from the BOOTP server, but not try to
5470 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005471
wdenk2729af92004-05-03 20:45:30 +00005472 autostart - if set to "yes", an image loaded using the "bootp",
5473 "rarpboot", "tftpboot" or "diskboot" commands will
5474 be automatically started (by internally calling
5475 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005476
wdenk2729af92004-05-03 20:45:30 +00005477 If set to "no", a standalone image passed to the
5478 "bootm" command will be copied to the load address
5479 (and eventually uncompressed), but NOT be started.
5480 This can be used to load and uncompress arbitrary
5481 data.
wdenkc6097192002-11-03 00:24:07 +00005482
David A. Longa28afca2011-07-09 16:40:19 -04005483 fdt_high - if set this restricts the maximum address that the
5484 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005485 For example, if you have a system with 1 GB memory
5486 at physical address 0x10000000, while Linux kernel
5487 only recognizes the first 704 MB as low memory, you
5488 may need to set fdt_high as 0x3C000000 to have the
5489 device tree blob be copied to the maximum address
5490 of the 704 MB low memory, so that Linux kernel can
5491 access it during the boot procedure.
5492
David A. Longa28afca2011-07-09 16:40:19 -04005493 If this is set to the special value 0xFFFFFFFF then
5494 the fdt will not be copied at all on boot. For this
5495 to work it must reside in writable memory, have
5496 sufficient padding on the end of it for u-boot to
5497 add the information it needs into it, and the memory
5498 must be accessible by the kernel.
5499
Simon Glasseea63e02011-10-24 19:15:34 +00005500 fdtcontroladdr- if set this is the address of the control flattened
5501 device tree used by U-Boot when CONFIG_OF_CONTROL is
5502 defined.
5503
wdenk17ea1172004-06-06 21:51:03 +00005504 i2cfast - (PPC405GP|PPC405EP only)
5505 if set to 'y' configures Linux I2C driver for fast
5506 mode (400kHZ). This environment variable is used in
5507 initialization code. So, for changes to be effective
5508 it must be saved and board must be reset.
5509
wdenk2729af92004-05-03 20:45:30 +00005510 initrd_high - restrict positioning of initrd images:
5511 If this variable is not set, initrd images will be
5512 copied to the highest possible address in RAM; this
5513 is usually what you want since it allows for
5514 maximum initrd size. If for some reason you want to
5515 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005516 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005517 variable to a value of "no" or "off" or "0".
5518 Alternatively, you can set it to a maximum upper
5519 address to use (U-Boot will still check that it
5520 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005521
wdenk2729af92004-05-03 20:45:30 +00005522 For instance, when you have a system with 16 MB
5523 RAM, and want to reserve 4 MB from use by Linux,
5524 you can do this by adding "mem=12M" to the value of
5525 the "bootargs" variable. However, now you must make
5526 sure that the initrd image is placed in the first
5527 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk2729af92004-05-03 20:45:30 +00005529 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk2729af92004-05-03 20:45:30 +00005531 If you set initrd_high to 0xFFFFFFFF, this is an
5532 indication to U-Boot that all addresses are legal
5533 for the Linux kernel, including addresses in flash
5534 memory. In this case U-Boot will NOT COPY the
5535 ramdisk at all. This may be useful to reduce the
5536 boot time on your system, but requires that this
5537 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005538
wdenk2729af92004-05-03 20:45:30 +00005539 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005540
wdenk2729af92004-05-03 20:45:30 +00005541 loadaddr - Default load address for commands like "bootp",
5542 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk2729af92004-05-03 20:45:30 +00005546 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005547
wdenk2729af92004-05-03 20:45:30 +00005548 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk2729af92004-05-03 20:45:30 +00005552 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005553
Mike Frysingere2a53452011-10-02 10:01:27 +00005554 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005555
Mike Frysingere2a53452011-10-02 10:01:27 +00005556 ethact - controls which interface is currently active.
5557 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005558
Heiko Schocher48690d82010-07-20 17:45:02 +02005559 => setenv ethact FEC
5560 => ping 192.168.0.1 # traffic sent on FEC
5561 => setenv ethact SCC
5562 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005563
Matthias Fuchse1692572008-01-17 07:45:05 +01005564 ethrotate - When set to "no" U-Boot does not go through all
5565 available network interfaces.
5566 It just stays at the currently selected interface.
5567
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005568 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005569 either succeed or fail without retrying.
5570 When set to "once" the network operation will
5571 fail when all the available network interfaces
5572 are tried once without success.
5573 Useful on scripts which control the retry operation
5574 themselves.
wdenkc6097192002-11-03 00:24:07 +00005575
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005576 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005577
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005578 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005579 changing the console to be empty. If "yes" it will be
5580 made silent. If "no" it will not be made silent. If
5581 unset, then it will be made silent if the U-Boot console
5582 is silent.
5583
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005584 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005585 UDP source port.
5586
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005587 tftpdstport - If this is set, the value is used for TFTP's UDP
5588 destination port instead of the Well Know Port 69.
5589
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005590 tftpblocksize - Block size to use for TFTP transfers; if not set,
5591 we use the TFTP server's default block size
5592
5593 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5594 seconds, minimum value is 1000 = 1 second). Defines
5595 when a packet is considered to be lost so it has to
5596 be retransmitted. The default is 5000 = 5 seconds.
5597 Lowering this value may make downloads succeed
5598 faster in networks with high packet loss rates or
5599 with unreliable TFTP servers.
5600
5601 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005602 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005603 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005604
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005605The following image location variables contain the location of images
5606used in booting. The "Image" column gives the role of the image and is
5607not an environment variable name. The other columns are environment
5608variable names. "File Name" gives the name of the file on a TFTP
5609server, "RAM Address" gives the location in RAM the image will be
5610loaded to, and "Flash Location" gives the image's address in NOR
5611flash or offset in NAND flash.
5612
5613*Note* - these variables don't have to be defined for all boards, some
5614boards currenlty use other variables for these purposes, and some
5615boards use these variables for other purposes.
5616
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005617Image File Name RAM Address Flash Location
5618----- --------- ----------- --------------
5619u-boot u-boot u-boot_addr_r u-boot_addr
5620Linux kernel bootfile kernel_addr_r kernel_addr
5621device tree blob fdtfile fdt_addr_r fdt_addr
5622ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005623
wdenk2729af92004-05-03 20:45:30 +00005624The following environment variables may be used and automatically
5625updated by the network boot commands ("bootp" and "rarpboot"),
5626depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005627
wdenk2729af92004-05-03 20:45:30 +00005628 bootfile - see above
5629 dnsip - IP address of your Domain Name Server
5630 dnsip2 - IP address of your secondary Domain Name Server
5631 gatewayip - IP address of the Gateway (Router) to use
5632 hostname - Target hostname
5633 ipaddr - see above
5634 netmask - Subnet Mask
5635 rootpath - Pathname of the root filesystem on the NFS server
5636 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005637
wdenka3d991b2004-04-15 21:48:45 +00005638
wdenk2729af92004-05-03 20:45:30 +00005639There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk2729af92004-05-03 20:45:30 +00005641 serial# - contains hardware identification information such
5642 as type string and/or serial number
5643 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk2729af92004-05-03 20:45:30 +00005645These variables can be set only once (usually during manufacturing of
5646the board). U-Boot refuses to delete or overwrite these variables
5647once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005648
5649
wdenk2729af92004-05-03 20:45:30 +00005650Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652 ver - Contains the U-Boot version string as printed
5653 with the "version" command. This variable is
5654 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005655
wdenkc6097192002-11-03 00:24:07 +00005656
wdenk2729af92004-05-03 20:45:30 +00005657Please note that changes to some configuration parameters may take
5658only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005659
stroesec1551ea2003-04-04 15:53:41 +00005660
Joe Hershberger170ab112012-12-11 22:16:24 -06005661Callback functions for environment variables:
5662---------------------------------------------
5663
5664For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005665when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005666be associated with arbitrary variables. On creation, overwrite, or
5667deletion, the callback will provide the opportunity for some side
5668effect to happen or for the change to be rejected.
5669
5670The callbacks are named and associated with a function using the
5671U_BOOT_ENV_CALLBACK macro in your board or driver code.
5672
5673These callbacks are associated with variables in one of two ways. The
5674static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5675in the board configuration to a string that defines a list of
5676associations. The list must be in the following format:
5677
5678 entry = variable_name[:callback_name]
5679 list = entry[,list]
5680
5681If the callback name is not specified, then the callback is deleted.
5682Spaces are also allowed anywhere in the list.
5683
5684Callbacks can also be associated by defining the ".callbacks" variable
5685with the same list format above. Any association in ".callbacks" will
5686override any association in the static list. You can define
5687CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005688".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005689
5690
wdenk2729af92004-05-03 20:45:30 +00005691Command Line Parsing:
5692=====================
stroesec1551ea2003-04-04 15:53:41 +00005693
wdenk2729af92004-05-03 20:45:30 +00005694There are two different command line parsers available with U-Boot:
5695the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005696
wdenk2729af92004-05-03 20:45:30 +00005697Old, simple command line parser:
5698--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk2729af92004-05-03 20:45:30 +00005700- supports environment variables (through setenv / saveenv commands)
5701- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005702- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005703- special characters ('$', ';') can be escaped by prefixing with '\',
5704 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005705 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005706- You can also escape text by enclosing in single apostrophes, for example:
5707 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk2729af92004-05-03 20:45:30 +00005709Hush shell:
5710-----------
wdenkf07771c2003-05-28 08:06:31 +00005711
wdenk2729af92004-05-03 20:45:30 +00005712- similar to Bourne shell, with control structures like
5713 if...then...else...fi, for...do...done; while...do...done,
5714 until...do...done, ...
5715- supports environment ("global") variables (through setenv / saveenv
5716 commands) and local shell variables (through standard shell syntax
5717 "name=value"); only environment variables can be used with "run"
5718 command
wdenkf07771c2003-05-28 08:06:31 +00005719
wdenk2729af92004-05-03 20:45:30 +00005720General rules:
5721--------------
wdenkf07771c2003-05-28 08:06:31 +00005722
wdenk2729af92004-05-03 20:45:30 +00005723(1) If a command line (or an environment variable executed by a "run"
5724 command) contains several commands separated by semicolon, and
5725 one of these commands fails, then the remaining commands will be
5726 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005727
wdenk2729af92004-05-03 20:45:30 +00005728(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005729 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005730 command will cause "run" to terminate, i. e. the remaining
5731 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733Note for Redundant Ethernet Interfaces:
5734=======================================
wdenkf07771c2003-05-28 08:06:31 +00005735
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005736Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005737such configurations and is capable of automatic selection of a
5738"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005739
wdenk2729af92004-05-03 20:45:30 +00005740Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5741MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5742"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005743
wdenk2729af92004-05-03 20:45:30 +00005744If the network interface stores some valid MAC address (for instance
5745in SROM), this is used as default address if there is NO correspon-
5746ding setting in the environment; if the corresponding environment
5747variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005748
wdenk2729af92004-05-03 20:45:30 +00005749o If the SROM has a valid MAC address, and there is no address in the
5750 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752o If there is no valid address in the SROM, and a definition in the
5753 environment exists, then the value from the environment variable is
5754 used.
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk2729af92004-05-03 20:45:30 +00005756o If both the SROM and the environment contain a MAC address, and
5757 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005758
wdenk2729af92004-05-03 20:45:30 +00005759o If both the SROM and the environment contain a MAC address, and the
5760 addresses differ, the value from the environment is used and a
5761 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk2729af92004-05-03 20:45:30 +00005763o If neither SROM nor the environment contain a MAC address, an error
5764 is raised.
wdenkc6097192002-11-03 00:24:07 +00005765
Ben Warrenecee9322010-04-26 11:11:46 -07005766If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005767will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005768may be skipped by setting the appropriate 'ethmacskip' environment variable.
5769The naming convention is as follows:
5770"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk2729af92004-05-03 20:45:30 +00005772Image Formats:
5773==============
wdenkc6097192002-11-03 00:24:07 +00005774
Marian Balakowicz3310c542008-03-12 12:13:13 +01005775U-Boot is capable of booting (and performing other auxiliary operations on)
5776images in two formats:
5777
5778New uImage format (FIT)
5779-----------------------
5780
5781Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5782to Flattened Device Tree). It allows the use of images with multiple
5783components (several kernels, ramdisks, etc.), with contents protected by
5784SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5785
5786
5787Old uImage format
5788-----------------
5789
5790Old image format is based on binary files which can be basically anything,
5791preceded by a special header; see the definitions in include/image.h for
5792details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk2729af92004-05-03 20:45:30 +00005794* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5795 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005796 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5797 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5798 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005799* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005800 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5801 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005802* Compression Type (uncompressed, gzip, bzip2)
5803* Load Address
5804* Entry Point
5805* Image Name
5806* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005807
wdenk2729af92004-05-03 20:45:30 +00005808The header is marked by a special Magic Number, and both the header
5809and the data portions of the image are secured against corruption by
5810CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005811
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk2729af92004-05-03 20:45:30 +00005813Linux Support:
5814==============
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk2729af92004-05-03 20:45:30 +00005816Although U-Boot should support any OS or standalone application
5817easily, the main focus has always been on Linux during the design of
5818U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk2729af92004-05-03 20:45:30 +00005820U-Boot includes many features that so far have been part of some
5821special "boot loader" code within the Linux kernel. Also, any
5822"initrd" images to be used are no longer part of one big Linux image;
5823instead, kernel and "initrd" are separate images. This implementation
5824serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005825
wdenk2729af92004-05-03 20:45:30 +00005826- the same features can be used for other OS or standalone
5827 applications (for instance: using compressed images to reduce the
5828 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005829
wdenk2729af92004-05-03 20:45:30 +00005830- it becomes much easier to port new Linux kernel versions because
5831 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005832
wdenk2729af92004-05-03 20:45:30 +00005833- the same Linux kernel image can now be used with different "initrd"
5834 images; of course this also means that different kernel images can
5835 be run with the same "initrd". This makes testing easier (you don't
5836 have to build a new "zImage.initrd" Linux image when you just
5837 change a file in your "initrd"). Also, a field-upgrade of the
5838 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005839
wdenkc6097192002-11-03 00:24:07 +00005840
wdenk2729af92004-05-03 20:45:30 +00005841Linux HOWTO:
5842============
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk2729af92004-05-03 20:45:30 +00005844Porting Linux to U-Boot based systems:
5845---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk2729af92004-05-03 20:45:30 +00005847U-Boot cannot save you from doing all the necessary modifications to
5848configure the Linux device drivers for use with your target hardware
5849(no, we don't intend to provide a full virtual machine interface to
5850Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005851
Stefan Roesea47a12b2010-04-15 16:07:28 +02005852But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk2729af92004-05-03 20:45:30 +00005854Just make sure your machine specific header file (for instance
5855include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005856Information structure as we define in include/asm-<arch>/u-boot.h,
5857and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005858as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005859
Simon Glass2eb31b12014-06-11 23:29:46 -06005860Note that U-Boot now has a driver model, a unified model for drivers.
5861If you are adding a new driver, plumb it into driver model. If there
5862is no uclass available, you are encouraged to create one. See
5863doc/driver-model.
5864
wdenkc6097192002-11-03 00:24:07 +00005865
wdenk2729af92004-05-03 20:45:30 +00005866Configuring the Linux kernel:
5867-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005868
wdenk2729af92004-05-03 20:45:30 +00005869No specific requirements for U-Boot. Make sure you have some root
5870device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005871
wdenkc6097192002-11-03 00:24:07 +00005872
wdenk2729af92004-05-03 20:45:30 +00005873Building a Linux Image:
5874-----------------------
wdenkc6097192002-11-03 00:24:07 +00005875
wdenk2729af92004-05-03 20:45:30 +00005876With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5877not used. If you use recent kernel source, a new build target
5878"uImage" will exist which automatically builds an image usable by
5879U-Boot. Most older kernels also have support for a "pImage" target,
5880which was introduced for our predecessor project PPCBoot and uses a
5881100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005882
wdenk2729af92004-05-03 20:45:30 +00005883Example:
wdenkc6097192002-11-03 00:24:07 +00005884
Holger Freytherab584d62014-08-04 09:26:05 +02005885 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005886 make oldconfig
5887 make dep
5888 make uImage
wdenkc6097192002-11-03 00:24:07 +00005889
wdenk2729af92004-05-03 20:45:30 +00005890The "uImage" build target uses a special tool (in 'tools/mkimage') to
5891encapsulate a compressed Linux kernel image with header information,
5892CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk2729af92004-05-03 20:45:30 +00005894* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005895
wdenk2729af92004-05-03 20:45:30 +00005896* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005897
wdenk2729af92004-05-03 20:45:30 +00005898 ${CROSS_COMPILE}-objcopy -O binary \
5899 -R .note -R .comment \
5900 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk2729af92004-05-03 20:45:30 +00005902* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005903
wdenk2729af92004-05-03 20:45:30 +00005904 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005905
wdenk2729af92004-05-03 20:45:30 +00005906* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005907
wdenk2729af92004-05-03 20:45:30 +00005908 mkimage -A ppc -O linux -T kernel -C gzip \
5909 -a 0 -e 0 -n "Linux Kernel Image" \
5910 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005911
wdenk24ee89b2002-11-03 17:56:27 +00005912
wdenk2729af92004-05-03 20:45:30 +00005913The "mkimage" tool can also be used to create ramdisk images for use
5914with U-Boot, either separated from the Linux kernel image, or
5915combined into one file. "mkimage" encapsulates the images with a 64
5916byte header containing information about target architecture,
5917operating system, image type, compression method, entry points, time
5918stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005919
wdenk2729af92004-05-03 20:45:30 +00005920"mkimage" can be called in two ways: to verify existing images and
5921print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005922
wdenk2729af92004-05-03 20:45:30 +00005923In the first form (with "-l" option) mkimage lists the information
5924contained in the header of an existing U-Boot image; this includes
5925checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005926
wdenk2729af92004-05-03 20:45:30 +00005927 tools/mkimage -l image
5928 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005929
wdenk2729af92004-05-03 20:45:30 +00005930The second form (with "-d" option) is used to build a U-Boot image
5931from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005932
wdenk2729af92004-05-03 20:45:30 +00005933 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5934 -n name -d data_file image
5935 -A ==> set architecture to 'arch'
5936 -O ==> set operating system to 'os'
5937 -T ==> set image type to 'type'
5938 -C ==> set compression type 'comp'
5939 -a ==> set load address to 'addr' (hex)
5940 -e ==> set entry point to 'ep' (hex)
5941 -n ==> set image name to 'name'
5942 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005943
wdenk69459792004-05-29 16:53:29 +00005944Right now, all Linux kernels for PowerPC systems use the same load
5945address (0x00000000), but the entry point address depends on the
5946kernel version:
wdenkc6097192002-11-03 00:24:07 +00005947
wdenk2729af92004-05-03 20:45:30 +00005948- 2.2.x kernels have the entry point at 0x0000000C,
5949- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005950
wdenk2729af92004-05-03 20:45:30 +00005951So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005952
wdenk2729af92004-05-03 20:45:30 +00005953 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5954 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005955 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005956 > examples/uImage.TQM850L
5957 Image Name: 2.4.4 kernel for TQM850L
5958 Created: Wed Jul 19 02:34:59 2000
5959 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5960 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5961 Load Address: 0x00000000
5962 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005963
wdenk2729af92004-05-03 20:45:30 +00005964To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk2729af92004-05-03 20:45:30 +00005966 -> tools/mkimage -l examples/uImage.TQM850L
5967 Image Name: 2.4.4 kernel for TQM850L
5968 Created: Wed Jul 19 02:34:59 2000
5969 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5970 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5971 Load Address: 0x00000000
5972 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005973
wdenk2729af92004-05-03 20:45:30 +00005974NOTE: for embedded systems where boot time is critical you can trade
5975speed for memory and install an UNCOMPRESSED image instead: this
5976needs more space in Flash, but boots much faster since it does not
5977need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005978
Stefan Roesea47a12b2010-04-15 16:07:28 +02005979 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005980 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5981 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005982 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005983 > examples/uImage.TQM850L-uncompressed
5984 Image Name: 2.4.4 kernel for TQM850L
5985 Created: Wed Jul 19 02:34:59 2000
5986 Image Type: PowerPC Linux Kernel Image (uncompressed)
5987 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5988 Load Address: 0x00000000
5989 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005990
wdenkc6097192002-11-03 00:24:07 +00005991
wdenk2729af92004-05-03 20:45:30 +00005992Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5993when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005994
wdenk2729af92004-05-03 20:45:30 +00005995 -> tools/mkimage -n 'Simple Ramdisk Image' \
5996 > -A ppc -O linux -T ramdisk -C gzip \
5997 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5998 Image Name: Simple Ramdisk Image
5999 Created: Wed Jan 12 14:01:50 2000
6000 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6001 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
6002 Load Address: 0x00000000
6003 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00006004
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07006005The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
6006option performs the converse operation of the mkimage's second form (the "-d"
6007option). Given an image built by mkimage, the dumpimage extracts a "data file"
6008from the image:
6009
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02006010 tools/dumpimage -i image -T type -p position data_file
6011 -i ==> extract from the 'image' a specific 'data_file'
6012 -T ==> set image type to 'type'
6013 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07006014
wdenkdb01a2e2004-04-15 23:14:49 +00006015
wdenk2729af92004-05-03 20:45:30 +00006016Installing a Linux Image:
6017-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00006018
wdenk2729af92004-05-03 20:45:30 +00006019To downloading a U-Boot image over the serial (console) interface,
6020you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00006021
wdenk2729af92004-05-03 20:45:30 +00006022 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00006023
wdenk2729af92004-05-03 20:45:30 +00006024The 'objcopy' does not understand the information in the U-Boot
6025image header, so the resulting S-Record file will be relative to
6026address 0x00000000. To load it to a given address, you need to
6027specify the target address as 'offset' parameter with the 'loads'
6028command.
wdenkc6097192002-11-03 00:24:07 +00006029
wdenk2729af92004-05-03 20:45:30 +00006030Example: install the image to address 0x40100000 (which on the
6031TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00006032
wdenk2729af92004-05-03 20:45:30 +00006033 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00006034
wdenk2729af92004-05-03 20:45:30 +00006035 .......... done
6036 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00006037
wdenk2729af92004-05-03 20:45:30 +00006038 => loads 40100000
6039 ## Ready for S-Record download ...
6040 ~>examples/image.srec
6041 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
6042 ...
6043 15989 15990 15991 15992
6044 [file transfer complete]
6045 [connected]
6046 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00006047
6048
wdenk2729af92004-05-03 20:45:30 +00006049You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01006050this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00006051corruption happened:
wdenkc6097192002-11-03 00:24:07 +00006052
wdenk2729af92004-05-03 20:45:30 +00006053 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00006054
wdenk2729af92004-05-03 20:45:30 +00006055 ## Checking Image at 40100000 ...
6056 Image Name: 2.2.13 for initrd on TQM850L
6057 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6058 Data Size: 335725 Bytes = 327 kB = 0 MB
6059 Load Address: 00000000
6060 Entry Point: 0000000c
6061 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006062
6063
wdenk2729af92004-05-03 20:45:30 +00006064Boot Linux:
6065-----------
wdenkc6097192002-11-03 00:24:07 +00006066
wdenk2729af92004-05-03 20:45:30 +00006067The "bootm" command is used to boot an application that is stored in
6068memory (RAM or Flash). In case of a Linux kernel image, the contents
6069of the "bootargs" environment variable is passed to the kernel as
6070parameters. You can check and modify this variable using the
6071"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00006072
6073
wdenk2729af92004-05-03 20:45:30 +00006074 => printenv bootargs
6075 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00006076
wdenk2729af92004-05-03 20:45:30 +00006077 => 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 +00006078
wdenk2729af92004-05-03 20:45:30 +00006079 => printenv bootargs
6080 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 +00006081
wdenk2729af92004-05-03 20:45:30 +00006082 => bootm 40020000
6083 ## Booting Linux kernel at 40020000 ...
6084 Image Name: 2.2.13 for NFS on TQM850L
6085 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6086 Data Size: 381681 Bytes = 372 kB = 0 MB
6087 Load Address: 00000000
6088 Entry Point: 0000000c
6089 Verifying Checksum ... OK
6090 Uncompressing Kernel Image ... OK
6091 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
6092 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6093 time_init: decrementer frequency = 187500000/60
6094 Calibrating delay loop... 49.77 BogoMIPS
6095 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6096 ...
wdenkc6097192002-11-03 00:24:07 +00006097
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006098If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00006099the memory addresses of both the kernel and the initrd image (PPBCOOT
6100format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00006101
wdenk2729af92004-05-03 20:45:30 +00006102 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006103
wdenk2729af92004-05-03 20:45:30 +00006104 ## Checking Image at 40100000 ...
6105 Image Name: 2.2.13 for initrd on TQM850L
6106 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6107 Data Size: 335725 Bytes = 327 kB = 0 MB
6108 Load Address: 00000000
6109 Entry Point: 0000000c
6110 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006111
wdenk2729af92004-05-03 20:45:30 +00006112 ## Checking Image at 40200000 ...
6113 Image Name: Simple Ramdisk Image
6114 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6115 Data Size: 566530 Bytes = 553 kB = 0 MB
6116 Load Address: 00000000
6117 Entry Point: 00000000
6118 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006119
wdenk2729af92004-05-03 20:45:30 +00006120 => bootm 40100000 40200000
6121 ## Booting Linux kernel at 40100000 ...
6122 Image Name: 2.2.13 for initrd on TQM850L
6123 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6124 Data Size: 335725 Bytes = 327 kB = 0 MB
6125 Load Address: 00000000
6126 Entry Point: 0000000c
6127 Verifying Checksum ... OK
6128 Uncompressing Kernel Image ... OK
6129 ## Loading RAMDisk Image at 40200000 ...
6130 Image Name: Simple Ramdisk Image
6131 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6132 Data Size: 566530 Bytes = 553 kB = 0 MB
6133 Load Address: 00000000
6134 Entry Point: 00000000
6135 Verifying Checksum ... OK
6136 Loading Ramdisk ... OK
6137 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
6138 Boot arguments: root=/dev/ram
6139 time_init: decrementer frequency = 187500000/60
6140 Calibrating delay loop... 49.77 BogoMIPS
6141 ...
6142 RAMDISK: Compressed image found at block 0
6143 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006144
wdenk2729af92004-05-03 20:45:30 +00006145 bash#
wdenkc6097192002-11-03 00:24:07 +00006146
Matthew McClintock02677682006-06-28 10:41:37 -05006147Boot Linux and pass a flat device tree:
6148-----------
6149
6150First, U-Boot must be compiled with the appropriate defines. See the section
6151titled "Linux Kernel Interface" above for a more in depth explanation. The
6152following is an example of how to start a kernel and pass an updated
6153flat device tree:
6154
6155=> print oftaddr
6156oftaddr=0x300000
6157=> print oft
6158oft=oftrees/mpc8540ads.dtb
6159=> tftp $oftaddr $oft
6160Speed: 1000, full duplex
6161Using TSEC0 device
6162TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6163Filename 'oftrees/mpc8540ads.dtb'.
6164Load address: 0x300000
6165Loading: #
6166done
6167Bytes transferred = 4106 (100a hex)
6168=> tftp $loadaddr $bootfile
6169Speed: 1000, full duplex
6170Using TSEC0 device
6171TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6172Filename 'uImage'.
6173Load address: 0x200000
6174Loading:############
6175done
6176Bytes transferred = 1029407 (fb51f hex)
6177=> print loadaddr
6178loadaddr=200000
6179=> print oftaddr
6180oftaddr=0x300000
6181=> bootm $loadaddr - $oftaddr
6182## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006183 Image Name: Linux-2.6.17-dirty
6184 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6185 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006186 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006187 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006188 Verifying Checksum ... OK
6189 Uncompressing Kernel Image ... OK
6190Booting using flat device tree at 0x300000
6191Using MPC85xx ADS machine description
6192Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6193[snip]
6194
6195
wdenk2729af92004-05-03 20:45:30 +00006196More About U-Boot Image Types:
6197------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006198
wdenk2729af92004-05-03 20:45:30 +00006199U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006200
wdenk2729af92004-05-03 20:45:30 +00006201 "Standalone Programs" are directly runnable in the environment
6202 provided by U-Boot; it is expected that (if they behave
6203 well) you can continue to work in U-Boot after return from
6204 the Standalone Program.
6205 "OS Kernel Images" are usually images of some Embedded OS which
6206 will take over control completely. Usually these programs
6207 will install their own set of exception handlers, device
6208 drivers, set up the MMU, etc. - this means, that you cannot
6209 expect to re-enter U-Boot except by resetting the CPU.
6210 "RAMDisk Images" are more or less just data blocks, and their
6211 parameters (address, size) are passed to an OS kernel that is
6212 being started.
6213 "Multi-File Images" contain several images, typically an OS
6214 (Linux) kernel image and one or more data images like
6215 RAMDisks. This construct is useful for instance when you want
6216 to boot over the network using BOOTP etc., where the boot
6217 server provides just a single image file, but you want to get
6218 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006219
wdenk2729af92004-05-03 20:45:30 +00006220 "Multi-File Images" start with a list of image sizes, each
6221 image size (in bytes) specified by an "uint32_t" in network
6222 byte order. This list is terminated by an "(uint32_t)0".
6223 Immediately after the terminating 0 follow the images, one by
6224 one, all aligned on "uint32_t" boundaries (size rounded up to
6225 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006226
wdenk2729af92004-05-03 20:45:30 +00006227 "Firmware Images" are binary images containing firmware (like
6228 U-Boot or FPGA images) which usually will be programmed to
6229 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006230
wdenk2729af92004-05-03 20:45:30 +00006231 "Script files" are command sequences that will be executed by
6232 U-Boot's command interpreter; this feature is especially
6233 useful when you configure U-Boot to use a real shell (hush)
6234 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006235
Marek Vasut44f074c2012-03-14 21:52:45 +00006236Booting the Linux zImage:
6237-------------------------
6238
6239On some platforms, it's possible to boot Linux zImage. This is done
6240using the "bootz" command. The syntax of "bootz" command is the same
6241as the syntax of "bootm" command.
6242
Tom Rini8ac28562013-05-16 11:40:11 -04006243Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006244kernel with raw initrd images. The syntax is slightly different, the
6245address of the initrd must be augmented by it's size, in the following
6246format: "<initrd addres>:<initrd size>".
6247
wdenkc6097192002-11-03 00:24:07 +00006248
wdenk2729af92004-05-03 20:45:30 +00006249Standalone HOWTO:
6250=================
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk2729af92004-05-03 20:45:30 +00006252One of the features of U-Boot is that you can dynamically load and
6253run "standalone" applications, which can use some resources of
6254U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006255
wdenk2729af92004-05-03 20:45:30 +00006256Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006257
wdenk2729af92004-05-03 20:45:30 +00006258"Hello World" Demo:
6259-------------------
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk2729af92004-05-03 20:45:30 +00006261'examples/hello_world.c' contains a small "Hello World" Demo
6262application; it is automatically compiled when you build U-Boot.
6263It's configured to run at address 0x00040004, so you can play with it
6264like that:
wdenkc6097192002-11-03 00:24:07 +00006265
wdenk2729af92004-05-03 20:45:30 +00006266 => loads
6267 ## Ready for S-Record download ...
6268 ~>examples/hello_world.srec
6269 1 2 3 4 5 6 7 8 9 10 11 ...
6270 [file transfer complete]
6271 [connected]
6272 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006273
wdenk2729af92004-05-03 20:45:30 +00006274 => go 40004 Hello World! This is a test.
6275 ## Starting application at 0x00040004 ...
6276 Hello World
6277 argc = 7
6278 argv[0] = "40004"
6279 argv[1] = "Hello"
6280 argv[2] = "World!"
6281 argv[3] = "This"
6282 argv[4] = "is"
6283 argv[5] = "a"
6284 argv[6] = "test."
6285 argv[7] = "<NULL>"
6286 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006287
wdenk2729af92004-05-03 20:45:30 +00006288 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006289
wdenk2729af92004-05-03 20:45:30 +00006290Another example, which demonstrates how to register a CPM interrupt
6291handler with the U-Boot code, can be found in 'examples/timer.c'.
6292Here, a CPM timer is set up to generate an interrupt every second.
6293The interrupt service routine is trivial, just printing a '.'
6294character, but this is just a demo program. The application can be
6295controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006296
wdenk2729af92004-05-03 20:45:30 +00006297 ? - print current values og the CPM Timer registers
6298 b - enable interrupts and start timer
6299 e - stop timer and disable interrupts
6300 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk2729af92004-05-03 20:45:30 +00006302 => loads
6303 ## Ready for S-Record download ...
6304 ~>examples/timer.srec
6305 1 2 3 4 5 6 7 8 9 10 11 ...
6306 [file transfer complete]
6307 [connected]
6308 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006309
wdenk2729af92004-05-03 20:45:30 +00006310 => go 40004
6311 ## Starting application at 0x00040004 ...
6312 TIMERS=0xfff00980
6313 Using timer 1
6314 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006315
wdenk2729af92004-05-03 20:45:30 +00006316Hit 'b':
6317 [q, b, e, ?] Set interval 1000000 us
6318 Enabling timer
6319Hit '?':
6320 [q, b, e, ?] ........
6321 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6322Hit '?':
6323 [q, b, e, ?] .
6324 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6325Hit '?':
6326 [q, b, e, ?] .
6327 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6328Hit '?':
6329 [q, b, e, ?] .
6330 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6331Hit 'e':
6332 [q, b, e, ?] ...Stopping timer
6333Hit 'q':
6334 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006335
6336
wdenk2729af92004-05-03 20:45:30 +00006337Minicom warning:
6338================
wdenk85ec0bc2003-03-31 16:34:49 +00006339
wdenk2729af92004-05-03 20:45:30 +00006340Over time, many people have reported problems when trying to use the
6341"minicom" terminal emulation program for serial download. I (wd)
6342consider minicom to be broken, and recommend not to use it. Under
6343Unix, I recommend to use C-Kermit for general purpose use (and
6344especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006345use "cu" for S-Record download ("loads" command). See
6346http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6347for help with kermit.
6348
wdenk85ec0bc2003-03-31 16:34:49 +00006349
wdenk2729af92004-05-03 20:45:30 +00006350Nevertheless, if you absolutely want to use it try adding this
6351configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006352
wdenk2729af92004-05-03 20:45:30 +00006353 Name Program Name U/D FullScr IO-Red. Multi
6354 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6355 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006356
6357
wdenk2729af92004-05-03 20:45:30 +00006358NetBSD Notes:
6359=============
wdenkc6097192002-11-03 00:24:07 +00006360
wdenk2729af92004-05-03 20:45:30 +00006361Starting at version 0.9.2, U-Boot supports NetBSD both as host
6362(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006363
wdenk2729af92004-05-03 20:45:30 +00006364Building requires a cross environment; it is known to work on
6365NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6366need gmake since the Makefiles are not compatible with BSD make).
6367Note that the cross-powerpc package does not install include files;
6368attempting to build U-Boot will fail because <machine/ansi.h> is
6369missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006370
wdenk2729af92004-05-03 20:45:30 +00006371 # cd /usr/pkg/cross/powerpc-netbsd/include
6372 # mkdir powerpc
6373 # ln -s powerpc machine
6374 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6375 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006376
wdenk2729af92004-05-03 20:45:30 +00006377Native builds *don't* work due to incompatibilities between native
6378and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006379
wdenk2729af92004-05-03 20:45:30 +00006380Booting assumes that (the first part of) the image booted is a
6381stage-2 loader which in turn loads and then invokes the kernel
6382proper. Loader sources will eventually appear in the NetBSD source
6383tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006384meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006385
6386
wdenk2729af92004-05-03 20:45:30 +00006387Implementation Internals:
6388=========================
wdenkc6097192002-11-03 00:24:07 +00006389
wdenk2729af92004-05-03 20:45:30 +00006390The following is not intended to be a complete description of every
6391implementation detail. However, it should help to understand the
6392inner workings of U-Boot and make it easier to port it to custom
6393hardware.
wdenkc6097192002-11-03 00:24:07 +00006394
6395
wdenk2729af92004-05-03 20:45:30 +00006396Initial Stack, Global Data:
6397---------------------------
wdenkc6097192002-11-03 00:24:07 +00006398
wdenk2729af92004-05-03 20:45:30 +00006399The implementation of U-Boot is complicated by the fact that U-Boot
6400starts running out of ROM (flash memory), usually without access to
6401system RAM (because the memory controller is not initialized yet).
6402This means that we don't have writable Data or BSS segments, and BSS
6403is not initialized as zero. To be able to get a C environment working
6404at all, we have to allocate at least a minimal stack. Implementation
6405options for this are defined and restricted by the CPU used: Some CPU
6406models provide on-chip memory (like the IMMR area on MPC8xx and
6407MPC826x processors), on others (parts of) the data cache can be
6408locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006409
Wolfgang Denk218ca722008-03-26 10:40:12 +01006410 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006411 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006412
wdenk2729af92004-05-03 20:45:30 +00006413 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6414 From: "Chris Hallinan" <clh@net1plus.com>
6415 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6416 ...
wdenk43d96162003-03-06 00:02:04 +00006417
wdenk2729af92004-05-03 20:45:30 +00006418 Correct me if I'm wrong, folks, but the way I understand it
6419 is this: Using DCACHE as initial RAM for Stack, etc, does not
6420 require any physical RAM backing up the cache. The cleverness
6421 is that the cache is being used as a temporary supply of
6422 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006423 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006424 can see how this works by studying the cache architecture and
6425 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006426
wdenk2729af92004-05-03 20:45:30 +00006427 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6428 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006429 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006430 option should work for you. Using CS 4 should be fine if your
6431 board designers haven't used it for something that would
6432 cause you grief during the initial boot! It is frequently not
6433 used.
wdenk43d96162003-03-06 00:02:04 +00006434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006435 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006436 with your processor/board/system design. The default value
6437 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006438 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006439 than your SDRAM module. If you have a 64MB SDRAM module, set
6440 it above 400_0000. Just make sure your board has no resources
6441 that are supposed to respond to that address! That code in
6442 start.S has been around a while and should work as is when
6443 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006444
wdenk2729af92004-05-03 20:45:30 +00006445 -Chris Hallinan
6446 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006447
wdenk2729af92004-05-03 20:45:30 +00006448It is essential to remember this, since it has some impact on the C
6449code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006450
wdenk2729af92004-05-03 20:45:30 +00006451* Initialized global data (data segment) is read-only. Do not attempt
6452 to write it.
wdenkc6097192002-11-03 00:24:07 +00006453
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006454* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006455 as zero data - BSS segment) at all - this is undefined, initiali-
6456 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006457
wdenk2729af92004-05-03 20:45:30 +00006458* Stack space is very limited. Avoid big data buffers or things like
6459 that.
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk2729af92004-05-03 20:45:30 +00006461Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006462normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006463turned out that the implementation of U-Boot can be greatly
6464simplified by making a global data structure (gd_t) available to all
6465functions. We could pass a pointer to this data as argument to _all_
6466functions, but this would bloat the code. Instead we use a feature of
6467the GCC compiler (Global Register Variables) to share the data: we
6468place a pointer (gd) to the global data into a register which we
6469reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006470
wdenk2729af92004-05-03 20:45:30 +00006471When choosing a register for such a purpose we are restricted by the
6472relevant (E)ABI specifications for the current architecture, and by
6473GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006474
wdenk2729af92004-05-03 20:45:30 +00006475For PowerPC, the following registers have specific use:
6476 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006477 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006478 R3-R4: parameter passing and return values
6479 R5-R10: parameter passing
6480 R13: small data area pointer
6481 R30: GOT pointer
6482 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006483
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006484 (U-Boot also uses R12 as internal GOT pointer. r12
6485 is a volatile register so r12 needs to be reset when
6486 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006487
Wolfgang Denke7670f62008-02-14 22:43:22 +01006488 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006489
wdenk2729af92004-05-03 20:45:30 +00006490 Note: on PPC, we could use a static initializer (since the
6491 address of the global data structure is known at compile time),
6492 but it turned out that reserving a register results in somewhat
6493 smaller code - although the code savings are not that big (on
6494 average for all boards 752 bytes for the whole U-Boot image,
6495 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006496
Robin Getzc4db3352009-08-17 15:23:02 +00006497On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006498 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6499
Robin Getzc4db3352009-08-17 15:23:02 +00006500 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006501
wdenk2729af92004-05-03 20:45:30 +00006502On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006503
wdenk2729af92004-05-03 20:45:30 +00006504 R0: function argument word/integer result
6505 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006506 R9: platform specific
6507 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006508 R11: argument (frame) pointer
6509 R12: temporary workspace
6510 R13: stack pointer
6511 R14: link register
6512 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006513
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006514 ==> U-Boot will use R9 to hold a pointer to the global data
6515
6516 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006517
Thomas Chou0df01fd2010-05-21 11:08:03 +08006518On Nios II, the ABI is documented here:
6519 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6520
6521 ==> U-Boot will use gp to hold a pointer to the global data
6522
6523 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6524 to access small data sections, so gp is free.
6525
Macpaul Linafc1ce82011-10-19 20:41:11 +00006526On NDS32, the following registers are used:
6527
6528 R0-R1: argument/return
6529 R2-R5: argument
6530 R15: temporary register for assembler
6531 R16: trampoline register
6532 R28: frame pointer (FP)
6533 R29: global pointer (GP)
6534 R30: link register (LP)
6535 R31: stack pointer (SP)
6536 PC: program counter (PC)
6537
6538 ==> U-Boot will use R10 to hold a pointer to the global data
6539
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006540NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6541or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006542
wdenk2729af92004-05-03 20:45:30 +00006543Memory Management:
6544------------------
wdenkc6097192002-11-03 00:24:07 +00006545
wdenk2729af92004-05-03 20:45:30 +00006546U-Boot runs in system state and uses physical addresses, i.e. the
6547MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006548
wdenk2729af92004-05-03 20:45:30 +00006549The available memory is mapped to fixed addresses using the memory
6550controller. In this process, a contiguous block is formed for each
6551memory type (Flash, SDRAM, SRAM), even when it consists of several
6552physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006553
wdenk2729af92004-05-03 20:45:30 +00006554U-Boot is installed in the first 128 kB of the first Flash bank (on
6555TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6556booting and sizing and initializing DRAM, the code relocates itself
6557to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006558memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006559configuration setting]. Below that, a structure with global Board
6560Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006561
wdenk2729af92004-05-03 20:45:30 +00006562Additionally, some exception handler code is copied to the low 8 kB
6563of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006564
wdenk2729af92004-05-03 20:45:30 +00006565So a typical memory configuration with 16 MB of DRAM could look like
6566this:
wdenkc6097192002-11-03 00:24:07 +00006567
wdenk2729af92004-05-03 20:45:30 +00006568 0x0000 0000 Exception Vector code
6569 :
6570 0x0000 1FFF
6571 0x0000 2000 Free for Application Use
6572 :
6573 :
wdenkc6097192002-11-03 00:24:07 +00006574
wdenk2729af92004-05-03 20:45:30 +00006575 :
6576 :
6577 0x00FB FF20 Monitor Stack (Growing downward)
6578 0x00FB FFAC Board Info Data and permanent copy of global data
6579 0x00FC 0000 Malloc Arena
6580 :
6581 0x00FD FFFF
6582 0x00FE 0000 RAM Copy of Monitor Code
6583 ... eventually: LCD or video framebuffer
6584 ... eventually: pRAM (Protected RAM - unchanged by reset)
6585 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006586
6587
wdenk2729af92004-05-03 20:45:30 +00006588System Initialization:
6589----------------------
wdenkc6097192002-11-03 00:24:07 +00006590
wdenk2729af92004-05-03 20:45:30 +00006591In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006592(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006593configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006594To be able to re-map memory U-Boot then jumps to its link address.
6595To be able to implement the initialization code in C, a (small!)
6596initial stack is set up in the internal Dual Ported RAM (in case CPUs
6597which provide such a feature like MPC8xx or MPC8260), or in a locked
6598part of the data cache. After that, U-Boot initializes the CPU core,
6599the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006600
wdenk2729af92004-05-03 20:45:30 +00006601Next, all (potentially) available memory banks are mapped using a
6602preliminary mapping. For example, we put them on 512 MB boundaries
6603(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6604on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6605programmed for SDRAM access. Using the temporary configuration, a
6606simple memory test is run that determines the size of the SDRAM
6607banks.
wdenkc6097192002-11-03 00:24:07 +00006608
wdenk2729af92004-05-03 20:45:30 +00006609When there is more than one SDRAM bank, and the banks are of
6610different size, the largest is mapped first. For equal size, the first
6611bank (CS2#) is mapped first. The first mapping is always for address
66120x00000000, with any additional banks following immediately to create
6613contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006614
wdenk2729af92004-05-03 20:45:30 +00006615Then, the monitor installs itself at the upper end of the SDRAM area
6616and allocates memory for use by malloc() and for the global Board
6617Info data; also, the exception vector code is copied to the low RAM
6618pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006619
wdenk2729af92004-05-03 20:45:30 +00006620Only after this relocation will you have a "normal" C environment;
6621until that you are restricted in several ways, mostly because you are
6622running from ROM, and because the code will have to be relocated to a
6623new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006624
6625
wdenk2729af92004-05-03 20:45:30 +00006626U-Boot Porting Guide:
6627----------------------
wdenkc6097192002-11-03 00:24:07 +00006628
wdenk2729af92004-05-03 20:45:30 +00006629[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6630list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006631
6632
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006633int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006634{
6635 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006636
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006637 signal(SIGALRM, no_more_time);
6638 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006639
wdenk2729af92004-05-03 20:45:30 +00006640 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006641 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006642 return 0;
6643 }
6644
wdenk2729af92004-05-03 20:45:30 +00006645 Download latest U-Boot source;
6646
Wolfgang Denk06682362008-12-30 22:56:11 +01006647 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006648
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006649 if (clueless)
6650 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006651
wdenk2729af92004-05-03 20:45:30 +00006652 while (learning) {
6653 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006654 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6655 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006656 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006657 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006658 }
wdenkc6097192002-11-03 00:24:07 +00006659
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006660 if (available_money > toLocalCurrency ($2500))
6661 Buy a BDI3000;
6662 else
wdenk2729af92004-05-03 20:45:30 +00006663 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006664
6665 if (a similar board exists) { /* hopefully... */
6666 cp -a board/<similar> board/<myboard>
6667 cp include/configs/<similar>.h include/configs/<myboard>.h
6668 } else {
6669 Create your own board support subdirectory;
6670 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006671 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006672 Edit new board/<myboard> files
6673 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006674
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006675 while (!accepted) {
6676 while (!running) {
6677 do {
6678 Add / modify source code;
6679 } until (compiles);
6680 Debug;
6681 if (clueless)
6682 email("Hi, I am having problems...");
6683 }
6684 Send patch file to the U-Boot email list;
6685 if (reasonable critiques)
6686 Incorporate improvements from email list code review;
6687 else
6688 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006689 }
wdenkc6097192002-11-03 00:24:07 +00006690
wdenk2729af92004-05-03 20:45:30 +00006691 return 0;
6692}
6693
6694void no_more_time (int sig)
6695{
6696 hire_a_guru();
6697}
wdenkc6097192002-11-03 00:24:07 +00006698
6699
wdenk2729af92004-05-03 20:45:30 +00006700Coding Standards:
6701-----------------
wdenkc6097192002-11-03 00:24:07 +00006702
wdenk2729af92004-05-03 20:45:30 +00006703All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006704coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006705"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006706
Detlev Zundel2c051652006-09-01 15:39:02 +02006707Source files originating from a different project (for example the
6708MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006709reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006710sources.
6711
6712Please note that U-Boot is implemented in C (and to some small parts in
6713Assembler); no C++ is used, so please do not use C++ style comments (//)
6714in your code.
wdenk2729af92004-05-03 20:45:30 +00006715
6716Please also stick to the following formatting rules:
6717- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006718- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006719- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006720- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006721- do not add trailing empty lines to source files
6722
6723Submissions which do not conform to the standards may be returned
6724with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006725
6726
wdenk2729af92004-05-03 20:45:30 +00006727Submitting Patches:
6728-------------------
wdenkc6097192002-11-03 00:24:07 +00006729
wdenk2729af92004-05-03 20:45:30 +00006730Since the number of patches for U-Boot is growing, we need to
6731establish some rules. Submissions which do not conform to these rules
6732may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006733
Magnus Lilja0d28f342008-08-06 19:32:33 +02006734Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006735
Wolfgang Denk06682362008-12-30 22:56:11 +01006736Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6737see http://lists.denx.de/mailman/listinfo/u-boot
6738
wdenk2729af92004-05-03 20:45:30 +00006739When you send a patch, please include the following information with
6740it:
wdenkc6097192002-11-03 00:24:07 +00006741
wdenk2729af92004-05-03 20:45:30 +00006742* For bug fixes: a description of the bug and how your patch fixes
6743 this bug. Please try to include a way of demonstrating that the
6744 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006745
wdenk2729af92004-05-03 20:45:30 +00006746* For new features: a description of the feature and your
6747 implementation.
wdenkc6097192002-11-03 00:24:07 +00006748
wdenk2729af92004-05-03 20:45:30 +00006749* A CHANGELOG entry as plaintext (separate from the patch)
6750
6751* For major contributions, your entry to the CREDITS file
6752
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006753* When you add support for a new board, don't forget to add a
6754 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006755
6756* If your patch adds new configuration options, don't forget to
6757 document these in the README file.
6758
Wolfgang Denk218ca722008-03-26 10:40:12 +01006759* The patch itself. If you are using git (which is *strongly*
6760 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006761 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006762 the U-Boot mailing list, you will avoid most of the common problems
6763 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006764
Wolfgang Denk218ca722008-03-26 10:40:12 +01006765 If you cannot use git, use "diff -purN OLD NEW". If your version of
6766 diff does not support these options, then get the latest version of
6767 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006768
Wolfgang Denk218ca722008-03-26 10:40:12 +01006769 The current directory when running this command shall be the parent
6770 directory of the U-Boot source tree (i. e. please make sure that
6771 your patch includes sufficient directory information for the
6772 affected files).
6773
6774 We prefer patches as plain text. MIME attachments are discouraged,
6775 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006776
6777* If one logical set of modifications affects or creates several
6778 files, all these changes shall be submitted in a SINGLE patch file.
6779
6780* Changesets that contain different, unrelated modifications shall be
6781 submitted as SEPARATE patches, one patch per changeset.
6782
6783
6784Notes:
6785
6786* Before sending the patch, run the MAKEALL script on your patched
6787 source tree and make sure that no errors or warnings are reported
6788 for any of the boards.
6789
6790* Keep your modifications to the necessary minimum: A patch
6791 containing several unrelated changes or arbitrary reformats will be
6792 returned with a request to re-formatting / split it.
6793
6794* If you modify existing code, make sure that your new code does not
6795 add to the memory footprint of the code ;-) Small is beautiful!
6796 When adding new features, these should compile conditionally only
6797 (using #ifdef), and the resulting code with the new feature
6798 disabled must not need more memory than the old code without your
6799 modification.
wdenk90dc6702005-05-03 14:12:25 +00006800
Wolfgang Denk06682362008-12-30 22:56:11 +01006801* Remember that there is a size limit of 100 kB per message on the
6802 u-boot mailing list. Bigger patches will be moderated. If they are
6803 reasonable and not too big, they will be acknowledged. But patches
6804 bigger than the size limit should be avoided.