]> git.kernelconcepts.de Git - karo-tx-uboot.git/blob - README
README: white-space cleanup
[karo-tx-uboot.git] / README
1 #
2 # (C) Copyright 2000 - 2011
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 #
5 # See file CREDITS for list of people who contributed to this
6 # project.
7 #
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; either version 2 of
11 # the License, or (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 # MA 02111-1307 USA
22 #
23
24 Summary:
25 ========
26
27 This directory contains the source code for U-Boot, a boot loader for
28 Embedded boards based on PowerPC, ARM, MIPS and several other
29 processors, which can be installed in a boot ROM and used to
30 initialize and test the hardware or to download and run application
31 code.
32
33 The development of U-Boot is closely related to Linux: some parts of
34 the source code originate in the Linux source tree, we have some
35 header files in common, and special provision has been made to
36 support booting of Linux images.
37
38 Some attention has been paid to make this software easily
39 configurable and extendable. For instance, all monitor commands are
40 implemented with the same call interface, so that it's very easy to
41 add new commands. Also, instead of permanently adding rarely used
42 code (for instance hardware test utilities) to the monitor, you can
43 load and run it dynamically.
44
45
46 Status:
47 =======
48
49 In general, all boards for which a configuration option exists in the
50 Makefile have been tested to some extent and can be considered
51 "working". In fact, many of them are used in production systems.
52
53 In case of problems see the CHANGELOG and CREDITS files to find out
54 who contributed the specific port. The MAINTAINERS file lists board
55 maintainers.
56
57
58 Where to get help:
59 ==================
60
61 In case you have questions about, problems with or contributions for
62 U-Boot you should send a message to the U-Boot mailing list at
63 <u-boot@lists.denx.de>. There is also an archive of previous traffic
64 on the mailing list - please search the archive before asking FAQ's.
65 Please see http://lists.denx.de/pipermail/u-boot and
66 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67
68
69 Where to get source code:
70 =========================
71
72 The U-Boot source code is maintained in the git repository at
73 git://www.denx.de/git/u-boot.git ; you can browse it online at
74 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76 The "snapshot" links on this page allow you to download tarballs of
77 any version you might be interested in. Official releases are also
78 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79 directory.
80
81 Pre-built (and tested) images are available from
82 ftp://ftp.denx.de/pub/u-boot/images/
83
84
85 Where we come from:
86 ===================
87
88 - start from 8xxrom sources
89 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90 - clean up code
91 - make it easier to add custom boards
92 - make it possible to add other [PowerPC] CPUs
93 - extend functions, especially:
94   * Provide extended interface to Linux boot loader
95   * S-Record download
96   * network boot
97   * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
98 - create ARMBoot project (http://sourceforge.net/projects/armboot)
99 - add other CPU families (starting with ARM)
100 - create U-Boot project (http://sourceforge.net/projects/u-boot)
101 - current project page: see http://www.denx.de/wiki/U-Boot
102
103
104 Names and Spelling:
105 ===================
106
107 The "official" name of this project is "Das U-Boot". The spelling
108 "U-Boot" shall be used in all written text (documentation, comments
109 in source files etc.). Example:
110
111         This is the README file for the U-Boot project.
112
113 File names etc. shall be based on the string "u-boot". Examples:
114
115         include/asm-ppc/u-boot.h
116
117         #include <asm/u-boot.h>
118
119 Variable names, preprocessor constants etc. shall be either based on
120 the string "u_boot" or on "U_BOOT". Example:
121
122         U_BOOT_VERSION          u_boot_logo
123         IH_OS_U_BOOT            u_boot_hush_start
124
125
126 Versioning:
127 ===========
128
129 Starting with the release in October 2008, the names of the releases
130 were changed from numerical release numbers without deeper meaning
131 into a time stamp based numbering. Regular releases are identified by
132 names consisting of the calendar year and month of the release date.
133 Additional fields (if present) indicate release candidates or bug fix
134 releases in "stable" maintenance trees.
135
136 Examples:
137         U-Boot v2009.11     - Release November 2009
138         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139         U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
140
141
142 Directory Hierarchy:
143 ====================
144
145 /arch                   Architecture specific files
146   /arm                  Files generic to ARM architecture
147     /cpu                CPU specific files
148       /arm720t          Files specific to ARM 720 CPUs
149       /arm920t          Files specific to ARM 920 CPUs
150         /at91           Files specific to Atmel AT91RM9200 CPU
151         /imx            Files specific to Freescale MC9328 i.MX CPUs
152         /s3c24x0        Files specific to Samsung S3C24X0 CPUs
153       /arm925t          Files specific to ARM 925 CPUs
154       /arm926ejs        Files specific to ARM 926 CPUs
155       /arm1136          Files specific to ARM 1136 CPUs
156       /ixp              Files specific to Intel XScale IXP CPUs
157       /pxa              Files specific to Intel XScale PXA CPUs
158       /s3c44b0          Files specific to Samsung S3C44B0 CPUs
159       /sa1100           Files specific to Intel StrongARM SA1100 CPUs
160     /lib                Architecture specific library files
161   /avr32                Files generic to AVR32 architecture
162     /cpu                CPU specific files
163     /lib                Architecture specific library files
164   /blackfin             Files generic to Analog Devices Blackfin architecture
165     /cpu                CPU specific files
166     /lib                Architecture specific library files
167   /x86                  Files generic to x86 architecture
168     /cpu                CPU specific files
169     /lib                Architecture specific library files
170   /m68k                 Files generic to m68k architecture
171     /cpu                CPU specific files
172       /mcf52x2          Files specific to Freescale ColdFire MCF52x2 CPUs
173       /mcf5227x         Files specific to Freescale ColdFire MCF5227x CPUs
174       /mcf532x          Files specific to Freescale ColdFire MCF5329 CPUs
175       /mcf5445x         Files specific to Freescale ColdFire MCF5445x CPUs
176       /mcf547x_8x       Files specific to Freescale ColdFire MCF547x_8x CPUs
177     /lib                Architecture specific library files
178   /microblaze           Files generic to microblaze architecture
179     /cpu                CPU specific files
180     /lib                Architecture specific library files
181   /mips                 Files generic to MIPS architecture
182     /cpu                CPU specific files
183       /mips32           Files specific to MIPS32 CPUs
184       /xburst           Files specific to Ingenic XBurst CPUs
185     /lib                Architecture specific library files
186   /nds32                Files generic to NDS32 architecture
187     /cpu                CPU specific files
188       /n1213            Files specific to Andes Technology N1213 CPUs
189     /lib                Architecture specific library files
190   /nios2                Files generic to Altera NIOS2 architecture
191     /cpu                CPU specific files
192     /lib                Architecture specific library files
193   /powerpc              Files generic to PowerPC architecture
194     /cpu                CPU specific files
195       /74xx_7xx         Files specific to Freescale MPC74xx and 7xx CPUs
196       /mpc5xx           Files specific to Freescale MPC5xx CPUs
197       /mpc5xxx          Files specific to Freescale MPC5xxx CPUs
198       /mpc8xx           Files specific to Freescale MPC8xx CPUs
199       /mpc8220          Files specific to Freescale MPC8220 CPUs
200       /mpc824x          Files specific to Freescale MPC824x CPUs
201       /mpc8260          Files specific to Freescale MPC8260 CPUs
202       /mpc85xx          Files specific to Freescale MPC85xx CPUs
203       /ppc4xx           Files specific to AMCC PowerPC 4xx CPUs
204     /lib                Architecture specific library files
205   /sh                   Files generic to SH architecture
206     /cpu                CPU specific files
207       /sh2              Files specific to sh2 CPUs
208       /sh3              Files specific to sh3 CPUs
209       /sh4              Files specific to sh4 CPUs
210     /lib                Architecture specific library files
211   /sparc                Files generic to SPARC architecture
212     /cpu                CPU specific files
213       /leon2            Files specific to Gaisler LEON2 SPARC CPU
214       /leon3            Files specific to Gaisler LEON3 SPARC CPU
215     /lib                Architecture specific library files
216 /api                    Machine/arch independent API for external apps
217 /board                  Board dependent files
218 /common                 Misc architecture independent functions
219 /disk                   Code for disk drive partition handling
220 /doc                    Documentation (don't expect too much)
221 /drivers                Commonly used device drivers
222 /examples               Example code for standalone applications, etc.
223 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
224 /include                Header Files
225 /lib                    Files generic to all architectures
226   /libfdt               Library files to support flattened device trees
227   /lzma                 Library files to support LZMA decompression
228   /lzo                  Library files to support LZO decompression
229 /net                    Networking code
230 /post                   Power On Self Test
231 /rtc                    Real Time Clock drivers
232 /tools                  Tools to build S-Record or U-Boot images, etc.
233
234 Software Configuration:
235 =======================
236
237 Configuration is usually done using C preprocessor defines; the
238 rationale behind that is to avoid dead code whenever possible.
239
240 There are two classes of configuration variables:
241
242 * Configuration _OPTIONS_:
243   These are selectable by the user and have names beginning with
244   "CONFIG_".
245
246 * Configuration _SETTINGS_:
247   These depend on the hardware etc. and should not be meddled with if
248   you don't know what you're doing; they have names beginning with
249   "CONFIG_SYS_".
250
251 Later we will add a configuration tool - probably similar to or even
252 identical to what's used for the Linux kernel. Right now, we have to
253 do the configuration by hand, which means creating some symbolic
254 links and editing some configuration files. We use the TQM8xxL boards
255 as an example here.
256
257
258 Selection of Processor Architecture and Board Type:
259 ---------------------------------------------------
260
261 For all supported boards there are ready-to-use default
262 configurations available; just type "make <board_name>_config".
263
264 Example: For a TQM823L module type:
265
266         cd u-boot
267         make TQM823L_config
268
269 For the Cogent platform, you need to specify the CPU type as well;
270 e.g. "make cogent_mpc8xx_config". And also configure the cogent
271 directory according to the instructions in cogent/README.
272
273
274 Configuration Options:
275 ----------------------
276
277 Configuration depends on the combination of board and CPU type; all
278 such information is kept in a configuration file
279 "include/configs/<board_name>.h".
280
281 Example: For a TQM823L module, all configuration settings are in
282 "include/configs/TQM823L.h".
283
284
285 Many of the options are named exactly as the corresponding Linux
286 kernel configuration options. The intention is to make it easier to
287 build a config tool - later.
288
289
290 The following options need to be configured:
291
292 - CPU Type:     Define exactly one, e.g. CONFIG_MPC85XX.
293
294 - Board Type:   Define exactly one, e.g. CONFIG_MPC8540ADS.
295
296 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
297                 Define exactly one, e.g. CONFIG_ATSTK1002
298
299 - CPU Module Type: (if CONFIG_COGENT is defined)
300                 Define exactly one of
301                 CONFIG_CMA286_60_OLD
302 --- FIXME --- not tested yet:
303                 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304                 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306 - Motherboard Type: (if CONFIG_COGENT is defined)
307                 Define exactly one of
308                 CONFIG_CMA101, CONFIG_CMA102
309
310 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311                 Define one or more of
312                 CONFIG_CMA302
313
314 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315                 Define one or more of
316                 CONFIG_LCD_HEARTBEAT    - update a character position on
317                                           the LCD display every second with
318                                           a "rotator" |\-/|\-/
319
320 - Board flavour: (if CONFIG_MPC8260ADS is defined)
321                 CONFIG_ADSTYPE
322                 Possible values are:
323                         CONFIG_SYS_8260ADS      - original MPC8260ADS
324                         CONFIG_SYS_8266ADS      - MPC8266ADS
325                         CONFIG_SYS_PQ2FADS      - PQ2FADS-ZU or PQ2FADS-VR
326                         CONFIG_SYS_8272ADS      - MPC8272ADS
327
328 - Marvell Family Member
329                 CONFIG_SYS_MVFS         - define it if you want to enable
330                                           multiple fs option at one time
331                                           for marvell soc family
332
333 - MPC824X Family Member (if CONFIG_MPC824X is defined)
334                 Define exactly one of
335                 CONFIG_MPC8240, CONFIG_MPC8245
336
337 - 8xx CPU Options: (if using an MPC8xx CPU)
338                 CONFIG_8xx_GCLK_FREQ    - deprecated: CPU clock if
339                                           get_gclk_freq() cannot work
340                                           e.g. if there is no 32KHz
341                                           reference PIT/RTC clock
342                 CONFIG_8xx_OSCLK        - PLL input clock (either EXTCLK
343                                           or XTAL/EXTAL)
344
345 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
346                 CONFIG_SYS_8xx_CPUCLK_MIN
347                 CONFIG_SYS_8xx_CPUCLK_MAX
348                 CONFIG_8xx_CPUCLK_DEFAULT
349                         See doc/README.MPC866
350
351                 CONFIG_SYS_MEASURE_CPUCLK
352
353                 Define this to measure the actual CPU clock instead
354                 of relying on the correctness of the configured
355                 values. Mostly useful for board bringup to make sure
356                 the PLL is locked at the intended frequency. Note
357                 that this requires a (stable) reference clock (32 kHz
358                 RTC clock or CONFIG_SYS_8XX_XIN)
359
360                 CONFIG_SYS_DELAYED_ICACHE
361
362                 Define this option if you want to enable the
363                 ICache only when Code runs from RAM.
364
365 - 85xx CPU Options:
366                 CONFIG_SYS_FSL_TBCLK_DIV
367
368                 Defines the core time base clock divider ratio compared to the
369                 system clock.  On most PQ3 devices this is 8, on newer QorIQ
370                 devices it can be 16 or 32.  The ratio varies from SoC to Soc.
371
372                 CONFIG_SYS_FSL_PCIE_COMPAT
373
374                 Defines the string to utilize when trying to match PCIe device
375                 tree nodes for the given platform.
376
377 - Intel Monahans options:
378                 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
379
380                 Defines the Monahans run mode to oscillator
381                 ratio. Valid values are 8, 16, 24, 31. The core
382                 frequency is this value multiplied by 13 MHz.
383
384                 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
385
386                 Defines the Monahans turbo mode to oscillator
387                 ratio. Valid values are 1 (default if undefined) and
388                 2. The core frequency as calculated above is multiplied
389                 by this value.
390
391 - MIPS CPU options:
392                 CONFIG_SYS_INIT_SP_OFFSET
393
394                 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
395                 pointer. This is needed for the temporary stack before
396                 relocation.
397
398                 CONFIG_SYS_MIPS_CACHE_MODE
399
400                 Cache operation mode for the MIPS CPU.
401                 See also arch/mips/include/asm/mipsregs.h.
402                 Possible values are:
403                         CONF_CM_CACHABLE_NO_WA
404                         CONF_CM_CACHABLE_WA
405                         CONF_CM_UNCACHED
406                         CONF_CM_CACHABLE_NONCOHERENT
407                         CONF_CM_CACHABLE_CE
408                         CONF_CM_CACHABLE_COW
409                         CONF_CM_CACHABLE_CUW
410                         CONF_CM_CACHABLE_ACCELERATED
411
412                 CONFIG_SYS_XWAY_EBU_BOOTCFG
413
414                 Special option for Lantiq XWAY SoCs for booting from NOR flash.
415                 See also arch/mips/cpu/mips32/start.S.
416
417                 CONFIG_XWAY_SWAP_BYTES
418
419                 Enable compilation of tools/xway-swap-bytes needed for Lantiq
420                 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
421                 be swapped if a flash programmer is used.
422
423 - Linux Kernel Interface:
424                 CONFIG_CLOCKS_IN_MHZ
425
426                 U-Boot stores all clock information in Hz
427                 internally. For binary compatibility with older Linux
428                 kernels (which expect the clocks passed in the
429                 bd_info data to be in MHz) the environment variable
430                 "clocks_in_mhz" can be defined so that U-Boot
431                 converts clock data to MHZ before passing it to the
432                 Linux kernel.
433                 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
434                 "clocks_in_mhz=1" is automatically included in the
435                 default environment.
436
437                 CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
438
439                 When transferring memsize parameter to linux, some versions
440                 expect it to be in bytes, others in MB.
441                 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
442
443                 CONFIG_OF_LIBFDT
444
445                 New kernel versions are expecting firmware settings to be
446                 passed using flattened device trees (based on open firmware
447                 concepts).
448
449                 CONFIG_OF_LIBFDT
450                  * New libfdt-based support
451                  * Adds the "fdt" command
452                  * The bootm command automatically updates the fdt
453
454                 OF_CPU - The proper name of the cpus node (only required for
455                         MPC512X and MPC5xxx based boards).
456                 OF_SOC - The proper name of the soc node (only required for
457                         MPC512X and MPC5xxx based boards).
458                 OF_TBCLK - The timebase frequency.
459                 OF_STDOUT_PATH - The path to the console device
460
461                 boards with QUICC Engines require OF_QE to set UCC MAC
462                 addresses
463
464                 CONFIG_OF_BOARD_SETUP
465
466                 Board code has addition modification that it wants to make
467                 to the flat device tree before handing it off to the kernel
468
469                 CONFIG_OF_BOOT_CPU
470
471                 This define fills in the correct boot CPU in the boot
472                 param header, the default value is zero if undefined.
473
474                 CONFIG_OF_IDE_FIXUP
475
476                 U-Boot can detect if an IDE device is present or not.
477                 If not, and this new config option is activated, U-Boot
478                 removes the ATA node from the DTS before booting Linux,
479                 so the Linux IDE driver does not probe the device and
480                 crash. This is needed for buggy hardware (uc101) where
481                 no pull down resistor is connected to the signal IDE5V_DD7.
482
483                 CONFIG_MACH_TYPE        [relevant for ARM only][mandatory]
484
485                 This setting is mandatory for all boards that have only one
486                 machine type and must be used to specify the machine type
487                 number as it appears in the ARM machine registry
488                 (see http://www.arm.linux.org.uk/developer/machines/).
489                 Only boards that have multiple machine types supported
490                 in a single configuration file and the machine type is
491                 runtime discoverable, do not have to use this setting.
492
493 - vxWorks boot parameters:
494
495                 bootvx constructs a valid bootline using the following
496                 environments variables: bootfile, ipaddr, serverip, hostname.
497                 It loads the vxWorks image pointed bootfile.
498
499                 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
500                 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
501                 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
502                 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
503
504                 CONFIG_SYS_VXWORKS_ADD_PARAMS
505
506                 Add it at the end of the bootline. E.g "u=username pw=secret"
507
508                 Note: If a "bootargs" environment is defined, it will overwride
509                 the defaults discussed just above.
510
511 - Cache Configuration:
512                 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
513                 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
514                 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
515
516 - Cache Configuration for ARM:
517                 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
518                                       controller
519                 CONFIG_SYS_PL310_BASE - Physical base address of PL310
520                                         controller register space
521
522 - Serial Ports:
523                 CONFIG_PL010_SERIAL
524
525                 Define this if you want support for Amba PrimeCell PL010 UARTs.
526
527                 CONFIG_PL011_SERIAL
528
529                 Define this if you want support for Amba PrimeCell PL011 UARTs.
530
531                 CONFIG_PL011_CLOCK
532
533                 If you have Amba PrimeCell PL011 UARTs, set this variable to
534                 the clock speed of the UARTs.
535
536                 CONFIG_PL01x_PORTS
537
538                 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
539                 define this to a list of base addresses for each (supported)
540                 port. See e.g. include/configs/versatile.h
541
542                 CONFIG_PL011_SERIAL_RLCR
543
544                 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
545                 have separate receive and transmit line control registers.  Set
546                 this variable to initialize the extra register.
547
548                 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
549
550                 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
551                 boot loader that has already initialized the UART.  Define this
552                 variable to flush the UART at init time.
553
554
555 - Console Interface:
556                 Depending on board, define exactly one serial port
557                 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
558                 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
559                 console by defining CONFIG_8xx_CONS_NONE
560
561                 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
562                 port routines must be defined elsewhere
563                 (i.e. serial_init(), serial_getc(), ...)
564
565                 CONFIG_CFB_CONSOLE
566                 Enables console device for a color framebuffer. Needs following
567                 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
568                         VIDEO_FB_LITTLE_ENDIAN  graphic memory organisation
569                                                 (default big endian)
570                         VIDEO_HW_RECTFILL       graphic chip supports
571                                                 rectangle fill
572                                                 (cf. smiLynxEM)
573                         VIDEO_HW_BITBLT         graphic chip supports
574                                                 bit-blit (cf. smiLynxEM)
575                         VIDEO_VISIBLE_COLS      visible pixel columns
576                                                 (cols=pitch)
577                         VIDEO_VISIBLE_ROWS      visible pixel rows
578                         VIDEO_PIXEL_SIZE        bytes per pixel
579                         VIDEO_DATA_FORMAT       graphic data format
580                                                 (0-5, cf. cfb_console.c)
581                         VIDEO_FB_ADRS           framebuffer address
582                         VIDEO_KBD_INIT_FCT      keyboard int fct
583                                                 (i.e. i8042_kbd_init())
584                         VIDEO_TSTC_FCT          test char fct
585                                                 (i.e. i8042_tstc)
586                         VIDEO_GETC_FCT          get char fct
587                                                 (i.e. i8042_getc)
588                         CONFIG_CONSOLE_CURSOR   cursor drawing on/off
589                                                 (requires blink timer
590                                                 cf. i8042.c)
591                         CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
592                         CONFIG_CONSOLE_TIME     display time/date info in
593                                                 upper right corner
594                                                 (requires CONFIG_CMD_DATE)
595                         CONFIG_VIDEO_LOGO       display Linux logo in
596                                                 upper left corner
597                         CONFIG_VIDEO_BMP_LOGO   use bmp_logo.h instead of
598                                                 linux_logo.h for logo.
599                                                 Requires CONFIG_VIDEO_LOGO
600                         CONFIG_CONSOLE_EXTRA_INFO
601                                                 additional board info beside
602                                                 the logo
603
604                 When CONFIG_CFB_CONSOLE is defined, video console is
605                 default i/o. Serial console can be forced with
606                 environment 'console=serial'.
607
608                 When CONFIG_SILENT_CONSOLE is defined, all console
609                 messages (by U-Boot and Linux!) can be silenced with
610                 the "silent" environment variable. See
611                 doc/README.silent for more information.
612
613 - Console Baudrate:
614                 CONFIG_BAUDRATE - in bps
615                 Select one of the baudrates listed in
616                 CONFIG_SYS_BAUDRATE_TABLE, see below.
617                 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
618
619 - Console Rx buffer length
620                 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
621                 the maximum receive buffer length for the SMC.
622                 This option is actual only for 82xx and 8xx possible.
623                 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
624                 must be defined, to setup the maximum idle timeout for
625                 the SMC.
626
627 - Pre-Console Buffer:
628                 Prior to the console being initialised (i.e. serial UART
629                 initialised etc) all console output is silently discarded.
630                 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
631                 buffer any console messages prior to the console being
632                 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
633                 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
634                 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
635                 bytes are output before the console is initialised, the
636                 earlier bytes are discarded.
637
638                 'Sane' compilers will generate smaller code if
639                 CONFIG_PRE_CON_BUF_SZ is a power of 2
640
641 - Boot Delay:   CONFIG_BOOTDELAY - in seconds
642                 Delay before automatically booting the default image;
643                 set to -1 to disable autoboot.
644
645                 See doc/README.autoboot for these options that
646                 work with CONFIG_BOOTDELAY. None are required.
647                 CONFIG_BOOT_RETRY_TIME
648                 CONFIG_BOOT_RETRY_MIN
649                 CONFIG_AUTOBOOT_KEYED
650                 CONFIG_AUTOBOOT_PROMPT
651                 CONFIG_AUTOBOOT_DELAY_STR
652                 CONFIG_AUTOBOOT_STOP_STR
653                 CONFIG_AUTOBOOT_DELAY_STR2
654                 CONFIG_AUTOBOOT_STOP_STR2
655                 CONFIG_ZERO_BOOTDELAY_CHECK
656                 CONFIG_RESET_TO_RETRY
657
658 - Autoboot Command:
659                 CONFIG_BOOTCOMMAND
660                 Only needed when CONFIG_BOOTDELAY is enabled;
661                 define a command string that is automatically executed
662                 when no character is read on the console interface
663                 within "Boot Delay" after reset.
664
665                 CONFIG_BOOTARGS
666                 This can be used to pass arguments to the bootm
667                 command. The value of CONFIG_BOOTARGS goes into the
668                 environment value "bootargs".
669
670                 CONFIG_RAMBOOT and CONFIG_NFSBOOT
671                 The value of these goes into the environment as
672                 "ramboot" and "nfsboot" respectively, and can be used
673                 as a convenience, when switching between booting from
674                 RAM and NFS.
675
676 - Pre-Boot Commands:
677                 CONFIG_PREBOOT
678
679                 When this option is #defined, the existence of the
680                 environment variable "preboot" will be checked
681                 immediately before starting the CONFIG_BOOTDELAY
682                 countdown and/or running the auto-boot command resp.
683                 entering interactive mode.
684
685                 This feature is especially useful when "preboot" is
686                 automatically generated or modified. For an example
687                 see the LWMON board specific code: here "preboot" is
688                 modified when the user holds down a certain
689                 combination of keys on the (special) keyboard when
690                 booting the systems
691
692 - Serial Download Echo Mode:
693                 CONFIG_LOADS_ECHO
694                 If defined to 1, all characters received during a
695                 serial download (using the "loads" command) are
696                 echoed back. This might be needed by some terminal
697                 emulations (like "cu"), but may as well just take
698                 time on others. This setting #define's the initial
699                 value of the "loads_echo" environment variable.
700
701 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
702                 CONFIG_KGDB_BAUDRATE
703                 Select one of the baudrates listed in
704                 CONFIG_SYS_BAUDRATE_TABLE, see below.
705
706 - Monitor Functions:
707                 Monitor commands can be included or excluded
708                 from the build by using the #include files
709                 "config_cmd_all.h" and #undef'ing unwanted
710                 commands, or using "config_cmd_default.h"
711                 and augmenting with additional #define's
712                 for wanted commands.
713
714                 The default command configuration includes all commands
715                 except those marked below with a "*".
716
717                 CONFIG_CMD_ASKENV       * ask for env variable
718                 CONFIG_CMD_BDI            bdinfo
719                 CONFIG_CMD_BEDBUG       * Include BedBug Debugger
720                 CONFIG_CMD_BMP          * BMP support
721                 CONFIG_CMD_BSP          * Board specific commands
722                 CONFIG_CMD_BOOTD          bootd
723                 CONFIG_CMD_CACHE        * icache, dcache
724                 CONFIG_CMD_CONSOLE        coninfo
725                 CONFIG_CMD_CRC32        * crc32
726                 CONFIG_CMD_DATE         * support for RTC, date/time...
727                 CONFIG_CMD_DHCP         * DHCP support
728                 CONFIG_CMD_DIAG         * Diagnostics
729                 CONFIG_CMD_DS4510       * ds4510 I2C gpio commands
730                 CONFIG_CMD_DS4510_INFO  * ds4510 I2C info command
731                 CONFIG_CMD_DS4510_MEM   * ds4510 I2C eeprom/sram commansd
732                 CONFIG_CMD_DS4510_RST   * ds4510 I2C rst command
733                 CONFIG_CMD_DTT          * Digital Therm and Thermostat
734                 CONFIG_CMD_ECHO           echo arguments
735                 CONFIG_CMD_EDITENV        edit env variable
736                 CONFIG_CMD_EEPROM       * EEPROM read/write support
737                 CONFIG_CMD_ELF          * bootelf, bootvx
738                 CONFIG_CMD_EXPORTENV    * export the environment
739                 CONFIG_CMD_SAVEENV        saveenv
740                 CONFIG_CMD_FDC          * Floppy Disk Support
741                 CONFIG_CMD_FAT          * FAT partition support
742                 CONFIG_CMD_FDOS         * Dos diskette Support
743                 CONFIG_CMD_FLASH          flinfo, erase, protect
744                 CONFIG_CMD_FPGA           FPGA device initialization support
745                 CONFIG_CMD_GO           * the 'go' command (exec code)
746                 CONFIG_CMD_GREPENV      * search environment
747                 CONFIG_CMD_HWFLOW       * RTS/CTS hw flow control
748                 CONFIG_CMD_I2C          * I2C serial bus support
749                 CONFIG_CMD_IDE          * IDE harddisk support
750                 CONFIG_CMD_IMI            iminfo
751                 CONFIG_CMD_IMLS           List all found images
752                 CONFIG_CMD_IMMAP        * IMMR dump support
753                 CONFIG_CMD_IMPORTENV    * import an environment
754                 CONFIG_CMD_IRQ          * irqinfo
755                 CONFIG_CMD_ITEST          Integer/string test of 2 values
756                 CONFIG_CMD_JFFS2        * JFFS2 Support
757                 CONFIG_CMD_KGDB         * kgdb
758                 CONFIG_CMD_LDRINFO        ldrinfo (display Blackfin loader)
759                 CONFIG_CMD_LOADB          loadb
760                 CONFIG_CMD_LOADS          loads
761                 CONFIG_CMD_MD5SUM         print md5 message digest
762                                           (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
763                 CONFIG_CMD_MEMORY         md, mm, nm, mw, cp, cmp, crc, base,
764                                           loop, loopw, mtest
765                 CONFIG_CMD_MISC           Misc functions like sleep etc
766                 CONFIG_CMD_MMC          * MMC memory mapped support
767                 CONFIG_CMD_MII          * MII utility commands
768                 CONFIG_CMD_MTDPARTS     * MTD partition support
769                 CONFIG_CMD_NAND         * NAND support
770                 CONFIG_CMD_NET            bootp, tftpboot, rarpboot
771                 CONFIG_CMD_PCA953X      * PCA953x I2C gpio commands
772                 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
773                 CONFIG_CMD_PCI          * pciinfo
774                 CONFIG_CMD_PCMCIA               * PCMCIA support
775                 CONFIG_CMD_PING         * send ICMP ECHO_REQUEST to network
776                                           host
777                 CONFIG_CMD_PORTIO       * Port I/O
778                 CONFIG_CMD_REGINFO      * Register dump
779                 CONFIG_CMD_RUN            run command in env variable
780                 CONFIG_CMD_SAVES        * save S record dump
781                 CONFIG_CMD_SCSI         * SCSI Support
782                 CONFIG_CMD_SDRAM        * print SDRAM configuration information
783                                           (requires CONFIG_CMD_I2C)
784                 CONFIG_CMD_SETGETDCR      Support for DCR Register access
785                                           (4xx only)
786                 CONFIG_CMD_SHA1SUM        print sha1 memory digest
787                                           (requires CONFIG_CMD_MEMORY)
788                 CONFIG_CMD_SOURCE         "source" command Support
789                 CONFIG_CMD_SPI          * SPI serial bus support
790                 CONFIG_CMD_TFTPSRV      * TFTP transfer in server mode
791                 CONFIG_CMD_TFTPPUT      * TFTP put command (upload)
792                 CONFIG_CMD_TIME         * run command and report execution time
793                 CONFIG_CMD_USB          * USB support
794                 CONFIG_CMD_CDP          * Cisco Discover Protocol support
795                 CONFIG_CMD_FSL          * Microblaze FSL support
796
797
798                 EXAMPLE: If you want all functions except of network
799                 support you can write:
800
801                 #include "config_cmd_all.h"
802                 #undef CONFIG_CMD_NET
803
804         Other Commands:
805                 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
806
807         Note:   Don't enable the "icache" and "dcache" commands
808                 (configuration option CONFIG_CMD_CACHE) unless you know
809                 what you (and your U-Boot users) are doing. Data
810                 cache cannot be enabled on systems like the 8xx or
811                 8260 (where accesses to the IMMR region must be
812                 uncached), and it cannot be disabled on all other
813                 systems where we (mis-) use the data cache to hold an
814                 initial stack and some data.
815
816
817                 XXX - this list needs to get updated!
818
819 - Device tree:
820                 CONFIG_OF_CONTROL
821                 If this variable is defined, U-Boot will use a device tree
822                 to configure its devices, instead of relying on statically
823                 compiled #defines in the board file. This option is
824                 experimental and only available on a few boards. The device
825                 tree is available in the global data as gd->fdt_blob.
826
827                 U-Boot needs to get its device tree from somewhere. This can
828                 be done using one of the two options below:
829
830                 CONFIG_OF_EMBED
831                 If this variable is defined, U-Boot will embed a device tree
832                 binary in its image. This device tree file should be in the
833                 board directory and called <soc>-<board>.dts. The binary file
834                 is then picked up in board_init_f() and made available through
835                 the global data structure as gd->blob.
836
837                 CONFIG_OF_SEPARATE
838                 If this variable is defined, U-Boot will build a device tree
839                 binary. It will be called u-boot.dtb. Architecture-specific
840                 code will locate it at run-time. Generally this works by:
841
842                         cat u-boot.bin u-boot.dtb >image.bin
843
844                 and in fact, U-Boot does this for you, creating a file called
845                 u-boot-dtb.bin which is useful in the common case. You can
846                 still use the individual files if you need something more
847                 exotic.
848
849 - Watchdog:
850                 CONFIG_WATCHDOG
851                 If this variable is defined, it enables watchdog
852                 support for the SoC. There must be support in the SoC
853                 specific code for a watchdog. For the 8xx and 8260
854                 CPUs, the SIU Watchdog feature is enabled in the SYPCR
855                 register.  When supported for a specific SoC is
856                 available, then no further board specific code should
857                 be needed to use it.
858
859                 CONFIG_HW_WATCHDOG
860                 When using a watchdog circuitry external to the used
861                 SoC, then define this variable and provide board
862                 specific code for the "hw_watchdog_reset" function.
863
864 - U-Boot Version:
865                 CONFIG_VERSION_VARIABLE
866                 If this variable is defined, an environment variable
867                 named "ver" is created by U-Boot showing the U-Boot
868                 version as printed by the "version" command.
869                 This variable is readonly.
870
871 - Real-Time Clock:
872
873                 When CONFIG_CMD_DATE is selected, the type of the RTC
874                 has to be selected, too. Define exactly one of the
875                 following options:
876
877                 CONFIG_RTC_MPC8xx       - use internal RTC of MPC8xx
878                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
879                 CONFIG_RTC_MC13783      - use MC13783 RTC
880                 CONFIG_RTC_MC146818     - use MC146818 RTC
881                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
882                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
883                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
884                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
885                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
886                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
887                 CONFIG_SYS_RTC_DS1337_NOOSC     - Turn off the OSC output for DS1337
888                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
889                                           RV3029 RTC.
890
891                 Note that if the RTC uses I2C, then the I2C interface
892                 must also be configured. See I2C Support, below.
893
894 - GPIO Support:
895                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
896                 CONFIG_PCA953X_INFO     - enable pca953x info command
897
898                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
899                 chip-ngpio pairs that tell the PCA953X driver the number of
900                 pins supported by a particular chip.
901
902                 Note that if the GPIO device uses I2C, then the I2C interface
903                 must also be configured. See I2C Support, below.
904
905 - Timestamp Support:
906
907                 When CONFIG_TIMESTAMP is selected, the timestamp
908                 (date and time) of an image is printed by image
909                 commands like bootm or iminfo. This option is
910                 automatically enabled when you select CONFIG_CMD_DATE .
911
912 - Partition Support:
913                 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
914                 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
915
916                 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
917                 CONFIG_CMD_SCSI) you must configure support for at
918                 least one partition type as well.
919
920 - IDE Reset method:
921                 CONFIG_IDE_RESET_ROUTINE - this is defined in several
922                 board configurations files but used nowhere!
923
924                 CONFIG_IDE_RESET - is this is defined, IDE Reset will
925                 be performed by calling the function
926                         ide_set_reset(int reset)
927                 which has to be defined in a board specific file
928
929 - ATAPI Support:
930                 CONFIG_ATAPI
931
932                 Set this to enable ATAPI support.
933
934 - LBA48 Support
935                 CONFIG_LBA48
936
937                 Set this to enable support for disks larger than 137GB
938                 Also look at CONFIG_SYS_64BIT_LBA.
939                 Whithout these , LBA48 support uses 32bit variables and will 'only'
940                 support disks up to 2.1TB.
941
942                 CONFIG_SYS_64BIT_LBA:
943                         When enabled, makes the IDE subsystem use 64bit sector addresses.
944                         Default is 32bit.
945
946 - SCSI Support:
947                 At the moment only there is only support for the
948                 SYM53C8XX SCSI controller; define
949                 CONFIG_SCSI_SYM53C8XX to enable it.
950
951                 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
952                 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
953                 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
954                 maximum numbers of LUNs, SCSI ID's and target
955                 devices.
956                 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
957
958 - NETWORK Support (PCI):
959                 CONFIG_E1000
960                 Support for Intel 8254x gigabit chips.
961
962                 CONFIG_E1000_FALLBACK_MAC
963                 default MAC for empty EEPROM after production.
964
965                 CONFIG_EEPRO100
966                 Support for Intel 82557/82559/82559ER chips.
967                 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
968                 write routine for first time initialisation.
969
970                 CONFIG_TULIP
971                 Support for Digital 2114x chips.
972                 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
973                 modem chip initialisation (KS8761/QS6611).
974
975                 CONFIG_NATSEMI
976                 Support for National dp83815 chips.
977
978                 CONFIG_NS8382X
979                 Support for National dp8382[01] gigabit chips.
980
981 - NETWORK Support (other):
982
983                 CONFIG_DRIVER_AT91EMAC
984                 Support for AT91RM9200 EMAC.
985
986                         CONFIG_RMII
987                         Define this to use reduced MII inteface
988
989                         CONFIG_DRIVER_AT91EMAC_QUIET
990                         If this defined, the driver is quiet.
991                         The driver doen't show link status messages.
992
993                 CONFIG_DRIVER_LAN91C96
994                 Support for SMSC's LAN91C96 chips.
995
996                         CONFIG_LAN91C96_BASE
997                         Define this to hold the physical address
998                         of the LAN91C96's I/O space
999
1000                         CONFIG_LAN91C96_USE_32_BIT
1001                         Define this to enable 32 bit addressing
1002
1003                 CONFIG_DRIVER_SMC91111
1004                 Support for SMSC's LAN91C111 chip
1005
1006                         CONFIG_SMC91111_BASE
1007                         Define this to hold the physical address
1008                         of the device (I/O space)
1009
1010                         CONFIG_SMC_USE_32_BIT
1011                         Define this if data bus is 32 bits
1012
1013                         CONFIG_SMC_USE_IOFUNCS
1014                         Define this to use i/o functions instead of macros
1015                         (some hardware wont work with macros)
1016
1017                 CONFIG_FTGMAC100
1018                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1019
1020                         CONFIG_FTGMAC100_EGIGA
1021                         Define this to use GE link update with gigabit PHY.
1022                         Define this if FTGMAC100 is connected to gigabit PHY.
1023                         If your system has 10/100 PHY only, it might not occur
1024                         wrong behavior. Because PHY usually return timeout or
1025                         useless data when polling gigabit status and gigabit
1026                         control registers. This behavior won't affect the
1027                         correctnessof 10/100 link speed update.
1028
1029                 CONFIG_SMC911X
1030                 Support for SMSC's LAN911x and LAN921x chips
1031
1032                         CONFIG_SMC911X_BASE
1033                         Define this to hold the physical address
1034                         of the device (I/O space)
1035
1036                         CONFIG_SMC911X_32_BIT
1037                         Define this if data bus is 32 bits
1038
1039                         CONFIG_SMC911X_16_BIT
1040                         Define this if data bus is 16 bits. If your processor
1041                         automatically converts one 32 bit word to two 16 bit
1042                         words you may also try CONFIG_SMC911X_32_BIT.
1043
1044                 CONFIG_SH_ETHER
1045                 Support for Renesas on-chip Ethernet controller
1046
1047                         CONFIG_SH_ETHER_USE_PORT
1048                         Define the number of ports to be used
1049
1050                         CONFIG_SH_ETHER_PHY_ADDR
1051                         Define the ETH PHY's address
1052
1053                         CONFIG_SH_ETHER_CACHE_WRITEBACK
1054                         If this option is set, the driver enables cache flush.
1055
1056 - USB Support:
1057                 At the moment only the UHCI host controller is
1058                 supported (PIP405, MIP405, MPC5200); define
1059                 CONFIG_USB_UHCI to enable it.
1060                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1061                 and define CONFIG_USB_STORAGE to enable the USB
1062                 storage devices.
1063                 Note:
1064                 Supported are USB Keyboards and USB Floppy drives
1065                 (TEAC FD-05PUB).
1066                 MPC5200 USB requires additional defines:
1067                         CONFIG_USB_CLOCK
1068                                 for 528 MHz Clock: 0x0001bbbb
1069                         CONFIG_PSC3_USB
1070                                 for USB on PSC3
1071                         CONFIG_USB_CONFIG
1072                                 for differential drivers: 0x00001000
1073                                 for single ended drivers: 0x00005000
1074                                 for differential drivers on PSC3: 0x00000100
1075                                 for single ended drivers on PSC3: 0x00004100
1076                         CONFIG_SYS_USB_EVENT_POLL
1077                                 May be defined to allow interrupt polling
1078                                 instead of using asynchronous interrupts
1079
1080 - USB Device:
1081                 Define the below if you wish to use the USB console.
1082                 Once firmware is rebuilt from a serial console issue the
1083                 command "setenv stdin usbtty; setenv stdout usbtty" and
1084                 attach your USB cable. The Unix command "dmesg" should print
1085                 it has found a new device. The environment variable usbtty
1086                 can be set to gserial or cdc_acm to enable your device to
1087                 appear to a USB host as a Linux gserial device or a
1088                 Common Device Class Abstract Control Model serial device.
1089                 If you select usbtty = gserial you should be able to enumerate
1090                 a Linux host by
1091                 # modprobe usbserial vendor=0xVendorID product=0xProductID
1092                 else if using cdc_acm, simply setting the environment
1093                 variable usbtty to be cdc_acm should suffice. The following
1094                 might be defined in YourBoardName.h
1095
1096                         CONFIG_USB_DEVICE
1097                         Define this to build a UDC device
1098
1099                         CONFIG_USB_TTY
1100                         Define this to have a tty type of device available to
1101                         talk to the UDC device
1102
1103                         CONFIG_SYS_CONSOLE_IS_IN_ENV
1104                         Define this if you want stdin, stdout &/or stderr to
1105                         be set to usbtty.
1106
1107                         mpc8xx:
1108                                 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1109                                 Derive USB clock from external clock "blah"
1110                                 - CONFIG_SYS_USB_EXTC_CLK 0x02
1111
1112                                 CONFIG_SYS_USB_BRG_CLK 0xBLAH
1113                                 Derive USB clock from brgclk
1114                                 - CONFIG_SYS_USB_BRG_CLK 0x04
1115
1116                 If you have a USB-IF assigned VendorID then you may wish to
1117                 define your own vendor specific values either in BoardName.h
1118                 or directly in usbd_vendor_info.h. If you don't define
1119                 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1120                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1121                 should pretend to be a Linux device to it's target host.
1122
1123                         CONFIG_USBD_MANUFACTURER
1124                         Define this string as the name of your company for
1125                         - CONFIG_USBD_MANUFACTURER "my company"
1126
1127                         CONFIG_USBD_PRODUCT_NAME
1128                         Define this string as the name of your product
1129                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1130
1131                         CONFIG_USBD_VENDORID
1132                         Define this as your assigned Vendor ID from the USB
1133                         Implementors Forum. This *must* be a genuine Vendor ID
1134                         to avoid polluting the USB namespace.
1135                         - CONFIG_USBD_VENDORID 0xFFFF
1136
1137                         CONFIG_USBD_PRODUCTID
1138                         Define this as the unique Product ID
1139                         for your device
1140                         - CONFIG_USBD_PRODUCTID 0xFFFF
1141
1142
1143 - MMC Support:
1144                 The MMC controller on the Intel PXA is supported. To
1145                 enable this define CONFIG_MMC. The MMC can be
1146                 accessed from the boot prompt by mapping the device
1147                 to physical memory similar to flash. Command line is
1148                 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1149                 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1150
1151                 CONFIG_SH_MMCIF
1152                 Support for Renesas on-chip MMCIF controller
1153
1154                         CONFIG_SH_MMCIF_ADDR
1155                         Define the base address of MMCIF registers
1156
1157                         CONFIG_SH_MMCIF_CLK
1158                         Define the clock frequency for MMCIF
1159
1160 - Journaling Flash filesystem support:
1161                 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1162                 CONFIG_JFFS2_NAND_DEV
1163                 Define these for a default partition on a NAND device
1164
1165                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1166                 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1167                 Define these for a default partition on a NOR device
1168
1169                 CONFIG_SYS_JFFS_CUSTOM_PART
1170                 Define this to create an own partition. You have to provide a
1171                 function struct part_info* jffs2_part_info(int part_num)
1172
1173                 If you define only one JFFS2 partition you may also want to
1174                 #define CONFIG_SYS_JFFS_SINGLE_PART     1
1175                 to disable the command chpart. This is the default when you
1176                 have not defined a custom partition
1177
1178 - FAT(File Allocation Table) filesystem write function support:
1179                 CONFIG_FAT_WRITE
1180                 Support for saving memory data as a file
1181                 in FAT formatted partition
1182
1183 - Keyboard Support:
1184                 CONFIG_ISA_KEYBOARD
1185
1186                 Define this to enable standard (PC-Style) keyboard
1187                 support
1188
1189                 CONFIG_I8042_KBD
1190                 Standard PC keyboard driver with US (is default) and
1191                 GERMAN key layout (switch via environment 'keymap=de') support.
1192                 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1193                 for cfb_console. Supports cursor blinking.
1194
1195 - Video support:
1196                 CONFIG_VIDEO
1197
1198                 Define this to enable video support (for output to
1199                 video).
1200
1201                 CONFIG_VIDEO_CT69000
1202
1203                 Enable Chips & Technologies 69000 Video chip
1204
1205                 CONFIG_VIDEO_SMI_LYNXEM
1206                 Enable Silicon Motion SMI 712/710/810 Video chip. The
1207                 video output is selected via environment 'videoout'
1208                 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1209                 assumed.
1210
1211                 For the CT69000 and SMI_LYNXEM drivers, videomode is
1212                 selected via environment 'videomode'. Two different ways
1213                 are possible:
1214                 - "videomode=num"   'num' is a standard LiLo mode numbers.
1215                 Following standard modes are supported  (* is default):
1216
1217                       Colors    640x480 800x600 1024x768 1152x864 1280x1024
1218                 -------------+---------------------------------------------
1219                       8 bits |  0x301*  0x303    0x305    0x161     0x307
1220                      15 bits |  0x310   0x313    0x316    0x162     0x319
1221                      16 bits |  0x311   0x314    0x317    0x163     0x31A
1222                      24 bits |  0x312   0x315    0x318      ?       0x31B
1223                 -------------+---------------------------------------------
1224                 (i.e. setenv videomode 317; saveenv; reset;)
1225
1226                 - "videomode=bootargs" all the video parameters are parsed
1227                 from the bootargs. (See drivers/video/videomodes.c)
1228
1229
1230                 CONFIG_VIDEO_SED13806
1231                 Enable Epson SED13806 driver. This driver supports 8bpp
1232                 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1233                 or CONFIG_VIDEO_SED13806_16BPP
1234
1235                 CONFIG_FSL_DIU_FB
1236                 Enable the Freescale DIU video driver.  Reference boards for
1237                 SOCs that have a DIU should define this macro to enable DIU
1238                 support, and should also define these other macros:
1239
1240                         CONFIG_SYS_DIU_ADDR
1241                         CONFIG_VIDEO
1242                         CONFIG_CMD_BMP
1243                         CONFIG_CFB_CONSOLE
1244                         CONFIG_VIDEO_SW_CURSOR
1245                         CONFIG_VGA_AS_SINGLE_DEVICE
1246                         CONFIG_VIDEO_LOGO
1247                         CONFIG_VIDEO_BMP_LOGO
1248
1249                 The DIU driver will look for the 'video-mode' environment
1250                 variable, and if defined, enable the DIU as a console during
1251                 boot.  See the documentation file README.video for a
1252                 description of this variable.
1253
1254 - Keyboard Support:
1255                 CONFIG_KEYBOARD
1256
1257                 Define this to enable a custom keyboard support.
1258                 This simply calls drv_keyboard_init() which must be
1259                 defined in your board-specific files.
1260                 The only board using this so far is RBC823.
1261
1262 - LCD Support:  CONFIG_LCD
1263
1264                 Define this to enable LCD support (for output to LCD
1265                 display); also select one of the supported displays
1266                 by defining one of these:
1267
1268                 CONFIG_ATMEL_LCD:
1269
1270                         HITACHI TX09D70VM1CCA, 3.5", 240x320.
1271
1272                 CONFIG_NEC_NL6448AC33:
1273
1274                         NEC NL6448AC33-18. Active, color, single scan.
1275
1276                 CONFIG_NEC_NL6448BC20
1277
1278                         NEC NL6448BC20-08. 6.5", 640x480.
1279                         Active, color, single scan.
1280
1281                 CONFIG_NEC_NL6448BC33_54
1282
1283                         NEC NL6448BC33-54. 10.4", 640x480.
1284                         Active, color, single scan.
1285
1286                 CONFIG_SHARP_16x9
1287
1288                         Sharp 320x240. Active, color, single scan.
1289                         It isn't 16x9, and I am not sure what it is.
1290
1291                 CONFIG_SHARP_LQ64D341
1292
1293                         Sharp LQ64D341 display, 640x480.
1294                         Active, color, single scan.
1295
1296                 CONFIG_HLD1045
1297
1298                         HLD1045 display, 640x480.
1299                         Active, color, single scan.
1300
1301                 CONFIG_OPTREX_BW
1302
1303                         Optrex   CBL50840-2 NF-FW 99 22 M5
1304                         or
1305                         Hitachi  LMG6912RPFC-00T
1306                         or
1307                         Hitachi  SP14Q002
1308
1309                         320x240. Black & white.
1310
1311                 Normally display is black on white background; define
1312                 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1313
1314 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1315
1316                 If this option is set, the environment is checked for
1317                 a variable "splashimage". If found, the usual display
1318                 of logo, copyright and system information on the LCD
1319                 is suppressed and the BMP image at the address
1320                 specified in "splashimage" is loaded instead. The
1321                 console is redirected to the "nulldev", too. This
1322                 allows for a "silent" boot where a splash screen is
1323                 loaded very quickly after power-on.
1324
1325                 CONFIG_SPLASH_SCREEN_ALIGN
1326
1327                 If this option is set the splash image can be freely positioned
1328                 on the screen. Environment variable "splashpos" specifies the
1329                 position as "x,y". If a positive number is given it is used as
1330                 number of pixel from left/top. If a negative number is given it
1331                 is used as number of pixel from right/bottom. You can also
1332                 specify 'm' for centering the image.
1333
1334                 Example:
1335                 setenv splashpos m,m
1336                         => image at center of screen
1337
1338                 setenv splashpos 30,20
1339                         => image at x = 30 and y = 20
1340
1341                 setenv splashpos -10,m
1342                         => vertically centered image
1343                            at x = dspWidth - bmpWidth - 9
1344
1345 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1346
1347                 If this option is set, additionally to standard BMP
1348                 images, gzipped BMP images can be displayed via the
1349                 splashscreen support or the bmp command.
1350
1351 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1352
1353                 If this option is set, 8-bit RLE compressed BMP images
1354                 can be displayed via the splashscreen support or the
1355                 bmp command.
1356
1357 - Compression support:
1358                 CONFIG_BZIP2
1359
1360                 If this option is set, support for bzip2 compressed
1361                 images is included. If not, only uncompressed and gzip
1362                 compressed images are supported.
1363
1364                 NOTE: the bzip2 algorithm requires a lot of RAM, so
1365                 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1366                 be at least 4MB.
1367
1368                 CONFIG_LZMA
1369
1370                 If this option is set, support for lzma compressed
1371                 images is included.
1372
1373                 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1374                 requires an amount of dynamic memory that is given by the
1375                 formula:
1376
1377                         (1846 + 768 << (lc + lp)) * sizeof(uint16)
1378
1379                 Where lc and lp stand for, respectively, Literal context bits
1380                 and Literal pos bits.
1381
1382                 This value is upper-bounded by 14MB in the worst case. Anyway,
1383                 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1384                 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1385                 a very small buffer.
1386
1387                 Use the lzmainfo tool to determinate the lc and lp values and
1388                 then calculate the amount of needed dynamic memory (ensuring
1389                 the appropriate CONFIG_SYS_MALLOC_LEN value).
1390
1391 - MII/PHY support:
1392                 CONFIG_PHY_ADDR
1393
1394                 The address of PHY on MII bus.
1395
1396                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1397
1398                 The clock frequency of the MII bus
1399
1400                 CONFIG_PHY_GIGE
1401
1402                 If this option is set, support for speed/duplex
1403                 detection of gigabit PHY is included.
1404
1405                 CONFIG_PHY_RESET_DELAY
1406
1407                 Some PHY like Intel LXT971A need extra delay after
1408                 reset before any MII register access is possible.
1409                 For such PHY, set this option to the usec delay
1410                 required. (minimum 300usec for LXT971A)
1411
1412                 CONFIG_PHY_CMD_DELAY (ppc4xx)
1413
1414                 Some PHY like Intel LXT971A need extra delay after
1415                 command issued before MII status register can be read
1416
1417 - Ethernet address:
1418                 CONFIG_ETHADDR
1419                 CONFIG_ETH1ADDR
1420                 CONFIG_ETH2ADDR
1421                 CONFIG_ETH3ADDR
1422                 CONFIG_ETH4ADDR
1423                 CONFIG_ETH5ADDR
1424
1425                 Define a default value for Ethernet address to use
1426                 for the respective Ethernet interface, in case this
1427                 is not determined automatically.
1428
1429 - IP address:
1430                 CONFIG_IPADDR
1431
1432                 Define a default value for the IP address to use for
1433                 the default Ethernet interface, in case this is not
1434                 determined through e.g. bootp.
1435
1436 - Server IP address:
1437                 CONFIG_SERVERIP
1438
1439                 Defines a default value for the IP address of a TFTP
1440                 server to contact when using the "tftboot" command.
1441
1442                 CONFIG_KEEP_SERVERADDR
1443
1444                 Keeps the server's MAC address, in the env 'serveraddr'
1445                 for passing to bootargs (like Linux's netconsole option)
1446
1447 - Multicast TFTP Mode:
1448                 CONFIG_MCAST_TFTP
1449
1450                 Defines whether you want to support multicast TFTP as per
1451                 rfc-2090; for example to work with atftp.  Lets lots of targets
1452                 tftp down the same boot image concurrently.  Note: the Ethernet
1453                 driver in use must provide a function: mcast() to join/leave a
1454                 multicast group.
1455
1456 - BOOTP Recovery Mode:
1457                 CONFIG_BOOTP_RANDOM_DELAY
1458
1459                 If you have many targets in a network that try to
1460                 boot using BOOTP, you may want to avoid that all
1461                 systems send out BOOTP requests at precisely the same
1462                 moment (which would happen for instance at recovery
1463                 from a power failure, when all systems will try to
1464                 boot, thus flooding the BOOTP server. Defining
1465                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1466                 inserted before sending out BOOTP requests. The
1467                 following delays are inserted then:
1468
1469                 1st BOOTP request:      delay 0 ... 1 sec
1470                 2nd BOOTP request:      delay 0 ... 2 sec
1471                 3rd BOOTP request:      delay 0 ... 4 sec
1472                 4th and following
1473                 BOOTP requests:         delay 0 ... 8 sec
1474
1475 - DHCP Advanced Options:
1476                 You can fine tune the DHCP functionality by defining
1477                 CONFIG_BOOTP_* symbols:
1478
1479                 CONFIG_BOOTP_SUBNETMASK
1480                 CONFIG_BOOTP_GATEWAY
1481                 CONFIG_BOOTP_HOSTNAME
1482                 CONFIG_BOOTP_NISDOMAIN
1483                 CONFIG_BOOTP_BOOTPATH
1484                 CONFIG_BOOTP_BOOTFILESIZE
1485                 CONFIG_BOOTP_DNS
1486                 CONFIG_BOOTP_DNS2
1487                 CONFIG_BOOTP_SEND_HOSTNAME
1488                 CONFIG_BOOTP_NTPSERVER
1489                 CONFIG_BOOTP_TIMEOFFSET
1490                 CONFIG_BOOTP_VENDOREX
1491
1492                 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1493                 environment variable, not the BOOTP server.
1494
1495                 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1496                 serverip from a DHCP server, it is possible that more
1497                 than one DNS serverip is offered to the client.
1498                 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1499                 serverip will be stored in the additional environment
1500                 variable "dnsip2". The first DNS serverip is always
1501                 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1502                 is defined.
1503
1504                 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1505                 to do a dynamic update of a DNS server. To do this, they
1506                 need the hostname of the DHCP requester.
1507                 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1508                 of the "hostname" environment variable is passed as
1509                 option 12 to the DHCP server.
1510
1511                 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1512
1513                 A 32bit value in microseconds for a delay between
1514                 receiving a "DHCP Offer" and sending the "DHCP Request".
1515                 This fixes a problem with certain DHCP servers that don't
1516                 respond 100% of the time to a "DHCP request". E.g. On an
1517                 AT91RM9200 processor running at 180MHz, this delay needed
1518                 to be *at least* 15,000 usec before a Windows Server 2003
1519                 DHCP server would reply 100% of the time. I recommend at
1520                 least 50,000 usec to be safe. The alternative is to hope
1521                 that one of the retries will be successful but note that
1522                 the DHCP timeout and retry process takes a longer than
1523                 this delay.
1524
1525  - CDP Options:
1526                 CONFIG_CDP_DEVICE_ID
1527
1528                 The device id used in CDP trigger frames.
1529
1530                 CONFIG_CDP_DEVICE_ID_PREFIX
1531
1532                 A two character string which is prefixed to the MAC address
1533                 of the device.
1534
1535                 CONFIG_CDP_PORT_ID
1536
1537                 A printf format string which contains the ascii name of
1538                 the port. Normally is set to "eth%d" which sets
1539                 eth0 for the first Ethernet, eth1 for the second etc.
1540
1541                 CONFIG_CDP_CAPABILITIES
1542
1543                 A 32bit integer which indicates the device capabilities;
1544                 0x00000010 for a normal host which does not forwards.
1545
1546                 CONFIG_CDP_VERSION
1547
1548                 An ascii string containing the version of the software.
1549
1550                 CONFIG_CDP_PLATFORM
1551
1552                 An ascii string containing the name of the platform.
1553
1554                 CONFIG_CDP_TRIGGER
1555
1556                 A 32bit integer sent on the trigger.
1557
1558                 CONFIG_CDP_POWER_CONSUMPTION
1559
1560                 A 16bit integer containing the power consumption of the
1561                 device in .1 of milliwatts.
1562
1563                 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1564
1565                 A byte containing the id of the VLAN.
1566
1567 - Status LED:   CONFIG_STATUS_LED
1568
1569                 Several configurations allow to display the current
1570                 status using a LED. For instance, the LED will blink
1571                 fast while running U-Boot code, stop blinking as
1572                 soon as a reply to a BOOTP request was received, and
1573                 start blinking slow once the Linux kernel is running
1574                 (supported by a status LED driver in the Linux
1575                 kernel). Defining CONFIG_STATUS_LED enables this
1576                 feature in U-Boot.
1577
1578 - CAN Support:  CONFIG_CAN_DRIVER
1579
1580                 Defining CONFIG_CAN_DRIVER enables CAN driver support
1581                 on those systems that support this (optional)
1582                 feature, like the TQM8xxL modules.
1583
1584 - I2C Support:  CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1585
1586                 These enable I2C serial bus commands. Defining either of
1587                 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1588                 include the appropriate I2C driver for the selected CPU.
1589
1590                 This will allow you to use i2c commands at the u-boot
1591                 command line (as long as you set CONFIG_CMD_I2C in
1592                 CONFIG_COMMANDS) and communicate with i2c based realtime
1593                 clock chips. See common/cmd_i2c.c for a description of the
1594                 command line interface.
1595
1596                 CONFIG_HARD_I2C selects a hardware I2C controller.
1597
1598                 CONFIG_SOFT_I2C configures u-boot to use a software (aka
1599                 bit-banging) driver instead of CPM or similar hardware
1600                 support for I2C.
1601
1602                 There are several other quantities that must also be
1603                 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1604
1605                 In both cases you will need to define CONFIG_SYS_I2C_SPEED
1606                 to be the frequency (in Hz) at which you wish your i2c bus
1607                 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
1608                 the CPU's i2c node address).
1609
1610                 Now, the u-boot i2c code for the mpc8xx
1611                 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
1612                 and so its address should therefore be cleared to 0 (See,
1613                 eg, MPC823e User's Manual p.16-473). So, set
1614                 CONFIG_SYS_I2C_SLAVE to 0.
1615
1616                 CONFIG_SYS_I2C_INIT_MPC5XXX
1617
1618                 When a board is reset during an i2c bus transfer
1619                 chips might think that the current transfer is still
1620                 in progress.  Reset the slave devices by sending start
1621                 commands until the slave device responds.
1622
1623                 That's all that's required for CONFIG_HARD_I2C.
1624
1625                 If you use the software i2c interface (CONFIG_SOFT_I2C)
1626                 then the following macros need to be defined (examples are
1627                 from include/configs/lwmon.h):
1628
1629                 I2C_INIT
1630
1631                 (Optional). Any commands necessary to enable the I2C
1632                 controller or configure ports.
1633
1634                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
1635
1636                 I2C_PORT
1637
1638                 (Only for MPC8260 CPU). The I/O port to use (the code
1639                 assumes both bits are on the same port). Valid values
1640                 are 0..3 for ports A..D.
1641
1642                 I2C_ACTIVE
1643
1644                 The code necessary to make the I2C data line active
1645                 (driven).  If the data line is open collector, this
1646                 define can be null.
1647
1648                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1649
1650                 I2C_TRISTATE
1651
1652                 The code necessary to make the I2C data line tri-stated
1653                 (inactive).  If the data line is open collector, this
1654                 define can be null.
1655
1656                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1657
1658                 I2C_READ
1659
1660                 Code that returns TRUE if the I2C data line is high,
1661                 FALSE if it is low.
1662
1663                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1664
1665                 I2C_SDA(bit)
1666
1667                 If <bit> is TRUE, sets the I2C data line high. If it
1668                 is FALSE, it clears it (low).
1669
1670                 eg: #define I2C_SDA(bit) \
1671                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1672                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
1673
1674                 I2C_SCL(bit)
1675
1676                 If <bit> is TRUE, sets the I2C clock line high. If it
1677                 is FALSE, it clears it (low).
1678
1679                 eg: #define I2C_SCL(bit) \
1680                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1681                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
1682
1683                 I2C_DELAY
1684
1685                 This delay is invoked four times per clock cycle so this
1686                 controls the rate of data transfer.  The data rate thus
1687                 is 1 / (I2C_DELAY * 4). Often defined to be something
1688                 like:
1689
1690                 #define I2C_DELAY  udelay(2)
1691
1692                 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1693
1694                 If your arch supports the generic GPIO framework (asm/gpio.h),
1695                 then you may alternatively define the two GPIOs that are to be
1696                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
1697                 have GPIO-based defaults assigned to them as appropriate.
1698
1699                 You should define these to the GPIO value as given directly to
1700                 the generic GPIO functions.
1701
1702                 CONFIG_SYS_I2C_INIT_BOARD
1703
1704                 When a board is reset during an i2c bus transfer
1705                 chips might think that the current transfer is still
1706                 in progress. On some boards it is possible to access
1707                 the i2c SCLK line directly, either by using the
1708                 processor pin as a GPIO or by having a second pin
1709                 connected to the bus. If this option is defined a
1710                 custom i2c_init_board() routine in boards/xxx/board.c
1711                 is run early in the boot sequence.
1712
1713                 CONFIG_SYS_I2C_BOARD_LATE_INIT
1714
1715                 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1716                 defined a custom i2c_board_late_init() routine in
1717                 boards/xxx/board.c is run AFTER the operations in i2c_init()
1718                 is completed. This callpoint can be used to unreset i2c bus
1719                 using CPU i2c controller register accesses for CPUs whose i2c
1720                 controller provide such a method. It is called at the end of
1721                 i2c_init() to allow i2c_init operations to setup the i2c bus
1722                 controller on the CPU (e.g. setting bus speed & slave address).
1723
1724                 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1725
1726                 This option enables configuration of bi_iic_fast[] flags
1727                 in u-boot bd_info structure based on u-boot environment
1728                 variable "i2cfast". (see also i2cfast)
1729
1730                 CONFIG_I2C_MULTI_BUS
1731
1732                 This option allows the use of multiple I2C buses, each of which
1733                 must have a controller.  At any point in time, only one bus is
1734                 active.  To switch to a different bus, use the 'i2c dev' command.
1735                 Note that bus numbering is zero-based.
1736
1737                 CONFIG_SYS_I2C_NOPROBES
1738
1739                 This option specifies a list of I2C devices that will be skipped
1740                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
1741                 is set, specify a list of bus-device pairs.  Otherwise, specify
1742                 a 1D array of device addresses
1743
1744                 e.g.
1745                         #undef  CONFIG_I2C_MULTI_BUS
1746                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1747
1748                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1749
1750                         #define CONFIG_I2C_MULTI_BUS
1751                         #define CONFIG_SYS_I2C_MULTI_NOPROBES   {{0,0x50},{0,0x68},{1,0x54}}
1752
1753                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1754
1755                 CONFIG_SYS_SPD_BUS_NUM
1756
1757                 If defined, then this indicates the I2C bus number for DDR SPD.
1758                 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1759
1760                 CONFIG_SYS_RTC_BUS_NUM
1761
1762                 If defined, then this indicates the I2C bus number for the RTC.
1763                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1764
1765                 CONFIG_SYS_DTT_BUS_NUM
1766
1767                 If defined, then this indicates the I2C bus number for the DTT.
1768                 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1769
1770                 CONFIG_SYS_I2C_DTT_ADDR:
1771
1772                 If defined, specifies the I2C address of the DTT device.
1773                 If not defined, then U-Boot uses predefined value for
1774                 specified DTT device.
1775
1776                 CONFIG_FSL_I2C
1777
1778                 Define this option if you want to use Freescale's I2C driver in
1779                 drivers/i2c/fsl_i2c.c.
1780
1781                 CONFIG_I2C_MUX
1782
1783                 Define this option if you have I2C devices reached over 1 .. n
1784                 I2C Muxes like the pca9544a. This option addes a new I2C
1785                 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1786                 new I2C Bus to the existing I2C Busses. If you select the
1787                 new Bus with "i2c dev", u-bbot sends first the commandos for
1788                 the muxes to activate this new "bus".
1789
1790                 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1791                 feature!
1792
1793                 Example:
1794                 Adding a new I2C Bus reached over 2 pca9544a muxes
1795                         The First mux with address 70 and channel 6
1796                         The Second mux with address 71 and channel 4
1797
1798                 => i2c bus pca9544a:70:6:pca9544a:71:4
1799
1800                 Use the "i2c bus" command without parameter, to get a list
1801                 of I2C Busses with muxes:
1802
1803                 => i2c bus
1804                 Busses reached over muxes:
1805                 Bus ID: 2
1806                   reached over Mux(es):
1807                     pca9544a@70 ch: 4
1808                 Bus ID: 3
1809                   reached over Mux(es):
1810                     pca9544a@70 ch: 6
1811                     pca9544a@71 ch: 4
1812                 =>
1813
1814                 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1815                 u-boot first sends the command to the mux@70 to enable
1816                 channel 6, and then the command to the mux@71 to enable
1817                 the channel 4.
1818
1819                 After that, you can use the "normal" i2c commands as
1820                 usual to communicate with your I2C devices behind
1821                 the 2 muxes.
1822
1823                 This option is actually implemented for the bitbanging
1824                 algorithm in common/soft_i2c.c and for the Hardware I2C
1825                 Bus on the MPC8260. But it should be not so difficult
1826                 to add this option to other architectures.
1827
1828                 CONFIG_SOFT_I2C_READ_REPEATED_START
1829
1830                 defining this will force the i2c_read() function in
1831                 the soft_i2c driver to perform an I2C repeated start
1832                 between writing the address pointer and reading the
1833                 data.  If this define is omitted the default behaviour
1834                 of doing a stop-start sequence will be used.  Most I2C
1835                 devices can use either method, but some require one or
1836                 the other.
1837
1838 - SPI Support:  CONFIG_SPI
1839
1840                 Enables SPI driver (so far only tested with
1841                 SPI EEPROM, also an instance works with Crystal A/D and
1842                 D/As on the SACSng board)
1843
1844                 CONFIG_SH_SPI
1845
1846                 Enables the driver for SPI controller on SuperH. Currently
1847                 only SH7757 is supported.
1848
1849                 CONFIG_SPI_X
1850
1851                 Enables extended (16-bit) SPI EEPROM addressing.
1852                 (symmetrical to CONFIG_I2C_X)
1853
1854                 CONFIG_SOFT_SPI
1855
1856                 Enables a software (bit-bang) SPI driver rather than
1857                 using hardware support. This is a general purpose
1858                 driver that only requires three general I/O port pins
1859                 (two outputs, one input) to function. If this is
1860                 defined, the board configuration must define several
1861                 SPI configuration items (port pins to use, etc). For
1862                 an example, see include/configs/sacsng.h.
1863
1864                 CONFIG_HARD_SPI
1865
1866                 Enables a hardware SPI driver for general-purpose reads
1867                 and writes.  As with CONFIG_SOFT_SPI, the board configuration
1868                 must define a list of chip-select function pointers.
1869                 Currently supported on some MPC8xxx processors.  For an
1870                 example, see include/configs/mpc8349emds.h.
1871
1872                 CONFIG_MXC_SPI
1873
1874                 Enables the driver for the SPI controllers on i.MX and MXC
1875                 SoCs. Currently only i.MX31 is supported.
1876
1877 - FPGA Support: CONFIG_FPGA
1878
1879                 Enables FPGA subsystem.
1880
1881                 CONFIG_FPGA_<vendor>
1882
1883                 Enables support for specific chip vendors.
1884                 (ALTERA, XILINX)
1885
1886                 CONFIG_FPGA_<family>
1887
1888                 Enables support for FPGA family.
1889                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1890
1891                 CONFIG_FPGA_COUNT
1892
1893                 Specify the number of FPGA devices to support.
1894
1895                 CONFIG_SYS_FPGA_PROG_FEEDBACK
1896
1897                 Enable printing of hash marks during FPGA configuration.
1898
1899                 CONFIG_SYS_FPGA_CHECK_BUSY
1900
1901                 Enable checks on FPGA configuration interface busy
1902                 status by the configuration function. This option
1903                 will require a board or device specific function to
1904                 be written.
1905
1906                 CONFIG_FPGA_DELAY
1907
1908                 If defined, a function that provides delays in the FPGA
1909                 configuration driver.
1910
1911                 CONFIG_SYS_FPGA_CHECK_CTRLC
1912                 Allow Control-C to interrupt FPGA configuration
1913
1914                 CONFIG_SYS_FPGA_CHECK_ERROR
1915
1916                 Check for configuration errors during FPGA bitfile
1917                 loading. For example, abort during Virtex II
1918                 configuration if the INIT_B line goes low (which
1919                 indicated a CRC error).
1920
1921                 CONFIG_SYS_FPGA_WAIT_INIT
1922
1923                 Maximum time to wait for the INIT_B line to deassert
1924                 after PROB_B has been deasserted during a Virtex II
1925                 FPGA configuration sequence. The default time is 500
1926                 ms.
1927
1928                 CONFIG_SYS_FPGA_WAIT_BUSY
1929
1930                 Maximum time to wait for BUSY to deassert during
1931                 Virtex II FPGA configuration. The default is 5 ms.
1932
1933                 CONFIG_SYS_FPGA_WAIT_CONFIG
1934
1935                 Time to wait after FPGA configuration. The default is
1936                 200 ms.
1937
1938 - Configuration Management:
1939                 CONFIG_IDENT_STRING
1940
1941                 If defined, this string will be added to the U-Boot
1942                 version information (U_BOOT_VERSION)
1943
1944 - Vendor Parameter Protection:
1945
1946                 U-Boot considers the values of the environment
1947                 variables "serial#" (Board Serial Number) and
1948                 "ethaddr" (Ethernet Address) to be parameters that
1949                 are set once by the board vendor / manufacturer, and
1950                 protects these variables from casual modification by
1951                 the user. Once set, these variables are read-only,
1952                 and write or delete attempts are rejected. You can
1953                 change this behaviour:
1954
1955                 If CONFIG_ENV_OVERWRITE is #defined in your config
1956                 file, the write protection for vendor parameters is
1957                 completely disabled. Anybody can change or delete
1958                 these parameters.
1959
1960                 Alternatively, if you #define _both_ CONFIG_ETHADDR
1961                 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1962                 Ethernet address is installed in the environment,
1963                 which can be changed exactly ONCE by the user. [The
1964                 serial# is unaffected by this, i. e. it remains
1965                 read-only.]
1966
1967 - Protected RAM:
1968                 CONFIG_PRAM
1969
1970                 Define this variable to enable the reservation of
1971                 "protected RAM", i. e. RAM which is not overwritten
1972                 by U-Boot. Define CONFIG_PRAM to hold the number of
1973                 kB you want to reserve for pRAM. You can overwrite
1974                 this default value by defining an environment
1975                 variable "pram" to the number of kB you want to
1976                 reserve. Note that the board info structure will
1977                 still show the full amount of RAM. If pRAM is
1978                 reserved, a new environment variable "mem" will
1979                 automatically be defined to hold the amount of
1980                 remaining RAM in a form that can be passed as boot
1981                 argument to Linux, for instance like that:
1982
1983                         setenv bootargs ... mem=\${mem}
1984                         saveenv
1985
1986                 This way you can tell Linux not to use this memory,
1987                 either, which results in a memory region that will
1988                 not be affected by reboots.
1989
1990                 *WARNING* If your board configuration uses automatic
1991                 detection of the RAM size, you must make sure that
1992                 this memory test is non-destructive. So far, the
1993                 following board configurations are known to be
1994                 "pRAM-clean":
1995
1996                         ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1997                         HERMES, IP860, RPXlite, LWMON, LANTEC,
1998                         FLAGADM, TQM8260
1999
2000 - Error Recovery:
2001                 CONFIG_PANIC_HANG
2002
2003                 Define this variable to stop the system in case of a
2004                 fatal error, so that you have to reset it manually.
2005                 This is probably NOT a good idea for an embedded
2006                 system where you want the system to reboot
2007                 automatically as fast as possible, but it may be
2008                 useful during development since you can try to debug
2009                 the conditions that lead to the situation.
2010
2011                 CONFIG_NET_RETRY_COUNT
2012
2013                 This variable defines the number of retries for
2014                 network operations like ARP, RARP, TFTP, or BOOTP
2015                 before giving up the operation. If not defined, a
2016                 default value of 5 is used.
2017
2018                 CONFIG_ARP_TIMEOUT
2019
2020                 Timeout waiting for an ARP reply in milliseconds.
2021
2022 - Command Interpreter:
2023                 CONFIG_AUTO_COMPLETE
2024
2025                 Enable auto completion of commands using TAB.
2026
2027                 Note that this feature has NOT been implemented yet
2028                 for the "hush" shell.
2029
2030
2031                 CONFIG_SYS_HUSH_PARSER
2032
2033                 Define this variable to enable the "hush" shell (from
2034                 Busybox) as command line interpreter, thus enabling
2035                 powerful command line syntax like
2036                 if...then...else...fi conditionals or `&&' and '||'
2037                 constructs ("shell scripts").
2038
2039                 If undefined, you get the old, much simpler behaviour
2040                 with a somewhat smaller memory footprint.
2041
2042
2043                 CONFIG_SYS_PROMPT_HUSH_PS2
2044
2045                 This defines the secondary prompt string, which is
2046                 printed when the command interpreter needs more input
2047                 to complete a command. Usually "> ".
2048
2049         Note:
2050
2051                 In the current implementation, the local variables
2052                 space and global environment variables space are
2053                 separated. Local variables are those you define by
2054                 simply typing `name=value'. To access a local
2055                 variable later on, you have write `$name' or
2056                 `${name}'; to execute the contents of a variable
2057                 directly type `$name' at the command prompt.
2058
2059                 Global environment variables are those you use
2060                 setenv/printenv to work with. To run a command stored
2061                 in such a variable, you need to use the run command,
2062                 and you must not use the '$' sign to access them.
2063
2064                 To store commands and special characters in a
2065                 variable, please use double quotation marks
2066                 surrounding the whole text of the variable, instead
2067                 of the backslashes before semicolons and special
2068                 symbols.
2069
2070 - Commandline Editing and History:
2071                 CONFIG_CMDLINE_EDITING
2072
2073                 Enable editing and History functions for interactive
2074                 commandline input operations
2075
2076 - Default Environment:
2077                 CONFIG_EXTRA_ENV_SETTINGS
2078
2079                 Define this to contain any number of null terminated
2080                 strings (variable = value pairs) that will be part of
2081                 the default environment compiled into the boot image.
2082
2083                 For example, place something like this in your
2084                 board's config file:
2085
2086                 #define CONFIG_EXTRA_ENV_SETTINGS \
2087                         "myvar1=value1\0" \
2088                         "myvar2=value2\0"
2089
2090                 Warning: This method is based on knowledge about the
2091                 internal format how the environment is stored by the
2092                 U-Boot code. This is NOT an official, exported
2093                 interface! Although it is unlikely that this format
2094                 will change soon, there is no guarantee either.
2095                 You better know what you are doing here.
2096
2097                 Note: overly (ab)use of the default environment is
2098                 discouraged. Make sure to check other ways to preset
2099                 the environment like the "source" command or the
2100                 boot command first.
2101
2102 - DataFlash Support:
2103                 CONFIG_HAS_DATAFLASH
2104
2105                 Defining this option enables DataFlash features and
2106                 allows to read/write in Dataflash via the standard
2107                 commands cp, md...
2108
2109 - SystemACE Support:
2110                 CONFIG_SYSTEMACE
2111
2112                 Adding this option adds support for Xilinx SystemACE
2113                 chips attached via some sort of local bus. The address
2114                 of the chip must also be defined in the
2115                 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2116
2117                 #define CONFIG_SYSTEMACE
2118                 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2119
2120                 When SystemACE support is added, the "ace" device type
2121                 becomes available to the fat commands, i.e. fatls.
2122
2123 - TFTP Fixed UDP Port:
2124                 CONFIG_TFTP_PORT
2125
2126                 If this is defined, the environment variable tftpsrcp
2127                 is used to supply the TFTP UDP source port value.
2128                 If tftpsrcp isn't defined, the normal pseudo-random port
2129                 number generator is used.
2130
2131                 Also, the environment variable tftpdstp is used to supply
2132                 the TFTP UDP destination port value.  If tftpdstp isn't
2133                 defined, the normal port 69 is used.
2134
2135                 The purpose for tftpsrcp is to allow a TFTP server to
2136                 blindly start the TFTP transfer using the pre-configured
2137                 target IP address and UDP port. This has the effect of
2138                 "punching through" the (Windows XP) firewall, allowing
2139                 the remainder of the TFTP transfer to proceed normally.
2140                 A better solution is to properly configure the firewall,
2141                 but sometimes that is not allowed.
2142
2143 - Show boot progress:
2144                 CONFIG_SHOW_BOOT_PROGRESS
2145
2146                 Defining this option allows to add some board-
2147                 specific code (calling a user-provided function
2148                 "show_boot_progress(int)") that enables you to show
2149                 the system's boot progress on some display (for
2150                 example, some LED's) on your board. At the moment,
2151                 the following checkpoints are implemented:
2152
2153 Legacy uImage format:
2154
2155   Arg   Where                   When
2156     1   common/cmd_bootm.c      before attempting to boot an image
2157    -1   common/cmd_bootm.c      Image header has bad     magic number
2158     2   common/cmd_bootm.c      Image header has correct magic number
2159    -2   common/cmd_bootm.c      Image header has bad     checksum
2160     3   common/cmd_bootm.c      Image header has correct checksum
2161    -3   common/cmd_bootm.c      Image data   has bad     checksum
2162     4   common/cmd_bootm.c      Image data   has correct checksum
2163    -4   common/cmd_bootm.c      Image is for unsupported architecture
2164     5   common/cmd_bootm.c      Architecture check OK
2165    -5   common/cmd_bootm.c      Wrong Image Type (not kernel, multi)
2166     6   common/cmd_bootm.c      Image Type check OK
2167    -6   common/cmd_bootm.c      gunzip uncompression error
2168    -7   common/cmd_bootm.c      Unimplemented compression type
2169     7   common/cmd_bootm.c      Uncompression OK
2170     8   common/cmd_bootm.c      No uncompress/copy overwrite error
2171    -9   common/cmd_bootm.c      Unsupported OS (not Linux, BSD, VxWorks, QNX)
2172
2173     9   common/image.c          Start initial ramdisk verification
2174   -10   common/image.c          Ramdisk header has bad     magic number
2175   -11   common/image.c          Ramdisk header has bad     checksum
2176    10   common/image.c          Ramdisk header is OK
2177   -12   common/image.c          Ramdisk data   has bad     checksum
2178    11   common/image.c          Ramdisk data   has correct checksum
2179    12   common/image.c          Ramdisk verification complete, start loading
2180   -13   common/image.c          Wrong Image Type (not PPC Linux ramdisk)
2181    13   common/image.c          Start multifile image verification
2182    14   common/image.c          No initial ramdisk, no multifile, continue.
2183
2184    15   arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2185
2186   -30   arch/powerpc/lib/board.c        Fatal error, hang the system
2187   -31   post/post.c             POST test failed, detected by post_output_backlog()
2188   -32   post/post.c             POST test failed, detected by post_run_single()
2189
2190    34   common/cmd_doc.c        before loading a Image from a DOC device
2191   -35   common/cmd_doc.c        Bad usage of "doc" command
2192    35   common/cmd_doc.c        correct usage of "doc" command
2193   -36   common/cmd_doc.c        No boot device
2194    36   common/cmd_doc.c        correct boot device
2195   -37   common/cmd_doc.c        Unknown Chip ID on boot device
2196    37   common/cmd_doc.c        correct chip ID found, device available
2197   -38   common/cmd_doc.c        Read Error on boot device
2198    38   common/cmd_doc.c        reading Image header from DOC device OK
2199   -39   common/cmd_doc.c        Image header has bad magic number
2200    39   common/cmd_doc.c        Image header has correct magic number
2201   -40   common/cmd_doc.c        Error reading Image from DOC device
2202    40   common/cmd_doc.c        Image header has correct magic number
2203    41   common/cmd_ide.c        before loading a Image from a IDE device
2204   -42   common/cmd_ide.c        Bad usage of "ide" command
2205    42   common/cmd_ide.c        correct usage of "ide" command
2206   -43   common/cmd_ide.c        No boot device
2207    43   common/cmd_ide.c        boot device found
2208   -44   common/cmd_ide.c        Device not available
2209    44   common/cmd_ide.c        Device available
2210   -45   common/cmd_ide.c        wrong partition selected
2211    45   common/cmd_ide.c        partition selected
2212   -46   common/cmd_ide.c        Unknown partition table
2213    46   common/cmd_ide.c        valid partition table found
2214   -47   common/cmd_ide.c        Invalid partition type
2215    47   common/cmd_ide.c        correct partition type
2216   -48   common/cmd_ide.c        Error reading Image Header on boot device
2217    48   common/cmd_ide.c        reading Image Header from IDE device OK
2218   -49   common/cmd_ide.c        Image header has bad magic number
2219    49   common/cmd_ide.c        Image header has correct magic number
2220   -50   common/cmd_ide.c        Image header has bad     checksum
2221    50   common/cmd_ide.c        Image header has correct checksum
2222   -51   common/cmd_ide.c        Error reading Image from IDE device
2223    51   common/cmd_ide.c        reading Image from IDE device OK
2224    52   common/cmd_nand.c       before loading a Image from a NAND device
2225   -53   common/cmd_nand.c       Bad usage of "nand" command
2226    53   common/cmd_nand.c       correct usage of "nand" command
2227   -54   common/cmd_nand.c       No boot device
2228    54   common/cmd_nand.c       boot device found
2229   -55   common/cmd_nand.c       Unknown Chip ID on boot device
2230    55   common/cmd_nand.c       correct chip ID found, device available
2231   -56   common/cmd_nand.c       Error reading Image Header on boot device
2232    56   common/cmd_nand.c       reading Image Header from NAND device OK
2233   -57   common/cmd_nand.c       Image header has bad magic number
2234    57   common/cmd_nand.c       Image header has correct magic number
2235   -58   common/cmd_nand.c       Error reading Image from NAND device
2236    58   common/cmd_nand.c       reading Image from NAND device OK
2237
2238   -60   common/env_common.c     Environment has a bad CRC, using default
2239
2240    64   net/eth.c               starting with Ethernet configuration.
2241   -64   net/eth.c               no Ethernet found.
2242    65   net/eth.c               Ethernet found.
2243
2244   -80   common/cmd_net.c        usage wrong
2245    80   common/cmd_net.c        before calling NetLoop()
2246   -81   common/cmd_net.c        some error in NetLoop() occurred
2247    81   common/cmd_net.c        NetLoop() back without error
2248   -82   common/cmd_net.c        size == 0 (File with size 0 loaded)
2249    82   common/cmd_net.c        trying automatic boot
2250    83   common/cmd_net.c        running "source" command
2251   -83   common/cmd_net.c        some error in automatic boot or "source" command
2252    84   common/cmd_net.c        end without errors
2253
2254 FIT uImage format:
2255
2256   Arg   Where                   When
2257   100   common/cmd_bootm.c      Kernel FIT Image has correct format
2258  -100   common/cmd_bootm.c      Kernel FIT Image has incorrect format
2259   101   common/cmd_bootm.c      No Kernel subimage unit name, using configuration
2260  -101   common/cmd_bootm.c      Can't get configuration for kernel subimage
2261   102   common/cmd_bootm.c      Kernel unit name specified
2262  -103   common/cmd_bootm.c      Can't get kernel subimage node offset
2263   103   common/cmd_bootm.c      Found configuration node
2264   104   common/cmd_bootm.c      Got kernel subimage node offset
2265  -104   common/cmd_bootm.c      Kernel subimage hash verification failed
2266   105   common/cmd_bootm.c      Kernel subimage hash verification OK
2267  -105   common/cmd_bootm.c      Kernel subimage is for unsupported architecture
2268   106   common/cmd_bootm.c      Architecture check OK
2269  -106   common/cmd_bootm.c      Kernel subimage has wrong type
2270   107   common/cmd_bootm.c      Kernel subimage type OK
2271  -107   common/cmd_bootm.c      Can't get kernel subimage data/size
2272   108   common/cmd_bootm.c      Got kernel subimage data/size
2273  -108   common/cmd_bootm.c      Wrong image type (not legacy, FIT)
2274  -109   common/cmd_bootm.c      Can't get kernel subimage type
2275  -110   common/cmd_bootm.c      Can't get kernel subimage comp
2276  -111   common/cmd_bootm.c      Can't get kernel subimage os
2277  -112   common/cmd_bootm.c      Can't get kernel subimage load address
2278  -113   common/cmd_bootm.c      Image uncompress/copy overwrite error
2279
2280   120   common/image.c          Start initial ramdisk verification
2281  -120   common/image.c          Ramdisk FIT image has incorrect format
2282   121   common/image.c          Ramdisk FIT image has correct format
2283   122   common/image.c          No ramdisk subimage unit name, using configuration
2284  -122   common/image.c          Can't get configuration for ramdisk subimage
2285   123   common/image.c          Ramdisk unit name specified
2286  -124   common/image.c          Can't get ramdisk subimage node offset
2287   125   common/image.c          Got ramdisk subimage node offset
2288  -125   common/image.c          Ramdisk subimage hash verification failed
2289   126   common/image.c          Ramdisk subimage hash verification OK
2290  -126   common/image.c          Ramdisk subimage for unsupported architecture
2291   127   common/image.c          Architecture check OK
2292  -127   common/image.c          Can't get ramdisk subimage data/size
2293   128   common/image.c          Got ramdisk subimage data/size
2294   129   common/image.c          Can't get ramdisk load address
2295  -129   common/image.c          Got ramdisk load address
2296
2297  -130   common/cmd_doc.c        Incorrect FIT image format
2298   131   common/cmd_doc.c        FIT image format OK
2299
2300  -140   common/cmd_ide.c        Incorrect FIT image format
2301   141   common/cmd_ide.c        FIT image format OK
2302
2303  -150   common/cmd_nand.c       Incorrect FIT image format
2304   151   common/cmd_nand.c       FIT image format OK
2305
2306 - Standalone program support:
2307                 CONFIG_STANDALONE_LOAD_ADDR
2308
2309                 This option defines a board specific value for the
2310                 address where standalone program gets loaded, thus
2311                 overwriting the architecture dependent default
2312                 settings.
2313
2314 - Frame Buffer Address:
2315                 CONFIG_FB_ADDR
2316
2317                 Define CONFIG_FB_ADDR if you want to use specific
2318                 address for frame buffer.
2319                 Then system will reserve the frame buffer address to
2320                 defined address instead of lcd_setmem (this function
2321                 grabs the memory for frame buffer by panel's size).
2322
2323                 Please see board_init_f function.
2324
2325 - Automatic software updates via TFTP server
2326                 CONFIG_UPDATE_TFTP
2327                 CONFIG_UPDATE_TFTP_CNT_MAX
2328                 CONFIG_UPDATE_TFTP_MSEC_MAX
2329
2330                 These options enable and control the auto-update feature;
2331                 for a more detailed description refer to doc/README.update.
2332
2333 - MTD Support (mtdparts command, UBI support)
2334                 CONFIG_MTD_DEVICE
2335
2336                 Adds the MTD device infrastructure from the Linux kernel.
2337                 Needed for mtdparts command support.
2338
2339                 CONFIG_MTD_PARTITIONS
2340
2341                 Adds the MTD partitioning infrastructure from the Linux
2342                 kernel. Needed for UBI support.
2343
2344 - SPL framework
2345                 CONFIG_SPL
2346                 Enable building of SPL globally.
2347
2348                 CONFIG_SPL_TEXT_BASE
2349                 TEXT_BASE for linking the SPL binary.
2350
2351                 CONFIG_SPL_LDSCRIPT
2352                 LDSCRIPT for linking the SPL binary.
2353
2354                 CONFIG_SPL_LIBCOMMON_SUPPORT
2355                 Support for common/libcommon.o in SPL binary
2356
2357                 CONFIG_SPL_LIBDISK_SUPPORT
2358                 Support for disk/libdisk.o in SPL binary
2359
2360                 CONFIG_SPL_I2C_SUPPORT
2361                 Support for drivers/i2c/libi2c.o in SPL binary
2362
2363                 CONFIG_SPL_GPIO_SUPPORT
2364                 Support for drivers/gpio/libgpio.o in SPL binary
2365
2366                 CONFIG_SPL_MMC_SUPPORT
2367                 Support for drivers/mmc/libmmc.o in SPL binary
2368
2369                 CONFIG_SPL_SERIAL_SUPPORT
2370                 Support for drivers/serial/libserial.o in SPL binary
2371
2372                 CONFIG_SPL_SPI_FLASH_SUPPORT
2373                 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
2374
2375                 CONFIG_SPL_SPI_SUPPORT
2376                 Support for drivers/spi/libspi.o in SPL binary
2377
2378                 CONFIG_SPL_FAT_SUPPORT
2379                 Support for fs/fat/libfat.o in SPL binary
2380
2381                 CONFIG_SPL_LIBGENERIC_SUPPORT
2382                 Support for lib/libgeneric.o in SPL binary
2383
2384 Modem Support:
2385 --------------
2386
2387 [so far only for SMDK2400 boards]
2388
2389 - Modem support enable:
2390                 CONFIG_MODEM_SUPPORT
2391
2392 - RTS/CTS Flow control enable:
2393                 CONFIG_HWFLOW
2394
2395 - Modem debug support:
2396                 CONFIG_MODEM_SUPPORT_DEBUG
2397
2398                 Enables debugging stuff (char screen[1024], dbg())
2399                 for modem support. Useful only with BDI2000.
2400
2401 - Interrupt support (PPC):
2402
2403                 There are common interrupt_init() and timer_interrupt()
2404                 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2405                 for CPU specific initialization. interrupt_init_cpu()
2406                 should set decrementer_count to appropriate value. If
2407                 CPU resets decrementer automatically after interrupt
2408                 (ppc4xx) it should set decrementer_count to zero.
2409                 timer_interrupt() calls timer_interrupt_cpu() for CPU
2410                 specific handling. If board has watchdog / status_led
2411                 / other_activity_monitor it works automatically from
2412                 general timer_interrupt().
2413
2414 - General:
2415
2416                 In the target system modem support is enabled when a
2417                 specific key (key combination) is pressed during
2418                 power-on. Otherwise U-Boot will boot normally
2419                 (autoboot). The key_pressed() function is called from
2420                 board_init(). Currently key_pressed() is a dummy
2421                 function, returning 1 and thus enabling modem
2422                 initialization.
2423
2424                 If there are no modem init strings in the
2425                 environment, U-Boot proceed to autoboot; the
2426                 previous output (banner, info printfs) will be
2427                 suppressed, though.
2428
2429                 See also: doc/README.Modem
2430
2431
2432 Configuration Settings:
2433 -----------------------
2434
2435 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2436                 undefine this when you're short of memory.
2437
2438 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2439                 width of the commands listed in the 'help' command output.
2440
2441 - CONFIG_SYS_PROMPT:    This is what U-Boot prints on the console to
2442                 prompt for user input.
2443
2444 - CONFIG_SYS_CBSIZE:    Buffer size for input from the Console
2445
2446 - CONFIG_SYS_PBSIZE:    Buffer size for Console output
2447
2448 - CONFIG_SYS_MAXARGS:   max. Number of arguments accepted for monitor commands
2449
2450 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2451                 the application (usually a Linux kernel) when it is
2452                 booted
2453
2454 - CONFIG_SYS_BAUDRATE_TABLE:
2455                 List of legal baudrate settings for this board.
2456
2457 - CONFIG_SYS_CONSOLE_INFO_QUIET
2458                 Suppress display of console information at boot.
2459
2460 - CONFIG_SYS_CONSOLE_IS_IN_ENV
2461                 If the board specific function
2462                         extern int overwrite_console (void);
2463                 returns 1, the stdin, stderr and stdout are switched to the
2464                 serial port, else the settings in the environment are used.
2465
2466 - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2467                 Enable the call to overwrite_console().
2468
2469 - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2470                 Enable overwrite of previous console environment settings.
2471
2472 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2473                 Begin and End addresses of the area used by the
2474                 simple memory test.
2475
2476 - CONFIG_SYS_ALT_MEMTEST:
2477                 Enable an alternate, more extensive memory test.
2478
2479 - CONFIG_SYS_MEMTEST_SCRATCH:
2480                 Scratch address used by the alternate memory test
2481                 You only need to set this if address zero isn't writeable
2482
2483 - CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2484                 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2485                 this specified memory area will get subtracted from the top
2486                 (end) of RAM and won't get "touched" at all by U-Boot. By
2487                 fixing up gd->ram_size the Linux kernel should gets passed
2488                 the now "corrected" memory size and won't touch it either.
2489                 This should work for arch/ppc and arch/powerpc. Only Linux
2490                 board ports in arch/powerpc with bootwrapper support that
2491                 recalculate the memory size from the SDRAM controller setup
2492                 will have to get fixed in Linux additionally.
2493
2494                 This option can be used as a workaround for the 440EPx/GRx
2495                 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2496                 be touched.
2497
2498                 WARNING: Please make sure that this value is a multiple of
2499                 the Linux page size (normally 4k). If this is not the case,
2500                 then the end address of the Linux memory will be located at a
2501                 non page size aligned address and this could cause major
2502                 problems.
2503
2504 - CONFIG_SYS_TFTP_LOADADDR:
2505                 Default load address for network file downloads
2506
2507 - CONFIG_SYS_LOADS_BAUD_CHANGE:
2508                 Enable temporary baudrate change while serial download
2509
2510 - CONFIG_SYS_SDRAM_BASE:
2511                 Physical start address of SDRAM. _Must_ be 0 here.
2512
2513 - CONFIG_SYS_MBIO_BASE:
2514                 Physical start address of Motherboard I/O (if using a
2515                 Cogent motherboard)
2516
2517 - CONFIG_SYS_FLASH_BASE:
2518                 Physical start address of Flash memory.
2519
2520 - CONFIG_SYS_MONITOR_BASE:
2521                 Physical start address of boot monitor code (set by
2522                 make config files to be same as the text base address
2523                 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
2524                 CONFIG_SYS_FLASH_BASE when booting from flash.
2525
2526 - CONFIG_SYS_MONITOR_LEN:
2527                 Size of memory reserved for monitor code, used to
2528                 determine _at_compile_time_ (!) if the environment is
2529                 embedded within the U-Boot image, or in a separate
2530                 flash sector.
2531
2532 - CONFIG_SYS_MALLOC_LEN:
2533                 Size of DRAM reserved for malloc() use.
2534
2535 - CONFIG_SYS_BOOTM_LEN:
2536                 Normally compressed uImages are limited to an
2537                 uncompressed size of 8 MBytes. If this is not enough,
2538                 you can define CONFIG_SYS_BOOTM_LEN in your board config file
2539                 to adjust this setting to your needs.
2540
2541 - CONFIG_SYS_BOOTMAPSZ:
2542                 Maximum size of memory mapped by the startup code of
2543                 the Linux kernel; all data that must be processed by
2544                 the Linux kernel (bd_info, boot arguments, FDT blob if
2545                 used) must be put below this limit, unless "bootm_low"
2546                 enviroment variable is defined and non-zero. In such case
2547                 all data for the Linux kernel must be between "bootm_low"
2548                 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2549                 variable "bootm_mapsize" will override the value of
2550                 CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2551                 then the value in "bootm_size" will be used instead.
2552
2553 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
2554                 Enable initrd_high functionality.  If defined then the
2555                 initrd_high feature is enabled and the bootm ramdisk subcommand
2556                 is enabled.
2557
2558 - CONFIG_SYS_BOOT_GET_CMDLINE:
2559                 Enables allocating and saving kernel cmdline in space between
2560                 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2561
2562 - CONFIG_SYS_BOOT_GET_KBD:
2563                 Enables allocating and saving a kernel copy of the bd_info in
2564                 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2565
2566 - CONFIG_SYS_MAX_FLASH_BANKS:
2567                 Max number of Flash memory banks
2568
2569 - CONFIG_SYS_MAX_FLASH_SECT:
2570                 Max number of sectors on a Flash chip
2571
2572 - CONFIG_SYS_FLASH_ERASE_TOUT:
2573                 Timeout for Flash erase operations (in ms)
2574
2575 - CONFIG_SYS_FLASH_WRITE_TOUT:
2576                 Timeout for Flash write operations (in ms)
2577
2578 - CONFIG_SYS_FLASH_LOCK_TOUT
2579                 Timeout for Flash set sector lock bit operation (in ms)
2580
2581 - CONFIG_SYS_FLASH_UNLOCK_TOUT
2582                 Timeout for Flash clear lock bits operation (in ms)
2583
2584 - CONFIG_SYS_FLASH_PROTECTION
2585                 If defined, hardware flash sectors protection is used
2586                 instead of U-Boot software protection.
2587
2588 - CONFIG_SYS_DIRECT_FLASH_TFTP:
2589
2590                 Enable TFTP transfers directly to flash memory;
2591                 without this option such a download has to be
2592                 performed in two steps: (1) download to RAM, and (2)
2593                 copy from RAM to flash.
2594
2595                 The two-step approach is usually more reliable, since
2596                 you can check if the download worked before you erase
2597                 the flash, but in some situations (when system RAM is
2598                 too limited to allow for a temporary copy of the
2599                 downloaded image) this option may be very useful.
2600
2601 - CONFIG_SYS_FLASH_CFI:
2602                 Define if the flash driver uses extra elements in the
2603                 common flash structure for storing flash geometry.
2604
2605 - CONFIG_FLASH_CFI_DRIVER
2606                 This option also enables the building of the cfi_flash driver
2607                 in the drivers directory
2608
2609 - CONFIG_FLASH_CFI_MTD
2610                 This option enables the building of the cfi_mtd driver
2611                 in the drivers directory. The driver exports CFI flash
2612                 to the MTD layer.
2613
2614 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2615                 Use buffered writes to flash.
2616
2617 - CONFIG_FLASH_SPANSION_S29WS_N
2618                 s29ws-n MirrorBit flash has non-standard addresses for buffered
2619                 write commands.
2620
2621 - CONFIG_SYS_FLASH_QUIET_TEST
2622                 If this option is defined, the common CFI flash doesn't
2623                 print it's warning upon not recognized FLASH banks. This
2624                 is useful, if some of the configured banks are only
2625                 optionally available.
2626
2627 - CONFIG_FLASH_SHOW_PROGRESS
2628                 If defined (must be an integer), print out countdown
2629                 digits and dots.  Recommended value: 45 (9..1) for 80
2630                 column displays, 15 (3..1) for 40 column displays.
2631
2632 - CONFIG_SYS_RX_ETH_BUFFER:
2633                 Defines the number of Ethernet receive buffers. On some
2634                 Ethernet controllers it is recommended to set this value
2635                 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2636                 buffers can be full shortly after enabling the interface
2637                 on high Ethernet traffic.
2638                 Defaults to 4 if not defined.
2639
2640 - CONFIG_ENV_MAX_ENTRIES
2641
2642         Maximum number of entries in the hash table that is used
2643         internally to store the environment settings. The default
2644         setting is supposed to be generous and should work in most
2645         cases. This setting can be used to tune behaviour; see
2646         lib/hashtable.c for details.
2647
2648 The following definitions that deal with the placement and management
2649 of environment data (variable area); in general, we support the
2650 following configurations:
2651
2652 - CONFIG_BUILD_ENVCRC:
2653
2654         Builds up envcrc with the target environment so that external utils
2655         may easily extract it and embed it in final U-Boot images.
2656
2657 - CONFIG_ENV_IS_IN_FLASH:
2658
2659         Define this if the environment is in flash memory.
2660
2661         a) The environment occupies one whole flash sector, which is
2662            "embedded" in the text segment with the U-Boot code. This
2663            happens usually with "bottom boot sector" or "top boot
2664            sector" type flash chips, which have several smaller
2665            sectors at the start or the end. For instance, such a
2666            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2667            such a case you would place the environment in one of the
2668            4 kB sectors - with U-Boot code before and after it. With
2669            "top boot sector" type flash chips, you would put the
2670            environment in one of the last sectors, leaving a gap
2671            between U-Boot and the environment.
2672
2673         - CONFIG_ENV_OFFSET:
2674
2675            Offset of environment data (variable area) to the
2676            beginning of flash memory; for instance, with bottom boot
2677            type flash chips the second sector can be used: the offset
2678            for this sector is given here.
2679
2680            CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2681
2682         - CONFIG_ENV_ADDR:
2683
2684            This is just another way to specify the start address of
2685            the flash sector containing the environment (instead of
2686            CONFIG_ENV_OFFSET).
2687
2688         - CONFIG_ENV_SECT_SIZE:
2689
2690            Size of the sector containing the environment.
2691
2692
2693         b) Sometimes flash chips have few, equal sized, BIG sectors.
2694            In such a case you don't want to spend a whole sector for
2695            the environment.
2696
2697         - CONFIG_ENV_SIZE:
2698
2699            If you use this in combination with CONFIG_ENV_IS_IN_FLASH
2700            and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2701            of this flash sector for the environment. This saves
2702            memory for the RAM copy of the environment.
2703
2704            It may also save flash memory if you decide to use this
2705            when your environment is "embedded" within U-Boot code,
2706            since then the remainder of the flash sector could be used
2707            for U-Boot code. It should be pointed out that this is
2708            STRONGLY DISCOURAGED from a robustness point of view:
2709            updating the environment in flash makes it always
2710            necessary to erase the WHOLE sector. If something goes
2711            wrong before the contents has been restored from a copy in
2712            RAM, your target system will be dead.
2713
2714         - CONFIG_ENV_ADDR_REDUND
2715           CONFIG_ENV_SIZE_REDUND
2716
2717            These settings describe a second storage area used to hold
2718            a redundant copy of the environment data, so that there is
2719            a valid backup copy in case there is a power failure during
2720            a "saveenv" operation.
2721
2722 BE CAREFUL! Any changes to the flash layout, and some changes to the
2723 source code will make it necessary to adapt <board>/u-boot.lds*
2724 accordingly!
2725
2726
2727 - CONFIG_ENV_IS_IN_NVRAM:
2728
2729         Define this if you have some non-volatile memory device
2730         (NVRAM, battery buffered SRAM) which you want to use for the
2731         environment.
2732
2733         - CONFIG_ENV_ADDR:
2734         - CONFIG_ENV_SIZE:
2735
2736           These two #defines are used to determine the memory area you
2737           want to use for environment. It is assumed that this memory
2738           can just be read and written to, without any special
2739           provision.
2740
2741 BE CAREFUL! The first access to the environment happens quite early
2742 in U-Boot initalization (when we try to get the setting of for the
2743 console baudrate). You *MUST* have mapped your NVRAM area then, or
2744 U-Boot will hang.
2745
2746 Please note that even with NVRAM we still use a copy of the
2747 environment in RAM: we could work on NVRAM directly, but we want to
2748 keep settings there always unmodified except somebody uses "saveenv"
2749 to save the current settings.
2750
2751
2752 - CONFIG_ENV_IS_IN_EEPROM:
2753
2754         Use this if you have an EEPROM or similar serial access
2755         device and a driver for it.
2756
2757         - CONFIG_ENV_OFFSET:
2758         - CONFIG_ENV_SIZE:
2759
2760           These two #defines specify the offset and size of the
2761           environment area within the total memory of your EEPROM.
2762
2763         - CONFIG_SYS_I2C_EEPROM_ADDR:
2764           If defined, specified the chip address of the EEPROM device.
2765           The default address is zero.
2766
2767         - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2768           If defined, the number of bits used to address bytes in a
2769           single page in the EEPROM device.  A 64 byte page, for example
2770           would require six bits.
2771
2772         - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2773           If defined, the number of milliseconds to delay between
2774           page writes.  The default is zero milliseconds.
2775
2776         - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2777           The length in bytes of the EEPROM memory array address.  Note
2778           that this is NOT the chip address length!
2779
2780         - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
2781           EEPROM chips that implement "address overflow" are ones
2782           like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2783           address and the extra bits end up in the "chip address" bit
2784           slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2785           byte chips.
2786
2787           Note that we consider the length of the address field to
2788           still be one byte because the extra address bits are hidden
2789           in the chip address.
2790
2791         - CONFIG_SYS_EEPROM_SIZE:
2792           The size in bytes of the EEPROM device.
2793
2794         - CONFIG_ENV_EEPROM_IS_ON_I2C
2795           define this, if you have I2C and SPI activated, and your
2796           EEPROM, which holds the environment, is on the I2C bus.
2797
2798         - CONFIG_I2C_ENV_EEPROM_BUS
2799           if you have an Environment on an EEPROM reached over
2800           I2C muxes, you can define here, how to reach this
2801           EEPROM. For example:
2802
2803           #define CONFIG_I2C_ENV_EEPROM_BUS       "pca9547:70:d\0"
2804
2805           EEPROM which holds the environment, is reached over
2806           a pca9547 i2c mux with address 0x70, channel 3.
2807
2808 - CONFIG_ENV_IS_IN_DATAFLASH:
2809
2810         Define this if you have a DataFlash memory device which you
2811         want to use for the environment.
2812
2813         - CONFIG_ENV_OFFSET:
2814         - CONFIG_ENV_ADDR:
2815         - CONFIG_ENV_SIZE:
2816
2817           These three #defines specify the offset and size of the
2818           environment area within the total memory of your DataFlash placed
2819           at the specified address.
2820
2821 - CONFIG_ENV_IS_IN_NAND:
2822
2823         Define this if you have a NAND device which you want to use
2824         for the environment.
2825
2826         - CONFIG_ENV_OFFSET:
2827         - CONFIG_ENV_SIZE:
2828
2829           These two #defines specify the offset and size of the environment
2830           area within the first NAND device.  CONFIG_ENV_OFFSET must be
2831           aligned to an erase block boundary.
2832
2833         - CONFIG_ENV_OFFSET_REDUND (optional):
2834
2835           This setting describes a second storage area of CONFIG_ENV_SIZE
2836           size used to hold a redundant copy of the environment data, so
2837           that there is a valid backup copy in case there is a power failure
2838           during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2839           aligned to an erase block boundary.
2840
2841         - CONFIG_ENV_RANGE (optional):
2842
2843           Specifies the length of the region in which the environment
2844           can be written.  This should be a multiple of the NAND device's
2845           block size.  Specifying a range with more erase blocks than
2846           are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2847           the range to be avoided.
2848
2849         - CONFIG_ENV_OFFSET_OOB (optional):
2850
2851           Enables support for dynamically retrieving the offset of the
2852           environment from block zero's out-of-band data.  The
2853           "nand env.oob" command can be used to record this offset.
2854           Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2855           using CONFIG_ENV_OFFSET_OOB.
2856
2857 - CONFIG_NAND_ENV_DST
2858
2859         Defines address in RAM to which the nand_spl code should copy the
2860         environment. If redundant environment is used, it will be copied to
2861         CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2862
2863 - CONFIG_SYS_SPI_INIT_OFFSET
2864
2865         Defines offset to the initial SPI buffer area in DPRAM. The
2866         area is used at an early stage (ROM part) if the environment
2867         is configured to reside in the SPI EEPROM: We need a 520 byte
2868         scratch DPRAM area. It is used between the two initialization
2869         calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2870         to be a good choice since it makes it far enough from the
2871         start of the data area as well as from the stack pointer.
2872
2873 Please note that the environment is read-only until the monitor
2874 has been relocated to RAM and a RAM copy of the environment has been
2875 created; also, when using EEPROM you will have to use getenv_f()
2876 until then to read environment variables.
2877
2878 The environment is protected by a CRC32 checksum. Before the monitor
2879 is relocated into RAM, as a result of a bad CRC you will be working
2880 with the compiled-in default environment - *silently*!!! [This is
2881 necessary, because the first environment variable we need is the
2882 "baudrate" setting for the console - if we have a bad CRC, we don't
2883 have any device yet where we could complain.]
2884
2885 Note: once the monitor has been relocated, then it will complain if
2886 the default environment is used; a new CRC is computed as soon as you
2887 use the "saveenv" command to store a valid environment.
2888
2889 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2890                 Echo the inverted Ethernet link state to the fault LED.
2891
2892                 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2893                       also needs to be defined.
2894
2895 - CONFIG_SYS_FAULT_MII_ADDR:
2896                 MII address of the PHY to check for the Ethernet link state.
2897
2898 - CONFIG_NS16550_MIN_FUNCTIONS:
2899                 Define this if you desire to only have use of the NS16550_init
2900                 and NS16550_putc functions for the serial driver located at
2901                 drivers/serial/ns16550.c.  This option is useful for saving
2902                 space for already greatly restricted images, including but not
2903                 limited to NAND_SPL configurations.
2904
2905 Low Level (hardware related) configuration options:
2906 ---------------------------------------------------
2907
2908 - CONFIG_SYS_CACHELINE_SIZE:
2909                 Cache Line Size of the CPU.
2910
2911 - CONFIG_SYS_DEFAULT_IMMR:
2912                 Default address of the IMMR after system reset.
2913
2914                 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2915                 and RPXsuper) to be able to adjust the position of
2916                 the IMMR register after a reset.
2917
2918 - CONFIG_SYS_CCSRBAR_DEFAULT:
2919                 Default (power-on reset) physical address of CCSR on Freescale
2920                 PowerPC SOCs.
2921
2922 - CONFIG_SYS_CCSRBAR:
2923                 Virtual address of CCSR.  On a 32-bit build, this is typically
2924                 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2925
2926                 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2927                 for cross-platform code that uses that macro instead.
2928
2929 - CONFIG_SYS_CCSRBAR_PHYS:
2930                 Physical address of CCSR.  CCSR can be relocated to a new
2931                 physical address, if desired.  In this case, this macro should
2932                 be set to that address.  Otherwise, it should be set to the
2933                 same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2934                 is typically relocated on 36-bit builds.  It is recommended
2935                 that this macro be defined via the _HIGH and _LOW macros:
2936
2937                 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2938                         * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2939
2940 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2941                 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
2942                 either 0 (32-bit build) or 0xF (36-bit build).  This macro is
2943                 used in assembly code, so it must not contain typecasts or
2944                 integer size suffixes (e.g. "ULL").
2945
2946 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
2947                 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2948                 used in assembly code, so it must not contain typecasts or
2949                 integer size suffixes (e.g. "ULL").
2950
2951 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2952                 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2953                 forced to a value that ensures that CCSR is not relocated.
2954
2955 - Floppy Disk Support:
2956                 CONFIG_SYS_FDC_DRIVE_NUMBER
2957
2958                 the default drive number (default value 0)
2959
2960                 CONFIG_SYS_ISA_IO_STRIDE
2961
2962                 defines the spacing between FDC chipset registers
2963                 (default value 1)
2964
2965                 CONFIG_SYS_ISA_IO_OFFSET
2966
2967                 defines the offset of register from address. It
2968                 depends on which part of the data bus is connected to
2969                 the FDC chipset. (default value 0)
2970
2971                 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2972                 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
2973                 default value.
2974
2975                 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
2976                 fdc_hw_init() is called at the beginning of the FDC
2977                 setup. fdc_hw_init() must be provided by the board
2978                 source code. It is used to make hardware dependant
2979                 initializations.
2980
2981 - CONFIG_IDE_AHB:
2982                 Most IDE controllers were designed to be connected with PCI
2983                 interface. Only few of them were designed for AHB interface.
2984                 When software is doing ATA command and data transfer to
2985                 IDE devices through IDE-AHB controller, some additional
2986                 registers accessing to these kind of IDE-AHB controller
2987                 is requierd.
2988
2989 - CONFIG_SYS_IMMR:      Physical address of the Internal Memory.
2990                 DO NOT CHANGE unless you know exactly what you're
2991                 doing! (11-4) [MPC8xx/82xx systems only]
2992
2993 - CONFIG_SYS_INIT_RAM_ADDR:
2994
2995                 Start address of memory area that can be used for
2996                 initial data and stack; please note that this must be
2997                 writable memory that is working WITHOUT special
2998                 initialization, i. e. you CANNOT use normal RAM which
2999                 will become available only after programming the
3000                 memory controller and running certain initialization
3001                 sequences.
3002
3003                 U-Boot uses the following memory types:
3004                 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3005                 - MPC824X: data cache
3006                 - PPC4xx:  data cache
3007
3008 - CONFIG_SYS_GBL_DATA_OFFSET:
3009
3010                 Offset of the initial data structure in the memory
3011                 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3012                 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3013                 data is located at the end of the available space
3014                 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3015                 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3016                 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3017                 CONFIG_SYS_GBL_DATA_OFFSET) downward.
3018
3019         Note:
3020                 On the MPC824X (or other systems that use the data
3021                 cache for initial memory) the address chosen for
3022                 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3023                 point to an otherwise UNUSED address space between
3024                 the top of RAM and the start of the PCI space.
3025
3026 - CONFIG_SYS_SIUMCR:    SIU Module Configuration (11-6)
3027
3028 - CONFIG_SYS_SYPCR:     System Protection Control (11-9)
3029
3030 - CONFIG_SYS_TBSCR:     Time Base Status and Control (11-26)
3031
3032 - CONFIG_SYS_PISCR:     Periodic Interrupt Status and Control (11-31)
3033
3034 - CONFIG_SYS_PLPRCR:    PLL, Low-Power, and Reset Control Register (15-30)
3035
3036 - CONFIG_SYS_SCCR:      System Clock and reset Control Register (15-27)
3037
3038 - CONFIG_SYS_OR_TIMING_SDRAM:
3039                 SDRAM timing
3040
3041 - CONFIG_SYS_MAMR_PTA:
3042                 periodic timer for refresh
3043
3044 - CONFIG_SYS_DER:       Debug Event Register (37-47)
3045
3046 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3047   CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3048   CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3049   CONFIG_SYS_BR1_PRELIM:
3050                 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3051
3052 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
3053   CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3054   CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3055                 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3056
3057 - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3058   CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3059                 Machine Mode Register and Memory Periodic Timer
3060                 Prescaler definitions (SDRAM timing)
3061
3062 - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3063                 enable I2C microcode relocation patch (MPC8xx);
3064                 define relocation offset in DPRAM [DSP2]
3065
3066 - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3067                 enable SMC microcode relocation patch (MPC8xx);
3068                 define relocation offset in DPRAM [SMC1]
3069
3070 - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3071                 enable SPI microcode relocation patch (MPC8xx);
3072                 define relocation offset in DPRAM [SCC4]
3073
3074 - CONFIG_SYS_USE_OSCCLK:
3075                 Use OSCM clock mode on MBX8xx board. Be careful,
3076                 wrong setting might damage your board. Read
3077                 doc/README.MBX before setting this variable!
3078
3079 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3080                 Offset of the bootmode word in DPRAM used by post
3081                 (Power On Self Tests). This definition overrides
3082                 #define'd default value in commproc.h resp.
3083                 cpm_8260.h.
3084
3085 - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3086   CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3087   CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3088   CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3089   CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3090   CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3091   CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3092   CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3093                 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
3094
3095 - CONFIG_PCI_DISABLE_PCIE:
3096                 Disable PCI-Express on systems where it is supported but not
3097                 required.
3098
3099 - CONFIG_SYS_SRIO:
3100                 Chip has SRIO or not
3101
3102 - CONFIG_SRIO1:
3103                 Board has SRIO 1 port available
3104
3105 - CONFIG_SRIO2:
3106                 Board has SRIO 2 port available
3107
3108 - CONFIG_SYS_SRIOn_MEM_VIRT:
3109                 Virtual Address of SRIO port 'n' memory region
3110
3111 - CONFIG_SYS_SRIOn_MEM_PHYS:
3112                 Physical Address of SRIO port 'n' memory region
3113
3114 - CONFIG_SYS_SRIOn_MEM_SIZE:
3115                 Size of SRIO port 'n' memory region
3116
3117 - CONFIG_SYS_NDFC_16
3118                 Defined to tell the NDFC that the NAND chip is using a
3119                 16 bit bus.
3120
3121 - CONFIG_SYS_NDFC_EBC0_CFG
3122                 Sets the EBC0_CFG register for the NDFC. If not defined
3123                 a default value will be used.
3124
3125 - CONFIG_SPD_EEPROM
3126                 Get DDR timing information from an I2C EEPROM. Common
3127                 with pluggable memory modules such as SODIMMs
3128
3129   SPD_EEPROM_ADDRESS
3130                 I2C address of the SPD EEPROM
3131
3132 - CONFIG_SYS_SPD_BUS_NUM
3133                 If SPD EEPROM is on an I2C bus other than the first
3134                 one, specify here. Note that the value must resolve
3135                 to something your driver can deal with.
3136
3137 - CONFIG_SYS_DDR_RAW_TIMING
3138                 Get DDR timing information from other than SPD. Common with
3139                 soldered DDR chips onboard without SPD. DDR raw timing
3140                 parameters are extracted from datasheet and hard-coded into
3141                 header files or board specific files.
3142
3143 - CONFIG_FSL_DDR_INTERACTIVE
3144                 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3145
3146 - CONFIG_SYS_83XX_DDR_USES_CS0
3147                 Only for 83xx systems. If specified, then DDR should
3148                 be configured using CS0 and CS1 instead of CS2 and CS3.
3149
3150 - CONFIG_ETHER_ON_FEC[12]
3151                 Define to enable FEC[12] on a 8xx series processor.
3152
3153 - CONFIG_FEC[12]_PHY
3154                 Define to the hardcoded PHY address which corresponds
3155                 to the given FEC; i. e.
3156                         #define CONFIG_FEC1_PHY 4
3157                 means that the PHY with address 4 is connected to FEC1
3158
3159                 When set to -1, means to probe for first available.
3160
3161 - CONFIG_FEC[12]_PHY_NORXERR
3162                 The PHY does not have a RXERR line (RMII only).
3163                 (so program the FEC to ignore it).
3164
3165 - CONFIG_RMII
3166                 Enable RMII mode for all FECs.
3167                 Note that this is a global option, we can't
3168                 have one FEC in standard MII mode and another in RMII mode.
3169
3170 - CONFIG_CRC32_VERIFY
3171                 Add a verify option to the crc32 command.
3172                 The syntax is:
3173
3174                 => crc32 -v <address> <count> <crc32>
3175
3176                 Where address/count indicate a memory area
3177                 and crc32 is the correct crc32 which the
3178                 area should have.
3179
3180 - CONFIG_LOOPW
3181                 Add the "loopw" memory command. This only takes effect if
3182                 the memory commands are activated globally (CONFIG_CMD_MEM).
3183
3184 - CONFIG_MX_CYCLIC
3185                 Add the "mdc" and "mwc" memory commands. These are cyclic
3186                 "md/mw" commands.
3187                 Examples:
3188
3189                 => mdc.b 10 4 500
3190                 This command will print 4 bytes (10,11,12,13) each 500 ms.
3191
3192                 => mwc.l 100 12345678 10
3193                 This command will write 12345678 to address 100 all 10 ms.
3194
3195                 This only takes effect if the memory commands are activated
3196                 globally (CONFIG_CMD_MEM).
3197
3198 - CONFIG_SKIP_LOWLEVEL_INIT
3199                 [ARM, NDS32, MIPS only] If this variable is defined, then certain
3200                 low level initializations (like setting up the memory
3201                 controller) are omitted and/or U-Boot does not
3202                 relocate itself into RAM.
3203
3204                 Normally this variable MUST NOT be defined. The only
3205                 exception is when U-Boot is loaded (to RAM) by some
3206                 other boot loader or by a debugger which performs
3207                 these initializations itself.
3208
3209 - CONFIG_SPL_BUILD
3210                 Modifies the behaviour of start.S when compiling a loader
3211                 that is executed before the actual U-Boot. E.g. when
3212                 compiling a NAND SPL.
3213
3214 - CONFIG_USE_ARCH_MEMCPY
3215   CONFIG_USE_ARCH_MEMSET
3216                 If these options are used a optimized version of memcpy/memset will
3217                 be used if available. These functions may be faster under some
3218                 conditions but may increase the binary size.
3219
3220 Building the Software:
3221 ======================
3222
3223 Building U-Boot has been tested in several native build environments
3224 and in many different cross environments. Of course we cannot support
3225 all possibly existing versions of cross development tools in all
3226 (potentially obsolete) versions. In case of tool chain problems we
3227 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3228 which is extensively used to build and test U-Boot.
3229
3230 If you are not using a native environment, it is assumed that you
3231 have GNU cross compiling tools available in your path. In this case,
3232 you must set the environment variable CROSS_COMPILE in your shell.
3233 Note that no changes to the Makefile or any other source files are
3234 necessary. For example using the ELDK on a 4xx CPU, please enter:
3235
3236         $ CROSS_COMPILE=ppc_4xx-
3237         $ export CROSS_COMPILE
3238
3239 Note: If you wish to generate Windows versions of the utilities in
3240       the tools directory you can use the MinGW toolchain
3241       (http://www.mingw.org).  Set your HOST tools to the MinGW
3242       toolchain and execute 'make tools'.  For example:
3243
3244        $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3245
3246       Binaries such as tools/mkimage.exe will be created which can
3247       be executed on computers running Windows.
3248
3249 U-Boot is intended to be simple to build. After installing the
3250 sources you must configure U-Boot for one specific board type. This
3251 is done by typing:
3252
3253         make NAME_config
3254
3255 where "NAME_config" is the name of one of the existing configu-
3256 rations; see the main Makefile for supported names.
3257
3258 Note: for some board special configuration names may exist; check if
3259       additional information is available from the board vendor; for
3260       instance, the TQM823L systems are available without (standard)
3261       or with LCD support. You can select such additional "features"
3262       when choosing the configuration, i. e.
3263
3264       make TQM823L_config
3265         - will configure for a plain TQM823L, i. e. no LCD support
3266
3267       make TQM823L_LCD_config
3268         - will configure for a TQM823L with U-Boot console on LCD
3269
3270       etc.
3271
3272
3273 Finally, type "make all", and you should get some working U-Boot
3274 images ready for download to / installation on your system:
3275
3276 - "u-boot.bin" is a raw binary image
3277 - "u-boot" is an image in ELF binary format
3278 - "u-boot.srec" is in Motorola S-Record format
3279
3280 By default the build is performed locally and the objects are saved
3281 in the source directory. One of the two methods can be used to change
3282 this behavior and build U-Boot to some external directory:
3283
3284 1. Add O= to the make command line invocations:
3285
3286         make O=/tmp/build distclean
3287         make O=/tmp/build NAME_config
3288         make O=/tmp/build all
3289
3290 2. Set environment variable BUILD_DIR to point to the desired location:
3291
3292         export BUILD_DIR=/tmp/build
3293         make distclean
3294         make NAME_config
3295         make all
3296
3297 Note that the command line "O=" setting overrides the BUILD_DIR environment
3298 variable.
3299
3300
3301 Please be aware that the Makefiles assume you are using GNU make, so
3302 for instance on NetBSD you might need to use "gmake" instead of
3303 native "make".
3304
3305
3306 If the system board that you have is not listed, then you will need
3307 to port U-Boot to your hardware platform. To do this, follow these
3308 steps:
3309
3310 1.  Add a new configuration option for your board to the toplevel
3311     "Makefile" and to the "MAKEALL" script, using the existing
3312     entries as examples. Note that here and at many other places
3313     boards and other names are listed in alphabetical sort order. Please
3314     keep this order.
3315 2.  Create a new directory to hold your board specific code. Add any
3316     files you need. In your board directory, you will need at least
3317     the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
3318 3.  Create a new configuration file "include/configs/<board>.h" for
3319     your board
3320 3.  If you're porting U-Boot to a new CPU, then also create a new
3321     directory to hold your CPU specific code. Add any files you need.
3322 4.  Run "make <board>_config" with your new name.
3323 5.  Type "make", and you should get a working "u-boot.srec" file
3324     to be installed on your target system.
3325 6.  Debug and solve any problems that might arise.
3326     [Of course, this last step is much harder than it sounds.]
3327
3328
3329 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3330 ==============================================================
3331
3332 If you have modified U-Boot sources (for instance added a new board
3333 or support for new devices, a new CPU, etc.) you are expected to
3334 provide feedback to the other developers. The feedback normally takes
3335 the form of a "patch", i. e. a context diff against a certain (latest
3336 official or latest in the git repository) version of U-Boot sources.
3337
3338 But before you submit such a patch, please verify that your modifi-
3339 cation did not break existing code. At least make sure that *ALL* of
3340 the supported boards compile WITHOUT ANY compiler warnings. To do so,
3341 just run the "MAKEALL" script, which will configure and build U-Boot
3342 for ALL supported system. Be warned, this will take a while. You can
3343 select which (cross) compiler to use by passing a `CROSS_COMPILE'
3344 environment variable to the script, i. e. to use the ELDK cross tools
3345 you can type
3346
3347         CROSS_COMPILE=ppc_8xx- MAKEALL
3348
3349 or to build on a native PowerPC system you can type
3350
3351         CROSS_COMPILE=' ' MAKEALL
3352
3353 When using the MAKEALL script, the default behaviour is to build
3354 U-Boot in the source directory. This location can be changed by
3355 setting the BUILD_DIR environment variable. Also, for each target
3356 built, the MAKEALL script saves two log files (<target>.ERR and
3357 <target>.MAKEALL) in the <source dir>/LOG directory. This default
3358 location can be changed by setting the MAKEALL_LOGDIR environment
3359 variable. For example:
3360
3361         export BUILD_DIR=/tmp/build
3362         export MAKEALL_LOGDIR=/tmp/log
3363         CROSS_COMPILE=ppc_8xx- MAKEALL
3364
3365 With the above settings build objects are saved in the /tmp/build,
3366 log files are saved in the /tmp/log and the source tree remains clean
3367 during the whole build process.
3368
3369
3370 See also "U-Boot Porting Guide" below.
3371
3372
3373 Monitor Commands - Overview:
3374 ============================
3375
3376 go      - start application at address 'addr'
3377 run     - run commands in an environment variable
3378 bootm   - boot application image from memory
3379 bootp   - boot image via network using BootP/TFTP protocol
3380 tftpboot- boot image via network using TFTP protocol
3381                and env variables "ipaddr" and "serverip"
3382                (and eventually "gatewayip")
3383 tftpput - upload a file via network using TFTP protocol
3384 rarpboot- boot image via network using RARP/TFTP protocol
3385 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3386 loads   - load S-Record file over serial line
3387 loadb   - load binary file over serial line (kermit mode)
3388 md      - memory display
3389 mm      - memory modify (auto-incrementing)
3390 nm      - memory modify (constant address)
3391 mw      - memory write (fill)
3392 cp      - memory copy
3393 cmp     - memory compare
3394 crc32   - checksum calculation
3395 i2c     - I2C sub-system
3396 sspi    - SPI utility commands
3397 base    - print or set address offset
3398 printenv- print environment variables
3399 setenv  - set environment variables
3400 saveenv - save environment variables to persistent storage
3401 protect - enable or disable FLASH write protection
3402 erase   - erase FLASH memory
3403 flinfo  - print FLASH memory information
3404 bdinfo  - print Board Info structure
3405 iminfo  - print header information for application image
3406 coninfo - print console devices and informations
3407 ide     - IDE sub-system
3408 loop    - infinite loop on address range
3409 loopw   - infinite write loop on address range
3410 mtest   - simple RAM test
3411 icache  - enable or disable instruction cache
3412 dcache  - enable or disable data cache
3413 reset   - Perform RESET of the CPU
3414 echo    - echo args to console
3415 version - print monitor version
3416 help    - print online help
3417 ?       - alias for 'help'
3418
3419
3420 Monitor Commands - Detailed Description:
3421 ========================================
3422
3423 TODO.
3424
3425 For now: just type "help <command>".
3426
3427
3428 Environment Variables:
3429 ======================
3430
3431 U-Boot supports user configuration using Environment Variables which
3432 can be made persistent by saving to Flash memory.
3433
3434 Environment Variables are set using "setenv", printed using
3435 "printenv", and saved to Flash using "saveenv". Using "setenv"
3436 without a value can be used to delete a variable from the
3437 environment. As long as you don't save the environment you are
3438 working with an in-memory copy. In case the Flash area containing the
3439 environment is erased by accident, a default environment is provided.
3440
3441 Some configuration options can be set using Environment Variables.
3442
3443 List of environment variables (most likely not complete):
3444
3445   baudrate      - see CONFIG_BAUDRATE
3446
3447   bootdelay     - see CONFIG_BOOTDELAY
3448
3449   bootcmd       - see CONFIG_BOOTCOMMAND
3450
3451   bootargs      - Boot arguments when booting an RTOS image
3452
3453   bootfile      - Name of the image to load with TFTP
3454
3455   bootm_low     - Memory range available for image processing in the bootm
3456                   command can be restricted. This variable is given as
3457                   a hexadecimal number and defines lowest address allowed
3458                   for use by the bootm command. See also "bootm_size"
3459                   environment variable. Address defined by "bootm_low" is
3460                   also the base of the initial memory mapping for the Linux
3461                   kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3462                   bootm_mapsize.
3463
3464   bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3465                   This variable is given as a hexadecimal number and it
3466                   defines the size of the memory region starting at base
3467                   address bootm_low that is accessible by the Linux kernel
3468                   during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3469                   as the default value if it is defined, and bootm_size is
3470                   used otherwise.
3471
3472   bootm_size    - Memory range available for image processing in the bootm
3473                   command can be restricted. This variable is given as
3474                   a hexadecimal number and defines the size of the region
3475                   allowed for use by the bootm command. See also "bootm_low"
3476                   environment variable.
3477
3478   updatefile    - Location of the software update file on a TFTP server, used
3479                   by the automatic software update feature. Please refer to
3480                   documentation in doc/README.update for more details.
3481
3482   autoload      - if set to "no" (any string beginning with 'n'),
3483                   "bootp" will just load perform a lookup of the
3484                   configuration from the BOOTP server, but not try to
3485                   load any image using TFTP
3486
3487   autostart     - if set to "yes", an image loaded using the "bootp",
3488                   "rarpboot", "tftpboot" or "diskboot" commands will
3489                   be automatically started (by internally calling
3490                   "bootm")
3491
3492                   If set to "no", a standalone image passed to the
3493                   "bootm" command will be copied to the load address
3494                   (and eventually uncompressed), but NOT be started.
3495                   This can be used to load and uncompress arbitrary
3496                   data.
3497
3498   fdt_high      - if set this restricts the maximum address that the
3499                   flattened device tree will be copied into upon boot.
3500                   If this is set to the special value 0xFFFFFFFF then
3501                   the fdt will not be copied at all on boot.  For this
3502                   to work it must reside in writable memory, have
3503                   sufficient padding on the end of it for u-boot to
3504                   add the information it needs into it, and the memory
3505                   must be accessible by the kernel.
3506
3507   fdtcontroladdr- if set this is the address of the control flattened
3508                   device tree used by U-Boot when CONFIG_OF_CONTROL is
3509                   defined.
3510
3511   i2cfast       - (PPC405GP|PPC405EP only)
3512                   if set to 'y' configures Linux I2C driver for fast
3513                   mode (400kHZ). This environment variable is used in
3514                   initialization code. So, for changes to be effective
3515                   it must be saved and board must be reset.
3516
3517   initrd_high   - restrict positioning of initrd images:
3518                   If this variable is not set, initrd images will be
3519                   copied to the highest possible address in RAM; this
3520                   is usually what you want since it allows for
3521                   maximum initrd size. If for some reason you want to
3522                   make sure that the initrd image is loaded below the
3523                   CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3524                   variable to a value of "no" or "off" or "0".
3525                   Alternatively, you can set it to a maximum upper
3526                   address to use (U-Boot will still check that it
3527                   does not overwrite the U-Boot stack and data).
3528
3529                   For instance, when you have a system with 16 MB
3530                   RAM, and want to reserve 4 MB from use by Linux,
3531                   you can do this by adding "mem=12M" to the value of
3532                   the "bootargs" variable. However, now you must make
3533                   sure that the initrd image is placed in the first
3534                   12 MB as well - this can be done with
3535
3536                   setenv initrd_high 00c00000
3537
3538                   If you set initrd_high to 0xFFFFFFFF, this is an
3539                   indication to U-Boot that all addresses are legal
3540                   for the Linux kernel, including addresses in flash
3541                   memory. In this case U-Boot will NOT COPY the
3542                   ramdisk at all. This may be useful to reduce the
3543                   boot time on your system, but requires that this
3544                   feature is supported by your Linux kernel.
3545
3546   ipaddr        - IP address; needed for tftpboot command
3547
3548   loadaddr      - Default load address for commands like "bootp",
3549                   "rarpboot", "tftpboot", "loadb" or "diskboot"
3550
3551   loads_echo    - see CONFIG_LOADS_ECHO
3552
3553   serverip      - TFTP server IP address; needed for tftpboot command
3554
3555   bootretry     - see CONFIG_BOOT_RETRY_TIME
3556
3557   bootdelaykey  - see CONFIG_AUTOBOOT_DELAY_STR
3558
3559   bootstopkey   - see CONFIG_AUTOBOOT_STOP_STR
3560
3561   ethprime      - controls which interface is used first.
3562
3563   ethact        - controls which interface is currently active.
3564                   For example you can do the following
3565
3566                   => setenv ethact FEC
3567                   => ping 192.168.0.1 # traffic sent on FEC
3568                   => setenv ethact SCC
3569                   => ping 10.0.0.1 # traffic sent on SCC
3570
3571   ethrotate     - When set to "no" U-Boot does not go through all
3572                   available network interfaces.
3573                   It just stays at the currently selected interface.
3574
3575   netretry      - When set to "no" each network operation will
3576                   either succeed or fail without retrying.
3577                   When set to "once" the network operation will
3578                   fail when all the available network interfaces
3579                   are tried once without success.
3580                   Useful on scripts which control the retry operation
3581                   themselves.
3582
3583   npe_ucode     - set load address for the NPE microcode
3584
3585   tftpsrcport   - If this is set, the value is used for TFTP's
3586                   UDP source port.
3587
3588   tftpdstport   - If this is set, the value is used for TFTP's UDP
3589                   destination port instead of the Well Know Port 69.
3590
3591   tftpblocksize - Block size to use for TFTP transfers; if not set,
3592                   we use the TFTP server's default block size
3593
3594   tftptimeout   - Retransmission timeout for TFTP packets (in milli-
3595                   seconds, minimum value is 1000 = 1 second). Defines
3596                   when a packet is considered to be lost so it has to
3597                   be retransmitted. The default is 5000 = 5 seconds.
3598                   Lowering this value may make downloads succeed
3599                   faster in networks with high packet loss rates or
3600                   with unreliable TFTP servers.
3601
3602   vlan          - When set to a value < 4095 the traffic over
3603                   Ethernet is encapsulated/received over 802.1q
3604                   VLAN tagged frames.
3605
3606 The following image location variables contain the location of images
3607 used in booting. The "Image" column gives the role of the image and is
3608 not an environment variable name. The other columns are environment
3609 variable names. "File Name" gives the name of the file on a TFTP
3610 server, "RAM Address" gives the location in RAM the image will be
3611 loaded to, and "Flash Location" gives the image's address in NOR
3612 flash or offset in NAND flash.
3613
3614 *Note* - these variables don't have to be defined for all boards, some
3615 boards currenlty use other variables for these purposes, and some
3616 boards use these variables for other purposes.
3617
3618 Image               File Name        RAM Address       Flash Location
3619 -----               ---------        -----------       --------------
3620 u-boot              u-boot           u-boot_addr_r     u-boot_addr
3621 Linux kernel        bootfile         kernel_addr_r     kernel_addr
3622 device tree blob    fdtfile          fdt_addr_r        fdt_addr
3623 ramdisk             ramdiskfile      ramdisk_addr_r    ramdisk_addr
3624
3625 The following environment variables may be used and automatically
3626 updated by the network boot commands ("bootp" and "rarpboot"),
3627 depending the information provided by your boot server:
3628
3629   bootfile      - see above
3630   dnsip         - IP address of your Domain Name Server
3631   dnsip2        - IP address of your secondary Domain Name Server
3632   gatewayip     - IP address of the Gateway (Router) to use
3633   hostname      - Target hostname
3634   ipaddr        - see above
3635   netmask       - Subnet Mask
3636   rootpath      - Pathname of the root filesystem on the NFS server
3637   serverip      - see above
3638
3639
3640 There are two special Environment Variables:
3641
3642   serial#       - contains hardware identification information such
3643                   as type string and/or serial number
3644   ethaddr       - Ethernet address
3645
3646 These variables can be set only once (usually during manufacturing of
3647 the board). U-Boot refuses to delete or overwrite these variables
3648 once they have been set once.
3649
3650
3651 Further special Environment Variables:
3652
3653   ver           - Contains the U-Boot version string as printed
3654                   with the "version" command. This variable is
3655                   readonly (see CONFIG_VERSION_VARIABLE).
3656
3657
3658 Please note that changes to some configuration parameters may take
3659 only effect after the next boot (yes, that's just like Windoze :-).
3660
3661
3662 Command Line Parsing:
3663 =====================
3664
3665 There are two different command line parsers available with U-Boot:
3666 the old "simple" one, and the much more powerful "hush" shell:
3667
3668 Old, simple command line parser:
3669 --------------------------------
3670
3671 - supports environment variables (through setenv / saveenv commands)
3672 - several commands on one line, separated by ';'
3673 - variable substitution using "... ${name} ..." syntax
3674 - special characters ('$', ';') can be escaped by prefixing with '\',
3675   for example:
3676         setenv bootcmd bootm \${address}
3677 - You can also escape text by enclosing in single apostrophes, for example:
3678         setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3679
3680 Hush shell:
3681 -----------
3682
3683 - similar to Bourne shell, with control structures like
3684   if...then...else...fi, for...do...done; while...do...done,
3685   until...do...done, ...
3686 - supports environment ("global") variables (through setenv / saveenv
3687   commands) and local shell variables (through standard shell syntax
3688   "name=value"); only environment variables can be used with "run"
3689   command
3690
3691 General rules:
3692 --------------
3693
3694 (1) If a command line (or an environment variable executed by a "run"
3695     command) contains several commands separated by semicolon, and
3696     one of these commands fails, then the remaining commands will be
3697     executed anyway.
3698
3699 (2) If you execute several variables with one call to run (i. e.
3700     calling run with a list of variables as arguments), any failing
3701     command will cause "run" to terminate, i. e. the remaining
3702     variables are not executed.
3703
3704 Note for Redundant Ethernet Interfaces:
3705 =======================================
3706
3707 Some boards come with redundant Ethernet interfaces; U-Boot supports
3708 such configurations and is capable of automatic selection of a
3709 "working" interface when needed. MAC assignment works as follows:
3710
3711 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3712 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3713 "eth1addr" (=>eth1), "eth2addr", ...
3714
3715 If the network interface stores some valid MAC address (for instance
3716 in SROM), this is used as default address if there is NO correspon-
3717 ding setting in the environment; if the corresponding environment
3718 variable is set, this overrides the settings in the card; that means:
3719
3720 o If the SROM has a valid MAC address, and there is no address in the
3721   environment, the SROM's address is used.
3722
3723 o If there is no valid address in the SROM, and a definition in the
3724   environment exists, then the value from the environment variable is
3725   used.
3726
3727 o If both the SROM and the environment contain a MAC address, and
3728   both addresses are the same, this MAC address is used.
3729
3730 o If both the SROM and the environment contain a MAC address, and the
3731   addresses differ, the value from the environment is used and a
3732   warning is printed.
3733
3734 o If neither SROM nor the environment contain a MAC address, an error
3735   is raised.
3736
3737 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3738 will be programmed into hardware as part of the initialization process.  This
3739 may be skipped by setting the appropriate 'ethmacskip' environment variable.
3740 The naming convention is as follows:
3741 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3742
3743 Image Formats:
3744 ==============
3745
3746 U-Boot is capable of booting (and performing other auxiliary operations on)
3747 images in two formats:
3748
3749 New uImage format (FIT)
3750 -----------------------
3751
3752 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3753 to Flattened Device Tree). It allows the use of images with multiple
3754 components (several kernels, ramdisks, etc.), with contents protected by
3755 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3756
3757
3758 Old uImage format
3759 -----------------
3760
3761 Old image format is based on binary files which can be basically anything,
3762 preceded by a special header; see the definitions in include/image.h for
3763 details; basically, the header defines the following image properties:
3764
3765 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3766   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3767   LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3768   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3769   INTEGRITY).
3770 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3771   IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3772   Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
3773 * Compression Type (uncompressed, gzip, bzip2)
3774 * Load Address
3775 * Entry Point
3776 * Image Name
3777 * Image Timestamp
3778
3779 The header is marked by a special Magic Number, and both the header
3780 and the data portions of the image are secured against corruption by
3781 CRC32 checksums.
3782
3783
3784 Linux Support:
3785 ==============
3786
3787 Although U-Boot should support any OS or standalone application
3788 easily, the main focus has always been on Linux during the design of
3789 U-Boot.
3790
3791 U-Boot includes many features that so far have been part of some
3792 special "boot loader" code within the Linux kernel. Also, any
3793 "initrd" images to be used are no longer part of one big Linux image;
3794 instead, kernel and "initrd" are separate images. This implementation
3795 serves several purposes:
3796
3797 - the same features can be used for other OS or standalone
3798   applications (for instance: using compressed images to reduce the
3799   Flash memory footprint)
3800
3801 - it becomes much easier to port new Linux kernel versions because
3802   lots of low-level, hardware dependent stuff are done by U-Boot
3803
3804 - the same Linux kernel image can now be used with different "initrd"
3805   images; of course this also means that different kernel images can
3806   be run with the same "initrd". This makes testing easier (you don't
3807   have to build a new "zImage.initrd" Linux image when you just
3808   change a file in your "initrd"). Also, a field-upgrade of the
3809   software is easier now.
3810
3811
3812 Linux HOWTO:
3813 ============
3814
3815 Porting Linux to U-Boot based systems:
3816 ---------------------------------------
3817
3818 U-Boot cannot save you from doing all the necessary modifications to
3819 configure the Linux device drivers for use with your target hardware
3820 (no, we don't intend to provide a full virtual machine interface to
3821 Linux :-).
3822
3823 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3824
3825 Just make sure your machine specific header file (for instance
3826 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3827 Information structure as we define in include/asm-<arch>/u-boot.h,
3828 and make sure that your definition of IMAP_ADDR uses the same value
3829 as your U-Boot configuration in CONFIG_SYS_IMMR.
3830
3831
3832 Configuring the Linux kernel:
3833 -----------------------------
3834
3835 No specific requirements for U-Boot. Make sure you have some root
3836 device (initial ramdisk, NFS) for your target system.
3837
3838
3839 Building a Linux Image:
3840 -----------------------
3841
3842 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3843 not used. If you use recent kernel source, a new build target
3844 "uImage" will exist which automatically builds an image usable by
3845 U-Boot. Most older kernels also have support for a "pImage" target,
3846 which was introduced for our predecessor project PPCBoot and uses a
3847 100% compatible format.
3848
3849 Example:
3850
3851         make TQM850L_config
3852         make oldconfig
3853         make dep
3854         make uImage
3855
3856 The "uImage" build target uses a special tool (in 'tools/mkimage') to
3857 encapsulate a compressed Linux kernel image with header  information,
3858 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3859
3860 * build a standard "vmlinux" kernel image (in ELF binary format):
3861
3862 * convert the kernel into a raw binary image:
3863
3864         ${CROSS_COMPILE}-objcopy -O binary \
3865                                  -R .note -R .comment \
3866                                  -S vmlinux linux.bin
3867
3868 * compress the binary image:
3869
3870         gzip -9 linux.bin
3871
3872 * package compressed binary image for U-Boot:
3873
3874         mkimage -A ppc -O linux -T kernel -C gzip \
3875                 -a 0 -e 0 -n "Linux Kernel Image" \
3876                 -d linux.bin.gz uImage
3877
3878
3879 The "mkimage" tool can also be used to create ramdisk images for use
3880 with U-Boot, either separated from the Linux kernel image, or
3881 combined into one file. "mkimage" encapsulates the images with a 64
3882 byte header containing information about target architecture,
3883 operating system, image type, compression method, entry points, time
3884 stamp, CRC32 checksums, etc.
3885
3886 "mkimage" can be called in two ways: to verify existing images and
3887 print the header information, or to build new images.
3888
3889 In the first form (with "-l" option) mkimage lists the information
3890 contained in the header of an existing U-Boot image; this includes
3891 checksum verification:
3892
3893         tools/mkimage -l image
3894           -l ==> list image header information
3895
3896 The second form (with "-d" option) is used to build a U-Boot image
3897 from a "data file" which is used as image payload:
3898
3899         tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3900                       -n name -d data_file image
3901           -A ==> set architecture to 'arch'
3902           -O ==> set operating system to 'os'
3903           -T ==> set image type to 'type'
3904           -C ==> set compression type 'comp'
3905           -a ==> set load address to 'addr' (hex)
3906           -e ==> set entry point to 'ep' (hex)
3907           -n ==> set image name to 'name'
3908           -d ==> use image data from 'datafile'
3909
3910 Right now, all Linux kernels for PowerPC systems use the same load
3911 address (0x00000000), but the entry point address depends on the
3912 kernel version:
3913
3914 - 2.2.x kernels have the entry point at 0x0000000C,
3915 - 2.3.x and later kernels have the entry point at 0x00000000.
3916
3917 So a typical call to build a U-Boot image would read:
3918
3919         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3920         > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3921         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3922         > examples/uImage.TQM850L
3923         Image Name:   2.4.4 kernel for TQM850L
3924         Created:      Wed Jul 19 02:34:59 2000
3925         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3926         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3927         Load Address: 0x00000000
3928         Entry Point:  0x00000000
3929
3930 To verify the contents of the image (or check for corruption):
3931
3932         -> tools/mkimage -l examples/uImage.TQM850L
3933         Image Name:   2.4.4 kernel for TQM850L
3934         Created:      Wed Jul 19 02:34:59 2000
3935         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3936         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3937         Load Address: 0x00000000
3938         Entry Point:  0x00000000
3939
3940 NOTE: for embedded systems where boot time is critical you can trade
3941 speed for memory and install an UNCOMPRESSED image instead: this
3942 needs more space in Flash, but boots much faster since it does not
3943 need to be uncompressed:
3944
3945         -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3946         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3947         > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3948         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3949         > examples/uImage.TQM850L-uncompressed
3950         Image Name:   2.4.4 kernel for TQM850L
3951         Created:      Wed Jul 19 02:34:59 2000
3952         Image Type:   PowerPC Linux Kernel Image (uncompressed)
3953         Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3954         Load Address: 0x00000000
3955         Entry Point:  0x00000000
3956
3957
3958 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3959 when your kernel is intended to use an initial ramdisk:
3960
3961         -> tools/mkimage -n 'Simple Ramdisk Image' \
3962         > -A ppc -O linux -T ramdisk -C gzip \
3963         > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3964         Image Name:   Simple Ramdisk Image
3965         Created:      Wed Jan 12 14:01:50 2000
3966         Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3967         Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3968         Load Address: 0x00000000
3969         Entry Point:  0x00000000
3970
3971
3972 Installing a Linux Image:
3973 -------------------------
3974
3975 To downloading a U-Boot image over the serial (console) interface,
3976 you must convert the image to S-Record format:
3977
3978         objcopy -I binary -O srec examples/image examples/image.srec
3979
3980 The 'objcopy' does not understand the information in the U-Boot
3981 image header, so the resulting S-Record file will be relative to
3982 address 0x00000000. To load it to a given address, you need to
3983 specify the target address as 'offset' parameter with the 'loads'
3984 command.
3985
3986 Example: install the image to address 0x40100000 (which on the
3987 TQM8xxL is in the first Flash bank):
3988
3989         => erase 40100000 401FFFFF
3990
3991         .......... done
3992         Erased 8 sectors
3993
3994         => loads 40100000
3995         ## Ready for S-Record download ...
3996         ~>examples/image.srec
3997         1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3998         ...
3999         15989 15990 15991 15992
4000         [file transfer complete]
4001         [connected]
4002         ## Start Addr = 0x00000000
4003
4004
4005 You can check the success of the download using the 'iminfo' command;
4006 this includes a checksum verification so you can be sure no data
4007 corruption happened:
4008
4009         => imi 40100000
4010
4011         ## Checking Image at 40100000 ...
4012            Image Name:   2.2.13 for initrd on TQM850L
4013            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4014            Data Size:    335725 Bytes = 327 kB = 0 MB
4015            Load Address: 00000000
4016            Entry Point:  0000000c
4017            Verifying Checksum ... OK
4018
4019
4020 Boot Linux:
4021 -----------
4022
4023 The "bootm" command is used to boot an application that is stored in
4024 memory (RAM or Flash). In case of a Linux kernel image, the contents
4025 of the "bootargs" environment variable is passed to the kernel as
4026 parameters. You can check and modify this variable using the
4027 "printenv" and "setenv" commands:
4028
4029
4030         => printenv bootargs
4031         bootargs=root=/dev/ram
4032
4033         => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4034
4035         => printenv bootargs
4036         bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4037
4038         => bootm 40020000
4039         ## Booting Linux kernel at 40020000 ...
4040            Image Name:   2.2.13 for NFS on TQM850L
4041            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4042            Data Size:    381681 Bytes = 372 kB = 0 MB
4043            Load Address: 00000000
4044            Entry Point:  0000000c
4045            Verifying Checksum ... OK
4046            Uncompressing Kernel Image ... OK
4047         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
4048         Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4049         time_init: decrementer frequency = 187500000/60
4050         Calibrating delay loop... 49.77 BogoMIPS
4051         Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4052         ...
4053
4054 If you want to boot a Linux kernel with initial RAM disk, you pass
4055 the memory addresses of both the kernel and the initrd image (PPBCOOT
4056 format!) to the "bootm" command:
4057
4058         => imi 40100000 40200000
4059
4060         ## Checking Image at 40100000 ...
4061            Image Name:   2.2.13 for initrd on TQM850L
4062            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4063            Data Size:    335725 Bytes = 327 kB = 0 MB
4064            Load Address: 00000000
4065            Entry Point:  0000000c
4066            Verifying Checksum ... OK
4067
4068         ## Checking Image at 40200000 ...
4069            Image Name:   Simple Ramdisk Image
4070            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4071            Data Size:    566530 Bytes = 553 kB = 0 MB
4072            Load Address: 00000000
4073            Entry Point:  00000000
4074            Verifying Checksum ... OK
4075
4076         => bootm 40100000 40200000
4077         ## Booting Linux kernel at 40100000 ...
4078            Image Name:   2.2.13 for initrd on TQM850L
4079            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4080            Data Size:    335725 Bytes = 327 kB = 0 MB
4081            Load Address: 00000000
4082            Entry Point:  0000000c
4083            Verifying Checksum ... OK
4084            Uncompressing Kernel Image ... OK
4085         ## Loading RAMDisk Image at 40200000 ...
4086            Image Name:   Simple Ramdisk Image
4087            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4088            Data Size:    566530 Bytes = 553 kB = 0 MB
4089            Load Address: 00000000
4090            Entry Point:  00000000
4091            Verifying Checksum ... OK
4092            Loading Ramdisk ... OK
4093         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
4094         Boot arguments: root=/dev/ram
4095         time_init: decrementer frequency = 187500000/60
4096         Calibrating delay loop... 49.77 BogoMIPS
4097         ...
4098         RAMDISK: Compressed image found at block 0
4099         VFS: Mounted root (ext2 filesystem).
4100
4101         bash#
4102
4103 Boot Linux and pass a flat device tree:
4104 -----------
4105
4106 First, U-Boot must be compiled with the appropriate defines. See the section
4107 titled "Linux Kernel Interface" above for a more in depth explanation. The
4108 following is an example of how to start a kernel and pass an updated
4109 flat device tree:
4110
4111 => print oftaddr
4112 oftaddr=0x300000
4113 => print oft
4114 oft=oftrees/mpc8540ads.dtb
4115 => tftp $oftaddr $oft
4116 Speed: 1000, full duplex
4117 Using TSEC0 device
4118 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4119 Filename 'oftrees/mpc8540ads.dtb'.
4120 Load address: 0x300000
4121 Loading: #
4122 done
4123 Bytes transferred = 4106 (100a hex)
4124 => tftp $loadaddr $bootfile
4125 Speed: 1000, full duplex
4126 Using TSEC0 device
4127 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4128 Filename 'uImage'.
4129 Load address: 0x200000
4130 Loading:############
4131 done
4132 Bytes transferred = 1029407 (fb51f hex)
4133 => print loadaddr
4134 loadaddr=200000
4135 => print oftaddr
4136 oftaddr=0x300000
4137 => bootm $loadaddr - $oftaddr
4138 ## Booting image at 00200000 ...
4139    Image Name:   Linux-2.6.17-dirty
4140    Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4141    Data Size:    1029343 Bytes = 1005.2 kB
4142    Load Address: 00000000
4143    Entry Point:  00000000
4144    Verifying Checksum ... OK
4145    Uncompressing Kernel Image ... OK
4146 Booting using flat device tree at 0x300000
4147 Using MPC85xx ADS machine description
4148 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4149 [snip]
4150
4151
4152 More About U-Boot Image Types:
4153 ------------------------------
4154
4155 U-Boot supports the following image types:
4156
4157    "Standalone Programs" are directly runnable in the environment
4158         provided by U-Boot; it is expected that (if they behave
4159         well) you can continue to work in U-Boot after return from
4160         the Standalone Program.
4161    "OS Kernel Images" are usually images of some Embedded OS which
4162         will take over control completely. Usually these programs
4163         will install their own set of exception handlers, device
4164         drivers, set up the MMU, etc. - this means, that you cannot
4165         expect to re-enter U-Boot except by resetting the CPU.
4166    "RAMDisk Images" are more or less just data blocks, and their
4167         parameters (address, size) are passed to an OS kernel that is
4168         being started.
4169    "Multi-File Images" contain several images, typically an OS
4170         (Linux) kernel image and one or more data images like
4171         RAMDisks. This construct is useful for instance when you want
4172         to boot over the network using BOOTP etc., where the boot
4173         server provides just a single image file, but you want to get
4174         for instance an OS kernel and a RAMDisk image.
4175
4176         "Multi-File Images" start with a list of image sizes, each
4177         image size (in bytes) specified by an "uint32_t" in network
4178         byte order. This list is terminated by an "(uint32_t)0".
4179         Immediately after the terminating 0 follow the images, one by
4180         one, all aligned on "uint32_t" boundaries (size rounded up to
4181         a multiple of 4 bytes).
4182
4183    "Firmware Images" are binary images containing firmware (like
4184         U-Boot or FPGA images) which usually will be programmed to
4185         flash memory.
4186
4187    "Script files" are command sequences that will be executed by
4188         U-Boot's command interpreter; this feature is especially
4189         useful when you configure U-Boot to use a real shell (hush)
4190         as command interpreter.
4191
4192
4193 Standalone HOWTO:
4194 =================
4195
4196 One of the features of U-Boot is that you can dynamically load and
4197 run "standalone" applications, which can use some resources of
4198 U-Boot like console I/O functions or interrupt services.
4199
4200 Two simple examples are included with the sources:
4201
4202 "Hello World" Demo:
4203 -------------------
4204
4205 'examples/hello_world.c' contains a small "Hello World" Demo
4206 application; it is automatically compiled when you build U-Boot.
4207 It's configured to run at address 0x00040004, so you can play with it
4208 like that:
4209
4210         => loads
4211         ## Ready for S-Record download ...
4212         ~>examples/hello_world.srec
4213         1 2 3 4 5 6 7 8 9 10 11 ...
4214         [file transfer complete]
4215         [connected]
4216         ## Start Addr = 0x00040004
4217
4218         => go 40004 Hello World! This is a test.
4219         ## Starting application at 0x00040004 ...
4220         Hello World
4221         argc = 7
4222         argv[0] = "40004"
4223         argv[1] = "Hello"
4224         argv[2] = "World!"
4225         argv[3] = "This"
4226         argv[4] = "is"
4227         argv[5] = "a"
4228         argv[6] = "test."
4229         argv[7] = "<NULL>"
4230         Hit any key to exit ...
4231
4232         ## Application terminated, rc = 0x0
4233
4234 Another example, which demonstrates how to register a CPM interrupt
4235 handler with the U-Boot code, can be found in 'examples/timer.c'.
4236 Here, a CPM timer is set up to generate an interrupt every second.
4237 The interrupt service routine is trivial, just printing a '.'
4238 character, but this is just a demo program. The application can be
4239 controlled by the following keys:
4240
4241         ? - print current values og the CPM Timer registers
4242         b - enable interrupts and start timer
4243         e - stop timer and disable interrupts
4244         q - quit application
4245
4246         => loads
4247         ## Ready for S-Record download ...
4248         ~>examples/timer.srec
4249         1 2 3 4 5 6 7 8 9 10 11 ...
4250         [file transfer complete]
4251         [connected]
4252         ## Start Addr = 0x00040004
4253
4254         => go 40004
4255         ## Starting application at 0x00040004 ...
4256         TIMERS=0xfff00980
4257         Using timer 1
4258           tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4259
4260 Hit 'b':
4261         [q, b, e, ?] Set interval 1000000 us
4262         Enabling timer
4263 Hit '?':
4264         [q, b, e, ?] ........
4265         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4266 Hit '?':
4267         [q, b, e, ?] .
4268         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4269 Hit '?':
4270         [q, b, e, ?] .
4271         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4272 Hit '?':
4273         [q, b, e, ?] .
4274         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4275 Hit 'e':
4276         [q, b, e, ?] ...Stopping timer
4277 Hit 'q':
4278         [q, b, e, ?] ## Application terminated, rc = 0x0
4279
4280
4281 Minicom warning:
4282 ================
4283
4284 Over time, many people have reported problems when trying to use the
4285 "minicom" terminal emulation program for serial download. I (wd)
4286 consider minicom to be broken, and recommend not to use it. Under
4287 Unix, I recommend to use C-Kermit for general purpose use (and
4288 especially for kermit binary protocol download ("loadb" command), and
4289 use "cu" for S-Record download ("loads" command).
4290
4291 Nevertheless, if you absolutely want to use it try adding this
4292 configuration to your "File transfer protocols" section:
4293
4294            Name    Program                      Name U/D FullScr IO-Red. Multi
4295         X  kermit  /usr/bin/kermit -i -l %l -s   Y    U    Y       N      N
4296         Y  kermit  /usr/bin/kermit -i -l %l -r   N    D    Y       N      N
4297
4298
4299 NetBSD Notes:
4300 =============
4301
4302 Starting at version 0.9.2, U-Boot supports NetBSD both as host
4303 (build U-Boot) and target system (boots NetBSD/mpc8xx).
4304
4305 Building requires a cross environment; it is known to work on
4306 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4307 need gmake since the Makefiles are not compatible with BSD make).
4308 Note that the cross-powerpc package does not install include files;
4309 attempting to build U-Boot will fail because <machine/ansi.h> is
4310 missing.  This file has to be installed and patched manually:
4311
4312         # cd /usr/pkg/cross/powerpc-netbsd/include
4313         # mkdir powerpc
4314         # ln -s powerpc machine
4315         # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4316         # ${EDIT} powerpc/ansi.h        ## must remove __va_list, _BSD_VA_LIST
4317
4318 Native builds *don't* work due to incompatibilities between native
4319 and U-Boot include files.
4320
4321 Booting assumes that (the first part of) the image booted is a
4322 stage-2 loader which in turn loads and then invokes the kernel
4323 proper. Loader sources will eventually appear in the NetBSD source
4324 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
4325 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4326
4327
4328 Implementation Internals:
4329 =========================
4330
4331 The following is not intended to be a complete description of every
4332 implementation detail. However, it should help to understand the
4333 inner workings of U-Boot and make it easier to port it to custom
4334 hardware.
4335
4336
4337 Initial Stack, Global Data:
4338 ---------------------------
4339
4340 The implementation of U-Boot is complicated by the fact that U-Boot
4341 starts running out of ROM (flash memory), usually without access to
4342 system RAM (because the memory controller is not initialized yet).
4343 This means that we don't have writable Data or BSS segments, and BSS
4344 is not initialized as zero. To be able to get a C environment working
4345 at all, we have to allocate at least a minimal stack. Implementation
4346 options for this are defined and restricted by the CPU used: Some CPU
4347 models provide on-chip memory (like the IMMR area on MPC8xx and
4348 MPC826x processors), on others (parts of) the data cache can be
4349 locked as (mis-) used as memory, etc.
4350
4351         Chris Hallinan posted a good summary of these issues to the
4352         U-Boot mailing list:
4353
4354         Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4355         From: "Chris Hallinan" <clh@net1plus.com>
4356         Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4357         ...
4358
4359         Correct me if I'm wrong, folks, but the way I understand it
4360         is this: Using DCACHE as initial RAM for Stack, etc, does not
4361         require any physical RAM backing up the cache. The cleverness
4362         is that the cache is being used as a temporary supply of
4363         necessary storage before the SDRAM controller is setup. It's
4364         beyond the scope of this list to explain the details, but you
4365         can see how this works by studying the cache architecture and
4366         operation in the architecture and processor-specific manuals.
4367
4368         OCM is On Chip Memory, which I believe the 405GP has 4K. It
4369         is another option for the system designer to use as an
4370         initial stack/RAM area prior to SDRAM being available. Either
4371         option should work for you. Using CS 4 should be fine if your
4372         board designers haven't used it for something that would
4373         cause you grief during the initial boot! It is frequently not
4374         used.
4375
4376         CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
4377         with your processor/board/system design. The default value
4378         you will find in any recent u-boot distribution in
4379         walnut.h should work for you. I'd set it to a value larger
4380         than your SDRAM module. If you have a 64MB SDRAM module, set
4381         it above 400_0000. Just make sure your board has no resources
4382         that are supposed to respond to that address! That code in
4383         start.S has been around a while and should work as is when
4384         you get the config right.
4385
4386         -Chris Hallinan
4387         DS4.COM, Inc.
4388
4389 It is essential to remember this, since it has some impact on the C
4390 code for the initialization procedures:
4391
4392 * Initialized global data (data segment) is read-only. Do not attempt
4393   to write it.
4394
4395 * Do not use any uninitialized global data (or implicitely initialized
4396   as zero data - BSS segment) at all - this is undefined, initiali-
4397   zation is performed later (when relocating to RAM).
4398
4399 * Stack space is very limited. Avoid big data buffers or things like
4400   that.
4401
4402 Having only the stack as writable memory limits means we cannot use
4403 normal global data to share information beween the code. But it
4404 turned out that the implementation of U-Boot can be greatly
4405 simplified by making a global data structure (gd_t) available to all
4406 functions. We could pass a pointer to this data as argument to _all_
4407 functions, but this would bloat the code. Instead we use a feature of
4408 the GCC compiler (Global Register Variables) to share the data: we
4409 place a pointer (gd) to the global data into a register which we
4410 reserve for this purpose.
4411
4412 When choosing a register for such a purpose we are restricted by the
4413 relevant  (E)ABI  specifications for the current architecture, and by
4414 GCC's implementation.
4415
4416 For PowerPC, the following registers have specific use:
4417         R1:     stack pointer
4418         R2:     reserved for system use
4419         R3-R4:  parameter passing and return values
4420         R5-R10: parameter passing
4421         R13:    small data area pointer
4422         R30:    GOT pointer
4423         R31:    frame pointer
4424
4425         (U-Boot also uses R12 as internal GOT pointer. r12
4426         is a volatile register so r12 needs to be reset when
4427         going back and forth between asm and C)
4428
4429     ==> U-Boot will use R2 to hold a pointer to the global data
4430
4431     Note: on PPC, we could use a static initializer (since the
4432     address of the global data structure is known at compile time),
4433     but it turned out that reserving a register results in somewhat
4434     smaller code - although the code savings are not that big (on
4435     average for all boards 752 bytes for the whole U-Boot image,
4436     624 text + 127 data).
4437
4438 On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4439         http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4440
4441     ==> U-Boot will use P3 to hold a pointer to the global data
4442
4443 On ARM, the following registers are used:
4444
4445         R0:     function argument word/integer result
4446         R1-R3:  function argument word
4447         R9:     GOT pointer
4448         R10:    stack limit (used only if stack checking if enabled)
4449         R11:    argument (frame) pointer
4450         R12:    temporary workspace
4451         R13:    stack pointer
4452         R14:    link register
4453         R15:    program counter
4454
4455     ==> U-Boot will use R8 to hold a pointer to the global data
4456
4457 On Nios II, the ABI is documented here:
4458         http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4459
4460     ==> U-Boot will use gp to hold a pointer to the global data
4461
4462     Note: on Nios II, we give "-G0" option to gcc and don't use gp
4463     to access small data sections, so gp is free.
4464
4465 On NDS32, the following registers are used:
4466
4467         R0-R1:  argument/return
4468         R2-R5:  argument
4469         R15:    temporary register for assembler
4470         R16:    trampoline register
4471         R28:    frame pointer (FP)
4472         R29:    global pointer (GP)
4473         R30:    link register (LP)
4474         R31:    stack pointer (SP)
4475         PC:     program counter (PC)
4476
4477     ==> U-Boot will use R10 to hold a pointer to the global data
4478
4479 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4480 or current versions of GCC may "optimize" the code too much.
4481
4482 Memory Management:
4483 ------------------
4484
4485 U-Boot runs in system state and uses physical addresses, i.e. the
4486 MMU is not used either for address mapping nor for memory protection.
4487
4488 The available memory is mapped to fixed addresses using the memory
4489 controller. In this process, a contiguous block is formed for each
4490 memory type (Flash, SDRAM, SRAM), even when it consists of several
4491 physical memory banks.
4492
4493 U-Boot is installed in the first 128 kB of the first Flash bank (on
4494 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4495 booting and sizing and initializing DRAM, the code relocates itself
4496 to the upper end of DRAM. Immediately below the U-Boot code some
4497 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4498 configuration setting]. Below that, a structure with global Board
4499 Info data is placed, followed by the stack (growing downward).
4500
4501 Additionally, some exception handler code is copied to the low 8 kB
4502 of DRAM (0x00000000 ... 0x00001FFF).
4503
4504 So a typical memory configuration with 16 MB of DRAM could look like
4505 this:
4506
4507         0x0000 0000     Exception Vector code
4508               :
4509         0x0000 1FFF
4510         0x0000 2000     Free for Application Use
4511               :
4512               :
4513
4514               :
4515               :
4516         0x00FB FF20     Monitor Stack (Growing downward)
4517         0x00FB FFAC     Board Info Data and permanent copy of global data
4518         0x00FC 0000     Malloc Arena
4519               :
4520         0x00FD FFFF
4521         0x00FE 0000     RAM Copy of Monitor Code
4522         ...             eventually: LCD or video framebuffer
4523         ...             eventually: pRAM (Protected RAM - unchanged by reset)
4524         0x00FF FFFF     [End of RAM]
4525
4526
4527 System Initialization:
4528 ----------------------
4529
4530 In the reset configuration, U-Boot starts at the reset entry point
4531 (on most PowerPC systems at address 0x00000100). Because of the reset
4532 configuration for CS0# this is a mirror of the onboard Flash memory.
4533 To be able to re-map memory U-Boot then jumps to its link address.
4534 To be able to implement the initialization code in C, a (small!)
4535 initial stack is set up in the internal Dual Ported RAM (in case CPUs
4536 which provide such a feature like MPC8xx or MPC8260), or in a locked
4537 part of the data cache. After that, U-Boot initializes the CPU core,
4538 the caches and the SIU.
4539
4540 Next, all (potentially) available memory banks are mapped using a
4541 preliminary mapping. For example, we put them on 512 MB boundaries
4542 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4543 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4544 programmed for SDRAM access. Using the temporary configuration, a
4545 simple memory test is run that determines the size of the SDRAM
4546 banks.
4547
4548 When there is more than one SDRAM bank, and the banks are of
4549 different size, the largest is mapped first. For equal size, the first
4550 bank (CS2#) is mapped first. The first mapping is always for address
4551 0x00000000, with any additional banks following immediately to create
4552 contiguous memory starting from 0.
4553
4554 Then, the monitor installs itself at the upper end of the SDRAM area
4555 and allocates memory for use by malloc() and for the global Board
4556 Info data; also, the exception vector code is copied to the low RAM
4557 pages, and the final stack is set up.
4558
4559 Only after this relocation will you have a "normal" C environment;
4560 until that you are restricted in several ways, mostly because you are
4561 running from ROM, and because the code will have to be relocated to a
4562 new address in RAM.
4563
4564
4565 U-Boot Porting Guide:
4566 ----------------------
4567
4568 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4569 list, October 2002]
4570
4571
4572 int main(int argc, char *argv[])
4573 {
4574         sighandler_t no_more_time;
4575
4576         signal(SIGALRM, no_more_time);
4577         alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4578
4579         if (available_money > available_manpower) {
4580                 Pay consultant to port U-Boot;
4581                 return 0;
4582         }
4583
4584         Download latest U-Boot source;
4585
4586         Subscribe to u-boot mailing list;
4587
4588         if (clueless)
4589                 email("Hi, I am new to U-Boot, how do I get started?");
4590
4591         while (learning) {
4592                 Read the README file in the top level directory;
4593                 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4594                 Read applicable doc/*.README;
4595                 Read the source, Luke;
4596                 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
4597         }
4598
4599         if (available_money > toLocalCurrency ($2500))
4600                 Buy a BDI3000;
4601         else
4602                 Add a lot of aggravation and time;
4603
4604         if (a similar board exists) {   /* hopefully... */
4605                 cp -a board/<similar> board/<myboard>
4606                 cp include/configs/<similar>.h include/configs/<myboard>.h
4607         } else {
4608                 Create your own board support subdirectory;
4609                 Create your own board include/configs/<myboard>.h file;
4610         }
4611         Edit new board/<myboard> files
4612         Edit new include/configs/<myboard>.h
4613
4614         while (!accepted) {
4615                 while (!running) {
4616                         do {
4617                                 Add / modify source code;
4618                         } until (compiles);
4619                         Debug;
4620                         if (clueless)
4621                                 email("Hi, I am having problems...");
4622                 }
4623                 Send patch file to the U-Boot email list;
4624                 if (reasonable critiques)
4625                         Incorporate improvements from email list code review;
4626                 else
4627                         Defend code as written;
4628         }
4629
4630         return 0;
4631 }
4632
4633 void no_more_time (int sig)
4634 {
4635       hire_a_guru();
4636 }
4637
4638
4639 Coding Standards:
4640 -----------------
4641
4642 All contributions to U-Boot should conform to the Linux kernel
4643 coding style; see the file "Documentation/CodingStyle" and the script
4644 "scripts/Lindent" in your Linux kernel source directory.
4645
4646 Source files originating from a different project (for example the
4647 MTD subsystem) are generally exempt from these guidelines and are not
4648 reformated to ease subsequent migration to newer versions of those
4649 sources.
4650
4651 Please note that U-Boot is implemented in C (and to some small parts in
4652 Assembler); no C++ is used, so please do not use C++ style comments (//)
4653 in your code.
4654
4655 Please also stick to the following formatting rules:
4656 - remove any trailing white space
4657 - use TAB characters for indentation and vertical alignment, not spaces
4658 - make sure NOT to use DOS '\r\n' line feeds
4659 - do not add more than 2 consecutive empty lines to source files
4660 - do not add trailing empty lines to source files
4661
4662 Submissions which do not conform to the standards may be returned
4663 with a request to reformat the changes.
4664
4665
4666 Submitting Patches:
4667 -------------------
4668
4669 Since the number of patches for U-Boot is growing, we need to
4670 establish some rules. Submissions which do not conform to these rules
4671 may be rejected, even when they contain important and valuable stuff.
4672
4673 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
4674
4675 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4676 see http://lists.denx.de/mailman/listinfo/u-boot
4677
4678 When you send a patch, please include the following information with
4679 it:
4680
4681 * For bug fixes: a description of the bug and how your patch fixes
4682   this bug. Please try to include a way of demonstrating that the
4683   patch actually fixes something.
4684
4685 * For new features: a description of the feature and your
4686   implementation.
4687
4688 * A CHANGELOG entry as plaintext (separate from the patch)
4689
4690 * For major contributions, your entry to the CREDITS file
4691
4692 * When you add support for a new board, don't forget to add this
4693   board to the MAINTAINERS file, too.
4694
4695 * If your patch adds new configuration options, don't forget to
4696   document these in the README file.
4697
4698 * The patch itself. If you are using git (which is *strongly*
4699   recommended) you can easily generate the patch using the
4700   "git format-patch". If you then use "git send-email" to send it to
4701   the U-Boot mailing list, you will avoid most of the common problems
4702   with some other mail clients.
4703
4704   If you cannot use git, use "diff -purN OLD NEW". If your version of
4705   diff does not support these options, then get the latest version of
4706   GNU diff.
4707
4708   The current directory when running this command shall be the parent
4709   directory of the U-Boot source tree (i. e. please make sure that
4710   your patch includes sufficient directory information for the
4711   affected files).
4712
4713   We prefer patches as plain text. MIME attachments are discouraged,
4714   and compressed attachments must not be used.
4715
4716 * If one logical set of modifications affects or creates several
4717   files, all these changes shall be submitted in a SINGLE patch file.
4718
4719 * Changesets that contain different, unrelated modifications shall be
4720   submitted as SEPARATE patches, one patch per changeset.
4721
4722
4723 Notes:
4724
4725 * Before sending the patch, run the MAKEALL script on your patched
4726   source tree and make sure that no errors or warnings are reported
4727   for any of the boards.
4728
4729 * Keep your modifications to the necessary minimum: A patch
4730   containing several unrelated changes or arbitrary reformats will be
4731   returned with a request to re-formatting / split it.
4732
4733 * If you modify existing code, make sure that your new code does not
4734   add to the memory footprint of the code ;-) Small is beautiful!
4735   When adding new features, these should compile conditionally only
4736   (using #ifdef), and the resulting code with the new feature
4737   disabled must not need more memory than the old code without your
4738   modification.
4739
4740 * Remember that there is a size limit of 100 kB per message on the
4741   u-boot mailing list. Bigger patches will be moderated. If they are
4742   reasonable and not too big, they will be acknowledged. But patches
4743   bigger than the size limit should be avoided.