Merge branch '2021-12-27-CONFIG-migrations' into next
[platform/kernel/u-boot.git] / README
1 # SPDX-License-Identifier: GPL-2.0+
2 #
3 # (C) Copyright 2000 - 2013
4 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5
6 Summary:
7 ========
8
9 This directory contains the source code for U-Boot, a boot loader for
10 Embedded boards based on PowerPC, ARM, MIPS and several other
11 processors, which can be installed in a boot ROM and used to
12 initialize and test the hardware or to download and run application
13 code.
14
15 The development of U-Boot is closely related to Linux: some parts of
16 the source code originate in the Linux source tree, we have some
17 header files in common, and special provision has been made to
18 support booting of Linux images.
19
20 Some attention has been paid to make this software easily
21 configurable and extendable. For instance, all monitor commands are
22 implemented with the same call interface, so that it's very easy to
23 add new commands. Also, instead of permanently adding rarely used
24 code (for instance hardware test utilities) to the monitor, you can
25 load and run it dynamically.
26
27
28 Status:
29 =======
30
31 In general, all boards for which a configuration option exists in the
32 Makefile have been tested to some extent and can be considered
33 "working". In fact, many of them are used in production systems.
34
35 In case of problems see the CHANGELOG file to find out who contributed
36 the specific port. In addition, there are various MAINTAINERS files
37 scattered throughout the U-Boot source identifying the people or
38 companies responsible for various boards and subsystems.
39
40 Note: As of August, 2010, there is no longer a CHANGELOG file in the
41 actual U-Boot source tree; however, it can be created dynamically
42 from the Git log using:
43
44         make CHANGELOG
45
46
47 Where to get help:
48 ==================
49
50 In case you have questions about, problems with or contributions for
51 U-Boot, you should send a message to the U-Boot mailing list at
52 <u-boot@lists.denx.de>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's.
54 Please see https://lists.denx.de/pipermail/u-boot and
55 https://marc.info/?l=u-boot
56
57 Where to get source code:
58 =========================
59
60 The U-Boot source code is maintained in the Git repository at
61 https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62 https://source.denx.de/u-boot/u-boot
63
64 The "Tags" links on this page allow you to download tarballs of
65 any version you might be interested in. Official releases are also
66 available from the DENX file server through HTTPS or FTP.
67 https://ftp.denx.de/pub/u-boot/
68 ftp://ftp.denx.de/pub/u-boot/
69
70
71 Where we come from:
72 ===================
73
74 - start from 8xxrom sources
75 - create PPCBoot project (https://sourceforge.net/projects/ppcboot)
76 - clean up code
77 - make it easier to add custom boards
78 - make it possible to add other [PowerPC] CPUs
79 - extend functions, especially:
80   * Provide extended interface to Linux boot loader
81   * S-Record download
82   * network boot
83   * ATA disk / SCSI ... boot
84 - create ARMBoot project (https://sourceforge.net/projects/armboot)
85 - add other CPU families (starting with ARM)
86 - create U-Boot project (https://sourceforge.net/projects/u-boot)
87 - current project page: see https://www.denx.de/wiki/U-Boot
88
89
90 Names and Spelling:
91 ===================
92
93 The "official" name of this project is "Das U-Boot". The spelling
94 "U-Boot" shall be used in all written text (documentation, comments
95 in source files etc.). Example:
96
97         This is the README file for the U-Boot project.
98
99 File names etc. shall be based on the string "u-boot". Examples:
100
101         include/asm-ppc/u-boot.h
102
103         #include <asm/u-boot.h>
104
105 Variable names, preprocessor constants etc. shall be either based on
106 the string "u_boot" or on "U_BOOT". Example:
107
108         U_BOOT_VERSION          u_boot_logo
109         IH_OS_U_BOOT            u_boot_hush_start
110
111
112 Versioning:
113 ===========
114
115 Starting with the release in October 2008, the names of the releases
116 were changed from numerical release numbers without deeper meaning
117 into a time stamp based numbering. Regular releases are identified by
118 names consisting of the calendar year and month of the release date.
119 Additional fields (if present) indicate release candidates or bug fix
120 releases in "stable" maintenance trees.
121
122 Examples:
123         U-Boot v2009.11     - Release November 2009
124         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
125         U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
126
127
128 Directory Hierarchy:
129 ====================
130
131 /arch                   Architecture-specific files
132   /arc                  Files generic to ARC architecture
133   /arm                  Files generic to ARM architecture
134   /m68k                 Files generic to m68k architecture
135   /microblaze           Files generic to microblaze architecture
136   /mips                 Files generic to MIPS architecture
137   /nds32                Files generic to NDS32 architecture
138   /nios2                Files generic to Altera NIOS2 architecture
139   /powerpc              Files generic to PowerPC architecture
140   /riscv                Files generic to RISC-V architecture
141   /sandbox              Files generic to HW-independent "sandbox"
142   /sh                   Files generic to SH architecture
143   /x86                  Files generic to x86 architecture
144   /xtensa               Files generic to Xtensa architecture
145 /api                    Machine/arch-independent API for external apps
146 /board                  Board-dependent files
147 /boot                   Support for images and booting
148 /cmd                    U-Boot commands functions
149 /common                 Misc architecture-independent functions
150 /configs                Board default configuration files
151 /disk                   Code for disk drive partition handling
152 /doc                    Documentation (a mix of ReST and READMEs)
153 /drivers                Device drivers
154 /dts                    Makefile for building internal U-Boot fdt.
155 /env                    Environment support
156 /examples               Example code for standalone applications, etc.
157 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
158 /include                Header Files
159 /lib                    Library routines generic to all architectures
160 /Licenses               Various license files
161 /net                    Networking code
162 /post                   Power On Self Test
163 /scripts                Various build scripts and Makefiles
164 /test                   Various unit test files
165 /tools                  Tools to build and sign FIT images, etc.
166
167 Software Configuration:
168 =======================
169
170 Configuration is usually done using C preprocessor defines; the
171 rationale behind that is to avoid dead code whenever possible.
172
173 There are two classes of configuration variables:
174
175 * Configuration _OPTIONS_:
176   These are selectable by the user and have names beginning with
177   "CONFIG_".
178
179 * Configuration _SETTINGS_:
180   These depend on the hardware etc. and should not be meddled with if
181   you don't know what you're doing; they have names beginning with
182   "CONFIG_SYS_".
183
184 Previously, all configuration was done by hand, which involved creating
185 symbolic links and editing configuration files manually. More recently,
186 U-Boot has added the Kbuild infrastructure used by the Linux kernel,
187 allowing you to use the "make menuconfig" command to configure your
188 build.
189
190
191 Selection of Processor Architecture and Board Type:
192 ---------------------------------------------------
193
194 For all supported boards there are ready-to-use default
195 configurations available; just type "make <board_name>_defconfig".
196
197 Example: For a TQM823L module type:
198
199         cd u-boot
200         make TQM823L_defconfig
201
202 Note: If you're looking for the default configuration file for a board
203 you're sure used to be there but is now missing, check the file
204 doc/README.scrapyard for a list of no longer supported boards.
205
206 Sandbox Environment:
207 --------------------
208
209 U-Boot can be built natively to run on a Linux host using the 'sandbox'
210 board. This allows feature development which is not board- or architecture-
211 specific to be undertaken on a native platform. The sandbox is also used to
212 run some of U-Boot's tests.
213
214 See doc/arch/sandbox.rst for more details.
215
216
217 Board Initialisation Flow:
218 --------------------------
219
220 This is the intended start-up flow for boards. This should apply for both
221 SPL and U-Boot proper (i.e. they both follow the same rules).
222
223 Note: "SPL" stands for "Secondary Program Loader," which is explained in
224 more detail later in this file.
225
226 At present, SPL mostly uses a separate code path, but the function names
227 and roles of each function are the same. Some boards or architectures
228 may not conform to this.  At least most ARM boards which use
229 CONFIG_SPL_FRAMEWORK conform to this.
230
231 Execution typically starts with an architecture-specific (and possibly
232 CPU-specific) start.S file, such as:
233
234         - arch/arm/cpu/armv7/start.S
235         - arch/powerpc/cpu/mpc83xx/start.S
236         - arch/mips/cpu/start.S
237
238 and so on. From there, three functions are called; the purpose and
239 limitations of each of these functions are described below.
240
241 lowlevel_init():
242         - purpose: essential init to permit execution to reach board_init_f()
243         - no global_data or BSS
244         - there is no stack (ARMv7 may have one but it will soon be removed)
245         - must not set up SDRAM or use console
246         - must only do the bare minimum to allow execution to continue to
247                 board_init_f()
248         - this is almost never needed
249         - return normally from this function
250
251 board_init_f():
252         - purpose: set up the machine ready for running board_init_r():
253                 i.e. SDRAM and serial UART
254         - global_data is available
255         - stack is in SRAM
256         - BSS is not available, so you cannot use global/static variables,
257                 only stack variables and global_data
258
259         Non-SPL-specific notes:
260         - dram_init() is called to set up DRAM. If already done in SPL this
261                 can do nothing
262
263         SPL-specific notes:
264         - you can override the entire board_init_f() function with your own
265                 version as needed.
266         - preloader_console_init() can be called here in extremis
267         - should set up SDRAM, and anything needed to make the UART work
268         - there is no need to clear BSS, it will be done by crt0.S
269         - for specific scenarios on certain architectures an early BSS *can*
270           be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
271           of BSS prior to entering board_init_f()) but doing so is discouraged.
272           Instead it is strongly recommended to architect any code changes
273           or additions such to not depend on the availability of BSS during
274           board_init_f() as indicated in other sections of this README to
275           maintain compatibility and consistency across the entire code base.
276         - must return normally from this function (don't call board_init_r()
277                 directly)
278
279 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
280 this point the stack and global_data are relocated to below
281 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
282 memory.
283
284 board_init_r():
285         - purpose: main execution, common code
286         - global_data is available
287         - SDRAM is available
288         - BSS is available, all static/global variables can be used
289         - execution eventually continues to main_loop()
290
291         Non-SPL-specific notes:
292         - U-Boot is relocated to the top of memory and is now running from
293                 there.
294
295         SPL-specific notes:
296         - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
297                 CONFIG_SPL_STACK_R_ADDR points into SDRAM
298         - preloader_console_init() can be called here - typically this is
299                 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
300                 spl_board_init() function containing this call
301         - loads U-Boot or (in falcon mode) Linux
302
303
304 Configuration Options:
305 ----------------------
306
307 Configuration depends on the combination of board and CPU type; all
308 such information is kept in a configuration file
309 "include/configs/<board_name>.h".
310
311 Example: For a TQM823L module, all configuration settings are in
312 "include/configs/TQM823L.h".
313
314
315 Many of the options are named exactly as the corresponding Linux
316 kernel configuration options. The intention is to make it easier to
317 build a config tool - later.
318
319 - ARM Platform Bus Type(CCI):
320                 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
321                 provides full cache coherency between two clusters of multi-core
322                 CPUs and I/O coherency for devices and I/O masters
323
324                 CONFIG_SYS_FSL_HAS_CCI400
325
326                 Defined For SoC that has cache coherent interconnect
327                 CCN-400
328
329                 CONFIG_SYS_FSL_HAS_CCN504
330
331                 Defined for SoC that has cache coherent interconnect CCN-504
332
333 The following options need to be configured:
334
335 - CPU Type:     Define exactly one, e.g. CONFIG_MPC85XX.
336
337 - Board Type:   Define exactly one, e.g. CONFIG_MPC8540ADS.
338
339 - 85xx CPU Options:
340                 CONFIG_SYS_PPC64
341
342                 Specifies that the core is a 64-bit PowerPC implementation (implements
343                 the "64" category of the Power ISA). This is necessary for ePAPR
344                 compliance, among other possible reasons.
345
346                 CONFIG_SYS_FSL_TBCLK_DIV
347
348                 Defines the core time base clock divider ratio compared to the
349                 system clock.  On most PQ3 devices this is 8, on newer QorIQ
350                 devices it can be 16 or 32.  The ratio varies from SoC to Soc.
351
352                 CONFIG_SYS_FSL_PCIE_COMPAT
353
354                 Defines the string to utilize when trying to match PCIe device
355                 tree nodes for the given platform.
356
357                 CONFIG_SYS_FSL_ERRATUM_A004510
358
359                 Enables a workaround for erratum A004510.  If set,
360                 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
362
363                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
365
366                 Defines one or two SoC revisions (low 8 bits of SVR)
367                 for which the A004510 workaround should be applied.
368
369                 The rest of SVR is either not relevant to the decision
370                 of whether the erratum is present (e.g. p2040 versus
371                 p2041) or is implied by the build target, which controls
372                 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
373
374                 See Freescale App Note 4493 for more information about
375                 this erratum.
376
377                 CONFIG_A003399_NOR_WORKAROUND
378                 Enables a workaround for IFC erratum A003399. It is only
379                 required during NOR boot.
380
381                 CONFIG_A008044_WORKAROUND
382                 Enables a workaround for T1040/T1042 erratum A008044. It is only
383                 required during NAND boot and valid for Rev 1.0 SoC revision
384
385                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
386
387                 This is the value to write into CCSR offset 0x18600
388                 according to the A004510 workaround.
389
390                 CONFIG_SYS_FSL_DSP_DDR_ADDR
391                 This value denotes start offset of DDR memory which is
392                 connected exclusively to the DSP cores.
393
394                 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
395                 This value denotes start offset of M2 memory
396                 which is directly connected to the DSP core.
397
398                 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
399                 This value denotes start offset of M3 memory which is directly
400                 connected to the DSP core.
401
402                 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
403                 This value denotes start offset of DSP CCSR space.
404
405                 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
406                 Single Source Clock is clocking mode present in some of FSL SoC's.
407                 In this mode, a single differential clock is used to supply
408                 clocks to the sysclock, ddrclock and usbclock.
409
410                 CONFIG_SYS_CPC_REINIT_F
411                 This CONFIG is defined when the CPC is configured as SRAM at the
412                 time of U-Boot entry and is required to be re-initialized.
413
414                 CONFIG_DEEP_SLEEP
415                 Indicates this SoC supports deep sleep feature. If deep sleep is
416                 supported, core will start to execute uboot when wakes up.
417
418 - Generic CPU options:
419                 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
420
421                 Defines the endianess of the CPU. Implementation of those
422                 values is arch specific.
423
424                 CONFIG_SYS_FSL_DDR
425                 Freescale DDR driver in use. This type of DDR controller is
426                 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
427
428                 CONFIG_SYS_FSL_DDR_ADDR
429                 Freescale DDR memory-mapped register base.
430
431                 CONFIG_SYS_FSL_DDR_EMU
432                 Specify emulator support for DDR. Some DDR features such as
433                 deskew training are not available.
434
435                 CONFIG_SYS_FSL_DDRC_GEN1
436                 Freescale DDR1 controller.
437
438                 CONFIG_SYS_FSL_DDRC_GEN2
439                 Freescale DDR2 controller.
440
441                 CONFIG_SYS_FSL_DDRC_GEN3
442                 Freescale DDR3 controller.
443
444                 CONFIG_SYS_FSL_DDRC_GEN4
445                 Freescale DDR4 controller.
446
447                 CONFIG_SYS_FSL_DDRC_ARM_GEN3
448                 Freescale DDR3 controller for ARM-based SoCs.
449
450                 CONFIG_SYS_FSL_DDR1
451                 Board config to use DDR1. It can be enabled for SoCs with
452                 Freescale DDR1 or DDR2 controllers, depending on the board
453                 implemetation.
454
455                 CONFIG_SYS_FSL_DDR2
456                 Board config to use DDR2. It can be enabled for SoCs with
457                 Freescale DDR2 or DDR3 controllers, depending on the board
458                 implementation.
459
460                 CONFIG_SYS_FSL_DDR3
461                 Board config to use DDR3. It can be enabled for SoCs with
462                 Freescale DDR3 or DDR3L controllers.
463
464                 CONFIG_SYS_FSL_DDR3L
465                 Board config to use DDR3L. It can be enabled for SoCs with
466                 DDR3L controllers.
467
468                 CONFIG_SYS_FSL_IFC_BE
469                 Defines the IFC controller register space as Big Endian
470
471                 CONFIG_SYS_FSL_IFC_LE
472                 Defines the IFC controller register space as Little Endian
473
474                 CONFIG_SYS_FSL_IFC_CLK_DIV
475                 Defines divider of platform clock(clock input to IFC controller).
476
477                 CONFIG_SYS_FSL_LBC_CLK_DIV
478                 Defines divider of platform clock(clock input to eLBC controller).
479
480                 CONFIG_SYS_FSL_DDR_BE
481                 Defines the DDR controller register space as Big Endian
482
483                 CONFIG_SYS_FSL_DDR_LE
484                 Defines the DDR controller register space as Little Endian
485
486                 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
487                 Physical address from the view of DDR controllers. It is the
488                 same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
489                 it could be different for ARM SoCs.
490
491                 CONFIG_SYS_FSL_DDR_INTLV_256B
492                 DDR controller interleaving on 256-byte. This is a special
493                 interleaving mode, handled by Dickens for Freescale layerscape
494                 SoCs with ARM core.
495
496                 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
497                 Number of controllers used as main memory.
498
499                 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
500                 Number of controllers used for other than main memory.
501
502                 CONFIG_SYS_FSL_HAS_DP_DDR
503                 Defines the SoC has DP-DDR used for DPAA.
504
505                 CONFIG_SYS_FSL_SEC_BE
506                 Defines the SEC controller register space as Big Endian
507
508                 CONFIG_SYS_FSL_SEC_LE
509                 Defines the SEC controller register space as Little Endian
510
511 - MIPS CPU options:
512                 CONFIG_SYS_INIT_SP_OFFSET
513
514                 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
515                 pointer. This is needed for the temporary stack before
516                 relocation.
517
518                 CONFIG_XWAY_SWAP_BYTES
519
520                 Enable compilation of tools/xway-swap-bytes needed for Lantiq
521                 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
522                 be swapped if a flash programmer is used.
523
524 - ARM options:
525                 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
526
527                 Select high exception vectors of the ARM core, e.g., do not
528                 clear the V bit of the c1 register of CP15.
529
530                 COUNTER_FREQUENCY
531                 Generic timer clock source frequency.
532
533                 COUNTER_FREQUENCY_REAL
534                 Generic timer clock source frequency if the real clock is
535                 different from COUNTER_FREQUENCY, and can only be determined
536                 at run time.
537
538 - Tegra SoC options:
539                 CONFIG_TEGRA_SUPPORT_NON_SECURE
540
541                 Support executing U-Boot in non-secure (NS) mode. Certain
542                 impossible actions will be skipped if the CPU is in NS mode,
543                 such as ARM architectural timer initialization.
544
545 - Linux Kernel Interface:
546                 CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
547
548                 When transferring memsize parameter to Linux, some versions
549                 expect it to be in bytes, others in MB.
550                 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
551
552                 CONFIG_OF_LIBFDT
553
554                 New kernel versions are expecting firmware settings to be
555                 passed using flattened device trees (based on open firmware
556                 concepts).
557
558                 CONFIG_OF_LIBFDT
559                  * New libfdt-based support
560                  * Adds the "fdt" command
561                  * The bootm command automatically updates the fdt
562
563                 OF_TBCLK - The timebase frequency.
564
565                 boards with QUICC Engines require OF_QE to set UCC MAC
566                 addresses
567
568                 CONFIG_OF_SYSTEM_SETUP
569
570                 Other code has addition modification that it wants to make
571                 to the flat device tree before handing it off to the kernel.
572                 This causes ft_system_setup() to be called before booting
573                 the kernel.
574
575                 CONFIG_OF_IDE_FIXUP
576
577                 U-Boot can detect if an IDE device is present or not.
578                 If not, and this new config option is activated, U-Boot
579                 removes the ATA node from the DTS before booting Linux,
580                 so the Linux IDE driver does not probe the device and
581                 crash. This is needed for buggy hardware (uc101) where
582                 no pull down resistor is connected to the signal IDE5V_DD7.
583
584 - vxWorks boot parameters:
585
586                 bootvx constructs a valid bootline using the following
587                 environments variables: bootdev, bootfile, ipaddr, netmask,
588                 serverip, gatewayip, hostname, othbootargs.
589                 It loads the vxWorks image pointed bootfile.
590
591                 Note: If a "bootargs" environment is defined, it will override
592                 the defaults discussed just above.
593
594 - Cache Configuration for ARM:
595                 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
596                                       controller
597                 CONFIG_SYS_PL310_BASE - Physical base address of PL310
598                                         controller register space
599
600 - Serial Ports:
601                 CONFIG_PL011_CLOCK
602
603                 If you have Amba PrimeCell PL011 UARTs, set this variable to
604                 the clock speed of the UARTs.
605
606                 CONFIG_PL01x_PORTS
607
608                 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
609                 define this to a list of base addresses for each (supported)
610                 port. See e.g. include/configs/versatile.h
611
612                 CONFIG_SERIAL_HW_FLOW_CONTROL
613
614                 Define this variable to enable hw flow control in serial driver.
615                 Current user of this option is drivers/serial/nsl16550.c driver
616
617 - Serial Download Echo Mode:
618                 CONFIG_LOADS_ECHO
619                 If defined to 1, all characters received during a
620                 serial download (using the "loads" command) are
621                 echoed back. This might be needed by some terminal
622                 emulations (like "cu"), but may as well just take
623                 time on others. This setting #define's the initial
624                 value of the "loads_echo" environment variable.
625
626 - Removal of commands
627                 If no commands are needed to boot, you can disable
628                 CONFIG_CMDLINE to remove them. In this case, the command line
629                 will not be available, and when U-Boot wants to execute the
630                 boot command (on start-up) it will call board_run_command()
631                 instead. This can reduce image size significantly for very
632                 simple boot procedures.
633
634 - Regular expression support:
635                 CONFIG_REGEX
636                 If this variable is defined, U-Boot is linked against
637                 the SLRE (Super Light Regular Expression) library,
638                 which adds regex support to some commands, as for
639                 example "env grep" and "setexpr".
640
641 - Watchdog:
642                 CONFIG_SYS_WATCHDOG_FREQ
643                 Some platforms automatically call WATCHDOG_RESET()
644                 from the timer interrupt handler every
645                 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
646                 board configuration file, a default of CONFIG_SYS_HZ/2
647                 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
648                 to 0 disables calling WATCHDOG_RESET() from the timer
649                 interrupt.
650
651 - Real-Time Clock:
652
653                 When CONFIG_CMD_DATE is selected, the type of the RTC
654                 has to be selected, too. Define exactly one of the
655                 following options:
656
657                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
658                 CONFIG_RTC_MC13XXX      - use MC13783 or MC13892 RTC
659                 CONFIG_RTC_MC146818     - use MC146818 RTC
660                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
661                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
662                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
663                 CONFIG_RTC_DS1339       - use Maxim, Inc. DS1339 RTC
664                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
665                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
666                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
667                 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
668                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
669                                           RV3029 RTC.
670
671                 Note that if the RTC uses I2C, then the I2C interface
672                 must also be configured. See I2C Support, below.
673
674 - GPIO Support:
675                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
676
677                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
678                 chip-ngpio pairs that tell the PCA953X driver the number of
679                 pins supported by a particular chip.
680
681                 Note that if the GPIO device uses I2C, then the I2C interface
682                 must also be configured. See I2C Support, below.
683
684 - I/O tracing:
685                 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
686                 accesses and can checksum them or write a list of them out
687                 to memory. See the 'iotrace' command for details. This is
688                 useful for testing device drivers since it can confirm that
689                 the driver behaves the same way before and after a code
690                 change. Currently this is supported on sandbox and arm. To
691                 add support for your architecture, add '#include <iotrace.h>'
692                 to the bottom of arch/<arch>/include/asm/io.h and test.
693
694                 Example output from the 'iotrace stats' command is below.
695                 Note that if the trace buffer is exhausted, the checksum will
696                 still continue to operate.
697
698                         iotrace is enabled
699                         Start:  10000000        (buffer start address)
700                         Size:   00010000        (buffer size)
701                         Offset: 00000120        (current buffer offset)
702                         Output: 10000120        (start + offset)
703                         Count:  00000018        (number of trace records)
704                         CRC32:  9526fb66        (CRC32 of all trace records)
705
706 - Timestamp Support:
707
708                 When CONFIG_TIMESTAMP is selected, the timestamp
709                 (date and time) of an image is printed by image
710                 commands like bootm or iminfo. This option is
711                 automatically enabled when you select CONFIG_CMD_DATE .
712
713 - Partition Labels (disklabels) Supported:
714                 Zero or more of the following:
715                 CONFIG_MAC_PARTITION   Apple's MacOS partition table.
716                 CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
717                 CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
718                                        bootloader.  Note 2TB partition limit; see
719                                        disk/part_efi.c
720                 CONFIG_SCSI) you must configure support for at
721                 least one non-MTD partition type as well.
722
723 - IDE Reset method:
724                 CONFIG_IDE_RESET - is this is defined, IDE Reset will
725                 be performed by calling the function
726                         ide_set_reset(int reset)
727                 which has to be defined in a board specific file
728
729 - ATAPI Support:
730                 CONFIG_ATAPI
731
732                 Set this to enable ATAPI support.
733
734 - LBA48 Support
735                 CONFIG_LBA48
736
737                 Set this to enable support for disks larger than 137GB
738                 Also look at CONFIG_SYS_64BIT_LBA.
739                 Whithout these , LBA48 support uses 32bit variables and will 'only'
740                 support disks up to 2.1TB.
741
742                 CONFIG_SYS_64BIT_LBA:
743                         When enabled, makes the IDE subsystem use 64bit sector addresses.
744                         Default is 32bit.
745
746 - SCSI Support:
747                 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
748                 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
749                 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
750                 maximum numbers of LUNs, SCSI ID's and target
751                 devices.
752
753                 The environment variable 'scsidevs' is set to the number of
754                 SCSI devices found during the last scan.
755
756 - NETWORK Support (PCI):
757                 CONFIG_E1000_SPI
758                 Utility code for direct access to the SPI bus on Intel 8257x.
759                 This does not do anything useful unless you set at least one
760                 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
761
762                 CONFIG_NATSEMI
763                 Support for National dp83815 chips.
764
765                 CONFIG_NS8382X
766                 Support for National dp8382[01] gigabit chips.
767
768 - NETWORK Support (other):
769                 CONFIG_CALXEDA_XGMAC
770                 Support for the Calxeda XGMAC device
771
772                 CONFIG_LAN91C96
773                 Support for SMSC's LAN91C96 chips.
774
775                         CONFIG_LAN91C96_USE_32_BIT
776                         Define this to enable 32 bit addressing
777
778                 CONFIG_SMC91111
779                 Support for SMSC's LAN91C111 chip
780
781                         CONFIG_SMC91111_BASE
782                         Define this to hold the physical address
783                         of the device (I/O space)
784
785                         CONFIG_SMC_USE_32_BIT
786                         Define this if data bus is 32 bits
787
788                         CONFIG_SMC_USE_IOFUNCS
789                         Define this to use i/o functions instead of macros
790                         (some hardware wont work with macros)
791
792                         CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
793                         Define this if you have more then 3 PHYs.
794
795                 CONFIG_FTGMAC100
796                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
797
798                         CONFIG_FTGMAC100_EGIGA
799                         Define this to use GE link update with gigabit PHY.
800                         Define this if FTGMAC100 is connected to gigabit PHY.
801                         If your system has 10/100 PHY only, it might not occur
802                         wrong behavior. Because PHY usually return timeout or
803                         useless data when polling gigabit status and gigabit
804                         control registers. This behavior won't affect the
805                         correctnessof 10/100 link speed update.
806
807                 CONFIG_SH_ETHER
808                 Support for Renesas on-chip Ethernet controller
809
810                         CONFIG_SH_ETHER_USE_PORT
811                         Define the number of ports to be used
812
813                         CONFIG_SH_ETHER_PHY_ADDR
814                         Define the ETH PHY's address
815
816                         CONFIG_SH_ETHER_CACHE_WRITEBACK
817                         If this option is set, the driver enables cache flush.
818
819 - TPM Support:
820                 CONFIG_TPM
821                 Support TPM devices.
822
823                 CONFIG_TPM_TIS_INFINEON
824                 Support for Infineon i2c bus TPM devices. Only one device
825                 per system is supported at this time.
826
827                         CONFIG_TPM_TIS_I2C_BURST_LIMITATION
828                         Define the burst count bytes upper limit
829
830                 CONFIG_TPM_ST33ZP24
831                 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
832
833                         CONFIG_TPM_ST33ZP24_I2C
834                         Support for STMicroelectronics ST33ZP24 I2C devices.
835                         Requires TPM_ST33ZP24 and I2C.
836
837                         CONFIG_TPM_ST33ZP24_SPI
838                         Support for STMicroelectronics ST33ZP24 SPI devices.
839                         Requires TPM_ST33ZP24 and SPI.
840
841                 CONFIG_TPM_ATMEL_TWI
842                 Support for Atmel TWI TPM device. Requires I2C support.
843
844                 CONFIG_TPM_TIS_LPC
845                 Support for generic parallel port TPM devices. Only one device
846                 per system is supported at this time.
847
848                         CONFIG_TPM_TIS_BASE_ADDRESS
849                         Base address where the generic TPM device is mapped
850                         to. Contemporary x86 systems usually map it at
851                         0xfed40000.
852
853                 CONFIG_TPM
854                 Define this to enable the TPM support library which provides
855                 functional interfaces to some TPM commands.
856                 Requires support for a TPM device.
857
858                 CONFIG_TPM_AUTH_SESSIONS
859                 Define this to enable authorized functions in the TPM library.
860                 Requires CONFIG_TPM and CONFIG_SHA1.
861
862 - USB Support:
863                 At the moment only the UHCI host controller is
864                 supported (PIP405, MIP405); define
865                 CONFIG_USB_UHCI to enable it.
866                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
867                 and define CONFIG_USB_STORAGE to enable the USB
868                 storage devices.
869                 Note:
870                 Supported are USB Keyboards and USB Floppy drives
871                 (TEAC FD-05PUB).
872
873                 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
874                 txfilltuning field in the EHCI controller on reset.
875
876                 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
877                 HW module registers.
878
879 - USB Device:
880                 Define the below if you wish to use the USB console.
881                 Once firmware is rebuilt from a serial console issue the
882                 command "setenv stdin usbtty; setenv stdout usbtty" and
883                 attach your USB cable. The Unix command "dmesg" should print
884                 it has found a new device. The environment variable usbtty
885                 can be set to gserial or cdc_acm to enable your device to
886                 appear to a USB host as a Linux gserial device or a
887                 Common Device Class Abstract Control Model serial device.
888                 If you select usbtty = gserial you should be able to enumerate
889                 a Linux host by
890                 # modprobe usbserial vendor=0xVendorID product=0xProductID
891                 else if using cdc_acm, simply setting the environment
892                 variable usbtty to be cdc_acm should suffice. The following
893                 might be defined in YourBoardName.h
894
895                         CONFIG_USB_DEVICE
896                         Define this to build a UDC device
897
898                         CONFIG_USB_TTY
899                         Define this to have a tty type of device available to
900                         talk to the UDC device
901
902                         CONFIG_USBD_HS
903                         Define this to enable the high speed support for usb
904                         device and usbtty. If this feature is enabled, a routine
905                         int is_usbd_high_speed(void)
906                         also needs to be defined by the driver to dynamically poll
907                         whether the enumeration has succeded at high speed or full
908                         speed.
909
910                 If you have a USB-IF assigned VendorID then you may wish to
911                 define your own vendor specific values either in BoardName.h
912                 or directly in usbd_vendor_info.h. If you don't define
913                 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
914                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
915                 should pretend to be a Linux device to it's target host.
916
917                         CONFIG_USBD_MANUFACTURER
918                         Define this string as the name of your company for
919                         - CONFIG_USBD_MANUFACTURER "my company"
920
921                         CONFIG_USBD_PRODUCT_NAME
922                         Define this string as the name of your product
923                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
924
925                         CONFIG_USBD_VENDORID
926                         Define this as your assigned Vendor ID from the USB
927                         Implementors Forum. This *must* be a genuine Vendor ID
928                         to avoid polluting the USB namespace.
929                         - CONFIG_USBD_VENDORID 0xFFFF
930
931                         CONFIG_USBD_PRODUCTID
932                         Define this as the unique Product ID
933                         for your device
934                         - CONFIG_USBD_PRODUCTID 0xFFFF
935
936 - ULPI Layer Support:
937                 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
938                 the generic ULPI layer. The generic layer accesses the ULPI PHY
939                 via the platform viewport, so you need both the genric layer and
940                 the viewport enabled. Currently only Chipidea/ARC based
941                 viewport is supported.
942                 To enable the ULPI layer support, define CONFIG_USB_ULPI and
943                 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
944                 If your ULPI phy needs a different reference clock than the
945                 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
946                 the appropriate value in Hz.
947
948 - MMC Support:
949                 The MMC controller on the Intel PXA is supported. To
950                 enable this define CONFIG_MMC. The MMC can be
951                 accessed from the boot prompt by mapping the device
952                 to physical memory similar to flash. Command line is
953                 enabled with CONFIG_CMD_MMC. The MMC driver also works with
954                 the FAT fs. This is enabled with CONFIG_CMD_FAT.
955
956                 CONFIG_SH_MMCIF
957                 Support for Renesas on-chip MMCIF controller
958
959                         CONFIG_SH_MMCIF_ADDR
960                         Define the base address of MMCIF registers
961
962                         CONFIG_SH_MMCIF_CLK
963                         Define the clock frequency for MMCIF
964
965 - USB Device Firmware Update (DFU) class support:
966                 CONFIG_DFU_OVER_USB
967                 This enables the USB portion of the DFU USB class
968
969                 CONFIG_DFU_NAND
970                 This enables support for exposing NAND devices via DFU.
971
972                 CONFIG_DFU_RAM
973                 This enables support for exposing RAM via DFU.
974                 Note: DFU spec refer to non-volatile memory usage, but
975                 allow usages beyond the scope of spec - here RAM usage,
976                 one that would help mostly the developer.
977
978                 CONFIG_SYS_DFU_DATA_BUF_SIZE
979                 Dfu transfer uses a buffer before writing data to the
980                 raw storage device. Make the size (in bytes) of this buffer
981                 configurable. The size of this buffer is also configurable
982                 through the "dfu_bufsiz" environment variable.
983
984                 CONFIG_SYS_DFU_MAX_FILE_SIZE
985                 When updating files rather than the raw storage device,
986                 we use a static buffer to copy the file into and then write
987                 the buffer once we've been given the whole file.  Define
988                 this to the maximum filesize (in bytes) for the buffer.
989                 Default is 4 MiB if undefined.
990
991                 DFU_DEFAULT_POLL_TIMEOUT
992                 Poll timeout [ms], is the timeout a device can send to the
993                 host. The host must wait for this timeout before sending
994                 a subsequent DFU_GET_STATUS request to the device.
995
996                 DFU_MANIFEST_POLL_TIMEOUT
997                 Poll timeout [ms], which the device sends to the host when
998                 entering dfuMANIFEST state. Host waits this timeout, before
999                 sending again an USB request to the device.
1000
1001 - Journaling Flash filesystem support:
1002                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1003                 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1004                 Define these for a default partition on a NOR device
1005
1006 - Keyboard Support:
1007                 See Kconfig help for available keyboard drivers.
1008
1009 - Video support:
1010                 CONFIG_FSL_DIU_FB
1011                 Enable the Freescale DIU video driver.  Reference boards for
1012                 SOCs that have a DIU should define this macro to enable DIU
1013                 support, and should also define these other macros:
1014
1015                         CONFIG_SYS_DIU_ADDR
1016                         CONFIG_VIDEO
1017                         CONFIG_CFB_CONSOLE
1018                         CONFIG_VIDEO_SW_CURSOR
1019                         CONFIG_VGA_AS_SINGLE_DEVICE
1020                         CONFIG_VIDEO_LOGO
1021                         CONFIG_VIDEO_BMP_LOGO
1022
1023                 The DIU driver will look for the 'video-mode' environment
1024                 variable, and if defined, enable the DIU as a console during
1025                 boot.  See the documentation file doc/README.video for a
1026                 description of this variable.
1027
1028 - LCD Support:  CONFIG_LCD
1029
1030                 Define this to enable LCD support (for output to LCD
1031                 display); also select one of the supported displays
1032                 by defining one of these:
1033
1034                 CONFIG_ATMEL_LCD:
1035
1036                         HITACHI TX09D70VM1CCA, 3.5", 240x320.
1037
1038                 CONFIG_NEC_NL6448AC33:
1039
1040                         NEC NL6448AC33-18. Active, color, single scan.
1041
1042                 CONFIG_NEC_NL6448BC20
1043
1044                         NEC NL6448BC20-08. 6.5", 640x480.
1045                         Active, color, single scan.
1046
1047                 CONFIG_NEC_NL6448BC33_54
1048
1049                         NEC NL6448BC33-54. 10.4", 640x480.
1050                         Active, color, single scan.
1051
1052                 CONFIG_SHARP_16x9
1053
1054                         Sharp 320x240. Active, color, single scan.
1055                         It isn't 16x9, and I am not sure what it is.
1056
1057                 CONFIG_SHARP_LQ64D341
1058
1059                         Sharp LQ64D341 display, 640x480.
1060                         Active, color, single scan.
1061
1062                 CONFIG_HLD1045
1063
1064                         HLD1045 display, 640x480.
1065                         Active, color, single scan.
1066
1067                 CONFIG_OPTREX_BW
1068
1069                         Optrex   CBL50840-2 NF-FW 99 22 M5
1070                         or
1071                         Hitachi  LMG6912RPFC-00T
1072                         or
1073                         Hitachi  SP14Q002
1074
1075                         320x240. Black & white.
1076
1077                 CONFIG_LCD_ALIGNMENT
1078
1079                 Normally the LCD is page-aligned (typically 4KB). If this is
1080                 defined then the LCD will be aligned to this value instead.
1081                 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1082                 here, since it is cheaper to change data cache settings on
1083                 a per-section basis.
1084
1085
1086                 CONFIG_LCD_ROTATION
1087
1088                 Sometimes, for example if the display is mounted in portrait
1089                 mode or even if it's mounted landscape but rotated by 180degree,
1090                 we need to rotate our content of the display relative to the
1091                 framebuffer, so that user can read the messages which are
1092                 printed out.
1093                 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1094                 initialized with a given rotation from "vl_rot" out of
1095                 "vidinfo_t" which is provided by the board specific code.
1096                 The value for vl_rot is coded as following (matching to
1097                 fbcon=rotate:<n> linux-kernel commandline):
1098                 0 = no rotation respectively 0 degree
1099                 1 = 90 degree rotation
1100                 2 = 180 degree rotation
1101                 3 = 270 degree rotation
1102
1103                 If CONFIG_LCD_ROTATION is not defined, the console will be
1104                 initialized with 0degree rotation.
1105
1106                 CONFIG_LCD_BMP_RLE8
1107
1108                 Support drawing of RLE8-compressed bitmaps on the LCD.
1109
1110 - MII/PHY support:
1111                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1112
1113                 The clock frequency of the MII bus
1114
1115                 CONFIG_PHY_RESET_DELAY
1116
1117                 Some PHY like Intel LXT971A need extra delay after
1118                 reset before any MII register access is possible.
1119                 For such PHY, set this option to the usec delay
1120                 required. (minimum 300usec for LXT971A)
1121
1122                 CONFIG_PHY_CMD_DELAY (ppc4xx)
1123
1124                 Some PHY like Intel LXT971A need extra delay after
1125                 command issued before MII status register can be read
1126
1127 - IP address:
1128                 CONFIG_IPADDR
1129
1130                 Define a default value for the IP address to use for
1131                 the default Ethernet interface, in case this is not
1132                 determined through e.g. bootp.
1133                 (Environment variable "ipaddr")
1134
1135 - Server IP address:
1136                 CONFIG_SERVERIP
1137
1138                 Defines a default value for the IP address of a TFTP
1139                 server to contact when using the "tftboot" command.
1140                 (Environment variable "serverip")
1141
1142                 CONFIG_KEEP_SERVERADDR
1143
1144                 Keeps the server's MAC address, in the env 'serveraddr'
1145                 for passing to bootargs (like Linux's netconsole option)
1146
1147 - Gateway IP address:
1148                 CONFIG_GATEWAYIP
1149
1150                 Defines a default value for the IP address of the
1151                 default router where packets to other networks are
1152                 sent to.
1153                 (Environment variable "gatewayip")
1154
1155 - Subnet mask:
1156                 CONFIG_NETMASK
1157
1158                 Defines a default value for the subnet mask (or
1159                 routing prefix) which is used to determine if an IP
1160                 address belongs to the local subnet or needs to be
1161                 forwarded through a router.
1162                 (Environment variable "netmask")
1163
1164 - BOOTP Recovery Mode:
1165                 CONFIG_BOOTP_RANDOM_DELAY
1166
1167                 If you have many targets in a network that try to
1168                 boot using BOOTP, you may want to avoid that all
1169                 systems send out BOOTP requests at precisely the same
1170                 moment (which would happen for instance at recovery
1171                 from a power failure, when all systems will try to
1172                 boot, thus flooding the BOOTP server. Defining
1173                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1174                 inserted before sending out BOOTP requests. The
1175                 following delays are inserted then:
1176
1177                 1st BOOTP request:      delay 0 ... 1 sec
1178                 2nd BOOTP request:      delay 0 ... 2 sec
1179                 3rd BOOTP request:      delay 0 ... 4 sec
1180                 4th and following
1181                 BOOTP requests:         delay 0 ... 8 sec
1182
1183                 CONFIG_BOOTP_ID_CACHE_SIZE
1184
1185                 BOOTP packets are uniquely identified using a 32-bit ID. The
1186                 server will copy the ID from client requests to responses and
1187                 U-Boot will use this to determine if it is the destination of
1188                 an incoming response. Some servers will check that addresses
1189                 aren't in use before handing them out (usually using an ARP
1190                 ping) and therefore take up to a few hundred milliseconds to
1191                 respond. Network congestion may also influence the time it
1192                 takes for a response to make it back to the client. If that
1193                 time is too long, U-Boot will retransmit requests. In order
1194                 to allow earlier responses to still be accepted after these
1195                 retransmissions, U-Boot's BOOTP client keeps a small cache of
1196                 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1197                 cache. The default is to keep IDs for up to four outstanding
1198                 requests. Increasing this will allow U-Boot to accept offers
1199                 from a BOOTP client in networks with unusually high latency.
1200
1201 - DHCP Advanced Options:
1202                 You can fine tune the DHCP functionality by defining
1203                 CONFIG_BOOTP_* symbols:
1204
1205                 CONFIG_BOOTP_NISDOMAIN
1206                 CONFIG_BOOTP_BOOTFILESIZE
1207                 CONFIG_BOOTP_NTPSERVER
1208                 CONFIG_BOOTP_TIMEOFFSET
1209                 CONFIG_BOOTP_VENDOREX
1210                 CONFIG_BOOTP_MAY_FAIL
1211
1212                 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1213                 environment variable, not the BOOTP server.
1214
1215                 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1216                 after the configured retry count, the call will fail
1217                 instead of starting over.  This can be used to fail over
1218                 to Link-local IP address configuration if the DHCP server
1219                 is not available.
1220
1221                 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1222
1223                 A 32bit value in microseconds for a delay between
1224                 receiving a "DHCP Offer" and sending the "DHCP Request".
1225                 This fixes a problem with certain DHCP servers that don't
1226                 respond 100% of the time to a "DHCP request". E.g. On an
1227                 AT91RM9200 processor running at 180MHz, this delay needed
1228                 to be *at least* 15,000 usec before a Windows Server 2003
1229                 DHCP server would reply 100% of the time. I recommend at
1230                 least 50,000 usec to be safe. The alternative is to hope
1231                 that one of the retries will be successful but note that
1232                 the DHCP timeout and retry process takes a longer than
1233                 this delay.
1234
1235  - Link-local IP address negotiation:
1236                 Negotiate with other link-local clients on the local network
1237                 for an address that doesn't require explicit configuration.
1238                 This is especially useful if a DHCP server cannot be guaranteed
1239                 to exist in all environments that the device must operate.
1240
1241                 See doc/README.link-local for more information.
1242
1243  - MAC address from environment variables
1244
1245                 FDT_SEQ_MACADDR_FROM_ENV
1246
1247                 Fix-up device tree with MAC addresses fetched sequentially from
1248                 environment variables. This config work on assumption that
1249                 non-usable ethernet node of device-tree are either not present
1250                 or their status has been marked as "disabled".
1251
1252  - CDP Options:
1253                 CONFIG_CDP_DEVICE_ID
1254
1255                 The device id used in CDP trigger frames.
1256
1257                 CONFIG_CDP_DEVICE_ID_PREFIX
1258
1259                 A two character string which is prefixed to the MAC address
1260                 of the device.
1261
1262                 CONFIG_CDP_PORT_ID
1263
1264                 A printf format string which contains the ascii name of
1265                 the port. Normally is set to "eth%d" which sets
1266                 eth0 for the first Ethernet, eth1 for the second etc.
1267
1268                 CONFIG_CDP_CAPABILITIES
1269
1270                 A 32bit integer which indicates the device capabilities;
1271                 0x00000010 for a normal host which does not forwards.
1272
1273                 CONFIG_CDP_VERSION
1274
1275                 An ascii string containing the version of the software.
1276
1277                 CONFIG_CDP_PLATFORM
1278
1279                 An ascii string containing the name of the platform.
1280
1281                 CONFIG_CDP_TRIGGER
1282
1283                 A 32bit integer sent on the trigger.
1284
1285                 CONFIG_CDP_POWER_CONSUMPTION
1286
1287                 A 16bit integer containing the power consumption of the
1288                 device in .1 of milliwatts.
1289
1290                 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1291
1292                 A byte containing the id of the VLAN.
1293
1294 - Status LED:   CONFIG_LED_STATUS
1295
1296                 Several configurations allow to display the current
1297                 status using a LED. For instance, the LED will blink
1298                 fast while running U-Boot code, stop blinking as
1299                 soon as a reply to a BOOTP request was received, and
1300                 start blinking slow once the Linux kernel is running
1301                 (supported by a status LED driver in the Linux
1302                 kernel). Defining CONFIG_LED_STATUS enables this
1303                 feature in U-Boot.
1304
1305                 Additional options:
1306
1307                 CONFIG_LED_STATUS_GPIO
1308                 The status LED can be connected to a GPIO pin.
1309                 In such cases, the gpio_led driver can be used as a
1310                 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1311                 to include the gpio_led driver in the U-Boot binary.
1312
1313                 CONFIG_GPIO_LED_INVERTED_TABLE
1314                 Some GPIO connected LEDs may have inverted polarity in which
1315                 case the GPIO high value corresponds to LED off state and
1316                 GPIO low value corresponds to LED on state.
1317                 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1318                 with a list of GPIO LEDs that have inverted polarity.
1319
1320 - I2C Support:
1321                 CONFIG_SYS_NUM_I2C_BUSES
1322                 Hold the number of i2c buses you want to use.
1323
1324                 CONFIG_SYS_I2C_DIRECT_BUS
1325                 define this, if you don't use i2c muxes on your hardware.
1326                 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1327                 omit this define.
1328
1329                 CONFIG_SYS_I2C_MAX_HOPS
1330                 define how many muxes are maximal consecutively connected
1331                 on one i2c bus. If you not use i2c muxes, omit this
1332                 define.
1333
1334                 CONFIG_SYS_I2C_BUSES
1335                 hold a list of buses you want to use, only used if
1336                 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1337                 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1338                 CONFIG_SYS_NUM_I2C_BUSES = 9:
1339
1340                  CONFIG_SYS_I2C_BUSES   {{0, {I2C_NULL_HOP}}, \
1341                                         {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1342                                         {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1343                                         {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1344                                         {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1345                                         {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1346                                         {1, {I2C_NULL_HOP}}, \
1347                                         {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1348                                         {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1349                                         }
1350
1351                 which defines
1352                         bus 0 on adapter 0 without a mux
1353                         bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1354                         bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1355                         bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1356                         bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1357                         bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
1358                         bus 6 on adapter 1 without a mux
1359                         bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1360                         bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
1361
1362                 If you do not have i2c muxes on your board, omit this define.
1363
1364 - Legacy I2C Support:
1365                 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1366                 then the following macros need to be defined (examples are
1367                 from include/configs/lwmon.h):
1368
1369                 I2C_INIT
1370
1371                 (Optional). Any commands necessary to enable the I2C
1372                 controller or configure ports.
1373
1374                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
1375
1376                 I2C_ACTIVE
1377
1378                 The code necessary to make the I2C data line active
1379                 (driven).  If the data line is open collector, this
1380                 define can be null.
1381
1382                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1383
1384                 I2C_TRISTATE
1385
1386                 The code necessary to make the I2C data line tri-stated
1387                 (inactive).  If the data line is open collector, this
1388                 define can be null.
1389
1390                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1391
1392                 I2C_READ
1393
1394                 Code that returns true if the I2C data line is high,
1395                 false if it is low.
1396
1397                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1398
1399                 I2C_SDA(bit)
1400
1401                 If <bit> is true, sets the I2C data line high. If it
1402                 is false, it clears it (low).
1403
1404                 eg: #define I2C_SDA(bit) \
1405                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1406                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
1407
1408                 I2C_SCL(bit)
1409
1410                 If <bit> is true, sets the I2C clock line high. If it
1411                 is false, it clears it (low).
1412
1413                 eg: #define I2C_SCL(bit) \
1414                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1415                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
1416
1417                 I2C_DELAY
1418
1419                 This delay is invoked four times per clock cycle so this
1420                 controls the rate of data transfer.  The data rate thus
1421                 is 1 / (I2C_DELAY * 4). Often defined to be something
1422                 like:
1423
1424                 #define I2C_DELAY  udelay(2)
1425
1426                 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1427
1428                 If your arch supports the generic GPIO framework (asm/gpio.h),
1429                 then you may alternatively define the two GPIOs that are to be
1430                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
1431                 have GPIO-based defaults assigned to them as appropriate.
1432
1433                 You should define these to the GPIO value as given directly to
1434                 the generic GPIO functions.
1435
1436                 CONFIG_SYS_I2C_INIT_BOARD
1437
1438                 When a board is reset during an i2c bus transfer
1439                 chips might think that the current transfer is still
1440                 in progress. On some boards it is possible to access
1441                 the i2c SCLK line directly, either by using the
1442                 processor pin as a GPIO or by having a second pin
1443                 connected to the bus. If this option is defined a
1444                 custom i2c_init_board() routine in boards/xxx/board.c
1445                 is run early in the boot sequence.
1446
1447                 CONFIG_I2C_MULTI_BUS
1448
1449                 This option allows the use of multiple I2C buses, each of which
1450                 must have a controller.  At any point in time, only one bus is
1451                 active.  To switch to a different bus, use the 'i2c dev' command.
1452                 Note that bus numbering is zero-based.
1453
1454                 CONFIG_SYS_I2C_NOPROBES
1455
1456                 This option specifies a list of I2C devices that will be skipped
1457                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
1458                 is set, specify a list of bus-device pairs.  Otherwise, specify
1459                 a 1D array of device addresses
1460
1461                 e.g.
1462                         #undef  CONFIG_I2C_MULTI_BUS
1463                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1464
1465                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1466
1467                         #define CONFIG_I2C_MULTI_BUS
1468                         #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1469
1470                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1471
1472                 CONFIG_SYS_SPD_BUS_NUM
1473
1474                 If defined, then this indicates the I2C bus number for DDR SPD.
1475                 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1476
1477                 CONFIG_SYS_RTC_BUS_NUM
1478
1479                 If defined, then this indicates the I2C bus number for the RTC.
1480                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1481
1482                 CONFIG_SOFT_I2C_READ_REPEATED_START
1483
1484                 defining this will force the i2c_read() function in
1485                 the soft_i2c driver to perform an I2C repeated start
1486                 between writing the address pointer and reading the
1487                 data.  If this define is omitted the default behaviour
1488                 of doing a stop-start sequence will be used.  Most I2C
1489                 devices can use either method, but some require one or
1490                 the other.
1491
1492 - SPI Support:  CONFIG_SPI
1493
1494                 Enables SPI driver (so far only tested with
1495                 SPI EEPROM, also an instance works with Crystal A/D and
1496                 D/As on the SACSng board)
1497
1498                 CONFIG_SYS_SPI_MXC_WAIT
1499                 Timeout for waiting until spi transfer completed.
1500                 default: (CONFIG_SYS_HZ/100)     /* 10 ms */
1501
1502 - FPGA Support: CONFIG_FPGA
1503
1504                 Enables FPGA subsystem.
1505
1506                 CONFIG_FPGA_<vendor>
1507
1508                 Enables support for specific chip vendors.
1509                 (ALTERA, XILINX)
1510
1511                 CONFIG_FPGA_<family>
1512
1513                 Enables support for FPGA family.
1514                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1515
1516                 CONFIG_FPGA_COUNT
1517
1518                 Specify the number of FPGA devices to support.
1519
1520                 CONFIG_SYS_FPGA_PROG_FEEDBACK
1521
1522                 Enable printing of hash marks during FPGA configuration.
1523
1524                 CONFIG_SYS_FPGA_CHECK_BUSY
1525
1526                 Enable checks on FPGA configuration interface busy
1527                 status by the configuration function. This option
1528                 will require a board or device specific function to
1529                 be written.
1530
1531                 CONFIG_FPGA_DELAY
1532
1533                 If defined, a function that provides delays in the FPGA
1534                 configuration driver.
1535
1536                 CONFIG_SYS_FPGA_CHECK_CTRLC
1537                 Allow Control-C to interrupt FPGA configuration
1538
1539                 CONFIG_SYS_FPGA_CHECK_ERROR
1540
1541                 Check for configuration errors during FPGA bitfile
1542                 loading. For example, abort during Virtex II
1543                 configuration if the INIT_B line goes low (which
1544                 indicated a CRC error).
1545
1546                 CONFIG_SYS_FPGA_WAIT_INIT
1547
1548                 Maximum time to wait for the INIT_B line to de-assert
1549                 after PROB_B has been de-asserted during a Virtex II
1550                 FPGA configuration sequence. The default time is 500
1551                 ms.
1552
1553                 CONFIG_SYS_FPGA_WAIT_BUSY
1554
1555                 Maximum time to wait for BUSY to de-assert during
1556                 Virtex II FPGA configuration. The default is 5 ms.
1557
1558                 CONFIG_SYS_FPGA_WAIT_CONFIG
1559
1560                 Time to wait after FPGA configuration. The default is
1561                 200 ms.
1562
1563 - Vendor Parameter Protection:
1564
1565                 U-Boot considers the values of the environment
1566                 variables "serial#" (Board Serial Number) and
1567                 "ethaddr" (Ethernet Address) to be parameters that
1568                 are set once by the board vendor / manufacturer, and
1569                 protects these variables from casual modification by
1570                 the user. Once set, these variables are read-only,
1571                 and write or delete attempts are rejected. You can
1572                 change this behaviour:
1573
1574                 If CONFIG_ENV_OVERWRITE is #defined in your config
1575                 file, the write protection for vendor parameters is
1576                 completely disabled. Anybody can change or delete
1577                 these parameters.
1578
1579                 Alternatively, if you define _both_ an ethaddr in the
1580                 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1581                 Ethernet address is installed in the environment,
1582                 which can be changed exactly ONCE by the user. [The
1583                 serial# is unaffected by this, i. e. it remains
1584                 read-only.]
1585
1586                 The same can be accomplished in a more flexible way
1587                 for any variable by configuring the type of access
1588                 to allow for those variables in the ".flags" variable
1589                 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1590
1591 - Protected RAM:
1592                 CONFIG_PRAM
1593
1594                 Define this variable to enable the reservation of
1595                 "protected RAM", i. e. RAM which is not overwritten
1596                 by U-Boot. Define CONFIG_PRAM to hold the number of
1597                 kB you want to reserve for pRAM. You can overwrite
1598                 this default value by defining an environment
1599                 variable "pram" to the number of kB you want to
1600                 reserve. Note that the board info structure will
1601                 still show the full amount of RAM. If pRAM is
1602                 reserved, a new environment variable "mem" will
1603                 automatically be defined to hold the amount of
1604                 remaining RAM in a form that can be passed as boot
1605                 argument to Linux, for instance like that:
1606
1607                         setenv bootargs ... mem=\${mem}
1608                         saveenv
1609
1610                 This way you can tell Linux not to use this memory,
1611                 either, which results in a memory region that will
1612                 not be affected by reboots.
1613
1614                 *WARNING* If your board configuration uses automatic
1615                 detection of the RAM size, you must make sure that
1616                 this memory test is non-destructive. So far, the
1617                 following board configurations are known to be
1618                 "pRAM-clean":
1619
1620                         IVMS8, IVML24, SPD8xx,
1621                         HERMES, IP860, RPXlite, LWMON,
1622                         FLAGADM
1623
1624 - Error Recovery:
1625                 CONFIG_NET_RETRY_COUNT
1626
1627                 This variable defines the number of retries for
1628                 network operations like ARP, RARP, TFTP, or BOOTP
1629                 before giving up the operation. If not defined, a
1630                 default value of 5 is used.
1631
1632                 CONFIG_ARP_TIMEOUT
1633
1634                 Timeout waiting for an ARP reply in milliseconds.
1635
1636                 CONFIG_NFS_TIMEOUT
1637
1638                 Timeout in milliseconds used in NFS protocol.
1639                 If you encounter "ERROR: Cannot umount" in nfs command,
1640                 try longer timeout such as
1641                 #define CONFIG_NFS_TIMEOUT 10000UL
1642
1643         Note:
1644
1645                 In the current implementation, the local variables
1646                 space and global environment variables space are
1647                 separated. Local variables are those you define by
1648                 simply typing `name=value'. To access a local
1649                 variable later on, you have write `$name' or
1650                 `${name}'; to execute the contents of a variable
1651                 directly type `$name' at the command prompt.
1652
1653                 Global environment variables are those you use
1654                 setenv/printenv to work with. To run a command stored
1655                 in such a variable, you need to use the run command,
1656                 and you must not use the '$' sign to access them.
1657
1658                 To store commands and special characters in a
1659                 variable, please use double quotation marks
1660                 surrounding the whole text of the variable, instead
1661                 of the backslashes before semicolons and special
1662                 symbols.
1663
1664 - Command Line Editing and History:
1665                 CONFIG_CMDLINE_PS_SUPPORT
1666
1667                 Enable support for changing the command prompt string
1668                 at run-time. Only static string is supported so far.
1669                 The string is obtained from environment variables PS1
1670                 and PS2.
1671
1672 - Default Environment:
1673                 CONFIG_EXTRA_ENV_SETTINGS
1674
1675                 Define this to contain any number of null terminated
1676                 strings (variable = value pairs) that will be part of
1677                 the default environment compiled into the boot image.
1678
1679                 For example, place something like this in your
1680                 board's config file:
1681
1682                 #define CONFIG_EXTRA_ENV_SETTINGS \
1683                         "myvar1=value1\0" \
1684                         "myvar2=value2\0"
1685
1686                 Warning: This method is based on knowledge about the
1687                 internal format how the environment is stored by the
1688                 U-Boot code. This is NOT an official, exported
1689                 interface! Although it is unlikely that this format
1690                 will change soon, there is no guarantee either.
1691                 You better know what you are doing here.
1692
1693                 Note: overly (ab)use of the default environment is
1694                 discouraged. Make sure to check other ways to preset
1695                 the environment like the "source" command or the
1696                 boot command first.
1697
1698                 CONFIG_DELAY_ENVIRONMENT
1699
1700                 Normally the environment is loaded when the board is
1701                 initialised so that it is available to U-Boot. This inhibits
1702                 that so that the environment is not available until
1703                 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1704                 this is instead controlled by the value of
1705                 /config/load-environment.
1706
1707 - TFTP Fixed UDP Port:
1708                 CONFIG_TFTP_PORT
1709
1710                 If this is defined, the environment variable tftpsrcp
1711                 is used to supply the TFTP UDP source port value.
1712                 If tftpsrcp isn't defined, the normal pseudo-random port
1713                 number generator is used.
1714
1715                 Also, the environment variable tftpdstp is used to supply
1716                 the TFTP UDP destination port value.  If tftpdstp isn't
1717                 defined, the normal port 69 is used.
1718
1719                 The purpose for tftpsrcp is to allow a TFTP server to
1720                 blindly start the TFTP transfer using the pre-configured
1721                 target IP address and UDP port. This has the effect of
1722                 "punching through" the (Windows XP) firewall, allowing
1723                 the remainder of the TFTP transfer to proceed normally.
1724                 A better solution is to properly configure the firewall,
1725                 but sometimes that is not allowed.
1726
1727                 CONFIG_STANDALONE_LOAD_ADDR
1728
1729                 This option defines a board specific value for the
1730                 address where standalone program gets loaded, thus
1731                 overwriting the architecture dependent default
1732                 settings.
1733
1734 - Frame Buffer Address:
1735                 CONFIG_FB_ADDR
1736
1737                 Define CONFIG_FB_ADDR if you want to use specific
1738                 address for frame buffer.  This is typically the case
1739                 when using a graphics controller has separate video
1740                 memory.  U-Boot will then place the frame buffer at
1741                 the given address instead of dynamically reserving it
1742                 in system RAM by calling lcd_setmem(), which grabs
1743                 the memory for the frame buffer depending on the
1744                 configured panel size.
1745
1746                 Please see board_init_f function.
1747
1748 - Automatic software updates via TFTP server
1749                 CONFIG_UPDATE_TFTP
1750                 CONFIG_UPDATE_TFTP_CNT_MAX
1751                 CONFIG_UPDATE_TFTP_MSEC_MAX
1752
1753                 These options enable and control the auto-update feature;
1754                 for a more detailed description refer to doc/README.update.
1755
1756 - MTD Support (mtdparts command, UBI support)
1757                 CONFIG_MTD_UBI_WL_THRESHOLD
1758                 This parameter defines the maximum difference between the highest
1759                 erase counter value and the lowest erase counter value of eraseblocks
1760                 of UBI devices. When this threshold is exceeded, UBI starts performing
1761                 wear leveling by means of moving data from eraseblock with low erase
1762                 counter to eraseblocks with high erase counter.
1763
1764                 The default value should be OK for SLC NAND flashes, NOR flashes and
1765                 other flashes which have eraseblock life-cycle 100000 or more.
1766                 However, in case of MLC NAND flashes which typically have eraseblock
1767                 life-cycle less than 10000, the threshold should be lessened (e.g.,
1768                 to 128 or 256, although it does not have to be power of 2).
1769
1770                 default: 4096
1771
1772                 CONFIG_MTD_UBI_BEB_LIMIT
1773                 This option specifies the maximum bad physical eraseblocks UBI
1774                 expects on the MTD device (per 1024 eraseblocks). If the
1775                 underlying flash does not admit of bad eraseblocks (e.g. NOR
1776                 flash), this value is ignored.
1777
1778                 NAND datasheets often specify the minimum and maximum NVM
1779                 (Number of Valid Blocks) for the flashes' endurance lifetime.
1780                 The maximum expected bad eraseblocks per 1024 eraseblocks
1781                 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1782                 which gives 20 for most NANDs (MaxNVB is basically the total
1783                 count of eraseblocks on the chip).
1784
1785                 To put it differently, if this value is 20, UBI will try to
1786                 reserve about 1.9% of physical eraseblocks for bad blocks
1787                 handling. And that will be 1.9% of eraseblocks on the entire
1788                 NAND chip, not just the MTD partition UBI attaches. This means
1789                 that if you have, say, a NAND flash chip admits maximum 40 bad
1790                 eraseblocks, and it is split on two MTD partitions of the same
1791                 size, UBI will reserve 40 eraseblocks when attaching a
1792                 partition.
1793
1794                 default: 20
1795
1796                 CONFIG_MTD_UBI_FASTMAP
1797                 Fastmap is a mechanism which allows attaching an UBI device
1798                 in nearly constant time. Instead of scanning the whole MTD device it
1799                 only has to locate a checkpoint (called fastmap) on the device.
1800                 The on-flash fastmap contains all information needed to attach
1801                 the device. Using fastmap makes only sense on large devices where
1802                 attaching by scanning takes long. UBI will not automatically install
1803                 a fastmap on old images, but you can set the UBI parameter
1804                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1805                 that fastmap-enabled images are still usable with UBI implementations
1806                 without fastmap support. On typical flash devices the whole fastmap
1807                 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1808
1809                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1810                 Set this parameter to enable fastmap automatically on images
1811                 without a fastmap.
1812                 default: 0
1813
1814                 CONFIG_MTD_UBI_FM_DEBUG
1815                 Enable UBI fastmap debug
1816                 default: 0
1817
1818 - SPL framework
1819                 CONFIG_SPL
1820                 Enable building of SPL globally.
1821
1822                 CONFIG_SPL_MAX_FOOTPRINT
1823                 Maximum size in memory allocated to the SPL, BSS included.
1824                 When defined, the linker checks that the actual memory
1825                 used by SPL from _start to __bss_end does not exceed it.
1826                 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
1827                 must not be both defined at the same time.
1828
1829                 CONFIG_SPL_MAX_SIZE
1830                 Maximum size of the SPL image (text, data, rodata, and
1831                 linker lists sections), BSS excluded.
1832                 When defined, the linker checks that the actual size does
1833                 not exceed it.
1834
1835                 CONFIG_SPL_RELOC_TEXT_BASE
1836                 Address to relocate to.  If unspecified, this is equal to
1837                 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
1838
1839                 CONFIG_SPL_BSS_START_ADDR
1840                 Link address for the BSS within the SPL binary.
1841
1842                 CONFIG_SPL_BSS_MAX_SIZE
1843                 Maximum size in memory allocated to the SPL BSS.
1844                 When defined, the linker checks that the actual memory used
1845                 by SPL from __bss_start to __bss_end does not exceed it.
1846                 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
1847                 must not be both defined at the same time.
1848
1849                 CONFIG_SPL_STACK
1850                 Adress of the start of the stack SPL will use
1851
1852                 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1853                 When defined, SPL will panic() if the image it has
1854                 loaded does not have a signature.
1855                 Defining this is useful when code which loads images
1856                 in SPL cannot guarantee that absolutely all read errors
1857                 will be caught.
1858                 An example is the LPC32XX MLC NAND driver, which will
1859                 consider that a completely unreadable NAND block is bad,
1860                 and thus should be skipped silently.
1861
1862                 CONFIG_SPL_RELOC_STACK
1863                 Adress of the start of the stack SPL will use after
1864                 relocation.  If unspecified, this is equal to
1865                 CONFIG_SPL_STACK.
1866
1867                 CONFIG_SYS_SPL_MALLOC_START
1868                 Starting address of the malloc pool used in SPL.
1869                 When this option is set the full malloc is used in SPL and
1870                 it is set up by spl_init() and before that, the simple malloc()
1871                 can be used if CONFIG_SYS_MALLOC_F is defined.
1872
1873                 CONFIG_SYS_SPL_MALLOC_SIZE
1874                 The size of the malloc pool used in SPL.
1875
1876                 CONFIG_SPL_DISPLAY_PRINT
1877                 For ARM, enable an optional function to print more information
1878                 about the running system.
1879
1880                 CONFIG_SPL_INIT_MINIMAL
1881                 Arch init code should be built for a very small image
1882
1883                 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
1884                 Sector to load kernel uImage from when MMC is being
1885                 used in raw mode (for Falcon mode)
1886
1887                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
1888                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
1889                 Sector and number of sectors to load kernel argument
1890                 parameters from when MMC is being used in raw mode
1891                 (for falcon mode)
1892
1893                 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
1894                 Filename to read to load U-Boot when reading from filesystem
1895
1896                 CONFIG_SPL_FS_LOAD_KERNEL_NAME
1897                 Filename to read to load kernel uImage when reading
1898                 from filesystem (for Falcon mode)
1899
1900                 CONFIG_SPL_FS_LOAD_ARGS_NAME
1901                 Filename to read to load kernel argument parameters
1902                 when reading from filesystem (for Falcon mode)
1903
1904                 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1905                 Set this for NAND SPL on PPC mpc83xx targets, so that
1906                 start.S waits for the rest of the SPL to load before
1907                 continuing (the hardware starts execution after just
1908                 loading the first page rather than the full 4K).
1909
1910                 CONFIG_SPL_SKIP_RELOCATE
1911                 Avoid SPL relocation
1912
1913                 CONFIG_SPL_NAND_IDENT
1914                 SPL uses the chip ID list to identify the NAND flash.
1915                 Requires CONFIG_SPL_NAND_BASE.
1916
1917                 CONFIG_SPL_UBI
1918                 Support for a lightweight UBI (fastmap) scanner and
1919                 loader
1920
1921                 CONFIG_SPL_NAND_RAW_ONLY
1922                 Support to boot only raw u-boot.bin images. Use this only
1923                 if you need to save space.
1924
1925                 CONFIG_SPL_COMMON_INIT_DDR
1926                 Set for common ddr init with serial presence detect in
1927                 SPL binary.
1928
1929                 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1930                 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1931                 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1932                 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1933                 CONFIG_SYS_NAND_ECCBYTES
1934                 Defines the size and behavior of the NAND that SPL uses
1935                 to read U-Boot
1936
1937                 CONFIG_SYS_NAND_U_BOOT_DST
1938                 Location in memory to load U-Boot to
1939
1940                 CONFIG_SYS_NAND_U_BOOT_SIZE
1941                 Size of image to load
1942
1943                 CONFIG_SYS_NAND_U_BOOT_START
1944                 Entry point in loaded image to jump to
1945
1946                 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1947                 Define this if you need to first read the OOB and then the
1948                 data. This is used, for example, on davinci platforms.
1949
1950                 CONFIG_SPL_RAM_DEVICE
1951                 Support for running image already present in ram, in SPL binary
1952
1953                 CONFIG_SPL_PAD_TO
1954                 Image offset to which the SPL should be padded before appending
1955                 the SPL payload. By default, this is defined as
1956                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1957                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1958                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
1959
1960                 CONFIG_SPL_TARGET
1961                 Final target image containing SPL and payload.  Some SPLs
1962                 use an arch-specific makefile fragment instead, for
1963                 example if more than one image needs to be produced.
1964
1965                 CONFIG_SPL_FIT_PRINT
1966                 Printing information about a FIT image adds quite a bit of
1967                 code to SPL. So this is normally disabled in SPL. Use this
1968                 option to re-enable it. This will affect the output of the
1969                 bootm command when booting a FIT image.
1970
1971 - TPL framework
1972                 CONFIG_TPL
1973                 Enable building of TPL globally.
1974
1975                 CONFIG_TPL_PAD_TO
1976                 Image offset to which the TPL should be padded before appending
1977                 the TPL payload. By default, this is defined as
1978                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1979                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1980                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
1981
1982 - Interrupt support (PPC):
1983
1984                 There are common interrupt_init() and timer_interrupt()
1985                 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1986                 for CPU specific initialization. interrupt_init_cpu()
1987                 should set decrementer_count to appropriate value. If
1988                 CPU resets decrementer automatically after interrupt
1989                 (ppc4xx) it should set decrementer_count to zero.
1990                 timer_interrupt() calls timer_interrupt_cpu() for CPU
1991                 specific handling. If board has watchdog / status_led
1992                 / other_activity_monitor it works automatically from
1993                 general timer_interrupt().
1994
1995
1996 Board initialization settings:
1997 ------------------------------
1998
1999 During Initialization u-boot calls a number of board specific functions
2000 to allow the preparation of board specific prerequisites, e.g. pin setup
2001 before drivers are initialized. To enable these callbacks the
2002 following configuration macros have to be defined. Currently this is
2003 architecture specific, so please check arch/your_architecture/lib/board.c
2004 typically in board_init_f() and board_init_r().
2005
2006 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2007 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2008 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
2009 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2010
2011 Configuration Settings:
2012 -----------------------
2013
2014 - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2015                 Optionally it can be defined to support 64-bit memory commands.
2016
2017 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2018                 undefine this when you're short of memory.
2019
2020 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2021                 width of the commands listed in the 'help' command output.
2022
2023 - CONFIG_SYS_PROMPT:    This is what U-Boot prints on the console to
2024                 prompt for user input.
2025
2026 - CONFIG_SYS_CBSIZE:    Buffer size for input from the Console
2027
2028 - CONFIG_SYS_PBSIZE:    Buffer size for Console output
2029
2030 - CONFIG_SYS_MAXARGS:   max. Number of arguments accepted for monitor commands
2031
2032 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2033                 the application (usually a Linux kernel) when it is
2034                 booted
2035
2036 - CONFIG_SYS_BAUDRATE_TABLE:
2037                 List of legal baudrate settings for this board.
2038
2039 - CONFIG_SYS_MEM_RESERVE_SECURE
2040                 Only implemented for ARMv8 for now.
2041                 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2042                 is substracted from total RAM and won't be reported to OS.
2043                 This memory can be used as secure memory. A variable
2044                 gd->arch.secure_ram is used to track the location. In systems
2045                 the RAM base is not zero, or RAM is divided into banks,
2046                 this variable needs to be recalcuated to get the address.
2047
2048 - CONFIG_SYS_MEM_TOP_HIDE:
2049                 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2050                 this specified memory area will get subtracted from the top
2051                 (end) of RAM and won't get "touched" at all by U-Boot. By
2052                 fixing up gd->ram_size the Linux kernel should gets passed
2053                 the now "corrected" memory size and won't touch it either.
2054                 This should work for arch/ppc and arch/powerpc. Only Linux
2055                 board ports in arch/powerpc with bootwrapper support that
2056                 recalculate the memory size from the SDRAM controller setup
2057                 will have to get fixed in Linux additionally.
2058
2059                 This option can be used as a workaround for the 440EPx/GRx
2060                 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2061                 be touched.
2062
2063                 WARNING: Please make sure that this value is a multiple of
2064                 the Linux page size (normally 4k). If this is not the case,
2065                 then the end address of the Linux memory will be located at a
2066                 non page size aligned address and this could cause major
2067                 problems.
2068
2069 - CONFIG_SYS_LOADS_BAUD_CHANGE:
2070                 Enable temporary baudrate change while serial download
2071
2072 - CONFIG_SYS_SDRAM_BASE:
2073                 Physical start address of SDRAM. _Must_ be 0 here.
2074
2075 - CONFIG_SYS_FLASH_BASE:
2076                 Physical start address of Flash memory.
2077
2078 - CONFIG_SYS_MONITOR_BASE:
2079                 Physical start address of boot monitor code (set by
2080                 make config files to be same as the text base address
2081                 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
2082                 CONFIG_SYS_FLASH_BASE when booting from flash.
2083
2084 - CONFIG_SYS_MONITOR_LEN:
2085                 Size of memory reserved for monitor code, used to
2086                 determine _at_compile_time_ (!) if the environment is
2087                 embedded within the U-Boot image, or in a separate
2088                 flash sector.
2089
2090 - CONFIG_SYS_MALLOC_LEN:
2091                 Size of DRAM reserved for malloc() use.
2092
2093 - CONFIG_SYS_MALLOC_F_LEN
2094                 Size of the malloc() pool for use before relocation. If
2095                 this is defined, then a very simple malloc() implementation
2096                 will become available before relocation. The address is just
2097                 below the global data, and the stack is moved down to make
2098                 space.
2099
2100                 This feature allocates regions with increasing addresses
2101                 within the region. calloc() is supported, but realloc()
2102                 is not available. free() is supported but does nothing.
2103                 The memory will be freed (or in fact just forgotten) when
2104                 U-Boot relocates itself.
2105
2106 - CONFIG_SYS_MALLOC_SIMPLE
2107                 Provides a simple and small malloc() and calloc() for those
2108                 boards which do not use the full malloc in SPL (which is
2109                 enabled with CONFIG_SYS_SPL_MALLOC_START).
2110
2111 - CONFIG_SYS_NONCACHED_MEMORY:
2112                 Size of non-cached memory area. This area of memory will be
2113                 typically located right below the malloc() area and mapped
2114                 uncached in the MMU. This is useful for drivers that would
2115                 otherwise require a lot of explicit cache maintenance. For
2116                 some drivers it's also impossible to properly maintain the
2117                 cache. For example if the regions that need to be flushed
2118                 are not a multiple of the cache-line size, *and* padding
2119                 cannot be allocated between the regions to align them (i.e.
2120                 if the HW requires a contiguous array of regions, and the
2121                 size of each region is not cache-aligned), then a flush of
2122                 one region may result in overwriting data that hardware has
2123                 written to another region in the same cache-line. This can
2124                 happen for example in network drivers where descriptors for
2125                 buffers are typically smaller than the CPU cache-line (e.g.
2126                 16 bytes vs. 32 or 64 bytes).
2127
2128                 Non-cached memory is only supported on 32-bit ARM at present.
2129
2130 - CONFIG_SYS_BOOTM_LEN:
2131                 Normally compressed uImages are limited to an
2132                 uncompressed size of 8 MBytes. If this is not enough,
2133                 you can define CONFIG_SYS_BOOTM_LEN in your board config file
2134                 to adjust this setting to your needs.
2135
2136 - CONFIG_SYS_BOOTMAPSZ:
2137                 Maximum size of memory mapped by the startup code of
2138                 the Linux kernel; all data that must be processed by
2139                 the Linux kernel (bd_info, boot arguments, FDT blob if
2140                 used) must be put below this limit, unless "bootm_low"
2141                 environment variable is defined and non-zero. In such case
2142                 all data for the Linux kernel must be between "bootm_low"
2143                 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2144                 variable "bootm_mapsize" will override the value of
2145                 CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2146                 then the value in "bootm_size" will be used instead.
2147
2148 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
2149                 Enable initrd_high functionality.  If defined then the
2150                 initrd_high feature is enabled and the bootm ramdisk subcommand
2151                 is enabled.
2152
2153 - CONFIG_SYS_BOOT_GET_CMDLINE:
2154                 Enables allocating and saving kernel cmdline in space between
2155                 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2156
2157 - CONFIG_SYS_BOOT_GET_KBD:
2158                 Enables allocating and saving a kernel copy of the bd_info in
2159                 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2160
2161 - CONFIG_SYS_MAX_FLASH_BANKS:
2162                 Max number of Flash memory banks
2163
2164 - CONFIG_SYS_MAX_FLASH_SECT:
2165                 Max number of sectors on a Flash chip
2166
2167 - CONFIG_SYS_FLASH_ERASE_TOUT:
2168                 Timeout for Flash erase operations (in ms)
2169
2170 - CONFIG_SYS_FLASH_WRITE_TOUT:
2171                 Timeout for Flash write operations (in ms)
2172
2173 - CONFIG_SYS_FLASH_LOCK_TOUT
2174                 Timeout for Flash set sector lock bit operation (in ms)
2175
2176 - CONFIG_SYS_FLASH_UNLOCK_TOUT
2177                 Timeout for Flash clear lock bits operation (in ms)
2178
2179 - CONFIG_SYS_FLASH_PROTECTION
2180                 If defined, hardware flash sectors protection is used
2181                 instead of U-Boot software protection.
2182
2183 - CONFIG_SYS_DIRECT_FLASH_TFTP:
2184
2185                 Enable TFTP transfers directly to flash memory;
2186                 without this option such a download has to be
2187                 performed in two steps: (1) download to RAM, and (2)
2188                 copy from RAM to flash.
2189
2190                 The two-step approach is usually more reliable, since
2191                 you can check if the download worked before you erase
2192                 the flash, but in some situations (when system RAM is
2193                 too limited to allow for a temporary copy of the
2194                 downloaded image) this option may be very useful.
2195
2196 - CONFIG_SYS_FLASH_CFI:
2197                 Define if the flash driver uses extra elements in the
2198                 common flash structure for storing flash geometry.
2199
2200 - CONFIG_FLASH_CFI_DRIVER
2201                 This option also enables the building of the cfi_flash driver
2202                 in the drivers directory
2203
2204 - CONFIG_FLASH_CFI_MTD
2205                 This option enables the building of the cfi_mtd driver
2206                 in the drivers directory. The driver exports CFI flash
2207                 to the MTD layer.
2208
2209 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2210                 Use buffered writes to flash.
2211
2212 - CONFIG_FLASH_SPANSION_S29WS_N
2213                 s29ws-n MirrorBit flash has non-standard addresses for buffered
2214                 write commands.
2215
2216 - CONFIG_SYS_FLASH_QUIET_TEST
2217                 If this option is defined, the common CFI flash doesn't
2218                 print it's warning upon not recognized FLASH banks. This
2219                 is useful, if some of the configured banks are only
2220                 optionally available.
2221
2222 - CONFIG_FLASH_SHOW_PROGRESS
2223                 If defined (must be an integer), print out countdown
2224                 digits and dots.  Recommended value: 45 (9..1) for 80
2225                 column displays, 15 (3..1) for 40 column displays.
2226
2227 - CONFIG_FLASH_VERIFY
2228                 If defined, the content of the flash (destination) is compared
2229                 against the source after the write operation. An error message
2230                 will be printed when the contents are not identical.
2231                 Please note that this option is useless in nearly all cases,
2232                 since such flash programming errors usually are detected earlier
2233                 while unprotecting/erasing/programming. Please only enable
2234                 this option if you really know what you are doing.
2235
2236 - CONFIG_SYS_RX_ETH_BUFFER:
2237                 Defines the number of Ethernet receive buffers. On some
2238                 Ethernet controllers it is recommended to set this value
2239                 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2240                 buffers can be full shortly after enabling the interface
2241                 on high Ethernet traffic.
2242                 Defaults to 4 if not defined.
2243
2244 - CONFIG_ENV_MAX_ENTRIES
2245
2246         Maximum number of entries in the hash table that is used
2247         internally to store the environment settings. The default
2248         setting is supposed to be generous and should work in most
2249         cases. This setting can be used to tune behaviour; see
2250         lib/hashtable.c for details.
2251
2252 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2253 - CONFIG_ENV_FLAGS_LIST_STATIC
2254         Enable validation of the values given to environment variables when
2255         calling env set.  Variables can be restricted to only decimal,
2256         hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
2257         the variables can also be restricted to IP address or MAC address.
2258
2259         The format of the list is:
2260                 type_attribute = [s|d|x|b|i|m]
2261                 access_attribute = [a|r|o|c]
2262                 attributes = type_attribute[access_attribute]
2263                 entry = variable_name[:attributes]
2264                 list = entry[,list]
2265
2266         The type attributes are:
2267                 s - String (default)
2268                 d - Decimal
2269                 x - Hexadecimal
2270                 b - Boolean ([1yYtT|0nNfF])
2271                 i - IP address
2272                 m - MAC address
2273
2274         The access attributes are:
2275                 a - Any (default)
2276                 r - Read-only
2277                 o - Write-once
2278                 c - Change-default
2279
2280         - CONFIG_ENV_FLAGS_LIST_DEFAULT
2281                 Define this to a list (string) to define the ".flags"
2282                 environment variable in the default or embedded environment.
2283
2284         - CONFIG_ENV_FLAGS_LIST_STATIC
2285                 Define this to a list (string) to define validation that
2286                 should be done if an entry is not found in the ".flags"
2287                 environment variable.  To override a setting in the static
2288                 list, simply add an entry for the same variable name to the
2289                 ".flags" variable.
2290
2291         If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2292         regular expression. This allows multiple variables to define the same
2293         flags without explicitly listing them for each variable.
2294
2295 The following definitions that deal with the placement and management
2296 of environment data (variable area); in general, we support the
2297 following configurations:
2298
2299 - CONFIG_BUILD_ENVCRC:
2300
2301         Builds up envcrc with the target environment so that external utils
2302         may easily extract it and embed it in final U-Boot images.
2303
2304 BE CAREFUL! The first access to the environment happens quite early
2305 in U-Boot initialization (when we try to get the setting of for the
2306 console baudrate). You *MUST* have mapped your NVRAM area then, or
2307 U-Boot will hang.
2308
2309 Please note that even with NVRAM we still use a copy of the
2310 environment in RAM: we could work on NVRAM directly, but we want to
2311 keep settings there always unmodified except somebody uses "saveenv"
2312 to save the current settings.
2313
2314 BE CAREFUL! For some special cases, the local device can not use
2315 "saveenv" command. For example, the local device will get the
2316 environment stored in a remote NOR flash by SRIO or PCIE link,
2317 but it can not erase, write this NOR flash by SRIO or PCIE interface.
2318
2319 - CONFIG_NAND_ENV_DST
2320
2321         Defines address in RAM to which the nand_spl code should copy the
2322         environment. If redundant environment is used, it will be copied to
2323         CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2324
2325 Please note that the environment is read-only until the monitor
2326 has been relocated to RAM and a RAM copy of the environment has been
2327 created; also, when using EEPROM you will have to use env_get_f()
2328 until then to read environment variables.
2329
2330 The environment is protected by a CRC32 checksum. Before the monitor
2331 is relocated into RAM, as a result of a bad CRC you will be working
2332 with the compiled-in default environment - *silently*!!! [This is
2333 necessary, because the first environment variable we need is the
2334 "baudrate" setting for the console - if we have a bad CRC, we don't
2335 have any device yet where we could complain.]
2336
2337 Note: once the monitor has been relocated, then it will complain if
2338 the default environment is used; a new CRC is computed as soon as you
2339 use the "saveenv" command to store a valid environment.
2340
2341 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2342                 Echo the inverted Ethernet link state to the fault LED.
2343
2344                 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2345                       also needs to be defined.
2346
2347 - CONFIG_SYS_FAULT_MII_ADDR:
2348                 MII address of the PHY to check for the Ethernet link state.
2349
2350 - CONFIG_NS16550_MIN_FUNCTIONS:
2351                 Define this if you desire to only have use of the NS16550_init
2352                 and NS16550_putc functions for the serial driver located at
2353                 drivers/serial/ns16550.c.  This option is useful for saving
2354                 space for already greatly restricted images, including but not
2355                 limited to NAND_SPL configurations.
2356
2357 - CONFIG_DISPLAY_BOARDINFO
2358                 Display information about the board that U-Boot is running on
2359                 when U-Boot starts up. The board function checkboard() is called
2360                 to do this.
2361
2362 - CONFIG_DISPLAY_BOARDINFO_LATE
2363                 Similar to the previous option, but display this information
2364                 later, once stdio is running and output goes to the LCD, if
2365                 present.
2366
2367 - CONFIG_BOARD_SIZE_LIMIT:
2368                 Maximum size of the U-Boot image. When defined, the
2369                 build system checks that the actual size does not
2370                 exceed it.
2371
2372 Low Level (hardware related) configuration options:
2373 ---------------------------------------------------
2374
2375 - CONFIG_SYS_CACHELINE_SIZE:
2376                 Cache Line Size of the CPU.
2377
2378 - CONFIG_SYS_CCSRBAR_DEFAULT:
2379                 Default (power-on reset) physical address of CCSR on Freescale
2380                 PowerPC SOCs.
2381
2382 - CONFIG_SYS_CCSRBAR:
2383                 Virtual address of CCSR.  On a 32-bit build, this is typically
2384                 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2385
2386 - CONFIG_SYS_CCSRBAR_PHYS:
2387                 Physical address of CCSR.  CCSR can be relocated to a new
2388                 physical address, if desired.  In this case, this macro should
2389                 be set to that address.  Otherwise, it should be set to the
2390                 same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2391                 is typically relocated on 36-bit builds.  It is recommended
2392                 that this macro be defined via the _HIGH and _LOW macros:
2393
2394                 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2395                         * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2396
2397 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2398                 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
2399                 either 0 (32-bit build) or 0xF (36-bit build).  This macro is
2400                 used in assembly code, so it must not contain typecasts or
2401                 integer size suffixes (e.g. "ULL").
2402
2403 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
2404                 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2405                 used in assembly code, so it must not contain typecasts or
2406                 integer size suffixes (e.g. "ULL").
2407
2408 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2409                 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2410                 forced to a value that ensures that CCSR is not relocated.
2411
2412 - CONFIG_IDE_AHB:
2413                 Most IDE controllers were designed to be connected with PCI
2414                 interface. Only few of them were designed for AHB interface.
2415                 When software is doing ATA command and data transfer to
2416                 IDE devices through IDE-AHB controller, some additional
2417                 registers accessing to these kind of IDE-AHB controller
2418                 is required.
2419
2420 - CONFIG_SYS_IMMR:      Physical address of the Internal Memory.
2421                 DO NOT CHANGE unless you know exactly what you're
2422                 doing! (11-4) [MPC8xx systems only]
2423
2424 - CONFIG_SYS_INIT_RAM_ADDR:
2425
2426                 Start address of memory area that can be used for
2427                 initial data and stack; please note that this must be
2428                 writable memory that is working WITHOUT special
2429                 initialization, i. e. you CANNOT use normal RAM which
2430                 will become available only after programming the
2431                 memory controller and running certain initialization
2432                 sequences.
2433
2434                 U-Boot uses the following memory types:
2435                 - MPC8xx: IMMR (internal memory of the CPU)
2436
2437 - CONFIG_SYS_GBL_DATA_OFFSET:
2438
2439                 Offset of the initial data structure in the memory
2440                 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2441                 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2442                 data is located at the end of the available space
2443                 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
2444                 GENERATED_GBL_DATA_SIZE), and the initial stack is just
2445                 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2446                 CONFIG_SYS_GBL_DATA_OFFSET) downward.
2447
2448         Note:
2449                 On the MPC824X (or other systems that use the data
2450                 cache for initial memory) the address chosen for
2451                 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2452                 point to an otherwise UNUSED address space between
2453                 the top of RAM and the start of the PCI space.
2454
2455 - CONFIG_SYS_SCCR:      System Clock and reset Control Register (15-27)
2456
2457 - CONFIG_SYS_OR_TIMING_SDRAM:
2458                 SDRAM timing
2459
2460 - CONFIG_SYS_MAMR_PTA:
2461                 periodic timer for refresh
2462
2463 - CONFIG_SYS_SRIO:
2464                 Chip has SRIO or not
2465
2466 - CONFIG_SRIO1:
2467                 Board has SRIO 1 port available
2468
2469 - CONFIG_SRIO2:
2470                 Board has SRIO 2 port available
2471
2472 - CONFIG_SRIO_PCIE_BOOT_MASTER
2473                 Board can support master function for Boot from SRIO and PCIE
2474
2475 - CONFIG_SYS_SRIOn_MEM_VIRT:
2476                 Virtual Address of SRIO port 'n' memory region
2477
2478 - CONFIG_SYS_SRIOn_MEM_PHYxS:
2479                 Physical Address of SRIO port 'n' memory region
2480
2481 - CONFIG_SYS_SRIOn_MEM_SIZE:
2482                 Size of SRIO port 'n' memory region
2483
2484 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
2485                 Defined to tell the NAND controller that the NAND chip is using
2486                 a 16 bit bus.
2487                 Not all NAND drivers use this symbol.
2488                 Example of drivers that use it:
2489                 - drivers/mtd/nand/raw/ndfc.c
2490                 - drivers/mtd/nand/raw/mxc_nand.c
2491
2492 - CONFIG_SYS_NDFC_EBC0_CFG
2493                 Sets the EBC0_CFG register for the NDFC. If not defined
2494                 a default value will be used.
2495
2496 - CONFIG_SPD_EEPROM
2497                 Get DDR timing information from an I2C EEPROM. Common
2498                 with pluggable memory modules such as SODIMMs
2499
2500   SPD_EEPROM_ADDRESS
2501                 I2C address of the SPD EEPROM
2502
2503 - CONFIG_SYS_SPD_BUS_NUM
2504                 If SPD EEPROM is on an I2C bus other than the first
2505                 one, specify here. Note that the value must resolve
2506                 to something your driver can deal with.
2507
2508 - CONFIG_SYS_DDR_RAW_TIMING
2509                 Get DDR timing information from other than SPD. Common with
2510                 soldered DDR chips onboard without SPD. DDR raw timing
2511                 parameters are extracted from datasheet and hard-coded into
2512                 header files or board specific files.
2513
2514 - CONFIG_FSL_DDR_INTERACTIVE
2515                 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2516
2517 - CONFIG_FSL_DDR_SYNC_REFRESH
2518                 Enable sync of refresh for multiple controllers.
2519
2520 - CONFIG_FSL_DDR_BIST
2521                 Enable built-in memory test for Freescale DDR controllers.
2522
2523 - CONFIG_SYS_83XX_DDR_USES_CS0
2524                 Only for 83xx systems. If specified, then DDR should
2525                 be configured using CS0 and CS1 instead of CS2 and CS3.
2526
2527 - CONFIG_RMII
2528                 Enable RMII mode for all FECs.
2529                 Note that this is a global option, we can't
2530                 have one FEC in standard MII mode and another in RMII mode.
2531
2532 - CONFIG_CRC32_VERIFY
2533                 Add a verify option to the crc32 command.
2534                 The syntax is:
2535
2536                 => crc32 -v <address> <count> <crc32>
2537
2538                 Where address/count indicate a memory area
2539                 and crc32 is the correct crc32 which the
2540                 area should have.
2541
2542 - CONFIG_LOOPW
2543                 Add the "loopw" memory command. This only takes effect if
2544                 the memory commands are activated globally (CONFIG_CMD_MEMORY).
2545
2546 - CONFIG_CMD_MX_CYCLIC
2547                 Add the "mdc" and "mwc" memory commands. These are cyclic
2548                 "md/mw" commands.
2549                 Examples:
2550
2551                 => mdc.b 10 4 500
2552                 This command will print 4 bytes (10,11,12,13) each 500 ms.
2553
2554                 => mwc.l 100 12345678 10
2555                 This command will write 12345678 to address 100 all 10 ms.
2556
2557                 This only takes effect if the memory commands are activated
2558                 globally (CONFIG_CMD_MEMORY).
2559
2560 - CONFIG_SPL_BUILD
2561                 Set when the currently-running compilation is for an artifact
2562                 that will end up in the SPL (as opposed to the TPL or U-Boot
2563                 proper). Code that needs stage-specific behavior should check
2564                 this.
2565
2566 - CONFIG_TPL_BUILD
2567                 Set when the currently-running compilation is for an artifact
2568                 that will end up in the TPL (as opposed to the SPL or U-Boot
2569                 proper). Code that needs stage-specific behavior should check
2570                 this.
2571
2572 - CONFIG_SYS_MPC85XX_NO_RESETVEC
2573                 Only for 85xx systems. If this variable is specified, the section
2574                 .resetvec is not kept and the section .bootpg is placed in the
2575                 previous 4k of the .text section.
2576
2577 - CONFIG_ARCH_MAP_SYSMEM
2578                 Generally U-Boot (and in particular the md command) uses
2579                 effective address. It is therefore not necessary to regard
2580                 U-Boot address as virtual addresses that need to be translated
2581                 to physical addresses. However, sandbox requires this, since
2582                 it maintains its own little RAM buffer which contains all
2583                 addressable memory. This option causes some memory accesses
2584                 to be mapped through map_sysmem() / unmap_sysmem().
2585
2586 - CONFIG_X86_RESET_VECTOR
2587                 If defined, the x86 reset vector code is included. This is not
2588                 needed when U-Boot is running from Coreboot.
2589
2590 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2591                 Option to disable subpage write in NAND driver
2592                 driver that uses this:
2593                 drivers/mtd/nand/raw/davinci_nand.c
2594
2595 Freescale QE/FMAN Firmware Support:
2596 -----------------------------------
2597
2598 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2599 loading of "firmware", which is encoded in the QE firmware binary format.
2600 This firmware often needs to be loaded during U-Boot booting, so macros
2601 are used to identify the storage device (NOR flash, SPI, etc) and the address
2602 within that device.
2603
2604 - CONFIG_SYS_FMAN_FW_ADDR
2605         The address in the storage device where the FMAN microcode is located.  The
2606         meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
2607         is also specified.
2608
2609 - CONFIG_SYS_QE_FW_ADDR
2610         The address in the storage device where the QE microcode is located.  The
2611         meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
2612         is also specified.
2613
2614 - CONFIG_SYS_QE_FMAN_FW_LENGTH
2615         The maximum possible size of the firmware.  The firmware binary format
2616         has a field that specifies the actual size of the firmware, but it
2617         might not be possible to read any part of the firmware unless some
2618         local storage is allocated to hold the entire firmware first.
2619
2620 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
2621         Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2622         normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
2623         virtual address in NOR flash.
2624
2625 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
2626         Specifies that QE/FMAN firmware is located in NAND flash.
2627         CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2628
2629 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
2630         Specifies that QE/FMAN firmware is located on the primary SD/MMC
2631         device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2632
2633 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2634         Specifies that QE/FMAN firmware is located in the remote (master)
2635         memory space.   CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
2636         can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2637         window->master inbound window->master LAW->the ucode address in
2638         master's memory space.
2639
2640 Freescale Layerscape Management Complex Firmware Support:
2641 ---------------------------------------------------------
2642 The Freescale Layerscape Management Complex (MC) supports the loading of
2643 "firmware".
2644 This firmware often needs to be loaded during U-Boot booting, so macros
2645 are used to identify the storage device (NOR flash, SPI, etc) and the address
2646 within that device.
2647
2648 - CONFIG_FSL_MC_ENET
2649         Enable the MC driver for Layerscape SoCs.
2650
2651 Freescale Layerscape Debug Server Support:
2652 -------------------------------------------
2653 The Freescale Layerscape Debug Server Support supports the loading of
2654 "Debug Server firmware" and triggering SP boot-rom.
2655 This firmware often needs to be loaded during U-Boot booting.
2656
2657 - CONFIG_SYS_MC_RSV_MEM_ALIGN
2658         Define alignment of reserved memory MC requires
2659
2660 Reproducible builds
2661 -------------------
2662
2663 In order to achieve reproducible builds, timestamps used in the U-Boot build
2664 process have to be set to a fixed value.
2665
2666 This is done using the SOURCE_DATE_EPOCH environment variable.
2667 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2668 option for U-Boot or an environment variable in U-Boot.
2669
2670 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2671
2672 Building the Software:
2673 ======================
2674
2675 Building U-Boot has been tested in several native build environments
2676 and in many different cross environments. Of course we cannot support
2677 all possibly existing versions of cross development tools in all
2678 (potentially obsolete) versions. In case of tool chain problems we
2679 recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
2680 which is extensively used to build and test U-Boot.
2681
2682 If you are not using a native environment, it is assumed that you
2683 have GNU cross compiling tools available in your path. In this case,
2684 you must set the environment variable CROSS_COMPILE in your shell.
2685 Note that no changes to the Makefile or any other source files are
2686 necessary. For example using the ELDK on a 4xx CPU, please enter:
2687
2688         $ CROSS_COMPILE=ppc_4xx-
2689         $ export CROSS_COMPILE
2690
2691 U-Boot is intended to be simple to build. After installing the
2692 sources you must configure U-Boot for one specific board type. This
2693 is done by typing:
2694
2695         make NAME_defconfig
2696
2697 where "NAME_defconfig" is the name of one of the existing configu-
2698 rations; see configs/*_defconfig for supported names.
2699
2700 Note: for some boards special configuration names may exist; check if
2701       additional information is available from the board vendor; for
2702       instance, the TQM823L systems are available without (standard)
2703       or with LCD support. You can select such additional "features"
2704       when choosing the configuration, i. e.
2705
2706       make TQM823L_defconfig
2707         - will configure for a plain TQM823L, i. e. no LCD support
2708
2709       make TQM823L_LCD_defconfig
2710         - will configure for a TQM823L with U-Boot console on LCD
2711
2712       etc.
2713
2714
2715 Finally, type "make all", and you should get some working U-Boot
2716 images ready for download to / installation on your system:
2717
2718 - "u-boot.bin" is a raw binary image
2719 - "u-boot" is an image in ELF binary format
2720 - "u-boot.srec" is in Motorola S-Record format
2721
2722 By default the build is performed locally and the objects are saved
2723 in the source directory. One of the two methods can be used to change
2724 this behavior and build U-Boot to some external directory:
2725
2726 1. Add O= to the make command line invocations:
2727
2728         make O=/tmp/build distclean
2729         make O=/tmp/build NAME_defconfig
2730         make O=/tmp/build all
2731
2732 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
2733
2734         export KBUILD_OUTPUT=/tmp/build
2735         make distclean
2736         make NAME_defconfig
2737         make all
2738
2739 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
2740 variable.
2741
2742 User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2743 setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2744 For example to treat all compiler warnings as errors:
2745
2746         make KCFLAGS=-Werror
2747
2748 Please be aware that the Makefiles assume you are using GNU make, so
2749 for instance on NetBSD you might need to use "gmake" instead of
2750 native "make".
2751
2752
2753 If the system board that you have is not listed, then you will need
2754 to port U-Boot to your hardware platform. To do this, follow these
2755 steps:
2756
2757 1.  Create a new directory to hold your board specific code. Add any
2758     files you need. In your board directory, you will need at least
2759     the "Makefile" and a "<board>.c".
2760 2.  Create a new configuration file "include/configs/<board>.h" for
2761     your board.
2762 3.  If you're porting U-Boot to a new CPU, then also create a new
2763     directory to hold your CPU specific code. Add any files you need.
2764 4.  Run "make <board>_defconfig" with your new name.
2765 5.  Type "make", and you should get a working "u-boot.srec" file
2766     to be installed on your target system.
2767 6.  Debug and solve any problems that might arise.
2768     [Of course, this last step is much harder than it sounds.]
2769
2770
2771 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2772 ==============================================================
2773
2774 If you have modified U-Boot sources (for instance added a new board
2775 or support for new devices, a new CPU, etc.) you are expected to
2776 provide feedback to the other developers. The feedback normally takes
2777 the form of a "patch", i.e. a context diff against a certain (latest
2778 official or latest in the git repository) version of U-Boot sources.
2779
2780 But before you submit such a patch, please verify that your modifi-
2781 cation did not break existing code. At least make sure that *ALL* of
2782 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2783 just run the buildman script (tools/buildman/buildman), which will
2784 configure and build U-Boot for ALL supported system. Be warned, this
2785 will take a while. Please see the buildman README, or run 'buildman -H'
2786 for documentation.
2787
2788
2789 See also "U-Boot Porting Guide" below.
2790
2791
2792 Monitor Commands - Overview:
2793 ============================
2794
2795 go      - start application at address 'addr'
2796 run     - run commands in an environment variable
2797 bootm   - boot application image from memory
2798 bootp   - boot image via network using BootP/TFTP protocol
2799 bootz   - boot zImage from memory
2800 tftpboot- boot image via network using TFTP protocol
2801                and env variables "ipaddr" and "serverip"
2802                (and eventually "gatewayip")
2803 tftpput - upload a file via network using TFTP protocol
2804 rarpboot- boot image via network using RARP/TFTP protocol
2805 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2806 loads   - load S-Record file over serial line
2807 loadb   - load binary file over serial line (kermit mode)
2808 md      - memory display
2809 mm      - memory modify (auto-incrementing)
2810 nm      - memory modify (constant address)
2811 mw      - memory write (fill)
2812 ms      - memory search
2813 cp      - memory copy
2814 cmp     - memory compare
2815 crc32   - checksum calculation
2816 i2c     - I2C sub-system
2817 sspi    - SPI utility commands
2818 base    - print or set address offset
2819 printenv- print environment variables
2820 pwm     - control pwm channels
2821 setenv  - set environment variables
2822 saveenv - save environment variables to persistent storage
2823 protect - enable or disable FLASH write protection
2824 erase   - erase FLASH memory
2825 flinfo  - print FLASH memory information
2826 nand    - NAND memory operations (see doc/README.nand)
2827 bdinfo  - print Board Info structure
2828 iminfo  - print header information for application image
2829 coninfo - print console devices and informations
2830 ide     - IDE sub-system
2831 loop    - infinite loop on address range
2832 loopw   - infinite write loop on address range
2833 mtest   - simple RAM test
2834 icache  - enable or disable instruction cache
2835 dcache  - enable or disable data cache
2836 reset   - Perform RESET of the CPU
2837 echo    - echo args to console
2838 version - print monitor version
2839 help    - print online help
2840 ?       - alias for 'help'
2841
2842
2843 Monitor Commands - Detailed Description:
2844 ========================================
2845
2846 TODO.
2847
2848 For now: just type "help <command>".
2849
2850
2851 Note for Redundant Ethernet Interfaces:
2852 =======================================
2853
2854 Some boards come with redundant Ethernet interfaces; U-Boot supports
2855 such configurations and is capable of automatic selection of a
2856 "working" interface when needed. MAC assignment works as follows:
2857
2858 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2859 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2860 "eth1addr" (=>eth1), "eth2addr", ...
2861
2862 If the network interface stores some valid MAC address (for instance
2863 in SROM), this is used as default address if there is NO correspon-
2864 ding setting in the environment; if the corresponding environment
2865 variable is set, this overrides the settings in the card; that means:
2866
2867 o If the SROM has a valid MAC address, and there is no address in the
2868   environment, the SROM's address is used.
2869
2870 o If there is no valid address in the SROM, and a definition in the
2871   environment exists, then the value from the environment variable is
2872   used.
2873
2874 o If both the SROM and the environment contain a MAC address, and
2875   both addresses are the same, this MAC address is used.
2876
2877 o If both the SROM and the environment contain a MAC address, and the
2878   addresses differ, the value from the environment is used and a
2879   warning is printed.
2880
2881 o If neither SROM nor the environment contain a MAC address, an error
2882   is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2883   a random, locally-assigned MAC is used.
2884
2885 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
2886 will be programmed into hardware as part of the initialization process.  This
2887 may be skipped by setting the appropriate 'ethmacskip' environment variable.
2888 The naming convention is as follows:
2889 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
2890
2891 Image Formats:
2892 ==============
2893
2894 U-Boot is capable of booting (and performing other auxiliary operations on)
2895 images in two formats:
2896
2897 New uImage format (FIT)
2898 -----------------------
2899
2900 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2901 to Flattened Device Tree). It allows the use of images with multiple
2902 components (several kernels, ramdisks, etc.), with contents protected by
2903 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2904
2905
2906 Old uImage format
2907 -----------------
2908
2909 Old image format is based on binary files which can be basically anything,
2910 preceded by a special header; see the definitions in include/image.h for
2911 details; basically, the header defines the following image properties:
2912
2913 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2914   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2915   LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
2916   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
2917   INTEGRITY).
2918 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2919   IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2920   Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2921 * Compression Type (uncompressed, gzip, bzip2)
2922 * Load Address
2923 * Entry Point
2924 * Image Name
2925 * Image Timestamp
2926
2927 The header is marked by a special Magic Number, and both the header
2928 and the data portions of the image are secured against corruption by
2929 CRC32 checksums.
2930
2931
2932 Linux Support:
2933 ==============
2934
2935 Although U-Boot should support any OS or standalone application
2936 easily, the main focus has always been on Linux during the design of
2937 U-Boot.
2938
2939 U-Boot includes many features that so far have been part of some
2940 special "boot loader" code within the Linux kernel. Also, any
2941 "initrd" images to be used are no longer part of one big Linux image;
2942 instead, kernel and "initrd" are separate images. This implementation
2943 serves several purposes:
2944
2945 - the same features can be used for other OS or standalone
2946   applications (for instance: using compressed images to reduce the
2947   Flash memory footprint)
2948
2949 - it becomes much easier to port new Linux kernel versions because
2950   lots of low-level, hardware dependent stuff are done by U-Boot
2951
2952 - the same Linux kernel image can now be used with different "initrd"
2953   images; of course this also means that different kernel images can
2954   be run with the same "initrd". This makes testing easier (you don't
2955   have to build a new "zImage.initrd" Linux image when you just
2956   change a file in your "initrd"). Also, a field-upgrade of the
2957   software is easier now.
2958
2959
2960 Linux HOWTO:
2961 ============
2962
2963 Porting Linux to U-Boot based systems:
2964 ---------------------------------------
2965
2966 U-Boot cannot save you from doing all the necessary modifications to
2967 configure the Linux device drivers for use with your target hardware
2968 (no, we don't intend to provide a full virtual machine interface to
2969 Linux :-).
2970
2971 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
2972
2973 Just make sure your machine specific header file (for instance
2974 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2975 Information structure as we define in include/asm-<arch>/u-boot.h,
2976 and make sure that your definition of IMAP_ADDR uses the same value
2977 as your U-Boot configuration in CONFIG_SYS_IMMR.
2978
2979 Note that U-Boot now has a driver model, a unified model for drivers.
2980 If you are adding a new driver, plumb it into driver model. If there
2981 is no uclass available, you are encouraged to create one. See
2982 doc/driver-model.
2983
2984
2985 Configuring the Linux kernel:
2986 -----------------------------
2987
2988 No specific requirements for U-Boot. Make sure you have some root
2989 device (initial ramdisk, NFS) for your target system.
2990
2991
2992 Building a Linux Image:
2993 -----------------------
2994
2995 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2996 not used. If you use recent kernel source, a new build target
2997 "uImage" will exist which automatically builds an image usable by
2998 U-Boot. Most older kernels also have support for a "pImage" target,
2999 which was introduced for our predecessor project PPCBoot and uses a
3000 100% compatible format.
3001
3002 Example:
3003
3004         make TQM850L_defconfig
3005         make oldconfig
3006         make dep
3007         make uImage
3008
3009 The "uImage" build target uses a special tool (in 'tools/mkimage') to
3010 encapsulate a compressed Linux kernel image with header  information,
3011 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3012
3013 * build a standard "vmlinux" kernel image (in ELF binary format):
3014
3015 * convert the kernel into a raw binary image:
3016
3017         ${CROSS_COMPILE}-objcopy -O binary \
3018                                  -R .note -R .comment \
3019                                  -S vmlinux linux.bin
3020
3021 * compress the binary image:
3022
3023         gzip -9 linux.bin
3024
3025 * package compressed binary image for U-Boot:
3026
3027         mkimage -A ppc -O linux -T kernel -C gzip \
3028                 -a 0 -e 0 -n "Linux Kernel Image" \
3029                 -d linux.bin.gz uImage
3030
3031
3032 The "mkimage" tool can also be used to create ramdisk images for use
3033 with U-Boot, either separated from the Linux kernel image, or
3034 combined into one file. "mkimage" encapsulates the images with a 64
3035 byte header containing information about target architecture,
3036 operating system, image type, compression method, entry points, time
3037 stamp, CRC32 checksums, etc.
3038
3039 "mkimage" can be called in two ways: to verify existing images and
3040 print the header information, or to build new images.
3041
3042 In the first form (with "-l" option) mkimage lists the information
3043 contained in the header of an existing U-Boot image; this includes
3044 checksum verification:
3045
3046         tools/mkimage -l image
3047           -l ==> list image header information
3048
3049 The second form (with "-d" option) is used to build a U-Boot image
3050 from a "data file" which is used as image payload:
3051
3052         tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3053                       -n name -d data_file image
3054           -A ==> set architecture to 'arch'
3055           -O ==> set operating system to 'os'
3056           -T ==> set image type to 'type'
3057           -C ==> set compression type 'comp'
3058           -a ==> set load address to 'addr' (hex)
3059           -e ==> set entry point to 'ep' (hex)
3060           -n ==> set image name to 'name'
3061           -d ==> use image data from 'datafile'
3062
3063 Right now, all Linux kernels for PowerPC systems use the same load
3064 address (0x00000000), but the entry point address depends on the
3065 kernel version:
3066
3067 - 2.2.x kernels have the entry point at 0x0000000C,
3068 - 2.3.x and later kernels have the entry point at 0x00000000.
3069
3070 So a typical call to build a U-Boot image would read:
3071
3072         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3073         > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3074         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3075         > examples/uImage.TQM850L
3076         Image Name:   2.4.4 kernel for TQM850L
3077         Created:      Wed Jul 19 02:34:59 2000
3078         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3079         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3080         Load Address: 0x00000000
3081         Entry Point:  0x00000000
3082
3083 To verify the contents of the image (or check for corruption):
3084
3085         -> tools/mkimage -l examples/uImage.TQM850L
3086         Image Name:   2.4.4 kernel for TQM850L
3087         Created:      Wed Jul 19 02:34:59 2000
3088         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3089         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3090         Load Address: 0x00000000
3091         Entry Point:  0x00000000
3092
3093 NOTE: for embedded systems where boot time is critical you can trade
3094 speed for memory and install an UNCOMPRESSED image instead: this
3095 needs more space in Flash, but boots much faster since it does not
3096 need to be uncompressed:
3097
3098         -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3099         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3100         > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3101         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3102         > examples/uImage.TQM850L-uncompressed
3103         Image Name:   2.4.4 kernel for TQM850L
3104         Created:      Wed Jul 19 02:34:59 2000
3105         Image Type:   PowerPC Linux Kernel Image (uncompressed)
3106         Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3107         Load Address: 0x00000000
3108         Entry Point:  0x00000000
3109
3110
3111 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3112 when your kernel is intended to use an initial ramdisk:
3113
3114         -> tools/mkimage -n 'Simple Ramdisk Image' \
3115         > -A ppc -O linux -T ramdisk -C gzip \
3116         > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3117         Image Name:   Simple Ramdisk Image
3118         Created:      Wed Jan 12 14:01:50 2000
3119         Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3120         Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3121         Load Address: 0x00000000
3122         Entry Point:  0x00000000
3123
3124 The "dumpimage" tool can be used to disassemble or list the contents of images
3125 built by mkimage. See dumpimage's help output (-h) for details.
3126
3127 Installing a Linux Image:
3128 -------------------------
3129
3130 To downloading a U-Boot image over the serial (console) interface,
3131 you must convert the image to S-Record format:
3132
3133         objcopy -I binary -O srec examples/image examples/image.srec
3134
3135 The 'objcopy' does not understand the information in the U-Boot
3136 image header, so the resulting S-Record file will be relative to
3137 address 0x00000000. To load it to a given address, you need to
3138 specify the target address as 'offset' parameter with the 'loads'
3139 command.
3140
3141 Example: install the image to address 0x40100000 (which on the
3142 TQM8xxL is in the first Flash bank):
3143
3144         => erase 40100000 401FFFFF
3145
3146         .......... done
3147         Erased 8 sectors
3148
3149         => loads 40100000
3150         ## Ready for S-Record download ...
3151         ~>examples/image.srec
3152         1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3153         ...
3154         15989 15990 15991 15992
3155         [file transfer complete]
3156         [connected]
3157         ## Start Addr = 0x00000000
3158
3159
3160 You can check the success of the download using the 'iminfo' command;
3161 this includes a checksum verification so you can be sure no data
3162 corruption happened:
3163
3164         => imi 40100000
3165
3166         ## Checking Image at 40100000 ...
3167            Image Name:   2.2.13 for initrd on TQM850L
3168            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3169            Data Size:    335725 Bytes = 327 kB = 0 MB
3170            Load Address: 00000000
3171            Entry Point:  0000000c
3172            Verifying Checksum ... OK
3173
3174
3175 Boot Linux:
3176 -----------
3177
3178 The "bootm" command is used to boot an application that is stored in
3179 memory (RAM or Flash). In case of a Linux kernel image, the contents
3180 of the "bootargs" environment variable is passed to the kernel as
3181 parameters. You can check and modify this variable using the
3182 "printenv" and "setenv" commands:
3183
3184
3185         => printenv bootargs
3186         bootargs=root=/dev/ram
3187
3188         => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3189
3190         => printenv bootargs
3191         bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3192
3193         => bootm 40020000
3194         ## Booting Linux kernel at 40020000 ...
3195            Image Name:   2.2.13 for NFS on TQM850L
3196            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3197            Data Size:    381681 Bytes = 372 kB = 0 MB
3198            Load Address: 00000000
3199            Entry Point:  0000000c
3200            Verifying Checksum ... OK
3201            Uncompressing Kernel Image ... OK
3202         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
3203         Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3204         time_init: decrementer frequency = 187500000/60
3205         Calibrating delay loop... 49.77 BogoMIPS
3206         Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3207         ...
3208
3209 If you want to boot a Linux kernel with initial RAM disk, you pass
3210 the memory addresses of both the kernel and the initrd image (PPBCOOT
3211 format!) to the "bootm" command:
3212
3213         => imi 40100000 40200000
3214
3215         ## Checking Image at 40100000 ...
3216            Image Name:   2.2.13 for initrd on TQM850L
3217            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3218            Data Size:    335725 Bytes = 327 kB = 0 MB
3219            Load Address: 00000000
3220            Entry Point:  0000000c
3221            Verifying Checksum ... OK
3222
3223         ## Checking Image at 40200000 ...
3224            Image Name:   Simple Ramdisk Image
3225            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3226            Data Size:    566530 Bytes = 553 kB = 0 MB
3227            Load Address: 00000000
3228            Entry Point:  00000000
3229            Verifying Checksum ... OK
3230
3231         => bootm 40100000 40200000
3232         ## Booting Linux kernel at 40100000 ...
3233            Image Name:   2.2.13 for initrd on TQM850L
3234            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3235            Data Size:    335725 Bytes = 327 kB = 0 MB
3236            Load Address: 00000000
3237            Entry Point:  0000000c
3238            Verifying Checksum ... OK
3239            Uncompressing Kernel Image ... OK
3240         ## Loading RAMDisk Image at 40200000 ...
3241            Image Name:   Simple Ramdisk Image
3242            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3243            Data Size:    566530 Bytes = 553 kB = 0 MB
3244            Load Address: 00000000
3245            Entry Point:  00000000
3246            Verifying Checksum ... OK
3247            Loading Ramdisk ... OK
3248         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
3249         Boot arguments: root=/dev/ram
3250         time_init: decrementer frequency = 187500000/60
3251         Calibrating delay loop... 49.77 BogoMIPS
3252         ...
3253         RAMDISK: Compressed image found at block 0
3254         VFS: Mounted root (ext2 filesystem).
3255
3256         bash#
3257
3258 Boot Linux and pass a flat device tree:
3259 -----------
3260
3261 First, U-Boot must be compiled with the appropriate defines. See the section
3262 titled "Linux Kernel Interface" above for a more in depth explanation. The
3263 following is an example of how to start a kernel and pass an updated
3264 flat device tree:
3265
3266 => print oftaddr
3267 oftaddr=0x300000
3268 => print oft
3269 oft=oftrees/mpc8540ads.dtb
3270 => tftp $oftaddr $oft
3271 Speed: 1000, full duplex
3272 Using TSEC0 device
3273 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3274 Filename 'oftrees/mpc8540ads.dtb'.
3275 Load address: 0x300000
3276 Loading: #
3277 done
3278 Bytes transferred = 4106 (100a hex)
3279 => tftp $loadaddr $bootfile
3280 Speed: 1000, full duplex
3281 Using TSEC0 device
3282 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3283 Filename 'uImage'.
3284 Load address: 0x200000
3285 Loading:############
3286 done
3287 Bytes transferred = 1029407 (fb51f hex)
3288 => print loadaddr
3289 loadaddr=200000
3290 => print oftaddr
3291 oftaddr=0x300000
3292 => bootm $loadaddr - $oftaddr
3293 ## Booting image at 00200000 ...
3294    Image Name:   Linux-2.6.17-dirty
3295    Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3296    Data Size:    1029343 Bytes = 1005.2 kB
3297    Load Address: 00000000
3298    Entry Point:  00000000
3299    Verifying Checksum ... OK
3300    Uncompressing Kernel Image ... OK
3301 Booting using flat device tree at 0x300000
3302 Using MPC85xx ADS machine description
3303 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3304 [snip]
3305
3306
3307 More About U-Boot Image Types:
3308 ------------------------------
3309
3310 U-Boot supports the following image types:
3311
3312    "Standalone Programs" are directly runnable in the environment
3313         provided by U-Boot; it is expected that (if they behave
3314         well) you can continue to work in U-Boot after return from
3315         the Standalone Program.
3316    "OS Kernel Images" are usually images of some Embedded OS which
3317         will take over control completely. Usually these programs
3318         will install their own set of exception handlers, device
3319         drivers, set up the MMU, etc. - this means, that you cannot
3320         expect to re-enter U-Boot except by resetting the CPU.
3321    "RAMDisk Images" are more or less just data blocks, and their
3322         parameters (address, size) are passed to an OS kernel that is
3323         being started.
3324    "Multi-File Images" contain several images, typically an OS
3325         (Linux) kernel image and one or more data images like
3326         RAMDisks. This construct is useful for instance when you want
3327         to boot over the network using BOOTP etc., where the boot
3328         server provides just a single image file, but you want to get
3329         for instance an OS kernel and a RAMDisk image.
3330
3331         "Multi-File Images" start with a list of image sizes, each
3332         image size (in bytes) specified by an "uint32_t" in network
3333         byte order. This list is terminated by an "(uint32_t)0".
3334         Immediately after the terminating 0 follow the images, one by
3335         one, all aligned on "uint32_t" boundaries (size rounded up to
3336         a multiple of 4 bytes).
3337
3338    "Firmware Images" are binary images containing firmware (like
3339         U-Boot or FPGA images) which usually will be programmed to
3340         flash memory.
3341
3342    "Script files" are command sequences that will be executed by
3343         U-Boot's command interpreter; this feature is especially
3344         useful when you configure U-Boot to use a real shell (hush)
3345         as command interpreter.
3346
3347 Booting the Linux zImage:
3348 -------------------------
3349
3350 On some platforms, it's possible to boot Linux zImage. This is done
3351 using the "bootz" command. The syntax of "bootz" command is the same
3352 as the syntax of "bootm" command.
3353
3354 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
3355 kernel with raw initrd images. The syntax is slightly different, the
3356 address of the initrd must be augmented by it's size, in the following
3357 format: "<initrd addres>:<initrd size>".
3358
3359
3360 Standalone HOWTO:
3361 =================
3362
3363 One of the features of U-Boot is that you can dynamically load and
3364 run "standalone" applications, which can use some resources of
3365 U-Boot like console I/O functions or interrupt services.
3366
3367 Two simple examples are included with the sources:
3368
3369 "Hello World" Demo:
3370 -------------------
3371
3372 'examples/hello_world.c' contains a small "Hello World" Demo
3373 application; it is automatically compiled when you build U-Boot.
3374 It's configured to run at address 0x00040004, so you can play with it
3375 like that:
3376
3377         => loads
3378         ## Ready for S-Record download ...
3379         ~>examples/hello_world.srec
3380         1 2 3 4 5 6 7 8 9 10 11 ...
3381         [file transfer complete]
3382         [connected]
3383         ## Start Addr = 0x00040004
3384
3385         => go 40004 Hello World! This is a test.
3386         ## Starting application at 0x00040004 ...
3387         Hello World
3388         argc = 7
3389         argv[0] = "40004"
3390         argv[1] = "Hello"
3391         argv[2] = "World!"
3392         argv[3] = "This"
3393         argv[4] = "is"
3394         argv[5] = "a"
3395         argv[6] = "test."
3396         argv[7] = "<NULL>"
3397         Hit any key to exit ...
3398
3399         ## Application terminated, rc = 0x0
3400
3401 Another example, which demonstrates how to register a CPM interrupt
3402 handler with the U-Boot code, can be found in 'examples/timer.c'.
3403 Here, a CPM timer is set up to generate an interrupt every second.
3404 The interrupt service routine is trivial, just printing a '.'
3405 character, but this is just a demo program. The application can be
3406 controlled by the following keys:
3407
3408         ? - print current values og the CPM Timer registers
3409         b - enable interrupts and start timer
3410         e - stop timer and disable interrupts
3411         q - quit application
3412
3413         => loads
3414         ## Ready for S-Record download ...
3415         ~>examples/timer.srec
3416         1 2 3 4 5 6 7 8 9 10 11 ...
3417         [file transfer complete]
3418         [connected]
3419         ## Start Addr = 0x00040004
3420
3421         => go 40004
3422         ## Starting application at 0x00040004 ...
3423         TIMERS=0xfff00980
3424         Using timer 1
3425           tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3426
3427 Hit 'b':
3428         [q, b, e, ?] Set interval 1000000 us
3429         Enabling timer
3430 Hit '?':
3431         [q, b, e, ?] ........
3432         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3433 Hit '?':
3434         [q, b, e, ?] .
3435         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3436 Hit '?':
3437         [q, b, e, ?] .
3438         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3439 Hit '?':
3440         [q, b, e, ?] .
3441         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3442 Hit 'e':
3443         [q, b, e, ?] ...Stopping timer
3444 Hit 'q':
3445         [q, b, e, ?] ## Application terminated, rc = 0x0
3446
3447
3448 Minicom warning:
3449 ================
3450
3451 Over time, many people have reported problems when trying to use the
3452 "minicom" terminal emulation program for serial download. I (wd)
3453 consider minicom to be broken, and recommend not to use it. Under
3454 Unix, I recommend to use C-Kermit for general purpose use (and
3455 especially for kermit binary protocol download ("loadb" command), and
3456 use "cu" for S-Record download ("loads" command).  See
3457 https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
3458 for help with kermit.
3459
3460
3461 Nevertheless, if you absolutely want to use it try adding this
3462 configuration to your "File transfer protocols" section:
3463
3464            Name    Program                      Name U/D FullScr IO-Red. Multi
3465         X  kermit  /usr/bin/kermit -i -l %l -s   Y    U    Y       N      N
3466         Y  kermit  /usr/bin/kermit -i -l %l -r   N    D    Y       N      N
3467
3468
3469 NetBSD Notes:
3470 =============
3471
3472 Starting at version 0.9.2, U-Boot supports NetBSD both as host
3473 (build U-Boot) and target system (boots NetBSD/mpc8xx).
3474
3475 Building requires a cross environment; it is known to work on
3476 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3477 need gmake since the Makefiles are not compatible with BSD make).
3478 Note that the cross-powerpc package does not install include files;
3479 attempting to build U-Boot will fail because <machine/ansi.h> is
3480 missing.  This file has to be installed and patched manually:
3481
3482         # cd /usr/pkg/cross/powerpc-netbsd/include
3483         # mkdir powerpc
3484         # ln -s powerpc machine
3485         # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3486         # ${EDIT} powerpc/ansi.h        ## must remove __va_list, _BSD_VA_LIST
3487
3488 Native builds *don't* work due to incompatibilities between native
3489 and U-Boot include files.
3490
3491 Booting assumes that (the first part of) the image booted is a
3492 stage-2 loader which in turn loads and then invokes the kernel
3493 proper. Loader sources will eventually appear in the NetBSD source
3494 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3495 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3496
3497
3498 Implementation Internals:
3499 =========================
3500
3501 The following is not intended to be a complete description of every
3502 implementation detail. However, it should help to understand the
3503 inner workings of U-Boot and make it easier to port it to custom
3504 hardware.
3505
3506
3507 Initial Stack, Global Data:
3508 ---------------------------
3509
3510 The implementation of U-Boot is complicated by the fact that U-Boot
3511 starts running out of ROM (flash memory), usually without access to
3512 system RAM (because the memory controller is not initialized yet).
3513 This means that we don't have writable Data or BSS segments, and BSS
3514 is not initialized as zero. To be able to get a C environment working
3515 at all, we have to allocate at least a minimal stack. Implementation
3516 options for this are defined and restricted by the CPU used: Some CPU
3517 models provide on-chip memory (like the IMMR area on MPC8xx and
3518 MPC826x processors), on others (parts of) the data cache can be
3519 locked as (mis-) used as memory, etc.
3520
3521         Chris Hallinan posted a good summary of these issues to the
3522         U-Boot mailing list:
3523
3524         Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3525         From: "Chris Hallinan" <clh@net1plus.com>
3526         Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3527         ...
3528
3529         Correct me if I'm wrong, folks, but the way I understand it
3530         is this: Using DCACHE as initial RAM for Stack, etc, does not
3531         require any physical RAM backing up the cache. The cleverness
3532         is that the cache is being used as a temporary supply of
3533         necessary storage before the SDRAM controller is setup. It's
3534         beyond the scope of this list to explain the details, but you
3535         can see how this works by studying the cache architecture and
3536         operation in the architecture and processor-specific manuals.
3537
3538         OCM is On Chip Memory, which I believe the 405GP has 4K. It
3539         is another option for the system designer to use as an
3540         initial stack/RAM area prior to SDRAM being available. Either
3541         option should work for you. Using CS 4 should be fine if your
3542         board designers haven't used it for something that would
3543         cause you grief during the initial boot! It is frequently not
3544         used.
3545
3546         CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
3547         with your processor/board/system design. The default value
3548         you will find in any recent u-boot distribution in
3549         walnut.h should work for you. I'd set it to a value larger
3550         than your SDRAM module. If you have a 64MB SDRAM module, set
3551         it above 400_0000. Just make sure your board has no resources
3552         that are supposed to respond to that address! That code in
3553         start.S has been around a while and should work as is when
3554         you get the config right.
3555
3556         -Chris Hallinan
3557         DS4.COM, Inc.
3558
3559 It is essential to remember this, since it has some impact on the C
3560 code for the initialization procedures:
3561
3562 * Initialized global data (data segment) is read-only. Do not attempt
3563   to write it.
3564
3565 * Do not use any uninitialized global data (or implicitly initialized
3566   as zero data - BSS segment) at all - this is undefined, initiali-
3567   zation is performed later (when relocating to RAM).
3568
3569 * Stack space is very limited. Avoid big data buffers or things like
3570   that.
3571
3572 Having only the stack as writable memory limits means we cannot use
3573 normal global data to share information between the code. But it
3574 turned out that the implementation of U-Boot can be greatly
3575 simplified by making a global data structure (gd_t) available to all
3576 functions. We could pass a pointer to this data as argument to _all_
3577 functions, but this would bloat the code. Instead we use a feature of
3578 the GCC compiler (Global Register Variables) to share the data: we
3579 place a pointer (gd) to the global data into a register which we
3580 reserve for this purpose.
3581
3582 When choosing a register for such a purpose we are restricted by the
3583 relevant  (E)ABI  specifications for the current architecture, and by
3584 GCC's implementation.
3585
3586 For PowerPC, the following registers have specific use:
3587         R1:     stack pointer
3588         R2:     reserved for system use
3589         R3-R4:  parameter passing and return values
3590         R5-R10: parameter passing
3591         R13:    small data area pointer
3592         R30:    GOT pointer
3593         R31:    frame pointer
3594
3595         (U-Boot also uses R12 as internal GOT pointer. r12
3596         is a volatile register so r12 needs to be reset when
3597         going back and forth between asm and C)
3598
3599     ==> U-Boot will use R2 to hold a pointer to the global data
3600
3601     Note: on PPC, we could use a static initializer (since the
3602     address of the global data structure is known at compile time),
3603     but it turned out that reserving a register results in somewhat
3604     smaller code - although the code savings are not that big (on
3605     average for all boards 752 bytes for the whole U-Boot image,
3606     624 text + 127 data).
3607
3608 On ARM, the following registers are used:
3609
3610         R0:     function argument word/integer result
3611         R1-R3:  function argument word
3612         R9:     platform specific
3613         R10:    stack limit (used only if stack checking is enabled)
3614         R11:    argument (frame) pointer
3615         R12:    temporary workspace
3616         R13:    stack pointer
3617         R14:    link register
3618         R15:    program counter
3619
3620     ==> U-Boot will use R9 to hold a pointer to the global data
3621
3622     Note: on ARM, only R_ARM_RELATIVE relocations are supported.
3623
3624 On Nios II, the ABI is documented here:
3625         https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
3626
3627     ==> U-Boot will use gp to hold a pointer to the global data
3628
3629     Note: on Nios II, we give "-G0" option to gcc and don't use gp
3630     to access small data sections, so gp is free.
3631
3632 On NDS32, the following registers are used:
3633
3634         R0-R1:  argument/return
3635         R2-R5:  argument
3636         R15:    temporary register for assembler
3637         R16:    trampoline register
3638         R28:    frame pointer (FP)
3639         R29:    global pointer (GP)
3640         R30:    link register (LP)
3641         R31:    stack pointer (SP)
3642         PC:     program counter (PC)
3643
3644     ==> U-Boot will use R10 to hold a pointer to the global data
3645
3646 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3647 or current versions of GCC may "optimize" the code too much.
3648
3649 On RISC-V, the following registers are used:
3650
3651         x0: hard-wired zero (zero)
3652         x1: return address (ra)
3653         x2:     stack pointer (sp)
3654         x3:     global pointer (gp)
3655         x4:     thread pointer (tp)
3656         x5:     link register (t0)
3657         x8:     frame pointer (fp)
3658         x10-x11:        arguments/return values (a0-1)
3659         x12-x17:        arguments (a2-7)
3660         x28-31:  temporaries (t3-6)
3661         pc:     program counter (pc)
3662
3663     ==> U-Boot will use gp to hold a pointer to the global data
3664
3665 Memory Management:
3666 ------------------
3667
3668 U-Boot runs in system state and uses physical addresses, i.e. the
3669 MMU is not used either for address mapping nor for memory protection.
3670
3671 The available memory is mapped to fixed addresses using the memory
3672 controller. In this process, a contiguous block is formed for each
3673 memory type (Flash, SDRAM, SRAM), even when it consists of several
3674 physical memory banks.
3675
3676 U-Boot is installed in the first 128 kB of the first Flash bank (on
3677 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3678 booting and sizing and initializing DRAM, the code relocates itself
3679 to the upper end of DRAM. Immediately below the U-Boot code some
3680 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
3681 configuration setting]. Below that, a structure with global Board
3682 Info data is placed, followed by the stack (growing downward).
3683
3684 Additionally, some exception handler code is copied to the low 8 kB
3685 of DRAM (0x00000000 ... 0x00001FFF).
3686
3687 So a typical memory configuration with 16 MB of DRAM could look like
3688 this:
3689
3690         0x0000 0000     Exception Vector code
3691               :
3692         0x0000 1FFF
3693         0x0000 2000     Free for Application Use
3694               :
3695               :
3696
3697               :
3698               :
3699         0x00FB FF20     Monitor Stack (Growing downward)
3700         0x00FB FFAC     Board Info Data and permanent copy of global data
3701         0x00FC 0000     Malloc Arena
3702               :
3703         0x00FD FFFF
3704         0x00FE 0000     RAM Copy of Monitor Code
3705         ...             eventually: LCD or video framebuffer
3706         ...             eventually: pRAM (Protected RAM - unchanged by reset)
3707         0x00FF FFFF     [End of RAM]
3708
3709
3710 System Initialization:
3711 ----------------------
3712
3713 In the reset configuration, U-Boot starts at the reset entry point
3714 (on most PowerPC systems at address 0x00000100). Because of the reset
3715 configuration for CS0# this is a mirror of the on board Flash memory.
3716 To be able to re-map memory U-Boot then jumps to its link address.
3717 To be able to implement the initialization code in C, a (small!)
3718 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3719 which provide such a feature like), or in a locked part of the data
3720 cache. After that, U-Boot initializes the CPU core, the caches and
3721 the SIU.
3722
3723 Next, all (potentially) available memory banks are mapped using a
3724 preliminary mapping. For example, we put them on 512 MB boundaries
3725 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3726 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3727 programmed for SDRAM access. Using the temporary configuration, a
3728 simple memory test is run that determines the size of the SDRAM
3729 banks.
3730
3731 When there is more than one SDRAM bank, and the banks are of
3732 different size, the largest is mapped first. For equal size, the first
3733 bank (CS2#) is mapped first. The first mapping is always for address
3734 0x00000000, with any additional banks following immediately to create
3735 contiguous memory starting from 0.
3736
3737 Then, the monitor installs itself at the upper end of the SDRAM area
3738 and allocates memory for use by malloc() and for the global Board
3739 Info data; also, the exception vector code is copied to the low RAM
3740 pages, and the final stack is set up.
3741
3742 Only after this relocation will you have a "normal" C environment;
3743 until that you are restricted in several ways, mostly because you are
3744 running from ROM, and because the code will have to be relocated to a
3745 new address in RAM.
3746
3747
3748 U-Boot Porting Guide:
3749 ----------------------
3750
3751 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3752 list, October 2002]
3753
3754
3755 int main(int argc, char *argv[])
3756 {
3757         sighandler_t no_more_time;
3758
3759         signal(SIGALRM, no_more_time);
3760         alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
3761
3762         if (available_money > available_manpower) {
3763                 Pay consultant to port U-Boot;
3764                 return 0;
3765         }
3766
3767         Download latest U-Boot source;
3768
3769         Subscribe to u-boot mailing list;
3770
3771         if (clueless)
3772                 email("Hi, I am new to U-Boot, how do I get started?");
3773
3774         while (learning) {
3775                 Read the README file in the top level directory;
3776                 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
3777                 Read applicable doc/README.*;
3778                 Read the source, Luke;
3779                 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
3780         }
3781
3782         if (available_money > toLocalCurrency ($2500))
3783                 Buy a BDI3000;
3784         else
3785                 Add a lot of aggravation and time;
3786
3787         if (a similar board exists) {   /* hopefully... */
3788                 cp -a board/<similar> board/<myboard>
3789                 cp include/configs/<similar>.h include/configs/<myboard>.h
3790         } else {
3791                 Create your own board support subdirectory;
3792                 Create your own board include/configs/<myboard>.h file;
3793         }
3794         Edit new board/<myboard> files
3795         Edit new include/configs/<myboard>.h
3796
3797         while (!accepted) {
3798                 while (!running) {
3799                         do {
3800                                 Add / modify source code;
3801                         } until (compiles);
3802                         Debug;
3803                         if (clueless)
3804                                 email("Hi, I am having problems...");
3805                 }
3806                 Send patch file to the U-Boot email list;
3807                 if (reasonable critiques)
3808                         Incorporate improvements from email list code review;
3809                 else
3810                         Defend code as written;
3811         }
3812
3813         return 0;
3814 }
3815
3816 void no_more_time (int sig)
3817 {
3818       hire_a_guru();
3819 }
3820
3821
3822 Coding Standards:
3823 -----------------
3824
3825 All contributions to U-Boot should conform to the Linux kernel
3826 coding style; see the kernel coding style guide at
3827 https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3828 script "scripts/Lindent" in your Linux kernel source directory.
3829
3830 Source files originating from a different project (for example the
3831 MTD subsystem) are generally exempt from these guidelines and are not
3832 reformatted to ease subsequent migration to newer versions of those
3833 sources.
3834
3835 Please note that U-Boot is implemented in C (and to some small parts in
3836 Assembler); no C++ is used, so please do not use C++ style comments (//)
3837 in your code.
3838
3839 Please also stick to the following formatting rules:
3840 - remove any trailing white space
3841 - use TAB characters for indentation and vertical alignment, not spaces
3842 - make sure NOT to use DOS '\r\n' line feeds
3843 - do not add more than 2 consecutive empty lines to source files
3844 - do not add trailing empty lines to source files
3845
3846 Submissions which do not conform to the standards may be returned
3847 with a request to reformat the changes.
3848
3849
3850 Submitting Patches:
3851 -------------------
3852
3853 Since the number of patches for U-Boot is growing, we need to
3854 establish some rules. Submissions which do not conform to these rules
3855 may be rejected, even when they contain important and valuable stuff.
3856
3857 Please see https://www.denx.de/wiki/U-Boot/Patches for details.
3858
3859 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
3860 see https://lists.denx.de/listinfo/u-boot
3861
3862 When you send a patch, please include the following information with
3863 it:
3864
3865 * For bug fixes: a description of the bug and how your patch fixes
3866   this bug. Please try to include a way of demonstrating that the
3867   patch actually fixes something.
3868
3869 * For new features: a description of the feature and your
3870   implementation.
3871
3872 * For major contributions, add a MAINTAINERS file with your
3873   information and associated file and directory references.
3874
3875 * When you add support for a new board, don't forget to add a
3876   maintainer e-mail address to the boards.cfg file, too.
3877
3878 * If your patch adds new configuration options, don't forget to
3879   document these in the README file.
3880
3881 * The patch itself. If you are using git (which is *strongly*
3882   recommended) you can easily generate the patch using the
3883   "git format-patch". If you then use "git send-email" to send it to
3884   the U-Boot mailing list, you will avoid most of the common problems
3885   with some other mail clients.
3886
3887   If you cannot use git, use "diff -purN OLD NEW". If your version of
3888   diff does not support these options, then get the latest version of
3889   GNU diff.
3890
3891   The current directory when running this command shall be the parent
3892   directory of the U-Boot source tree (i. e. please make sure that
3893   your patch includes sufficient directory information for the
3894   affected files).
3895
3896   We prefer patches as plain text. MIME attachments are discouraged,
3897   and compressed attachments must not be used.
3898
3899 * If one logical set of modifications affects or creates several
3900   files, all these changes shall be submitted in a SINGLE patch file.
3901
3902 * Changesets that contain different, unrelated modifications shall be
3903   submitted as SEPARATE patches, one patch per changeset.
3904
3905
3906 Notes:
3907
3908 * Before sending the patch, run the buildman script on your patched
3909   source tree and make sure that no errors or warnings are reported
3910   for any of the boards.
3911
3912 * Keep your modifications to the necessary minimum: A patch
3913   containing several unrelated changes or arbitrary reformats will be
3914   returned with a request to re-formatting / split it.
3915
3916 * If you modify existing code, make sure that your new code does not
3917   add to the memory footprint of the code ;-) Small is beautiful!
3918   When adding new features, these should compile conditionally only
3919   (using #ifdef), and the resulting code with the new feature
3920   disabled must not need more memory than the old code without your
3921   modification.
3922
3923 * Remember that there is a size limit of 100 kB per message on the
3924   u-boot mailing list. Bigger patches will be moderated. If they are
3925   reasonable and not too big, they will be acknowledged. But patches
3926   bigger than the size limit should be avoided.