blob: 7c41f8d20ca428b1aedeeb714cb2c30b3e503433 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000032Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000033"working". In fact, many of them are used in production systems.
34
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050035In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000039
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050040Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000043
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
Naoki Hayama2bc50c22020-10-08 13:16:18 +090054Please see https://lists.denx.de/pipermail/u-boot and
55https://marc.info/?l=u-boot
wdenkc6097192002-11-03 00:24:07 +000056
Wolfgang Denkb240aef2008-03-26 10:40:12 +010057Where to get source code:
58=========================
59
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050060The U-Boot source code is maintained in the Git repository at
Heinrich Schuchardt28b2b852021-02-24 13:19:04 +010061https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62https://source.denx.de/u-boot/u-boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +010063
Naoki Hayama65ae68a2020-10-08 13:16:25 +090064The "Tags" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020065any version you might be interested in. Official releases are also
Naoki Hayama65ae68a2020-10-08 13:16:25 +090066available from the DENX file server through HTTPS or FTP.
67https://ftp.denx.de/pub/u-boot/
68ftp://ftp.denx.de/pub/u-boot/
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069
70
wdenkc6097192002-11-03 00:24:07 +000071Where we come from:
72===================
73
74- start from 8xxrom sources
Naoki Hayamae0cc1852020-10-08 13:17:16 +090075- create PPCBoot project (https://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000076- clean up code
77- make it easier to add custom boards
78- make it possible to add other [PowerPC] CPUs
79- extend functions, especially:
80 * Provide extended interface to Linux boot loader
81 * S-Record download
82 * network boot
Simon Glassaaef3bf2019-08-01 09:47:14 -060083 * ATA disk / SCSI ... boot
Naoki Hayamae0cc1852020-10-08 13:17:16 +090084- create ARMBoot project (https://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000085- add other CPU families (starting with ARM)
Naoki Hayamae0cc1852020-10-08 13:17:16 +090086- create U-Boot project (https://sourceforge.net/projects/u-boot)
87- current project page: see https://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000088
89
90Names and Spelling:
91===================
92
93The "official" name of this project is "Das U-Boot". The spelling
94"U-Boot" shall be used in all written text (documentation, comments
95in source files etc.). Example:
96
97 This is the README file for the U-Boot project.
98
99File names etc. shall be based on the string "u-boot". Examples:
100
101 include/asm-ppc/u-boot.h
102
103 #include <asm/u-boot.h>
104
105Variable names, preprocessor constants etc. shall be either based on
106the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000107
wdenk24ee89b2002-11-03 17:56:27 +0000108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
110
wdenkc6097192002-11-03 00:24:07 +0000111
wdenk7474aca2002-12-17 17:55:09 +0000112Versioning:
113===========
114
Thomas Webere89e6282010-09-28 08:06:25 +0200115Starting with the release in October 2008, the names of the releases
116were changed from numerical release numbers without deeper meaning
117into a time stamp based numbering. Regular releases are identified by
118names consisting of the calendar year and month of the release date.
119Additional fields (if present) indicate release candidates or bug fix
120releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000121
Thomas Webere89e6282010-09-28 08:06:25 +0200122Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000123 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000126
127
wdenkc6097192002-11-03 00:24:07 +0000128Directory Hierarchy:
129====================
130
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600131/arch Architecture-specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900132 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500133 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500134 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500135 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000137 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /nios2 Files generic to Altera NIOS2 architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200139 /powerpc Files generic to PowerPC architecture
Rick Chend7e6f922017-12-26 13:55:59 +0800140 /riscv Files generic to RISC-V architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500141 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400143 /x86 Files generic to x86 architecture
Naoki Hayama411f5c62020-10-08 13:16:38 +0900144 /xtensa Files generic to Xtensa architecture
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600145/api Machine/arch-independent API for external apps
146/board Board-dependent files
Simon Glass91944df2021-10-14 12:47:54 -0600147/boot Support for images and booting
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800148/cmd U-Boot commands functions
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600149/common Misc architecture-independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500150/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500151/disk Code for disk drive partition handling
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600152/doc Documentation (a mix of ReST and READMEs)
153/drivers Device drivers
154/dts Makefile for building internal U-Boot fdt.
155/env Environment support
Peter Tysere4d1abc2010-04-12 22:28:21 -0500156/examples Example code for standalone applications, etc.
157/fs Filesystem code (cramfs, ext2, jffs2, etc.)
158/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500159/lib Library routines generic to all architectures
160/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500161/net Networking code
162/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500163/scripts Various build scripts and Makefiles
164/test Various unit test files
Simon Glass1a0a4ac2021-07-10 21:14:21 -0600165/tools Tools to build and sign FIT images, etc.
wdenkc6097192002-11-03 00:24:07 +0000166
wdenkc6097192002-11-03 00:24:07 +0000167Software Configuration:
168=======================
169
170Configuration is usually done using C preprocessor defines; the
171rationale behind that is to avoid dead code whenever possible.
172
173There are two classes of configuration variables:
174
175* Configuration _OPTIONS_:
176 These are selectable by the user and have names beginning with
177 "CONFIG_".
178
179* Configuration _SETTINGS_:
180 These depend on the hardware etc. and should not be meddled with if
181 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200182 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000183
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500184Previously, all configuration was done by hand, which involved creating
185symbolic links and editing configuration files manually. More recently,
186U-Boot has added the Kbuild infrastructure used by the Linux kernel,
187allowing you to use the "make menuconfig" command to configure your
188build.
wdenkc6097192002-11-03 00:24:07 +0000189
190
191Selection of Processor Architecture and Board Type:
192---------------------------------------------------
193
194For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200195configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000196
197Example: For a TQM823L module type:
198
199 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200200 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000201
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500202Note: If you're looking for the default configuration file for a board
203you're sure used to be there but is now missing, check the file
204doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000205
Simon Glass53552c92014-03-22 17:12:59 -0600206Sandbox Environment:
207--------------------
208
209U-Boot can be built natively to run on a Linux host using the 'sandbox'
210board. This allows feature development which is not board- or architecture-
211specific to be undertaken on a native platform. The sandbox is also used to
212run some of U-Boot's tests.
213
Naoki Hayamadd860ca2020-10-08 13:16:58 +0900214See doc/arch/sandbox.rst for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600215
216
Simon Glassd8711af2015-03-03 08:03:00 -0700217Board Initialisation Flow:
218--------------------------
219
220This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500221SPL and U-Boot proper (i.e. they both follow the same rules).
222
223Note: "SPL" stands for "Secondary Program Loader," which is explained in
224more detail later in this file.
225
226At present, SPL mostly uses a separate code path, but the function names
227and roles of each function are the same. Some boards or architectures
228may not conform to this. At least most ARM boards which use
229CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700230
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500231Execution typically starts with an architecture-specific (and possibly
232CPU-specific) start.S file, such as:
233
234 - arch/arm/cpu/armv7/start.S
235 - arch/powerpc/cpu/mpc83xx/start.S
236 - arch/mips/cpu/start.S
237
238and so on. From there, three functions are called; the purpose and
239limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700240
241lowlevel_init():
242 - purpose: essential init to permit execution to reach board_init_f()
243 - no global_data or BSS
244 - there is no stack (ARMv7 may have one but it will soon be removed)
245 - must not set up SDRAM or use console
246 - must only do the bare minimum to allow execution to continue to
247 board_init_f()
248 - this is almost never needed
249 - return normally from this function
250
251board_init_f():
252 - purpose: set up the machine ready for running board_init_r():
253 i.e. SDRAM and serial UART
254 - global_data is available
255 - stack is in SRAM
256 - BSS is not available, so you cannot use global/static variables,
257 only stack variables and global_data
258
259 Non-SPL-specific notes:
260 - dram_init() is called to set up DRAM. If already done in SPL this
261 can do nothing
262
263 SPL-specific notes:
264 - you can override the entire board_init_f() function with your own
265 version as needed.
266 - preloader_console_init() can be called here in extremis
267 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayamaebfd8192020-09-24 15:57:19 +0900268 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg7673bed2019-08-08 12:54:49 -0500269 - for specific scenarios on certain architectures an early BSS *can*
270 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
271 of BSS prior to entering board_init_f()) but doing so is discouraged.
272 Instead it is strongly recommended to architect any code changes
273 or additions such to not depend on the availability of BSS during
274 board_init_f() as indicated in other sections of this README to
275 maintain compatibility and consistency across the entire code base.
Simon Glassd8711af2015-03-03 08:03:00 -0700276 - must return normally from this function (don't call board_init_r()
277 directly)
278
279Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
280this point the stack and global_data are relocated to below
281CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
282memory.
283
284board_init_r():
285 - purpose: main execution, common code
286 - global_data is available
287 - SDRAM is available
288 - BSS is available, all static/global variables can be used
289 - execution eventually continues to main_loop()
290
291 Non-SPL-specific notes:
292 - U-Boot is relocated to the top of memory and is now running from
293 there.
294
295 SPL-specific notes:
296 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
297 CONFIG_SPL_STACK_R_ADDR points into SDRAM
298 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800299 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700300 spl_board_init() function containing this call
301 - loads U-Boot or (in falcon mode) Linux
302
303
wdenkc6097192002-11-03 00:24:07 +0000304Configuration Options:
305----------------------
306
307Configuration depends on the combination of board and CPU type; all
308such information is kept in a configuration file
309"include/configs/<board_name>.h".
310
311Example: For a TQM823L module, all configuration settings are in
312"include/configs/TQM823L.h".
313
314
wdenk1272e232002-11-10 22:06:23 +0000315Many of the options are named exactly as the corresponding Linux
316kernel configuration options. The intention is to make it easier to
317build a config tool - later.
318
Ashish Kumar11234062017-08-11 11:09:14 +0530319- ARM Platform Bus Type(CCI):
320 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
321 provides full cache coherency between two clusters of multi-core
322 CPUs and I/O coherency for devices and I/O masters
323
324 CONFIG_SYS_FSL_HAS_CCI400
325
326 Defined For SoC that has cache coherent interconnect
327 CCN-400
wdenk1272e232002-11-10 22:06:23 +0000328
Ashish Kumar97393d62017-08-18 10:54:36 +0530329 CONFIG_SYS_FSL_HAS_CCN504
330
331 Defined for SoC that has cache coherent interconnect CCN-504
332
wdenkc6097192002-11-03 00:24:07 +0000333The following options need to be configured:
334
Kim Phillips203fee32007-08-10 13:28:25 -0500335- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000336
Kim Phillips203fee32007-08-10 13:28:25 -0500337- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200338
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600339- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000340 CONFIG_SYS_PPC64
341
342 Specifies that the core is a 64-bit PowerPC implementation (implements
343 the "64" category of the Power ISA). This is necessary for ePAPR
344 compliance, among other possible reasons.
345
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600346 CONFIG_SYS_FSL_TBCLK_DIV
347
348 Defines the core time base clock divider ratio compared to the
349 system clock. On most PQ3 devices this is 8, on newer QorIQ
350 devices it can be 16 or 32. The ratio varies from SoC to Soc.
351
Kumar Gala179b1b22011-05-20 00:39:21 -0500352 CONFIG_SYS_FSL_PCIE_COMPAT
353
354 Defines the string to utilize when trying to match PCIe device
355 tree nodes for the given platform.
356
Scott Wood80806962012-08-14 10:14:53 +0000357 CONFIG_SYS_FSL_ERRATUM_A004510
358
359 Enables a workaround for erratum A004510. If set,
360 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
362
363 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
365
366 Defines one or two SoC revisions (low 8 bits of SVR)
367 for which the A004510 workaround should be applied.
368
369 The rest of SVR is either not relevant to the decision
370 of whether the erratum is present (e.g. p2040 versus
371 p2041) or is implied by the build target, which controls
372 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
373
374 See Freescale App Note 4493 for more information about
375 this erratum.
376
377 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
378
379 This is the value to write into CCSR offset 0x18600
380 according to the A004510 workaround.
381
Priyanka Jainc73b9032013-07-02 09:21:04 +0530382 CONFIG_SYS_FSL_DSP_DDR_ADDR
383 This value denotes start offset of DDR memory which is
384 connected exclusively to the DSP cores.
385
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530386 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
387 This value denotes start offset of M2 memory
388 which is directly connected to the DSP core.
389
Priyanka Jainc73b9032013-07-02 09:21:04 +0530390 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
391 This value denotes start offset of M3 memory which is directly
392 connected to the DSP core.
393
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530394 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
395 This value denotes start offset of DSP CCSR space.
396
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530397 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
398 Single Source Clock is clocking mode present in some of FSL SoC's.
399 In this mode, a single differential clock is used to supply
400 clocks to the sysclock, ddrclock and usbclock.
401
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530402 CONFIG_SYS_CPC_REINIT_F
403 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800404 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530405
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000406- Generic CPU options:
407 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
408
409 Defines the endianess of the CPU. Implementation of those
410 values is arch specific.
411
York Sunf0626592013-09-30 09:22:09 -0700412 CONFIG_SYS_FSL_DDR
413 Freescale DDR driver in use. This type of DDR controller is
Tom Rinie5404982021-05-14 21:34:26 -0400414 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
York Sunf0626592013-09-30 09:22:09 -0700415
416 CONFIG_SYS_FSL_DDR_ADDR
417 Freescale DDR memory-mapped register base.
418
419 CONFIG_SYS_FSL_DDR_EMU
420 Specify emulator support for DDR. Some DDR features such as
421 deskew training are not available.
422
423 CONFIG_SYS_FSL_DDRC_GEN1
424 Freescale DDR1 controller.
425
426 CONFIG_SYS_FSL_DDRC_GEN2
427 Freescale DDR2 controller.
428
429 CONFIG_SYS_FSL_DDRC_GEN3
430 Freescale DDR3 controller.
431
York Sun2896cb72014-03-27 17:54:47 -0700432 CONFIG_SYS_FSL_DDRC_GEN4
433 Freescale DDR4 controller.
434
York Sun461c9392013-09-30 14:20:51 -0700435 CONFIG_SYS_FSL_DDRC_ARM_GEN3
436 Freescale DDR3 controller for ARM-based SoCs.
437
York Sunf0626592013-09-30 09:22:09 -0700438 CONFIG_SYS_FSL_DDR1
439 Board config to use DDR1. It can be enabled for SoCs with
440 Freescale DDR1 or DDR2 controllers, depending on the board
441 implemetation.
442
443 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400444 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700445 Freescale DDR2 or DDR3 controllers, depending on the board
446 implementation.
447
448 CONFIG_SYS_FSL_DDR3
449 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700450 Freescale DDR3 or DDR3L controllers.
451
452 CONFIG_SYS_FSL_DDR3L
453 Board config to use DDR3L. It can be enabled for SoCs with
454 DDR3L controllers.
455
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530456 CONFIG_SYS_FSL_IFC_BE
457 Defines the IFC controller register space as Big Endian
458
459 CONFIG_SYS_FSL_IFC_LE
460 Defines the IFC controller register space as Little Endian
461
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530462 CONFIG_SYS_FSL_IFC_CLK_DIV
463 Defines divider of platform clock(clock input to IFC controller).
464
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530465 CONFIG_SYS_FSL_LBC_CLK_DIV
466 Defines divider of platform clock(clock input to eLBC controller).
467
York Sun29647ab2014-02-10 13:59:42 -0800468 CONFIG_SYS_FSL_DDR_BE
469 Defines the DDR controller register space as Big Endian
470
471 CONFIG_SYS_FSL_DDR_LE
472 Defines the DDR controller register space as Little Endian
473
York Sun3a0916d2014-02-10 13:59:43 -0800474 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
475 Physical address from the view of DDR controllers. It is the
476 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
477 it could be different for ARM SoCs.
478
York Sunc459ae62014-02-10 13:59:44 -0800479 CONFIG_SYS_FSL_DDR_INTLV_256B
480 DDR controller interleaving on 256-byte. This is a special
481 interleaving mode, handled by Dickens for Freescale layerscape
482 SoCs with ARM core.
483
York Sun79a779b2014-08-01 15:51:00 -0700484 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
485 Number of controllers used as main memory.
486
487 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
488 Number of controllers used for other than main memory.
489
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530490 CONFIG_SYS_FSL_HAS_DP_DDR
491 Defines the SoC has DP-DDR used for DPAA.
492
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530493 CONFIG_SYS_FSL_SEC_BE
494 Defines the SEC controller register space as Big Endian
495
496 CONFIG_SYS_FSL_SEC_LE
497 Defines the SEC controller register space as Little Endian
498
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200499- MIPS CPU options:
500 CONFIG_SYS_INIT_SP_OFFSET
501
502 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
503 pointer. This is needed for the temporary stack before
504 relocation.
505
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200506 CONFIG_XWAY_SWAP_BYTES
507
508 Enable compilation of tools/xway-swap-bytes needed for Lantiq
509 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
510 be swapped if a flash programmer is used.
511
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000512- ARM options:
513 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
514
515 Select high exception vectors of the ARM core, e.g., do not
516 clear the V bit of the c1 register of CP15.
517
York Sun77a10972015-03-20 19:28:08 -0700518 COUNTER_FREQUENCY
519 Generic timer clock source frequency.
520
521 COUNTER_FREQUENCY_REAL
522 Generic timer clock source frequency if the real clock is
523 different from COUNTER_FREQUENCY, and can only be determined
524 at run time.
525
Stephen Warren8d1fb312015-01-19 16:25:52 -0700526- Tegra SoC options:
527 CONFIG_TEGRA_SUPPORT_NON_SECURE
528
529 Support executing U-Boot in non-secure (NS) mode. Certain
530 impossible actions will be skipped if the CPU is in NS mode,
531 such as ARM architectural timer initialization.
532
wdenk9b7f3842003-10-09 20:09:04 +0000533- Linux Kernel Interface:
wdenk9b7f3842003-10-09 20:09:04 +0000534 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
535
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800536 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000537 expect it to be in bytes, others in MB.
538 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
539
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400540 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200541
542 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400543 passed using flattened device trees (based on open firmware
544 concepts).
545
546 CONFIG_OF_LIBFDT
547 * New libfdt-based support
548 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500549 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400550
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200551 OF_TBCLK - The timebase frequency.
552
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200553 boards with QUICC Engines require OF_QE to set UCC MAC
554 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500555
Heiko Schocherffb293a2009-09-23 07:56:08 +0200556 CONFIG_OF_IDE_FIXUP
557
558 U-Boot can detect if an IDE device is present or not.
559 If not, and this new config option is activated, U-Boot
560 removes the ATA node from the DTS before booting Linux,
561 so the Linux IDE driver does not probe the device and
562 crash. This is needed for buggy hardware (uc101) where
563 no pull down resistor is connected to the signal IDE5V_DD7.
564
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100565- vxWorks boot parameters:
566
567 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700568 environments variables: bootdev, bootfile, ipaddr, netmask,
569 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100570 It loads the vxWorks image pointed bootfile.
571
Naoki Hayama158c2262020-10-08 13:17:08 +0900572 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100573 the defaults discussed just above.
574
Aneesh V686a0752011-06-16 23:30:51 +0000575- Cache Configuration for ARM:
576 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
577 controller
578 CONFIG_SYS_PL310_BASE - Physical base address of PL310
579 controller register space
580
wdenkda04a8b2004-08-02 23:22:59 +0000581- Serial Ports:
wdenkda04a8b2004-08-02 23:22:59 +0000582 CONFIG_PL011_CLOCK
583
584 If you have Amba PrimeCell PL011 UARTs, set this variable to
585 the clock speed of the UARTs.
586
587 CONFIG_PL01x_PORTS
588
589 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
590 define this to a list of base addresses for each (supported)
591 port. See e.g. include/configs/versatile.h
592
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400593 CONFIG_SERIAL_HW_FLOW_CONTROL
594
595 Define this variable to enable hw flow control in serial driver.
596 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000597
wdenkc6097192002-11-03 00:24:07 +0000598- Serial Download Echo Mode:
599 CONFIG_LOADS_ECHO
600 If defined to 1, all characters received during a
601 serial download (using the "loads" command) are
602 echoed back. This might be needed by some terminal
603 emulations (like "cu"), but may as well just take
604 time on others. This setting #define's the initial
605 value of the "loads_echo" environment variable.
606
Simon Glassaa34ef22016-03-13 19:07:28 -0600607- Removal of commands
608 If no commands are needed to boot, you can disable
609 CONFIG_CMDLINE to remove them. In this case, the command line
610 will not be available, and when U-Boot wants to execute the
611 boot command (on start-up) it will call board_run_command()
612 instead. This can reduce image size significantly for very
613 simple boot procedures.
614
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000615- Regular expression support:
616 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200617 If this variable is defined, U-Boot is linked against
618 the SLRE (Super Light Regular Expression) library,
619 which adds regex support to some commands, as for
620 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000621
wdenkc6097192002-11-03 00:24:07 +0000622- Watchdog:
Rasmus Villemoes134cc2b2021-04-14 09:18:22 +0200623 CONFIG_SYS_WATCHDOG_FREQ
624 Some platforms automatically call WATCHDOG_RESET()
625 from the timer interrupt handler every
626 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
627 board configuration file, a default of CONFIG_SYS_HZ/2
628 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
629 to 0 disables calling WATCHDOG_RESET() from the timer
630 interrupt.
631
wdenkc6097192002-11-03 00:24:07 +0000632- Real-Time Clock:
633
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500634 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000635 has to be selected, too. Define exactly one of the
636 following options:
637
wdenkc6097192002-11-03 00:24:07 +0000638 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000639 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000640 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000641 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000642 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000643 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +0200644 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +0000645 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100646 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000647 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2d3ac512017-05-30 12:03:33 +1200648 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +0200649 CONFIG_SYS_RV3029_TCR - enable trickle charger on
650 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000651
wdenkb9bbd242003-06-30 16:24:52 +0000652 Note that if the RTC uses I2C, then the I2C interface
653 must also be configured. See I2C Support, below.
654
Peter Tyser9902e422008-12-17 16:36:21 -0600655- GPIO Support:
656 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -0600657
Chris Packham9b383202010-12-19 10:12:13 +0000658 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
659 chip-ngpio pairs that tell the PCA953X driver the number of
660 pins supported by a particular chip.
661
Peter Tyser9902e422008-12-17 16:36:21 -0600662 Note that if the GPIO device uses I2C, then the I2C interface
663 must also be configured. See I2C Support, below.
664
Simon Glass4dc47ca2014-06-11 23:29:41 -0600665- I/O tracing:
666 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
667 accesses and can checksum them or write a list of them out
668 to memory. See the 'iotrace' command for details. This is
669 useful for testing device drivers since it can confirm that
670 the driver behaves the same way before and after a code
671 change. Currently this is supported on sandbox and arm. To
672 add support for your architecture, add '#include <iotrace.h>'
673 to the bottom of arch/<arch>/include/asm/io.h and test.
674
675 Example output from the 'iotrace stats' command is below.
676 Note that if the trace buffer is exhausted, the checksum will
677 still continue to operate.
678
679 iotrace is enabled
680 Start: 10000000 (buffer start address)
681 Size: 00010000 (buffer size)
682 Offset: 00000120 (current buffer offset)
683 Output: 10000120 (start + offset)
684 Count: 00000018 (number of trace records)
685 CRC32: 9526fb66 (CRC32 of all trace records)
686
wdenkc6097192002-11-03 00:24:07 +0000687- Timestamp Support:
688
wdenk4a5c8a72003-03-06 00:02:04 +0000689 When CONFIG_TIMESTAMP is selected, the timestamp
690 (date and time) of an image is printed by image
691 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500692 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000693
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000694- Partition Labels (disklabels) Supported:
695 Zero or more of the following:
696 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000697 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
698 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
699 bootloader. Note 2TB partition limit; see
700 disk/part_efi.c
Simon Glass8706b812016-05-01 11:36:02 -0600701 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +0000702 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000703
wdenkf602aa02004-03-13 23:29:43 +0000704- LBA48 Support
705 CONFIG_LBA48
706
707 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +0100708 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +0000709 Whithout these , LBA48 support uses 32bit variables and will 'only'
710 support disks up to 2.1TB.
711
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200712 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000713 When enabled, makes the IDE subsystem use 64bit sector addresses.
714 Default is 32bit.
715
wdenkc6097192002-11-03 00:24:07 +0000716- NETWORK Support (PCI):
Kyle Moffett64b94dd2011-10-18 11:05:29 +0000717 CONFIG_E1000_SPI
718 Utility code for direct access to the SPI bus on Intel 8257x.
719 This does not do anything useful unless you set at least one
720 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
721
wdenkc6097192002-11-03 00:24:07 +0000722 CONFIG_NATSEMI
723 Support for National dp83815 chips.
724
725 CONFIG_NS8382X
726 Support for National dp8382[01] gigabit chips.
727
wdenkaa603362003-05-12 21:50:16 +0000728- NETWORK Support (other):
Rob Herringc9830dc2011-12-15 11:15:49 +0000729 CONFIG_CALXEDA_XGMAC
730 Support for the Calxeda XGMAC device
731
Ashok93fb8722012-10-15 06:20:47 +0000732 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +0000733 Support for SMSC's LAN91C96 chips.
734
wdenkaa603362003-05-12 21:50:16 +0000735 CONFIG_LAN91C96_USE_32_BIT
736 Define this to enable 32 bit addressing
737
Ashok93fb8722012-10-15 06:20:47 +0000738 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +0000739 Support for SMSC's LAN91C111 chip
740
741 CONFIG_SMC91111_BASE
742 Define this to hold the physical address
743 of the device (I/O space)
744
745 CONFIG_SMC_USE_32_BIT
746 Define this if data bus is 32 bits
747
748 CONFIG_SMC_USE_IOFUNCS
749 Define this to use i/o functions instead of macros
750 (some hardware wont work with macros)
751
Heiko Schocher7d037f72011-11-15 10:00:04 -0500752 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
753 Define this if you have more then 3 PHYs.
754
Macpaul Lin199c6252010-12-21 16:59:46 +0800755 CONFIG_FTGMAC100
756 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
757
758 CONFIG_FTGMAC100_EGIGA
759 Define this to use GE link update with gigabit PHY.
760 Define this if FTGMAC100 is connected to gigabit PHY.
761 If your system has 10/100 PHY only, it might not occur
762 wrong behavior. Because PHY usually return timeout or
763 useless data when polling gigabit status and gigabit
764 control registers. This behavior won't affect the
765 correctnessof 10/100 link speed update.
766
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +0900767 CONFIG_SH_ETHER
768 Support for Renesas on-chip Ethernet controller
769
770 CONFIG_SH_ETHER_USE_PORT
771 Define the number of ports to be used
772
773 CONFIG_SH_ETHER_PHY_ADDR
774 Define the ETH PHY's address
775
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +0900776 CONFIG_SH_ETHER_CACHE_WRITEBACK
777 If this option is set, the driver enables cache flush.
778
Vadim Bendeburydac69642011-10-17 08:36:14 +0000779- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +0000780 CONFIG_TPM
781 Support TPM devices.
782
Christophe Ricard8759ff82015-10-06 22:54:41 +0200783 CONFIG_TPM_TIS_INFINEON
784 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000785 per system is supported at this time.
786
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +0000787 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
788 Define the burst count bytes upper limit
789
Christophe Ricard88249232016-01-21 23:27:13 +0100790 CONFIG_TPM_ST33ZP24
791 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
792
793 CONFIG_TPM_ST33ZP24_I2C
794 Support for STMicroelectronics ST33ZP24 I2C devices.
795 Requires TPM_ST33ZP24 and I2C.
796
Christophe Ricard5ffadc32016-01-21 23:27:14 +0100797 CONFIG_TPM_ST33ZP24_SPI
798 Support for STMicroelectronics ST33ZP24 SPI devices.
799 Requires TPM_ST33ZP24 and SPI.
800
Dirk Eibach20489092013-06-26 15:55:15 +0200801 CONFIG_TPM_ATMEL_TWI
802 Support for Atmel TWI TPM device. Requires I2C support.
803
Che-liang Chiouacea5702013-04-12 11:04:34 +0000804 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +0000805 Support for generic parallel port TPM devices. Only one device
806 per system is supported at this time.
807
808 CONFIG_TPM_TIS_BASE_ADDRESS
809 Base address where the generic TPM device is mapped
810 to. Contemporary x86 systems usually map it at
811 0xfed40000.
812
Reinhard Pfau4fece432013-06-26 15:55:13 +0200813 CONFIG_TPM
814 Define this to enable the TPM support library which provides
815 functional interfaces to some TPM commands.
816 Requires support for a TPM device.
817
818 CONFIG_TPM_AUTH_SESSIONS
819 Define this to enable authorized functions in the TPM library.
820 Requires CONFIG_TPM and CONFIG_SHA1.
821
wdenkc6097192002-11-03 00:24:07 +0000822- USB Support:
823 At the moment only the UHCI host controller is
Heiko Schocher6f90e582017-06-14 05:49:40 +0200824 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000825 CONFIG_USB_UHCI to enable it.
826 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000827 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000828 storage devices.
829 Note:
830 Supported are USB Keyboards and USB Floppy drives
831 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000832
Simon Glass5978cdb2012-02-27 10:52:47 +0000833 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
834 txfilltuning field in the EHCI controller on reset.
835
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -0700836 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
837 HW module registers.
838
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200839- USB Device:
840 Define the below if you wish to use the USB console.
841 Once firmware is rebuilt from a serial console issue the
842 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200843 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200844 it has found a new device. The environment variable usbtty
845 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200846 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200847 Common Device Class Abstract Control Model serial device.
848 If you select usbtty = gserial you should be able to enumerate
849 a Linux host by
850 # modprobe usbserial vendor=0xVendorID product=0xProductID
851 else if using cdc_acm, simply setting the environment
852 variable usbtty to be cdc_acm should suffice. The following
853 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200854
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200855 CONFIG_USB_DEVICE
856 Define this to build a UDC device
857
858 CONFIG_USB_TTY
859 Define this to have a tty type of device available to
860 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200861
Vipin KUMARbdb17702012-03-26 15:38:06 +0530862 CONFIG_USBD_HS
863 Define this to enable the high speed support for usb
864 device and usbtty. If this feature is enabled, a routine
865 int is_usbd_high_speed(void)
866 also needs to be defined by the driver to dynamically poll
867 whether the enumeration has succeded at high speed or full
868 speed.
869
Wolfgang Denke2601822006-06-14 18:14:56 +0200870 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200871 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200872 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200873 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
874 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
875 should pretend to be a Linux device to it's target host.
876
877 CONFIG_USBD_MANUFACTURER
878 Define this string as the name of your company for
879 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200880
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200881 CONFIG_USBD_PRODUCT_NAME
882 Define this string as the name of your product
883 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000884
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200885 CONFIG_USBD_VENDORID
886 Define this as your assigned Vendor ID from the USB
887 Implementors Forum. This *must* be a genuine Vendor ID
888 to avoid polluting the USB namespace.
889 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200890
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200891 CONFIG_USBD_PRODUCTID
892 Define this as the unique Product ID
893 for your device
894 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200895
Igor Grinbergac5f6ee2011-12-12 12:08:35 +0200896- ULPI Layer Support:
897 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
898 the generic ULPI layer. The generic layer accesses the ULPI PHY
899 via the platform viewport, so you need both the genric layer and
900 the viewport enabled. Currently only Chipidea/ARC based
901 viewport is supported.
902 To enable the ULPI layer support, define CONFIG_USB_ULPI and
903 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +0200904 If your ULPI phy needs a different reference clock than the
905 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
906 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +0000907
wdenk7a428cc2003-06-15 22:40:42 +0000908- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +0000909 The MMC controller on the Intel PXA is supported. To
910 enable this define CONFIG_MMC. The MMC can be
911 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +0000912 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500913 enabled with CONFIG_CMD_MMC. The MMC driver also works with
914 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +0000915
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +0000916 CONFIG_SH_MMCIF
917 Support for Renesas on-chip MMCIF controller
918
919 CONFIG_SH_MMCIF_ADDR
920 Define the base address of MMCIF registers
921
922 CONFIG_SH_MMCIF_CLK
923 Define the clock frequency for MMCIF
924
Tom Rini58a8d322013-03-14 05:32:47 +0000925- USB Device Firmware Update (DFU) class support:
Marek Vasut7f8d4362018-02-16 16:41:18 +0100926 CONFIG_DFU_OVER_USB
Tom Rini58a8d322013-03-14 05:32:47 +0000927 This enables the USB portion of the DFU USB class
928
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000929 CONFIG_DFU_NAND
930 This enables support for exposing NAND devices via DFU.
931
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530932 CONFIG_DFU_RAM
933 This enables support for exposing RAM via DFU.
934 Note: DFU spec refer to non-volatile memory usage, but
935 allow usages beyond the scope of spec - here RAM usage,
936 one that would help mostly the developer.
937
Heiko Schochera2f831e2013-06-12 06:05:51 +0200938 CONFIG_SYS_DFU_DATA_BUF_SIZE
939 Dfu transfer uses a buffer before writing data to the
940 raw storage device. Make the size (in bytes) of this buffer
941 configurable. The size of this buffer is also configurable
942 through the "dfu_bufsiz" environment variable.
943
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000944 CONFIG_SYS_DFU_MAX_FILE_SIZE
945 When updating files rather than the raw storage device,
946 we use a static buffer to copy the file into and then write
947 the buffer once we've been given the whole file. Define
948 this to the maximum filesize (in bytes) for the buffer.
949 Default is 4 MiB if undefined.
950
Heiko Schochere1ba1512014-03-18 08:09:56 +0100951 DFU_DEFAULT_POLL_TIMEOUT
952 Poll timeout [ms], is the timeout a device can send to the
953 host. The host must wait for this timeout before sending
954 a subsequent DFU_GET_STATUS request to the device.
955
956 DFU_MANIFEST_POLL_TIMEOUT
957 Poll timeout [ms], which the device sends to the host when
958 entering dfuMANIFEST state. Host waits this timeout, before
959 sending again an USB request to the device.
960
wdenkda04a8b2004-08-02 23:22:59 +0000961- Journaling Flash filesystem support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200962 CONFIG_SYS_JFFS2_FIRST_SECTOR,
963 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +0000964 Define these for a default partition on a NOR device
965
wdenkc6097192002-11-03 00:24:07 +0000966- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -0700967 See Kconfig help for available keyboard drivers.
968
wdenkc6097192002-11-03 00:24:07 +0000969- LCD Support: CONFIG_LCD
970
971 Define this to enable LCD support (for output to LCD
972 display); also select one of the supported displays
973 by defining one of these:
974
wdenkc0d54ae2003-11-25 16:55:19 +0000975 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000976
wdenkc0d54ae2003-11-25 16:55:19 +0000977 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000978
wdenkc0d54ae2003-11-25 16:55:19 +0000979 CONFIG_NEC_NL6448BC20
980
981 NEC NL6448BC20-08. 6.5", 640x480.
982 Active, color, single scan.
983
984 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +0000985
wdenkc0d54ae2003-11-25 16:55:19 +0000986 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000987 Active, color, single scan.
988
989 CONFIG_SHARP_16x9
990
991 Sharp 320x240. Active, color, single scan.
992 It isn't 16x9, and I am not sure what it is.
993
994 CONFIG_SHARP_LQ64D341
995
996 Sharp LQ64D341 display, 640x480.
997 Active, color, single scan.
998
999 CONFIG_HLD1045
1000
1001 HLD1045 display, 640x480.
1002 Active, color, single scan.
1003
1004 CONFIG_OPTREX_BW
1005
1006 Optrex CBL50840-2 NF-FW 99 22 M5
1007 or
1008 Hitachi LMG6912RPFC-00T
1009 or
1010 Hitachi SP14Q002
1011
1012 320x240. Black & white.
1013
Simon Glass599a4df2012-10-17 13:24:54 +00001014 CONFIG_LCD_ALIGNMENT
1015
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001016 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001017 defined then the LCD will be aligned to this value instead.
1018 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1019 here, since it is cheaper to change data cache settings on
1020 a per-section basis.
1021
1022
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001023 CONFIG_LCD_ROTATION
1024
1025 Sometimes, for example if the display is mounted in portrait
1026 mode or even if it's mounted landscape but rotated by 180degree,
1027 we need to rotate our content of the display relative to the
1028 framebuffer, so that user can read the messages which are
1029 printed out.
1030 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1031 initialized with a given rotation from "vl_rot" out of
1032 "vidinfo_t" which is provided by the board specific code.
1033 The value for vl_rot is coded as following (matching to
1034 fbcon=rotate:<n> linux-kernel commandline):
1035 0 = no rotation respectively 0 degree
1036 1 = 90 degree rotation
1037 2 = 180 degree rotation
1038 3 = 270 degree rotation
1039
1040 If CONFIG_LCD_ROTATION is not defined, the console will be
1041 initialized with 0degree rotation.
1042
wdenk0e2bd9c2004-06-06 21:51:03 +00001043- MII/PHY support:
wdenk0e2bd9c2004-06-06 21:51:03 +00001044 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1045
1046 The clock frequency of the MII bus
1047
wdenk0e2bd9c2004-06-06 21:51:03 +00001048 CONFIG_PHY_CMD_DELAY (ppc4xx)
1049
1050 Some PHY like Intel LXT971A need extra delay after
1051 command issued before MII status register can be read
1052
wdenkc6097192002-11-03 00:24:07 +00001053- IP address:
1054 CONFIG_IPADDR
1055
1056 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001057 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001058 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001059 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001060
1061- Server IP address:
1062 CONFIG_SERVERIP
1063
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001064 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001065 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001066 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001067
Wolfgang Denk26da2992011-10-26 10:21:22 +00001068- Gateway IP address:
1069 CONFIG_GATEWAYIP
1070
1071 Defines a default value for the IP address of the
1072 default router where packets to other networks are
1073 sent to.
1074 (Environment variable "gatewayip")
1075
1076- Subnet mask:
1077 CONFIG_NETMASK
1078
1079 Defines a default value for the subnet mask (or
1080 routing prefix) which is used to determine if an IP
1081 address belongs to the local subnet or needs to be
1082 forwarded through a router.
1083 (Environment variable "netmask")
1084
wdenkc6097192002-11-03 00:24:07 +00001085- BOOTP Recovery Mode:
1086 CONFIG_BOOTP_RANDOM_DELAY
1087
1088 If you have many targets in a network that try to
1089 boot using BOOTP, you may want to avoid that all
1090 systems send out BOOTP requests at precisely the same
1091 moment (which would happen for instance at recovery
1092 from a power failure, when all systems will try to
1093 boot, thus flooding the BOOTP server. Defining
1094 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1095 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001096 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001097
1098 1st BOOTP request: delay 0 ... 1 sec
1099 2nd BOOTP request: delay 0 ... 2 sec
1100 3rd BOOTP request: delay 0 ... 4 sec
1101 4th and following
1102 BOOTP requests: delay 0 ... 8 sec
1103
Thierry Reding8977cda2014-08-19 10:21:24 +02001104 CONFIG_BOOTP_ID_CACHE_SIZE
1105
1106 BOOTP packets are uniquely identified using a 32-bit ID. The
1107 server will copy the ID from client requests to responses and
1108 U-Boot will use this to determine if it is the destination of
1109 an incoming response. Some servers will check that addresses
1110 aren't in use before handing them out (usually using an ARP
1111 ping) and therefore take up to a few hundred milliseconds to
1112 respond. Network congestion may also influence the time it
1113 takes for a response to make it back to the client. If that
1114 time is too long, U-Boot will retransmit requests. In order
1115 to allow earlier responses to still be accepted after these
1116 retransmissions, U-Boot's BOOTP client keeps a small cache of
1117 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1118 cache. The default is to keep IDs for up to four outstanding
1119 requests. Increasing this will allow U-Boot to accept offers
1120 from a BOOTP client in networks with unusually high latency.
1121
stroesee0aadfb2003-08-28 14:17:32 +00001122- DHCP Advanced Options:
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001123
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001124 - Link-local IP address negotiation:
1125 Negotiate with other link-local clients on the local network
1126 for an address that doesn't require explicit configuration.
1127 This is especially useful if a DHCP server cannot be guaranteed
1128 to exist in all environments that the device must operate.
1129
1130 See doc/README.link-local for more information.
1131
Prabhakar Kushwaha2dec06f2017-11-23 16:51:32 +05301132 - MAC address from environment variables
1133
1134 FDT_SEQ_MACADDR_FROM_ENV
1135
1136 Fix-up device tree with MAC addresses fetched sequentially from
1137 environment variables. This config work on assumption that
1138 non-usable ethernet node of device-tree are either not present
1139 or their status has been marked as "disabled".
1140
wdenk145d2c12004-04-15 21:48:45 +00001141 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001142 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001143
1144 The device id used in CDP trigger frames.
1145
1146 CONFIG_CDP_DEVICE_ID_PREFIX
1147
1148 A two character string which is prefixed to the MAC address
1149 of the device.
1150
1151 CONFIG_CDP_PORT_ID
1152
1153 A printf format string which contains the ascii name of
1154 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001155 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001156
1157 CONFIG_CDP_CAPABILITIES
1158
1159 A 32bit integer which indicates the device capabilities;
1160 0x00000010 for a normal host which does not forwards.
1161
1162 CONFIG_CDP_VERSION
1163
1164 An ascii string containing the version of the software.
1165
1166 CONFIG_CDP_PLATFORM
1167
1168 An ascii string containing the name of the platform.
1169
1170 CONFIG_CDP_TRIGGER
1171
1172 A 32bit integer sent on the trigger.
1173
1174 CONFIG_CDP_POWER_CONSUMPTION
1175
1176 A 16bit integer containing the power consumption of the
1177 device in .1 of milliwatts.
1178
1179 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1180
1181 A byte containing the id of the VLAN.
1182
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001183- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001184
1185 Several configurations allow to display the current
1186 status using a LED. For instance, the LED will blink
1187 fast while running U-Boot code, stop blinking as
1188 soon as a reply to a BOOTP request was received, and
1189 start blinking slow once the Linux kernel is running
1190 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001191 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001192 feature in U-Boot.
1193
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001194 Additional options:
1195
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001196 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001197 The status LED can be connected to a GPIO pin.
1198 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001199 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001200 to include the gpio_led driver in the U-Boot binary.
1201
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001202 CONFIG_GPIO_LED_INVERTED_TABLE
1203 Some GPIO connected LEDs may have inverted polarity in which
1204 case the GPIO high value corresponds to LED off state and
1205 GPIO low value corresponds to LED on state.
1206 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1207 with a list of GPIO LEDs that have inverted polarity.
1208
Tom Rini52b2e262021-08-18 23:12:24 -04001209- I2C Support:
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001210 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06001211 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001212
1213 CONFIG_SYS_I2C_DIRECT_BUS
1214 define this, if you don't use i2c muxes on your hardware.
1215 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1216 omit this define.
1217
1218 CONFIG_SYS_I2C_MAX_HOPS
1219 define how many muxes are maximal consecutively connected
1220 on one i2c bus. If you not use i2c muxes, omit this
1221 define.
1222
1223 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001224 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001225 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1226 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1227 CONFIG_SYS_NUM_I2C_BUSES = 9:
1228
1229 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1230 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1231 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1232 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1233 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1234 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1235 {1, {I2C_NULL_HOP}}, \
1236 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1237 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1238 }
1239
1240 which defines
1241 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001242 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1243 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1244 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1245 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1246 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001247 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001248 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1249 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001250
1251 If you do not have i2c muxes on your board, omit this define.
1252
Simon Glass3efce392017-05-12 21:10:00 -06001253- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001254 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00001255 then the following macros need to be defined (examples are
1256 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001257
1258 I2C_INIT
1259
wdenkb9bbd242003-06-30 16:24:52 +00001260 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001261 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001262
wdenk544e9732004-02-06 23:19:44 +00001263 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001264
wdenkc6097192002-11-03 00:24:07 +00001265 I2C_ACTIVE
1266
1267 The code necessary to make the I2C data line active
1268 (driven). If the data line is open collector, this
1269 define can be null.
1270
wdenkb9bbd242003-06-30 16:24:52 +00001271 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1272
wdenkc6097192002-11-03 00:24:07 +00001273 I2C_TRISTATE
1274
1275 The code necessary to make the I2C data line tri-stated
1276 (inactive). If the data line is open collector, this
1277 define can be null.
1278
wdenkb9bbd242003-06-30 16:24:52 +00001279 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1280
wdenkc6097192002-11-03 00:24:07 +00001281 I2C_READ
1282
York Sun4a598092013-04-01 11:29:11 -07001283 Code that returns true if the I2C data line is high,
1284 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001285
wdenkb9bbd242003-06-30 16:24:52 +00001286 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1287
wdenkc6097192002-11-03 00:24:07 +00001288 I2C_SDA(bit)
1289
York Sun4a598092013-04-01 11:29:11 -07001290 If <bit> is true, sets the I2C data line high. If it
1291 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001292
wdenkb9bbd242003-06-30 16:24:52 +00001293 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001294 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001295 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001296
wdenkc6097192002-11-03 00:24:07 +00001297 I2C_SCL(bit)
1298
York Sun4a598092013-04-01 11:29:11 -07001299 If <bit> is true, sets the I2C clock line high. If it
1300 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001301
wdenkb9bbd242003-06-30 16:24:52 +00001302 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001303 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001304 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001305
wdenkc6097192002-11-03 00:24:07 +00001306 I2C_DELAY
1307
1308 This delay is invoked four times per clock cycle so this
1309 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001310 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001311 like:
1312
wdenkb9bbd242003-06-30 16:24:52 +00001313 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001314
Mike Frysingeree12d542010-07-21 13:38:02 -04001315 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1316
1317 If your arch supports the generic GPIO framework (asm/gpio.h),
1318 then you may alternatively define the two GPIOs that are to be
1319 used as SCL / SDA. Any of the previous I2C_xxx macros will
1320 have GPIO-based defaults assigned to them as appropriate.
1321
1322 You should define these to the GPIO value as given directly to
1323 the generic GPIO functions.
1324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001325 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001326
wdenk57b2d802003-06-27 21:31:46 +00001327 When a board is reset during an i2c bus transfer
1328 chips might think that the current transfer is still
1329 in progress. On some boards it is possible to access
1330 the i2c SCLK line directly, either by using the
1331 processor pin as a GPIO or by having a second pin
1332 connected to the bus. If this option is defined a
1333 custom i2c_init_board() routine in boards/xxx/board.c
1334 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001335
Ben Warren45657152006-09-07 16:50:54 -04001336 CONFIG_I2C_MULTI_BUS
1337
1338 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00001339 must have a controller. At any point in time, only one bus is
1340 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04001341 Note that bus numbering is zero-based.
1342
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001343 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001344
1345 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00001346 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05001347 is set, specify a list of bus-device pairs. Otherwise, specify
1348 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001349
1350 e.g.
1351 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00001352 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001353
1354 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1355
Wolfgang Denk092ae952011-10-26 10:21:21 +00001356 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06001357 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001358
1359 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1360
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001361 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001362
1363 If defined, then this indicates the I2C bus number for DDR SPD.
1364 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1365
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001366 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001367
1368 If defined, then this indicates the I2C bus number for the RTC.
1369 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1370
Andrew Dyer58c41f92008-12-29 17:36:01 -06001371 CONFIG_SOFT_I2C_READ_REPEATED_START
1372
1373 defining this will force the i2c_read() function in
1374 the soft_i2c driver to perform an I2C repeated start
1375 between writing the address pointer and reading the
1376 data. If this define is omitted the default behaviour
1377 of doing a stop-start sequence will be used. Most I2C
1378 devices can use either method, but some require one or
1379 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001380
wdenkc6097192002-11-03 00:24:07 +00001381- SPI Support: CONFIG_SPI
1382
1383 Enables SPI driver (so far only tested with
1384 SPI EEPROM, also an instance works with Crystal A/D and
1385 D/As on the SACSng board)
1386
Heiko Schocherb77c8882014-07-14 10:22:11 +02001387 CONFIG_SYS_SPI_MXC_WAIT
1388 Timeout for waiting until spi transfer completed.
1389 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1390
Matthias Fuchsa4400872007-12-27 17:12:34 +01001391- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001392
Matthias Fuchsa4400872007-12-27 17:12:34 +01001393 Enables FPGA subsystem.
1394
1395 CONFIG_FPGA_<vendor>
1396
1397 Enables support for specific chip vendors.
1398 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001399
Matthias Fuchsa4400872007-12-27 17:12:34 +01001400 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001401
Matthias Fuchsa4400872007-12-27 17:12:34 +01001402 Enables support for FPGA family.
1403 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1404
1405 CONFIG_FPGA_COUNT
1406
1407 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001408
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001409 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001410
wdenk57b2d802003-06-27 21:31:46 +00001411 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001412
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001413 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001414
wdenk4a5c8a72003-03-06 00:02:04 +00001415 Enable checks on FPGA configuration interface busy
1416 status by the configuration function. This option
1417 will require a board or device specific function to
1418 be written.
wdenkc6097192002-11-03 00:24:07 +00001419
1420 CONFIG_FPGA_DELAY
1421
1422 If defined, a function that provides delays in the FPGA
1423 configuration driver.
1424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001425 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001426 Allow Control-C to interrupt FPGA configuration
1427
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001428 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001429
wdenk4a5c8a72003-03-06 00:02:04 +00001430 Check for configuration errors during FPGA bitfile
1431 loading. For example, abort during Virtex II
1432 configuration if the INIT_B line goes low (which
1433 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001434
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001435 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001436
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001437 Maximum time to wait for the INIT_B line to de-assert
1438 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00001439 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001440 ms.
wdenkc6097192002-11-03 00:24:07 +00001441
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001442 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001443
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001444 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001445 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001447 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001448
wdenk4a5c8a72003-03-06 00:02:04 +00001449 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001450 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001451
wdenkc6097192002-11-03 00:24:07 +00001452- Vendor Parameter Protection:
1453
wdenk4a5c8a72003-03-06 00:02:04 +00001454 U-Boot considers the values of the environment
1455 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001456 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001457 are set once by the board vendor / manufacturer, and
1458 protects these variables from casual modification by
1459 the user. Once set, these variables are read-only,
1460 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001461 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001462
1463 If CONFIG_ENV_OVERWRITE is #defined in your config
1464 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001465 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001466 these parameters.
1467
Joe Hershberger76f353e2015-05-04 14:55:14 -05001468 Alternatively, if you define _both_ an ethaddr in the
1469 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001470 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001471 which can be changed exactly ONCE by the user. [The
1472 serial# is unaffected by this, i. e. it remains
1473 read-only.]
1474
Joe Hershberger71497d02012-12-11 22:16:31 -06001475 The same can be accomplished in a more flexible way
1476 for any variable by configuring the type of access
1477 to allow for those variables in the ".flags" variable
1478 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1479
wdenkc6097192002-11-03 00:24:07 +00001480- Protected RAM:
1481 CONFIG_PRAM
1482
1483 Define this variable to enable the reservation of
1484 "protected RAM", i. e. RAM which is not overwritten
1485 by U-Boot. Define CONFIG_PRAM to hold the number of
1486 kB you want to reserve for pRAM. You can overwrite
1487 this default value by defining an environment
1488 variable "pram" to the number of kB you want to
1489 reserve. Note that the board info structure will
1490 still show the full amount of RAM. If pRAM is
1491 reserved, a new environment variable "mem" will
1492 automatically be defined to hold the amount of
1493 remaining RAM in a form that can be passed as boot
1494 argument to Linux, for instance like that:
1495
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001496 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001497 saveenv
1498
1499 This way you can tell Linux not to use this memory,
1500 either, which results in a memory region that will
1501 not be affected by reboots.
1502
1503 *WARNING* If your board configuration uses automatic
1504 detection of the RAM size, you must make sure that
1505 this memory test is non-destructive. So far, the
1506 following board configurations are known to be
1507 "pRAM-clean":
1508
Heiko Schocher65d94db2017-06-07 17:33:09 +02001509 IVMS8, IVML24, SPD8xx,
Wolfgang Denk90326762012-10-24 02:36:15 +00001510 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher71cb3e92017-06-07 17:33:10 +02001511 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001512
1513- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001514 Note:
1515
wdenk57b2d802003-06-27 21:31:46 +00001516 In the current implementation, the local variables
1517 space and global environment variables space are
1518 separated. Local variables are those you define by
1519 simply typing `name=value'. To access a local
1520 variable later on, you have write `$name' or
1521 `${name}'; to execute the contents of a variable
1522 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001523
wdenk4a5c8a72003-03-06 00:02:04 +00001524 Global environment variables are those you use
1525 setenv/printenv to work with. To run a command stored
1526 in such a variable, you need to use the run command,
1527 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001528
1529 To store commands and special characters in a
1530 variable, please use double quotation marks
1531 surrounding the whole text of the variable, instead
1532 of the backslashes before semicolons and special
1533 symbols.
1534
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001535- Command Line Editing and History:
Marek Vasut734fb042016-01-27 04:47:55 +01001536 CONFIG_CMDLINE_PS_SUPPORT
1537
1538 Enable support for changing the command prompt string
1539 at run-time. Only static string is supported so far.
1540 The string is obtained from environment variables PS1
1541 and PS2.
1542
wdenkc0aa5c52003-12-06 19:49:23 +00001543- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001544 CONFIG_EXTRA_ENV_SETTINGS
1545
wdenk4a5c8a72003-03-06 00:02:04 +00001546 Define this to contain any number of null terminated
1547 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001548 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001549
wdenk4a5c8a72003-03-06 00:02:04 +00001550 For example, place something like this in your
1551 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001552
1553 #define CONFIG_EXTRA_ENV_SETTINGS \
1554 "myvar1=value1\0" \
1555 "myvar2=value2\0"
1556
wdenk4a5c8a72003-03-06 00:02:04 +00001557 Warning: This method is based on knowledge about the
1558 internal format how the environment is stored by the
1559 U-Boot code. This is NOT an official, exported
1560 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001561 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001562 You better know what you are doing here.
1563
wdenk4a5c8a72003-03-06 00:02:04 +00001564 Note: overly (ab)use of the default environment is
1565 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001566 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00001567 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001568
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001569 CONFIG_DELAY_ENVIRONMENT
1570
1571 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001572 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00001573 that so that the environment is not available until
1574 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1575 this is instead controlled by the value of
1576 /config/load-environment.
1577
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001578 CONFIG_STANDALONE_LOAD_ADDR
1579
Wolfgang Denk23f78482011-10-09 21:06:34 +02001580 This option defines a board specific value for the
1581 address where standalone program gets loaded, thus
1582 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001583 settings.
1584
1585- Frame Buffer Address:
1586 CONFIG_FB_ADDR
1587
1588 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00001589 address for frame buffer. This is typically the case
1590 when using a graphics controller has separate video
1591 memory. U-Boot will then place the frame buffer at
1592 the given address instead of dynamically reserving it
1593 in system RAM by calling lcd_setmem(), which grabs
1594 the memory for the frame buffer depending on the
1595 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02001596
1597 Please see board_init_f function.
1598
Detlev Zundel0ecb6112009-12-01 17:16:19 +01001599- Automatic software updates via TFTP server
1600 CONFIG_UPDATE_TFTP
1601 CONFIG_UPDATE_TFTP_CNT_MAX
1602 CONFIG_UPDATE_TFTP_MSEC_MAX
1603
1604 These options enable and control the auto-update feature;
1605 for a more detailed description refer to doc/README.update.
1606
1607- MTD Support (mtdparts command, UBI support)
Heiko Schocherf5895d12014-06-24 10:10:04 +02001608 CONFIG_MTD_UBI_WL_THRESHOLD
1609 This parameter defines the maximum difference between the highest
1610 erase counter value and the lowest erase counter value of eraseblocks
1611 of UBI devices. When this threshold is exceeded, UBI starts performing
1612 wear leveling by means of moving data from eraseblock with low erase
1613 counter to eraseblocks with high erase counter.
1614
1615 The default value should be OK for SLC NAND flashes, NOR flashes and
1616 other flashes which have eraseblock life-cycle 100000 or more.
1617 However, in case of MLC NAND flashes which typically have eraseblock
1618 life-cycle less than 10000, the threshold should be lessened (e.g.,
1619 to 128 or 256, although it does not have to be power of 2).
1620
1621 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06001622
Heiko Schocherf5895d12014-06-24 10:10:04 +02001623 CONFIG_MTD_UBI_BEB_LIMIT
1624 This option specifies the maximum bad physical eraseblocks UBI
1625 expects on the MTD device (per 1024 eraseblocks). If the
1626 underlying flash does not admit of bad eraseblocks (e.g. NOR
1627 flash), this value is ignored.
1628
1629 NAND datasheets often specify the minimum and maximum NVM
1630 (Number of Valid Blocks) for the flashes' endurance lifetime.
1631 The maximum expected bad eraseblocks per 1024 eraseblocks
1632 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1633 which gives 20 for most NANDs (MaxNVB is basically the total
1634 count of eraseblocks on the chip).
1635
1636 To put it differently, if this value is 20, UBI will try to
1637 reserve about 1.9% of physical eraseblocks for bad blocks
1638 handling. And that will be 1.9% of eraseblocks on the entire
1639 NAND chip, not just the MTD partition UBI attaches. This means
1640 that if you have, say, a NAND flash chip admits maximum 40 bad
1641 eraseblocks, and it is split on two MTD partitions of the same
1642 size, UBI will reserve 40 eraseblocks when attaching a
1643 partition.
1644
1645 default: 20
1646
1647 CONFIG_MTD_UBI_FASTMAP
1648 Fastmap is a mechanism which allows attaching an UBI device
1649 in nearly constant time. Instead of scanning the whole MTD device it
1650 only has to locate a checkpoint (called fastmap) on the device.
1651 The on-flash fastmap contains all information needed to attach
1652 the device. Using fastmap makes only sense on large devices where
1653 attaching by scanning takes long. UBI will not automatically install
1654 a fastmap on old images, but you can set the UBI parameter
1655 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1656 that fastmap-enabled images are still usable with UBI implementations
1657 without fastmap support. On typical flash devices the whole fastmap
1658 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1659
1660 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1661 Set this parameter to enable fastmap automatically on images
1662 without a fastmap.
1663 default: 0
1664
Heiko Schocher94b66de2015-10-22 06:19:21 +02001665 CONFIG_MTD_UBI_FM_DEBUG
1666 Enable UBI fastmap debug
1667 default: 0
1668
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001669- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02001670 CONFIG_SPL
1671 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001672
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001673 CONFIG_SPL_MAX_FOOTPRINT
1674 Maximum size in memory allocated to the SPL, BSS included.
1675 When defined, the linker checks that the actual memory
1676 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00001677 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001678 must not be both defined at the same time.
1679
Tom Rini36853852012-02-14 07:29:40 +00001680 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001681 Maximum size of the SPL image (text, data, rodata, and
1682 linker lists sections), BSS excluded.
1683 When defined, the linker checks that the actual size does
1684 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00001685
Scott Woodc4f0d002012-09-20 19:05:12 -05001686 CONFIG_SPL_RELOC_TEXT_BASE
1687 Address to relocate to. If unspecified, this is equal to
1688 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
1689
Tom Rini36853852012-02-14 07:29:40 +00001690 CONFIG_SPL_BSS_START_ADDR
1691 Link address for the BSS within the SPL binary.
1692
1693 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001694 Maximum size in memory allocated to the SPL BSS.
1695 When defined, the linker checks that the actual memory used
1696 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00001697 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00001698 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00001699
1700 CONFIG_SPL_STACK
1701 Adress of the start of the stack SPL will use
1702
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02001703 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1704 When defined, SPL will panic() if the image it has
1705 loaded does not have a signature.
1706 Defining this is useful when code which loads images
1707 in SPL cannot guarantee that absolutely all read errors
1708 will be caught.
1709 An example is the LPC32XX MLC NAND driver, which will
1710 consider that a completely unreadable NAND block is bad,
1711 and thus should be skipped silently.
1712
Scott Woodc4f0d002012-09-20 19:05:12 -05001713 CONFIG_SPL_RELOC_STACK
1714 Adress of the start of the stack SPL will use after
1715 relocation. If unspecified, this is equal to
1716 CONFIG_SPL_STACK.
1717
Tom Rini36853852012-02-14 07:29:40 +00001718 CONFIG_SYS_SPL_MALLOC_START
1719 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02001720 When this option is set the full malloc is used in SPL and
1721 it is set up by spl_init() and before that, the simple malloc()
1722 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00001723
1724 CONFIG_SYS_SPL_MALLOC_SIZE
1725 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00001726
Tom Rinife3b0c72012-08-13 11:37:56 -07001727 CONFIG_SPL_DISPLAY_PRINT
1728 For ARM, enable an optional function to print more information
1729 about the running system.
1730
Scott Wood7c810902012-09-20 16:35:21 -05001731 CONFIG_SPL_INIT_MINIMAL
1732 Arch init code should be built for a very small image
1733
Peter Korsgaard01b542f2013-05-13 08:36:29 +00001734 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
1735 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
1736 Sector and number of sectors to load kernel argument
1737 parameters from when MMC is being used in raw mode
1738 (for falcon mode)
1739
Guillaume GARDET5065b712014-10-15 17:53:13 +02001740 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
1741 Filename to read to load U-Boot when reading from filesystem
1742
1743 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001744 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02001745 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001746
Guillaume GARDET5065b712014-10-15 17:53:13 +02001747 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001748 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02001749 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00001750
Scott Wood2b36fbb2012-12-06 13:33:17 +00001751 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1752 Set this for NAND SPL on PPC mpc83xx targets, so that
1753 start.S waits for the rest of the SPL to load before
1754 continuing (the hardware starts execution after just
1755 loading the first page rather than the full 4K).
1756
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05301757 CONFIG_SPL_SKIP_RELOCATE
1758 Avoid SPL relocation
1759
Thomas Gleixner820d24d2016-07-12 20:28:12 +02001760 CONFIG_SPL_UBI
1761 Support for a lightweight UBI (fastmap) scanner and
1762 loader
1763
Heiko Schochercf000272014-10-31 08:31:00 +01001764 CONFIG_SPL_NAND_RAW_ONLY
1765 Support to boot only raw u-boot.bin images. Use this only
1766 if you need to save space.
1767
Ying Zhangdfb2b152013-08-16 15:16:12 +08001768 CONFIG_SPL_COMMON_INIT_DDR
1769 Set for common ddr init with serial presence detect in
1770 SPL binary.
1771
Tom Rini36853852012-02-14 07:29:40 +00001772 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1773 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1774 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1775 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1776 CONFIG_SYS_NAND_ECCBYTES
1777 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05001778 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00001779
Scott Wood36c440e2012-09-21 18:35:27 -05001780 CONFIG_SYS_NAND_U_BOOT_DST
1781 Location in memory to load U-Boot to
1782
1783 CONFIG_SYS_NAND_U_BOOT_SIZE
1784 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00001785
1786 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05001787 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00001788
1789 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1790 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001791 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00001792
Pavel Machekde997252012-08-30 22:42:11 +02001793 CONFIG_SPL_RAM_DEVICE
1794 Support for running image already present in ram, in SPL binary
1795
Scott Woodeb7bd972012-12-06 13:33:16 +00001796 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00001797 Image offset to which the SPL should be padded before appending
1798 the SPL payload. By default, this is defined as
1799 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1800 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1801 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00001802
Scott Woodf147eb72012-09-21 16:27:32 -05001803 CONFIG_SPL_TARGET
1804 Final target image containing SPL and payload. Some SPLs
1805 use an arch-specific makefile fragment instead, for
1806 example if more than one image needs to be produced.
1807
Marek Vasut9f2e0eb2018-05-13 00:22:52 +02001808 CONFIG_SPL_FIT_PRINT
Simon Glass82d94532013-05-08 08:05:59 +00001809 Printing information about a FIT image adds quite a bit of
1810 code to SPL. So this is normally disabled in SPL. Use this
1811 option to re-enable it. This will affect the output of the
1812 bootm command when booting a FIT image.
1813
Ying Zhang2d2e3b62013-08-16 15:16:15 +08001814- TPL framework
1815 CONFIG_TPL
1816 Enable building of TPL globally.
1817
1818 CONFIG_TPL_PAD_TO
1819 Image offset to which the TPL should be padded before appending
1820 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001821 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1822 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1823 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08001824
wdenkc0aa5c52003-12-06 19:49:23 +00001825- Interrupt support (PPC):
1826
wdenk1ebf41e2004-01-02 14:00:00 +00001827 There are common interrupt_init() and timer_interrupt()
1828 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001829 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00001830 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001831 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00001832 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001833 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00001834 specific handling. If board has watchdog / status_led
1835 / other_activity_monitor it works automatically from
1836 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00001837
wdenkc6097192002-11-03 00:24:07 +00001838
Helmut Raigerd5a184b2011-10-20 04:19:47 +00001839Board initialization settings:
1840------------------------------
1841
1842During Initialization u-boot calls a number of board specific functions
1843to allow the preparation of board specific prerequisites, e.g. pin setup
1844before drivers are initialized. To enable these callbacks the
1845following configuration macros have to be defined. Currently this is
1846architecture specific, so please check arch/your_architecture/lib/board.c
1847typically in board_init_f() and board_init_r().
1848
1849- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1850- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1851- CONFIG_BOARD_LATE_INIT: Call board_late_init()
wdenkc6097192002-11-03 00:24:07 +00001852
wdenkc6097192002-11-03 00:24:07 +00001853Configuration Settings:
1854-----------------------
1855
Simon Glass8927bf22019-12-28 10:45:10 -07001856- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun6c480012014-02-26 17:03:19 -08001857 Optionally it can be defined to support 64-bit memory commands.
1858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001859- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00001860 undefine this when you're short of memory.
1861
Peter Tyserdfb72b82009-01-27 18:03:12 -06001862- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
1863 width of the commands listed in the 'help' command output.
1864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001865- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00001866 prompt for user input.
1867
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001868- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00001869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001870- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00001871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001872- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00001873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001874- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00001875 the application (usually a Linux kernel) when it is
1876 booted
1877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001878- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00001879 List of legal baudrate settings for this board.
1880
York Sun5d286cd2015-12-04 11:57:07 -08001881- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07001882 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08001883 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
1884 is substracted from total RAM and won't be reported to OS.
1885 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07001886 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08001887 the RAM base is not zero, or RAM is divided into banks,
1888 this variable needs to be recalcuated to get the address.
1889
York Sun50739372015-12-07 11:05:29 -08001890- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001891 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01001892 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001893 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01001894 fixing up gd->ram_size the Linux kernel should gets passed
1895 the now "corrected" memory size and won't touch it either.
1896 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01001897 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01001898 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01001899 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01001900
1901 This option can be used as a workaround for the 440EPx/GRx
1902 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
1903 be touched.
1904
1905 WARNING: Please make sure that this value is a multiple of
1906 the Linux page size (normally 4k). If this is not the case,
1907 then the end address of the Linux memory will be located at a
1908 non page size aligned address and this could cause major
1909 problems.
1910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001911- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00001912 Enable temporary baudrate change while serial download
1913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001914- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00001915 Physical start address of SDRAM. _Must_ be 0 here.
1916
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001917- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00001918 Physical start address of Flash memory.
1919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001920- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00001921 Physical start address of boot monitor code (set by
1922 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02001923 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001924 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00001925
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001926- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00001927 Size of memory reserved for monitor code, used to
1928 determine _at_compile_time_ (!) if the environment is
1929 embedded within the U-Boot image, or in a separate
1930 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001932- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00001933 Size of DRAM reserved for malloc() use.
1934
Simon Glass863e4042014-07-10 22:23:28 -06001935- CONFIG_SYS_MALLOC_F_LEN
1936 Size of the malloc() pool for use before relocation. If
1937 this is defined, then a very simple malloc() implementation
1938 will become available before relocation. The address is just
1939 below the global data, and the stack is moved down to make
1940 space.
1941
1942 This feature allocates regions with increasing addresses
1943 within the region. calloc() is supported, but realloc()
1944 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001945 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06001946 U-Boot relocates itself.
1947
Simon Glass9fa901b2014-11-10 17:16:54 -07001948- CONFIG_SYS_MALLOC_SIMPLE
1949 Provides a simple and small malloc() and calloc() for those
1950 boards which do not use the full malloc in SPL (which is
1951 enabled with CONFIG_SYS_SPL_MALLOC_START).
1952
Thierry Redingc97d9742014-12-09 22:25:22 -07001953- CONFIG_SYS_NONCACHED_MEMORY:
1954 Size of non-cached memory area. This area of memory will be
1955 typically located right below the malloc() area and mapped
1956 uncached in the MMU. This is useful for drivers that would
1957 otherwise require a lot of explicit cache maintenance. For
1958 some drivers it's also impossible to properly maintain the
1959 cache. For example if the regions that need to be flushed
1960 are not a multiple of the cache-line size, *and* padding
1961 cannot be allocated between the regions to align them (i.e.
1962 if the HW requires a contiguous array of regions, and the
1963 size of each region is not cache-aligned), then a flush of
1964 one region may result in overwriting data that hardware has
1965 written to another region in the same cache-line. This can
1966 happen for example in network drivers where descriptors for
1967 buffers are typically smaller than the CPU cache-line (e.g.
1968 16 bytes vs. 32 or 64 bytes).
1969
1970 Non-cached memory is only supported on 32-bit ARM at present.
1971
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001972- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01001973 Normally compressed uImages are limited to an
1974 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001975 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01001976 to adjust this setting to your needs.
1977
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001978- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00001979 Maximum size of memory mapped by the startup code of
1980 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02001981 the Linux kernel (bd_info, boot arguments, FDT blob if
1982 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04001983 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02001984 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00001985 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00001986 variable "bootm_mapsize" will override the value of
1987 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
1988 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00001989
John Rigbyeea8e692010-10-13 13:57:35 -06001990- CONFIG_SYS_BOOT_RAMDISK_HIGH:
1991 Enable initrd_high functionality. If defined then the
1992 initrd_high feature is enabled and the bootm ramdisk subcommand
1993 is enabled.
1994
1995- CONFIG_SYS_BOOT_GET_CMDLINE:
1996 Enables allocating and saving kernel cmdline in space between
1997 "bootm_low" and "bootm_low" + BOOTMAPSZ.
1998
1999- CONFIG_SYS_BOOT_GET_KBD:
2000 Enables allocating and saving a kernel copy of the bd_info in
2001 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2002
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002003- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002004 Max number of sectors on a Flash chip
2005
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002006- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002007 Timeout for Flash erase operations (in ms)
2008
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002009- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002010 Timeout for Flash write operations (in ms)
2011
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002012- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002013 Timeout for Flash set sector lock bit operation (in ms)
2014
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002015- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002016 Timeout for Flash clear lock bits operation (in ms)
2017
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002018- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002019 If defined, hardware flash sectors protection is used
2020 instead of U-Boot software protection.
2021
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002022- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002023
2024 Enable TFTP transfers directly to flash memory;
2025 without this option such a download has to be
2026 performed in two steps: (1) download to RAM, and (2)
2027 copy from RAM to flash.
2028
2029 The two-step approach is usually more reliable, since
2030 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002031 the flash, but in some situations (when system RAM is
2032 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002033 downloaded image) this option may be very useful.
2034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002035- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002036 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002037 common flash structure for storing flash geometry.
2038
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002039- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002040 This option also enables the building of the cfi_flash driver
2041 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002042
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002043- CONFIG_FLASH_CFI_MTD
2044 This option enables the building of the cfi_mtd driver
2045 in the drivers directory. The driver exports CFI flash
2046 to the MTD layer.
2047
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002048- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002049 Use buffered writes to flash.
2050
2051- CONFIG_FLASH_SPANSION_S29WS_N
2052 s29ws-n MirrorBit flash has non-standard addresses for buffered
2053 write commands.
2054
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002055- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002056 If this option is defined, the common CFI flash doesn't
2057 print it's warning upon not recognized FLASH banks. This
2058 is useful, if some of the configured banks are only
2059 optionally available.
2060
Jerry Van Barenaae73572008-03-08 13:48:01 -05002061- CONFIG_FLASH_SHOW_PROGRESS
2062 If defined (must be an integer), print out countdown
2063 digits and dots. Recommended value: 45 (9..1) for 80
2064 column displays, 15 (3..1) for 40 column displays.
2065
Stefan Roesed20cba52013-04-04 15:53:14 +02002066- CONFIG_FLASH_VERIFY
2067 If defined, the content of the flash (destination) is compared
2068 against the source after the write operation. An error message
2069 will be printed when the contents are not identical.
2070 Please note that this option is useless in nearly all cases,
2071 since such flash programming errors usually are detected earlier
2072 while unprotecting/erasing/programming. Please only enable
2073 this option if you really know what you are doing.
2074
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002075- CONFIG_ENV_MAX_ENTRIES
2076
Wolfgang Denk1136f692010-10-27 22:48:30 +02002077 Maximum number of entries in the hash table that is used
2078 internally to store the environment settings. The default
2079 setting is supposed to be generous and should work in most
2080 cases. This setting can be used to tune behaviour; see
2081 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02002082
Joe Hershberger71497d02012-12-11 22:16:31 -06002083- CONFIG_ENV_FLAGS_LIST_DEFAULT
2084- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04002085 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06002086 calling env set. Variables can be restricted to only decimal,
2087 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2088 the variables can also be restricted to IP address or MAC address.
2089
2090 The format of the list is:
2091 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002092 access_attribute = [a|r|o|c]
2093 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06002094 entry = variable_name[:attributes]
2095 list = entry[,list]
2096
2097 The type attributes are:
2098 s - String (default)
2099 d - Decimal
2100 x - Hexadecimal
2101 b - Boolean ([1yYtT|0nNfF])
2102 i - IP address
2103 m - MAC address
2104
Joe Hershberger6fe26c92012-12-11 22:16:34 -06002105 The access attributes are:
2106 a - Any (default)
2107 r - Read-only
2108 o - Write-once
2109 c - Change-default
2110
Joe Hershberger71497d02012-12-11 22:16:31 -06002111 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2112 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002113 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06002114
2115 - CONFIG_ENV_FLAGS_LIST_STATIC
2116 Define this to a list (string) to define validation that
2117 should be done if an entry is not found in the ".flags"
2118 environment variable. To override a setting in the static
2119 list, simply add an entry for the same variable name to the
2120 ".flags" variable.
2121
Joe Hershberger6db9fd42015-05-20 14:27:20 -05002122 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2123 regular expression. This allows multiple variables to define the same
2124 flags without explicitly listing them for each variable.
2125
wdenkc6097192002-11-03 00:24:07 +00002126The following definitions that deal with the placement and management
2127of environment data (variable area); in general, we support the
2128following configurations:
2129
Mike Frysinger63b8f122011-07-08 10:44:25 +00002130- CONFIG_BUILD_ENVCRC:
2131
2132 Builds up envcrc with the target environment so that external utils
2133 may easily extract it and embed it in final U-Boot images.
2134
wdenkc6097192002-11-03 00:24:07 +00002135BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002136in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002137console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002138U-Boot will hang.
2139
2140Please note that even with NVRAM we still use a copy of the
2141environment in RAM: we could work on NVRAM directly, but we want to
2142keep settings there always unmodified except somebody uses "saveenv"
2143to save the current settings.
2144
Liu Gang85bcd732012-03-08 00:33:20 +00002145BE CAREFUL! For some special cases, the local device can not use
2146"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00002147environment stored in a remote NOR flash by SRIO or PCIE link,
2148but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00002149
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002150- CONFIG_NAND_ENV_DST
2151
2152 Defines address in RAM to which the nand_spl code should copy the
2153 environment. If redundant environment is used, it will be copied to
2154 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2155
Bruce Adleredecc942007-11-02 13:15:42 -07002156Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002157has been relocated to RAM and a RAM copy of the environment has been
Simon Glass64b723f2017-08-03 12:22:12 -06002158created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00002159until then to read environment variables.
2160
wdenk8dba0502003-03-31 16:34:49 +00002161The environment is protected by a CRC32 checksum. Before the monitor
2162is relocated into RAM, as a result of a bad CRC you will be working
2163with the compiled-in default environment - *silently*!!! [This is
2164necessary, because the first environment variable we need is the
2165"baudrate" setting for the console - if we have a bad CRC, we don't
2166have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002167
2168Note: once the monitor has been relocated, then it will complain if
2169the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002170use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002171
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002172- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002173 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002174
Ron Madriddfa028a2009-02-18 14:30:44 -08002175- CONFIG_NS16550_MIN_FUNCTIONS:
2176 Define this if you desire to only have use of the NS16550_init
2177 and NS16550_putc functions for the serial driver located at
2178 drivers/serial/ns16550.c. This option is useful for saving
2179 space for already greatly restricted images, including but not
2180 limited to NAND_SPL configurations.
2181
Simon Glass28a9e332012-11-30 13:01:18 +00002182- CONFIG_DISPLAY_BOARDINFO
2183 Display information about the board that U-Boot is running on
2184 when U-Boot starts up. The board function checkboard() is called
2185 to do this.
2186
Simon Glasse8822012012-11-30 13:01:19 +00002187- CONFIG_DISPLAY_BOARDINFO_LATE
2188 Similar to the previous option, but display this information
2189 later, once stdio is running and output goes to the LCD, if
2190 present.
2191
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02002192- CONFIG_BOARD_SIZE_LIMIT:
2193 Maximum size of the U-Boot image. When defined, the
2194 build system checks that the actual size does not
2195 exceed it.
2196
wdenkc6097192002-11-03 00:24:07 +00002197Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002198---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002200- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002201 Cache Line Size of the CPU.
2202
Timur Tabid8f341c2011-08-04 18:03:41 -05002203- CONFIG_SYS_CCSRBAR_DEFAULT:
2204 Default (power-on reset) physical address of CCSR on Freescale
2205 PowerPC SOCs.
2206
2207- CONFIG_SYS_CCSRBAR:
2208 Virtual address of CCSR. On a 32-bit build, this is typically
2209 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2210
Timur Tabid8f341c2011-08-04 18:03:41 -05002211- CONFIG_SYS_CCSRBAR_PHYS:
2212 Physical address of CCSR. CCSR can be relocated to a new
2213 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00002214 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05002215 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2216 is typically relocated on 36-bit builds. It is recommended
2217 that this macro be defined via the _HIGH and _LOW macros:
2218
2219 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2220 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2221
2222- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002223 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2224 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05002225 used in assembly code, so it must not contain typecasts or
2226 integer size suffixes (e.g. "ULL").
2227
2228- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2229 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2230 used in assembly code, so it must not contain typecasts or
2231 integer size suffixes (e.g. "ULL").
2232
2233- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2234 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2235 forced to a value that ensures that CCSR is not relocated.
2236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002237- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002238 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy069fa832017-07-06 10:23:22 +02002239 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002241- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002242
wdenkeb20ad32003-09-05 23:19:14 +00002243 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002244 initial data and stack; please note that this must be
2245 writable memory that is working WITHOUT special
2246 initialization, i. e. you CANNOT use normal RAM which
2247 will become available only after programming the
2248 memory controller and running certain initialization
2249 sequences.
2250
2251 U-Boot uses the following memory types:
Christophe Leroy069fa832017-07-06 10:23:22 +02002252 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00002253
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002254- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002255
2256 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002257 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2258 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002259 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02002260 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06002261 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002262 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2263 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002264
2265 Note:
2266 On the MPC824X (or other systems that use the data
2267 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002268 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002269 point to an otherwise UNUSED address space between
2270 the top of RAM and the start of the PCI space.
2271
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002272- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002273
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002274- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002275 SDRAM timing
2276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002277- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002278 periodic timer for refresh
2279
Kumar Gala8975d7a2010-12-30 12:09:53 -06002280- CONFIG_SYS_SRIO:
2281 Chip has SRIO or not
2282
2283- CONFIG_SRIO1:
2284 Board has SRIO 1 port available
2285
2286- CONFIG_SRIO2:
2287 Board has SRIO 2 port available
2288
Liu Gang27afb9c2013-05-07 16:30:46 +08002289- CONFIG_SRIO_PCIE_BOOT_MASTER
2290 Board can support master function for Boot from SRIO and PCIE
2291
Kumar Gala8975d7a2010-12-30 12:09:53 -06002292- CONFIG_SYS_SRIOn_MEM_VIRT:
2293 Virtual Address of SRIO port 'n' memory region
2294
Simon Glass970b61e2019-11-14 12:57:09 -07002295- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Gala8975d7a2010-12-30 12:09:53 -06002296 Physical Address of SRIO port 'n' memory region
2297
2298- CONFIG_SYS_SRIOn_MEM_SIZE:
2299 Size of SRIO port 'n' memory region
2300
Fabio Estevamf17e8782013-04-11 09:35:34 +00002301- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2302 Defined to tell the NAND controller that the NAND chip is using
2303 a 16 bit bus.
2304 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00002305 Example of drivers that use it:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002306 - drivers/mtd/nand/raw/ndfc.c
2307 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04002308
2309- CONFIG_SYS_NDFC_EBC0_CFG
2310 Sets the EBC0_CFG register for the NDFC. If not defined
2311 a default value will be used.
2312
Ben Warren45657152006-09-07 16:50:54 -04002313- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002314 Get DDR timing information from an I2C EEPROM. Common
2315 with pluggable memory modules such as SODIMMs
2316
Ben Warren45657152006-09-07 16:50:54 -04002317 SPD_EEPROM_ADDRESS
2318 I2C address of the SPD EEPROM
2319
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002320- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002321 If SPD EEPROM is on an I2C bus other than the first
2322 one, specify here. Note that the value must resolve
2323 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002324
York Sune73cc042011-06-07 09:42:16 +08002325- CONFIG_SYS_DDR_RAW_TIMING
2326 Get DDR timing information from other than SPD. Common with
2327 soldered DDR chips onboard without SPD. DDR raw timing
2328 parameters are extracted from datasheet and hard-coded into
2329 header files or board specific files.
2330
York Sunbd495cf2011-09-16 13:21:35 -07002331- CONFIG_FSL_DDR_INTERACTIVE
2332 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2333
York Sun8ced0502015-01-06 13:18:55 -08002334- CONFIG_FSL_DDR_SYNC_REFRESH
2335 Enable sync of refresh for multiple controllers.
2336
York Sunb6a35f82015-03-19 09:30:28 -07002337- CONFIG_FSL_DDR_BIST
2338 Enable built-in memory test for Freescale DDR controllers.
2339
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002340- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002341 Only for 83xx systems. If specified, then DDR should
2342 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002343
wdenk6203e402004-04-18 10:13:26 +00002344- CONFIG_RMII
2345 Enable RMII mode for all FECs.
2346 Note that this is a global option, we can't
2347 have one FEC in standard MII mode and another in RMII mode.
2348
wdenk20c98a62004-04-23 20:32:05 +00002349- CONFIG_CRC32_VERIFY
2350 Add a verify option to the crc32 command.
2351 The syntax is:
2352
2353 => crc32 -v <address> <count> <crc32>
2354
2355 Where address/count indicate a memory area
2356 and crc32 is the correct crc32 which the
2357 area should have.
2358
wdenk64519362004-07-11 17:40:54 +00002359- CONFIG_LOOPW
2360 Add the "loopw" memory command. This only takes effect if
Simon Glass92ffdee2017-08-04 16:34:27 -06002361 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk64519362004-07-11 17:40:54 +00002362
Joel Johnsondb5a97e2020-01-29 09:17:18 -07002363- CONFIG_CMD_MX_CYCLIC
stroesecc3af832004-12-16 18:46:55 +00002364 Add the "mdc" and "mwc" memory commands. These are cyclic
2365 "md/mw" commands.
2366 Examples:
2367
wdenk07d7e6b2004-12-16 21:44:03 +00002368 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002369 This command will print 4 bytes (10,11,12,13) each 500 ms.
2370
wdenk07d7e6b2004-12-16 21:44:03 +00002371 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002372 This command will write 12345678 to address 100 all 10 ms.
2373
wdenk07d7e6b2004-12-16 21:44:03 +00002374 This only takes effect if the memory commands are activated
Simon Glass92ffdee2017-08-04 16:34:27 -06002375 globally (CONFIG_CMD_MEMORY).
stroesecc3af832004-12-16 18:46:55 +00002376
Aneesh V552a3192011-07-13 05:11:07 +00002377- CONFIG_SPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002378 Set when the currently-running compilation is for an artifact
2379 that will end up in the SPL (as opposed to the TPL or U-Boot
2380 proper). Code that needs stage-specific behavior should check
2381 this.
wdenk336b2bc2005-04-02 23:52:25 +00002382
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002383- CONFIG_TPL_BUILD
Thomas Hebbfd37f242019-11-13 18:18:03 -08002384 Set when the currently-running compilation is for an artifact
2385 that will end up in the TPL (as opposed to the SPL or U-Boot
2386 proper). Code that needs stage-specific behavior should check
2387 this.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08002388
Ying Zhang0d4f5442013-05-20 14:07:23 +08002389- CONFIG_SYS_MPC85XX_NO_RESETVEC
2390 Only for 85xx systems. If this variable is specified, the section
2391 .resetvec is not kept and the section .bootpg is placed in the
2392 previous 4k of the .text section.
2393
Simon Glass17dabf02013-02-24 17:33:14 +00002394- CONFIG_ARCH_MAP_SYSMEM
2395 Generally U-Boot (and in particular the md command) uses
2396 effective address. It is therefore not necessary to regard
2397 U-Boot address as virtual addresses that need to be translated
2398 to physical addresses. However, sandbox requires this, since
2399 it maintains its own little RAM buffer which contains all
2400 addressable memory. This option causes some memory accesses
2401 to be mapped through map_sysmem() / unmap_sysmem().
2402
Simon Glassbfb59802013-02-14 04:18:54 +00002403- CONFIG_X86_RESET_VECTOR
2404 If defined, the x86 reset vector code is included. This is not
2405 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00002406
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002407- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2408 Option to disable subpage write in NAND driver
2409 driver that uses this:
Miquel Raynal1f1ae152018-08-16 17:30:07 +02002410 drivers/mtd/nand/raw/davinci_nand.c
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04002411
Timur Tabi275f4bb2011-11-22 09:21:25 -06002412Freescale QE/FMAN Firmware Support:
2413-----------------------------------
2414
2415The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2416loading of "firmware", which is encoded in the QE firmware binary format.
2417This firmware often needs to be loaded during U-Boot booting, so macros
2418are used to identify the storage device (NOR flash, SPI, etc) and the address
2419within that device.
2420
Zhao Qiang83a90842014-03-21 16:21:44 +08002421- CONFIG_SYS_FMAN_FW_ADDR
2422 The address in the storage device where the FMAN microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002423 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiang83a90842014-03-21 16:21:44 +08002424 is also specified.
2425
2426- CONFIG_SYS_QE_FW_ADDR
2427 The address in the storage device where the QE microcode is located. The
Tom Rinifa911f82019-05-12 07:59:12 -04002428 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabi275f4bb2011-11-22 09:21:25 -06002429 is also specified.
2430
2431- CONFIG_SYS_QE_FMAN_FW_LENGTH
2432 The maximum possible size of the firmware. The firmware binary format
2433 has a field that specifies the actual size of the firmware, but it
2434 might not be possible to read any part of the firmware unless some
2435 local storage is allocated to hold the entire firmware first.
2436
2437- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2438 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2439 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2440 virtual address in NOR flash.
2441
2442- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2443 Specifies that QE/FMAN firmware is located in NAND flash.
2444 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2445
2446- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2447 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2448 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2449
Liu Gang1e084582012-03-08 00:33:18 +00002450- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2451 Specifies that QE/FMAN firmware is located in the remote (master)
2452 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00002453 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2454 window->master inbound window->master LAW->the ucode address in
2455 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06002456
J. German Rivera8ff14b72014-06-23 15:15:55 -07002457Freescale Layerscape Management Complex Firmware Support:
2458---------------------------------------------------------
2459The Freescale Layerscape Management Complex (MC) supports the loading of
2460"firmware".
2461This firmware often needs to be loaded during U-Boot booting, so macros
2462are used to identify the storage device (NOR flash, SPI, etc) and the address
2463within that device.
2464
2465- CONFIG_FSL_MC_ENET
2466 Enable the MC driver for Layerscape SoCs.
2467
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302468Freescale Layerscape Debug Server Support:
2469-------------------------------------------
2470The Freescale Layerscape Debug Server Support supports the loading of
2471"Debug Server firmware" and triggering SP boot-rom.
2472This firmware often needs to be loaded during U-Boot booting.
2473
York Sun928b6812015-12-07 11:08:58 -08002474- CONFIG_SYS_MC_RSV_MEM_ALIGN
2475 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05302476
Paul Kocialkowski7b917022015-07-26 18:48:15 +02002477Reproducible builds
2478-------------------
2479
2480In order to achieve reproducible builds, timestamps used in the U-Boot build
2481process have to be set to a fixed value.
2482
2483This is done using the SOURCE_DATE_EPOCH environment variable.
2484SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2485option for U-Boot or an environment variable in U-Boot.
2486
2487SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2488
wdenkc6097192002-11-03 00:24:07 +00002489Building the Software:
2490======================
2491
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002492Building U-Boot has been tested in several native build environments
2493and in many different cross environments. Of course we cannot support
2494all possibly existing versions of cross development tools in all
2495(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayamae0cc1852020-10-08 13:17:16 +09002496recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002497which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002498
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002499If you are not using a native environment, it is assumed that you
2500have GNU cross compiling tools available in your path. In this case,
2501you must set the environment variable CROSS_COMPILE in your shell.
2502Note that no changes to the Makefile or any other source files are
2503necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002504
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002505 $ CROSS_COMPILE=ppc_4xx-
2506 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002507
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002508U-Boot is intended to be simple to build. After installing the
2509sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002510is done by typing:
2511
Holger Freyther7ba4e572014-08-04 09:26:05 +02002512 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00002513
Holger Freyther7ba4e572014-08-04 09:26:05 +02002514where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01002515rations; see configs/*_defconfig for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00002516
Heinrich Schuchardtd6e07af2020-02-24 18:36:30 +01002517Note: for some boards special configuration names may exist; check if
wdenk6c59edc2004-05-03 20:45:30 +00002518 additional information is available from the board vendor; for
2519 instance, the TQM823L systems are available without (standard)
2520 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002521 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002522
Holger Freyther7ba4e572014-08-04 09:26:05 +02002523 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002524 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002525
Holger Freyther7ba4e572014-08-04 09:26:05 +02002526 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002527 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002528
wdenk6c59edc2004-05-03 20:45:30 +00002529 etc.
wdenkc6097192002-11-03 00:24:07 +00002530
wdenkc6097192002-11-03 00:24:07 +00002531
wdenk6c59edc2004-05-03 20:45:30 +00002532Finally, type "make all", and you should get some working U-Boot
2533images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002534
wdenk6c59edc2004-05-03 20:45:30 +00002535- "u-boot.bin" is a raw binary image
2536- "u-boot" is an image in ELF binary format
2537- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002538
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002539By default the build is performed locally and the objects are saved
2540in the source directory. One of the two methods can be used to change
2541this behavior and build U-Boot to some external directory:
2542
25431. Add O= to the make command line invocations:
2544
2545 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02002546 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002547 make O=/tmp/build all
2548
Timo Ketolac8c67602014-11-06 14:39:05 +020025492. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002550
Timo Ketolac8c67602014-11-06 14:39:05 +02002551 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002552 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02002553 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002554 make all
2555
Timo Ketolac8c67602014-11-06 14:39:05 +02002556Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002557variable.
2558
Daniel Schwierzeck88484422018-01-26 16:31:04 +01002559User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2560setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2561For example to treat all compiler warnings as errors:
2562
2563 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00002564
wdenk6c59edc2004-05-03 20:45:30 +00002565Please be aware that the Makefiles assume you are using GNU make, so
2566for instance on NetBSD you might need to use "gmake" instead of
2567native "make".
wdenkc6097192002-11-03 00:24:07 +00002568
wdenkc6097192002-11-03 00:24:07 +00002569
wdenk6c59edc2004-05-03 20:45:30 +00002570If the system board that you have is not listed, then you will need
2571to port U-Boot to your hardware platform. To do this, follow these
2572steps:
wdenkc6097192002-11-03 00:24:07 +00002573
Phil Sutterc77b4882015-12-25 14:41:18 +010025741. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00002575 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01002576 the "Makefile" and a "<board>.c".
25772. Create a new configuration file "include/configs/<board>.h" for
2578 your board.
wdenk6c59edc2004-05-03 20:45:30 +000025793. If you're porting U-Boot to a new CPU, then also create a new
2580 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020025814. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000025825. Type "make", and you should get a working "u-boot.srec" file
2583 to be installed on your target system.
25846. Debug and solve any problems that might arise.
2585 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002586
wdenkc6097192002-11-03 00:24:07 +00002587
wdenk6c59edc2004-05-03 20:45:30 +00002588Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2589==============================================================
wdenkc6097192002-11-03 00:24:07 +00002590
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002591If you have modified U-Boot sources (for instance added a new board
2592or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00002593provide feedback to the other developers. The feedback normally takes
Thomas Hebbfd37f242019-11-13 18:18:03 -08002594the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002595official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002596
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002597But before you submit such a patch, please verify that your modifi-
2598cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00002599the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06002600just run the buildman script (tools/buildman/buildman), which will
2601configure and build U-Boot for ALL supported system. Be warned, this
2602will take a while. Please see the buildman README, or run 'buildman -H'
2603for documentation.
wdenkc6097192002-11-03 00:24:07 +00002604
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002605
wdenk6c59edc2004-05-03 20:45:30 +00002606See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002607
wdenkc6097192002-11-03 00:24:07 +00002608
wdenk6c59edc2004-05-03 20:45:30 +00002609Monitor Commands - Overview:
2610============================
wdenkc6097192002-11-03 00:24:07 +00002611
wdenk6c59edc2004-05-03 20:45:30 +00002612go - start application at address 'addr'
2613run - run commands in an environment variable
2614bootm - boot application image from memory
2615bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00002616bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00002617tftpboot- boot image via network using TFTP protocol
2618 and env variables "ipaddr" and "serverip"
2619 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00002620tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00002621rarpboot- boot image via network using RARP/TFTP protocol
2622diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2623loads - load S-Record file over serial line
2624loadb - load binary file over serial line (kermit mode)
2625md - memory display
2626mm - memory modify (auto-incrementing)
2627nm - memory modify (constant address)
2628mw - memory write (fill)
Simon Glass19038de2020-06-02 19:26:49 -06002629ms - memory search
wdenk6c59edc2004-05-03 20:45:30 +00002630cp - memory copy
2631cmp - memory compare
2632crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05002633i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00002634sspi - SPI utility commands
2635base - print or set address offset
2636printenv- print environment variables
Pragnesh Patel1d5955f2020-12-22 11:30:05 +05302637pwm - control pwm channels
wdenk6c59edc2004-05-03 20:45:30 +00002638setenv - set environment variables
2639saveenv - save environment variables to persistent storage
2640protect - enable or disable FLASH write protection
2641erase - erase FLASH memory
2642flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00002643nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00002644bdinfo - print Board Info structure
2645iminfo - print header information for application image
2646coninfo - print console devices and informations
2647ide - IDE sub-system
2648loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002649loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002650mtest - simple RAM test
2651icache - enable or disable instruction cache
2652dcache - enable or disable data cache
2653reset - Perform RESET of the CPU
2654echo - echo args to console
2655version - print monitor version
2656help - print online help
2657? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002658
wdenkc6097192002-11-03 00:24:07 +00002659
wdenk6c59edc2004-05-03 20:45:30 +00002660Monitor Commands - Detailed Description:
2661========================================
wdenkc6097192002-11-03 00:24:07 +00002662
wdenk6c59edc2004-05-03 20:45:30 +00002663TODO.
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk6c59edc2004-05-03 20:45:30 +00002665For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002666
2667
wdenk6c59edc2004-05-03 20:45:30 +00002668Note for Redundant Ethernet Interfaces:
2669=======================================
wdenkf4688a22003-05-28 08:06:31 +00002670
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002671Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00002672such configurations and is capable of automatic selection of a
2673"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00002674
wdenk6c59edc2004-05-03 20:45:30 +00002675Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2676MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2677"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00002678
wdenk6c59edc2004-05-03 20:45:30 +00002679If the network interface stores some valid MAC address (for instance
2680in SROM), this is used as default address if there is NO correspon-
2681ding setting in the environment; if the corresponding environment
2682variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00002683
wdenk6c59edc2004-05-03 20:45:30 +00002684o If the SROM has a valid MAC address, and there is no address in the
2685 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002686
wdenk6c59edc2004-05-03 20:45:30 +00002687o If there is no valid address in the SROM, and a definition in the
2688 environment exists, then the value from the environment variable is
2689 used.
wdenkc6097192002-11-03 00:24:07 +00002690
wdenk6c59edc2004-05-03 20:45:30 +00002691o If both the SROM and the environment contain a MAC address, and
2692 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002693
wdenk6c59edc2004-05-03 20:45:30 +00002694o If both the SROM and the environment contain a MAC address, and the
2695 addresses differ, the value from the environment is used and a
2696 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002697
wdenk6c59edc2004-05-03 20:45:30 +00002698o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05002699 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2700 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00002701
Ben Warren6db991a2010-04-26 11:11:46 -07002702If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00002703will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07002704may be skipped by setting the appropriate 'ethmacskip' environment variable.
2705The naming convention is as follows:
2706"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00002707
wdenk6c59edc2004-05-03 20:45:30 +00002708Image Formats:
2709==============
wdenkc6097192002-11-03 00:24:07 +00002710
Marian Balakowicz18710b82008-03-12 12:13:13 +01002711U-Boot is capable of booting (and performing other auxiliary operations on)
2712images in two formats:
2713
2714New uImage format (FIT)
2715-----------------------
2716
2717Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2718to Flattened Device Tree). It allows the use of images with multiple
2719components (several kernels, ramdisks, etc.), with contents protected by
2720SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2721
2722
2723Old uImage format
2724-----------------
2725
2726Old image format is based on binary files which can be basically anything,
2727preceded by a special header; see the definitions in include/image.h for
2728details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002729
wdenk6c59edc2004-05-03 20:45:30 +00002730* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2731 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05002732 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
Thomas Huthc90d56a2021-11-13 18:13:50 +01002733 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03002734* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00002735 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Andy Shevchenko8cb5cdd2017-07-05 16:25:22 +03002736 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00002737* Compression Type (uncompressed, gzip, bzip2)
2738* Load Address
2739* Entry Point
2740* Image Name
2741* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002742
wdenk6c59edc2004-05-03 20:45:30 +00002743The header is marked by a special Magic Number, and both the header
2744and the data portions of the image are secured against corruption by
2745CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002746
wdenkc6097192002-11-03 00:24:07 +00002747
wdenk6c59edc2004-05-03 20:45:30 +00002748Linux Support:
2749==============
wdenkc6097192002-11-03 00:24:07 +00002750
wdenk6c59edc2004-05-03 20:45:30 +00002751Although U-Boot should support any OS or standalone application
2752easily, the main focus has always been on Linux during the design of
2753U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002754
wdenk6c59edc2004-05-03 20:45:30 +00002755U-Boot includes many features that so far have been part of some
2756special "boot loader" code within the Linux kernel. Also, any
2757"initrd" images to be used are no longer part of one big Linux image;
2758instead, kernel and "initrd" are separate images. This implementation
2759serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002760
wdenk6c59edc2004-05-03 20:45:30 +00002761- the same features can be used for other OS or standalone
2762 applications (for instance: using compressed images to reduce the
2763 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002764
wdenk6c59edc2004-05-03 20:45:30 +00002765- it becomes much easier to port new Linux kernel versions because
2766 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002767
wdenk6c59edc2004-05-03 20:45:30 +00002768- the same Linux kernel image can now be used with different "initrd"
2769 images; of course this also means that different kernel images can
2770 be run with the same "initrd". This makes testing easier (you don't
2771 have to build a new "zImage.initrd" Linux image when you just
2772 change a file in your "initrd"). Also, a field-upgrade of the
2773 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002774
wdenkc6097192002-11-03 00:24:07 +00002775
wdenk6c59edc2004-05-03 20:45:30 +00002776Linux HOWTO:
2777============
wdenkc6097192002-11-03 00:24:07 +00002778
wdenk6c59edc2004-05-03 20:45:30 +00002779Porting Linux to U-Boot based systems:
2780---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002781
wdenk6c59edc2004-05-03 20:45:30 +00002782U-Boot cannot save you from doing all the necessary modifications to
2783configure the Linux device drivers for use with your target hardware
2784(no, we don't intend to provide a full virtual machine interface to
2785Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002786
Stefan Roese88fbf932010-04-15 16:07:28 +02002787But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002788
wdenk6c59edc2004-05-03 20:45:30 +00002789Just make sure your machine specific header file (for instance
2790include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02002791Information structure as we define in include/asm-<arch>/u-boot.h,
2792and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002793as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002794
Simon Glassd097e592014-06-11 23:29:46 -06002795Note that U-Boot now has a driver model, a unified model for drivers.
2796If you are adding a new driver, plumb it into driver model. If there
2797is no uclass available, you are encouraged to create one. See
2798doc/driver-model.
2799
wdenkc6097192002-11-03 00:24:07 +00002800
wdenk6c59edc2004-05-03 20:45:30 +00002801Configuring the Linux kernel:
2802-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002803
wdenk6c59edc2004-05-03 20:45:30 +00002804No specific requirements for U-Boot. Make sure you have some root
2805device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002806
wdenkc6097192002-11-03 00:24:07 +00002807
wdenk6c59edc2004-05-03 20:45:30 +00002808Building a Linux Image:
2809-----------------------
wdenkc6097192002-11-03 00:24:07 +00002810
wdenk6c59edc2004-05-03 20:45:30 +00002811With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2812not used. If you use recent kernel source, a new build target
2813"uImage" will exist which automatically builds an image usable by
2814U-Boot. Most older kernels also have support for a "pImage" target,
2815which was introduced for our predecessor project PPCBoot and uses a
2816100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002817
wdenk6c59edc2004-05-03 20:45:30 +00002818Example:
wdenkc6097192002-11-03 00:24:07 +00002819
Holger Freyther7ba4e572014-08-04 09:26:05 +02002820 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00002821 make oldconfig
2822 make dep
2823 make uImage
wdenkc6097192002-11-03 00:24:07 +00002824
wdenk6c59edc2004-05-03 20:45:30 +00002825The "uImage" build target uses a special tool (in 'tools/mkimage') to
2826encapsulate a compressed Linux kernel image with header information,
2827CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002828
wdenk6c59edc2004-05-03 20:45:30 +00002829* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002830
wdenk6c59edc2004-05-03 20:45:30 +00002831* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk6c59edc2004-05-03 20:45:30 +00002833 ${CROSS_COMPILE}-objcopy -O binary \
2834 -R .note -R .comment \
2835 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00002836
wdenk6c59edc2004-05-03 20:45:30 +00002837* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00002838
wdenk6c59edc2004-05-03 20:45:30 +00002839 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00002840
wdenk6c59edc2004-05-03 20:45:30 +00002841* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002842
wdenk6c59edc2004-05-03 20:45:30 +00002843 mkimage -A ppc -O linux -T kernel -C gzip \
2844 -a 0 -e 0 -n "Linux Kernel Image" \
2845 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00002846
wdenkc6097192002-11-03 00:24:07 +00002847
wdenk6c59edc2004-05-03 20:45:30 +00002848The "mkimage" tool can also be used to create ramdisk images for use
2849with U-Boot, either separated from the Linux kernel image, or
2850combined into one file. "mkimage" encapsulates the images with a 64
2851byte header containing information about target architecture,
2852operating system, image type, compression method, entry points, time
2853stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00002854
wdenk6c59edc2004-05-03 20:45:30 +00002855"mkimage" can be called in two ways: to verify existing images and
2856print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002857
wdenk6c59edc2004-05-03 20:45:30 +00002858In the first form (with "-l" option) mkimage lists the information
2859contained in the header of an existing U-Boot image; this includes
2860checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002861
wdenk6c59edc2004-05-03 20:45:30 +00002862 tools/mkimage -l image
2863 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002864
wdenk6c59edc2004-05-03 20:45:30 +00002865The second form (with "-d" option) is used to build a U-Boot image
2866from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002867
wdenk6c59edc2004-05-03 20:45:30 +00002868 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2869 -n name -d data_file image
2870 -A ==> set architecture to 'arch'
2871 -O ==> set operating system to 'os'
2872 -T ==> set image type to 'type'
2873 -C ==> set compression type 'comp'
2874 -a ==> set load address to 'addr' (hex)
2875 -e ==> set entry point to 'ep' (hex)
2876 -n ==> set image name to 'name'
2877 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002878
wdenkcd914452004-05-29 16:53:29 +00002879Right now, all Linux kernels for PowerPC systems use the same load
2880address (0x00000000), but the entry point address depends on the
2881kernel version:
wdenkc6097192002-11-03 00:24:07 +00002882
wdenk6c59edc2004-05-03 20:45:30 +00002883- 2.2.x kernels have the entry point at 0x0000000C,
2884- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002885
wdenk6c59edc2004-05-03 20:45:30 +00002886So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002887
wdenk6c59edc2004-05-03 20:45:30 +00002888 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2889 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02002890 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00002891 > examples/uImage.TQM850L
2892 Image Name: 2.4.4 kernel for TQM850L
2893 Created: Wed Jul 19 02:34:59 2000
2894 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2895 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2896 Load Address: 0x00000000
2897 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002898
wdenk6c59edc2004-05-03 20:45:30 +00002899To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002900
wdenk6c59edc2004-05-03 20:45:30 +00002901 -> tools/mkimage -l examples/uImage.TQM850L
2902 Image Name: 2.4.4 kernel for TQM850L
2903 Created: Wed Jul 19 02:34:59 2000
2904 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2905 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2906 Load Address: 0x00000000
2907 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002908
wdenk6c59edc2004-05-03 20:45:30 +00002909NOTE: for embedded systems where boot time is critical you can trade
2910speed for memory and install an UNCOMPRESSED image instead: this
2911needs more space in Flash, but boots much faster since it does not
2912need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002913
Stefan Roese88fbf932010-04-15 16:07:28 +02002914 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00002915 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2916 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02002917 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00002918 > examples/uImage.TQM850L-uncompressed
2919 Image Name: 2.4.4 kernel for TQM850L
2920 Created: Wed Jul 19 02:34:59 2000
2921 Image Type: PowerPC Linux Kernel Image (uncompressed)
2922 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2923 Load Address: 0x00000000
2924 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002925
wdenkc6097192002-11-03 00:24:07 +00002926
wdenk6c59edc2004-05-03 20:45:30 +00002927Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2928when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00002929
wdenk6c59edc2004-05-03 20:45:30 +00002930 -> tools/mkimage -n 'Simple Ramdisk Image' \
2931 > -A ppc -O linux -T ramdisk -C gzip \
2932 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2933 Image Name: Simple Ramdisk Image
2934 Created: Wed Jan 12 14:01:50 2000
2935 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2936 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2937 Load Address: 0x00000000
2938 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002939
Tyler Hicks791c7472020-10-26 10:40:24 -05002940The "dumpimage" tool can be used to disassemble or list the contents of images
2941built by mkimage. See dumpimage's help output (-h) for details.
wdenkc6097192002-11-03 00:24:07 +00002942
wdenk6c59edc2004-05-03 20:45:30 +00002943Installing a Linux Image:
2944-------------------------
wdenkc6097192002-11-03 00:24:07 +00002945
wdenk6c59edc2004-05-03 20:45:30 +00002946To downloading a U-Boot image over the serial (console) interface,
2947you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00002948
wdenk6c59edc2004-05-03 20:45:30 +00002949 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00002950
wdenk6c59edc2004-05-03 20:45:30 +00002951The 'objcopy' does not understand the information in the U-Boot
2952image header, so the resulting S-Record file will be relative to
2953address 0x00000000. To load it to a given address, you need to
2954specify the target address as 'offset' parameter with the 'loads'
2955command.
wdenkc6097192002-11-03 00:24:07 +00002956
wdenk6c59edc2004-05-03 20:45:30 +00002957Example: install the image to address 0x40100000 (which on the
2958TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002959
wdenk6c59edc2004-05-03 20:45:30 +00002960 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002961
wdenk6c59edc2004-05-03 20:45:30 +00002962 .......... done
2963 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002964
wdenk6c59edc2004-05-03 20:45:30 +00002965 => loads 40100000
2966 ## Ready for S-Record download ...
2967 ~>examples/image.srec
2968 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2969 ...
2970 15989 15990 15991 15992
2971 [file transfer complete]
2972 [connected]
2973 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002974
wdenkc6097192002-11-03 00:24:07 +00002975
wdenk6c59edc2004-05-03 20:45:30 +00002976You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002977this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00002978corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002979
wdenk6c59edc2004-05-03 20:45:30 +00002980 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002981
wdenk6c59edc2004-05-03 20:45:30 +00002982 ## Checking Image at 40100000 ...
2983 Image Name: 2.2.13 for initrd on TQM850L
2984 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2985 Data Size: 335725 Bytes = 327 kB = 0 MB
2986 Load Address: 00000000
2987 Entry Point: 0000000c
2988 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002989
2990
wdenk6c59edc2004-05-03 20:45:30 +00002991Boot Linux:
2992-----------
wdenkc6097192002-11-03 00:24:07 +00002993
wdenk6c59edc2004-05-03 20:45:30 +00002994The "bootm" command is used to boot an application that is stored in
2995memory (RAM or Flash). In case of a Linux kernel image, the contents
2996of the "bootargs" environment variable is passed to the kernel as
2997parameters. You can check and modify this variable using the
2998"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002999
wdenkc6097192002-11-03 00:24:07 +00003000
wdenk6c59edc2004-05-03 20:45:30 +00003001 => printenv bootargs
3002 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003003
wdenk6c59edc2004-05-03 20:45:30 +00003004 => 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 +00003005
wdenk6c59edc2004-05-03 20:45:30 +00003006 => printenv bootargs
3007 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 +00003008
wdenk6c59edc2004-05-03 20:45:30 +00003009 => bootm 40020000
3010 ## Booting Linux kernel at 40020000 ...
3011 Image Name: 2.2.13 for NFS on TQM850L
3012 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3013 Data Size: 381681 Bytes = 372 kB = 0 MB
3014 Load Address: 00000000
3015 Entry Point: 0000000c
3016 Verifying Checksum ... OK
3017 Uncompressing Kernel Image ... OK
3018 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
3019 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3020 time_init: decrementer frequency = 187500000/60
3021 Calibrating delay loop... 49.77 BogoMIPS
3022 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3023 ...
wdenkc6097192002-11-03 00:24:07 +00003024
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003025If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003026the memory addresses of both the kernel and the initrd image (PPBCOOT
3027format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003028
wdenk6c59edc2004-05-03 20:45:30 +00003029 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003030
wdenk6c59edc2004-05-03 20:45:30 +00003031 ## Checking Image at 40100000 ...
3032 Image Name: 2.2.13 for initrd on TQM850L
3033 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3034 Data Size: 335725 Bytes = 327 kB = 0 MB
3035 Load Address: 00000000
3036 Entry Point: 0000000c
3037 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003038
wdenk6c59edc2004-05-03 20:45:30 +00003039 ## Checking Image at 40200000 ...
3040 Image Name: Simple Ramdisk Image
3041 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3042 Data Size: 566530 Bytes = 553 kB = 0 MB
3043 Load Address: 00000000
3044 Entry Point: 00000000
3045 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003046
wdenk6c59edc2004-05-03 20:45:30 +00003047 => bootm 40100000 40200000
3048 ## Booting Linux kernel at 40100000 ...
3049 Image Name: 2.2.13 for initrd on TQM850L
3050 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3051 Data Size: 335725 Bytes = 327 kB = 0 MB
3052 Load Address: 00000000
3053 Entry Point: 0000000c
3054 Verifying Checksum ... OK
3055 Uncompressing Kernel Image ... OK
3056 ## Loading RAMDisk Image at 40200000 ...
3057 Image Name: Simple Ramdisk Image
3058 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3059 Data Size: 566530 Bytes = 553 kB = 0 MB
3060 Load Address: 00000000
3061 Entry Point: 00000000
3062 Verifying Checksum ... OK
3063 Loading Ramdisk ... OK
3064 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
3065 Boot arguments: root=/dev/ram
3066 time_init: decrementer frequency = 187500000/60
3067 Calibrating delay loop... 49.77 BogoMIPS
3068 ...
3069 RAMDISK: Compressed image found at block 0
3070 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk6c59edc2004-05-03 20:45:30 +00003072 bash#
wdenkc6097192002-11-03 00:24:07 +00003073
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003074Boot Linux and pass a flat device tree:
3075-----------
3076
3077First, U-Boot must be compiled with the appropriate defines. See the section
3078titled "Linux Kernel Interface" above for a more in depth explanation. The
3079following is an example of how to start a kernel and pass an updated
3080flat device tree:
3081
3082=> print oftaddr
3083oftaddr=0x300000
3084=> print oft
3085oft=oftrees/mpc8540ads.dtb
3086=> tftp $oftaddr $oft
3087Speed: 1000, full duplex
3088Using TSEC0 device
3089TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3090Filename 'oftrees/mpc8540ads.dtb'.
3091Load address: 0x300000
3092Loading: #
3093done
3094Bytes transferred = 4106 (100a hex)
3095=> tftp $loadaddr $bootfile
3096Speed: 1000, full duplex
3097Using TSEC0 device
3098TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3099Filename 'uImage'.
3100Load address: 0x200000
3101Loading:############
3102done
3103Bytes transferred = 1029407 (fb51f hex)
3104=> print loadaddr
3105loadaddr=200000
3106=> print oftaddr
3107oftaddr=0x300000
3108=> bootm $loadaddr - $oftaddr
3109## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003110 Image Name: Linux-2.6.17-dirty
3111 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3112 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003113 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003114 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003115 Verifying Checksum ... OK
3116 Uncompressing Kernel Image ... OK
3117Booting using flat device tree at 0x300000
3118Using MPC85xx ADS machine description
3119Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3120[snip]
3121
3122
wdenk6c59edc2004-05-03 20:45:30 +00003123More About U-Boot Image Types:
3124------------------------------
wdenkc6097192002-11-03 00:24:07 +00003125
wdenk6c59edc2004-05-03 20:45:30 +00003126U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003127
wdenk6c59edc2004-05-03 20:45:30 +00003128 "Standalone Programs" are directly runnable in the environment
3129 provided by U-Boot; it is expected that (if they behave
3130 well) you can continue to work in U-Boot after return from
3131 the Standalone Program.
3132 "OS Kernel Images" are usually images of some Embedded OS which
3133 will take over control completely. Usually these programs
3134 will install their own set of exception handlers, device
3135 drivers, set up the MMU, etc. - this means, that you cannot
3136 expect to re-enter U-Boot except by resetting the CPU.
3137 "RAMDisk Images" are more or less just data blocks, and their
3138 parameters (address, size) are passed to an OS kernel that is
3139 being started.
3140 "Multi-File Images" contain several images, typically an OS
3141 (Linux) kernel image and one or more data images like
3142 RAMDisks. This construct is useful for instance when you want
3143 to boot over the network using BOOTP etc., where the boot
3144 server provides just a single image file, but you want to get
3145 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003146
wdenk6c59edc2004-05-03 20:45:30 +00003147 "Multi-File Images" start with a list of image sizes, each
3148 image size (in bytes) specified by an "uint32_t" in network
3149 byte order. This list is terminated by an "(uint32_t)0".
3150 Immediately after the terminating 0 follow the images, one by
3151 one, all aligned on "uint32_t" boundaries (size rounded up to
3152 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003153
wdenk6c59edc2004-05-03 20:45:30 +00003154 "Firmware Images" are binary images containing firmware (like
3155 U-Boot or FPGA images) which usually will be programmed to
3156 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003157
wdenk6c59edc2004-05-03 20:45:30 +00003158 "Script files" are command sequences that will be executed by
3159 U-Boot's command interpreter; this feature is especially
3160 useful when you configure U-Boot to use a real shell (hush)
3161 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003162
Marek Vasutcf41a9b2012-03-14 21:52:45 +00003163Booting the Linux zImage:
3164-------------------------
3165
3166On some platforms, it's possible to boot Linux zImage. This is done
3167using the "bootz" command. The syntax of "bootz" command is the same
3168as the syntax of "bootm" command.
3169
Tom Rini45f46d12013-05-16 11:40:11 -04003170Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00003171kernel with raw initrd images. The syntax is slightly different, the
3172address of the initrd must be augmented by it's size, in the following
3173format: "<initrd addres>:<initrd size>".
3174
stroeseb9c17c52003-04-04 15:53:41 +00003175
wdenk6c59edc2004-05-03 20:45:30 +00003176Standalone HOWTO:
3177=================
stroeseb9c17c52003-04-04 15:53:41 +00003178
wdenk6c59edc2004-05-03 20:45:30 +00003179One of the features of U-Boot is that you can dynamically load and
3180run "standalone" applications, which can use some resources of
3181U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003182
wdenk6c59edc2004-05-03 20:45:30 +00003183Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003184
wdenk6c59edc2004-05-03 20:45:30 +00003185"Hello World" Demo:
3186-------------------
wdenkc6097192002-11-03 00:24:07 +00003187
wdenk6c59edc2004-05-03 20:45:30 +00003188'examples/hello_world.c' contains a small "Hello World" Demo
3189application; it is automatically compiled when you build U-Boot.
3190It's configured to run at address 0x00040004, so you can play with it
3191like that:
wdenkc6097192002-11-03 00:24:07 +00003192
wdenk6c59edc2004-05-03 20:45:30 +00003193 => loads
3194 ## Ready for S-Record download ...
3195 ~>examples/hello_world.srec
3196 1 2 3 4 5 6 7 8 9 10 11 ...
3197 [file transfer complete]
3198 [connected]
3199 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003200
wdenk6c59edc2004-05-03 20:45:30 +00003201 => go 40004 Hello World! This is a test.
3202 ## Starting application at 0x00040004 ...
3203 Hello World
3204 argc = 7
3205 argv[0] = "40004"
3206 argv[1] = "Hello"
3207 argv[2] = "World!"
3208 argv[3] = "This"
3209 argv[4] = "is"
3210 argv[5] = "a"
3211 argv[6] = "test."
3212 argv[7] = "<NULL>"
3213 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003214
wdenk6c59edc2004-05-03 20:45:30 +00003215 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003216
wdenk6c59edc2004-05-03 20:45:30 +00003217Another example, which demonstrates how to register a CPM interrupt
3218handler with the U-Boot code, can be found in 'examples/timer.c'.
3219Here, a CPM timer is set up to generate an interrupt every second.
3220The interrupt service routine is trivial, just printing a '.'
3221character, but this is just a demo program. The application can be
3222controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003223
wdenk6c59edc2004-05-03 20:45:30 +00003224 ? - print current values og the CPM Timer registers
3225 b - enable interrupts and start timer
3226 e - stop timer and disable interrupts
3227 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk6c59edc2004-05-03 20:45:30 +00003229 => loads
3230 ## Ready for S-Record download ...
3231 ~>examples/timer.srec
3232 1 2 3 4 5 6 7 8 9 10 11 ...
3233 [file transfer complete]
3234 [connected]
3235 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003236
wdenk6c59edc2004-05-03 20:45:30 +00003237 => go 40004
3238 ## Starting application at 0x00040004 ...
3239 TIMERS=0xfff00980
3240 Using timer 1
3241 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003242
wdenk6c59edc2004-05-03 20:45:30 +00003243Hit 'b':
3244 [q, b, e, ?] Set interval 1000000 us
3245 Enabling timer
3246Hit '?':
3247 [q, b, e, ?] ........
3248 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3249Hit '?':
3250 [q, b, e, ?] .
3251 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3252Hit '?':
3253 [q, b, e, ?] .
3254 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3255Hit '?':
3256 [q, b, e, ?] .
3257 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3258Hit 'e':
3259 [q, b, e, ?] ...Stopping timer
3260Hit 'q':
3261 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003262
wdenkc6097192002-11-03 00:24:07 +00003263
wdenk6c59edc2004-05-03 20:45:30 +00003264Minicom warning:
3265================
wdenkc6097192002-11-03 00:24:07 +00003266
wdenk6c59edc2004-05-03 20:45:30 +00003267Over time, many people have reported problems when trying to use the
3268"minicom" terminal emulation program for serial download. I (wd)
3269consider minicom to be broken, and recommend not to use it. Under
3270Unix, I recommend to use C-Kermit for general purpose use (and
3271especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00003272use "cu" for S-Record download ("loads" command). See
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003273https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
Karl O. Pinca0189bb2012-10-01 05:11:56 +00003274for help with kermit.
3275
wdenkc6097192002-11-03 00:24:07 +00003276
wdenk6c59edc2004-05-03 20:45:30 +00003277Nevertheless, if you absolutely want to use it try adding this
3278configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003279
wdenk6c59edc2004-05-03 20:45:30 +00003280 Name Program Name U/D FullScr IO-Red. Multi
3281 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3282 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003283
wdenk8dba0502003-03-31 16:34:49 +00003284
wdenk6c59edc2004-05-03 20:45:30 +00003285NetBSD Notes:
3286=============
wdenkc6097192002-11-03 00:24:07 +00003287
wdenk6c59edc2004-05-03 20:45:30 +00003288Starting at version 0.9.2, U-Boot supports NetBSD both as host
3289(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003290
wdenk6c59edc2004-05-03 20:45:30 +00003291Building requires a cross environment; it is known to work on
3292NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3293need gmake since the Makefiles are not compatible with BSD make).
3294Note that the cross-powerpc package does not install include files;
3295attempting to build U-Boot will fail because <machine/ansi.h> is
3296missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003297
wdenk6c59edc2004-05-03 20:45:30 +00003298 # cd /usr/pkg/cross/powerpc-netbsd/include
3299 # mkdir powerpc
3300 # ln -s powerpc machine
3301 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3302 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003303
wdenk6c59edc2004-05-03 20:45:30 +00003304Native builds *don't* work due to incompatibilities between native
3305and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk6c59edc2004-05-03 20:45:30 +00003307Booting assumes that (the first part of) the image booted is a
3308stage-2 loader which in turn loads and then invokes the kernel
3309proper. Loader sources will eventually appear in the NetBSD source
3310tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003311meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003312
wdenkc6097192002-11-03 00:24:07 +00003313
wdenk6c59edc2004-05-03 20:45:30 +00003314Implementation Internals:
3315=========================
wdenkc6097192002-11-03 00:24:07 +00003316
wdenk6c59edc2004-05-03 20:45:30 +00003317The following is not intended to be a complete description of every
3318implementation detail. However, it should help to understand the
3319inner workings of U-Boot and make it easier to port it to custom
3320hardware.
wdenkc6097192002-11-03 00:24:07 +00003321
wdenkc6097192002-11-03 00:24:07 +00003322
wdenk6c59edc2004-05-03 20:45:30 +00003323Initial Stack, Global Data:
3324---------------------------
wdenkc6097192002-11-03 00:24:07 +00003325
wdenk6c59edc2004-05-03 20:45:30 +00003326The implementation of U-Boot is complicated by the fact that U-Boot
3327starts running out of ROM (flash memory), usually without access to
3328system RAM (because the memory controller is not initialized yet).
3329This means that we don't have writable Data or BSS segments, and BSS
3330is not initialized as zero. To be able to get a C environment working
3331at all, we have to allocate at least a minimal stack. Implementation
3332options for this are defined and restricted by the CPU used: Some CPU
3333models provide on-chip memory (like the IMMR area on MPC8xx and
3334MPC826x processors), on others (parts of) the data cache can be
3335locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003336
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003337 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003338 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk6c59edc2004-05-03 20:45:30 +00003340 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3341 From: "Chris Hallinan" <clh@net1plus.com>
3342 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3343 ...
wdenkc6097192002-11-03 00:24:07 +00003344
wdenk6c59edc2004-05-03 20:45:30 +00003345 Correct me if I'm wrong, folks, but the way I understand it
3346 is this: Using DCACHE as initial RAM for Stack, etc, does not
3347 require any physical RAM backing up the cache. The cleverness
3348 is that the cache is being used as a temporary supply of
3349 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003350 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00003351 can see how this works by studying the cache architecture and
3352 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003353
wdenk6c59edc2004-05-03 20:45:30 +00003354 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3355 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003356 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00003357 option should work for you. Using CS 4 should be fine if your
3358 board designers haven't used it for something that would
3359 cause you grief during the initial boot! It is frequently not
3360 used.
wdenkc6097192002-11-03 00:24:07 +00003361
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003362 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00003363 with your processor/board/system design. The default value
3364 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003365 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003366 than your SDRAM module. If you have a 64MB SDRAM module, set
3367 it above 400_0000. Just make sure your board has no resources
3368 that are supposed to respond to that address! That code in
3369 start.S has been around a while and should work as is when
3370 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003371
wdenk6c59edc2004-05-03 20:45:30 +00003372 -Chris Hallinan
3373 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003374
wdenk6c59edc2004-05-03 20:45:30 +00003375It is essential to remember this, since it has some impact on the C
3376code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003377
wdenk6c59edc2004-05-03 20:45:30 +00003378* Initialized global data (data segment) is read-only. Do not attempt
3379 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003380
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003381* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00003382 as zero data - BSS segment) at all - this is undefined, initiali-
3383 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003384
wdenk6c59edc2004-05-03 20:45:30 +00003385* Stack space is very limited. Avoid big data buffers or things like
3386 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003387
wdenk6c59edc2004-05-03 20:45:30 +00003388Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003389normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00003390turned out that the implementation of U-Boot can be greatly
3391simplified by making a global data structure (gd_t) available to all
3392functions. We could pass a pointer to this data as argument to _all_
3393functions, but this would bloat the code. Instead we use a feature of
3394the GCC compiler (Global Register Variables) to share the data: we
3395place a pointer (gd) to the global data into a register which we
3396reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003397
wdenk6c59edc2004-05-03 20:45:30 +00003398When choosing a register for such a purpose we are restricted by the
3399relevant (E)ABI specifications for the current architecture, and by
3400GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003401
wdenk6c59edc2004-05-03 20:45:30 +00003402For PowerPC, the following registers have specific use:
3403 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01003404 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00003405 R3-R4: parameter passing and return values
3406 R5-R10: parameter passing
3407 R13: small data area pointer
3408 R30: GOT pointer
3409 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003410
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01003411 (U-Boot also uses R12 as internal GOT pointer. r12
3412 is a volatile register so r12 needs to be reset when
3413 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00003414
Wolfgang Denk69c09642008-02-14 22:43:22 +01003415 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003416
wdenk6c59edc2004-05-03 20:45:30 +00003417 Note: on PPC, we could use a static initializer (since the
3418 address of the global data structure is known at compile time),
3419 but it turned out that reserving a register results in somewhat
3420 smaller code - although the code savings are not that big (on
3421 average for all boards 752 bytes for the whole U-Boot image,
3422 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003423
wdenk6c59edc2004-05-03 20:45:30 +00003424On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003425
wdenk6c59edc2004-05-03 20:45:30 +00003426 R0: function argument word/integer result
3427 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02003428 R9: platform specific
3429 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00003430 R11: argument (frame) pointer
3431 R12: temporary workspace
3432 R13: stack pointer
3433 R14: link register
3434 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003435
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02003436 ==> U-Boot will use R9 to hold a pointer to the global data
3437
3438 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00003439
Thomas Chou8fa38582010-05-21 11:08:03 +08003440On Nios II, the ABI is documented here:
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003441 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
Thomas Chou8fa38582010-05-21 11:08:03 +08003442
3443 ==> U-Boot will use gp to hold a pointer to the global data
3444
3445 Note: on Nios II, we give "-G0" option to gcc and don't use gp
3446 to access small data sections, so gp is free.
3447
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003448On NDS32, the following registers are used:
3449
3450 R0-R1: argument/return
3451 R2-R5: argument
3452 R15: temporary register for assembler
3453 R16: trampoline register
3454 R28: frame pointer (FP)
3455 R29: global pointer (GP)
3456 R30: link register (LP)
3457 R31: stack pointer (SP)
3458 PC: program counter (PC)
3459
3460 ==> U-Boot will use R10 to hold a pointer to the global data
3461
Wolfgang Denk6405a152006-03-31 18:32:53 +02003462NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3463or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003464
Rick Chend7e6f922017-12-26 13:55:59 +08003465On RISC-V, the following registers are used:
3466
3467 x0: hard-wired zero (zero)
3468 x1: return address (ra)
3469 x2: stack pointer (sp)
3470 x3: global pointer (gp)
3471 x4: thread pointer (tp)
3472 x5: link register (t0)
3473 x8: frame pointer (fp)
3474 x10-x11: arguments/return values (a0-1)
3475 x12-x17: arguments (a2-7)
3476 x28-31: temporaries (t3-6)
3477 pc: program counter (pc)
3478
3479 ==> U-Boot will use gp to hold a pointer to the global data
3480
wdenk6c59edc2004-05-03 20:45:30 +00003481Memory Management:
3482------------------
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk6c59edc2004-05-03 20:45:30 +00003484U-Boot runs in system state and uses physical addresses, i.e. the
3485MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003486
wdenk6c59edc2004-05-03 20:45:30 +00003487The available memory is mapped to fixed addresses using the memory
3488controller. In this process, a contiguous block is formed for each
3489memory type (Flash, SDRAM, SRAM), even when it consists of several
3490physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003491
wdenk6c59edc2004-05-03 20:45:30 +00003492U-Boot is installed in the first 128 kB of the first Flash bank (on
3493TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3494booting and sizing and initializing DRAM, the code relocates itself
3495to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003496memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00003497configuration setting]. Below that, a structure with global Board
3498Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003499
wdenk6c59edc2004-05-03 20:45:30 +00003500Additionally, some exception handler code is copied to the low 8 kB
3501of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk6c59edc2004-05-03 20:45:30 +00003503So a typical memory configuration with 16 MB of DRAM could look like
3504this:
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk6c59edc2004-05-03 20:45:30 +00003506 0x0000 0000 Exception Vector code
3507 :
3508 0x0000 1FFF
3509 0x0000 2000 Free for Application Use
3510 :
3511 :
wdenkc6097192002-11-03 00:24:07 +00003512
wdenk6c59edc2004-05-03 20:45:30 +00003513 :
3514 :
3515 0x00FB FF20 Monitor Stack (Growing downward)
3516 0x00FB FFAC Board Info Data and permanent copy of global data
3517 0x00FC 0000 Malloc Arena
3518 :
3519 0x00FD FFFF
3520 0x00FE 0000 RAM Copy of Monitor Code
3521 ... eventually: LCD or video framebuffer
3522 ... eventually: pRAM (Protected RAM - unchanged by reset)
3523 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003524
wdenkc6097192002-11-03 00:24:07 +00003525
wdenk6c59edc2004-05-03 20:45:30 +00003526System Initialization:
3527----------------------
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk6c59edc2004-05-03 20:45:30 +00003529In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003530(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003531configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00003532To be able to re-map memory U-Boot then jumps to its link address.
3533To be able to implement the initialization code in C, a (small!)
3534initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher71cb3e92017-06-07 17:33:10 +02003535which provide such a feature like), or in a locked part of the data
3536cache. After that, U-Boot initializes the CPU core, the caches and
3537the SIU.
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk6c59edc2004-05-03 20:45:30 +00003539Next, all (potentially) available memory banks are mapped using a
3540preliminary mapping. For example, we put them on 512 MB boundaries
3541(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3542on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3543programmed for SDRAM access. Using the temporary configuration, a
3544simple memory test is run that determines the size of the SDRAM
3545banks.
wdenkc6097192002-11-03 00:24:07 +00003546
wdenk6c59edc2004-05-03 20:45:30 +00003547When there is more than one SDRAM bank, and the banks are of
3548different size, the largest is mapped first. For equal size, the first
3549bank (CS2#) is mapped first. The first mapping is always for address
35500x00000000, with any additional banks following immediately to create
3551contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk6c59edc2004-05-03 20:45:30 +00003553Then, the monitor installs itself at the upper end of the SDRAM area
3554and allocates memory for use by malloc() and for the global Board
3555Info data; also, the exception vector code is copied to the low RAM
3556pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk6c59edc2004-05-03 20:45:30 +00003558Only after this relocation will you have a "normal" C environment;
3559until that you are restricted in several ways, mostly because you are
3560running from ROM, and because the code will have to be relocated to a
3561new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003562
wdenkc6097192002-11-03 00:24:07 +00003563
wdenk6c59edc2004-05-03 20:45:30 +00003564U-Boot Porting Guide:
3565----------------------
wdenkc6097192002-11-03 00:24:07 +00003566
wdenk6c59edc2004-05-03 20:45:30 +00003567[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3568list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003569
wdenkc6097192002-11-03 00:24:07 +00003570
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003571int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00003572{
3573 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003574
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003575 signal(SIGALRM, no_more_time);
3576 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk6c59edc2004-05-03 20:45:30 +00003578 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003579 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00003580 return 0;
3581 }
wdenkc6097192002-11-03 00:24:07 +00003582
wdenk6c59edc2004-05-03 20:45:30 +00003583 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00003584
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003585 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00003586
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003587 if (clueless)
3588 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003589
wdenk6c59edc2004-05-03 20:45:30 +00003590 while (learning) {
3591 Read the README file in the top level directory;
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003592 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
Patrick Delaunay9b281fa2020-02-28 15:18:10 +01003593 Read applicable doc/README.*;
wdenk6c59edc2004-05-03 20:45:30 +00003594 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003595 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00003596 }
wdenkc6097192002-11-03 00:24:07 +00003597
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003598 if (available_money > toLocalCurrency ($2500))
3599 Buy a BDI3000;
3600 else
wdenk6c59edc2004-05-03 20:45:30 +00003601 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00003602
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003603 if (a similar board exists) { /* hopefully... */
3604 cp -a board/<similar> board/<myboard>
3605 cp include/configs/<similar>.h include/configs/<myboard>.h
3606 } else {
3607 Create your own board support subdirectory;
3608 Create your own board include/configs/<myboard>.h file;
3609 }
3610 Edit new board/<myboard> files
3611 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00003612
Jerry Van Barenba0687c2009-07-15 20:42:59 -04003613 while (!accepted) {
3614 while (!running) {
3615 do {
3616 Add / modify source code;
3617 } until (compiles);
3618 Debug;
3619 if (clueless)
3620 email("Hi, I am having problems...");
3621 }
3622 Send patch file to the U-Boot email list;
3623 if (reasonable critiques)
3624 Incorporate improvements from email list code review;
3625 else
3626 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00003627 }
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk6c59edc2004-05-03 20:45:30 +00003629 return 0;
3630}
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk6c59edc2004-05-03 20:45:30 +00003632void no_more_time (int sig)
3633{
3634 hire_a_guru();
3635}
wdenkc6097192002-11-03 00:24:07 +00003636
wdenkc6097192002-11-03 00:24:07 +00003637
wdenk6c59edc2004-05-03 20:45:30 +00003638Coding Standards:
3639-----------------
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk6c59edc2004-05-03 20:45:30 +00003641All contributions to U-Boot should conform to the Linux kernel
Baruch Siachb1081252017-12-10 17:34:35 +02003642coding style; see the kernel coding style guide at
3643https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3644script "scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02003645
3646Source files originating from a different project (for example the
3647MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003648reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02003649sources.
wdenkc6097192002-11-03 00:24:07 +00003650
Detlev Zundelaa63d482006-09-01 15:39:02 +02003651Please note that U-Boot is implemented in C (and to some small parts in
3652Assembler); no C++ is used, so please do not use C++ style comments (//)
3653in your code.
wdenkad276f22004-01-04 16:28:35 +00003654
wdenk6c59edc2004-05-03 20:45:30 +00003655Please also stick to the following formatting rules:
3656- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003657- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00003658- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003659- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00003660- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00003661
wdenk6c59edc2004-05-03 20:45:30 +00003662Submissions which do not conform to the standards may be returned
3663with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003664
wdenkc6097192002-11-03 00:24:07 +00003665
wdenk6c59edc2004-05-03 20:45:30 +00003666Submitting Patches:
3667-------------------
wdenkc6097192002-11-03 00:24:07 +00003668
wdenk6c59edc2004-05-03 20:45:30 +00003669Since the number of patches for U-Boot is growing, we need to
3670establish some rules. Submissions which do not conform to these rules
3671may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003672
Naoki Hayamae0cc1852020-10-08 13:17:16 +09003673Please see https://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003674
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003675Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
S. Lockwood-Childsda6d34c2017-11-14 22:56:42 -08003676see https://lists.denx.de/listinfo/u-boot
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003677
wdenk6c59edc2004-05-03 20:45:30 +00003678When you send a patch, please include the following information with
3679it:
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk6c59edc2004-05-03 20:45:30 +00003681* For bug fixes: a description of the bug and how your patch fixes
3682 this bug. Please try to include a way of demonstrating that the
3683 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk6c59edc2004-05-03 20:45:30 +00003685* For new features: a description of the feature and your
3686 implementation.
wdenkc6097192002-11-03 00:24:07 +00003687
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05003688* For major contributions, add a MAINTAINERS file with your
3689 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00003690
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02003691* When you add support for a new board, don't forget to add a
3692 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk6c59edc2004-05-03 20:45:30 +00003694* If your patch adds new configuration options, don't forget to
3695 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00003696
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003697* The patch itself. If you are using git (which is *strongly*
3698 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00003699 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003700 the U-Boot mailing list, you will avoid most of the common problems
3701 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00003702
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003703 If you cannot use git, use "diff -purN OLD NEW". If your version of
3704 diff does not support these options, then get the latest version of
3705 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00003706
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003707 The current directory when running this command shall be the parent
3708 directory of the U-Boot source tree (i. e. please make sure that
3709 your patch includes sufficient directory information for the
3710 affected files).
3711
3712 We prefer patches as plain text. MIME attachments are discouraged,
3713 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00003714
wdenk6c59edc2004-05-03 20:45:30 +00003715* If one logical set of modifications affects or creates several
3716 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00003717
wdenk6c59edc2004-05-03 20:45:30 +00003718* Changesets that contain different, unrelated modifications shall be
3719 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00003720
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk6c59edc2004-05-03 20:45:30 +00003722Notes:
wdenkc6097192002-11-03 00:24:07 +00003723
Simon Glassdc27def2016-07-27 20:33:08 -06003724* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00003725 source tree and make sure that no errors or warnings are reported
3726 for any of the boards.
3727
3728* Keep your modifications to the necessary minimum: A patch
3729 containing several unrelated changes or arbitrary reformats will be
3730 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00003731
wdenk6c59edc2004-05-03 20:45:30 +00003732* If you modify existing code, make sure that your new code does not
3733 add to the memory footprint of the code ;-) Small is beautiful!
3734 When adding new features, these should compile conditionally only
3735 (using #ifdef), and the resulting code with the new feature
3736 disabled must not need more memory than the old code without your
3737 modification.
wdenkcbc49a52005-05-03 14:12:25 +00003738
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003739* Remember that there is a size limit of 100 kB per message on the
3740 u-boot mailing list. Bigger patches will be moderated. If they are
3741 reasonable and not too big, they will be acknowledged. But patches
3742 bigger than the size limit should be avoided.