blob: b89768f17917f9bfcf79ad9c462346f6835db639 [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
Christian Rieschb67d8812012-02-02 00:44:39 +0000289- ARM options:
Tom Rini65cc0e22022-11-16 13:10:41 -0500290 CFG_SYS_EXCEPTION_VECTORS_HIGH
Christian Rieschb67d8812012-02-02 00:44:39 +0000291
292 Select high exception vectors of the ARM core, e.g., do not
293 clear the V bit of the c1 register of CP15.
294
York Sun207774b2015-03-20 19:28:08 -0700295 COUNTER_FREQUENCY
296 Generic timer clock source frequency.
297
298 COUNTER_FREQUENCY_REAL
299 Generic timer clock source frequency if the real clock is
300 different from COUNTER_FREQUENCY, and can only be determined
301 at run time.
302
wdenk5da627a2003-10-09 20:09:04 +0000303- Linux Kernel Interface:
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400304 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200305
306 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400307 passed using flattened device trees (based on open firmware
308 concepts).
309
310 CONFIG_OF_LIBFDT
311 * New libfdt-based support
312 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500313 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400314
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200315 OF_TBCLK - The timebase frequency.
316
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 boards with QUICC Engines require OF_QE to set UCC MAC
318 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500319
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200320 CONFIG_OF_IDE_FIXUP
321
322 U-Boot can detect if an IDE device is present or not.
323 If not, and this new config option is activated, U-Boot
324 removes the ATA node from the DTS before booting Linux,
325 so the Linux IDE driver does not probe the device and
326 crash. This is needed for buggy hardware (uc101) where
327 no pull down resistor is connected to the signal IDE5V_DD7.
328
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100329- vxWorks boot parameters:
330
331 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700332 environments variables: bootdev, bootfile, ipaddr, netmask,
333 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100334 It loads the vxWorks image pointed bootfile.
335
Naoki Hayama81a05d92020-10-08 13:17:08 +0900336 Note: If a "bootargs" environment is defined, it will override
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100337 the defaults discussed just above.
338
Aneesh V93bc2192011-06-16 23:30:51 +0000339- Cache Configuration for ARM:
Tom Rini65cc0e22022-11-16 13:10:41 -0500340 CFG_SYS_PL310_BASE - Physical base address of PL310
Aneesh V93bc2192011-06-16 23:30:51 +0000341 controller register space
342
wdenk6705d812004-08-02 23:22:59 +0000343- Serial Ports:
Tom Rinif410d0a2022-12-04 10:13:30 -0500344 CFG_PL011_CLOCK
wdenk6705d812004-08-02 23:22:59 +0000345
346 If you have Amba PrimeCell PL011 UARTs, set this variable to
347 the clock speed of the UARTs.
348
Tom Rinib8615742022-12-04 10:13:31 -0500349 CFG_PL01x_PORTS
wdenk6705d812004-08-02 23:22:59 +0000350
351 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
352 define this to a list of base addresses for each (supported)
353 port. See e.g. include/configs/versatile.h
354
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400355 CONFIG_SERIAL_HW_FLOW_CONTROL
356
357 Define this variable to enable hw flow control in serial driver.
358 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000359
Simon Glass302a6482016-03-13 19:07:28 -0600360- Removal of commands
361 If no commands are needed to boot, you can disable
362 CONFIG_CMDLINE to remove them. In this case, the command line
363 will not be available, and when U-Boot wants to execute the
364 boot command (on start-up) it will call board_run_command()
365 instead. This can reduce image size significantly for very
366 simple boot procedures.
367
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000368- Regular expression support:
369 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200370 If this variable is defined, U-Boot is linked against
371 the SLRE (Super Light Regular Expression) library,
372 which adds regex support to some commands, as for
373 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000374
wdenkc6097192002-11-03 00:24:07 +0000375- Watchdog:
Tom Rini6e7df1d2023-01-10 11:19:45 -0500376 CFG_SYS_WATCHDOG_FREQ
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200377 Some platforms automatically call WATCHDOG_RESET()
378 from the timer interrupt handler every
Tom Rini6e7df1d2023-01-10 11:19:45 -0500379 CFG_SYS_WATCHDOG_FREQ interrupts. If not set by the
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200380 board configuration file, a default of CONFIG_SYS_HZ/2
Tom Rini6e7df1d2023-01-10 11:19:45 -0500381 (i.e. 500) is used. Setting CFG_SYS_WATCHDOG_FREQ
Rasmus Villemoes933ada52021-04-14 09:18:22 +0200382 to 0 disables calling WATCHDOG_RESET() from the timer
383 interrupt.
384
Peter Tysere92739d2008-12-17 16:36:21 -0600385- GPIO Support:
Tom Rini65cc0e22022-11-16 13:10:41 -0500386 The CFG_SYS_I2C_PCA953X_WIDTH option specifies a list of
Chris Packham5dec49c2010-12-19 10:12:13 +0000387 chip-ngpio pairs that tell the PCA953X driver the number of
388 pins supported by a particular chip.
389
Peter Tysere92739d2008-12-17 16:36:21 -0600390 Note that if the GPIO device uses I2C, then the I2C interface
391 must also be configured. See I2C Support, below.
392
Simon Glassaa532332014-06-11 23:29:41 -0600393- I/O tracing:
394 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
395 accesses and can checksum them or write a list of them out
396 to memory. See the 'iotrace' command for details. This is
397 useful for testing device drivers since it can confirm that
398 the driver behaves the same way before and after a code
399 change. Currently this is supported on sandbox and arm. To
400 add support for your architecture, add '#include <iotrace.h>'
401 to the bottom of arch/<arch>/include/asm/io.h and test.
402
403 Example output from the 'iotrace stats' command is below.
404 Note that if the trace buffer is exhausted, the checksum will
405 still continue to operate.
406
407 iotrace is enabled
408 Start: 10000000 (buffer start address)
409 Size: 00010000 (buffer size)
410 Offset: 00000120 (current buffer offset)
411 Output: 10000120 (start + offset)
412 Count: 00000018 (number of trace records)
413 CRC32: 9526fb66 (CRC32 of all trace records)
414
wdenkc6097192002-11-03 00:24:07 +0000415- Timestamp Support:
416
wdenk43d96162003-03-06 00:02:04 +0000417 When CONFIG_TIMESTAMP is selected, the timestamp
418 (date and time) of an image is printed by image
419 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500420 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000421
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000422- Partition Labels (disklabels) Supported:
423 Zero or more of the following:
424 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000425 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
426 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
427 bootloader. Note 2TB partition limit; see
428 disk/part_efi.c
Simon Glassc649e3c2016-05-01 11:36:02 -0600429 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000430 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000431
wdenkc6097192002-11-03 00:24:07 +0000432- NETWORK Support (PCI):
Kyle Moffettce5207e2011-10-18 11:05:29 +0000433 CONFIG_E1000_SPI
434 Utility code for direct access to the SPI bus on Intel 8257x.
435 This does not do anything useful unless you set at least one
436 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
437
wdenkc6097192002-11-03 00:24:07 +0000438 CONFIG_NATSEMI
439 Support for National dp83815 chips.
440
441 CONFIG_NS8382X
442 Support for National dp8382[01] gigabit chips.
443
wdenk45219c42003-05-12 21:50:16 +0000444- NETWORK Support (other):
Rob Herringefdd7312011-12-15 11:15:49 +0000445 CONFIG_CALXEDA_XGMAC
446 Support for the Calxeda XGMAC device
447
Ashok3bb46d22012-10-15 06:20:47 +0000448 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000449 Support for SMSC's LAN91C96 chips.
450
wdenk45219c42003-05-12 21:50:16 +0000451 CONFIG_LAN91C96_USE_32_BIT
452 Define this to enable 32 bit addressing
453
Tom Rini6e7df1d2023-01-10 11:19:45 -0500454 CFG_SYS_DAVINCI_EMAC_PHY_COUNT
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500455 Define this if you have more then 3 PHYs.
456
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800457 CONFIG_FTGMAC100
458 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
459
460 CONFIG_FTGMAC100_EGIGA
461 Define this to use GE link update with gigabit PHY.
462 Define this if FTGMAC100 is connected to gigabit PHY.
463 If your system has 10/100 PHY only, it might not occur
464 wrong behavior. Because PHY usually return timeout or
465 useless data when polling gigabit status and gigabit
466 control registers. This behavior won't affect the
467 correctnessof 10/100 link speed update.
468
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900469 CONFIG_SH_ETHER
470 Support for Renesas on-chip Ethernet controller
471
Tom Rini97148cb2022-12-04 10:13:52 -0500472 CFG_SH_ETHER_USE_PORT
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900473 Define the number of ports to be used
474
Tom Rini7c480ba2022-12-04 10:13:50 -0500475 CFG_SH_ETHER_PHY_ADDR
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900476 Define the ETH PHY's address
477
Tom Riniff53ecc2022-12-04 10:13:49 -0500478 CFG_SH_ETHER_CACHE_WRITEBACK
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900479 If this option is set, the driver enables cache flush.
480
Vadim Bendebury5e124722011-10-17 08:36:14 +0000481- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000482 CONFIG_TPM
483 Support TPM devices.
484
Christophe Ricard0766ad22015-10-06 22:54:41 +0200485 CONFIG_TPM_TIS_INFINEON
486 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000487 per system is supported at this time.
488
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +0000489 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
490 Define the burst count bytes upper limit
491
Christophe Ricard3aa74082016-01-21 23:27:13 +0100492 CONFIG_TPM_ST33ZP24
493 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
494
495 CONFIG_TPM_ST33ZP24_I2C
496 Support for STMicroelectronics ST33ZP24 I2C devices.
497 Requires TPM_ST33ZP24 and I2C.
498
Christophe Ricardb75fdc12016-01-21 23:27:14 +0100499 CONFIG_TPM_ST33ZP24_SPI
500 Support for STMicroelectronics ST33ZP24 SPI devices.
501 Requires TPM_ST33ZP24 and SPI.
502
Dirk Eibachc01939c2013-06-26 15:55:15 +0200503 CONFIG_TPM_ATMEL_TWI
504 Support for Atmel TWI TPM device. Requires I2C support.
505
Che-liang Chiou90899cc2013-04-12 11:04:34 +0000506 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +0000507 Support for generic parallel port TPM devices. Only one device
508 per system is supported at this time.
509
Reinhard Pfaube6c1522013-06-26 15:55:13 +0200510 CONFIG_TPM
511 Define this to enable the TPM support library which provides
512 functional interfaces to some TPM commands.
513 Requires support for a TPM device.
514
515 CONFIG_TPM_AUTH_SESSIONS
516 Define this to enable authorized functions in the TPM library.
517 Requires CONFIG_TPM and CONFIG_SHA1.
518
wdenkc6097192002-11-03 00:24:07 +0000519- USB Support:
520 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +0200521 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +0000522 CONFIG_USB_UHCI to enable it.
523 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000524 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000525 storage devices.
526 Note:
527 Supported are USB Keyboards and USB Floppy drives
528 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000529
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -0700530 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
531 HW module registers.
532
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200533- USB Device:
534 Define the below if you wish to use the USB console.
535 Once firmware is rebuilt from a serial console issue the
536 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200537 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200538 it has found a new device. The environment variable usbtty
539 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200540 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200541 Common Device Class Abstract Control Model serial device.
542 If you select usbtty = gserial you should be able to enumerate
543 a Linux host by
544 # modprobe usbserial vendor=0xVendorID product=0xProductID
545 else if using cdc_acm, simply setting the environment
546 variable usbtty to be cdc_acm should suffice. The following
547 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200548
Wolfgang Denk386eda02006-06-14 18:14:56 +0200549 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200550 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200551 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200552 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
553 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
554 should pretend to be a Linux device to it's target host.
555
556 CONFIG_USBD_MANUFACTURER
557 Define this string as the name of your company for
558 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200559
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200560 CONFIG_USBD_PRODUCT_NAME
561 Define this string as the name of your product
562 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
563
564 CONFIG_USBD_VENDORID
565 Define this as your assigned Vendor ID from the USB
566 Implementors Forum. This *must* be a genuine Vendor ID
567 to avoid polluting the USB namespace.
568 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200569
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200570 CONFIG_USBD_PRODUCTID
571 Define this as the unique Product ID
572 for your device
573 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000574
Igor Grinbergd70a5602011-12-12 12:08:35 +0200575- ULPI Layer Support:
576 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
577 the generic ULPI layer. The generic layer accesses the ULPI PHY
578 via the platform viewport, so you need both the genric layer and
579 the viewport enabled. Currently only Chipidea/ARC based
580 viewport is supported.
581 To enable the ULPI layer support, define CONFIG_USB_ULPI and
582 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +0200583 If your ULPI phy needs a different reference clock than the
Tom Rini6e7df1d2023-01-10 11:19:45 -0500584 standard 24 MHz then you have to define CFG_ULPI_REF_CLK to
Lucas Stach6d365ea2012-10-01 00:44:35 +0200585 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +0000586
587- MMC Support:
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +0000588 CONFIG_SH_MMCIF
589 Support for Renesas on-chip MMCIF controller
590
591 CONFIG_SH_MMCIF_ADDR
592 Define the base address of MMCIF registers
593
594 CONFIG_SH_MMCIF_CLK
595 Define the clock frequency for MMCIF
596
Tom Rinib3ba6e92013-03-14 05:32:47 +0000597- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +0100598 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +0000599 This enables the USB portion of the DFU USB class
600
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000601 CONFIG_DFU_NAND
602 This enables support for exposing NAND devices via DFU.
603
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530604 CONFIG_DFU_RAM
605 This enables support for exposing RAM via DFU.
606 Note: DFU spec refer to non-volatile memory usage, but
607 allow usages beyond the scope of spec - here RAM usage,
608 one that would help mostly the developer.
609
Heiko Schochere7e75c72013-06-12 06:05:51 +0200610 CONFIG_SYS_DFU_DATA_BUF_SIZE
611 Dfu transfer uses a buffer before writing data to the
612 raw storage device. Make the size (in bytes) of this buffer
613 configurable. The size of this buffer is also configurable
614 through the "dfu_bufsiz" environment variable.
615
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000616 CONFIG_SYS_DFU_MAX_FILE_SIZE
617 When updating files rather than the raw storage device,
618 we use a static buffer to copy the file into and then write
619 the buffer once we've been given the whole file. Define
620 this to the maximum filesize (in bytes) for the buffer.
621 Default is 4 MiB if undefined.
622
Heiko Schocher001a8312014-03-18 08:09:56 +0100623 DFU_DEFAULT_POLL_TIMEOUT
624 Poll timeout [ms], is the timeout a device can send to the
625 host. The host must wait for this timeout before sending
626 a subsequent DFU_GET_STATUS request to the device.
627
628 DFU_MANIFEST_POLL_TIMEOUT
629 Poll timeout [ms], which the device sends to the host when
630 entering dfuMANIFEST state. Host waits this timeout, before
631 sending again an USB request to the device.
632
wdenkc6097192002-11-03 00:24:07 +0000633- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -0700634 See Kconfig help for available keyboard drivers.
635
wdenk17ea1172004-06-06 21:51:03 +0000636- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +0000637 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
638
639 The clock frequency of the MII bus
640
wdenk17ea1172004-06-06 21:51:03 +0000641 CONFIG_PHY_CMD_DELAY (ppc4xx)
642
643 Some PHY like Intel LXT971A need extra delay after
644 command issued before MII status register can be read
645
wdenkc6097192002-11-03 00:24:07 +0000646- BOOTP Recovery Mode:
647 CONFIG_BOOTP_RANDOM_DELAY
648
649 If you have many targets in a network that try to
650 boot using BOOTP, you may want to avoid that all
651 systems send out BOOTP requests at precisely the same
652 moment (which would happen for instance at recovery
653 from a power failure, when all systems will try to
654 boot, thus flooding the BOOTP server. Defining
655 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
656 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +0200657 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +0000658
659 1st BOOTP request: delay 0 ... 1 sec
660 2nd BOOTP request: delay 0 ... 2 sec
661 3rd BOOTP request: delay 0 ... 4 sec
662 4th and following
663 BOOTP requests: delay 0 ... 8 sec
664
Tom Rini6e7df1d2023-01-10 11:19:45 -0500665 CFG_BOOTP_ID_CACHE_SIZE
Thierry Reding92ac8ac2014-08-19 10:21:24 +0200666
667 BOOTP packets are uniquely identified using a 32-bit ID. The
668 server will copy the ID from client requests to responses and
669 U-Boot will use this to determine if it is the destination of
670 an incoming response. Some servers will check that addresses
671 aren't in use before handing them out (usually using an ARP
672 ping) and therefore take up to a few hundred milliseconds to
673 respond. Network congestion may also influence the time it
674 takes for a response to make it back to the client. If that
675 time is too long, U-Boot will retransmit requests. In order
676 to allow earlier responses to still be accepted after these
677 retransmissions, U-Boot's BOOTP client keeps a small cache of
Tom Rini6e7df1d2023-01-10 11:19:45 -0500678 IDs. The CFG_BOOTP_ID_CACHE_SIZE controls the size of this
Thierry Reding92ac8ac2014-08-19 10:21:24 +0200679 cache. The default is to keep IDs for up to four outstanding
680 requests. Increasing this will allow U-Boot to accept offers
681 from a BOOTP client in networks with unusually high latency.
682
stroesefe389a82003-08-28 14:17:32 +0000683- DHCP Advanced Options:
Joe Hershberger2c00e092012-05-23 07:59:19 +0000684
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000685 - Link-local IP address negotiation:
686 Negotiate with other link-local clients on the local network
687 for an address that doesn't require explicit configuration.
688 This is especially useful if a DHCP server cannot be guaranteed
689 to exist in all environments that the device must operate.
690
691 See doc/README.link-local for more information.
692
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +0530693 - MAC address from environment variables
694
695 FDT_SEQ_MACADDR_FROM_ENV
696
697 Fix-up device tree with MAC addresses fetched sequentially from
698 environment variables. This config work on assumption that
699 non-usable ethernet node of device-tree are either not present
700 or their status has been marked as "disabled".
701
wdenka3d991b2004-04-15 21:48:45 +0000702 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +0000703 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +0000704
705 The device id used in CDP trigger frames.
706
707 CONFIG_CDP_DEVICE_ID_PREFIX
708
709 A two character string which is prefixed to the MAC address
710 of the device.
711
712 CONFIG_CDP_PORT_ID
713
714 A printf format string which contains the ascii name of
715 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200716 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +0000717
718 CONFIG_CDP_CAPABILITIES
719
720 A 32bit integer which indicates the device capabilities;
721 0x00000010 for a normal host which does not forwards.
722
723 CONFIG_CDP_VERSION
724
725 An ascii string containing the version of the software.
726
727 CONFIG_CDP_PLATFORM
728
729 An ascii string containing the name of the platform.
730
731 CONFIG_CDP_TRIGGER
732
733 A 32bit integer sent on the trigger.
734
735 CONFIG_CDP_POWER_CONSUMPTION
736
737 A 16bit integer containing the power consumption of the
738 device in .1 of milliwatts.
739
740 CONFIG_CDP_APPLIANCE_VLAN_TYPE
741
742 A byte containing the id of the VLAN.
743
Uri Mashiach79267ed2017-01-19 10:51:05 +0200744- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +0000745
746 Several configurations allow to display the current
747 status using a LED. For instance, the LED will blink
748 fast while running U-Boot code, stop blinking as
749 soon as a reply to a BOOTP request was received, and
750 start blinking slow once the Linux kernel is running
751 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +0200752 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +0000753 feature in U-Boot.
754
Igor Grinberg1df7bbb2013-11-08 01:03:50 +0200755 Additional options:
756
Uri Mashiach79267ed2017-01-19 10:51:05 +0200757 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +0200758 The status LED can be connected to a GPIO pin.
759 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +0200760 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +0200761 to include the gpio_led driver in the U-Boot binary.
762
Tom Rini6e7df1d2023-01-10 11:19:45 -0500763 CFG_GPIO_LED_INVERTED_TABLE
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +0200764 Some GPIO connected LEDs may have inverted polarity in which
765 case the GPIO high value corresponds to LED off state and
766 GPIO low value corresponds to LED on state.
Tom Rini6e7df1d2023-01-10 11:19:45 -0500767 In such cases CFG_GPIO_LED_INVERTED_TABLE may be defined
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +0200768 with a list of GPIO LEDs that have inverted polarity.
769
Tom Rini55dabcc2021-08-18 23:12:24 -0400770- I2C Support:
Tom Rinicdc5ed82022-11-16 13:10:29 -0500771 CFG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -0600772 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000773
Tom Rinid8964b32022-12-04 10:13:57 -0500774 CFG_SYS_I2C_DIRECT_BUS
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000775 define this, if you don't use i2c muxes on your hardware.
Tom Rini65cc0e22022-11-16 13:10:41 -0500776 if CFG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000777 omit this define.
778
Tom Rini65cc0e22022-11-16 13:10:41 -0500779 CFG_SYS_I2C_MAX_HOPS
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000780 define how many muxes are maximal consecutively connected
781 on one i2c bus. If you not use i2c muxes, omit this
782 define.
783
Tom Rini65cc0e22022-11-16 13:10:41 -0500784 CFG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800785 hold a list of buses you want to use, only used if
Tom Rinid8964b32022-12-04 10:13:57 -0500786 CFG_SYS_I2C_DIRECT_BUS is not defined, for example
Tom Rini65cc0e22022-11-16 13:10:41 -0500787 a board with CFG_SYS_I2C_MAX_HOPS = 1 and
Tom Rinicdc5ed82022-11-16 13:10:29 -0500788 CFG_SYS_NUM_I2C_BUSES = 9:
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000789
Tom Rini65cc0e22022-11-16 13:10:41 -0500790 CFG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000791 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
792 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
793 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
794 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
795 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
796 {1, {I2C_NULL_HOP}}, \
797 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
798 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
799 }
800
801 which defines
802 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +0100803 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
804 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
805 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
806 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
807 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000808 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +0100809 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
810 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +0000811
812 If you do not have i2c muxes on your board, omit this define.
813
Simon Glassce3b5d62017-05-12 21:10:00 -0600814- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +0100815 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +0000816 then the following macros need to be defined (examples are
817 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +0000818
819 I2C_INIT
820
wdenkb37c7e52003-06-30 16:24:52 +0000821 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +0000822 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +0000823
wdenkba56f622004-02-06 23:19:44 +0000824 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +0000825
wdenkc6097192002-11-03 00:24:07 +0000826 I2C_ACTIVE
827
828 The code necessary to make the I2C data line active
829 (driven). If the data line is open collector, this
830 define can be null.
831
wdenkb37c7e52003-06-30 16:24:52 +0000832 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
833
wdenkc6097192002-11-03 00:24:07 +0000834 I2C_TRISTATE
835
836 The code necessary to make the I2C data line tri-stated
837 (inactive). If the data line is open collector, this
838 define can be null.
839
wdenkb37c7e52003-06-30 16:24:52 +0000840 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
841
wdenkc6097192002-11-03 00:24:07 +0000842 I2C_READ
843
York Sun472d5462013-04-01 11:29:11 -0700844 Code that returns true if the I2C data line is high,
845 false if it is low.
wdenkc6097192002-11-03 00:24:07 +0000846
wdenkb37c7e52003-06-30 16:24:52 +0000847 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
848
wdenkc6097192002-11-03 00:24:07 +0000849 I2C_SDA(bit)
850
York Sun472d5462013-04-01 11:29:11 -0700851 If <bit> is true, sets the I2C data line high. If it
852 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +0000853
wdenkb37c7e52003-06-30 16:24:52 +0000854 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +0000855 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +0000856 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +0000857
wdenkc6097192002-11-03 00:24:07 +0000858 I2C_SCL(bit)
859
York Sun472d5462013-04-01 11:29:11 -0700860 If <bit> is true, sets the I2C clock line high. If it
861 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +0000862
wdenkb37c7e52003-06-30 16:24:52 +0000863 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +0000864 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +0000865 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +0000866
wdenkc6097192002-11-03 00:24:07 +0000867 I2C_DELAY
868
869 This delay is invoked four times per clock cycle so this
870 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +0000871 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +0000872 like:
873
wdenkb37c7e52003-06-30 16:24:52 +0000874 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +0000875
Mike Frysinger793b5722010-07-21 13:38:02 -0400876 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
877
878 If your arch supports the generic GPIO framework (asm/gpio.h),
879 then you may alternatively define the two GPIOs that are to be
880 used as SCL / SDA. Any of the previous I2C_xxx macros will
881 have GPIO-based defaults assigned to them as appropriate.
882
883 You should define these to the GPIO value as given directly to
884 the generic GPIO functions.
885
Tom Rinie06b9b82022-12-04 10:04:08 -0500886 CFG_I2C_MULTI_BUS
Ben Warrenbb99ad62006-09-07 16:50:54 -0400887
888 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000889 must have a controller. At any point in time, only one bus is
890 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -0400891 Note that bus numbering is zero-based.
892
Tom Rini65cc0e22022-11-16 13:10:41 -0500893 CFG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -0400894
895 This option specifies a list of I2C devices that will be skipped
Tom Rini1353b252022-12-02 16:42:30 -0500896 when the 'i2c probe' command is issued.
Ben Warrenbb99ad62006-09-07 16:50:54 -0400897
898 e.g.
Tom Rini65cc0e22022-11-16 13:10:41 -0500899 #define CFG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -0400900
901 will skip addresses 0x50 and 0x68 on a board with one I2C bus
902
Tom Rini65cc0e22022-11-16 13:10:41 -0500903 CFG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +0100904
905 If defined, then this indicates the I2C bus number for the RTC.
906 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
907
Andrew Dyer2ac69852008-12-29 17:36:01 -0600908 CONFIG_SOFT_I2C_READ_REPEATED_START
909
910 defining this will force the i2c_read() function in
911 the soft_i2c driver to perform an I2C repeated start
912 between writing the address pointer and reading the
913 data. If this define is omitted the default behaviour
914 of doing a stop-start sequence will be used. Most I2C
915 devices can use either method, but some require one or
916 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -0600917
wdenkc6097192002-11-03 00:24:07 +0000918- SPI Support: CONFIG_SPI
919
920 Enables SPI driver (so far only tested with
921 SPI EEPROM, also an instance works with Crystal A/D and
922 D/As on the SACSng board)
923
Tom Rini6e7df1d2023-01-10 11:19:45 -0500924 CFG_SYS_SPI_MXC_WAIT
Heiko Schocherf659b572014-07-14 10:22:11 +0200925 Timeout for waiting until spi transfer completed.
926 default: (CONFIG_SYS_HZ/100) /* 10 ms */
927
Matthias Fuchs01335022007-12-27 17:12:34 +0100928- FPGA Support: CONFIG_FPGA
929
930 Enables FPGA subsystem.
931
932 CONFIG_FPGA_<vendor>
933
934 Enables support for specific chip vendors.
935 (ALTERA, XILINX)
936
937 CONFIG_FPGA_<family>
938
939 Enables support for FPGA family.
940 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200942 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +0000943
wdenk43d96162003-03-06 00:02:04 +0000944 Enable checks on FPGA configuration interface busy
945 status by the configuration function. This option
946 will require a board or device specific function to
947 be written.
wdenkc6097192002-11-03 00:24:07 +0000948
Tom Rini72fc2642022-12-04 10:03:57 -0500949 CFG_FPGA_DELAY
wdenkc6097192002-11-03 00:24:07 +0000950
951 If defined, a function that provides delays in the FPGA
952 configuration driver.
953
Tom Rini6e7df1d2023-01-10 11:19:45 -0500954 CFG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +0000955
wdenk43d96162003-03-06 00:02:04 +0000956 Check for configuration errors during FPGA bitfile
957 loading. For example, abort during Virtex II
958 configuration if the INIT_B line goes low (which
959 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +0000960
Tom Rini65cc0e22022-11-16 13:10:41 -0500961 CFG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +0000962
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800963 Maximum time to wait for the INIT_B line to de-assert
964 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +0000965 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200966 ms.
wdenkc6097192002-11-03 00:24:07 +0000967
Tom Rini65cc0e22022-11-16 13:10:41 -0500968 CFG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +0000969
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800970 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200971 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +0000972
Tom Rini65cc0e22022-11-16 13:10:41 -0500973 CFG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +0000974
wdenk43d96162003-03-06 00:02:04 +0000975 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200976 200 ms.
wdenkc6097192002-11-03 00:24:07 +0000977
wdenkc6097192002-11-03 00:24:07 +0000978- Vendor Parameter Protection:
979
wdenk43d96162003-03-06 00:02:04 +0000980 U-Boot considers the values of the environment
981 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +0000982 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +0000983 are set once by the board vendor / manufacturer, and
984 protects these variables from casual modification by
985 the user. Once set, these variables are read-only,
986 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200987 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +0000988
989 If CONFIG_ENV_OVERWRITE is #defined in your config
990 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +0000991 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +0000992 these parameters.
993
Joe Hershberger25980902012-12-11 22:16:31 -0600994 The same can be accomplished in a more flexible way
995 for any variable by configuring the type of access
996 to allow for those variables in the ".flags" variable
Tom Riniacf29d82022-12-04 10:03:40 -0500997 or define CFG_ENV_FLAGS_LIST_STATIC.
Joe Hershberger25980902012-12-11 22:16:31 -0600998
wdenkc6097192002-11-03 00:24:07 +0000999- Protected RAM:
Tom Rini7c5c1372022-12-04 10:13:37 -05001000 CFG_PRAM
wdenkc6097192002-11-03 00:24:07 +00001001
1002 Define this variable to enable the reservation of
1003 "protected RAM", i. e. RAM which is not overwritten
Tom Rini7c5c1372022-12-04 10:13:37 -05001004 by U-Boot. Define CFG_PRAM to hold the number of
wdenkc6097192002-11-03 00:24:07 +00001005 kB you want to reserve for pRAM. You can overwrite
1006 this default value by defining an environment
1007 variable "pram" to the number of kB you want to
1008 reserve. Note that the board info structure will
1009 still show the full amount of RAM. If pRAM is
1010 reserved, a new environment variable "mem" will
1011 automatically be defined to hold the amount of
1012 remaining RAM in a form that can be passed as boot
1013 argument to Linux, for instance like that:
1014
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001015 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001016 saveenv
1017
1018 This way you can tell Linux not to use this memory,
1019 either, which results in a memory region that will
1020 not be affected by reboots.
1021
1022 *WARNING* If your board configuration uses automatic
1023 detection of the RAM size, you must make sure that
1024 this memory test is non-destructive. So far, the
1025 following board configurations are known to be
1026 "pRAM-clean":
1027
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02001028 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00001029 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02001030 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00001031
1032- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00001033 Note:
1034
wdenk8bde7f72003-06-27 21:31:46 +00001035 In the current implementation, the local variables
1036 space and global environment variables space are
1037 separated. Local variables are those you define by
1038 simply typing `name=value'. To access a local
1039 variable later on, you have write `$name' or
1040 `${name}'; to execute the contents of a variable
1041 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001042
wdenk43d96162003-03-06 00:02:04 +00001043 Global environment variables are those you use
1044 setenv/printenv to work with. To run a command stored
1045 in such a variable, you need to use the run command,
1046 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001047
1048 To store commands and special characters in a
1049 variable, please use double quotation marks
1050 surrounding the whole text of the variable, instead
1051 of the backslashes before semicolons and special
1052 symbols.
1053
wdenka8c7c702003-12-06 19:49:23 +00001054- Default Environment:
Tom Rini0613c362022-12-04 10:03:50 -05001055 CFG_EXTRA_ENV_SETTINGS
wdenkc6097192002-11-03 00:24:07 +00001056
wdenk43d96162003-03-06 00:02:04 +00001057 Define this to contain any number of null terminated
1058 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001059 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001060
wdenk43d96162003-03-06 00:02:04 +00001061 For example, place something like this in your
1062 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001063
Tom Rini0613c362022-12-04 10:03:50 -05001064 #define CFG_EXTRA_ENV_SETTINGS \
wdenkc6097192002-11-03 00:24:07 +00001065 "myvar1=value1\0" \
1066 "myvar2=value2\0"
1067
wdenk43d96162003-03-06 00:02:04 +00001068 Warning: This method is based on knowledge about the
1069 internal format how the environment is stored by the
1070 U-Boot code. This is NOT an official, exported
1071 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001072 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001073 You better know what you are doing here.
1074
wdenk43d96162003-03-06 00:02:04 +00001075 Note: overly (ab)use of the default environment is
1076 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001077 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001078 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001079
Simon Glass06fd8532012-11-30 13:01:17 +00001080 CONFIG_DELAY_ENVIRONMENT
1081
1082 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001083 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00001084 that so that the environment is not available until
1085 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1086 this is instead controlled by the value of
1087 /config/load-environment.
1088
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01001089- Automatic software updates via TFTP server
1090 CONFIG_UPDATE_TFTP
1091 CONFIG_UPDATE_TFTP_CNT_MAX
1092 CONFIG_UPDATE_TFTP_MSEC_MAX
1093
1094 These options enable and control the auto-update feature;
1095 for a more detailed description refer to doc/README.update.
1096
1097- MTD Support (mtdparts command, UBI support)
Heiko Schocherff94bc42014-06-24 10:10:04 +02001098 CONFIG_MTD_UBI_WL_THRESHOLD
1099 This parameter defines the maximum difference between the highest
1100 erase counter value and the lowest erase counter value of eraseblocks
1101 of UBI devices. When this threshold is exceeded, UBI starts performing
1102 wear leveling by means of moving data from eraseblock with low erase
1103 counter to eraseblocks with high erase counter.
1104
1105 The default value should be OK for SLC NAND flashes, NOR flashes and
1106 other flashes which have eraseblock life-cycle 100000 or more.
1107 However, in case of MLC NAND flashes which typically have eraseblock
1108 life-cycle less than 10000, the threshold should be lessened (e.g.,
1109 to 128 or 256, although it does not have to be power of 2).
1110
1111 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06001112
Heiko Schocherff94bc42014-06-24 10:10:04 +02001113 CONFIG_MTD_UBI_BEB_LIMIT
1114 This option specifies the maximum bad physical eraseblocks UBI
1115 expects on the MTD device (per 1024 eraseblocks). If the
1116 underlying flash does not admit of bad eraseblocks (e.g. NOR
1117 flash), this value is ignored.
1118
1119 NAND datasheets often specify the minimum and maximum NVM
1120 (Number of Valid Blocks) for the flashes' endurance lifetime.
1121 The maximum expected bad eraseblocks per 1024 eraseblocks
1122 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1123 which gives 20 for most NANDs (MaxNVB is basically the total
1124 count of eraseblocks on the chip).
1125
1126 To put it differently, if this value is 20, UBI will try to
1127 reserve about 1.9% of physical eraseblocks for bad blocks
1128 handling. And that will be 1.9% of eraseblocks on the entire
1129 NAND chip, not just the MTD partition UBI attaches. This means
1130 that if you have, say, a NAND flash chip admits maximum 40 bad
1131 eraseblocks, and it is split on two MTD partitions of the same
1132 size, UBI will reserve 40 eraseblocks when attaching a
1133 partition.
1134
1135 default: 20
1136
1137 CONFIG_MTD_UBI_FASTMAP
1138 Fastmap is a mechanism which allows attaching an UBI device
1139 in nearly constant time. Instead of scanning the whole MTD device it
1140 only has to locate a checkpoint (called fastmap) on the device.
1141 The on-flash fastmap contains all information needed to attach
1142 the device. Using fastmap makes only sense on large devices where
1143 attaching by scanning takes long. UBI will not automatically install
1144 a fastmap on old images, but you can set the UBI parameter
1145 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1146 that fastmap-enabled images are still usable with UBI implementations
1147 without fastmap support. On typical flash devices the whole fastmap
1148 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1149
1150 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1151 Set this parameter to enable fastmap automatically on images
1152 without a fastmap.
1153 default: 0
1154
Heiko Schocher0195a7b2015-10-22 06:19:21 +02001155 CONFIG_MTD_UBI_FM_DEBUG
1156 Enable UBI fastmap debug
1157 default: 0
1158
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00001159- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001160 CONFIG_SPL
1161 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00001162
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02001163 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1164 When defined, SPL will panic() if the image it has
1165 loaded does not have a signature.
1166 Defining this is useful when code which loads images
1167 in SPL cannot guarantee that absolutely all read errors
1168 will be caught.
1169 An example is the LPC32XX MLC NAND driver, which will
1170 consider that a completely unreadable NAND block is bad,
1171 and thus should be skipped silently.
1172
Tom Rini861a86f2012-08-13 11:37:56 -07001173 CONFIG_SPL_DISPLAY_PRINT
1174 For ARM, enable an optional function to print more information
1175 about the running system.
1176
Scott Wood06f60ae2012-12-06 13:33:17 +00001177 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1178 Set this for NAND SPL on PPC mpc83xx targets, so that
1179 start.S waits for the rest of the SPL to load before
1180 continuing (the hardware starts execution after just
1181 loading the first page rather than the full 4K).
1182
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02001183 CONFIG_SPL_UBI
1184 Support for a lightweight UBI (fastmap) scanner and
1185 loader
1186
Sean Anderson601b8902023-11-04 16:37:41 -04001187 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_SIZE,
1188 CONFIG_SYS_NAND_OOBSIZE, CONFIG_SYS_NAND_BLOCK_SIZE,
1189 CONFIG_SYS_NAND_BAD_BLOCK_POS, CFG_SYS_NAND_ECCPOS,
1190 CFG_SYS_NAND_ECCSIZE, CFG_SYS_NAND_ECCBYTES
Tom Rini95579792012-02-14 07:29:40 +00001191 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05001192 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00001193
Tom Rini4e590942022-11-12 17:36:51 -05001194 CFG_SYS_NAND_U_BOOT_DST
Scott Wood7d4b7952012-09-21 18:35:27 -05001195 Location in memory to load U-Boot to
1196
Tom Rini4e590942022-11-12 17:36:51 -05001197 CFG_SYS_NAND_U_BOOT_SIZE
Scott Wood7d4b7952012-09-21 18:35:27 -05001198 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00001199
Tom Rini4e590942022-11-12 17:36:51 -05001200 CFG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05001201 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00001202
Pavel Machekc57b9532012-08-30 22:42:11 +02001203 CONFIG_SPL_RAM_DEVICE
1204 Support for running image already present in ram, in SPL binary
1205
Marek Vasutb527b9c2018-05-13 00:22:52 +02001206 CONFIG_SPL_FIT_PRINT
Simon Glass87ebee32013-05-08 08:05:59 +00001207 Printing information about a FIT image adds quite a bit of
1208 code to SPL. So this is normally disabled in SPL. Use this
1209 option to re-enable it. This will affect the output of the
1210 bootm command when booting a FIT image.
1211
wdenka8c7c702003-12-06 19:49:23 +00001212- Interrupt support (PPC):
1213
wdenkd4ca31c2004-01-02 14:00:00 +00001214 There are common interrupt_init() and timer_interrupt()
1215 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001216 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00001217 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001218 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00001219 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001220 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00001221 specific handling. If board has watchdog / status_led
1222 / other_activity_monitor it works automatically from
1223 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001224
wdenkc6097192002-11-03 00:24:07 +00001225
Helmut Raiger9660e442011-10-20 04:19:47 +00001226Board initialization settings:
1227------------------------------
1228
1229During Initialization u-boot calls a number of board specific functions
1230to allow the preparation of board specific prerequisites, e.g. pin setup
1231before drivers are initialized. To enable these callbacks the
1232following configuration macros have to be defined. Currently this is
1233architecture specific, so please check arch/your_architecture/lib/board.c
1234typically in board_init_f() and board_init_r().
1235
1236- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1237- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1238- CONFIG_BOARD_LATE_INIT: Call board_late_init()
wdenkc6097192002-11-03 00:24:07 +00001239
wdenkc6097192002-11-03 00:24:07 +00001240Configuration Settings:
1241-----------------------
1242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001243- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00001244 undefine this when you're short of memory.
1245
Tom Rini6e7df1d2023-01-10 11:19:45 -05001246- CFG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
Peter Tyser2fb26042009-01-27 18:03:12 -06001247 width of the commands listed in the 'help' command output.
1248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001249- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00001250 prompt for user input.
1251
Tom Rini65cc0e22022-11-16 13:10:41 -05001252- CFG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00001253 List of legal baudrate settings for this board.
1254
Tom Rini65cc0e22022-11-16 13:10:41 -05001255- CFG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07001256 Only implemented for ARMv8 for now.
Tom Rini65cc0e22022-11-16 13:10:41 -05001257 If defined, the size of CFG_SYS_MEM_RESERVE_SECURE memory
York Sune8149522015-12-04 11:57:07 -08001258 is substracted from total RAM and won't be reported to OS.
1259 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07001260 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08001261 the RAM base is not zero, or RAM is divided into banks,
1262 this variable needs to be recalcuated to get the address.
1263
Tom Riniaa6e94d2022-11-16 13:10:37 -05001264- CFG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00001265 Physical start address of SDRAM. _Must_ be 0 here.
1266
Tom Rini65cc0e22022-11-16 13:10:41 -05001267- CFG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00001268 Physical start address of Flash memory.
1269
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001270- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00001271 Size of DRAM reserved for malloc() use.
1272
Tom Rini65cc0e22022-11-16 13:10:41 -05001273- CFG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00001274 Maximum size of memory mapped by the startup code of
1275 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02001276 the Linux kernel (bd_info, boot arguments, FDT blob if
1277 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04001278 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02001279 all data for the Linux kernel must be between "bootm_low"
Tom Rini65cc0e22022-11-16 13:10:41 -05001280 and "bootm_low" + CFG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00001281 variable "bootm_mapsize" will override the value of
Tom Rini65cc0e22022-11-16 13:10:41 -05001282 CFG_SYS_BOOTMAPSZ. If CFG_SYS_BOOTMAPSZ is undefined,
Grant Likelyc3624e62011-03-28 09:58:43 +00001283 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00001284
John Rigbyfca43cc2010-10-13 13:57:35 -06001285- CONFIG_SYS_BOOT_GET_CMDLINE:
1286 Enables allocating and saving kernel cmdline in space between
1287 "bootm_low" and "bootm_low" + BOOTMAPSZ.
1288
1289- CONFIG_SYS_BOOT_GET_KBD:
1290 Enables allocating and saving a kernel copy of the bd_info in
1291 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
1292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001293- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00001294 If defined, hardware flash sectors protection is used
1295 instead of U-Boot software protection.
1296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001297- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001298 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001299 common flash structure for storing flash geometry.
1300
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02001301- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00001302 This option also enables the building of the cfi_flash driver
1303 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001304
Piotr Ziecik91809ed2008-11-17 15:57:58 +01001305- CONFIG_FLASH_CFI_MTD
1306 This option enables the building of the cfi_mtd driver
1307 in the drivers directory. The driver exports CFI flash
1308 to the MTD layer.
1309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001310- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02001311 Use buffered writes to flash.
1312
Joe Hershberger25980902012-12-11 22:16:31 -06001313- CONFIG_ENV_FLAGS_LIST_DEFAULT
Tom Riniacf29d82022-12-04 10:03:40 -05001314- CFG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04001315 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06001316 calling env set. Variables can be restricted to only decimal,
1317 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
1318 the variables can also be restricted to IP address or MAC address.
1319
1320 The format of the list is:
1321 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001322 access_attribute = [a|r|o|c]
1323 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06001324 entry = variable_name[:attributes]
1325 list = entry[,list]
1326
1327 The type attributes are:
1328 s - String (default)
1329 d - Decimal
1330 x - Hexadecimal
1331 b - Boolean ([1yYtT|0nNfF])
1332 i - IP address
1333 m - MAC address
1334
Joe Hershberger267541f2012-12-11 22:16:34 -06001335 The access attributes are:
1336 a - Any (default)
1337 r - Read-only
1338 o - Write-once
1339 c - Change-default
1340
Joe Hershberger25980902012-12-11 22:16:31 -06001341 - CONFIG_ENV_FLAGS_LIST_DEFAULT
1342 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001343 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06001344
Tom Riniacf29d82022-12-04 10:03:40 -05001345 - CFG_ENV_FLAGS_LIST_STATIC
Joe Hershberger25980902012-12-11 22:16:31 -06001346 Define this to a list (string) to define validation that
1347 should be done if an entry is not found in the ".flags"
1348 environment variable. To override a setting in the static
1349 list, simply add an entry for the same variable name to the
1350 ".flags" variable.
1351
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05001352 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
1353 regular expression. This allows multiple variables to define the same
1354 flags without explicitly listing them for each variable.
1355
wdenkc6097192002-11-03 00:24:07 +00001356The following definitions that deal with the placement and management
1357of environment data (variable area); in general, we support the
1358following configurations:
1359
wdenkc6097192002-11-03 00:24:07 +00001360BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001361in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001362console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00001363U-Boot will hang.
1364
1365Please note that even with NVRAM we still use a copy of the
1366environment in RAM: we could work on NVRAM directly, but we want to
1367keep settings there always unmodified except somebody uses "saveenv"
1368to save the current settings.
1369
Liu Gang0a85a9e2012-03-08 00:33:20 +00001370BE CAREFUL! For some special cases, the local device can not use
1371"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00001372environment stored in a remote NOR flash by SRIO or PCIE link,
1373but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00001374
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02001375- CONFIG_NAND_ENV_DST
1376
1377 Defines address in RAM to which the nand_spl code should copy the
1378 environment. If redundant environment is used, it will be copied to
1379 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
1380
Bruce Adlere881cb52007-11-02 13:15:42 -07001381Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00001382has been relocated to RAM and a RAM copy of the environment has been
Simon Glass00caae62017-08-03 12:22:12 -06001383created; also, when using EEPROM you will have to use env_get_f()
wdenkc6097192002-11-03 00:24:07 +00001384until then to read environment variables.
1385
wdenk85ec0bc2003-03-31 16:34:49 +00001386The environment is protected by a CRC32 checksum. Before the monitor
1387is relocated into RAM, as a result of a bad CRC you will be working
1388with the compiled-in default environment - *silently*!!! [This is
1389necessary, because the first environment variable we need is the
1390"baudrate" setting for the console - if we have a bad CRC, we don't
1391have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001392
1393Note: once the monitor has been relocated, then it will complain if
1394the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001395use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001397- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001398 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001399
Simon Glassb2b92f52012-11-30 13:01:18 +00001400- CONFIG_DISPLAY_BOARDINFO
1401 Display information about the board that U-Boot is running on
1402 when U-Boot starts up. The board function checkboard() is called
1403 to do this.
1404
Simon Glasse2e3e2b2012-11-30 13:01:19 +00001405- CONFIG_DISPLAY_BOARDINFO_LATE
1406 Similar to the previous option, but display this information
1407 later, once stdio is running and output goes to the LCD, if
1408 present.
1409
wdenkc6097192002-11-03 00:24:07 +00001410Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001411---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001413- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00001414 Cache Line Size of the CPU.
1415
Timur Tabie46fedf2011-08-04 18:03:41 -05001416- CONFIG_SYS_CCSRBAR_DEFAULT:
1417 Default (power-on reset) physical address of CCSR on Freescale
1418 PowerPC SOCs.
1419
Tom Rini65cc0e22022-11-16 13:10:41 -05001420- CFG_SYS_CCSRBAR:
Timur Tabie46fedf2011-08-04 18:03:41 -05001421 Virtual address of CCSR. On a 32-bit build, this is typically
1422 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
1423
Tom Rini65cc0e22022-11-16 13:10:41 -05001424- CFG_SYS_CCSRBAR_PHYS:
Timur Tabie46fedf2011-08-04 18:03:41 -05001425 Physical address of CCSR. CCSR can be relocated to a new
1426 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001427 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05001428 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
1429 is typically relocated on 36-bit builds. It is recommended
1430 that this macro be defined via the _HIGH and _LOW macros:
1431
Tom Rini65cc0e22022-11-16 13:10:41 -05001432 #define CFG_SYS_CCSRBAR_PHYS ((CFG_SYS_CCSRBAR_PHYS_HIGH
1433 * 1ull) << 32 | CFG_SYS_CCSRBAR_PHYS_LOW)
Timur Tabie46fedf2011-08-04 18:03:41 -05001434
Tom Rini65cc0e22022-11-16 13:10:41 -05001435- CFG_SYS_CCSRBAR_PHYS_HIGH:
1436 Bits 33-36 of CFG_SYS_CCSRBAR_PHYS. This value is typically
Wolfgang Denk4cf26092011-10-07 09:58:21 +02001437 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05001438 used in assembly code, so it must not contain typecasts or
1439 integer size suffixes (e.g. "ULL").
1440
Tom Rini65cc0e22022-11-16 13:10:41 -05001441- CFG_SYS_CCSRBAR_PHYS_LOW:
1442 Lower 32-bits of CFG_SYS_CCSRBAR_PHYS. This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05001443 used in assembly code, so it must not contain typecasts or
1444 integer size suffixes (e.g. "ULL").
1445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001446- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00001447 DO NOT CHANGE unless you know exactly what you're
Christophe Leroy907208c2017-07-06 10:23:22 +02001448 doing! (11-4) [MPC8xx systems only]
wdenkc6097192002-11-03 00:24:07 +00001449
Tom Rini65cc0e22022-11-16 13:10:41 -05001450- CFG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00001451
wdenk7152b1d2003-09-05 23:19:14 +00001452 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00001453 initial data and stack; please note that this must be
1454 writable memory that is working WITHOUT special
1455 initialization, i. e. you CANNOT use normal RAM which
1456 will become available only after programming the
1457 memory controller and running certain initialization
1458 sequences.
1459
1460 U-Boot uses the following memory types:
Christophe Leroy907208c2017-07-06 10:23:22 +02001461 - MPC8xx: IMMR (internal memory of the CPU)
wdenkc6097192002-11-03 00:24:07 +00001462
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001463- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00001464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001465- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00001466 SDRAM timing
1467
Kumar Galaa09b9b62010-12-30 12:09:53 -06001468- CONFIG_SYS_SRIOn_MEM_VIRT:
1469 Virtual Address of SRIO port 'n' memory region
1470
Simon Glass62f9b652019-11-14 12:57:09 -07001471- CONFIG_SYS_SRIOn_MEM_PHYxS:
Kumar Galaa09b9b62010-12-30 12:09:53 -06001472 Physical Address of SRIO port 'n' memory region
1473
1474- CONFIG_SYS_SRIOn_MEM_SIZE:
1475 Size of SRIO port 'n' memory region
1476
Fabio Estevam66bd1842013-04-11 09:35:34 +00001477- CONFIG_SYS_NAND_BUSWIDTH_16BIT
1478 Defined to tell the NAND controller that the NAND chip is using
1479 a 16 bit bus.
1480 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00001481 Example of drivers that use it:
Miquel Raynala430fa02018-08-16 17:30:07 +02001482 - drivers/mtd/nand/raw/ndfc.c
1483 - drivers/mtd/nand/raw/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04001484
1485- CONFIG_SYS_NDFC_EBC0_CFG
1486 Sets the EBC0_CFG register for the NDFC. If not defined
1487 a default value will be used.
1488
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001489- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01001490 If SPD EEPROM is on an I2C bus other than the first
1491 one, specify here. Note that the value must resolve
1492 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001493
York Sun6f5e1dc2011-09-16 13:21:35 -07001494- CONFIG_FSL_DDR_INTERACTIVE
1495 Enable interactive DDR debugging. See doc/README.fsl-ddr.
1496
York Sune32d59a2015-01-06 13:18:55 -08001497- CONFIG_FSL_DDR_SYNC_REFRESH
1498 Enable sync of refresh for multiple controllers.
1499
York Sun4516ff82015-03-19 09:30:28 -07001500- CONFIG_FSL_DDR_BIST
1501 Enable built-in memory test for Freescale DDR controllers.
1502
wdenkc26e4542004-04-18 10:13:26 +00001503- CONFIG_RMII
1504 Enable RMII mode for all FECs.
1505 Note that this is a global option, we can't
1506 have one FEC in standard MII mode and another in RMII mode.
1507
wdenk5cf91d62004-04-23 20:32:05 +00001508- CONFIG_CRC32_VERIFY
1509 Add a verify option to the crc32 command.
1510 The syntax is:
1511
1512 => crc32 -v <address> <count> <crc32>
1513
1514 Where address/count indicate a memory area
1515 and crc32 is the correct crc32 which the
1516 area should have.
1517
wdenk56523f12004-07-11 17:40:54 +00001518- CONFIG_LOOPW
1519 Add the "loopw" memory command. This only takes effect if
Simon Glass493f4202017-08-04 16:34:27 -06001520 the memory commands are activated globally (CONFIG_CMD_MEMORY).
wdenk56523f12004-07-11 17:40:54 +00001521
Joel Johnson72732312020-01-29 09:17:18 -07001522- CONFIG_CMD_MX_CYCLIC
stroese7b466642004-12-16 18:46:55 +00001523 Add the "mdc" and "mwc" memory commands. These are cyclic
1524 "md/mw" commands.
1525 Examples:
1526
wdenkefe2a4d2004-12-16 21:44:03 +00001527 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00001528 This command will print 4 bytes (10,11,12,13) each 500 ms.
1529
wdenkefe2a4d2004-12-16 21:44:03 +00001530 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00001531 This command will write 12345678 to address 100 all 10 ms.
1532
wdenkefe2a4d2004-12-16 21:44:03 +00001533 This only takes effect if the memory commands are activated
Simon Glass493f4202017-08-04 16:34:27 -06001534 globally (CONFIG_CMD_MEMORY).
stroese7b466642004-12-16 18:46:55 +00001535
Aneesh V401bb302011-07-13 05:11:07 +00001536- CONFIG_SPL_BUILD
Simon Glass1d387222023-11-18 14:04:50 -07001537 Set when the currently running compilation is for an artifact
1538 that will end up in one of the 'xPL' builds, i.e. SPL, TPL or
1539 VPL. Code that needs phase-specific behaviour can check this,
1540 or (where possible) use spl_phase() instead.
1541
1542 Note that CONFIG_SPL_BUILD *is* always defined when either
1543 of CONFIG_TPL_BUILD / CONFIG_VPL_BUILD is defined. This can be
1544 counter-intuitive and should perhaps be changed.
wdenk400558b2005-04-02 23:52:25 +00001545
Ying Zhang3aa29de2013-08-16 15:16:15 +08001546- CONFIG_TPL_BUILD
Simon Glass1d387222023-11-18 14:04:50 -07001547 Set when the currently running compilation is for an artifact
1548 that will end up in the TPL build (as opposed to SPL, VPL or
1549 U-Boot proper). Code that needs phase-specific behaviour can
1550 check this, or (where possible) use spl_phase() instead.
1551
1552- CONFIG_VPL_BUILD
1553 Set when the currently running compilation is for an artifact
1554 that will end up in the VPL build (as opposed to the SPL, TPL
1555 or U-Boot proper). Code that needs phase-specific behaviour can
1556 check this, or (where possible) use spl_phase() instead.
Ying Zhang3aa29de2013-08-16 15:16:15 +08001557
Simon Glass4213fc22013-02-24 17:33:14 +00001558- CONFIG_ARCH_MAP_SYSMEM
1559 Generally U-Boot (and in particular the md command) uses
1560 effective address. It is therefore not necessary to regard
1561 U-Boot address as virtual addresses that need to be translated
1562 to physical addresses. However, sandbox requires this, since
1563 it maintains its own little RAM buffer which contains all
1564 addressable memory. This option causes some memory accesses
1565 to be mapped through map_sysmem() / unmap_sysmem().
1566
Simon Glass588a13f2013-02-14 04:18:54 +00001567- CONFIG_X86_RESET_VECTOR
1568 If defined, the x86 reset vector code is included. This is not
1569 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00001570
Timur Tabif2717b42011-11-22 09:21:25 -06001571Freescale QE/FMAN Firmware Support:
1572-----------------------------------
1573
1574The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
1575loading of "firmware", which is encoded in the QE firmware binary format.
1576This firmware often needs to be loaded during U-Boot booting, so macros
1577are used to identify the storage device (NOR flash, SPI, etc) and the address
1578within that device.
1579
Zhao Qiangdcf1d772014-03-21 16:21:44 +08001580- CONFIG_SYS_FMAN_FW_ADDR
1581 The address in the storage device where the FMAN microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04001582 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Zhao Qiangdcf1d772014-03-21 16:21:44 +08001583 is also specified.
1584
1585- CONFIG_SYS_QE_FW_ADDR
1586 The address in the storage device where the QE microcode is located. The
Tom Rinicc1e98b2019-05-12 07:59:12 -04001587 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
Timur Tabif2717b42011-11-22 09:21:25 -06001588 is also specified.
1589
1590- CONFIG_SYS_QE_FMAN_FW_LENGTH
1591 The maximum possible size of the firmware. The firmware binary format
1592 has a field that specifies the actual size of the firmware, but it
1593 might not be possible to read any part of the firmware unless some
1594 local storage is allocated to hold the entire firmware first.
1595
1596- CONFIG_SYS_QE_FMAN_FW_IN_NOR
1597 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
1598 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
1599 virtual address in NOR flash.
1600
1601- CONFIG_SYS_QE_FMAN_FW_IN_NAND
1602 Specifies that QE/FMAN firmware is located in NAND flash.
1603 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
1604
1605- CONFIG_SYS_QE_FMAN_FW_IN_MMC
1606 Specifies that QE/FMAN firmware is located on the primary SD/MMC
1607 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
1608
Liu Gang292dc6c2012-03-08 00:33:18 +00001609- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
1610 Specifies that QE/FMAN firmware is located in the remote (master)
1611 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00001612 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
1613 window->master inbound window->master LAW->the ucode address in
1614 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06001615
J. German Riverab940ca62014-06-23 15:15:55 -07001616Freescale Layerscape Management Complex Firmware Support:
1617---------------------------------------------------------
1618The Freescale Layerscape Management Complex (MC) supports the loading of
1619"firmware".
1620This firmware often needs to be loaded during U-Boot booting, so macros
1621are used to identify the storage device (NOR flash, SPI, etc) and the address
1622within that device.
1623
1624- CONFIG_FSL_MC_ENET
1625 Enable the MC driver for Layerscape SoCs.
1626
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05301627Freescale Layerscape Debug Server Support:
1628-------------------------------------------
1629The Freescale Layerscape Debug Server Support supports the loading of
1630"Debug Server firmware" and triggering SP boot-rom.
1631This firmware often needs to be loaded during U-Boot booting.
1632
York Sunc0492142015-12-07 11:08:58 -08001633- CONFIG_SYS_MC_RSV_MEM_ALIGN
1634 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05301635
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02001636
wdenkc6097192002-11-03 00:24:07 +00001637Building the Software:
1638======================
1639
Wolfgang Denk218ca722008-03-26 10:40:12 +01001640Building U-Boot has been tested in several native build environments
1641and in many different cross environments. Of course we cannot support
1642all possibly existing versions of cross development tools in all
1643(potentially obsolete) versions. In case of tool chain problems we
Naoki Hayama047f6ec2020-10-08 13:17:16 +09001644recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
Wolfgang Denk218ca722008-03-26 10:40:12 +01001645which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00001646
Wolfgang Denk218ca722008-03-26 10:40:12 +01001647If you are not using a native environment, it is assumed that you
1648have GNU cross compiling tools available in your path. In this case,
1649you must set the environment variable CROSS_COMPILE in your shell.
1650Note that no changes to the Makefile or any other source files are
1651necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00001652
Wolfgang Denk218ca722008-03-26 10:40:12 +01001653 $ CROSS_COMPILE=ppc_4xx-
1654 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00001655
Wolfgang Denk218ca722008-03-26 10:40:12 +01001656U-Boot is intended to be simple to build. After installing the
1657sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00001658is done by typing:
1659
Holger Freytherab584d62014-08-04 09:26:05 +02001660 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00001661
Holger Freytherab584d62014-08-04 09:26:05 +02001662where "NAME_defconfig" is the name of one of the existing configu-
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01001663rations; see configs/*_defconfig for supported names.
wdenk54387ac2003-10-08 22:45:44 +00001664
Heinrich Schuchardtecb3a0a2020-02-24 18:36:30 +01001665Note: for some boards special configuration names may exist; check if
wdenk2729af92004-05-03 20:45:30 +00001666 additional information is available from the board vendor; for
1667 instance, the TQM823L systems are available without (standard)
1668 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001669 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00001670
Holger Freytherab584d62014-08-04 09:26:05 +02001671 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00001672 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00001673
Holger Freytherab584d62014-08-04 09:26:05 +02001674 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00001675 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00001676
wdenk2729af92004-05-03 20:45:30 +00001677 etc.
wdenkc6097192002-11-03 00:24:07 +00001678
wdenkc6097192002-11-03 00:24:07 +00001679
wdenk2729af92004-05-03 20:45:30 +00001680Finally, type "make all", and you should get some working U-Boot
1681images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00001682
wdenk2729af92004-05-03 20:45:30 +00001683- "u-boot.bin" is a raw binary image
1684- "u-boot" is an image in ELF binary format
1685- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00001686
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001687By default the build is performed locally and the objects are saved
1688in the source directory. One of the two methods can be used to change
1689this behavior and build U-Boot to some external directory:
1690
16911. Add O= to the make command line invocations:
1692
1693 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02001694 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001695 make O=/tmp/build all
1696
Timo Ketolaadbba992014-11-06 14:39:05 +020016972. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001698
Timo Ketolaadbba992014-11-06 14:39:05 +02001699 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001700 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02001701 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001702 make all
1703
Timo Ketolaadbba992014-11-06 14:39:05 +02001704Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001705variable.
1706
Daniel Schwierzeck215bb1c2018-01-26 16:31:04 +01001707User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
1708setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
1709For example to treat all compiler warnings as errors:
1710
1711 make KCFLAGS=-Werror
wdenkc6097192002-11-03 00:24:07 +00001712
wdenk2729af92004-05-03 20:45:30 +00001713Please be aware that the Makefiles assume you are using GNU make, so
1714for instance on NetBSD you might need to use "gmake" instead of
1715native "make".
wdenkc6097192002-11-03 00:24:07 +00001716
wdenkc6097192002-11-03 00:24:07 +00001717
wdenk2729af92004-05-03 20:45:30 +00001718If the system board that you have is not listed, then you will need
1719to port U-Boot to your hardware platform. To do this, follow these
1720steps:
wdenkc6097192002-11-03 00:24:07 +00001721
Phil Sutter3c1496c2015-12-25 14:41:18 +010017221. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00001723 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01001724 the "Makefile" and a "<board>.c".
17252. Create a new configuration file "include/configs/<board>.h" for
1726 your board.
wdenk2729af92004-05-03 20:45:30 +000017273. If you're porting U-Boot to a new CPU, then also create a new
1728 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020017294. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000017305. Type "make", and you should get a working "u-boot.srec" file
1731 to be installed on your target system.
17326. Debug and solve any problems that might arise.
1733 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00001734
wdenkc6097192002-11-03 00:24:07 +00001735
wdenk2729af92004-05-03 20:45:30 +00001736Testing of U-Boot Modifications, Ports to New Hardware, etc.:
1737==============================================================
wdenkc6097192002-11-03 00:24:07 +00001738
Wolfgang Denk218ca722008-03-26 10:40:12 +01001739If you have modified U-Boot sources (for instance added a new board
1740or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00001741provide feedback to the other developers. The feedback normally takes
Thomas Hebb32f2ca22019-11-13 18:18:03 -08001742the form of a "patch", i.e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01001743official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00001744
Wolfgang Denk218ca722008-03-26 10:40:12 +01001745But before you submit such a patch, please verify that your modifi-
1746cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00001747the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06001748just run the buildman script (tools/buildman/buildman), which will
1749configure and build U-Boot for ALL supported system. Be warned, this
1750will take a while. Please see the buildman README, or run 'buildman -H'
1751for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02001752
1753
wdenk2729af92004-05-03 20:45:30 +00001754See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00001755
wdenkc6097192002-11-03 00:24:07 +00001756
wdenk2729af92004-05-03 20:45:30 +00001757Monitor Commands - Overview:
1758============================
wdenkc6097192002-11-03 00:24:07 +00001759
wdenk2729af92004-05-03 20:45:30 +00001760go - start application at address 'addr'
1761run - run commands in an environment variable
1762bootm - boot application image from memory
1763bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00001764bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00001765tftpboot- boot image via network using TFTP protocol
1766 and env variables "ipaddr" and "serverip"
1767 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00001768tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00001769rarpboot- boot image via network using RARP/TFTP protocol
1770diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
1771loads - load S-Record file over serial line
1772loadb - load binary file over serial line (kermit mode)
Rui Miguel Silvabfef72e2022-05-11 10:55:40 +01001773loadm - load binary blob from source address to destination address
wdenk2729af92004-05-03 20:45:30 +00001774md - memory display
1775mm - memory modify (auto-incrementing)
1776nm - memory modify (constant address)
1777mw - memory write (fill)
Simon Glassbdded202020-06-02 19:26:49 -06001778ms - memory search
wdenk2729af92004-05-03 20:45:30 +00001779cp - memory copy
1780cmp - memory compare
1781crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05001782i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00001783sspi - SPI utility commands
1784base - print or set address offset
1785printenv- print environment variables
Pragnesh Patel9e9a5302020-12-22 11:30:05 +05301786pwm - control pwm channels
Linus Walleij41a29f22023-02-01 00:16:13 +01001787seama - load SEAMA NAND image
wdenk2729af92004-05-03 20:45:30 +00001788setenv - set environment variables
1789saveenv - save environment variables to persistent storage
1790protect - enable or disable FLASH write protection
1791erase - erase FLASH memory
1792flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00001793nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00001794bdinfo - print Board Info structure
1795iminfo - print header information for application image
1796coninfo - print console devices and informations
1797ide - IDE sub-system
1798loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00001799loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00001800mtest - simple RAM test
1801icache - enable or disable instruction cache
1802dcache - enable or disable data cache
1803reset - Perform RESET of the CPU
1804echo - echo args to console
1805version - print monitor version
1806help - print online help
1807? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00001808
wdenkc6097192002-11-03 00:24:07 +00001809
wdenk2729af92004-05-03 20:45:30 +00001810Monitor Commands - Detailed Description:
1811========================================
wdenkc6097192002-11-03 00:24:07 +00001812
wdenk2729af92004-05-03 20:45:30 +00001813TODO.
wdenkc6097192002-11-03 00:24:07 +00001814
wdenk2729af92004-05-03 20:45:30 +00001815For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00001816
1817
wdenk2729af92004-05-03 20:45:30 +00001818Note for Redundant Ethernet Interfaces:
1819=======================================
wdenkf07771c2003-05-28 08:06:31 +00001820
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001821Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00001822such configurations and is capable of automatic selection of a
1823"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00001824
wdenk2729af92004-05-03 20:45:30 +00001825Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
1826MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
1827"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00001828
wdenk2729af92004-05-03 20:45:30 +00001829If the network interface stores some valid MAC address (for instance
1830in SROM), this is used as default address if there is NO correspon-
1831ding setting in the environment; if the corresponding environment
1832variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00001833
wdenk2729af92004-05-03 20:45:30 +00001834o If the SROM has a valid MAC address, and there is no address in the
1835 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00001836
wdenk2729af92004-05-03 20:45:30 +00001837o If there is no valid address in the SROM, and a definition in the
1838 environment exists, then the value from the environment variable is
1839 used.
wdenkc6097192002-11-03 00:24:07 +00001840
wdenk2729af92004-05-03 20:45:30 +00001841o If both the SROM and the environment contain a MAC address, and
1842 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00001843
wdenk2729af92004-05-03 20:45:30 +00001844o If both the SROM and the environment contain a MAC address, and the
1845 addresses differ, the value from the environment is used and a
1846 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00001847
wdenk2729af92004-05-03 20:45:30 +00001848o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05001849 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
1850 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00001851
Ben Warrenecee9322010-04-26 11:11:46 -07001852If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001853will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07001854may be skipped by setting the appropriate 'ethmacskip' environment variable.
1855The naming convention is as follows:
1856"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00001857
wdenk2729af92004-05-03 20:45:30 +00001858Image Formats:
1859==============
wdenkc6097192002-11-03 00:24:07 +00001860
Marian Balakowicz3310c542008-03-12 12:13:13 +01001861U-Boot is capable of booting (and performing other auxiliary operations on)
1862images in two formats:
1863
1864New uImage format (FIT)
1865-----------------------
1866
1867Flexible and powerful format based on Flattened Image Tree -- FIT (similar
1868to Flattened Device Tree). It allows the use of images with multiple
1869components (several kernels, ramdisks, etc.), with contents protected by
1870SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
1871
1872
1873Old uImage format
1874-----------------
1875
1876Old image format is based on binary files which can be basically anything,
1877preceded by a special header; see the definitions in include/image.h for
1878details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00001879
wdenk2729af92004-05-03 20:45:30 +00001880* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
1881 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05001882 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
Thomas Huth0797e732021-11-13 18:13:50 +01001883 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
Andy Shevchenkodaab59a2017-07-05 16:25:22 +03001884* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
Tom Rini11232132022-04-06 09:21:25 -04001885 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
1886 Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00001887* Compression Type (uncompressed, gzip, bzip2)
1888* Load Address
1889* Entry Point
1890* Image Name
1891* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00001892
wdenk2729af92004-05-03 20:45:30 +00001893The header is marked by a special Magic Number, and both the header
1894and the data portions of the image are secured against corruption by
1895CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00001896
wdenkc6097192002-11-03 00:24:07 +00001897
wdenk2729af92004-05-03 20:45:30 +00001898Linux Support:
1899==============
wdenkc6097192002-11-03 00:24:07 +00001900
wdenk2729af92004-05-03 20:45:30 +00001901Although U-Boot should support any OS or standalone application
1902easily, the main focus has always been on Linux during the design of
1903U-Boot.
wdenkc6097192002-11-03 00:24:07 +00001904
wdenk2729af92004-05-03 20:45:30 +00001905U-Boot includes many features that so far have been part of some
1906special "boot loader" code within the Linux kernel. Also, any
1907"initrd" images to be used are no longer part of one big Linux image;
1908instead, kernel and "initrd" are separate images. This implementation
1909serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00001910
wdenk2729af92004-05-03 20:45:30 +00001911- the same features can be used for other OS or standalone
1912 applications (for instance: using compressed images to reduce the
1913 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00001914
wdenk2729af92004-05-03 20:45:30 +00001915- it becomes much easier to port new Linux kernel versions because
1916 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00001917
wdenk2729af92004-05-03 20:45:30 +00001918- the same Linux kernel image can now be used with different "initrd"
1919 images; of course this also means that different kernel images can
1920 be run with the same "initrd". This makes testing easier (you don't
1921 have to build a new "zImage.initrd" Linux image when you just
1922 change a file in your "initrd"). Also, a field-upgrade of the
1923 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00001924
wdenkc6097192002-11-03 00:24:07 +00001925
wdenk2729af92004-05-03 20:45:30 +00001926Linux HOWTO:
1927============
wdenkc6097192002-11-03 00:24:07 +00001928
wdenk2729af92004-05-03 20:45:30 +00001929Porting Linux to U-Boot based systems:
1930---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001931
wdenk2729af92004-05-03 20:45:30 +00001932U-Boot cannot save you from doing all the necessary modifications to
1933configure the Linux device drivers for use with your target hardware
1934(no, we don't intend to provide a full virtual machine interface to
1935Linux :-).
wdenkc6097192002-11-03 00:24:07 +00001936
Stefan Roesea47a12b2010-04-15 16:07:28 +02001937But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00001938
wdenk2729af92004-05-03 20:45:30 +00001939Just make sure your machine specific header file (for instance
1940include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02001941Information structure as we define in include/asm-<arch>/u-boot.h,
1942and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001943as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00001944
Simon Glass2eb31b12014-06-11 23:29:46 -06001945Note that U-Boot now has a driver model, a unified model for drivers.
1946If you are adding a new driver, plumb it into driver model. If there
1947is no uclass available, you are encouraged to create one. See
1948doc/driver-model.
1949
wdenkc6097192002-11-03 00:24:07 +00001950
wdenk2729af92004-05-03 20:45:30 +00001951Configuring the Linux kernel:
1952-----------------------------
wdenkc6097192002-11-03 00:24:07 +00001953
wdenk2729af92004-05-03 20:45:30 +00001954No specific requirements for U-Boot. Make sure you have some root
1955device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00001956
wdenkc6097192002-11-03 00:24:07 +00001957
wdenk2729af92004-05-03 20:45:30 +00001958Building a Linux Image:
1959-----------------------
wdenkc6097192002-11-03 00:24:07 +00001960
wdenk2729af92004-05-03 20:45:30 +00001961With U-Boot, "normal" build targets like "zImage" or "bzImage" are
1962not used. If you use recent kernel source, a new build target
1963"uImage" will exist which automatically builds an image usable by
1964U-Boot. Most older kernels also have support for a "pImage" target,
1965which was introduced for our predecessor project PPCBoot and uses a
1966100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00001967
wdenk2729af92004-05-03 20:45:30 +00001968Example:
wdenkc6097192002-11-03 00:24:07 +00001969
Holger Freytherab584d62014-08-04 09:26:05 +02001970 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00001971 make oldconfig
1972 make dep
1973 make uImage
wdenkc6097192002-11-03 00:24:07 +00001974
wdenk2729af92004-05-03 20:45:30 +00001975The "uImage" build target uses a special tool (in 'tools/mkimage') to
1976encapsulate a compressed Linux kernel image with header information,
1977CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00001978
wdenk2729af92004-05-03 20:45:30 +00001979* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00001980
wdenk2729af92004-05-03 20:45:30 +00001981* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00001982
wdenk2729af92004-05-03 20:45:30 +00001983 ${CROSS_COMPILE}-objcopy -O binary \
1984 -R .note -R .comment \
1985 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00001986
wdenk2729af92004-05-03 20:45:30 +00001987* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00001988
wdenk2729af92004-05-03 20:45:30 +00001989 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00001990
wdenk2729af92004-05-03 20:45:30 +00001991* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00001992
wdenk2729af92004-05-03 20:45:30 +00001993 mkimage -A ppc -O linux -T kernel -C gzip \
1994 -a 0 -e 0 -n "Linux Kernel Image" \
1995 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00001996
wdenk24ee89b2002-11-03 17:56:27 +00001997
wdenk2729af92004-05-03 20:45:30 +00001998The "mkimage" tool can also be used to create ramdisk images for use
1999with U-Boot, either separated from the Linux kernel image, or
2000combined into one file. "mkimage" encapsulates the images with a 64
2001byte header containing information about target architecture,
2002operating system, image type, compression method, entry points, time
2003stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002004
wdenk2729af92004-05-03 20:45:30 +00002005"mkimage" can be called in two ways: to verify existing images and
2006print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002007
wdenk2729af92004-05-03 20:45:30 +00002008In the first form (with "-l" option) mkimage lists the information
2009contained in the header of an existing U-Boot image; this includes
2010checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002011
wdenk2729af92004-05-03 20:45:30 +00002012 tools/mkimage -l image
2013 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002014
wdenk2729af92004-05-03 20:45:30 +00002015The second form (with "-d" option) is used to build a U-Boot image
2016from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002017
wdenk2729af92004-05-03 20:45:30 +00002018 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2019 -n name -d data_file image
2020 -A ==> set architecture to 'arch'
2021 -O ==> set operating system to 'os'
2022 -T ==> set image type to 'type'
2023 -C ==> set compression type 'comp'
2024 -a ==> set load address to 'addr' (hex)
2025 -e ==> set entry point to 'ep' (hex)
2026 -n ==> set image name to 'name'
2027 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002028
wdenk69459792004-05-29 16:53:29 +00002029Right now, all Linux kernels for PowerPC systems use the same load
2030address (0x00000000), but the entry point address depends on the
2031kernel version:
wdenkc6097192002-11-03 00:24:07 +00002032
wdenk2729af92004-05-03 20:45:30 +00002033- 2.2.x kernels have the entry point at 0x0000000C,
2034- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002035
wdenk2729af92004-05-03 20:45:30 +00002036So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002037
wdenk2729af92004-05-03 20:45:30 +00002038 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2039 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02002040 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00002041 > examples/uImage.TQM850L
2042 Image Name: 2.4.4 kernel for TQM850L
2043 Created: Wed Jul 19 02:34:59 2000
2044 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2045 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2046 Load Address: 0x00000000
2047 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002048
wdenk2729af92004-05-03 20:45:30 +00002049To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002050
wdenk2729af92004-05-03 20:45:30 +00002051 -> tools/mkimage -l examples/uImage.TQM850L
2052 Image Name: 2.4.4 kernel for TQM850L
2053 Created: Wed Jul 19 02:34:59 2000
2054 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2055 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2056 Load Address: 0x00000000
2057 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002058
wdenk2729af92004-05-03 20:45:30 +00002059NOTE: for embedded systems where boot time is critical you can trade
2060speed for memory and install an UNCOMPRESSED image instead: this
2061needs more space in Flash, but boots much faster since it does not
2062need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002063
Stefan Roesea47a12b2010-04-15 16:07:28 +02002064 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00002065 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2066 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02002067 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00002068 > examples/uImage.TQM850L-uncompressed
2069 Image Name: 2.4.4 kernel for TQM850L
2070 Created: Wed Jul 19 02:34:59 2000
2071 Image Type: PowerPC Linux Kernel Image (uncompressed)
2072 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2073 Load Address: 0x00000000
2074 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002075
wdenkc6097192002-11-03 00:24:07 +00002076
wdenk2729af92004-05-03 20:45:30 +00002077Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2078when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002079
wdenk2729af92004-05-03 20:45:30 +00002080 -> tools/mkimage -n 'Simple Ramdisk Image' \
2081 > -A ppc -O linux -T ramdisk -C gzip \
2082 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2083 Image Name: Simple Ramdisk Image
2084 Created: Wed Jan 12 14:01:50 2000
2085 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2086 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2087 Load Address: 0x00000000
2088 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002089
Tyler Hickse157a112020-10-26 10:40:24 -05002090The "dumpimage" tool can be used to disassemble or list the contents of images
2091built by mkimage. See dumpimage's help output (-h) for details.
wdenkdb01a2e2004-04-15 23:14:49 +00002092
wdenk2729af92004-05-03 20:45:30 +00002093Installing a Linux Image:
2094-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002095
wdenk2729af92004-05-03 20:45:30 +00002096To downloading a U-Boot image over the serial (console) interface,
2097you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002098
wdenk2729af92004-05-03 20:45:30 +00002099 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002100
wdenk2729af92004-05-03 20:45:30 +00002101The 'objcopy' does not understand the information in the U-Boot
2102image header, so the resulting S-Record file will be relative to
2103address 0x00000000. To load it to a given address, you need to
2104specify the target address as 'offset' parameter with the 'loads'
2105command.
wdenkc6097192002-11-03 00:24:07 +00002106
wdenk2729af92004-05-03 20:45:30 +00002107Example: install the image to address 0x40100000 (which on the
2108TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002109
wdenk2729af92004-05-03 20:45:30 +00002110 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002111
wdenk2729af92004-05-03 20:45:30 +00002112 .......... done
2113 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002114
wdenk2729af92004-05-03 20:45:30 +00002115 => loads 40100000
2116 ## Ready for S-Record download ...
2117 ~>examples/image.srec
2118 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2119 ...
2120 15989 15990 15991 15992
2121 [file transfer complete]
2122 [connected]
2123 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002124
2125
wdenk2729af92004-05-03 20:45:30 +00002126You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01002127this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00002128corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002129
wdenk2729af92004-05-03 20:45:30 +00002130 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002131
wdenk2729af92004-05-03 20:45:30 +00002132 ## Checking Image at 40100000 ...
2133 Image Name: 2.2.13 for initrd on TQM850L
2134 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2135 Data Size: 335725 Bytes = 327 kB = 0 MB
2136 Load Address: 00000000
2137 Entry Point: 0000000c
2138 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002139
2140
wdenk2729af92004-05-03 20:45:30 +00002141Boot Linux:
2142-----------
wdenkc6097192002-11-03 00:24:07 +00002143
wdenk2729af92004-05-03 20:45:30 +00002144The "bootm" command is used to boot an application that is stored in
2145memory (RAM or Flash). In case of a Linux kernel image, the contents
2146of the "bootargs" environment variable is passed to the kernel as
2147parameters. You can check and modify this variable using the
2148"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002149
2150
wdenk2729af92004-05-03 20:45:30 +00002151 => printenv bootargs
2152 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002153
wdenk2729af92004-05-03 20:45:30 +00002154 => 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 +00002155
wdenk2729af92004-05-03 20:45:30 +00002156 => printenv bootargs
2157 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 +00002158
wdenk2729af92004-05-03 20:45:30 +00002159 => bootm 40020000
2160 ## Booting Linux kernel at 40020000 ...
2161 Image Name: 2.2.13 for NFS on TQM850L
2162 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2163 Data Size: 381681 Bytes = 372 kB = 0 MB
2164 Load Address: 00000000
2165 Entry Point: 0000000c
2166 Verifying Checksum ... OK
2167 Uncompressing Kernel Image ... OK
2168 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
2169 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2170 time_init: decrementer frequency = 187500000/60
2171 Calibrating delay loop... 49.77 BogoMIPS
2172 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2173 ...
wdenkc6097192002-11-03 00:24:07 +00002174
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002175If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00002176the memory addresses of both the kernel and the initrd image (PPBCOOT
2177format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00002178
wdenk2729af92004-05-03 20:45:30 +00002179 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00002180
wdenk2729af92004-05-03 20:45:30 +00002181 ## Checking Image at 40100000 ...
2182 Image Name: 2.2.13 for initrd on TQM850L
2183 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2184 Data Size: 335725 Bytes = 327 kB = 0 MB
2185 Load Address: 00000000
2186 Entry Point: 0000000c
2187 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002188
wdenk2729af92004-05-03 20:45:30 +00002189 ## Checking Image at 40200000 ...
2190 Image Name: Simple Ramdisk Image
2191 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2192 Data Size: 566530 Bytes = 553 kB = 0 MB
2193 Load Address: 00000000
2194 Entry Point: 00000000
2195 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002196
wdenk2729af92004-05-03 20:45:30 +00002197 => bootm 40100000 40200000
2198 ## Booting Linux kernel at 40100000 ...
2199 Image Name: 2.2.13 for initrd on TQM850L
2200 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2201 Data Size: 335725 Bytes = 327 kB = 0 MB
2202 Load Address: 00000000
2203 Entry Point: 0000000c
2204 Verifying Checksum ... OK
2205 Uncompressing Kernel Image ... OK
2206 ## Loading RAMDisk Image at 40200000 ...
2207 Image Name: Simple Ramdisk Image
2208 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2209 Data Size: 566530 Bytes = 553 kB = 0 MB
2210 Load Address: 00000000
2211 Entry Point: 00000000
2212 Verifying Checksum ... OK
2213 Loading Ramdisk ... OK
2214 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
2215 Boot arguments: root=/dev/ram
2216 time_init: decrementer frequency = 187500000/60
2217 Calibrating delay loop... 49.77 BogoMIPS
2218 ...
2219 RAMDISK: Compressed image found at block 0
2220 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00002221
wdenk2729af92004-05-03 20:45:30 +00002222 bash#
wdenkc6097192002-11-03 00:24:07 +00002223
Matthew McClintock02677682006-06-28 10:41:37 -05002224Boot Linux and pass a flat device tree:
2225-----------
2226
2227First, U-Boot must be compiled with the appropriate defines. See the section
2228titled "Linux Kernel Interface" above for a more in depth explanation. The
2229following is an example of how to start a kernel and pass an updated
2230flat device tree:
2231
2232=> print oftaddr
2233oftaddr=0x300000
2234=> print oft
2235oft=oftrees/mpc8540ads.dtb
2236=> tftp $oftaddr $oft
2237Speed: 1000, full duplex
2238Using TSEC0 device
2239TFTP from server 192.168.1.1; our IP address is 192.168.1.101
2240Filename 'oftrees/mpc8540ads.dtb'.
2241Load address: 0x300000
2242Loading: #
2243done
2244Bytes transferred = 4106 (100a hex)
2245=> tftp $loadaddr $bootfile
2246Speed: 1000, full duplex
2247Using TSEC0 device
2248TFTP from server 192.168.1.1; our IP address is 192.168.1.2
2249Filename 'uImage'.
2250Load address: 0x200000
2251Loading:############
2252done
2253Bytes transferred = 1029407 (fb51f hex)
2254=> print loadaddr
2255loadaddr=200000
2256=> print oftaddr
2257oftaddr=0x300000
2258=> bootm $loadaddr - $oftaddr
2259## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01002260 Image Name: Linux-2.6.17-dirty
2261 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2262 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05002263 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01002264 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05002265 Verifying Checksum ... OK
2266 Uncompressing Kernel Image ... OK
2267Booting using flat device tree at 0x300000
2268Using MPC85xx ADS machine description
2269Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
2270[snip]
2271
2272
wdenk2729af92004-05-03 20:45:30 +00002273More About U-Boot Image Types:
2274------------------------------
wdenk6069ff22003-02-28 00:49:47 +00002275
wdenk2729af92004-05-03 20:45:30 +00002276U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00002277
wdenk2729af92004-05-03 20:45:30 +00002278 "Standalone Programs" are directly runnable in the environment
2279 provided by U-Boot; it is expected that (if they behave
2280 well) you can continue to work in U-Boot after return from
2281 the Standalone Program.
2282 "OS Kernel Images" are usually images of some Embedded OS which
2283 will take over control completely. Usually these programs
2284 will install their own set of exception handlers, device
2285 drivers, set up the MMU, etc. - this means, that you cannot
2286 expect to re-enter U-Boot except by resetting the CPU.
2287 "RAMDisk Images" are more or less just data blocks, and their
2288 parameters (address, size) are passed to an OS kernel that is
2289 being started.
2290 "Multi-File Images" contain several images, typically an OS
2291 (Linux) kernel image and one or more data images like
2292 RAMDisks. This construct is useful for instance when you want
2293 to boot over the network using BOOTP etc., where the boot
2294 server provides just a single image file, but you want to get
2295 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00002296
wdenk2729af92004-05-03 20:45:30 +00002297 "Multi-File Images" start with a list of image sizes, each
2298 image size (in bytes) specified by an "uint32_t" in network
2299 byte order. This list is terminated by an "(uint32_t)0".
2300 Immediately after the terminating 0 follow the images, one by
2301 one, all aligned on "uint32_t" boundaries (size rounded up to
2302 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00002303
wdenk2729af92004-05-03 20:45:30 +00002304 "Firmware Images" are binary images containing firmware (like
2305 U-Boot or FPGA images) which usually will be programmed to
2306 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00002307
wdenk2729af92004-05-03 20:45:30 +00002308 "Script files" are command sequences that will be executed by
2309 U-Boot's command interpreter; this feature is especially
2310 useful when you configure U-Boot to use a real shell (hush)
2311 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00002312
Marek Vasut44f074c2012-03-14 21:52:45 +00002313Booting the Linux zImage:
2314-------------------------
2315
2316On some platforms, it's possible to boot Linux zImage. This is done
2317using the "bootz" command. The syntax of "bootz" command is the same
2318as the syntax of "bootm" command.
2319
Tom Rini8ac28562013-05-16 11:40:11 -04002320Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00002321kernel with raw initrd images. The syntax is slightly different, the
2322address of the initrd must be augmented by it's size, in the following
2323format: "<initrd addres>:<initrd size>".
2324
wdenkc6097192002-11-03 00:24:07 +00002325
wdenk2729af92004-05-03 20:45:30 +00002326Standalone HOWTO:
2327=================
wdenkc6097192002-11-03 00:24:07 +00002328
wdenk2729af92004-05-03 20:45:30 +00002329One of the features of U-Boot is that you can dynamically load and
2330run "standalone" applications, which can use some resources of
2331U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00002332
wdenk2729af92004-05-03 20:45:30 +00002333Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00002334
wdenk2729af92004-05-03 20:45:30 +00002335"Hello World" Demo:
2336-------------------
wdenkc6097192002-11-03 00:24:07 +00002337
wdenk2729af92004-05-03 20:45:30 +00002338'examples/hello_world.c' contains a small "Hello World" Demo
2339application; it is automatically compiled when you build U-Boot.
2340It's configured to run at address 0x00040004, so you can play with it
2341like that:
wdenkc6097192002-11-03 00:24:07 +00002342
wdenk2729af92004-05-03 20:45:30 +00002343 => loads
2344 ## Ready for S-Record download ...
2345 ~>examples/hello_world.srec
2346 1 2 3 4 5 6 7 8 9 10 11 ...
2347 [file transfer complete]
2348 [connected]
2349 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002350
wdenk2729af92004-05-03 20:45:30 +00002351 => go 40004 Hello World! This is a test.
2352 ## Starting application at 0x00040004 ...
2353 Hello World
2354 argc = 7
2355 argv[0] = "40004"
2356 argv[1] = "Hello"
2357 argv[2] = "World!"
2358 argv[3] = "This"
2359 argv[4] = "is"
2360 argv[5] = "a"
2361 argv[6] = "test."
2362 argv[7] = "<NULL>"
2363 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00002364
wdenk2729af92004-05-03 20:45:30 +00002365 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00002366
wdenk2729af92004-05-03 20:45:30 +00002367Another example, which demonstrates how to register a CPM interrupt
2368handler with the U-Boot code, can be found in 'examples/timer.c'.
2369Here, a CPM timer is set up to generate an interrupt every second.
2370The interrupt service routine is trivial, just printing a '.'
2371character, but this is just a demo program. The application can be
2372controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00002373
wdenk2729af92004-05-03 20:45:30 +00002374 ? - print current values og the CPM Timer registers
2375 b - enable interrupts and start timer
2376 e - stop timer and disable interrupts
2377 q - quit application
wdenkc6097192002-11-03 00:24:07 +00002378
wdenk2729af92004-05-03 20:45:30 +00002379 => loads
2380 ## Ready for S-Record download ...
2381 ~>examples/timer.srec
2382 1 2 3 4 5 6 7 8 9 10 11 ...
2383 [file transfer complete]
2384 [connected]
2385 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002386
wdenk2729af92004-05-03 20:45:30 +00002387 => go 40004
2388 ## Starting application at 0x00040004 ...
2389 TIMERS=0xfff00980
2390 Using timer 1
2391 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00002392
wdenk2729af92004-05-03 20:45:30 +00002393Hit 'b':
2394 [q, b, e, ?] Set interval 1000000 us
2395 Enabling timer
2396Hit '?':
2397 [q, b, e, ?] ........
2398 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2399Hit '?':
2400 [q, b, e, ?] .
2401 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2402Hit '?':
2403 [q, b, e, ?] .
2404 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2405Hit '?':
2406 [q, b, e, ?] .
2407 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2408Hit 'e':
2409 [q, b, e, ?] ...Stopping timer
2410Hit 'q':
2411 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00002412
2413
wdenk2729af92004-05-03 20:45:30 +00002414Implementation Internals:
2415=========================
wdenkc6097192002-11-03 00:24:07 +00002416
wdenk2729af92004-05-03 20:45:30 +00002417The following is not intended to be a complete description of every
2418implementation detail. However, it should help to understand the
2419inner workings of U-Boot and make it easier to port it to custom
2420hardware.
wdenkc6097192002-11-03 00:24:07 +00002421
2422
wdenk2729af92004-05-03 20:45:30 +00002423Initial Stack, Global Data:
2424---------------------------
wdenkc6097192002-11-03 00:24:07 +00002425
wdenk2729af92004-05-03 20:45:30 +00002426The implementation of U-Boot is complicated by the fact that U-Boot
2427starts running out of ROM (flash memory), usually without access to
2428system RAM (because the memory controller is not initialized yet).
2429This means that we don't have writable Data or BSS segments, and BSS
2430is not initialized as zero. To be able to get a C environment working
2431at all, we have to allocate at least a minimal stack. Implementation
2432options for this are defined and restricted by the CPU used: Some CPU
2433models provide on-chip memory (like the IMMR area on MPC8xx and
2434MPC826x processors), on others (parts of) the data cache can be
2435locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00002436
Wolfgang Denk218ca722008-03-26 10:40:12 +01002437 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01002438 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00002439
wdenk2729af92004-05-03 20:45:30 +00002440 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
2441 From: "Chris Hallinan" <clh@net1plus.com>
2442 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
2443 ...
wdenk43d96162003-03-06 00:02:04 +00002444
wdenk2729af92004-05-03 20:45:30 +00002445 Correct me if I'm wrong, folks, but the way I understand it
2446 is this: Using DCACHE as initial RAM for Stack, etc, does not
2447 require any physical RAM backing up the cache. The cleverness
2448 is that the cache is being used as a temporary supply of
2449 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002450 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00002451 can see how this works by studying the cache architecture and
2452 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00002453
wdenk2729af92004-05-03 20:45:30 +00002454 OCM is On Chip Memory, which I believe the 405GP has 4K. It
2455 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002456 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00002457 option should work for you. Using CS 4 should be fine if your
2458 board designers haven't used it for something that would
2459 cause you grief during the initial boot! It is frequently not
2460 used.
wdenk43d96162003-03-06 00:02:04 +00002461
Tom Rini65cc0e22022-11-16 13:10:41 -05002462 CFG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00002463 with your processor/board/system design. The default value
2464 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02002465 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00002466 than your SDRAM module. If you have a 64MB SDRAM module, set
2467 it above 400_0000. Just make sure your board has no resources
2468 that are supposed to respond to that address! That code in
2469 start.S has been around a while and should work as is when
2470 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00002471
wdenk2729af92004-05-03 20:45:30 +00002472 -Chris Hallinan
2473 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00002474
wdenk2729af92004-05-03 20:45:30 +00002475It is essential to remember this, since it has some impact on the C
2476code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00002477
wdenk2729af92004-05-03 20:45:30 +00002478* Initialized global data (data segment) is read-only. Do not attempt
2479 to write it.
wdenkc6097192002-11-03 00:24:07 +00002480
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002481* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00002482 as zero data - BSS segment) at all - this is undefined, initiali-
2483 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00002484
wdenk2729af92004-05-03 20:45:30 +00002485* Stack space is very limited. Avoid big data buffers or things like
2486 that.
wdenkc6097192002-11-03 00:24:07 +00002487
wdenk2729af92004-05-03 20:45:30 +00002488Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002489normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00002490turned out that the implementation of U-Boot can be greatly
2491simplified by making a global data structure (gd_t) available to all
2492functions. We could pass a pointer to this data as argument to _all_
2493functions, but this would bloat the code. Instead we use a feature of
2494the GCC compiler (Global Register Variables) to share the data: we
2495place a pointer (gd) to the global data into a register which we
2496reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00002497
wdenk2729af92004-05-03 20:45:30 +00002498When choosing a register for such a purpose we are restricted by the
2499relevant (E)ABI specifications for the current architecture, and by
2500GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00002501
wdenk2729af92004-05-03 20:45:30 +00002502For PowerPC, the following registers have specific use:
2503 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01002504 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00002505 R3-R4: parameter passing and return values
2506 R5-R10: parameter passing
2507 R13: small data area pointer
2508 R30: GOT pointer
2509 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00002510
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01002511 (U-Boot also uses R12 as internal GOT pointer. r12
2512 is a volatile register so r12 needs to be reset when
2513 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00002514
Wolfgang Denke7670f62008-02-14 22:43:22 +01002515 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00002516
wdenk2729af92004-05-03 20:45:30 +00002517 Note: on PPC, we could use a static initializer (since the
2518 address of the global data structure is known at compile time),
2519 but it turned out that reserving a register results in somewhat
2520 smaller code - although the code savings are not that big (on
2521 average for all boards 752 bytes for the whole U-Boot image,
2522 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00002523
wdenk2729af92004-05-03 20:45:30 +00002524On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00002525
wdenk2729af92004-05-03 20:45:30 +00002526 R0: function argument word/integer result
2527 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02002528 R9: platform specific
2529 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00002530 R11: argument (frame) pointer
2531 R12: temporary workspace
2532 R13: stack pointer
2533 R14: link register
2534 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00002535
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02002536 ==> U-Boot will use R9 to hold a pointer to the global data
2537
2538 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00002539
Thomas Chou0df01fd32010-05-21 11:08:03 +08002540On Nios II, the ABI is documented here:
Naoki Hayama047f6ec2020-10-08 13:17:16 +09002541 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
Thomas Chou0df01fd32010-05-21 11:08:03 +08002542
2543 ==> U-Boot will use gp to hold a pointer to the global data
2544
2545 Note: on Nios II, we give "-G0" option to gcc and don't use gp
2546 to access small data sections, so gp is free.
2547
Rick Chen3fafced2017-12-26 13:55:59 +08002548On RISC-V, the following registers are used:
2549
2550 x0: hard-wired zero (zero)
2551 x1: return address (ra)
2552 x2: stack pointer (sp)
2553 x3: global pointer (gp)
2554 x4: thread pointer (tp)
2555 x5: link register (t0)
2556 x8: frame pointer (fp)
2557 x10-x11: arguments/return values (a0-1)
2558 x12-x17: arguments (a2-7)
2559 x28-31: temporaries (t3-6)
2560 pc: program counter (pc)
2561
2562 ==> U-Boot will use gp to hold a pointer to the global data
2563
wdenk2729af92004-05-03 20:45:30 +00002564Memory Management:
2565------------------
wdenkc6097192002-11-03 00:24:07 +00002566
wdenk2729af92004-05-03 20:45:30 +00002567U-Boot runs in system state and uses physical addresses, i.e. the
2568MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00002569
wdenk2729af92004-05-03 20:45:30 +00002570The available memory is mapped to fixed addresses using the memory
2571controller. In this process, a contiguous block is formed for each
2572memory type (Flash, SDRAM, SRAM), even when it consists of several
2573physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00002574
wdenk2729af92004-05-03 20:45:30 +00002575U-Boot is installed in the first 128 kB of the first Flash bank (on
2576TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
2577booting and sizing and initializing DRAM, the code relocates itself
2578to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002579memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00002580configuration setting]. Below that, a structure with global Board
2581Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00002582
wdenk2729af92004-05-03 20:45:30 +00002583Additionally, some exception handler code is copied to the low 8 kB
2584of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00002585
wdenk2729af92004-05-03 20:45:30 +00002586So a typical memory configuration with 16 MB of DRAM could look like
2587this:
wdenkc6097192002-11-03 00:24:07 +00002588
wdenk2729af92004-05-03 20:45:30 +00002589 0x0000 0000 Exception Vector code
2590 :
2591 0x0000 1FFF
2592 0x0000 2000 Free for Application Use
2593 :
2594 :
wdenkc6097192002-11-03 00:24:07 +00002595
wdenk2729af92004-05-03 20:45:30 +00002596 :
2597 :
2598 0x00FB FF20 Monitor Stack (Growing downward)
2599 0x00FB FFAC Board Info Data and permanent copy of global data
2600 0x00FC 0000 Malloc Arena
2601 :
2602 0x00FD FFFF
2603 0x00FE 0000 RAM Copy of Monitor Code
2604 ... eventually: LCD or video framebuffer
2605 ... eventually: pRAM (Protected RAM - unchanged by reset)
2606 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00002607
2608
wdenk2729af92004-05-03 20:45:30 +00002609System Initialization:
2610----------------------
wdenkc6097192002-11-03 00:24:07 +00002611
wdenk2729af92004-05-03 20:45:30 +00002612In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002613(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002614configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00002615To be able to re-map memory U-Boot then jumps to its link address.
2616To be able to implement the initialization code in C, a (small!)
2617initial stack is set up in the internal Dual Ported RAM (in case CPUs
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002618which provide such a feature like), or in a locked part of the data
2619cache. After that, U-Boot initializes the CPU core, the caches and
2620the SIU.
wdenkc6097192002-11-03 00:24:07 +00002621
wdenk2729af92004-05-03 20:45:30 +00002622Next, all (potentially) available memory banks are mapped using a
2623preliminary mapping. For example, we put them on 512 MB boundaries
2624(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
2625on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
2626programmed for SDRAM access. Using the temporary configuration, a
2627simple memory test is run that determines the size of the SDRAM
2628banks.
wdenkc6097192002-11-03 00:24:07 +00002629
wdenk2729af92004-05-03 20:45:30 +00002630When there is more than one SDRAM bank, and the banks are of
2631different size, the largest is mapped first. For equal size, the first
2632bank (CS2#) is mapped first. The first mapping is always for address
26330x00000000, with any additional banks following immediately to create
2634contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00002635
wdenk2729af92004-05-03 20:45:30 +00002636Then, the monitor installs itself at the upper end of the SDRAM area
2637and allocates memory for use by malloc() and for the global Board
2638Info data; also, the exception vector code is copied to the low RAM
2639pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00002640
wdenk2729af92004-05-03 20:45:30 +00002641Only after this relocation will you have a "normal" C environment;
2642until that you are restricted in several ways, mostly because you are
2643running from ROM, and because the code will have to be relocated to a
2644new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00002645
2646
Heinrich Schuchardt1405bfd2023-01-25 19:14:57 +01002647Contributing
2648============
wdenkc6097192002-11-03 00:24:07 +00002649
Heinrich Schuchardt1405bfd2023-01-25 19:14:57 +01002650The U-Boot projects depends on contributions from the user community.
2651If you want to participate, please, have a look at the 'General'
Simon Glass4c4977c2023-11-19 08:36:00 -07002652section of https://docs.u-boot.org/en/latest/develop/index.html
Heinrich Schuchardt1405bfd2023-01-25 19:14:57 +01002653where we describe coding standards and the patch submission process.