buildman: Permit branch names with an embedded '/'
[karo-tx-uboot.git] / README
1 #
2 # (C) Copyright 2000 - 2013
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 #
5 # SPDX-License-Identifier:      GPL-2.0+
6 #
7
8 Summary:
9 ========
10
11 This directory contains the source code for U-Boot, a boot loader for
12 Embedded boards based on PowerPC, ARM, MIPS and several other
13 processors, which can be installed in a boot ROM and used to
14 initialize and test the hardware or to download and run application
15 code.
16
17 The development of U-Boot is closely related to Linux: some parts of
18 the source code originate in the Linux source tree, we have some
19 header files in common, and special provision has been made to
20 support booting of Linux images.
21
22 Some attention has been paid to make this software easily
23 configurable and extendable. For instance, all monitor commands are
24 implemented with the same call interface, so that it's very easy to
25 add new commands. Also, instead of permanently adding rarely used
26 code (for instance hardware test utilities) to the monitor, you can
27 load and run it dynamically.
28
29
30 Status:
31 =======
32
33 In general, all boards for which a configuration option exists in the
34 Makefile have been tested to some extent and can be considered
35 "working". In fact, many of them are used in production systems.
36
37 In case of problems see the CHANGELOG and CREDITS files to find out
38 who contributed the specific port. The boards.cfg file lists board
39 maintainers.
40
41 Note: There is no CHANGELOG file in the actual U-Boot source tree;
42 it can be created dynamically from the Git log using:
43
44         make CHANGELOG
45
46
47 Where to get help:
48 ==================
49
50 In case you have questions about, problems with or contributions for
51 U-Boot you should send a message to the U-Boot mailing list at
52 <u-boot@lists.denx.de>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's.
54 Please see http://lists.denx.de/pipermail/u-boot and
55 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56
57
58 Where to get source code:
59 =========================
60
61 The U-Boot source code is maintained in the git repository at
62 git://www.denx.de/git/u-boot.git ; you can browse it online at
63 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65 The "snapshot" links on this page allow you to download tarballs of
66 any version you might be interested in. Official releases are also
67 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68 directory.
69
70 Pre-built (and tested) images are available from
71 ftp://ftp.denx.de/pub/u-boot/images/
72
73
74 Where we come from:
75 ===================
76
77 - start from 8xxrom sources
78 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79 - clean up code
80 - make it easier to add custom boards
81 - make it possible to add other [PowerPC] CPUs
82 - extend functions, especially:
83   * Provide extended interface to Linux boot loader
84   * S-Record download
85   * network boot
86   * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87 - create ARMBoot project (http://sourceforge.net/projects/armboot)
88 - add other CPU families (starting with ARM)
89 - create U-Boot project (http://sourceforge.net/projects/u-boot)
90 - current project page: see http://www.denx.de/wiki/U-Boot
91
92
93 Names and Spelling:
94 ===================
95
96 The "official" name of this project is "Das U-Boot". The spelling
97 "U-Boot" shall be used in all written text (documentation, comments
98 in source files etc.). Example:
99
100         This is the README file for the U-Boot project.
101
102 File names etc. shall be based on the string "u-boot". Examples:
103
104         include/asm-ppc/u-boot.h
105
106         #include <asm/u-boot.h>
107
108 Variable names, preprocessor constants etc. shall be either based on
109 the string "u_boot" or on "U_BOOT". Example:
110
111         U_BOOT_VERSION          u_boot_logo
112         IH_OS_U_BOOT            u_boot_hush_start
113
114
115 Versioning:
116 ===========
117
118 Starting with the release in October 2008, the names of the releases
119 were changed from numerical release numbers without deeper meaning
120 into a time stamp based numbering. Regular releases are identified by
121 names consisting of the calendar year and month of the release date.
122 Additional fields (if present) indicate release candidates or bug fix
123 releases in "stable" maintenance trees.
124
125 Examples:
126         U-Boot v2009.11     - Release November 2009
127         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128         U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
129
130
131 Directory Hierarchy:
132 ====================
133
134 /arch                   Architecture specific files
135   /arc                  Files generic to ARC architecture
136     /cpu                CPU specific files
137       /arc700           Files specific to ARC 700 CPUs
138     /lib                Architecture specific library files
139   /arm                  Files generic to ARM architecture
140     /cpu                CPU specific files
141       /arm720t          Files specific to ARM 720 CPUs
142       /arm920t          Files specific to ARM 920 CPUs
143         /at91           Files specific to Atmel AT91RM9200 CPU
144         /imx            Files specific to Freescale MC9328 i.MX CPUs
145         /s3c24x0        Files specific to Samsung S3C24X0 CPUs
146       /arm926ejs        Files specific to ARM 926 CPUs
147       /arm1136          Files specific to ARM 1136 CPUs
148       /pxa              Files specific to Intel XScale PXA CPUs
149       /sa1100           Files specific to Intel StrongARM SA1100 CPUs
150     /lib                Architecture specific library files
151   /avr32                Files generic to AVR32 architecture
152     /cpu                CPU specific files
153     /lib                Architecture specific library files
154   /blackfin             Files generic to Analog Devices Blackfin architecture
155     /cpu                CPU specific files
156     /lib                Architecture specific library files
157   /m68k                 Files generic to m68k architecture
158     /cpu                CPU specific files
159       /mcf52x2          Files specific to Freescale ColdFire MCF52x2 CPUs
160       /mcf5227x         Files specific to Freescale ColdFire MCF5227x CPUs
161       /mcf532x          Files specific to Freescale ColdFire MCF5329 CPUs
162       /mcf5445x         Files specific to Freescale ColdFire MCF5445x CPUs
163       /mcf547x_8x       Files specific to Freescale ColdFire MCF547x_8x CPUs
164     /lib                Architecture specific library files
165   /microblaze           Files generic to microblaze architecture
166     /cpu                CPU specific files
167     /lib                Architecture specific library files
168   /mips                 Files generic to MIPS architecture
169     /cpu                CPU specific files
170       /mips32           Files specific to MIPS32 CPUs
171       /mips64           Files specific to MIPS64 CPUs
172     /lib                Architecture specific library files
173   /nds32                Files generic to NDS32 architecture
174     /cpu                CPU specific files
175       /n1213            Files specific to Andes Technology N1213 CPUs
176     /lib                Architecture specific library files
177   /nios2                Files generic to Altera NIOS2 architecture
178     /cpu                CPU specific files
179     /lib                Architecture specific library files
180   /openrisc             Files generic to OpenRISC architecture
181     /cpu                CPU specific files
182     /lib                Architecture specific library files
183   /powerpc              Files generic to PowerPC architecture
184     /cpu                CPU specific files
185       /74xx_7xx         Files specific to Freescale MPC74xx and 7xx CPUs
186       /mpc5xx           Files specific to Freescale MPC5xx CPUs
187       /mpc5xxx          Files specific to Freescale MPC5xxx CPUs
188       /mpc8xx           Files specific to Freescale MPC8xx CPUs
189       /mpc824x          Files specific to Freescale MPC824x CPUs
190       /mpc8260          Files specific to Freescale MPC8260 CPUs
191       /mpc85xx          Files specific to Freescale MPC85xx CPUs
192       /ppc4xx           Files specific to AMCC PowerPC 4xx CPUs
193     /lib                Architecture specific library files
194   /sh                   Files generic to SH architecture
195     /cpu                CPU specific files
196       /sh2              Files specific to sh2 CPUs
197       /sh3              Files specific to sh3 CPUs
198       /sh4              Files specific to sh4 CPUs
199     /lib                Architecture specific library files
200   /sparc                Files generic to SPARC architecture
201     /cpu                CPU specific files
202       /leon2            Files specific to Gaisler LEON2 SPARC CPU
203       /leon3            Files specific to Gaisler LEON3 SPARC CPU
204     /lib                Architecture specific library files
205   /x86                  Files generic to x86 architecture
206     /cpu                CPU specific files
207     /lib                Architecture specific library files
208 /api                    Machine/arch independent API for external apps
209 /board                  Board dependent files
210 /common                 Misc architecture independent functions
211 /disk                   Code for disk drive partition handling
212 /doc                    Documentation (don't expect too much)
213 /drivers                Commonly used device drivers
214 /dts                    Contains Makefile for building internal U-Boot fdt.
215 /examples               Example code for standalone applications, etc.
216 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
217 /include                Header Files
218 /lib                    Files generic to all architectures
219   /libfdt               Library files to support flattened device trees
220   /lzma                 Library files to support LZMA decompression
221   /lzo                  Library files to support LZO decompression
222 /net                    Networking code
223 /post                   Power On Self Test
224 /spl                    Secondary Program Loader framework
225 /tools                  Tools to build S-Record or U-Boot images, etc.
226
227 Software Configuration:
228 =======================
229
230 Configuration is usually done using C preprocessor defines; the
231 rationale behind that is to avoid dead code whenever possible.
232
233 There are two classes of configuration variables:
234
235 * Configuration _OPTIONS_:
236   These are selectable by the user and have names beginning with
237   "CONFIG_".
238
239 * Configuration _SETTINGS_:
240   These depend on the hardware etc. and should not be meddled with if
241   you don't know what you're doing; they have names beginning with
242   "CONFIG_SYS_".
243
244 Later we will add a configuration tool - probably similar to or even
245 identical to what's used for the Linux kernel. Right now, we have to
246 do the configuration by hand, which means creating some symbolic
247 links and editing some configuration files. We use the TQM8xxL boards
248 as an example here.
249
250
251 Selection of Processor Architecture and Board Type:
252 ---------------------------------------------------
253
254 For all supported boards there are ready-to-use default
255 configurations available; just type "make <board_name>_defconfig".
256
257 Example: For a TQM823L module type:
258
259         cd u-boot
260         make TQM823L_defconfig
261
262 For the Cogent platform, you need to specify the CPU type as well;
263 e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
264 directory according to the instructions in cogent/README.
265
266
267 Sandbox Environment:
268 --------------------
269
270 U-Boot can be built natively to run on a Linux host using the 'sandbox'
271 board. This allows feature development which is not board- or architecture-
272 specific to be undertaken on a native platform. The sandbox is also used to
273 run some of U-Boot's tests.
274
275 See board/sandbox/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_BOOTI        * ARM64 Linux kernel Image support
963                 CONFIG_CMD_CACHE        * icache, dcache
964                 CONFIG_CMD_CLK          * clock command support
965                 CONFIG_CMD_CONSOLE        coninfo
966                 CONFIG_CMD_CRC32        * crc32
967                 CONFIG_CMD_DATE         * support for RTC, date/time...
968                 CONFIG_CMD_DHCP         * DHCP support
969                 CONFIG_CMD_DIAG         * Diagnostics
970                 CONFIG_CMD_DS4510       * ds4510 I2C gpio commands
971                 CONFIG_CMD_DS4510_INFO  * ds4510 I2C info command
972                 CONFIG_CMD_DS4510_MEM   * ds4510 I2C eeprom/sram commansd
973                 CONFIG_CMD_DS4510_RST   * ds4510 I2C rst command
974                 CONFIG_CMD_DTT          * Digital Therm and Thermostat
975                 CONFIG_CMD_ECHO           echo arguments
976                 CONFIG_CMD_EDITENV        edit env variable
977                 CONFIG_CMD_EEPROM       * EEPROM read/write support
978                 CONFIG_CMD_ELF          * bootelf, bootvx
979                 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
980                 CONFIG_CMD_ENV_FLAGS    * display details about env flags
981                 CONFIG_CMD_ENV_EXISTS   * check existence of env variable
982                 CONFIG_CMD_EXPORTENV    * export the environment
983                 CONFIG_CMD_EXT2         * ext2 command support
984                 CONFIG_CMD_EXT4         * ext4 command support
985                 CONFIG_CMD_FS_GENERIC   * filesystem commands (e.g. load, ls)
986                                           that work for multiple fs types
987                 CONFIG_CMD_SAVEENV        saveenv
988                 CONFIG_CMD_FDC          * Floppy Disk Support
989                 CONFIG_CMD_FAT          * FAT command support
990                 CONFIG_CMD_FLASH          flinfo, erase, protect
991                 CONFIG_CMD_FPGA           FPGA device initialization support
992                 CONFIG_CMD_FUSE         * Device fuse support
993                 CONFIG_CMD_GETTIME      * Get time since boot
994                 CONFIG_CMD_GO           * the 'go' command (exec code)
995                 CONFIG_CMD_GREPENV      * search environment
996                 CONFIG_CMD_HASH         * calculate hash / digest
997                 CONFIG_CMD_HWFLOW       * RTS/CTS hw flow control
998                 CONFIG_CMD_I2C          * I2C serial bus support
999                 CONFIG_CMD_IDE          * IDE harddisk support
1000                 CONFIG_CMD_IMI            iminfo
1001                 CONFIG_CMD_IMLS           List all images found in NOR flash
1002                 CONFIG_CMD_IMLS_NAND    * List all images found in NAND flash
1003                 CONFIG_CMD_IMMAP        * IMMR dump support
1004                 CONFIG_CMD_IOTRACE      * I/O tracing for debugging
1005                 CONFIG_CMD_IMPORTENV    * import an environment
1006                 CONFIG_CMD_INI          * import data from an ini file into the env
1007                 CONFIG_CMD_IRQ          * irqinfo
1008                 CONFIG_CMD_ITEST          Integer/string test of 2 values
1009                 CONFIG_CMD_JFFS2        * JFFS2 Support
1010                 CONFIG_CMD_KGDB         * kgdb
1011                 CONFIG_CMD_LDRINFO      * ldrinfo (display Blackfin loader)
1012                 CONFIG_CMD_LINK_LOCAL   * link-local IP address auto-configuration
1013                                           (169.254.*.*)
1014                 CONFIG_CMD_LOADB          loadb
1015                 CONFIG_CMD_LOADS          loads
1016                 CONFIG_CMD_MD5SUM       * print md5 message digest
1017                                           (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
1018                 CONFIG_CMD_MEMINFO      * Display detailed memory information
1019                 CONFIG_CMD_MEMORY         md, mm, nm, mw, cp, cmp, crc, base,
1020                                           loop, loopw
1021                 CONFIG_CMD_MEMTEST      * mtest
1022                 CONFIG_CMD_MISC           Misc functions like sleep etc
1023                 CONFIG_CMD_MMC          * MMC memory mapped support
1024                 CONFIG_CMD_MII          * MII utility commands
1025                 CONFIG_CMD_MTDPARTS     * MTD partition support
1026                 CONFIG_CMD_NAND         * NAND support
1027                 CONFIG_CMD_NET            bootp, tftpboot, rarpboot
1028                 CONFIG_CMD_NFS            NFS support
1029                 CONFIG_CMD_PCA953X      * PCA953x I2C gpio commands
1030                 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1031                 CONFIG_CMD_PCI          * pciinfo
1032                 CONFIG_CMD_PCMCIA               * PCMCIA support
1033                 CONFIG_CMD_PING         * send ICMP ECHO_REQUEST to network
1034                                           host
1035                 CONFIG_CMD_PORTIO       * Port I/O
1036                 CONFIG_CMD_READ         * Read raw data from partition
1037                 CONFIG_CMD_REGINFO      * Register dump
1038                 CONFIG_CMD_RUN            run command in env variable
1039                 CONFIG_CMD_SANDBOX      * sb command to access sandbox features
1040                 CONFIG_CMD_SAVES        * save S record dump
1041                 CONFIG_CMD_SCSI         * SCSI Support
1042                 CONFIG_CMD_SDRAM        * print SDRAM configuration information
1043                                           (requires CONFIG_CMD_I2C)
1044                 CONFIG_CMD_SETGETDCR      Support for DCR Register access
1045                                           (4xx only)
1046                 CONFIG_CMD_SF           * Read/write/erase SPI NOR flash
1047                 CONFIG_CMD_SHA1SUM      * print sha1 memory digest
1048                                           (requires CONFIG_CMD_MEMORY)
1049                 CONFIG_CMD_SOFTSWITCH   * Soft switch setting command for BF60x
1050                 CONFIG_CMD_SOURCE         "source" command Support
1051                 CONFIG_CMD_SPI          * SPI serial bus support
1052                 CONFIG_CMD_TFTPSRV      * TFTP transfer in server mode
1053                 CONFIG_CMD_TFTPPUT      * TFTP put command (upload)
1054                 CONFIG_CMD_TIME         * run command and report execution time (ARM specific)
1055                 CONFIG_CMD_TIMER        * access to the system tick timer
1056                 CONFIG_CMD_USB          * USB support
1057                 CONFIG_CMD_CDP          * Cisco Discover Protocol support
1058                 CONFIG_CMD_MFSL         * Microblaze FSL support
1059                 CONFIG_CMD_XIMG           Load part of Multi Image
1060                 CONFIG_CMD_UUID         * Generate random UUID or GUID string
1061
1062                 EXAMPLE: If you want all functions except of network
1063                 support you can write:
1064
1065                 #include "config_cmd_all.h"
1066                 #undef CONFIG_CMD_NET
1067
1068         Other Commands:
1069                 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1070
1071         Note:   Don't enable the "icache" and "dcache" commands
1072                 (configuration option CONFIG_CMD_CACHE) unless you know
1073                 what you (and your U-Boot users) are doing. Data
1074                 cache cannot be enabled on systems like the 8xx or
1075                 8260 (where accesses to the IMMR region must be
1076                 uncached), and it cannot be disabled on all other
1077                 systems where we (mis-) use the data cache to hold an
1078                 initial stack and some data.
1079
1080
1081                 XXX - this list needs to get updated!
1082
1083 - Regular expression support:
1084                 CONFIG_REGEX
1085                 If this variable is defined, U-Boot is linked against
1086                 the SLRE (Super Light Regular Expression) library,
1087                 which adds regex support to some commands, as for
1088                 example "env grep" and "setexpr".
1089
1090 - Device tree:
1091                 CONFIG_OF_CONTROL
1092                 If this variable is defined, U-Boot will use a device tree
1093                 to configure its devices, instead of relying on statically
1094                 compiled #defines in the board file. This option is
1095                 experimental and only available on a few boards. The device
1096                 tree is available in the global data as gd->fdt_blob.
1097
1098                 U-Boot needs to get its device tree from somewhere. This can
1099                 be done using one of the two options below:
1100
1101                 CONFIG_OF_EMBED
1102                 If this variable is defined, U-Boot will embed a device tree
1103                 binary in its image. This device tree file should be in the
1104                 board directory and called <soc>-<board>.dts. The binary file
1105                 is then picked up in board_init_f() and made available through
1106                 the global data structure as gd->blob.
1107
1108                 CONFIG_OF_SEPARATE
1109                 If this variable is defined, U-Boot will build a device tree
1110                 binary. It will be called u-boot.dtb. Architecture-specific
1111                 code will locate it at run-time. Generally this works by:
1112
1113                         cat u-boot.bin u-boot.dtb >image.bin
1114
1115                 and in fact, U-Boot does this for you, creating a file called
1116                 u-boot-dtb.bin which is useful in the common case. You can
1117                 still use the individual files if you need something more
1118                 exotic.
1119
1120 - Watchdog:
1121                 CONFIG_WATCHDOG
1122                 If this variable is defined, it enables watchdog
1123                 support for the SoC. There must be support in the SoC
1124                 specific code for a watchdog. For the 8xx and 8260
1125                 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1126                 register.  When supported for a specific SoC is
1127                 available, then no further board specific code should
1128                 be needed to use it.
1129
1130                 CONFIG_HW_WATCHDOG
1131                 When using a watchdog circuitry external to the used
1132                 SoC, then define this variable and provide board
1133                 specific code for the "hw_watchdog_reset" function.
1134
1135 - U-Boot Version:
1136                 CONFIG_VERSION_VARIABLE
1137                 If this variable is defined, an environment variable
1138                 named "ver" is created by U-Boot showing the U-Boot
1139                 version as printed by the "version" command.
1140                 Any change to this variable will be reverted at the
1141                 next reset.
1142
1143 - Real-Time Clock:
1144
1145                 When CONFIG_CMD_DATE is selected, the type of the RTC
1146                 has to be selected, too. Define exactly one of the
1147                 following options:
1148
1149                 CONFIG_RTC_MPC8xx       - use internal RTC of MPC8xx
1150                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
1151                 CONFIG_RTC_MC13XXX      - use MC13783 or MC13892 RTC
1152                 CONFIG_RTC_MC146818     - use MC146818 RTC
1153                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
1154                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
1155                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
1156                 CONFIG_RTC_DS1339       - use Maxim, Inc. DS1339 RTC
1157                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
1158                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
1159                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
1160                 CONFIG_SYS_RTC_DS1337_NOOSC     - Turn off the OSC output for DS1337
1161                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
1162                                           RV3029 RTC.
1163
1164                 Note that if the RTC uses I2C, then the I2C interface
1165                 must also be configured. See I2C Support, below.
1166
1167 - GPIO Support:
1168                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
1169
1170                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1171                 chip-ngpio pairs that tell the PCA953X driver the number of
1172                 pins supported by a particular chip.
1173
1174                 Note that if the GPIO device uses I2C, then the I2C interface
1175                 must also be configured. See I2C Support, below.
1176
1177 - I/O tracing:
1178                 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1179                 accesses and can checksum them or write a list of them out
1180                 to memory. See the 'iotrace' command for details. This is
1181                 useful for testing device drivers since it can confirm that
1182                 the driver behaves the same way before and after a code
1183                 change. Currently this is supported on sandbox and arm. To
1184                 add support for your architecture, add '#include <iotrace.h>'
1185                 to the bottom of arch/<arch>/include/asm/io.h and test.
1186
1187                 Example output from the 'iotrace stats' command is below.
1188                 Note that if the trace buffer is exhausted, the checksum will
1189                 still continue to operate.
1190
1191                         iotrace is enabled
1192                         Start:  10000000        (buffer start address)
1193                         Size:   00010000        (buffer size)
1194                         Offset: 00000120        (current buffer offset)
1195                         Output: 10000120        (start + offset)
1196                         Count:  00000018        (number of trace records)
1197                         CRC32:  9526fb66        (CRC32 of all trace records)
1198
1199 - Timestamp Support:
1200
1201                 When CONFIG_TIMESTAMP is selected, the timestamp
1202                 (date and time) of an image is printed by image
1203                 commands like bootm or iminfo. This option is
1204                 automatically enabled when you select CONFIG_CMD_DATE .
1205
1206 - Partition Labels (disklabels) Supported:
1207                 Zero or more of the following:
1208                 CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1209                 CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1210                                        Intel architecture, USB sticks, etc.
1211                 CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1212                 CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1213                                        bootloader.  Note 2TB partition limit; see
1214                                        disk/part_efi.c
1215                 CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1216
1217                 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1218                 CONFIG_CMD_SCSI) you must configure support for at
1219                 least one non-MTD partition type as well.
1220
1221 - IDE Reset method:
1222                 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1223                 board configurations files but used nowhere!
1224
1225                 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1226                 be performed by calling the function
1227                         ide_set_reset(int reset)
1228                 which has to be defined in a board specific file
1229
1230 - ATAPI Support:
1231                 CONFIG_ATAPI
1232
1233                 Set this to enable ATAPI support.
1234
1235 - LBA48 Support
1236                 CONFIG_LBA48
1237
1238                 Set this to enable support for disks larger than 137GB
1239                 Also look at CONFIG_SYS_64BIT_LBA.
1240                 Whithout these , LBA48 support uses 32bit variables and will 'only'
1241                 support disks up to 2.1TB.
1242
1243                 CONFIG_SYS_64BIT_LBA:
1244                         When enabled, makes the IDE subsystem use 64bit sector addresses.
1245                         Default is 32bit.
1246
1247 - SCSI Support:
1248                 At the moment only there is only support for the
1249                 SYM53C8XX SCSI controller; define
1250                 CONFIG_SCSI_SYM53C8XX to enable it.
1251
1252                 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1253                 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1254                 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1255                 maximum numbers of LUNs, SCSI ID's and target
1256                 devices.
1257                 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1258
1259                 The environment variable 'scsidevs' is set to the number of
1260                 SCSI devices found during the last scan.
1261
1262 - NETWORK Support (PCI):
1263                 CONFIG_E1000
1264                 Support for Intel 8254x/8257x gigabit chips.
1265
1266                 CONFIG_E1000_SPI
1267                 Utility code for direct access to the SPI bus on Intel 8257x.
1268                 This does not do anything useful unless you set at least one
1269                 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1270
1271                 CONFIG_E1000_SPI_GENERIC
1272                 Allow generic access to the SPI bus on the Intel 8257x, for
1273                 example with the "sspi" command.
1274
1275                 CONFIG_CMD_E1000
1276                 Management command for E1000 devices.  When used on devices
1277                 with SPI support you can reprogram the EEPROM from U-Boot.
1278
1279                 CONFIG_E1000_FALLBACK_MAC
1280                 default MAC for empty EEPROM after production.
1281
1282                 CONFIG_EEPRO100
1283                 Support for Intel 82557/82559/82559ER chips.
1284                 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1285                 write routine for first time initialisation.
1286
1287                 CONFIG_TULIP
1288                 Support for Digital 2114x chips.
1289                 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1290                 modem chip initialisation (KS8761/QS6611).
1291
1292                 CONFIG_NATSEMI
1293                 Support for National dp83815 chips.
1294
1295                 CONFIG_NS8382X
1296                 Support for National dp8382[01] gigabit chips.
1297
1298 - NETWORK Support (other):
1299
1300                 CONFIG_DRIVER_AT91EMAC
1301                 Support for AT91RM9200 EMAC.
1302
1303                         CONFIG_RMII
1304                         Define this to use reduced MII inteface
1305
1306                         CONFIG_DRIVER_AT91EMAC_QUIET
1307                         If this defined, the driver is quiet.
1308                         The driver doen't show link status messages.
1309
1310                 CONFIG_CALXEDA_XGMAC
1311                 Support for the Calxeda XGMAC device
1312
1313                 CONFIG_LAN91C96
1314                 Support for SMSC's LAN91C96 chips.
1315
1316                         CONFIG_LAN91C96_BASE
1317                         Define this to hold the physical address
1318                         of the LAN91C96's I/O space
1319
1320                         CONFIG_LAN91C96_USE_32_BIT
1321                         Define this to enable 32 bit addressing
1322
1323                 CONFIG_SMC91111
1324                 Support for SMSC's LAN91C111 chip
1325
1326                         CONFIG_SMC91111_BASE
1327                         Define this to hold the physical address
1328                         of the device (I/O space)
1329
1330                         CONFIG_SMC_USE_32_BIT
1331                         Define this if data bus is 32 bits
1332
1333                         CONFIG_SMC_USE_IOFUNCS
1334                         Define this to use i/o functions instead of macros
1335                         (some hardware wont work with macros)
1336
1337                 CONFIG_DRIVER_TI_EMAC
1338                 Support for davinci emac
1339
1340                         CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1341                         Define this if you have more then 3 PHYs.
1342
1343                 CONFIG_FTGMAC100
1344                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1345
1346                         CONFIG_FTGMAC100_EGIGA
1347                         Define this to use GE link update with gigabit PHY.
1348                         Define this if FTGMAC100 is connected to gigabit PHY.
1349                         If your system has 10/100 PHY only, it might not occur
1350                         wrong behavior. Because PHY usually return timeout or
1351                         useless data when polling gigabit status and gigabit
1352                         control registers. This behavior won't affect the
1353                         correctnessof 10/100 link speed update.
1354
1355                 CONFIG_SMC911X
1356                 Support for SMSC's LAN911x and LAN921x chips
1357
1358                         CONFIG_SMC911X_BASE
1359                         Define this to hold the physical address
1360                         of the device (I/O space)
1361
1362                         CONFIG_SMC911X_32_BIT
1363                         Define this if data bus is 32 bits
1364
1365                         CONFIG_SMC911X_16_BIT
1366                         Define this if data bus is 16 bits. If your processor
1367                         automatically converts one 32 bit word to two 16 bit
1368                         words you may also try CONFIG_SMC911X_32_BIT.
1369
1370                 CONFIG_SH_ETHER
1371                 Support for Renesas on-chip Ethernet controller
1372
1373                         CONFIG_SH_ETHER_USE_PORT
1374                         Define the number of ports to be used
1375
1376                         CONFIG_SH_ETHER_PHY_ADDR
1377                         Define the ETH PHY's address
1378
1379                         CONFIG_SH_ETHER_CACHE_WRITEBACK
1380                         If this option is set, the driver enables cache flush.
1381
1382 - PWM Support:
1383                 CONFIG_PWM_IMX
1384                 Support for PWM modul on the imx6.
1385
1386 - TPM Support:
1387                 CONFIG_TPM
1388                 Support TPM devices.
1389
1390                 CONFIG_TPM_TIS_I2C
1391                 Support for i2c bus TPM devices. Only one device
1392                 per system is supported at this time.
1393
1394                         CONFIG_TPM_TIS_I2C_BUS_NUMBER
1395                         Define the the i2c bus number for the TPM device
1396
1397                         CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1398                         Define the TPM's address on the i2c bus
1399
1400                         CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1401                         Define the burst count bytes upper limit
1402
1403                 CONFIG_TPM_ATMEL_TWI
1404                 Support for Atmel TWI TPM device. Requires I2C support.
1405
1406                 CONFIG_TPM_TIS_LPC
1407                 Support for generic parallel port TPM devices. Only one device
1408                 per system is supported at this time.
1409
1410                         CONFIG_TPM_TIS_BASE_ADDRESS
1411                         Base address where the generic TPM device is mapped
1412                         to. Contemporary x86 systems usually map it at
1413                         0xfed40000.
1414
1415                 CONFIG_CMD_TPM
1416                 Add tpm monitor functions.
1417                 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1418                 provides monitor access to authorized functions.
1419
1420                 CONFIG_TPM
1421                 Define this to enable the TPM support library which provides
1422                 functional interfaces to some TPM commands.
1423                 Requires support for a TPM device.
1424
1425                 CONFIG_TPM_AUTH_SESSIONS
1426                 Define this to enable authorized functions in the TPM library.
1427                 Requires CONFIG_TPM and CONFIG_SHA1.
1428
1429 - USB Support:
1430                 At the moment only the UHCI host controller is
1431                 supported (PIP405, MIP405, MPC5200); define
1432                 CONFIG_USB_UHCI to enable it.
1433                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1434                 and define CONFIG_USB_STORAGE to enable the USB
1435                 storage devices.
1436                 Note:
1437                 Supported are USB Keyboards and USB Floppy drives
1438                 (TEAC FD-05PUB).
1439                 MPC5200 USB requires additional defines:
1440                         CONFIG_USB_CLOCK
1441                                 for 528 MHz Clock: 0x0001bbbb
1442                         CONFIG_PSC3_USB
1443                                 for USB on PSC3
1444                         CONFIG_USB_CONFIG
1445                                 for differential drivers: 0x00001000
1446                                 for single ended drivers: 0x00005000
1447                                 for differential drivers on PSC3: 0x00000100
1448                                 for single ended drivers on PSC3: 0x00004100
1449                         CONFIG_SYS_USB_EVENT_POLL
1450                                 May be defined to allow interrupt polling
1451                                 instead of using asynchronous interrupts
1452
1453                 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1454                 txfilltuning field in the EHCI controller on reset.
1455
1456 - USB Device:
1457                 Define the below if you wish to use the USB console.
1458                 Once firmware is rebuilt from a serial console issue the
1459                 command "setenv stdin usbtty; setenv stdout usbtty" and
1460                 attach your USB cable. The Unix command "dmesg" should print
1461                 it has found a new device. The environment variable usbtty
1462                 can be set to gserial or cdc_acm to enable your device to
1463                 appear to a USB host as a Linux gserial device or a
1464                 Common Device Class Abstract Control Model serial device.
1465                 If you select usbtty = gserial you should be able to enumerate
1466                 a Linux host by
1467                 # modprobe usbserial vendor=0xVendorID product=0xProductID
1468                 else if using cdc_acm, simply setting the environment
1469                 variable usbtty to be cdc_acm should suffice. The following
1470                 might be defined in YourBoardName.h
1471
1472                         CONFIG_USB_DEVICE
1473                         Define this to build a UDC device
1474
1475                         CONFIG_USB_TTY
1476                         Define this to have a tty type of device available to
1477                         talk to the UDC device
1478
1479                         CONFIG_USBD_HS
1480                         Define this to enable the high speed support for usb
1481                         device and usbtty. If this feature is enabled, a routine
1482                         int is_usbd_high_speed(void)
1483                         also needs to be defined by the driver to dynamically poll
1484                         whether the enumeration has succeded at high speed or full
1485                         speed.
1486
1487                         CONFIG_SYS_CONSOLE_IS_IN_ENV
1488                         Define this if you want stdin, stdout &/or stderr to
1489                         be set to usbtty.
1490
1491                         mpc8xx:
1492                                 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1493                                 Derive USB clock from external clock "blah"
1494                                 - CONFIG_SYS_USB_EXTC_CLK 0x02
1495
1496                                 CONFIG_SYS_USB_BRG_CLK 0xBLAH
1497                                 Derive USB clock from brgclk
1498                                 - CONFIG_SYS_USB_BRG_CLK 0x04
1499
1500                 If you have a USB-IF assigned VendorID then you may wish to
1501                 define your own vendor specific values either in BoardName.h
1502                 or directly in usbd_vendor_info.h. If you don't define
1503                 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1504                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1505                 should pretend to be a Linux device to it's target host.
1506
1507                         CONFIG_USBD_MANUFACTURER
1508                         Define this string as the name of your company for
1509                         - CONFIG_USBD_MANUFACTURER "my company"
1510
1511                         CONFIG_USBD_PRODUCT_NAME
1512                         Define this string as the name of your product
1513                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1514
1515                         CONFIG_USBD_VENDORID
1516                         Define this as your assigned Vendor ID from the USB
1517                         Implementors Forum. This *must* be a genuine Vendor ID
1518                         to avoid polluting the USB namespace.
1519                         - CONFIG_USBD_VENDORID 0xFFFF
1520
1521                         CONFIG_USBD_PRODUCTID
1522                         Define this as the unique Product ID
1523                         for your device
1524                         - CONFIG_USBD_PRODUCTID 0xFFFF
1525
1526 - ULPI Layer Support:
1527                 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1528                 the generic ULPI layer. The generic layer accesses the ULPI PHY
1529                 via the platform viewport, so you need both the genric layer and
1530                 the viewport enabled. Currently only Chipidea/ARC based
1531                 viewport is supported.
1532                 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1533                 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1534                 If your ULPI phy needs a different reference clock than the
1535                 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1536                 the appropriate value in Hz.
1537
1538 - MMC Support:
1539                 The MMC controller on the Intel PXA is supported. To
1540                 enable this define CONFIG_MMC. The MMC can be
1541                 accessed from the boot prompt by mapping the device
1542                 to physical memory similar to flash. Command line is
1543                 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1544                 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1545
1546                 CONFIG_SH_MMCIF
1547                 Support for Renesas on-chip MMCIF controller
1548
1549                         CONFIG_SH_MMCIF_ADDR
1550                         Define the base address of MMCIF registers
1551
1552                         CONFIG_SH_MMCIF_CLK
1553                         Define the clock frequency for MMCIF
1554
1555                 CONFIG_GENERIC_MMC
1556                 Enable the generic MMC driver
1557
1558                 CONFIG_SUPPORT_EMMC_BOOT
1559                 Enable some additional features of the eMMC boot partitions.
1560
1561                 CONFIG_SUPPORT_EMMC_RPMB
1562                 Enable the commands for reading, writing and programming the
1563                 key for the Replay Protection Memory Block partition in eMMC.
1564
1565 - USB Device Firmware Update (DFU) class support:
1566                 CONFIG_DFU_FUNCTION
1567                 This enables the USB portion of the DFU USB class
1568
1569                 CONFIG_CMD_DFU
1570                 This enables the command "dfu" which is used to have
1571                 U-Boot create a DFU class device via USB.  This command
1572                 requires that the "dfu_alt_info" environment variable be
1573                 set and define the alt settings to expose to the host.
1574
1575                 CONFIG_DFU_MMC
1576                 This enables support for exposing (e)MMC devices via DFU.
1577
1578                 CONFIG_DFU_NAND
1579                 This enables support for exposing NAND devices via DFU.
1580
1581                 CONFIG_DFU_RAM
1582                 This enables support for exposing RAM via DFU.
1583                 Note: DFU spec refer to non-volatile memory usage, but
1584                 allow usages beyond the scope of spec - here RAM usage,
1585                 one that would help mostly the developer.
1586
1587                 CONFIG_SYS_DFU_DATA_BUF_SIZE
1588                 Dfu transfer uses a buffer before writing data to the
1589                 raw storage device. Make the size (in bytes) of this buffer
1590                 configurable. The size of this buffer is also configurable
1591                 through the "dfu_bufsiz" environment variable.
1592
1593                 CONFIG_SYS_DFU_MAX_FILE_SIZE
1594                 When updating files rather than the raw storage device,
1595                 we use a static buffer to copy the file into and then write
1596                 the buffer once we've been given the whole file.  Define
1597                 this to the maximum filesize (in bytes) for the buffer.
1598                 Default is 4 MiB if undefined.
1599
1600                 DFU_DEFAULT_POLL_TIMEOUT
1601                 Poll timeout [ms], is the timeout a device can send to the
1602                 host. The host must wait for this timeout before sending
1603                 a subsequent DFU_GET_STATUS request to the device.
1604
1605                 DFU_MANIFEST_POLL_TIMEOUT
1606                 Poll timeout [ms], which the device sends to the host when
1607                 entering dfuMANIFEST state. Host waits this timeout, before
1608                 sending again an USB request to the device.
1609
1610 - USB Device Android Fastboot support:
1611                 CONFIG_CMD_FASTBOOT
1612                 This enables the command "fastboot" which enables the Android
1613                 fastboot mode for the platform's USB device. Fastboot is a USB
1614                 protocol for downloading images, flashing and device control
1615                 used on Android devices.
1616                 See doc/README.android-fastboot for more information.
1617
1618                 CONFIG_ANDROID_BOOT_IMAGE
1619                 This enables support for booting images which use the Android
1620                 image format header.
1621
1622                 CONFIG_USB_FASTBOOT_BUF_ADDR
1623                 The fastboot protocol requires a large memory buffer for
1624                 downloads. Define this to the starting RAM address to use for
1625                 downloaded images.
1626
1627                 CONFIG_USB_FASTBOOT_BUF_SIZE
1628                 The fastboot protocol requires a large memory buffer for
1629                 downloads. This buffer should be as large as possible for a
1630                 platform. Define this to the size available RAM for fastboot.
1631
1632 - Journaling Flash filesystem support:
1633                 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1634                 CONFIG_JFFS2_NAND_DEV
1635                 Define these for a default partition on a NAND device
1636
1637                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1638                 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1639                 Define these for a default partition on a NOR device
1640
1641                 CONFIG_SYS_JFFS_CUSTOM_PART
1642                 Define this to create an own partition. You have to provide a
1643                 function struct part_info* jffs2_part_info(int part_num)
1644
1645                 If you define only one JFFS2 partition you may also want to
1646                 #define CONFIG_SYS_JFFS_SINGLE_PART     1
1647                 to disable the command chpart. This is the default when you
1648                 have not defined a custom partition
1649
1650 - FAT(File Allocation Table) filesystem write function support:
1651                 CONFIG_FAT_WRITE
1652
1653                 Define this to enable support for saving memory data as a
1654                 file in FAT formatted partition.
1655
1656                 This will also enable the command "fatwrite" enabling the
1657                 user to write files to FAT.
1658
1659 CBFS (Coreboot Filesystem) support
1660                 CONFIG_CMD_CBFS
1661
1662                 Define this to enable support for reading from a Coreboot
1663                 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1664                 and cbfsload.
1665
1666 - FAT(File Allocation Table) filesystem cluster size:
1667                 CONFIG_FS_FAT_MAX_CLUSTSIZE
1668
1669                 Define the max cluster size for fat operations else
1670                 a default value of 65536 will be defined.
1671
1672 - Keyboard Support:
1673                 CONFIG_ISA_KEYBOARD
1674
1675                 Define this to enable standard (PC-Style) keyboard
1676                 support
1677
1678                 CONFIG_I8042_KBD
1679                 Standard PC keyboard driver with US (is default) and
1680                 GERMAN key layout (switch via environment 'keymap=de') support.
1681                 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1682                 for cfb_console. Supports cursor blinking.
1683
1684                 CONFIG_CROS_EC_KEYB
1685                 Enables a Chrome OS keyboard using the CROS_EC interface.
1686                 This uses CROS_EC to communicate with a second microcontroller
1687                 which provides key scans on request.
1688
1689 - Video support:
1690                 CONFIG_VIDEO
1691
1692                 Define this to enable video support (for output to
1693                 video).
1694
1695                 CONFIG_VIDEO_CT69000
1696
1697                 Enable Chips & Technologies 69000 Video chip
1698
1699                 CONFIG_VIDEO_SMI_LYNXEM
1700                 Enable Silicon Motion SMI 712/710/810 Video chip. The
1701                 video output is selected via environment 'videoout'
1702                 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1703                 assumed.
1704
1705                 For the CT69000 and SMI_LYNXEM drivers, videomode is
1706                 selected via environment 'videomode'. Two different ways
1707                 are possible:
1708                 - "videomode=num"   'num' is a standard LiLo mode numbers.
1709                 Following standard modes are supported  (* is default):
1710
1711                       Colors    640x480 800x600 1024x768 1152x864 1280x1024
1712                 -------------+---------------------------------------------
1713                       8 bits |  0x301*  0x303    0x305    0x161     0x307
1714                      15 bits |  0x310   0x313    0x316    0x162     0x319
1715                      16 bits |  0x311   0x314    0x317    0x163     0x31A
1716                      24 bits |  0x312   0x315    0x318      ?       0x31B
1717                 -------------+---------------------------------------------
1718                 (i.e. setenv videomode 317; saveenv; reset;)
1719
1720                 - "videomode=bootargs" all the video parameters are parsed
1721                 from the bootargs. (See drivers/video/videomodes.c)
1722
1723
1724                 CONFIG_VIDEO_SED13806
1725                 Enable Epson SED13806 driver. This driver supports 8bpp
1726                 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1727                 or CONFIG_VIDEO_SED13806_16BPP
1728
1729                 CONFIG_FSL_DIU_FB
1730                 Enable the Freescale DIU video driver.  Reference boards for
1731                 SOCs that have a DIU should define this macro to enable DIU
1732                 support, and should also define these other macros:
1733
1734                         CONFIG_SYS_DIU_ADDR
1735                         CONFIG_VIDEO
1736                         CONFIG_CMD_BMP
1737                         CONFIG_CFB_CONSOLE
1738                         CONFIG_VIDEO_SW_CURSOR
1739                         CONFIG_VGA_AS_SINGLE_DEVICE
1740                         CONFIG_VIDEO_LOGO
1741                         CONFIG_VIDEO_BMP_LOGO
1742
1743                 The DIU driver will look for the 'video-mode' environment
1744                 variable, and if defined, enable the DIU as a console during
1745                 boot.  See the documentation file README.video for a
1746                 description of this variable.
1747
1748                 CONFIG_VIDEO_VGA
1749
1750                 Enable the VGA video / BIOS for x86. The alternative if you
1751                 are using coreboot is to use the coreboot frame buffer
1752                 driver.
1753
1754
1755 - Keyboard Support:
1756                 CONFIG_KEYBOARD
1757
1758                 Define this to enable a custom keyboard support.
1759                 This simply calls drv_keyboard_init() which must be
1760                 defined in your board-specific files.
1761                 The only board using this so far is RBC823.
1762
1763 - LCD Support:  CONFIG_LCD
1764
1765                 Define this to enable LCD support (for output to LCD
1766                 display); also select one of the supported displays
1767                 by defining one of these:
1768
1769                 CONFIG_ATMEL_LCD:
1770
1771                         HITACHI TX09D70VM1CCA, 3.5", 240x320.
1772
1773                 CONFIG_NEC_NL6448AC33:
1774
1775                         NEC NL6448AC33-18. Active, color, single scan.
1776
1777                 CONFIG_NEC_NL6448BC20
1778
1779                         NEC NL6448BC20-08. 6.5", 640x480.
1780                         Active, color, single scan.
1781
1782                 CONFIG_NEC_NL6448BC33_54
1783
1784                         NEC NL6448BC33-54. 10.4", 640x480.
1785                         Active, color, single scan.
1786
1787                 CONFIG_SHARP_16x9
1788
1789                         Sharp 320x240. Active, color, single scan.
1790                         It isn't 16x9, and I am not sure what it is.
1791
1792                 CONFIG_SHARP_LQ64D341
1793
1794                         Sharp LQ64D341 display, 640x480.
1795                         Active, color, single scan.
1796
1797                 CONFIG_HLD1045
1798
1799                         HLD1045 display, 640x480.
1800                         Active, color, single scan.
1801
1802                 CONFIG_OPTREX_BW
1803
1804                         Optrex   CBL50840-2 NF-FW 99 22 M5
1805                         or
1806                         Hitachi  LMG6912RPFC-00T
1807                         or
1808                         Hitachi  SP14Q002
1809
1810                         320x240. Black & white.
1811
1812                 Normally display is black on white background; define
1813                 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1814
1815                 CONFIG_LCD_ALIGNMENT
1816
1817                 Normally the LCD is page-aligned (tyically 4KB). If this is
1818                 defined then the LCD will be aligned to this value instead.
1819                 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1820                 here, since it is cheaper to change data cache settings on
1821                 a per-section basis.
1822
1823                 CONFIG_CONSOLE_SCROLL_LINES
1824
1825                 When the console need to be scrolled, this is the number of
1826                 lines to scroll by. It defaults to 1. Increasing this makes
1827                 the console jump but can help speed up operation when scrolling
1828                 is slow.
1829
1830                 CONFIG_LCD_BMP_RLE8
1831
1832                 Support drawing of RLE8-compressed bitmaps on the LCD.
1833
1834                 CONFIG_I2C_EDID
1835
1836                 Enables an 'i2c edid' command which can read EDID
1837                 information over I2C from an attached LCD display.
1838
1839 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1840
1841                 If this option is set, the environment is checked for
1842                 a variable "splashimage". If found, the usual display
1843                 of logo, copyright and system information on the LCD
1844                 is suppressed and the BMP image at the address
1845                 specified in "splashimage" is loaded instead. The
1846                 console is redirected to the "nulldev", too. This
1847                 allows for a "silent" boot where a splash screen is
1848                 loaded very quickly after power-on.
1849
1850                 CONFIG_SPLASHIMAGE_GUARD
1851
1852                 If this option is set, then U-Boot will prevent the environment
1853                 variable "splashimage" from being set to a problematic address
1854                 (see README.displaying-bmps).
1855                 This option is useful for targets where, due to alignment
1856                 restrictions, an improperly aligned BMP image will cause a data
1857                 abort. If you think you will not have problems with unaligned
1858                 accesses (for example because your toolchain prevents them)
1859                 there is no need to set this option.
1860
1861                 CONFIG_SPLASH_SCREEN_ALIGN
1862
1863                 If this option is set the splash image can be freely positioned
1864                 on the screen. Environment variable "splashpos" specifies the
1865                 position as "x,y". If a positive number is given it is used as
1866                 number of pixel from left/top. If a negative number is given it
1867                 is used as number of pixel from right/bottom. You can also
1868                 specify 'm' for centering the image.
1869
1870                 Example:
1871                 setenv splashpos m,m
1872                         => image at center of screen
1873
1874                 setenv splashpos 30,20
1875                         => image at x = 30 and y = 20
1876
1877                 setenv splashpos -10,m
1878                         => vertically centered image
1879                            at x = dspWidth - bmpWidth - 9
1880
1881 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1882
1883                 If this option is set, additionally to standard BMP
1884                 images, gzipped BMP images can be displayed via the
1885                 splashscreen support or the bmp command.
1886
1887 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1888
1889                 If this option is set, 8-bit RLE compressed BMP images
1890                 can be displayed via the splashscreen support or the
1891                 bmp command.
1892
1893 - Do compresssing for memory range:
1894                 CONFIG_CMD_ZIP
1895
1896                 If this option is set, it would use zlib deflate method
1897                 to compress the specified memory at its best effort.
1898
1899 - Compression support:
1900                 CONFIG_GZIP
1901
1902                 Enabled by default to support gzip compressed images.
1903
1904                 CONFIG_BZIP2
1905
1906                 If this option is set, support for bzip2 compressed
1907                 images is included. If not, only uncompressed and gzip
1908                 compressed images are supported.
1909
1910                 NOTE: the bzip2 algorithm requires a lot of RAM, so
1911                 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1912                 be at least 4MB.
1913
1914                 CONFIG_LZMA
1915
1916                 If this option is set, support for lzma compressed
1917                 images is included.
1918
1919                 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1920                 requires an amount of dynamic memory that is given by the
1921                 formula:
1922
1923                         (1846 + 768 << (lc + lp)) * sizeof(uint16)
1924
1925                 Where lc and lp stand for, respectively, Literal context bits
1926                 and Literal pos bits.
1927
1928                 This value is upper-bounded by 14MB in the worst case. Anyway,
1929                 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1930                 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1931                 a very small buffer.
1932
1933                 Use the lzmainfo tool to determinate the lc and lp values and
1934                 then calculate the amount of needed dynamic memory (ensuring
1935                 the appropriate CONFIG_SYS_MALLOC_LEN value).
1936
1937                 CONFIG_LZO
1938
1939                 If this option is set, support for LZO compressed images
1940                 is included.
1941
1942 - MII/PHY support:
1943                 CONFIG_PHY_ADDR
1944
1945                 The address of PHY on MII bus.
1946
1947                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1948
1949                 The clock frequency of the MII bus
1950
1951                 CONFIG_PHY_GIGE
1952
1953                 If this option is set, support for speed/duplex
1954                 detection of gigabit PHY is included.
1955
1956                 CONFIG_PHY_RESET_DELAY
1957
1958                 Some PHY like Intel LXT971A need extra delay after
1959                 reset before any MII register access is possible.
1960                 For such PHY, set this option to the usec delay
1961                 required. (minimum 300usec for LXT971A)
1962
1963                 CONFIG_PHY_CMD_DELAY (ppc4xx)
1964
1965                 Some PHY like Intel LXT971A need extra delay after
1966                 command issued before MII status register can be read
1967
1968 - Ethernet address:
1969                 CONFIG_ETHADDR
1970                 CONFIG_ETH1ADDR
1971                 CONFIG_ETH2ADDR
1972                 CONFIG_ETH3ADDR
1973                 CONFIG_ETH4ADDR
1974                 CONFIG_ETH5ADDR
1975
1976                 Define a default value for Ethernet address to use
1977                 for the respective Ethernet interface, in case this
1978                 is not determined automatically.
1979
1980 - IP address:
1981                 CONFIG_IPADDR
1982
1983                 Define a default value for the IP address to use for
1984                 the default Ethernet interface, in case this is not
1985                 determined through e.g. bootp.
1986                 (Environment variable "ipaddr")
1987
1988 - Server IP address:
1989                 CONFIG_SERVERIP
1990
1991                 Defines a default value for the IP address of a TFTP
1992                 server to contact when using the "tftboot" command.
1993                 (Environment variable "serverip")
1994
1995                 CONFIG_KEEP_SERVERADDR
1996
1997                 Keeps the server's MAC address, in the env 'serveraddr'
1998                 for passing to bootargs (like Linux's netconsole option)
1999
2000 - Gateway IP address:
2001                 CONFIG_GATEWAYIP
2002
2003                 Defines a default value for the IP address of the
2004                 default router where packets to other networks are
2005                 sent to.
2006                 (Environment variable "gatewayip")
2007
2008 - Subnet mask:
2009                 CONFIG_NETMASK
2010
2011                 Defines a default value for the subnet mask (or
2012                 routing prefix) which is used to determine if an IP
2013                 address belongs to the local subnet or needs to be
2014                 forwarded through a router.
2015                 (Environment variable "netmask")
2016
2017 - Multicast TFTP Mode:
2018                 CONFIG_MCAST_TFTP
2019
2020                 Defines whether you want to support multicast TFTP as per
2021                 rfc-2090; for example to work with atftp.  Lets lots of targets
2022                 tftp down the same boot image concurrently.  Note: the Ethernet
2023                 driver in use must provide a function: mcast() to join/leave a
2024                 multicast group.
2025
2026 - BOOTP Recovery Mode:
2027                 CONFIG_BOOTP_RANDOM_DELAY
2028
2029                 If you have many targets in a network that try to
2030                 boot using BOOTP, you may want to avoid that all
2031                 systems send out BOOTP requests at precisely the same
2032                 moment (which would happen for instance at recovery
2033                 from a power failure, when all systems will try to
2034                 boot, thus flooding the BOOTP server. Defining
2035                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2036                 inserted before sending out BOOTP requests. The
2037                 following delays are inserted then:
2038
2039                 1st BOOTP request:      delay 0 ... 1 sec
2040                 2nd BOOTP request:      delay 0 ... 2 sec
2041                 3rd BOOTP request:      delay 0 ... 4 sec
2042                 4th and following
2043                 BOOTP requests:         delay 0 ... 8 sec
2044
2045                 CONFIG_BOOTP_ID_CACHE_SIZE
2046
2047                 BOOTP packets are uniquely identified using a 32-bit ID. The
2048                 server will copy the ID from client requests to responses and
2049                 U-Boot will use this to determine if it is the destination of
2050                 an incoming response. Some servers will check that addresses
2051                 aren't in use before handing them out (usually using an ARP
2052                 ping) and therefore take up to a few hundred milliseconds to
2053                 respond. Network congestion may also influence the time it
2054                 takes for a response to make it back to the client. If that
2055                 time is too long, U-Boot will retransmit requests. In order
2056                 to allow earlier responses to still be accepted after these
2057                 retransmissions, U-Boot's BOOTP client keeps a small cache of
2058                 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2059                 cache. The default is to keep IDs for up to four outstanding
2060                 requests. Increasing this will allow U-Boot to accept offers
2061                 from a BOOTP client in networks with unusually high latency.
2062
2063 - DHCP Advanced Options:
2064                 You can fine tune the DHCP functionality by defining
2065                 CONFIG_BOOTP_* symbols:
2066
2067                 CONFIG_BOOTP_SUBNETMASK
2068                 CONFIG_BOOTP_GATEWAY
2069                 CONFIG_BOOTP_HOSTNAME
2070                 CONFIG_BOOTP_NISDOMAIN
2071                 CONFIG_BOOTP_BOOTPATH
2072                 CONFIG_BOOTP_BOOTFILESIZE
2073                 CONFIG_BOOTP_DNS
2074                 CONFIG_BOOTP_DNS2
2075                 CONFIG_BOOTP_SEND_HOSTNAME
2076                 CONFIG_BOOTP_NTPSERVER
2077                 CONFIG_BOOTP_TIMEOFFSET
2078                 CONFIG_BOOTP_VENDOREX
2079                 CONFIG_BOOTP_MAY_FAIL
2080
2081                 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2082                 environment variable, not the BOOTP server.
2083
2084                 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2085                 after the configured retry count, the call will fail
2086                 instead of starting over.  This can be used to fail over
2087                 to Link-local IP address configuration if the DHCP server
2088                 is not available.
2089
2090                 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2091                 serverip from a DHCP server, it is possible that more
2092                 than one DNS serverip is offered to the client.
2093                 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2094                 serverip will be stored in the additional environment
2095                 variable "dnsip2". The first DNS serverip is always
2096                 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
2097                 is defined.
2098
2099                 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2100                 to do a dynamic update of a DNS server. To do this, they
2101                 need the hostname of the DHCP requester.
2102                 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
2103                 of the "hostname" environment variable is passed as
2104                 option 12 to the DHCP server.
2105
2106                 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2107
2108                 A 32bit value in microseconds for a delay between
2109                 receiving a "DHCP Offer" and sending the "DHCP Request".
2110                 This fixes a problem with certain DHCP servers that don't
2111                 respond 100% of the time to a "DHCP request". E.g. On an
2112                 AT91RM9200 processor running at 180MHz, this delay needed
2113                 to be *at least* 15,000 usec before a Windows Server 2003
2114                 DHCP server would reply 100% of the time. I recommend at
2115                 least 50,000 usec to be safe. The alternative is to hope
2116                 that one of the retries will be successful but note that
2117                 the DHCP timeout and retry process takes a longer than
2118                 this delay.
2119
2120  - Link-local IP address negotiation:
2121                 Negotiate with other link-local clients on the local network
2122                 for an address that doesn't require explicit configuration.
2123                 This is especially useful if a DHCP server cannot be guaranteed
2124                 to exist in all environments that the device must operate.
2125
2126                 See doc/README.link-local for more information.
2127
2128  - CDP Options:
2129                 CONFIG_CDP_DEVICE_ID
2130
2131                 The device id used in CDP trigger frames.
2132
2133                 CONFIG_CDP_DEVICE_ID_PREFIX
2134
2135                 A two character string which is prefixed to the MAC address
2136                 of the device.
2137
2138                 CONFIG_CDP_PORT_ID
2139
2140                 A printf format string which contains the ascii name of
2141                 the port. Normally is set to "eth%d" which sets
2142                 eth0 for the first Ethernet, eth1 for the second etc.
2143
2144                 CONFIG_CDP_CAPABILITIES
2145
2146                 A 32bit integer which indicates the device capabilities;
2147                 0x00000010 for a normal host which does not forwards.
2148
2149                 CONFIG_CDP_VERSION
2150
2151                 An ascii string containing the version of the software.
2152
2153                 CONFIG_CDP_PLATFORM
2154
2155                 An ascii string containing the name of the platform.
2156
2157                 CONFIG_CDP_TRIGGER
2158
2159                 A 32bit integer sent on the trigger.
2160
2161                 CONFIG_CDP_POWER_CONSUMPTION
2162
2163                 A 16bit integer containing the power consumption of the
2164                 device in .1 of milliwatts.
2165
2166                 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2167
2168                 A byte containing the id of the VLAN.
2169
2170 - Status LED:   CONFIG_STATUS_LED
2171
2172                 Several configurations allow to display the current
2173                 status using a LED. For instance, the LED will blink
2174                 fast while running U-Boot code, stop blinking as
2175                 soon as a reply to a BOOTP request was received, and
2176                 start blinking slow once the Linux kernel is running
2177                 (supported by a status LED driver in the Linux
2178                 kernel). Defining CONFIG_STATUS_LED enables this
2179                 feature in U-Boot.
2180
2181                 Additional options:
2182
2183                 CONFIG_GPIO_LED
2184                 The status LED can be connected to a GPIO pin.
2185                 In such cases, the gpio_led driver can be used as a
2186                 status LED backend implementation. Define CONFIG_GPIO_LED
2187                 to include the gpio_led driver in the U-Boot binary.
2188
2189                 CONFIG_GPIO_LED_INVERTED_TABLE
2190                 Some GPIO connected LEDs may have inverted polarity in which
2191                 case the GPIO high value corresponds to LED off state and
2192                 GPIO low value corresponds to LED on state.
2193                 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2194                 with a list of GPIO LEDs that have inverted polarity.
2195
2196 - CAN Support:  CONFIG_CAN_DRIVER
2197
2198                 Defining CONFIG_CAN_DRIVER enables CAN driver support
2199                 on those systems that support this (optional)
2200                 feature, like the TQM8xxL modules.
2201
2202 - I2C Support:  CONFIG_SYS_I2C
2203
2204                 This enable the NEW i2c subsystem, and will allow you to use
2205                 i2c commands at the u-boot command line (as long as you set
2206                 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2207                 based realtime clock chips or other i2c devices. See
2208                 common/cmd_i2c.c for a description of the command line
2209                 interface.
2210
2211                 ported i2c driver to the new framework:
2212                 - drivers/i2c/soft_i2c.c:
2213                   - activate first bus with CONFIG_SYS_I2C_SOFT define
2214                     CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2215                     for defining speed and slave address
2216                   - activate second bus with I2C_SOFT_DECLARATIONS2 define
2217                     CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2218                     for defining speed and slave address
2219                   - activate third bus with I2C_SOFT_DECLARATIONS3 define
2220                     CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2221                     for defining speed and slave address
2222                   - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2223                     CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2224                     for defining speed and slave address
2225
2226                 - drivers/i2c/fsl_i2c.c:
2227                   - activate i2c driver with CONFIG_SYS_I2C_FSL
2228                     define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2229                     offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2230                     CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2231                     bus.
2232                   - If your board supports a second fsl i2c bus, define
2233                     CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2234                     CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2235                     CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2236                     second bus.
2237
2238                 - drivers/i2c/tegra_i2c.c:
2239                   - activate this driver with CONFIG_SYS_I2C_TEGRA
2240                   - This driver adds 4 i2c buses with a fix speed from
2241                     100000 and the slave addr 0!
2242
2243                 - drivers/i2c/ppc4xx_i2c.c
2244                   - activate this driver with CONFIG_SYS_I2C_PPC4XX
2245                   - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2246                   - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2247
2248                 - drivers/i2c/i2c_mxc.c
2249                   - activate this driver with CONFIG_SYS_I2C_MXC
2250                   - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2251                   - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2252                   - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2253                   - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2254                   - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2255                   - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2256                 If thoses defines are not set, default value is 100000
2257                 for speed, and 0 for slave.
2258
2259                 - drivers/i2c/rcar_i2c.c:
2260                   - activate this driver with CONFIG_SYS_I2C_RCAR
2261                   - This driver adds 4 i2c buses
2262
2263                   - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2264                   - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2265                   - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2266                   - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2267                   - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2268                   - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2269                   - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2270                   - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2271                   - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2272
2273                 - drivers/i2c/sh_i2c.c:
2274                   - activate this driver with CONFIG_SYS_I2C_SH
2275                   - This driver adds from 2 to 5 i2c buses
2276
2277                   - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2278                   - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2279                   - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2280                   - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2281                   - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2282                   - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2283                   - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2284                   - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2285                   - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2286                   - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2287                   - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2288                   - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2289                   - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2290
2291                 - drivers/i2c/omap24xx_i2c.c
2292                   - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2293                   - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2294                   - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2295                   - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2296                   - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2297                   - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2298                   - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2299                   - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2300                   - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2301                   - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2302                   - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2303
2304                 - drivers/i2c/zynq_i2c.c
2305                   - activate this driver with CONFIG_SYS_I2C_ZYNQ
2306                   - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2307                   - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2308
2309                 - drivers/i2c/s3c24x0_i2c.c:
2310                   - activate this driver with CONFIG_SYS_I2C_S3C24X0
2311                   - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2312                     9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2313                     with a fix speed from 100000 and the slave addr 0!
2314
2315                 - drivers/i2c/ihs_i2c.c
2316                   - activate this driver with CONFIG_SYS_I2C_IHS
2317                   - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2318                   - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2319                   - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2320                   - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2321                   - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2322                   - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2323                   - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2324                   - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2325                   - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2326                   - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2327                   - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2328                   - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2329
2330                 additional defines:
2331
2332                 CONFIG_SYS_NUM_I2C_BUSES
2333                 Hold the number of i2c busses you want to use. If you
2334                 don't use/have i2c muxes on your i2c bus, this
2335                 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2336                 omit this define.
2337
2338                 CONFIG_SYS_I2C_DIRECT_BUS
2339                 define this, if you don't use i2c muxes on your hardware.
2340                 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2341                 omit this define.
2342
2343                 CONFIG_SYS_I2C_MAX_HOPS
2344                 define how many muxes are maximal consecutively connected
2345                 on one i2c bus. If you not use i2c muxes, omit this
2346                 define.
2347
2348                 CONFIG_SYS_I2C_BUSES
2349                 hold a list of busses you want to use, only used if
2350                 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2351                 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2352                 CONFIG_SYS_NUM_I2C_BUSES = 9:
2353
2354                  CONFIG_SYS_I2C_BUSES   {{0, {I2C_NULL_HOP}}, \
2355                                         {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2356                                         {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2357                                         {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2358                                         {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2359                                         {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2360                                         {1, {I2C_NULL_HOP}}, \
2361                                         {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2362                                         {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2363                                         }
2364
2365                 which defines
2366                         bus 0 on adapter 0 without a mux
2367                         bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2368                         bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2369                         bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2370                         bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2371                         bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2372                         bus 6 on adapter 1 without a mux
2373                         bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2374                         bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2375
2376                 If you do not have i2c muxes on your board, omit this define.
2377
2378 - Legacy I2C Support:   CONFIG_HARD_I2C
2379
2380                 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2381                 provides the following compelling advantages:
2382
2383                 - more than one i2c adapter is usable
2384                 - approved multibus support
2385                 - better i2c mux support
2386
2387                 ** Please consider updating your I2C driver now. **
2388
2389                 These enable legacy I2C serial bus commands. Defining
2390                 CONFIG_HARD_I2C will include the appropriate I2C driver
2391                 for the selected CPU.
2392
2393                 This will allow you to use i2c commands at the u-boot
2394                 command line (as long as you set CONFIG_CMD_I2C in
2395                 CONFIG_COMMANDS) and communicate with i2c based realtime
2396                 clock chips. See common/cmd_i2c.c for a description of the
2397                 command line interface.
2398
2399                 CONFIG_HARD_I2C selects a hardware I2C controller.
2400
2401                 There are several other quantities that must also be
2402                 defined when you define CONFIG_HARD_I2C.
2403
2404                 In both cases you will need to define CONFIG_SYS_I2C_SPEED
2405                 to be the frequency (in Hz) at which you wish your i2c bus
2406                 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2407                 the CPU's i2c node address).
2408
2409                 Now, the u-boot i2c code for the mpc8xx
2410                 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2411                 and so its address should therefore be cleared to 0 (See,
2412                 eg, MPC823e User's Manual p.16-473). So, set
2413                 CONFIG_SYS_I2C_SLAVE to 0.
2414
2415                 CONFIG_SYS_I2C_INIT_MPC5XXX
2416
2417                 When a board is reset during an i2c bus transfer
2418                 chips might think that the current transfer is still
2419                 in progress.  Reset the slave devices by sending start
2420                 commands until the slave device responds.
2421
2422                 That's all that's required for CONFIG_HARD_I2C.
2423
2424                 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2425                 then the following macros need to be defined (examples are
2426                 from include/configs/lwmon.h):
2427
2428                 I2C_INIT
2429
2430                 (Optional). Any commands necessary to enable the I2C
2431                 controller or configure ports.
2432
2433                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
2434
2435                 I2C_PORT
2436
2437                 (Only for MPC8260 CPU). The I/O port to use (the code
2438                 assumes both bits are on the same port). Valid values
2439                 are 0..3 for ports A..D.
2440
2441                 I2C_ACTIVE
2442
2443                 The code necessary to make the I2C data line active
2444                 (driven).  If the data line is open collector, this
2445                 define can be null.
2446
2447                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2448
2449                 I2C_TRISTATE
2450
2451                 The code necessary to make the I2C data line tri-stated
2452                 (inactive).  If the data line is open collector, this
2453                 define can be null.
2454
2455                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2456
2457                 I2C_READ
2458
2459                 Code that returns true if the I2C data line is high,
2460                 false if it is low.
2461
2462                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2463
2464                 I2C_SDA(bit)
2465
2466                 If <bit> is true, sets the I2C data line high. If it
2467                 is false, it clears it (low).
2468
2469                 eg: #define I2C_SDA(bit) \
2470                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2471                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
2472
2473                 I2C_SCL(bit)
2474
2475                 If <bit> is true, sets the I2C clock line high. If it
2476                 is false, it clears it (low).
2477
2478                 eg: #define I2C_SCL(bit) \
2479                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2480                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
2481
2482                 I2C_DELAY
2483
2484                 This delay is invoked four times per clock cycle so this
2485                 controls the rate of data transfer.  The data rate thus
2486                 is 1 / (I2C_DELAY * 4). Often defined to be something
2487                 like:
2488
2489                 #define I2C_DELAY  udelay(2)
2490
2491                 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2492
2493                 If your arch supports the generic GPIO framework (asm/gpio.h),
2494                 then you may alternatively define the two GPIOs that are to be
2495                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
2496                 have GPIO-based defaults assigned to them as appropriate.
2497
2498                 You should define these to the GPIO value as given directly to
2499                 the generic GPIO functions.
2500
2501                 CONFIG_SYS_I2C_INIT_BOARD
2502
2503                 When a board is reset during an i2c bus transfer
2504                 chips might think that the current transfer is still
2505                 in progress. On some boards it is possible to access
2506                 the i2c SCLK line directly, either by using the
2507                 processor pin as a GPIO or by having a second pin
2508                 connected to the bus. If this option is defined a
2509                 custom i2c_init_board() routine in boards/xxx/board.c
2510                 is run early in the boot sequence.
2511
2512                 CONFIG_SYS_I2C_BOARD_LATE_INIT
2513
2514                 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2515                 defined a custom i2c_board_late_init() routine in
2516                 boards/xxx/board.c is run AFTER the operations in i2c_init()
2517                 is completed. This callpoint can be used to unreset i2c bus
2518                 using CPU i2c controller register accesses for CPUs whose i2c
2519                 controller provide such a method. It is called at the end of
2520                 i2c_init() to allow i2c_init operations to setup the i2c bus
2521                 controller on the CPU (e.g. setting bus speed & slave address).
2522
2523                 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2524
2525                 This option enables configuration of bi_iic_fast[] flags
2526                 in u-boot bd_info structure based on u-boot environment
2527                 variable "i2cfast". (see also i2cfast)
2528
2529                 CONFIG_I2C_MULTI_BUS
2530
2531                 This option allows the use of multiple I2C buses, each of which
2532                 must have a controller.  At any point in time, only one bus is
2533                 active.  To switch to a different bus, use the 'i2c dev' command.
2534                 Note that bus numbering is zero-based.
2535
2536                 CONFIG_SYS_I2C_NOPROBES
2537
2538                 This option specifies a list of I2C devices that will be skipped
2539                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
2540                 is set, specify a list of bus-device pairs.  Otherwise, specify
2541                 a 1D array of device addresses
2542
2543                 e.g.
2544                         #undef  CONFIG_I2C_MULTI_BUS
2545                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2546
2547                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2548
2549                         #define CONFIG_I2C_MULTI_BUS
2550                         #define CONFIG_SYS_I2C_MULTI_NOPROBES   {{0,0x50},{0,0x68},{1,0x54}}
2551
2552                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2553
2554                 CONFIG_SYS_SPD_BUS_NUM
2555
2556                 If defined, then this indicates the I2C bus number for DDR SPD.
2557                 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2558
2559                 CONFIG_SYS_RTC_BUS_NUM
2560
2561                 If defined, then this indicates the I2C bus number for the RTC.
2562                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2563
2564                 CONFIG_SYS_DTT_BUS_NUM
2565
2566                 If defined, then this indicates the I2C bus number for the DTT.
2567                 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2568
2569                 CONFIG_SYS_I2C_DTT_ADDR:
2570
2571                 If defined, specifies the I2C address of the DTT device.
2572                 If not defined, then U-Boot uses predefined value for
2573                 specified DTT device.
2574
2575                 CONFIG_SOFT_I2C_READ_REPEATED_START
2576
2577                 defining this will force the i2c_read() function in
2578                 the soft_i2c driver to perform an I2C repeated start
2579                 between writing the address pointer and reading the
2580                 data.  If this define is omitted the default behaviour
2581                 of doing a stop-start sequence will be used.  Most I2C
2582                 devices can use either method, but some require one or
2583                 the other.
2584
2585 - SPI Support:  CONFIG_SPI
2586
2587                 Enables SPI driver (so far only tested with
2588                 SPI EEPROM, also an instance works with Crystal A/D and
2589                 D/As on the SACSng board)
2590
2591                 CONFIG_SH_SPI
2592
2593                 Enables the driver for SPI controller on SuperH. Currently
2594                 only SH7757 is supported.
2595
2596                 CONFIG_SPI_X
2597
2598                 Enables extended (16-bit) SPI EEPROM addressing.
2599                 (symmetrical to CONFIG_I2C_X)
2600
2601                 CONFIG_SOFT_SPI
2602
2603                 Enables a software (bit-bang) SPI driver rather than
2604                 using hardware support. This is a general purpose
2605                 driver that only requires three general I/O port pins
2606                 (two outputs, one input) to function. If this is
2607                 defined, the board configuration must define several
2608                 SPI configuration items (port pins to use, etc). For
2609                 an example, see include/configs/sacsng.h.
2610
2611                 CONFIG_HARD_SPI
2612
2613                 Enables a hardware SPI driver for general-purpose reads
2614                 and writes.  As with CONFIG_SOFT_SPI, the board configuration
2615                 must define a list of chip-select function pointers.
2616                 Currently supported on some MPC8xxx processors.  For an
2617                 example, see include/configs/mpc8349emds.h.
2618
2619                 CONFIG_MXC_SPI
2620
2621                 Enables the driver for the SPI controllers on i.MX and MXC
2622                 SoCs. Currently i.MX31/35/51 are supported.
2623
2624                 CONFIG_SYS_SPI_MXC_WAIT
2625                 Timeout for waiting until spi transfer completed.
2626                 default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2627
2628 - FPGA Support: CONFIG_FPGA
2629
2630                 Enables FPGA subsystem.
2631
2632                 CONFIG_FPGA_<vendor>
2633
2634                 Enables support for specific chip vendors.
2635                 (ALTERA, XILINX)
2636
2637                 CONFIG_FPGA_<family>
2638
2639                 Enables support for FPGA family.
2640                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2641
2642                 CONFIG_FPGA_COUNT
2643
2644                 Specify the number of FPGA devices to support.
2645
2646                 CONFIG_CMD_FPGA_LOADMK
2647
2648                 Enable support for fpga loadmk command
2649
2650                 CONFIG_CMD_FPGA_LOADP
2651
2652                 Enable support for fpga loadp command - load partial bitstream
2653
2654                 CONFIG_CMD_FPGA_LOADBP
2655
2656                 Enable support for fpga loadbp command - load partial bitstream
2657                 (Xilinx only)
2658
2659                 CONFIG_SYS_FPGA_PROG_FEEDBACK
2660
2661                 Enable printing of hash marks during FPGA configuration.
2662
2663                 CONFIG_SYS_FPGA_CHECK_BUSY
2664
2665                 Enable checks on FPGA configuration interface busy
2666                 status by the configuration function. This option
2667                 will require a board or device specific function to
2668                 be written.
2669
2670                 CONFIG_FPGA_DELAY
2671
2672                 If defined, a function that provides delays in the FPGA
2673                 configuration driver.
2674
2675                 CONFIG_SYS_FPGA_CHECK_CTRLC
2676                 Allow Control-C to interrupt FPGA configuration
2677
2678                 CONFIG_SYS_FPGA_CHECK_ERROR
2679
2680                 Check for configuration errors during FPGA bitfile
2681                 loading. For example, abort during Virtex II
2682                 configuration if the INIT_B line goes low (which
2683                 indicated a CRC error).
2684
2685                 CONFIG_SYS_FPGA_WAIT_INIT
2686
2687                 Maximum time to wait for the INIT_B line to deassert
2688                 after PROB_B has been deasserted during a Virtex II
2689                 FPGA configuration sequence. The default time is 500
2690                 ms.
2691
2692                 CONFIG_SYS_FPGA_WAIT_BUSY
2693
2694                 Maximum time to wait for BUSY to deassert during
2695                 Virtex II FPGA configuration. The default is 5 ms.
2696
2697                 CONFIG_SYS_FPGA_WAIT_CONFIG
2698
2699                 Time to wait after FPGA configuration. The default is
2700                 200 ms.
2701
2702 - Configuration Management:
2703                 CONFIG_IDENT_STRING
2704
2705                 If defined, this string will be added to the U-Boot
2706                 version information (U_BOOT_VERSION)
2707
2708 - Vendor Parameter Protection:
2709
2710                 U-Boot considers the values of the environment
2711                 variables "serial#" (Board Serial Number) and
2712                 "ethaddr" (Ethernet Address) to be parameters that
2713                 are set once by the board vendor / manufacturer, and
2714                 protects these variables from casual modification by
2715                 the user. Once set, these variables are read-only,
2716                 and write or delete attempts are rejected. You can
2717                 change this behaviour:
2718
2719                 If CONFIG_ENV_OVERWRITE is #defined in your config
2720                 file, the write protection for vendor parameters is
2721                 completely disabled. Anybody can change or delete
2722                 these parameters.
2723
2724                 Alternatively, if you #define _both_ CONFIG_ETHADDR
2725                 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2726                 Ethernet address is installed in the environment,
2727                 which can be changed exactly ONCE by the user. [The
2728                 serial# is unaffected by this, i. e. it remains
2729                 read-only.]
2730
2731                 The same can be accomplished in a more flexible way
2732                 for any variable by configuring the type of access
2733                 to allow for those variables in the ".flags" variable
2734                 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2735
2736 - Protected RAM:
2737                 CONFIG_PRAM
2738
2739                 Define this variable to enable the reservation of
2740                 "protected RAM", i. e. RAM which is not overwritten
2741                 by U-Boot. Define CONFIG_PRAM to hold the number of
2742                 kB you want to reserve for pRAM. You can overwrite
2743                 this default value by defining an environment
2744                 variable "pram" to the number of kB you want to
2745                 reserve. Note that the board info structure will
2746                 still show the full amount of RAM. If pRAM is
2747                 reserved, a new environment variable "mem" will
2748                 automatically be defined to hold the amount of
2749                 remaining RAM in a form that can be passed as boot
2750                 argument to Linux, for instance like that:
2751
2752                         setenv bootargs ... mem=\${mem}
2753                         saveenv
2754
2755                 This way you can tell Linux not to use this memory,
2756                 either, which results in a memory region that will
2757                 not be affected by reboots.
2758
2759                 *WARNING* If your board configuration uses automatic
2760                 detection of the RAM size, you must make sure that
2761                 this memory test is non-destructive. So far, the
2762                 following board configurations are known to be
2763                 "pRAM-clean":
2764
2765                         IVMS8, IVML24, SPD8xx, TQM8xxL,
2766                         HERMES, IP860, RPXlite, LWMON,
2767                         FLAGADM, TQM8260
2768
2769 - Access to physical memory region (> 4GB)
2770                 Some basic support is provided for operations on memory not
2771                 normally accessible to U-Boot - e.g. some architectures
2772                 support access to more than 4GB of memory on 32-bit
2773                 machines using physical address extension or similar.
2774                 Define CONFIG_PHYSMEM to access this basic support, which
2775                 currently only supports clearing the memory.
2776
2777 - Error Recovery:
2778                 CONFIG_PANIC_HANG
2779
2780                 Define this variable to stop the system in case of a
2781                 fatal error, so that you have to reset it manually.
2782                 This is probably NOT a good idea for an embedded
2783                 system where you want the system to reboot
2784                 automatically as fast as possible, but it may be
2785                 useful during development since you can try to debug
2786                 the conditions that lead to the situation.
2787
2788                 CONFIG_NET_RETRY_COUNT
2789
2790                 This variable defines the number of retries for
2791                 network operations like ARP, RARP, TFTP, or BOOTP
2792                 before giving up the operation. If not defined, a
2793                 default value of 5 is used.
2794
2795                 CONFIG_ARP_TIMEOUT
2796
2797                 Timeout waiting for an ARP reply in milliseconds.
2798
2799                 CONFIG_NFS_TIMEOUT
2800
2801                 Timeout in milliseconds used in NFS protocol.
2802                 If you encounter "ERROR: Cannot umount" in nfs command,
2803                 try longer timeout such as
2804                 #define CONFIG_NFS_TIMEOUT 10000UL
2805
2806 - Command Interpreter:
2807                 CONFIG_AUTO_COMPLETE
2808
2809                 Enable auto completion of commands using TAB.
2810
2811                 Note that this feature has NOT been implemented yet
2812                 for the "hush" shell.
2813
2814
2815                 CONFIG_SYS_HUSH_PARSER
2816
2817                 Define this variable to enable the "hush" shell (from
2818                 Busybox) as command line interpreter, thus enabling
2819                 powerful command line syntax like
2820                 if...then...else...fi conditionals or `&&' and '||'
2821                 constructs ("shell scripts").
2822
2823                 If undefined, you get the old, much simpler behaviour
2824                 with a somewhat smaller memory footprint.
2825
2826
2827                 CONFIG_SYS_PROMPT_HUSH_PS2
2828
2829                 This defines the secondary prompt string, which is
2830                 printed when the command interpreter needs more input
2831                 to complete a command. Usually "> ".
2832
2833         Note:
2834
2835                 In the current implementation, the local variables
2836                 space and global environment variables space are
2837                 separated. Local variables are those you define by
2838                 simply typing `name=value'. To access a local
2839                 variable later on, you have write `$name' or
2840                 `${name}'; to execute the contents of a variable
2841                 directly type `$name' at the command prompt.
2842
2843                 Global environment variables are those you use
2844                 setenv/printenv to work with. To run a command stored
2845                 in such a variable, you need to use the run command,
2846                 and you must not use the '$' sign to access them.
2847
2848                 To store commands and special characters in a
2849                 variable, please use double quotation marks
2850                 surrounding the whole text of the variable, instead
2851                 of the backslashes before semicolons and special
2852                 symbols.
2853
2854 - Commandline Editing and History:
2855                 CONFIG_CMDLINE_EDITING
2856
2857                 Enable editing and History functions for interactive
2858                 commandline input operations
2859
2860 - Default Environment:
2861                 CONFIG_EXTRA_ENV_SETTINGS
2862
2863                 Define this to contain any number of null terminated
2864                 strings (variable = value pairs) that will be part of
2865                 the default environment compiled into the boot image.
2866
2867                 For example, place something like this in your
2868                 board's config file:
2869
2870                 #define CONFIG_EXTRA_ENV_SETTINGS \
2871                         "myvar1=value1\0" \
2872                         "myvar2=value2\0"
2873
2874                 Warning: This method is based on knowledge about the
2875                 internal format how the environment is stored by the
2876                 U-Boot code. This is NOT an official, exported
2877                 interface! Although it is unlikely that this format
2878                 will change soon, there is no guarantee either.
2879                 You better know what you are doing here.
2880
2881                 Note: overly (ab)use of the default environment is
2882                 discouraged. Make sure to check other ways to preset
2883                 the environment like the "source" command or the
2884                 boot command first.
2885
2886                 CONFIG_ENV_VARS_UBOOT_CONFIG
2887
2888                 Define this in order to add variables describing the
2889                 U-Boot build configuration to the default environment.
2890                 These will be named arch, cpu, board, vendor, and soc.
2891
2892                 Enabling this option will cause the following to be defined:
2893
2894                 - CONFIG_SYS_ARCH
2895                 - CONFIG_SYS_CPU
2896                 - CONFIG_SYS_BOARD
2897                 - CONFIG_SYS_VENDOR
2898                 - CONFIG_SYS_SOC
2899
2900                 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2901
2902                 Define this in order to add variables describing certain
2903                 run-time determined information about the hardware to the
2904                 environment.  These will be named board_name, board_rev.
2905
2906                 CONFIG_DELAY_ENVIRONMENT
2907
2908                 Normally the environment is loaded when the board is
2909                 intialised so that it is available to U-Boot. This inhibits
2910                 that so that the environment is not available until
2911                 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2912                 this is instead controlled by the value of
2913                 /config/load-environment.
2914
2915 - DataFlash Support:
2916                 CONFIG_HAS_DATAFLASH
2917
2918                 Defining this option enables DataFlash features and
2919                 allows to read/write in Dataflash via the standard
2920                 commands cp, md...
2921
2922 - Serial Flash support
2923                 CONFIG_CMD_SF
2924
2925                 Defining this option enables SPI flash commands
2926                 'sf probe/read/write/erase/update'.
2927
2928                 Usage requires an initial 'probe' to define the serial
2929                 flash parameters, followed by read/write/erase/update
2930                 commands.
2931
2932                 The following defaults may be provided by the platform
2933                 to handle the common case when only a single serial
2934                 flash is present on the system.
2935
2936                 CONFIG_SF_DEFAULT_BUS           Bus identifier
2937                 CONFIG_SF_DEFAULT_CS            Chip-select
2938                 CONFIG_SF_DEFAULT_MODE          (see include/spi.h)
2939                 CONFIG_SF_DEFAULT_SPEED         in Hz
2940
2941                 CONFIG_CMD_SF_TEST
2942
2943                 Define this option to include a destructive SPI flash
2944                 test ('sf test').
2945
2946                 CONFIG_SPI_FLASH_BAR            Ban/Extended Addr Reg
2947
2948                 Define this option to use the Bank addr/Extended addr
2949                 support on SPI flashes which has size > 16Mbytes.
2950
2951                 CONFIG_SF_DUAL_FLASH            Dual flash memories
2952
2953                 Define this option to use dual flash support where two flash
2954                 memories can be connected with a given cs line.
2955                 currently Xilinx Zynq qspi support these type of connections.
2956
2957                 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2958                 enable the W#/Vpp signal to disable writing to the status
2959                 register on ST MICRON flashes like the N25Q128.
2960                 The status register write enable/disable bit, combined with
2961                 the W#/VPP signal provides hardware data protection for the
2962                 device as follows: When the enable/disable bit is set to 1,
2963                 and the W#/VPP signal is driven LOW, the status register
2964                 nonvolatile bits become read-only and the WRITE STATUS REGISTER
2965                 operation will not execute. The only way to exit this
2966                 hardware-protected mode is to drive W#/VPP HIGH.
2967
2968 - SystemACE Support:
2969                 CONFIG_SYSTEMACE
2970
2971                 Adding this option adds support for Xilinx SystemACE
2972                 chips attached via some sort of local bus. The address
2973                 of the chip must also be defined in the
2974                 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2975
2976                 #define CONFIG_SYSTEMACE
2977                 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2978
2979                 When SystemACE support is added, the "ace" device type
2980                 becomes available to the fat commands, i.e. fatls.
2981
2982 - TFTP Fixed UDP Port:
2983                 CONFIG_TFTP_PORT
2984
2985                 If this is defined, the environment variable tftpsrcp
2986                 is used to supply the TFTP UDP source port value.
2987                 If tftpsrcp isn't defined, the normal pseudo-random port
2988                 number generator is used.
2989
2990                 Also, the environment variable tftpdstp is used to supply
2991                 the TFTP UDP destination port value.  If tftpdstp isn't
2992                 defined, the normal port 69 is used.
2993
2994                 The purpose for tftpsrcp is to allow a TFTP server to
2995                 blindly start the TFTP transfer using the pre-configured
2996                 target IP address and UDP port. This has the effect of
2997                 "punching through" the (Windows XP) firewall, allowing
2998                 the remainder of the TFTP transfer to proceed normally.
2999                 A better solution is to properly configure the firewall,
3000                 but sometimes that is not allowed.
3001
3002 - Hashing support:
3003                 CONFIG_CMD_HASH
3004
3005                 This enables a generic 'hash' command which can produce
3006                 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3007
3008                 CONFIG_HASH_VERIFY
3009
3010                 Enable the hash verify command (hash -v). This adds to code
3011                 size a little.
3012
3013                 CONFIG_SHA1 - support SHA1 hashing
3014                 CONFIG_SHA256 - support SHA256 hashing
3015
3016                 Note: There is also a sha1sum command, which should perhaps
3017                 be deprecated in favour of 'hash sha1'.
3018
3019 - Freescale i.MX specific commands:
3020                 CONFIG_CMD_HDMIDETECT
3021                 This enables 'hdmidet' command which returns true if an
3022                 HDMI monitor is detected.  This command is i.MX 6 specific.
3023
3024                 CONFIG_CMD_BMODE
3025                 This enables the 'bmode' (bootmode) command for forcing
3026                 a boot from specific media.
3027
3028                 This is useful for forcing the ROM's usb downloader to
3029                 activate upon a watchdog reset which is nice when iterating
3030                 on U-Boot.  Using the reset button or running bmode normal
3031                 will set it back to normal.  This command currently
3032                 supports i.MX53 and i.MX6.
3033
3034 - Signing support:
3035                 CONFIG_RSA
3036
3037                 This enables the RSA algorithm used for FIT image verification
3038                 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
3039
3040                 The signing part is build into mkimage regardless of this
3041                 option.
3042
3043 - bootcount support:
3044                 CONFIG_BOOTCOUNT_LIMIT
3045
3046                 This enables the bootcounter support, see:
3047                 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3048
3049                 CONFIG_AT91SAM9XE
3050                 enable special bootcounter support on at91sam9xe based boards.
3051                 CONFIG_BLACKFIN
3052                 enable special bootcounter support on blackfin based boards.
3053                 CONFIG_SOC_DA8XX
3054                 enable special bootcounter support on da850 based boards.
3055                 CONFIG_BOOTCOUNT_RAM
3056                 enable support for the bootcounter in RAM
3057                 CONFIG_BOOTCOUNT_I2C
3058                 enable support for the bootcounter on an i2c (like RTC) device.
3059                         CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3060                         CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3061                                                     the bootcounter.
3062                         CONFIG_BOOTCOUNT_ALEN = address len
3063
3064 - Show boot progress:
3065                 CONFIG_SHOW_BOOT_PROGRESS
3066
3067                 Defining this option allows to add some board-
3068                 specific code (calling a user-provided function
3069                 "show_boot_progress(int)") that enables you to show
3070                 the system's boot progress on some display (for
3071                 example, some LED's) on your board. At the moment,
3072                 the following checkpoints are implemented:
3073
3074 - Detailed boot stage timing
3075                 CONFIG_BOOTSTAGE
3076                 Define this option to get detailed timing of each stage
3077                 of the boot process.
3078
3079                 CONFIG_BOOTSTAGE_USER_COUNT
3080                 This is the number of available user bootstage records.
3081                 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3082                 a new ID will be allocated from this stash. If you exceed
3083                 the limit, recording will stop.
3084
3085                 CONFIG_BOOTSTAGE_REPORT
3086                 Define this to print a report before boot, similar to this:
3087
3088                 Timer summary in microseconds:
3089                        Mark    Elapsed  Stage
3090                           0          0  reset
3091                   3,575,678  3,575,678  board_init_f start
3092                   3,575,695         17  arch_cpu_init A9
3093                   3,575,777         82  arch_cpu_init done
3094                   3,659,598     83,821  board_init_r start
3095                   3,910,375    250,777  main_loop
3096                  29,916,167 26,005,792  bootm_start
3097                  30,361,327    445,160  start_kernel
3098
3099                 CONFIG_CMD_BOOTSTAGE
3100                 Add a 'bootstage' command which supports printing a report
3101                 and un/stashing of bootstage data.
3102
3103                 CONFIG_BOOTSTAGE_FDT
3104                 Stash the bootstage information in the FDT. A root 'bootstage'
3105                 node is created with each bootstage id as a child. Each child
3106                 has a 'name' property and either 'mark' containing the
3107                 mark time in microsecond, or 'accum' containing the
3108                 accumulated time for that bootstage id in microseconds.
3109                 For example:
3110
3111                 bootstage {
3112                         154 {
3113                                 name = "board_init_f";
3114                                 mark = <3575678>;
3115                         };
3116                         170 {
3117                                 name = "lcd";
3118                                 accum = <33482>;
3119                         };
3120                 };
3121
3122                 Code in the Linux kernel can find this in /proc/devicetree.
3123
3124 Legacy uImage format:
3125
3126   Arg   Where                   When
3127     1   common/cmd_bootm.c      before attempting to boot an image
3128    -1   common/cmd_bootm.c      Image header has bad     magic number
3129     2   common/cmd_bootm.c      Image header has correct magic number
3130    -2   common/cmd_bootm.c      Image header has bad     checksum
3131     3   common/cmd_bootm.c      Image header has correct checksum
3132    -3   common/cmd_bootm.c      Image data   has bad     checksum
3133     4   common/cmd_bootm.c      Image data   has correct checksum
3134    -4   common/cmd_bootm.c      Image is for unsupported architecture
3135     5   common/cmd_bootm.c      Architecture check OK
3136    -5   common/cmd_bootm.c      Wrong Image Type (not kernel, multi)
3137     6   common/cmd_bootm.c      Image Type check OK
3138    -6   common/cmd_bootm.c      gunzip uncompression error
3139    -7   common/cmd_bootm.c      Unimplemented compression type
3140     7   common/cmd_bootm.c      Uncompression OK
3141     8   common/cmd_bootm.c      No uncompress/copy overwrite error
3142    -9   common/cmd_bootm.c      Unsupported OS (not Linux, BSD, VxWorks, QNX)
3143
3144     9   common/image.c          Start initial ramdisk verification
3145   -10   common/image.c          Ramdisk header has bad     magic number
3146   -11   common/image.c          Ramdisk header has bad     checksum
3147    10   common/image.c          Ramdisk header is OK
3148   -12   common/image.c          Ramdisk data   has bad     checksum
3149    11   common/image.c          Ramdisk data   has correct checksum
3150    12   common/image.c          Ramdisk verification complete, start loading
3151   -13   common/image.c          Wrong Image Type (not PPC Linux ramdisk)
3152    13   common/image.c          Start multifile image verification
3153    14   common/image.c          No initial ramdisk, no multifile, continue.
3154
3155    15   arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3156
3157   -30   arch/powerpc/lib/board.c        Fatal error, hang the system
3158   -31   post/post.c             POST test failed, detected by post_output_backlog()
3159   -32   post/post.c             POST test failed, detected by post_run_single()
3160
3161    34   common/cmd_doc.c        before loading a Image from a DOC device
3162   -35   common/cmd_doc.c        Bad usage of "doc" command
3163    35   common/cmd_doc.c        correct usage of "doc" command
3164   -36   common/cmd_doc.c        No boot device
3165    36   common/cmd_doc.c        correct boot device
3166   -37   common/cmd_doc.c        Unknown Chip ID on boot device
3167    37   common/cmd_doc.c        correct chip ID found, device available
3168   -38   common/cmd_doc.c        Read Error on boot device
3169    38   common/cmd_doc.c        reading Image header from DOC device OK
3170   -39   common/cmd_doc.c        Image header has bad magic number
3171    39   common/cmd_doc.c        Image header has correct magic number
3172   -40   common/cmd_doc.c        Error reading Image from DOC device
3173    40   common/cmd_doc.c        Image header has correct magic number
3174    41   common/cmd_ide.c        before loading a Image from a IDE device
3175   -42   common/cmd_ide.c        Bad usage of "ide" command
3176    42   common/cmd_ide.c        correct usage of "ide" command
3177   -43   common/cmd_ide.c        No boot device
3178    43   common/cmd_ide.c        boot device found
3179   -44   common/cmd_ide.c        Device not available
3180    44   common/cmd_ide.c        Device available
3181   -45   common/cmd_ide.c        wrong partition selected
3182    45   common/cmd_ide.c        partition selected
3183   -46   common/cmd_ide.c        Unknown partition table
3184    46   common/cmd_ide.c        valid partition table found
3185   -47   common/cmd_ide.c        Invalid partition type
3186    47   common/cmd_ide.c        correct partition type
3187   -48   common/cmd_ide.c        Error reading Image Header on boot device
3188    48   common/cmd_ide.c        reading Image Header from IDE device OK
3189   -49   common/cmd_ide.c        Image header has bad magic number
3190    49   common/cmd_ide.c        Image header has correct magic number
3191   -50   common/cmd_ide.c        Image header has bad     checksum
3192    50   common/cmd_ide.c        Image header has correct checksum
3193   -51   common/cmd_ide.c        Error reading Image from IDE device
3194    51   common/cmd_ide.c        reading Image from IDE device OK
3195    52   common/cmd_nand.c       before loading a Image from a NAND device
3196   -53   common/cmd_nand.c       Bad usage of "nand" command
3197    53   common/cmd_nand.c       correct usage of "nand" command
3198   -54   common/cmd_nand.c       No boot device
3199    54   common/cmd_nand.c       boot device found