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