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