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