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