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