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