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