blob: fca495bcf598f9d53183ecb640f95b33bd1374f1 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denkeca3aeb2013-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
wdenke86e5a02004-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. Day7207b362015-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. Day7207b362015-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. Dayadb9d852012-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. Day7207b362015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
Naoki Hayama6681bbb2020-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 Denk218ca722008-03-26 10:40:12 +010057Where to get source code:
58=========================
59
Robert P. J. Day7207b362015-12-19 07:16:10 -050060The U-Boot source code is maintained in the Git repository at
Heinrich Schuchardta3bbd0b2021-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 Denk218ca722008-03-26 10:40:12 +010063
Naoki Hayamac4bd51e2020-10-08 13:16:25 +090064The "Tags" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020065any version you might be interested in. Official releases are also
Naoki Hayamac4bd51e2020-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 Denk218ca722008-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 Hayama047f6ec2020-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 Glass9e5616d2019-08-01 09:47:14 -060083 * ATA disk / SCSI ... boot
Naoki Hayama047f6ec2020-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 Hayama047f6ec2020-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:
107
108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000110
111
wdenk93f19cc2002-12-17 17:55:09 +0000112Versioning:
113===========
114
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000121
Thomas Weber360d8832010-09-28 08:06:25 +0200122Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000123 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000126
127
wdenkc6097192002-11-03 00:24:07 +0000128Directory Hierarchy:
129====================
130
Simon Glass6e73ed02021-07-10 21:14:21 -0600131/arch Architecture-specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900132 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500133 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500134 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500135 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500136 /mips Files generic to MIPS architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500137 /nios2 Files generic to Altera NIOS2 architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200138 /powerpc Files generic to PowerPC architecture
Rick Chen3fafced2017-12-26 13:55:59 +0800139 /riscv Files generic to RISC-V architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500140 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400142 /x86 Files generic to x86 architecture
Naoki Hayamae4eb3132020-10-08 13:16:38 +0900143 /xtensa Files generic to Xtensa architecture
Simon Glass6e73ed02021-07-10 21:14:21 -0600144/api Machine/arch-independent API for external apps
145/board Board-dependent files
Simon Glass19a91f22021-10-14 12:47:54 -0600146/boot Support for images and booting
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800147/cmd U-Boot commands functions
Simon Glass6e73ed02021-07-10 21:14:21 -0600148/common Misc architecture-independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500149/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/disk Code for disk drive partition handling
Simon Glass6e73ed02021-07-10 21:14:21 -0600151/doc Documentation (a mix of ReST and READMEs)
152/drivers Device drivers
153/dts Makefile for building internal U-Boot fdt.
154/env Environment support
Peter Tyser8d321b82010-04-12 22:28:21 -0500155/examples Example code for standalone applications, etc.
156/fs Filesystem code (cramfs, ext2, jffs2, etc.)
157/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500158/lib Library routines generic to all architectures
159/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500160/net Networking code
161/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500162/scripts Various build scripts and Makefiles
163/test Various unit test files
Simon Glass6e73ed02021-07-10 21:14:21 -0600164/tools Tools to build and sign FIT images, etc.
wdenkc6097192002-11-03 00:24:07 +0000165
wdenkc6097192002-11-03 00:24:07 +0000166Software Configuration:
167=======================
168
169Configuration is usually done using C preprocessor defines; the
170rationale behind that is to avoid dead code whenever possible.
171
172There are two classes of configuration variables:
173
174* Configuration _OPTIONS_:
175 These are selectable by the user and have names beginning with
176 "CONFIG_".
177
178* Configuration _SETTINGS_:
179 These depend on the hardware etc. and should not be meddled with if
180 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200181 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000182
Robert P. J. Day7207b362015-12-19 07:16:10 -0500183Previously, all configuration was done by hand, which involved creating
184symbolic links and editing configuration files manually. More recently,
185U-Boot has added the Kbuild infrastructure used by the Linux kernel,
186allowing you to use the "make menuconfig" command to configure your
187build.
wdenkc6097192002-11-03 00:24:07 +0000188
189
190Selection of Processor Architecture and Board Type:
191---------------------------------------------------
192
193For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200194configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000195
196Example: For a TQM823L module type:
197
198 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200199 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000200
Robert P. J. Day7207b362015-12-19 07:16:10 -0500201Note: If you're looking for the default configuration file for a board
202you're sure used to be there but is now missing, check the file
203doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000204
Simon Glass75b3c3a2014-03-22 17:12:59 -0600205Sandbox Environment:
206--------------------
207
208U-Boot can be built natively to run on a Linux host using the 'sandbox'
209board. This allows feature development which is not board- or architecture-
210specific to be undertaken on a native platform. The sandbox is also used to
211run some of U-Boot's tests.
212
Naoki Hayamabbb140e2020-10-08 13:16:58 +0900213See doc/arch/sandbox.rst for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600214
215
Simon Glassdb910352015-03-03 08:03:00 -0700216Board Initialisation Flow:
217--------------------------
218
219This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500220SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700221
Robert P. J. Day7207b362015-12-19 07:16:10 -0500222Note: "SPL" stands for "Secondary Program Loader," which is explained in
223more detail later in this file.
224
225At present, SPL mostly uses a separate code path, but the function names
226and roles of each function are the same. Some boards or architectures
227may not conform to this. At least most ARM boards which use
228CONFIG_SPL_FRAMEWORK conform to this.
229
230Execution typically starts with an architecture-specific (and possibly
231CPU-specific) start.S file, such as:
232
233 - arch/arm/cpu/armv7/start.S
234 - arch/powerpc/cpu/mpc83xx/start.S
235 - arch/mips/cpu/start.S
236
237and so on. From there, three functions are called; the purpose and
238limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700239
240lowlevel_init():
241 - purpose: essential init to permit execution to reach board_init_f()
242 - no global_data or BSS
243 - there is no stack (ARMv7 may have one but it will soon be removed)
244 - must not set up SDRAM or use console
245 - must only do the bare minimum to allow execution to continue to
246 board_init_f()
247 - this is almost never needed
248 - return normally from this function
249
250board_init_f():
251 - purpose: set up the machine ready for running board_init_r():
252 i.e. SDRAM and serial UART
253 - global_data is available
254 - stack is in SRAM
255 - BSS is not available, so you cannot use global/static variables,
256 only stack variables and global_data
257
258 Non-SPL-specific notes:
259 - dram_init() is called to set up DRAM. If already done in SPL this
260 can do nothing
261
262 SPL-specific notes:
263 - you can override the entire board_init_f() function with your own
264 version as needed.
265 - preloader_console_init() can be called here in extremis
266 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayama499696e2020-09-24 15:57:19 +0900267 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg14254652019-08-08 12:54:49 -0500268 - for specific scenarios on certain architectures an early BSS *can*
269 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
270 of BSS prior to entering board_init_f()) but doing so is discouraged.
271 Instead it is strongly recommended to architect any code changes
272 or additions such to not depend on the availability of BSS during
273 board_init_f() as indicated in other sections of this README to
274 maintain compatibility and consistency across the entire code base.
Simon Glassdb910352015-03-03 08:03:00 -0700275 - must return normally from this function (don't call board_init_r()
276 directly)
277
278Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
279this point the stack and global_data are relocated to below
280CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
281memory.
282
283board_init_r():
284 - purpose: main execution, common code
285 - global_data is available
286 - SDRAM is available
287 - BSS is available, all static/global variables can be used
288 - execution eventually continues to main_loop()
289
290 Non-SPL-specific notes:
291 - U-Boot is relocated to the top of memory and is now running from
292 there.
293
294 SPL-specific notes:
295 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
Ashish Kumar63b23162017-08-11 11:09:14 +0530296 CONFIG_SYS_FSL_HAS_CCI400
297
298 Defined For SoC that has cache coherent interconnect
299 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000300
Ashish Kumarc055cee2017-08-18 10:54:36 +0530301 CONFIG_SYS_FSL_HAS_CCN504
302
303 Defined for SoC that has cache coherent interconnect CCN-504
304
wdenkc6097192002-11-03 00:24:07 +0000305The following options need to be configured:
306
Kim Phillips26281142007-08-10 13:28:25 -0500307- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000308
Kim Phillips26281142007-08-10 13:28:25 -0500309- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200310
Kumar Gala66412c62011-02-18 05:40:54 -0600311- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000312 CONFIG_SYS_PPC64
313
314 Specifies that the core is a 64-bit PowerPC implementation (implements
315 the "64" category of the Power ISA). This is necessary for ePAPR
316 compliance, among other possible reasons.
317
Kumar Gala66412c62011-02-18 05:40:54 -0600318 CONFIG_SYS_FSL_TBCLK_DIV
319
320 Defines the core time base clock divider ratio compared to the
321 system clock. On most PQ3 devices this is 8, on newer QorIQ
322 devices it can be 16 or 32. The ratio varies from SoC to Soc.
323
Kumar Gala8f290842011-05-20 00:39:21 -0500324 CONFIG_SYS_FSL_PCIE_COMPAT
325
326 Defines the string to utilize when trying to match PCIe device
327 tree nodes for the given platform.
328
Scott Wood33eee332012-08-14 10:14:53 +0000329 CONFIG_SYS_FSL_ERRATUM_A004510
330
331 Enables a workaround for erratum A004510. If set,
332 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
333 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
334
335 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
336 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
337
338 Defines one or two SoC revisions (low 8 bits of SVR)
339 for which the A004510 workaround should be applied.
340
341 The rest of SVR is either not relevant to the decision
342 of whether the erratum is present (e.g. p2040 versus
343 p2041) or is implied by the build target, which controls
344 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
345
346 See Freescale App Note 4493 for more information about
347 this erratum.
348
349 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
350
351 This is the value to write into CCSR offset 0x18600
352 according to the A004510 workaround.
353
Priyanka Jain64501c62013-07-02 09:21:04 +0530354 CONFIG_SYS_FSL_DSP_DDR_ADDR
355 This value denotes start offset of DDR memory which is
356 connected exclusively to the DSP cores.
357
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530358 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
359 This value denotes start offset of M2 memory
360 which is directly connected to the DSP core.
361
Priyanka Jain64501c62013-07-02 09:21:04 +0530362 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
363 This value denotes start offset of M3 memory which is directly
364 connected to the DSP core.
365
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530366 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
367 This value denotes start offset of DSP CCSR space.
368
Priyanka Jainb1359912013-12-17 14:25:52 +0530369 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
370 Single Source Clock is clocking mode present in some of FSL SoC's.
371 In this mode, a single differential clock is used to supply
372 clocks to the sysclock, ddrclock and usbclock.
373
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530374 CONFIG_SYS_CPC_REINIT_F
375 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800376 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530377
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000378- Generic CPU options:
379 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
380
381 Defines the endianess of the CPU. Implementation of those
382 values is arch specific.
383
York Sun5614e712013-09-30 09:22:09 -0700384 CONFIG_SYS_FSL_DDR
385 Freescale DDR driver in use. This type of DDR controller is
Tom Rini1c588572021-05-14 21:34:26 -0400386 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
York Sun5614e712013-09-30 09:22:09 -0700387
388 CONFIG_SYS_FSL_DDR_ADDR
389 Freescale DDR memory-mapped register base.
390
391 CONFIG_SYS_FSL_DDR_EMU
392 Specify emulator support for DDR. Some DDR features such as
393 deskew training are not available.
394
395 CONFIG_SYS_FSL_DDRC_GEN1
396 Freescale DDR1 controller.
397
398 CONFIG_SYS_FSL_DDRC_GEN2
399 Freescale DDR2 controller.
400
401 CONFIG_SYS_FSL_DDRC_GEN3
402 Freescale DDR3 controller.
403
York Sun34e026f2014-03-27 17:54:47 -0700404 CONFIG_SYS_FSL_DDRC_GEN4
405 Freescale DDR4 controller.
406
York Sun9ac4ffb2013-09-30 14:20:51 -0700407 CONFIG_SYS_FSL_DDRC_ARM_GEN3
408 Freescale DDR3 controller for ARM-based SoCs.
409
York Sun5614e712013-09-30 09:22:09 -0700410 CONFIG_SYS_FSL_DDR1
411 Board config to use DDR1. It can be enabled for SoCs with
412 Freescale DDR1 or DDR2 controllers, depending on the board
413 implemetation.
414
415 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400416 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700417 Freescale DDR2 or DDR3 controllers, depending on the board
418 implementation.
419
420 CONFIG_SYS_FSL_DDR3
421 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700422 Freescale DDR3 or DDR3L controllers.
423
424 CONFIG_SYS_FSL_DDR3L
425 Board config to use DDR3L. It can be enabled for SoCs with
426 DDR3L controllers.
427
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530428 CONFIG_SYS_FSL_IFC_BE
429 Defines the IFC controller register space as Big Endian
430
431 CONFIG_SYS_FSL_IFC_LE
432 Defines the IFC controller register space as Little Endian
433
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530434 CONFIG_SYS_FSL_IFC_CLK_DIV
435 Defines divider of platform clock(clock input to IFC controller).
436
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530437 CONFIG_SYS_FSL_LBC_CLK_DIV
438 Defines divider of platform clock(clock input to eLBC controller).
439
York Sun4e5b1bd2014-02-10 13:59:42 -0800440 CONFIG_SYS_FSL_DDR_BE
441 Defines the DDR controller register space as Big Endian
442
443 CONFIG_SYS_FSL_DDR_LE
444 Defines the DDR controller register space as Little Endian
445
York Sun6b9e3092014-02-10 13:59:43 -0800446 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
447 Physical address from the view of DDR controllers. It is the
448 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
449 it could be different for ARM SoCs.
450
York Sun6b1e1252014-02-10 13:59:44 -0800451 CONFIG_SYS_FSL_DDR_INTLV_256B
452 DDR controller interleaving on 256-byte. This is a special
453 interleaving mode, handled by Dickens for Freescale layerscape
454 SoCs with ARM core.
455
York Sun1d71efb2014-08-01 15:51:00 -0700456 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
457 Number of controllers used as main memory.
458
459 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
460 Number of controllers used for other than main memory.
461
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530462 CONFIG_SYS_FSL_SEC_BE
463 Defines the SEC controller register space as Big Endian
464
465 CONFIG_SYS_FSL_SEC_LE
466 Defines the SEC controller register space as Little Endian
467
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200468- MIPS CPU options:
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200469 CONFIG_XWAY_SWAP_BYTES
470
471 Enable compilation of tools/xway-swap-bytes needed for Lantiq
472 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
473 be swapped if a flash programmer is used.
474
Christian Rieschb67d8812012-02-02 00:44:39 +0000475- ARM options:
476 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
477
478 Select high exception vectors of the ARM core, e.g., do not
479 clear the V bit of the c1 register of CP15.
480
York Sun207774b2015-03-20 19:28:08 -0700481 COUNTER_FREQUENCY
482 Generic timer clock source frequency.
483
484 COUNTER_FREQUENCY_REAL
485 Generic timer clock source frequency if the real clock is
486 different from COUNTER_FREQUENCY, and can only be determined
487 at run time.
488
Stephen Warren73c38932015-01-19 16:25:52 -0700489- Tegra SoC options:
490 CONFIG_TEGRA_SUPPORT_NON_SECURE
491
492 Support executing U-Boot in non-secure (NS) mode. Certain
493 impossible actions will be skipped if the CPU is in NS mode,
494 such as ARM architectural timer initialization.
495
wdenk5da627a2003-10-09 20:09:04 +0000496- Linux Kernel Interface:
wdenk5da627a2003-10-09 20:09:04 +0000497 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
498
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800499 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000500 expect it to be in bytes, others in MB.
501 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
502
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400503 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200504
505 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400506 passed using flattened device trees (based on open firmware
507 concepts).
508
509 CONFIG_OF_LIBFDT
510 * New libfdt-based support
511 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500512 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400513
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200514 OF_TBCLK - The timebase frequency.
515
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200516 boards with QUICC Engines require OF_QE to set UCC MAC
517 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500518
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200519 CONFIG_OF_IDE_FIXUP
520
521 U-Boot can detect if an IDE device is present or not.
522 If not, and this new config option is activated, U-Boot
523 removes the ATA node from the DTS before booting Linux,
524 so the Linux IDE driver does not probe the device and
525 crash. This is needed for buggy hardware (uc101) where
526 no pull down resistor is connected to the signal IDE5V_DD7.
527
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100528- vxWorks boot parameters:
529
530 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700531 environments variables: bootdev, bootfile, ipaddr, netmask,
532 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100533 It loads the vxWorks image pointed bootfile.
534
Naoki Hayama81a05d92020-10-08 13:17:08 +0900535 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100536 the defaults discussed just above.
537
Aneesh V93bc2192011-06-16 23:30:51 +0000538- Cache Configuration for ARM:
539 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
540 controller
541 CONFIG_SYS_PL310_BASE - Physical base address of PL310
542 controller register space
543
wdenk6705d812004-08-02 23:22:59 +0000544- Serial Ports:
wdenk6705d812004-08-02 23:22:59 +0000545 CONFIG_PL011_CLOCK
546
547 If you have Amba PrimeCell PL011 UARTs, set this variable to
548 the clock speed of the UARTs.
549
550 CONFIG_PL01x_PORTS
551
552 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
553 define this to a list of base addresses for each (supported)
554 port. See e.g. include/configs/versatile.h
555
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400556 CONFIG_SERIAL_HW_FLOW_CONTROL
557
558 Define this variable to enable hw flow control in serial driver.
559 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000560
wdenkc6097192002-11-03 00:24:07 +0000561- Serial Download Echo Mode:
562 CONFIG_LOADS_ECHO
563 If defined to 1, all characters received during a
564 serial download (using the "loads" command) are
565 echoed back. This might be needed by some terminal
566 emulations (like "cu"), but may as well just take
567 time on others. This setting #define's the initial
568 value of the "loads_echo" environment variable.
569
Simon Glass302a6482016-03-13 19:07:28 -0600570- Removal of commands
571 If no commands are needed to boot, you can disable
572 CONFIG_CMDLINE to remove them. In this case, the command line
573 will not be available, and when U-Boot wants to execute the
574 boot command (on start-up) it will call board_run_command()
575 instead. This can reduce image size significantly for very
576 simple boot procedures.
577
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000578- Regular expression support:
579 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200580 If this variable is defined, U-Boot is linked against
581 the SLRE (Super Light Regular Expression) library,
582 which adds regex support to some commands, as for
583 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000584
wdenkc6097192002-11-03 00:24:07 +0000585- Watchdog:
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200586 CONFIG_SYS_WATCHDOG_FREQ
587 Some platforms automatically call WATCHDOG_RESET()
588 from the timer interrupt handler every
589 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
590 board configuration file, a default of CONFIG_SYS_HZ/2
591 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
592 to 0 disables calling WATCHDOG_RESET() from the timer
593 interrupt.
594
wdenkc6097192002-11-03 00:24:07 +0000595- Real-Time Clock:
596
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500597 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000598 has to be selected, too. Define exactly one of the
599 following options:
600
wdenkc6097192002-11-03 00:24:07 +0000601 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000602 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000603 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000604 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000605 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000606 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200607 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000608 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100609 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000610 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200611 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200612 CONFIG_SYS_RV3029_TCR - enable trickle charger on
613 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000614
wdenkb37c7e52003-06-30 16:24:52 +0000615 Note that if the RTC uses I2C, then the I2C interface
616 must also be configured. See I2C Support, below.
617
Peter Tysere92739d2008-12-17 16:36:21 -0600618- GPIO Support:
619 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600620
Chris Packham5dec49c2010-12-19 10:12:13 +0000621 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
622 chip-ngpio pairs that tell the PCA953X driver the number of
623 pins supported by a particular chip.
624
Peter Tysere92739d2008-12-17 16:36:21 -0600625 Note that if the GPIO device uses I2C, then the I2C interface
626 must also be configured. See I2C Support, below.
627
Simon Glassaa532332014-06-11 23:29:41 -0600628- I/O tracing:
629 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
630 accesses and can checksum them or write a list of them out
631 to memory. See the 'iotrace' command for details. This is
632 useful for testing device drivers since it can confirm that
633 the driver behaves the same way before and after a code
634 change. Currently this is supported on sandbox and arm. To
635 add support for your architecture, add '#include <iotrace.h>'
636 to the bottom of arch/<arch>/include/asm/io.h and test.
637
638 Example output from the 'iotrace stats' command is below.
639 Note that if the trace buffer is exhausted, the checksum will
640 still continue to operate.
641
642 iotrace is enabled
643 Start: 10000000 (buffer start address)
644 Size: 00010000 (buffer size)
645 Offset: 00000120 (current buffer offset)
646 Output: 10000120 (start + offset)
647 Count: 00000018 (number of trace records)
648 CRC32: 9526fb66 (CRC32 of all trace records)
649
wdenkc6097192002-11-03 00:24:07 +0000650- Timestamp Support:
651
wdenk43d96162003-03-06 00:02:04 +0000652 When CONFIG_TIMESTAMP is selected, the timestamp
653 (date and time) of an image is printed by image
654 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000656
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000657- Partition Labels (disklabels) Supported:
658 Zero or more of the following:
659 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000660 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
661 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
662 bootloader. Note 2TB partition limit; see
663 disk/part_efi.c
Simon Glassc649e3c2016-05-01 11:36:02 -0600664 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000665 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000666
wdenkc6097192002-11-03 00:24:07 +0000667- NETWORK Support (PCI):
Kyle Moffettce5207e2011-10-18 11:05:29 +0000668 CONFIG_E1000_SPI
669 Utility code for direct access to the SPI bus on Intel 8257x.
670 This does not do anything useful unless you set at least one
671 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
672
wdenkc6097192002-11-03 00:24:07 +0000673 CONFIG_NATSEMI
674 Support for National dp83815 chips.
675
676 CONFIG_NS8382X
677 Support for National dp8382[01] gigabit chips.
678
wdenk45219c42003-05-12 21:50:16 +0000679- NETWORK Support (other):
Rob Herringefdd7312011-12-15 11:15:49 +0000680 CONFIG_CALXEDA_XGMAC
681 Support for the Calxeda XGMAC device
682
Ashok3bb46d22012-10-15 06:20:47 +0000683 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000684 Support for SMSC's LAN91C96 chips.
685
wdenk45219c42003-05-12 21:50:16 +0000686 CONFIG_LAN91C96_USE_32_BIT
687 Define this to enable 32 bit addressing
688
Ashok3bb46d22012-10-15 06:20:47 +0000689 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +0000690 Support for SMSC's LAN91C111 chip
691
692 CONFIG_SMC91111_BASE
693 Define this to hold the physical address
694 of the device (I/O space)
695
696 CONFIG_SMC_USE_32_BIT
697 Define this if data bus is 32 bits
698
699 CONFIG_SMC_USE_IOFUNCS
700 Define this to use i/o functions instead of macros
701 (some hardware wont work with macros)
702
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500703 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
704 Define this if you have more then 3 PHYs.
705
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800706 CONFIG_FTGMAC100
707 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
708
709 CONFIG_FTGMAC100_EGIGA
710 Define this to use GE link update with gigabit PHY.
711 Define this if FTGMAC100 is connected to gigabit PHY.
712 If your system has 10/100 PHY only, it might not occur
713 wrong behavior. Because PHY usually return timeout or
714 useless data when polling gigabit status and gigabit
715 control registers. This behavior won't affect the
716 correctnessof 10/100 link speed update.
717
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900718 CONFIG_SH_ETHER
719 Support for Renesas on-chip Ethernet controller
720
721 CONFIG_SH_ETHER_USE_PORT
722 Define the number of ports to be used
723
724 CONFIG_SH_ETHER_PHY_ADDR
725 Define the ETH PHY's address
726
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900727 CONFIG_SH_ETHER_CACHE_WRITEBACK
728 If this option is set, the driver enables cache flush.
729
Vadim Bendebury5e124722011-10-17 08:36:14 +0000730- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000731 CONFIG_TPM
732 Support TPM devices.
733
Christophe Ricard0766ad22015-10-06 22:54:41 +0200734 CONFIG_TPM_TIS_INFINEON
735 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000736 per system is supported at this time.
737
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000738 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
739 Define the burst count bytes upper limit
740
Christophe Ricard3aa74082016-01-21 23:27:13 +0100741 CONFIG_TPM_ST33ZP24
742 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
743
744 CONFIG_TPM_ST33ZP24_I2C
745 Support for STMicroelectronics ST33ZP24 I2C devices.
746 Requires TPM_ST33ZP24 and I2C.
747
Christophe Ricardb75fdc12016-01-21 23:27:14 +0100748 CONFIG_TPM_ST33ZP24_SPI
749 Support for STMicroelectronics ST33ZP24 SPI devices.
750 Requires TPM_ST33ZP24 and SPI.
751
Dirk Eibachc01939c2013-06-26 15:55:15 +0200752 CONFIG_TPM_ATMEL_TWI
753 Support for Atmel TWI TPM device. Requires I2C support.
754
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000755 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +0000756 Support for generic parallel port TPM devices. Only one device
757 per system is supported at this time.
758
759 CONFIG_TPM_TIS_BASE_ADDRESS
760 Base address where the generic TPM device is mapped
761 to. Contemporary x86 systems usually map it at
762 0xfed40000.
763
Reinhard Pfaube6c1522013-06-26 15:55:13 +0200764 CONFIG_TPM
765 Define this to enable the TPM support library which provides
766 functional interfaces to some TPM commands.
767 Requires support for a TPM device.
768
769 CONFIG_TPM_AUTH_SESSIONS
770 Define this to enable authorized functions in the TPM library.
771 Requires CONFIG_TPM and CONFIG_SHA1.
772
wdenkc6097192002-11-03 00:24:07 +0000773- USB Support:
774 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +0200775 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000776 CONFIG_USB_UHCI to enable it.
777 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000778 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000779 storage devices.
780 Note:
781 Supported are USB Keyboards and USB Floppy drives
782 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000783
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -0700784 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
785 HW module registers.
786
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200787- USB Device:
788 Define the below if you wish to use the USB console.
789 Once firmware is rebuilt from a serial console issue the
790 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200791 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200792 it has found a new device. The environment variable usbtty
793 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200794 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200795 Common Device Class Abstract Control Model serial device.
796 If you select usbtty = gserial you should be able to enumerate
797 a Linux host by
798 # modprobe usbserial vendor=0xVendorID product=0xProductID
799 else if using cdc_acm, simply setting the environment
800 variable usbtty to be cdc_acm should suffice. The following
801 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200802
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200803 CONFIG_USB_DEVICE
804 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000805
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200806 CONFIG_USB_TTY
807 Define this to have a tty type of device available to
808 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200809
Vipin KUMARf9da0f82012-03-26 15:38:06 +0530810 CONFIG_USBD_HS
811 Define this to enable the high speed support for usb
812 device and usbtty. If this feature is enabled, a routine
813 int is_usbd_high_speed(void)
814 also needs to be defined by the driver to dynamically poll
815 whether the enumeration has succeded at high speed or full
816 speed.
817
Wolfgang Denk386eda02006-06-14 18:14:56 +0200818 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200819 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200820 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200821 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
822 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
823 should pretend to be a Linux device to it's target host.
824
825 CONFIG_USBD_MANUFACTURER
826 Define this string as the name of your company for
827 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200828
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200829 CONFIG_USBD_PRODUCT_NAME
830 Define this string as the name of your product
831 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
832
833 CONFIG_USBD_VENDORID
834 Define this as your assigned Vendor ID from the USB
835 Implementors Forum. This *must* be a genuine Vendor ID
836 to avoid polluting the USB namespace.
837 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200838
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200839 CONFIG_USBD_PRODUCTID
840 Define this as the unique Product ID
841 for your device
842 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000843
Igor Grinbergd70a5602011-12-12 12:08:35 +0200844- ULPI Layer Support:
845 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
846 the generic ULPI layer. The generic layer accesses the ULPI PHY
847 via the platform viewport, so you need both the genric layer and
848 the viewport enabled. Currently only Chipidea/ARC based
849 viewport is supported.
850 To enable the ULPI layer support, define CONFIG_USB_ULPI and
851 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +0200852 If your ULPI phy needs a different reference clock than the
853 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
854 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +0000855
856- MMC Support:
857 The MMC controller on the Intel PXA is supported. To
858 enable this define CONFIG_MMC. The MMC can be
859 accessed from the boot prompt by mapping the device
860 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500861 enabled with CONFIG_CMD_MMC. The MMC driver also works with
862 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000863
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +0000864 CONFIG_SH_MMCIF
865 Support for Renesas on-chip MMCIF controller
866
867 CONFIG_SH_MMCIF_ADDR
868 Define the base address of MMCIF registers
869
870 CONFIG_SH_MMCIF_CLK
871 Define the clock frequency for MMCIF
872
Tom Rinib3ba6e92013-03-14 05:32:47 +0000873- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +0100874 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +0000875 This enables the USB portion of the DFU USB class
876
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000877 CONFIG_DFU_NAND
878 This enables support for exposing NAND devices via DFU.
879
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530880 CONFIG_DFU_RAM
881 This enables support for exposing RAM via DFU.
882 Note: DFU spec refer to non-volatile memory usage, but
883 allow usages beyond the scope of spec - here RAM usage,
884 one that would help mostly the developer.
885
Heiko Schochere7e75c72013-06-12 06:05:51 +0200886 CONFIG_SYS_DFU_DATA_BUF_SIZE
887 Dfu transfer uses a buffer before writing data to the
888 raw storage device. Make the size (in bytes) of this buffer
889 configurable. The size of this buffer is also configurable
890 through the "dfu_bufsiz" environment variable.
891
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000892 CONFIG_SYS_DFU_MAX_FILE_SIZE
893 When updating files rather than the raw storage device,
894 we use a static buffer to copy the file into and then write
895 the buffer once we've been given the whole file. Define
896 this to the maximum filesize (in bytes) for the buffer.
897 Default is 4 MiB if undefined.
898
Heiko Schocher001a8312014-03-18 08:09:56 +0100899 DFU_DEFAULT_POLL_TIMEOUT
900 Poll timeout [ms], is the timeout a device can send to the
901 host. The host must wait for this timeout before sending
902 a subsequent DFU_GET_STATUS request to the device.
903
904 DFU_MANIFEST_POLL_TIMEOUT
905 Poll timeout [ms], which the device sends to the host when
906 entering dfuMANIFEST state. Host waits this timeout, before
907 sending again an USB request to the device.
908
wdenk6705d812004-08-02 23:22:59 +0000909- Journaling Flash filesystem support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200910 CONFIG_SYS_JFFS2_FIRST_SECTOR,
911 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000912 Define these for a default partition on a NOR device
913
wdenkc6097192002-11-03 00:24:07 +0000914- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -0700915 See Kconfig help for available keyboard drivers.
916
wdenkc6097192002-11-03 00:24:07 +0000917- LCD Support: CONFIG_LCD
918
919 Define this to enable LCD support (for output to LCD
920 display); also select one of the supported displays
921 by defining one of these:
922
wdenkfd3103b2003-11-25 16:55:19 +0000923 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000924
wdenkfd3103b2003-11-25 16:55:19 +0000925 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000926
wdenkfd3103b2003-11-25 16:55:19 +0000927 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000928
wdenkfd3103b2003-11-25 16:55:19 +0000929 NEC NL6448BC20-08. 6.5", 640x480.
930 Active, color, single scan.
931
932 CONFIG_NEC_NL6448BC33_54
933
934 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000935 Active, color, single scan.
936
937 CONFIG_SHARP_16x9
938
939 Sharp 320x240. Active, color, single scan.
940 It isn't 16x9, and I am not sure what it is.
941
942 CONFIG_SHARP_LQ64D341
943
944 Sharp LQ64D341 display, 640x480.
945 Active, color, single scan.
946
947 CONFIG_HLD1045
948
949 HLD1045 display, 640x480.
950 Active, color, single scan.
951
952 CONFIG_OPTREX_BW
953
954 Optrex CBL50840-2 NF-FW 99 22 M5
955 or
956 Hitachi LMG6912RPFC-00T
957 or
958 Hitachi SP14Q002
959
960 320x240. Black & white.
961
Simon Glass676d3192012-10-17 13:24:54 +0000962 CONFIG_LCD_ALIGNMENT
963
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800964 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +0000965 defined then the LCD will be aligned to this value instead.
966 For ARM it is sometimes useful to use MMU_SECTION_SIZE
967 here, since it is cheaper to change data cache settings on
968 a per-section basis.
969
970
Hannes Petermaier604c7d42015-03-27 08:01:38 +0100971 CONFIG_LCD_ROTATION
972
973 Sometimes, for example if the display is mounted in portrait
974 mode or even if it's mounted landscape but rotated by 180degree,
975 we need to rotate our content of the display relative to the
976 framebuffer, so that user can read the messages which are
977 printed out.
978 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
979 initialized with a given rotation from "vl_rot" out of
980 "vidinfo_t" which is provided by the board specific code.
981 The value for vl_rot is coded as following (matching to
982 fbcon=rotate:<n> linux-kernel commandline):
983 0 = no rotation respectively 0 degree
984 1 = 90 degree rotation
985 2 = 180 degree rotation
986 3 = 270 degree rotation
987
988 If CONFIG_LCD_ROTATION is not defined, the console will be
989 initialized with 0degree rotation.
990
wdenk17ea1172004-06-06 21:51:03 +0000991- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +0000992 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
993
994 The clock frequency of the MII bus
995
wdenk17ea1172004-06-06 21:51:03 +0000996 CONFIG_PHY_CMD_DELAY (ppc4xx)
997
998 Some PHY like Intel LXT971A need extra delay after
999 command issued before MII status register can be read
1000
wdenkc6097192002-11-03 00:24:07 +00001001- IP address:
1002 CONFIG_IPADDR
1003
1004 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001005 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001006 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001007 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001008
1009- Server IP address:
1010 CONFIG_SERVERIP
1011
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001012 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001013 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001014 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001015
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001016- Gateway IP address:
1017 CONFIG_GATEWAYIP
1018
1019 Defines a default value for the IP address of the
1020 default router where packets to other networks are
1021 sent to.
1022 (Environment variable "gatewayip")
1023
1024- Subnet mask:
1025 CONFIG_NETMASK
1026
1027 Defines a default value for the subnet mask (or
1028 routing prefix) which is used to determine if an IP
1029 address belongs to the local subnet or needs to be
1030 forwarded through a router.
1031 (Environment variable "netmask")
1032
wdenkc6097192002-11-03 00:24:07 +00001033- BOOTP Recovery Mode:
1034 CONFIG_BOOTP_RANDOM_DELAY
1035
1036 If you have many targets in a network that try to
1037 boot using BOOTP, you may want to avoid that all
1038 systems send out BOOTP requests at precisely the same
1039 moment (which would happen for instance at recovery
1040 from a power failure, when all systems will try to
1041 boot, thus flooding the BOOTP server. Defining
1042 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1043 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001044 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001045
1046 1st BOOTP request: delay 0 ... 1 sec
1047 2nd BOOTP request: delay 0 ... 2 sec
1048 3rd BOOTP request: delay 0 ... 4 sec
1049 4th and following
1050 BOOTP requests: delay 0 ... 8 sec
1051
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001052 CONFIG_BOOTP_ID_CACHE_SIZE
1053
1054 BOOTP packets are uniquely identified using a 32-bit ID. The
1055 server will copy the ID from client requests to responses and
1056 U-Boot will use this to determine if it is the destination of
1057 an incoming response. Some servers will check that addresses
1058 aren't in use before handing them out (usually using an ARP
1059 ping) and therefore take up to a few hundred milliseconds to
1060 respond. Network congestion may also influence the time it
1061 takes for a response to make it back to the client. If that
1062 time is too long, U-Boot will retransmit requests. In order
1063 to allow earlier responses to still be accepted after these
1064 retransmissions, U-Boot's BOOTP client keeps a small cache of
1065 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1066 cache. The default is to keep IDs for up to four outstanding
1067 requests. Increasing this will allow U-Boot to accept offers
1068 from a BOOTP client in networks with unusually high latency.
1069
stroesefe389a82003-08-28 14:17:32 +00001070- DHCP Advanced Options:
Joe Hershberger2c00e092012-05-23 07:59:19 +00001071
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001072 - Link-local IP address negotiation:
1073 Negotiate with other link-local clients on the local network
1074 for an address that doesn't require explicit configuration.
1075 This is especially useful if a DHCP server cannot be guaranteed
1076 to exist in all environments that the device must operate.
1077
1078 See doc/README.link-local for more information.
1079
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301080 - MAC address from environment variables
1081
1082 FDT_SEQ_MACADDR_FROM_ENV
1083
1084 Fix-up device tree with MAC addresses fetched sequentially from
1085 environment variables. This config work on assumption that
1086 non-usable ethernet node of device-tree are either not present
1087 or their status has been marked as "disabled".
1088
wdenka3d991b2004-04-15 21:48:45 +00001089 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001090 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001091
1092 The device id used in CDP trigger frames.
1093
1094 CONFIG_CDP_DEVICE_ID_PREFIX
1095
1096 A two character string which is prefixed to the MAC address
1097 of the device.
1098
1099 CONFIG_CDP_PORT_ID
1100
1101 A printf format string which contains the ascii name of
1102 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001103 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001104
1105 CONFIG_CDP_CAPABILITIES
1106
1107 A 32bit integer which indicates the device capabilities;
1108 0x00000010 for a normal host which does not forwards.
1109
1110 CONFIG_CDP_VERSION
1111
1112 An ascii string containing the version of the software.
1113
1114 CONFIG_CDP_PLATFORM
1115
1116 An ascii string containing the name of the platform.
1117
1118 CONFIG_CDP_TRIGGER
1119
1120 A 32bit integer sent on the trigger.
1121
1122 CONFIG_CDP_POWER_CONSUMPTION
1123
1124 A 16bit integer containing the power consumption of the
1125 device in .1 of milliwatts.
1126
1127 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1128
1129 A byte containing the id of the VLAN.
1130
Uri Mashiach79267ed2017-01-19 10:51:05 +02001131- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001132
1133 Several configurations allow to display the current
1134 status using a LED. For instance, the LED will blink
1135 fast while running U-Boot code, stop blinking as
1136 soon as a reply to a BOOTP request was received, and
1137 start blinking slow once the Linux kernel is running
1138 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001139 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001140 feature in U-Boot.
1141
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001142 Additional options:
1143
Uri Mashiach79267ed2017-01-19 10:51:05 +02001144 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001145 The status LED can be connected to a GPIO pin.
1146 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001147 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001148 to include the gpio_led driver in the U-Boot binary.
1149
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001150 CONFIG_GPIO_LED_INVERTED_TABLE
1151 Some GPIO connected LEDs may have inverted polarity in which
1152 case the GPIO high value corresponds to LED off state and
1153 GPIO low value corresponds to LED on state.
1154 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1155 with a list of GPIO LEDs that have inverted polarity.
1156
Tom Rini55dabcc2021-08-18 23:12:24 -04001157- I2C Support:
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001158 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001159 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001160
1161 CONFIG_SYS_I2C_DIRECT_BUS
1162 define this, if you don't use i2c muxes on your hardware.
1163 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1164 omit this define.
1165
1166 CONFIG_SYS_I2C_MAX_HOPS
1167 define how many muxes are maximal consecutively connected
1168 on one i2c bus. If you not use i2c muxes, omit this
1169 define.
1170
1171 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001172 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001173 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1174 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1175 CONFIG_SYS_NUM_I2C_BUSES = 9:
1176
1177 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1178 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1179 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1180 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1181 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1182 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1183 {1, {I2C_NULL_HOP}}, \
1184 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1185 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1186 }
1187
1188 which defines
1189 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001190 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1191 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1192 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1193 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1194 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001195 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001196 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1197 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001198
1199 If you do not have i2c muxes on your board, omit this define.
1200
Simon Glassce3b5d62017-05-12 21:10:00 -06001201- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001202 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001203 then the following macros need to be defined (examples are
1204 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001205
1206 I2C_INIT
1207
wdenkb37c7e52003-06-30 16:24:52 +00001208 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001209 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001210
wdenkba56f622004-02-06 23:19:44 +00001211 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001212
wdenkc6097192002-11-03 00:24:07 +00001213 I2C_ACTIVE
1214
1215 The code necessary to make the I2C data line active
1216 (driven). If the data line is open collector, this
1217 define can be null.
1218
wdenkb37c7e52003-06-30 16:24:52 +00001219 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1220
wdenkc6097192002-11-03 00:24:07 +00001221 I2C_TRISTATE
1222
1223 The code necessary to make the I2C data line tri-stated
1224 (inactive). If the data line is open collector, this
1225 define can be null.
1226
wdenkb37c7e52003-06-30 16:24:52 +00001227 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1228
wdenkc6097192002-11-03 00:24:07 +00001229 I2C_READ
1230
York Sun472d5462013-04-01 11:29:11 -07001231 Code that returns true if the I2C data line is high,
1232 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001233
wdenkb37c7e52003-06-30 16:24:52 +00001234 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1235
wdenkc6097192002-11-03 00:24:07 +00001236 I2C_SDA(bit)
1237
York Sun472d5462013-04-01 11:29:11 -07001238 If <bit> is true, sets the I2C data line high. If it
1239 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001240
wdenkb37c7e52003-06-30 16:24:52 +00001241 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001242 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001243 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001244
wdenkc6097192002-11-03 00:24:07 +00001245 I2C_SCL(bit)
1246
York Sun472d5462013-04-01 11:29:11 -07001247 If <bit> is true, sets the I2C clock line high. If it
1248 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001249
wdenkb37c7e52003-06-30 16:24:52 +00001250 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001251 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001252 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001253
wdenkc6097192002-11-03 00:24:07 +00001254 I2C_DELAY
1255
1256 This delay is invoked four times per clock cycle so this
1257 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001258 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001259 like:
1260
wdenkb37c7e52003-06-30 16:24:52 +00001261 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001262
Mike Frysinger793b5722010-07-21 13:38:02 -04001263 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1264
1265 If your arch supports the generic GPIO framework (asm/gpio.h),
1266 then you may alternatively define the two GPIOs that are to be
1267 used as SCL / SDA. Any of the previous I2C_xxx macros will
1268 have GPIO-based defaults assigned to them as appropriate.
1269
1270 You should define these to the GPIO value as given directly to
1271 the generic GPIO functions.
1272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001273 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001274
wdenk8bde7f72003-06-27 21:31:46 +00001275 When a board is reset during an i2c bus transfer
1276 chips might think that the current transfer is still
1277 in progress. On some boards it is possible to access
1278 the i2c SCLK line directly, either by using the
1279 processor pin as a GPIO or by having a second pin
1280 connected to the bus. If this option is defined a
1281 custom i2c_init_board() routine in boards/xxx/board.c
1282 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001283
Ben Warrenbb99ad62006-09-07 16:50:54 -04001284 CONFIG_I2C_MULTI_BUS
1285
1286 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001287 must have a controller. At any point in time, only one bus is
1288 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001289 Note that bus numbering is zero-based.
1290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001291 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001292
1293 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001294 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001295 is set, specify a list of bus-device pairs. Otherwise, specify
1296 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001297
1298 e.g.
1299 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001300 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001301
1302 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1303
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001304 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001305 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001306
1307 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001309 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001310
1311 If defined, then this indicates the I2C bus number for DDR SPD.
1312 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1313
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001314 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001315
1316 If defined, then this indicates the I2C bus number for the RTC.
1317 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1318
Andrew Dyer2ac69852008-12-29 17:36:01 -06001319 CONFIG_SOFT_I2C_READ_REPEATED_START
1320
1321 defining this will force the i2c_read() function in
1322 the soft_i2c driver to perform an I2C repeated start
1323 between writing the address pointer and reading the
1324 data. If this define is omitted the default behaviour
1325 of doing a stop-start sequence will be used. Most I2C
1326 devices can use either method, but some require one or
1327 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001328
wdenkc6097192002-11-03 00:24:07 +00001329- SPI Support: CONFIG_SPI
1330
1331 Enables SPI driver (so far only tested with
1332 SPI EEPROM, also an instance works with Crystal A/D and
1333 D/As on the SACSng board)
1334
Heiko Schocherf659b572014-07-14 10:22:11 +02001335 CONFIG_SYS_SPI_MXC_WAIT
1336 Timeout for waiting until spi transfer completed.
1337 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1338
Matthias Fuchs01335022007-12-27 17:12:34 +01001339- FPGA Support: CONFIG_FPGA
1340
1341 Enables FPGA subsystem.
1342
1343 CONFIG_FPGA_<vendor>
1344
1345 Enables support for specific chip vendors.
1346 (ALTERA, XILINX)
1347
1348 CONFIG_FPGA_<family>
1349
1350 Enables support for FPGA family.
1351 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1352
1353 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001354
wdenk43d96162003-03-06 00:02:04 +00001355 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001357 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001358
wdenk8bde7f72003-06-27 21:31:46 +00001359 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001361 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001362
wdenk43d96162003-03-06 00:02:04 +00001363 Enable checks on FPGA configuration interface busy
1364 status by the configuration function. This option
1365 will require a board or device specific function to
1366 be written.
wdenkc6097192002-11-03 00:24:07 +00001367
1368 CONFIG_FPGA_DELAY
1369
1370 If defined, a function that provides delays in the FPGA
1371 configuration driver.
1372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001373 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001374 Allow Control-C to interrupt FPGA configuration
1375
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001376 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001377
wdenk43d96162003-03-06 00:02:04 +00001378 Check for configuration errors during FPGA bitfile
1379 loading. For example, abort during Virtex II
1380 configuration if the INIT_B line goes low (which
1381 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001383 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001384
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001385 Maximum time to wait for the INIT_B line to de-assert
1386 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00001387 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001388 ms.
wdenkc6097192002-11-03 00:24:07 +00001389
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001390 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001391
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001392 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001393 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001395 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001396
wdenk43d96162003-03-06 00:02:04 +00001397 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001398 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001399
wdenkc6097192002-11-03 00:24:07 +00001400- Vendor Parameter Protection:
1401
wdenk43d96162003-03-06 00:02:04 +00001402 U-Boot considers the values of the environment
1403 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001404 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001405 are set once by the board vendor / manufacturer, and
1406 protects these variables from casual modification by
1407 the user. Once set, these variables are read-only,
1408 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001409 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001410
1411 If CONFIG_ENV_OVERWRITE is #defined in your config
1412 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001413 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001414 these parameters.
1415
Joe Hershberger92ac5202015-05-04 14:55:14 -05001416 Alternatively, if you define _both_ an ethaddr in the
1417 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001418 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001419 which can be changed exactly ONCE by the user. [The
1420 serial# is unaffected by this, i. e. it remains
1421 read-only.]
1422
Joe Hershberger25980902012-12-11 22:16:31 -06001423 The same can be accomplished in a more flexible way
1424 for any variable by configuring the type of access
1425 to allow for those variables in the ".flags" variable
1426 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1427
wdenkc6097192002-11-03 00:24:07 +00001428- Protected RAM:
1429 CONFIG_PRAM
1430
1431 Define this variable to enable the reservation of
1432 "protected RAM", i. e. RAM which is not overwritten
1433 by U-Boot. Define CONFIG_PRAM to hold the number of
1434 kB you want to reserve for pRAM. You can overwrite
1435 this default value by defining an environment
1436 variable "pram" to the number of kB you want to
1437 reserve. Note that the board info structure will
1438 still show the full amount of RAM. If pRAM is
1439 reserved, a new environment variable "mem" will
1440 automatically be defined to hold the amount of
1441 remaining RAM in a form that can be passed as boot
1442 argument to Linux, for instance like that:
1443
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001444 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001445 saveenv
1446
1447 This way you can tell Linux not to use this memory,
1448 either, which results in a memory region that will
1449 not be affected by reboots.
1450
1451 *WARNING* If your board configuration uses automatic
1452 detection of the RAM size, you must make sure that
1453 this memory test is non-destructive. So far, the
1454 following board configurations are known to be
1455 "pRAM-clean":
1456
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02001457 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00001458 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02001459 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001460
1461- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001462 Note:
1463
wdenk8bde7f72003-06-27 21:31:46 +00001464 In the current implementation, the local variables
1465 space and global environment variables space are
1466 separated. Local variables are those you define by
1467 simply typing `name=value'. To access a local
1468 variable later on, you have write `$name' or
1469 `${name}'; to execute the contents of a variable
1470 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001471
wdenk43d96162003-03-06 00:02:04 +00001472 Global environment variables are those you use
1473 setenv/printenv to work with. To run a command stored
1474 in such a variable, you need to use the run command,
1475 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001476
1477 To store commands and special characters in a
1478 variable, please use double quotation marks
1479 surrounding the whole text of the variable, instead
1480 of the backslashes before semicolons and special
1481 symbols.
1482
wdenka8c7c702003-12-06 19:49:23 +00001483- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001484 CONFIG_EXTRA_ENV_SETTINGS
1485
wdenk43d96162003-03-06 00:02:04 +00001486 Define this to contain any number of null terminated
1487 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001488 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001489
wdenk43d96162003-03-06 00:02:04 +00001490 For example, place something like this in your
1491 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001492
1493 #define CONFIG_EXTRA_ENV_SETTINGS \
1494 "myvar1=value1\0" \
1495 "myvar2=value2\0"
1496
wdenk43d96162003-03-06 00:02:04 +00001497 Warning: This method is based on knowledge about the
1498 internal format how the environment is stored by the
1499 U-Boot code. This is NOT an official, exported
1500 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001501 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001502 You better know what you are doing here.
1503
wdenk43d96162003-03-06 00:02:04 +00001504 Note: overly (ab)use of the default environment is
1505 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001506 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001507 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001508
Simon Glass06fd8532012-11-30 13:01:17 +00001509 CONFIG_DELAY_ENVIRONMENT
1510
1511 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001512 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00001513 that so that the environment is not available until
1514 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1515 this is instead controlled by the value of
1516 /config/load-environment.
1517
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001518 CONFIG_STANDALONE_LOAD_ADDR
1519
Wolfgang Denk6feff892011-10-09 21:06:34 +02001520 This option defines a board specific value for the
1521 address where standalone program gets loaded, thus
1522 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001523 settings.
1524
1525- Frame Buffer Address:
1526 CONFIG_FB_ADDR
1527
1528 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00001529 address for frame buffer. This is typically the case
1530 when using a graphics controller has separate video
1531 memory. U-Boot will then place the frame buffer at
1532 the given address instead of dynamically reserving it
1533 in system RAM by calling lcd_setmem(), which grabs
1534 the memory for the frame buffer depending on the
1535 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001536
1537 Please see board_init_f function.
1538
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01001539- Automatic software updates via TFTP server
1540 CONFIG_UPDATE_TFTP
1541 CONFIG_UPDATE_TFTP_CNT_MAX
1542 CONFIG_UPDATE_TFTP_MSEC_MAX
1543
1544 These options enable and control the auto-update feature;
1545 for a more detailed description refer to doc/README.update.
1546
1547- MTD Support (mtdparts command, UBI support)
Heiko Schocherff94bc42014-06-24 10:10:04 +02001548 CONFIG_MTD_UBI_WL_THRESHOLD
1549 This parameter defines the maximum difference between the highest
1550 erase counter value and the lowest erase counter value of eraseblocks
1551 of UBI devices. When this threshold is exceeded, UBI starts performing
1552 wear leveling by means of moving data from eraseblock with low erase
1553 counter to eraseblocks with high erase counter.
1554
1555 The default value should be OK for SLC NAND flashes, NOR flashes and
1556 other flashes which have eraseblock life-cycle 100000 or more.
1557 However, in case of MLC NAND flashes which typically have eraseblock
1558 life-cycle less than 10000, the threshold should be lessened (e.g.,
1559 to 128 or 256, although it does not have to be power of 2).
1560
1561 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06001562
Heiko Schocherff94bc42014-06-24 10:10:04 +02001563 CONFIG_MTD_UBI_BEB_LIMIT
1564 This option specifies the maximum bad physical eraseblocks UBI
1565 expects on the MTD device (per 1024 eraseblocks). If the
1566 underlying flash does not admit of bad eraseblocks (e.g. NOR
1567 flash), this value is ignored.
1568
1569 NAND datasheets often specify the minimum and maximum NVM
1570 (Number of Valid Blocks) for the flashes' endurance lifetime.
1571 The maximum expected bad eraseblocks per 1024 eraseblocks
1572 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1573 which gives 20 for most NANDs (MaxNVB is basically the total
1574 count of eraseblocks on the chip).
1575
1576 To put it differently, if this value is 20, UBI will try to
1577 reserve about 1.9% of physical eraseblocks for bad blocks
1578 handling. And that will be 1.9% of eraseblocks on the entire
1579 NAND chip, not just the MTD partition UBI attaches. This means
1580 that if you have, say, a NAND flash chip admits maximum 40 bad
1581 eraseblocks, and it is split on two MTD partitions of the same
1582 size, UBI will reserve 40 eraseblocks when attaching a
1583 partition.
1584
1585 default: 20
1586
1587 CONFIG_MTD_UBI_FASTMAP
1588 Fastmap is a mechanism which allows attaching an UBI device
1589 in nearly constant time. Instead of scanning the whole MTD device it
1590 only has to locate a checkpoint (called fastmap) on the device.
1591 The on-flash fastmap contains all information needed to attach
1592 the device. Using fastmap makes only sense on large devices where
1593 attaching by scanning takes long. UBI will not automatically install
1594 a fastmap on old images, but you can set the UBI parameter
1595 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1596 that fastmap-enabled images are still usable with UBI implementations
1597 without fastmap support. On typical flash devices the whole fastmap
1598 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1599
1600 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1601 Set this parameter to enable fastmap automatically on images
1602 without a fastmap.
1603 default: 0
1604
Heiko Schocher0195a7b2015-10-22 06:19:21 +02001605 CONFIG_MTD_UBI_FM_DEBUG
1606 Enable UBI fastmap debug
1607 default: 0
1608
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00001609- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001610 CONFIG_SPL
1611 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00001612
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02001613 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1614 When defined, SPL will panic() if the image it has
1615 loaded does not have a signature.
1616 Defining this is useful when code which loads images
1617 in SPL cannot guarantee that absolutely all read errors
1618 will be caught.
1619 An example is the LPC32XX MLC NAND driver, which will
1620 consider that a completely unreadable NAND block is bad,
1621 and thus should be skipped silently.
1622
Tom Rini861a86f2012-08-13 11:37:56 -07001623 CONFIG_SPL_DISPLAY_PRINT
1624 For ARM, enable an optional function to print more information
1625 about the running system.
1626
Scott Wood06f60ae2012-12-06 13:33:17 +00001627 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1628 Set this for NAND SPL on PPC mpc83xx targets, so that
1629 start.S waits for the rest of the SPL to load before
1630 continuing (the hardware starts execution after just
1631 loading the first page rather than the full 4K).
1632
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02001633 CONFIG_SPL_UBI
1634 Support for a lightweight UBI (fastmap) scanner and
1635 loader
1636
Tom Rini95579792012-02-14 07:29:40 +00001637 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1638 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1639 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1640 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1641 CONFIG_SYS_NAND_ECCBYTES
1642 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05001643 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00001644
Scott Wood7d4b7952012-09-21 18:35:27 -05001645 CONFIG_SYS_NAND_U_BOOT_DST
1646 Location in memory to load U-Boot to
1647
1648 CONFIG_SYS_NAND_U_BOOT_SIZE
1649 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00001650
1651 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05001652 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00001653
1654 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1655 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001656 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00001657
Pavel Machekc57b9532012-08-30 22:42:11 +02001658 CONFIG_SPL_RAM_DEVICE
1659 Support for running image already present in ram, in SPL binary
1660
Marek Vasutb527b9c2018-05-13 00:22:52 +02001661 CONFIG_SPL_FIT_PRINT
Simon Glass87ebee32013-05-08 08:05:59 +00001662 Printing information about a FIT image adds quite a bit of
1663 code to SPL. So this is normally disabled in SPL. Use this
1664 option to re-enable it. This will affect the output of the
1665 bootm command when booting a FIT image.
1666
wdenka8c7c702003-12-06 19:49:23 +00001667- Interrupt support (PPC):
1668
wdenkd4ca31c2004-01-02 14:00:00 +00001669 There are common interrupt_init() and timer_interrupt()
1670 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001671 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00001672 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001673 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00001674 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001675 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00001676 specific handling. If board has watchdog / status_led
1677 / other_activity_monitor it works automatically from
1678 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001679
wdenkc6097192002-11-03 00:24:07 +00001680
Helmut Raiger9660e442011-10-20 04:19:47 +00001681Board initialization settings:
1682------------------------------
1683
1684During Initialization u-boot calls a number of board specific functions
1685to allow the preparation of board specific prerequisites, e.g. pin setup
1686before drivers are initialized. To enable these callbacks the
1687following configuration macros have to be defined. Currently this is
1688architecture specific, so please check arch/your_architecture/lib/board.c
1689typically in board_init_f() and board_init_r().
1690
1691- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1692- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1693- CONFIG_BOARD_LATE_INIT: Call board_late_init()
wdenkc6097192002-11-03 00:24:07 +00001694
wdenkc6097192002-11-03 00:24:07 +00001695Configuration Settings:
1696-----------------------
1697
Simon Glass4d979bf2019-12-28 10:45:10 -07001698- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun4d1fd7f2014-02-26 17:03:19 -08001699 Optionally it can be defined to support 64-bit memory commands.
1700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001701- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00001702 undefine this when you're short of memory.
1703
Peter Tyser2fb26042009-01-27 18:03:12 -06001704- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
1705 width of the commands listed in the 'help' command output.
1706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001707- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00001708 prompt for user input.
1709
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001710- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00001711 List of legal baudrate settings for this board.
1712
York Sune8149522015-12-04 11:57:07 -08001713- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07001714 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08001715 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
1716 is substracted from total RAM and won't be reported to OS.
1717 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07001718 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08001719 the RAM base is not zero, or RAM is divided into banks,
1720 this variable needs to be recalcuated to get the address.
1721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001722- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00001723 Enable temporary baudrate change while serial download
1724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001725- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00001726 Physical start address of SDRAM. _Must_ be 0 here.
1727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001728- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00001729 Physical start address of Flash memory.
1730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001731- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001732 Size of memory reserved for monitor code, used to
1733 determine _at_compile_time_ (!) if the environment is
1734 embedded within the U-Boot image, or in a separate
1735 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001736
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001737- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00001738 Size of DRAM reserved for malloc() use.
1739
Simon Glassd59476b2014-07-10 22:23:28 -06001740- CONFIG_SYS_MALLOC_F_LEN
1741 Size of the malloc() pool for use before relocation. If
1742 this is defined, then a very simple malloc() implementation
1743 will become available before relocation. The address is just
1744 below the global data, and the stack is moved down to make
1745 space.
1746
1747 This feature allocates regions with increasing addresses
1748 within the region. calloc() is supported, but realloc()
1749 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001750 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06001751 U-Boot relocates itself.
1752
Simon Glass38687ae2014-11-10 17:16:54 -07001753- CONFIG_SYS_MALLOC_SIMPLE
1754 Provides a simple and small malloc() and calloc() for those
1755 boards which do not use the full malloc in SPL (which is
Tom Rini10f6e4d2022-05-27 12:48:32 -04001756 enabled with CONFIG_SYS_SPL_MALLOC).
Simon Glass38687ae2014-11-10 17:16:54 -07001757
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07001758- CONFIG_SYS_NONCACHED_MEMORY:
1759 Size of non-cached memory area. This area of memory will be
1760 typically located right below the malloc() area and mapped
1761 uncached in the MMU. This is useful for drivers that would
1762 otherwise require a lot of explicit cache maintenance. For
1763 some drivers it's also impossible to properly maintain the
1764 cache. For example if the regions that need to be flushed
1765 are not a multiple of the cache-line size, *and* padding
1766 cannot be allocated between the regions to align them (i.e.
1767 if the HW requires a contiguous array of regions, and the
1768 size of each region is not cache-aligned), then a flush of
1769 one region may result in overwriting data that hardware has
1770 written to another region in the same cache-line. This can
1771 happen for example in network drivers where descriptors for
1772 buffers are typically smaller than the CPU cache-line (e.g.
1773 16 bytes vs. 32 or 64 bytes).
1774
1775 Non-cached memory is only supported on 32-bit ARM at present.
1776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001777- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01001778 Normally compressed uImages are limited to an
1779 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001780 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01001781 to adjust this setting to your needs.
1782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001783- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00001784 Maximum size of memory mapped by the startup code of
1785 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02001786 the Linux kernel (bd_info, boot arguments, FDT blob if
1787 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04001788 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02001789 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001790 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00001791 variable "bootm_mapsize" will override the value of
1792 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
1793 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00001794
John Rigbyfca43cc2010-10-13 13:57:35 -06001795- CONFIG_SYS_BOOT_RAMDISK_HIGH:
1796 Enable initrd_high functionality. If defined then the
1797 initrd_high feature is enabled and the bootm ramdisk subcommand
1798 is enabled.
1799
1800- CONFIG_SYS_BOOT_GET_CMDLINE:
1801 Enables allocating and saving kernel cmdline in space between
1802 "bootm_low" and "bootm_low" + BOOTMAPSZ.
1803
1804- CONFIG_SYS_BOOT_GET_KBD:
1805 Enables allocating and saving a kernel copy of the bd_info in
1806 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
1807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001808- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00001809 Max number of sectors on a Flash chip
1810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001811- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00001812 Timeout for Flash erase operations (in ms)
1813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001814- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00001815 Timeout for Flash write operations (in ms)
1816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001817- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00001818 Timeout for Flash set sector lock bit operation (in ms)
1819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001820- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00001821 Timeout for Flash clear lock bits operation (in ms)
1822
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001823- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00001824 If defined, hardware flash sectors protection is used
1825 instead of U-Boot software protection.
1826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001827- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00001828
1829 Enable TFTP transfers directly to flash memory;
1830 without this option such a download has to be
1831 performed in two steps: (1) download to RAM, and (2)
1832 copy from RAM to flash.
1833
1834 The two-step approach is usually more reliable, since
1835 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001836 the flash, but in some situations (when system RAM is
1837 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00001838 downloaded image) this option may be very useful.
1839
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001840- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001841 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001842 common flash structure for storing flash geometry.
1843
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02001844- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00001845 This option also enables the building of the cfi_flash driver
1846 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001847
Piotr Ziecik91809ed2008-11-17 15:57:58 +01001848- CONFIG_FLASH_CFI_MTD
1849 This option enables the building of the cfi_mtd driver
1850 in the drivers directory. The driver exports CFI flash
1851 to the MTD layer.
1852
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001853- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02001854 Use buffered writes to flash.
1855
1856- CONFIG_FLASH_SPANSION_S29WS_N
1857 s29ws-n MirrorBit flash has non-standard addresses for buffered
1858 write commands.
1859
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001860- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01001861 If this option is defined, the common CFI flash doesn't
1862 print it's warning upon not recognized FLASH banks. This
1863 is useful, if some of the configured banks are only
1864 optionally available.
1865
Jerry Van Baren9a042e92008-03-08 13:48:01 -05001866- CONFIG_FLASH_SHOW_PROGRESS
1867 If defined (must be an integer), print out countdown
1868 digits and dots. Recommended value: 45 (9..1) for 80
1869 column displays, 15 (3..1) for 40 column displays.
1870
Stefan Roese352ef3f2013-04-04 15:53:14 +02001871- CONFIG_FLASH_VERIFY
1872 If defined, the content of the flash (destination) is compared
1873 against the source after the write operation. An error message
1874 will be printed when the contents are not identical.
1875 Please note that this option is useless in nearly all cases,
1876 since such flash programming errors usually are detected earlier
1877 while unprotecting/erasing/programming. Please only enable
1878 this option if you really know what you are doing.
1879
Wolfgang Denkea882ba2010-06-20 23:33:59 +02001880- CONFIG_ENV_MAX_ENTRIES
1881
Wolfgang Denk071bc922010-10-27 22:48:30 +02001882 Maximum number of entries in the hash table that is used
1883 internally to store the environment settings. The default
1884 setting is supposed to be generous and should work in most
1885 cases. This setting can be used to tune behaviour; see
1886 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02001887
Joe Hershberger25980902012-12-11 22:16:31 -06001888- CONFIG_ENV_FLAGS_LIST_DEFAULT
1889- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04001890 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06001891 calling env set. Variables can be restricted to only decimal,
1892 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
1893 the variables can also be restricted to IP address or MAC address.
1894
1895 The format of the list is:
1896 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001897 access_attribute = [a|r|o|c]
1898 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06001899 entry = variable_name[:attributes]
1900 list = entry[,list]
1901
1902 The type attributes are:
1903 s - String (default)
1904 d - Decimal
1905 x - Hexadecimal
1906 b - Boolean ([1yYtT|0nNfF])
1907 i - IP address
1908 m - MAC address
1909
Joe Hershberger267541f2012-12-11 22:16:34 -06001910 The access attributes are:
1911 a - Any (default)
1912 r - Read-only
1913 o - Write-once
1914 c - Change-default
1915
Joe Hershberger25980902012-12-11 22:16:31 -06001916 - CONFIG_ENV_FLAGS_LIST_DEFAULT
1917 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001918 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06001919
1920 - CONFIG_ENV_FLAGS_LIST_STATIC
1921 Define this to a list (string) to define validation that
1922 should be done if an entry is not found in the ".flags"
1923 environment variable. To override a setting in the static
1924 list, simply add an entry for the same variable name to the
1925 ".flags" variable.
1926
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05001927 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
1928 regular expression. This allows multiple variables to define the same
1929 flags without explicitly listing them for each variable.
1930
wdenkc6097192002-11-03 00:24:07 +00001931The following definitions that deal with the placement and management
1932of environment data (variable area); in general, we support the
1933following configurations:
1934
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00001935- CONFIG_BUILD_ENVCRC:
1936
1937 Builds up envcrc with the target environment so that external utils
1938 may easily extract it and embed it in final U-Boot images.
1939
wdenkc6097192002-11-03 00:24:07 +00001940BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001941in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001942console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00001943U-Boot will hang.
1944
1945Please note that even with NVRAM we still use a copy of the
1946environment in RAM: we could work on NVRAM directly, but we want to
1947keep settings there always unmodified except somebody uses "saveenv"
1948to save the current settings.
1949
Liu Gang0a85a9e2012-03-08 00:33:20 +00001950BE CAREFUL! For some special cases, the local device can not use
1951"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00001952environment stored in a remote NOR flash by SRIO or PCIE link,
1953but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00001954
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02001955- CONFIG_NAND_ENV_DST
1956
1957 Defines address in RAM to which the nand_spl code should copy the
1958 environment. If redundant environment is used, it will be copied to
1959 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
1960
Bruce Adlere881cb52007-11-02 13:15:42 -07001961Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00001962has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06001963created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00001964until then to read environment variables.
1965
wdenk85ec0bc2003-03-31 16:34:49 +00001966The environment is protected by a CRC32 checksum. Before the monitor
1967is relocated into RAM, as a result of a bad CRC you will be working
1968with the compiled-in default environment - *silently*!!! [This is
1969necessary, because the first environment variable we need is the
1970"baudrate" setting for the console - if we have a bad CRC, we don't
1971have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001972
1973Note: once the monitor has been relocated, then it will complain if
1974the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001975use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001976
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001977- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001978 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001979
Ron Madridf5675aa2009-02-18 14:30:44 -08001980- CONFIG_NS16550_MIN_FUNCTIONS:
1981 Define this if you desire to only have use of the NS16550_init
1982 and NS16550_putc functions for the serial driver located at
1983 drivers/serial/ns16550.c. This option is useful for saving
1984 space for already greatly restricted images, including but not
1985 limited to NAND_SPL configurations.
1986
Simon Glassb2b92f52012-11-30 13:01:18 +00001987- CONFIG_DISPLAY_BOARDINFO
1988 Display information about the board that U-Boot is running on
1989 when U-Boot starts up. The board function checkboard() is called
1990 to do this.
1991
Simon Glasse2e3e2b2012-11-30 13:01:19 +00001992- CONFIG_DISPLAY_BOARDINFO_LATE
1993 Similar to the previous option, but display this information
1994 later, once stdio is running and output goes to the LCD, if
1995 present.
1996
wdenkc6097192002-11-03 00:24:07 +00001997Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001998---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002000- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002001 Cache Line Size of the CPU.
2002
Timur Tabie46fedf2011-08-04 18:03:41 -05002003- CONFIG_SYS_CCSRBAR_DEFAULT:
2004 Default (power-on reset) physical address of CCSR on Freescale
2005 PowerPC SOCs.
2006
2007- CONFIG_SYS_CCSRBAR:
2008 Virtual address of CCSR. On a 32-bit build, this is typically
2009 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2010
Timur Tabie46fedf2011-08-04 18:03:41 -05002011- CONFIG_SYS_CCSRBAR_PHYS:
2012 Physical address of CCSR. CCSR can be relocated to a new
2013 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002014 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05002015 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2016 is typically relocated on 36-bit builds. It is recommended
2017 that this macro be defined via the _HIGH and _LOW macros:
2018
2019 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2020 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2021
2022- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002023 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2024 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002025 used in assembly code, so it must not contain typecasts or
2026 integer size suffixes (e.g. "ULL").
2027
2028- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2029 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2030 used in assembly code, so it must not contain typecasts or
2031 integer size suffixes (e.g. "ULL").
2032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002033- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002034 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02002035 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002036
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002037- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002038
wdenk7152b1d2003-09-05 23:19:14 +00002039 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002040 initial data and stack; please note that this must be
2041 writable memory that is working WITHOUT special
2042 initialization, i. e. you CANNOT use normal RAM which
2043 will become available only after programming the
2044 memory controller and running certain initialization
2045 sequences.
2046
2047 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02002048 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002050- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002051
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002052- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002053 SDRAM timing
2054
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002055- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002056 periodic timer for refresh
2057
Kumar Galaa09b9b62010-12-30 12:09:53 -06002058- CONFIG_SYS_SRIO:
2059 Chip has SRIO or not
2060
2061- CONFIG_SRIO1:
2062 Board has SRIO 1 port available
2063
2064- CONFIG_SRIO2:
2065 Board has SRIO 2 port available
2066
Liu Gangc8b28152013-05-07 16:30:46 +08002067- CONFIG_SRIO_PCIE_BOOT_MASTER
2068 Board can support master function for Boot from SRIO and PCIE
2069
Kumar Galaa09b9b62010-12-30 12:09:53 -06002070- CONFIG_SYS_SRIOn_MEM_VIRT:
2071 Virtual Address of SRIO port 'n' memory region
2072
Simon Glass62f9b652019-11-14 12:57:09 -07002073- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Galaa09b9b62010-12-30 12:09:53 -06002074 Physical Address of SRIO port 'n' memory region
2075
2076- CONFIG_SYS_SRIOn_MEM_SIZE:
2077 Size of SRIO port 'n' memory region
2078
Fabio Estevam66bd1842013-04-11 09:35:34 +00002079- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2080 Defined to tell the NAND controller that the NAND chip is using
2081 a 16 bit bus.
2082 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00002083 Example of drivers that use it:
Miquel Raynala430fa02018-08-16 17:30:07 +02002084 - drivers/mtd/nand/raw/ndfc.c
2085 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04002086
2087- CONFIG_SYS_NDFC_EBC0_CFG
2088 Sets the EBC0_CFG register for the NDFC. If not defined
2089 a default value will be used.
2090
Ben Warrenbb99ad62006-09-07 16:50:54 -04002091- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002092 Get DDR timing information from an I2C EEPROM. Common
2093 with pluggable memory modules such as SODIMMs
2094
Ben Warrenbb99ad62006-09-07 16:50:54 -04002095 SPD_EEPROM_ADDRESS
2096 I2C address of the SPD EEPROM
2097
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002098- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002099 If SPD EEPROM is on an I2C bus other than the first
2100 one, specify here. Note that the value must resolve
2101 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002102
York Sun1b3e3c42011-06-07 09:42:16 +08002103- CONFIG_SYS_DDR_RAW_TIMING
2104 Get DDR timing information from other than SPD. Common with
2105 soldered DDR chips onboard without SPD. DDR raw timing
2106 parameters are extracted from datasheet and hard-coded into
2107 header files or board specific files.
2108
York Sun6f5e1dc2011-09-16 13:21:35 -07002109- CONFIG_FSL_DDR_INTERACTIVE
2110 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2111
York Sune32d59a2015-01-06 13:18:55 -08002112- CONFIG_FSL_DDR_SYNC_REFRESH
2113 Enable sync of refresh for multiple controllers.
2114
York Sun4516ff82015-03-19 09:30:28 -07002115- CONFIG_FSL_DDR_BIST
2116 Enable built-in memory test for Freescale DDR controllers.
2117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002118- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002119 Only for 83xx systems. If specified, then DDR should
2120 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002121
wdenkc26e4542004-04-18 10:13:26 +00002122- CONFIG_RMII
2123 Enable RMII mode for all FECs.
2124 Note that this is a global option, we can't
2125 have one FEC in standard MII mode and another in RMII mode.
2126
wdenk5cf91d62004-04-23 20:32:05 +00002127- CONFIG_CRC32_VERIFY
2128 Add a verify option to the crc32 command.
2129 The syntax is:
2130
2131 => crc32 -v <address> <count> <crc32>
2132
2133 Where address/count indicate a memory area
2134 and crc32 is the correct crc32 which the
2135 area should have.
2136
wdenk56523f12004-07-11 17:40:54 +00002137- CONFIG_LOOPW
2138 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06002139 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00002140
Joel Johnson72732312020-01-29 09:17:18 -07002141- CONFIG_CMD_MX_CYCLIC
stroese7b466642004-12-16 18:46:55 +00002142 Add the "mdc" and "mwc" memory commands. These are cyclic
2143 "md/mw" commands.
2144 Examples:
2145
wdenkefe2a4d2004-12-16 21:44:03 +00002146 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002147 This command will print 4 bytes (10,11,12,13) each 500 ms.
2148
wdenkefe2a4d2004-12-16 21:44:03 +00002149 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002150 This command will write 12345678 to address 100 all 10 ms.
2151
wdenkefe2a4d2004-12-16 21:44:03 +00002152 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06002153 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00002154
Aneesh V401bb302011-07-13 05:11:07 +00002155- CONFIG_SPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002156 Set when the currently-running compilation is for an artifact
2157 that will end up in the SPL (as opposed to the TPL or U-Boot
2158 proper). Code that needs stage-specific behavior should check
2159 this.
wdenk400558b2005-04-02 23:52:25 +00002160
Ying Zhang3aa29de2013-08-16 15:16:15 +08002161- CONFIG_TPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002162 Set when the currently-running compilation is for an artifact
2163 that will end up in the TPL (as opposed to the SPL or U-Boot
2164 proper). Code that needs stage-specific behavior should check
2165 this.
Ying Zhang3aa29de2013-08-16 15:16:15 +08002166
Ying Zhang5df572f2013-05-20 14:07:23 +08002167- CONFIG_SYS_MPC85XX_NO_RESETVEC
2168 Only for 85xx systems. If this variable is specified, the section
2169 .resetvec is not kept and the section .bootpg is placed in the
2170 previous 4k of the .text section.
2171
Simon Glass4213fc22013-02-24 17:33:14 +00002172- CONFIG_ARCH_MAP_SYSMEM
2173 Generally U-Boot (and in particular the md command) uses
2174 effective address. It is therefore not necessary to regard
2175 U-Boot address as virtual addresses that need to be translated
2176 to physical addresses. However, sandbox requires this, since
2177 it maintains its own little RAM buffer which contains all
2178 addressable memory. This option causes some memory accesses
2179 to be mapped through map_sysmem() / unmap_sysmem().
2180
Simon Glass588a13f2013-02-14 04:18:54 +00002181- CONFIG_X86_RESET_VECTOR
2182 If defined, the x86 reset vector code is included. This is not
2183 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00002184
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04002185- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2186 Option to disable subpage write in NAND driver
2187 driver that uses this:
Miquel Raynala430fa02018-08-16 17:30:07 +02002188 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04002189
Timur Tabif2717b42011-11-22 09:21:25 -06002190Freescale QE/FMAN Firmware Support:
2191-----------------------------------
2192
2193The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2194loading of "firmware", which is encoded in the QE firmware binary format.
2195This firmware often needs to be loaded during U-Boot booting, so macros
2196are used to identify the storage device (NOR flash, SPI, etc) and the address
2197within that device.
2198
Zhao Qiangdcf1d772014-03-21 16:21:44 +08002199- CONFIG_SYS_FMAN_FW_ADDR
2200 The address in the storage device where the FMAN microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04002201 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiangdcf1d772014-03-21 16:21:44 +08002202 is also specified.
2203
2204- CONFIG_SYS_QE_FW_ADDR
2205 The address in the storage device where the QE microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04002206 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabif2717b42011-11-22 09:21:25 -06002207 is also specified.
2208
2209- CONFIG_SYS_QE_FMAN_FW_LENGTH
2210 The maximum possible size of the firmware. The firmware binary format
2211 has a field that specifies the actual size of the firmware, but it
2212 might not be possible to read any part of the firmware unless some
2213 local storage is allocated to hold the entire firmware first.
2214
2215- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2216 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2217 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2218 virtual address in NOR flash.
2219
2220- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2221 Specifies that QE/FMAN firmware is located in NAND flash.
2222 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2223
2224- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2225 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2226 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2227
Liu Gang292dc6c2012-03-08 00:33:18 +00002228- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2229 Specifies that QE/FMAN firmware is located in the remote (master)
2230 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00002231 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2232 window->master inbound window->master LAW->the ucode address in
2233 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06002234
J. German Riverab940ca62014-06-23 15:15:55 -07002235Freescale Layerscape Management Complex Firmware Support:
2236---------------------------------------------------------
2237The Freescale Layerscape Management Complex (MC) supports the loading of
2238"firmware".
2239This firmware often needs to be loaded during U-Boot booting, so macros
2240are used to identify the storage device (NOR flash, SPI, etc) and the address
2241within that device.
2242
2243- CONFIG_FSL_MC_ENET
2244 Enable the MC driver for Layerscape SoCs.
2245
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05302246Freescale Layerscape Debug Server Support:
2247-------------------------------------------
2248The Freescale Layerscape Debug Server Support supports the loading of
2249"Debug Server firmware" and triggering SP boot-rom.
2250This firmware often needs to be loaded during U-Boot booting.
2251
York Sunc0492142015-12-07 11:08:58 -08002252- CONFIG_SYS_MC_RSV_MEM_ALIGN
2253 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05302254
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02002255Reproducible builds
2256-------------------
2257
2258In order to achieve reproducible builds, timestamps used in the U-Boot build
2259process have to be set to a fixed value.
2260
2261This is done using the SOURCE_DATE_EPOCH environment variable.
2262SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2263option for U-Boot or an environment variable in U-Boot.
2264
2265SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2266
wdenkc6097192002-11-03 00:24:07 +00002267Building the Software:
2268======================
2269
Wolfgang Denk218ca722008-03-26 10:40:12 +01002270Building U-Boot has been tested in several native build environments
2271and in many different cross environments. Of course we cannot support
2272all possibly existing versions of cross development tools in all
2273(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayama047f6ec2020-10-08 13:17:16 +09002274recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denk218ca722008-03-26 10:40:12 +01002275which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002276
Wolfgang Denk218ca722008-03-26 10:40:12 +01002277If you are not using a native environment, it is assumed that you
2278have GNU cross compiling tools available in your path. In this case,
2279you must set the environment variable CROSS_COMPILE in your shell.
2280Note that no changes to the Makefile or any other source files are
2281necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002282
Wolfgang Denk218ca722008-03-26 10:40:12 +01002283 $ CROSS_COMPILE=ppc_4xx-
2284 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002285
Wolfgang Denk218ca722008-03-26 10:40:12 +01002286U-Boot is intended to be simple to build. After installing the
2287sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002288is done by typing:
2289
Holger Freytherab584d62014-08-04 09:26:05 +02002290 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00002291
Holger Freytherab584d62014-08-04 09:26:05 +02002292where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01002293rations; see configs/*_defconfig for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002294
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01002295Note: for some boards special configuration names may exist; check if
wdenk2729af92004-05-03 20:45:30 +00002296 additional information is available from the board vendor; for
2297 instance, the TQM823L systems are available without (standard)
2298 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002299 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002300
Holger Freytherab584d62014-08-04 09:26:05 +02002301 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00002302 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002303
Holger Freytherab584d62014-08-04 09:26:05 +02002304 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00002305 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002306
wdenk2729af92004-05-03 20:45:30 +00002307 etc.
wdenkc6097192002-11-03 00:24:07 +00002308
wdenkc6097192002-11-03 00:24:07 +00002309
wdenk2729af92004-05-03 20:45:30 +00002310Finally, type "make all", and you should get some working U-Boot
2311images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002312
wdenk2729af92004-05-03 20:45:30 +00002313- "u-boot.bin" is a raw binary image
2314- "u-boot" is an image in ELF binary format
2315- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002316
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002317By default the build is performed locally and the objects are saved
2318in the source directory. One of the two methods can be used to change
2319this behavior and build U-Boot to some external directory:
2320
23211. Add O= to the make command line invocations:
2322
2323 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02002324 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002325 make O=/tmp/build all
2326
Timo Ketolaadbba992014-11-06 14:39:05 +020023272. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002328
Timo Ketolaadbba992014-11-06 14:39:05 +02002329 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002330 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02002331 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002332 make all
2333
Timo Ketolaadbba992014-11-06 14:39:05 +02002334Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002335variable.
2336
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01002337User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2338setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2339For example to treat all compiler warnings as errors:
2340
2341 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00002342
wdenk2729af92004-05-03 20:45:30 +00002343Please be aware that the Makefiles assume you are using GNU make, so
2344for instance on NetBSD you might need to use "gmake" instead of
2345native "make".
wdenkc6097192002-11-03 00:24:07 +00002346
wdenkc6097192002-11-03 00:24:07 +00002347
wdenk2729af92004-05-03 20:45:30 +00002348If the system board that you have is not listed, then you will need
2349to port U-Boot to your hardware platform. To do this, follow these
2350steps:
wdenkc6097192002-11-03 00:24:07 +00002351
Phil Sutter3c1496c2015-12-25 14:41:18 +010023521. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00002353 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01002354 the "Makefile" and a "<board>.c".
23552. Create a new configuration file "include/configs/<board>.h" for
2356 your board.
wdenk2729af92004-05-03 20:45:30 +000023573. If you're porting U-Boot to a new CPU, then also create a new
2358 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020023594. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000023605. Type "make", and you should get a working "u-boot.srec" file
2361 to be installed on your target system.
23626. Debug and solve any problems that might arise.
2363 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002364
wdenkc6097192002-11-03 00:24:07 +00002365
wdenk2729af92004-05-03 20:45:30 +00002366Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2367==============================================================
wdenkc6097192002-11-03 00:24:07 +00002368
Wolfgang Denk218ca722008-03-26 10:40:12 +01002369If you have modified U-Boot sources (for instance added a new board
2370or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002371provide feedback to the other developers. The feedback normally takes
Thomas Hebb32f2ca22019-11-13 18:18:03 -08002372the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002373official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002374
Wolfgang Denk218ca722008-03-26 10:40:12 +01002375But before you submit such a patch, please verify that your modifi-
2376cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002377the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06002378just run the buildman script (tools/buildman/buildman), which will
2379configure and build U-Boot for ALL supported system. Be warned, this
2380will take a while. Please see the buildman README, or run 'buildman -H'
2381for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002382
2383
wdenk2729af92004-05-03 20:45:30 +00002384See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002385
wdenkc6097192002-11-03 00:24:07 +00002386
wdenk2729af92004-05-03 20:45:30 +00002387Monitor Commands - Overview:
2388============================
wdenkc6097192002-11-03 00:24:07 +00002389
wdenk2729af92004-05-03 20:45:30 +00002390go - start application at address 'addr'
2391run - run commands in an environment variable
2392bootm - boot application image from memory
2393bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00002394bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00002395tftpboot- boot image via network using TFTP protocol
2396 and env variables "ipaddr" and "serverip"
2397 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00002398tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00002399rarpboot- boot image via network using RARP/TFTP protocol
2400diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2401loads - load S-Record file over serial line
2402loadb - load binary file over serial line (kermit mode)
Rui Miguel Silvabfef72e2022-05-11 10:55:40 +01002403loadm - load binary blob from source address to destination address
wdenk2729af92004-05-03 20:45:30 +00002404md - memory display
2405mm - memory modify (auto-incrementing)
2406nm - memory modify (constant address)
2407mw - memory write (fill)
Simon Glassbdded202020-06-02 19:26:49 -06002408ms - memory search
wdenk2729af92004-05-03 20:45:30 +00002409cp - memory copy
2410cmp - memory compare
2411crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05002412i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00002413sspi - SPI utility commands
2414base - print or set address offset
2415printenv- print environment variables
Pragnesh Patel9e9a5302020-12-22 11:30:05 +05302416pwm - control pwm channels
wdenk2729af92004-05-03 20:45:30 +00002417setenv - set environment variables
2418saveenv - save environment variables to persistent storage
2419protect - enable or disable FLASH write protection
2420erase - erase FLASH memory
2421flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00002422nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00002423bdinfo - print Board Info structure
2424iminfo - print header information for application image
2425coninfo - print console devices and informations
2426ide - IDE sub-system
2427loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002428loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002429mtest - simple RAM test
2430icache - enable or disable instruction cache
2431dcache - enable or disable data cache
2432reset - Perform RESET of the CPU
2433echo - echo args to console
2434version - print monitor version
2435help - print online help
2436? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002437
wdenkc6097192002-11-03 00:24:07 +00002438
wdenk2729af92004-05-03 20:45:30 +00002439Monitor Commands - Detailed Description:
2440========================================
wdenkc6097192002-11-03 00:24:07 +00002441
wdenk2729af92004-05-03 20:45:30 +00002442TODO.
wdenkc6097192002-11-03 00:24:07 +00002443
wdenk2729af92004-05-03 20:45:30 +00002444For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002445
2446
wdenk2729af92004-05-03 20:45:30 +00002447Note for Redundant Ethernet Interfaces:
2448=======================================
wdenkf07771c2003-05-28 08:06:31 +00002449
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002450Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00002451such configurations and is capable of automatic selection of a
2452"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002453
wdenk2729af92004-05-03 20:45:30 +00002454Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2455MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2456"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002457
wdenk2729af92004-05-03 20:45:30 +00002458If the network interface stores some valid MAC address (for instance
2459in SROM), this is used as default address if there is NO correspon-
2460ding setting in the environment; if the corresponding environment
2461variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002462
wdenk2729af92004-05-03 20:45:30 +00002463o If the SROM has a valid MAC address, and there is no address in the
2464 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002465
wdenk2729af92004-05-03 20:45:30 +00002466o If there is no valid address in the SROM, and a definition in the
2467 environment exists, then the value from the environment variable is
2468 used.
wdenkc6097192002-11-03 00:24:07 +00002469
wdenk2729af92004-05-03 20:45:30 +00002470o If both the SROM and the environment contain a MAC address, and
2471 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002472
wdenk2729af92004-05-03 20:45:30 +00002473o If both the SROM and the environment contain a MAC address, and the
2474 addresses differ, the value from the environment is used and a
2475 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002476
wdenk2729af92004-05-03 20:45:30 +00002477o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05002478 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2479 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00002480
Ben Warrenecee9322010-04-26 11:11:46 -07002481If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002482will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07002483may be skipped by setting the appropriate 'ethmacskip' environment variable.
2484The naming convention is as follows:
2485"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00002486
wdenk2729af92004-05-03 20:45:30 +00002487Image Formats:
2488==============
wdenkc6097192002-11-03 00:24:07 +00002489
Marian Balakowicz3310c542008-03-12 12:13:13 +01002490U-Boot is capable of booting (and performing other auxiliary operations on)
2491images in two formats:
2492
2493New uImage format (FIT)
2494-----------------------
2495
2496Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2497to Flattened Device Tree). It allows the use of images with multiple
2498components (several kernels, ramdisks, etc.), with contents protected by
2499SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2500
2501
2502Old uImage format
2503-----------------
2504
2505Old image format is based on binary files which can be basically anything,
2506preceded by a special header; see the definitions in include/image.h for
2507details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002508
wdenk2729af92004-05-03 20:45:30 +00002509* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2510 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05002511 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
Thomas Huth0797e732021-11-13 18:13:50 +01002512 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03002513* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Tom Rini11232132022-04-06 09:21:25 -04002514 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2515 Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00002516* Compression Type (uncompressed, gzip, bzip2)
2517* Load Address
2518* Entry Point
2519* Image Name
2520* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002521
wdenk2729af92004-05-03 20:45:30 +00002522The header is marked by a special Magic Number, and both the header
2523and the data portions of the image are secured against corruption by
2524CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002525
wdenkc6097192002-11-03 00:24:07 +00002526
wdenk2729af92004-05-03 20:45:30 +00002527Linux Support:
2528==============
wdenkc6097192002-11-03 00:24:07 +00002529
wdenk2729af92004-05-03 20:45:30 +00002530Although U-Boot should support any OS or standalone application
2531easily, the main focus has always been on Linux during the design of
2532U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002533
wdenk2729af92004-05-03 20:45:30 +00002534U-Boot includes many features that so far have been part of some
2535special "boot loader" code within the Linux kernel. Also, any
2536"initrd" images to be used are no longer part of one big Linux image;
2537instead, kernel and "initrd" are separate images. This implementation
2538serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002539
wdenk2729af92004-05-03 20:45:30 +00002540- the same features can be used for other OS or standalone
2541 applications (for instance: using compressed images to reduce the
2542 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002543
wdenk2729af92004-05-03 20:45:30 +00002544- it becomes much easier to port new Linux kernel versions because
2545 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002546
wdenk2729af92004-05-03 20:45:30 +00002547- the same Linux kernel image can now be used with different "initrd"
2548 images; of course this also means that different kernel images can
2549 be run with the same "initrd". This makes testing easier (you don't
2550 have to build a new "zImage.initrd" Linux image when you just
2551 change a file in your "initrd"). Also, a field-upgrade of the
2552 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002553
wdenkc6097192002-11-03 00:24:07 +00002554
wdenk2729af92004-05-03 20:45:30 +00002555Linux HOWTO:
2556============
wdenkc6097192002-11-03 00:24:07 +00002557
wdenk2729af92004-05-03 20:45:30 +00002558Porting Linux to U-Boot based systems:
2559---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002560
wdenk2729af92004-05-03 20:45:30 +00002561U-Boot cannot save you from doing all the necessary modifications to
2562configure the Linux device drivers for use with your target hardware
2563(no, we don't intend to provide a full virtual machine interface to
2564Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002565
Stefan Roesea47a12b2010-04-15 16:07:28 +02002566But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002567
wdenk2729af92004-05-03 20:45:30 +00002568Just make sure your machine specific header file (for instance
2569include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02002570Information structure as we define in include/asm-<arch>/u-boot.h,
2571and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002572as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002573
Simon Glass2eb31b12014-06-11 23:29:46 -06002574Note that U-Boot now has a driver model, a unified model for drivers.
2575If you are adding a new driver, plumb it into driver model. If there
2576is no uclass available, you are encouraged to create one. See
2577doc/driver-model.
2578
wdenkc6097192002-11-03 00:24:07 +00002579
wdenk2729af92004-05-03 20:45:30 +00002580Configuring the Linux kernel:
2581-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002582
wdenk2729af92004-05-03 20:45:30 +00002583No specific requirements for U-Boot. Make sure you have some root
2584device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002585
wdenkc6097192002-11-03 00:24:07 +00002586
wdenk2729af92004-05-03 20:45:30 +00002587Building a Linux Image:
2588-----------------------
wdenkc6097192002-11-03 00:24:07 +00002589
wdenk2729af92004-05-03 20:45:30 +00002590With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2591not used. If you use recent kernel source, a new build target
2592"uImage" will exist which automatically builds an image usable by
2593U-Boot. Most older kernels also have support for a "pImage" target,
2594which was introduced for our predecessor project PPCBoot and uses a
2595100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002596
wdenk2729af92004-05-03 20:45:30 +00002597Example:
wdenkc6097192002-11-03 00:24:07 +00002598
Holger Freytherab584d62014-08-04 09:26:05 +02002599 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00002600 make oldconfig
2601 make dep
2602 make uImage
wdenkc6097192002-11-03 00:24:07 +00002603
wdenk2729af92004-05-03 20:45:30 +00002604The "uImage" build target uses a special tool (in 'tools/mkimage') to
2605encapsulate a compressed Linux kernel image with header information,
2606CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002607
wdenk2729af92004-05-03 20:45:30 +00002608* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002609
wdenk2729af92004-05-03 20:45:30 +00002610* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002611
wdenk2729af92004-05-03 20:45:30 +00002612 ${CROSS_COMPILE}-objcopy -O binary \
2613 -R .note -R .comment \
2614 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002615
wdenk2729af92004-05-03 20:45:30 +00002616* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002617
wdenk2729af92004-05-03 20:45:30 +00002618 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002619
wdenk2729af92004-05-03 20:45:30 +00002620* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002621
wdenk2729af92004-05-03 20:45:30 +00002622 mkimage -A ppc -O linux -T kernel -C gzip \
2623 -a 0 -e 0 -n "Linux Kernel Image" \
2624 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002625
wdenk24ee89b2002-11-03 17:56:27 +00002626
wdenk2729af92004-05-03 20:45:30 +00002627The "mkimage" tool can also be used to create ramdisk images for use
2628with U-Boot, either separated from the Linux kernel image, or
2629combined into one file. "mkimage" encapsulates the images with a 64
2630byte header containing information about target architecture,
2631operating system, image type, compression method, entry points, time
2632stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002633
wdenk2729af92004-05-03 20:45:30 +00002634"mkimage" can be called in two ways: to verify existing images and
2635print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002636
wdenk2729af92004-05-03 20:45:30 +00002637In the first form (with "-l" option) mkimage lists the information
2638contained in the header of an existing U-Boot image; this includes
2639checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002640
wdenk2729af92004-05-03 20:45:30 +00002641 tools/mkimage -l image
2642 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002643
wdenk2729af92004-05-03 20:45:30 +00002644The second form (with "-d" option) is used to build a U-Boot image
2645from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002646
wdenk2729af92004-05-03 20:45:30 +00002647 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2648 -n name -d data_file image
2649 -A ==> set architecture to 'arch'
2650 -O ==> set operating system to 'os'
2651 -T ==> set image type to 'type'
2652 -C ==> set compression type 'comp'
2653 -a ==> set load address to 'addr' (hex)
2654 -e ==> set entry point to 'ep' (hex)
2655 -n ==> set image name to 'name'
2656 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002657
wdenk69459792004-05-29 16:53:29 +00002658Right now, all Linux kernels for PowerPC systems use the same load
2659address (0x00000000), but the entry point address depends on the
2660kernel version:
wdenkc6097192002-11-03 00:24:07 +00002661
wdenk2729af92004-05-03 20:45:30 +00002662- 2.2.x kernels have the entry point at 0x0000000C,
2663- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk2729af92004-05-03 20:45:30 +00002665So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002666
wdenk2729af92004-05-03 20:45:30 +00002667 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2668 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02002669 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00002670 > examples/uImage.TQM850L
2671 Image Name: 2.4.4 kernel for TQM850L
2672 Created: Wed Jul 19 02:34:59 2000
2673 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2674 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2675 Load Address: 0x00000000
2676 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002677
wdenk2729af92004-05-03 20:45:30 +00002678To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002679
wdenk2729af92004-05-03 20:45:30 +00002680 -> tools/mkimage -l examples/uImage.TQM850L
2681 Image Name: 2.4.4 kernel for TQM850L
2682 Created: Wed Jul 19 02:34:59 2000
2683 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2684 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2685 Load Address: 0x00000000
2686 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002687
wdenk2729af92004-05-03 20:45:30 +00002688NOTE: for embedded systems where boot time is critical you can trade
2689speed for memory and install an UNCOMPRESSED image instead: this
2690needs more space in Flash, but boots much faster since it does not
2691need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002692
Stefan Roesea47a12b2010-04-15 16:07:28 +02002693 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00002694 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2695 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02002696 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00002697 > examples/uImage.TQM850L-uncompressed
2698 Image Name: 2.4.4 kernel for TQM850L
2699 Created: Wed Jul 19 02:34:59 2000
2700 Image Type: PowerPC Linux Kernel Image (uncompressed)
2701 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2702 Load Address: 0x00000000
2703 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002704
wdenkc6097192002-11-03 00:24:07 +00002705
wdenk2729af92004-05-03 20:45:30 +00002706Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2707when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002708
wdenk2729af92004-05-03 20:45:30 +00002709 -> tools/mkimage -n 'Simple Ramdisk Image' \
2710 > -A ppc -O linux -T ramdisk -C gzip \
2711 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2712 Image Name: Simple Ramdisk Image
2713 Created: Wed Jan 12 14:01:50 2000
2714 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2715 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2716 Load Address: 0x00000000
2717 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002718
Tyler Hickse157a112020-10-26 10:40:24 -05002719The "dumpimage" tool can be used to disassemble or list the contents of images
2720built by mkimage. See dumpimage's help output (-h) for details.
wdenkdb01a2e2004-04-15 23:14:49 +00002721
wdenk2729af92004-05-03 20:45:30 +00002722Installing a Linux Image:
2723-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002724
wdenk2729af92004-05-03 20:45:30 +00002725To downloading a U-Boot image over the serial (console) interface,
2726you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002727
wdenk2729af92004-05-03 20:45:30 +00002728 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002729
wdenk2729af92004-05-03 20:45:30 +00002730The 'objcopy' does not understand the information in the U-Boot
2731image header, so the resulting S-Record file will be relative to
2732address 0x00000000. To load it to a given address, you need to
2733specify the target address as 'offset' parameter with the 'loads'
2734command.
wdenkc6097192002-11-03 00:24:07 +00002735
wdenk2729af92004-05-03 20:45:30 +00002736Example: install the image to address 0x40100000 (which on the
2737TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002738
wdenk2729af92004-05-03 20:45:30 +00002739 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002740
wdenk2729af92004-05-03 20:45:30 +00002741 .......... done
2742 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002743
wdenk2729af92004-05-03 20:45:30 +00002744 => loads 40100000
2745 ## Ready for S-Record download ...
2746 ~>examples/image.srec
2747 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2748 ...
2749 15989 15990 15991 15992
2750 [file transfer complete]
2751 [connected]
2752 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002753
2754
wdenk2729af92004-05-03 20:45:30 +00002755You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01002756this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00002757corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002758
wdenk2729af92004-05-03 20:45:30 +00002759 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002760
wdenk2729af92004-05-03 20:45:30 +00002761 ## Checking Image at 40100000 ...
2762 Image Name: 2.2.13 for initrd on TQM850L
2763 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2764 Data Size: 335725 Bytes = 327 kB = 0 MB
2765 Load Address: 00000000
2766 Entry Point: 0000000c
2767 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002768
2769
wdenk2729af92004-05-03 20:45:30 +00002770Boot Linux:
2771-----------
wdenkc6097192002-11-03 00:24:07 +00002772
wdenk2729af92004-05-03 20:45:30 +00002773The "bootm" command is used to boot an application that is stored in
2774memory (RAM or Flash). In case of a Linux kernel image, the contents
2775of the "bootargs" environment variable is passed to the kernel as
2776parameters. You can check and modify this variable using the
2777"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002778
2779
wdenk2729af92004-05-03 20:45:30 +00002780 => printenv bootargs
2781 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002782
wdenk2729af92004-05-03 20:45:30 +00002783 => 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 +00002784
wdenk2729af92004-05-03 20:45:30 +00002785 => printenv bootargs
2786 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 +00002787
wdenk2729af92004-05-03 20:45:30 +00002788 => bootm 40020000
2789 ## Booting Linux kernel at 40020000 ...
2790 Image Name: 2.2.13 for NFS on TQM850L
2791 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2792 Data Size: 381681 Bytes = 372 kB = 0 MB
2793 Load Address: 00000000
2794 Entry Point: 0000000c
2795 Verifying Checksum ... OK
2796 Uncompressing Kernel Image ... OK
2797 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
2798 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2799 time_init: decrementer frequency = 187500000/60
2800 Calibrating delay loop... 49.77 BogoMIPS
2801 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2802 ...
wdenkc6097192002-11-03 00:24:07 +00002803
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002804If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00002805the memory addresses of both the kernel and the initrd image (PPBCOOT
2806format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00002807
wdenk2729af92004-05-03 20:45:30 +00002808 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00002809
wdenk2729af92004-05-03 20:45:30 +00002810 ## Checking Image at 40100000 ...
2811 Image Name: 2.2.13 for initrd on TQM850L
2812 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2813 Data Size: 335725 Bytes = 327 kB = 0 MB
2814 Load Address: 00000000
2815 Entry Point: 0000000c
2816 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002817
wdenk2729af92004-05-03 20:45:30 +00002818 ## Checking Image at 40200000 ...
2819 Image Name: Simple Ramdisk Image
2820 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2821 Data Size: 566530 Bytes = 553 kB = 0 MB
2822 Load Address: 00000000
2823 Entry Point: 00000000
2824 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002825
wdenk2729af92004-05-03 20:45:30 +00002826 => bootm 40100000 40200000
2827 ## Booting Linux kernel at 40100000 ...
2828 Image Name: 2.2.13 for initrd on TQM850L
2829 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2830 Data Size: 335725 Bytes = 327 kB = 0 MB
2831 Load Address: 00000000
2832 Entry Point: 0000000c
2833 Verifying Checksum ... OK
2834 Uncompressing Kernel Image ... OK
2835 ## Loading RAMDisk Image at 40200000 ...
2836 Image Name: Simple Ramdisk Image
2837 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2838 Data Size: 566530 Bytes = 553 kB = 0 MB
2839 Load Address: 00000000
2840 Entry Point: 00000000
2841 Verifying Checksum ... OK
2842 Loading Ramdisk ... OK
2843 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
2844 Boot arguments: root=/dev/ram
2845 time_init: decrementer frequency = 187500000/60
2846 Calibrating delay loop... 49.77 BogoMIPS
2847 ...
2848 RAMDISK: Compressed image found at block 0
2849 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00002850
wdenk2729af92004-05-03 20:45:30 +00002851 bash#
wdenkc6097192002-11-03 00:24:07 +00002852
Matthew McClintock02677682006-06-28 10:41:37 -05002853Boot Linux and pass a flat device tree:
2854-----------
2855
2856First, U-Boot must be compiled with the appropriate defines. See the section
2857titled "Linux Kernel Interface" above for a more in depth explanation. The
2858following is an example of how to start a kernel and pass an updated
2859flat device tree:
2860
2861=> print oftaddr
2862oftaddr=0x300000
2863=> print oft
2864oft=oftrees/mpc8540ads.dtb
2865=> tftp $oftaddr $oft
2866Speed: 1000, full duplex
2867Using TSEC0 device
2868TFTP from server 192.168.1.1; our IP address is 192.168.1.101
2869Filename 'oftrees/mpc8540ads.dtb'.
2870Load address: 0x300000
2871Loading: #
2872done
2873Bytes transferred = 4106 (100a hex)
2874=> tftp $loadaddr $bootfile
2875Speed: 1000, full duplex
2876Using TSEC0 device
2877TFTP from server 192.168.1.1; our IP address is 192.168.1.2
2878Filename 'uImage'.
2879Load address: 0x200000
2880Loading:############
2881done
2882Bytes transferred = 1029407 (fb51f hex)
2883=> print loadaddr
2884loadaddr=200000
2885=> print oftaddr
2886oftaddr=0x300000
2887=> bootm $loadaddr - $oftaddr
2888## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01002889 Image Name: Linux-2.6.17-dirty
2890 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2891 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05002892 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01002893 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05002894 Verifying Checksum ... OK
2895 Uncompressing Kernel Image ... OK
2896Booting using flat device tree at 0x300000
2897Using MPC85xx ADS machine description
2898Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
2899[snip]
2900
2901
wdenk2729af92004-05-03 20:45:30 +00002902More About U-Boot Image Types:
2903------------------------------
wdenk6069ff22003-02-28 00:49:47 +00002904
wdenk2729af92004-05-03 20:45:30 +00002905U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00002906
wdenk2729af92004-05-03 20:45:30 +00002907 "Standalone Programs" are directly runnable in the environment
2908 provided by U-Boot; it is expected that (if they behave
2909 well) you can continue to work in U-Boot after return from
2910 the Standalone Program.
2911 "OS Kernel Images" are usually images of some Embedded OS which
2912 will take over control completely. Usually these programs
2913 will install their own set of exception handlers, device
2914 drivers, set up the MMU, etc. - this means, that you cannot
2915 expect to re-enter U-Boot except by resetting the CPU.
2916 "RAMDisk Images" are more or less just data blocks, and their
2917 parameters (address, size) are passed to an OS kernel that is
2918 being started.
2919 "Multi-File Images" contain several images, typically an OS
2920 (Linux) kernel image and one or more data images like
2921 RAMDisks. This construct is useful for instance when you want
2922 to boot over the network using BOOTP etc., where the boot
2923 server provides just a single image file, but you want to get
2924 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00002925
wdenk2729af92004-05-03 20:45:30 +00002926 "Multi-File Images" start with a list of image sizes, each
2927 image size (in bytes) specified by an "uint32_t" in network
2928 byte order. This list is terminated by an "(uint32_t)0".
2929 Immediately after the terminating 0 follow the images, one by
2930 one, all aligned on "uint32_t" boundaries (size rounded up to
2931 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00002932
wdenk2729af92004-05-03 20:45:30 +00002933 "Firmware Images" are binary images containing firmware (like
2934 U-Boot or FPGA images) which usually will be programmed to
2935 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00002936
wdenk2729af92004-05-03 20:45:30 +00002937 "Script files" are command sequences that will be executed by
2938 U-Boot's command interpreter; this feature is especially
2939 useful when you configure U-Boot to use a real shell (hush)
2940 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00002941
Marek Vasut44f074c2012-03-14 21:52:45 +00002942Booting the Linux zImage:
2943-------------------------
2944
2945On some platforms, it's possible to boot Linux zImage. This is done
2946using the "bootz" command. The syntax of "bootz" command is the same
2947as the syntax of "bootm" command.
2948
Tom Rini8ac28562013-05-16 11:40:11 -04002949Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00002950kernel with raw initrd images. The syntax is slightly different, the
2951address of the initrd must be augmented by it's size, in the following
2952format: "<initrd addres>:<initrd size>".
2953
wdenkc6097192002-11-03 00:24:07 +00002954
wdenk2729af92004-05-03 20:45:30 +00002955Standalone HOWTO:
2956=================
wdenkc6097192002-11-03 00:24:07 +00002957
wdenk2729af92004-05-03 20:45:30 +00002958One of the features of U-Boot is that you can dynamically load and
2959run "standalone" applications, which can use some resources of
2960U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00002961
wdenk2729af92004-05-03 20:45:30 +00002962Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00002963
wdenk2729af92004-05-03 20:45:30 +00002964"Hello World" Demo:
2965-------------------
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk2729af92004-05-03 20:45:30 +00002967'examples/hello_world.c' contains a small "Hello World" Demo
2968application; it is automatically compiled when you build U-Boot.
2969It's configured to run at address 0x00040004, so you can play with it
2970like that:
wdenkc6097192002-11-03 00:24:07 +00002971
wdenk2729af92004-05-03 20:45:30 +00002972 => loads
2973 ## Ready for S-Record download ...
2974 ~>examples/hello_world.srec
2975 1 2 3 4 5 6 7 8 9 10 11 ...
2976 [file transfer complete]
2977 [connected]
2978 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002979
wdenk2729af92004-05-03 20:45:30 +00002980 => go 40004 Hello World! This is a test.
2981 ## Starting application at 0x00040004 ...
2982 Hello World
2983 argc = 7
2984 argv[0] = "40004"
2985 argv[1] = "Hello"
2986 argv[2] = "World!"
2987 argv[3] = "This"
2988 argv[4] = "is"
2989 argv[5] = "a"
2990 argv[6] = "test."
2991 argv[7] = "<NULL>"
2992 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00002993
wdenk2729af92004-05-03 20:45:30 +00002994 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00002995
wdenk2729af92004-05-03 20:45:30 +00002996Another example, which demonstrates how to register a CPM interrupt
2997handler with the U-Boot code, can be found in 'examples/timer.c'.
2998Here, a CPM timer is set up to generate an interrupt every second.
2999The interrupt service routine is trivial, just printing a '.'
3000character, but this is just a demo program. The application can be
3001controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003002
wdenk2729af92004-05-03 20:45:30 +00003003 ? - print current values og the CPM Timer registers
3004 b - enable interrupts and start timer
3005 e - stop timer and disable interrupts
3006 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003007
wdenk2729af92004-05-03 20:45:30 +00003008 => loads
3009 ## Ready for S-Record download ...
3010 ~>examples/timer.srec
3011 1 2 3 4 5 6 7 8 9 10 11 ...
3012 [file transfer complete]
3013 [connected]
3014 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003015
wdenk2729af92004-05-03 20:45:30 +00003016 => go 40004
3017 ## Starting application at 0x00040004 ...
3018 TIMERS=0xfff00980
3019 Using timer 1
3020 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003021
wdenk2729af92004-05-03 20:45:30 +00003022Hit 'b':
3023 [q, b, e, ?] Set interval 1000000 us
3024 Enabling timer
3025Hit '?':
3026 [q, b, e, ?] ........
3027 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3028Hit '?':
3029 [q, b, e, ?] .
3030 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3031Hit '?':
3032 [q, b, e, ?] .
3033 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3034Hit '?':
3035 [q, b, e, ?] .
3036 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3037Hit 'e':
3038 [q, b, e, ?] ...Stopping timer
3039Hit 'q':
3040 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003041
3042
wdenk2729af92004-05-03 20:45:30 +00003043Minicom warning:
3044================
wdenk85ec0bc2003-03-31 16:34:49 +00003045
wdenk2729af92004-05-03 20:45:30 +00003046Over time, many people have reported problems when trying to use the
3047"minicom" terminal emulation program for serial download. I (wd)
3048consider minicom to be broken, and recommend not to use it. Under
3049Unix, I recommend to use C-Kermit for general purpose use (and
3050especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00003051use "cu" for S-Record download ("loads" command). See
Naoki Hayama047f6ec2020-10-08 13:17:16 +09003052https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
Karl O. Pince53515a2012-10-01 05:11:56 +00003053for help with kermit.
3054
wdenk85ec0bc2003-03-31 16:34:49 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056Nevertheless, if you absolutely want to use it try adding this
3057configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003058
wdenk2729af92004-05-03 20:45:30 +00003059 Name Program Name U/D FullScr IO-Red. Multi
3060 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3061 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003062
3063
wdenk2729af92004-05-03 20:45:30 +00003064NetBSD Notes:
3065=============
wdenkc6097192002-11-03 00:24:07 +00003066
wdenk2729af92004-05-03 20:45:30 +00003067Starting at version 0.9.2, U-Boot supports NetBSD both as host
3068(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003069
wdenk2729af92004-05-03 20:45:30 +00003070Building requires a cross environment; it is known to work on
3071NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3072need gmake since the Makefiles are not compatible with BSD make).
3073Note that the cross-powerpc package does not install include files;
3074attempting to build U-Boot will fail because <machine/ansi.h> is
3075missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003076
wdenk2729af92004-05-03 20:45:30 +00003077 # cd /usr/pkg/cross/powerpc-netbsd/include
3078 # mkdir powerpc
3079 # ln -s powerpc machine
3080 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3081 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003082
wdenk2729af92004-05-03 20:45:30 +00003083Native builds *don't* work due to incompatibilities between native
3084and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003085
wdenk2729af92004-05-03 20:45:30 +00003086Booting assumes that (the first part of) the image booted is a
3087stage-2 loader which in turn loads and then invokes the kernel
3088proper. Loader sources will eventually appear in the NetBSD source
3089tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003090meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003091
3092
wdenk2729af92004-05-03 20:45:30 +00003093Implementation Internals:
3094=========================
wdenkc6097192002-11-03 00:24:07 +00003095
wdenk2729af92004-05-03 20:45:30 +00003096The following is not intended to be a complete description of every
3097implementation detail. However, it should help to understand the
3098inner workings of U-Boot and make it easier to port it to custom
3099hardware.
wdenkc6097192002-11-03 00:24:07 +00003100
3101
wdenk2729af92004-05-03 20:45:30 +00003102Initial Stack, Global Data:
3103---------------------------
wdenkc6097192002-11-03 00:24:07 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105The implementation of U-Boot is complicated by the fact that U-Boot
3106starts running out of ROM (flash memory), usually without access to
3107system RAM (because the memory controller is not initialized yet).
3108This means that we don't have writable Data or BSS segments, and BSS
3109is not initialized as zero. To be able to get a C environment working
3110at all, we have to allocate at least a minimal stack. Implementation
3111options for this are defined and restricted by the CPU used: Some CPU
3112models provide on-chip memory (like the IMMR area on MPC8xx and
3113MPC826x processors), on others (parts of) the data cache can be
3114locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003115
Wolfgang Denk218ca722008-03-26 10:40:12 +01003116 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003117 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003118
wdenk2729af92004-05-03 20:45:30 +00003119 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3120 From: "Chris Hallinan" <clh@net1plus.com>
3121 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3122 ...
wdenk43d96162003-03-06 00:02:04 +00003123
wdenk2729af92004-05-03 20:45:30 +00003124 Correct me if I'm wrong, folks, but the way I understand it
3125 is this: Using DCACHE as initial RAM for Stack, etc, does not
3126 require any physical RAM backing up the cache. The cleverness
3127 is that the cache is being used as a temporary supply of
3128 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003129 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003130 can see how this works by studying the cache architecture and
3131 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003132
wdenk2729af92004-05-03 20:45:30 +00003133 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3134 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003135 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003136 option should work for you. Using CS 4 should be fine if your
3137 board designers haven't used it for something that would
3138 cause you grief during the initial boot! It is frequently not
3139 used.
wdenk43d96162003-03-06 00:02:04 +00003140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003141 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003142 with your processor/board/system design. The default value
3143 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003144 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003145 than your SDRAM module. If you have a 64MB SDRAM module, set
3146 it above 400_0000. Just make sure your board has no resources
3147 that are supposed to respond to that address! That code in
3148 start.S has been around a while and should work as is when
3149 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003150
wdenk2729af92004-05-03 20:45:30 +00003151 -Chris Hallinan
3152 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003153
wdenk2729af92004-05-03 20:45:30 +00003154It is essential to remember this, since it has some impact on the C
3155code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk2729af92004-05-03 20:45:30 +00003157* Initialized global data (data segment) is read-only. Do not attempt
3158 to write it.
wdenkc6097192002-11-03 00:24:07 +00003159
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003160* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00003161 as zero data - BSS segment) at all - this is undefined, initiali-
3162 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003163
wdenk2729af92004-05-03 20:45:30 +00003164* Stack space is very limited. Avoid big data buffers or things like
3165 that.
wdenkc6097192002-11-03 00:24:07 +00003166
wdenk2729af92004-05-03 20:45:30 +00003167Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003168normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00003169turned out that the implementation of U-Boot can be greatly
3170simplified by making a global data structure (gd_t) available to all
3171functions. We could pass a pointer to this data as argument to _all_
3172functions, but this would bloat the code. Instead we use a feature of
3173the GCC compiler (Global Register Variables) to share the data: we
3174place a pointer (gd) to the global data into a register which we
3175reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003176
wdenk2729af92004-05-03 20:45:30 +00003177When choosing a register for such a purpose we are restricted by the
3178relevant (E)ABI specifications for the current architecture, and by
3179GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003180
wdenk2729af92004-05-03 20:45:30 +00003181For PowerPC, the following registers have specific use:
3182 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003183 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003184 R3-R4: parameter passing and return values
3185 R5-R10: parameter passing
3186 R13: small data area pointer
3187 R30: GOT pointer
3188 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003189
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01003190 (U-Boot also uses R12 as internal GOT pointer. r12
3191 is a volatile register so r12 needs to be reset when
3192 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00003193
Wolfgang Denke7670f62008-02-14 22:43:22 +01003194 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196 Note: on PPC, we could use a static initializer (since the
3197 address of the global data structure is known at compile time),
3198 but it turned out that reserving a register results in somewhat
3199 smaller code - although the code savings are not that big (on
3200 average for all boards 752 bytes for the whole U-Boot image,
3201 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003202
wdenk2729af92004-05-03 20:45:30 +00003203On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205 R0: function argument word/integer result
3206 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02003207 R9: platform specific
3208 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00003209 R11: argument (frame) pointer
3210 R12: temporary workspace
3211 R13: stack pointer
3212 R14: link register
3213 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003214
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02003215 ==> U-Boot will use R9 to hold a pointer to the global data
3216
3217 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00003218
Thomas Chou0df01fd2010-05-21 11:08:03 +08003219On Nios II, the ABI is documented here:
Naoki Hayama047f6ec2020-10-08 13:17:16 +09003220 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
Thomas Chou0df01fd2010-05-21 11:08:03 +08003221
3222 ==> U-Boot will use gp to hold a pointer to the global data
3223
3224 Note: on Nios II, we give "-G0" option to gcc and don't use gp
3225 to access small data sections, so gp is free.
3226
Rick Chen3fafced2017-12-26 13:55:59 +08003227On RISC-V, the following registers are used:
3228
3229 x0: hard-wired zero (zero)
3230 x1: return address (ra)
3231 x2: stack pointer (sp)
3232 x3: global pointer (gp)
3233 x4: thread pointer (tp)
3234 x5: link register (t0)
3235 x8: frame pointer (fp)
3236 x10-x11: arguments/return values (a0-1)
3237 x12-x17: arguments (a2-7)
3238 x28-31: temporaries (t3-6)
3239 pc: program counter (pc)
3240
3241 ==> U-Boot will use gp to hold a pointer to the global data
3242
wdenk2729af92004-05-03 20:45:30 +00003243Memory Management:
3244------------------
wdenkc6097192002-11-03 00:24:07 +00003245
wdenk2729af92004-05-03 20:45:30 +00003246U-Boot runs in system state and uses physical addresses, i.e. the
3247MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003248
wdenk2729af92004-05-03 20:45:30 +00003249The available memory is mapped to fixed addresses using the memory
3250controller. In this process, a contiguous block is formed for each
3251memory type (Flash, SDRAM, SRAM), even when it consists of several
3252physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk2729af92004-05-03 20:45:30 +00003254U-Boot is installed in the first 128 kB of the first Flash bank (on
3255TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3256booting and sizing and initializing DRAM, the code relocates itself
3257to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003258memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00003259configuration setting]. Below that, a structure with global Board
3260Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk2729af92004-05-03 20:45:30 +00003262Additionally, some exception handler code is copied to the low 8 kB
3263of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003264
wdenk2729af92004-05-03 20:45:30 +00003265So a typical memory configuration with 16 MB of DRAM could look like
3266this:
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk2729af92004-05-03 20:45:30 +00003268 0x0000 0000 Exception Vector code
3269 :
3270 0x0000 1FFF
3271 0x0000 2000 Free for Application Use
3272 :
3273 :
wdenkc6097192002-11-03 00:24:07 +00003274
wdenk2729af92004-05-03 20:45:30 +00003275 :
3276 :
3277 0x00FB FF20 Monitor Stack (Growing downward)
3278 0x00FB FFAC Board Info Data and permanent copy of global data
3279 0x00FC 0000 Malloc Arena
3280 :
3281 0x00FD FFFF
3282 0x00FE 0000 RAM Copy of Monitor Code
3283 ... eventually: LCD or video framebuffer
3284 ... eventually: pRAM (Protected RAM - unchanged by reset)
3285 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003286
3287
wdenk2729af92004-05-03 20:45:30 +00003288System Initialization:
3289----------------------
wdenkc6097192002-11-03 00:24:07 +00003290
wdenk2729af92004-05-03 20:45:30 +00003291In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003292(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003293configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00003294To be able to re-map memory U-Boot then jumps to its link address.
3295To be able to implement the initialization code in C, a (small!)
3296initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02003297which provide such a feature like), or in a locked part of the data
3298cache. After that, U-Boot initializes the CPU core, the caches and
3299the SIU.
wdenkc6097192002-11-03 00:24:07 +00003300
wdenk2729af92004-05-03 20:45:30 +00003301Next, all (potentially) available memory banks are mapped using a
3302preliminary mapping. For example, we put them on 512 MB boundaries
3303(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3304on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3305programmed for SDRAM access. Using the temporary configuration, a
3306simple memory test is run that determines the size of the SDRAM
3307banks.
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk2729af92004-05-03 20:45:30 +00003309When there is more than one SDRAM bank, and the banks are of
3310different size, the largest is mapped first. For equal size, the first
3311bank (CS2#) is mapped first. The first mapping is always for address
33120x00000000, with any additional banks following immediately to create
3313contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003314
wdenk2729af92004-05-03 20:45:30 +00003315Then, the monitor installs itself at the upper end of the SDRAM area
3316and allocates memory for use by malloc() and for the global Board
3317Info data; also, the exception vector code is copied to the low RAM
3318pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320Only after this relocation will you have a "normal" C environment;
3321until that you are restricted in several ways, mostly because you are
3322running from ROM, and because the code will have to be relocated to a
3323new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003324
3325
wdenk2729af92004-05-03 20:45:30 +00003326U-Boot Porting Guide:
3327----------------------
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3330list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003331
3332
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003333int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00003334{
3335 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003336
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003337 signal(SIGALRM, no_more_time);
3338 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk2729af92004-05-03 20:45:30 +00003340 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003341 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003342 return 0;
3343 }
3344
wdenk2729af92004-05-03 20:45:30 +00003345 Download latest U-Boot source;
3346
Wolfgang Denk06682362008-12-30 22:56:11 +01003347 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00003348
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003349 if (clueless)
3350 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003351
wdenk2729af92004-05-03 20:45:30 +00003352 while (learning) {
3353 Read the README file in the top level directory;
Naoki Hayama047f6ec2020-10-08 13:17:16 +09003354 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
Patrick Delaunay24bcaec2020-02-28 15:18:10 +01003355 Read applicable doc/README.*;
wdenk2729af92004-05-03 20:45:30 +00003356 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003357 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00003358 }
wdenkc6097192002-11-03 00:24:07 +00003359
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003360 if (available_money > toLocalCurrency ($2500))
3361 Buy a BDI3000;
3362 else
wdenk2729af92004-05-03 20:45:30 +00003363 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003364
3365 if (a similar board exists) { /* hopefully... */
3366 cp -a board/<similar> board/<myboard>
3367 cp include/configs/<similar>.h include/configs/<myboard>.h
3368 } else {
3369 Create your own board support subdirectory;
3370 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00003371 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003372 Edit new board/<myboard> files
3373 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00003374
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04003375 while (!accepted) {
3376 while (!running) {
3377 do {
3378 Add / modify source code;
3379 } until (compiles);
3380 Debug;
3381 if (clueless)
3382 email("Hi, I am having problems...");
3383 }
3384 Send patch file to the U-Boot email list;
3385 if (reasonable critiques)
3386 Incorporate improvements from email list code review;
3387 else
3388 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00003389 }
wdenkc6097192002-11-03 00:24:07 +00003390
wdenk2729af92004-05-03 20:45:30 +00003391 return 0;
3392}
3393
3394void no_more_time (int sig)
3395{
3396 hire_a_guru();
3397}
wdenkc6097192002-11-03 00:24:07 +00003398
3399
wdenk2729af92004-05-03 20:45:30 +00003400Coding Standards:
3401-----------------
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403All contributions to U-Boot should conform to the Linux kernel
Baruch Siach659208d2017-12-10 17:34:35 +02003404coding style; see the kernel coding style guide at
3405https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3406script "scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00003407
Detlev Zundel2c051652006-09-01 15:39:02 +02003408Source files originating from a different project (for example the
3409MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003410reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02003411sources.
3412
3413Please note that U-Boot is implemented in C (and to some small parts in
3414Assembler); no C++ is used, so please do not use C++ style comments (//)
3415in your code.
wdenk2729af92004-05-03 20:45:30 +00003416
3417Please also stick to the following formatting rules:
3418- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00003419- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00003420- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00003421- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00003422- do not add trailing empty lines to source files
3423
3424Submissions which do not conform to the standards may be returned
3425with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003426
3427
wdenk2729af92004-05-03 20:45:30 +00003428Submitting Patches:
3429-------------------
wdenkc6097192002-11-03 00:24:07 +00003430
wdenk2729af92004-05-03 20:45:30 +00003431Since the number of patches for U-Boot is growing, we need to
3432establish some rules. Submissions which do not conform to these rules
3433may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003434
Naoki Hayama047f6ec2020-10-08 13:17:16 +09003435Please see https://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01003436
Wolfgang Denk06682362008-12-30 22:56:11 +01003437Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childs1dade182017-11-14 22:56:42 -08003438see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk06682362008-12-30 22:56:11 +01003439
wdenk2729af92004-05-03 20:45:30 +00003440When you send a patch, please include the following information with
3441it:
wdenkc6097192002-11-03 00:24:07 +00003442
wdenk2729af92004-05-03 20:45:30 +00003443* For bug fixes: a description of the bug and how your patch fixes
3444 this bug. Please try to include a way of demonstrating that the
3445 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447* For new features: a description of the feature and your
3448 implementation.
wdenkc6097192002-11-03 00:24:07 +00003449
Robert P. J. Day7207b362015-12-19 07:16:10 -05003450* For major contributions, add a MAINTAINERS file with your
3451 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00003452
Albert ARIBAUD27af9302013-09-11 15:52:51 +02003453* When you add support for a new board, don't forget to add a
3454 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00003455
3456* If your patch adds new configuration options, don't forget to
3457 document these in the README file.
3458
Wolfgang Denk218ca722008-03-26 10:40:12 +01003459* The patch itself. If you are using git (which is *strongly*
3460 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00003461 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01003462 the U-Boot mailing list, you will avoid most of the common problems
3463 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00003464
Wolfgang Denk218ca722008-03-26 10:40:12 +01003465 If you cannot use git, use "diff -purN OLD NEW". If your version of
3466 diff does not support these options, then get the latest version of
3467 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00003468
Wolfgang Denk218ca722008-03-26 10:40:12 +01003469 The current directory when running this command shall be the parent
3470 directory of the U-Boot source tree (i. e. please make sure that
3471 your patch includes sufficient directory information for the
3472 affected files).
3473
3474 We prefer patches as plain text. MIME attachments are discouraged,
3475 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00003476
3477* If one logical set of modifications affects or creates several
3478 files, all these changes shall be submitted in a SINGLE patch file.
3479
3480* Changesets that contain different, unrelated modifications shall be
3481 submitted as SEPARATE patches, one patch per changeset.
3482
3483
3484Notes:
3485
Simon Glass6de80f22016-07-27 20:33:08 -06003486* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00003487 source tree and make sure that no errors or warnings are reported
3488 for any of the boards.
3489
3490* Keep your modifications to the necessary minimum: A patch
3491 containing several unrelated changes or arbitrary reformats will be
3492 returned with a request to re-formatting / split it.
3493
3494* If you modify existing code, make sure that your new code does not
3495 add to the memory footprint of the code ;-) Small is beautiful!
3496 When adding new features, these should compile conditionally only
3497 (using #ifdef), and the resulting code with the new feature
3498 disabled must not need more memory than the old code without your
3499 modification.
wdenk90dc6702005-05-03 14:12:25 +00003500
Wolfgang Denk06682362008-12-30 22:56:11 +01003501* Remember that there is a size limit of 100 kB per message on the
3502 u-boot mailing list. Bigger patches will be moderated. If they are
3503 reasonable and not too big, they will be acknowledged. But patches
3504 bigger than the size limit should be avoided.