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