]> git.kernelconcepts.de Git - karo-tx-uboot.git/blob - README
fdt: Add ft_system_setup() function for system device tree additions
[karo-tx-uboot.git] / README
1 #
2 # (C) Copyright 2000 - 2013
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 #
5 # SPDX-License-Identifier:      GPL-2.0+
6 #
7
8 Summary:
9 ========
10
11 This directory contains the source code for U-Boot, a boot loader for
12 Embedded boards based on PowerPC, ARM, MIPS and several other
13 processors, which can be installed in a boot ROM and used to
14 initialize and test the hardware or to download and run application
15 code.
16
17 The development of U-Boot is closely related to Linux: some parts of
18 the source code originate in the Linux source tree, we have some
19 header files in common, and special provision has been made to
20 support booting of Linux images.
21
22 Some attention has been paid to make this software easily
23 configurable and extendable. For instance, all monitor commands are
24 implemented with the same call interface, so that it's very easy to
25 add new commands. Also, instead of permanently adding rarely used
26 code (for instance hardware test utilities) to the monitor, you can
27 load and run it dynamically.
28
29
30 Status:
31 =======
32
33 In general, all boards for which a configuration option exists in the
34 Makefile have been tested to some extent and can be considered
35 "working". In fact, many of them are used in production systems.
36
37 In case of problems see the CHANGELOG and CREDITS files to find out
38 who contributed the specific port. The boards.cfg file lists board
39 maintainers.
40
41 Note: There is no CHANGELOG file in the actual U-Boot source tree;
42 it can be created dynamically 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 http://lists.denx.de/pipermail/u-boot and
55 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56
57
58 Where to get source code:
59 =========================
60
61 The U-Boot source code is maintained in the git repository at
62 git://www.denx.de/git/u-boot.git ; you can browse it online at
63 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65 The "snapshot" links on this page allow you to download tarballs of
66 any version you might be interested in. Official releases are also
67 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68 directory.
69
70 Pre-built (and tested) images are available from
71 ftp://ftp.denx.de/pub/u-boot/images/
72
73
74 Where we come from:
75 ===================
76
77 - start from 8xxrom sources
78 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79 - clean up code
80 - make it easier to add custom boards
81 - make it possible to add other [PowerPC] CPUs
82 - extend functions, especially:
83   * Provide extended interface to Linux boot loader
84   * S-Record download
85   * network boot
86   * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87 - create ARMBoot project (http://sourceforge.net/projects/armboot)
88 - add other CPU families (starting with ARM)
89 - create U-Boot project (http://sourceforge.net/projects/u-boot)
90 - current project page: see http://www.denx.de/wiki/U-Boot
91
92
93 Names and Spelling:
94 ===================
95
96 The "official" name of this project is "Das U-Boot". The spelling
97 "U-Boot" shall be used in all written text (documentation, comments
98 in source files etc.). Example:
99
100         This is the README file for the U-Boot project.
101
102 File names etc. shall be based on the string "u-boot". Examples:
103
104         include/asm-ppc/u-boot.h
105
106         #include <asm/u-boot.h>
107
108 Variable names, preprocessor constants etc. shall be either based on
109 the string "u_boot" or on "U_BOOT". Example:
110
111         U_BOOT_VERSION          u_boot_logo
112         IH_OS_U_BOOT            u_boot_hush_start
113
114
115 Versioning:
116 ===========
117
118 Starting with the release in October 2008, the names of the releases
119 were changed from numerical release numbers without deeper meaning
120 into a time stamp based numbering. Regular releases are identified by
121 names consisting of the calendar year and month of the release date.
122 Additional fields (if present) indicate release candidates or bug fix
123 releases in "stable" maintenance trees.
124
125 Examples:
126         U-Boot v2009.11     - Release November 2009
127         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128         U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
129
130
131 Directory Hierarchy:
132 ====================
133
134 /arch                   Architecture specific files
135   /arc                  Files generic to ARC architecture
136     /cpu                CPU specific files
137       /arc700           Files specific to ARC 700 CPUs
138     /lib                Architecture specific library files
139   /arm                  Files generic to ARM architecture
140     /cpu                CPU specific files
141       /arm720t          Files specific to ARM 720 CPUs
142       /arm920t          Files specific to ARM 920 CPUs
143         /at91           Files specific to Atmel AT91RM9200 CPU
144         /imx            Files specific to Freescale MC9328 i.MX CPUs
145         /s3c24x0        Files specific to Samsung S3C24X0 CPUs
146       /arm926ejs        Files specific to ARM 926 CPUs
147       /arm1136          Files specific to ARM 1136 CPUs
148       /pxa              Files specific to Intel XScale PXA CPUs
149       /sa1100           Files specific to Intel StrongARM SA1100 CPUs
150     /lib                Architecture specific library files
151   /avr32                Files generic to AVR32 architecture
152     /cpu                CPU specific files
153     /lib                Architecture specific library files
154   /blackfin             Files generic to Analog Devices Blackfin architecture
155     /cpu                CPU specific files
156     /lib                Architecture specific library files
157   /m68k                 Files generic to m68k architecture
158     /cpu                CPU specific files
159       /mcf52x2          Files specific to Freescale ColdFire MCF52x2 CPUs
160       /mcf5227x         Files specific to Freescale ColdFire MCF5227x CPUs
161       /mcf532x          Files specific to Freescale ColdFire MCF5329 CPUs
162       /mcf5445x         Files specific to Freescale ColdFire MCF5445x CPUs
163       /mcf547x_8x       Files specific to Freescale ColdFire MCF547x_8x CPUs
164     /lib                Architecture specific library files
165   /microblaze           Files generic to microblaze architecture
166     /cpu                CPU specific files
167     /lib                Architecture specific library files
168   /mips                 Files generic to MIPS architecture
169     /cpu                CPU specific files
170       /mips32           Files specific to MIPS32 CPUs
171       /mips64           Files specific to MIPS64 CPUs
172     /lib                Architecture specific library files
173   /nds32                Files generic to NDS32 architecture
174     /cpu                CPU specific files
175       /n1213            Files specific to Andes Technology N1213 CPUs
176     /lib                Architecture specific library files
177   /nios2                Files generic to Altera NIOS2 architecture
178     /cpu                CPU specific files
179     /lib                Architecture specific library files
180   /openrisc             Files generic to OpenRISC architecture
181     /cpu                CPU specific files
182     /lib                Architecture specific library files
183   /powerpc              Files generic to PowerPC architecture
184     /cpu                CPU specific files
185       /74xx_7xx         Files specific to Freescale MPC74xx and 7xx CPUs
186       /mpc5xx           Files specific to Freescale MPC5xx CPUs
187       /mpc5xxx          Files specific to Freescale MPC5xxx CPUs
188       /mpc8xx           Files specific to Freescale MPC8xx CPUs
189       /mpc824x          Files specific to Freescale MPC824x CPUs
190       /mpc8260          Files specific to Freescale MPC8260 CPUs
191       /mpc85xx          Files specific to Freescale MPC85xx CPUs
192       /ppc4xx           Files specific to AMCC PowerPC 4xx CPUs
193     /lib                Architecture specific library files
194   /sh                   Files generic to SH architecture
195     /cpu                CPU specific files
196       /sh2              Files specific to sh2 CPUs
197       /sh3              Files specific to sh3 CPUs
198       /sh4              Files specific to sh4 CPUs
199     /lib                Architecture specific library files
200   /sparc                Files generic to SPARC architecture
201     /cpu                CPU specific files
202       /leon2            Files specific to Gaisler LEON2 SPARC CPU
203       /leon3            Files specific to Gaisler LEON3 SPARC CPU
204     /lib                Architecture specific library files
205   /x86                  Files generic to x86 architecture
206     /cpu                CPU specific files
207     /lib                Architecture specific library files
208 /api                    Machine/arch independent API for external apps
209 /board                  Board dependent files
210 /common                 Misc architecture independent functions
211 /disk                   Code for disk drive partition handling
212 /doc                    Documentation (don't expect too much)
213 /drivers                Commonly used device drivers
214 /dts                    Contains Makefile for building internal U-Boot fdt.
215 /examples               Example code for standalone applications, etc.
216 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
217 /include                Header Files
218 /lib                    Files generic to all architectures
219   /libfdt               Library files to support flattened device trees
220   /lzma                 Library files to support LZMA decompression
221   /lzo                  Library files to support LZO decompression
222 /net                    Networking code
223 /post                   Power On Self Test
224 /spl                    Secondary Program Loader framework
225 /tools                  Tools to build S-Record or U-Boot images, etc.
226
227 Software Configuration:
228 =======================
229
230 Configuration is usually done using C preprocessor defines; the
231 rationale behind that is to avoid dead code whenever possible.
232
233 There are two classes of configuration variables:
234
235 * Configuration _OPTIONS_:
236   These are selectable by the user and have names beginning with
237   "CONFIG_".
238
239 * Configuration _SETTINGS_:
240   These depend on the hardware etc. and should not be meddled with if
241   you don't know what you're doing; they have names beginning with
242   "CONFIG_SYS_".
243
244 Later we will add a configuration tool - probably similar to or even
245 identical to what's used for the Linux kernel. Right now, we have to
246 do the configuration by hand, which means creating some symbolic
247 links and editing some configuration files. We use the TQM8xxL boards
248 as an example here.
249
250
251 Selection of Processor Architecture and Board Type:
252 ---------------------------------------------------
253
254 For all supported boards there are ready-to-use default
255 configurations available; just type "make <board_name>_defconfig".
256
257 Example: For a TQM823L module type:
258
259         cd u-boot
260         make TQM823L_defconfig
261
262 For the Cogent platform, you need to specify the CPU type as well;
263 e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
264 directory according to the instructions in cogent/README.
265
266
267 Sandbox Environment:
268 --------------------
269
270 U-Boot can be built natively to run on a Linux host using the 'sandbox'
271 board. This allows feature development which is not board- or architecture-
272 specific to be undertaken on a native platform. The sandbox is also used to
273 run some of U-Boot's tests.
274
275 See board/sandbox/README.sandbox for more details.
276
277
278 Configuration Options:
279 ----------------------
280
281 Configuration depends on the combination of board and CPU type; all
282 such information is kept in a configuration file
283 "include/configs/<board_name>.h".
284
285 Example: For a TQM823L module, all configuration settings are in
286 "include/configs/TQM823L.h".
287
288
289 Many of the options are named exactly as the corresponding Linux
290 kernel configuration options. The intention is to make it easier to
291 build a config tool - later.
292
293
294 The following options need to be configured:
295
296 - CPU Type:     Define exactly one, e.g. CONFIG_MPC85XX.
297
298 - Board Type:   Define exactly one, e.g. CONFIG_MPC8540ADS.
299
300 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
301                 Define exactly one, e.g. CONFIG_ATSTK1002
302
303 - CPU Module Type: (if CONFIG_COGENT is defined)
304                 Define exactly one of
305                 CONFIG_CMA286_60_OLD
306 --- FIXME --- not tested yet:
307                 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308                 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310 - Motherboard Type: (if CONFIG_COGENT is defined)
311                 Define exactly one of
312                 CONFIG_CMA101, CONFIG_CMA102
313
314 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315                 Define one or more of
316                 CONFIG_CMA302
317
318 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319                 Define one or more of
320                 CONFIG_LCD_HEARTBEAT    - update a character position on
321                                           the LCD display every second with
322                                           a "rotator" |\-/|\-/
323
324 - Marvell Family Member
325                 CONFIG_SYS_MVFS         - define it if you want to enable
326                                           multiple fs option at one time
327                                           for marvell soc family
328
329 - MPC824X Family Member (if CONFIG_MPC824X is defined)
330                 Define exactly one of
331                 CONFIG_MPC8240, CONFIG_MPC8245
332
333 - 8xx CPU Options: (if using an MPC8xx CPU)
334                 CONFIG_8xx_GCLK_FREQ    - deprecated: CPU clock if
335                                           get_gclk_freq() cannot work
336                                           e.g. if there is no 32KHz
337                                           reference PIT/RTC clock
338                 CONFIG_8xx_OSCLK        - PLL input clock (either EXTCLK
339                                           or XTAL/EXTAL)
340
341 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
342                 CONFIG_SYS_8xx_CPUCLK_MIN
343                 CONFIG_SYS_8xx_CPUCLK_MAX
344                 CONFIG_8xx_CPUCLK_DEFAULT
345                         See doc/README.MPC866
346
347                 CONFIG_SYS_MEASURE_CPUCLK
348
349                 Define this to measure the actual CPU clock instead
350                 of relying on the correctness of the configured
351                 values. Mostly useful for board bringup to make sure
352                 the PLL is locked at the intended frequency. Note
353                 that this requires a (stable) reference clock (32 kHz
354                 RTC clock or CONFIG_SYS_8XX_XIN)
355
356                 CONFIG_SYS_DELAYED_ICACHE
357
358                 Define this option if you want to enable the
359                 ICache only when Code runs from RAM.
360
361 - 85xx CPU Options:
362                 CONFIG_SYS_PPC64
363
364                 Specifies that the core is a 64-bit PowerPC implementation (implements
365                 the "64" category of the Power ISA). This is necessary for ePAPR
366                 compliance, among other possible reasons.
367
368                 CONFIG_SYS_FSL_TBCLK_DIV
369
370                 Defines the core time base clock divider ratio compared to the
371                 system clock.  On most PQ3 devices this is 8, on newer QorIQ
372                 devices it can be 16 or 32.  The ratio varies from SoC to Soc.
373
374                 CONFIG_SYS_FSL_PCIE_COMPAT
375
376                 Defines the string to utilize when trying to match PCIe device
377                 tree nodes for the given platform.
378
379                 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381                 Enables a temporary TLB entry to be used during boot to work
382                 around limitations in e500v1 and e500v2 external debugger
383                 support. This reduces the portions of the boot code where
384                 breakpoints and single stepping do not work.  The value of this
385                 symbol should be set to the TLB1 entry to be used for this
386                 purpose.
387
388                 CONFIG_SYS_FSL_ERRATUM_A004510
389
390                 Enables a workaround for erratum A004510.  If set,
391                 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397                 Defines one or two SoC revisions (low 8 bits of SVR)
398                 for which the A004510 workaround should be applied.
399
400                 The rest of SVR is either not relevant to the decision
401                 of whether the erratum is present (e.g. p2040 versus
402                 p2041) or is implied by the build target, which controls
403                 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405                 See Freescale App Note 4493 for more information about
406                 this erratum.
407
408                 CONFIG_A003399_NOR_WORKAROUND
409                 Enables a workaround for IFC erratum A003399. It is only
410                 requred during NOR boot.
411
412                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414                 This is the value to write into CCSR offset 0x18600
415                 according to the A004510 workaround.
416
417                 CONFIG_SYS_FSL_DSP_DDR_ADDR
418                 This value denotes start offset of DDR memory which is
419                 connected exclusively to the DSP cores.
420
421                 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422                 This value denotes start offset of M2 memory
423                 which is directly connected to the DSP core.
424
425                 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426                 This value denotes start offset of M3 memory which is directly
427                 connected to the DSP core.
428
429                 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430                 This value denotes start offset of DSP CCSR space.
431
432                 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433                 Single Source Clock is clocking mode present in some of FSL SoC's.
434                 In this mode, a single differential clock is used to supply
435                 clocks to the sysclock, ddrclock and usbclock.
436
437                 CONFIG_SYS_CPC_REINIT_F
438                 This CONFIG is defined when the CPC is configured as SRAM at the
439                 time of U-boot entry and is required to be re-initialized.
440
441                 CONFIG_DEEP_SLEEP
442                 Inidcates this SoC supports deep sleep feature. If deep sleep is
443                 supported, core will start to execute uboot when wakes up.
444
445 - Generic CPU options:
446                 CONFIG_SYS_GENERIC_GLOBAL_DATA
447                 Defines global data is initialized in generic board board_init_f().
448                 If this macro is defined, global data is created and cleared in
449                 generic board board_init_f(). Without this macro, architecture/board
450                 should initialize global data before calling board_init_f().
451
452                 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454                 Defines the endianess of the CPU. Implementation of those
455                 values is arch specific.
456
457                 CONFIG_SYS_FSL_DDR
458                 Freescale DDR driver in use. This type of DDR controller is
459                 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460                 SoCs.
461
462                 CONFIG_SYS_FSL_DDR_ADDR
463                 Freescale DDR memory-mapped register base.
464
465                 CONFIG_SYS_FSL_DDR_EMU
466                 Specify emulator support for DDR. Some DDR features such as
467                 deskew training are not available.
468
469                 CONFIG_SYS_FSL_DDRC_GEN1
470                 Freescale DDR1 controller.
471
472                 CONFIG_SYS_FSL_DDRC_GEN2
473                 Freescale DDR2 controller.
474
475                 CONFIG_SYS_FSL_DDRC_GEN3
476                 Freescale DDR3 controller.
477
478                 CONFIG_SYS_FSL_DDRC_GEN4
479                 Freescale DDR4 controller.
480
481                 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482                 Freescale DDR3 controller for ARM-based SoCs.
483
484                 CONFIG_SYS_FSL_DDR1
485                 Board config to use DDR1. It can be enabled for SoCs with
486                 Freescale DDR1 or DDR2 controllers, depending on the board
487                 implemetation.
488
489                 CONFIG_SYS_FSL_DDR2
490                 Board config to use DDR2. It can be eanbeld for SoCs with
491                 Freescale DDR2 or DDR3 controllers, depending on the board
492                 implementation.
493
494                 CONFIG_SYS_FSL_DDR3
495                 Board config to use DDR3. It can be enabled for SoCs with
496                 Freescale DDR3 or DDR3L controllers.
497
498                 CONFIG_SYS_FSL_DDR3L
499                 Board config to use DDR3L. It can be enabled for SoCs with
500                 DDR3L controllers.
501
502                 CONFIG_SYS_FSL_DDR4
503                 Board config to use DDR4. It can be enabled for SoCs with
504                 DDR4 controllers.
505
506                 CONFIG_SYS_FSL_IFC_BE
507                 Defines the IFC controller register space as Big Endian
508
509                 CONFIG_SYS_FSL_IFC_LE
510                 Defines the IFC controller register space as Little Endian
511
512                 CONFIG_SYS_FSL_PBL_PBI
513                 It enables addition of RCW (Power on reset configuration) in built image.
514                 Please refer doc/README.pblimage for more details
515
516                 CONFIG_SYS_FSL_PBL_RCW
517                 It adds PBI(pre-boot instructions) commands in u-boot build image.
518                 PBI commands can be used to configure SoC before it starts the execution.
519                 Please refer doc/README.pblimage for more details
520
521                 CONFIG_SPL_FSL_PBL
522                 It adds a target to create boot binary having SPL binary in PBI format
523                 concatenated with u-boot binary.
524
525                 CONFIG_SYS_FSL_DDR_BE
526                 Defines the DDR controller register space as Big Endian
527
528                 CONFIG_SYS_FSL_DDR_LE
529                 Defines the DDR controller register space as Little Endian
530
531                 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532                 Physical address from the view of DDR controllers. It is the
533                 same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
534                 it could be different for ARM SoCs.
535
536                 CONFIG_SYS_FSL_DDR_INTLV_256B
537                 DDR controller interleaving on 256-byte. This is a special
538                 interleaving mode, handled by Dickens for Freescale layerscape
539                 SoCs with ARM core.
540
541                 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
542                 Number of controllers used as main memory.
543
544                 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
545                 Number of controllers used for other than main memory.
546
547                 CONFIG_SYS_FSL_SEC_BE
548                 Defines the SEC controller register space as Big Endian
549
550                 CONFIG_SYS_FSL_SEC_LE
551                 Defines the SEC controller register space as Little Endian
552
553 - Intel Monahans options:
554                 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
555
556                 Defines the Monahans run mode to oscillator
557                 ratio. Valid values are 8, 16, 24, 31. The core
558                 frequency is this value multiplied by 13 MHz.
559
560                 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
561
562                 Defines the Monahans turbo mode to oscillator
563                 ratio. Valid values are 1 (default if undefined) and
564                 2. The core frequency as calculated above is multiplied
565                 by this value.
566
567 - MIPS CPU options:
568                 CONFIG_SYS_INIT_SP_OFFSET
569
570                 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
571                 pointer. This is needed for the temporary stack before
572                 relocation.
573
574                 CONFIG_SYS_MIPS_CACHE_MODE
575
576                 Cache operation mode for the MIPS CPU.
577                 See also arch/mips/include/asm/mipsregs.h.
578                 Possible values are:
579                         CONF_CM_CACHABLE_NO_WA
580                         CONF_CM_CACHABLE_WA
581                         CONF_CM_UNCACHED
582                         CONF_CM_CACHABLE_NONCOHERENT
583                         CONF_CM_CACHABLE_CE
584                         CONF_CM_CACHABLE_COW
585                         CONF_CM_CACHABLE_CUW
586                         CONF_CM_CACHABLE_ACCELERATED
587
588                 CONFIG_SYS_XWAY_EBU_BOOTCFG
589
590                 Special option for Lantiq XWAY SoCs for booting from NOR flash.
591                 See also arch/mips/cpu/mips32/start.S.
592
593                 CONFIG_XWAY_SWAP_BYTES
594
595                 Enable compilation of tools/xway-swap-bytes needed for Lantiq
596                 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
597                 be swapped if a flash programmer is used.
598
599 - ARM options:
600                 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
601
602                 Select high exception vectors of the ARM core, e.g., do not
603                 clear the V bit of the c1 register of CP15.
604
605                 CONFIG_SYS_THUMB_BUILD
606
607                 Use this flag to build U-Boot using the Thumb instruction
608                 set for ARM architectures. Thumb instruction set provides
609                 better code density. For ARM architectures that support
610                 Thumb2 this flag will result in Thumb2 code generated by
611                 GCC.
612
613                 CONFIG_ARM_ERRATA_716044
614                 CONFIG_ARM_ERRATA_742230
615                 CONFIG_ARM_ERRATA_743622
616                 CONFIG_ARM_ERRATA_751472
617                 CONFIG_ARM_ERRATA_794072
618                 CONFIG_ARM_ERRATA_761320
619
620                 If set, the workarounds for these ARM errata are applied early
621                 during U-Boot startup. Note that these options force the
622                 workarounds to be applied; no CPU-type/version detection
623                 exists, unlike the similar options in the Linux kernel. Do not
624                 set these options unless they apply!
625
626 - Linux Kernel Interface:
627                 CONFIG_CLOCKS_IN_MHZ
628
629                 U-Boot stores all clock information in Hz
630                 internally. For binary compatibility with older Linux
631                 kernels (which expect the clocks passed in the
632                 bd_info data to be in MHz) the environment variable
633                 "clocks_in_mhz" can be defined so that U-Boot
634                 converts clock data to MHZ before passing it to the
635                 Linux kernel.
636                 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
637                 "clocks_in_mhz=1" is automatically included in the
638                 default environment.
639
640                 CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
641
642                 When transferring memsize parameter to linux, some versions
643                 expect it to be in bytes, others in MB.
644                 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
645
646                 CONFIG_OF_LIBFDT
647
648                 New kernel versions are expecting firmware settings to be
649                 passed using flattened device trees (based on open firmware
650                 concepts).
651
652                 CONFIG_OF_LIBFDT
653                  * New libfdt-based support
654                  * Adds the "fdt" command
655                  * The bootm command automatically updates the fdt
656
657                 OF_CPU - The proper name of the cpus node (only required for
658                         MPC512X and MPC5xxx based boards).
659                 OF_SOC - The proper name of the soc node (only required for
660                         MPC512X and MPC5xxx based boards).
661                 OF_TBCLK - The timebase frequency.
662                 OF_STDOUT_PATH - The path to the console device
663
664                 boards with QUICC Engines require OF_QE to set UCC MAC
665                 addresses
666
667                 CONFIG_OF_BOARD_SETUP
668
669                 Board code has addition modification that it wants to make
670                 to the flat device tree before handing it off to the kernel
671
672                 CONFIG_OF_SYSTEM_SETUP
673
674                 Other code has addition modification that it wants to make
675                 to the flat device tree before handing it off to the kernel.
676                 This causes ft_system_setup() to be called before booting
677                 the kernel.
678
679                 CONFIG_OF_BOOT_CPU
680
681                 This define fills in the correct boot CPU in the boot
682                 param header, the default value is zero if undefined.
683
684                 CONFIG_OF_IDE_FIXUP
685
686                 U-Boot can detect if an IDE device is present or not.
687                 If not, and this new config option is activated, U-Boot
688                 removes the ATA node from the DTS before booting Linux,
689                 so the Linux IDE driver does not probe the device and
690                 crash. This is needed for buggy hardware (uc101) where
691                 no pull down resistor is connected to the signal IDE5V_DD7.
692
693                 CONFIG_MACH_TYPE        [relevant for ARM only][mandatory]
694
695                 This setting is mandatory for all boards that have only one
696                 machine type and must be used to specify the machine type
697                 number as it appears in the ARM machine registry
698                 (see http://www.arm.linux.org.uk/developer/machines/).
699                 Only boards that have multiple machine types supported
700                 in a single configuration file and the machine type is
701                 runtime discoverable, do not have to use this setting.
702
703 - vxWorks boot parameters:
704
705                 bootvx constructs a valid bootline using the following
706                 environments variables: bootfile, ipaddr, serverip, hostname.
707                 It loads the vxWorks image pointed bootfile.
708
709                 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
710                 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
711                 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
712                 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
713
714                 CONFIG_SYS_VXWORKS_ADD_PARAMS
715
716                 Add it at the end of the bootline. E.g "u=username pw=secret"
717
718                 Note: If a "bootargs" environment is defined, it will overwride
719                 the defaults discussed just above.
720
721 - Cache Configuration:
722                 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
723                 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
724                 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
725
726 - Cache Configuration for ARM:
727                 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
728                                       controller
729                 CONFIG_SYS_PL310_BASE - Physical base address of PL310
730                                         controller register space
731
732 - Serial Ports:
733                 CONFIG_PL010_SERIAL
734
735                 Define this if you want support for Amba PrimeCell PL010 UARTs.
736
737                 CONFIG_PL011_SERIAL
738
739                 Define this if you want support for Amba PrimeCell PL011 UARTs.
740
741                 CONFIG_PL011_CLOCK
742
743                 If you have Amba PrimeCell PL011 UARTs, set this variable to
744                 the clock speed of the UARTs.
745
746                 CONFIG_PL01x_PORTS
747
748                 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
749                 define this to a list of base addresses for each (supported)
750                 port. See e.g. include/configs/versatile.h
751
752                 CONFIG_PL011_SERIAL_RLCR
753
754                 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
755                 have separate receive and transmit line control registers.  Set
756                 this variable to initialize the extra register.
757
758                 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
759
760                 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
761                 boot loader that has already initialized the UART.  Define this
762                 variable to flush the UART at init time.
763
764                 CONFIG_SERIAL_HW_FLOW_CONTROL
765
766                 Define this variable to enable hw flow control in serial driver.
767                 Current user of this option is drivers/serial/nsl16550.c driver
768
769 - Console Interface:
770                 Depending on board, define exactly one serial port
771                 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
772                 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
773                 console by defining CONFIG_8xx_CONS_NONE
774
775                 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
776                 port routines must be defined elsewhere
777                 (i.e. serial_init(), serial_getc(), ...)
778
779                 CONFIG_CFB_CONSOLE
780                 Enables console device for a color framebuffer. Needs following
781                 defines (cf. smiLynxEM, i8042)
782                         VIDEO_FB_LITTLE_ENDIAN  graphic memory organisation
783                                                 (default big endian)
784                         VIDEO_HW_RECTFILL       graphic chip supports
785                                                 rectangle fill
786                                                 (cf. smiLynxEM)
787                         VIDEO_HW_BITBLT         graphic chip supports
788                                                 bit-blit (cf. smiLynxEM)
789                         VIDEO_VISIBLE_COLS      visible pixel columns
790                                                 (cols=pitch)
791                         VIDEO_VISIBLE_ROWS      visible pixel rows
792                         VIDEO_PIXEL_SIZE        bytes per pixel
793                         VIDEO_DATA_FORMAT       graphic data format
794                                                 (0-5, cf. cfb_console.c)
795                         VIDEO_FB_ADRS           framebuffer address
796                         VIDEO_KBD_INIT_FCT      keyboard int fct
797                                                 (i.e. i8042_kbd_init())
798                         VIDEO_TSTC_FCT          test char fct
799                                                 (i.e. i8042_tstc)
800                         VIDEO_GETC_FCT          get char fct
801                                                 (i.e. i8042_getc)
802                         CONFIG_CONSOLE_CURSOR   cursor drawing on/off
803                                                 (requires blink timer
804                                                 cf. i8042.c)
805                         CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
806                         CONFIG_CONSOLE_TIME     display time/date info in
807                                                 upper right corner
808                                                 (requires CONFIG_CMD_DATE)
809                         CONFIG_VIDEO_LOGO       display Linux logo in
810                                                 upper left corner
811                         CONFIG_VIDEO_BMP_LOGO   use bmp_logo.h instead of
812                                                 linux_logo.h for logo.
813                                                 Requires CONFIG_VIDEO_LOGO
814                         CONFIG_CONSOLE_EXTRA_INFO
815                                                 additional board info beside
816                                                 the logo
817
818                 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
819                 a limited number of ANSI escape sequences (cursor control,
820                 erase functions and limited graphics rendition control).
821
822                 When CONFIG_CFB_CONSOLE is defined, video console is
823                 default i/o. Serial console can be forced with
824                 environment 'console=serial'.
825
826                 When CONFIG_SILENT_CONSOLE is defined, all console
827                 messages (by U-Boot and Linux!) can be silenced with
828                 the "silent" environment variable. See
829                 doc/README.silent for more information.
830
831                 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
832                         is 0x00.
833                 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
834                         is 0xa0.
835
836 - Console Baudrate:
837                 CONFIG_BAUDRATE - in bps
838                 Select one of the baudrates listed in
839                 CONFIG_SYS_BAUDRATE_TABLE, see below.
840                 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
841
842 - Console Rx buffer length
843                 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
844                 the maximum receive buffer length for the SMC.
845                 This option is actual only for 82xx and 8xx possible.
846                 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
847                 must be defined, to setup the maximum idle timeout for
848                 the SMC.
849
850 - Pre-Console Buffer:
851                 Prior to the console being initialised (i.e. serial UART
852                 initialised etc) all console output is silently discarded.
853                 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
854                 buffer any console messages prior to the console being
855                 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
856                 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
857                 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
858                 bytes are output before the console is initialised, the
859                 earlier bytes are discarded.
860
861                 'Sane' compilers will generate smaller code if
862                 CONFIG_PRE_CON_BUF_SZ is a power of 2
863
864 - Safe printf() functions
865                 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
866                 the printf() functions. These are defined in
867                 include/vsprintf.h and include snprintf(), vsnprintf() and
868                 so on. Code size increase is approximately 300-500 bytes.
869                 If this option is not given then these functions will
870                 silently discard their buffer size argument - this means
871                 you are not getting any overflow checking in this case.
872
873 - Boot Delay:   CONFIG_BOOTDELAY - in seconds
874                 Delay before automatically booting the default image;
875                 set to -1 to disable autoboot.
876                 set to -2 to autoboot with no delay and not check for abort
877                 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
878
879                 See doc/README.autoboot for these options that
880                 work with CONFIG_BOOTDELAY. None are required.
881                 CONFIG_BOOT_RETRY_TIME
882                 CONFIG_BOOT_RETRY_MIN
883                 CONFIG_AUTOBOOT_KEYED
884                 CONFIG_AUTOBOOT_PROMPT
885                 CONFIG_AUTOBOOT_DELAY_STR
886                 CONFIG_AUTOBOOT_STOP_STR
887                 CONFIG_AUTOBOOT_DELAY_STR2
888                 CONFIG_AUTOBOOT_STOP_STR2
889                 CONFIG_ZERO_BOOTDELAY_CHECK
890                 CONFIG_RESET_TO_RETRY
891
892 - Autoboot Command:
893                 CONFIG_BOOTCOMMAND
894                 Only needed when CONFIG_BOOTDELAY is enabled;
895                 define a command string that is automatically executed
896                 when no character is read on the console interface
897                 within "Boot Delay" after reset.
898
899                 CONFIG_BOOTARGS
900                 This can be used to pass arguments to the bootm
901                 command. The value of CONFIG_BOOTARGS goes into the
902                 environment value "bootargs".
903
904                 CONFIG_RAMBOOT and CONFIG_NFSBOOT
905                 The value of these goes into the environment as
906                 "ramboot" and "nfsboot" respectively, and can be used
907                 as a convenience, when switching between booting from
908                 RAM and NFS.
909
910 - Bootcount:
911                 CONFIG_BOOTCOUNT_LIMIT
912                 Implements a mechanism for detecting a repeating reboot
913                 cycle, see:
914                 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
915
916                 CONFIG_BOOTCOUNT_ENV
917                 If no softreset save registers are found on the hardware
918                 "bootcount" is stored in the environment. To prevent a
919                 saveenv on all reboots, the environment variable
920                 "upgrade_available" is used. If "upgrade_available" is
921                 0, "bootcount" is always 0, if "upgrade_available" is
922                 1 "bootcount" is incremented in the environment.
923                 So the Userspace Applikation must set the "upgrade_available"
924                 and "bootcount" variable to 0, if a boot was successfully.
925
926 - Pre-Boot Commands:
927                 CONFIG_PREBOOT
928
929                 When this option is #defined, the existence of the
930                 environment variable "preboot" will be checked
931                 immediately before starting the CONFIG_BOOTDELAY
932                 countdown and/or running the auto-boot command resp.
933                 entering interactive mode.
934
935                 This feature is especially useful when "preboot" is
936                 automatically generated or modified. For an example
937                 see the LWMON board specific code: here "preboot" is
938                 modified when the user holds down a certain
939                 combination of keys on the (special) keyboard when
940                 booting the systems
941
942 - Serial Download Echo Mode:
943                 CONFIG_LOADS_ECHO
944                 If defined to 1, all characters received during a
945                 serial download (using the "loads" command) are
946                 echoed back. This might be needed by some terminal
947                 emulations (like "cu"), but may as well just take
948                 time on others. This setting #define's the initial
949                 value of the "loads_echo" environment variable.
950
951 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
952                 CONFIG_KGDB_BAUDRATE
953                 Select one of the baudrates listed in
954                 CONFIG_SYS_BAUDRATE_TABLE, see below.
955
956 - Monitor Functions:
957                 Monitor commands can be included or excluded
958                 from the build by using the #include files
959                 <config_cmd_all.h> and #undef'ing unwanted
960                 commands, or using <config_cmd_default.h>
961                 and augmenting with additional #define's
962                 for wanted commands.
963
964                 The default command configuration includes all commands
965                 except those marked below with a "*".
966
967                 CONFIG_CMD_AES            AES 128 CBC encrypt/decrypt
968                 CONFIG_CMD_ASKENV       * ask for env variable
969                 CONFIG_CMD_BDI            bdinfo
970                 CONFIG_CMD_BEDBUG       * Include BedBug Debugger
971                 CONFIG_CMD_BMP          * BMP support
972                 CONFIG_CMD_BSP          * Board specific commands
973                 CONFIG_CMD_BOOTD          bootd
974                 CONFIG_CMD_BOOTI        * ARM64 Linux kernel Image support
975                 CONFIG_CMD_CACHE        * icache, dcache
976                 CONFIG_CMD_CLK          * clock command support
977                 CONFIG_CMD_CONSOLE        coninfo
978                 CONFIG_CMD_CRC32        * crc32
979                 CONFIG_CMD_DATE         * support for RTC, date/time...
980                 CONFIG_CMD_DHCP         * DHCP support
981                 CONFIG_CMD_DIAG         * Diagnostics
982                 CONFIG_CMD_DS4510       * ds4510 I2C gpio commands
983                 CONFIG_CMD_DS4510_INFO  * ds4510 I2C info command
984                 CONFIG_CMD_DS4510_MEM   * ds4510 I2C eeprom/sram commansd
985                 CONFIG_CMD_DS4510_RST   * ds4510 I2C rst command
986                 CONFIG_CMD_DTT          * Digital Therm and Thermostat
987                 CONFIG_CMD_ECHO           echo arguments
988                 CONFIG_CMD_EDITENV        edit env variable
989                 CONFIG_CMD_EEPROM       * EEPROM read/write support
990                 CONFIG_CMD_ELF          * bootelf, bootvx
991                 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
992                 CONFIG_CMD_ENV_FLAGS    * display details about env flags
993                 CONFIG_CMD_ENV_EXISTS   * check existence of env variable
994                 CONFIG_CMD_EXPORTENV    * export the environment
995                 CONFIG_CMD_EXT2         * ext2 command support
996                 CONFIG_CMD_EXT4         * ext4 command support
997                 CONFIG_CMD_FS_GENERIC   * filesystem commands (e.g. load, ls)
998                                           that work for multiple fs types
999                 CONFIG_CMD_SAVEENV        saveenv
1000                 CONFIG_CMD_FDC          * Floppy Disk Support
1001                 CONFIG_CMD_FAT          * FAT command support
1002                 CONFIG_CMD_FLASH          flinfo, erase, protect
1003                 CONFIG_CMD_FPGA           FPGA device initialization support
1004                 CONFIG_CMD_FUSE         * Device fuse support
1005                 CONFIG_CMD_GETTIME      * Get time since boot
1006                 CONFIG_CMD_GO           * the 'go' command (exec code)
1007                 CONFIG_CMD_GREPENV      * search environment
1008                 CONFIG_CMD_HASH         * calculate hash / digest
1009                 CONFIG_CMD_HWFLOW       * RTS/CTS hw flow control
1010                 CONFIG_CMD_I2C          * I2C serial bus support
1011                 CONFIG_CMD_IDE          * IDE harddisk support
1012                 CONFIG_CMD_IMI            iminfo
1013                 CONFIG_CMD_IMLS           List all images found in NOR flash
1014                 CONFIG_CMD_IMLS_NAND    * List all images found in NAND flash
1015                 CONFIG_CMD_IMMAP        * IMMR dump support
1016                 CONFIG_CMD_IOTRACE      * I/O tracing for debugging
1017                 CONFIG_CMD_IMPORTENV    * import an environment
1018                 CONFIG_CMD_INI          * import data from an ini file into the env
1019                 CONFIG_CMD_IRQ          * irqinfo
1020                 CONFIG_CMD_ITEST          Integer/string test of 2 values
1021                 CONFIG_CMD_JFFS2        * JFFS2 Support
1022                 CONFIG_CMD_KGDB         * kgdb
1023                 CONFIG_CMD_LDRINFO      * ldrinfo (display Blackfin loader)
1024                 CONFIG_CMD_LINK_LOCAL   * link-local IP address auto-configuration
1025                                           (169.254.*.*)
1026                 CONFIG_CMD_LOADB          loadb
1027                 CONFIG_CMD_LOADS          loads
1028                 CONFIG_CMD_MD5SUM       * print md5 message digest
1029                                           (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
1030                 CONFIG_CMD_MEMINFO      * Display detailed memory information
1031                 CONFIG_CMD_MEMORY         md, mm, nm, mw, cp, cmp, crc, base,
1032                                           loop, loopw
1033                 CONFIG_CMD_MEMTEST      * mtest
1034                 CONFIG_CMD_MISC           Misc functions like sleep etc
1035                 CONFIG_CMD_MMC          * MMC memory mapped support
1036                 CONFIG_CMD_MII          * MII utility commands
1037                 CONFIG_CMD_MTDPARTS     * MTD partition support
1038                 CONFIG_CMD_NAND         * NAND support
1039                 CONFIG_CMD_NET            bootp, tftpboot, rarpboot
1040                 CONFIG_CMD_NFS            NFS support
1041                 CONFIG_CMD_PCA953X      * PCA953x I2C gpio commands
1042                 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1043                 CONFIG_CMD_PCI          * pciinfo
1044                 CONFIG_CMD_PCMCIA               * PCMCIA support
1045                 CONFIG_CMD_PING         * send ICMP ECHO_REQUEST to network
1046                                           host
1047                 CONFIG_CMD_PORTIO       * Port I/O
1048                 CONFIG_CMD_READ         * Read raw data from partition
1049                 CONFIG_CMD_REGINFO      * Register dump
1050                 CONFIG_CMD_RUN            run command in env variable
1051                 CONFIG_CMD_SANDBOX      * sb command to access sandbox features
1052                 CONFIG_CMD_SAVES        * save S record dump
1053                 CONFIG_CMD_SCSI         * SCSI Support
1054                 CONFIG_CMD_SDRAM        * print SDRAM configuration information
1055                                           (requires CONFIG_CMD_I2C)
1056                 CONFIG_CMD_SETGETDCR      Support for DCR Register access
1057                                           (4xx only)
1058                 CONFIG_CMD_SF           * Read/write/erase SPI NOR flash
1059                 CONFIG_CMD_SHA1SUM      * print sha1 memory digest
1060                                           (requires CONFIG_CMD_MEMORY)
1061                 CONFIG_CMD_SOFTSWITCH   * Soft switch setting command for BF60x
1062                 CONFIG_CMD_SOURCE         "source" command Support
1063                 CONFIG_CMD_SPI          * SPI serial bus support
1064                 CONFIG_CMD_TFTPSRV      * TFTP transfer in server mode
1065                 CONFIG_CMD_TFTPPUT      * TFTP put command (upload)
1066                 CONFIG_CMD_TIME         * run command and report execution time (ARM specific)
1067                 CONFIG_CMD_TIMER        * access to the system tick timer
1068                 CONFIG_CMD_USB          * USB support
1069                 CONFIG_CMD_CDP          * Cisco Discover Protocol support
1070                 CONFIG_CMD_MFSL         * Microblaze FSL support
1071                 CONFIG_CMD_XIMG           Load part of Multi Image
1072                 CONFIG_CMD_UUID         * Generate random UUID or GUID string
1073
1074                 EXAMPLE: If you want all functions except of network
1075                 support you can write:
1076
1077                 #include "config_cmd_all.h"
1078                 #undef CONFIG_CMD_NET
1079
1080         Other Commands:
1081                 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1082
1083         Note:   Don't enable the "icache" and "dcache" commands
1084                 (configuration option CONFIG_CMD_CACHE) unless you know
1085                 what you (and your U-Boot users) are doing. Data
1086                 cache cannot be enabled on systems like the 8xx or
1087                 8260 (where accesses to the IMMR region must be
1088                 uncached), and it cannot be disabled on all other
1089                 systems where we (mis-) use the data cache to hold an
1090                 initial stack and some data.
1091
1092
1093                 XXX - this list needs to get updated!
1094
1095 - Regular expression support:
1096                 CONFIG_REGEX
1097                 If this variable is defined, U-Boot is linked against
1098                 the SLRE (Super Light Regular Expression) library,
1099                 which adds regex support to some commands, as for
1100                 example "env grep" and "setexpr".
1101
1102 - Device tree:
1103                 CONFIG_OF_CONTROL
1104                 If this variable is defined, U-Boot will use a device tree
1105                 to configure its devices, instead of relying on statically
1106                 compiled #defines in the board file. This option is
1107                 experimental and only available on a few boards. The device
1108                 tree is available in the global data as gd->fdt_blob.
1109
1110                 U-Boot needs to get its device tree from somewhere. This can
1111                 be done using one of the two options below:
1112
1113                 CONFIG_OF_EMBED
1114                 If this variable is defined, U-Boot will embed a device tree
1115                 binary in its image. This device tree file should be in the
1116                 board directory and called <soc>-<board>.dts. The binary file
1117                 is then picked up in board_init_f() and made available through
1118                 the global data structure as gd->blob.
1119
1120                 CONFIG_OF_SEPARATE
1121                 If this variable is defined, U-Boot will build a device tree
1122                 binary. It will be called u-boot.dtb. Architecture-specific
1123                 code will locate it at run-time. Generally this works by:
1124
1125                         cat u-boot.bin u-boot.dtb >image.bin
1126
1127                 and in fact, U-Boot does this for you, creating a file called
1128                 u-boot-dtb.bin which is useful in the common case. You can
1129                 still use the individual files if you need something more
1130                 exotic.
1131
1132 - Watchdog:
1133                 CONFIG_WATCHDOG
1134                 If this variable is defined, it enables watchdog
1135                 support for the SoC. There must be support in the SoC
1136                 specific code for a watchdog. For the 8xx and 8260
1137                 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1138                 register.  When supported for a specific SoC is
1139                 available, then no further board specific code should
1140                 be needed to use it.
1141
1142                 CONFIG_HW_WATCHDOG
1143                 When using a watchdog circuitry external to the used
1144                 SoC, then define this variable and provide board
1145                 specific code for the "hw_watchdog_reset" function.
1146
1147 - U-Boot Version:
1148                 CONFIG_VERSION_VARIABLE
1149                 If this variable is defined, an environment variable
1150                 named "ver" is created by U-Boot showing the U-Boot
1151                 version as printed by the "version" command.
1152                 Any change to this variable will be reverted at the
1153                 next reset.
1154
1155 - Real-Time Clock:
1156
1157                 When CONFIG_CMD_DATE is selected, the type of the RTC
1158                 has to be selected, too. Define exactly one of the
1159                 following options:
1160
1161                 CONFIG_RTC_MPC8xx       - use internal RTC of MPC8xx
1162                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
1163                 CONFIG_RTC_MC13XXX      - use MC13783 or MC13892 RTC
1164                 CONFIG_RTC_MC146818     - use MC146818 RTC
1165                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
1166                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
1167                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
1168                 CONFIG_RTC_DS1339       - use Maxim, Inc. DS1339 RTC
1169                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
1170                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
1171                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
1172                 CONFIG_SYS_RTC_DS1337_NOOSC     - Turn off the OSC output for DS1337
1173                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
1174                                           RV3029 RTC.
1175
1176                 Note that if the RTC uses I2C, then the I2C interface
1177                 must also be configured. See I2C Support, below.
1178
1179 - GPIO Support:
1180                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
1181
1182                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1183                 chip-ngpio pairs that tell the PCA953X driver the number of
1184                 pins supported by a particular chip.
1185
1186                 Note that if the GPIO device uses I2C, then the I2C interface
1187                 must also be configured. See I2C Support, below.
1188
1189 - I/O tracing:
1190                 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1191                 accesses and can checksum them or write a list of them out
1192                 to memory. See the 'iotrace' command for details. This is
1193                 useful for testing device drivers since it can confirm that
1194                 the driver behaves the same way before and after a code
1195                 change. Currently this is supported on sandbox and arm. To
1196                 add support for your architecture, add '#include <iotrace.h>'
1197                 to the bottom of arch/<arch>/include/asm/io.h and test.
1198
1199                 Example output from the 'iotrace stats' command is below.
1200                 Note that if the trace buffer is exhausted, the checksum will
1201                 still continue to operate.
1202
1203                         iotrace is enabled
1204                         Start:  10000000        (buffer start address)
1205                         Size:   00010000        (buffer size)
1206                         Offset: 00000120        (current buffer offset)
1207                         Output: 10000120        (start + offset)
1208                         Count:  00000018        (number of trace records)
1209                         CRC32:  9526fb66        (CRC32 of all trace records)
1210
1211 - Timestamp Support:
1212
1213                 When CONFIG_TIMESTAMP is selected, the timestamp
1214                 (date and time) of an image is printed by image
1215                 commands like bootm or iminfo. This option is
1216                 automatically enabled when you select CONFIG_CMD_DATE .
1217
1218 - Partition Labels (disklabels) Supported:
1219                 Zero or more of the following:
1220                 CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1221                 CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1222                                        Intel architecture, USB sticks, etc.
1223                 CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1224                 CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1225                                        bootloader.  Note 2TB partition limit; see
1226                                        disk/part_efi.c
1227                 CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1228
1229                 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1230                 CONFIG_CMD_SCSI) you must configure support for at
1231                 least one non-MTD partition type as well.
1232
1233 - IDE Reset method:
1234                 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1235                 board configurations files but used nowhere!
1236
1237                 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1238                 be performed by calling the function
1239                         ide_set_reset(int reset)
1240                 which has to be defined in a board specific file
1241
1242 - ATAPI Support:
1243                 CONFIG_ATAPI
1244
1245                 Set this to enable ATAPI support.
1246
1247 - LBA48 Support
1248                 CONFIG_LBA48
1249
1250                 Set this to enable support for disks larger than 137GB
1251                 Also look at CONFIG_SYS_64BIT_LBA.
1252                 Whithout these , LBA48 support uses 32bit variables and will 'only'
1253                 support disks up to 2.1TB.
1254
1255                 CONFIG_SYS_64BIT_LBA:
1256                         When enabled, makes the IDE subsystem use 64bit sector addresses.
1257                         Default is 32bit.
1258
1259 - SCSI Support:
1260                 At the moment only there is only support for the
1261                 SYM53C8XX SCSI controller; define
1262                 CONFIG_SCSI_SYM53C8XX to enable it.
1263
1264                 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1265                 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1266                 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1267                 maximum numbers of LUNs, SCSI ID's and target
1268                 devices.
1269                 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1270
1271                 The environment variable 'scsidevs' is set to the number of
1272                 SCSI devices found during the last scan.
1273
1274 - NETWORK Support (PCI):
1275                 CONFIG_E1000
1276                 Support for Intel 8254x/8257x gigabit chips.
1277
1278                 CONFIG_E1000_SPI
1279                 Utility code for direct access to the SPI bus on Intel 8257x.
1280                 This does not do anything useful unless you set at least one
1281                 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1282
1283                 CONFIG_E1000_SPI_GENERIC
1284                 Allow generic access to the SPI bus on the Intel 8257x, for
1285                 example with the "sspi" command.
1286
1287                 CONFIG_CMD_E1000
1288                 Management command for E1000 devices.  When used on devices
1289                 with SPI support you can reprogram the EEPROM from U-Boot.
1290
1291                 CONFIG_E1000_FALLBACK_MAC
1292                 default MAC for empty EEPROM after production.
1293
1294                 CONFIG_EEPRO100
1295                 Support for Intel 82557/82559/82559ER chips.
1296                 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1297                 write routine for first time initialisation.
1298
1299                 CONFIG_TULIP
1300                 Support for Digital 2114x chips.
1301                 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1302                 modem chip initialisation (KS8761/QS6611).
1303
1304                 CONFIG_NATSEMI
1305                 Support for National dp83815 chips.
1306
1307                 CONFIG_NS8382X
1308                 Support for National dp8382[01] gigabit chips.
1309
1310 - NETWORK Support (other):
1311
1312                 CONFIG_DRIVER_AT91EMAC
1313                 Support for AT91RM9200 EMAC.
1314
1315                         CONFIG_RMII
1316                         Define this to use reduced MII inteface
1317
1318                         CONFIG_DRIVER_AT91EMAC_QUIET
1319                         If this defined, the driver is quiet.
1320                         The driver doen't show link status messages.
1321
1322                 CONFIG_CALXEDA_XGMAC
1323                 Support for the Calxeda XGMAC device
1324
1325                 CONFIG_LAN91C96
1326                 Support for SMSC's LAN91C96 chips.
1327
1328                         CONFIG_LAN91C96_BASE
1329                         Define this to hold the physical address
1330                         of the LAN91C96's I/O space
1331
1332                         CONFIG_LAN91C96_USE_32_BIT
1333                         Define this to enable 32 bit addressing
1334
1335                 CONFIG_SMC91111
1336                 Support for SMSC's LAN91C111 chip
1337
1338                         CONFIG_SMC91111_BASE
1339                         Define this to hold the physical address
1340                         of the device (I/O space)
1341
1342                         CONFIG_SMC_USE_32_BIT
1343                         Define this if data bus is 32 bits
1344
1345                         CONFIG_SMC_USE_IOFUNCS
1346                         Define this to use i/o functions instead of macros
1347                         (some hardware wont work with macros)
1348
1349                 CONFIG_DRIVER_TI_EMAC
1350                 Support for davinci emac
1351
1352                         CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1353                         Define this if you have more then 3 PHYs.
1354
1355                 CONFIG_FTGMAC100
1356                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1357
1358                         CONFIG_FTGMAC100_EGIGA
1359                         Define this to use GE link update with gigabit PHY.
1360                         Define this if FTGMAC100 is connected to gigabit PHY.
1361                         If your system has 10/100 PHY only, it might not occur
1362                         wrong behavior. Because PHY usually return timeout or
1363                         useless data when polling gigabit status and gigabit
1364                         control registers. This behavior won't affect the
1365                         correctnessof 10/100 link speed update.
1366
1367                 CONFIG_SMC911X
1368                 Support for SMSC's LAN911x and LAN921x chips
1369
1370                         CONFIG_SMC911X_BASE
1371                         Define this to hold the physical address
1372                         of the device (I/O space)
1373
1374                         CONFIG_SMC911X_32_BIT
1375                         Define this if data bus is 32 bits
1376
1377                         CONFIG_SMC911X_16_BIT
1378                         Define this if data bus is 16 bits. If your processor
1379                         automatically converts one 32 bit word to two 16 bit
1380                         words you may also try CONFIG_SMC911X_32_BIT.
1381
1382                 CONFIG_SH_ETHER
1383                 Support for Renesas on-chip Ethernet controller
1384
1385                         CONFIG_SH_ETHER_USE_PORT
1386                         Define the number of ports to be used
1387
1388                         CONFIG_SH_ETHER_PHY_ADDR
1389                         Define the ETH PHY's address
1390
1391                         CONFIG_SH_ETHER_CACHE_WRITEBACK
1392                         If this option is set, the driver enables cache flush.
1393
1394 - PWM Support:
1395                 CONFIG_PWM_IMX
1396                 Support for PWM modul on the imx6.
1397
1398 - TPM Support:
1399                 CONFIG_TPM
1400                 Support TPM devices.
1401
1402                 CONFIG_TPM_TIS_I2C
1403                 Support for i2c bus TPM devices. Only one device
1404                 per system is supported at this time.
1405
1406                         CONFIG_TPM_TIS_I2C_BUS_NUMBER
1407                         Define the the i2c bus number for the TPM device
1408
1409                         CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1410                         Define the TPM's address on the i2c bus
1411
1412                         CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1413                         Define the burst count bytes upper limit
1414
1415                 CONFIG_TPM_ATMEL_TWI
1416                 Support for Atmel TWI TPM device. Requires I2C support.
1417
1418                 CONFIG_TPM_TIS_LPC
1419                 Support for generic parallel port TPM devices. Only one device
1420                 per system is supported at this time.
1421
1422                         CONFIG_TPM_TIS_BASE_ADDRESS
1423                         Base address where the generic TPM device is mapped
1424                         to. Contemporary x86 systems usually map it at
1425                         0xfed40000.
1426
1427                 CONFIG_CMD_TPM
1428                 Add tpm monitor functions.
1429                 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1430                 provides monitor access to authorized functions.
1431
1432                 CONFIG_TPM
1433                 Define this to enable the TPM support library which provides
1434                 functional interfaces to some TPM commands.
1435                 Requires support for a TPM device.
1436
1437                 CONFIG_TPM_AUTH_SESSIONS
1438                 Define this to enable authorized functions in the TPM library.
1439                 Requires CONFIG_TPM and CONFIG_SHA1.
1440
1441 - USB Support:
1442                 At the moment only the UHCI host controller is
1443                 supported (PIP405, MIP405, MPC5200); define
1444                 CONFIG_USB_UHCI to enable it.
1445                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1446                 and define CONFIG_USB_STORAGE to enable the USB
1447                 storage devices.
1448                 Note:
1449                 Supported are USB Keyboards and USB Floppy drives
1450                 (TEAC FD-05PUB).
1451                 MPC5200 USB requires additional defines:
1452                         CONFIG_USB_CLOCK
1453                                 for 528 MHz Clock: 0x0001bbbb
1454                         CONFIG_PSC3_USB
1455                                 for USB on PSC3
1456                         CONFIG_USB_CONFIG
1457                                 for differential drivers: 0x00001000
1458                                 for single ended drivers: 0x00005000
1459                                 for differential drivers on PSC3: 0x00000100
1460                                 for single ended drivers on PSC3: 0x00004100
1461                         CONFIG_SYS_USB_EVENT_POLL
1462                                 May be defined to allow interrupt polling
1463                                 instead of using asynchronous interrupts
1464
1465                 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1466                 txfilltuning field in the EHCI controller on reset.
1467
1468                 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1469                 HW module registers.
1470
1471 - USB Device:
1472                 Define the below if you wish to use the USB console.
1473                 Once firmware is rebuilt from a serial console issue the
1474                 command "setenv stdin usbtty; setenv stdout usbtty" and
1475                 attach your USB cable. The Unix command "dmesg" should print
1476                 it has found a new device. The environment variable usbtty
1477                 can be set to gserial or cdc_acm to enable your device to
1478                 appear to a USB host as a Linux gserial device or a
1479                 Common Device Class Abstract Control Model serial device.
1480                 If you select usbtty = gserial you should be able to enumerate
1481                 a Linux host by
1482                 # modprobe usbserial vendor=0xVendorID product=0xProductID
1483                 else if using cdc_acm, simply setting the environment
1484                 variable usbtty to be cdc_acm should suffice. The following
1485                 might be defined in YourBoardName.h
1486
1487                         CONFIG_USB_DEVICE
1488                         Define this to build a UDC device
1489
1490                         CONFIG_USB_TTY
1491                         Define this to have a tty type of device available to
1492                         talk to the UDC device
1493
1494                         CONFIG_USBD_HS
1495                         Define this to enable the high speed support for usb
1496                         device and usbtty. If this feature is enabled, a routine
1497                         int is_usbd_high_speed(void)
1498                         also needs to be defined by the driver to dynamically poll
1499                         whether the enumeration has succeded at high speed or full
1500                         speed.
1501
1502                         CONFIG_SYS_CONSOLE_IS_IN_ENV
1503                         Define this if you want stdin, stdout &/or stderr to
1504                         be set to usbtty.
1505
1506                         mpc8xx:
1507                                 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1508                                 Derive USB clock from external clock "blah"
1509                                 - CONFIG_SYS_USB_EXTC_CLK 0x02
1510
1511                                 CONFIG_SYS_USB_BRG_CLK 0xBLAH
1512                                 Derive USB clock from brgclk
1513                                 - CONFIG_SYS_USB_BRG_CLK 0x04
1514
1515                 If you have a USB-IF assigned VendorID then you may wish to
1516                 define your own vendor specific values either in BoardName.h
1517                 or directly in usbd_vendor_info.h. If you don't define
1518                 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1519                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1520                 should pretend to be a Linux device to it's target host.
1521
1522                         CONFIG_USBD_MANUFACTURER
1523                         Define this string as the name of your company for
1524                         - CONFIG_USBD_MANUFACTURER "my company"
1525
1526                         CONFIG_USBD_PRODUCT_NAME
1527                         Define this string as the name of your product
1528                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1529
1530                         CONFIG_USBD_VENDORID
1531                         Define this as your assigned Vendor ID from the USB
1532                         Implementors Forum. This *must* be a genuine Vendor ID
1533                         to avoid polluting the USB namespace.
1534                         - CONFIG_USBD_VENDORID 0xFFFF
1535
1536                         CONFIG_USBD_PRODUCTID
1537                         Define this as the unique Product ID
1538                         for your device
1539                         - CONFIG_USBD_PRODUCTID 0xFFFF
1540
1541 - ULPI Layer Support:
1542                 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1543                 the generic ULPI layer. The generic layer accesses the ULPI PHY
1544                 via the platform viewport, so you need both the genric layer and
1545                 the viewport enabled. Currently only Chipidea/ARC based
1546                 viewport is supported.
1547                 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1548                 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1549                 If your ULPI phy needs a different reference clock than the
1550                 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1551                 the appropriate value in Hz.
1552
1553 - MMC Support:
1554                 The MMC controller on the Intel PXA is supported. To
1555                 enable this define CONFIG_MMC. The MMC can be
1556                 accessed from the boot prompt by mapping the device
1557                 to physical memory similar to flash. Command line is
1558                 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1559                 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1560
1561                 CONFIG_SH_MMCIF
1562                 Support for Renesas on-chip MMCIF controller
1563
1564                         CONFIG_SH_MMCIF_ADDR
1565                         Define the base address of MMCIF registers
1566
1567                         CONFIG_SH_MMCIF_CLK
1568                         Define the clock frequency for MMCIF
1569
1570                 CONFIG_GENERIC_MMC
1571                 Enable the generic MMC driver
1572
1573                 CONFIG_SUPPORT_EMMC_BOOT
1574                 Enable some additional features of the eMMC boot partitions.
1575
1576                 CONFIG_SUPPORT_EMMC_RPMB
1577                 Enable the commands for reading, writing and programming the
1578                 key for the Replay Protection Memory Block partition in eMMC.
1579
1580 - USB Device Firmware Update (DFU) class support:
1581                 CONFIG_DFU_FUNCTION
1582                 This enables the USB portion of the DFU USB class
1583
1584                 CONFIG_CMD_DFU
1585                 This enables the command "dfu" which is used to have
1586                 U-Boot create a DFU class device via USB.  This command
1587                 requires that the "dfu_alt_info" environment variable be
1588                 set and define the alt settings to expose to the host.
1589
1590                 CONFIG_DFU_MMC
1591                 This enables support for exposing (e)MMC devices via DFU.
1592
1593                 CONFIG_DFU_NAND
1594                 This enables support for exposing NAND devices via DFU.
1595
1596                 CONFIG_DFU_RAM
1597                 This enables support for exposing RAM via DFU.
1598                 Note: DFU spec refer to non-volatile memory usage, but
1599                 allow usages beyond the scope of spec - here RAM usage,
1600                 one that would help mostly the developer.
1601
1602                 CONFIG_SYS_DFU_DATA_BUF_SIZE
1603                 Dfu transfer uses a buffer before writing data to the
1604                 raw storage device. Make the size (in bytes) of this buffer
1605                 configurable. The size of this buffer is also configurable
1606                 through the "dfu_bufsiz" environment variable.
1607
1608                 CONFIG_SYS_DFU_MAX_FILE_SIZE
1609                 When updating files rather than the raw storage device,
1610                 we use a static buffer to copy the file into and then write
1611                 the buffer once we've been given the whole file.  Define
1612                 this to the maximum filesize (in bytes) for the buffer.
1613                 Default is 4 MiB if undefined.
1614
1615                 DFU_DEFAULT_POLL_TIMEOUT
1616                 Poll timeout [ms], is the timeout a device can send to the
1617                 host. The host must wait for this timeout before sending
1618                 a subsequent DFU_GET_STATUS request to the device.
1619
1620                 DFU_MANIFEST_POLL_TIMEOUT
1621                 Poll timeout [ms], which the device sends to the host when
1622                 entering dfuMANIFEST state. Host waits this timeout, before
1623                 sending again an USB request to the device.
1624
1625 - USB Device Android Fastboot support:
1626                 CONFIG_CMD_FASTBOOT
1627                 This enables the command "fastboot" which enables the Android
1628                 fastboot mode for the platform's USB device. Fastboot is a USB
1629                 protocol for downloading images, flashing and device control
1630                 used on Android devices.
1631                 See doc/README.android-fastboot for more information.
1632
1633                 CONFIG_ANDROID_BOOT_IMAGE
1634                 This enables support for booting images which use the Android
1635                 image format header.
1636
1637                 CONFIG_USB_FASTBOOT_BUF_ADDR
1638                 The fastboot protocol requires a large memory buffer for
1639                 downloads. Define this to the starting RAM address to use for
1640                 downloaded images.
1641
1642                 CONFIG_USB_FASTBOOT_BUF_SIZE
1643                 The fastboot protocol requires a large memory buffer for
1644                 downloads. This buffer should be as large as possible for a
1645                 platform. Define this to the size available RAM for fastboot.
1646
1647                 CONFIG_FASTBOOT_FLASH
1648                 The fastboot protocol includes a "flash" command for writing
1649                 the downloaded image to a non-volatile storage device. Define
1650                 this to enable the "fastboot flash" command.
1651
1652                 CONFIG_FASTBOOT_FLASH_MMC_DEV
1653                 The fastboot "flash" command requires additional information
1654                 regarding the non-volatile storage device. Define this to
1655                 the eMMC device that fastboot should use to store the image.
1656
1657 - Journaling Flash filesystem support:
1658                 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1659                 CONFIG_JFFS2_NAND_DEV
1660                 Define these for a default partition on a NAND device
1661
1662                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1663                 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1664                 Define these for a default partition on a NOR device
1665
1666                 CONFIG_SYS_JFFS_CUSTOM_PART
1667                 Define this to create an own partition. You have to provide a
1668                 function struct part_info* jffs2_part_info(int part_num)
1669
1670                 If you define only one JFFS2 partition you may also want to
1671                 #define CONFIG_SYS_JFFS_SINGLE_PART     1
1672                 to disable the command chpart. This is the default when you
1673                 have not defined a custom partition
1674
1675 - FAT(File Allocation Table) filesystem write function support:
1676                 CONFIG_FAT_WRITE
1677
1678                 Define this to enable support for saving memory data as a
1679                 file in FAT formatted partition.
1680
1681                 This will also enable the command "fatwrite" enabling the
1682                 user to write files to FAT.
1683
1684 CBFS (Coreboot Filesystem) support
1685                 CONFIG_CMD_CBFS
1686
1687                 Define this to enable support for reading from a Coreboot
1688                 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1689                 and cbfsload.
1690
1691 - FAT(File Allocation Table) filesystem cluster size:
1692                 CONFIG_FS_FAT_MAX_CLUSTSIZE
1693
1694                 Define the max cluster size for fat operations else
1695                 a default value of 65536 will be defined.
1696
1697 - Keyboard Support:
1698                 CONFIG_ISA_KEYBOARD
1699
1700                 Define this to enable standard (PC-Style) keyboard
1701                 support
1702
1703                 CONFIG_I8042_KBD
1704                 Standard PC keyboard driver with US (is default) and
1705                 GERMAN key layout (switch via environment 'keymap=de') support.
1706                 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1707                 for cfb_console. Supports cursor blinking.
1708
1709                 CONFIG_CROS_EC_KEYB
1710                 Enables a Chrome OS keyboard using the CROS_EC interface.
1711                 This uses CROS_EC to communicate with a second microcontroller
1712                 which provides key scans on request.
1713
1714 - Video support:
1715                 CONFIG_VIDEO
1716
1717                 Define this to enable video support (for output to
1718                 video).
1719
1720                 CONFIG_VIDEO_CT69000
1721
1722                 Enable Chips & Technologies 69000 Video chip
1723
1724                 CONFIG_VIDEO_SMI_LYNXEM
1725                 Enable Silicon Motion SMI 712/710/810 Video chip. The
1726                 video output is selected via environment 'videoout'
1727                 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1728                 assumed.
1729
1730                 For the CT69000 and SMI_LYNXEM drivers, videomode is
1731                 selected via environment 'videomode'. Two different ways
1732                 are possible:
1733                 - "videomode=num"   'num' is a standard LiLo mode numbers.
1734                 Following standard modes are supported  (* is default):
1735
1736                       Colors    640x480 800x600 1024x768 1152x864 1280x1024
1737                 -------------+---------------------------------------------
1738                       8 bits |  0x301*  0x303    0x305    0x161     0x307
1739                      15 bits |  0x310   0x313    0x316    0x162     0x319
1740                      16 bits |  0x311   0x314    0x317    0x163     0x31A
1741                      24 bits |  0x312   0x315    0x318      ?       0x31B
1742                 -------------+---------------------------------------------
1743                 (i.e. setenv videomode 317; saveenv; reset;)
1744
1745                 - "videomode=bootargs" all the video parameters are parsed
1746                 from the bootargs. (See drivers/video/videomodes.c)
1747
1748
1749                 CONFIG_VIDEO_SED13806
1750                 Enable Epson SED13806 driver. This driver supports 8bpp
1751                 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1752                 or CONFIG_VIDEO_SED13806_16BPP
1753
1754                 CONFIG_FSL_DIU_FB
1755                 Enable the Freescale DIU video driver.  Reference boards for
1756                 SOCs that have a DIU should define this macro to enable DIU
1757                 support, and should also define these other macros:
1758
1759                         CONFIG_SYS_DIU_ADDR
1760                         CONFIG_VIDEO
1761                         CONFIG_CMD_BMP
1762                         CONFIG_CFB_CONSOLE
1763                         CONFIG_VIDEO_SW_CURSOR
1764                         CONFIG_VGA_AS_SINGLE_DEVICE
1765                         CONFIG_VIDEO_LOGO
1766                         CONFIG_VIDEO_BMP_LOGO
1767
1768                 The DIU driver will look for the 'video-mode' environment
1769                 variable, and if defined, enable the DIU as a console during
1770                 boot.  See the documentation file README.video for a
1771                 description of this variable.
1772
1773                 CONFIG_VIDEO_VGA
1774
1775                 Enable the VGA video / BIOS for x86. The alternative if you
1776                 are using coreboot is to use the coreboot frame buffer
1777                 driver.
1778
1779
1780 - Keyboard Support:
1781                 CONFIG_KEYBOARD
1782
1783                 Define this to enable a custom keyboard support.
1784                 This simply calls drv_keyboard_init() which must be
1785                 defined in your board-specific files.
1786                 The only board using this so far is RBC823.
1787
1788 - LCD Support:  CONFIG_LCD
1789
1790                 Define this to enable LCD support (for output to LCD
1791                 display); also select one of the supported displays
1792                 by defining one of these:
1793
1794                 CONFIG_ATMEL_LCD:
1795
1796                         HITACHI TX09D70VM1CCA, 3.5", 240x320.
1797
1798                 CONFIG_NEC_NL6448AC33:
1799
1800                         NEC NL6448AC33-18. Active, color, single scan.
1801
1802                 CONFIG_NEC_NL6448BC20
1803
1804                         NEC NL6448BC20-08. 6.5", 640x480.
1805                         Active, color, single scan.
1806
1807                 CONFIG_NEC_NL6448BC33_54
1808
1809                         NEC NL6448BC33-54. 10.4", 640x480.
1810                         Active, color, single scan.
1811
1812                 CONFIG_SHARP_16x9
1813
1814                         Sharp 320x240. Active, color, single scan.
1815                         It isn't 16x9, and I am not sure what it is.
1816
1817                 CONFIG_SHARP_LQ64D341
1818
1819                         Sharp LQ64D341 display, 640x480.
1820                         Active, color, single scan.
1821
1822                 CONFIG_HLD1045
1823
1824                         HLD1045 display, 640x480.
1825                         Active, color, single scan.
1826
1827                 CONFIG_OPTREX_BW
1828
1829                         Optrex   CBL50840-2 NF-FW 99 22 M5
1830                         or
1831                         Hitachi  LMG6912RPFC-00T
1832                         or
1833                         Hitachi  SP14Q002
1834
1835                         320x240. Black & white.
1836
1837                 Normally display is black on white background; define
1838                 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1839
1840                 CONFIG_LCD_ALIGNMENT
1841
1842                 Normally the LCD is page-aligned (tyically 4KB). If this is
1843                 defined then the LCD will be aligned to this value instead.
1844                 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1845                 here, since it is cheaper to change data cache settings on
1846                 a per-section basis.
1847
1848                 CONFIG_CONSOLE_SCROLL_LINES
1849
1850                 When the console need to be scrolled, this is the number of
1851                 lines to scroll by. It defaults to 1. Increasing this makes
1852                 the console jump but can help speed up operation when scrolling
1853                 is slow.
1854
1855                 CONFIG_LCD_BMP_RLE8
1856
1857                 Support drawing of RLE8-compressed bitmaps on the LCD.
1858
1859                 CONFIG_I2C_EDID
1860
1861                 Enables an 'i2c edid' command which can read EDID
1862                 information over I2C from an attached LCD display.
1863
1864 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1865
1866                 If this option is set, the environment is checked for
1867                 a variable "splashimage". If found, the usual display
1868                 of logo, copyright and system information on the LCD
1869                 is suppressed and the BMP image at the address
1870                 specified in "splashimage" is loaded instead. The
1871                 console is redirected to the "nulldev", too. This
1872                 allows for a "silent" boot where a splash screen is
1873                 loaded very quickly after power-on.
1874
1875                 CONFIG_SPLASHIMAGE_GUARD
1876
1877                 If this option is set, then U-Boot will prevent the environment
1878                 variable "splashimage" from being set to a problematic address
1879                 (see README.displaying-bmps).
1880                 This option is useful for targets where, due to alignment
1881                 restrictions, an improperly aligned BMP image will cause a data
1882                 abort. If you think you will not have problems with unaligned
1883                 accesses (for example because your toolchain prevents them)
1884                 there is no need to set this option.
1885
1886                 CONFIG_SPLASH_SCREEN_ALIGN
1887
1888                 If this option is set the splash image can be freely positioned
1889                 on the screen. Environment variable "splashpos" specifies the
1890                 position as "x,y". If a positive number is given it is used as
1891                 number of pixel from left/top. If a negative number is given it
1892                 is used as number of pixel from right/bottom. You can also
1893                 specify 'm' for centering the image.
1894
1895                 Example:
1896                 setenv splashpos m,m
1897                         => image at center of screen
1898
1899                 setenv splashpos 30,20
1900                         => image at x = 30 and y = 20
1901
1902                 setenv splashpos -10,m
1903                         => vertically centered image
1904                            at x = dspWidth - bmpWidth - 9
1905
1906 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1907
1908                 If this option is set, additionally to standard BMP
1909                 images, gzipped BMP images can be displayed via the
1910                 splashscreen support or the bmp command.
1911
1912 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1913
1914                 If this option is set, 8-bit RLE compressed BMP images
1915                 can be displayed via the splashscreen support or the
1916                 bmp command.
1917
1918 - Do compresssing for memory range:
1919                 CONFIG_CMD_ZIP
1920
1921                 If this option is set, it would use zlib deflate method
1922                 to compress the specified memory at its best effort.
1923
1924 - Compression support:
1925                 CONFIG_GZIP
1926
1927                 Enabled by default to support gzip compressed images.
1928
1929                 CONFIG_BZIP2
1930
1931                 If this option is set, support for bzip2 compressed
1932                 images is included. If not, only uncompressed and gzip
1933                 compressed images are supported.
1934
1935                 NOTE: the bzip2 algorithm requires a lot of RAM, so
1936                 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1937                 be at least 4MB.
1938
1939                 CONFIG_LZMA
1940
1941                 If this option is set, support for lzma compressed
1942                 images is included.
1943
1944                 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1945                 requires an amount of dynamic memory that is given by the
1946                 formula:
1947
1948                         (1846 + 768 << (lc + lp)) * sizeof(uint16)
1949
1950                 Where lc and lp stand for, respectively, Literal context bits
1951                 and Literal pos bits.
1952
1953                 This value is upper-bounded by 14MB in the worst case. Anyway,
1954                 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1955                 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1956                 a very small buffer.
1957
1958                 Use the lzmainfo tool to determinate the lc and lp values and
1959                 then calculate the amount of needed dynamic memory (ensuring
1960                 the appropriate CONFIG_SYS_MALLOC_LEN value).
1961
1962                 CONFIG_LZO
1963
1964                 If this option is set, support for LZO compressed images
1965                 is included.
1966
1967 - MII/PHY support:
1968                 CONFIG_PHY_ADDR
1969
1970                 The address of PHY on MII bus.
1971
1972                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1973
1974                 The clock frequency of the MII bus
1975
1976                 CONFIG_PHY_GIGE
1977
1978                 If this option is set, support for speed/duplex
1979                 detection of gigabit PHY is included.
1980
1981                 CONFIG_PHY_RESET_DELAY
1982
1983                 Some PHY like Intel LXT971A need extra delay after
1984                 reset before any MII register access is possible.
1985                 For such PHY, set this option to the usec delay
1986                 required. (minimum 300usec for LXT971A)
1987
1988                 CONFIG_PHY_CMD_DELAY (ppc4xx)
1989
1990                 Some PHY like Intel LXT971A need extra delay after
1991                 command issued before MII status register can be read
1992
1993 - Ethernet address:
1994                 CONFIG_ETHADDR
1995                 CONFIG_ETH1ADDR
1996                 CONFIG_ETH2ADDR
1997                 CONFIG_ETH3ADDR
1998                 CONFIG_ETH4ADDR
1999                 CONFIG_ETH5ADDR
2000
2001                 Define a default value for Ethernet address to use
2002                 for the respective Ethernet interface, in case this
2003                 is not determined automatically.
2004
2005 - IP address:
2006                 CONFIG_IPADDR
2007
2008                 Define a default value for the IP address to use for
2009                 the default Ethernet interface, in case this is not
2010                 determined through e.g. bootp.
2011                 (Environment variable "ipaddr")
2012
2013 - Server IP address:
2014                 CONFIG_SERVERIP
2015
2016                 Defines a default value for the IP address of a TFTP
2017                 server to contact when using the "tftboot" command.
2018                 (Environment variable "serverip")
2019
2020                 CONFIG_KEEP_SERVERADDR
2021
2022                 Keeps the server's MAC address, in the env 'serveraddr'
2023                 for passing to bootargs (like Linux's netconsole option)
2024
2025 - Gateway IP address:
2026                 CONFIG_GATEWAYIP
2027
2028                 Defines a default value for the IP address of the
2029                 default router where packets to other networks are
2030                 sent to.
2031                 (Environment variable "gatewayip")
2032
2033 - Subnet mask:
2034                 CONFIG_NETMASK
2035
2036                 Defines a default value for the subnet mask (or
2037                 routing prefix) which is used to determine if an IP
2038                 address belongs to the local subnet or needs to be
2039                 forwarded through a router.
2040                 (Environment variable "netmask")
2041
2042 - Multicast TFTP Mode:
2043                 CONFIG_MCAST_TFTP
2044
2045                 Defines whether you want to support multicast TFTP as per
2046                 rfc-2090; for example to work with atftp.  Lets lots of targets
2047                 tftp down the same boot image concurrently.  Note: the Ethernet
2048                 driver in use must provide a function: mcast() to join/leave a
2049                 multicast group.
2050
2051 - BOOTP Recovery Mode:
2052                 CONFIG_BOOTP_RANDOM_DELAY
2053
2054                 If you have many targets in a network that try to
2055                 boot using BOOTP, you may want to avoid that all
2056                 systems send out BOOTP requests at precisely the same
2057                 moment (which would happen for instance at recovery
2058                 from a power failure, when all systems will try to
2059                 boot, thus flooding the BOOTP server. Defining
2060                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2061                 inserted before sending out BOOTP requests. The
2062                 following delays are inserted then:
2063
2064                 1st BOOTP request:      delay 0 ... 1 sec
2065                 2nd BOOTP request:      delay 0 ... 2 sec
2066                 3rd BOOTP request:      delay 0 ... 4 sec
2067                 4th and following
2068                 BOOTP requests:         delay 0 ... 8 sec
2069
2070                 CONFIG_BOOTP_ID_CACHE_SIZE
2071
2072                 BOOTP packets are uniquely identified using a 32-bit ID. The
2073                 server will copy the ID from client requests to responses and
2074                 U-Boot will use this to determine if it is the destination of
2075                 an incoming response. Some servers will check that addresses
2076                 aren't in use before handing them out (usually using an ARP
2077                 ping) and therefore take up to a few hundred milliseconds to
2078                 respond. Network congestion may also influence the time it
2079                 takes for a response to make it back to the client. If that
2080                 time is too long, U-Boot will retransmit requests. In order
2081                 to allow earlier responses to still be accepted after these
2082                 retransmissions, U-Boot's BOOTP client keeps a small cache of
2083                 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2084                 cache. The default is to keep IDs for up to four outstanding
2085                 requests. Increasing this will allow U-Boot to accept offers
2086                 from a BOOTP client in networks with unusually high latency.
2087
2088 - DHCP Advanced Options:
2089                 You can fine tune the DHCP functionality by defining
2090                 CONFIG_BOOTP_* symbols:
2091
2092                 CONFIG_BOOTP_SUBNETMASK
2093                 CONFIG_BOOTP_GATEWAY
2094                 CONFIG_BOOTP_HOSTNAME
2095                 CONFIG_BOOTP_NISDOMAIN
2096                 CONFIG_BOOTP_BOOTPATH
2097                 CONFIG_BOOTP_BOOTFILESIZE
2098                 CONFIG_BOOTP_DNS
2099                 CONFIG_BOOTP_DNS2
2100                 CONFIG_BOOTP_SEND_HOSTNAME
2101                 CONFIG_BOOTP_NTPSERVER
2102                 CONFIG_BOOTP_TIMEOFFSET
2103                 CONFIG_BOOTP_VENDOREX
2104                 CONFIG_BOOTP_MAY_FAIL
2105
2106                 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2107                 environment variable, not the BOOTP server.
2108
2109                 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2110                 after the configured retry count, the call will fail
2111                 instead of starting over.  This can be used to fail over
2112                 to Link-local IP address configuration if the DHCP server
2113                 is not available.
2114
2115                 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2116                 serverip from a DHCP server, it is possible that more
2117                 than one DNS serverip is offered to the client.
2118                 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2119                 serverip will be stored in the additional environment
2120                 variable "dnsip2". The first DNS serverip is always
2121                 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
2122                 is defined.
2123
2124                 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2125                 to do a dynamic update of a DNS server. To do this, they
2126                 need the hostname of the DHCP requester.
2127                 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
2128                 of the "hostname" environment variable is passed as
2129                 option 12 to the DHCP server.
2130
2131                 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2132
2133                 A 32bit value in microseconds for a delay between
2134                 receiving a "DHCP Offer" and sending the "DHCP Request".
2135                 This fixes a problem with certain DHCP servers that don't
2136                 respond 100% of the time to a "DHCP request". E.g. On an
2137                 AT91RM9200 processor running at 180MHz, this delay needed
2138                 to be *at least* 15,000 usec before a Windows Server 2003
2139                 DHCP server would reply 100% of the time. I recommend at
2140                 least 50,000 usec to be safe. The alternative is to hope
2141                 that one of the retries will be successful but note that
2142                 the DHCP timeout and retry process takes a longer than
2143                 this delay.
2144
2145  - Link-local IP address negotiation:
2146                 Negotiate with other link-local clients on the local network
2147                 for an address that doesn't require explicit configuration.
2148                 This is especially useful if a DHCP server cannot be guaranteed
2149                 to exist in all environments that the device must operate.
2150
2151                 See doc/README.link-local for more information.
2152
2153  - CDP Options:
2154                 CONFIG_CDP_DEVICE_ID
2155
2156                 The device id used in CDP trigger frames.
2157
2158                 CONFIG_CDP_DEVICE_ID_PREFIX
2159
2160                 A two character string which is prefixed to the MAC address
2161                 of the device.
2162
2163                 CONFIG_CDP_PORT_ID
2164
2165                 A printf format string which contains the ascii name of
2166                 the port. Normally is set to "eth%d" which sets
2167                 eth0 for the first Ethernet, eth1 for the second etc.
2168
2169                 CONFIG_CDP_CAPABILITIES
2170
2171                 A 32bit integer which indicates the device capabilities;
2172                 0x00000010 for a normal host which does not forwards.
2173
2174                 CONFIG_CDP_VERSION
2175
2176                 An ascii string containing the version of the software.
2177
2178                 CONFIG_CDP_PLATFORM
2179
2180                 An ascii string containing the name of the platform.
2181
2182                 CONFIG_CDP_TRIGGER
2183
2184                 A 32bit integer sent on the trigger.
2185
2186                 CONFIG_CDP_POWER_CONSUMPTION
2187
2188                 A 16bit integer containing the power consumption of the
2189                 device in .1 of milliwatts.
2190
2191                 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2192
2193                 A byte containing the id of the VLAN.
2194
2195 - Status LED:   CONFIG_STATUS_LED
2196
2197                 Several configurations allow to display the current
2198                 status using a LED. For instance, the LED will blink
2199                 fast while running U-Boot code, stop blinking as
2200                 soon as a reply to a BOOTP request was received, and
2201                 start blinking slow once the Linux kernel is running
2202                 (supported by a status LED driver in the Linux
2203                 kernel). Defining CONFIG_STATUS_LED enables this
2204                 feature in U-Boot.
2205
2206                 Additional options:
2207
2208                 CONFIG_GPIO_LED
2209                 The status LED can be connected to a GPIO pin.
2210                 In such cases, the gpio_led driver can be used as a
2211                 status LED backend implementation. Define CONFIG_GPIO_LED
2212                 to include the gpio_led driver in the U-Boot binary.
2213
2214                 CONFIG_GPIO_LED_INVERTED_TABLE
2215                 Some GPIO connected LEDs may have inverted polarity in which
2216                 case the GPIO high value corresponds to LED off state and
2217                 GPIO low value corresponds to LED on state.
2218                 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2219                 with a list of GPIO LEDs that have inverted polarity.
2220
2221 - CAN Support:  CONFIG_CAN_DRIVER
2222
2223                 Defining CONFIG_CAN_DRIVER enables CAN driver support
2224                 on those systems that support this (optional)
2225                 feature, like the TQM8xxL modules.
2226
2227 - I2C Support:  CONFIG_SYS_I2C
2228
2229                 This enable the NEW i2c subsystem, and will allow you to use
2230                 i2c commands at the u-boot command line (as long as you set
2231                 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2232                 based realtime clock chips or other i2c devices. See
2233                 common/cmd_i2c.c for a description of the command line
2234                 interface.
2235
2236                 ported i2c driver to the new framework:
2237                 - drivers/i2c/soft_i2c.c:
2238                   - activate first bus with CONFIG_SYS_I2C_SOFT define
2239                     CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2240                     for defining speed and slave address
2241                   - activate second bus with I2C_SOFT_DECLARATIONS2 define
2242                     CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2243                     for defining speed and slave address
2244                   - activate third bus with I2C_SOFT_DECLARATIONS3 define
2245                     CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2246                     for defining speed and slave address
2247                   - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2248                     CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2249                     for defining speed and slave address
2250
2251                 - drivers/i2c/fsl_i2c.c:
2252                   - activate i2c driver with CONFIG_SYS_I2C_FSL
2253                     define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2254                     offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2255                     CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2256                     bus.
2257                   - If your board supports a second fsl i2c bus, define
2258                     CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2259                     CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2260                     CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2261                     second bus.
2262
2263                 - drivers/i2c/tegra_i2c.c:
2264                   - activate this driver with CONFIG_SYS_I2C_TEGRA
2265                   - This driver adds 4 i2c buses with a fix speed from
2266                     100000 and the slave addr 0!
2267
2268                 - drivers/i2c/ppc4xx_i2c.c
2269                   - activate this driver with CONFIG_SYS_I2C_PPC4XX
2270                   - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2271                   - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2272
2273                 - drivers/i2c/i2c_mxc.c
2274                   - activate this driver with CONFIG_SYS_I2C_MXC
2275                   - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2276                   - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2277                   - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2278                   - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2279                   - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2280                   - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2281                 If thoses defines are not set, default value is 100000
2282                 for speed, and 0 for slave.
2283
2284                 - drivers/i2c/rcar_i2c.c:
2285                   - activate this driver with CONFIG_SYS_I2C_RCAR
2286                   - This driver adds 4 i2c buses
2287
2288                   - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2289                   - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2290                   - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2291                   - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2292                   - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2293                   - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2294                   - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2295                   - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2296                   - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2297
2298                 - drivers/i2c/sh_i2c.c:
2299                   - activate this driver with CONFIG_SYS_I2C_SH
2300                   - This driver adds from 2 to 5 i2c buses
2301
2302                   - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2303                   - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2304                   - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2305                   - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2306                   - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2307                   - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2308                   - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2309                   - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2310                   - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2311                   - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2312                   - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2313                   - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2314                   - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2315
2316                 - drivers/i2c/omap24xx_i2c.c
2317                   - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2318                   - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2319                   - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2320                   - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2321                   - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2322                   - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2323                   - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2324                   - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2325                   - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2326                   - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2327                   - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2328
2329                 - drivers/i2c/zynq_i2c.c
2330                   - activate this driver with CONFIG_SYS_I2C_ZYNQ
2331                   - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2332                   - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2333
2334                 - drivers/i2c/s3c24x0_i2c.c:
2335                   - activate this driver with CONFIG_SYS_I2C_S3C24X0
2336                   - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2337                     9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2338                     with a fix speed from 100000 and the slave addr 0!
2339
2340                 - drivers/i2c/ihs_i2c.c
2341                   - activate this driver with CONFIG_SYS_I2C_IHS
2342                   - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2343                   - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2344                   - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2345                   - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2346                   - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2347                   - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2348                   - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2349                   - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2350                   - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2351                   - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2352                   - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2353                   - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2354
2355                 additional defines:
2356
2357                 CONFIG_SYS_NUM_I2C_BUSES
2358                 Hold the number of i2c busses you want to use. If you
2359                 don't use/have i2c muxes on your i2c bus, this
2360                 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2361                 omit this define.
2362
2363                 CONFIG_SYS_I2C_DIRECT_BUS
2364                 define this, if you don't use i2c muxes on your hardware.
2365                 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2366                 omit this define.
2367
2368                 CONFIG_SYS_I2C_MAX_HOPS
2369                 define how many muxes are maximal consecutively connected
2370                 on one i2c bus. If you not use i2c muxes, omit this
2371                 define.
2372
2373                 CONFIG_SYS_I2C_BUSES
2374                 hold a list of busses you want to use, only used if
2375                 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2376                 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2377                 CONFIG_SYS_NUM_I2C_BUSES = 9:
2378
2379                  CONFIG_SYS_I2C_BUSES   {{0, {I2C_NULL_HOP}}, \
2380                                         {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2381                                         {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2382                                         {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2383                                         {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2384                                         {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2385                                         {1, {I2C_NULL_HOP}}, \
2386                                         {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2387                                         {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2388                                         }
2389
2390                 which defines
2391                         bus 0 on adapter 0 without a mux
2392                         bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2393                         bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2394                         bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2395                         bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2396                         bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2397                         bus 6 on adapter 1 without a mux
2398                         bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2399                         bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2400
2401                 If you do not have i2c muxes on your board, omit this define.
2402
2403 - Legacy I2C Support:   CONFIG_HARD_I2C
2404
2405                 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2406                 provides the following compelling advantages:
2407
2408                 - more than one i2c adapter is usable
2409                 - approved multibus support
2410                 - better i2c mux support
2411
2412                 ** Please consider updating your I2C driver now. **
2413
2414                 These enable legacy I2C serial bus commands. Defining
2415                 CONFIG_HARD_I2C will include the appropriate I2C driver
2416                 for the selected CPU.
2417
2418                 This will allow you to use i2c commands at the u-boot
2419                 command line (as long as you set CONFIG_CMD_I2C in
2420                 CONFIG_COMMANDS) and communicate with i2c based realtime
2421                 clock chips. See common/cmd_i2c.c for a description of the
2422                 command line interface.
2423
2424                 CONFIG_HARD_I2C selects a hardware I2C controller.
2425
2426                 There are several other quantities that must also be
2427                 defined when you define CONFIG_HARD_I2C.
2428
2429                 In both cases you will need to define CONFIG_SYS_I2C_SPEED
2430                 to be the frequency (in Hz) at which you wish your i2c bus
2431                 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2432                 the CPU's i2c node address).
2433
2434                 Now, the u-boot i2c code for the mpc8xx
2435                 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2436                 and so its address should therefore be cleared to 0 (See,
2437                 eg, MPC823e User's Manual p.16-473). So, set
2438                 CONFIG_SYS_I2C_SLAVE to 0.
2439
2440                 CONFIG_SYS_I2C_INIT_MPC5XXX
2441
2442                 When a board is reset during an i2c bus transfer
2443                 chips might think that the current transfer is still
2444                 in progress.  Reset the slave devices by sending start
2445                 commands until the slave device responds.
2446
2447                 That's all that's required for CONFIG_HARD_I2C.
2448
2449                 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2450                 then the following macros need to be defined (examples are
2451                 from include/configs/lwmon.h):
2452
2453                 I2C_INIT
2454
2455                 (Optional). Any commands necessary to enable the I2C
2456                 controller or configure ports.
2457
2458                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
2459
2460                 I2C_PORT
2461
2462                 (Only for MPC8260 CPU). The I/O port to use (the code
2463                 assumes both bits are on the same port). Valid values
2464                 are 0..3 for ports A..D.
2465
2466                 I2C_ACTIVE
2467
2468                 The code necessary to make the I2C data line active
2469                 (driven).  If the data line is open collector, this
2470                 define can be null.
2471
2472                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2473
2474                 I2C_TRISTATE
2475
2476                 The code necessary to make the I2C data line tri-stated
2477                 (inactive).  If the data line is open collector, this
2478                 define can be null.
2479
2480                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2481
2482                 I2C_READ
2483
2484                 Code that returns true if the I2C data line is high,
2485                 false if it is low.
2486
2487                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2488
2489                 I2C_SDA(bit)
2490
2491                 If <bit> is true, sets the I2C data line high. If it
2492                 is false, it clears it (low).
2493
2494                 eg: #define I2C_SDA(bit) \
2495                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2496                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
2497
2498                 I2C_SCL(bit)
2499
2500                 If <bit> is true, sets the I2C clock line high. If it
2501                 is false, it clears it (low).
2502
2503                 eg: #define I2C_SCL(bit) \
2504                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2505                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
2506
2507                 I2C_DELAY
2508
2509                 This delay is invoked four times per clock cycle so this
2510                 controls the rate of data transfer.  The data rate thus
2511                 is 1 / (I2C_DELAY * 4). Often defined to be something
2512                 like:
2513
2514                 #define I2C_DELAY  udelay(2)
2515
2516                 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2517
2518                 If your arch supports the generic GPIO framework (asm/gpio.h),
2519                 then you may alternatively define the two GPIOs that are to be
2520                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
2521                 have GPIO-based defaults assigned to them as appropriate.
2522
2523                 You should define these to the GPIO value as given directly to
2524                 the generic GPIO functions.
2525
2526                 CONFIG_SYS_I2C_INIT_BOARD
2527
2528                 When a board is reset during an i2c bus transfer
2529                 chips might think that the current transfer is still
2530                 in progress. On some boards it is possible to access
2531                 the i2c SCLK line directly, either by using the
2532                 processor pin as a GPIO or by having a second pin
2533                 connected to the bus. If this option is defined a
2534                 custom i2c_init_board() routine in boards/xxx/board.c
2535                 is run early in the boot sequence.
2536
2537                 CONFIG_SYS_I2C_BOARD_LATE_INIT
2538
2539                 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2540                 defined a custom i2c_board_late_init() routine in
2541                 boards/xxx/board.c is run AFTER the operations in i2c_init()
2542                 is completed. This callpoint can be used to unreset i2c bus
2543                 using CPU i2c controller register accesses for CPUs whose i2c
2544                 controller provide such a method. It is called at the end of
2545                 i2c_init() to allow i2c_init operations to setup the i2c bus
2546                 controller on the CPU (e.g. setting bus speed & slave address).
2547
2548                 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2549
2550                 This option enables configuration of bi_iic_fast[] flags
2551                 in u-boot bd_info structure based on u-boot environment
2552                 variable "i2cfast". (see also i2cfast)
2553
2554                 CONFIG_I2C_MULTI_BUS
2555
2556                 This option allows the use of multiple I2C buses, each of which
2557                 must have a controller.  At any point in time, only one bus is
2558                 active.  To switch to a different bus, use the 'i2c dev' command.
2559                 Note that bus numbering is zero-based.
2560
2561                 CONFIG_SYS_I2C_NOPROBES
2562
2563                 This option specifies a list of I2C devices that will be skipped
2564                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
2565                 is set, specify a list of bus-device pairs.  Otherwise, specify
2566                 a 1D array of device addresses
2567
2568                 e.g.
2569                         #undef  CONFIG_I2C_MULTI_BUS
2570                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2571
2572                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2573
2574                         #define CONFIG_I2C_MULTI_BUS
2575                         #define CONFIG_SYS_I2C_MULTI_NOPROBES   {{0,0x50},{0,0x68},{1,0x54}}
2576
2577                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2578
2579                 CONFIG_SYS_SPD_BUS_NUM
2580
2581                 If defined, then this indicates the I2C bus number for DDR SPD.
2582                 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2583
2584                 CONFIG_SYS_RTC_BUS_NUM
2585
2586                 If defined, then this indicates the I2C bus number for the RTC.
2587                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2588
2589                 CONFIG_SYS_DTT_BUS_NUM
2590
2591                 If defined, then this indicates the I2C bus number for the DTT.
2592                 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2593
2594                 CONFIG_SYS_I2C_DTT_ADDR:
2595
2596                 If defined, specifies the I2C address of the DTT device.
2597                 If not defined, then U-Boot uses predefined value for
2598                 specified DTT device.
2599
2600                 CONFIG_SOFT_I2C_READ_REPEATED_START
2601
2602                 defining this will force the i2c_read() function in
2603                 the soft_i2c driver to perform an I2C repeated start
2604                 between writing the address pointer and reading the
2605                 data.  If this define is omitted the default behaviour
2606                 of doing a stop-start sequence will be used.  Most I2C
2607                 devices can use either method, but some require one or
2608                 the other.
2609
2610 - SPI Support:  CONFIG_SPI
2611
2612                 Enables SPI driver (so far only tested with
2613                 SPI EEPROM, also an instance works with Crystal A/D and
2614                 D/As on the SACSng board)
2615
2616                 CONFIG_SH_SPI
2617
2618                 Enables the driver for SPI controller on SuperH. Currently
2619                 only SH7757 is supported.
2620
2621                 CONFIG_SPI_X
2622
2623                 Enables extended (16-bit) SPI EEPROM addressing.
2624                 (symmetrical to CONFIG_I2C_X)
2625
2626                 CONFIG_SOFT_SPI
2627
2628                 Enables a software (bit-bang) SPI driver rather than
2629                 using hardware support. This is a general purpose
2630                 driver that only requires three general I/O port pins
2631                 (two outputs, one input) to function. If this is
2632                 defined, the board configuration must define several
2633                 SPI configuration items (port pins to use, etc). For
2634                 an example, see include/configs/sacsng.h.
2635
2636                 CONFIG_HARD_SPI
2637
2638                 Enables a hardware SPI driver for general-purpose reads
2639                 and writes.  As with CONFIG_SOFT_SPI, the board configuration
2640                 must define a list of chip-select function pointers.
2641                 Currently supported on some MPC8xxx processors.  For an
2642                 example, see include/configs/mpc8349emds.h.
2643
2644                 CONFIG_MXC_SPI
2645
2646                 Enables the driver for the SPI controllers on i.MX and MXC
2647                 SoCs. Currently i.MX31/35/51 are supported.
2648
2649                 CONFIG_SYS_SPI_MXC_WAIT
2650                 Timeout for waiting until spi transfer completed.
2651                 default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2652
2653 - FPGA Support: CONFIG_FPGA
2654
2655                 Enables FPGA subsystem.
2656
2657                 CONFIG_FPGA_<vendor>
2658
2659                 Enables support for specific chip vendors.
2660                 (ALTERA, XILINX)
2661
2662                 CONFIG_FPGA_<family>
2663
2664                 Enables support for FPGA family.
2665                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2666
2667                 CONFIG_FPGA_COUNT
2668
2669                 Specify the number of FPGA devices to support.
2670
2671                 CONFIG_CMD_FPGA_LOADMK
2672
2673                 Enable support for fpga loadmk command
2674
2675                 CONFIG_CMD_FPGA_LOADP
2676
2677                 Enable support for fpga loadp command - load partial bitstream
2678
2679                 CONFIG_CMD_FPGA_LOADBP
2680
2681                 Enable support for fpga loadbp command - load partial bitstream
2682                 (Xilinx only)
2683
2684                 CONFIG_SYS_FPGA_PROG_FEEDBACK
2685
2686                 Enable printing of hash marks during FPGA configuration.
2687
2688                 CONFIG_SYS_FPGA_CHECK_BUSY
2689
2690                 Enable checks on FPGA configuration interface busy
2691                 status by the configuration function. This option
2692                 will require a board or device specific function to
2693                 be written.
2694
2695                 CONFIG_FPGA_DELAY
2696
2697                 If defined, a function that provides delays in the FPGA
2698                 configuration driver.
2699
2700                 CONFIG_SYS_FPGA_CHECK_CTRLC
2701                 Allow Control-C to interrupt FPGA configuration
2702
2703                 CONFIG_SYS_FPGA_CHECK_ERROR
2704
2705                 Check for configuration errors during FPGA bitfile
2706                 loading. For example, abort during Virtex II
2707                 configuration if the INIT_B line goes low (which
2708                 indicated a CRC error).
2709
2710                 CONFIG_SYS_FPGA_WAIT_INIT
2711
2712                 Maximum time to wait for the INIT_B line to deassert
2713                 after PROB_B has been deasserted during a Virtex II
2714                 FPGA configuration sequence. The default time is 500
2715                 ms.
2716
2717                 CONFIG_SYS_FPGA_WAIT_BUSY
2718
2719                 Maximum time to wait for BUSY to deassert during
2720                 Virtex II FPGA configuration. The default is 5 ms.
2721
2722                 CONFIG_SYS_FPGA_WAIT_CONFIG
2723
2724                 Time to wait after FPGA configuration. The default is
2725                 200 ms.
2726
2727 - Configuration Management:
2728                 CONFIG_BUILD_TARGET
2729
2730                 Some SoCs need special image types (e.g. U-Boot binary
2731                 with a special header) as build targets. By defining
2732                 CONFIG_BUILD_TARGET in the SoC / board header, this
2733                 special image will be automatically built upon calling
2734                 make / MAKEALL.
2735
2736                 CONFIG_IDENT_STRING
2737
2738                 If defined, this string will be added to the U-Boot
2739                 version information (U_BOOT_VERSION)
2740
2741 - Vendor Parameter Protection:
2742
2743                 U-Boot considers the values of the environment
2744                 variables "serial#" (Board Serial Number) and
2745                 "ethaddr" (Ethernet Address) to be parameters that
2746                 are set once by the board vendor / manufacturer, and
2747                 protects these variables from casual modification by
2748                 the user. Once set, these variables are read-only,
2749                 and write or delete attempts are rejected. You can
2750                 change this behaviour:
2751
2752                 If CONFIG_ENV_OVERWRITE is #defined in your config
2753                 file, the write protection for vendor parameters is
2754                 completely disabled. Anybody can change or delete
2755                 these parameters.
2756
2757                 Alternatively, if you #define _both_ CONFIG_ETHADDR
2758                 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2759                 Ethernet address is installed in the environment,
2760                 which can be changed exactly ONCE by the user. [The
2761                 serial# is unaffected by this, i. e. it remains
2762                 read-only.]
2763
2764                 The same can be accomplished in a more flexible way
2765                 for any variable by configuring the type of access
2766                 to allow for those variables in the ".flags" variable
2767                 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2768
2769 - Protected RAM:
2770                 CONFIG_PRAM
2771
2772                 Define this variable to enable the reservation of
2773                 "protected RAM", i. e. RAM which is not overwritten
2774                 by U-Boot. Define CONFIG_PRAM to hold the number of
2775                 kB you want to reserve for pRAM. You can overwrite
2776                 this default value by defining an environment
2777                 variable "pram" to the number of kB you want to
2778                 reserve. Note that the board info structure will
2779                 still show the full amount of RAM. If pRAM is
2780                 reserved, a new environment variable "mem" will
2781                 automatically be defined to hold the amount of
2782                 remaining RAM in a form that can be passed as boot
2783                 argument to Linux, for instance like that:
2784
2785                         setenv bootargs ... mem=\${mem}
2786                         saveenv
2787
2788                 This way you can tell Linux not to use this memory,
2789                 either, which results in a memory region that will
2790                 not be affected by reboots.
2791
2792                 *WARNING* If your board configuration uses automatic
2793                 detection of the RAM size, you must make sure that
2794                 this memory test is non-destructive. So far, the
2795                 following board configurations are known to be
2796                 "pRAM-clean":
2797
2798                         IVMS8, IVML24, SPD8xx, TQM8xxL,
2799                         HERMES, IP860, RPXlite, LWMON,
2800                         FLAGADM, TQM8260
2801
2802 - Access to physical memory region (> 4GB)
2803                 Some basic support is provided for operations on memory not
2804                 normally accessible to U-Boot - e.g. some architectures
2805                 support access to more than 4GB of memory on 32-bit
2806                 machines using physical address extension or similar.
2807                 Define CONFIG_PHYSMEM to access this basic support, which
2808                 currently only supports clearing the memory.
2809
2810 - Error Recovery:
2811                 CONFIG_PANIC_HANG
2812
2813                 Define this variable to stop the system in case of a
2814                 fatal error, so that you have to reset it manually.
2815                 This is probably NOT a good idea for an embedded
2816                 system where you want the system to reboot
2817                 automatically as fast as possible, but it may be
2818                 useful during development since you can try to debug
2819                 the conditions that lead to the situation.
2820
2821                 CONFIG_NET_RETRY_COUNT
2822
2823                 This variable defines the number of retries for
2824                 network operations like ARP, RARP, TFTP, or BOOTP
2825                 before giving up the operation. If not defined, a
2826                 default value of 5 is used.
2827
2828                 CONFIG_ARP_TIMEOUT
2829
2830                 Timeout waiting for an ARP reply in milliseconds.
2831
2832                 CONFIG_NFS_TIMEOUT
2833
2834                 Timeout in milliseconds used in NFS protocol.
2835                 If you encounter "ERROR: Cannot umount" in nfs command,
2836                 try longer timeout such as
2837                 #define CONFIG_NFS_TIMEOUT 10000UL
2838
2839 - Command Interpreter:
2840                 CONFIG_AUTO_COMPLETE
2841
2842                 Enable auto completion of commands using TAB.
2843
2844                 CONFIG_SYS_HUSH_PARSER
2845
2846                 Define this variable to enable the "hush" shell (from
2847                 Busybox) as command line interpreter, thus enabling
2848                 powerful command line syntax like
2849                 if...then...else...fi conditionals or `&&' and '||'
2850                 constructs ("shell scripts").
2851
2852                 If undefined, you get the old, much simpler behaviour
2853                 with a somewhat smaller memory footprint.
2854
2855
2856                 CONFIG_SYS_PROMPT_HUSH_PS2
2857
2858                 This defines the secondary prompt string, which is
2859                 printed when the command interpreter needs more input
2860                 to complete a command. Usually "> ".
2861
2862         Note:
2863
2864                 In the current implementation, the local variables
2865                 space and global environment variables space are
2866                 separated. Local variables are those you define by
2867                 simply typing `name=value'. To access a local
2868                 variable later on, you have write `$name' or
2869                 `${name}'; to execute the contents of a variable
2870                 directly type `$name' at the command prompt.
2871
2872                 Global environment variables are those you use
2873                 setenv/printenv to work with. To run a command stored
2874                 in such a variable, you need to use the run command,
2875                 and you must not use the '$' sign to access them.
2876
2877                 To store commands and special characters in a
2878                 variable, please use double quotation marks
2879                 surrounding the whole text of the variable, instead
2880                 of the backslashes before semicolons and special
2881                 symbols.
2882
2883 - Commandline Editing and History:
2884                 CONFIG_CMDLINE_EDITING
2885
2886                 Enable editing and History functions for interactive
2887                 commandline input operations
2888
2889 - Default Environment:
2890                 CONFIG_EXTRA_ENV_SETTINGS
2891
2892                 Define this to contain any number of null terminated
2893                 strings (variable = value pairs) that will be part of
2894                 the default environment compiled into the boot image.
2895
2896                 For example, place something like this in your
2897                 board's config file:
2898
2899                 #define CONFIG_EXTRA_ENV_SETTINGS \
2900                         "myvar1=value1\0" \
2901                         "myvar2=value2\0"
2902
2903                 Warning: This method is based on knowledge about the
2904                 internal format how the environment is stored by the
2905                 U-Boot code. This is NOT an official, exported
2906                 interface! Although it is unlikely that this format
2907                 will change soon, there is no guarantee either.
2908                 You better know what you are doing here.
2909
2910                 Note: overly (ab)use of the default environment is
2911                 discouraged. Make sure to check other ways to preset
2912                 the environment like the "source" command or the
2913                 boot command first.
2914
2915                 CONFIG_ENV_VARS_UBOOT_CONFIG
2916
2917                 Define this in order to add variables describing the
2918                 U-Boot build configuration to the default environment.
2919                 These will be named arch, cpu, board, vendor, and soc.
2920
2921                 Enabling this option will cause the following to be defined:
2922
2923                 - CONFIG_SYS_ARCH
2924                 - CONFIG_SYS_CPU
2925                 - CONFIG_SYS_BOARD
2926                 - CONFIG_SYS_VENDOR
2927                 - CONFIG_SYS_SOC
2928
2929                 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2930
2931                 Define this in order to add variables describing certain
2932                 run-time determined information about the hardware to the
2933                 environment.  These will be named board_name, board_rev.
2934
2935                 CONFIG_DELAY_ENVIRONMENT
2936
2937                 Normally the environment is loaded when the board is
2938                 intialised so that it is available to U-Boot. This inhibits
2939                 that so that the environment is not available until
2940                 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2941                 this is instead controlled by the value of
2942                 /config/load-environment.
2943
2944 - DataFlash Support:
2945                 CONFIG_HAS_DATAFLASH
2946
2947                 Defining this option enables DataFlash features and
2948                 allows to read/write in Dataflash via the standard
2949                 commands cp, md...
2950
2951 - Serial Flash support
2952                 CONFIG_CMD_SF
2953
2954                 Defining this option enables SPI flash commands
2955                 'sf probe/read/write/erase/update'.
2956
2957                 Usage requires an initial 'probe' to define the serial
2958                 flash parameters, followed by read/write/erase/update
2959                 commands.
2960
2961                 The following defaults may be provided by the platform
2962                 to handle the common case when only a single serial
2963                 flash is present on the system.
2964
2965                 CONFIG_SF_DEFAULT_BUS           Bus identifier
2966                 CONFIG_SF_DEFAULT_CS            Chip-select
2967                 CONFIG_SF_DEFAULT_MODE          (see include/spi.h)
2968                 CONFIG_SF_DEFAULT_SPEED         in Hz
2969
2970                 CONFIG_CMD_SF_TEST
2971
2972                 Define this option to include a destructive SPI flash
2973                 test ('sf test').
2974
2975                 CONFIG_SPI_FLASH_BAR            Ban/Extended Addr Reg
2976
2977                 Define this option to use the Bank addr/Extended addr
2978                 support on SPI flashes which has size > 16Mbytes.
2979
2980                 CONFIG_SF_DUAL_FLASH            Dual flash memories
2981
2982                 Define this option to use dual flash support where two flash
2983                 memories can be connected with a given cs line.
2984                 currently Xilinx Zynq qspi support these type of connections.
2985
2986                 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2987                 enable the W#/Vpp signal to disable writing to the status
2988                 register on ST MICRON flashes like the N25Q128.
2989                 The status register write enable/disable bit, combined with
2990                 the W#/VPP signal provides hardware data protection for the
2991                 device as follows: When the enable/disable bit is set to 1,
2992                 and the W#/VPP signal is driven LOW, the status register
2993                 nonvolatile bits become read-only and the WRITE STATUS REGISTER
2994                 operation will not execute. The only way to exit this
2995                 hardware-protected mode is to drive W#/VPP HIGH.
2996
2997 - SystemACE Support:
2998                 CONFIG_SYSTEMACE
2999
3000                 Adding this option adds support for Xilinx SystemACE
3001                 chips attached via some sort of local bus. The address
3002                 of the chip must also be defined in the
3003                 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3004
3005                 #define CONFIG_SYSTEMACE
3006                 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3007
3008                 When SystemACE support is added, the "ace" device type
3009                 becomes available to the fat commands, i.e. fatls.
3010
3011 - TFTP Fixed UDP Port:
3012                 CONFIG_TFTP_PORT
3013
3014                 If this is defined, the environment variable tftpsrcp
3015                 is used to supply the TFTP UDP source port value.
3016                 If tftpsrcp isn't defined, the normal pseudo-random port
3017                 number generator is used.
3018
3019                 Also, the environment variable tftpdstp is used to supply
3020                 the TFTP UDP destination port value.  If tftpdstp isn't
3021                 defined, the normal port 69 is used.
3022
3023                 The purpose for tftpsrcp is to allow a TFTP server to
3024                 blindly start the TFTP transfer using the pre-configured
3025                 target IP address and UDP port. This has the effect of
3026                 "punching through" the (Windows XP) firewall, allowing
3027                 the remainder of the TFTP transfer to proceed normally.
3028                 A better solution is to properly configure the firewall,
3029                 but sometimes that is not allowed.
3030
3031 - Hashing support:
3032                 CONFIG_CMD_HASH
3033
3034                 This enables a generic 'hash' command which can produce
3035                 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3036
3037                 CONFIG_HASH_VERIFY
3038
3039                 Enable the hash verify command (hash -v). This adds to code
3040                 size a little.
3041
3042                 CONFIG_SHA1 - support SHA1 hashing
3043                 CONFIG_SHA256 - support SHA256 hashing
3044
3045                 Note: There is also a sha1sum command, which should perhaps
3046                 be deprecated in favour of 'hash sha1'.
3047
3048 - Freescale i.MX specific commands:
3049                 CONFIG_CMD_HDMIDETECT
3050                 This enables 'hdmidet' command which returns true if an
3051                 HDMI monitor is detected.  This command is i.MX 6 specific.
3052
3053                 CONFIG_CMD_BMODE
3054                 This enables the 'bmode' (bootmode) command for forcing
3055                 a boot from specific media.
3056
3057                 This is useful for forcing the ROM's usb downloader to
3058                 activate upon a watchdog reset which is nice when iterating
3059                 on U-Boot.  Using the reset button or running bmode normal
3060                 will set it back to normal.  This command currently
3061                 supports i.MX53 and i.MX6.
3062
3063 - Signing support:
3064                 CONFIG_RSA
3065
3066                 This enables the RSA algorithm used for FIT image verification
3067                 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
3068
3069                 The signing part is build into mkimage regardless of this
3070                 option.
3071
3072 - bootcount support:
3073                 CONFIG_BOOTCOUNT_LIMIT
3074
3075                 This enables the bootcounter support, see:
3076                 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3077
3078                 CONFIG_AT91SAM9XE
3079                 enable special bootcounter support on at91sam9xe based boards.
3080                 CONFIG_BLACKFIN
3081                 enable special bootcounter support on blackfin based boards.
3082                 CONFIG_SOC_DA8XX
3083                 enable special bootcounter support on da850 based boards.
3084                 CONFIG_BOOTCOUNT_RAM
3085                 enable support for the bootcounter in RAM
3086                 CONFIG_BOOTCOUNT_I2C
3087                 enable support for the bootcounter on an i2c (like RTC) device.
3088                         CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3089                         CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3090                                                     the bootcounter.
3091                         CONFIG_BOOTCOUNT_ALEN = address len
3092
3093 - Show boot progress:
3094                 CONFIG_SHOW_BOOT_PROGRESS
3095
3096                 Defining this option allows to add some board-
3097                 specific code (calling a user-provided function
3098                 "show_boot_progress(int)") that enables you to show
3099                 the system's boot progress on some display (for
3100                 example, some LED's) on your board. At the moment,
3101                 the following checkpoints are implemented:
3102
3103 - Detailed boot stage timing
3104                 CONFIG_BOOTSTAGE
3105                 Define this option to get detailed timing of each stage
3106                 of the boot process.
3107
3108                 CONFIG_BOOTSTAGE_USER_COUNT
3109                 This is the number of available user bootstage records.
3110                 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3111                 a new ID will be allocated from this stash. If you exceed
3112                 the limit, recording will stop.
3113
3114                 CONFIG_BOOTSTAGE_REPORT
3115                 Define this to print a report before boot, similar to this:
3116
3117                 Timer summary in microseconds:
3118                        Mark    Elapsed  Stage
3119                           0          0  reset
3120                   3,575,678  3,575,678  board_init_f start
3121                   3,575,695         17  arch_cpu_init A9
3122                   3,575,777         82  arch_cpu_init done
3123                   3,659,598     83,821  board_init_r start
3124                   3,910,375    250,777  main_loop
3125                  29,916,167 26,005,792  bootm_start
3126                  30,361,327    445,160  start_kernel
3127
3128                 CONFIG_CMD_BOOTSTAGE
3129                 Add a 'bootstage' command which supports printing a report
3130                 and un/stashing of bootstage data.
3131
3132                 CONFIG_BOOTSTAGE_FDT
3133                 Stash the bootstage information in the FDT. A root 'bootstage'
3134                 node is created with each bootstage id as a child. Each child
3135                 has a 'name' property and either 'mark' containing the
3136                 mark time in microsecond, or 'accum' containing the
3137                 accumulated time for that bootstage id in microseconds.
3138                 For example:
3139
3140                 bootstage {
3141                         154 {
3142                                 name = "board_init_f";
3143                                 mark = <3575678>;
3144                         };
3145                         170 {
3146                                 name = "lcd";
3147                                 accum = <33482>;
3148                         };
3149                 };
3150
3151                 Code in the Linux kernel can find this in /proc/devicetree.
3152
3153 Legacy uImage format:
3154
3155   Arg   Where                   When
3156     1   common/cmd_bootm.c      before attempting to boot an image
3157    -1   common/cmd_bootm.c      Image header has bad     magic number
3158     2   common/cmd_bootm.c      Image header has correct magic number
3159    -2   common/cmd_bootm.c      Image header has bad     checksum
3160     3   common/cmd_bootm.c      Image header has correct checksum
3161    -3   common/cmd_bootm.c      Image data   has bad     checksum
3162     4   common/cmd_bootm.c      Image data   has correct checksum
3163    -4   common/cmd_bootm.c      Image is for unsupported architecture
3164     5   common/cmd_bootm.c      Architecture check OK
3165    -5   common/cmd_bootm.c      Wrong Image Type (not kernel, multi)
3166     6   common/cmd_bootm.c      Image Type check OK
3167    -6   common/cmd_bootm.c      gunzip uncompression error
3168    -7   common/cmd_bootm.c      Unimplemented compression type
3169     7   common/cmd_bootm.c      Uncompression OK
3170     8   common/cmd_bootm.c      No uncompress/copy overwrite error
3171    -9   common/cmd_bootm.c      Unsupported OS (not Linux, BSD, VxWorks, QNX)
3172
3173     9   common/image.c          Start initial ramdisk verification
3174   -10   common/image.c          Ramdisk header has bad     magic number
3175   -11   common/image.c          Ramdisk header has bad     checksum
3176    10   common/image.c          Ramdisk header is OK
3177   -12   common/image.c          Ramdisk data   has bad     checksum
3178    11   common/image.c          Ramdisk data   has correct checksum
3179    12   common/image.c          Ramdisk verification complete, start loading
3180   -13   common/image.c          Wrong Image Type (not PPC Linux ramdisk)
3181    13   common/image.c          Start multifile image verification
3182    14   common/image.c          No initial ramdisk, no multifile, continue.
3183
3184    15   arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3185
3186   -30   arch/powerpc/lib/board.c        Fatal error, hang the system
3187   -31   post/post.c             POST test failed, detected by post_output_backlog()
3188   -32   post/post.c             POST test failed, detected by post_run_single()
3189
3190    34   common/cmd_doc.c        before loading a Image from a DOC device
3191   -35   common/cmd_doc.c        Bad usage of "doc" command
3192    35   common/cmd_doc.c        correct usage of "doc" command
3193   -36   common/cmd_doc.c        No boot device
3194    36   common/cmd_doc.c        correct boot device
3195   -37   common/cmd_doc.c        Unknown Chip ID on boot device
3196    37   common/cmd_doc.c        correct chip ID found, device available
3197   -38   common/cmd_doc.c        Read Error on boot device
3198    38   common/cmd_doc.c        reading Image header from DOC device OK
3199   -39   common/cmd_doc.c        Image header has bad magic number
3200    39   common/cmd_doc.c        Image header has correct magic number
3201   -40   common/cmd_doc.c        Error reading Image from DOC device
3202    40   common/cmd_doc.c        Image header has correct magic number
3203    41   common/cmd_ide.c        before loading a Image from a IDE device
3204   -42   common/cmd_ide.c        Bad usage of "ide" command
3205    42   common/cmd_ide.c        correct usage of "ide" command
3206   -43   common/cmd_ide.c        No boot device
3207    43   common/cmd_ide.c        boot device found
3208   -44   common/cmd_ide.c        Device not available
3209    44   common/cmd_ide.c        Device available
3210   -45   common/cmd_ide.c        wrong partition selected
3211    45   common/cmd_ide.c        partition selected
3212   -46   common/cmd_ide.c        Unknown partition table
3213    46   common/cmd_ide.c        valid partition table found
3214   -47   common/cmd_ide.c        Invalid partition type
3215    47   common/cmd_ide.c        correct partition type
3216   -48   common/cmd_ide.c        Error reading Image Header on boot device
3217    48   common/cmd_ide.c        reading Image Header from IDE device OK
3218   -49   common/cmd_ide.c        Image header has bad magic number
3219    49   common/cmd_ide.c        Image header has correct magic number
3220   -50   common/cmd_ide.c        Image header has bad     checksum
3221    50   common/cmd_ide.c        Image header has correct checksum
3222   -51   common/cmd_ide.c        Error reading Image from IDE device
3223    51   common/cmd_ide.c        reading Image from IDE device OK
3224    52   common/cmd_nand.c       before loading a Image from a NAND device
3225   -53   common/cmd_nand.c       Bad usage of "nand" command
3226    53   common/cmd_nand.c       correct usage of "nand" command
3227   -54   common/cmd_nand.c       No boot device
3228    54   common/cmd_nand.c       boot device found
3229   -55   common/cmd_nand.c       Unknown Chip ID on boot device
3230    55   common/cmd_nand.c       correct chip ID found, device available
3231   -56   common/cmd_nand.c       Error reading Image Header on boot device
3232    56   common/cmd_nand.c       reading Image Header from NAND device OK
3233   -57   common/cmd_nand.c       Image header has bad magic number
3234    57   common/cmd_nand.c       Image header has correct magic number
3235   -58   common/cmd_nand.c       Error reading Image from NAND device
3236    58   common/cmd_nand.c       reading Image from NAND device OK
3237
3238   -60   common/env_common.c     Environment has a bad CRC, using default
3239
3240    64   net/eth.c               starting with Ethernet configuration.
3241   -64   net/eth.c               no Ethernet found.
3242    65   net/eth.c               Ethernet found.
3243
3244   -80   common/cmd_net.c        usage wrong
3245    80   common/cmd_net.c        before calling NetLoop()
3246   -81   common/cmd_net.c        some error in NetLoop() occurred
3247    81   common/cmd_net.c        NetLoop() back without error
3248   -82   common/cmd_net.c        size == 0 (File with size 0 loaded)
3249    82   common/cmd_net.c        trying automatic boot
3250    83   common/cmd_net.c        running "source" command
3251   -83   common/cmd_net.c        some error in automatic boot or "source" command
3252    84   common/cmd_net.c        end without errors
3253
3254 FIT uImage format:
3255
3256   Arg   Where                   When
3257   100   common/cmd_bootm.c      Kernel FIT Image has correct format
3258  -100   common/cmd_bootm.c      Kernel FIT Image has incorrect format
3259   101   common/cmd_bootm.c      No Kernel subimage unit name, using configuration
3260  -101   common/cmd_bootm.c      Can't get configuration for kernel subimage
3261   102   common/cmd_bootm.c      Kernel unit name specified
3262  -103   common/cmd_bootm.c      Can't get kernel subimage node offset
3263   103   common/cmd_bootm.c      Found configuration node
3264   104   common/cmd_bootm.c      Got kernel subimage node offset
3265  -104   common/cmd_bootm.c      Kernel subimage hash verification failed
3266   105   common/cmd_bootm.c      Kernel subimage hash verification OK
3267  -105   common/cmd_bootm.c      Kernel subimage is for unsupported architecture
3268   106   common/cmd_bootm.c      Architecture check OK
3269  -106   common/cmd_bootm.c      Kernel subimage has wrong type
3270   107   common/cmd_bootm.c      Kernel subimage type OK
3271  -107   common/cmd_bootm.c      Can't get kernel subimage data/size
3272   108   common/cmd_bootm.c      Got kernel subimage data/size
3273  -108   common/cmd_bootm.c      Wrong image type (not legacy, FIT)
3274  -109   common/cmd_bootm.c      Can't get kernel subimage type
3275  -110   common/cmd_bootm.c      Can't get kernel subimage comp
3276  -111   common/cmd_bootm.c      Can't get kernel subimage os
3277  -112   common/cmd_bootm.c      Can't get kernel subimage load address
3278  -113   common/cmd_bootm.c      Image uncompress/copy overwrite error
3279
3280   120   common/image.c          Start initial ramdisk verification
3281  -120   common/image.c          Ramdisk FIT image has incorrect format
3282   121   common/image.c          Ramdisk FIT image has correct format
3283   122   common/image.c          No ramdisk subimage unit name, using configuration
3284  -122   common/image.c          Can't get configuration for ramdisk subimage
3285   123   common/image.c          Ramdisk unit name specified
3286  -124   common/image.c          Can't get ramdisk subimage node offset
3287   125   common/image.c          Got ramdisk subimage node offset
3288  -125   common/image.c          Ramdisk subimage hash verification failed
3289   126   common/image.c          Ramdisk subimage hash verification OK
3290  -126   common/image.c          Ramdisk subimage for unsupported architecture
3291   127   common/image.c          Architecture check OK
3292  -127   common/image.c          Can't get ramdisk subimage data/size
3293   128   common/image.c          Got ramdisk subimage data/size
3294   129   common/image.c          Can't get ramdisk load address
3295  -129   common/image.c          Got ramdisk load address
3296
3297  -130   common/cmd_doc.c        Incorrect FIT image format
3298   131   common/cmd_doc.c        FIT image format OK
3299
3300  -140   common/cmd_ide.c        Incorrect FIT image format
3301   141   common/cmd_ide.c        FIT image format OK
3302
3303  -150   common/cmd_nand.c       Incorrect FIT image format
3304   151   common/cmd_nand.c       FIT image format OK
3305
3306 - legacy image format:
3307                 CONFIG_IMAGE_FORMAT_LEGACY
3308                 enables the legacy image format support in U-Boot.
3309
3310                 Default:
3311                 enabled if CONFIG_FIT_SIGNATURE is not defined.
3312
3313                 CONFIG_DISABLE_IMAGE_LEGACY
3314                 disable the legacy image format
3315
3316                 This define is introduced, as the legacy image format is
3317                 enabled per default for backward compatibility.
3318
3319 - FIT image support:
3320                 CONFIG_FIT
3321                 Enable support for the FIT uImage format.
3322
3323                 CONFIG_FIT_BEST_MATCH
3324                 When no configuration is explicitly selected, default to the
3325                 one whose fdt's compatibility field best matches that of
3326                 U-Boot itself. A match is considered "best" if it matches the
3327                 most specific compatibility entry of U-Boot's fdt's root node.
3328                 The order of entries in the configuration's fdt is ignored.
3329
3330                 CONFIG_FIT_SIGNATURE
3331                 This option enables signature verification of FIT uImages,
3332                 using a hash signed and verified using RSA. See
3333                 doc/uImage.FIT/signature.txt for more details.
3334
3335                 WARNING: When relying on signed FIT images with required
3336                 signature check the legacy image format is default
3337                 disabled. If a board need legacy image format support
3338                 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3339
3340                 CONFIG_FIT_DISABLE_SHA256
3341                 Supporting SHA256 hashes has quite an impact on binary size.
3342                 For constrained systems sha256 hash support can be disabled
3343                 with this option.
3344
3345 - Standalone program support:
3346                 CONFIG_STANDALONE_LOAD_ADDR
3347
3348                 This option defines a board specific value for the
3349                 address where standalone program gets loaded, thus
3350                 overwriting the architecture dependent default
3351                 settings.
3352
3353 - Frame Buffer Address:
3354                 CONFIG_FB_ADDR
3355
3356                 Define CONFIG_FB_ADDR if you want to use specific
3357                 address for frame buffer.  This is typically the case
3358                 when using a graphics controller has separate video
3359                 memory.  U-Boot will then place the frame buffer at
3360                 the given address instead of dynamically reserving it
3361                 in system RAM by calling lcd_setmem(), which grabs
3362                 the memory for the frame buffer depending on the
3363                 configured panel size.
3364
3365                 Please see board_init_f function.
3366
3367 - Automatic software updates via TFTP server
3368                 CONFIG_UPDATE_TFTP
3369                 CONFIG_UPDATE_TFTP_CNT_MAX
3370                 CONFIG_UPDATE_TFTP_MSEC_MAX
3371
3372                 These options enable and control the auto-update feature;
3373                 for a more detailed description refer to doc/README.update.
3374
3375 - MTD Support (mtdparts command, UBI support)
3376                 CONFIG_MTD_DEVICE
3377
3378                 Adds the MTD device infrastructure from the Linux kernel.
3379                 Needed for mtdparts command support.
3380
3381                 CONFIG_MTD_PARTITIONS
3382
3383                 Adds the MTD partitioning infrastructure from the Linux
3384                 kernel. Needed for UBI support.
3385
3386                 CONFIG_MTD_NAND_VERIFY_WRITE
3387                 verify if the written data is correct reread.
3388
3389 - UBI support
3390                 CONFIG_CMD_UBI
3391
3392                 Adds commands for interacting with MTD partitions formatted
3393                 with the UBI flash translation layer
3394
3395                 Requires also defining CONFIG_RBTREE
3396
3397                 CONFIG_UBI_SILENCE_MSG
3398
3399                 Make the verbose messages from UBI stop printing.  This leaves
3400                 warnings and errors enabled.
3401
3402
3403                 CONFIG_MTD_UBI_WL_THRESHOLD
3404                 This parameter defines the maximum difference between the highest
3405                 erase counter value and the lowest erase counter value of eraseblocks
3406                 of UBI devices. When this threshold is exceeded, UBI starts performing
3407                 wear leveling by means of moving data from eraseblock with low erase
3408                 counter to eraseblocks with high erase counter.
3409
3410                 The default value should be OK for SLC NAND flashes, NOR flashes and
3411                 other flashes which have eraseblock life-cycle 100000 or more.
3412                 However, in case of MLC NAND flashes which typically have eraseblock
3413                 life-cycle less than 10000, the threshold should be lessened (e.g.,
3414                 to 128 or 256, although it does not have to be power of 2).
3415
3416                 default: 4096
3417
3418                 CONFIG_MTD_UBI_BEB_LIMIT
3419                 This option specifies the maximum bad physical eraseblocks UBI
3420                 expects on the MTD device (per 1024 eraseblocks). If the
3421                 underlying flash does not admit of bad eraseblocks (e.g. NOR
3422                 flash), this value is ignored.
3423
3424                 NAND datasheets often specify the minimum and maximum NVM
3425                 (Number of Valid Blocks) for the flashes' endurance lifetime.
3426                 The maximum expected bad eraseblocks per 1024 eraseblocks
3427                 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3428                 which gives 20 for most NANDs (MaxNVB is basically the total
3429                 count of eraseblocks on the chip).
3430
3431                 To put it differently, if this value is 20, UBI will try to
3432                 reserve about 1.9% of physical eraseblocks for bad blocks
3433                 handling. And that will be 1.9% of eraseblocks on the entire
3434                 NAND chip, not just the MTD partition UBI attaches. This means
3435                 that if you have, say, a NAND flash chip admits maximum 40 bad
3436                 eraseblocks, and it is split on two MTD partitions of the same
3437                 size, UBI will reserve 40 eraseblocks when attaching a
3438                 partition.
3439
3440                 default: 20
3441
3442                 CONFIG_MTD_UBI_FASTMAP
3443                 Fastmap is a mechanism which allows attaching an UBI device
3444                 in nearly constant time. Instead of scanning the whole MTD device it
3445                 only has to locate a checkpoint (called fastmap) on the device.
3446                 The on-flash fastmap contains all information needed to attach
3447                 the device. Using fastmap makes only sense on large devices where
3448                 attaching by scanning takes long. UBI will not automatically install
3449                 a fastmap on old images, but you can set the UBI parameter
3450                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3451                 that fastmap-enabled images are still usable with UBI implementations
3452                 without fastmap support. On typical flash devices the whole fastmap
3453                 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3454
3455                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3456                 Set this parameter to enable fastmap automatically on images
3457                 without a fastmap.
3458                 default: 0
3459
3460 - UBIFS support
3461                 CONFIG_CMD_UBIFS
3462
3463                 Adds commands for interacting with UBI volumes formatted as
3464                 UBIFS.  UBIFS is read-only in u-boot.
3465
3466                 Requires UBI support as well as CONFIG_LZO
3467
3468                 CONFIG_UBIFS_SILENCE_MSG
3469
3470                 Make the verbose messages from UBIFS stop printing.  This leaves
3471                 warnings and errors enabled.
3472
3473 - SPL framework
3474                 CONFIG_SPL
3475                 Enable building of SPL globally.
3476
3477                 CONFIG_SPL_LDSCRIPT
3478                 LDSCRIPT for linking the SPL binary.
3479
3480                 CONFIG_SPL_MAX_FOOTPRINT
3481                 Maximum size in memory allocated to the SPL, BSS included.
3482                 When defined, the linker checks that the actual memory
3483                 used by SPL from _start to __bss_end does not exceed it.
3484                 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3485                 must not be both defined at the same time.
3486
3487                 CONFIG_SPL_MAX_SIZE
3488                 Maximum size of the SPL image (text, data, rodata, and
3489                 linker lists sections), BSS excluded.
3490                 When defined, the linker checks that the actual size does
3491                 not exceed it.
3492
3493                 CONFIG_SPL_TEXT_BASE
3494                 TEXT_BASE for linking the SPL binary.
3495
3496                 CONFIG_SPL_RELOC_TEXT_BASE
3497                 Address to relocate to.  If unspecified, this is equal to
3498                 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3499
3500                 CONFIG_SPL_BSS_START_ADDR
3501                 Link address for the BSS within the SPL binary.
3502
3503                 CONFIG_SPL_BSS_MAX_SIZE
3504                 Maximum size in memory allocated to the SPL BSS.
3505                 When defined, the linker checks that the actual memory used
3506                 by SPL from __bss_start to __bss_end does not exceed it.
3507                 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3508                 must not be both defined at the same time.
3509
3510                 CONFIG_SPL_STACK
3511                 Adress of the start of the stack SPL will use
3512
3513                 CONFIG_SPL_RELOC_STACK
3514                 Adress of the start of the stack SPL will use after
3515                 relocation.  If unspecified, this is equal to
3516                 CONFIG_SPL_STACK.
3517
3518                 CONFIG_SYS_SPL_MALLOC_START
3519                 Starting address of the malloc pool used in SPL.
3520
3521                 CONFIG_SYS_SPL_MALLOC_SIZE
3522                 The size of the malloc pool used in SPL.
3523
3524                 CONFIG_SPL_FRAMEWORK
3525                 Enable the SPL framework under common/.  This framework
3526                 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3527                 NAND loading of the Linux Kernel.
3528
3529                 CONFIG_SPL_OS_BOOT
3530                 Enable booting directly to an OS from SPL.
3531                 See also: doc/README.falcon
3532
3533                 CONFIG_SPL_DISPLAY_PRINT
3534                 For ARM, enable an optional function to print more information
3535                 about the running system.
3536
3537                 CONFIG_SPL_INIT_MINIMAL
3538                 Arch init code should be built for a very small image
3539
3540                 CONFIG_SPL_LIBCOMMON_SUPPORT
3541                 Support for common/libcommon.o in SPL binary
3542
3543                 CONFIG_SPL_LIBDISK_SUPPORT
3544                 Support for disk/libdisk.o in SPL binary
3545
3546                 CONFIG_SPL_I2C_SUPPORT
3547                 Support for drivers/i2c/libi2c.o in SPL binary
3548
3549                 CONFIG_SPL_GPIO_SUPPORT
3550                 Support for drivers/gpio/libgpio.o in SPL binary
3551
3552                 CONFIG_SPL_MMC_SUPPORT
3553                 Support for drivers/mmc/libmmc.o in SPL binary
3554
3555                 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3556                 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3557                 CONFIG_SYS_MMC_SD_FS_BOOT_PARTITION
3558                 Address, size and partition on the MMC to load U-Boot from
3559                 when the MMC is being used in raw mode.
3560
3561                 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3562                 Sector to load kernel uImage from when MMC is being
3563                 used in raw mode (for Falcon mode)
3564
3565                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3566                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3567                 Sector and number of sectors to load kernel argument
3568                 parameters from when MMC is being used in raw mode
3569                 (for falcon mode)
3570
3571                 CONFIG_SPL_FAT_SUPPORT
3572                 Support for fs/fat/libfat.o in SPL binary
3573
3574                 CONFIG_SPL_EXT_SUPPORT
3575                 Support for EXT filesystem in SPL binary
3576
3577                 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3578                 Filename to read to load U-Boot when reading from filesystem
3579
3580                 CONFIG_SPL_FS_LOAD_KERNEL_NAME
3581                 Filename to read to load kernel uImage when reading
3582                 from filesystem (for Falcon mode)
3583
3584                 CONFIG_SPL_FS_LOAD_ARGS_NAME
3585                 Filename to read to load kernel argument parameters
3586                 when reading from filesystem (for Falcon mode)
3587
3588                 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3589                 Set this for NAND SPL on PPC mpc83xx targets, so that
3590                 start.S waits for the rest of the SPL to load before
3591                 continuing (the hardware starts execution after just
3592                 loading the first page rather than the full 4K).
3593
3594                 CONFIG_SPL_SKIP_RELOCATE
3595                 Avoid SPL relocation
3596
3597                 CONFIG_SPL_NAND_BASE
3598                 Include nand_base.c in the SPL.  Requires
3599                 CONFIG_SPL_NAND_DRIVERS.
3600
3601                 CONFIG_SPL_NAND_DRIVERS
3602                 SPL uses normal NAND drivers, not minimal drivers.
3603
3604                 CONFIG_SPL_NAND_ECC
3605                 Include standard software ECC in the SPL
3606
3607                 CONFIG_SPL_NAND_SIMPLE
3608                 Support for NAND boot using simple NAND drivers that
3609                 expose the cmd_ctrl() interface.
3610
3611                 CONFIG_SPL_MTD_SUPPORT
3612                 Support for the MTD subsystem within SPL.  Useful for
3613                 environment on NAND support within SPL.
3614
3615                 CONFIG_SPL_NAND_RAW_ONLY
3616                 Support to boot only raw u-boot.bin images. Use this only
3617                 if you need to save space.
3618
3619                 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3620                 Set for the SPL on PPC mpc8xxx targets, support for
3621                 drivers/ddr/fsl/libddr.o in SPL binary.
3622
3623                 CONFIG_SPL_COMMON_INIT_DDR
3624                 Set for common ddr init with serial presence detect in
3625                 SPL binary.
3626
3627                 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3628                 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3629                 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3630                 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3631                 CONFIG_SYS_NAND_ECCBYTES
3632                 Defines the size and behavior of the NAND that SPL uses
3633                 to read U-Boot
3634
3635                 CONFIG_SPL_NAND_BOOT
3636                 Add support NAND boot
3637
3638                 CONFIG_SYS_NAND_U_BOOT_OFFS
3639                 Location in NAND to read U-Boot from
3640
3641                 CONFIG_SYS_NAND_U_BOOT_DST
3642                 Location in memory to load U-Boot to
3643
3644                 CONFIG_SYS_NAND_U_BOOT_SIZE
3645                 Size of image to load
3646
3647                 CONFIG_SYS_NAND_U_BOOT_START
3648                 Entry point in loaded image to jump to
3649
3650                 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3651                 Define this if you need to first read the OOB and then the
3652                 data. This is used for example on davinci plattforms.
3653
3654                 CONFIG_SPL_OMAP3_ID_NAND
3655                 Support for an OMAP3-specific set of functions to return the
3656                 ID and MFR of the first attached NAND chip, if present.
3657
3658                 CONFIG_SPL_SERIAL_SUPPORT
3659                 Support for drivers/serial/libserial.o in SPL binary
3660
3661                 CONFIG_SPL_SPI_FLASH_SUPPORT
3662                 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
3663
3664                 CONFIG_SPL_SPI_SUPPORT
3665                 Support for drivers/spi/libspi.o in SPL binary
3666
3667                 CONFIG_SPL_RAM_DEVICE
3668                 Support for running image already present in ram, in SPL binary
3669
3670                 CONFIG_SPL_LIBGENERIC_SUPPORT
3671                 Support for lib/libgeneric.o in SPL binary
3672
3673                 CONFIG_SPL_ENV_SUPPORT
3674                 Support for the environment operating in SPL binary
3675
3676                 CONFIG_SPL_NET_SUPPORT
3677                 Support for the net/libnet.o in SPL binary.
3678                 It conflicts with SPL env from storage medium specified by
3679                 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3680
3681                 CONFIG_SPL_PAD_TO
3682                 Image offset to which the SPL should be padded before appending
3683                 the SPL payload. By default, this is defined as
3684                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3685                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3686                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3687
3688                 CONFIG_SPL_TARGET
3689                 Final target image containing SPL and payload.  Some SPLs
3690                 use an arch-specific makefile fragment instead, for
3691                 example if more than one image needs to be produced.
3692
3693                 CONFIG_FIT_SPL_PRINT
3694                 Printing information about a FIT image adds quite a bit of
3695                 code to SPL. So this is normally disabled in SPL. Use this
3696                 option to re-enable it. This will affect the output of the
3697                 bootm command when booting a FIT image.
3698
3699 - TPL framework
3700                 CONFIG_TPL
3701                 Enable building of TPL globally.
3702
3703                 CONFIG_TPL_PAD_TO
3704                 Image offset to which the TPL should be padded before appending
3705                 the TPL payload. By default, this is defined as
3706                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3707                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3708                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3709
3710 Modem Support:
3711 --------------
3712
3713 [so far only for SMDK2400 boards]
3714
3715 - Modem support enable:
3716                 CONFIG_MODEM_SUPPORT
3717
3718 - RTS/CTS Flow control enable:
3719                 CONFIG_HWFLOW
3720
3721 - Modem debug support:
3722                 CONFIG_MODEM_SUPPORT_DEBUG
3723
3724                 Enables debugging stuff (char screen[1024], dbg())
3725                 for modem support. Useful only with BDI2000.
3726
3727 - Interrupt support (PPC):
3728
3729                 There are common interrupt_init() and timer_interrupt()
3730                 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
3731                 for CPU specific initialization. interrupt_init_cpu()
3732                 should set decrementer_count to appropriate value. If
3733                 CPU resets decrementer automatically after interrupt
3734                 (ppc4xx) it should set decrementer_count to zero.
3735                 timer_interrupt() calls timer_interrupt_cpu() for CPU
3736                 specific handling. If board has watchdog / status_led
3737                 / other_activity_monitor it works automatically from
3738                 general timer_interrupt().
3739
3740 - General:
3741
3742                 In the target system modem support is enabled when a
3743                 specific key (key combination) is pressed during
3744                 power-on. Otherwise U-Boot will boot normally
3745                 (autoboot). The key_pressed() function is called from
3746                 board_init(). Currently key_pressed() is a dummy
3747                 function, returning 1 and thus enabling modem
3748                 initialization.
3749
3750                 If there are no modem init strings in the
3751                 environment, U-Boot proceed to autoboot; the
3752                 previous output (banner, info printfs) will be
3753                 suppressed, though.
3754
3755                 See also: doc/README.Modem
3756
3757 Board initialization settings:
3758 ------------------------------
3759
3760 During Initialization u-boot calls a number of board specific functions
3761 to allow the preparation of board specific prerequisites, e.g. pin setup
3762 before drivers are initialized. To enable these callbacks the
3763 following configuration macros have to be defined. Currently this is
3764 architecture specific, so please check arch/your_architecture/lib/board.c
3765 typically in board_init_f() and board_init_r().
3766
3767 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3768 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3769 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
3770 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3771
3772 Configuration Settings:
3773 -----------------------
3774
3775 - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3776                 Optionally it can be defined to support 64-bit memory commands.
3777
3778 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3779                 undefine this when you're short of memory.
3780
3781 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3782                 width of the commands listed in the 'help' command output.
3783
3784 - CONFIG_SYS_PROMPT:    This is what U-Boot prints on the console to
3785                 prompt for user input.
3786
3787 - CONFIG_SYS_CBSIZE:    Buffer size for input from the Console
3788
3789 - CONFIG_SYS_PBSIZE:    Buffer size for Console output
3790
3791 - CONFIG_SYS_MAXARGS:   max. Number of arguments accepted for monitor commands
3792
3793 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3794                 the application (usually a Linux kernel) when it is
3795                 booted
3796
3797 - CONFIG_SYS_BAUDRATE_TABLE:
3798                 List of legal baudrate settings for this board.
3799
3800 - CONFIG_SYS_CONSOLE_INFO_QUIET
3801                 Suppress display of console information at boot.
3802
3803 - CONFIG_SYS_CONSOLE_IS_IN_ENV
3804                 If the board specific function
3805                         extern int overwrite_console (void);
3806                 returns 1, the stdin, stderr and stdout are switched to the
3807                 serial port, else the settings in the environment are used.
3808
3809 - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3810                 Enable the call to overwrite_console().
3811
3812 - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3813                 Enable overwrite of previous console environment settings.
3814
3815 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3816                 Begin and End addresses of the area used by the
3817                 simple memory test.
3818
3819 - CONFIG_SYS_ALT_MEMTEST:
3820                 Enable an alternate, more extensive memory test.
3821
3822 - CONFIG_SYS_MEMTEST_SCRATCH:
3823                 Scratch address used by the alternate memory test
3824                 You only need to set this if address zero isn't writeable
3825
3826 - CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3827                 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3828                 this specified memory area will get subtracted from the top
3829                 (end) of RAM and won't get "touched" at all by U-Boot. By
3830                 fixing up gd->ram_size the Linux kernel should gets passed
3831                 the now "corrected" memory size and won't touch it either.
3832                 This should work for arch/ppc and arch/powerpc. Only Linux
3833                 board ports in arch/powerpc with bootwrapper support that
3834                 recalculate the memory size from the SDRAM controller setup
3835                 will have to get fixed in Linux additionally.
3836
3837                 This option can be used as a workaround for the 440EPx/GRx
3838                 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3839                 be touched.
3840
3841                 WARNING: Please make sure that this value is a multiple of
3842                 the Linux page size (normally 4k). If this is not the case,
3843                 then the end address of the Linux memory will be located at a
3844                 non page size aligned address and this could cause major
3845                 problems.
3846
3847 - CONFIG_SYS_LOADS_BAUD_CHANGE:
3848                 Enable temporary baudrate change while serial download
3849
3850 - CONFIG_SYS_SDRAM_BASE:
3851                 Physical start address of SDRAM. _Must_ be 0 here.
3852
3853 - CONFIG_SYS_MBIO_BASE:
3854                 Physical start address of Motherboard I/O (if using a
3855                 Cogent motherboard)
3856
3857 - CONFIG_SYS_FLASH_BASE:
3858                 Physical start address of Flash memory.
3859
3860 - CONFIG_SYS_MONITOR_BASE:
3861                 Physical start address of boot monitor code (set by
3862                 make config files to be same as the text base address
3863                 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
3864                 CONFIG_SYS_FLASH_BASE when booting from flash.
3865
3866 - CONFIG_SYS_MONITOR_LEN:
3867                 Size of memory reserved for monitor code, used to
3868                 determine _at_compile_time_ (!) if the environment is
3869                 embedded within the U-Boot image, or in a separate
3870                 flash sector.
3871
3872 - CONFIG_SYS_MALLOC_LEN:
3873                 Size of DRAM reserved for malloc() use.
3874
3875 - CONFIG_SYS_MALLOC_F_LEN
3876                 Size of the malloc() pool for use before relocation. If
3877                 this is defined, then a very simple malloc() implementation
3878                 will become available before relocation. The address is just
3879                 below the global data, and the stack is moved down to make
3880                 space.
3881
3882                 This feature allocates regions with increasing addresses
3883                 within the region. calloc() is supported, but realloc()
3884                 is not available. free() is supported but does nothing.
3885                 The memory will be freed (or in fact just forgotton) when
3886                 U-Boot relocates itself.
3887
3888                 Pre-relocation malloc() is only supported on ARM and sandbox
3889                 at present but is fairly easy to enable for other archs.
3890
3891 - CONFIG_SYS_BOOTM_LEN:
3892                 Normally compressed uImages are limited to an
3893                 uncompressed size of 8 MBytes. If this is not enough,
3894                 you can define CONFIG_SYS_BOOTM_LEN in your board config file
3895                 to adjust this setting to your needs.
3896
3897 - CONFIG_SYS_BOOTMAPSZ:
3898                 Maximum size of memory mapped by the startup code of
3899                 the Linux kernel; all data that must be processed by
3900                 the Linux kernel (bd_info, boot arguments, FDT blob if
3901                 used) must be put below this limit, unless "bootm_low"
3902                 environment variable is defined and non-zero. In such case
3903                 all data for the Linux kernel must be between "bootm_low"
3904                 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
3905                 variable "bootm_mapsize" will override the value of
3906                 CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3907                 then the value in "bootm_size" will be used instead.
3908
3909 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
3910                 Enable initrd_high functionality.  If defined then the
3911                 initrd_high feature is enabled and the bootm ramdisk subcommand
3912                 is enabled.
3913
3914 - CONFIG_SYS_BOOT_GET_CMDLINE:
3915                 Enables allocating and saving kernel cmdline in space between
3916                 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3917
3918 - CONFIG_SYS_BOOT_GET_KBD:
3919                 Enables allocating and saving a kernel copy of the bd_info in
3920                 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3921
3922 - CONFIG_SYS_MAX_FLASH_BANKS:
3923                 Max number of Flash memory banks
3924
3925 - CONFIG_SYS_MAX_FLASH_SECT:
3926                 Max number of sectors on a Flash chip
3927
3928 - CONFIG_SYS_FLASH_ERASE_TOUT:
3929                 Timeout for Flash erase operations (in ms)
3930
3931 - CONFIG_SYS_FLASH_WRITE_TOUT:
3932                 Timeout for Flash write operations (in ms)
3933
3934 - CONFIG_SYS_FLASH_LOCK_TOUT
3935                 Timeout for Flash set sector lock bit operation (in ms)
3936
3937 - CONFIG_SYS_FLASH_UNLOCK_TOUT
3938                 Timeout for Flash clear lock bits operation (in ms)
3939
3940 - CONFIG_SYS_FLASH_PROTECTION
3941                 If defined, hardware flash sectors protection is used
3942                 instead of U-Boot software protection.
3943
3944 - CONFIG_SYS_DIRECT_FLASH_TFTP:
3945
3946                 Enable TFTP transfers directly to flash memory;
3947                 without this option such a download has to be
3948                 performed in two steps: (1) download to RAM, and (2)
3949                 copy from RAM to flash.
3950
3951                 The two-step approach is usually more reliable, since
3952                 you can check if the download worked before you erase
3953                 the flash, but in some situations (when system RAM is
3954                 too limited to allow for a temporary copy of the
3955                 downloaded image) this option may be very useful.
3956
3957 - CONFIG_SYS_FLASH_CFI:
3958                 Define if the flash driver uses extra elements in the
3959                 common flash structure for storing flash geometry.
3960
3961 - CONFIG_FLASH_CFI_DRIVER
3962                 This option also enables the building of the cfi_flash driver
3963                 in the drivers directory
3964
3965 - CONFIG_FLASH_CFI_MTD
3966                 This option enables the building of the cfi_mtd driver
3967                 in the drivers directory. The driver exports CFI flash
3968                 to the MTD layer.
3969
3970 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3971                 Use buffered writes to flash.
3972
3973 - CONFIG_FLASH_SPANSION_S29WS_N
3974                 s29ws-n MirrorBit flash has non-standard addresses for buffered
3975                 write commands.
3976
3977 - CONFIG_SYS_FLASH_QUIET_TEST
3978                 If this option is defined, the common CFI flash doesn't
3979                 print it's warning upon not recognized FLASH banks. This
3980                 is useful, if some of the configured banks are only
3981                 optionally available.
3982
3983 - CONFIG_FLASH_SHOW_PROGRESS
3984                 If defined (must be an integer), print out countdown
3985                 digits and dots.  Recommended value: 45 (9..1) for 80
3986                 column displays, 15 (3..1) for 40 column displays.
3987
3988 - CONFIG_FLASH_VERIFY
3989                 If defined, the content of the flash (destination) is compared
3990                 against the source after the write operation. An error message
3991                 will be printed when the contents are not identical.
3992                 Please note that this option is useless in nearly all cases,
3993                 since such flash programming errors usually are detected earlier
3994                 while unprotecting/erasing/programming. Please only enable
3995                 this option if you really know what you are doing.
3996
3997 - CONFIG_SYS_RX_ETH_BUFFER:
3998                 Defines the number of Ethernet receive buffers. On some
3999                 Ethernet controllers it is recommended to set this value
4000                 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4001                 buffers can be full shortly after enabling the interface
4002                 on high Ethernet traffic.
4003                 Defaults to 4 if not defined.
4004
4005 - CONFIG_ENV_MAX_ENTRIES
4006
4007         Maximum number of entries in the hash table that is used
4008         internally to store the environment settings. The default
4009         setting is supposed to be generous and should work in most
4010         cases. This setting can be used to tune behaviour; see
4011         lib/hashtable.c for details.
4012
4013 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4014 - CONFIG_ENV_FLAGS_LIST_STATIC
4015         Enable validation of the values given to environment variables when
4016         calling env set.  Variables can be restricted to only decimal,
4017         hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
4018         the variables can also be restricted to IP address or MAC address.
4019
4020         The format of the list is:
4021                 type_attribute = [s|d|x|b|i|m]
4022                 access_atribute = [a|r|o|c]
4023                 attributes = type_attribute[access_atribute]
4024                 entry = variable_name[:attributes]
4025                 list = entry[,list]
4026
4027         The type attributes are:
4028                 s - String (default)
4029                 d - Decimal
4030                 x - Hexadecimal
4031                 b - Boolean ([1yYtT|0nNfF])
4032                 i - IP address
4033                 m - MAC address
4034
4035         The access attributes are:
4036                 a - Any (default)
4037                 r - Read-only
4038                 o - Write-once
4039                 c - Change-default
4040
4041         - CONFIG_ENV_FLAGS_LIST_DEFAULT
4042                 Define this to a list (string) to define the ".flags"
4043                 envirnoment variable in the default or embedded environment.
4044
4045         - CONFIG_ENV_FLAGS_LIST_STATIC
4046                 Define this to a list (string) to define validation that
4047                 should be done if an entry is not found in the ".flags"
4048                 environment variable.  To override a setting in the static
4049                 list, simply add an entry for the same variable name to the
4050                 ".flags" variable.
4051
4052 - CONFIG_ENV_ACCESS_IGNORE_FORCE
4053         If defined, don't allow the -f switch to env set override variable
4054         access flags.
4055
4056 - CONFIG_SYS_GENERIC_BOARD
4057         This selects the architecture-generic board system instead of the
4058         architecture-specific board files. It is intended to move boards
4059         to this new framework over time. Defining this will disable the
4060         arch/foo/lib/board.c file and use common/board_f.c and
4061         common/board_r.c instead. To use this option your architecture
4062         must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4063         its config.mk file). If you find problems enabling this option on
4064         your board please report the problem and send patches!
4065
4066 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4067         This is set by OMAP boards for the max time that reset should
4068         be asserted. See doc/README.omap-reset-time for details on how
4069         the value can be calulated on a given board.
4070
4071 - CONFIG_USE_STDINT
4072         If stdint.h is available with your toolchain you can define this
4073         option to enable it. You can provide option 'USE_STDINT=1' when
4074         building U-Boot to enable this.
4075
4076 The following definitions that deal with the placement and management
4077 of environment data (variable area); in general, we support the
4078 following configurations:
4079
4080 - CONFIG_BUILD_ENVCRC:
4081
4082         Builds up envcrc with the target environment so that external utils
4083         may easily extract it and embed it in final U-Boot images.
4084
4085 - CONFIG_ENV_IS_IN_FLASH:
4086
4087         Define this if the environment is in flash memory.
4088
4089         a) The environment occupies one whole flash sector, which is
4090            "embedded" in the text segment with the U-Boot code. This
4091            happens usually with "bottom boot sector" or "top boot
4092            sector" type flash chips, which have several smaller
4093            sectors at the start or the end. For instance, such a
4094            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4095            such a case you would place the environment in one of the
4096            4 kB sectors - with U-Boot code before and after it. With
4097            "top boot sector" type flash chips, you would put the
4098            environment in one of the last sectors, leaving a gap
4099            between U-Boot and the environment.
4100
4101         - CONFIG_ENV_OFFSET:
4102
4103            Offset of environment data (variable area) to the
4104            beginning of flash memory; for instance, with bottom boot
4105            type flash chips the second sector can be used: the offset
4106            for this sector is given here.
4107
4108            CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4109
4110         - CONFIG_ENV_ADDR:
4111
4112            This is just another way to specify the start address of
4113            the flash sector containing the environment (instead of
4114            CONFIG_ENV_OFFSET).
4115
4116         - CONFIG_ENV_SECT_SIZE:
4117
4118            Size of the sector containing the environment.
4119
4120
4121         b) Sometimes flash chips have few, equal sized, BIG sectors.
4122            In such a case you don't want to spend a whole sector for
4123            the environment.
4124
4125         - CONFIG_ENV_SIZE:
4126
4127            If you use this in combination with CONFIG_ENV_IS_IN_FLASH
4128            and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4129            of this flash sector for the environment. This saves
4130            memory for the RAM copy of the environment.
4131
4132            It may also save flash memory if you decide to use this
4133            when your environment is "embedded" within U-Boot code,
4134            since then the remainder of the flash sector could be used
4135            for U-Boot code. It should be pointed out that this is
4136            STRONGLY DISCOURAGED from a robustness point of view:
4137            updating the environment in flash makes it always
4138            necessary to erase the WHOLE sector. If something goes
4139            wrong before the contents has been restored from a copy in
4140            RAM, your target system will be dead.
4141
4142         - CONFIG_ENV_ADDR_REDUND
4143           CONFIG_ENV_SIZE_REDUND
4144
4145            These settings describe a second storage area used to hold
4146            a redundant copy of the environment data, so that there is
4147            a valid backup copy in case there is a power failure during
4148            a "saveenv" operation.
4149
4150 BE CAREFUL! Any changes to the flash layout, and some changes to the
4151 source code will make it necessary to adapt <board>/u-boot.lds*
4152 accordingly!
4153
4154
4155 - CONFIG_ENV_IS_IN_NVRAM:
4156
4157         Define this if you have some non-volatile memory device
4158         (NVRAM, battery buffered SRAM) which you want to use for the
4159         environment.
4160
4161         - CONFIG_ENV_ADDR:
4162         - CONFIG_ENV_SIZE:
4163
4164           These two #defines are used to determine the memory area you
4165           want to use for environment. It is assumed that this memory
4166           can just be read and written to, without any special
4167           provision.
4168
4169 BE CAREFUL! The first access to the environment happens quite early
4170 in U-Boot initalization (when we try to get the setting of for the
4171 console baudrate). You *MUST* have mapped your NVRAM area then, or
4172 U-Boot will hang.
4173
4174 Please note that even with NVRAM we still use a copy of the
4175 environment in RAM: we could work on NVRAM directly, but we want to
4176 keep settings there always unmodified except somebody uses "saveenv"
4177 to save the current settings.
4178
4179
4180 - CONFIG_ENV_IS_IN_EEPROM:
4181
4182         Use this if you have an EEPROM or similar serial access
4183         device and a driver for it.
4184
4185         - CONFIG_ENV_OFFSET:
4186         - CONFIG_ENV_SIZE:
4187
4188           These two #defines specify the offset and size of the
4189           environment area within the total memory of your EEPROM.
4190
4191         - CONFIG_SYS_I2C_EEPROM_ADDR:
4192           If defined, specified the chip address of the EEPROM device.
4193           The default address is zero.
4194
4195         - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4196           If defined, the number of bits used to address bytes in a
4197           single page in the EEPROM device.  A 64 byte page, for example
4198           would require six bits.
4199
4200         - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4201           If defined, the number of milliseconds to delay between
4202           page writes.  The default is zero milliseconds.
4203
4204         - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4205           The length in bytes of the EEPROM memory array address.  Note
4206           that this is NOT the chip address length!
4207
4208         - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
4209           EEPROM chips that implement "address overflow" are ones
4210           like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4211           address and the extra bits end up in the "chip address" bit
4212           slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4213           byte chips.
4214
4215           Note that we consider the length of the address field to
4216           still be one byte because the extra address bits are hidden
4217           in the chip address.
4218
4219         - CONFIG_SYS_EEPROM_SIZE:
4220           The size in bytes of the EEPROM device.
4221
4222         - CONFIG_ENV_EEPROM_IS_ON_I2C
4223           define this, if you have I2C and SPI activated, and your
4224           EEPROM, which holds the environment, is on the I2C bus.
4225
4226         - CONFIG_I2C_ENV_EEPROM_BUS
4227           if you have an Environment on an EEPROM reached over
4228           I2C muxes, you can define here, how to reach this
4229           EEPROM. For example:
4230
4231           #define CONFIG_I2C_ENV_EEPROM_BUS       1
4232
4233           EEPROM which holds the environment, is reached over
4234           a pca9547 i2c mux with address 0x70, channel 3.
4235
4236 - CONFIG_ENV_IS_IN_DATAFLASH:
4237
4238         Define this if you have a DataFlash memory device which you
4239         want to use for the environment.
4240
4241         - CONFIG_ENV_OFFSET:
4242         - CONFIG_ENV_ADDR:
4243         - CONFIG_ENV_SIZE:
4244
4245           These three #defines specify the offset and size of the
4246           environment area within the total memory of your DataFlash placed
4247           at the specified address.
4248
4249 - CONFIG_ENV_IS_IN_SPI_FLASH:
4250
4251         Define this if you have a SPI Flash memory device which you
4252         want to use for the environment.
4253
4254         - CONFIG_ENV_OFFSET:
4255         - CONFIG_ENV_SIZE:
4256
4257           These two #defines specify the offset and size of the
4258           environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4259           aligned to an erase sector boundary.
4260
4261         - CONFIG_ENV_SECT_SIZE:
4262
4263           Define the SPI flash's sector size.
4264
4265         - CONFIG_ENV_OFFSET_REDUND (optional):
4266
4267           This setting describes a second storage area of CONFIG_ENV_SIZE
4268           size used to hold a redundant copy of the environment data, so
4269           that there is a valid backup copy in case there is a power failure
4270           during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4271           aligned to an erase sector boundary.
4272
4273         - CONFIG_ENV_SPI_BUS (optional):
4274         - CONFIG_ENV_SPI_CS (optional):
4275
4276           Define the SPI bus and chip select. If not defined they will be 0.
4277
4278         - CONFIG_ENV_SPI_MAX_HZ (optional):
4279
4280           Define the SPI max work clock. If not defined then use 1MHz.
4281
4282         - CONFIG_ENV_SPI_MODE (optional):
4283
4284           Define the SPI work mode. If not defined then use SPI_MODE_3.
4285
4286 - CONFIG_ENV_IS_IN_REMOTE:
4287
4288         Define this if you have a remote memory space which you
4289         want to use for the local device's environment.
4290
4291         - CONFIG_ENV_ADDR:
4292         - CONFIG_ENV_SIZE:
4293
4294           These two #defines specify the address and size of the
4295           environment area within the remote memory space. The
4296           local device can get the environment from remote memory
4297           space by SRIO or PCIE links.
4298
4299 BE CAREFUL! For some special cases, the local device can not use
4300 "saveenv" command. For example, the local device will get the
4301 environment stored in a remote NOR flash by SRIO or PCIE link,
4302 but it can not erase, write this NOR flash by SRIO or PCIE interface.
4303
4304 - CONFIG_ENV_IS_IN_NAND:
4305
4306         Define this if you have a NAND device which you want to use
4307         for the environment.
4308
4309         - CONFIG_ENV_OFFSET:
4310         - CONFIG_ENV_SIZE:
4311
4312           These two #defines specify the offset and size of the environment
4313           area within the first NAND device.  CONFIG_ENV_OFFSET must be
4314           aligned to an erase block boundary.
4315
4316         - CONFIG_ENV_OFFSET_REDUND (optional):
4317
4318           This setting describes a second storage area of CONFIG_ENV_SIZE
4319           size used to hold a redundant copy of the environment data, so
4320           that there is a valid backup copy in case there is a power failure
4321           during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
4322           aligned to an erase block boundary.
4323
4324         - CONFIG_ENV_RANGE (optional):
4325
4326           Specifies the length of the region in which the environment
4327           can be written.  This should be a multiple of the NAND device's
4328           block size.  Specifying a range with more erase blocks than
4329           are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4330           the range to be avoided.
4331
4332         - CONFIG_ENV_OFFSET_OOB (optional):
4333
4334           Enables support for dynamically retrieving the offset of the
4335           environment from block zero's out-of-band data.  The
4336           "nand env.oob" command can be used to record this offset.
4337           Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4338           using CONFIG_ENV_OFFSET_OOB.
4339
4340 - CONFIG_NAND_ENV_DST
4341
4342         Defines address in RAM to which the nand_spl code should copy the
4343         environment. If redundant environment is used, it will be copied to
4344         CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4345
4346 - CONFIG_ENV_IS_IN_UBI:
4347
4348         Define this if you have an UBI volume that you want to use for the
4349         environment.  This has the benefit of wear-leveling the environment
4350         accesses, which is important on NAND.
4351
4352         - CONFIG_ENV_UBI_PART:
4353
4354           Define this to a string that is the mtd partition containing the UBI.
4355
4356         - CONFIG_ENV_UBI_VOLUME:
4357
4358           Define this to the name of the volume that you want to store the
4359           environment in.
4360
4361         - CONFIG_ENV_UBI_VOLUME_REDUND:
4362
4363           Define this to the name of another volume to store a second copy of
4364           the environment in.  This will enable redundant environments in UBI.
4365           It is assumed that both volumes are in the same MTD partition.
4366
4367         - CONFIG_UBI_SILENCE_MSG
4368         - CONFIG_UBIFS_SILENCE_MSG
4369
4370           You will probably want to define these to avoid a really noisy system
4371           when storing the env in UBI.
4372
4373 - CONFIG_ENV_IS_IN_FAT:
4374        Define this if you want to use the FAT file system for the environment.
4375
4376        - FAT_ENV_INTERFACE:
4377
4378          Define this to a string that is the name of the block device.
4379
4380        - FAT_ENV_DEV_AND_PART:
4381
4382          Define this to a string to specify the partition of the device. It can
4383          be as following:
4384
4385            "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4386                - "D:P": device D partition P. Error occurs if device D has no
4387                         partition table.
4388                - "D:0": device D.
4389                - "D" or "D:": device D partition 1 if device D has partition
4390                               table, or the whole device D if has no partition
4391                               table.
4392                - "D:auto": first partition in device D with bootable flag set.
4393                            If none, first valid paratition in device D. If no
4394                            partition table then means device D.
4395
4396        - FAT_ENV_FILE:
4397
4398          It's a string of the FAT file name. This file use to store the
4399          envrionment.
4400
4401        - CONFIG_FAT_WRITE:
4402          This should be defined. Otherwise it cannot save the envrionment file.
4403
4404 - CONFIG_ENV_IS_IN_MMC:
4405
4406         Define this if you have an MMC device which you want to use for the
4407         environment.
4408
4409         - CONFIG_SYS_MMC_ENV_DEV:
4410
4411           Specifies which MMC device the environment is stored in.
4412
4413         - CONFIG_SYS_MMC_ENV_PART (optional):
4414
4415           Specifies which MMC partition the environment is stored in. If not
4416           set, defaults to partition 0, the user area. Common values might be
4417           1 (first MMC boot partition), 2 (second MMC boot partition).
4418
4419         - CONFIG_ENV_OFFSET:
4420         - CONFIG_ENV_SIZE:
4421
4422           These two #defines specify the offset and size of the environment
4423           area within the specified MMC device.
4424
4425           If offset is positive (the usual case), it is treated as relative to
4426           the start of the MMC partition. If offset is negative, it is treated
4427           as relative to the end of the MMC partition. This can be useful if
4428           your board may be fitted with different MMC devices, which have
4429           different sizes for the MMC partitions, and you always want the
4430           environment placed at the very end of the partition, to leave the
4431           maximum possible space before it, to store other data.
4432
4433           These two values are in units of bytes, but must be aligned to an
4434           MMC sector boundary.
4435
4436         - CONFIG_ENV_OFFSET_REDUND (optional):
4437
4438           Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4439           hold a redundant copy of the environment data. This provides a
4440           valid backup copy in case the other copy is corrupted, e.g. due
4441           to a power failure during a "saveenv" operation.
4442
4443           This value may also be positive or negative; this is handled in the
4444           same way as CONFIG_ENV_OFFSET.
4445
4446           This value is also in units of bytes, but must also be aligned to
4447           an MMC sector boundary.
4448
4449         - CONFIG_ENV_SIZE_REDUND (optional):
4450
4451           This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4452           set. If this value is set, it must be set to the same value as
4453           CONFIG_ENV_SIZE.
4454
4455 - CONFIG_SYS_SPI_INIT_OFFSET
4456
4457         Defines offset to the initial SPI buffer area in DPRAM. The
4458         area is used at an early stage (ROM part) if the environment
4459         is configured to reside in the SPI EEPROM: We need a 520 byte
4460         scratch DPRAM area. It is used between the two initialization
4461         calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4462         to be a good choice since it makes it far enough from the
4463         start of the data area as well as from the stack pointer.
4464
4465 Please note that the environment is read-only until the monitor
4466 has been relocated to RAM and a RAM copy of the environment has been
4467 created; also, when using EEPROM you will have to use getenv_f()
4468 until then to read environment variables.
4469
4470 The environment is protected by a CRC32 checksum. Before the monitor
4471 is relocated into RAM, as a result of a bad CRC you will be working
4472 with the compiled-in default environment - *silently*!!! [This is
4473 necessary, because the first environment variable we need is the
4474 "baudrate" setting for the console - if we have a bad CRC, we don't
4475 have any device yet where we could complain.]
4476
4477 Note: once the monitor has been relocated, then it will complain if
4478 the default environment is used; a new CRC is computed as soon as you
4479 use the "saveenv" command to store a valid environment.
4480
4481 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4482                 Echo the inverted Ethernet link state to the fault LED.
4483
4484                 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4485                       also needs to be defined.
4486
4487 - CONFIG_SYS_FAULT_MII_ADDR:
4488                 MII address of the PHY to check for the Ethernet link state.
4489
4490 - CONFIG_NS16550_MIN_FUNCTIONS:
4491                 Define this if you desire to only have use of the NS16550_init
4492                 and NS16550_putc functions for the serial driver located at
4493                 drivers/serial/ns16550.c.  This option is useful for saving
4494                 space for already greatly restricted images, including but not
4495                 limited to NAND_SPL configurations.
4496
4497 - CONFIG_DISPLAY_BOARDINFO
4498                 Display information about the board that U-Boot is running on
4499                 when U-Boot starts up. The board function checkboard() is called
4500                 to do this.
4501
4502 - CONFIG_DISPLAY_BOARDINFO_LATE
4503                 Similar to the previous option, but display this information
4504                 later, once stdio is running and output goes to the LCD, if
4505                 present.
4506
4507 - CONFIG_BOARD_SIZE_LIMIT:
4508                 Maximum size of the U-Boot image. When defined, the
4509                 build system checks that the actual size does not
4510                 exceed it.
4511
4512 Low Level (hardware related) configuration options:
4513 ---------------------------------------------------
4514
4515 - CONFIG_SYS_CACHELINE_SIZE:
4516                 Cache Line Size of the CPU.
4517
4518 - CONFIG_SYS_DEFAULT_IMMR:
4519                 Default address of the IMMR after system reset.
4520
4521                 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4522                 and RPXsuper) to be able to adjust the position of
4523                 the IMMR register after a reset.
4524
4525 - CONFIG_SYS_CCSRBAR_DEFAULT:
4526                 Default (power-on reset) physical address of CCSR on Freescale
4527                 PowerPC SOCs.
4528
4529 - CONFIG_SYS_CCSRBAR:
4530                 Virtual address of CCSR.  On a 32-bit build, this is typically
4531                 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4532
4533                 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4534                 for cross-platform code that uses that macro instead.
4535
4536 - CONFIG_SYS_CCSRBAR_PHYS:
4537                 Physical address of CCSR.  CCSR can be relocated to a new
4538                 physical address, if desired.  In this case, this macro should
4539                 be set to that address.  Otherwise, it should be set to the
4540                 same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4541                 is typically relocated on 36-bit builds.  It is recommended
4542                 that this macro be defined via the _HIGH and _LOW macros:
4543
4544                 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4545                         * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4546
4547 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4548                 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
4549                 either 0 (32-bit build) or 0xF (36-bit build).  This macro is
4550                 used in assembly code, so it must not contain typecasts or
4551                 integer size suffixes (e.g. "ULL").
4552
4553 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
4554                 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4555                 used in assembly code, so it must not contain typecasts or
4556                 integer size suffixes (e.g. "ULL").
4557
4558 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4559                 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4560                 forced to a value that ensures that CCSR is not relocated.
4561
4562 - Floppy Disk Support:
4563                 CONFIG_SYS_FDC_DRIVE_NUMBER
4564
4565                 the default drive number (default value 0)
4566
4567                 CONFIG_SYS_ISA_IO_STRIDE
4568
4569                 defines the spacing between FDC chipset registers
4570                 (default value 1)
4571
4572                 CONFIG_SYS_ISA_IO_OFFSET
4573
4574                 defines the offset of register from address. It
4575                 depends on which part of the data bus is connected to
4576                 the FDC chipset. (default value 0)
4577
4578                 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4579                 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
4580                 default value.
4581
4582                 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
4583                 fdc_hw_init() is called at the beginning of the FDC
4584                 setup. fdc_hw_init() must be provided by the board
4585                 source code. It is used to make hardware dependant
4586                 initializations.
4587
4588 - CONFIG_IDE_AHB:
4589                 Most IDE controllers were designed to be connected with PCI
4590                 interface. Only few of them were designed for AHB interface.
4591                 When software is doing ATA command and data transfer to
4592                 IDE devices through IDE-AHB controller, some additional
4593                 registers accessing to these kind of IDE-AHB controller
4594                 is requierd.
4595
4596 - CONFIG_SYS_IMMR:      Physical address of the Internal Memory.
4597                 DO NOT CHANGE unless you know exactly what you're
4598                 doing! (11-4) [MPC8xx/82xx systems only]
4599
4600 - CONFIG_SYS_INIT_RAM_ADDR:
4601
4602                 Start address of memory area that can be used for
4603                 initial data and stack; please note that this must be
4604                 writable memory that is working WITHOUT special
4605                 initialization, i. e. you CANNOT use normal RAM which
4606                 will become available only after programming the
4607                 memory controller and running certain initialization
4608                 sequences.
4609
4610                 U-Boot uses the following memory types:
4611                 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4612                 - MPC824X: data cache
4613                 - PPC4xx:  data cache
4614
4615 - CONFIG_SYS_GBL_DATA_OFFSET:
4616
4617                 Offset of the initial data structure in the memory
4618                 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4619                 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4620                 data is located at the end of the available space
4621                 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4622                 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4623                 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4624                 CONFIG_SYS_GBL_DATA_OFFSET) downward.
4625
4626         Note:
4627                 On the MPC824X (or other systems that use the data
4628                 cache for initial memory) the address chosen for
4629                 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4630                 point to an otherwise UNUSED address space between
4631                 the top of RAM and the start of the PCI space.
4632
4633 - CONFIG_SYS_SIUMCR:    SIU Module Configuration (11-6)
4634
4635 - CONFIG_SYS_SYPCR:     System Protection Control (11-9)
4636
4637 - CONFIG_SYS_TBSCR:     Time Base Status and Control (11-26)
4638
4639 - CONFIG_SYS_PISCR:     Periodic Interrupt Status and Control (11-31)
4640
4641 - CONFIG_SYS_PLPRCR:    PLL, Low-Power, and Reset Control Register (15-30)
4642
4643 - CONFIG_SYS_SCCR:      System Clock and reset Control Register (15-27)
4644
4645 - CONFIG_SYS_OR_TIMING_SDRAM:
4646                 SDRAM timing
4647
4648 - CONFIG_SYS_MAMR_PTA:
4649                 periodic timer for refresh
4650
4651 - CONFIG_SYS_DER:       Debug Event Register (37-47)
4652
4653 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4654   CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4655   CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4656   CONFIG_SYS_BR1_PRELIM:
4657                 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4658
4659 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4660   CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4661   CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4662                 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4663
4664 - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4665   CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4666                 Machine Mode Register and Memory Periodic Timer
4667                 Prescaler definitions (SDRAM timing)
4668
4669 - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4670                 enable I2C microcode relocation patch (MPC8xx);
4671                 define relocation offset in DPRAM [DSP2]
4672
4673 - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4674                 enable SMC microcode relocation patch (MPC8xx);
4675                 define relocation offset in DPRAM [SMC1]
4676
4677 - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4678                 enable SPI microcode relocation patch (MPC8xx);
4679                 define relocation offset in DPRAM [SCC4]
4680
4681 - CONFIG_SYS_USE_OSCCLK:
4682                 Use OSCM clock mode on MBX8xx board. Be careful,
4683                 wrong setting might damage your board. Read
4684                 doc/README.MBX before setting this variable!
4685
4686 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4687                 Offset of the bootmode word in DPRAM used by post
4688                 (Power On Self Tests). This definition overrides
4689                 #define'd default value in commproc.h resp.
4690                 cpm_8260.h.
4691
4692 - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4693   CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4694   CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4695   CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4696   CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4697   CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4698   CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4699   CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4700                 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
4701
4702 - CONFIG_PCI_DISABLE_PCIE:
4703                 Disable PCI-Express on systems where it is supported but not
4704                 required.
4705
4706 - CONFIG_PCI_ENUM_ONLY
4707                 Only scan through and get the devices on the busses.
4708                 Don't do any setup work, presumably because someone or
4709                 something has already done it, and we don't need to do it
4710                 a second time.  Useful for platforms that are pre-booted
4711                 by coreboot or similar.
4712
4713 - CONFIG_PCI_INDIRECT_BRIDGE:
4714                 Enable support for indirect PCI bridges.
4715
4716 - CONFIG_SYS_SRIO:
4717                 Chip has SRIO or not
4718
4719 - CONFIG_SRIO1:
4720                 Board has SRIO 1 port available
4721
4722 - CONFIG_SRIO2:
4723                 Board has SRIO 2 port available
4724
4725 - CONFIG_SRIO_PCIE_BOOT_MASTER
4726                 Board can support master function for Boot from SRIO and PCIE
4727
4728 - CONFIG_SYS_SRIOn_MEM_VIRT:
4729                 Virtual Address of SRIO port 'n' memory region
4730
4731 - CONFIG_SYS_SRIOn_MEM_PHYS:
4732                 Physical Address of SRIO port 'n' memory region
4733
4734 - CONFIG_SYS_SRIOn_MEM_SIZE:
4735                 Size of SRIO port 'n' memory region
4736
4737 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
4738                 Defined to tell the NAND controller that the NAND chip is using
4739                 a 16 bit bus.
4740                 Not all NAND drivers use this symbol.
4741                 Example of drivers that use it:
4742                 - drivers/mtd/nand/ndfc.c
4743                 - drivers/mtd/nand/mxc_nand.c
4744
4745 - CONFIG_SYS_NDFC_EBC0_CFG
4746                 Sets the EBC0_CFG register for the NDFC. If not defined
4747                 a default value will be used.
4748
4749 - CONFIG_SPD_EEPROM
4750                 Get DDR timing information from an I2C EEPROM. Common
4751                 with pluggable memory modules such as SODIMMs
4752
4753   SPD_EEPROM_ADDRESS
4754                 I2C address of the SPD EEPROM
4755
4756 - CONFIG_SYS_SPD_BUS_NUM
4757                 If SPD EEPROM is on an I2C bus other than the first
4758                 one, specify here. Note that the value must resolve
4759                 to something your driver can deal with.
4760
4761 - CONFIG_SYS_DDR_RAW_TIMING
4762                 Get DDR timing information from other than SPD. Common with
4763                 soldered DDR chips onboard without SPD. DDR raw timing
4764                 parameters are extracted from datasheet and hard-coded into
4765                 header files or board specific files.
4766
4767 - CONFIG_FSL_DDR_INTERACTIVE
4768                 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4769
4770 - CONFIG_SYS_83XX_DDR_USES_CS0
4771                 Only for 83xx systems. If specified, then DDR should
4772                 be configured using CS0 and CS1 instead of CS2 and CS3.
4773
4774 - CONFIG_ETHER_ON_FEC[12]
4775                 Define to enable FEC[12] on a 8xx series processor.
4776
4777 - CONFIG_FEC[12]_PHY
4778                 Define to the hardcoded PHY address which corresponds
4779                 to the given FEC; i. e.
4780                         #define CONFIG_FEC1_PHY 4
4781                 means that the PHY with address 4 is connected to FEC1
4782
4783                 When set to -1, means to probe for first available.
4784
4785 - CONFIG_FEC[12]_PHY_NORXERR
4786                 The PHY does not have a RXERR line (RMII only).
4787                 (so program the FEC to ignore it).
4788
4789 - CONFIG_RMII
4790                 Enable RMII mode for all FECs.
4791                 Note that this is a global option, we can't
4792                 have one FEC in standard MII mode and another in RMII mode.
4793
4794 - CONFIG_CRC32_VERIFY
4795                 Add a verify option to the crc32 command.
4796                 The syntax is:
4797
4798                 => crc32 -v <address> <count> <crc32>
4799
4800                 Where address/count indicate a memory area
4801                 and crc32 is the correct crc32 which the
4802                 area should have.
4803
4804 - CONFIG_LOOPW
4805                 Add the "loopw" memory command. This only takes effect if
4806                 the memory commands are activated globally (CONFIG_CMD_MEM).
4807
4808 - CONFIG_MX_CYCLIC
4809                 Add the "mdc" and "mwc" memory commands. These are cyclic
4810                 "md/mw" commands.
4811                 Examples:
4812
4813                 => mdc.b 10 4 500
4814                 This command will print 4 bytes (10,11,12,13) each 500 ms.
4815
4816                 => mwc.l 100 12345678 10
4817                 This command will write 12345678 to address 100 all 10 ms.
4818
4819                 This only takes effect if the memory commands are activated
4820                 globally (CONFIG_CMD_MEM).
4821
4822 - CONFIG_SKIP_LOWLEVEL_INIT
4823                 [ARM, NDS32, MIPS only] If this variable is defined, then certain
4824                 low level initializations (like setting up the memory
4825                 controller) are omitted and/or U-Boot does not
4826                 relocate itself into RAM.
4827
4828                 Normally this variable MUST NOT be defined. The only
4829                 exception is when U-Boot is loaded (to RAM) by some
4830                 other boot loader or by a debugger which performs
4831                 these initializations itself.
4832
4833 - CONFIG_SPL_BUILD
4834                 Modifies the behaviour of start.S when compiling a loader
4835                 that is executed before the actual U-Boot. E.g. when
4836                 compiling a NAND SPL.
4837
4838 - CONFIG_TPL_BUILD
4839                 Modifies the behaviour of start.S  when compiling a loader
4840                 that is executed after the SPL and before the actual U-Boot.
4841                 It is loaded by the SPL.
4842
4843 - CONFIG_SYS_MPC85XX_NO_RESETVEC
4844                 Only for 85xx systems. If this variable is specified, the section
4845                 .resetvec is not kept and the section .bootpg is placed in the
4846                 previous 4k of the .text section.
4847
4848 - CONFIG_ARCH_MAP_SYSMEM
4849                 Generally U-Boot (and in particular the md command) uses
4850                 effective address. It is therefore not necessary to regard
4851                 U-Boot address as virtual addresses that need to be translated
4852                 to physical addresses. However, sandbox requires this, since
4853                 it maintains its own little RAM buffer which contains all
4854                 addressable memory. This option causes some memory accesses
4855                 to be mapped through map_sysmem() / unmap_sysmem().
4856
4857 - CONFIG_USE_ARCH_MEMCPY
4858   CONFIG_USE_ARCH_MEMSET
4859                 If these options are used a optimized version of memcpy/memset will
4860                 be used if available. These functions may be faster under some
4861                 conditions but may increase the binary size.
4862
4863 - CONFIG_X86_RESET_VECTOR
4864                 If defined, the x86 reset vector code is included. This is not
4865                 needed when U-Boot is running from Coreboot.
4866
4867 - CONFIG_SYS_MPUCLK
4868                 Defines the MPU clock speed (in MHz).
4869
4870                 NOTE : currently only supported on AM335x platforms.
4871
4872 - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4873                 Enables the RTC32K OSC on AM33xx based plattforms
4874
4875 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4876                 Option to disable subpage write in NAND driver
4877                 driver that uses this:
4878                 drivers/mtd/nand/davinci_nand.c
4879
4880 Freescale QE/FMAN Firmware Support:
4881 -----------------------------------
4882
4883 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4884 loading of "firmware", which is encoded in the QE firmware binary format.
4885 This firmware often needs to be loaded during U-Boot booting, so macros
4886 are used to identify the storage device (NOR flash, SPI, etc) and the address
4887 within that device.
4888
4889 - CONFIG_SYS_FMAN_FW_ADDR
4890         The address in the storage device where the FMAN microcode is located.  The
4891         meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4892         is also specified.
4893
4894 - CONFIG_SYS_QE_FW_ADDR
4895         The address in the storage device where the QE microcode is located.  The
4896         meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4897         is also specified.
4898
4899 - CONFIG_SYS_QE_FMAN_FW_LENGTH
4900         The maximum possible size of the firmware.  The firmware binary format
4901         has a field that specifies the actual size of the firmware, but it
4902         might not be possible to read any part of the firmware unless some
4903         local storage is allocated to hold the entire firmware first.
4904
4905 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
4906         Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4907         normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4908         virtual address in NOR flash.
4909
4910 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
4911         Specifies that QE/FMAN firmware is located in NAND flash.
4912         CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4913
4914 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
4915         Specifies that QE/FMAN firmware is located on the primary SD/MMC
4916         device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4917
4918 - CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4919         Specifies that QE/FMAN firmware is located on the primary SPI
4920         device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4921
4922 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4923         Specifies that QE/FMAN firmware is located in the remote (master)
4924         memory space.   CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4925         can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4926         window->master inbound window->master LAW->the ucode address in
4927         master's memory space.
4928
4929 Freescale Layerscape Management Complex Firmware Support:
4930 ---------------------------------------------------------
4931 The Freescale Layerscape Management Complex (MC) supports the loading of
4932 "firmware".
4933 This firmware often needs to be loaded during U-Boot booting, so macros
4934 are used to identify the storage device (NOR flash, SPI, etc) and the address
4935 within that device.
4936
4937 - CONFIG_FSL_MC_ENET
4938         Enable the MC driver for Layerscape SoCs.
4939
4940 - CONFIG_SYS_LS_MC_FW_ADDR
4941         The address in the storage device where the firmware is located.  The
4942         meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4943         is also specified.
4944
4945 - CONFIG_SYS_LS_MC_FW_LENGTH
4946         The maximum possible size of the firmware.  The firmware binary format
4947         has a field that specifies the actual size of the firmware, but it
4948         might not be possible to read any part of the firmware unless some
4949         local storage is allocated to hold the entire firmware first.
4950
4951 - CONFIG_SYS_LS_MC_FW_IN_NOR
4952         Specifies that MC firmware is located in NOR flash, mapped as
4953         normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4954         virtual address in NOR flash.
4955
4956 Building the Software:
4957 ======================
4958
4959 Building U-Boot has been tested in several native build environments
4960 and in many different cross environments. Of course we cannot support
4961 all possibly existing versions of cross development tools in all
4962 (potentially obsolete) versions. In case of tool chain problems we
4963 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4964 which is extensively used to build and test U-Boot.
4965
4966 If you are not using a native environment, it is assumed that you
4967 have GNU cross compiling tools available in your path. In this case,
4968 you must set the environment variable CROSS_COMPILE in your shell.
4969 Note that no changes to the Makefile or any other source files are
4970 necessary. For example using the ELDK on a 4xx CPU, please enter:
4971
4972         $ CROSS_COMPILE=ppc_4xx-
4973         $ export CROSS_COMPILE
4974
4975 Note: If you wish to generate Windows versions of the utilities in
4976       the tools directory you can use the MinGW toolchain
4977       (http://www.mingw.org).  Set your HOST tools to the MinGW
4978       toolchain and execute 'make tools'.  For example:
4979
4980        $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4981
4982       Binaries such as tools/mkimage.exe will be created which can
4983       be executed on computers running Windows.
4984
4985 U-Boot is intended to be simple to build. After installing the
4986 sources you must configure U-Boot for one specific board type. This
4987 is done by typing:
4988
4989         make NAME_defconfig
4990
4991 where "NAME_defconfig" is the name of one of the existing configu-
4992 rations; see boards.cfg for supported names.
4993
4994 Note: for some board special configuration names may exist; check if
4995       additional information is available from the board vendor; for
4996       instance, the TQM823L systems are available without (standard)
4997       or with LCD support. You can select such additional "features"
4998       when choosing the configuration, i. e.
4999
5000       make TQM823L_defconfig
5001         - will configure for a plain TQM823L, i. e. no LCD support
5002
5003       make TQM823L_LCD_defconfig
5004         - will configure for a TQM823L with U-Boot console on LCD
5005
5006       etc.
5007
5008
5009 Finally, type "make all", and you should get some working U-Boot
5010 images ready for download to / installation on your system:
5011
5012 - "u-boot.bin" is a raw binary image
5013 - "u-boot" is an image in ELF binary format
5014 - "u-boot.srec" is in Motorola S-Record format
5015
5016 By default the build is performed locally and the objects are saved
5017 in the source directory. One of the two methods can be used to change
5018 this behavior and build U-Boot to some external directory:
5019
5020 1. Add O= to the make command line invocations:
5021
5022         make O=/tmp/build distclean
5023         make O=/tmp/build NAME_defconfig
5024         make O=/tmp/build all
5025
5026 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5027
5028         export KBUILD_OUTPUT=/tmp/build
5029         make distclean
5030         make NAME_defconfig
5031         make all
5032
5033 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5034 variable.
5035
5036
5037 Please be aware that the Makefiles assume you are using GNU make, so
5038 for instance on NetBSD you might need to use "gmake" instead of
5039 native "make".
5040
5041
5042 If the system board that you have is not listed, then you will need
5043 to port U-Boot to your hardware platform. To do this, follow these
5044 steps:
5045
5046 1.  Add a new configuration option for your board to the toplevel
5047     "boards.cfg" file, using the existing entries as examples.
5048     Follow the instructions there to keep the boards in order.
5049 2.  Create a new directory to hold your board specific code. Add any
5050     files you need. In your board directory, you will need at least
5051     the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
5052 3.  Create a new configuration file "include/configs/<board>.h" for
5053     your board
5054 3.  If you're porting U-Boot to a new CPU, then also create a new
5055     directory to hold your CPU specific code. Add any files you need.
5056 4.  Run "make <board>_defconfig" with your new name.
5057 5.  Type "make", and you should get a working "u-boot.srec" file
5058     to be installed on your target system.
5059 6.  Debug and solve any problems that might arise.
5060     [Of course, this last step is much harder than it sounds.]
5061
5062
5063 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5064 ==============================================================
5065
5066 If you have modified U-Boot sources (for instance added a new board
5067 or support for new devices, a new CPU, etc.) you are expected to
5068 provide feedback to the other developers. The feedback normally takes
5069 the form of a "patch", i. e. a context diff against a certain (latest
5070 official or latest in the git repository) version of U-Boot sources.
5071
5072 But before you submit such a patch, please verify that your modifi-
5073 cation did not break existing code. At least make sure that *ALL* of
5074 the supported boards compile WITHOUT ANY compiler warnings. To do so,
5075 just run the "MAKEALL" script, which will configure and build U-Boot
5076 for ALL supported system. Be warned, this will take a while. You can
5077 select which (cross) compiler to use by passing a `CROSS_COMPILE'
5078 environment variable to the script, i. e. to use the ELDK cross tools
5079 you can type
5080
5081         CROSS_COMPILE=ppc_8xx- MAKEALL
5082
5083 or to build on a native PowerPC system you can type
5084
5085         CROSS_COMPILE=' ' MAKEALL
5086
5087 When using the MAKEALL script, the default behaviour is to build
5088 U-Boot in the source directory. This location can be changed by
5089 setting the BUILD_DIR environment variable. Also, for each target
5090 built, the MAKEALL script saves two log files (<target>.ERR and
5091 <target>.MAKEALL) in the <source dir>/LOG directory. This default
5092 location can be changed by setting the MAKEALL_LOGDIR environment
5093 variable. For example:
5094
5095         export BUILD_DIR=/tmp/build
5096         export MAKEALL_LOGDIR=/tmp/log
5097         CROSS_COMPILE=ppc_8xx- MAKEALL
5098
5099 With the above settings build objects are saved in the /tmp/build,
5100 log files are saved in the /tmp/log and the source tree remains clean
5101 during the whole build process.
5102
5103
5104 See also "U-Boot Porting Guide" below.
5105
5106
5107 Monitor Commands - Overview:
5108 ============================
5109
5110 go      - start application at address 'addr'
5111 run     - run commands in an environment variable
5112 bootm   - boot application image from memory
5113 bootp   - boot image via network using BootP/TFTP protocol
5114 bootz   - boot zImage from memory
5115 tftpboot- boot image via network using TFTP protocol
5116                and env variables "ipaddr" and "serverip"
5117                (and eventually "gatewayip")
5118 tftpput - upload a file via network using TFTP protocol
5119 rarpboot- boot image via network using RARP/TFTP protocol
5120 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5121 loads   - load S-Record file over serial line
5122 loadb   - load binary file over serial line (kermit mode)
5123 md      - memory display
5124 mm      - memory modify (auto-incrementing)
5125 nm      - memory modify (constant address)
5126 mw      - memory write (fill)
5127 cp      - memory copy
5128 cmp     - memory compare
5129 crc32   - checksum calculation
5130 i2c     - I2C sub-system
5131 sspi    - SPI utility commands
5132 base    - print or set address offset
5133 printenv- print environment variables
5134 setenv  - set environment variables
5135 saveenv - save environment variables to persistent storage
5136 protect - enable or disable FLASH write protection
5137 erase   - erase FLASH memory
5138 flinfo  - print FLASH memory information
5139 nand    - NAND memory operations (see doc/README.nand)
5140 bdinfo  - print Board Info structure
5141 iminfo  - print header information for application image
5142 coninfo - print console devices and informations
5143 ide     - IDE sub-system
5144 loop    - infinite loop on address range
5145 loopw   - infinite write loop on address range
5146 mtest   - simple RAM test
5147 icache  - enable or disable instruction cache
5148 dcache  - enable or disable data cache
5149 reset   - Perform RESET of the CPU
5150 echo    - echo args to console
5151 version - print monitor version
5152 help    - print online help
5153 ?       - alias for 'help'
5154
5155
5156 Monitor Commands - Detailed Description:
5157 ========================================
5158
5159 TODO.
5160
5161 For now: just type "help <command>".
5162
5163
5164 Environment Variables:
5165 ======================
5166
5167 U-Boot supports user configuration using Environment Variables which
5168 can be made persistent by saving to Flash memory.
5169
5170 Environment Variables are set using "setenv", printed using
5171 "printenv", and saved to Flash using "saveenv". Using "setenv"
5172 without a value can be used to delete a variable from the
5173 environment. As long as you don't save the environment you are
5174 working with an in-memory copy. In case the Flash area containing the
5175 environment is erased by accident, a default environment is provided.
5176
5177 Some configuration options can be set using Environment Variables.
5178
5179 List of environment variables (most likely not complete):
5180
5181   baudrate      - see CONFIG_BAUDRATE
5182
5183   bootdelay     - see CONFIG_BOOTDELAY
5184
5185   bootcmd       - see CONFIG_BOOTCOMMAND
5186
5187   bootargs      - Boot arguments when booting an RTOS image
5188
5189   bootfile      - Name of the image to load with TFTP
5190
5191   bootm_low     - Memory range available for image processing in the bootm
5192                   command can be restricted. This variable is given as
5193                   a hexadecimal number and defines lowest address allowed
5194                   for use by the bootm command. See also "bootm_size"
5195                   environment variable. Address defined by "bootm_low" is
5196                   also the base of the initial memory mapping for the Linux
5197                   kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5198                   bootm_mapsize.
5199
5200   bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5201                   This variable is given as a hexadecimal number and it
5202                   defines the size of the memory region starting at base
5203                   address bootm_low that is accessible by the Linux kernel
5204                   during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5205                   as the default value if it is defined, and bootm_size is
5206                   used otherwise.
5207
5208   bootm_size    - Memory range available for image processing in the bootm
5209                   command can be restricted. This variable is given as
5210                   a hexadecimal number and defines the size of the region
5211                   allowed for use by the bootm command. See also "bootm_low"
5212                   environment variable.
5213
5214   updatefile    - Location of the software update file on a TFTP server, used
5215                   by the automatic software update feature. Please refer to
5216                   documentation in doc/README.update for more details.
5217
5218   autoload      - if set to "no" (any string beginning with 'n'),
5219                   "bootp" will just load perform a lookup of the
5220                   configuration from the BOOTP server, but not try to
5221                   load any image using TFTP
5222
5223   autostart     - if set to "yes", an image loaded using the "bootp",
5224                   "rarpboot", "tftpboot" or "diskboot" commands will
5225                   be automatically started (by internally calling
5226                   "bootm")
5227
5228                   If set to "no", a standalone image passed to the
5229                   "bootm" command will be copied to the load address
5230                   (and eventually uncompressed), but NOT be started.
5231                   This can be used to load and uncompress arbitrary
5232                   data.
5233
5234   fdt_high      - if set this restricts the maximum address that the
5235                   flattened device tree will be copied into upon boot.
5236                   For example, if you have a system with 1 GB memory
5237                   at physical address 0x10000000, while Linux kernel
5238                   only recognizes the first 704 MB as low memory, you
5239                   may need to set fdt_high as 0x3C000000 to have the
5240                   device tree blob be copied to the maximum address
5241                   of the 704 MB low memory, so that Linux kernel can
5242                   access it during the boot procedure.
5243
5244                   If this is set to the special value 0xFFFFFFFF then
5245                   the fdt will not be copied at all on boot.  For this
5246                   to work it must reside in writable memory, have
5247                   sufficient padding on the end of it for u-boot to
5248                   add the information it needs into it, and the memory
5249                   must be accessible by the kernel.
5250
5251   fdtcontroladdr- if set this is the address of the control flattened
5252                   device tree used by U-Boot when CONFIG_OF_CONTROL is
5253                   defined.
5254
5255   i2cfast       - (PPC405GP|PPC405EP only)
5256                   if set to 'y' configures Linux I2C driver for fast
5257                   mode (400kHZ). This environment variable is used in
5258                   initialization code. So, for changes to be effective
5259                   it must be saved and board must be reset.
5260
5261   initrd_high   - restrict positioning of initrd images:
5262                   If this variable is not set, initrd images will be
5263                   copied to the highest possible address in RAM; this
5264                   is usually what you want since it allows for
5265                   maximum initrd size. If for some reason you want to
5266                   make sure that the initrd image is loaded below the
5267                   CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5268                   variable to a value of "no" or "off" or "0".
5269                   Alternatively, you can set it to a maximum upper
5270                   address to use (U-Boot will still check that it
5271                   does not overwrite the U-Boot stack and data).
5272
5273                   For instance, when you have a system with 16 MB
5274                   RAM, and want to reserve 4 MB from use by Linux,
5275                   you can do this by adding "mem=12M" to the value of
5276                   the "bootargs" variable. However, now you must make
5277                   sure that the initrd image is placed in the first
5278                   12 MB as well - this can be done with
5279
5280                   setenv initrd_high 00c00000
5281
5282                   If you set initrd_high to 0xFFFFFFFF, this is an
5283                   indication to U-Boot that all addresses are legal
5284                   for the Linux kernel, including addresses in flash
5285                   memory. In this case U-Boot will NOT COPY the
5286                   ramdisk at all. This may be useful to reduce the
5287                   boot time on your system, but requires that this
5288                   feature is supported by your Linux kernel.
5289
5290   ipaddr        - IP address; needed for tftpboot command
5291
5292   loadaddr      - Default load address for commands like "bootp",
5293                   "rarpboot", "tftpboot", "loadb" or "diskboot"
5294
5295   loads_echo    - see CONFIG_LOADS_ECHO
5296
5297   serverip      - TFTP server IP address; needed for tftpboot command
5298
5299   bootretry     - see CONFIG_BOOT_RETRY_TIME
5300
5301   bootdelaykey  - see CONFIG_AUTOBOOT_DELAY_STR
5302
5303   bootstopkey   - see CONFIG_AUTOBOOT_STOP_STR
5304
5305   ethprime      - controls which interface is used first.
5306
5307   ethact        - controls which interface is currently active.
5308                   For example you can do the following
5309
5310                   => setenv ethact FEC
5311                   => ping 192.168.0.1 # traffic sent on FEC
5312                   => setenv ethact SCC
5313                   => ping 10.0.0.1 # traffic sent on SCC
5314
5315   ethrotate     - When set to "no" U-Boot does not go through all
5316                   available network interfaces.
5317                   It just stays at the currently selected interface.
5318
5319   netretry      - When set to "no" each network operation will
5320                   either succeed or fail without retrying.
5321                   When set to "once" the network operation will
5322                   fail when all the available network interfaces
5323                   are tried once without success.
5324                   Useful on scripts which control the retry operation
5325                   themselves.
5326
5327   npe_ucode     - set load address for the NPE microcode
5328
5329   silent_linux  - If set then linux will be told to boot silently, by
5330                   changing the console to be empty. If "yes" it will be
5331                   made silent. If "no" it will not be made silent. If
5332                   unset, then it will be made silent if the U-Boot console
5333                   is silent.
5334
5335   tftpsrcport   - If this is set, the value is used for TFTP's
5336                   UDP source port.
5337
5338   tftpdstport   - If this is set, the value is used for TFTP's UDP
5339                   destination port instead of the Well Know Port 69.
5340
5341   tftpblocksize - Block size to use for TFTP transfers; if not set,
5342                   we use the TFTP server's default block size
5343
5344   tftptimeout   - Retransmission timeout for TFTP packets (in milli-
5345                   seconds, minimum value is 1000 = 1 second). Defines
5346                   when a packet is considered to be lost so it has to
5347                   be retransmitted. The default is 5000 = 5 seconds.
5348                   Lowering this value may make downloads succeed
5349                   faster in networks with high packet loss rates or
5350                   with unreliable TFTP servers.
5351
5352   vlan          - When set to a value < 4095 the traffic over
5353                   Ethernet is encapsulated/received over 802.1q
5354                   VLAN tagged frames.
5355
5356 The following image location variables contain the location of images
5357 used in booting. The "Image" column gives the role of the image and is
5358 not an environment variable name. The other columns are environment
5359 variable names. "File Name" gives the name of the file on a TFTP
5360 server, "RAM Address" gives the location in RAM the image will be
5361 loaded to, and "Flash Location" gives the image's address in NOR
5362 flash or offset in NAND flash.
5363
5364 *Note* - these variables don't have to be defined for all boards, some
5365 boards currenlty use other variables for these purposes, and some
5366 boards use these variables for other purposes.
5367
5368 Image               File Name        RAM Address       Flash Location
5369 -----               ---------        -----------       --------------
5370 u-boot              u-boot           u-boot_addr_r     u-boot_addr
5371 Linux kernel        bootfile         kernel_addr_r     kernel_addr
5372 device tree blob    fdtfile          fdt_addr_r        fdt_addr
5373 ramdisk             ramdiskfile      ramdisk_addr_r    ramdisk_addr
5374
5375 The following environment variables may be used and automatically
5376 updated by the network boot commands ("bootp" and "rarpboot"),
5377 depending the information provided by your boot server:
5378
5379   bootfile      - see above
5380   dnsip         - IP address of your Domain Name Server
5381   dnsip2        - IP address of your secondary Domain Name Server
5382   gatewayip     - IP address of the Gateway (Router) to use
5383   hostname      - Target hostname
5384   ipaddr        - see above
5385   netmask       - Subnet Mask
5386   rootpath      - Pathname of the root filesystem on the NFS server
5387   serverip      - see above
5388
5389
5390 There are two special Environment Variables:
5391
5392   serial#       - contains hardware identification information such
5393                   as type string and/or serial number
5394   ethaddr       - Ethernet address
5395
5396 These variables can be set only once (usually during manufacturing of
5397 the board). U-Boot refuses to delete or overwrite these variables
5398 once they have been set once.
5399
5400
5401 Further special Environment Variables:
5402
5403   ver           - Contains the U-Boot version string as printed
5404                   with the "version" command. This variable is
5405                   readonly (see CONFIG_VERSION_VARIABLE).
5406
5407
5408 Please note that changes to some configuration parameters may take
5409 only effect after the next boot (yes, that's just like Windoze :-).
5410
5411
5412 Callback functions for environment variables:
5413 ---------------------------------------------
5414
5415 For some environment variables, the behavior of u-boot needs to change
5416 when their values are changed.  This functionailty allows functions to
5417 be associated with arbitrary variables.  On creation, overwrite, or
5418 deletion, the callback will provide the opportunity for some side
5419 effect to happen or for the change to be rejected.
5420
5421 The callbacks are named and associated with a function using the
5422 U_BOOT_ENV_CALLBACK macro in your board or driver code.
5423
5424 These callbacks are associated with variables in one of two ways.  The
5425 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5426 in the board configuration to a string that defines a list of
5427 associations.  The list must be in the following format:
5428
5429         entry = variable_name[:callback_name]
5430         list = entry[,list]
5431
5432 If the callback name is not specified, then the callback is deleted.
5433 Spaces are also allowed anywhere in the list.
5434
5435 Callbacks can also be associated by defining the ".callbacks" variable
5436 with the same list format above.  Any association in ".callbacks" will
5437 override any association in the static list. You can define
5438 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5439 ".callbacks" envirnoment variable in the default or embedded environment.
5440
5441
5442 Command Line Parsing:
5443 =====================
5444
5445 There are two different command line parsers available with U-Boot:
5446 the old "simple" one, and the much more powerful "hush" shell:
5447
5448 Old, simple command line parser:
5449 --------------------------------
5450
5451 - supports environment variables (through setenv / saveenv commands)
5452 - several commands on one line, separated by ';'
5453 - variable substitution using "... ${name} ..." syntax
5454 - special characters ('$', ';') can be escaped by prefixing with '\',
5455   for example:
5456         setenv bootcmd bootm \${address}
5457 - You can also escape text by enclosing in single apostrophes, for example:
5458         setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5459
5460 Hush shell:
5461 -----------
5462
5463 - similar to Bourne shell, with control structures like
5464   if...then...else...fi, for...do...done; while...do...done,
5465   until...do...done, ...
5466 - supports environment ("global") variables (through setenv / saveenv
5467   commands) and local shell variables (through standard shell syntax
5468   "name=value"); only environment variables can be used with "run"
5469   command
5470
5471 General rules:
5472 --------------
5473
5474 (1) If a command line (or an environment variable executed by a "run"
5475     command) contains several commands separated by semicolon, and
5476     one of these commands fails, then the remaining commands will be
5477     executed anyway.
5478
5479 (2) If you execute several variables with one call to run (i. e.
5480     calling run with a list of variables as arguments), any failing
5481     command will cause "run" to terminate, i. e. the remaining
5482     variables are not executed.
5483
5484 Note for Redundant Ethernet Interfaces:
5485 =======================================
5486
5487 Some boards come with redundant Ethernet interfaces; U-Boot supports
5488 such configurations and is capable of automatic selection of a
5489 "working" interface when needed. MAC assignment works as follows:
5490
5491 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5492 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5493 "eth1addr" (=>eth1), "eth2addr", ...
5494
5495 If the network interface stores some valid MAC address (for instance
5496 in SROM), this is used as default address if there is NO correspon-
5497 ding setting in the environment; if the corresponding environment
5498 variable is set, this overrides the settings in the card; that means:
5499
5500 o If the SROM has a valid MAC address, and there is no address in the
5501   environment, the SROM's address is used.
5502
5503 o If there is no valid address in the SROM, and a definition in the
5504   environment exists, then the value from the environment variable is
5505   used.
5506
5507 o If both the SROM and the environment contain a MAC address, and
5508   both addresses are the same, this MAC address is used.
5509
5510 o If both the SROM and the environment contain a MAC address, and the
5511   addresses differ, the value from the environment is used and a
5512   warning is printed.
5513
5514 o If neither SROM nor the environment contain a MAC address, an error
5515   is raised.
5516
5517 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5518 will be programmed into hardware as part of the initialization process.  This
5519 may be skipped by setting the appropriate 'ethmacskip' environment variable.
5520 The naming convention is as follows:
5521 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5522
5523 Image Formats:
5524 ==============
5525
5526 U-Boot is capable of booting (and performing other auxiliary operations on)
5527 images in two formats:
5528
5529 New uImage format (FIT)
5530 -----------------------
5531
5532 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5533 to Flattened Device Tree). It allows the use of images with multiple
5534 components (several kernels, ramdisks, etc.), with contents protected by
5535 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5536
5537
5538 Old uImage format
5539 -----------------
5540
5541 Old image format is based on binary files which can be basically anything,
5542 preceded by a special header; see the definitions in include/image.h for
5543 details; basically, the header defines the following image properties:
5544
5545 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5546   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5547   LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5548   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5549   INTEGRITY).
5550 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5551   IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5552   Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5553 * Compression Type (uncompressed, gzip, bzip2)
5554 * Load Address
5555 * Entry Point
5556 * Image Name
5557 * Image Timestamp
5558
5559 The header is marked by a special Magic Number, and both the header
5560 and the data portions of the image are secured against corruption by
5561 CRC32 checksums.
5562
5563
5564 Linux Support:
5565 ==============
5566
5567 Although U-Boot should support any OS or standalone application
5568 easily, the main focus has always been on Linux during the design of
5569 U-Boot.
5570
5571 U-Boot includes many features that so far have been part of some
5572 special "boot loader" code within the Linux kernel. Also, any
5573 "initrd" images to be used are no longer part of one big Linux image;
5574 instead, kernel and "initrd" are separate images. This implementation
5575 serves several purposes:
5576
5577 - the same features can be used for other OS or standalone
5578   applications (for instance: using compressed images to reduce the
5579   Flash memory footprint)
5580
5581 - it becomes much easier to port new Linux kernel versions because
5582   lots of low-level, hardware dependent stuff are done by U-Boot
5583
5584 - the same Linux kernel image can now be used with different "initrd"
5585   images; of course this also means that different kernel images can
5586   be run with the same "initrd". This makes testing easier (you don't
5587   have to build a new "zImage.initrd" Linux image when you just
5588   change a file in your "initrd"). Also, a field-upgrade of the
5589   software is easier now.
5590
5591
5592 Linux HOWTO:
5593 ============
5594
5595 Porting Linux to U-Boot based systems:
5596 ---------------------------------------
5597
5598 U-Boot cannot save you from doing all the necessary modifications to
5599 configure the Linux device drivers for use with your target hardware
5600 (no, we don't intend to provide a full virtual machine interface to
5601 Linux :-).
5602
5603 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5604
5605 Just make sure your machine specific header file (for instance
5606 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
5607 Information structure as we define in include/asm-<arch>/u-boot.h,
5608 and make sure that your definition of IMAP_ADDR uses the same value
5609 as your U-Boot configuration in CONFIG_SYS_IMMR.
5610
5611 Note that U-Boot now has a driver model, a unified model for drivers.
5612 If you are adding a new driver, plumb it into driver model. If there
5613 is no uclass available, you are encouraged to create one. See
5614 doc/driver-model.
5615
5616
5617 Configuring the Linux kernel:
5618 -----------------------------
5619
5620 No specific requirements for U-Boot. Make sure you have some root
5621 device (initial ramdisk, NFS) for your target system.
5622
5623
5624 Building a Linux Image:
5625 -----------------------
5626
5627 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5628 not used. If you use recent kernel source, a new build target
5629 "uImage" will exist which automatically builds an image usable by
5630 U-Boot. Most older kernels also have support for a "pImage" target,
5631 which was introduced for our predecessor project PPCBoot and uses a
5632 100% compatible format.
5633
5634 Example:
5635
5636         make TQM850L_defconfig
5637         make oldconfig
5638         make dep
5639         make uImage
5640
5641 The "uImage" build target uses a special tool (in 'tools/mkimage') to
5642 encapsulate a compressed Linux kernel image with header  information,
5643 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
5644
5645 * build a standard "vmlinux" kernel image (in ELF binary format):
5646
5647 * convert the kernel into a raw binary image:
5648
5649         ${CROSS_COMPILE}-objcopy -O binary \
5650                                  -R .note -R .comment \
5651                                  -S vmlinux linux.bin
5652
5653 * compress the binary image:
5654
5655         gzip -9 linux.bin
5656
5657 * package compressed binary image for U-Boot:
5658
5659         mkimage -A ppc -O linux -T kernel -C gzip \
5660                 -a 0 -e 0 -n "Linux Kernel Image" \
5661                 -d linux.bin.gz uImage
5662
5663
5664 The "mkimage" tool can also be used to create ramdisk images for use
5665 with U-Boot, either separated from the Linux kernel image, or
5666 combined into one file. "mkimage" encapsulates the images with a 64
5667 byte header containing information about target architecture,
5668 operating system, image type, compression method, entry points, time
5669 stamp, CRC32 checksums, etc.
5670
5671 "mkimage" can be called in two ways: to verify existing images and
5672 print the header information, or to build new images.
5673
5674 In the first form (with "-l" option) mkimage lists the information
5675 contained in the header of an existing U-Boot image; this includes
5676 checksum verification:
5677
5678         tools/mkimage -l image
5679           -l ==> list image header information
5680
5681 The second form (with "-d" option) is used to build a U-Boot image
5682 from a "data file" which is used as image payload:
5683
5684         tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5685                       -n name -d data_file image
5686           -A ==> set architecture to 'arch'
5687           -O ==> set operating system to 'os'
5688           -T ==> set image type to 'type'
5689           -C ==> set compression type 'comp'
5690           -a ==> set load address to 'addr' (hex)
5691           -e ==> set entry point to 'ep' (hex)
5692           -n ==> set image name to 'name'
5693           -d ==> use image data from 'datafile'
5694
5695 Right now, all Linux kernels for PowerPC systems use the same load
5696 address (0x00000000), but the entry point address depends on the
5697 kernel version:
5698
5699 - 2.2.x kernels have the entry point at 0x0000000C,
5700 - 2.3.x and later kernels have the entry point at 0x00000000.
5701
5702 So a typical call to build a U-Boot image would read:
5703
5704         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5705         > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5706         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
5707         > examples/uImage.TQM850L
5708         Image Name:   2.4.4 kernel for TQM850L
5709         Created:      Wed Jul 19 02:34:59 2000
5710         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5711         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5712         Load Address: 0x00000000
5713         Entry Point:  0x00000000
5714
5715 To verify the contents of the image (or check for corruption):
5716
5717         -> tools/mkimage -l examples/uImage.TQM850L
5718         Image Name:   2.4.4 kernel for TQM850L
5719         Created:      Wed Jul 19 02:34:59 2000
5720         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5721         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5722         Load Address: 0x00000000
5723         Entry Point:  0x00000000
5724
5725 NOTE: for embedded systems where boot time is critical you can trade
5726 speed for memory and install an UNCOMPRESSED image instead: this
5727 needs more space in Flash, but boots much faster since it does not
5728 need to be uncompressed:
5729
5730         -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
5731         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5732         > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5733         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
5734         > examples/uImage.TQM850L-uncompressed
5735         Image Name:   2.4.4 kernel for TQM850L
5736         Created:      Wed Jul 19 02:34:59 2000
5737         Image Type:   PowerPC Linux Kernel Image (uncompressed)
5738         Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5739         Load Address: 0x00000000
5740         Entry Point:  0x00000000
5741
5742
5743 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5744 when your kernel is intended to use an initial ramdisk:
5745
5746         -> tools/mkimage -n 'Simple Ramdisk Image' \
5747         > -A ppc -O linux -T ramdisk -C gzip \
5748         > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5749         Image Name:   Simple Ramdisk Image
5750         Created:      Wed Jan 12 14:01:50 2000
5751         Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5752         Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5753         Load Address: 0x00000000
5754         Entry Point:  0x00000000
5755
5756 The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5757 option performs the converse operation of the mkimage's second form (the "-d"
5758 option). Given an image built by mkimage, the dumpimage extracts a "data file"
5759 from the image:
5760
5761         tools/dumpimage -i image -p position data_file
5762           -i ==> extract from the 'image' a specific 'data_file', \
5763            indexed by 'position'
5764
5765
5766 Installing a Linux Image:
5767 -------------------------
5768
5769 To downloading a U-Boot image over the serial (console) interface,
5770 you must convert the image to S-Record format:
5771
5772         objcopy -I binary -O srec examples/image examples/image.srec
5773
5774 The 'objcopy' does not understand the information in the U-Boot
5775 image header, so the resulting S-Record file will be relative to
5776 address 0x00000000. To load it to a given address, you need to
5777 specify the target address as 'offset' parameter with the 'loads'
5778 command.
5779
5780 Example: install the image to address 0x40100000 (which on the
5781 TQM8xxL is in the first Flash bank):
5782
5783         => erase 40100000 401FFFFF
5784
5785         .......... done
5786         Erased 8 sectors
5787
5788         => loads 40100000
5789         ## Ready for S-Record download ...
5790         ~>examples/image.srec
5791         1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5792         ...
5793         15989 15990 15991 15992
5794         [file transfer complete]
5795         [connected]
5796         ## Start Addr = 0x00000000
5797
5798
5799 You can check the success of the download using the 'iminfo' command;
5800 this includes a checksum verification so you can be sure no data
5801 corruption happened:
5802
5803         => imi 40100000
5804
5805         ## Checking Image at 40100000 ...
5806            Image Name:   2.2.13 for initrd on TQM850L
5807            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5808            Data Size:    335725 Bytes = 327 kB = 0 MB
5809            Load Address: 00000000
5810            Entry Point:  0000000c
5811            Verifying Checksum ... OK
5812
5813
5814 Boot Linux:
5815 -----------
5816
5817 The "bootm" command is used to boot an application that is stored in
5818 memory (RAM or Flash). In case of a Linux kernel image, the contents
5819 of the "bootargs" environment variable is passed to the kernel as
5820 parameters. You can check and modify this variable using the
5821 "printenv" and "setenv" commands:
5822
5823
5824         => printenv bootargs
5825         bootargs=root=/dev/ram
5826
5827         => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5828
5829         => printenv bootargs
5830         bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5831
5832         => bootm 40020000
5833         ## Booting Linux kernel at 40020000 ...
5834            Image Name:   2.2.13 for NFS on TQM850L
5835            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5836            Data Size:    381681 Bytes = 372 kB = 0 MB
5837            Load Address: 00000000
5838            Entry Point:  0000000c
5839            Verifying Checksum ... OK
5840            Uncompressing Kernel Image ... OK
5841         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
5842         Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5843         time_init: decrementer frequency = 187500000/60
5844         Calibrating delay loop... 49.77 BogoMIPS
5845         Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5846         ...
5847
5848 If you want to boot a Linux kernel with initial RAM disk, you pass
5849 the memory addresses of both the kernel and the initrd image (PPBCOOT
5850 format!) to the "bootm" command:
5851
5852         => imi 40100000 40200000
5853
5854         ## Checking Image at 40100000 ...
5855            Image Name:   2.2.13 for initrd on TQM850L
5856            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5857            Data Size:    335725 Bytes = 327 kB = 0 MB
5858            Load Address: 00000000
5859            Entry Point:  0000000c
5860            Verifying Checksum ... OK
5861
5862         ## Checking Image at 40200000 ...
5863            Image Name:   Simple Ramdisk Image
5864            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5865            Data Size:    566530 Bytes = 553 kB = 0 MB
5866            Load Address: 00000000
5867            Entry Point:  00000000
5868            Verifying Checksum ... OK
5869
5870         => bootm 40100000 40200000
5871         ## Booting Linux kernel at 40100000 ...
5872            Image Name:   2.2.13 for initrd on TQM850L
5873            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5874            Data Size:    335725 Bytes = 327 kB = 0 MB
5875            Load Address: 00000000
5876            Entry Point:  0000000c
5877            Verifying Checksum ... OK
5878            Uncompressing Kernel Image ... OK
5879         ## Loading RAMDisk Image at 40200000 ...
5880            Image Name:   Simple Ramdisk Image
5881            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5882            Data Size:    566530 Bytes = 553 kB = 0 MB
5883            Load Address: 00000000
5884            Entry Point:  00000000
5885            Verifying Checksum ... OK
5886            Loading Ramdisk ... OK
5887         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
5888         Boot arguments: root=/dev/ram
5889         time_init: decrementer frequency = 187500000/60
5890         Calibrating delay loop... 49.77 BogoMIPS
5891         ...
5892         RAMDISK: Compressed image found at block 0
5893         VFS: Mounted root (ext2 filesystem).
5894
5895         bash#
5896
5897 Boot Linux and pass a flat device tree:
5898 -----------
5899
5900 First, U-Boot must be compiled with the appropriate defines. See the section
5901 titled "Linux Kernel Interface" above for a more in depth explanation. The
5902 following is an example of how to start a kernel and pass an updated
5903 flat device tree:
5904
5905 => print oftaddr
5906 oftaddr=0x300000
5907 => print oft
5908 oft=oftrees/mpc8540ads.dtb
5909 => tftp $oftaddr $oft
5910 Speed: 1000, full duplex
5911 Using TSEC0 device
5912 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5913 Filename 'oftrees/mpc8540ads.dtb'.
5914 Load address: 0x300000
5915 Loading: #
5916 done
5917 Bytes transferred = 4106 (100a hex)
5918 => tftp $loadaddr $bootfile
5919 Speed: 1000, full duplex
5920 Using TSEC0 device
5921 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5922 Filename 'uImage'.
5923 Load address: 0x200000
5924 Loading:############
5925 done
5926 Bytes transferred = 1029407 (fb51f hex)
5927 => print loadaddr
5928 loadaddr=200000
5929 => print oftaddr
5930 oftaddr=0x300000
5931 => bootm $loadaddr - $oftaddr
5932 ## Booting image at 00200000 ...
5933    Image Name:   Linux-2.6.17-dirty
5934    Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5935    Data Size:    1029343 Bytes = 1005.2 kB
5936    Load Address: 00000000
5937    Entry Point:  00000000
5938    Verifying Checksum ... OK
5939    Uncompressing Kernel Image ... OK
5940 Booting using flat device tree at 0x300000
5941 Using MPC85xx ADS machine description
5942 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5943 [snip]
5944
5945
5946 More About U-Boot Image Types:
5947 ------------------------------
5948
5949 U-Boot supports the following image types:
5950
5951    "Standalone Programs" are directly runnable in the environment
5952         provided by U-Boot; it is expected that (if they behave
5953         well) you can continue to work in U-Boot after return from
5954         the Standalone Program.
5955    "OS Kernel Images" are usually images of some Embedded OS which
5956         will take over control completely. Usually these programs
5957         will install their own set of exception handlers, device
5958         drivers, set up the MMU, etc. - this means, that you cannot
5959         expect to re-enter U-Boot except by resetting the CPU.
5960    "RAMDisk Images" are more or less just data blocks, and their
5961         parameters (address, size) are passed to an OS kernel that is
5962         being started.
5963    "Multi-File Images" contain several images, typically an OS
5964         (Linux) kernel image and one or more data images like
5965         RAMDisks. This construct is useful for instance when you want
5966         to boot over the network using BOOTP etc., where the boot
5967         server provides just a single image file, but you want to get
5968         for instance an OS kernel and a RAMDisk image.
5969
5970         "Multi-File Images" start with a list of image sizes, each
5971         image size (in bytes) specified by an "uint32_t" in network
5972         byte order. This list is terminated by an "(uint32_t)0".
5973         Immediately after the terminating 0 follow the images, one by
5974         one, all aligned on "uint32_t" boundaries (size rounded up to
5975         a multiple of 4 bytes).
5976
5977    "Firmware Images" are binary images containing firmware (like
5978         U-Boot or FPGA images) which usually will be programmed to
5979         flash memory.
5980
5981    "Script files" are command sequences that will be executed by
5982         U-Boot's command interpreter; this feature is especially
5983         useful when you configure U-Boot to use a real shell (hush)
5984         as command interpreter.
5985
5986 Booting the Linux zImage:
5987 -------------------------
5988
5989 On some platforms, it's possible to boot Linux zImage. This is done
5990 using the "bootz" command. The syntax of "bootz" command is the same
5991 as the syntax of "bootm" command.
5992
5993 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5994 kernel with raw initrd images. The syntax is slightly different, the
5995 address of the initrd must be augmented by it's size, in the following
5996 format: "<initrd addres>:<initrd size>".
5997
5998
5999 Standalone HOWTO:
6000 =================
6001
6002 One of the features of U-Boot is that you can dynamically load and
6003 run "standalone" applications, which can use some resources of
6004 U-Boot like console I/O functions or interrupt services.
6005
6006 Two simple examples are included with the sources:
6007
6008 "Hello World" Demo:
6009 -------------------
6010
6011 'examples/hello_world.c' contains a small "Hello World" Demo
6012 application; it is automatically compiled when you build U-Boot.
6013 It's configured to run at address 0x00040004, so you can play with it
6014 like that:
6015
6016         => loads
6017         ## Ready for S-Record download ...
6018         ~>examples/hello_world.srec
6019         1 2 3 4 5 6 7 8 9 10 11 ...
6020         [file transfer complete]
6021         [connected]
6022         ## Start Addr = 0x00040004
6023
6024         => go 40004 Hello World! This is a test.
6025         ## Starting application at 0x00040004 ...
6026         Hello World
6027         argc = 7
6028         argv[0] = "40004"
6029         argv[1] = "Hello"
6030         argv[2] = "World!"
6031         argv[3] = "This"
6032         argv[4] = "is"
6033         argv[5] = "a"
6034         argv[6] = "test."
6035         argv[7] = "<NULL>"
6036         Hit any key to exit ...
6037
6038         ## Application terminated, rc = 0x0
6039
6040 Another example, which demonstrates how to register a CPM interrupt
6041 handler with the U-Boot code, can be found in 'examples/timer.c'.
6042 Here, a CPM timer is set up to generate an interrupt every second.
6043 The interrupt service routine is trivial, just printing a '.'
6044 character, but this is just a demo program. The application can be
6045 controlled by the following keys:
6046
6047         ? - print current values og the CPM Timer registers
6048         b - enable interrupts and start timer
6049         e - stop timer and disable interrupts
6050         q - quit application
6051
6052         => loads
6053         ## Ready for S-Record download ...
6054         ~>examples/timer.srec
6055         1 2 3 4 5 6 7 8 9 10 11 ...
6056         [file transfer complete]
6057         [connected]
6058         ## Start Addr = 0x00040004
6059
6060         => go 40004
6061         ## Starting application at 0x00040004 ...
6062         TIMERS=0xfff00980
6063         Using timer 1
6064           tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6065
6066 Hit 'b':
6067         [q, b, e, ?] Set interval 1000000 us
6068         Enabling timer
6069 Hit '?':
6070         [q, b, e, ?] ........
6071         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6072 Hit '?':
6073         [q, b, e, ?] .
6074         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6075 Hit '?':
6076         [q, b, e, ?] .
6077         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6078 Hit '?':
6079         [q, b, e, ?] .
6080         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6081 Hit 'e':
6082         [q, b, e, ?] ...Stopping timer
6083 Hit 'q':
6084         [q, b, e, ?] ## Application terminated, rc = 0x0
6085
6086
6087 Minicom warning:
6088 ================
6089
6090 Over time, many people have reported problems when trying to use the
6091 "minicom" terminal emulation program for serial download. I (wd)
6092 consider minicom to be broken, and recommend not to use it. Under
6093 Unix, I recommend to use C-Kermit for general purpose use (and
6094 especially for kermit binary protocol download ("loadb" command), and
6095 use "cu" for S-Record download ("loads" command).  See
6096 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6097 for help with kermit.
6098
6099
6100 Nevertheless, if you absolutely want to use it try adding this
6101 configuration to your "File transfer protocols" section:
6102
6103            Name    Program                      Name U/D FullScr IO-Red. Multi
6104         X  kermit  /usr/bin/kermit -i -l %l -s   Y    U    Y       N      N
6105         Y  kermit  /usr/bin/kermit -i -l %l -r   N    D    Y       N      N
6106
6107
6108 NetBSD Notes:
6109 =============
6110
6111 Starting at version 0.9.2, U-Boot supports NetBSD both as host
6112 (build U-Boot) and target system (boots NetBSD/mpc8xx).
6113
6114 Building requires a cross environment; it is known to work on
6115 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6116 need gmake since the Makefiles are not compatible with BSD make).
6117 Note that the cross-powerpc package does not install include files;
6118 attempting to build U-Boot will fail because <machine/ansi.h> is
6119 missing.  This file has to be installed and patched manually:
6120
6121         # cd /usr/pkg/cross/powerpc-netbsd/include
6122         # mkdir powerpc
6123         # ln -s powerpc machine
6124         # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6125         # ${EDIT} powerpc/ansi.h        ## must remove __va_list, _BSD_VA_LIST
6126
6127 Native builds *don't* work due to incompatibilities between native
6128 and U-Boot include files.
6129
6130 Booting assumes that (the first part of) the image booted is a
6131 stage-2 loader which in turn loads and then invokes the kernel
6132 proper. Loader sources will eventually appear in the NetBSD source
6133 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
6134 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6135
6136
6137 Implementation Internals:
6138 =========================
6139
6140 The following is not intended to be a complete description of every
6141 implementation detail. However, it should help to understand the
6142 inner workings of U-Boot and make it easier to port it to custom
6143 hardware.
6144
6145
6146 Initial Stack, Global Data:
6147 ---------------------------
6148
6149 The implementation of U-Boot is complicated by the fact that U-Boot
6150 starts running out of ROM (flash memory), usually without access to
6151 system RAM (because the memory controller is not initialized yet).
6152 This means that we don't have writable Data or BSS segments, and BSS
6153 is not initialized as zero. To be able to get a C environment working
6154 at all, we have to allocate at least a minimal stack. Implementation
6155 options for this are defined and restricted by the CPU used: Some CPU
6156 models provide on-chip memory (like the IMMR area on MPC8xx and
6157 MPC826x processors), on others (parts of) the data cache can be
6158 locked as (mis-) used as memory, etc.
6159
6160         Chris Hallinan posted a good summary of these issues to the
6161         U-Boot mailing list:
6162
6163         Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6164         From: "Chris Hallinan" <clh@net1plus.com>
6165         Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6166         ...
6167
6168         Correct me if I'm wrong, folks, but the way I understand it
6169         is this: Using DCACHE as initial RAM for Stack, etc, does not
6170         require any physical RAM backing up the cache. The cleverness
6171         is that the cache is being used as a temporary supply of
6172         necessary storage before the SDRAM controller is setup. It's
6173         beyond the scope of this list to explain the details, but you
6174         can see how this works by studying the cache architecture and
6175         operation in the architecture and processor-specific manuals.
6176
6177         OCM is On Chip Memory, which I believe the 405GP has 4K. It
6178         is another option for the system designer to use as an
6179         initial stack/RAM area prior to SDRAM being available. Either
6180         option should work for you. Using CS 4 should be fine if your
6181         board designers haven't used it for something that would
6182         cause you grief during the initial boot! It is frequently not
6183         used.
6184
6185         CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
6186         with your processor/board/system design. The default value
6187         you will find in any recent u-boot distribution in
6188         walnut.h should work for you. I'd set it to a value larger
6189         than your SDRAM module. If you have a 64MB SDRAM module, set
6190         it above 400_0000. Just make sure your board has no resources
6191         that are supposed to respond to that address! That code in
6192         start.S has been around a while and should work as is when
6193         you get the config right.
6194
6195         -Chris Hallinan
6196         DS4.COM, Inc.
6197
6198 It is essential to remember this, since it has some impact on the C
6199 code for the initialization procedures:
6200
6201 * Initialized global data (data segment) is read-only. Do not attempt
6202   to write it.
6203
6204 * Do not use any uninitialized global data (or implicitely initialized
6205   as zero data - BSS segment) at all - this is undefined, initiali-
6206   zation is performed later (when relocating to RAM).
6207
6208 * Stack space is very limited. Avoid big data buffers or things like
6209   that.
6210
6211 Having only the stack as writable memory limits means we cannot use
6212 normal global data to share information beween the code. But it
6213 turned out that the implementation of U-Boot can be greatly
6214 simplified by making a global data structure (gd_t) available to all
6215 functions. We could pass a pointer to this data as argument to _all_
6216 functions, but this would bloat the code. Instead we use a feature of
6217 the GCC compiler (Global Register Variables) to share the data: we
6218 place a pointer (gd) to the global data into a register which we
6219 reserve for this purpose.
6220
6221 When choosing a register for such a purpose we are restricted by the
6222 relevant  (E)ABI  specifications for the current architecture, and by
6223 GCC's implementation.
6224
6225 For PowerPC, the following registers have specific use:
6226         R1:     stack pointer
6227         R2:     reserved for system use
6228         R3-R4:  parameter passing and return values
6229         R5-R10: parameter passing
6230         R13:    small data area pointer
6231         R30:    GOT pointer
6232         R31:    frame pointer
6233
6234         (U-Boot also uses R12 as internal GOT pointer. r12
6235         is a volatile register so r12 needs to be reset when
6236         going back and forth between asm and C)
6237
6238     ==> U-Boot will use R2 to hold a pointer to the global data
6239
6240     Note: on PPC, we could use a static initializer (since the
6241     address of the global data structure is known at compile time),
6242     but it turned out that reserving a register results in somewhat
6243     smaller code - although the code savings are not that big (on
6244     average for all boards 752 bytes for the whole U-Boot image,
6245     624 text + 127 data).
6246
6247 On Blackfin, the normal C ABI (except for P3) is followed as documented here:
6248         http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6249
6250     ==> U-Boot will use P3 to hold a pointer to the global data
6251
6252 On ARM, the following registers are used:
6253
6254         R0:     function argument word/integer result
6255         R1-R3:  function argument word
6256         R9:     platform specific
6257         R10:    stack limit (used only if stack checking is enabled)
6258         R11:    argument (frame) pointer
6259         R12:    temporary workspace
6260         R13:    stack pointer
6261         R14:    link register
6262         R15:    program counter
6263
6264     ==> U-Boot will use R9 to hold a pointer to the global data
6265
6266     Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6267
6268 On Nios II, the ABI is documented here:
6269         http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6270
6271     ==> U-Boot will use gp to hold a pointer to the global data
6272
6273     Note: on Nios II, we give "-G0" option to gcc and don't use gp
6274     to access small data sections, so gp is free.
6275
6276 On NDS32, the following registers are used:
6277
6278         R0-R1:  argument/return
6279         R2-R5:  argument
6280         R15:    temporary register for assembler
6281         R16:    trampoline register
6282         R28:    frame pointer (FP)
6283         R29:    global pointer (GP)
6284         R30:    link register (LP)
6285         R31:    stack pointer (SP)
6286         PC:     program counter (PC)
6287
6288     ==> U-Boot will use R10 to hold a pointer to the global data
6289
6290 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6291 or current versions of GCC may "optimize" the code too much.
6292
6293 Memory Management:
6294 ------------------
6295
6296 U-Boot runs in system state and uses physical addresses, i.e. the
6297 MMU is not used either for address mapping nor for memory protection.
6298
6299 The available memory is mapped to fixed addresses using the memory
6300 controller. In this process, a contiguous block is formed for each
6301 memory type (Flash, SDRAM, SRAM), even when it consists of several
6302 physical memory banks.
6303
6304 U-Boot is installed in the first 128 kB of the first Flash bank (on
6305 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6306 booting and sizing and initializing DRAM, the code relocates itself
6307 to the upper end of DRAM. Immediately below the U-Boot code some
6308 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6309 configuration setting]. Below that, a structure with global Board
6310 Info data is placed, followed by the stack (growing downward).
6311
6312 Additionally, some exception handler code is copied to the low 8 kB
6313 of DRAM (0x00000000 ... 0x00001FFF).
6314
6315 So a typical memory configuration with 16 MB of DRAM could look like
6316 this:
6317
6318         0x0000 0000     Exception Vector code
6319               :
6320         0x0000 1FFF
6321         0x0000 2000     Free for Application Use
6322               :
6323               :
6324
6325               :
6326               :
6327         0x00FB FF20     Monitor Stack (Growing downward)
6328         0x00FB FFAC     Board Info Data and permanent copy of global data
6329         0x00FC 0000     Malloc Arena
6330               :
6331         0x00FD FFFF
6332         0x00FE 0000     RAM Copy of Monitor Code
6333         ...             eventually: LCD or video framebuffer
6334         ...             eventually: pRAM (Protected RAM - unchanged by reset)
6335         0x00FF FFFF     [End of RAM]
6336
6337
6338 System Initialization:
6339 ----------------------
6340
6341 In the reset configuration, U-Boot starts at the reset entry point
6342 (on most PowerPC systems at address 0x00000100). Because of the reset
6343 configuration for CS0# this is a mirror of the onboard Flash memory.
6344 To be able to re-map memory U-Boot then jumps to its link address.
6345 To be able to implement the initialization code in C, a (small!)
6346 initial stack is set up in the internal Dual Ported RAM (in case CPUs
6347 which provide such a feature like MPC8xx or MPC8260), or in a locked
6348 part of the data cache. After that, U-Boot initializes the CPU core,
6349 the caches and the SIU.
6350
6351 Next, all (potentially) available memory banks are mapped using a
6352 preliminary mapping. For example, we put them on 512 MB boundaries
6353 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6354 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6355 programmed for SDRAM access. Using the temporary configuration, a
6356 simple memory test is run that determines the size of the SDRAM
6357 banks.
6358
6359 When there is more than one SDRAM bank, and the banks are of
6360 different size, the largest is mapped first. For equal size, the first
6361 bank (CS2#) is mapped first. The first mapping is always for address
6362 0x00000000, with any additional banks following immediately to create
6363 contiguous memory starting from 0.
6364
6365 Then, the monitor installs itself at the upper end of the SDRAM area
6366 and allocates memory for use by malloc() and for the global Board
6367 Info data; also, the exception vector code is copied to the low RAM
6368 pages, and the final stack is set up.
6369
6370 Only after this relocation will you have a "normal" C environment;
6371 until that you are restricted in several ways, mostly because you are
6372 running from ROM, and because the code will have to be relocated to a
6373 new address in RAM.
6374
6375
6376 U-Boot Porting Guide:
6377 ----------------------
6378
6379 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6380 list, October 2002]
6381
6382
6383 int main(int argc, char *argv[])
6384 {
6385         sighandler_t no_more_time;
6386
6387         signal(SIGALRM, no_more_time);
6388         alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6389
6390         if (available_money > available_manpower) {
6391                 Pay consultant to port U-Boot;
6392                 return 0;
6393         }
6394
6395         Download latest U-Boot source;
6396
6397         Subscribe to u-boot mailing list;
6398
6399         if (clueless)
6400                 email("Hi, I am new to U-Boot, how do I get started?");
6401
6402         while (learning) {
6403                 Read the README file in the top level directory;
6404                 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6405                 Read applicable doc/*.README;
6406                 Read the source, Luke;
6407                 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
6408         }
6409
6410         if (available_money > toLocalCurrency ($2500))
6411                 Buy a BDI3000;
6412         else
6413                 Add a lot of aggravation and time;
6414
6415         if (a similar board exists) {   /* hopefully... */
6416                 cp -a board/<similar> board/<myboard>
6417                 cp include/configs/<similar>.h include/configs/<myboard>.h
6418         } else {
6419                 Create your own board support subdirectory;
6420                 Create your own board include/configs/<myboard>.h file;
6421         }
6422         Edit new board/<myboard> files
6423         Edit new include/configs/<myboard>.h
6424
6425         while (!accepted) {
6426                 while (!running) {
6427                         do {
6428                                 Add / modify source code;
6429                         } until (compiles);
6430                         Debug;
6431                         if (clueless)
6432                                 email("Hi, I am having problems...");
6433                 }
6434                 Send patch file to the U-Boot email list;
6435                 if (reasonable critiques)
6436                         Incorporate improvements from email list code review;
6437                 else
6438                         Defend code as written;
6439         }
6440
6441         return 0;
6442 }
6443
6444 void no_more_time (int sig)
6445 {
6446       hire_a_guru();
6447 }
6448
6449
6450 Coding Standards:
6451 -----------------
6452
6453 All contributions to U-Boot should conform to the Linux kernel
6454 coding style; see the file "Documentation/CodingStyle" and the script
6455 "scripts/Lindent" in your Linux kernel source directory.
6456
6457 Source files originating from a different project (for example the
6458 MTD subsystem) are generally exempt from these guidelines and are not
6459 reformated to ease subsequent migration to newer versions of those
6460 sources.
6461
6462 Please note that U-Boot is implemented in C (and to some small parts in
6463 Assembler); no C++ is used, so please do not use C++ style comments (//)
6464 in your code.
6465
6466 Please also stick to the following formatting rules:
6467 - remove any trailing white space
6468 - use TAB characters for indentation and vertical alignment, not spaces
6469 - make sure NOT to use DOS '\r\n' line feeds
6470 - do not add more than 2 consecutive empty lines to source files
6471 - do not add trailing empty lines to source files
6472
6473 Submissions which do not conform to the standards may be returned
6474 with a request to reformat the changes.
6475
6476
6477 Submitting Patches:
6478 -------------------
6479
6480 Since the number of patches for U-Boot is growing, we need to
6481 establish some rules. Submissions which do not conform to these rules
6482 may be rejected, even when they contain important and valuable stuff.
6483
6484 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
6485
6486 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6487 see http://lists.denx.de/mailman/listinfo/u-boot
6488
6489 When you send a patch, please include the following information with
6490 it:
6491
6492 * For bug fixes: a description of the bug and how your patch fixes
6493   this bug. Please try to include a way of demonstrating that the
6494   patch actually fixes something.
6495
6496 * For new features: a description of the feature and your
6497   implementation.
6498
6499 * A CHANGELOG entry as plaintext (separate from the patch)
6500
6501 * For major contributions, your entry to the CREDITS file
6502
6503 * When you add support for a new board, don't forget to add a
6504   maintainer e-mail address to the boards.cfg file, too.
6505
6506 * If your patch adds new configuration options, don't forget to
6507   document these in the README file.
6508
6509 * The patch itself. If you are using git (which is *strongly*
6510   recommended) you can easily generate the patch using the
6511   "git format-patch". If you then use "git send-email" to send it to
6512   the U-Boot mailing list, you will avoid most of the common problems
6513   with some other mail clients.
6514
6515   If you cannot use git, use "diff -purN OLD NEW". If your version of
6516   diff does not support these options, then get the latest version of
6517   GNU diff.
6518
6519   The current directory when running this command shall be the parent
6520   directory of the U-Boot source tree (i. e. please make sure that
6521   your patch includes sufficient directory information for the
6522   affected files).
6523
6524   We prefer patches as plain text. MIME attachments are discouraged,
6525   and compressed attachments must not be used.
6526
6527 * If one logical set of modifications affects or creates several
6528   files, all these changes shall be submitted in a SINGLE patch file.
6529
6530 * Changesets that contain different, unrelated modifications shall be
6531   submitted as SEPARATE patches, one patch per changeset.
6532
6533
6534 Notes:
6535
6536 * Before sending the patch, run the MAKEALL script on your patched
6537   source tree and make sure that no errors or warnings are reported
6538   for any of the boards.
6539
6540 * Keep your modifications to the necessary minimum: A patch
6541   containing several unrelated changes or arbitrary reformats will be
6542   returned with a request to re-formatting / split it.
6543
6544 * If you modify existing code, make sure that your new code does not
6545   add to the memory footprint of the code ;-) Small is beautiful!
6546   When adding new features, these should compile conditionally only
6547   (using #ifdef), and the resulting code with the new feature
6548   disabled must not need more memory than the old code without your
6549   modification.
6550
6551 * Remember that there is a size limit of 100 kB per message on the
6552   u-boot mailing list. Bigger patches will be moderated. If they are
6553   reasonable and not too big, they will be acknowledged. But patches
6554   bigger than the size limit should be avoided.