blob: edce7890c0f9e82c73682f5717b32edc90935bcf [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
Heinrich Schuchardt0c4759f2023-01-25 19:14:59 +010031In general, all boards for which a default configuration file exists in the
32configs/ directory 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
Heinrich Schuchardt0c4759f2023-01-25 19:14:59 +010035In case of problems you can use
wdenkc6097192002-11-03 00:24:07 +000036
Heinrich Schuchardt0c4759f2023-01-25 19:14:59 +010037 scripts/get_maintainer.pl <path>
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000038
Heinrich Schuchardt0c4759f2023-01-25 19:14:59 +010039to identify the people or companies responsible for various boards and
40subsystems. Or have a look at the git log.
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041
wdenkc6097192002-11-03 00:24:07 +000042
43Where to get help:
44==================
45
wdenk24ee89b2002-11-03 17:56:27 +000046In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050047U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050048<u-boot@lists.denx.de>. There is also an archive of previous traffic
49on the mailing list - please search the archive before asking FAQ's.
Naoki Hayama6681bbb2020-10-08 13:16:18 +090050Please see https://lists.denx.de/pipermail/u-boot and
51https://marc.info/?l=u-boot
wdenkc6097192002-11-03 00:24:07 +000052
Wolfgang Denk218ca722008-03-26 10:40:12 +010053Where to get source code:
54=========================
55
Robert P. J. Day7207b362015-12-19 07:16:10 -050056The U-Boot source code is maintained in the Git repository at
Heinrich Schuchardta3bbd0b2021-02-24 13:19:04 +010057https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
58https://source.denx.de/u-boot/u-boot
Wolfgang Denk218ca722008-03-26 10:40:12 +010059
Naoki Hayamac4bd51e2020-10-08 13:16:25 +090060The "Tags" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020061any version you might be interested in. Official releases are also
Naoki Hayamac4bd51e2020-10-08 13:16:25 +090062available from the DENX file server through HTTPS or FTP.
63https://ftp.denx.de/pub/u-boot/
64ftp://ftp.denx.de/pub/u-boot/
Wolfgang Denk218ca722008-03-26 10:40:12 +010065
66
wdenkc6097192002-11-03 00:24:07 +000067Where we come from:
68===================
69
70- start from 8xxrom sources
Naoki Hayama047f6ec2020-10-08 13:17:16 +090071- create PPCBoot project (https://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000072- clean up code
73- make it easier to add custom boards
74- make it possible to add other [PowerPC] CPUs
75- extend functions, especially:
76 * Provide extended interface to Linux boot loader
77 * S-Record download
78 * network boot
Simon Glass9e5616d2019-08-01 09:47:14 -060079 * ATA disk / SCSI ... boot
Naoki Hayama047f6ec2020-10-08 13:17:16 +090080- create ARMBoot project (https://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000081- add other CPU families (starting with ARM)
Naoki Hayama047f6ec2020-10-08 13:17:16 +090082- create U-Boot project (https://sourceforge.net/projects/u-boot)
83- current project page: see https://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000084
85
86Names and Spelling:
87===================
88
89The "official" name of this project is "Das U-Boot". The spelling
90"U-Boot" shall be used in all written text (documentation, comments
91in source files etc.). Example:
92
93 This is the README file for the U-Boot project.
94
95File names etc. shall be based on the string "u-boot". Examples:
96
97 include/asm-ppc/u-boot.h
98
99 #include <asm/u-boot.h>
100
101Variable names, preprocessor constants etc. shall be either based on
102the string "u_boot" or on "U_BOOT". Example:
103
104 U_BOOT_VERSION u_boot_logo
105 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000106
107
wdenkc6097192002-11-03 00:24:07 +0000108Software Configuration:
109=======================
110
wdenkc6097192002-11-03 00:24:07 +0000111Selection of Processor Architecture and Board Type:
112---------------------------------------------------
113
114For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200115configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000116
117Example: For a TQM823L module type:
118
119 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200120 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000121
Robert P. J. Day7207b362015-12-19 07:16:10 -0500122Note: If you're looking for the default configuration file for a board
123you're sure used to be there but is now missing, check the file
124doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000125
Simon Glass75b3c3a2014-03-22 17:12:59 -0600126Sandbox Environment:
127--------------------
128
129U-Boot can be built natively to run on a Linux host using the 'sandbox'
130board. This allows feature development which is not board- or architecture-
131specific to be undertaken on a native platform. The sandbox is also used to
132run some of U-Boot's tests.
133
Heinrich Schuchardtcf69dc72023-01-25 19:14:56 +0100134See doc/arch/sandbox/sandbox.rst for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600135
136
Simon Glassdb910352015-03-03 08:03:00 -0700137Board Initialisation Flow:
138--------------------------
139
140This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500141SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700142
Robert P. J. Day7207b362015-12-19 07:16:10 -0500143Note: "SPL" stands for "Secondary Program Loader," which is explained in
144more detail later in this file.
145
146At present, SPL mostly uses a separate code path, but the function names
147and roles of each function are the same. Some boards or architectures
148may not conform to this. At least most ARM boards which use
149CONFIG_SPL_FRAMEWORK conform to this.
150
151Execution typically starts with an architecture-specific (and possibly
152CPU-specific) start.S file, such as:
153
154 - arch/arm/cpu/armv7/start.S
155 - arch/powerpc/cpu/mpc83xx/start.S
156 - arch/mips/cpu/start.S
157
158and so on. From there, three functions are called; the purpose and
159limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700160
161lowlevel_init():
162 - purpose: essential init to permit execution to reach board_init_f()
163 - no global_data or BSS
164 - there is no stack (ARMv7 may have one but it will soon be removed)
165 - must not set up SDRAM or use console
166 - must only do the bare minimum to allow execution to continue to
167 board_init_f()
168 - this is almost never needed
169 - return normally from this function
170
171board_init_f():
172 - purpose: set up the machine ready for running board_init_r():
173 i.e. SDRAM and serial UART
174 - global_data is available
175 - stack is in SRAM
176 - BSS is not available, so you cannot use global/static variables,
177 only stack variables and global_data
178
179 Non-SPL-specific notes:
180 - dram_init() is called to set up DRAM. If already done in SPL this
181 can do nothing
182
183 SPL-specific notes:
184 - you can override the entire board_init_f() function with your own
185 version as needed.
186 - preloader_console_init() can be called here in extremis
187 - should set up SDRAM, and anything needed to make the UART work
Naoki Hayama499696e2020-09-24 15:57:19 +0900188 - there is no need to clear BSS, it will be done by crt0.S
Andreas Dannenberg14254652019-08-08 12:54:49 -0500189 - for specific scenarios on certain architectures an early BSS *can*
190 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
191 of BSS prior to entering board_init_f()) but doing so is discouraged.
192 Instead it is strongly recommended to architect any code changes
193 or additions such to not depend on the availability of BSS during
194 board_init_f() as indicated in other sections of this README to
195 maintain compatibility and consistency across the entire code base.
Simon Glassdb910352015-03-03 08:03:00 -0700196 - must return normally from this function (don't call board_init_r()
197 directly)
198
199Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
200this point the stack and global_data are relocated to below
201CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
202memory.
203
204board_init_r():
205 - purpose: main execution, common code
206 - global_data is available
207 - SDRAM is available
208 - BSS is available, all static/global variables can be used
209 - execution eventually continues to main_loop()
210
211 Non-SPL-specific notes:
212 - U-Boot is relocated to the top of memory and is now running from
213 there.
214
215 SPL-specific notes:
216 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
Ashish Kumar63b23162017-08-11 11:09:14 +0530217 CONFIG_SYS_FSL_HAS_CCI400
218
219 Defined For SoC that has cache coherent interconnect
220 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000221
Ashish Kumarc055cee2017-08-18 10:54:36 +0530222 CONFIG_SYS_FSL_HAS_CCN504
223
224 Defined for SoC that has cache coherent interconnect CCN-504
225
wdenkc6097192002-11-03 00:24:07 +0000226The following options need to be configured:
227
Kim Phillips26281142007-08-10 13:28:25 -0500228- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000229
Kim Phillips26281142007-08-10 13:28:25 -0500230- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200231
Kumar Gala66412c62011-02-18 05:40:54 -0600232- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000233 CONFIG_SYS_PPC64
234
235 Specifies that the core is a 64-bit PowerPC implementation (implements
236 the "64" category of the Power ISA). This is necessary for ePAPR
237 compliance, among other possible reasons.
238
Scott Wood33eee332012-08-14 10:14:53 +0000239 CONFIG_SYS_FSL_ERRATUM_A004510
240
241 Enables a workaround for erratum A004510. If set,
242 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
Tom Rini6cc04542022-10-28 20:27:13 -0400243 CFG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
Scott Wood33eee332012-08-14 10:14:53 +0000244
245 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
246 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
247
248 Defines one or two SoC revisions (low 8 bits of SVR)
249 for which the A004510 workaround should be applied.
250
251 The rest of SVR is either not relevant to the decision
252 of whether the erratum is present (e.g. p2040 versus
253 p2041) or is implied by the build target, which controls
254 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
255
256 See Freescale App Note 4493 for more information about
257 this erratum.
258
Tom Rini6cc04542022-10-28 20:27:13 -0400259 CFG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
Scott Wood33eee332012-08-14 10:14:53 +0000260
261 This is the value to write into CCSR offset 0x18600
262 according to the A004510 workaround.
263
Priyanka Jainb1359912013-12-17 14:25:52 +0530264 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
265 Single Source Clock is clocking mode present in some of FSL SoC's.
266 In this mode, a single differential clock is used to supply
267 clocks to the sysclock, ddrclock and usbclock.
268
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000269- Generic CPU options:
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000270
York Sun5614e712013-09-30 09:22:09 -0700271 CONFIG_SYS_FSL_DDR
272 Freescale DDR driver in use. This type of DDR controller is
Tom Rini1c588572021-05-14 21:34:26 -0400273 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
York Sun5614e712013-09-30 09:22:09 -0700274
Tom Rini6cc04542022-10-28 20:27:13 -0400275 CFG_SYS_FSL_DDR_ADDR
York Sun5614e712013-09-30 09:22:09 -0700276 Freescale DDR memory-mapped register base.
277
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530278 CONFIG_SYS_FSL_IFC_CLK_DIV
279 Defines divider of platform clock(clock input to IFC controller).
280
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530281 CONFIG_SYS_FSL_LBC_CLK_DIV
282 Defines divider of platform clock(clock input to eLBC controller).
283
Tom Rini6cc04542022-10-28 20:27:13 -0400284 CFG_SYS_FSL_DDR_SDRAM_BASE_PHY
York Sun6b9e3092014-02-10 13:59:43 -0800285 Physical address from the view of DDR controllers. It is the
Tom Rini65cc0e22022-11-16 13:10:41 -0500286 same as CFG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
York Sun6b9e3092014-02-10 13:59:43 -0800287 it could be different for ARM SoCs.
288
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200289- MIPS CPU options:
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200290 CONFIG_XWAY_SWAP_BYTES
291
292 Enable compilation of tools/xway-swap-bytes needed for Lantiq
293 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
294 be swapped if a flash programmer is used.
295
Christian Rieschb67d8812012-02-02 00:44:39 +0000296- ARM options:
Tom Rini65cc0e22022-11-16 13:10:41 -0500297 CFG_SYS_EXCEPTION_VECTORS_HIGH
Christian Rieschb67d8812012-02-02 00:44:39 +0000298
299 Select high exception vectors of the ARM core, e.g., do not
300 clear the V bit of the c1 register of CP15.
301
York Sun207774b2015-03-20 19:28:08 -0700302 COUNTER_FREQUENCY
303 Generic timer clock source frequency.
304
305 COUNTER_FREQUENCY_REAL
306 Generic timer clock source frequency if the real clock is
307 different from COUNTER_FREQUENCY, and can only be determined
308 at run time.
309
Stephen Warren73c38932015-01-19 16:25:52 -0700310- Tegra SoC options:
311 CONFIG_TEGRA_SUPPORT_NON_SECURE
312
313 Support executing U-Boot in non-secure (NS) mode. Certain
314 impossible actions will be skipped if the CPU is in NS mode,
315 such as ARM architectural timer initialization.
316
wdenk5da627a2003-10-09 20:09:04 +0000317- Linux Kernel Interface:
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400318 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200319
320 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400321 passed using flattened device trees (based on open firmware
322 concepts).
323
324 CONFIG_OF_LIBFDT
325 * New libfdt-based support
326 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500327 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400328
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200329 OF_TBCLK - The timebase frequency.
330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331 boards with QUICC Engines require OF_QE to set UCC MAC
332 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500333
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200334 CONFIG_OF_IDE_FIXUP
335
336 U-Boot can detect if an IDE device is present or not.
337 If not, and this new config option is activated, U-Boot
338 removes the ATA node from the DTS before booting Linux,
339 so the Linux IDE driver does not probe the device and
340 crash. This is needed for buggy hardware (uc101) where
341 no pull down resistor is connected to the signal IDE5V_DD7.
342
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100343- vxWorks boot parameters:
344
345 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700346 environments variables: bootdev, bootfile, ipaddr, netmask,
347 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100348 It loads the vxWorks image pointed bootfile.
349
Naoki Hayama81a05d92020-10-08 13:17:08 +0900350 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100351 the defaults discussed just above.
352
Aneesh V93bc2192011-06-16 23:30:51 +0000353- Cache Configuration for ARM:
Tom Rini65cc0e22022-11-16 13:10:41 -0500354 CFG_SYS_PL310_BASE - Physical base address of PL310
Aneesh V93bc2192011-06-16 23:30:51 +0000355 controller register space
356
wdenk6705d812004-08-02 23:22:59 +0000357- Serial Ports:
Tom Rinif410d0a2022-12-04 10:13:30 -0500358 CFG_PL011_CLOCK
wdenk6705d812004-08-02 23:22:59 +0000359
360 If you have Amba PrimeCell PL011 UARTs, set this variable to
361 the clock speed of the UARTs.
362
Tom Rinib8615742022-12-04 10:13:31 -0500363 CFG_PL01x_PORTS
wdenk6705d812004-08-02 23:22:59 +0000364
365 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
366 define this to a list of base addresses for each (supported)
367 port. See e.g. include/configs/versatile.h
368
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400369 CONFIG_SERIAL_HW_FLOW_CONTROL
370
371 Define this variable to enable hw flow control in serial driver.
372 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000373
Simon Glass302a6482016-03-13 19:07:28 -0600374- Removal of commands
375 If no commands are needed to boot, you can disable
376 CONFIG_CMDLINE to remove them. In this case, the command line
377 will not be available, and when U-Boot wants to execute the
378 boot command (on start-up) it will call board_run_command()
379 instead. This can reduce image size significantly for very
380 simple boot procedures.
381
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000382- Regular expression support:
383 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200384 If this variable is defined, U-Boot is linked against
385 the SLRE (Super Light Regular Expression) library,
386 which adds regex support to some commands, as for
387 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000388
wdenkc6097192002-11-03 00:24:07 +0000389- Watchdog:
Tom Rini6e7df1d2023-01-10 11:19:45 -0500390 CFG_SYS_WATCHDOG_FREQ
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200391 Some platforms automatically call WATCHDOG_RESET()
392 from the timer interrupt handler every
Tom Rini6e7df1d2023-01-10 11:19:45 -0500393 CFG_SYS_WATCHDOG_FREQ interrupts. If not set by the
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200394 board configuration file, a default of CONFIG_SYS_HZ/2
Tom Rini6e7df1d2023-01-10 11:19:45 -0500395 (i.e. 500) is used. Setting CFG_SYS_WATCHDOG_FREQ
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200396 to 0 disables calling WATCHDOG_RESET() from the timer
397 interrupt.
398
Peter Tysere92739d2008-12-17 16:36:21 -0600399- GPIO Support:
Tom Rini65cc0e22022-11-16 13:10:41 -0500400 The CFG_SYS_I2C_PCA953X_WIDTH option specifies a list of
Chris Packham5dec49c2010-12-19 10:12:13 +0000401 chip-ngpio pairs that tell the PCA953X driver the number of
402 pins supported by a particular chip.
403
Peter Tysere92739d2008-12-17 16:36:21 -0600404 Note that if the GPIO device uses I2C, then the I2C interface
405 must also be configured. See I2C Support, below.
406
Simon Glassaa532332014-06-11 23:29:41 -0600407- I/O tracing:
408 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
409 accesses and can checksum them or write a list of them out
410 to memory. See the 'iotrace' command for details. This is
411 useful for testing device drivers since it can confirm that
412 the driver behaves the same way before and after a code
413 change. Currently this is supported on sandbox and arm. To
414 add support for your architecture, add '#include <iotrace.h>'
415 to the bottom of arch/<arch>/include/asm/io.h and test.
416
417 Example output from the 'iotrace stats' command is below.
418 Note that if the trace buffer is exhausted, the checksum will
419 still continue to operate.
420
421 iotrace is enabled
422 Start: 10000000 (buffer start address)
423 Size: 00010000 (buffer size)
424 Offset: 00000120 (current buffer offset)
425 Output: 10000120 (start + offset)
426 Count: 00000018 (number of trace records)
427 CRC32: 9526fb66 (CRC32 of all trace records)
428
wdenkc6097192002-11-03 00:24:07 +0000429- Timestamp Support:
430
wdenk43d96162003-03-06 00:02:04 +0000431 When CONFIG_TIMESTAMP is selected, the timestamp
432 (date and time) of an image is printed by image
433 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500434 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000435
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000436- Partition Labels (disklabels) Supported:
437 Zero or more of the following:
438 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000439 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
440 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
441 bootloader. Note 2TB partition limit; see
442 disk/part_efi.c
Simon Glassc649e3c2016-05-01 11:36:02 -0600443 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000444 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000445
wdenkc6097192002-11-03 00:24:07 +0000446- NETWORK Support (PCI):
Kyle Moffettce5207e2011-10-18 11:05:29 +0000447 CONFIG_E1000_SPI
448 Utility code for direct access to the SPI bus on Intel 8257x.
449 This does not do anything useful unless you set at least one
450 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
451
wdenkc6097192002-11-03 00:24:07 +0000452 CONFIG_NATSEMI
453 Support for National dp83815 chips.
454
455 CONFIG_NS8382X
456 Support for National dp8382[01] gigabit chips.
457
wdenk45219c42003-05-12 21:50:16 +0000458- NETWORK Support (other):
Rob Herringefdd7312011-12-15 11:15:49 +0000459 CONFIG_CALXEDA_XGMAC
460 Support for the Calxeda XGMAC device
461
Ashok3bb46d22012-10-15 06:20:47 +0000462 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000463 Support for SMSC's LAN91C96 chips.
464
wdenk45219c42003-05-12 21:50:16 +0000465 CONFIG_LAN91C96_USE_32_BIT
466 Define this to enable 32 bit addressing
467
Tom Rini6e7df1d2023-01-10 11:19:45 -0500468 CFG_SYS_DAVINCI_EMAC_PHY_COUNT
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500469 Define this if you have more then 3 PHYs.
470
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800471 CONFIG_FTGMAC100
472 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
473
474 CONFIG_FTGMAC100_EGIGA
475 Define this to use GE link update with gigabit PHY.
476 Define this if FTGMAC100 is connected to gigabit PHY.
477 If your system has 10/100 PHY only, it might not occur
478 wrong behavior. Because PHY usually return timeout or
479 useless data when polling gigabit status and gigabit
480 control registers. This behavior won't affect the
481 correctnessof 10/100 link speed update.
482
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900483 CONFIG_SH_ETHER
484 Support for Renesas on-chip Ethernet controller
485
Tom Rini97148cb2022-12-04 10:13:52 -0500486 CFG_SH_ETHER_USE_PORT
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900487 Define the number of ports to be used
488
Tom Rini7c480ba2022-12-04 10:13:50 -0500489 CFG_SH_ETHER_PHY_ADDR
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900490 Define the ETH PHY's address
491
Tom Riniff53ecc2022-12-04 10:13:49 -0500492 CFG_SH_ETHER_CACHE_WRITEBACK
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900493 If this option is set, the driver enables cache flush.
494
Vadim Bendebury5e124722011-10-17 08:36:14 +0000495- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000496 CONFIG_TPM
497 Support TPM devices.
498
Christophe Ricard0766ad22015-10-06 22:54:41 +0200499 CONFIG_TPM_TIS_INFINEON
500 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000501 per system is supported at this time.
502
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000503 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
504 Define the burst count bytes upper limit
505
Christophe Ricard3aa74082016-01-21 23:27:13 +0100506 CONFIG_TPM_ST33ZP24
507 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
508
509 CONFIG_TPM_ST33ZP24_I2C
510 Support for STMicroelectronics ST33ZP24 I2C devices.
511 Requires TPM_ST33ZP24 and I2C.
512
Christophe Ricardb75fdc12016-01-21 23:27:14 +0100513 CONFIG_TPM_ST33ZP24_SPI
514 Support for STMicroelectronics ST33ZP24 SPI devices.
515 Requires TPM_ST33ZP24 and SPI.
516
Dirk Eibachc01939c2013-06-26 15:55:15 +0200517 CONFIG_TPM_ATMEL_TWI
518 Support for Atmel TWI TPM device. Requires I2C support.
519
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000520 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +0000521 Support for generic parallel port TPM devices. Only one device
522 per system is supported at this time.
523
Reinhard Pfaube6c1522013-06-26 15:55:13 +0200524 CONFIG_TPM
525 Define this to enable the TPM support library which provides
526 functional interfaces to some TPM commands.
527 Requires support for a TPM device.
528
529 CONFIG_TPM_AUTH_SESSIONS
530 Define this to enable authorized functions in the TPM library.
531 Requires CONFIG_TPM and CONFIG_SHA1.
532
wdenkc6097192002-11-03 00:24:07 +0000533- USB Support:
534 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +0200535 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000536 CONFIG_USB_UHCI to enable it.
537 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000538 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000539 storage devices.
540 Note:
541 Supported are USB Keyboards and USB Floppy drives
542 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000543
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -0700544 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
545 HW module registers.
546
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200547- USB Device:
548 Define the below if you wish to use the USB console.
549 Once firmware is rebuilt from a serial console issue the
550 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200551 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200552 it has found a new device. The environment variable usbtty
553 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200554 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200555 Common Device Class Abstract Control Model serial device.
556 If you select usbtty = gserial you should be able to enumerate
557 a Linux host by
558 # modprobe usbserial vendor=0xVendorID product=0xProductID
559 else if using cdc_acm, simply setting the environment
560 variable usbtty to be cdc_acm should suffice. The following
561 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200562
Wolfgang Denk386eda02006-06-14 18:14:56 +0200563 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200564 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200565 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200566 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
567 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
568 should pretend to be a Linux device to it's target host.
569
570 CONFIG_USBD_MANUFACTURER
571 Define this string as the name of your company for
572 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200573
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200574 CONFIG_USBD_PRODUCT_NAME
575 Define this string as the name of your product
576 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
577
578 CONFIG_USBD_VENDORID
579 Define this as your assigned Vendor ID from the USB
580 Implementors Forum. This *must* be a genuine Vendor ID
581 to avoid polluting the USB namespace.
582 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200583
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200584 CONFIG_USBD_PRODUCTID
585 Define this as the unique Product ID
586 for your device
587 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000588
Igor Grinbergd70a5602011-12-12 12:08:35 +0200589- ULPI Layer Support:
590 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
591 the generic ULPI layer. The generic layer accesses the ULPI PHY
592 via the platform viewport, so you need both the genric layer and
593 the viewport enabled. Currently only Chipidea/ARC based
594 viewport is supported.
595 To enable the ULPI layer support, define CONFIG_USB_ULPI and
596 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +0200597 If your ULPI phy needs a different reference clock than the
Tom Rini6e7df1d2023-01-10 11:19:45 -0500598 standard 24 MHz then you have to define CFG_ULPI_REF_CLK to
Lucas Stach6d365ea2012-10-01 00:44:35 +0200599 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +0000600
601- MMC Support:
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +0000602 CONFIG_SH_MMCIF
603 Support for Renesas on-chip MMCIF controller
604
605 CONFIG_SH_MMCIF_ADDR
606 Define the base address of MMCIF registers
607
608 CONFIG_SH_MMCIF_CLK
609 Define the clock frequency for MMCIF
610
Tom Rinib3ba6e92013-03-14 05:32:47 +0000611- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +0100612 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +0000613 This enables the USB portion of the DFU USB class
614
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000615 CONFIG_DFU_NAND
616 This enables support for exposing NAND devices via DFU.
617
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530618 CONFIG_DFU_RAM
619 This enables support for exposing RAM via DFU.
620 Note: DFU spec refer to non-volatile memory usage, but
621 allow usages beyond the scope of spec - here RAM usage,
622 one that would help mostly the developer.
623
Heiko Schochere7e75c72013-06-12 06:05:51 +0200624 CONFIG_SYS_DFU_DATA_BUF_SIZE
625 Dfu transfer uses a buffer before writing data to the
626 raw storage device. Make the size (in bytes) of this buffer
627 configurable. The size of this buffer is also configurable
628 through the "dfu_bufsiz" environment variable.
629
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000630 CONFIG_SYS_DFU_MAX_FILE_SIZE
631 When updating files rather than the raw storage device,
632 we use a static buffer to copy the file into and then write
633 the buffer once we've been given the whole file. Define
634 this to the maximum filesize (in bytes) for the buffer.
635 Default is 4 MiB if undefined.
636
Heiko Schocher001a8312014-03-18 08:09:56 +0100637 DFU_DEFAULT_POLL_TIMEOUT
638 Poll timeout [ms], is the timeout a device can send to the
639 host. The host must wait for this timeout before sending
640 a subsequent DFU_GET_STATUS request to the device.
641
642 DFU_MANIFEST_POLL_TIMEOUT
643 Poll timeout [ms], which the device sends to the host when
644 entering dfuMANIFEST state. Host waits this timeout, before
645 sending again an USB request to the device.
646
wdenkc6097192002-11-03 00:24:07 +0000647- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -0700648 See Kconfig help for available keyboard drivers.
649
wdenk17ea1172004-06-06 21:51:03 +0000650- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +0000651 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
652
653 The clock frequency of the MII bus
654
wdenk17ea1172004-06-06 21:51:03 +0000655 CONFIG_PHY_CMD_DELAY (ppc4xx)
656
657 Some PHY like Intel LXT971A need extra delay after
658 command issued before MII status register can be read
659
wdenkc6097192002-11-03 00:24:07 +0000660- BOOTP Recovery Mode:
661 CONFIG_BOOTP_RANDOM_DELAY
662
663 If you have many targets in a network that try to
664 boot using BOOTP, you may want to avoid that all
665 systems send out BOOTP requests at precisely the same
666 moment (which would happen for instance at recovery
667 from a power failure, when all systems will try to
668 boot, thus flooding the BOOTP server. Defining
669 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
670 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +0200671 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +0000672
673 1st BOOTP request: delay 0 ... 1 sec
674 2nd BOOTP request: delay 0 ... 2 sec
675 3rd BOOTP request: delay 0 ... 4 sec
676 4th and following
677 BOOTP requests: delay 0 ... 8 sec
678
Tom Rini6e7df1d2023-01-10 11:19:45 -0500679 CFG_BOOTP_ID_CACHE_SIZE
Thierry Reding92ac8ac2014-08-19 10:21:24 +0200680
681 BOOTP packets are uniquely identified using a 32-bit ID. The
682 server will copy the ID from client requests to responses and
683 U-Boot will use this to determine if it is the destination of
684 an incoming response. Some servers will check that addresses
685 aren't in use before handing them out (usually using an ARP
686 ping) and therefore take up to a few hundred milliseconds to
687 respond. Network congestion may also influence the time it
688 takes for a response to make it back to the client. If that
689 time is too long, U-Boot will retransmit requests. In order
690 to allow earlier responses to still be accepted after these
691 retransmissions, U-Boot's BOOTP client keeps a small cache of
Tom Rini6e7df1d2023-01-10 11:19:45 -0500692 IDs. The CFG_BOOTP_ID_CACHE_SIZE controls the size of this
Thierry Reding92ac8ac2014-08-19 10:21:24 +0200693 cache. The default is to keep IDs for up to four outstanding
694 requests. Increasing this will allow U-Boot to accept offers
695 from a BOOTP client in networks with unusually high latency.
696
stroesefe389a82003-08-28 14:17:32 +0000697- DHCP Advanced Options:
Joe Hershberger2c00e092012-05-23 07:59:19 +0000698
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000699 - Link-local IP address negotiation:
700 Negotiate with other link-local clients on the local network
701 for an address that doesn't require explicit configuration.
702 This is especially useful if a DHCP server cannot be guaranteed
703 to exist in all environments that the device must operate.
704
705 See doc/README.link-local for more information.
706
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +0530707 - MAC address from environment variables
708
709 FDT_SEQ_MACADDR_FROM_ENV
710
711 Fix-up device tree with MAC addresses fetched sequentially from
712 environment variables. This config work on assumption that
713 non-usable ethernet node of device-tree are either not present
714 or their status has been marked as "disabled".
715
wdenka3d991b2004-04-15 21:48:45 +0000716 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +0000717 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +0000718
719 The device id used in CDP trigger frames.
720
721 CONFIG_CDP_DEVICE_ID_PREFIX
722
723 A two character string which is prefixed to the MAC address
724 of the device.
725
726 CONFIG_CDP_PORT_ID
727
728 A printf format string which contains the ascii name of
729 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200730 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +0000731
732 CONFIG_CDP_CAPABILITIES
733
734 A 32bit integer which indicates the device capabilities;
735 0x00000010 for a normal host which does not forwards.
736
737 CONFIG_CDP_VERSION
738
739 An ascii string containing the version of the software.
740
741 CONFIG_CDP_PLATFORM
742
743 An ascii string containing the name of the platform.
744
745 CONFIG_CDP_TRIGGER
746
747 A 32bit integer sent on the trigger.
748
749 CONFIG_CDP_POWER_CONSUMPTION
750
751 A 16bit integer containing the power consumption of the
752 device in .1 of milliwatts.
753
754 CONFIG_CDP_APPLIANCE_VLAN_TYPE
755
756 A byte containing the id of the VLAN.
757
Uri Mashiach79267ed2017-01-19 10:51:05 +0200758- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +0000759
760 Several configurations allow to display the current
761 status using a LED. For instance, the LED will blink
762 fast while running U-Boot code, stop blinking as
763 soon as a reply to a BOOTP request was received, and
764 start blinking slow once the Linux kernel is running
765 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +0200766 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +0000767 feature in U-Boot.
768
Igor Grinberg1df7bbb2013-11-08 01:03:50 +0200769 Additional options:
770
Uri Mashiach79267ed2017-01-19 10:51:05 +0200771 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +0200772 The status LED can be connected to a GPIO pin.
773 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +0200774 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +0200775 to include the gpio_led driver in the U-Boot binary.
776
Tom Rini6e7df1d2023-01-10 11:19:45 -0500777 CFG_GPIO_LED_INVERTED_TABLE
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +0200778 Some GPIO connected LEDs may have inverted polarity in which
779 case the GPIO high value corresponds to LED off state and
780 GPIO low value corresponds to LED on state.
Tom Rini6e7df1d2023-01-10 11:19:45 -0500781 In such cases CFG_GPIO_LED_INVERTED_TABLE may be defined
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +0200782 with a list of GPIO LEDs that have inverted polarity.
783
Tom Rini55dabcc2021-08-18 23:12:24 -0400784- I2C Support:
Tom Rinicdc5ed82022-11-16 13:10:29 -0500785 CFG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -0600786 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000787
Tom Rinid8964b32022-12-04 10:13:57 -0500788 CFG_SYS_I2C_DIRECT_BUS
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000789 define this, if you don't use i2c muxes on your hardware.
Tom Rini65cc0e22022-11-16 13:10:41 -0500790 if CFG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000791 omit this define.
792
Tom Rini65cc0e22022-11-16 13:10:41 -0500793 CFG_SYS_I2C_MAX_HOPS
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000794 define how many muxes are maximal consecutively connected
795 on one i2c bus. If you not use i2c muxes, omit this
796 define.
797
Tom Rini65cc0e22022-11-16 13:10:41 -0500798 CFG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800799 hold a list of buses you want to use, only used if
Tom Rinid8964b32022-12-04 10:13:57 -0500800 CFG_SYS_I2C_DIRECT_BUS is not defined, for example
Tom Rini65cc0e22022-11-16 13:10:41 -0500801 a board with CFG_SYS_I2C_MAX_HOPS = 1 and
Tom Rinicdc5ed82022-11-16 13:10:29 -0500802 CFG_SYS_NUM_I2C_BUSES = 9:
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000803
Tom Rini65cc0e22022-11-16 13:10:41 -0500804 CFG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000805 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
806 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
807 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
808 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
809 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
810 {1, {I2C_NULL_HOP}}, \
811 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
812 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
813 }
814
815 which defines
816 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +0100817 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
818 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
819 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
820 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
821 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000822 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +0100823 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
824 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000825
826 If you do not have i2c muxes on your board, omit this define.
827
Simon Glassce3b5d62017-05-12 21:10:00 -0600828- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +0100829 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +0000830 then the following macros need to be defined (examples are
831 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +0000832
833 I2C_INIT
834
wdenkb37c7e52003-06-30 16:24:52 +0000835 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +0000836 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +0000837
wdenkba56f622004-02-06 23:19:44 +0000838 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +0000839
wdenkc6097192002-11-03 00:24:07 +0000840 I2C_ACTIVE
841
842 The code necessary to make the I2C data line active
843 (driven). If the data line is open collector, this
844 define can be null.
845
wdenkb37c7e52003-06-30 16:24:52 +0000846 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
847
wdenkc6097192002-11-03 00:24:07 +0000848 I2C_TRISTATE
849
850 The code necessary to make the I2C data line tri-stated
851 (inactive). If the data line is open collector, this
852 define can be null.
853
wdenkb37c7e52003-06-30 16:24:52 +0000854 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
855
wdenkc6097192002-11-03 00:24:07 +0000856 I2C_READ
857
York Sun472d5462013-04-01 11:29:11 -0700858 Code that returns true if the I2C data line is high,
859 false if it is low.
wdenkc6097192002-11-03 00:24:07 +0000860
wdenkb37c7e52003-06-30 16:24:52 +0000861 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
862
wdenkc6097192002-11-03 00:24:07 +0000863 I2C_SDA(bit)
864
York Sun472d5462013-04-01 11:29:11 -0700865 If <bit> is true, sets the I2C data line high. If it
866 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +0000867
wdenkb37c7e52003-06-30 16:24:52 +0000868 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +0000869 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +0000870 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +0000871
wdenkc6097192002-11-03 00:24:07 +0000872 I2C_SCL(bit)
873
York Sun472d5462013-04-01 11:29:11 -0700874 If <bit> is true, sets the I2C clock line high. If it
875 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +0000876
wdenkb37c7e52003-06-30 16:24:52 +0000877 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +0000878 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +0000879 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +0000880
wdenkc6097192002-11-03 00:24:07 +0000881 I2C_DELAY
882
883 This delay is invoked four times per clock cycle so this
884 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +0000885 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +0000886 like:
887
wdenkb37c7e52003-06-30 16:24:52 +0000888 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +0000889
Mike Frysinger793b5722010-07-21 13:38:02 -0400890 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
891
892 If your arch supports the generic GPIO framework (asm/gpio.h),
893 then you may alternatively define the two GPIOs that are to be
894 used as SCL / SDA. Any of the previous I2C_xxx macros will
895 have GPIO-based defaults assigned to them as appropriate.
896
897 You should define these to the GPIO value as given directly to
898 the generic GPIO functions.
899
Tom Rinie06b9b82022-12-04 10:04:08 -0500900 CFG_I2C_MULTI_BUS
Ben Warrenbb99ad62006-09-07 16:50:54 -0400901
902 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000903 must have a controller. At any point in time, only one bus is
904 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -0400905 Note that bus numbering is zero-based.
906
Tom Rini65cc0e22022-11-16 13:10:41 -0500907 CFG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -0400908
909 This option specifies a list of I2C devices that will be skipped
Tom Rini1353b252022-12-02 16:42:30 -0500910 when the 'i2c probe' command is issued.
Ben Warrenbb99ad62006-09-07 16:50:54 -0400911
912 e.g.
Tom Rini65cc0e22022-11-16 13:10:41 -0500913 #define CFG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -0400914
915 will skip addresses 0x50 and 0x68 on a board with one I2C bus
916
Tom Rini65cc0e22022-11-16 13:10:41 -0500917 CFG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +0100918
919 If defined, then this indicates the I2C bus number for the RTC.
920 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
921
Andrew Dyer2ac69852008-12-29 17:36:01 -0600922 CONFIG_SOFT_I2C_READ_REPEATED_START
923
924 defining this will force the i2c_read() function in
925 the soft_i2c driver to perform an I2C repeated start
926 between writing the address pointer and reading the
927 data. If this define is omitted the default behaviour
928 of doing a stop-start sequence will be used. Most I2C
929 devices can use either method, but some require one or
930 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -0600931
wdenkc6097192002-11-03 00:24:07 +0000932- SPI Support: CONFIG_SPI
933
934 Enables SPI driver (so far only tested with
935 SPI EEPROM, also an instance works with Crystal A/D and
936 D/As on the SACSng board)
937
Tom Rini6e7df1d2023-01-10 11:19:45 -0500938 CFG_SYS_SPI_MXC_WAIT
Heiko Schocherf659b572014-07-14 10:22:11 +0200939 Timeout for waiting until spi transfer completed.
940 default: (CONFIG_SYS_HZ/100) /* 10 ms */
941
Matthias Fuchs01335022007-12-27 17:12:34 +0100942- FPGA Support: CONFIG_FPGA
943
944 Enables FPGA subsystem.
945
946 CONFIG_FPGA_<vendor>
947
948 Enables support for specific chip vendors.
949 (ALTERA, XILINX)
950
951 CONFIG_FPGA_<family>
952
953 Enables support for FPGA family.
954 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200956 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +0000957
wdenk43d96162003-03-06 00:02:04 +0000958 Enable checks on FPGA configuration interface busy
959 status by the configuration function. This option
960 will require a board or device specific function to
961 be written.
wdenkc6097192002-11-03 00:24:07 +0000962
Tom Rini72fc2642022-12-04 10:03:57 -0500963 CFG_FPGA_DELAY
wdenkc6097192002-11-03 00:24:07 +0000964
965 If defined, a function that provides delays in the FPGA
966 configuration driver.
967
Tom Rini6e7df1d2023-01-10 11:19:45 -0500968 CFG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +0000969
wdenk43d96162003-03-06 00:02:04 +0000970 Check for configuration errors during FPGA bitfile
971 loading. For example, abort during Virtex II
972 configuration if the INIT_B line goes low (which
973 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +0000974
Tom Rini65cc0e22022-11-16 13:10:41 -0500975 CFG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +0000976
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800977 Maximum time to wait for the INIT_B line to de-assert
978 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +0000979 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200980 ms.
wdenkc6097192002-11-03 00:24:07 +0000981
Tom Rini65cc0e22022-11-16 13:10:41 -0500982 CFG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +0000983
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800984 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200985 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +0000986
Tom Rini65cc0e22022-11-16 13:10:41 -0500987 CFG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +0000988
wdenk43d96162003-03-06 00:02:04 +0000989 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200990 200 ms.
wdenkc6097192002-11-03 00:24:07 +0000991
wdenkc6097192002-11-03 00:24:07 +0000992- Vendor Parameter Protection:
993
wdenk43d96162003-03-06 00:02:04 +0000994 U-Boot considers the values of the environment
995 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +0000996 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +0000997 are set once by the board vendor / manufacturer, and
998 protects these variables from casual modification by
999 the user. Once set, these variables are read-only,
1000 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001001 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001002
1003 If CONFIG_ENV_OVERWRITE is #defined in your config
1004 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001005 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001006 these parameters.
1007
Joe Hershberger25980902012-12-11 22:16:31 -06001008 The same can be accomplished in a more flexible way
1009 for any variable by configuring the type of access
1010 to allow for those variables in the ".flags" variable
Tom Riniacf29d82022-12-04 10:03:40 -05001011 or define CFG_ENV_FLAGS_LIST_STATIC.
Joe Hershberger25980902012-12-11 22:16:31 -06001012
wdenkc6097192002-11-03 00:24:07 +00001013- Protected RAM:
Tom Rini7c5c1372022-12-04 10:13:37 -05001014 CFG_PRAM
wdenkc6097192002-11-03 00:24:07 +00001015
1016 Define this variable to enable the reservation of
1017 "protected RAM", i. e. RAM which is not overwritten
Tom Rini7c5c1372022-12-04 10:13:37 -05001018 by U-Boot. Define CFG_PRAM to hold the number of
wdenkc6097192002-11-03 00:24:07 +00001019 kB you want to reserve for pRAM. You can overwrite
1020 this default value by defining an environment
1021 variable "pram" to the number of kB you want to
1022 reserve. Note that the board info structure will
1023 still show the full amount of RAM. If pRAM is
1024 reserved, a new environment variable "mem" will
1025 automatically be defined to hold the amount of
1026 remaining RAM in a form that can be passed as boot
1027 argument to Linux, for instance like that:
1028
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001029 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001030 saveenv
1031
1032 This way you can tell Linux not to use this memory,
1033 either, which results in a memory region that will
1034 not be affected by reboots.
1035
1036 *WARNING* If your board configuration uses automatic
1037 detection of the RAM size, you must make sure that
1038 this memory test is non-destructive. So far, the
1039 following board configurations are known to be
1040 "pRAM-clean":
1041
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02001042 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00001043 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02001044 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001045
1046- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001047 Note:
1048
wdenk8bde7f72003-06-27 21:31:46 +00001049 In the current implementation, the local variables
1050 space and global environment variables space are
1051 separated. Local variables are those you define by
1052 simply typing `name=value'. To access a local
1053 variable later on, you have write `$name' or
1054 `${name}'; to execute the contents of a variable
1055 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001056
wdenk43d96162003-03-06 00:02:04 +00001057 Global environment variables are those you use
1058 setenv/printenv to work with. To run a command stored
1059 in such a variable, you need to use the run command,
1060 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001061
1062 To store commands and special characters in a
1063 variable, please use double quotation marks
1064 surrounding the whole text of the variable, instead
1065 of the backslashes before semicolons and special
1066 symbols.
1067
wdenka8c7c702003-12-06 19:49:23 +00001068- Default Environment:
Tom Rini0613c362022-12-04 10:03:50 -05001069 CFG_EXTRA_ENV_SETTINGS
wdenkc6097192002-11-03 00:24:07 +00001070
wdenk43d96162003-03-06 00:02:04 +00001071 Define this to contain any number of null terminated
1072 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001073 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001074
wdenk43d96162003-03-06 00:02:04 +00001075 For example, place something like this in your
1076 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001077
Tom Rini0613c362022-12-04 10:03:50 -05001078 #define CFG_EXTRA_ENV_SETTINGS \
wdenkc6097192002-11-03 00:24:07 +00001079 "myvar1=value1\0" \
1080 "myvar2=value2\0"
1081
wdenk43d96162003-03-06 00:02:04 +00001082 Warning: This method is based on knowledge about the
1083 internal format how the environment is stored by the
1084 U-Boot code. This is NOT an official, exported
1085 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001086 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001087 You better know what you are doing here.
1088
wdenk43d96162003-03-06 00:02:04 +00001089 Note: overly (ab)use of the default environment is
1090 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001091 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001092 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001093
Simon Glass06fd8532012-11-30 13:01:17 +00001094 CONFIG_DELAY_ENVIRONMENT
1095
1096 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001097 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00001098 that so that the environment is not available until
1099 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1100 this is instead controlled by the value of
1101 /config/load-environment.
1102
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01001103- Automatic software updates via TFTP server
1104 CONFIG_UPDATE_TFTP
1105 CONFIG_UPDATE_TFTP_CNT_MAX
1106 CONFIG_UPDATE_TFTP_MSEC_MAX
1107
1108 These options enable and control the auto-update feature;
1109 for a more detailed description refer to doc/README.update.
1110
1111- MTD Support (mtdparts command, UBI support)
Heiko Schocherff94bc42014-06-24 10:10:04 +02001112 CONFIG_MTD_UBI_WL_THRESHOLD
1113 This parameter defines the maximum difference between the highest
1114 erase counter value and the lowest erase counter value of eraseblocks
1115 of UBI devices. When this threshold is exceeded, UBI starts performing
1116 wear leveling by means of moving data from eraseblock with low erase
1117 counter to eraseblocks with high erase counter.
1118
1119 The default value should be OK for SLC NAND flashes, NOR flashes and
1120 other flashes which have eraseblock life-cycle 100000 or more.
1121 However, in case of MLC NAND flashes which typically have eraseblock
1122 life-cycle less than 10000, the threshold should be lessened (e.g.,
1123 to 128 or 256, although it does not have to be power of 2).
1124
1125 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06001126
Heiko Schocherff94bc42014-06-24 10:10:04 +02001127 CONFIG_MTD_UBI_BEB_LIMIT
1128 This option specifies the maximum bad physical eraseblocks UBI
1129 expects on the MTD device (per 1024 eraseblocks). If the
1130 underlying flash does not admit of bad eraseblocks (e.g. NOR
1131 flash), this value is ignored.
1132
1133 NAND datasheets often specify the minimum and maximum NVM
1134 (Number of Valid Blocks) for the flashes' endurance lifetime.
1135 The maximum expected bad eraseblocks per 1024 eraseblocks
1136 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1137 which gives 20 for most NANDs (MaxNVB is basically the total
1138 count of eraseblocks on the chip).
1139
1140 To put it differently, if this value is 20, UBI will try to
1141 reserve about 1.9% of physical eraseblocks for bad blocks
1142 handling. And that will be 1.9% of eraseblocks on the entire
1143 NAND chip, not just the MTD partition UBI attaches. This means
1144 that if you have, say, a NAND flash chip admits maximum 40 bad
1145 eraseblocks, and it is split on two MTD partitions of the same
1146 size, UBI will reserve 40 eraseblocks when attaching a
1147 partition.
1148
1149 default: 20
1150
1151 CONFIG_MTD_UBI_FASTMAP
1152 Fastmap is a mechanism which allows attaching an UBI device
1153 in nearly constant time. Instead of scanning the whole MTD device it
1154 only has to locate a checkpoint (called fastmap) on the device.
1155 The on-flash fastmap contains all information needed to attach
1156 the device. Using fastmap makes only sense on large devices where
1157 attaching by scanning takes long. UBI will not automatically install
1158 a fastmap on old images, but you can set the UBI parameter
1159 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1160 that fastmap-enabled images are still usable with UBI implementations
1161 without fastmap support. On typical flash devices the whole fastmap
1162 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1163
1164 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1165 Set this parameter to enable fastmap automatically on images
1166 without a fastmap.
1167 default: 0
1168
Heiko Schocher0195a7b2015-10-22 06:19:21 +02001169 CONFIG_MTD_UBI_FM_DEBUG
1170 Enable UBI fastmap debug
1171 default: 0
1172
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00001173- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001174 CONFIG_SPL
1175 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00001176
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02001177 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1178 When defined, SPL will panic() if the image it has
1179 loaded does not have a signature.
1180 Defining this is useful when code which loads images
1181 in SPL cannot guarantee that absolutely all read errors
1182 will be caught.
1183 An example is the LPC32XX MLC NAND driver, which will
1184 consider that a completely unreadable NAND block is bad,
1185 and thus should be skipped silently.
1186
Tom Rini861a86f2012-08-13 11:37:56 -07001187 CONFIG_SPL_DISPLAY_PRINT
1188 For ARM, enable an optional function to print more information
1189 about the running system.
1190
Scott Wood06f60ae2012-12-06 13:33:17 +00001191 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1192 Set this for NAND SPL on PPC mpc83xx targets, so that
1193 start.S waits for the rest of the SPL to load before
1194 continuing (the hardware starts execution after just
1195 loading the first page rather than the full 4K).
1196
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02001197 CONFIG_SPL_UBI
1198 Support for a lightweight UBI (fastmap) scanner and
1199 loader
1200
Tom Rini95579792012-02-14 07:29:40 +00001201 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1202 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1203 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
Tom Rini4e590942022-11-12 17:36:51 -05001204 CFG_SYS_NAND_ECCPOS, CFG_SYS_NAND_ECCSIZE,
1205 CFG_SYS_NAND_ECCBYTES
Tom Rini95579792012-02-14 07:29:40 +00001206 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05001207 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00001208
Tom Rini4e590942022-11-12 17:36:51 -05001209 CFG_SYS_NAND_U_BOOT_DST
Scott Wood7d4b7952012-09-21 18:35:27 -05001210 Location in memory to load U-Boot to
1211
Tom Rini4e590942022-11-12 17:36:51 -05001212 CFG_SYS_NAND_U_BOOT_SIZE
Scott Wood7d4b7952012-09-21 18:35:27 -05001213 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00001214
Tom Rini4e590942022-11-12 17:36:51 -05001215 CFG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05001216 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00001217
Pavel Machekc57b9532012-08-30 22:42:11 +02001218 CONFIG_SPL_RAM_DEVICE
1219 Support for running image already present in ram, in SPL binary
1220
Marek Vasutb527b9c2018-05-13 00:22:52 +02001221 CONFIG_SPL_FIT_PRINT
Simon Glass87ebee32013-05-08 08:05:59 +00001222 Printing information about a FIT image adds quite a bit of
1223 code to SPL. So this is normally disabled in SPL. Use this
1224 option to re-enable it. This will affect the output of the
1225 bootm command when booting a FIT image.
1226
wdenka8c7c702003-12-06 19:49:23 +00001227- Interrupt support (PPC):
1228
wdenkd4ca31c2004-01-02 14:00:00 +00001229 There are common interrupt_init() and timer_interrupt()
1230 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001231 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00001232 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001233 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00001234 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001235 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00001236 specific handling. If board has watchdog / status_led
1237 / other_activity_monitor it works automatically from
1238 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001239
wdenkc6097192002-11-03 00:24:07 +00001240
Helmut Raiger9660e442011-10-20 04:19:47 +00001241Board initialization settings:
1242------------------------------
1243
1244During Initialization u-boot calls a number of board specific functions
1245to allow the preparation of board specific prerequisites, e.g. pin setup
1246before drivers are initialized. To enable these callbacks the
1247following configuration macros have to be defined. Currently this is
1248architecture specific, so please check arch/your_architecture/lib/board.c
1249typically in board_init_f() and board_init_r().
1250
1251- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1252- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1253- CONFIG_BOARD_LATE_INIT: Call board_late_init()
wdenkc6097192002-11-03 00:24:07 +00001254
wdenkc6097192002-11-03 00:24:07 +00001255Configuration Settings:
1256-----------------------
1257
Simon Glass4d979bf2019-12-28 10:45:10 -07001258- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
York Sun4d1fd7f2014-02-26 17:03:19 -08001259 Optionally it can be defined to support 64-bit memory commands.
1260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001261- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00001262 undefine this when you're short of memory.
1263
Tom Rini6e7df1d2023-01-10 11:19:45 -05001264- CFG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
Peter Tyser2fb26042009-01-27 18:03:12 -06001265 width of the commands listed in the 'help' command output.
1266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001267- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00001268 prompt for user input.
1269
Tom Rini65cc0e22022-11-16 13:10:41 -05001270- CFG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00001271 List of legal baudrate settings for this board.
1272
Tom Rini65cc0e22022-11-16 13:10:41 -05001273- CFG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07001274 Only implemented for ARMv8 for now.
Tom Rini65cc0e22022-11-16 13:10:41 -05001275 If defined, the size of CFG_SYS_MEM_RESERVE_SECURE memory
York Sune8149522015-12-04 11:57:07 -08001276 is substracted from total RAM and won't be reported to OS.
1277 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07001278 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08001279 the RAM base is not zero, or RAM is divided into banks,
1280 this variable needs to be recalcuated to get the address.
1281
Tom Riniaa6e94d2022-11-16 13:10:37 -05001282- CFG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00001283 Physical start address of SDRAM. _Must_ be 0 here.
1284
Tom Rini65cc0e22022-11-16 13:10:41 -05001285- CFG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00001286 Physical start address of Flash memory.
1287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001288- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00001289 Size of DRAM reserved for malloc() use.
1290
Simon Glassd59476b2014-07-10 22:23:28 -06001291- CONFIG_SYS_MALLOC_F_LEN
1292 Size of the malloc() pool for use before relocation. If
1293 this is defined, then a very simple malloc() implementation
1294 will become available before relocation. The address is just
1295 below the global data, and the stack is moved down to make
1296 space.
1297
1298 This feature allocates regions with increasing addresses
1299 within the region. calloc() is supported, but realloc()
1300 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001301 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06001302 U-Boot relocates itself.
1303
Simon Glass38687ae2014-11-10 17:16:54 -07001304- CONFIG_SYS_MALLOC_SIMPLE
1305 Provides a simple and small malloc() and calloc() for those
1306 boards which do not use the full malloc in SPL (which is
Tom Rini10f6e4d2022-05-27 12:48:32 -04001307 enabled with CONFIG_SYS_SPL_MALLOC).
Simon Glass38687ae2014-11-10 17:16:54 -07001308
Tom Rini65cc0e22022-11-16 13:10:41 -05001309- CFG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00001310 Maximum size of memory mapped by the startup code of
1311 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02001312 the Linux kernel (bd_info, boot arguments, FDT blob if
1313 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04001314 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02001315 all data for the Linux kernel must be between "bootm_low"
Tom Rini65cc0e22022-11-16 13:10:41 -05001316 and "bootm_low" + CFG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00001317 variable "bootm_mapsize" will override the value of
Tom Rini65cc0e22022-11-16 13:10:41 -05001318 CFG_SYS_BOOTMAPSZ. If CFG_SYS_BOOTMAPSZ is undefined,
Grant Likelyc3624e62011-03-28 09:58:43 +00001319 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00001320
John Rigbyfca43cc2010-10-13 13:57:35 -06001321- CONFIG_SYS_BOOT_GET_CMDLINE:
1322 Enables allocating and saving kernel cmdline in space between
1323 "bootm_low" and "bootm_low" + BOOTMAPSZ.
1324
1325- CONFIG_SYS_BOOT_GET_KBD:
1326 Enables allocating and saving a kernel copy of the bd_info in
1327 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
1328
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001329- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00001330 If defined, hardware flash sectors protection is used
1331 instead of U-Boot software protection.
1332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001333- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001334 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001335 common flash structure for storing flash geometry.
1336
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02001337- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00001338 This option also enables the building of the cfi_flash driver
1339 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001340
Piotr Ziecik91809ed2008-11-17 15:57:58 +01001341- CONFIG_FLASH_CFI_MTD
1342 This option enables the building of the cfi_mtd driver
1343 in the drivers directory. The driver exports CFI flash
1344 to the MTD layer.
1345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001346- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02001347 Use buffered writes to flash.
1348
Joe Hershberger25980902012-12-11 22:16:31 -06001349- CONFIG_ENV_FLAGS_LIST_DEFAULT
Tom Riniacf29d82022-12-04 10:03:40 -05001350- CFG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04001351 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06001352 calling env set. Variables can be restricted to only decimal,
1353 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
1354 the variables can also be restricted to IP address or MAC address.
1355
1356 The format of the list is:
1357 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001358 access_attribute = [a|r|o|c]
1359 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06001360 entry = variable_name[:attributes]
1361 list = entry[,list]
1362
1363 The type attributes are:
1364 s - String (default)
1365 d - Decimal
1366 x - Hexadecimal
1367 b - Boolean ([1yYtT|0nNfF])
1368 i - IP address
1369 m - MAC address
1370
Joe Hershberger267541f2012-12-11 22:16:34 -06001371 The access attributes are:
1372 a - Any (default)
1373 r - Read-only
1374 o - Write-once
1375 c - Change-default
1376
Joe Hershberger25980902012-12-11 22:16:31 -06001377 - CONFIG_ENV_FLAGS_LIST_DEFAULT
1378 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001379 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06001380
Tom Riniacf29d82022-12-04 10:03:40 -05001381 - CFG_ENV_FLAGS_LIST_STATIC
Joe Hershberger25980902012-12-11 22:16:31 -06001382 Define this to a list (string) to define validation that
1383 should be done if an entry is not found in the ".flags"
1384 environment variable. To override a setting in the static
1385 list, simply add an entry for the same variable name to the
1386 ".flags" variable.
1387
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05001388 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
1389 regular expression. This allows multiple variables to define the same
1390 flags without explicitly listing them for each variable.
1391
wdenkc6097192002-11-03 00:24:07 +00001392The following definitions that deal with the placement and management
1393of environment data (variable area); in general, we support the
1394following configurations:
1395
wdenkc6097192002-11-03 00:24:07 +00001396BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001397in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001398console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00001399U-Boot will hang.
1400
1401Please note that even with NVRAM we still use a copy of the
1402environment in RAM: we could work on NVRAM directly, but we want to
1403keep settings there always unmodified except somebody uses "saveenv"
1404to save the current settings.
1405
Liu Gang0a85a9e2012-03-08 00:33:20 +00001406BE CAREFUL! For some special cases, the local device can not use
1407"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00001408environment stored in a remote NOR flash by SRIO or PCIE link,
1409but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00001410
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02001411- CONFIG_NAND_ENV_DST
1412
1413 Defines address in RAM to which the nand_spl code should copy the
1414 environment. If redundant environment is used, it will be copied to
1415 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
1416
Bruce Adlere881cb52007-11-02 13:15:42 -07001417Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00001418has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06001419created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00001420until then to read environment variables.
1421
wdenk85ec0bc2003-03-31 16:34:49 +00001422The environment is protected by a CRC32 checksum. Before the monitor
1423is relocated into RAM, as a result of a bad CRC you will be working
1424with the compiled-in default environment - *silently*!!! [This is
1425necessary, because the first environment variable we need is the
1426"baudrate" setting for the console - if we have a bad CRC, we don't
1427have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001428
1429Note: once the monitor has been relocated, then it will complain if
1430the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001431use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001432
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001433- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001434 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001435
Simon Glassb2b92f52012-11-30 13:01:18 +00001436- CONFIG_DISPLAY_BOARDINFO
1437 Display information about the board that U-Boot is running on
1438 when U-Boot starts up. The board function checkboard() is called
1439 to do this.
1440
Simon Glasse2e3e2b2012-11-30 13:01:19 +00001441- CONFIG_DISPLAY_BOARDINFO_LATE
1442 Similar to the previous option, but display this information
1443 later, once stdio is running and output goes to the LCD, if
1444 present.
1445
wdenkc6097192002-11-03 00:24:07 +00001446Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001447---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001449- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00001450 Cache Line Size of the CPU.
1451
Timur Tabie46fedf2011-08-04 18:03:41 -05001452- CONFIG_SYS_CCSRBAR_DEFAULT:
1453 Default (power-on reset) physical address of CCSR on Freescale
1454 PowerPC SOCs.
1455
Tom Rini65cc0e22022-11-16 13:10:41 -05001456- CFG_SYS_CCSRBAR:
Timur Tabie46fedf2011-08-04 18:03:41 -05001457 Virtual address of CCSR. On a 32-bit build, this is typically
1458 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
1459
Tom Rini65cc0e22022-11-16 13:10:41 -05001460- CFG_SYS_CCSRBAR_PHYS:
Timur Tabie46fedf2011-08-04 18:03:41 -05001461 Physical address of CCSR. CCSR can be relocated to a new
1462 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001463 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05001464 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
1465 is typically relocated on 36-bit builds. It is recommended
1466 that this macro be defined via the _HIGH and _LOW macros:
1467
Tom Rini65cc0e22022-11-16 13:10:41 -05001468 #define CFG_SYS_CCSRBAR_PHYS ((CFG_SYS_CCSRBAR_PHYS_HIGH
1469 * 1ull) << 32 | CFG_SYS_CCSRBAR_PHYS_LOW)
Timur Tabie46fedf2011-08-04 18:03:41 -05001470
Tom Rini65cc0e22022-11-16 13:10:41 -05001471- CFG_SYS_CCSRBAR_PHYS_HIGH:
1472 Bits 33-36 of CFG_SYS_CCSRBAR_PHYS. This value is typically
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001473 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05001474 used in assembly code, so it must not contain typecasts or
1475 integer size suffixes (e.g. "ULL").
1476
Tom Rini65cc0e22022-11-16 13:10:41 -05001477- CFG_SYS_CCSRBAR_PHYS_LOW:
1478 Lower 32-bits of CFG_SYS_CCSRBAR_PHYS. This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05001479 used in assembly code, so it must not contain typecasts or
1480 integer size suffixes (e.g. "ULL").
1481
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001482- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00001483 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02001484 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00001485
Tom Rini65cc0e22022-11-16 13:10:41 -05001486- CFG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00001487
wdenk7152b1d2003-09-05 23:19:14 +00001488 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00001489 initial data and stack; please note that this must be
1490 writable memory that is working WITHOUT special
1491 initialization, i. e. you CANNOT use normal RAM which
1492 will become available only after programming the
1493 memory controller and running certain initialization
1494 sequences.
1495
1496 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02001497 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00001498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001499- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00001500
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001501- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00001502 SDRAM timing
1503
Kumar Galaa09b9b62010-12-30 12:09:53 -06001504- CONFIG_SYS_SRIOn_MEM_VIRT:
1505 Virtual Address of SRIO port 'n' memory region
1506
Simon Glass62f9b652019-11-14 12:57:09 -07001507- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Galaa09b9b62010-12-30 12:09:53 -06001508 Physical Address of SRIO port 'n' memory region
1509
1510- CONFIG_SYS_SRIOn_MEM_SIZE:
1511 Size of SRIO port 'n' memory region
1512
Fabio Estevam66bd1842013-04-11 09:35:34 +00001513- CONFIG_SYS_NAND_BUSWIDTH_16BIT
1514 Defined to tell the NAND controller that the NAND chip is using
1515 a 16 bit bus.
1516 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00001517 Example of drivers that use it:
Miquel Raynala430fa02018-08-16 17:30:07 +02001518 - drivers/mtd/nand/raw/ndfc.c
1519 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04001520
1521- CONFIG_SYS_NDFC_EBC0_CFG
1522 Sets the EBC0_CFG register for the NDFC. If not defined
1523 a default value will be used.
1524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001525- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01001526 If SPD EEPROM is on an I2C bus other than the first
1527 one, specify here. Note that the value must resolve
1528 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001529
York Sun6f5e1dc2011-09-16 13:21:35 -07001530- CONFIG_FSL_DDR_INTERACTIVE
1531 Enable interactive DDR debugging. See doc/README.fsl-ddr.
1532
York Sune32d59a2015-01-06 13:18:55 -08001533- CONFIG_FSL_DDR_SYNC_REFRESH
1534 Enable sync of refresh for multiple controllers.
1535
York Sun4516ff82015-03-19 09:30:28 -07001536- CONFIG_FSL_DDR_BIST
1537 Enable built-in memory test for Freescale DDR controllers.
1538
wdenkc26e4542004-04-18 10:13:26 +00001539- CONFIG_RMII
1540 Enable RMII mode for all FECs.
1541 Note that this is a global option, we can't
1542 have one FEC in standard MII mode and another in RMII mode.
1543
wdenk5cf91d62004-04-23 20:32:05 +00001544- CONFIG_CRC32_VERIFY
1545 Add a verify option to the crc32 command.
1546 The syntax is:
1547
1548 => crc32 -v <address> <count> <crc32>
1549
1550 Where address/count indicate a memory area
1551 and crc32 is the correct crc32 which the
1552 area should have.
1553
wdenk56523f12004-07-11 17:40:54 +00001554- CONFIG_LOOPW
1555 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06001556 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00001557
Joel Johnson72732312020-01-29 09:17:18 -07001558- CONFIG_CMD_MX_CYCLIC
stroese7b466642004-12-16 18:46:55 +00001559 Add the "mdc" and "mwc" memory commands. These are cyclic
1560 "md/mw" commands.
1561 Examples:
1562
wdenkefe2a4d2004-12-16 21:44:03 +00001563 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00001564 This command will print 4 bytes (10,11,12,13) each 500 ms.
1565
wdenkefe2a4d2004-12-16 21:44:03 +00001566 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00001567 This command will write 12345678 to address 100 all 10 ms.
1568
wdenkefe2a4d2004-12-16 21:44:03 +00001569 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06001570 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00001571
Aneesh V401bb302011-07-13 05:11:07 +00001572- CONFIG_SPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08001573 Set when the currently-running compilation is for an artifact
1574 that will end up in the SPL (as opposed to the TPL or U-Boot
1575 proper). Code that needs stage-specific behavior should check
1576 this.
wdenk400558b2005-04-02 23:52:25 +00001577
Ying Zhang3aa29de2013-08-16 15:16:15 +08001578- CONFIG_TPL_BUILD
Thomas Hebb32f2ca22019-11-13 18:18:03 -08001579 Set when the currently-running compilation is for an artifact
1580 that will end up in the TPL (as opposed to the SPL or U-Boot
1581 proper). Code that needs stage-specific behavior should check
1582 this.
Ying Zhang3aa29de2013-08-16 15:16:15 +08001583
Simon Glass4213fc22013-02-24 17:33:14 +00001584- CONFIG_ARCH_MAP_SYSMEM
1585 Generally U-Boot (and in particular the md command) uses
1586 effective address. It is therefore not necessary to regard
1587 U-Boot address as virtual addresses that need to be translated
1588 to physical addresses. However, sandbox requires this, since
1589 it maintains its own little RAM buffer which contains all
1590 addressable memory. This option causes some memory accesses
1591 to be mapped through map_sysmem() / unmap_sysmem().
1592
Simon Glass588a13f2013-02-14 04:18:54 +00001593- CONFIG_X86_RESET_VECTOR
1594 If defined, the x86 reset vector code is included. This is not
1595 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00001596
Timur Tabif2717b42011-11-22 09:21:25 -06001597Freescale QE/FMAN Firmware Support:
1598-----------------------------------
1599
1600The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
1601loading of "firmware", which is encoded in the QE firmware binary format.
1602This firmware often needs to be loaded during U-Boot booting, so macros
1603are used to identify the storage device (NOR flash, SPI, etc) and the address
1604within that device.
1605
Zhao Qiangdcf1d772014-03-21 16:21:44 +08001606- CONFIG_SYS_FMAN_FW_ADDR
1607 The address in the storage device where the FMAN microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04001608 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiangdcf1d772014-03-21 16:21:44 +08001609 is also specified.
1610
1611- CONFIG_SYS_QE_FW_ADDR
1612 The address in the storage device where the QE microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04001613 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabif2717b42011-11-22 09:21:25 -06001614 is also specified.
1615
1616- CONFIG_SYS_QE_FMAN_FW_LENGTH
1617 The maximum possible size of the firmware. The firmware binary format
1618 has a field that specifies the actual size of the firmware, but it
1619 might not be possible to read any part of the firmware unless some
1620 local storage is allocated to hold the entire firmware first.
1621
1622- CONFIG_SYS_QE_FMAN_FW_IN_NOR
1623 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
1624 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
1625 virtual address in NOR flash.
1626
1627- CONFIG_SYS_QE_FMAN_FW_IN_NAND
1628 Specifies that QE/FMAN firmware is located in NAND flash.
1629 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
1630
1631- CONFIG_SYS_QE_FMAN_FW_IN_MMC
1632 Specifies that QE/FMAN firmware is located on the primary SD/MMC
1633 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
1634
Liu Gang292dc6c2012-03-08 00:33:18 +00001635- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
1636 Specifies that QE/FMAN firmware is located in the remote (master)
1637 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00001638 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
1639 window->master inbound window->master LAW->the ucode address in
1640 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06001641
J. German Riverab940ca62014-06-23 15:15:55 -07001642Freescale Layerscape Management Complex Firmware Support:
1643---------------------------------------------------------
1644The Freescale Layerscape Management Complex (MC) supports the loading of
1645"firmware".
1646This firmware often needs to be loaded during U-Boot booting, so macros
1647are used to identify the storage device (NOR flash, SPI, etc) and the address
1648within that device.
1649
1650- CONFIG_FSL_MC_ENET
1651 Enable the MC driver for Layerscape SoCs.
1652
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05301653Freescale Layerscape Debug Server Support:
1654-------------------------------------------
1655The Freescale Layerscape Debug Server Support supports the loading of
1656"Debug Server firmware" and triggering SP boot-rom.
1657This firmware often needs to be loaded during U-Boot booting.
1658
York Sunc0492142015-12-07 11:08:58 -08001659- CONFIG_SYS_MC_RSV_MEM_ALIGN
1660 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05301661
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02001662
wdenkc6097192002-11-03 00:24:07 +00001663Building the Software:
1664======================
1665
Wolfgang Denk218ca722008-03-26 10:40:12 +01001666Building U-Boot has been tested in several native build environments
1667and in many different cross environments. Of course we cannot support
1668all possibly existing versions of cross development tools in all
1669(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayama047f6ec2020-10-08 13:17:16 +09001670recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denk218ca722008-03-26 10:40:12 +01001671which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00001672
Wolfgang Denk218ca722008-03-26 10:40:12 +01001673If you are not using a native environment, it is assumed that you
1674have GNU cross compiling tools available in your path. In this case,
1675you must set the environment variable CROSS_COMPILE in your shell.
1676Note that no changes to the Makefile or any other source files are
1677necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00001678
Wolfgang Denk218ca722008-03-26 10:40:12 +01001679 $ CROSS_COMPILE=ppc_4xx-
1680 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00001681
Wolfgang Denk218ca722008-03-26 10:40:12 +01001682U-Boot is intended to be simple to build. After installing the
1683sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00001684is done by typing:
1685
Holger Freytherab584d62014-08-04 09:26:05 +02001686 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00001687
Holger Freytherab584d62014-08-04 09:26:05 +02001688where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01001689rations; see configs/*_defconfig for supported names.
wdenk54387ac2003-10-08 22:45:44 +00001690
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01001691Note: for some boards special configuration names may exist; check if
wdenk2729af92004-05-03 20:45:30 +00001692 additional information is available from the board vendor; for
1693 instance, the TQM823L systems are available without (standard)
1694 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001695 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00001696
Holger Freytherab584d62014-08-04 09:26:05 +02001697 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00001698 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00001699
Holger Freytherab584d62014-08-04 09:26:05 +02001700 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00001701 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00001702
wdenk2729af92004-05-03 20:45:30 +00001703 etc.
wdenkc6097192002-11-03 00:24:07 +00001704
wdenkc6097192002-11-03 00:24:07 +00001705
wdenk2729af92004-05-03 20:45:30 +00001706Finally, type "make all", and you should get some working U-Boot
1707images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00001708
wdenk2729af92004-05-03 20:45:30 +00001709- "u-boot.bin" is a raw binary image
1710- "u-boot" is an image in ELF binary format
1711- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00001712
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001713By default the build is performed locally and the objects are saved
1714in the source directory. One of the two methods can be used to change
1715this behavior and build U-Boot to some external directory:
1716
17171. Add O= to the make command line invocations:
1718
1719 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02001720 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001721 make O=/tmp/build all
1722
Timo Ketolaadbba992014-11-06 14:39:05 +020017232. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001724
Timo Ketolaadbba992014-11-06 14:39:05 +02001725 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001726 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02001727 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001728 make all
1729
Timo Ketolaadbba992014-11-06 14:39:05 +02001730Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001731variable.
1732
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01001733User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
1734setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
1735For example to treat all compiler warnings as errors:
1736
1737 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00001738
wdenk2729af92004-05-03 20:45:30 +00001739Please be aware that the Makefiles assume you are using GNU make, so
1740for instance on NetBSD you might need to use "gmake" instead of
1741native "make".
wdenkc6097192002-11-03 00:24:07 +00001742
wdenkc6097192002-11-03 00:24:07 +00001743
wdenk2729af92004-05-03 20:45:30 +00001744If the system board that you have is not listed, then you will need
1745to port U-Boot to your hardware platform. To do this, follow these
1746steps:
wdenkc6097192002-11-03 00:24:07 +00001747
Phil Sutter3c1496c2015-12-25 14:41:18 +010017481. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00001749 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01001750 the "Makefile" and a "<board>.c".
17512. Create a new configuration file "include/configs/<board>.h" for
1752 your board.
wdenk2729af92004-05-03 20:45:30 +000017533. If you're porting U-Boot to a new CPU, then also create a new
1754 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020017554. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000017565. Type "make", and you should get a working "u-boot.srec" file
1757 to be installed on your target system.
17586. Debug and solve any problems that might arise.
1759 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00001760
wdenkc6097192002-11-03 00:24:07 +00001761
wdenk2729af92004-05-03 20:45:30 +00001762Testing of U-Boot Modifications, Ports to New Hardware, etc.:
1763==============================================================
wdenkc6097192002-11-03 00:24:07 +00001764
Wolfgang Denk218ca722008-03-26 10:40:12 +01001765If you have modified U-Boot sources (for instance added a new board
1766or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00001767provide feedback to the other developers. The feedback normally takes
Thomas Hebb32f2ca22019-11-13 18:18:03 -08001768the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01001769official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00001770
Wolfgang Denk218ca722008-03-26 10:40:12 +01001771But before you submit such a patch, please verify that your modifi-
1772cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00001773the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06001774just run the buildman script (tools/buildman/buildman), which will
1775configure and build U-Boot for ALL supported system. Be warned, this
1776will take a while. Please see the buildman README, or run 'buildman -H'
1777for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001778
1779
wdenk2729af92004-05-03 20:45:30 +00001780See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00001781
wdenkc6097192002-11-03 00:24:07 +00001782
wdenk2729af92004-05-03 20:45:30 +00001783Monitor Commands - Overview:
1784============================
wdenkc6097192002-11-03 00:24:07 +00001785
wdenk2729af92004-05-03 20:45:30 +00001786go - start application at address 'addr'
1787run - run commands in an environment variable
1788bootm - boot application image from memory
1789bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00001790bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00001791tftpboot- boot image via network using TFTP protocol
1792 and env variables "ipaddr" and "serverip"
1793 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00001794tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00001795rarpboot- boot image via network using RARP/TFTP protocol
1796diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
1797loads - load S-Record file over serial line
1798loadb - load binary file over serial line (kermit mode)
Rui Miguel Silvabfef72e2022-05-11 10:55:40 +01001799loadm - load binary blob from source address to destination address
wdenk2729af92004-05-03 20:45:30 +00001800md - memory display
1801mm - memory modify (auto-incrementing)
1802nm - memory modify (constant address)
1803mw - memory write (fill)
Simon Glassbdded202020-06-02 19:26:49 -06001804ms - memory search
wdenk2729af92004-05-03 20:45:30 +00001805cp - memory copy
1806cmp - memory compare
1807crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05001808i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00001809sspi - SPI utility commands
1810base - print or set address offset
1811printenv- print environment variables
Pragnesh Patel9e9a5302020-12-22 11:30:05 +05301812pwm - control pwm channels
wdenk2729af92004-05-03 20:45:30 +00001813setenv - set environment variables
1814saveenv - save environment variables to persistent storage
1815protect - enable or disable FLASH write protection
1816erase - erase FLASH memory
1817flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00001818nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00001819bdinfo - print Board Info structure
1820iminfo - print header information for application image
1821coninfo - print console devices and informations
1822ide - IDE sub-system
1823loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00001824loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00001825mtest - simple RAM test
1826icache - enable or disable instruction cache
1827dcache - enable or disable data cache
1828reset - Perform RESET of the CPU
1829echo - echo args to console
1830version - print monitor version
1831help - print online help
1832? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00001833
wdenkc6097192002-11-03 00:24:07 +00001834
wdenk2729af92004-05-03 20:45:30 +00001835Monitor Commands - Detailed Description:
1836========================================
wdenkc6097192002-11-03 00:24:07 +00001837
wdenk2729af92004-05-03 20:45:30 +00001838TODO.
wdenkc6097192002-11-03 00:24:07 +00001839
wdenk2729af92004-05-03 20:45:30 +00001840For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00001841
1842
wdenk2729af92004-05-03 20:45:30 +00001843Note for Redundant Ethernet Interfaces:
1844=======================================
wdenkf07771c2003-05-28 08:06:31 +00001845
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001846Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00001847such configurations and is capable of automatic selection of a
1848"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00001849
wdenk2729af92004-05-03 20:45:30 +00001850Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
1851MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
1852"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00001853
wdenk2729af92004-05-03 20:45:30 +00001854If the network interface stores some valid MAC address (for instance
1855in SROM), this is used as default address if there is NO correspon-
1856ding setting in the environment; if the corresponding environment
1857variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00001858
wdenk2729af92004-05-03 20:45:30 +00001859o If the SROM has a valid MAC address, and there is no address in the
1860 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00001861
wdenk2729af92004-05-03 20:45:30 +00001862o If there is no valid address in the SROM, and a definition in the
1863 environment exists, then the value from the environment variable is
1864 used.
wdenkc6097192002-11-03 00:24:07 +00001865
wdenk2729af92004-05-03 20:45:30 +00001866o If both the SROM and the environment contain a MAC address, and
1867 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00001868
wdenk2729af92004-05-03 20:45:30 +00001869o If both the SROM and the environment contain a MAC address, and the
1870 addresses differ, the value from the environment is used and a
1871 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00001872
wdenk2729af92004-05-03 20:45:30 +00001873o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05001874 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
1875 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00001876
Ben Warrenecee9322010-04-26 11:11:46 -07001877If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001878will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07001879may be skipped by setting the appropriate 'ethmacskip' environment variable.
1880The naming convention is as follows:
1881"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00001882
wdenk2729af92004-05-03 20:45:30 +00001883Image Formats:
1884==============
wdenkc6097192002-11-03 00:24:07 +00001885
Marian Balakowicz3310c542008-03-12 12:13:13 +01001886U-Boot is capable of booting (and performing other auxiliary operations on)
1887images in two formats:
1888
1889New uImage format (FIT)
1890-----------------------
1891
1892Flexible and powerful format based on Flattened Image Tree -- FIT (similar
1893to Flattened Device Tree). It allows the use of images with multiple
1894components (several kernels, ramdisks, etc.), with contents protected by
1895SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
1896
1897
1898Old uImage format
1899-----------------
1900
1901Old image format is based on binary files which can be basically anything,
1902preceded by a special header; see the definitions in include/image.h for
1903details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00001904
wdenk2729af92004-05-03 20:45:30 +00001905* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
1906 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05001907 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
Thomas Huth0797e732021-11-13 18:13:50 +01001908 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03001909* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Tom Rini11232132022-04-06 09:21:25 -04001910 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
1911 Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00001912* Compression Type (uncompressed, gzip, bzip2)
1913* Load Address
1914* Entry Point
1915* Image Name
1916* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00001917
wdenk2729af92004-05-03 20:45:30 +00001918The header is marked by a special Magic Number, and both the header
1919and the data portions of the image are secured against corruption by
1920CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00001921
wdenkc6097192002-11-03 00:24:07 +00001922
wdenk2729af92004-05-03 20:45:30 +00001923Linux Support:
1924==============
wdenkc6097192002-11-03 00:24:07 +00001925
wdenk2729af92004-05-03 20:45:30 +00001926Although U-Boot should support any OS or standalone application
1927easily, the main focus has always been on Linux during the design of
1928U-Boot.
wdenkc6097192002-11-03 00:24:07 +00001929
wdenk2729af92004-05-03 20:45:30 +00001930U-Boot includes many features that so far have been part of some
1931special "boot loader" code within the Linux kernel. Also, any
1932"initrd" images to be used are no longer part of one big Linux image;
1933instead, kernel and "initrd" are separate images. This implementation
1934serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00001935
wdenk2729af92004-05-03 20:45:30 +00001936- the same features can be used for other OS or standalone
1937 applications (for instance: using compressed images to reduce the
1938 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00001939
wdenk2729af92004-05-03 20:45:30 +00001940- it becomes much easier to port new Linux kernel versions because
1941 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00001942
wdenk2729af92004-05-03 20:45:30 +00001943- the same Linux kernel image can now be used with different "initrd"
1944 images; of course this also means that different kernel images can
1945 be run with the same "initrd". This makes testing easier (you don't
1946 have to build a new "zImage.initrd" Linux image when you just
1947 change a file in your "initrd"). Also, a field-upgrade of the
1948 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00001949
wdenkc6097192002-11-03 00:24:07 +00001950
wdenk2729af92004-05-03 20:45:30 +00001951Linux HOWTO:
1952============
wdenkc6097192002-11-03 00:24:07 +00001953
wdenk2729af92004-05-03 20:45:30 +00001954Porting Linux to U-Boot based systems:
1955---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001956
wdenk2729af92004-05-03 20:45:30 +00001957U-Boot cannot save you from doing all the necessary modifications to
1958configure the Linux device drivers for use with your target hardware
1959(no, we don't intend to provide a full virtual machine interface to
1960Linux :-).
wdenkc6097192002-11-03 00:24:07 +00001961
Stefan Roesea47a12b2010-04-15 16:07:28 +02001962But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00001963
wdenk2729af92004-05-03 20:45:30 +00001964Just make sure your machine specific header file (for instance
1965include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02001966Information structure as we define in include/asm-<arch>/u-boot.h,
1967and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001968as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00001969
Simon Glass2eb31b12014-06-11 23:29:46 -06001970Note that U-Boot now has a driver model, a unified model for drivers.
1971If you are adding a new driver, plumb it into driver model. If there
1972is no uclass available, you are encouraged to create one. See
1973doc/driver-model.
1974
wdenkc6097192002-11-03 00:24:07 +00001975
wdenk2729af92004-05-03 20:45:30 +00001976Configuring the Linux kernel:
1977-----------------------------
wdenkc6097192002-11-03 00:24:07 +00001978
wdenk2729af92004-05-03 20:45:30 +00001979No specific requirements for U-Boot. Make sure you have some root
1980device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00001981
wdenkc6097192002-11-03 00:24:07 +00001982
wdenk2729af92004-05-03 20:45:30 +00001983Building a Linux Image:
1984-----------------------
wdenkc6097192002-11-03 00:24:07 +00001985
wdenk2729af92004-05-03 20:45:30 +00001986With U-Boot, "normal" build targets like "zImage" or "bzImage" are
1987not used. If you use recent kernel source, a new build target
1988"uImage" will exist which automatically builds an image usable by
1989U-Boot. Most older kernels also have support for a "pImage" target,
1990which was introduced for our predecessor project PPCBoot and uses a
1991100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00001992
wdenk2729af92004-05-03 20:45:30 +00001993Example:
wdenkc6097192002-11-03 00:24:07 +00001994
Holger Freytherab584d62014-08-04 09:26:05 +02001995 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00001996 make oldconfig
1997 make dep
1998 make uImage
wdenkc6097192002-11-03 00:24:07 +00001999
wdenk2729af92004-05-03 20:45:30 +00002000The "uImage" build target uses a special tool (in 'tools/mkimage') to
2001encapsulate a compressed Linux kernel image with header information,
2002CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002003
wdenk2729af92004-05-03 20:45:30 +00002004* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002005
wdenk2729af92004-05-03 20:45:30 +00002006* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002007
wdenk2729af92004-05-03 20:45:30 +00002008 ${CROSS_COMPILE}-objcopy -O binary \
2009 -R .note -R .comment \
2010 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002011
wdenk2729af92004-05-03 20:45:30 +00002012* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002013
wdenk2729af92004-05-03 20:45:30 +00002014 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002015
wdenk2729af92004-05-03 20:45:30 +00002016* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002017
wdenk2729af92004-05-03 20:45:30 +00002018 mkimage -A ppc -O linux -T kernel -C gzip \
2019 -a 0 -e 0 -n "Linux Kernel Image" \
2020 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002021
wdenk24ee89b2002-11-03 17:56:27 +00002022
wdenk2729af92004-05-03 20:45:30 +00002023The "mkimage" tool can also be used to create ramdisk images for use
2024with U-Boot, either separated from the Linux kernel image, or
2025combined into one file. "mkimage" encapsulates the images with a 64
2026byte header containing information about target architecture,
2027operating system, image type, compression method, entry points, time
2028stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002029
wdenk2729af92004-05-03 20:45:30 +00002030"mkimage" can be called in two ways: to verify existing images and
2031print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002032
wdenk2729af92004-05-03 20:45:30 +00002033In the first form (with "-l" option) mkimage lists the information
2034contained in the header of an existing U-Boot image; this includes
2035checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002036
wdenk2729af92004-05-03 20:45:30 +00002037 tools/mkimage -l image
2038 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002039
wdenk2729af92004-05-03 20:45:30 +00002040The second form (with "-d" option) is used to build a U-Boot image
2041from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002042
wdenk2729af92004-05-03 20:45:30 +00002043 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2044 -n name -d data_file image
2045 -A ==> set architecture to 'arch'
2046 -O ==> set operating system to 'os'
2047 -T ==> set image type to 'type'
2048 -C ==> set compression type 'comp'
2049 -a ==> set load address to 'addr' (hex)
2050 -e ==> set entry point to 'ep' (hex)
2051 -n ==> set image name to 'name'
2052 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002053
wdenk69459792004-05-29 16:53:29 +00002054Right now, all Linux kernels for PowerPC systems use the same load
2055address (0x00000000), but the entry point address depends on the
2056kernel version:
wdenkc6097192002-11-03 00:24:07 +00002057
wdenk2729af92004-05-03 20:45:30 +00002058- 2.2.x kernels have the entry point at 0x0000000C,
2059- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002060
wdenk2729af92004-05-03 20:45:30 +00002061So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002062
wdenk2729af92004-05-03 20:45:30 +00002063 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2064 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02002065 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00002066 > examples/uImage.TQM850L
2067 Image Name: 2.4.4 kernel for TQM850L
2068 Created: Wed Jul 19 02:34:59 2000
2069 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2070 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2071 Load Address: 0x00000000
2072 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002073
wdenk2729af92004-05-03 20:45:30 +00002074To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002075
wdenk2729af92004-05-03 20:45:30 +00002076 -> tools/mkimage -l examples/uImage.TQM850L
2077 Image Name: 2.4.4 kernel for TQM850L
2078 Created: Wed Jul 19 02:34:59 2000
2079 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2080 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2081 Load Address: 0x00000000
2082 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002083
wdenk2729af92004-05-03 20:45:30 +00002084NOTE: for embedded systems where boot time is critical you can trade
2085speed for memory and install an UNCOMPRESSED image instead: this
2086needs more space in Flash, but boots much faster since it does not
2087need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002088
Stefan Roesea47a12b2010-04-15 16:07:28 +02002089 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00002090 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2091 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02002092 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00002093 > examples/uImage.TQM850L-uncompressed
2094 Image Name: 2.4.4 kernel for TQM850L
2095 Created: Wed Jul 19 02:34:59 2000
2096 Image Type: PowerPC Linux Kernel Image (uncompressed)
2097 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2098 Load Address: 0x00000000
2099 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002100
wdenkc6097192002-11-03 00:24:07 +00002101
wdenk2729af92004-05-03 20:45:30 +00002102Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2103when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002104
wdenk2729af92004-05-03 20:45:30 +00002105 -> tools/mkimage -n 'Simple Ramdisk Image' \
2106 > -A ppc -O linux -T ramdisk -C gzip \
2107 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2108 Image Name: Simple Ramdisk Image
2109 Created: Wed Jan 12 14:01:50 2000
2110 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2111 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2112 Load Address: 0x00000000
2113 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002114
Tyler Hickse157a112020-10-26 10:40:24 -05002115The "dumpimage" tool can be used to disassemble or list the contents of images
2116built by mkimage. See dumpimage's help output (-h) for details.
wdenkdb01a2e2004-04-15 23:14:49 +00002117
wdenk2729af92004-05-03 20:45:30 +00002118Installing a Linux Image:
2119-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002120
wdenk2729af92004-05-03 20:45:30 +00002121To downloading a U-Boot image over the serial (console) interface,
2122you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002123
wdenk2729af92004-05-03 20:45:30 +00002124 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002125
wdenk2729af92004-05-03 20:45:30 +00002126The 'objcopy' does not understand the information in the U-Boot
2127image header, so the resulting S-Record file will be relative to
2128address 0x00000000. To load it to a given address, you need to
2129specify the target address as 'offset' parameter with the 'loads'
2130command.
wdenkc6097192002-11-03 00:24:07 +00002131
wdenk2729af92004-05-03 20:45:30 +00002132Example: install the image to address 0x40100000 (which on the
2133TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002134
wdenk2729af92004-05-03 20:45:30 +00002135 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002136
wdenk2729af92004-05-03 20:45:30 +00002137 .......... done
2138 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002139
wdenk2729af92004-05-03 20:45:30 +00002140 => loads 40100000
2141 ## Ready for S-Record download ...
2142 ~>examples/image.srec
2143 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2144 ...
2145 15989 15990 15991 15992
2146 [file transfer complete]
2147 [connected]
2148 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002149
2150
wdenk2729af92004-05-03 20:45:30 +00002151You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01002152this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00002153corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002154
wdenk2729af92004-05-03 20:45:30 +00002155 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002156
wdenk2729af92004-05-03 20:45:30 +00002157 ## Checking Image at 40100000 ...
2158 Image Name: 2.2.13 for initrd on TQM850L
2159 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2160 Data Size: 335725 Bytes = 327 kB = 0 MB
2161 Load Address: 00000000
2162 Entry Point: 0000000c
2163 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002164
2165
wdenk2729af92004-05-03 20:45:30 +00002166Boot Linux:
2167-----------
wdenkc6097192002-11-03 00:24:07 +00002168
wdenk2729af92004-05-03 20:45:30 +00002169The "bootm" command is used to boot an application that is stored in
2170memory (RAM or Flash). In case of a Linux kernel image, the contents
2171of the "bootargs" environment variable is passed to the kernel as
2172parameters. You can check and modify this variable using the
2173"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002174
2175
wdenk2729af92004-05-03 20:45:30 +00002176 => printenv bootargs
2177 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002178
wdenk2729af92004-05-03 20:45:30 +00002179 => 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 +00002180
wdenk2729af92004-05-03 20:45:30 +00002181 => printenv bootargs
2182 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 +00002183
wdenk2729af92004-05-03 20:45:30 +00002184 => bootm 40020000
2185 ## Booting Linux kernel at 40020000 ...
2186 Image Name: 2.2.13 for NFS on TQM850L
2187 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2188 Data Size: 381681 Bytes = 372 kB = 0 MB
2189 Load Address: 00000000
2190 Entry Point: 0000000c
2191 Verifying Checksum ... OK
2192 Uncompressing Kernel Image ... OK
2193 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
2194 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2195 time_init: decrementer frequency = 187500000/60
2196 Calibrating delay loop... 49.77 BogoMIPS
2197 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]