blob: c704d0a007a85d1b2470d0ed7df19c4e09a9deef [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000032Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000033"working". In fact, many of them are used in production systems.
34
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050035In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000039
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050040Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000043
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
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
Naoki Hayama2bc50c22020-10-08 13:16:18 +090054Please see https://lists.denx.de/pipermail/u-boot and
55https://marc.info/?l=u-boot
wdenkc6097192002-11-03 00:24:07 +000056
Wolfgang Denkb240aef2008-03-26 10:40:12 +010057Where to get source code:
58=========================
59
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050060The U-Boot source code is maintained in the Git repository at
Heinrich Schuchardt28b2b852021-02-24 13:19:04 +010061https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62https://source.denx.de/u-boot/u-boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +010063
Naoki Hayama65ae68a2020-10-08 13:16:25 +090064The "Tags" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020065any version you might be interested in. Official releases are also
Naoki Hayama65ae68a2020-10-08 13:16:25 +090066available from the DENX file server through HTTPS or FTP.
67https://ftp.denx.de/pub/u-boot/
68ftp://ftp.denx.de/pub/u-boot/
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069
70
wdenkc6097192002-11-03 00:24:07 +000071Where we come from:
72===================
73
74- start from 8xxrom sources
Naoki Hayamae0cc1852020-10-08 13:17:16 +090075- create PPCBoot project (https://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000076- clean up code
77- make it easier to add custom boards
78- make it possible to add other [PowerPC] CPUs
79- extend functions, especially:
80 * Provide extended interface to Linux boot loader
81 * S-Record download
82 * network boot
Simon Glassaaef3bf2019-08-01 09:47:14 -060083 * ATA disk / SCSI ... boot
Naoki Hayamae0cc1852020-10-08 13:17:16 +090084- create ARMBoot project (https://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000085- add other CPU families (starting with ARM)
Naoki Hayamae0cc1852020-10-08 13:17:16 +090086- create U-Boot project (https://sourceforge.net/projects/u-boot)
87- current project page: see https://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000088
89
90Names and Spelling:
91===================
92
93The "official" name of this project is "Das U-Boot". The spelling
94"U-Boot" shall be used in all written text (documentation, comments
95in source files etc.). Example:
96
97 This is the README file for the U-Boot project.
98
99File names etc. shall be based on the string "u-boot". Examples:
100
101 include/asm-ppc/u-boot.h
102
103 #include <asm/u-boot.h>
104
105Variable names, preprocessor constants etc. shall be either based on
106the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000107
wdenk24ee89b2002-11-03 17:56:27 +0000108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
110
wdenkc6097192002-11-03 00:24:07 +0000111
wdenk7474aca2002-12-17 17:55:09 +0000112Versioning:
113===========
114
Thomas Webere89e6282010-09-28 08:06:25 +0200115Starting with the release in October 2008, the names of the releases
116were changed from numerical release numbers without deeper meaning
117into a time stamp based numbering. Regular releases are identified by
118names consisting of the calendar year and month of the release date.
119Additional fields (if present) indicate release candidates or bug fix
120releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000121
Thomas Webere89e6282010-09-28 08:06:25 +0200122Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000123 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000126
127
wdenkc6097192002-11-03 00:24:07 +0000128Directory Hierarchy:
129====================
130
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600131/arch Architecture-specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900132 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500133 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500135 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000137 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /nios2 Files generic to Altera NIOS2 architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200139 /powerpc Files generic to PowerPC architecture
Rick Chend7e6f922017-12-26 13:55:59 +0800140 /riscv Files generic to RISC-V architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500141 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400143 /x86 Files generic to x86 architecture
Naoki Hayama411f5c62020-10-08 13:16:38 +0900144 /xtensa Files generic to Xtensa architecture
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600145/api Machine/arch-independent API for external apps
146/board Board-dependent files
Simon Glass91944df2021-10-14 12:47:54 -0600147/boot Support for images and booting
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800148/cmd U-Boot commands functions
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600149/common Misc architecture-independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500150/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500151/disk Code for disk drive partition handling
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600152/doc Documentation (a mix of ReST and READMEs)
153/drivers Device drivers
154/dts Makefile for building internal U-Boot fdt.
155/env Environment support
Peter Tysere4d1abc2010-04-12 22:28:21 -0500156/examples Example code for standalone applications, etc.
157/fs Filesystem code (cramfs, ext2, jffs2, etc.)
158/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500159/lib Library routines generic to all architectures
160/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500161/net Networking code
162/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500163/scripts Various build scripts and Makefiles
164/test Various unit test files
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600165/tools Tools to build and sign FIT images, etc.
wdenkc6097192002-11-03 00:24:07 +0000166
wdenkc6097192002-11-03 00:24:07 +0000167Software Configuration:
168=======================
169
170Configuration is usually done using C preprocessor defines; the
171rationale behind that is to avoid dead code whenever possible.
172
173There are two classes of configuration variables:
174
175* Configuration _OPTIONS_:
176 These are selectable by the user and have names beginning with
177 "CONFIG_".
178
179* Configuration _SETTINGS_:
180 These depend on the hardware etc. and should not be meddled with if
181 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200182 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000183
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500184Previously, all configuration was done by hand, which involved creating
185symbolic links and editing configuration files manually. More recently,
186U-Boot has added the Kbuild infrastructure used by the Linux kernel,
187allowing you to use the "make menuconfig" command to configure your
188build.
wdenkc6097192002-11-03 00:24:07 +0000189
190
191Selection of Processor Architecture and Board Type:
192---------------------------------------------------
193
194For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200195configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000196
197Example: For a TQM823L module type:
198
199 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200200 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000201
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500202Note: If you're looking for the default configuration file for a board
203you're sure used to be there but is now missing, check the file
204doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000205
Simon Glass53552c92014-03-22 17:12:59 -0600206Sandbox Environment:
207--------------------
208
209U-Boot can be built natively to run on a Linux host using the 'sandbox'
210board. This allows feature development which is not board- or architecture-
211specific to be undertaken on a native platform. The sandbox is also used to
212run some of U-Boot's tests.
213
Naoki Hayamadd860ca2020-10-08 13:16:58 +0900214See doc/arch/sandbox.rst for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600215
216
Simon Glassd8711af2015-03-03 08:03:00 -0700217Board Initialisation Flow:
218--------------------------
219
220This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500221SPL and U-Boot proper (i.e. they both follow the same rules).
222
223Note: "SPL" stands for "Secondary Program Loader," which is explained in
224more detail later in this file.
225
226At present, SPL mostly uses a separate code path, but the function names
227and roles of each function are the same. Some boards or architectures
228may not conform to this. At least most ARM boards which use
229CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700230
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500231Execution typically starts with an architecture-specific (and possibly
232CPU-specific) start.S file, such as:
233
234 - arch/arm/cpu/armv7/start.S
235 - arch/powerpc/cpu/mpc83xx/start.S
236 - arch/mips/cpu/start.S
237
238and so on. From there, three functions are called; the purpose and
239limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700240
241lowlevel_init():
242 - purpose: essential init to permit execution to reach board_init_f()
243 - no global_data or BSS
244 - there is no stack (ARMv7 may have one but it will soon be removed)
245 - must not set up SDRAM or use console
246 - must only do the bare minimum to allow execution to continue to
247 board_init_f()
248 - this is almost never needed
249 - return normally from this function
250
251board_init_f():
252 - purpose: set up the machine ready for running board_init_r():
253 i.e. SDRAM and serial UART
254 - global_data is available
255 - stack is in SRAM
256 - BSS is not available, so you cannot use global/static variables,
257 only stack variables and global_data
258
259 Non-SPL-specific notes:
260 - dram_init() is called to set up DRAM. If already done in SPL this
261 can do nothing
262
263 SPL-specific notes:
264 - you can override the entire board_init_f() function with your own
265 version as needed.
266 - preloader_console_init() can be called here in extremis
267 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayamaebfd8192020-09-24 15:57:19 +0900268 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg7673bed2019-08-08 12:54:49 -0500269 - for specific scenarios on certain architectures an early BSS *can*
270 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
271 of BSS prior to entering board_init_f()) but doing so is discouraged.
272 Instead it is strongly recommended to architect any code changes
273 or additions such to not depend on the availability of BSS during
274 board_init_f() as indicated in other sections of this README to
275 maintain compatibility and consistency across the entire code base.
Simon Glassd8711af2015-03-03 08:03:00 -0700276 - must return normally from this function (don't call board_init_r()
277 directly)
278
279Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
280this point the stack and global_data are relocated to below
281CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
282memory.
283
284board_init_r():
285 - purpose: main execution, common code
286 - global_data is available
287 - SDRAM is available
288 - BSS is available, all static/global variables can be used
289 - execution eventually continues to main_loop()
290
291 Non-SPL-specific notes:
292 - U-Boot is relocated to the top of memory and is now running from
293 there.
294
295 SPL-specific notes:
296 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
297 CONFIG_SPL_STACK_R_ADDR points into SDRAM
298 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800299 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700300 spl_board_init() function containing this call
301 - loads U-Boot or (in falcon mode) Linux
302
303
wdenkc6097192002-11-03 00:24:07 +0000304Configuration Options:
305----------------------
306
307Configuration depends on the combination of board and CPU type; all
308such information is kept in a configuration file
309"include/configs/<board_name>.h".
310
311Example: For a TQM823L module, all configuration settings are in
312"include/configs/TQM823L.h".
313
314
wdenk1272e232002-11-10 22:06:23 +0000315Many of the options are named exactly as the corresponding Linux
316kernel configuration options. The intention is to make it easier to
317build a config tool - later.
318
Ashish Kumar11234062017-08-11 11:09:14 +0530319- ARM Platform Bus Type(CCI):
320 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
321 provides full cache coherency between two clusters of multi-core
322 CPUs and I/O coherency for devices and I/O masters
323
324 CONFIG_SYS_FSL_HAS_CCI400
325
326 Defined For SoC that has cache coherent interconnect
327 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000328
Ashish Kumar97393d62017-08-18 10:54:36 +0530329 CONFIG_SYS_FSL_HAS_CCN504
330
331 Defined for SoC that has cache coherent interconnect CCN-504
332
wdenkc6097192002-11-03 00:24:07 +0000333The following options need to be configured:
334
Kim Phillips203fee32007-08-10 13:28:25 -0500335- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000336
Kim Phillips203fee32007-08-10 13:28:25 -0500337- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200338
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600339- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000340 CONFIG_SYS_PPC64
341
342 Specifies that the core is a 64-bit PowerPC implementation (implements
343 the "64" category of the Power ISA). This is necessary for ePAPR
344 compliance, among other possible reasons.
345
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600346 CONFIG_SYS_FSL_TBCLK_DIV
347
348 Defines the core time base clock divider ratio compared to the
349 system clock. On most PQ3 devices this is 8, on newer QorIQ
350 devices it can be 16 or 32. The ratio varies from SoC to Soc.
351
Kumar Gala179b1b22011-05-20 00:39:21 -0500352 CONFIG_SYS_FSL_PCIE_COMPAT
353
354 Defines the string to utilize when trying to match PCIe device
355 tree nodes for the given platform.
356
Scott Wood80806962012-08-14 10:14:53 +0000357 CONFIG_SYS_FSL_ERRATUM_A004510
358
359 Enables a workaround for erratum A004510. If set,
360 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
362
363 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
365
366 Defines one or two SoC revisions (low 8 bits of SVR)
367 for which the A004510 workaround should be applied.
368
369 The rest of SVR is either not relevant to the decision
370 of whether the erratum is present (e.g. p2040 versus
371 p2041) or is implied by the build target, which controls
372 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
373
374 See Freescale App Note 4493 for more information about
375 this erratum.
376
377 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
378
379 This is the value to write into CCSR offset 0x18600
380 according to the A004510 workaround.
381
Priyanka Jainc73b9032013-07-02 09:21:04 +0530382 CONFIG_SYS_FSL_DSP_DDR_ADDR
383 This value denotes start offset of DDR memory which is
384 connected exclusively to the DSP cores.
385
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530386 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
387 This value denotes start offset of M2 memory
388 which is directly connected to the DSP core.
389
Priyanka Jainc73b9032013-07-02 09:21:04 +0530390 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
391 This value denotes start offset of M3 memory which is directly
392 connected to the DSP core.
393
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530394 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
395 This value denotes start offset of DSP CCSR space.
396
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530397 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
398 Single Source Clock is clocking mode present in some of FSL SoC's.
399 In this mode, a single differential clock is used to supply
400 clocks to the sysclock, ddrclock and usbclock.
401
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530402 CONFIG_SYS_CPC_REINIT_F
403 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800404 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530405
Tang Yuantiana7364af2014-04-17 15:33:46 +0800406 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800407 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800408 supported, core will start to execute uboot when wakes up.
409
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000410- Generic CPU options:
411 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
412
413 Defines the endianess of the CPU. Implementation of those
414 values is arch specific.
415
York Sunf0626592013-09-30 09:22:09 -0700416 CONFIG_SYS_FSL_DDR
417 Freescale DDR driver in use. This type of DDR controller is
Tom Rinie5404982021-05-14 21:34:26 -0400418 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
York Sunf0626592013-09-30 09:22:09 -0700419
420 CONFIG_SYS_FSL_DDR_ADDR
421 Freescale DDR memory-mapped register base.
422
423 CONFIG_SYS_FSL_DDR_EMU
424 Specify emulator support for DDR. Some DDR features such as
425 deskew training are not available.
426
427 CONFIG_SYS_FSL_DDRC_GEN1
428 Freescale DDR1 controller.
429
430 CONFIG_SYS_FSL_DDRC_GEN2
431 Freescale DDR2 controller.
432
433 CONFIG_SYS_FSL_DDRC_GEN3
434 Freescale DDR3 controller.
435
York Sun2896cb72014-03-27 17:54:47 -0700436 CONFIG_SYS_FSL_DDRC_GEN4
437 Freescale DDR4 controller.
438
York Sun461c9392013-09-30 14:20:51 -0700439 CONFIG_SYS_FSL_DDRC_ARM_GEN3
440 Freescale DDR3 controller for ARM-based SoCs.
441
York Sunf0626592013-09-30 09:22:09 -0700442 CONFIG_SYS_FSL_DDR1
443 Board config to use DDR1. It can be enabled for SoCs with
444 Freescale DDR1 or DDR2 controllers, depending on the board
445 implemetation.
446
447 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400448 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700449 Freescale DDR2 or DDR3 controllers, depending on the board
450 implementation.
451
452 CONFIG_SYS_FSL_DDR3
453 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700454 Freescale DDR3 or DDR3L controllers.
455
456 CONFIG_SYS_FSL_DDR3L
457 Board config to use DDR3L. It can be enabled for SoCs with
458 DDR3L controllers.
459
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530460 CONFIG_SYS_FSL_IFC_BE
461 Defines the IFC controller register space as Big Endian
462
463 CONFIG_SYS_FSL_IFC_LE
464 Defines the IFC controller register space as Little Endian
465
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530466 CONFIG_SYS_FSL_IFC_CLK_DIV
467 Defines divider of platform clock(clock input to IFC controller).
468
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530469 CONFIG_SYS_FSL_LBC_CLK_DIV
470 Defines divider of platform clock(clock input to eLBC controller).
471
York Sun29647ab2014-02-10 13:59:42 -0800472 CONFIG_SYS_FSL_DDR_BE
473 Defines the DDR controller register space as Big Endian
474
475 CONFIG_SYS_FSL_DDR_LE
476 Defines the DDR controller register space as Little Endian
477
York Sun3a0916d2014-02-10 13:59:43 -0800478 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
479 Physical address from the view of DDR controllers. It is the
480 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
481 it could be different for ARM SoCs.
482
York Sunc459ae62014-02-10 13:59:44 -0800483 CONFIG_SYS_FSL_DDR_INTLV_256B
484 DDR controller interleaving on 256-byte. This is a special
485 interleaving mode, handled by Dickens for Freescale layerscape
486 SoCs with ARM core.
487
York Sun79a779b2014-08-01 15:51:00 -0700488 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
489 Number of controllers used as main memory.
490
491 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
492 Number of controllers used for other than main memory.
493
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530494 CONFIG_SYS_FSL_HAS_DP_DDR
495 Defines the SoC has DP-DDR used for DPAA.
496
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530497 CONFIG_SYS_FSL_SEC_BE
498 Defines the SEC controller register space as Big Endian
499
500 CONFIG_SYS_FSL_SEC_LE
501 Defines the SEC controller register space as Little Endian
502
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200503- MIPS CPU options:
504 CONFIG_SYS_INIT_SP_OFFSET
505
506 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
507 pointer. This is needed for the temporary stack before
508 relocation.
509
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200510 CONFIG_XWAY_SWAP_BYTES
511
512 Enable compilation of tools/xway-swap-bytes needed for Lantiq
513 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
514 be swapped if a flash programmer is used.
515
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000516- ARM options:
517 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
518
519 Select high exception vectors of the ARM core, e.g., do not
520 clear the V bit of the c1 register of CP15.
521
York Sun77a10972015-03-20 19:28:08 -0700522 COUNTER_FREQUENCY
523 Generic timer clock source frequency.
524
525 COUNTER_FREQUENCY_REAL
526 Generic timer clock source frequency if the real clock is
527 different from COUNTER_FREQUENCY, and can only be determined
528 at run time.
529
Stephen Warren8d1fb312015-01-19 16:25:52 -0700530- Tegra SoC options:
531 CONFIG_TEGRA_SUPPORT_NON_SECURE
532
533 Support executing U-Boot in non-secure (NS) mode. Certain
534 impossible actions will be skipped if the CPU is in NS mode,
535 such as ARM architectural timer initialization.
536
wdenk9b7f3842003-10-09 20:09:04 +0000537- Linux Kernel Interface:
wdenk9b7f3842003-10-09 20:09:04 +0000538 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
539
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800540 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000541 expect it to be in bytes, others in MB.
542 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
543
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400544 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200545
546 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400547 passed using flattened device trees (based on open firmware
548 concepts).
549
550 CONFIG_OF_LIBFDT
551 * New libfdt-based support
552 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500553 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400554
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200555 OF_TBCLK - The timebase frequency.
556
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200557 boards with QUICC Engines require OF_QE to set UCC MAC
558 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500559
Heiko Schocherffb293a2009-09-23 07:56:08 +0200560 CONFIG_OF_IDE_FIXUP
561
562 U-Boot can detect if an IDE device is present or not.
563 If not, and this new config option is activated, U-Boot
564 removes the ATA node from the DTS before booting Linux,
565 so the Linux IDE driver does not probe the device and
566 crash. This is needed for buggy hardware (uc101) where
567 no pull down resistor is connected to the signal IDE5V_DD7.
568
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100569- vxWorks boot parameters:
570
571 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700572 environments variables: bootdev, bootfile, ipaddr, netmask,
573 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100574 It loads the vxWorks image pointed bootfile.
575
Naoki Hayama158c2262020-10-08 13:17:08 +0900576 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100577 the defaults discussed just above.
578
Aneesh V686a0752011-06-16 23:30:51 +0000579- Cache Configuration for ARM:
580 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
581 controller
582 CONFIG_SYS_PL310_BASE - Physical base address of PL310
583 controller register space
584
wdenkda04a8b2004-08-02 23:22:59 +0000585- Serial Ports:
wdenkda04a8b2004-08-02 23:22:59 +0000586 CONFIG_PL011_CLOCK
587
588 If you have Amba PrimeCell PL011 UARTs, set this variable to
589 the clock speed of the UARTs.
590
591 CONFIG_PL01x_PORTS
592
593 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
594 define this to a list of base addresses for each (supported)
595 port. See e.g. include/configs/versatile.h
596
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400597 CONFIG_SERIAL_HW_FLOW_CONTROL
598
599 Define this variable to enable hw flow control in serial driver.
600 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000601
wdenkc6097192002-11-03 00:24:07 +0000602- Serial Download Echo Mode:
603 CONFIG_LOADS_ECHO
604 If defined to 1, all characters received during a
605 serial download (using the "loads" command) are
606 echoed back. This might be needed by some terminal
607 emulations (like "cu"), but may as well just take
608 time on others. This setting #define's the initial
609 value of the "loads_echo" environment variable.
610
Simon Glassaa34ef22016-03-13 19:07:28 -0600611- Removal of commands
612 If no commands are needed to boot, you can disable
613 CONFIG_CMDLINE to remove them. In this case, the command line
614 will not be available, and when U-Boot wants to execute the
615 boot command (on start-up) it will call board_run_command()
616 instead. This can reduce image size significantly for very
617 simple boot procedures.
618
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000619- Regular expression support:
620 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200621 If this variable is defined, U-Boot is linked against
622 the SLRE (Super Light Regular Expression) library,
623 which adds regex support to some commands, as for
624 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000625
wdenkc6097192002-11-03 00:24:07 +0000626- Watchdog:
Rasmus Villemoes134cc2b2021-04-14 09:18:22 +0200627 CONFIG_SYS_WATCHDOG_FREQ
628 Some platforms automatically call WATCHDOG_RESET()
629 from the timer interrupt handler every
630 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
631 board configuration file, a default of CONFIG_SYS_HZ/2
632 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
633 to 0 disables calling WATCHDOG_RESET() from the timer
634 interrupt.
635
wdenkc6097192002-11-03 00:24:07 +0000636- Real-Time Clock:
637
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500638 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000639 has to be selected, too. Define exactly one of the
640 following options:
641
wdenkc6097192002-11-03 00:24:07 +0000642 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000643 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000644 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000645 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000646 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000647 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200648 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000649 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100650 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000651 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200652 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200653 CONFIG_SYS_RV3029_TCR - enable trickle charger on
654 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000655
wdenkb9bbd242003-06-30 16:24:52 +0000656 Note that if the RTC uses I2C, then the I2C interface
657 must also be configured. See I2C Support, below.
658
Peter Tyser9902e422008-12-17 16:36:21 -0600659- GPIO Support:
660 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600661
Chris Packham9b383202010-12-19 10:12:13 +0000662 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
663 chip-ngpio pairs that tell the PCA953X driver the number of
664 pins supported by a particular chip.
665
Peter Tyser9902e422008-12-17 16:36:21 -0600666 Note that if the GPIO device uses I2C, then the I2C interface
667 must also be configured. See I2C Support, below.
668
Simon Glass4dc47ca2014-06-11 23:29:41 -0600669- I/O tracing:
670 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
671 accesses and can checksum them or write a list of them out
672 to memory. See the 'iotrace' command for details. This is
673 useful for testing device drivers since it can confirm that
674 the driver behaves the same way before and after a code
675 change. Currently this is supported on sandbox and arm. To
676 add support for your architecture, add '#include <iotrace.h>'
677 to the bottom of arch/<arch>/include/asm/io.h and test.
678
679 Example output from the 'iotrace stats' command is below.
680 Note that if the trace buffer is exhausted, the checksum will
681 still continue to operate.
682
683 iotrace is enabled
684 Start: 10000000 (buffer start address)
685 Size: 00010000 (buffer size)
686 Offset: 00000120 (current buffer offset)
687 Output: 10000120 (start + offset)
688 Count: 00000018 (number of trace records)
689 CRC32: 9526fb66 (CRC32 of all trace records)
690
wdenkc6097192002-11-03 00:24:07 +0000691- Timestamp Support:
692
wdenk4a5c8a72003-03-06 00:02:04 +0000693 When CONFIG_TIMESTAMP is selected, the timestamp
694 (date and time) of an image is printed by image
695 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500696 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000697
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000698- Partition Labels (disklabels) Supported:
699 Zero or more of the following:
700 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000701 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
702 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
703 bootloader. Note 2TB partition limit; see
704 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600705 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000706 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000707
wdenkf602aa02004-03-13 23:29:43 +0000708- LBA48 Support
709 CONFIG_LBA48
710
711 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100712 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000713 Whithout these , LBA48 support uses 32bit variables and will 'only'
714 support disks up to 2.1TB.
715
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200716 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000717 When enabled, makes the IDE subsystem use 64bit sector addresses.
718 Default is 32bit.
719
wdenkc6097192002-11-03 00:24:07 +0000720- NETWORK Support (PCI):
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000721 CONFIG_E1000_SPI
722 Utility code for direct access to the SPI bus on Intel 8257x.
723 This does not do anything useful unless you set at least one
724 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
725
wdenkc6097192002-11-03 00:24:07 +0000726 CONFIG_NATSEMI
727 Support for National dp83815 chips.
728
729 CONFIG_NS8382X
730 Support for National dp8382[01] gigabit chips.
731
wdenkaa603362003-05-12 21:50:16 +0000732- NETWORK Support (other):
Rob Herringc9830dc2011-12-15 11:15:49 +0000733 CONFIG_CALXEDA_XGMAC
734 Support for the Calxeda XGMAC device
735
Ashok93fb8722012-10-15 06:20:47 +0000736 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000737 Support for SMSC's LAN91C96 chips.
738
wdenkaa603362003-05-12 21:50:16 +0000739 CONFIG_LAN91C96_USE_32_BIT
740 Define this to enable 32 bit addressing
741
Ashok93fb8722012-10-15 06:20:47 +0000742 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000743 Support for SMSC's LAN91C111 chip
744
745 CONFIG_SMC91111_BASE
746 Define this to hold the physical address
747 of the device (I/O space)
748
749 CONFIG_SMC_USE_32_BIT
750 Define this if data bus is 32 bits
751
752 CONFIG_SMC_USE_IOFUNCS
753 Define this to use i/o functions instead of macros
754 (some hardware wont work with macros)
755
Heiko Schocher7d037f72011-11-15 10:00:04 -0500756 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
757 Define this if you have more then 3 PHYs.
758
Macpaul Lin199c6252010-12-21 16:59:46 +0800759 CONFIG_FTGMAC100
760 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
761
762 CONFIG_FTGMAC100_EGIGA
763 Define this to use GE link update with gigabit PHY.
764 Define this if FTGMAC100 is connected to gigabit PHY.
765 If your system has 10/100 PHY only, it might not occur
766 wrong behavior. Because PHY usually return timeout or
767 useless data when polling gigabit status and gigabit
768 control registers. This behavior won't affect the
769 correctnessof 10/100 link speed update.
770
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900771 CONFIG_SH_ETHER
772 Support for Renesas on-chip Ethernet controller
773
774 CONFIG_SH_ETHER_USE_PORT
775 Define the number of ports to be used
776
777 CONFIG_SH_ETHER_PHY_ADDR
778 Define the ETH PHY's address
779
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900780 CONFIG_SH_ETHER_CACHE_WRITEBACK
781 If this option is set, the driver enables cache flush.
782
Vadim Bendeburydac69642011-10-17 08:36:14 +0000783- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000784 CONFIG_TPM
785 Support TPM devices.
786
Christophe Ricard8759ff82015-10-06 22:54:41 +0200787 CONFIG_TPM_TIS_INFINEON
788 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000789 per system is supported at this time.
790
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000791 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
792 Define the burst count bytes upper limit
793
Christophe Ricard88249232016-01-21 23:27:13 +0100794 CONFIG_TPM_ST33ZP24
795 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
796
797 CONFIG_TPM_ST33ZP24_I2C
798 Support for STMicroelectronics ST33ZP24 I2C devices.
799 Requires TPM_ST33ZP24 and I2C.
800
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100801 CONFIG_TPM_ST33ZP24_SPI
802 Support for STMicroelectronics ST33ZP24 SPI devices.
803 Requires TPM_ST33ZP24 and SPI.
804
Dirk Eibach20489092013-06-26 15:55:15 +0200805 CONFIG_TPM_ATMEL_TWI
806 Support for Atmel TWI TPM device. Requires I2C support.
807
Che-liang Chiouacea5702013-04-12 11:04:34 +0000808 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000809 Support for generic parallel port TPM devices. Only one device
810 per system is supported at this time.
811
812 CONFIG_TPM_TIS_BASE_ADDRESS
813 Base address where the generic TPM device is mapped
814 to. Contemporary x86 systems usually map it at
815 0xfed40000.
816
Reinhard Pfau4fece432013-06-26 15:55:13 +0200817 CONFIG_TPM
818 Define this to enable the TPM support library which provides
819 functional interfaces to some TPM commands.
820 Requires support for a TPM device.
821
822 CONFIG_TPM_AUTH_SESSIONS
823 Define this to enable authorized functions in the TPM library.
824 Requires CONFIG_TPM and CONFIG_SHA1.
825
wdenkc6097192002-11-03 00:24:07 +0000826- USB Support:
827 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +0200828 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000829 CONFIG_USB_UHCI to enable it.
830 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000831 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000832 storage devices.
833 Note:
834 Supported are USB Keyboards and USB Floppy drives
835 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000836
Simon Glass5978cdb2012-02-27 10:52:47 +0000837 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
838 txfilltuning field in the EHCI controller on reset.
839
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -0700840 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
841 HW module registers.
842
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200843- USB Device:
844 Define the below if you wish to use the USB console.
845 Once firmware is rebuilt from a serial console issue the
846 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200847 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200848 it has found a new device. The environment variable usbtty
849 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200850 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200851 Common Device Class Abstract Control Model serial device.
852 If you select usbtty = gserial you should be able to enumerate
853 a Linux host by
854 # modprobe usbserial vendor=0xVendorID product=0xProductID
855 else if using cdc_acm, simply setting the environment
856 variable usbtty to be cdc_acm should suffice. The following
857 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200858
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200859 CONFIG_USB_DEVICE
860 Define this to build a UDC device
861
862 CONFIG_USB_TTY
863 Define this to have a tty type of device available to
864 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200865
Vipin KUMARbdb17702012-03-26 15:38:06 +0530866 CONFIG_USBD_HS
867 Define this to enable the high speed support for usb
868 device and usbtty. If this feature is enabled, a routine
869 int is_usbd_high_speed(void)
870 also needs to be defined by the driver to dynamically poll
871 whether the enumeration has succeded at high speed or full
872 speed.
873
Wolfgang Denke2601822006-06-14 18:14:56 +0200874 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200875 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200876 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200877 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
878 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
879 should pretend to be a Linux device to it's target host.
880
881 CONFIG_USBD_MANUFACTURER
882 Define this string as the name of your company for
883 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200884
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200885 CONFIG_USBD_PRODUCT_NAME
886 Define this string as the name of your product
887 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000888
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200889 CONFIG_USBD_VENDORID
890 Define this as your assigned Vendor ID from the USB
891 Implementors Forum. This *must* be a genuine Vendor ID
892 to avoid polluting the USB namespace.
893 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200894
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200895 CONFIG_USBD_PRODUCTID
896 Define this as the unique Product ID
897 for your device
898 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200899
Igor Grinbergac5f6ee2011-12-12 12:08:35 +0200900- ULPI Layer Support:
901 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
902 the generic ULPI layer. The generic layer accesses the ULPI PHY
903 via the platform viewport, so you need both the genric layer and
904 the viewport enabled. Currently only Chipidea/ARC based
905 viewport is supported.
906 To enable the ULPI layer support, define CONFIG_USB_ULPI and
907 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +0200908 If your ULPI phy needs a different reference clock than the
909 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
910 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +0000911
wdenk7a428cc2003-06-15 22:40:42 +0000912- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +0000913 The MMC controller on the Intel PXA is supported. To
914 enable this define CONFIG_MMC. The MMC can be
915 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +0000916 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500917 enabled with CONFIG_CMD_MMC. The MMC driver also works with
918 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +0000919
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +0000920 CONFIG_SH_MMCIF
921 Support for Renesas on-chip MMCIF controller
922
923 CONFIG_SH_MMCIF_ADDR
924 Define the base address of MMCIF registers
925
926 CONFIG_SH_MMCIF_CLK
927 Define the clock frequency for MMCIF
928
Tom Rini58a8d322013-03-14 05:32:47 +0000929- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +0100930 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +0000931 This enables the USB portion of the DFU USB class
932
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000933 CONFIG_DFU_NAND
934 This enables support for exposing NAND devices via DFU.
935
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530936 CONFIG_DFU_RAM
937 This enables support for exposing RAM via DFU.
938 Note: DFU spec refer to non-volatile memory usage, but
939 allow usages beyond the scope of spec - here RAM usage,
940 one that would help mostly the developer.
941
Heiko Schochera2f831e2013-06-12 06:05:51 +0200942 CONFIG_SYS_DFU_DATA_BUF_SIZE
943 Dfu transfer uses a buffer before writing data to the
944 raw storage device. Make the size (in bytes) of this buffer
945 configurable. The size of this buffer is also configurable
946 through the "dfu_bufsiz" environment variable.
947
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000948 CONFIG_SYS_DFU_MAX_FILE_SIZE
949 When updating files rather than the raw storage device,
950 we use a static buffer to copy the file into and then write
951 the buffer once we've been given the whole file. Define
952 this to the maximum filesize (in bytes) for the buffer.
953 Default is 4 MiB if undefined.
954
Heiko Schochere1ba1512014-03-18 08:09:56 +0100955 DFU_DEFAULT_POLL_TIMEOUT
956 Poll timeout [ms], is the timeout a device can send to the
957 host. The host must wait for this timeout before sending
958 a subsequent DFU_GET_STATUS request to the device.
959
960 DFU_MANIFEST_POLL_TIMEOUT
961 Poll timeout [ms], which the device sends to the host when
962 entering dfuMANIFEST state. Host waits this timeout, before
963 sending again an USB request to the device.
964
wdenkda04a8b2004-08-02 23:22:59 +0000965- Journaling Flash filesystem support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200966 CONFIG_SYS_JFFS2_FIRST_SECTOR,
967 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +0000968 Define these for a default partition on a NOR device
969
wdenkc6097192002-11-03 00:24:07 +0000970- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -0700971 See Kconfig help for available keyboard drivers.
972
wdenkc6097192002-11-03 00:24:07 +0000973- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -0600974 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +0200975 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -0600976 SOCs that have a DIU should define this macro to enable DIU
977 support, and should also define these other macros:
978
979 CONFIG_SYS_DIU_ADDR
980 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -0600981 CONFIG_CFB_CONSOLE
982 CONFIG_VIDEO_SW_CURSOR
983 CONFIG_VGA_AS_SINGLE_DEVICE
Timur Tabi020edd22011-02-15 17:09:19 -0600984 CONFIG_VIDEO_BMP_LOGO
985
Timur Tabi32f709e2011-04-11 14:18:22 -0500986 The DIU driver will look for the 'video-mode' environment
987 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -0300988 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -0500989 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -0600990
wdenkc6097192002-11-03 00:24:07 +0000991- LCD Support: CONFIG_LCD
992
993 Define this to enable LCD support (for output to LCD
994 display); also select one of the supported displays
995 by defining one of these:
996
Stelian Popf6f86652008-05-09 21:57:18 +0200997 CONFIG_ATMEL_LCD:
998
999 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1000
wdenkc0d54ae2003-11-25 16:55:19 +00001001 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001002
wdenkc0d54ae2003-11-25 16:55:19 +00001003 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001004
wdenkc0d54ae2003-11-25 16:55:19 +00001005 CONFIG_NEC_NL6448BC20
1006
1007 NEC NL6448BC20-08. 6.5", 640x480.
1008 Active, color, single scan.
1009
1010 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001011
wdenkc0d54ae2003-11-25 16:55:19 +00001012 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001013 Active, color, single scan.
1014
1015 CONFIG_SHARP_16x9
1016
1017 Sharp 320x240. Active, color, single scan.
1018 It isn't 16x9, and I am not sure what it is.
1019
1020 CONFIG_SHARP_LQ64D341
1021
1022 Sharp LQ64D341 display, 640x480.
1023 Active, color, single scan.
1024
1025 CONFIG_HLD1045
1026
1027 HLD1045 display, 640x480.
1028 Active, color, single scan.
1029
1030 CONFIG_OPTREX_BW
1031
1032 Optrex CBL50840-2 NF-FW 99 22 M5
1033 or
1034 Hitachi LMG6912RPFC-00T
1035 or
1036 Hitachi SP14Q002
1037
1038 320x240. Black & white.
1039
Simon Glass599a4df2012-10-17 13:24:54 +00001040 CONFIG_LCD_ALIGNMENT
1041
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001042 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001043 defined then the LCD will be aligned to this value instead.
1044 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1045 here, since it is cheaper to change data cache settings on
1046 a per-section basis.
1047
1048
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001049 CONFIG_LCD_ROTATION
1050
1051 Sometimes, for example if the display is mounted in portrait
1052 mode or even if it's mounted landscape but rotated by 180degree,
1053 we need to rotate our content of the display relative to the
1054 framebuffer, so that user can read the messages which are
1055 printed out.
1056 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1057 initialized with a given rotation from "vl_rot" out of
1058 "vidinfo_t" which is provided by the board specific code.
1059 The value for vl_rot is coded as following (matching to
1060 fbcon=rotate:<n> linux-kernel commandline):
1061 0 = no rotation respectively 0 degree
1062 1 = 90 degree rotation
1063 2 = 180 degree rotation
1064 3 = 270 degree rotation
1065
1066 If CONFIG_LCD_ROTATION is not defined, the console will be
1067 initialized with 0degree rotation.
1068
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001069 CONFIG_LCD_BMP_RLE8
1070
1071 Support drawing of RLE8-compressed bitmaps on the LCD.
1072
wdenk0e2bd9c2004-06-06 21:51:03 +00001073- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001074 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1075
1076 The clock frequency of the MII bus
1077
wdenk0e2bd9c2004-06-06 21:51:03 +00001078 CONFIG_PHY_RESET_DELAY
1079
1080 Some PHY like Intel LXT971A need extra delay after
1081 reset before any MII register access is possible.
1082 For such PHY, set this option to the usec delay
1083 required. (minimum 300usec for LXT971A)
1084
1085 CONFIG_PHY_CMD_DELAY (ppc4xx)
1086
1087 Some PHY like Intel LXT971A need extra delay after
1088 command issued before MII status register can be read
1089
wdenkc6097192002-11-03 00:24:07 +00001090- IP address:
1091 CONFIG_IPADDR
1092
1093 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001094 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001095 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001096 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001097
1098- Server IP address:
1099 CONFIG_SERVERIP
1100
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001101 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001102 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001103 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001104
Wolfgang Denk26da2992011-10-26 10:21:22 +00001105- Gateway IP address:
1106 CONFIG_GATEWAYIP
1107
1108 Defines a default value for the IP address of the
1109 default router where packets to other networks are
1110 sent to.
1111 (Environment variable "gatewayip")
1112
1113- Subnet mask:
1114 CONFIG_NETMASK
1115
1116 Defines a default value for the subnet mask (or
1117 routing prefix) which is used to determine if an IP
1118 address belongs to the local subnet or needs to be
1119 forwarded through a router.
1120 (Environment variable "netmask")
1121
wdenkc6097192002-11-03 00:24:07 +00001122- BOOTP Recovery Mode:
1123 CONFIG_BOOTP_RANDOM_DELAY
1124
1125 If you have many targets in a network that try to
1126 boot using BOOTP, you may want to avoid that all
1127 systems send out BOOTP requests at precisely the same
1128 moment (which would happen for instance at recovery
1129 from a power failure, when all systems will try to
1130 boot, thus flooding the BOOTP server. Defining
1131 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1132 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001133 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001134
1135 1st BOOTP request: delay 0 ... 1 sec
1136 2nd BOOTP request: delay 0 ... 2 sec
1137 3rd BOOTP request: delay 0 ... 4 sec
1138 4th and following
1139 BOOTP requests: delay 0 ... 8 sec
1140
Thierry Reding8977cda2014-08-19 10:21:24 +02001141 CONFIG_BOOTP_ID_CACHE_SIZE
1142
1143 BOOTP packets are uniquely identified using a 32-bit ID. The
1144 server will copy the ID from client requests to responses and
1145 U-Boot will use this to determine if it is the destination of
1146 an incoming response. Some servers will check that addresses
1147 aren't in use before handing them out (usually using an ARP
1148 ping) and therefore take up to a few hundred milliseconds to
1149 respond. Network congestion may also influence the time it
1150 takes for a response to make it back to the client. If that
1151 time is too long, U-Boot will retransmit requests. In order
1152 to allow earlier responses to still be accepted after these
1153 retransmissions, U-Boot's BOOTP client keeps a small cache of
1154 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1155 cache. The default is to keep IDs for up to four outstanding
1156 requests. Increasing this will allow U-Boot to accept offers
1157 from a BOOTP client in networks with unusually high latency.
1158
stroesee0aadfb2003-08-28 14:17:32 +00001159- DHCP Advanced Options:
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001160
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001161 - Link-local IP address negotiation:
1162 Negotiate with other link-local clients on the local network
1163 for an address that doesn't require explicit configuration.
1164 This is especially useful if a DHCP server cannot be guaranteed
1165 to exist in all environments that the device must operate.
1166
1167 See doc/README.link-local for more information.
1168
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301169 - MAC address from environment variables
1170
1171 FDT_SEQ_MACADDR_FROM_ENV
1172
1173 Fix-up device tree with MAC addresses fetched sequentially from
1174 environment variables. This config work on assumption that
1175 non-usable ethernet node of device-tree are either not present
1176 or their status has been marked as "disabled".
1177
wdenk145d2c12004-04-15 21:48:45 +00001178 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001179 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001180
1181 The device id used in CDP trigger frames.
1182
1183 CONFIG_CDP_DEVICE_ID_PREFIX
1184
1185 A two character string which is prefixed to the MAC address
1186 of the device.
1187
1188 CONFIG_CDP_PORT_ID
1189
1190 A printf format string which contains the ascii name of
1191 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001192 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001193
1194 CONFIG_CDP_CAPABILITIES
1195
1196 A 32bit integer which indicates the device capabilities;
1197 0x00000010 for a normal host which does not forwards.
1198
1199 CONFIG_CDP_VERSION
1200
1201 An ascii string containing the version of the software.
1202
1203 CONFIG_CDP_PLATFORM
1204
1205 An ascii string containing the name of the platform.
1206
1207 CONFIG_CDP_TRIGGER
1208
1209 A 32bit integer sent on the trigger.
1210
1211 CONFIG_CDP_POWER_CONSUMPTION
1212
1213 A 16bit integer containing the power consumption of the
1214 device in .1 of milliwatts.
1215
1216 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1217
1218 A byte containing the id of the VLAN.
1219
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001220- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001221
1222 Several configurations allow to display the current
1223 status using a LED. For instance, the LED will blink
1224 fast while running U-Boot code, stop blinking as
1225 soon as a reply to a BOOTP request was received, and
1226 start blinking slow once the Linux kernel is running
1227 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001228 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001229 feature in U-Boot.
1230
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001231 Additional options:
1232
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001233 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001234 The status LED can be connected to a GPIO pin.
1235 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001236 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001237 to include the gpio_led driver in the U-Boot binary.
1238
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001239 CONFIG_GPIO_LED_INVERTED_TABLE
1240 Some GPIO connected LEDs may have inverted polarity in which
1241 case the GPIO high value corresponds to LED off state and
1242 GPIO low value corresponds to LED on state.
1243 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1244 with a list of GPIO LEDs that have inverted polarity.
1245
Tom Rini52b2e262021-08-18 23:12:24 -04001246- I2C Support:
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001247 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001248 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001249
1250 CONFIG_SYS_I2C_DIRECT_BUS
1251 define this, if you don't use i2c muxes on your hardware.
1252 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1253 omit this define.
1254
1255 CONFIG_SYS_I2C_MAX_HOPS
1256 define how many muxes are maximal consecutively connected
1257 on one i2c bus. If you not use i2c muxes, omit this
1258 define.
1259
1260 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001261 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001262 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1263 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1264 CONFIG_SYS_NUM_I2C_BUSES = 9:
1265
1266 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1267 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1268 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1269 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1270 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1271 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1272 {1, {I2C_NULL_HOP}}, \
1273 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1274 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1275 }
1276
1277 which defines
1278 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001279 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1280 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1281 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1282 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1283 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001284 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001285 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1286 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001287
1288 If you do not have i2c muxes on your board, omit this define.
1289
Simon Glass3efce392017-05-12 21:10:00 -06001290- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001291 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001292 then the following macros need to be defined (examples are
1293 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001294
1295 I2C_INIT
1296
wdenkb9bbd242003-06-30 16:24:52 +00001297 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001298 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001299
wdenk544e9732004-02-06 23:19:44 +00001300 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001301
wdenkc6097192002-11-03 00:24:07 +00001302 I2C_ACTIVE
1303
1304 The code necessary to make the I2C data line active
1305 (driven). If the data line is open collector, this
1306 define can be null.
1307
wdenkb9bbd242003-06-30 16:24:52 +00001308 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1309
wdenkc6097192002-11-03 00:24:07 +00001310 I2C_TRISTATE
1311
1312 The code necessary to make the I2C data line tri-stated
1313 (inactive). If the data line is open collector, this
1314 define can be null.
1315
wdenkb9bbd242003-06-30 16:24:52 +00001316 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1317
wdenkc6097192002-11-03 00:24:07 +00001318 I2C_READ
1319
York Sun4a598092013-04-01 11:29:11 -07001320 Code that returns true if the I2C data line is high,
1321 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001322
wdenkb9bbd242003-06-30 16:24:52 +00001323 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1324
wdenkc6097192002-11-03 00:24:07 +00001325 I2C_SDA(bit)
1326
York Sun4a598092013-04-01 11:29:11 -07001327 If <bit> is true, sets the I2C data line high. If it
1328 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001329
wdenkb9bbd242003-06-30 16:24:52 +00001330 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001331 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001332 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001333
wdenkc6097192002-11-03 00:24:07 +00001334 I2C_SCL(bit)
1335
York Sun4a598092013-04-01 11:29:11 -07001336 If <bit> is true, sets the I2C clock line high. If it
1337 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001338
wdenkb9bbd242003-06-30 16:24:52 +00001339 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001340 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001341 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001342
wdenkc6097192002-11-03 00:24:07 +00001343 I2C_DELAY
1344
1345 This delay is invoked four times per clock cycle so this
1346 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001347 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001348 like:
1349
wdenkb9bbd242003-06-30 16:24:52 +00001350 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001351
Mike Frysingeree12d542010-07-21 13:38:02 -04001352 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1353
1354 If your arch supports the generic GPIO framework (asm/gpio.h),
1355 then you may alternatively define the two GPIOs that are to be
1356 used as SCL / SDA. Any of the previous I2C_xxx macros will
1357 have GPIO-based defaults assigned to them as appropriate.
1358
1359 You should define these to the GPIO value as given directly to
1360 the generic GPIO functions.
1361
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001362 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001363
wdenk57b2d802003-06-27 21:31:46 +00001364 When a board is reset during an i2c bus transfer
1365 chips might think that the current transfer is still
1366 in progress. On some boards it is possible to access
1367 the i2c SCLK line directly, either by using the
1368 processor pin as a GPIO or by having a second pin
1369 connected to the bus. If this option is defined a
1370 custom i2c_init_board() routine in boards/xxx/board.c
1371 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001372
Ben Warren45657152006-09-07 16:50:54 -04001373 CONFIG_I2C_MULTI_BUS
1374
1375 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001376 must have a controller. At any point in time, only one bus is
1377 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001378 Note that bus numbering is zero-based.
1379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001380 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001381
1382 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001383 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001384 is set, specify a list of bus-device pairs. Otherwise, specify
1385 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001386
1387 e.g.
1388 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001389 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001390
1391 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1392
Wolfgang Denk092ae952011-10-26 10:21:21 +00001393 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001394 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001395
1396 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1397
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001398 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001399
1400 If defined, then this indicates the I2C bus number for DDR SPD.
1401 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1402
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001403 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001404
1405 If defined, then this indicates the I2C bus number for the RTC.
1406 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1407
Andrew Dyer58c41f92008-12-29 17:36:01 -06001408 CONFIG_SOFT_I2C_READ_REPEATED_START
1409
1410 defining this will force the i2c_read() function in
1411 the soft_i2c driver to perform an I2C repeated start
1412 between writing the address pointer and reading the
1413 data. If this define is omitted the default behaviour
1414 of doing a stop-start sequence will be used. Most I2C
1415 devices can use either method, but some require one or
1416 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001417
wdenkc6097192002-11-03 00:24:07 +00001418- SPI Support: CONFIG_SPI
1419
1420 Enables SPI driver (so far only tested with
1421 SPI EEPROM, also an instance works with Crystal A/D and
1422 D/As on the SACSng board)
1423
Heiko Schocherb77c8882014-07-14 10:22:11 +02001424 CONFIG_SYS_SPI_MXC_WAIT
1425 Timeout for waiting until spi transfer completed.
1426 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1427
Matthias Fuchsa4400872007-12-27 17:12:34 +01001428- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001429
Matthias Fuchsa4400872007-12-27 17:12:34 +01001430 Enables FPGA subsystem.
1431
1432 CONFIG_FPGA_<vendor>
1433
1434 Enables support for specific chip vendors.
1435 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001436
Matthias Fuchsa4400872007-12-27 17:12:34 +01001437 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001438
Matthias Fuchsa4400872007-12-27 17:12:34 +01001439 Enables support for FPGA family.
1440 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1441
1442 CONFIG_FPGA_COUNT
1443
1444 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001446 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001447
wdenk57b2d802003-06-27 21:31:46 +00001448 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001450 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001451
wdenk4a5c8a72003-03-06 00:02:04 +00001452 Enable checks on FPGA configuration interface busy
1453 status by the configuration function. This option
1454 will require a board or device specific function to
1455 be written.
wdenkc6097192002-11-03 00:24:07 +00001456
1457 CONFIG_FPGA_DELAY
1458
1459 If defined, a function that provides delays in the FPGA
1460 configuration driver.
1461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001462 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001463 Allow Control-C to interrupt FPGA configuration
1464
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001465 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001466
wdenk4a5c8a72003-03-06 00:02:04 +00001467 Check for configuration errors during FPGA bitfile
1468 loading. For example, abort during Virtex II
1469 configuration if the INIT_B line goes low (which
1470 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001471
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001472 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001473
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001474 Maximum time to wait for the INIT_B line to de-assert
1475 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001476 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001477 ms.
wdenkc6097192002-11-03 00:24:07 +00001478
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001479 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001480
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001481 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001482 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001484 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001485
wdenk4a5c8a72003-03-06 00:02:04 +00001486 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001487 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001488
wdenkc6097192002-11-03 00:24:07 +00001489- Vendor Parameter Protection:
1490
wdenk4a5c8a72003-03-06 00:02:04 +00001491 U-Boot considers the values of the environment
1492 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001493 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001494 are set once by the board vendor / manufacturer, and
1495 protects these variables from casual modification by
1496 the user. Once set, these variables are read-only,
1497 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001498 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001499
1500 If CONFIG_ENV_OVERWRITE is #defined in your config
1501 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001502 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001503 these parameters.
1504
Joe Hershberger76f353e2015-05-04 14:55:14 -05001505 Alternatively, if you define _both_ an ethaddr in the
1506 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001507 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001508 which can be changed exactly ONCE by the user. [The
1509 serial# is unaffected by this, i. e. it remains
1510 read-only.]
1511
Joe Hershberger71497d02012-12-11 22:16:31 -06001512 The same can be accomplished in a more flexible way
1513 for any variable by configuring the type of access
1514 to allow for those variables in the ".flags" variable
1515 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1516
wdenkc6097192002-11-03 00:24:07 +00001517- Protected RAM:
1518 CONFIG_PRAM
1519
1520 Define this variable to enable the reservation of
1521 "protected RAM", i. e. RAM which is not overwritten
1522 by U-Boot. Define CONFIG_PRAM to hold the number of
1523 kB you want to reserve for pRAM. You can overwrite
1524 this default value by defining an environment
1525 variable "pram" to the number of kB you want to
1526 reserve. Note that the board info structure will
1527 still show the full amount of RAM. If pRAM is
1528 reserved, a new environment variable "mem" will
1529 automatically be defined to hold the amount of
1530 remaining RAM in a form that can be passed as boot
1531 argument to Linux, for instance like that:
1532
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001533 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001534 saveenv
1535
1536 This way you can tell Linux not to use this memory,
1537 either, which results in a memory region that will
1538 not be affected by reboots.
1539
1540 *WARNING* If your board configuration uses automatic
1541 detection of the RAM size, you must make sure that
1542 this memory test is non-destructive. So far, the
1543 following board configurations are known to be
1544 "pRAM-clean":
1545
Heiko Schocher65d94db2017-06-07 17:33:09 +02001546 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00001547 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02001548 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001549
1550- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001551 Note:
1552
wdenk57b2d802003-06-27 21:31:46 +00001553 In the current implementation, the local variables
1554 space and global environment variables space are
1555 separated. Local variables are those you define by
1556 simply typing `name=value'. To access a local
1557 variable later on, you have write `$name' or
1558 `${name}'; to execute the contents of a variable
1559 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001560
wdenk4a5c8a72003-03-06 00:02:04 +00001561 Global environment variables are those you use
1562 setenv/printenv to work with. To run a command stored
1563 in such a variable, you need to use the run command,
1564 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001565
1566 To store commands and special characters in a
1567 variable, please use double quotation marks
1568 surrounding the whole text of the variable, instead
1569 of the backslashes before semicolons and special
1570 symbols.
1571
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001572- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01001573 CONFIG_CMDLINE_PS_SUPPORT
1574
1575 Enable support for changing the command prompt string
1576 at run-time. Only static string is supported so far.
1577 The string is obtained from environment variables PS1
1578 and PS2.
1579
wdenkc0aa5c52003-12-06 19:49:23 +00001580- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001581 CONFIG_EXTRA_ENV_SETTINGS
1582
wdenk4a5c8a72003-03-06 00:02:04 +00001583 Define this to contain any number of null terminated
1584 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001585 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001586
wdenk4a5c8a72003-03-06 00:02:04 +00001587 For example, place something like this in your
1588 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001589
1590 #define CONFIG_EXTRA_ENV_SETTINGS \
1591 "myvar1=value1\0" \
1592 "myvar2=value2\0"
1593
wdenk4a5c8a72003-03-06 00:02:04 +00001594 Warning: This method is based on knowledge about the
1595 internal format how the environment is stored by the
1596 U-Boot code. This is NOT an official, exported
1597 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001598 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001599 You better know what you are doing here.
1600
wdenk4a5c8a72003-03-06 00:02:04 +00001601 Note: overly (ab)use of the default environment is
1602 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001603 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00001604 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001605
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001606 CONFIG_DELAY_ENVIRONMENT
1607
1608 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001609 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001610 that so that the environment is not available until
1611 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1612 this is instead controlled by the value of
1613 /config/load-environment.
1614
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001615 CONFIG_STANDALONE_LOAD_ADDR
1616
Wolfgang Denk23f78482011-10-09 21:06:34 +02001617 This option defines a board specific value for the
1618 address where standalone program gets loaded, thus
1619 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001620 settings.
1621
1622- Frame Buffer Address:
1623 CONFIG_FB_ADDR
1624
1625 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00001626 address for frame buffer. This is typically the case
1627 when using a graphics controller has separate video
1628 memory. U-Boot will then place the frame buffer at
1629 the given address instead of dynamically reserving it
1630 in system RAM by calling lcd_setmem(), which grabs
1631 the memory for the frame buffer depending on the
1632 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001633
1634 Please see board_init_f function.
1635
Detlev Zundel0ecb6112009-12-01 17:16:19 +01001636- Automatic software updates via TFTP server
1637 CONFIG_UPDATE_TFTP
1638 CONFIG_UPDATE_TFTP_CNT_MAX
1639 CONFIG_UPDATE_TFTP_MSEC_MAX
1640
1641 These options enable and control the auto-update feature;
1642 for a more detailed description refer to doc/README.update.
1643
1644- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02001645 CONFIG_MTD_UBI_WL_THRESHOLD
1646 This parameter defines the maximum difference between the highest
1647 erase counter value and the lowest erase counter value of eraseblocks
1648 of UBI devices. When this threshold is exceeded, UBI starts performing
1649 wear leveling by means of moving data from eraseblock with low erase
1650 counter to eraseblocks with high erase counter.
1651
1652 The default value should be OK for SLC NAND flashes, NOR flashes and
1653 other flashes which have eraseblock life-cycle 100000 or more.
1654 However, in case of MLC NAND flashes which typically have eraseblock
1655 life-cycle less than 10000, the threshold should be lessened (e.g.,
1656 to 128 or 256, although it does not have to be power of 2).
1657
1658 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06001659
Heiko Schocherf5895d12014-06-24 10:10:04 +02001660 CONFIG_MTD_UBI_BEB_LIMIT
1661 This option specifies the maximum bad physical eraseblocks UBI
1662 expects on the MTD device (per 1024 eraseblocks). If the
1663 underlying flash does not admit of bad eraseblocks (e.g. NOR
1664 flash), this value is ignored.
1665
1666 NAND datasheets often specify the minimum and maximum NVM
1667 (Number of Valid Blocks) for the flashes' endurance lifetime.
1668 The maximum expected bad eraseblocks per 1024 eraseblocks
1669 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1670 which gives 20 for most NANDs (MaxNVB is basically the total
1671 count of eraseblocks on the chip).
1672
1673 To put it differently, if this value is 20, UBI will try to
1674 reserve about 1.9% of physical eraseblocks for bad blocks
1675 handling. And that will be 1.9% of eraseblocks on the entire
1676 NAND chip, not just the MTD partition UBI attaches. This means
1677 that if you have, say, a NAND flash chip admits maximum 40 bad
1678 eraseblocks, and it is split on two MTD partitions of the same
1679 size, UBI will reserve 40 eraseblocks when attaching a
1680 partition.
1681
1682 default: 20
1683
1684 CONFIG_MTD_UBI_FASTMAP
1685 Fastmap is a mechanism which allows attaching an UBI device
1686 in nearly constant time. Instead of scanning the whole MTD device it
1687 only has to locate a checkpoint (called fastmap) on the device.
1688 The on-flash fastmap contains all information needed to attach
1689 the device. Using fastmap makes only sense on large devices where
1690 attaching by scanning takes long. UBI will not automatically install
1691 a fastmap on old images, but you can set the UBI parameter
1692 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1693 that fastmap-enabled images are still usable with UBI implementations
1694 without fastmap support. On typical flash devices the whole fastmap
1695 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1696
1697 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1698 Set this parameter to enable fastmap automatically on images
1699 without a fastmap.
1700 default: 0
1701
Heiko Schocher94b66de2015-10-22 06:19:21 +02001702 CONFIG_MTD_UBI_FM_DEBUG
1703 Enable UBI fastmap debug
1704 default: 0
1705
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001706- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02001707 CONFIG_SPL
1708 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001709
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001710 CONFIG_SPL_MAX_FOOTPRINT
1711 Maximum size in memory allocated to the SPL, BSS included.
1712 When defined, the linker checks that the actual memory
1713 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00001714 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001715 must not be both defined at the same time.
1716
Tom Rini36853852012-02-14 07:29:40 +00001717 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001718 Maximum size of the SPL image (text, data, rodata, and
1719 linker lists sections), BSS excluded.
1720 When defined, the linker checks that the actual size does
1721 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00001722
Scott Woodc4f0d002012-09-20 19:05:12 -05001723 CONFIG_SPL_RELOC_TEXT_BASE
1724 Address to relocate to. If unspecified, this is equal to
1725 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
1726
Tom Rini36853852012-02-14 07:29:40 +00001727 CONFIG_SPL_BSS_START_ADDR
1728 Link address for the BSS within the SPL binary.
1729
1730 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001731 Maximum size in memory allocated to the SPL BSS.
1732 When defined, the linker checks that the actual memory used
1733 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00001734 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001735 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00001736
1737 CONFIG_SPL_STACK
1738 Adress of the start of the stack SPL will use
1739
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02001740 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1741 When defined, SPL will panic() if the image it has
1742 loaded does not have a signature.
1743 Defining this is useful when code which loads images
1744 in SPL cannot guarantee that absolutely all read errors
1745 will be caught.
1746 An example is the LPC32XX MLC NAND driver, which will
1747 consider that a completely unreadable NAND block is bad,
1748 and thus should be skipped silently.
1749
Scott Woodc4f0d002012-09-20 19:05:12 -05001750 CONFIG_SPL_RELOC_STACK
1751 Adress of the start of the stack SPL will use after
1752 relocation. If unspecified, this is equal to
1753 CONFIG_SPL_STACK.
1754
Tom Rini36853852012-02-14 07:29:40 +00001755 CONFIG_SYS_SPL_MALLOC_START
1756 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02001757 When this option is set the full malloc is used in SPL and
1758 it is set up by spl_init() and before that, the simple malloc()
1759 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00001760
1761 CONFIG_SYS_SPL_MALLOC_SIZE
1762 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001763
Tom Rinife3b0c72012-08-13 11:37:56 -07001764 CONFIG_SPL_DISPLAY_PRINT
1765 For ARM, enable an optional function to print more information
1766 about the running system.
1767
Scott Wood7c810902012-09-20 16:35:21 -05001768 CONFIG_SPL_INIT_MINIMAL
1769 Arch init code should be built for a very small image
1770
Peter Korsgaard01b542f2013-05-13 08:36:29 +00001771 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
1772 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
1773 Sector and number of sectors to load kernel argument
1774 parameters from when MMC is being used in raw mode
1775 (for falcon mode)
1776
Guillaume GARDET5065b712014-10-15 17:53:13 +02001777 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
1778 Filename to read to load U-Boot when reading from filesystem
1779
1780 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001781 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02001782 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001783
Guillaume GARDET5065b712014-10-15 17:53:13 +02001784 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001785 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02001786 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001787
Scott Wood2b36fbb2012-12-06 13:33:17 +00001788 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1789 Set this for NAND SPL on PPC mpc83xx targets, so that
1790 start.S waits for the rest of the SPL to load before
1791 continuing (the hardware starts execution after just
1792 loading the first page rather than the full 4K).
1793
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05301794 CONFIG_SPL_SKIP_RELOCATE
1795 Avoid SPL relocation
1796
Thomas Gleixner820d24d2016-07-12 20:28:12 +02001797 CONFIG_SPL_UBI
1798 Support for a lightweight UBI (fastmap) scanner and
1799 loader
1800
Heiko Schochercf000272014-10-31 08:31:00 +01001801 CONFIG_SPL_NAND_RAW_ONLY
1802 Support to boot only raw u-boot.bin images. Use this only
1803 if you need to save space.
1804
Ying Zhangdfb2b152013-08-16 15:16:12 +08001805 CONFIG_SPL_COMMON_INIT_DDR
1806 Set for common ddr init with serial presence detect in
1807 SPL binary.
1808
Tom Rini36853852012-02-14 07:29:40 +00001809 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1810 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1811 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1812 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1813 CONFIG_SYS_NAND_ECCBYTES
1814 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05001815 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00001816
Scott Wood36c440e2012-09-21 18:35:27 -05001817 CONFIG_SYS_NAND_U_BOOT_DST
1818 Location in memory to load U-Boot to
1819
1820 CONFIG_SYS_NAND_U_BOOT_SIZE
1821 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00001822
1823 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05001824 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00001825
1826 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1827 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001828 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00001829
Pavel Machekde997252012-08-30 22:42:11 +02001830 CONFIG_SPL_RAM_DEVICE
1831 Support for running image already present in ram, in SPL binary
1832
Scott Woodeb7bd972012-12-06 13:33:16 +00001833 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00001834 Image offset to which the SPL should be padded before appending
1835 the SPL payload. By default, this is defined as
1836 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1837 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1838 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00001839
Scott Woodf147eb72012-09-21 16:27:32 -05001840 CONFIG_SPL_TARGET
1841 Final target image containing SPL and payload. Some SPLs
1842 use an arch-specific makefile fragment instead, for
1843 example if more than one image needs to be produced.
1844
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02001845 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00001846 Printing information about a FIT image adds quite a bit of
1847 code to SPL. So this is normally disabled in SPL. Use this
1848 option to re-enable it. This will affect the output of the
1849 bootm command when booting a FIT image.
1850
Ying Zhang2d2e3b62013-08-16 15:16:15 +08001851- TPL framework
1852 CONFIG_TPL
1853 Enable building of TPL globally.
1854
1855 CONFIG_TPL_PAD_TO
1856 Image offset to which the TPL should be padded before appending
1857 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001858 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1859 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1860 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08001861
wdenkc0aa5c52003-12-06 19:49:23 +00001862- Interrupt support (PPC):
1863
wdenk1ebf41e2004-01-02 14:00:00 +00001864 There are common interrupt_init() and timer_interrupt()
1865 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001866 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00001867 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001868 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00001869 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001870 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00001871 specific handling. If board has watchdog / status_led
1872 / other_activity_monitor it works automatically from
1873 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00001874
wdenkc6097192002-11-03 00:24:07 +00001875
Helmut Raigerd5a184b2011-10-20 04:19:47 +00001876Board initialization settings:
1877------------------------------
1878
1879During Initialization u-boot calls a number of board specific functions
1880to allow the preparation of board specific prerequisites, e.g. pin setup
1881before drivers are initialized. To enable these callbacks the
1882following configuration macros have to be defined. Currently this is
1883architecture specific, so please check arch/your_architecture/lib/board.c
1884typically in board_init_f() and board_init_r().
1885
1886- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1887- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1888- CONFIG_BOARD_LATE_INIT: Call board_late_init()
wdenkc6097192002-11-03 00:24:07 +00001889
wdenkc6097192002-11-03 00:24:07 +00001890Configuration Settings:
1891-----------------------
1892
Simon Glass8927bf22019-12-28 10:45:10 -07001893- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun6c480012014-02-26 17:03:19 -08001894 Optionally it can be defined to support 64-bit memory commands.
1895
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001896- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00001897 undefine this when you're short of memory.
1898
Peter Tyserdfb72b82009-01-27 18:03:12 -06001899- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
1900 width of the commands listed in the 'help' command output.
1901
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001902- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00001903 prompt for user input.
1904
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001905- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00001906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001907- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00001908
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001909- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00001910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001911- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00001912 the application (usually a Linux kernel) when it is
1913 booted
1914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001915- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00001916 List of legal baudrate settings for this board.
1917
York Sun5d286cd2015-12-04 11:57:07 -08001918- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07001919 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08001920 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
1921 is substracted from total RAM and won't be reported to OS.
1922 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07001923 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08001924 the RAM base is not zero, or RAM is divided into banks,
1925 this variable needs to be recalcuated to get the address.
1926
York Sun50739372015-12-07 11:05:29 -08001927- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001928 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01001929 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001930 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01001931 fixing up gd->ram_size the Linux kernel should gets passed
1932 the now "corrected" memory size and won't touch it either.
1933 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01001934 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01001935 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01001936 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01001937
1938 This option can be used as a workaround for the 440EPx/GRx
1939 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
1940 be touched.
1941
1942 WARNING: Please make sure that this value is a multiple of
1943 the Linux page size (normally 4k). If this is not the case,
1944 then the end address of the Linux memory will be located at a
1945 non page size aligned address and this could cause major
1946 problems.
1947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001948- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00001949 Enable temporary baudrate change while serial download
1950
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001951- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00001952 Physical start address of SDRAM. _Must_ be 0 here.
1953
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001954- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00001955 Physical start address of Flash memory.
1956
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001957- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00001958 Physical start address of boot monitor code (set by
1959 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02001960 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001961 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00001962
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001963- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00001964 Size of memory reserved for monitor code, used to
1965 determine _at_compile_time_ (!) if the environment is
1966 embedded within the U-Boot image, or in a separate
1967 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001969- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00001970 Size of DRAM reserved for malloc() use.
1971
Simon Glass863e4042014-07-10 22:23:28 -06001972- CONFIG_SYS_MALLOC_F_LEN
1973 Size of the malloc() pool for use before relocation. If
1974 this is defined, then a very simple malloc() implementation
1975 will become available before relocation. The address is just
1976 below the global data, and the stack is moved down to make
1977 space.
1978
1979 This feature allocates regions with increasing addresses
1980 within the region. calloc() is supported, but realloc()
1981 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001982 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06001983 U-Boot relocates itself.
1984
Simon Glass9fa901b2014-11-10 17:16:54 -07001985- CONFIG_SYS_MALLOC_SIMPLE
1986 Provides a simple and small malloc() and calloc() for those
1987 boards which do not use the full malloc in SPL (which is
1988 enabled with CONFIG_SYS_SPL_MALLOC_START).
1989
Thierry Redingc97d9742014-12-09 22:25:22 -07001990- CONFIG_SYS_NONCACHED_MEMORY:
1991 Size of non-cached memory area. This area of memory will be
1992 typically located right below the malloc() area and mapped
1993 uncached in the MMU. This is useful for drivers that would
1994 otherwise require a lot of explicit cache maintenance. For
1995 some drivers it's also impossible to properly maintain the
1996 cache. For example if the regions that need to be flushed
1997 are not a multiple of the cache-line size, *and* padding
1998 cannot be allocated between the regions to align them (i.e.
1999 if the HW requires a contiguous array of regions, and the
2000 size of each region is not cache-aligned), then a flush of
2001 one region may result in overwriting data that hardware has
2002 written to another region in the same cache-line. This can
2003 happen for example in network drivers where descriptors for
2004 buffers are typically smaller than the CPU cache-line (e.g.
2005 16 bytes vs. 32 or 64 bytes).
2006
2007 Non-cached memory is only supported on 32-bit ARM at present.
2008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002009- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002010 Normally compressed uImages are limited to an
2011 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002012 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002013 to adjust this setting to your needs.
2014
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002015- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002016 Maximum size of memory mapped by the startup code of
2017 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002018 the Linux kernel (bd_info, boot arguments, FDT blob if
2019 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002020 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002021 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00002022 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00002023 variable "bootm_mapsize" will override the value of
2024 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2025 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002026
John Rigbyeea8e692010-10-13 13:57:35 -06002027- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2028 Enable initrd_high functionality. If defined then the
2029 initrd_high feature is enabled and the bootm ramdisk subcommand
2030 is enabled.
2031
2032- CONFIG_SYS_BOOT_GET_CMDLINE:
2033 Enables allocating and saving kernel cmdline in space between
2034 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2035
2036- CONFIG_SYS_BOOT_GET_KBD:
2037 Enables allocating and saving a kernel copy of the bd_info in
2038 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2039
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002040- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002041 Max number of sectors on a Flash chip
2042
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002043- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002044 Timeout for Flash erase operations (in ms)
2045
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002046- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002047 Timeout for Flash write operations (in ms)
2048
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002049- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002050 Timeout for Flash set sector lock bit operation (in ms)
2051
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002052- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002053 Timeout for Flash clear lock bits operation (in ms)
2054
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002055- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002056 If defined, hardware flash sectors protection is used
2057 instead of U-Boot software protection.
2058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002059- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002060
2061 Enable TFTP transfers directly to flash memory;
2062 without this option such a download has to be
2063 performed in two steps: (1) download to RAM, and (2)
2064 copy from RAM to flash.
2065
2066 The two-step approach is usually more reliable, since
2067 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002068 the flash, but in some situations (when system RAM is
2069 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002070 downloaded image) this option may be very useful.
2071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002072- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002073 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002074 common flash structure for storing flash geometry.
2075
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002076- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002077 This option also enables the building of the cfi_flash driver
2078 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002079
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002080- CONFIG_FLASH_CFI_MTD
2081 This option enables the building of the cfi_mtd driver
2082 in the drivers directory. The driver exports CFI flash
2083 to the MTD layer.
2084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002085- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002086 Use buffered writes to flash.
2087
2088- CONFIG_FLASH_SPANSION_S29WS_N
2089 s29ws-n MirrorBit flash has non-standard addresses for buffered
2090 write commands.
2091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002092- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002093 If this option is defined, the common CFI flash doesn't
2094 print it's warning upon not recognized FLASH banks. This
2095 is useful, if some of the configured banks are only
2096 optionally available.
2097
Jerry Van Barenaae73572008-03-08 13:48:01 -05002098- CONFIG_FLASH_SHOW_PROGRESS
2099 If defined (must be an integer), print out countdown
2100 digits and dots. Recommended value: 45 (9..1) for 80
2101 column displays, 15 (3..1) for 40 column displays.
2102
Stefan Roesed20cba52013-04-04 15:53:14 +02002103- CONFIG_FLASH_VERIFY
2104 If defined, the content of the flash (destination) is compared
2105 against the source after the write operation. An error message
2106 will be printed when the contents are not identical.
2107 Please note that this option is useless in nearly all cases,
2108 since such flash programming errors usually are detected earlier
2109 while unprotecting/erasing/programming. Please only enable
2110 this option if you really know what you are doing.
2111
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002112- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002113 Defines the number of Ethernet receive buffers. On some
2114 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002115 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2116 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002117 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002118 Defaults to 4 if not defined.
2119
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002120- CONFIG_ENV_MAX_ENTRIES
2121
Wolfgang Denk1136f692010-10-27 22:48:30 +02002122 Maximum number of entries in the hash table that is used
2123 internally to store the environment settings. The default
2124 setting is supposed to be generous and should work in most
2125 cases. This setting can be used to tune behaviour; see
2126 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002127
Joe Hershberger71497d02012-12-11 22:16:31 -06002128- CONFIG_ENV_FLAGS_LIST_DEFAULT
2129- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002130 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002131 calling env set. Variables can be restricted to only decimal,
2132 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2133 the variables can also be restricted to IP address or MAC address.
2134
2135 The format of the list is:
2136 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002137 access_attribute = [a|r|o|c]
2138 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002139 entry = variable_name[:attributes]
2140 list = entry[,list]
2141
2142 The type attributes are:
2143 s - String (default)
2144 d - Decimal
2145 x - Hexadecimal
2146 b - Boolean ([1yYtT|0nNfF])
2147 i - IP address
2148 m - MAC address
2149
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002150 The access attributes are:
2151 a - Any (default)
2152 r - Read-only
2153 o - Write-once
2154 c - Change-default
2155
Joe Hershberger71497d02012-12-11 22:16:31 -06002156 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2157 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002158 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002159
2160 - CONFIG_ENV_FLAGS_LIST_STATIC
2161 Define this to a list (string) to define validation that
2162 should be done if an entry is not found in the ".flags"
2163 environment variable. To override a setting in the static
2164 list, simply add an entry for the same variable name to the
2165 ".flags" variable.
2166
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002167 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2168 regular expression. This allows multiple variables to define the same
2169 flags without explicitly listing them for each variable.
2170
wdenkc6097192002-11-03 00:24:07 +00002171The following definitions that deal with the placement and management
2172of environment data (variable area); in general, we support the
2173following configurations:
2174
Mike Frysinger63b8f122011-07-08 10:44:25 +00002175- CONFIG_BUILD_ENVCRC:
2176
2177 Builds up envcrc with the target environment so that external utils
2178 may easily extract it and embed it in final U-Boot images.
2179
wdenkc6097192002-11-03 00:24:07 +00002180BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002181in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002182console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002183U-Boot will hang.
2184
2185Please note that even with NVRAM we still use a copy of the
2186environment in RAM: we could work on NVRAM directly, but we want to
2187keep settings there always unmodified except somebody uses "saveenv"
2188to save the current settings.
2189
Liu Gang85bcd732012-03-08 00:33:20 +00002190BE CAREFUL! For some special cases, the local device can not use
2191"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002192environment stored in a remote NOR flash by SRIO or PCIE link,
2193but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002194
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002195- CONFIG_NAND_ENV_DST
2196
2197 Defines address in RAM to which the nand_spl code should copy the
2198 environment. If redundant environment is used, it will be copied to
2199 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2200
Bruce Adleredecc942007-11-02 13:15:42 -07002201Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002202has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002203created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002204until then to read environment variables.
2205
wdenk8dba0502003-03-31 16:34:49 +00002206The environment is protected by a CRC32 checksum. Before the monitor
2207is relocated into RAM, as a result of a bad CRC you will be working
2208with the compiled-in default environment - *silently*!!! [This is
2209necessary, because the first environment variable we need is the
2210"baudrate" setting for the console - if we have a bad CRC, we don't
2211have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002212
2213Note: once the monitor has been relocated, then it will complain if
2214the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002215use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002216
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002217- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002218 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002219
Ron Madriddfa028a2009-02-18 14:30:44 -08002220- CONFIG_NS16550_MIN_FUNCTIONS:
2221 Define this if you desire to only have use of the NS16550_init
2222 and NS16550_putc functions for the serial driver located at
2223 drivers/serial/ns16550.c. This option is useful for saving
2224 space for already greatly restricted images, including but not
2225 limited to NAND_SPL configurations.
2226
Simon Glass28a9e332012-11-30 13:01:18 +00002227- CONFIG_DISPLAY_BOARDINFO
2228 Display information about the board that U-Boot is running on
2229 when U-Boot starts up. The board function checkboard() is called
2230 to do this.
2231
Simon Glasse8822012012-11-30 13:01:19 +00002232- CONFIG_DISPLAY_BOARDINFO_LATE
2233 Similar to the previous option, but display this information
2234 later, once stdio is running and output goes to the LCD, if
2235 present.
2236
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002237- CONFIG_BOARD_SIZE_LIMIT:
2238 Maximum size of the U-Boot image. When defined, the
2239 build system checks that the actual size does not
2240 exceed it.
2241
wdenkc6097192002-11-03 00:24:07 +00002242Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002243---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002245- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002246 Cache Line Size of the CPU.
2247
Timur Tabid8f341c2011-08-04 18:03:41 -05002248- CONFIG_SYS_CCSRBAR_DEFAULT:
2249 Default (power-on reset) physical address of CCSR on Freescale
2250 PowerPC SOCs.
2251
2252- CONFIG_SYS_CCSRBAR:
2253 Virtual address of CCSR. On a 32-bit build, this is typically
2254 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2255
Timur Tabid8f341c2011-08-04 18:03:41 -05002256- CONFIG_SYS_CCSRBAR_PHYS:
2257 Physical address of CCSR. CCSR can be relocated to a new
2258 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002259 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002260 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2261 is typically relocated on 36-bit builds. It is recommended
2262 that this macro be defined via the _HIGH and _LOW macros:
2263
2264 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2265 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2266
2267- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002268 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2269 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002270 used in assembly code, so it must not contain typecasts or
2271 integer size suffixes (e.g. "ULL").
2272
2273- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2274 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2275 used in assembly code, so it must not contain typecasts or
2276 integer size suffixes (e.g. "ULL").
2277
2278- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2279 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2280 forced to a value that ensures that CCSR is not relocated.
2281
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002282- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002283 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02002284 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002285
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002286- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002287
wdenkeb20ad32003-09-05 23:19:14 +00002288 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002289 initial data and stack; please note that this must be
2290 writable memory that is working WITHOUT special
2291 initialization, i. e. you CANNOT use normal RAM which
2292 will become available only after programming the
2293 memory controller and running certain initialization
2294 sequences.
2295
2296 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02002297 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002299- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002300
2301 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002302 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2303 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002304 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002305 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06002306 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002307 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2308 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002309
2310 Note:
2311 On the MPC824X (or other systems that use the data
2312 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002313 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002314 point to an otherwise UNUSED address space between
2315 the top of RAM and the start of the PCI space.
2316
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002317- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002318
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002319- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002320 SDRAM timing
2321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002322- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002323 periodic timer for refresh
2324
Kumar Gala8975d7a2010-12-30 12:09:53 -06002325- CONFIG_SYS_SRIO:
2326 Chip has SRIO or not
2327
2328- CONFIG_SRIO1:
2329 Board has SRIO 1 port available
2330
2331- CONFIG_SRIO2:
2332 Board has SRIO 2 port available
2333
Liu Gang27afb9c2013-05-07 16:30:46 +08002334- CONFIG_SRIO_PCIE_BOOT_MASTER
2335 Board can support master function for Boot from SRIO and PCIE
2336
Kumar Gala8975d7a2010-12-30 12:09:53 -06002337- CONFIG_SYS_SRIOn_MEM_VIRT:
2338 Virtual Address of SRIO port 'n' memory region
2339
Simon Glass970b61e2019-11-14 12:57:09 -07002340- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Gala8975d7a2010-12-30 12:09:53 -06002341 Physical Address of SRIO port 'n' memory region
2342
2343- CONFIG_SYS_SRIOn_MEM_SIZE:
2344 Size of SRIO port 'n' memory region
2345
Fabio Estevamf17e8782013-04-11 09:35:34 +00002346- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2347 Defined to tell the NAND controller that the NAND chip is using
2348 a 16 bit bus.
2349 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00002350 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002351 - drivers/mtd/nand/raw/ndfc.c
2352 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04002353
2354- CONFIG_SYS_NDFC_EBC0_CFG
2355 Sets the EBC0_CFG register for the NDFC. If not defined
2356 a default value will be used.
2357
Ben Warren45657152006-09-07 16:50:54 -04002358- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002359 Get DDR timing information from an I2C EEPROM. Common
2360 with pluggable memory modules such as SODIMMs
2361
Ben Warren45657152006-09-07 16:50:54 -04002362 SPD_EEPROM_ADDRESS
2363 I2C address of the SPD EEPROM
2364
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002365- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002366 If SPD EEPROM is on an I2C bus other than the first
2367 one, specify here. Note that the value must resolve
2368 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002369
York Sune73cc042011-06-07 09:42:16 +08002370- CONFIG_SYS_DDR_RAW_TIMING
2371 Get DDR timing information from other than SPD. Common with
2372 soldered DDR chips onboard without SPD. DDR raw timing
2373 parameters are extracted from datasheet and hard-coded into
2374 header files or board specific files.
2375
York Sunbd495cf2011-09-16 13:21:35 -07002376- CONFIG_FSL_DDR_INTERACTIVE
2377 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2378
York Sun8ced0502015-01-06 13:18:55 -08002379- CONFIG_FSL_DDR_SYNC_REFRESH
2380 Enable sync of refresh for multiple controllers.
2381
York Sunb6a35f82015-03-19 09:30:28 -07002382- CONFIG_FSL_DDR_BIST
2383 Enable built-in memory test for Freescale DDR controllers.
2384
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002385- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002386 Only for 83xx systems. If specified, then DDR should
2387 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002388
wdenk6203e402004-04-18 10:13:26 +00002389- CONFIG_RMII
2390 Enable RMII mode for all FECs.
2391 Note that this is a global option, we can't
2392 have one FEC in standard MII mode and another in RMII mode.
2393
wdenk20c98a62004-04-23 20:32:05 +00002394- CONFIG_CRC32_VERIFY
2395 Add a verify option to the crc32 command.
2396 The syntax is:
2397
2398 => crc32 -v <address> <count> <crc32>
2399
2400 Where address/count indicate a memory area
2401 and crc32 is the correct crc32 which the
2402 area should have.
2403
wdenk64519362004-07-11 17:40:54 +00002404- CONFIG_LOOPW
2405 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06002406 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00002407
Joel Johnsondb5a97e2020-01-29 09:17:18 -07002408- CONFIG_CMD_MX_CYCLIC
stroesecc3af832004-12-16 18:46:55 +00002409 Add the "mdc" and "mwc" memory commands. These are cyclic
2410 "md/mw" commands.
2411 Examples:
2412
wdenk07d7e6b2004-12-16 21:44:03 +00002413 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002414 This command will print 4 bytes (10,11,12,13) each 500 ms.
2415
wdenk07d7e6b2004-12-16 21:44:03 +00002416 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002417 This command will write 12345678 to address 100 all 10 ms.
2418
wdenk07d7e6b2004-12-16 21:44:03 +00002419 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06002420 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00002421
Aneesh V552a3192011-07-13 05:11:07 +00002422- CONFIG_SPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002423 Set when the currently-running compilation is for an artifact
2424 that will end up in the SPL (as opposed to the TPL or U-Boot
2425 proper). Code that needs stage-specific behavior should check
2426 this.
wdenk336b2bc2005-04-02 23:52:25 +00002427
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002428- CONFIG_TPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002429 Set when the currently-running compilation is for an artifact
2430 that will end up in the TPL (as opposed to the SPL or U-Boot
2431 proper). Code that needs stage-specific behavior should check
2432 this.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002433
Ying Zhang0d4f5442013-05-20 14:07:23 +08002434- CONFIG_SYS_MPC85XX_NO_RESETVEC
2435 Only for 85xx systems. If this variable is specified, the section
2436 .resetvec is not kept and the section .bootpg is placed in the
2437 previous 4k of the .text section.
2438
Simon Glass17dabf02013-02-24 17:33:14 +00002439- CONFIG_ARCH_MAP_SYSMEM
2440 Generally U-Boot (and in particular the md command) uses
2441 effective address. It is therefore not necessary to regard
2442 U-Boot address as virtual addresses that need to be translated
2443 to physical addresses. However, sandbox requires this, since
2444 it maintains its own little RAM buffer which contains all
2445 addressable memory. This option causes some memory accesses
2446 to be mapped through map_sysmem() / unmap_sysmem().
2447
Simon Glassbfb59802013-02-14 04:18:54 +00002448- CONFIG_X86_RESET_VECTOR
2449 If defined, the x86 reset vector code is included. This is not
2450 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00002451
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002452- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2453 Option to disable subpage write in NAND driver
2454 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002455 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002456
Timur Tabi275f4bb2011-11-22 09:21:25 -06002457Freescale QE/FMAN Firmware Support:
2458-----------------------------------
2459
2460The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2461loading of "firmware", which is encoded in the QE firmware binary format.
2462This firmware often needs to be loaded during U-Boot booting, so macros
2463are used to identify the storage device (NOR flash, SPI, etc) and the address
2464within that device.
2465
Zhao Qiang83a90842014-03-21 16:21:44 +08002466- CONFIG_SYS_FMAN_FW_ADDR
2467 The address in the storage device where the FMAN microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002468 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiang83a90842014-03-21 16:21:44 +08002469 is also specified.
2470
2471- CONFIG_SYS_QE_FW_ADDR
2472 The address in the storage device where the QE microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002473 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabi275f4bb2011-11-22 09:21:25 -06002474 is also specified.
2475
2476- CONFIG_SYS_QE_FMAN_FW_LENGTH
2477 The maximum possible size of the firmware. The firmware binary format
2478 has a field that specifies the actual size of the firmware, but it
2479 might not be possible to read any part of the firmware unless some
2480 local storage is allocated to hold the entire firmware first.
2481
2482- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2483 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2484 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2485 virtual address in NOR flash.
2486
2487- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2488 Specifies that QE/FMAN firmware is located in NAND flash.
2489 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2490
2491- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2492 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2493 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2494
Liu Gang1e084582012-03-08 00:33:18 +00002495- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2496 Specifies that QE/FMAN firmware is located in the remote (master)
2497 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00002498 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2499 window->master inbound window->master LAW->the ucode address in
2500 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06002501
J. German Rivera8ff14b72014-06-23 15:15:55 -07002502Freescale Layerscape Management Complex Firmware Support:
2503---------------------------------------------------------
2504The Freescale Layerscape Management Complex (MC) supports the loading of
2505"firmware".
2506This firmware often needs to be loaded during U-Boot booting, so macros
2507are used to identify the storage device (NOR flash, SPI, etc) and the address
2508within that device.
2509
2510- CONFIG_FSL_MC_ENET
2511 Enable the MC driver for Layerscape SoCs.
2512
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302513Freescale Layerscape Debug Server Support:
2514-------------------------------------------
2515The Freescale Layerscape Debug Server Support supports the loading of
2516"Debug Server firmware" and triggering SP boot-rom.
2517This firmware often needs to be loaded during U-Boot booting.
2518
York Sun928b6812015-12-07 11:08:58 -08002519- CONFIG_SYS_MC_RSV_MEM_ALIGN
2520 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302521
Paul Kocialkowski7b917022015-07-26 18:48:15 +02002522Reproducible builds
2523-------------------
2524
2525In order to achieve reproducible builds, timestamps used in the U-Boot build
2526process have to be set to a fixed value.
2527
2528This is done using the SOURCE_DATE_EPOCH environment variable.
2529SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2530option for U-Boot or an environment variable in U-Boot.
2531
2532SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2533
wdenkc6097192002-11-03 00:24:07 +00002534Building the Software:
2535======================
2536
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002537Building U-Boot has been tested in several native build environments
2538and in many different cross environments. Of course we cannot support
2539all possibly existing versions of cross development tools in all
2540(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayamae0cc1852020-10-08 13:17:16 +09002541recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002542which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002543
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002544If you are not using a native environment, it is assumed that you
2545have GNU cross compiling tools available in your path. In this case,
2546you must set the environment variable CROSS_COMPILE in your shell.
2547Note that no changes to the Makefile or any other source files are
2548necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002549
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002550 $ CROSS_COMPILE=ppc_4xx-
2551 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002552
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002553U-Boot is intended to be simple to build. After installing the
2554sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002555is done by typing:
2556
Holger Freyther7ba4e572014-08-04 09:26:05 +02002557 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00002558
Holger Freyther7ba4e572014-08-04 09:26:05 +02002559where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01002560rations; see configs/*_defconfig for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00002561
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01002562Note: for some boards special configuration names may exist; check if
wdenk6c59edc2004-05-03 20:45:30 +00002563 additional information is available from the board vendor; for
2564 instance, the TQM823L systems are available without (standard)
2565 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002566 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002567
Holger Freyther7ba4e572014-08-04 09:26:05 +02002568 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002569 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002570
Holger Freyther7ba4e572014-08-04 09:26:05 +02002571 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002572 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002573
wdenk6c59edc2004-05-03 20:45:30 +00002574 etc.
wdenkc6097192002-11-03 00:24:07 +00002575
wdenkc6097192002-11-03 00:24:07 +00002576
wdenk6c59edc2004-05-03 20:45:30 +00002577Finally, type "make all", and you should get some working U-Boot
2578images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002579
wdenk6c59edc2004-05-03 20:45:30 +00002580- "u-boot.bin" is a raw binary image
2581- "u-boot" is an image in ELF binary format
2582- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002583
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002584By default the build is performed locally and the objects are saved
2585in the source directory. One of the two methods can be used to change
2586this behavior and build U-Boot to some external directory:
2587
25881. Add O= to the make command line invocations:
2589
2590 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02002591 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002592 make O=/tmp/build all
2593
Timo Ketolac8c67602014-11-06 14:39:05 +020025942. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002595
Timo Ketolac8c67602014-11-06 14:39:05 +02002596 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002597 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02002598 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002599 make all
2600
Timo Ketolac8c67602014-11-06 14:39:05 +02002601Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002602variable.
2603
Daniel Schwierzeck88484422018-01-26 16:31:04 +01002604User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2605setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2606For example to treat all compiler warnings as errors:
2607
2608 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00002609
wdenk6c59edc2004-05-03 20:45:30 +00002610Please be aware that the Makefiles assume you are using GNU make, so
2611for instance on NetBSD you might need to use "gmake" instead of
2612native "make".
wdenkc6097192002-11-03 00:24:07 +00002613
wdenkc6097192002-11-03 00:24:07 +00002614
wdenk6c59edc2004-05-03 20:45:30 +00002615If the system board that you have is not listed, then you will need
2616to port U-Boot to your hardware platform. To do this, follow these
2617steps:
wdenkc6097192002-11-03 00:24:07 +00002618
Phil Sutterc77b4882015-12-25 14:41:18 +010026191. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00002620 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01002621 the "Makefile" and a "<board>.c".
26222. Create a new configuration file "include/configs/<board>.h" for
2623 your board.
wdenk6c59edc2004-05-03 20:45:30 +000026243. If you're porting U-Boot to a new CPU, then also create a new
2625 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020026264. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000026275. Type "make", and you should get a working "u-boot.srec" file
2628 to be installed on your target system.
26296. Debug and solve any problems that might arise.
2630 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002631
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk6c59edc2004-05-03 20:45:30 +00002633Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2634==============================================================
wdenkc6097192002-11-03 00:24:07 +00002635
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002636If you have modified U-Boot sources (for instance added a new board
2637or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00002638provide feedback to the other developers. The feedback normally takes
Thomas Hebbfd37f242019-11-13 18:18:03 -08002639the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002640official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002641
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002642But before you submit such a patch, please verify that your modifi-
2643cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00002644the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06002645just run the buildman script (tools/buildman/buildman), which will
2646configure and build U-Boot for ALL supported system. Be warned, this
2647will take a while. Please see the buildman README, or run 'buildman -H'
2648for documentation.
wdenkc6097192002-11-03 00:24:07 +00002649
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002650
wdenk6c59edc2004-05-03 20:45:30 +00002651See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002652
wdenkc6097192002-11-03 00:24:07 +00002653
wdenk6c59edc2004-05-03 20:45:30 +00002654Monitor Commands - Overview:
2655============================
wdenkc6097192002-11-03 00:24:07 +00002656
wdenk6c59edc2004-05-03 20:45:30 +00002657go - start application at address 'addr'
2658run - run commands in an environment variable
2659bootm - boot application image from memory
2660bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00002661bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00002662tftpboot- boot image via network using TFTP protocol
2663 and env variables "ipaddr" and "serverip"
2664 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00002665tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00002666rarpboot- boot image via network using RARP/TFTP protocol
2667diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2668loads - load S-Record file over serial line
2669loadb - load binary file over serial line (kermit mode)
2670md - memory display
2671mm - memory modify (auto-incrementing)
2672nm - memory modify (constant address)
2673mw - memory write (fill)
Simon Glass19038de2020-06-02 19:26:49 -06002674ms - memory search
wdenk6c59edc2004-05-03 20:45:30 +00002675cp - memory copy
2676cmp - memory compare
2677crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05002678i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00002679sspi - SPI utility commands
2680base - print or set address offset
2681printenv- print environment variables
Pragnesh Patel1d5955f2020-12-22 11:30:05 +05302682pwm - control pwm channels
wdenk6c59edc2004-05-03 20:45:30 +00002683setenv - set environment variables
2684saveenv - save environment variables to persistent storage
2685protect - enable or disable FLASH write protection
2686erase - erase FLASH memory
2687flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00002688nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00002689bdinfo - print Board Info structure
2690iminfo - print header information for application image
2691coninfo - print console devices and informations
2692ide - IDE sub-system
2693loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002694loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002695mtest - simple RAM test
2696icache - enable or disable instruction cache
2697dcache - enable or disable data cache
2698reset - Perform RESET of the CPU
2699echo - echo args to console
2700version - print monitor version
2701help - print online help
2702? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002703
wdenkc6097192002-11-03 00:24:07 +00002704
wdenk6c59edc2004-05-03 20:45:30 +00002705Monitor Commands - Detailed Description:
2706========================================
wdenkc6097192002-11-03 00:24:07 +00002707
wdenk6c59edc2004-05-03 20:45:30 +00002708TODO.
wdenkc6097192002-11-03 00:24:07 +00002709
wdenk6c59edc2004-05-03 20:45:30 +00002710For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002711
2712
wdenk6c59edc2004-05-03 20:45:30 +00002713Note for Redundant Ethernet Interfaces:
2714=======================================
wdenkf4688a22003-05-28 08:06:31 +00002715
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002716Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00002717such configurations and is capable of automatic selection of a
2718"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00002719
wdenk6c59edc2004-05-03 20:45:30 +00002720Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2721MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2722"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00002723
wdenk6c59edc2004-05-03 20:45:30 +00002724If the network interface stores some valid MAC address (for instance
2725in SROM), this is used as default address if there is NO correspon-
2726ding setting in the environment; if the corresponding environment
2727variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00002728
wdenk6c59edc2004-05-03 20:45:30 +00002729o If the SROM has a valid MAC address, and there is no address in the
2730 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002731
wdenk6c59edc2004-05-03 20:45:30 +00002732o If there is no valid address in the SROM, and a definition in the
2733 environment exists, then the value from the environment variable is
2734 used.
wdenkc6097192002-11-03 00:24:07 +00002735
wdenk6c59edc2004-05-03 20:45:30 +00002736o If both the SROM and the environment contain a MAC address, and
2737 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002738
wdenk6c59edc2004-05-03 20:45:30 +00002739o If both the SROM and the environment contain a MAC address, and the
2740 addresses differ, the value from the environment is used and a
2741 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002742
wdenk6c59edc2004-05-03 20:45:30 +00002743o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05002744 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2745 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00002746
Ben Warren6db991a2010-04-26 11:11:46 -07002747If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00002748will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07002749may be skipped by setting the appropriate 'ethmacskip' environment variable.
2750The naming convention is as follows:
2751"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00002752
wdenk6c59edc2004-05-03 20:45:30 +00002753Image Formats:
2754==============
wdenkc6097192002-11-03 00:24:07 +00002755
Marian Balakowicz18710b82008-03-12 12:13:13 +01002756U-Boot is capable of booting (and performing other auxiliary operations on)
2757images in two formats:
2758
2759New uImage format (FIT)
2760-----------------------
2761
2762Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2763to Flattened Device Tree). It allows the use of images with multiple
2764components (several kernels, ramdisks, etc.), with contents protected by
2765SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2766
2767
2768Old uImage format
2769-----------------
2770
2771Old image format is based on binary files which can be basically anything,
2772preceded by a special header; see the definitions in include/image.h for
2773details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002774
wdenk6c59edc2004-05-03 20:45:30 +00002775* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2776 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05002777 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
Thomas Huthc90d56a2021-11-13 18:13:50 +01002778 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03002779* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00002780 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03002781 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00002782* Compression Type (uncompressed, gzip, bzip2)
2783* Load Address
2784* Entry Point
2785* Image Name
2786* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002787
wdenk6c59edc2004-05-03 20:45:30 +00002788The header is marked by a special Magic Number, and both the header
2789and the data portions of the image are secured against corruption by
2790CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002791
wdenkc6097192002-11-03 00:24:07 +00002792
wdenk6c59edc2004-05-03 20:45:30 +00002793Linux Support:
2794==============
wdenkc6097192002-11-03 00:24:07 +00002795
wdenk6c59edc2004-05-03 20:45:30 +00002796Although U-Boot should support any OS or standalone application
2797easily, the main focus has always been on Linux during the design of
2798U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002799
wdenk6c59edc2004-05-03 20:45:30 +00002800U-Boot includes many features that so far have been part of some
2801special "boot loader" code within the Linux kernel. Also, any
2802"initrd" images to be used are no longer part of one big Linux image;
2803instead, kernel and "initrd" are separate images. This implementation
2804serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002805
wdenk6c59edc2004-05-03 20:45:30 +00002806- the same features can be used for other OS or standalone
2807 applications (for instance: using compressed images to reduce the
2808 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002809
wdenk6c59edc2004-05-03 20:45:30 +00002810- it becomes much easier to port new Linux kernel versions because
2811 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002812
wdenk6c59edc2004-05-03 20:45:30 +00002813- the same Linux kernel image can now be used with different "initrd"
2814 images; of course this also means that different kernel images can
2815 be run with the same "initrd". This makes testing easier (you don't
2816 have to build a new "zImage.initrd" Linux image when you just
2817 change a file in your "initrd"). Also, a field-upgrade of the
2818 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002819
wdenkc6097192002-11-03 00:24:07 +00002820
wdenk6c59edc2004-05-03 20:45:30 +00002821Linux HOWTO:
2822============
wdenkc6097192002-11-03 00:24:07 +00002823
wdenk6c59edc2004-05-03 20:45:30 +00002824Porting Linux to U-Boot based systems:
2825---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk6c59edc2004-05-03 20:45:30 +00002827U-Boot cannot save you from doing all the necessary modifications to
2828configure the Linux device drivers for use with your target hardware
2829(no, we don't intend to provide a full virtual machine interface to
2830Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002831
Stefan Roese88fbf932010-04-15 16:07:28 +02002832But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002833
wdenk6c59edc2004-05-03 20:45:30 +00002834Just make sure your machine specific header file (for instance
2835include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02002836Information structure as we define in include/asm-<arch>/u-boot.h,
2837and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002838as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002839
Simon Glassd097e592014-06-11 23:29:46 -06002840Note that U-Boot now has a driver model, a unified model for drivers.
2841If you are adding a new driver, plumb it into driver model. If there
2842is no uclass available, you are encouraged to create one. See
2843doc/driver-model.
2844
wdenkc6097192002-11-03 00:24:07 +00002845
wdenk6c59edc2004-05-03 20:45:30 +00002846Configuring the Linux kernel:
2847-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002848
wdenk6c59edc2004-05-03 20:45:30 +00002849No specific requirements for U-Boot. Make sure you have some root
2850device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002851
wdenkc6097192002-11-03 00:24:07 +00002852
wdenk6c59edc2004-05-03 20:45:30 +00002853Building a Linux Image:
2854-----------------------
wdenkc6097192002-11-03 00:24:07 +00002855
wdenk6c59edc2004-05-03 20:45:30 +00002856With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2857not used. If you use recent kernel source, a new build target
2858"uImage" will exist which automatically builds an image usable by
2859U-Boot. Most older kernels also have support for a "pImage" target,
2860which was introduced for our predecessor project PPCBoot and uses a
2861100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002862
wdenk6c59edc2004-05-03 20:45:30 +00002863Example:
wdenkc6097192002-11-03 00:24:07 +00002864
Holger Freyther7ba4e572014-08-04 09:26:05 +02002865 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002866 make oldconfig
2867 make dep
2868 make uImage
wdenkc6097192002-11-03 00:24:07 +00002869
wdenk6c59edc2004-05-03 20:45:30 +00002870The "uImage" build target uses a special tool (in 'tools/mkimage') to
2871encapsulate a compressed Linux kernel image with header information,
2872CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002873
wdenk6c59edc2004-05-03 20:45:30 +00002874* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002875
wdenk6c59edc2004-05-03 20:45:30 +00002876* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002877
wdenk6c59edc2004-05-03 20:45:30 +00002878 ${CROSS_COMPILE}-objcopy -O binary \
2879 -R .note -R .comment \
2880 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00002881
wdenk6c59edc2004-05-03 20:45:30 +00002882* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00002883
wdenk6c59edc2004-05-03 20:45:30 +00002884 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00002885
wdenk6c59edc2004-05-03 20:45:30 +00002886* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002887
wdenk6c59edc2004-05-03 20:45:30 +00002888 mkimage -A ppc -O linux -T kernel -C gzip \
2889 -a 0 -e 0 -n "Linux Kernel Image" \
2890 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00002891
wdenkc6097192002-11-03 00:24:07 +00002892
wdenk6c59edc2004-05-03 20:45:30 +00002893The "mkimage" tool can also be used to create ramdisk images for use
2894with U-Boot, either separated from the Linux kernel image, or
2895combined into one file. "mkimage" encapsulates the images with a 64
2896byte header containing information about target architecture,
2897operating system, image type, compression method, entry points, time
2898stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00002899
wdenk6c59edc2004-05-03 20:45:30 +00002900"mkimage" can be called in two ways: to verify existing images and
2901print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002902
wdenk6c59edc2004-05-03 20:45:30 +00002903In the first form (with "-l" option) mkimage lists the information
2904contained in the header of an existing U-Boot image; this includes
2905checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002906
wdenk6c59edc2004-05-03 20:45:30 +00002907 tools/mkimage -l image
2908 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002909
wdenk6c59edc2004-05-03 20:45:30 +00002910The second form (with "-d" option) is used to build a U-Boot image
2911from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002912
wdenk6c59edc2004-05-03 20:45:30 +00002913 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2914 -n name -d data_file image
2915 -A ==> set architecture to 'arch'
2916 -O ==> set operating system to 'os'
2917 -T ==> set image type to 'type'
2918 -C ==> set compression type 'comp'
2919 -a ==> set load address to 'addr' (hex)
2920 -e ==> set entry point to 'ep' (hex)
2921 -n ==> set image name to 'name'
2922 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002923
wdenkcd914452004-05-29 16:53:29 +00002924Right now, all Linux kernels for PowerPC systems use the same load
2925address (0x00000000), but the entry point address depends on the
2926kernel version:
wdenkc6097192002-11-03 00:24:07 +00002927
wdenk6c59edc2004-05-03 20:45:30 +00002928- 2.2.x kernels have the entry point at 0x0000000C,
2929- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002930
wdenk6c59edc2004-05-03 20:45:30 +00002931So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002932
wdenk6c59edc2004-05-03 20:45:30 +00002933 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2934 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02002935 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00002936 > examples/uImage.TQM850L
2937 Image Name: 2.4.4 kernel for TQM850L
2938 Created: Wed Jul 19 02:34:59 2000
2939 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2940 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2941 Load Address: 0x00000000
2942 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002943
wdenk6c59edc2004-05-03 20:45:30 +00002944To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002945
wdenk6c59edc2004-05-03 20:45:30 +00002946 -> tools/mkimage -l examples/uImage.TQM850L
2947 Image Name: 2.4.4 kernel for TQM850L
2948 Created: Wed Jul 19 02:34:59 2000
2949 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2950 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2951 Load Address: 0x00000000
2952 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002953
wdenk6c59edc2004-05-03 20:45:30 +00002954NOTE: for embedded systems where boot time is critical you can trade
2955speed for memory and install an UNCOMPRESSED image instead: this
2956needs more space in Flash, but boots much faster since it does not
2957need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002958
Stefan Roese88fbf932010-04-15 16:07:28 +02002959 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00002960 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2961 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02002962 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00002963 > examples/uImage.TQM850L-uncompressed
2964 Image Name: 2.4.4 kernel for TQM850L
2965 Created: Wed Jul 19 02:34:59 2000
2966 Image Type: PowerPC Linux Kernel Image (uncompressed)
2967 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2968 Load Address: 0x00000000
2969 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002970
wdenkc6097192002-11-03 00:24:07 +00002971
wdenk6c59edc2004-05-03 20:45:30 +00002972Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2973when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00002974
wdenk6c59edc2004-05-03 20:45:30 +00002975 -> tools/mkimage -n 'Simple Ramdisk Image' \
2976 > -A ppc -O linux -T ramdisk -C gzip \
2977 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2978 Image Name: Simple Ramdisk Image
2979 Created: Wed Jan 12 14:01:50 2000
2980 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2981 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2982 Load Address: 0x00000000
2983 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002984
Tyler Hicks791c7472020-10-26 10:40:24 -05002985The "dumpimage" tool can be used to disassemble or list the contents of images
2986built by mkimage. See dumpimage's help output (-h) for details.
wdenkc6097192002-11-03 00:24:07 +00002987
wdenk6c59edc2004-05-03 20:45:30 +00002988Installing a Linux Image:
2989-------------------------
wdenkc6097192002-11-03 00:24:07 +00002990
wdenk6c59edc2004-05-03 20:45:30 +00002991To downloading a U-Boot image over the serial (console) interface,
2992you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00002993
wdenk6c59edc2004-05-03 20:45:30 +00002994 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00002995
wdenk6c59edc2004-05-03 20:45:30 +00002996The 'objcopy' does not understand the information in the U-Boot
2997image header, so the resulting S-Record file will be relative to
2998address 0x00000000. To load it to a given address, you need to
2999specify the target address as 'offset' parameter with the 'loads'
3000command.
wdenkc6097192002-11-03 00:24:07 +00003001
wdenk6c59edc2004-05-03 20:45:30 +00003002Example: install the image to address 0x40100000 (which on the
3003TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003004
wdenk6c59edc2004-05-03 20:45:30 +00003005 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003006
wdenk6c59edc2004-05-03 20:45:30 +00003007 .......... done
3008 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003009
wdenk6c59edc2004-05-03 20:45:30 +00003010 => loads 40100000
3011 ## Ready for S-Record download ...
3012 ~>examples/image.srec
3013 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3014 ...
3015 15989 15990 15991 15992
3016 [file transfer complete]
3017 [connected]
3018 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003019
wdenkc6097192002-11-03 00:24:07 +00003020
wdenk6c59edc2004-05-03 20:45:30 +00003021You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003022this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003023corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003024
wdenk6c59edc2004-05-03 20:45:30 +00003025 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003026
wdenk6c59edc2004-05-03 20:45:30 +00003027 ## Checking Image at 40100000 ...
3028 Image Name: 2.2.13 for initrd on TQM850L
3029 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3030 Data Size: 335725 Bytes = 327 kB = 0 MB
3031 Load Address: 00000000
3032 Entry Point: 0000000c
3033 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003034
3035
wdenk6c59edc2004-05-03 20:45:30 +00003036Boot Linux:
3037-----------
wdenkc6097192002-11-03 00:24:07 +00003038
wdenk6c59edc2004-05-03 20:45:30 +00003039The "bootm" command is used to boot an application that is stored in
3040memory (RAM or Flash). In case of a Linux kernel image, the contents
3041of the "bootargs" environment variable is passed to the kernel as
3042parameters. You can check and modify this variable using the
3043"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003044
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk6c59edc2004-05-03 20:45:30 +00003046 => printenv bootargs
3047 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003048
wdenk6c59edc2004-05-03 20:45:30 +00003049 => 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 +00003050
wdenk6c59edc2004-05-03 20:45:30 +00003051 => printenv bootargs
3052 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 +00003053
wdenk6c59edc2004-05-03 20:45:30 +00003054 => bootm 40020000
3055 ## Booting Linux kernel at 40020000 ...
3056 Image Name: 2.2.13 for NFS on TQM850L
3057 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3058 Data Size: 381681 Bytes = 372 kB = 0 MB
3059 Load Address: 00000000
3060 Entry Point: 0000000c
3061 Verifying Checksum ... OK
3062 Uncompressing Kernel Image ... OK
3063 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
3064 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3065 time_init: decrementer frequency = 187500000/60
3066 Calibrating delay loop... 49.77 BogoMIPS
3067 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3068 ...
wdenkc6097192002-11-03 00:24:07 +00003069
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003070If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003071the memory addresses of both the kernel and the initrd image (PPBCOOT
3072format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003073
wdenk6c59edc2004-05-03 20:45:30 +00003074 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003075
wdenk6c59edc2004-05-03 20:45:30 +00003076 ## Checking Image at 40100000 ...
3077 Image Name: 2.2.13 for initrd on TQM850L
3078 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3079 Data Size: 335725 Bytes = 327 kB = 0 MB
3080 Load Address: 00000000
3081 Entry Point: 0000000c
3082 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003083
wdenk6c59edc2004-05-03 20:45:30 +00003084 ## Checking Image at 40200000 ...
3085 Image Name: Simple Ramdisk Image
3086 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3087 Data Size: 566530 Bytes = 553 kB = 0 MB
3088 Load Address: 00000000
3089 Entry Point: 00000000
3090 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003091
wdenk6c59edc2004-05-03 20:45:30 +00003092 => bootm 40100000 40200000
3093 ## Booting Linux kernel at 40100000 ...
3094 Image Name: 2.2.13 for initrd on TQM850L
3095 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3096 Data Size: 335725 Bytes = 327 kB = 0 MB
3097 Load Address: 00000000
3098 Entry Point: 0000000c
3099 Verifying Checksum ... OK
3100 Uncompressing Kernel Image ... OK
3101 ## Loading RAMDisk Image at 40200000 ...
3102 Image Name: Simple Ramdisk Image
3103 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3104 Data Size: 566530 Bytes = 553 kB = 0 MB
3105 Load Address: 00000000
3106 Entry Point: 00000000
3107 Verifying Checksum ... OK
3108 Loading Ramdisk ... OK
3109 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
3110 Boot arguments: root=/dev/ram
3111 time_init: decrementer frequency = 187500000/60
3112 Calibrating delay loop... 49.77 BogoMIPS
3113 ...
3114 RAMDISK: Compressed image found at block 0
3115 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003116
wdenk6c59edc2004-05-03 20:45:30 +00003117 bash#
wdenkc6097192002-11-03 00:24:07 +00003118
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003119Boot Linux and pass a flat device tree:
3120-----------
3121
3122First, U-Boot must be compiled with the appropriate defines. See the section
3123titled "Linux Kernel Interface" above for a more in depth explanation. The
3124following is an example of how to start a kernel and pass an updated
3125flat device tree:
3126
3127=> print oftaddr
3128oftaddr=0x300000
3129=> print oft
3130oft=oftrees/mpc8540ads.dtb
3131=> tftp $oftaddr $oft
3132Speed: 1000, full duplex
3133Using TSEC0 device
3134TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3135Filename 'oftrees/mpc8540ads.dtb'.
3136Load address: 0x300000
3137Loading: #
3138done
3139Bytes transferred = 4106 (100a hex)
3140=> tftp $loadaddr $bootfile
3141Speed: 1000, full duplex
3142Using TSEC0 device
3143TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3144Filename 'uImage'.
3145Load address: 0x200000
3146Loading:############
3147done
3148Bytes transferred = 1029407 (fb51f hex)
3149=> print loadaddr
3150loadaddr=200000
3151=> print oftaddr
3152oftaddr=0x300000
3153=> bootm $loadaddr - $oftaddr
3154## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003155 Image Name: Linux-2.6.17-dirty
3156 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3157 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003158 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003159 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003160 Verifying Checksum ... OK
3161 Uncompressing Kernel Image ... OK
3162Booting using flat device tree at 0x300000
3163Using MPC85xx ADS machine description
3164Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3165[snip]
3166
3167
wdenk6c59edc2004-05-03 20:45:30 +00003168More About U-Boot Image Types:
3169------------------------------
wdenkc6097192002-11-03 00:24:07 +00003170
wdenk6c59edc2004-05-03 20:45:30 +00003171U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003172
wdenk6c59edc2004-05-03 20:45:30 +00003173 "Standalone Programs" are directly runnable in the environment
3174 provided by U-Boot; it is expected that (if they behave
3175 well) you can continue to work in U-Boot after return from
3176 the Standalone Program.
3177 "OS Kernel Images" are usually images of some Embedded OS which
3178 will take over control completely. Usually these programs
3179 will install their own set of exception handlers, device
3180 drivers, set up the MMU, etc. - this means, that you cannot
3181 expect to re-enter U-Boot except by resetting the CPU.
3182 "RAMDisk Images" are more or less just data blocks, and their
3183 parameters (address, size) are passed to an OS kernel that is
3184 being started.
3185 "Multi-File Images" contain several images, typically an OS
3186 (Linux) kernel image and one or more data images like
3187 RAMDisks. This construct is useful for instance when you want
3188 to boot over the network using BOOTP etc., where the boot
3189 server provides just a single image file, but you want to get
3190 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003191
wdenk6c59edc2004-05-03 20:45:30 +00003192 "Multi-File Images" start with a list of image sizes, each
3193 image size (in bytes) specified by an "uint32_t" in network
3194 byte order. This list is terminated by an "(uint32_t)0".
3195 Immediately after the terminating 0 follow the images, one by
3196 one, all aligned on "uint32_t" boundaries (size rounded up to
3197 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003198
wdenk6c59edc2004-05-03 20:45:30 +00003199 "Firmware Images" are binary images containing firmware (like
3200 U-Boot or FPGA images) which usually will be programmed to
3201 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003202
wdenk6c59edc2004-05-03 20:45:30 +00003203 "Script files" are command sequences that will be executed by
3204 U-Boot's command interpreter; this feature is especially
3205 useful when you configure U-Boot to use a real shell (hush)
3206 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003207
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003208Booting the Linux zImage:
3209-------------------------
3210
3211On some platforms, it's possible to boot Linux zImage. This is done
3212using the "bootz" command. The syntax of "bootz" command is the same
3213as the syntax of "bootm" command.
3214
Tom Rini45f46d12013-05-16 11:40:11 -04003215Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00003216kernel with raw initrd images. The syntax is slightly different, the
3217address of the initrd must be augmented by it's size, in the following
3218format: "<initrd addres>:<initrd size>".
3219
stroeseb9c17c52003-04-04 15:53:41 +00003220
wdenk6c59edc2004-05-03 20:45:30 +00003221Standalone HOWTO:
3222=================
stroeseb9c17c52003-04-04 15:53:41 +00003223
wdenk6c59edc2004-05-03 20:45:30 +00003224One of the features of U-Boot is that you can dynamically load and
3225run "standalone" applications, which can use some resources of
3226U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003227
wdenk6c59edc2004-05-03 20:45:30 +00003228Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003229
wdenk6c59edc2004-05-03 20:45:30 +00003230"Hello World" Demo:
3231-------------------
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk6c59edc2004-05-03 20:45:30 +00003233'examples/hello_world.c' contains a small "Hello World" Demo
3234application; it is automatically compiled when you build U-Boot.
3235It's configured to run at address 0x00040004, so you can play with it
3236like that:
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk6c59edc2004-05-03 20:45:30 +00003238 => loads
3239 ## Ready for S-Record download ...
3240 ~>examples/hello_world.srec
3241 1 2 3 4 5 6 7 8 9 10 11 ...
3242 [file transfer complete]
3243 [connected]
3244 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003245
wdenk6c59edc2004-05-03 20:45:30 +00003246 => go 40004 Hello World! This is a test.
3247 ## Starting application at 0x00040004 ...
3248 Hello World
3249 argc = 7
3250 argv[0] = "40004"
3251 argv[1] = "Hello"
3252 argv[2] = "World!"
3253 argv[3] = "This"
3254 argv[4] = "is"
3255 argv[5] = "a"
3256 argv[6] = "test."
3257 argv[7] = "<NULL>"
3258 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003259
wdenk6c59edc2004-05-03 20:45:30 +00003260 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk6c59edc2004-05-03 20:45:30 +00003262Another example, which demonstrates how to register a CPM interrupt
3263handler with the U-Boot code, can be found in 'examples/timer.c'.
3264Here, a CPM timer is set up to generate an interrupt every second.
3265The interrupt service routine is trivial, just printing a '.'
3266character, but this is just a demo program. The application can be
3267controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003268
wdenk6c59edc2004-05-03 20:45:30 +00003269 ? - print current values og the CPM Timer registers
3270 b - enable interrupts and start timer
3271 e - stop timer and disable interrupts
3272 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003273
wdenk6c59edc2004-05-03 20:45:30 +00003274 => loads
3275 ## Ready for S-Record download ...
3276 ~>examples/timer.srec
3277 1 2 3 4 5 6 7 8 9 10 11 ...
3278 [file transfer complete]
3279 [connected]
3280 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk6c59edc2004-05-03 20:45:30 +00003282 => go 40004
3283 ## Starting application at 0x00040004 ...
3284 TIMERS=0xfff00980
3285 Using timer 1
3286 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003287
wdenk6c59edc2004-05-03 20:45:30 +00003288Hit 'b':
3289 [q, b, e, ?] Set interval 1000000 us
3290 Enabling timer
3291Hit '?':
3292 [q, b, e, ?] ........
3293 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3294Hit '?':
3295 [q, b, e, ?] .
3296 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3297Hit '?':
3298 [q, b, e, ?] .
3299 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3300Hit '?':
3301 [q, b, e, ?] .
3302 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3303Hit 'e':
3304 [q, b, e, ?] ...Stopping timer
3305Hit 'q':
3306 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003307
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk6c59edc2004-05-03 20:45:30 +00003309Minicom warning:
3310================
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk6c59edc2004-05-03 20:45:30 +00003312Over time, many people have reported problems when trying to use the
3313"minicom" terminal emulation program for serial download. I (wd)
3314consider minicom to be broken, and recommend not to use it. Under
3315Unix, I recommend to use C-Kermit for general purpose use (and
3316especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00003317use "cu" for S-Record download ("loads" command). See
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003318https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
Karl O. Pinca0189bb2012-10-01 05:11:56 +00003319for help with kermit.
3320
wdenkc6097192002-11-03 00:24:07 +00003321
wdenk6c59edc2004-05-03 20:45:30 +00003322Nevertheless, if you absolutely want to use it try adding this
3323configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003324
wdenk6c59edc2004-05-03 20:45:30 +00003325 Name Program Name U/D FullScr IO-Red. Multi
3326 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3327 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003328
wdenk8dba0502003-03-31 16:34:49 +00003329
wdenk6c59edc2004-05-03 20:45:30 +00003330NetBSD Notes:
3331=============
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk6c59edc2004-05-03 20:45:30 +00003333Starting at version 0.9.2, U-Boot supports NetBSD both as host
3334(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003335
wdenk6c59edc2004-05-03 20:45:30 +00003336Building requires a cross environment; it is known to work on
3337NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3338need gmake since the Makefiles are not compatible with BSD make).
3339Note that the cross-powerpc package does not install include files;
3340attempting to build U-Boot will fail because <machine/ansi.h> is
3341missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003342
wdenk6c59edc2004-05-03 20:45:30 +00003343 # cd /usr/pkg/cross/powerpc-netbsd/include
3344 # mkdir powerpc
3345 # ln -s powerpc machine
3346 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3347 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003348
wdenk6c59edc2004-05-03 20:45:30 +00003349Native builds *don't* work due to incompatibilities between native
3350and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003351
wdenk6c59edc2004-05-03 20:45:30 +00003352Booting assumes that (the first part of) the image booted is a
3353stage-2 loader which in turn loads and then invokes the kernel
3354proper. Loader sources will eventually appear in the NetBSD source
3355tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003356meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003357
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk6c59edc2004-05-03 20:45:30 +00003359Implementation Internals:
3360=========================
wdenkc6097192002-11-03 00:24:07 +00003361
wdenk6c59edc2004-05-03 20:45:30 +00003362The following is not intended to be a complete description of every
3363implementation detail. However, it should help to understand the
3364inner workings of U-Boot and make it easier to port it to custom
3365hardware.
wdenkc6097192002-11-03 00:24:07 +00003366
wdenkc6097192002-11-03 00:24:07 +00003367
wdenk6c59edc2004-05-03 20:45:30 +00003368Initial Stack, Global Data:
3369---------------------------
wdenkc6097192002-11-03 00:24:07 +00003370
wdenk6c59edc2004-05-03 20:45:30 +00003371The implementation of U-Boot is complicated by the fact that U-Boot
3372starts running out of ROM (flash memory), usually without access to
3373system RAM (because the memory controller is not initialized yet).
3374This means that we don't have writable Data or BSS segments, and BSS
3375is not initialized as zero. To be able to get a C environment working
3376at all, we have to allocate at least a minimal stack. Implementation
3377options for this are defined and restricted by the CPU used: Some CPU
3378models provide on-chip memory (like the IMMR area on MPC8xx and
3379MPC826x processors), on others (parts of) the data cache can be
3380locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003381
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003382 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003383 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00003384
wdenk6c59edc2004-05-03 20:45:30 +00003385 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3386 From: "Chris Hallinan" <clh@net1plus.com>
3387 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3388 ...
wdenkc6097192002-11-03 00:24:07 +00003389
wdenk6c59edc2004-05-03 20:45:30 +00003390 Correct me if I'm wrong, folks, but the way I understand it
3391 is this: Using DCACHE as initial RAM for Stack, etc, does not
3392 require any physical RAM backing up the cache. The cleverness
3393 is that the cache is being used as a temporary supply of
3394 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003395 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00003396 can see how this works by studying the cache architecture and
3397 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003398
wdenk6c59edc2004-05-03 20:45:30 +00003399 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3400 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003401 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00003402 option should work for you. Using CS 4 should be fine if your
3403 board designers haven't used it for something that would
3404 cause you grief during the initial boot! It is frequently not
3405 used.
wdenkc6097192002-11-03 00:24:07 +00003406
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003407 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00003408 with your processor/board/system design. The default value
3409 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003410 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003411 than your SDRAM module. If you have a 64MB SDRAM module, set
3412 it above 400_0000. Just make sure your board has no resources
3413 that are supposed to respond to that address! That code in
3414 start.S has been around a while and should work as is when
3415 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003416
wdenk6c59edc2004-05-03 20:45:30 +00003417 -Chris Hallinan
3418 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003419
wdenk6c59edc2004-05-03 20:45:30 +00003420It is essential to remember this, since it has some impact on the C
3421code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003422
wdenk6c59edc2004-05-03 20:45:30 +00003423* Initialized global data (data segment) is read-only. Do not attempt
3424 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003425
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003426* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00003427 as zero data - BSS segment) at all - this is undefined, initiali-
3428 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003429
wdenk6c59edc2004-05-03 20:45:30 +00003430* Stack space is very limited. Avoid big data buffers or things like
3431 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003432
wdenk6c59edc2004-05-03 20:45:30 +00003433Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003434normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00003435turned out that the implementation of U-Boot can be greatly
3436simplified by making a global data structure (gd_t) available to all
3437functions. We could pass a pointer to this data as argument to _all_
3438functions, but this would bloat the code. Instead we use a feature of
3439the GCC compiler (Global Register Variables) to share the data: we
3440place a pointer (gd) to the global data into a register which we
3441reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003442
wdenk6c59edc2004-05-03 20:45:30 +00003443When choosing a register for such a purpose we are restricted by the
3444relevant (E)ABI specifications for the current architecture, and by
3445GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk6c59edc2004-05-03 20:45:30 +00003447For PowerPC, the following registers have specific use:
3448 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01003449 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00003450 R3-R4: parameter passing and return values
3451 R5-R10: parameter passing
3452 R13: small data area pointer
3453 R30: GOT pointer
3454 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003455
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01003456 (U-Boot also uses R12 as internal GOT pointer. r12
3457 is a volatile register so r12 needs to be reset when
3458 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00003459
Wolfgang Denk69c09642008-02-14 22:43:22 +01003460 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003461
wdenk6c59edc2004-05-03 20:45:30 +00003462 Note: on PPC, we could use a static initializer (since the
3463 address of the global data structure is known at compile time),
3464 but it turned out that reserving a register results in somewhat
3465 smaller code - although the code savings are not that big (on
3466 average for all boards 752 bytes for the whole U-Boot image,
3467 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003468
wdenk6c59edc2004-05-03 20:45:30 +00003469On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003470
wdenk6c59edc2004-05-03 20:45:30 +00003471 R0: function argument word/integer result
3472 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02003473 R9: platform specific
3474 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00003475 R11: argument (frame) pointer
3476 R12: temporary workspace
3477 R13: stack pointer
3478 R14: link register
3479 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003480
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02003481 ==> U-Boot will use R9 to hold a pointer to the global data
3482
3483 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00003484
Thomas Chou8fa38582010-05-21 11:08:03 +08003485On Nios II, the ABI is documented here:
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003486 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
Thomas Chou8fa38582010-05-21 11:08:03 +08003487
3488 ==> U-Boot will use gp to hold a pointer to the global data
3489
3490 Note: on Nios II, we give "-G0" option to gcc and don't use gp
3491 to access small data sections, so gp is free.
3492
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003493On NDS32, the following registers are used:
3494
3495 R0-R1: argument/return
3496 R2-R5: argument
3497 R15: temporary register for assembler
3498 R16: trampoline register
3499 R28: frame pointer (FP)
3500 R29: global pointer (GP)
3501 R30: link register (LP)
3502 R31: stack pointer (SP)
3503 PC: program counter (PC)
3504
3505 ==> U-Boot will use R10 to hold a pointer to the global data
3506
Wolfgang Denk6405a152006-03-31 18:32:53 +02003507NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3508or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003509
Rick Chend7e6f922017-12-26 13:55:59 +08003510On RISC-V, the following registers are used:
3511
3512 x0: hard-wired zero (zero)
3513 x1: return address (ra)
3514 x2: stack pointer (sp)
3515 x3: global pointer (gp)
3516 x4: thread pointer (tp)
3517 x5: link register (t0)
3518 x8: frame pointer (fp)
3519 x10-x11: arguments/return values (a0-1)
3520 x12-x17: arguments (a2-7)
3521 x28-31: temporaries (t3-6)
3522 pc: program counter (pc)
3523
3524 ==> U-Boot will use gp to hold a pointer to the global data
3525
wdenk6c59edc2004-05-03 20:45:30 +00003526Memory Management:
3527------------------
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk6c59edc2004-05-03 20:45:30 +00003529U-Boot runs in system state and uses physical addresses, i.e. the
3530MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003531
wdenk6c59edc2004-05-03 20:45:30 +00003532The available memory is mapped to fixed addresses using the memory
3533controller. In this process, a contiguous block is formed for each
3534memory type (Flash, SDRAM, SRAM), even when it consists of several
3535physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk6c59edc2004-05-03 20:45:30 +00003537U-Boot is installed in the first 128 kB of the first Flash bank (on
3538TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3539booting and sizing and initializing DRAM, the code relocates itself
3540to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003541memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00003542configuration setting]. Below that, a structure with global Board
3543Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003544
wdenk6c59edc2004-05-03 20:45:30 +00003545Additionally, some exception handler code is copied to the low 8 kB
3546of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003547
wdenk6c59edc2004-05-03 20:45:30 +00003548So a typical memory configuration with 16 MB of DRAM could look like
3549this:
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk6c59edc2004-05-03 20:45:30 +00003551 0x0000 0000 Exception Vector code
3552 :
3553 0x0000 1FFF
3554 0x0000 2000 Free for Application Use
3555 :
3556 :
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk6c59edc2004-05-03 20:45:30 +00003558 :
3559 :
3560 0x00FB FF20 Monitor Stack (Growing downward)
3561 0x00FB FFAC Board Info Data and permanent copy of global data
3562 0x00FC 0000 Malloc Arena
3563 :
3564 0x00FD FFFF
3565 0x00FE 0000 RAM Copy of Monitor Code
3566 ... eventually: LCD or video framebuffer
3567 ... eventually: pRAM (Protected RAM - unchanged by reset)
3568 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003569
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk6c59edc2004-05-03 20:45:30 +00003571System Initialization:
3572----------------------
wdenkc6097192002-11-03 00:24:07 +00003573
wdenk6c59edc2004-05-03 20:45:30 +00003574In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003575(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003576configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00003577To be able to re-map memory U-Boot then jumps to its link address.
3578To be able to implement the initialization code in C, a (small!)
3579initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02003580which provide such a feature like), or in a locked part of the data
3581cache. After that, U-Boot initializes the CPU core, the caches and
3582the SIU.
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk6c59edc2004-05-03 20:45:30 +00003584Next, all (potentially) available memory banks are mapped using a
3585preliminary mapping. For example, we put them on 512 MB boundaries
3586(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3587on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3588programmed for SDRAM access. Using the temporary configuration, a
3589simple memory test is run that determines the size of the SDRAM
3590banks.
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk6c59edc2004-05-03 20:45:30 +00003592When there is more than one SDRAM bank, and the banks are of
3593different size, the largest is mapped first. For equal size, the first
3594bank (CS2#) is mapped first. The first mapping is always for address
35950x00000000, with any additional banks following immediately to create
3596contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003597
wdenk6c59edc2004-05-03 20:45:30 +00003598Then, the monitor installs itself at the upper end of the SDRAM area
3599and allocates memory for use by malloc() and for the global Board
3600Info data; also, the exception vector code is copied to the low RAM
3601pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk6c59edc2004-05-03 20:45:30 +00003603Only after this relocation will you have a "normal" C environment;
3604until that you are restricted in several ways, mostly because you are
3605running from ROM, and because the code will have to be relocated to a
3606new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003607
wdenkc6097192002-11-03 00:24:07 +00003608
wdenk6c59edc2004-05-03 20:45:30 +00003609U-Boot Porting Guide:
3610----------------------
wdenkc6097192002-11-03 00:24:07 +00003611
wdenk6c59edc2004-05-03 20:45:30 +00003612[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3613list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003614
wdenkc6097192002-11-03 00:24:07 +00003615
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003616int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00003617{
3618 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003619
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003620 signal(SIGALRM, no_more_time);
3621 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003622
wdenk6c59edc2004-05-03 20:45:30 +00003623 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003624 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00003625 return 0;
3626 }
wdenkc6097192002-11-03 00:24:07 +00003627
wdenk6c59edc2004-05-03 20:45:30 +00003628 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00003629
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003630 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00003631
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003632 if (clueless)
3633 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003634
wdenk6c59edc2004-05-03 20:45:30 +00003635 while (learning) {
3636 Read the README file in the top level directory;
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003637 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
Patrick Delaunay9b281fa2020-02-28 15:18:10 +01003638 Read applicable doc/README.*;
wdenk6c59edc2004-05-03 20:45:30 +00003639 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003640 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00003641 }
wdenkc6097192002-11-03 00:24:07 +00003642
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003643 if (available_money > toLocalCurrency ($2500))
3644 Buy a BDI3000;
3645 else
wdenk6c59edc2004-05-03 20:45:30 +00003646 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00003647
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003648 if (a similar board exists) { /* hopefully... */
3649 cp -a board/<similar> board/<myboard>
3650 cp include/configs/<similar>.h include/configs/<myboard>.h
3651 } else {
3652 Create your own board support subdirectory;
3653 Create your own board include/configs/<myboard>.h file;
3654 }
3655 Edit new board/<myboard> files
3656 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00003657
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003658 while (!accepted) {
3659 while (!running) {
3660 do {
3661 Add / modify source code;
3662 } until (compiles);
3663 Debug;
3664 if (clueless)
3665 email("Hi, I am having problems...");
3666 }
3667 Send patch file to the U-Boot email list;
3668 if (reasonable critiques)
3669 Incorporate improvements from email list code review;
3670 else
3671 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00003672 }
wdenkc6097192002-11-03 00:24:07 +00003673
wdenk6c59edc2004-05-03 20:45:30 +00003674 return 0;
3675}
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk6c59edc2004-05-03 20:45:30 +00003677void no_more_time (int sig)
3678{
3679 hire_a_guru();
3680}
wdenkc6097192002-11-03 00:24:07 +00003681
wdenkc6097192002-11-03 00:24:07 +00003682
wdenk6c59edc2004-05-03 20:45:30 +00003683Coding Standards:
3684-----------------
wdenkc6097192002-11-03 00:24:07 +00003685
wdenk6c59edc2004-05-03 20:45:30 +00003686All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02003687coding style; see the kernel coding style guide at
3688https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3689script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02003690
3691Source files originating from a different project (for example the
3692MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003693reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02003694sources.
wdenkc6097192002-11-03 00:24:07 +00003695
Detlev Zundelaa63d482006-09-01 15:39:02 +02003696Please note that U-Boot is implemented in C (and to some small parts in
3697Assembler); no C++ is used, so please do not use C++ style comments (//)
3698in your code.
wdenkad276f22004-01-04 16:28:35 +00003699
wdenk6c59edc2004-05-03 20:45:30 +00003700Please also stick to the following formatting rules:
3701- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003702- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00003703- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003704- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00003705- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk6c59edc2004-05-03 20:45:30 +00003707Submissions which do not conform to the standards may be returned
3708with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003709
wdenkc6097192002-11-03 00:24:07 +00003710
wdenk6c59edc2004-05-03 20:45:30 +00003711Submitting Patches:
3712-------------------
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk6c59edc2004-05-03 20:45:30 +00003714Since the number of patches for U-Boot is growing, we need to
3715establish some rules. Submissions which do not conform to these rules
3716may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003717
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003718Please see https://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003719
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003720Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08003721see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003722
wdenk6c59edc2004-05-03 20:45:30 +00003723When you send a patch, please include the following information with
3724it:
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk6c59edc2004-05-03 20:45:30 +00003726* For bug fixes: a description of the bug and how your patch fixes
3727 this bug. Please try to include a way of demonstrating that the
3728 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003729
wdenk6c59edc2004-05-03 20:45:30 +00003730* For new features: a description of the feature and your
3731 implementation.
wdenkc6097192002-11-03 00:24:07 +00003732
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05003733* For major contributions, add a MAINTAINERS file with your
3734 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00003735
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02003736* When you add support for a new board, don't forget to add a
3737 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk6c59edc2004-05-03 20:45:30 +00003739* If your patch adds new configuration options, don't forget to
3740 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00003741
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003742* The patch itself. If you are using git (which is *strongly*
3743 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003744 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003745 the U-Boot mailing list, you will avoid most of the common problems
3746 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00003747
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003748 If you cannot use git, use "diff -purN OLD NEW". If your version of
3749 diff does not support these options, then get the latest version of
3750 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00003751
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003752 The current directory when running this command shall be the parent
3753 directory of the U-Boot source tree (i. e. please make sure that
3754 your patch includes sufficient directory information for the
3755 affected files).
3756
3757 We prefer patches as plain text. MIME attachments are discouraged,
3758 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00003759
wdenk6c59edc2004-05-03 20:45:30 +00003760* If one logical set of modifications affects or creates several
3761 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00003762
wdenk6c59edc2004-05-03 20:45:30 +00003763* Changesets that contain different, unrelated modifications shall be
3764 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00003765
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk6c59edc2004-05-03 20:45:30 +00003767Notes:
wdenkc6097192002-11-03 00:24:07 +00003768
Simon Glassdc27def2016-07-27 20:33:08 -06003769* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00003770 source tree and make sure that no errors or warnings are reported
3771 for any of the boards.
3772
3773* Keep your modifications to the necessary minimum: A patch
3774 containing several unrelated changes or arbitrary reformats will be
3775 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00003776
wdenk6c59edc2004-05-03 20:45:30 +00003777* If you modify existing code, make sure that your new code does not
3778 add to the memory footprint of the code ;-) Small is beautiful!
3779 When adding new features, these should compile conditionally only
3780 (using #ifdef), and the resulting code with the new feature
3781 disabled must not need more memory than the old code without your
3782 modification.
wdenkcbc49a52005-05-03 14:12:25 +00003783
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003784* Remember that there is a size limit of 100 kB per message on the
3785 u-boot mailing list. Bigger patches will be moderated. If they are
3786 reasonable and not too big, they will be acknowledged. But patches
3787 bigger than the size limit should be avoided.