2 # (C) Copyright 2000 - 2013
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 # SPDX-License-Identifier: GPL-2.0+
11 This directory contains the source code for U-Boot, a boot loader for
12 Embedded boards based on PowerPC, ARM, MIPS and several other
13 processors, which can be installed in a boot ROM and used to
14 initialize and test the hardware or to download and run application
17 The development of U-Boot is closely related to Linux: some parts of
18 the source code originate in the Linux source tree, we have some
19 header files in common, and special provision has been made to
20 support booting of Linux images.
22 Some attention has been paid to make this software easily
23 configurable and extendable. For instance, all monitor commands are
24 implemented with the same call interface, so that it's very easy to
25 add new commands. Also, instead of permanently adding rarely used
26 code (for instance hardware test utilities) to the monitor, you can
27 load and run it dynamically.
33 In general, all boards for which a configuration option exists in the
34 Makefile have been tested to some extent and can be considered
35 "working". In fact, many of them are used in production systems.
37 In case of problems see the CHANGELOG and CREDITS files to find out
38 who contributed the specific port. The boards.cfg file lists board
41 Note: There is no CHANGELOG file in the actual U-Boot source tree;
42 it can be created dynamically from the Git log using:
50 In case you have questions about, problems with or contributions for
51 U-Boot you should send a message to the U-Boot mailing list at
52 <u-boot@lists.denx.de>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's.
54 Please see http://lists.denx.de/pipermail/u-boot and
55 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58 Where to get source code:
59 =========================
61 The U-Boot source code is maintained in the git repository at
62 git://www.denx.de/git/u-boot.git ; you can browse it online at
63 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
65 The "snapshot" links on this page allow you to download tarballs of
66 any version you might be interested in. Official releases are also
67 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70 Pre-built (and tested) images are available from
71 ftp://ftp.denx.de/pub/u-boot/images/
77 - start from 8xxrom sources
78 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
80 - make it easier to add custom boards
81 - make it possible to add other [PowerPC] CPUs
82 - extend functions, especially:
83 * Provide extended interface to Linux boot loader
86 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87 - create ARMBoot project (http://sourceforge.net/projects/armboot)
88 - add other CPU families (starting with ARM)
89 - create U-Boot project (http://sourceforge.net/projects/u-boot)
90 - current project page: see http://www.denx.de/wiki/U-Boot
96 The "official" name of this project is "Das U-Boot". The spelling
97 "U-Boot" shall be used in all written text (documentation, comments
98 in source files etc.). Example:
100 This is the README file for the U-Boot project.
102 File names etc. shall be based on the string "u-boot". Examples:
104 include/asm-ppc/u-boot.h
106 #include <asm/u-boot.h>
108 Variable names, preprocessor constants etc. shall be either based on
109 the string "u_boot" or on "U_BOOT". Example:
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
118 Starting with the release in October 2008, the names of the releases
119 were changed from numerical release numbers without deeper meaning
120 into a time stamp based numbering. Regular releases are identified by
121 names consisting of the calendar year and month of the release date.
122 Additional fields (if present) indicate release candidates or bug fix
123 releases in "stable" maintenance trees.
126 U-Boot v2009.11 - Release November 2009
127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
134 /arch Architecture specific files
135 /arm Files generic to ARM architecture
136 /cpu CPU specific files
137 /arm720t Files specific to ARM 720 CPUs
138 /arm920t Files specific to ARM 920 CPUs
139 /at91 Files specific to Atmel AT91RM9200 CPU
140 /imx Files specific to Freescale MC9328 i.MX CPUs
141 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
142 /arm926ejs Files specific to ARM 926 CPUs
143 /arm1136 Files specific to ARM 1136 CPUs
144 /ixp Files specific to Intel XScale IXP CPUs
145 /pxa Files specific to Intel XScale PXA CPUs
146 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
147 /lib Architecture specific library files
148 /avr32 Files generic to AVR32 architecture
149 /cpu CPU specific files
150 /lib Architecture specific library files
151 /blackfin Files generic to Analog Devices Blackfin architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /m68k Files generic to m68k architecture
155 /cpu CPU specific files
156 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
157 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
158 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
159 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
160 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
161 /lib Architecture specific library files
162 /microblaze Files generic to microblaze architecture
163 /cpu CPU specific files
164 /lib Architecture specific library files
165 /mips Files generic to MIPS architecture
166 /cpu CPU specific files
167 /mips32 Files specific to MIPS32 CPUs
168 /xburst Files specific to Ingenic XBurst CPUs
169 /lib Architecture specific library files
170 /nds32 Files generic to NDS32 architecture
171 /cpu CPU specific files
172 /n1213 Files specific to Andes Technology N1213 CPUs
173 /lib Architecture specific library files
174 /nios2 Files generic to Altera NIOS2 architecture
175 /cpu CPU specific files
176 /lib Architecture specific library files
177 /openrisc Files generic to OpenRISC architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
180 /powerpc Files generic to PowerPC architecture
181 /cpu CPU specific files
182 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
183 /mpc5xx Files specific to Freescale MPC5xx CPUs
184 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
185 /mpc8xx Files specific to Freescale MPC8xx CPUs
186 /mpc824x Files specific to Freescale MPC824x CPUs
187 /mpc8260 Files specific to Freescale MPC8260 CPUs
188 /mpc85xx Files specific to Freescale MPC85xx CPUs
189 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
190 /lib Architecture specific library files
191 /sh Files generic to SH architecture
192 /cpu CPU specific files
193 /sh2 Files specific to sh2 CPUs
194 /sh3 Files specific to sh3 CPUs
195 /sh4 Files specific to sh4 CPUs
196 /lib Architecture specific library files
197 /sparc Files generic to SPARC architecture
198 /cpu CPU specific files
199 /leon2 Files specific to Gaisler LEON2 SPARC CPU
200 /leon3 Files specific to Gaisler LEON3 SPARC CPU
201 /lib Architecture specific library files
202 /x86 Files generic to x86 architecture
203 /cpu CPU specific files
204 /lib Architecture specific library files
205 /api Machine/arch independent API for external apps
206 /board Board dependent files
207 /common Misc architecture independent functions
208 /disk Code for disk drive partition handling
209 /doc Documentation (don't expect too much)
210 /drivers Commonly used device drivers
211 /dts Contains Makefile for building internal U-Boot fdt.
212 /examples Example code for standalone applications, etc.
213 /fs Filesystem code (cramfs, ext2, jffs2, etc.)
214 /include Header Files
215 /lib Files generic to all architectures
216 /libfdt Library files to support flattened device trees
217 /lzma Library files to support LZMA decompression
218 /lzo Library files to support LZO decompression
220 /post Power On Self Test
221 /spl Secondary Program Loader framework
222 /tools Tools to build S-Record or U-Boot images, etc.
224 Software Configuration:
225 =======================
227 Configuration is usually done using C preprocessor defines; the
228 rationale behind that is to avoid dead code whenever possible.
230 There are two classes of configuration variables:
232 * Configuration _OPTIONS_:
233 These are selectable by the user and have names beginning with
236 * Configuration _SETTINGS_:
237 These depend on the hardware etc. and should not be meddled with if
238 you don't know what you're doing; they have names beginning with
241 Later we will add a configuration tool - probably similar to or even
242 identical to what's used for the Linux kernel. Right now, we have to
243 do the configuration by hand, which means creating some symbolic
244 links and editing some configuration files. We use the TQM8xxL boards
248 Selection of Processor Architecture and Board Type:
249 ---------------------------------------------------
251 For all supported boards there are ready-to-use default
252 configurations available; just type "make <board_name>_config".
254 Example: For a TQM823L module type:
259 For the Cogent platform, you need to specify the CPU type as well;
260 e.g. "make cogent_mpc8xx_config". And also configure the cogent
261 directory according to the instructions in cogent/README.
264 Configuration Options:
265 ----------------------
267 Configuration depends on the combination of board and CPU type; all
268 such information is kept in a configuration file
269 "include/configs/<board_name>.h".
271 Example: For a TQM823L module, all configuration settings are in
272 "include/configs/TQM823L.h".
275 Many of the options are named exactly as the corresponding Linux
276 kernel configuration options. The intention is to make it easier to
277 build a config tool - later.
280 The following options need to be configured:
282 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
284 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
286 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
287 Define exactly one, e.g. CONFIG_ATSTK1002
289 - CPU Module Type: (if CONFIG_COGENT is defined)
290 Define exactly one of
292 --- FIXME --- not tested yet:
293 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294 CONFIG_CMA287_23, CONFIG_CMA287_50
296 - Motherboard Type: (if CONFIG_COGENT is defined)
297 Define exactly one of
298 CONFIG_CMA101, CONFIG_CMA102
300 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301 Define one or more of
304 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305 Define one or more of
306 CONFIG_LCD_HEARTBEAT - update a character position on
307 the LCD display every second with
310 - Board flavour: (if CONFIG_MPC8260ADS is defined)
313 CONFIG_SYS_8260ADS - original MPC8260ADS
314 CONFIG_SYS_8266ADS - MPC8266ADS
315 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
316 CONFIG_SYS_8272ADS - MPC8272ADS
318 - Marvell Family Member
319 CONFIG_SYS_MVFS - define it if you want to enable
320 multiple fs option at one time
321 for marvell soc family
323 - MPC824X Family Member (if CONFIG_MPC824X is defined)
324 Define exactly one of
325 CONFIG_MPC8240, CONFIG_MPC8245
327 - 8xx CPU Options: (if using an MPC8xx CPU)
328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
332 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
335 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
338 CONFIG_8xx_CPUCLK_DEFAULT
339 See doc/README.MPC866
341 CONFIG_SYS_MEASURE_CPUCLK
343 Define this to measure the actual CPU clock instead
344 of relying on the correctness of the configured
345 values. Mostly useful for board bringup to make sure
346 the PLL is locked at the intended frequency. Note
347 that this requires a (stable) reference clock (32 kHz
348 RTC clock or CONFIG_SYS_8XX_XIN)
350 CONFIG_SYS_DELAYED_ICACHE
352 Define this option if you want to enable the
353 ICache only when Code runs from RAM.
358 Specifies that the core is a 64-bit PowerPC implementation (implements
359 the "64" category of the Power ISA). This is necessary for ePAPR
360 compliance, among other possible reasons.
362 CONFIG_SYS_FSL_TBCLK_DIV
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
368 CONFIG_SYS_FSL_PCIE_COMPAT
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
373 CONFIG_SYS_PPC_E500_DEBUG_TLB
375 Enables a temporary TLB entry to be used during boot to work
376 around limitations in e500v1 and e500v2 external debugger
377 support. This reduces the portions of the boot code where
378 breakpoints and single stepping do not work. The value of this
379 symbol should be set to the TLB1 entry to be used for this
382 CONFIG_SYS_FSL_ERRATUM_A004510
384 Enables a workaround for erratum A004510. If set,
385 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
389 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
391 Defines one or two SoC revisions (low 8 bits of SVR)
392 for which the A004510 workaround should be applied.
394 The rest of SVR is either not relevant to the decision
395 of whether the erratum is present (e.g. p2040 versus
396 p2041) or is implied by the build target, which controls
397 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
399 See Freescale App Note 4493 for more information about
402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
404 requred during NOR boot.
406 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
408 This is the value to write into CCSR offset 0x18600
409 according to the A004510 workaround.
411 CONFIG_SYS_FSL_DSP_DDR_ADDR
412 This value denotes start offset of DDR memory which is
413 connected exclusively to the DSP cores.
415 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416 This value denotes start offset of M2 memory
417 which is directly connected to the DSP core.
419 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
420 This value denotes start offset of M3 memory which is directly
421 connected to the DSP core.
423 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424 This value denotes start offset of DSP CCSR space.
426 CONFIG_SYS_FSL_DDR_EMU
427 Specify emulator support for DDR. Some DDR features such as
428 deskew training are not available.
430 - Generic CPU options:
431 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
433 Defines the endianess of the CPU. Implementation of those
434 values is arch specific.
436 - Intel Monahans options:
437 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
439 Defines the Monahans run mode to oscillator
440 ratio. Valid values are 8, 16, 24, 31. The core
441 frequency is this value multiplied by 13 MHz.
443 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
445 Defines the Monahans turbo mode to oscillator
446 ratio. Valid values are 1 (default if undefined) and
447 2. The core frequency as calculated above is multiplied
451 CONFIG_SYS_INIT_SP_OFFSET
453 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
454 pointer. This is needed for the temporary stack before
457 CONFIG_SYS_MIPS_CACHE_MODE
459 Cache operation mode for the MIPS CPU.
460 See also arch/mips/include/asm/mipsregs.h.
462 CONF_CM_CACHABLE_NO_WA
465 CONF_CM_CACHABLE_NONCOHERENT
469 CONF_CM_CACHABLE_ACCELERATED
471 CONFIG_SYS_XWAY_EBU_BOOTCFG
473 Special option for Lantiq XWAY SoCs for booting from NOR flash.
474 See also arch/mips/cpu/mips32/start.S.
476 CONFIG_XWAY_SWAP_BYTES
478 Enable compilation of tools/xway-swap-bytes needed for Lantiq
479 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
480 be swapped if a flash programmer is used.
483 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
485 Select high exception vectors of the ARM core, e.g., do not
486 clear the V bit of the c1 register of CP15.
488 CONFIG_SYS_THUMB_BUILD
490 Use this flag to build U-Boot using the Thumb instruction
491 set for ARM architectures. Thumb instruction set provides
492 better code density. For ARM architectures that support
493 Thumb2 this flag will result in Thumb2 code generated by
496 CONFIG_ARM_ERRATA_716044
497 CONFIG_ARM_ERRATA_742230
498 CONFIG_ARM_ERRATA_743622
499 CONFIG_ARM_ERRATA_751472
501 If set, the workarounds for these ARM errata are applied early
502 during U-Boot startup. Note that these options force the
503 workarounds to be applied; no CPU-type/version detection
504 exists, unlike the similar options in the Linux kernel. Do not
505 set these options unless they apply!
510 The frequency of the timer returned by get_timer().
511 get_timer() must operate in milliseconds and this CONFIG
512 option must be set to 1000.
514 - Linux Kernel Interface:
517 U-Boot stores all clock information in Hz
518 internally. For binary compatibility with older Linux
519 kernels (which expect the clocks passed in the
520 bd_info data to be in MHz) the environment variable
521 "clocks_in_mhz" can be defined so that U-Boot
522 converts clock data to MHZ before passing it to the
524 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
525 "clocks_in_mhz=1" is automatically included in the
528 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
530 When transferring memsize parameter to linux, some versions
531 expect it to be in bytes, others in MB.
532 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
536 New kernel versions are expecting firmware settings to be
537 passed using flattened device trees (based on open firmware
541 * New libfdt-based support
542 * Adds the "fdt" command
543 * The bootm command automatically updates the fdt
545 OF_CPU - The proper name of the cpus node (only required for
546 MPC512X and MPC5xxx based boards).
547 OF_SOC - The proper name of the soc node (only required for
548 MPC512X and MPC5xxx based boards).
549 OF_TBCLK - The timebase frequency.
550 OF_STDOUT_PATH - The path to the console device
552 boards with QUICC Engines require OF_QE to set UCC MAC
555 CONFIG_OF_BOARD_SETUP
557 Board code has addition modification that it wants to make
558 to the flat device tree before handing it off to the kernel
562 This define fills in the correct boot CPU in the boot
563 param header, the default value is zero if undefined.
567 U-Boot can detect if an IDE device is present or not.
568 If not, and this new config option is activated, U-Boot
569 removes the ATA node from the DTS before booting Linux,
570 so the Linux IDE driver does not probe the device and
571 crash. This is needed for buggy hardware (uc101) where
572 no pull down resistor is connected to the signal IDE5V_DD7.
574 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
576 This setting is mandatory for all boards that have only one
577 machine type and must be used to specify the machine type
578 number as it appears in the ARM machine registry
579 (see http://www.arm.linux.org.uk/developer/machines/).
580 Only boards that have multiple machine types supported
581 in a single configuration file and the machine type is
582 runtime discoverable, do not have to use this setting.
584 - vxWorks boot parameters:
586 bootvx constructs a valid bootline using the following
587 environments variables: bootfile, ipaddr, serverip, hostname.
588 It loads the vxWorks image pointed bootfile.
590 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
591 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
592 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
593 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
595 CONFIG_SYS_VXWORKS_ADD_PARAMS
597 Add it at the end of the bootline. E.g "u=username pw=secret"
599 Note: If a "bootargs" environment is defined, it will overwride
600 the defaults discussed just above.
602 - Cache Configuration:
603 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
604 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
605 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
607 - Cache Configuration for ARM:
608 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
610 CONFIG_SYS_PL310_BASE - Physical base address of PL310
611 controller register space
616 Define this if you want support for Amba PrimeCell PL010 UARTs.
620 Define this if you want support for Amba PrimeCell PL011 UARTs.
624 If you have Amba PrimeCell PL011 UARTs, set this variable to
625 the clock speed of the UARTs.
629 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
630 define this to a list of base addresses for each (supported)
631 port. See e.g. include/configs/versatile.h
633 CONFIG_PL011_SERIAL_RLCR
635 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
636 have separate receive and transmit line control registers. Set
637 this variable to initialize the extra register.
639 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
641 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
642 boot loader that has already initialized the UART. Define this
643 variable to flush the UART at init time.
647 Depending on board, define exactly one serial port
648 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
649 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
650 console by defining CONFIG_8xx_CONS_NONE
652 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
653 port routines must be defined elsewhere
654 (i.e. serial_init(), serial_getc(), ...)
657 Enables console device for a color framebuffer. Needs following
658 defines (cf. smiLynxEM, i8042)
659 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
661 VIDEO_HW_RECTFILL graphic chip supports
664 VIDEO_HW_BITBLT graphic chip supports
665 bit-blit (cf. smiLynxEM)
666 VIDEO_VISIBLE_COLS visible pixel columns
668 VIDEO_VISIBLE_ROWS visible pixel rows
669 VIDEO_PIXEL_SIZE bytes per pixel
670 VIDEO_DATA_FORMAT graphic data format
671 (0-5, cf. cfb_console.c)
672 VIDEO_FB_ADRS framebuffer address
673 VIDEO_KBD_INIT_FCT keyboard int fct
674 (i.e. i8042_kbd_init())
675 VIDEO_TSTC_FCT test char fct
677 VIDEO_GETC_FCT get char fct
679 CONFIG_CONSOLE_CURSOR cursor drawing on/off
680 (requires blink timer
682 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
683 CONFIG_CONSOLE_TIME display time/date info in
685 (requires CONFIG_CMD_DATE)
686 CONFIG_VIDEO_LOGO display Linux logo in
688 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
689 linux_logo.h for logo.
690 Requires CONFIG_VIDEO_LOGO
691 CONFIG_CONSOLE_EXTRA_INFO
692 additional board info beside
695 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
696 a limited number of ANSI escape sequences (cursor control,
697 erase functions and limited graphics rendition control).
699 When CONFIG_CFB_CONSOLE is defined, video console is
700 default i/o. Serial console can be forced with
701 environment 'console=serial'.
703 When CONFIG_SILENT_CONSOLE is defined, all console
704 messages (by U-Boot and Linux!) can be silenced with
705 the "silent" environment variable. See
706 doc/README.silent for more information.
708 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
710 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
714 CONFIG_BAUDRATE - in bps
715 Select one of the baudrates listed in
716 CONFIG_SYS_BAUDRATE_TABLE, see below.
717 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
719 - Console Rx buffer length
720 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
721 the maximum receive buffer length for the SMC.
722 This option is actual only for 82xx and 8xx possible.
723 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
724 must be defined, to setup the maximum idle timeout for
727 - Pre-Console Buffer:
728 Prior to the console being initialised (i.e. serial UART
729 initialised etc) all console output is silently discarded.
730 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
731 buffer any console messages prior to the console being
732 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
733 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
734 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
735 bytes are output before the console is initialised, the
736 earlier bytes are discarded.
738 'Sane' compilers will generate smaller code if
739 CONFIG_PRE_CON_BUF_SZ is a power of 2
741 - Safe printf() functions
742 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
743 the printf() functions. These are defined in
744 include/vsprintf.h and include snprintf(), vsnprintf() and
745 so on. Code size increase is approximately 300-500 bytes.
746 If this option is not given then these functions will
747 silently discard their buffer size argument - this means
748 you are not getting any overflow checking in this case.
750 - Boot Delay: CONFIG_BOOTDELAY - in seconds
751 Delay before automatically booting the default image;
752 set to -1 to disable autoboot.
753 set to -2 to autoboot with no delay and not check for abort
754 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
756 See doc/README.autoboot for these options that
757 work with CONFIG_BOOTDELAY. None are required.
758 CONFIG_BOOT_RETRY_TIME
759 CONFIG_BOOT_RETRY_MIN
760 CONFIG_AUTOBOOT_KEYED
761 CONFIG_AUTOBOOT_PROMPT
762 CONFIG_AUTOBOOT_DELAY_STR
763 CONFIG_AUTOBOOT_STOP_STR
764 CONFIG_AUTOBOOT_DELAY_STR2
765 CONFIG_AUTOBOOT_STOP_STR2
766 CONFIG_ZERO_BOOTDELAY_CHECK
767 CONFIG_RESET_TO_RETRY
771 Only needed when CONFIG_BOOTDELAY is enabled;
772 define a command string that is automatically executed
773 when no character is read on the console interface
774 within "Boot Delay" after reset.
777 This can be used to pass arguments to the bootm
778 command. The value of CONFIG_BOOTARGS goes into the
779 environment value "bootargs".
781 CONFIG_RAMBOOT and CONFIG_NFSBOOT
782 The value of these goes into the environment as
783 "ramboot" and "nfsboot" respectively, and can be used
784 as a convenience, when switching between booting from
790 When this option is #defined, the existence of the
791 environment variable "preboot" will be checked
792 immediately before starting the CONFIG_BOOTDELAY
793 countdown and/or running the auto-boot command resp.
794 entering interactive mode.
796 This feature is especially useful when "preboot" is
797 automatically generated or modified. For an example
798 see the LWMON board specific code: here "preboot" is
799 modified when the user holds down a certain
800 combination of keys on the (special) keyboard when
803 - Serial Download Echo Mode:
805 If defined to 1, all characters received during a
806 serial download (using the "loads" command) are
807 echoed back. This might be needed by some terminal
808 emulations (like "cu"), but may as well just take
809 time on others. This setting #define's the initial
810 value of the "loads_echo" environment variable.
812 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
814 Select one of the baudrates listed in
815 CONFIG_SYS_BAUDRATE_TABLE, see below.
818 Monitor commands can be included or excluded
819 from the build by using the #include files
820 <config_cmd_all.h> and #undef'ing unwanted
821 commands, or using <config_cmd_default.h>
822 and augmenting with additional #define's
825 The default command configuration includes all commands
826 except those marked below with a "*".
828 CONFIG_CMD_ASKENV * ask for env variable
829 CONFIG_CMD_BDI bdinfo
830 CONFIG_CMD_BEDBUG * Include BedBug Debugger
831 CONFIG_CMD_BMP * BMP support
832 CONFIG_CMD_BSP * Board specific commands
833 CONFIG_CMD_BOOTD bootd
834 CONFIG_CMD_CACHE * icache, dcache
835 CONFIG_CMD_CONSOLE coninfo
836 CONFIG_CMD_CRC32 * crc32
837 CONFIG_CMD_DATE * support for RTC, date/time...
838 CONFIG_CMD_DHCP * DHCP support
839 CONFIG_CMD_DIAG * Diagnostics
840 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
841 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
842 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
843 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
844 CONFIG_CMD_DTT * Digital Therm and Thermostat
845 CONFIG_CMD_ECHO echo arguments
846 CONFIG_CMD_EDITENV edit env variable
847 CONFIG_CMD_EEPROM * EEPROM read/write support
848 CONFIG_CMD_ELF * bootelf, bootvx
849 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
850 CONFIG_CMD_ENV_FLAGS * display details about env flags
851 CONFIG_CMD_ENV_EXISTS * check existence of env variable
852 CONFIG_CMD_EXPORTENV * export the environment
853 CONFIG_CMD_EXT2 * ext2 command support
854 CONFIG_CMD_EXT4 * ext4 command support
855 CONFIG_CMD_SAVEENV saveenv
856 CONFIG_CMD_FDC * Floppy Disk Support
857 CONFIG_CMD_FAT * FAT command support
858 CONFIG_CMD_FDOS * Dos diskette Support
859 CONFIG_CMD_FLASH flinfo, erase, protect
860 CONFIG_CMD_FPGA FPGA device initialization support
861 CONFIG_CMD_FUSE * Device fuse support
862 CONFIG_CMD_GETTIME * Get time since boot
863 CONFIG_CMD_GO * the 'go' command (exec code)
864 CONFIG_CMD_GREPENV * search environment
865 CONFIG_CMD_HASH * calculate hash / digest
866 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
867 CONFIG_CMD_I2C * I2C serial bus support
868 CONFIG_CMD_IDE * IDE harddisk support
869 CONFIG_CMD_IMI iminfo
870 CONFIG_CMD_IMLS List all images found in NOR flash
871 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
872 CONFIG_CMD_IMMAP * IMMR dump support
873 CONFIG_CMD_IMPORTENV * import an environment
874 CONFIG_CMD_INI * import data from an ini file into the env
875 CONFIG_CMD_IRQ * irqinfo
876 CONFIG_CMD_ITEST Integer/string test of 2 values
877 CONFIG_CMD_JFFS2 * JFFS2 Support
878 CONFIG_CMD_KGDB * kgdb
879 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
880 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
882 CONFIG_CMD_LOADB loadb
883 CONFIG_CMD_LOADS loads
884 CONFIG_CMD_MD5SUM * print md5 message digest
885 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
886 CONFIG_CMD_MEMINFO * Display detailed memory information
887 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
889 CONFIG_CMD_MEMTEST * mtest
890 CONFIG_CMD_MISC Misc functions like sleep etc
891 CONFIG_CMD_MMC * MMC memory mapped support
892 CONFIG_CMD_MII * MII utility commands
893 CONFIG_CMD_MTDPARTS * MTD partition support
894 CONFIG_CMD_NAND * NAND support
895 CONFIG_CMD_NET bootp, tftpboot, rarpboot
896 CONFIG_CMD_NFS NFS support
897 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
898 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
899 CONFIG_CMD_PCI * pciinfo
900 CONFIG_CMD_PCMCIA * PCMCIA support
901 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
903 CONFIG_CMD_PORTIO * Port I/O
904 CONFIG_CMD_READ * Read raw data from partition
905 CONFIG_CMD_REGINFO * Register dump
906 CONFIG_CMD_RUN run command in env variable
907 CONFIG_CMD_SANDBOX * sb command to access sandbox features
908 CONFIG_CMD_SAVES * save S record dump
909 CONFIG_CMD_SCSI * SCSI Support
910 CONFIG_CMD_SDRAM * print SDRAM configuration information
911 (requires CONFIG_CMD_I2C)
912 CONFIG_CMD_SETGETDCR Support for DCR Register access
914 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
915 CONFIG_CMD_SHA1SUM * print sha1 memory digest
916 (requires CONFIG_CMD_MEMORY)
917 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
918 CONFIG_CMD_SOURCE "source" command Support
919 CONFIG_CMD_SPI * SPI serial bus support
920 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
921 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
922 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
923 CONFIG_CMD_TIMER * access to the system tick timer
924 CONFIG_CMD_USB * USB support
925 CONFIG_CMD_CDP * Cisco Discover Protocol support
926 CONFIG_CMD_MFSL * Microblaze FSL support
927 CONFIG_CMD_XIMG Load part of Multi Image
930 EXAMPLE: If you want all functions except of network
931 support you can write:
933 #include "config_cmd_all.h"
934 #undef CONFIG_CMD_NET
937 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
939 Note: Don't enable the "icache" and "dcache" commands
940 (configuration option CONFIG_CMD_CACHE) unless you know
941 what you (and your U-Boot users) are doing. Data
942 cache cannot be enabled on systems like the 8xx or
943 8260 (where accesses to the IMMR region must be
944 uncached), and it cannot be disabled on all other
945 systems where we (mis-) use the data cache to hold an
946 initial stack and some data.
949 XXX - this list needs to get updated!
951 - Regular expression support:
953 If this variable is defined, U-Boot is linked against
954 the SLRE (Super Light Regular Expression) library,
955 which adds regex support to some commands, as for
956 example "env grep" and "setexpr".
960 If this variable is defined, U-Boot will use a device tree
961 to configure its devices, instead of relying on statically
962 compiled #defines in the board file. This option is
963 experimental and only available on a few boards. The device
964 tree is available in the global data as gd->fdt_blob.
966 U-Boot needs to get its device tree from somewhere. This can
967 be done using one of the two options below:
970 If this variable is defined, U-Boot will embed a device tree
971 binary in its image. This device tree file should be in the
972 board directory and called <soc>-<board>.dts. The binary file
973 is then picked up in board_init_f() and made available through
974 the global data structure as gd->blob.
977 If this variable is defined, U-Boot will build a device tree
978 binary. It will be called u-boot.dtb. Architecture-specific
979 code will locate it at run-time. Generally this works by:
981 cat u-boot.bin u-boot.dtb >image.bin
983 and in fact, U-Boot does this for you, creating a file called
984 u-boot-dtb.bin which is useful in the common case. You can
985 still use the individual files if you need something more
990 If this variable is defined, it enables watchdog
991 support for the SoC. There must be support in the SoC
992 specific code for a watchdog. For the 8xx and 8260
993 CPUs, the SIU Watchdog feature is enabled in the SYPCR
994 register. When supported for a specific SoC is
995 available, then no further board specific code should
999 When using a watchdog circuitry external to the used
1000 SoC, then define this variable and provide board
1001 specific code for the "hw_watchdog_reset" function.
1004 CONFIG_VERSION_VARIABLE
1005 If this variable is defined, an environment variable
1006 named "ver" is created by U-Boot showing the U-Boot
1007 version as printed by the "version" command.
1008 Any change to this variable will be reverted at the
1013 When CONFIG_CMD_DATE is selected, the type of the RTC
1014 has to be selected, too. Define exactly one of the
1017 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1018 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
1019 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
1020 CONFIG_RTC_MC146818 - use MC146818 RTC
1021 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
1022 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
1023 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
1024 CONFIG_RTC_DS164x - use Dallas DS164x RTC
1025 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
1026 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
1027 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
1028 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1031 Note that if the RTC uses I2C, then the I2C interface
1032 must also be configured. See I2C Support, below.
1035 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1037 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1038 chip-ngpio pairs that tell the PCA953X driver the number of
1039 pins supported by a particular chip.
1041 Note that if the GPIO device uses I2C, then the I2C interface
1042 must also be configured. See I2C Support, below.
1044 - Timestamp Support:
1046 When CONFIG_TIMESTAMP is selected, the timestamp
1047 (date and time) of an image is printed by image
1048 commands like bootm or iminfo. This option is
1049 automatically enabled when you select CONFIG_CMD_DATE .
1051 - Partition Labels (disklabels) Supported:
1052 Zero or more of the following:
1053 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1054 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1055 Intel architecture, USB sticks, etc.
1056 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1057 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1058 bootloader. Note 2TB partition limit; see
1060 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
1062 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1063 CONFIG_CMD_SCSI) you must configure support for at
1064 least one non-MTD partition type as well.
1067 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1068 board configurations files but used nowhere!
1070 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1071 be performed by calling the function
1072 ide_set_reset(int reset)
1073 which has to be defined in a board specific file
1078 Set this to enable ATAPI support.
1083 Set this to enable support for disks larger than 137GB
1084 Also look at CONFIG_SYS_64BIT_LBA.
1085 Whithout these , LBA48 support uses 32bit variables and will 'only'
1086 support disks up to 2.1TB.
1088 CONFIG_SYS_64BIT_LBA:
1089 When enabled, makes the IDE subsystem use 64bit sector addresses.
1093 At the moment only there is only support for the
1094 SYM53C8XX SCSI controller; define
1095 CONFIG_SCSI_SYM53C8XX to enable it.
1097 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1098 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1099 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1100 maximum numbers of LUNs, SCSI ID's and target
1102 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1104 The environment variable 'scsidevs' is set to the number of
1105 SCSI devices found during the last scan.
1107 - NETWORK Support (PCI):
1109 Support for Intel 8254x/8257x gigabit chips.
1112 Utility code for direct access to the SPI bus on Intel 8257x.
1113 This does not do anything useful unless you set at least one
1114 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1116 CONFIG_E1000_SPI_GENERIC
1117 Allow generic access to the SPI bus on the Intel 8257x, for
1118 example with the "sspi" command.
1121 Management command for E1000 devices. When used on devices
1122 with SPI support you can reprogram the EEPROM from U-Boot.
1124 CONFIG_E1000_FALLBACK_MAC
1125 default MAC for empty EEPROM after production.
1128 Support for Intel 82557/82559/82559ER chips.
1129 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1130 write routine for first time initialisation.
1133 Support for Digital 2114x chips.
1134 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1135 modem chip initialisation (KS8761/QS6611).
1138 Support for National dp83815 chips.
1141 Support for National dp8382[01] gigabit chips.
1143 - NETWORK Support (other):
1145 CONFIG_DRIVER_AT91EMAC
1146 Support for AT91RM9200 EMAC.
1149 Define this to use reduced MII inteface
1151 CONFIG_DRIVER_AT91EMAC_QUIET
1152 If this defined, the driver is quiet.
1153 The driver doen't show link status messages.
1155 CONFIG_CALXEDA_XGMAC
1156 Support for the Calxeda XGMAC device
1159 Support for SMSC's LAN91C96 chips.
1161 CONFIG_LAN91C96_BASE
1162 Define this to hold the physical address
1163 of the LAN91C96's I/O space
1165 CONFIG_LAN91C96_USE_32_BIT
1166 Define this to enable 32 bit addressing
1169 Support for SMSC's LAN91C111 chip
1171 CONFIG_SMC91111_BASE
1172 Define this to hold the physical address
1173 of the device (I/O space)
1175 CONFIG_SMC_USE_32_BIT
1176 Define this if data bus is 32 bits
1178 CONFIG_SMC_USE_IOFUNCS
1179 Define this to use i/o functions instead of macros
1180 (some hardware wont work with macros)
1182 CONFIG_DRIVER_TI_EMAC
1183 Support for davinci emac
1185 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1186 Define this if you have more then 3 PHYs.
1189 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1191 CONFIG_FTGMAC100_EGIGA
1192 Define this to use GE link update with gigabit PHY.
1193 Define this if FTGMAC100 is connected to gigabit PHY.
1194 If your system has 10/100 PHY only, it might not occur
1195 wrong behavior. Because PHY usually return timeout or
1196 useless data when polling gigabit status and gigabit
1197 control registers. This behavior won't affect the
1198 correctnessof 10/100 link speed update.
1201 Support for SMSC's LAN911x and LAN921x chips
1204 Define this to hold the physical address
1205 of the device (I/O space)
1207 CONFIG_SMC911X_32_BIT
1208 Define this if data bus is 32 bits
1210 CONFIG_SMC911X_16_BIT
1211 Define this if data bus is 16 bits. If your processor
1212 automatically converts one 32 bit word to two 16 bit
1213 words you may also try CONFIG_SMC911X_32_BIT.
1216 Support for Renesas on-chip Ethernet controller
1218 CONFIG_SH_ETHER_USE_PORT
1219 Define the number of ports to be used
1221 CONFIG_SH_ETHER_PHY_ADDR
1222 Define the ETH PHY's address
1224 CONFIG_SH_ETHER_CACHE_WRITEBACK
1225 If this option is set, the driver enables cache flush.
1229 Support TPM devices.
1232 Support for i2c bus TPM devices. Only one device
1233 per system is supported at this time.
1235 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1236 Define the the i2c bus number for the TPM device
1238 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1239 Define the TPM's address on the i2c bus
1241 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1242 Define the burst count bytes upper limit
1244 CONFIG_TPM_ATMEL_TWI
1245 Support for Atmel TWI TPM device. Requires I2C support.
1248 Support for generic parallel port TPM devices. Only one device
1249 per system is supported at this time.
1251 CONFIG_TPM_TIS_BASE_ADDRESS
1252 Base address where the generic TPM device is mapped
1253 to. Contemporary x86 systems usually map it at
1257 Add tpm monitor functions.
1258 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1259 provides monitor access to authorized functions.
1262 Define this to enable the TPM support library which provides
1263 functional interfaces to some TPM commands.
1264 Requires support for a TPM device.
1266 CONFIG_TPM_AUTH_SESSIONS
1267 Define this to enable authorized functions in the TPM library.
1268 Requires CONFIG_TPM and CONFIG_SHA1.
1271 At the moment only the UHCI host controller is
1272 supported (PIP405, MIP405, MPC5200); define
1273 CONFIG_USB_UHCI to enable it.
1274 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1275 and define CONFIG_USB_STORAGE to enable the USB
1278 Supported are USB Keyboards and USB Floppy drives
1280 MPC5200 USB requires additional defines:
1282 for 528 MHz Clock: 0x0001bbbb
1286 for differential drivers: 0x00001000
1287 for single ended drivers: 0x00005000
1288 for differential drivers on PSC3: 0x00000100
1289 for single ended drivers on PSC3: 0x00004100
1290 CONFIG_SYS_USB_EVENT_POLL
1291 May be defined to allow interrupt polling
1292 instead of using asynchronous interrupts
1294 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1295 txfilltuning field in the EHCI controller on reset.
1297 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1298 interval for usb hub power-on delay.(minimum 100msec)
1301 Define the below if you wish to use the USB console.
1302 Once firmware is rebuilt from a serial console issue the
1303 command "setenv stdin usbtty; setenv stdout usbtty" and
1304 attach your USB cable. The Unix command "dmesg" should print
1305 it has found a new device. The environment variable usbtty
1306 can be set to gserial or cdc_acm to enable your device to
1307 appear to a USB host as a Linux gserial device or a
1308 Common Device Class Abstract Control Model serial device.
1309 If you select usbtty = gserial you should be able to enumerate
1311 # modprobe usbserial vendor=0xVendorID product=0xProductID
1312 else if using cdc_acm, simply setting the environment
1313 variable usbtty to be cdc_acm should suffice. The following
1314 might be defined in YourBoardName.h
1317 Define this to build a UDC device
1320 Define this to have a tty type of device available to
1321 talk to the UDC device
1324 Define this to enable the high speed support for usb
1325 device and usbtty. If this feature is enabled, a routine
1326 int is_usbd_high_speed(void)
1327 also needs to be defined by the driver to dynamically poll
1328 whether the enumeration has succeded at high speed or full
1331 CONFIG_SYS_CONSOLE_IS_IN_ENV
1332 Define this if you want stdin, stdout &/or stderr to
1336 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1337 Derive USB clock from external clock "blah"
1338 - CONFIG_SYS_USB_EXTC_CLK 0x02
1340 CONFIG_SYS_USB_BRG_CLK 0xBLAH
1341 Derive USB clock from brgclk
1342 - CONFIG_SYS_USB_BRG_CLK 0x04
1344 If you have a USB-IF assigned VendorID then you may wish to
1345 define your own vendor specific values either in BoardName.h
1346 or directly in usbd_vendor_info.h. If you don't define
1347 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1348 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1349 should pretend to be a Linux device to it's target host.
1351 CONFIG_USBD_MANUFACTURER
1352 Define this string as the name of your company for
1353 - CONFIG_USBD_MANUFACTURER "my company"
1355 CONFIG_USBD_PRODUCT_NAME
1356 Define this string as the name of your product
1357 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1359 CONFIG_USBD_VENDORID
1360 Define this as your assigned Vendor ID from the USB
1361 Implementors Forum. This *must* be a genuine Vendor ID
1362 to avoid polluting the USB namespace.
1363 - CONFIG_USBD_VENDORID 0xFFFF
1365 CONFIG_USBD_PRODUCTID
1366 Define this as the unique Product ID
1368 - CONFIG_USBD_PRODUCTID 0xFFFF
1370 Some USB device drivers may need to check USB cable attachment.
1371 In this case you can enable following config in BoardName.h:
1372 CONFIG_USB_CABLE_CHECK
1373 This enables function definition:
1374 - usb_cable_connected() in include/usb.h
1375 Implementation of this function is board-specific.
1377 - ULPI Layer Support:
1378 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1379 the generic ULPI layer. The generic layer accesses the ULPI PHY
1380 via the platform viewport, so you need both the genric layer and
1381 the viewport enabled. Currently only Chipidea/ARC based
1382 viewport is supported.
1383 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1384 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1385 If your ULPI phy needs a different reference clock than the
1386 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1387 the appropriate value in Hz.
1390 The MMC controller on the Intel PXA is supported. To
1391 enable this define CONFIG_MMC. The MMC can be
1392 accessed from the boot prompt by mapping the device
1393 to physical memory similar to flash. Command line is
1394 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1395 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1398 Support for Renesas on-chip MMCIF controller
1400 CONFIG_SH_MMCIF_ADDR
1401 Define the base address of MMCIF registers
1404 Define the clock frequency for MMCIF
1406 - USB Device Firmware Update (DFU) class support:
1408 This enables the USB portion of the DFU USB class
1411 This enables the command "dfu" which is used to have
1412 U-Boot create a DFU class device via USB. This command
1413 requires that the "dfu_alt_info" environment variable be
1414 set and define the alt settings to expose to the host.
1417 This enables support for exposing (e)MMC devices via DFU.
1420 This enables support for exposing NAND devices via DFU.
1423 This enables support for exposing RAM via DFU.
1424 Note: DFU spec refer to non-volatile memory usage, but
1425 allow usages beyond the scope of spec - here RAM usage,
1426 one that would help mostly the developer.
1428 CONFIG_SYS_DFU_DATA_BUF_SIZE
1429 Dfu transfer uses a buffer before writing data to the
1430 raw storage device. Make the size (in bytes) of this buffer
1431 configurable. The size of this buffer is also configurable
1432 through the "dfu_bufsiz" environment variable.
1434 CONFIG_SYS_DFU_MAX_FILE_SIZE
1435 When updating files rather than the raw storage device,
1436 we use a static buffer to copy the file into and then write
1437 the buffer once we've been given the whole file. Define
1438 this to the maximum filesize (in bytes) for the buffer.
1439 Default is 4 MiB if undefined.
1441 - Journaling Flash filesystem support:
1442 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1443 CONFIG_JFFS2_NAND_DEV
1444 Define these for a default partition on a NAND device
1446 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1447 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1448 Define these for a default partition on a NOR device
1450 CONFIG_SYS_JFFS_CUSTOM_PART
1451 Define this to create an own partition. You have to provide a
1452 function struct part_info* jffs2_part_info(int part_num)
1454 If you define only one JFFS2 partition you may also want to
1455 #define CONFIG_SYS_JFFS_SINGLE_PART 1
1456 to disable the command chpart. This is the default when you
1457 have not defined a custom partition
1459 - FAT(File Allocation Table) filesystem write function support:
1462 Define this to enable support for saving memory data as a
1463 file in FAT formatted partition.
1465 This will also enable the command "fatwrite" enabling the
1466 user to write files to FAT.
1468 CBFS (Coreboot Filesystem) support
1471 Define this to enable support for reading from a Coreboot
1472 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1478 Define this to enable standard (PC-Style) keyboard
1482 Standard PC keyboard driver with US (is default) and
1483 GERMAN key layout (switch via environment 'keymap=de') support.
1484 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1485 for cfb_console. Supports cursor blinking.
1488 Enables a Chrome OS keyboard using the CROS_EC interface.
1489 This uses CROS_EC to communicate with a second microcontroller
1490 which provides key scans on request.
1495 Define this to enable video support (for output to
1498 CONFIG_VIDEO_CT69000
1500 Enable Chips & Technologies 69000 Video chip
1502 CONFIG_VIDEO_SMI_LYNXEM
1503 Enable Silicon Motion SMI 712/710/810 Video chip. The
1504 video output is selected via environment 'videoout'
1505 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1508 For the CT69000 and SMI_LYNXEM drivers, videomode is
1509 selected via environment 'videomode'. Two different ways
1511 - "videomode=num" 'num' is a standard LiLo mode numbers.
1512 Following standard modes are supported (* is default):
1514 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1515 -------------+---------------------------------------------
1516 8 bits | 0x301* 0x303 0x305 0x161 0x307
1517 15 bits | 0x310 0x313 0x316 0x162 0x319
1518 16 bits | 0x311 0x314 0x317 0x163 0x31A
1519 24 bits | 0x312 0x315 0x318 ? 0x31B
1520 -------------+---------------------------------------------
1521 (i.e. setenv videomode 317; saveenv; reset;)
1523 - "videomode=bootargs" all the video parameters are parsed
1524 from the bootargs. (See drivers/video/videomodes.c)
1527 CONFIG_VIDEO_SED13806
1528 Enable Epson SED13806 driver. This driver supports 8bpp
1529 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1530 or CONFIG_VIDEO_SED13806_16BPP
1533 Enable the Freescale DIU video driver. Reference boards for
1534 SOCs that have a DIU should define this macro to enable DIU
1535 support, and should also define these other macros:
1541 CONFIG_VIDEO_SW_CURSOR
1542 CONFIG_VGA_AS_SINGLE_DEVICE
1544 CONFIG_VIDEO_BMP_LOGO
1546 The DIU driver will look for the 'video-mode' environment
1547 variable, and if defined, enable the DIU as a console during
1548 boot. See the documentation file README.video for a
1549 description of this variable.
1553 Enable the VGA video / BIOS for x86. The alternative if you
1554 are using coreboot is to use the coreboot frame buffer
1561 Define this to enable a custom keyboard support.
1562 This simply calls drv_keyboard_init() which must be
1563 defined in your board-specific files.
1564 The only board using this so far is RBC823.
1566 - LCD Support: CONFIG_LCD
1568 Define this to enable LCD support (for output to LCD
1569 display); also select one of the supported displays
1570 by defining one of these:
1574 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1576 CONFIG_NEC_NL6448AC33:
1578 NEC NL6448AC33-18. Active, color, single scan.
1580 CONFIG_NEC_NL6448BC20
1582 NEC NL6448BC20-08. 6.5", 640x480.
1583 Active, color, single scan.
1585 CONFIG_NEC_NL6448BC33_54
1587 NEC NL6448BC33-54. 10.4", 640x480.
1588 Active, color, single scan.
1592 Sharp 320x240. Active, color, single scan.
1593 It isn't 16x9, and I am not sure what it is.
1595 CONFIG_SHARP_LQ64D341
1597 Sharp LQ64D341 display, 640x480.
1598 Active, color, single scan.
1602 HLD1045 display, 640x480.
1603 Active, color, single scan.
1607 Optrex CBL50840-2 NF-FW 99 22 M5
1609 Hitachi LMG6912RPFC-00T
1613 320x240. Black & white.
1615 Normally display is black on white background; define
1616 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1618 CONFIG_LCD_ALIGNMENT
1620 Normally the LCD is page-aligned (tyically 4KB). If this is
1621 defined then the LCD will be aligned to this value instead.
1622 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1623 here, since it is cheaper to change data cache settings on
1624 a per-section basis.
1626 CONFIG_CONSOLE_SCROLL_LINES
1628 When the console need to be scrolled, this is the number of
1629 lines to scroll by. It defaults to 1. Increasing this makes
1630 the console jump but can help speed up operation when scrolling
1635 Support drawing of RLE8-compressed bitmaps on the LCD.
1639 Enables an 'i2c edid' command which can read EDID
1640 information over I2C from an attached LCD display.
1642 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1644 If this option is set, the environment is checked for
1645 a variable "splashimage". If found, the usual display
1646 of logo, copyright and system information on the LCD
1647 is suppressed and the BMP image at the address
1648 specified in "splashimage" is loaded instead. The
1649 console is redirected to the "nulldev", too. This
1650 allows for a "silent" boot where a splash screen is
1651 loaded very quickly after power-on.
1653 CONFIG_SPLASHIMAGE_GUARD
1655 If this option is set, then U-Boot will prevent the environment
1656 variable "splashimage" from being set to a problematic address
1657 (see README.displaying-bmps and README.arm-unaligned-accesses).
1658 This option is useful for targets where, due to alignment
1659 restrictions, an improperly aligned BMP image will cause a data
1660 abort. If you think you will not have problems with unaligned
1661 accesses (for example because your toolchain prevents them)
1662 there is no need to set this option.
1664 CONFIG_SPLASH_SCREEN_ALIGN
1666 If this option is set the splash image can be freely positioned
1667 on the screen. Environment variable "splashpos" specifies the
1668 position as "x,y". If a positive number is given it is used as
1669 number of pixel from left/top. If a negative number is given it
1670 is used as number of pixel from right/bottom. You can also
1671 specify 'm' for centering the image.
1674 setenv splashpos m,m
1675 => image at center of screen
1677 setenv splashpos 30,20
1678 => image at x = 30 and y = 20
1680 setenv splashpos -10,m
1681 => vertically centered image
1682 at x = dspWidth - bmpWidth - 9
1684 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1686 If this option is set, additionally to standard BMP
1687 images, gzipped BMP images can be displayed via the
1688 splashscreen support or the bmp command.
1690 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1692 If this option is set, 8-bit RLE compressed BMP images
1693 can be displayed via the splashscreen support or the
1696 - Do compresssing for memory range:
1699 If this option is set, it would use zlib deflate method
1700 to compress the specified memory at its best effort.
1702 - Compression support:
1705 Enabled by default to support gzip compressed images.
1709 If this option is set, support for bzip2 compressed
1710 images is included. If not, only uncompressed and gzip
1711 compressed images are supported.
1713 NOTE: the bzip2 algorithm requires a lot of RAM, so
1714 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1719 If this option is set, support for lzma compressed
1722 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1723 requires an amount of dynamic memory that is given by the
1726 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1728 Where lc and lp stand for, respectively, Literal context bits
1729 and Literal pos bits.
1731 This value is upper-bounded by 14MB in the worst case. Anyway,
1732 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1733 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1734 a very small buffer.
1736 Use the lzmainfo tool to determinate the lc and lp values and
1737 then calculate the amount of needed dynamic memory (ensuring
1738 the appropriate CONFIG_SYS_MALLOC_LEN value).
1742 If this option is set, support for LZO compressed images
1748 The address of PHY on MII bus.
1750 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1752 The clock frequency of the MII bus
1756 If this option is set, support for speed/duplex
1757 detection of gigabit PHY is included.
1759 CONFIG_PHY_RESET_DELAY
1761 Some PHY like Intel LXT971A need extra delay after
1762 reset before any MII register access is possible.
1763 For such PHY, set this option to the usec delay
1764 required. (minimum 300usec for LXT971A)
1766 CONFIG_PHY_CMD_DELAY (ppc4xx)
1768 Some PHY like Intel LXT971A need extra delay after
1769 command issued before MII status register can be read
1779 Define a default value for Ethernet address to use
1780 for the respective Ethernet interface, in case this
1781 is not determined automatically.
1786 Define a default value for the IP address to use for
1787 the default Ethernet interface, in case this is not
1788 determined through e.g. bootp.
1789 (Environment variable "ipaddr")
1791 - Server IP address:
1794 Defines a default value for the IP address of a TFTP
1795 server to contact when using the "tftboot" command.
1796 (Environment variable "serverip")
1798 CONFIG_KEEP_SERVERADDR
1800 Keeps the server's MAC address, in the env 'serveraddr'
1801 for passing to bootargs (like Linux's netconsole option)
1803 - Gateway IP address:
1806 Defines a default value for the IP address of the
1807 default router where packets to other networks are
1809 (Environment variable "gatewayip")
1814 Defines a default value for the subnet mask (or
1815 routing prefix) which is used to determine if an IP
1816 address belongs to the local subnet or needs to be
1817 forwarded through a router.
1818 (Environment variable "netmask")
1820 - Multicast TFTP Mode:
1823 Defines whether you want to support multicast TFTP as per
1824 rfc-2090; for example to work with atftp. Lets lots of targets
1825 tftp down the same boot image concurrently. Note: the Ethernet
1826 driver in use must provide a function: mcast() to join/leave a
1829 - BOOTP Recovery Mode:
1830 CONFIG_BOOTP_RANDOM_DELAY
1832 If you have many targets in a network that try to
1833 boot using BOOTP, you may want to avoid that all
1834 systems send out BOOTP requests at precisely the same
1835 moment (which would happen for instance at recovery
1836 from a power failure, when all systems will try to
1837 boot, thus flooding the BOOTP server. Defining
1838 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1839 inserted before sending out BOOTP requests. The
1840 following delays are inserted then:
1842 1st BOOTP request: delay 0 ... 1 sec
1843 2nd BOOTP request: delay 0 ... 2 sec
1844 3rd BOOTP request: delay 0 ... 4 sec
1846 BOOTP requests: delay 0 ... 8 sec
1848 - DHCP Advanced Options:
1849 You can fine tune the DHCP functionality by defining
1850 CONFIG_BOOTP_* symbols:
1852 CONFIG_BOOTP_SUBNETMASK
1853 CONFIG_BOOTP_GATEWAY
1854 CONFIG_BOOTP_HOSTNAME
1855 CONFIG_BOOTP_NISDOMAIN
1856 CONFIG_BOOTP_BOOTPATH
1857 CONFIG_BOOTP_BOOTFILESIZE
1860 CONFIG_BOOTP_SEND_HOSTNAME
1861 CONFIG_BOOTP_NTPSERVER
1862 CONFIG_BOOTP_TIMEOFFSET
1863 CONFIG_BOOTP_VENDOREX
1864 CONFIG_BOOTP_MAY_FAIL
1866 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1867 environment variable, not the BOOTP server.
1869 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1870 after the configured retry count, the call will fail
1871 instead of starting over. This can be used to fail over
1872 to Link-local IP address configuration if the DHCP server
1875 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1876 serverip from a DHCP server, it is possible that more
1877 than one DNS serverip is offered to the client.
1878 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1879 serverip will be stored in the additional environment
1880 variable "dnsip2". The first DNS serverip is always
1881 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1884 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1885 to do a dynamic update of a DNS server. To do this, they
1886 need the hostname of the DHCP requester.
1887 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1888 of the "hostname" environment variable is passed as
1889 option 12 to the DHCP server.
1891 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1893 A 32bit value in microseconds for a delay between
1894 receiving a "DHCP Offer" and sending the "DHCP Request".
1895 This fixes a problem with certain DHCP servers that don't
1896 respond 100% of the time to a "DHCP request". E.g. On an
1897 AT91RM9200 processor running at 180MHz, this delay needed
1898 to be *at least* 15,000 usec before a Windows Server 2003
1899 DHCP server would reply 100% of the time. I recommend at
1900 least 50,000 usec to be safe. The alternative is to hope
1901 that one of the retries will be successful but note that
1902 the DHCP timeout and retry process takes a longer than
1905 - Link-local IP address negotiation:
1906 Negotiate with other link-local clients on the local network
1907 for an address that doesn't require explicit configuration.
1908 This is especially useful if a DHCP server cannot be guaranteed
1909 to exist in all environments that the device must operate.
1911 See doc/README.link-local for more information.
1914 CONFIG_CDP_DEVICE_ID
1916 The device id used in CDP trigger frames.
1918 CONFIG_CDP_DEVICE_ID_PREFIX
1920 A two character string which is prefixed to the MAC address
1925 A printf format string which contains the ascii name of
1926 the port. Normally is set to "eth%d" which sets
1927 eth0 for the first Ethernet, eth1 for the second etc.
1929 CONFIG_CDP_CAPABILITIES
1931 A 32bit integer which indicates the device capabilities;
1932 0x00000010 for a normal host which does not forwards.
1936 An ascii string containing the version of the software.
1940 An ascii string containing the name of the platform.
1944 A 32bit integer sent on the trigger.
1946 CONFIG_CDP_POWER_CONSUMPTION
1948 A 16bit integer containing the power consumption of the
1949 device in .1 of milliwatts.
1951 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1953 A byte containing the id of the VLAN.
1955 - Status LED: CONFIG_STATUS_LED
1957 Several configurations allow to display the current
1958 status using a LED. For instance, the LED will blink
1959 fast while running U-Boot code, stop blinking as
1960 soon as a reply to a BOOTP request was received, and
1961 start blinking slow once the Linux kernel is running
1962 (supported by a status LED driver in the Linux
1963 kernel). Defining CONFIG_STATUS_LED enables this
1969 The status LED can be connected to a GPIO pin.
1970 In such cases, the gpio_led driver can be used as a
1971 status LED backend implementation. Define CONFIG_GPIO_LED
1972 to include the gpio_led driver in the U-Boot binary.
1974 CONFIG_GPIO_LED_INVERTED_TABLE
1975 Some GPIO connected LEDs may have inverted polarity in which
1976 case the GPIO high value corresponds to LED off state and
1977 GPIO low value corresponds to LED on state.
1978 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1979 with a list of GPIO LEDs that have inverted polarity.
1981 - CAN Support: CONFIG_CAN_DRIVER
1983 Defining CONFIG_CAN_DRIVER enables CAN driver support
1984 on those systems that support this (optional)
1985 feature, like the TQM8xxL modules.
1987 - I2C Support: CONFIG_SYS_I2C
1989 This enable the NEW i2c subsystem, and will allow you to use
1990 i2c commands at the u-boot command line (as long as you set
1991 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1992 based realtime clock chips or other i2c devices. See
1993 common/cmd_i2c.c for a description of the command line
1996 ported i2c driver to the new framework:
1997 - drivers/i2c/soft_i2c.c:
1998 - activate first bus with CONFIG_SYS_I2C_SOFT define
1999 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2000 for defining speed and slave address
2001 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2002 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2003 for defining speed and slave address
2004 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2005 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2006 for defining speed and slave address
2007 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2008 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2009 for defining speed and slave address
2011 - drivers/i2c/fsl_i2c.c:
2012 - activate i2c driver with CONFIG_SYS_I2C_FSL
2013 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2014 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2015 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2017 - If your board supports a second fsl i2c bus, define
2018 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2019 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2020 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2023 - drivers/i2c/tegra_i2c.c:
2024 - activate this driver with CONFIG_SYS_I2C_TEGRA
2025 - This driver adds 4 i2c buses with a fix speed from
2026 100000 and the slave addr 0!
2028 - drivers/i2c/ppc4xx_i2c.c
2029 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2030 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2031 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2033 - drivers/i2c/i2c_mxc.c
2034 - activate this driver with CONFIG_SYS_I2C_MXC
2035 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2036 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2037 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2038 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2039 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2040 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2041 If thoses defines are not set, default value is 100000
2042 for speed, and 0 for slave.
2044 - drivers/i2c/rcar_i2c.c:
2045 - activate this driver with CONFIG_SYS_I2C_RCAR
2046 - This driver adds 4 i2c buses
2048 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2049 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2050 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2051 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2052 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2053 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2054 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2055 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2056 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2058 - drivers/i2c/sh_i2c.c:
2059 - activate this driver with CONFIG_SYS_I2C_SH
2060 - This driver adds from 2 to 5 i2c buses
2062 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2063 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2064 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2065 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2066 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2067 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2068 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2069 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2070 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2071 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2072 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2073 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2074 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2076 - drivers/i2c/omap24xx_i2c.c
2077 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2078 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2079 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2080 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2081 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2082 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2083 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2084 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2085 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2086 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2087 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2089 - drivers/i2c/zynq_i2c.c
2090 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2091 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2092 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2096 CONFIG_SYS_NUM_I2C_BUSES
2097 Hold the number of i2c busses you want to use. If you
2098 don't use/have i2c muxes on your i2c bus, this
2099 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2102 CONFIG_SYS_I2C_DIRECT_BUS
2103 define this, if you don't use i2c muxes on your hardware.
2104 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2107 CONFIG_SYS_I2C_MAX_HOPS
2108 define how many muxes are maximal consecutively connected
2109 on one i2c bus. If you not use i2c muxes, omit this
2112 CONFIG_SYS_I2C_BUSES
2113 hold a list of busses you want to use, only used if
2114 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2115 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2116 CONFIG_SYS_NUM_I2C_BUSES = 9:
2118 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2119 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2120 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2121 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2122 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2123 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2124 {1, {I2C_NULL_HOP}}, \
2125 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2126 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2130 bus 0 on adapter 0 without a mux
2131 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2132 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2133 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2134 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2135 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2136 bus 6 on adapter 1 without a mux
2137 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2138 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2140 If you do not have i2c muxes on your board, omit this define.
2142 - Legacy I2C Support: CONFIG_HARD_I2C
2144 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2145 provides the following compelling advantages:
2147 - more than one i2c adapter is usable
2148 - approved multibus support
2149 - better i2c mux support
2151 ** Please consider updating your I2C driver now. **
2153 These enable legacy I2C serial bus commands. Defining
2154 CONFIG_HARD_I2C will include the appropriate I2C driver
2155 for the selected CPU.
2157 This will allow you to use i2c commands at the u-boot
2158 command line (as long as you set CONFIG_CMD_I2C in
2159 CONFIG_COMMANDS) and communicate with i2c based realtime
2160 clock chips. See common/cmd_i2c.c for a description of the
2161 command line interface.
2163 CONFIG_HARD_I2C selects a hardware I2C controller.
2165 There are several other quantities that must also be
2166 defined when you define CONFIG_HARD_I2C.
2168 In both cases you will need to define CONFIG_SYS_I2C_SPEED
2169 to be the frequency (in Hz) at which you wish your i2c bus
2170 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2171 the CPU's i2c node address).
2173 Now, the u-boot i2c code for the mpc8xx
2174 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2175 and so its address should therefore be cleared to 0 (See,
2176 eg, MPC823e User's Manual p.16-473). So, set
2177 CONFIG_SYS_I2C_SLAVE to 0.
2179 CONFIG_SYS_I2C_INIT_MPC5XXX
2181 When a board is reset during an i2c bus transfer
2182 chips might think that the current transfer is still
2183 in progress. Reset the slave devices by sending start
2184 commands until the slave device responds.
2186 That's all that's required for CONFIG_HARD_I2C.
2188 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2189 then the following macros need to be defined (examples are
2190 from include/configs/lwmon.h):
2194 (Optional). Any commands necessary to enable the I2C
2195 controller or configure ports.
2197 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
2201 (Only for MPC8260 CPU). The I/O port to use (the code
2202 assumes both bits are on the same port). Valid values
2203 are 0..3 for ports A..D.
2207 The code necessary to make the I2C data line active
2208 (driven). If the data line is open collector, this
2211 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2215 The code necessary to make the I2C data line tri-stated
2216 (inactive). If the data line is open collector, this
2219 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2223 Code that returns true if the I2C data line is high,
2226 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2230 If <bit> is true, sets the I2C data line high. If it
2231 is false, it clears it (low).
2233 eg: #define I2C_SDA(bit) \
2234 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
2235 else immr->im_cpm.cp_pbdat &= ~PB_SDA
2239 If <bit> is true, sets the I2C clock line high. If it
2240 is false, it clears it (low).
2242 eg: #define I2C_SCL(bit) \
2243 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
2244 else immr->im_cpm.cp_pbdat &= ~PB_SCL
2248 This delay is invoked four times per clock cycle so this
2249 controls the rate of data transfer. The data rate thus
2250 is 1 / (I2C_DELAY * 4). Often defined to be something
2253 #define I2C_DELAY udelay(2)
2255 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2257 If your arch supports the generic GPIO framework (asm/gpio.h),
2258 then you may alternatively define the two GPIOs that are to be
2259 used as SCL / SDA. Any of the previous I2C_xxx macros will
2260 have GPIO-based defaults assigned to them as appropriate.
2262 You should define these to the GPIO value as given directly to
2263 the generic GPIO functions.
2265 CONFIG_SYS_I2C_INIT_BOARD
2267 When a board is reset during an i2c bus transfer
2268 chips might think that the current transfer is still
2269 in progress. On some boards it is possible to access
2270 the i2c SCLK line directly, either by using the
2271 processor pin as a GPIO or by having a second pin
2272 connected to the bus. If this option is defined a
2273 custom i2c_init_board() routine in boards/xxx/board.c
2274 is run early in the boot sequence.
2276 CONFIG_SYS_I2C_BOARD_LATE_INIT
2278 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2279 defined a custom i2c_board_late_init() routine in
2280 boards/xxx/board.c is run AFTER the operations in i2c_init()
2281 is completed. This callpoint can be used to unreset i2c bus
2282 using CPU i2c controller register accesses for CPUs whose i2c
2283 controller provide such a method. It is called at the end of
2284 i2c_init() to allow i2c_init operations to setup the i2c bus
2285 controller on the CPU (e.g. setting bus speed & slave address).
2287 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2289 This option enables configuration of bi_iic_fast[] flags
2290 in u-boot bd_info structure based on u-boot environment
2291 variable "i2cfast". (see also i2cfast)
2293 CONFIG_I2C_MULTI_BUS
2295 This option allows the use of multiple I2C buses, each of which
2296 must have a controller. At any point in time, only one bus is
2297 active. To switch to a different bus, use the 'i2c dev' command.
2298 Note that bus numbering is zero-based.
2300 CONFIG_SYS_I2C_NOPROBES
2302 This option specifies a list of I2C devices that will be skipped
2303 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
2304 is set, specify a list of bus-device pairs. Otherwise, specify
2305 a 1D array of device addresses
2308 #undef CONFIG_I2C_MULTI_BUS
2309 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2311 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2313 #define CONFIG_I2C_MULTI_BUS
2314 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
2316 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2318 CONFIG_SYS_SPD_BUS_NUM
2320 If defined, then this indicates the I2C bus number for DDR SPD.
2321 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2323 CONFIG_SYS_RTC_BUS_NUM
2325 If defined, then this indicates the I2C bus number for the RTC.
2326 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2328 CONFIG_SYS_DTT_BUS_NUM
2330 If defined, then this indicates the I2C bus number for the DTT.
2331 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2333 CONFIG_SYS_I2C_DTT_ADDR:
2335 If defined, specifies the I2C address of the DTT device.
2336 If not defined, then U-Boot uses predefined value for
2337 specified DTT device.
2339 CONFIG_SOFT_I2C_READ_REPEATED_START
2341 defining this will force the i2c_read() function in
2342 the soft_i2c driver to perform an I2C repeated start
2343 between writing the address pointer and reading the
2344 data. If this define is omitted the default behaviour
2345 of doing a stop-start sequence will be used. Most I2C
2346 devices can use either method, but some require one or
2349 - SPI Support: CONFIG_SPI
2351 Enables SPI driver (so far only tested with
2352 SPI EEPROM, also an instance works with Crystal A/D and
2353 D/As on the SACSng board)
2357 Enables the driver for SPI controller on SuperH. Currently
2358 only SH7757 is supported.
2362 Enables extended (16-bit) SPI EEPROM addressing.
2363 (symmetrical to CONFIG_I2C_X)
2367 Enables a software (bit-bang) SPI driver rather than
2368 using hardware support. This is a general purpose
2369 driver that only requires three general I/O port pins
2370 (two outputs, one input) to function. If this is
2371 defined, the board configuration must define several
2372 SPI configuration items (port pins to use, etc). For
2373 an example, see include/configs/sacsng.h.
2377 Enables a hardware SPI driver for general-purpose reads
2378 and writes. As with CONFIG_SOFT_SPI, the board configuration
2379 must define a list of chip-select function pointers.
2380 Currently supported on some MPC8xxx processors. For an
2381 example, see include/configs/mpc8349emds.h.
2385 Enables the driver for the SPI controllers on i.MX and MXC
2386 SoCs. Currently i.MX31/35/51 are supported.
2388 - FPGA Support: CONFIG_FPGA
2390 Enables FPGA subsystem.
2392 CONFIG_FPGA_<vendor>
2394 Enables support for specific chip vendors.
2397 CONFIG_FPGA_<family>
2399 Enables support for FPGA family.
2400 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2404 Specify the number of FPGA devices to support.
2406 CONFIG_SYS_FPGA_PROG_FEEDBACK
2408 Enable printing of hash marks during FPGA configuration.
2410 CONFIG_SYS_FPGA_CHECK_BUSY
2412 Enable checks on FPGA configuration interface busy
2413 status by the configuration function. This option
2414 will require a board or device specific function to
2419 If defined, a function that provides delays in the FPGA
2420 configuration driver.
2422 CONFIG_SYS_FPGA_CHECK_CTRLC
2423 Allow Control-C to interrupt FPGA configuration
2425 CONFIG_SYS_FPGA_CHECK_ERROR
2427 Check for configuration errors during FPGA bitfile
2428 loading. For example, abort during Virtex II
2429 configuration if the INIT_B line goes low (which
2430 indicated a CRC error).
2432 CONFIG_SYS_FPGA_WAIT_INIT
2434 Maximum time to wait for the INIT_B line to deassert
2435 after PROB_B has been deasserted during a Virtex II
2436 FPGA configuration sequence. The default time is 500
2439 CONFIG_SYS_FPGA_WAIT_BUSY
2441 Maximum time to wait for BUSY to deassert during
2442 Virtex II FPGA configuration. The default is 5 ms.
2444 CONFIG_SYS_FPGA_WAIT_CONFIG
2446 Time to wait after FPGA configuration. The default is
2449 - Configuration Management:
2452 If defined, this string will be added to the U-Boot
2453 version information (U_BOOT_VERSION)
2455 - Vendor Parameter Protection:
2457 U-Boot considers the values of the environment
2458 variables "serial#" (Board Serial Number) and
2459 "ethaddr" (Ethernet Address) to be parameters that
2460 are set once by the board vendor / manufacturer, and
2461 protects these variables from casual modification by
2462 the user. Once set, these variables are read-only,
2463 and write or delete attempts are rejected. You can
2464 change this behaviour:
2466 If CONFIG_ENV_OVERWRITE is #defined in your config
2467 file, the write protection for vendor parameters is
2468 completely disabled. Anybody can change or delete
2471 Alternatively, if you #define _both_ CONFIG_ETHADDR
2472 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2473 Ethernet address is installed in the environment,
2474 which can be changed exactly ONCE by the user. [The
2475 serial# is unaffected by this, i. e. it remains
2478 The same can be accomplished in a more flexible way
2479 for any variable by configuring the type of access
2480 to allow for those variables in the ".flags" variable
2481 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2486 Define this variable to enable the reservation of
2487 "protected RAM", i. e. RAM which is not overwritten
2488 by U-Boot. Define CONFIG_PRAM to hold the number of
2489 kB you want to reserve for pRAM. You can overwrite
2490 this default value by defining an environment
2491 variable "pram" to the number of kB you want to
2492 reserve. Note that the board info structure will
2493 still show the full amount of RAM. If pRAM is
2494 reserved, a new environment variable "mem" will
2495 automatically be defined to hold the amount of
2496 remaining RAM in a form that can be passed as boot
2497 argument to Linux, for instance like that:
2499 setenv bootargs ... mem=\${mem}
2502 This way you can tell Linux not to use this memory,
2503 either, which results in a memory region that will
2504 not be affected by reboots.
2506 *WARNING* If your board configuration uses automatic
2507 detection of the RAM size, you must make sure that
2508 this memory test is non-destructive. So far, the
2509 following board configurations are known to be
2512 IVMS8, IVML24, SPD8xx, TQM8xxL,
2513 HERMES, IP860, RPXlite, LWMON,
2516 - Access to physical memory region (> 4GB)
2517 Some basic support is provided for operations on memory not
2518 normally accessible to U-Boot - e.g. some architectures
2519 support access to more than 4GB of memory on 32-bit
2520 machines using physical address extension or similar.
2521 Define CONFIG_PHYSMEM to access this basic support, which
2522 currently only supports clearing the memory.
2527 Define this variable to stop the system in case of a
2528 fatal error, so that you have to reset it manually.
2529 This is probably NOT a good idea for an embedded
2530 system where you want the system to reboot
2531 automatically as fast as possible, but it may be
2532 useful during development since you can try to debug
2533 the conditions that lead to the situation.
2535 CONFIG_NET_RETRY_COUNT
2537 This variable defines the number of retries for
2538 network operations like ARP, RARP, TFTP, or BOOTP
2539 before giving up the operation. If not defined, a
2540 default value of 5 is used.
2544 Timeout waiting for an ARP reply in milliseconds.
2548 Timeout in milliseconds used in NFS protocol.
2549 If you encounter "ERROR: Cannot umount" in nfs command,
2550 try longer timeout such as
2551 #define CONFIG_NFS_TIMEOUT 10000UL
2553 - Command Interpreter:
2554 CONFIG_AUTO_COMPLETE
2556 Enable auto completion of commands using TAB.
2558 Note that this feature has NOT been implemented yet
2559 for the "hush" shell.
2562 CONFIG_SYS_HUSH_PARSER
2564 Define this variable to enable the "hush" shell (from
2565 Busybox) as command line interpreter, thus enabling
2566 powerful command line syntax like
2567 if...then...else...fi conditionals or `&&' and '||'
2568 constructs ("shell scripts").
2570 If undefined, you get the old, much simpler behaviour
2571 with a somewhat smaller memory footprint.
2574 CONFIG_SYS_PROMPT_HUSH_PS2
2576 This defines the secondary prompt string, which is
2577 printed when the command interpreter needs more input
2578 to complete a command. Usually "> ".
2582 In the current implementation, the local variables
2583 space and global environment variables space are
2584 separated. Local variables are those you define by
2585 simply typing `name=value'. To access a local
2586 variable later on, you have write `$name' or
2587 `${name}'; to execute the contents of a variable
2588 directly type `$name' at the command prompt.
2590 Global environment variables are those you use
2591 setenv/printenv to work with. To run a command stored
2592 in such a variable, you need to use the run command,
2593 and you must not use the '$' sign to access them.
2595 To store commands and special characters in a
2596 variable, please use double quotation marks
2597 surrounding the whole text of the variable, instead
2598 of the backslashes before semicolons and special
2601 - Commandline Editing and History:
2602 CONFIG_CMDLINE_EDITING
2604 Enable editing and History functions for interactive
2605 commandline input operations
2607 - Default Environment:
2608 CONFIG_EXTRA_ENV_SETTINGS
2610 Define this to contain any number of null terminated
2611 strings (variable = value pairs) that will be part of
2612 the default environment compiled into the boot image.
2614 For example, place something like this in your
2615 board's config file:
2617 #define CONFIG_EXTRA_ENV_SETTINGS \
2621 Warning: This method is based on knowledge about the
2622 internal format how the environment is stored by the
2623 U-Boot code. This is NOT an official, exported
2624 interface! Although it is unlikely that this format
2625 will change soon, there is no guarantee either.
2626 You better know what you are doing here.
2628 Note: overly (ab)use of the default environment is
2629 discouraged. Make sure to check other ways to preset
2630 the environment like the "source" command or the
2633 CONFIG_ENV_VARS_UBOOT_CONFIG
2635 Define this in order to add variables describing the
2636 U-Boot build configuration to the default environment.
2637 These will be named arch, cpu, board, vendor, and soc.
2639 Enabling this option will cause the following to be defined:
2647 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2649 Define this in order to add variables describing certain
2650 run-time determined information about the hardware to the
2651 environment. These will be named board_name, board_rev.
2653 CONFIG_DELAY_ENVIRONMENT
2655 Normally the environment is loaded when the board is
2656 intialised so that it is available to U-Boot. This inhibits
2657 that so that the environment is not available until
2658 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2659 this is instead controlled by the value of
2660 /config/load-environment.
2662 - DataFlash Support:
2663 CONFIG_HAS_DATAFLASH
2665 Defining this option enables DataFlash features and
2666 allows to read/write in Dataflash via the standard
2669 - Serial Flash support
2672 Defining this option enables SPI flash commands
2673 'sf probe/read/write/erase/update'.
2675 Usage requires an initial 'probe' to define the serial
2676 flash parameters, followed by read/write/erase/update
2679 The following defaults may be provided by the platform
2680 to handle the common case when only a single serial
2681 flash is present on the system.
2683 CONFIG_SF_DEFAULT_BUS Bus identifier
2684 CONFIG_SF_DEFAULT_CS Chip-select
2685 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2686 CONFIG_SF_DEFAULT_SPEED in Hz
2690 Define this option to include a destructive SPI flash
2693 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2695 Define this option to use the Bank addr/Extended addr
2696 support on SPI flashes which has size > 16Mbytes.
2698 - SystemACE Support:
2701 Adding this option adds support for Xilinx SystemACE
2702 chips attached via some sort of local bus. The address
2703 of the chip must also be defined in the
2704 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2706 #define CONFIG_SYSTEMACE
2707 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2709 When SystemACE support is added, the "ace" device type
2710 becomes available to the fat commands, i.e. fatls.
2712 - TFTP Fixed UDP Port:
2715 If this is defined, the environment variable tftpsrcp
2716 is used to supply the TFTP UDP source port value.
2717 If tftpsrcp isn't defined, the normal pseudo-random port
2718 number generator is used.
2720 Also, the environment variable tftpdstp is used to supply
2721 the TFTP UDP destination port value. If tftpdstp isn't
2722 defined, the normal port 69 is used.
2724 The purpose for tftpsrcp is to allow a TFTP server to
2725 blindly start the TFTP transfer using the pre-configured
2726 target IP address and UDP port. This has the effect of
2727 "punching through" the (Windows XP) firewall, allowing
2728 the remainder of the TFTP transfer to proceed normally.
2729 A better solution is to properly configure the firewall,
2730 but sometimes that is not allowed.
2735 This enables a generic 'hash' command which can produce
2736 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2740 Enable the hash verify command (hash -v). This adds to code
2743 CONFIG_SHA1 - support SHA1 hashing
2744 CONFIG_SHA256 - support SHA256 hashing
2746 Note: There is also a sha1sum command, which should perhaps
2747 be deprecated in favour of 'hash sha1'.
2749 - Freescale i.MX specific commands:
2750 CONFIG_CMD_HDMIDETECT
2751 This enables 'hdmidet' command which returns true if an
2752 HDMI monitor is detected. This command is i.MX 6 specific.
2755 This enables the 'bmode' (bootmode) command for forcing
2756 a boot from specific media.
2758 This is useful for forcing the ROM's usb downloader to
2759 activate upon a watchdog reset which is nice when iterating
2760 on U-Boot. Using the reset button or running bmode normal
2761 will set it back to normal. This command currently
2762 supports i.MX53 and i.MX6.
2767 This enables the RSA algorithm used for FIT image verification
2768 in U-Boot. See doc/uImage/signature for more information.
2770 The signing part is build into mkimage regardless of this
2774 - Show boot progress:
2775 CONFIG_SHOW_BOOT_PROGRESS
2777 Defining this option allows to add some board-
2778 specific code (calling a user-provided function
2779 "show_boot_progress(int)") that enables you to show
2780 the system's boot progress on some display (for
2781 example, some LED's) on your board. At the moment,
2782 the following checkpoints are implemented:
2784 - Detailed boot stage timing
2786 Define this option to get detailed timing of each stage
2787 of the boot process.
2789 CONFIG_BOOTSTAGE_USER_COUNT
2790 This is the number of available user bootstage records.
2791 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2792 a new ID will be allocated from this stash. If you exceed
2793 the limit, recording will stop.
2795 CONFIG_BOOTSTAGE_REPORT
2796 Define this to print a report before boot, similar to this:
2798 Timer summary in microseconds:
2801 3,575,678 3,575,678 board_init_f start
2802 3,575,695 17 arch_cpu_init A9
2803 3,575,777 82 arch_cpu_init done
2804 3,659,598 83,821 board_init_r start
2805 3,910,375 250,777 main_loop
2806 29,916,167 26,005,792 bootm_start
2807 30,361,327 445,160 start_kernel
2809 CONFIG_CMD_BOOTSTAGE
2810 Add a 'bootstage' command which supports printing a report
2811 and un/stashing of bootstage data.
2813 CONFIG_BOOTSTAGE_FDT
2814 Stash the bootstage information in the FDT. A root 'bootstage'
2815 node is created with each bootstage id as a child. Each child
2816 has a 'name' property and either 'mark' containing the
2817 mark time in microsecond, or 'accum' containing the
2818 accumulated time for that bootstage id in microseconds.
2823 name = "board_init_f";
2832 Code in the Linux kernel can find this in /proc/devicetree.
2834 Legacy uImage format:
2837 1 common/cmd_bootm.c before attempting to boot an image
2838 -1 common/cmd_bootm.c Image header has bad magic number
2839 2 common/cmd_bootm.c Image header has correct magic number
2840 -2 common/cmd_bootm.c Image header has bad checksum
2841 3 common/cmd_bootm.c Image header has correct checksum
2842 -3 common/cmd_bootm.c Image data has bad checksum
2843 4 common/cmd_bootm.c Image data has correct checksum
2844 -4 common/cmd_bootm.c Image is for unsupported architecture
2845 5 common/cmd_bootm.c Architecture check OK
2846 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
2847 6 common/cmd_bootm.c Image Type check OK
2848 -6 common/cmd_bootm.c gunzip uncompression error
2849 -7 common/cmd_bootm.c Unimplemented compression type
2850 7 common/cmd_bootm.c Uncompression OK
2851 8 common/cmd_bootm.c No uncompress/copy overwrite error
2852 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
2854 9 common/image.c Start initial ramdisk verification
2855 -10 common/image.c Ramdisk header has bad magic number
2856 -11 common/image.c Ramdisk header has bad checksum
2857 10 common/image.c Ramdisk header is OK
2858 -12 common/image.c Ramdisk data has bad checksum
2859 11 common/image.c Ramdisk data has correct checksum
2860 12 common/image.c Ramdisk verification complete, start loading
2861 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
2862 13 common/image.c Start multifile image verification
2863 14 common/image.c No initial ramdisk, no multifile, continue.
2865 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2867 -30 arch/powerpc/lib/board.c Fatal error, hang the system
2868 -31 post/post.c POST test failed, detected by post_output_backlog()
2869 -32 post/post.c POST test failed, detected by post_run_single()
2871 34 common/cmd_doc.c before loading a Image from a DOC device
2872 -35 common/cmd_doc.c Bad usage of "doc" command
2873 35 common/cmd_doc.c correct usage of "doc" command
2874 -36 common/cmd_doc.c No boot device
2875 36 common/cmd_doc.c correct boot device
2876 -37 common/cmd_doc.c Unknown Chip ID on boot device
2877 37 common/cmd_doc.c correct chip ID found, device available
2878 -38 common/cmd_doc.c Read Error on boot device
2879 38 common/cmd_doc.c reading Image header from DOC device OK
2880 -39 common/cmd_doc.c Image header has bad magic number
2881 39 common/cmd_doc.c Image header has correct magic number
2882 -40 common/cmd_doc.c Error reading Image from DOC device
2883 40 common/cmd_doc.c Image header has correct magic number
2884 41 common/cmd_ide.c before loading a Image from a IDE device
2885 -42 common/cmd_ide.c Bad usage of "ide" command
2886 42 common/cmd_ide.c correct usage of "ide" command
2887 -43 common/cmd_ide.c No boot device
2888 43 common/cmd_ide.c boot device found
2889 -44 common/cmd_ide.c Device not available
2890 44 common/cmd_ide.c Device available
2891 -45 common/cmd_ide.c wrong partition selected
2892 45 common/cmd_ide.c partition selected
2893 -46 common/cmd_ide.c Unknown partition table
2894 46 common/cmd_ide.c valid partition table found
2895 -47 common/cmd_ide.c Invalid partition type
2896 47 common/cmd_ide.c correct partition type
2897 -48 common/cmd_ide.c Error reading Image Header on boot device
2898 48 common/cmd_ide.c reading Image Header from IDE device OK
2899 -49 common/cmd_ide.c Image header has bad magic number
2900 49 common/cmd_ide.c Image header has correct magic number
2901 -50 common/cmd_ide.c Image header has bad checksum
2902 50 common/cmd_ide.c Image header has correct checksum
2903 -51 common/cmd_ide.c Error reading Image from IDE device
2904 51 common/cmd_ide.c reading Image from IDE device OK
2905 52 common/cmd_nand.c before loading a Image from a NAND device
2906 -53 common/cmd_nand.c Bad usage of "nand" command
2907 53 common/cmd_nand.c correct usage of "nand" command
2908 -54 common/cmd_nand.c No boot device
2909 54 common/cmd_nand.c boot device found
2910 -55 common/cmd_nand.c Unknown Chip ID on boot device
2911 55 common/cmd_nand.c correct chip ID found, device available
2912 -56 common/cmd_nand.c Error reading Image Header on boot device
2913 56 common/cmd_nand.c reading Image Header from NAND device OK
2914 -57 common/cmd_nand.c Image header has bad magic number
2915 57 common/cmd_nand.c Image header has correct magic number
2916 -58 common/cmd_nand.c Error reading Image from NAND device
2917 58 common/cmd_nand.c reading Image from NAND device OK
2919 -60 common/env_common.c Environment has a bad CRC, using default
2921 64 net/eth.c starting with Ethernet configuration.
2922 -64 net/eth.c no Ethernet found.
2923 65 net/eth.c Ethernet found.
2925 -80 common/cmd_net.c usage wrong
2926 80 common/cmd_net.c before calling NetLoop()
2927 -81 common/cmd_net.c some error in NetLoop() occurred
2928 81 common/cmd_net.c NetLoop() back without error
2929 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2930 82 common/cmd_net.c trying automatic boot
2931 83 common/cmd_net.c running "source" command
2932 -83 common/cmd_net.c some error in automatic boot or "source" command
2933 84 common/cmd_net.c end without errors
2938 100 common/cmd_bootm.c Kernel FIT Image has correct format
2939 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2940 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2941 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2942 102 common/cmd_bootm.c Kernel unit name specified
2943 -103 common/cmd_bootm.c Can't get kernel subimage node offset
2944 103 common/cmd_bootm.c Found configuration node
2945 104 common/cmd_bootm.c Got kernel subimage node offset
2946 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2947 105 common/cmd_bootm.c Kernel subimage hash verification OK
2948 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2949 106 common/cmd_bootm.c Architecture check OK
2950 -106 common/cmd_bootm.c Kernel subimage has wrong type
2951 107 common/cmd_bootm.c Kernel subimage type OK
2952 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2953 108 common/cmd_bootm.c Got kernel subimage data/size
2954 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2955 -109 common/cmd_bootm.c Can't get kernel subimage type
2956 -110 common/cmd_bootm.c Can't get kernel subimage comp
2957 -111 common/cmd_bootm.c Can't get kernel subimage os
2958 -112 common/cmd_bootm.c Can't get kernel subimage load address
2959 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2961 120 common/image.c Start initial ramdisk verification
2962 -120 common/image.c Ramdisk FIT image has incorrect format
2963 121 common/image.c Ramdisk FIT image has correct format
2964 122 common/image.c No ramdisk subimage unit name, using configuration
2965 -122 common/image.c Can't get configuration for ramdisk subimage
2966 123 common/image.c Ramdisk unit name specified
2967 -124 common/image.c Can't get ramdisk subimage node offset
2968 125 common/image.c Got ramdisk subimage node offset
2969 -125 common/image.c Ramdisk subimage hash verification failed
2970 126 common/image.c Ramdisk subimage hash verification OK
2971 -126 common/image.c Ramdisk subimage for unsupported architecture
2972 127 common/image.c Architecture check OK
2973 -127 common/image.c Can't get ramdisk subimage data/size
2974 128 common/image.c Got ramdisk subimage data/size
2975 129 common/image.c Can't get ramdisk load address
2976 -129 common/image.c Got ramdisk load address
2978 -130 common/cmd_doc.c Incorrect FIT image format
2979 131 common/cmd_doc.c FIT image format OK
2981 -140 common/cmd_ide.c Incorrect FIT image format
2982 141 common/cmd_ide.c FIT image format OK
2984 -150 common/cmd_nand.c Incorrect FIT image format
2985 151 common/cmd_nand.c FIT image format OK
2987 - FIT image support:
2989 Enable support for the FIT uImage format.
2991 CONFIG_FIT_BEST_MATCH
2992 When no configuration is explicitly selected, default to the
2993 one whose fdt's compatibility field best matches that of
2994 U-Boot itself. A match is considered "best" if it matches the
2995 most specific compatibility entry of U-Boot's fdt's root node.
2996 The order of entries in the configuration's fdt is ignored.
2998 CONFIG_FIT_SIGNATURE
2999 This option enables signature verification of FIT uImages,
3000 using a hash signed and verified using RSA. See
3001 doc/uImage.FIT/signature.txt for more details.
3003 - Standalone program support:
3004 CONFIG_STANDALONE_LOAD_ADDR
3006 This option defines a board specific value for the
3007 address where standalone program gets loaded, thus
3008 overwriting the architecture dependent default
3011 - Frame Buffer Address:
3014 Define CONFIG_FB_ADDR if you want to use specific
3015 address for frame buffer. This is typically the case
3016 when using a graphics controller has separate video
3017 memory. U-Boot will then place the frame buffer at
3018 the given address instead of dynamically reserving it
3019 in system RAM by calling lcd_setmem(), which grabs
3020 the memory for the frame buffer depending on the
3021 configured panel size.
3023 Please see board_init_f function.
3025 - Automatic software updates via TFTP server
3027 CONFIG_UPDATE_TFTP_CNT_MAX
3028 CONFIG_UPDATE_TFTP_MSEC_MAX
3030 These options enable and control the auto-update feature;
3031 for a more detailed description refer to doc/README.update.
3033 - MTD Support (mtdparts command, UBI support)
3036 Adds the MTD device infrastructure from the Linux kernel.
3037 Needed for mtdparts command support.
3039 CONFIG_MTD_PARTITIONS
3041 Adds the MTD partitioning infrastructure from the Linux
3042 kernel. Needed for UBI support.
3047 Adds commands for interacting with MTD partitions formatted
3048 with the UBI flash translation layer
3050 Requires also defining CONFIG_RBTREE
3052 CONFIG_UBI_SILENCE_MSG
3054 Make the verbose messages from UBI stop printing. This leaves
3055 warnings and errors enabled.
3060 Adds commands for interacting with UBI volumes formatted as
3061 UBIFS. UBIFS is read-only in u-boot.
3063 Requires UBI support as well as CONFIG_LZO
3065 CONFIG_UBIFS_SILENCE_MSG
3067 Make the verbose messages from UBIFS stop printing. This leaves
3068 warnings and errors enabled.
3072 Enable building of SPL globally.
3075 LDSCRIPT for linking the SPL binary.
3077 CONFIG_SPL_MAX_FOOTPRINT
3078 Maximum size in memory allocated to the SPL, BSS included.
3079 When defined, the linker checks that the actual memory
3080 used by SPL from _start to __bss_end does not exceed it.
3081 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3082 must not be both defined at the same time.
3085 Maximum size of the SPL image (text, data, rodata, and
3086 linker lists sections), BSS excluded.
3087 When defined, the linker checks that the actual size does
3090 CONFIG_SPL_TEXT_BASE
3091 TEXT_BASE for linking the SPL binary.
3093 CONFIG_SPL_RELOC_TEXT_BASE
3094 Address to relocate to. If unspecified, this is equal to
3095 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3097 CONFIG_SPL_BSS_START_ADDR
3098 Link address for the BSS within the SPL binary.
3100 CONFIG_SPL_BSS_MAX_SIZE
3101 Maximum size in memory allocated to the SPL BSS.
3102 When defined, the linker checks that the actual memory used
3103 by SPL from __bss_start to __bss_end does not exceed it.
3104 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3105 must not be both defined at the same time.
3108 Adress of the start of the stack SPL will use
3110 CONFIG_SPL_RELOC_STACK
3111 Adress of the start of the stack SPL will use after
3112 relocation. If unspecified, this is equal to
3115 CONFIG_SYS_SPL_MALLOC_START
3116 Starting address of the malloc pool used in SPL.
3118 CONFIG_SYS_SPL_MALLOC_SIZE
3119 The size of the malloc pool used in SPL.
3121 CONFIG_SPL_FRAMEWORK
3122 Enable the SPL framework under common/. This framework
3123 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3124 NAND loading of the Linux Kernel.
3126 CONFIG_SPL_DISPLAY_PRINT
3127 For ARM, enable an optional function to print more information
3128 about the running system.
3130 CONFIG_SPL_INIT_MINIMAL
3131 Arch init code should be built for a very small image
3133 CONFIG_SPL_LIBCOMMON_SUPPORT
3134 Support for common/libcommon.o in SPL binary
3136 CONFIG_SPL_LIBDISK_SUPPORT
3137 Support for disk/libdisk.o in SPL binary
3139 CONFIG_SPL_I2C_SUPPORT
3140 Support for drivers/i2c/libi2c.o in SPL binary
3142 CONFIG_SPL_GPIO_SUPPORT
3143 Support for drivers/gpio/libgpio.o in SPL binary
3145 CONFIG_SPL_MMC_SUPPORT
3146 Support for drivers/mmc/libmmc.o in SPL binary
3148 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3149 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3150 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3151 Address, size and partition on the MMC to load U-Boot from
3152 when the MMC is being used in raw mode.
3154 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3155 Sector to load kernel uImage from when MMC is being
3156 used in raw mode (for Falcon mode)
3158 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3159 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3160 Sector and number of sectors to load kernel argument
3161 parameters from when MMC is being used in raw mode
3164 CONFIG_SPL_FAT_SUPPORT
3165 Support for fs/fat/libfat.o in SPL binary
3167 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3168 Filename to read to load U-Boot when reading from FAT
3170 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3171 Filename to read to load kernel uImage when reading
3172 from FAT (for Falcon mode)
3174 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3175 Filename to read to load kernel argument parameters
3176 when reading from FAT (for Falcon mode)
3178 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3179 Set this for NAND SPL on PPC mpc83xx targets, so that
3180 start.S waits for the rest of the SPL to load before
3181 continuing (the hardware starts execution after just
3182 loading the first page rather than the full 4K).
3184 CONFIG_SPL_NAND_BASE
3185 Include nand_base.c in the SPL. Requires
3186 CONFIG_SPL_NAND_DRIVERS.
3188 CONFIG_SPL_NAND_DRIVERS
3189 SPL uses normal NAND drivers, not minimal drivers.
3192 Include standard software ECC in the SPL
3194 CONFIG_SPL_NAND_SIMPLE
3195 Support for NAND boot using simple NAND drivers that
3196 expose the cmd_ctrl() interface.
3198 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3199 Set for the SPL on PPC mpc8xxx targets, support for
3200 arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.
3202 CONFIG_SPL_COMMON_INIT_DDR
3203 Set for common ddr init with serial presence detect in
3206 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3207 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3208 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3209 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3210 CONFIG_SYS_NAND_ECCBYTES
3211 Defines the size and behavior of the NAND that SPL uses
3214 CONFIG_SYS_NAND_U_BOOT_OFFS
3215 Location in NAND to read U-Boot from
3217 CONFIG_SYS_NAND_U_BOOT_DST
3218 Location in memory to load U-Boot to
3220 CONFIG_SYS_NAND_U_BOOT_SIZE
3221 Size of image to load
3223 CONFIG_SYS_NAND_U_BOOT_START
3224 Entry point in loaded image to jump to
3226 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3227 Define this if you need to first read the OOB and then the
3228 data. This is used for example on davinci plattforms.
3230 CONFIG_SPL_OMAP3_ID_NAND
3231 Support for an OMAP3-specific set of functions to return the
3232 ID and MFR of the first attached NAND chip, if present.
3234 CONFIG_SPL_SERIAL_SUPPORT
3235 Support for drivers/serial/libserial.o in SPL binary
3237 CONFIG_SPL_SPI_FLASH_SUPPORT
3238 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
3240 CONFIG_SPL_SPI_SUPPORT
3241 Support for drivers/spi/libspi.o in SPL binary
3243 CONFIG_SPL_RAM_DEVICE
3244 Support for running image already present in ram, in SPL binary
3246 CONFIG_SPL_LIBGENERIC_SUPPORT
3247 Support for lib/libgeneric.o in SPL binary
3249 CONFIG_SPL_ENV_SUPPORT
3250 Support for the environment operating in SPL binary
3252 CONFIG_SPL_NET_SUPPORT
3253 Support for the net/libnet.o in SPL binary.
3254 It conflicts with SPL env from storage medium specified by
3255 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3258 Image offset to which the SPL should be padded before appending
3259 the SPL payload. By default, this is defined as
3260 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3261 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3262 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3265 Final target image containing SPL and payload. Some SPLs
3266 use an arch-specific makefile fragment instead, for
3267 example if more than one image needs to be produced.
3269 CONFIG_FIT_SPL_PRINT
3270 Printing information about a FIT image adds quite a bit of
3271 code to SPL. So this is normally disabled in SPL. Use this
3272 option to re-enable it. This will affect the output of the
3273 bootm command when booting a FIT image.
3277 Enable building of TPL globally.
3280 Image offset to which the TPL should be padded before appending
3281 the TPL payload. By default, this is defined as
3282 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3283 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3284 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3289 [so far only for SMDK2400 boards]
3291 - Modem support enable:
3292 CONFIG_MODEM_SUPPORT
3294 - RTS/CTS Flow control enable:
3297 - Modem debug support:
3298 CONFIG_MODEM_SUPPORT_DEBUG
3300 Enables debugging stuff (char screen[1024], dbg())
3301 for modem support. Useful only with BDI2000.
3303 - Interrupt support (PPC):
3305 There are common interrupt_init() and timer_interrupt()
3306 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
3307 for CPU specific initialization. interrupt_init_cpu()
3308 should set decrementer_count to appropriate value. If
3309 CPU resets decrementer automatically after interrupt
3310 (ppc4xx) it should set decrementer_count to zero.
3311 timer_interrupt() calls timer_interrupt_cpu() for CPU
3312 specific handling. If board has watchdog / status_led
3313 / other_activity_monitor it works automatically from
3314 general timer_interrupt().
3318 In the target system modem support is enabled when a
3319 specific key (key combination) is pressed during
3320 power-on. Otherwise U-Boot will boot normally
3321 (autoboot). The key_pressed() function is called from
3322 board_init(). Currently key_pressed() is a dummy
3323 function, returning 1 and thus enabling modem
3326 If there are no modem init strings in the
3327 environment, U-Boot proceed to autoboot; the
3328 previous output (banner, info printfs) will be
3331 See also: doc/README.Modem
3333 Board initialization settings:
3334 ------------------------------
3336 During Initialization u-boot calls a number of board specific functions
3337 to allow the preparation of board specific prerequisites, e.g. pin setup
3338 before drivers are initialized. To enable these callbacks the
3339 following configuration macros have to be defined. Currently this is
3340 architecture specific, so please check arch/your_architecture/lib/board.c
3341 typically in board_init_f() and board_init_r().
3343 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3344 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3345 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
3346 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3348 Configuration Settings:
3349 -----------------------
3351 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3352 undefine this when you're short of memory.
3354 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3355 width of the commands listed in the 'help' command output.
3357 - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
3358 prompt for user input.
3360 - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
3362 - CONFIG_SYS_PBSIZE: Buffer size for Console output
3364 - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
3366 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3367 the application (usually a Linux kernel) when it is
3370 - CONFIG_SYS_BAUDRATE_TABLE:
3371 List of legal baudrate settings for this board.
3373 - CONFIG_SYS_CONSOLE_INFO_QUIET
3374 Suppress display of console information at boot.
3376 - CONFIG_SYS_CONSOLE_IS_IN_ENV
3377 If the board specific function
3378 extern int overwrite_console (void);
3379 returns 1, the stdin, stderr and stdout are switched to the
3380 serial port, else the settings in the environment are used.
3382 - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3383 Enable the call to overwrite_console().
3385 - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3386 Enable overwrite of previous console environment settings.
3388 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3389 Begin and End addresses of the area used by the
3392 - CONFIG_SYS_ALT_MEMTEST:
3393 Enable an alternate, more extensive memory test.
3395 - CONFIG_SYS_MEMTEST_SCRATCH:
3396 Scratch address used by the alternate memory test
3397 You only need to set this if address zero isn't writeable
3399 - CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3400 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3401 this specified memory area will get subtracted from the top
3402 (end) of RAM and won't get "touched" at all by U-Boot. By
3403 fixing up gd->ram_size the Linux kernel should gets passed
3404 the now "corrected" memory size and won't touch it either.
3405 This should work for arch/ppc and arch/powerpc. Only Linux
3406 board ports in arch/powerpc with bootwrapper support that
3407 recalculate the memory size from the SDRAM controller setup
3408 will have to get fixed in Linux additionally.
3410 This option can be used as a workaround for the 440EPx/GRx
3411 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3414 WARNING: Please make sure that this value is a multiple of
3415 the Linux page size (normally 4k). If this is not the case,
3416 then the end address of the Linux memory will be located at a
3417 non page size aligned address and this could cause major
3420 - CONFIG_SYS_LOADS_BAUD_CHANGE:
3421 Enable temporary baudrate change while serial download
3423 - CONFIG_SYS_SDRAM_BASE:
3424 Physical start address of SDRAM. _Must_ be 0 here.
3426 - CONFIG_SYS_MBIO_BASE:
3427 Physical start address of Motherboard I/O (if using a
3430 - CONFIG_SYS_FLASH_BASE:
3431 Physical start address of Flash memory.
3433 - CONFIG_SYS_MONITOR_BASE:
3434 Physical start address of boot monitor code (set by
3435 make config files to be same as the text base address
3436 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
3437 CONFIG_SYS_FLASH_BASE when booting from flash.
3439 - CONFIG_SYS_MONITOR_LEN:
3440 Size of memory reserved for monitor code, used to
3441 determine _at_compile_time_ (!) if the environment is
3442 embedded within the U-Boot image, or in a separate
3445 - CONFIG_SYS_MALLOC_LEN:
3446 Size of DRAM reserved for malloc() use.
3448 - CONFIG_SYS_BOOTM_LEN:
3449 Normally compressed uImages are limited to an
3450 uncompressed size of 8 MBytes. If this is not enough,
3451 you can define CONFIG_SYS_BOOTM_LEN in your board config file
3452 to adjust this setting to your needs.
3454 - CONFIG_SYS_BOOTMAPSZ:
3455 Maximum size of memory mapped by the startup code of
3456 the Linux kernel; all data that must be processed by
3457 the Linux kernel (bd_info, boot arguments, FDT blob if
3458 used) must be put below this limit, unless "bootm_low"
3459 environment variable is defined and non-zero. In such case
3460 all data for the Linux kernel must be between "bootm_low"
3461 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
3462 variable "bootm_mapsize" will override the value of
3463 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3464 then the value in "bootm_size" will be used instead.
3466 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
3467 Enable initrd_high functionality. If defined then the
3468 initrd_high feature is enabled and the bootm ramdisk subcommand
3471 - CONFIG_SYS_BOOT_GET_CMDLINE:
3472 Enables allocating and saving kernel cmdline in space between
3473 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3475 - CONFIG_SYS_BOOT_GET_KBD:
3476 Enables allocating and saving a kernel copy of the bd_info in
3477 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3479 - CONFIG_SYS_MAX_FLASH_BANKS:
3480 Max number of Flash memory banks
3482 - CONFIG_SYS_MAX_FLASH_SECT:
3483 Max number of sectors on a Flash chip
3485 - CONFIG_SYS_FLASH_ERASE_TOUT:
3486 Timeout for Flash erase operations (in ms)
3488 - CONFIG_SYS_FLASH_WRITE_TOUT:
3489 Timeout for Flash write operations (in ms)
3491 - CONFIG_SYS_FLASH_LOCK_TOUT
3492 Timeout for Flash set sector lock bit operation (in ms)
3494 - CONFIG_SYS_FLASH_UNLOCK_TOUT
3495 Timeout for Flash clear lock bits operation (in ms)
3497 - CONFIG_SYS_FLASH_PROTECTION
3498 If defined, hardware flash sectors protection is used
3499 instead of U-Boot software protection.
3501 - CONFIG_SYS_DIRECT_FLASH_TFTP:
3503 Enable TFTP transfers directly to flash memory;
3504 without this option such a download has to be
3505 performed in two steps: (1) download to RAM, and (2)
3506 copy from RAM to flash.
3508 The two-step approach is usually more reliable, since
3509 you can check if the download worked before you erase
3510 the flash, but in some situations (when system RAM is
3511 too limited to allow for a temporary copy of the
3512 downloaded image) this option may be very useful.
3514 - CONFIG_SYS_FLASH_CFI:
3515 Define if the flash driver uses extra elements in the
3516 common flash structure for storing flash geometry.
3518 - CONFIG_FLASH_CFI_DRIVER
3519 This option also enables the building of the cfi_flash driver
3520 in the drivers directory
3522 - CONFIG_FLASH_CFI_MTD
3523 This option enables the building of the cfi_mtd driver
3524 in the drivers directory. The driver exports CFI flash
3527 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3528 Use buffered writes to flash.
3530 - CONFIG_FLASH_SPANSION_S29WS_N
3531 s29ws-n MirrorBit flash has non-standard addresses for buffered
3534 - CONFIG_SYS_FLASH_QUIET_TEST
3535 If this option is defined, the common CFI flash doesn't
3536 print it's warning upon not recognized FLASH banks. This
3537 is useful, if some of the configured banks are only
3538 optionally available.
3540 - CONFIG_FLASH_SHOW_PROGRESS
3541 If defined (must be an integer), print out countdown
3542 digits and dots. Recommended value: 45 (9..1) for 80
3543 column displays, 15 (3..1) for 40 column displays.
3545 - CONFIG_FLASH_VERIFY
3546 If defined, the content of the flash (destination) is compared
3547 against the source after the write operation. An error message
3548 will be printed when the contents are not identical.
3549 Please note that this option is useless in nearly all cases,
3550 since such flash programming errors usually are detected earlier
3551 while unprotecting/erasing/programming. Please only enable
3552 this option if you really know what you are doing.
3554 - CONFIG_SYS_RX_ETH_BUFFER:
3555 Defines the number of Ethernet receive buffers. On some
3556 Ethernet controllers it is recommended to set this value
3557 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3558 buffers can be full shortly after enabling the interface
3559 on high Ethernet traffic.
3560 Defaults to 4 if not defined.
3562 - CONFIG_ENV_MAX_ENTRIES
3564 Maximum number of entries in the hash table that is used
3565 internally to store the environment settings. The default
3566 setting is supposed to be generous and should work in most
3567 cases. This setting can be used to tune behaviour; see
3568 lib/hashtable.c for details.
3570 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3571 - CONFIG_ENV_FLAGS_LIST_STATIC
3572 Enable validation of the values given to environment variables when
3573 calling env set. Variables can be restricted to only decimal,
3574 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3575 the variables can also be restricted to IP address or MAC address.
3577 The format of the list is:
3578 type_attribute = [s|d|x|b|i|m]
3579 access_atribute = [a|r|o|c]
3580 attributes = type_attribute[access_atribute]
3581 entry = variable_name[:attributes]
3584 The type attributes are:
3585 s - String (default)
3588 b - Boolean ([1yYtT|0nNfF])
3592 The access attributes are:
3598 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3599 Define this to a list (string) to define the ".flags"
3600 envirnoment variable in the default or embedded environment.
3602 - CONFIG_ENV_FLAGS_LIST_STATIC
3603 Define this to a list (string) to define validation that
3604 should be done if an entry is not found in the ".flags"
3605 environment variable. To override a setting in the static
3606 list, simply add an entry for the same variable name to the
3609 - CONFIG_ENV_ACCESS_IGNORE_FORCE
3610 If defined, don't allow the -f switch to env set override variable
3613 - CONFIG_SYS_GENERIC_BOARD
3614 This selects the architecture-generic board system instead of the
3615 architecture-specific board files. It is intended to move boards
3616 to this new framework over time. Defining this will disable the
3617 arch/foo/lib/board.c file and use common/board_f.c and
3618 common/board_r.c instead. To use this option your architecture
3619 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3620 its config.mk file). If you find problems enabling this option on
3621 your board please report the problem and send patches!
3623 - CONFIG_SYS_SYM_OFFSETS
3624 This is set by architectures that use offsets for link symbols
3625 instead of absolute values. So bss_start is obtained using an
3626 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3627 directly. You should not need to touch this setting.
3629 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3630 This is set by OMAP boards for the max time that reset should
3631 be asserted. See doc/README.omap-reset-time for details on how
3632 the value can be calulated on a given board.
3634 The following definitions that deal with the placement and management
3635 of environment data (variable area); in general, we support the
3636 following configurations:
3638 - CONFIG_BUILD_ENVCRC:
3640 Builds up envcrc with the target environment so that external utils
3641 may easily extract it and embed it in final U-Boot images.
3643 - CONFIG_ENV_IS_IN_FLASH:
3645 Define this if the environment is in flash memory.
3647 a) The environment occupies one whole flash sector, which is
3648 "embedded" in the text segment with the U-Boot code. This
3649 happens usually with "bottom boot sector" or "top boot
3650 sector" type flash chips, which have several smaller
3651 sectors at the start or the end. For instance, such a
3652 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3653 such a case you would place the environment in one of the
3654 4 kB sectors - with U-Boot code before and after it. With
3655 "top boot sector" type flash chips, you would put the
3656 environment in one of the last sectors, leaving a gap
3657 between U-Boot and the environment.
3659 - CONFIG_ENV_OFFSET:
3661 Offset of environment data (variable area) to the
3662 beginning of flash memory; for instance, with bottom boot
3663 type flash chips the second sector can be used: the offset
3664 for this sector is given here.
3666 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3670 This is just another way to specify the start address of
3671 the flash sector containing the environment (instead of
3674 - CONFIG_ENV_SECT_SIZE:
3676 Size of the sector containing the environment.
3679 b) Sometimes flash chips have few, equal sized, BIG sectors.
3680 In such a case you don't want to spend a whole sector for
3685 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
3686 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3687 of this flash sector for the environment. This saves
3688 memory for the RAM copy of the environment.
3690 It may also save flash memory if you decide to use this
3691 when your environment is "embedded" within U-Boot code,
3692 since then the remainder of the flash sector could be used
3693 for U-Boot code. It should be pointed out that this is
3694 STRONGLY DISCOURAGED from a robustness point of view:
3695 updating the environment in flash makes it always
3696 necessary to erase the WHOLE sector. If something goes
3697 wrong before the contents has been restored from a copy in
3698 RAM, your target system will be dead.
3700 - CONFIG_ENV_ADDR_REDUND
3701 CONFIG_ENV_SIZE_REDUND
3703 These settings describe a second storage area used to hold
3704 a redundant copy of the environment data, so that there is
3705 a valid backup copy in case there is a power failure during
3706 a "saveenv" operation.
3708 BE CAREFUL! Any changes to the flash layout, and some changes to the
3709 source code will make it necessary to adapt <board>/u-boot.lds*
3713 - CONFIG_ENV_IS_IN_NVRAM:
3715 Define this if you have some non-volatile memory device
3716 (NVRAM, battery buffered SRAM) which you want to use for the
3722 These two #defines are used to determine the memory area you
3723 want to use for environment. It is assumed that this memory
3724 can just be read and written to, without any special
3727 BE CAREFUL! The first access to the environment happens quite early
3728 in U-Boot initalization (when we try to get the setting of for the
3729 console baudrate). You *MUST* have mapped your NVRAM area then, or
3732 Please note that even with NVRAM we still use a copy of the
3733 environment in RAM: we could work on NVRAM directly, but we want to
3734 keep settings there always unmodified except somebody uses "saveenv"
3735 to save the current settings.
3738 - CONFIG_ENV_IS_IN_EEPROM:
3740 Use this if you have an EEPROM or similar serial access
3741 device and a driver for it.
3743 - CONFIG_ENV_OFFSET:
3746 These two #defines specify the offset and size of the
3747 environment area within the total memory of your EEPROM.
3749 - CONFIG_SYS_I2C_EEPROM_ADDR:
3750 If defined, specified the chip address of the EEPROM device.
3751 The default address is zero.
3753 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3754 If defined, the number of bits used to address bytes in a
3755 single page in the EEPROM device. A 64 byte page, for example
3756 would require six bits.
3758 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3759 If defined, the number of milliseconds to delay between
3760 page writes. The default is zero milliseconds.
3762 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3763 The length in bytes of the EEPROM memory array address. Note
3764 that this is NOT the chip address length!
3766 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
3767 EEPROM chips that implement "address overflow" are ones
3768 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3769 address and the extra bits end up in the "chip address" bit
3770 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3773 Note that we consider the length of the address field to
3774 still be one byte because the extra address bits are hidden
3775 in the chip address.
3777 - CONFIG_SYS_EEPROM_SIZE:
3778 The size in bytes of the EEPROM device.
3780 - CONFIG_ENV_EEPROM_IS_ON_I2C
3781 define this, if you have I2C and SPI activated, and your
3782 EEPROM, which holds the environment, is on the I2C bus.
3784 - CONFIG_I2C_ENV_EEPROM_BUS
3785 if you have an Environment on an EEPROM reached over
3786 I2C muxes, you can define here, how to reach this
3787 EEPROM. For example:
3789 #define CONFIG_I2C_ENV_EEPROM_BUS 1
3791 EEPROM which holds the environment, is reached over
3792 a pca9547 i2c mux with address 0x70, channel 3.
3794 - CONFIG_ENV_IS_IN_DATAFLASH:
3796 Define this if you have a DataFlash memory device which you
3797 want to use for the environment.
3799 - CONFIG_ENV_OFFSET:
3803 These three #defines specify the offset and size of the
3804 environment area within the total memory of your DataFlash placed
3805 at the specified address.
3807 - CONFIG_ENV_IS_IN_REMOTE:
3809 Define this if you have a remote memory space which you
3810 want to use for the local device's environment.
3815 These two #defines specify the address and size of the
3816 environment area within the remote memory space. The
3817 local device can get the environment from remote memory
3818 space by SRIO or PCIE links.
3820 BE CAREFUL! For some special cases, the local device can not use
3821 "saveenv" command. For example, the local device will get the
3822 environment stored in a remote NOR flash by SRIO or PCIE link,
3823 but it can not erase, write this NOR flash by SRIO or PCIE interface.
3825 - CONFIG_ENV_IS_IN_NAND:
3827 Define this if you have a NAND device which you want to use
3828 for the environment.
3830 - CONFIG_ENV_OFFSET:
3833 These two #defines specify the offset and size of the environment
3834 area within the first NAND device. CONFIG_ENV_OFFSET must be
3835 aligned to an erase block boundary.
3837 - CONFIG_ENV_OFFSET_REDUND (optional):
3839 This setting describes a second storage area of CONFIG_ENV_SIZE
3840 size used to hold a redundant copy of the environment data, so
3841 that there is a valid backup copy in case there is a power failure
3842 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
3843 aligned to an erase block boundary.
3845 - CONFIG_ENV_RANGE (optional):
3847 Specifies the length of the region in which the environment
3848 can be written. This should be a multiple of the NAND device's
3849 block size. Specifying a range with more erase blocks than
3850 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3851 the range to be avoided.
3853 - CONFIG_ENV_OFFSET_OOB (optional):
3855 Enables support for dynamically retrieving the offset of the
3856 environment from block zero's out-of-band data. The
3857 "nand env.oob" command can be used to record this offset.
3858 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3859 using CONFIG_ENV_OFFSET_OOB.
3861 - CONFIG_NAND_ENV_DST
3863 Defines address in RAM to which the nand_spl code should copy the
3864 environment. If redundant environment is used, it will be copied to
3865 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3867 - CONFIG_ENV_IS_IN_UBI:
3869 Define this if you have an UBI volume that you want to use for the
3870 environment. This has the benefit of wear-leveling the environment
3871 accesses, which is important on NAND.
3873 - CONFIG_ENV_UBI_PART:
3875 Define this to a string that is the mtd partition containing the UBI.
3877 - CONFIG_ENV_UBI_VOLUME:
3879 Define this to the name of the volume that you want to store the
3882 - CONFIG_ENV_UBI_VOLUME_REDUND:
3884 Define this to the name of another volume to store a second copy of
3885 the environment in. This will enable redundant environments in UBI.
3886 It is assumed that both volumes are in the same MTD partition.
3888 - CONFIG_UBI_SILENCE_MSG
3889 - CONFIG_UBIFS_SILENCE_MSG
3891 You will probably want to define these to avoid a really noisy system
3892 when storing the env in UBI.
3894 - CONFIG_ENV_IS_IN_MMC:
3896 Define this if you have an MMC device which you want to use for the
3899 - CONFIG_SYS_MMC_ENV_DEV:
3901 Specifies which MMC device the environment is stored in.
3903 - CONFIG_SYS_MMC_ENV_PART (optional):
3905 Specifies which MMC partition the environment is stored in. If not
3906 set, defaults to partition 0, the user area. Common values might be
3907 1 (first MMC boot partition), 2 (second MMC boot partition).
3909 - CONFIG_ENV_OFFSET:
3912 These two #defines specify the offset and size of the environment
3913 area within the specified MMC device.
3915 If offset is positive (the usual case), it is treated as relative to
3916 the start of the MMC partition. If offset is negative, it is treated
3917 as relative to the end of the MMC partition. This can be useful if
3918 your board may be fitted with different MMC devices, which have
3919 different sizes for the MMC partitions, and you always want the
3920 environment placed at the very end of the partition, to leave the
3921 maximum possible space before it, to store other data.
3923 These two values are in units of bytes, but must be aligned to an
3924 MMC sector boundary.
3926 - CONFIG_ENV_OFFSET_REDUND (optional):
3928 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3929 hold a redundant copy of the environment data. This provides a
3930 valid backup copy in case the other copy is corrupted, e.g. due
3931 to a power failure during a "saveenv" operation.
3933 This value may also be positive or negative; this is handled in the
3934 same way as CONFIG_ENV_OFFSET.
3936 This value is also in units of bytes, but must also be aligned to
3937 an MMC sector boundary.
3939 - CONFIG_ENV_SIZE_REDUND (optional):
3941 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3942 set. If this value is set, it must be set to the same value as
3945 - CONFIG_SYS_SPI_INIT_OFFSET
3947 Defines offset to the initial SPI buffer area in DPRAM. The
3948 area is used at an early stage (ROM part) if the environment
3949 is configured to reside in the SPI EEPROM: We need a 520 byte
3950 scratch DPRAM area. It is used between the two initialization
3951 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3952 to be a good choice since it makes it far enough from the
3953 start of the data area as well as from the stack pointer.
3955 Please note that the environment is read-only until the monitor
3956 has been relocated to RAM and a RAM copy of the environment has been
3957 created; also, when using EEPROM you will have to use getenv_f()
3958 until then to read environment variables.
3960 The environment is protected by a CRC32 checksum. Before the monitor
3961 is relocated into RAM, as a result of a bad CRC you will be working
3962 with the compiled-in default environment - *silently*!!! [This is
3963 necessary, because the first environment variable we need is the
3964 "baudrate" setting for the console - if we have a bad CRC, we don't
3965 have any device yet where we could complain.]
3967 Note: once the monitor has been relocated, then it will complain if
3968 the default environment is used; a new CRC is computed as soon as you
3969 use the "saveenv" command to store a valid environment.
3971 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3972 Echo the inverted Ethernet link state to the fault LED.
3974 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3975 also needs to be defined.
3977 - CONFIG_SYS_FAULT_MII_ADDR:
3978 MII address of the PHY to check for the Ethernet link state.
3980 - CONFIG_NS16550_MIN_FUNCTIONS:
3981 Define this if you desire to only have use of the NS16550_init
3982 and NS16550_putc functions for the serial driver located at
3983 drivers/serial/ns16550.c. This option is useful for saving
3984 space for already greatly restricted images, including but not
3985 limited to NAND_SPL configurations.
3987 - CONFIG_DISPLAY_BOARDINFO
3988 Display information about the board that U-Boot is running on
3989 when U-Boot starts up. The board function checkboard() is called
3992 - CONFIG_DISPLAY_BOARDINFO_LATE
3993 Similar to the previous option, but display this information
3994 later, once stdio is running and output goes to the LCD, if
3997 Low Level (hardware related) configuration options:
3998 ---------------------------------------------------
4000 - CONFIG_SYS_CACHELINE_SIZE:
4001 Cache Line Size of the CPU.
4003 - CONFIG_SYS_DEFAULT_IMMR:
4004 Default address of the IMMR after system reset.
4006 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4007 and RPXsuper) to be able to adjust the position of
4008 the IMMR register after a reset.
4010 - CONFIG_SYS_CCSRBAR_DEFAULT:
4011 Default (power-on reset) physical address of CCSR on Freescale
4014 - CONFIG_SYS_CCSRBAR:
4015 Virtual address of CCSR. On a 32-bit build, this is typically
4016 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4018 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4019 for cross-platform code that uses that macro instead.
4021 - CONFIG_SYS_CCSRBAR_PHYS:
4022 Physical address of CCSR. CCSR can be relocated to a new
4023 physical address, if desired. In this case, this macro should
4024 be set to that address. Otherwise, it should be set to the
4025 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4026 is typically relocated on 36-bit builds. It is recommended
4027 that this macro be defined via the _HIGH and _LOW macros:
4029 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4030 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4032 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4033 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4034 either 0 (32-bit build) or 0xF (36-bit build). This macro is
4035 used in assembly code, so it must not contain typecasts or
4036 integer size suffixes (e.g. "ULL").
4038 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
4039 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4040 used in assembly code, so it must not contain typecasts or
4041 integer size suffixes (e.g. "ULL").
4043 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4044 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4045 forced to a value that ensures that CCSR is not relocated.
4047 - Floppy Disk Support:
4048 CONFIG_SYS_FDC_DRIVE_NUMBER
4050 the default drive number (default value 0)
4052 CONFIG_SYS_ISA_IO_STRIDE
4054 defines the spacing between FDC chipset registers
4057 CONFIG_SYS_ISA_IO_OFFSET
4059 defines the offset of register from address. It
4060 depends on which part of the data bus is connected to
4061 the FDC chipset. (default value 0)
4063 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4064 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
4067 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
4068 fdc_hw_init() is called at the beginning of the FDC
4069 setup. fdc_hw_init() must be provided by the board
4070 source code. It is used to make hardware dependant
4074 Most IDE controllers were designed to be connected with PCI
4075 interface. Only few of them were designed for AHB interface.
4076 When software is doing ATA command and data transfer to
4077 IDE devices through IDE-AHB controller, some additional
4078 registers accessing to these kind of IDE-AHB controller
4081 - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
4082 DO NOT CHANGE unless you know exactly what you're
4083 doing! (11-4) [MPC8xx/82xx systems only]
4085 - CONFIG_SYS_INIT_RAM_ADDR:
4087 Start address of memory area that can be used for
4088 initial data and stack; please note that this must be
4089 writable memory that is working WITHOUT special
4090 initialization, i. e. you CANNOT use normal RAM which
4091 will become available only after programming the
4092 memory controller and running certain initialization
4095 U-Boot uses the following memory types:
4096 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4097 - MPC824X: data cache
4098 - PPC4xx: data cache
4100 - CONFIG_SYS_GBL_DATA_OFFSET:
4102 Offset of the initial data structure in the memory
4103 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4104 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4105 data is located at the end of the available space
4106 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4107 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4108 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4109 CONFIG_SYS_GBL_DATA_OFFSET) downward.
4112 On the MPC824X (or other systems that use the data
4113 cache for initial memory) the address chosen for
4114 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4115 point to an otherwise UNUSED address space between
4116 the top of RAM and the start of the PCI space.
4118 - CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
4120 - CONFIG_SYS_SYPCR: System Protection Control (11-9)
4122 - CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
4124 - CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
4126 - CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
4128 - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
4130 - CONFIG_SYS_OR_TIMING_SDRAM:
4133 - CONFIG_SYS_MAMR_PTA:
4134 periodic timer for refresh
4136 - CONFIG_SYS_DER: Debug Event Register (37-47)
4138 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4139 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4140 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4141 CONFIG_SYS_BR1_PRELIM:
4142 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4144 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4145 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4146 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4147 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4149 - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4150 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4151 Machine Mode Register and Memory Periodic Timer
4152 Prescaler definitions (SDRAM timing)
4154 - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4155 enable I2C microcode relocation patch (MPC8xx);
4156 define relocation offset in DPRAM [DSP2]
4158 - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4159 enable SMC microcode relocation patch (MPC8xx);
4160 define relocation offset in DPRAM [SMC1]
4162 - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4163 enable SPI microcode relocation patch (MPC8xx);
4164 define relocation offset in DPRAM [SCC4]
4166 - CONFIG_SYS_USE_OSCCLK:
4167 Use OSCM clock mode on MBX8xx board. Be careful,
4168 wrong setting might damage your board. Read
4169 doc/README.MBX before setting this variable!
4171 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4172 Offset of the bootmode word in DPRAM used by post
4173 (Power On Self Tests). This definition overrides
4174 #define'd default value in commproc.h resp.
4177 - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4178 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4179 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4180 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4181 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4182 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4183 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4184 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4185 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
4187 - CONFIG_PCI_DISABLE_PCIE:
4188 Disable PCI-Express on systems where it is supported but not
4191 - CONFIG_PCI_ENUM_ONLY
4192 Only scan through and get the devices on the busses.
4193 Don't do any setup work, presumably because someone or
4194 something has already done it, and we don't need to do it
4195 a second time. Useful for platforms that are pre-booted
4196 by coreboot or similar.
4198 - CONFIG_PCI_INDIRECT_BRIDGE:
4199 Enable support for indirect PCI bridges.
4202 Chip has SRIO or not
4205 Board has SRIO 1 port available
4208 Board has SRIO 2 port available
4210 - CONFIG_SRIO_PCIE_BOOT_MASTER
4211 Board can support master function for Boot from SRIO and PCIE
4213 - CONFIG_SYS_SRIOn_MEM_VIRT:
4214 Virtual Address of SRIO port 'n' memory region
4216 - CONFIG_SYS_SRIOn_MEM_PHYS:
4217 Physical Address of SRIO port 'n' memory region
4219 - CONFIG_SYS_SRIOn_MEM_SIZE:
4220 Size of SRIO port 'n' memory region
4222 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
4223 Defined to tell the NAND controller that the NAND chip is using
4225 Not all NAND drivers use this symbol.
4226 Example of drivers that use it:
4227 - drivers/mtd/nand/ndfc.c
4228 - drivers/mtd/nand/mxc_nand.c
4230 - CONFIG_SYS_NDFC_EBC0_CFG
4231 Sets the EBC0_CFG register for the NDFC. If not defined
4232 a default value will be used.
4235 Get DDR timing information from an I2C EEPROM. Common
4236 with pluggable memory modules such as SODIMMs
4239 I2C address of the SPD EEPROM
4241 - CONFIG_SYS_SPD_BUS_NUM
4242 If SPD EEPROM is on an I2C bus other than the first
4243 one, specify here. Note that the value must resolve
4244 to something your driver can deal with.
4246 - CONFIG_SYS_DDR_RAW_TIMING
4247 Get DDR timing information from other than SPD. Common with
4248 soldered DDR chips onboard without SPD. DDR raw timing
4249 parameters are extracted from datasheet and hard-coded into
4250 header files or board specific files.
4252 - CONFIG_FSL_DDR_INTERACTIVE
4253 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4255 - CONFIG_SYS_83XX_DDR_USES_CS0
4256 Only for 83xx systems. If specified, then DDR should
4257 be configured using CS0 and CS1 instead of CS2 and CS3.
4259 - CONFIG_ETHER_ON_FEC[12]
4260 Define to enable FEC[12] on a 8xx series processor.
4262 - CONFIG_FEC[12]_PHY
4263 Define to the hardcoded PHY address which corresponds
4264 to the given FEC; i. e.
4265 #define CONFIG_FEC1_PHY 4
4266 means that the PHY with address 4 is connected to FEC1
4268 When set to -1, means to probe for first available.
4270 - CONFIG_FEC[12]_PHY_NORXERR
4271 The PHY does not have a RXERR line (RMII only).
4272 (so program the FEC to ignore it).
4275 Enable RMII mode for all FECs.
4276 Note that this is a global option, we can't
4277 have one FEC in standard MII mode and another in RMII mode.
4279 - CONFIG_CRC32_VERIFY
4280 Add a verify option to the crc32 command.
4283 => crc32 -v <address> <count> <crc32>
4285 Where address/count indicate a memory area
4286 and crc32 is the correct crc32 which the
4290 Add the "loopw" memory command. This only takes effect if
4291 the memory commands are activated globally (CONFIG_CMD_MEM).
4294 Add the "mdc" and "mwc" memory commands. These are cyclic
4299 This command will print 4 bytes (10,11,12,13) each 500 ms.
4301 => mwc.l 100 12345678 10
4302 This command will write 12345678 to address 100 all 10 ms.
4304 This only takes effect if the memory commands are activated
4305 globally (CONFIG_CMD_MEM).
4307 - CONFIG_SKIP_LOWLEVEL_INIT
4308 [ARM, NDS32, MIPS only] If this variable is defined, then certain
4309 low level initializations (like setting up the memory
4310 controller) are omitted and/or U-Boot does not
4311 relocate itself into RAM.
4313 Normally this variable MUST NOT be defined. The only
4314 exception is when U-Boot is loaded (to RAM) by some
4315 other boot loader or by a debugger which performs
4316 these initializations itself.
4319 Modifies the behaviour of start.S when compiling a loader
4320 that is executed before the actual U-Boot. E.g. when
4321 compiling a NAND SPL.
4324 Modifies the behaviour of start.S when compiling a loader
4325 that is executed after the SPL and before the actual U-Boot.
4326 It is loaded by the SPL.
4328 - CONFIG_SYS_MPC85XX_NO_RESETVEC
4329 Only for 85xx systems. If this variable is specified, the section
4330 .resetvec is not kept and the section .bootpg is placed in the
4331 previous 4k of the .text section.
4333 - CONFIG_ARCH_MAP_SYSMEM
4334 Generally U-Boot (and in particular the md command) uses
4335 effective address. It is therefore not necessary to regard
4336 U-Boot address as virtual addresses that need to be translated
4337 to physical addresses. However, sandbox requires this, since
4338 it maintains its own little RAM buffer which contains all
4339 addressable memory. This option causes some memory accesses
4340 to be mapped through map_sysmem() / unmap_sysmem().
4342 - CONFIG_USE_ARCH_MEMCPY
4343 CONFIG_USE_ARCH_MEMSET
4344 If these options are used a optimized version of memcpy/memset will
4345 be used if available. These functions may be faster under some
4346 conditions but may increase the binary size.
4348 - CONFIG_X86_RESET_VECTOR
4349 If defined, the x86 reset vector code is included. This is not
4350 needed when U-Boot is running from Coreboot.
4353 Defines the MPU clock speed (in MHz).
4355 NOTE : currently only supported on AM335x platforms.
4357 Freescale QE/FMAN Firmware Support:
4358 -----------------------------------
4360 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4361 loading of "firmware", which is encoded in the QE firmware binary format.
4362 This firmware often needs to be loaded during U-Boot booting, so macros
4363 are used to identify the storage device (NOR flash, SPI, etc) and the address
4366 - CONFIG_SYS_QE_FMAN_FW_ADDR
4367 The address in the storage device where the firmware is located. The
4368 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4371 - CONFIG_SYS_QE_FMAN_FW_LENGTH
4372 The maximum possible size of the firmware. The firmware binary format
4373 has a field that specifies the actual size of the firmware, but it
4374 might not be possible to read any part of the firmware unless some
4375 local storage is allocated to hold the entire firmware first.
4377 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
4378 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4379 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4380 virtual address in NOR flash.
4382 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
4383 Specifies that QE/FMAN firmware is located in NAND flash.
4384 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4386 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
4387 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4388 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4390 - CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4391 Specifies that QE/FMAN firmware is located on the primary SPI
4392 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4394 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4395 Specifies that QE/FMAN firmware is located in the remote (master)
4396 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4397 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4398 window->master inbound window->master LAW->the ucode address in
4399 master's memory space.
4401 Building the Software:
4402 ======================
4404 Building U-Boot has been tested in several native build environments
4405 and in many different cross environments. Of course we cannot support
4406 all possibly existing versions of cross development tools in all
4407 (potentially obsolete) versions. In case of tool chain problems we
4408 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4409 which is extensively used to build and test U-Boot.
4411 If you are not using a native environment, it is assumed that you
4412 have GNU cross compiling tools available in your path. In this case,
4413 you must set the environment variable CROSS_COMPILE in your shell.
4414 Note that no changes to the Makefile or any other source files are
4415 necessary. For example using the ELDK on a 4xx CPU, please enter:
4417 $ CROSS_COMPILE=ppc_4xx-
4418 $ export CROSS_COMPILE
4420 Note: If you wish to generate Windows versions of the utilities in
4421 the tools directory you can use the MinGW toolchain
4422 (http://www.mingw.org). Set your HOST tools to the MinGW
4423 toolchain and execute 'make tools'. For example:
4425 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4427 Binaries such as tools/mkimage.exe will be created which can
4428 be executed on computers running Windows.
4430 U-Boot is intended to be simple to build. After installing the
4431 sources you must configure U-Boot for one specific board type. This
4436 where "NAME_config" is the name of one of the existing configu-
4437 rations; see boards.cfg for supported names.
4439 Note: for some board special configuration names may exist; check if
4440 additional information is available from the board vendor; for
4441 instance, the TQM823L systems are available without (standard)
4442 or with LCD support. You can select such additional "features"
4443 when choosing the configuration, i. e.
4446 - will configure for a plain TQM823L, i. e. no LCD support
4448 make TQM823L_LCD_config
4449 - will configure for a TQM823L with U-Boot console on LCD
4454 Finally, type "make all", and you should get some working U-Boot
4455 images ready for download to / installation on your system:
4457 - "u-boot.bin" is a raw binary image
4458 - "u-boot" is an image in ELF binary format
4459 - "u-boot.srec" is in Motorola S-Record format
4461 By default the build is performed locally and the objects are saved
4462 in the source directory. One of the two methods can be used to change
4463 this behavior and build U-Boot to some external directory:
4465 1. Add O= to the make command line invocations:
4467 make O=/tmp/build distclean
4468 make O=/tmp/build NAME_config
4469 make O=/tmp/build all
4471 2. Set environment variable BUILD_DIR to point to the desired location:
4473 export BUILD_DIR=/tmp/build
4478 Note that the command line "O=" setting overrides the BUILD_DIR environment
4482 Please be aware that the Makefiles assume you are using GNU make, so
4483 for instance on NetBSD you might need to use "gmake" instead of
4487 If the system board that you have is not listed, then you will need
4488 to port U-Boot to your hardware platform. To do this, follow these
4491 1. Add a new configuration option for your board to the toplevel
4492 "boards.cfg" file, using the existing entries as examples.
4493 Follow the instructions there to keep the boards in order.
4494 2. Create a new directory to hold your board specific code. Add any
4495 files you need. In your board directory, you will need at least
4496 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
4497 3. Create a new configuration file "include/configs/<board>.h" for
4499 3. If you're porting U-Boot to a new CPU, then also create a new
4500 directory to hold your CPU specific code. Add any files you need.
4501 4. Run "make <board>_config" with your new name.
4502 5. Type "make", and you should get a working "u-boot.srec" file
4503 to be installed on your target system.
4504 6. Debug and solve any problems that might arise.
4505 [Of course, this last step is much harder than it sounds.]
4508 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4509 ==============================================================
4511 If you have modified U-Boot sources (for instance added a new board
4512 or support for new devices, a new CPU, etc.) you are expected to
4513 provide feedback to the other developers. The feedback normally takes
4514 the form of a "patch", i. e. a context diff against a certain (latest
4515 official or latest in the git repository) version of U-Boot sources.
4517 But before you submit such a patch, please verify that your modifi-
4518 cation did not break existing code. At least make sure that *ALL* of
4519 the supported boards compile WITHOUT ANY compiler warnings. To do so,
4520 just run the "MAKEALL" script, which will configure and build U-Boot
4521 for ALL supported system. Be warned, this will take a while. You can
4522 select which (cross) compiler to use by passing a `CROSS_COMPILE'
4523 environment variable to the script, i. e. to use the ELDK cross tools
4526 CROSS_COMPILE=ppc_8xx- MAKEALL
4528 or to build on a native PowerPC system you can type
4530 CROSS_COMPILE=' ' MAKEALL
4532 When using the MAKEALL script, the default behaviour is to build
4533 U-Boot in the source directory. This location can be changed by
4534 setting the BUILD_DIR environment variable. Also, for each target
4535 built, the MAKEALL script saves two log files (<target>.ERR and
4536 <target>.MAKEALL) in the <source dir>/LOG directory. This default
4537 location can be changed by setting the MAKEALL_LOGDIR environment
4538 variable. For example:
4540 export BUILD_DIR=/tmp/build
4541 export MAKEALL_LOGDIR=/tmp/log
4542 CROSS_COMPILE=ppc_8xx- MAKEALL
4544 With the above settings build objects are saved in the /tmp/build,
4545 log files are saved in the /tmp/log and the source tree remains clean
4546 during the whole build process.
4549 See also "U-Boot Porting Guide" below.
4552 Monitor Commands - Overview:
4553 ============================
4555 go - start application at address 'addr'
4556 run - run commands in an environment variable
4557 bootm - boot application image from memory
4558 bootp - boot image via network using BootP/TFTP protocol
4559 bootz - boot zImage from memory
4560 tftpboot- boot image via network using TFTP protocol
4561 and env variables "ipaddr" and "serverip"
4562 (and eventually "gatewayip")
4563 tftpput - upload a file via network using TFTP protocol
4564 rarpboot- boot image via network using RARP/TFTP protocol
4565 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4566 loads - load S-Record file over serial line
4567 loadb - load binary file over serial line (kermit mode)
4569 mm - memory modify (auto-incrementing)
4570 nm - memory modify (constant address)
4571 mw - memory write (fill)
4573 cmp - memory compare
4574 crc32 - checksum calculation
4575 i2c - I2C sub-system
4576 sspi - SPI utility commands
4577 base - print or set address offset
4578 printenv- print environment variables
4579 setenv - set environment variables
4580 saveenv - save environment variables to persistent storage
4581 protect - enable or disable FLASH write protection
4582 erase - erase FLASH memory
4583 flinfo - print FLASH memory information
4584 nand - NAND memory operations (see doc/README.nand)
4585 bdinfo - print Board Info structure
4586 iminfo - print header information for application image
4587 coninfo - print console devices and informations
4588 ide - IDE sub-system
4589 loop - infinite loop on address range
4590 loopw - infinite write loop on address range
4591 mtest - simple RAM test
4592 icache - enable or disable instruction cache
4593 dcache - enable or disable data cache
4594 reset - Perform RESET of the CPU
4595 echo - echo args to console
4596 version - print monitor version
4597 help - print online help
4598 ? - alias for 'help'
4601 Monitor Commands - Detailed Description:
4602 ========================================
4606 For now: just type "help <command>".
4609 Environment Variables:
4610 ======================
4612 U-Boot supports user configuration using Environment Variables which
4613 can be made persistent by saving to Flash memory.
4615 Environment Variables are set using "setenv", printed using
4616 "printenv", and saved to Flash using "saveenv". Using "setenv"
4617 without a value can be used to delete a variable from the
4618 environment. As long as you don't save the environment you are
4619 working with an in-memory copy. In case the Flash area containing the
4620 environment is erased by accident, a default environment is provided.
4622 Some configuration options can be set using Environment Variables.
4624 List of environment variables (most likely not complete):
4626 baudrate - see CONFIG_BAUDRATE
4628 bootdelay - see CONFIG_BOOTDELAY
4630 bootcmd - see CONFIG_BOOTCOMMAND
4632 bootargs - Boot arguments when booting an RTOS image
4634 bootfile - Name of the image to load with TFTP
4636 bootm_low - Memory range available for image processing in the bootm
4637 command can be restricted. This variable is given as
4638 a hexadecimal number and defines lowest address allowed
4639 for use by the bootm command. See also "bootm_size"
4640 environment variable. Address defined by "bootm_low" is
4641 also the base of the initial memory mapping for the Linux
4642 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4645 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4646 This variable is given as a hexadecimal number and it
4647 defines the size of the memory region starting at base
4648 address bootm_low that is accessible by the Linux kernel
4649 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4650 as the default value if it is defined, and bootm_size is
4653 bootm_size - Memory range available for image processing in the bootm
4654 command can be restricted. This variable is given as
4655 a hexadecimal number and defines the size of the region
4656 allowed for use by the bootm command. See also "bootm_low"
4657 environment variable.
4659 updatefile - Location of the software update file on a TFTP server, used
4660 by the automatic software update feature. Please refer to
4661 documentation in doc/README.update for more details.
4663 autoload - if set to "no" (any string beginning with 'n'),
4664 "bootp" will just load perform a lookup of the
4665 configuration from the BOOTP server, but not try to
4666 load any image using TFTP
4668 autostart - if set to "yes", an image loaded using the "bootp",
4669 "rarpboot", "tftpboot" or "diskboot" commands will
4670 be automatically started (by internally calling
4673 If set to "no", a standalone image passed to the
4674 "bootm" command will be copied to the load address
4675 (and eventually uncompressed), but NOT be started.
4676 This can be used to load and uncompress arbitrary
4679 fdt_high - if set this restricts the maximum address that the
4680 flattened device tree will be copied into upon boot.
4681 For example, if you have a system with 1 GB memory
4682 at physical address 0x10000000, while Linux kernel
4683 only recognizes the first 704 MB as low memory, you
4684 may need to set fdt_high as 0x3C000000 to have the
4685 device tree blob be copied to the maximum address
4686 of the 704 MB low memory, so that Linux kernel can
4687 access it during the boot procedure.
4689 If this is set to the special value 0xFFFFFFFF then
4690 the fdt will not be copied at all on boot. For this
4691 to work it must reside in writable memory, have
4692 sufficient padding on the end of it for u-boot to
4693 add the information it needs into it, and the memory
4694 must be accessible by the kernel.
4696 fdtcontroladdr- if set this is the address of the control flattened
4697 device tree used by U-Boot when CONFIG_OF_CONTROL is
4700 i2cfast - (PPC405GP|PPC405EP only)
4701 if set to 'y' configures Linux I2C driver for fast
4702 mode (400kHZ). This environment variable is used in
4703 initialization code. So, for changes to be effective
4704 it must be saved and board must be reset.
4706 initrd_high - restrict positioning of initrd images:
4707 If this variable is not set, initrd images will be
4708 copied to the highest possible address in RAM; this
4709 is usually what you want since it allows for
4710 maximum initrd size. If for some reason you want to
4711 make sure that the initrd image is loaded below the
4712 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4713 variable to a value of "no" or "off" or "0".
4714 Alternatively, you can set it to a maximum upper
4715 address to use (U-Boot will still check that it
4716 does not overwrite the U-Boot stack and data).
4718 For instance, when you have a system with 16 MB
4719 RAM, and want to reserve 4 MB from use by Linux,
4720 you can do this by adding "mem=12M" to the value of
4721 the "bootargs" variable. However, now you must make
4722 sure that the initrd image is placed in the first
4723 12 MB as well - this can be done with
4725 setenv initrd_high 00c00000
4727 If you set initrd_high to 0xFFFFFFFF, this is an
4728 indication to U-Boot that all addresses are legal
4729 for the Linux kernel, including addresses in flash
4730 memory. In this case U-Boot will NOT COPY the
4731 ramdisk at all. This may be useful to reduce the
4732 boot time on your system, but requires that this
4733 feature is supported by your Linux kernel.
4735 ipaddr - IP address; needed for tftpboot command
4737 loadaddr - Default load address for commands like "bootp",
4738 "rarpboot", "tftpboot", "loadb" or "diskboot"
4740 loads_echo - see CONFIG_LOADS_ECHO
4742 serverip - TFTP server IP address; needed for tftpboot command
4744 bootretry - see CONFIG_BOOT_RETRY_TIME
4746 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
4748 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
4750 ethprime - controls which interface is used first.
4752 ethact - controls which interface is currently active.
4753 For example you can do the following
4755 => setenv ethact FEC
4756 => ping 192.168.0.1 # traffic sent on FEC
4757 => setenv ethact SCC
4758 => ping 10.0.0.1 # traffic sent on SCC
4760 ethrotate - When set to "no" U-Boot does not go through all
4761 available network interfaces.
4762 It just stays at the currently selected interface.
4764 netretry - When set to "no" each network operation will
4765 either succeed or fail without retrying.
4766 When set to "once" the network operation will
4767 fail when all the available network interfaces
4768 are tried once without success.
4769 Useful on scripts which control the retry operation
4772 npe_ucode - set load address for the NPE microcode
4774 silent_linux - If set then linux will be told to boot silently, by
4775 changing the console to be empty. If "yes" it will be
4776 made silent. If "no" it will not be made silent. If
4777 unset, then it will be made silent if the U-Boot console
4780 tftpsrcport - If this is set, the value is used for TFTP's
4783 tftpdstport - If this is set, the value is used for TFTP's UDP
4784 destination port instead of the Well Know Port 69.
4786 tftpblocksize - Block size to use for TFTP transfers; if not set,
4787 we use the TFTP server's default block size
4789 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4790 seconds, minimum value is 1000 = 1 second). Defines
4791 when a packet is considered to be lost so it has to
4792 be retransmitted. The default is 5000 = 5 seconds.
4793 Lowering this value may make downloads succeed
4794 faster in networks with high packet loss rates or
4795 with unreliable TFTP servers.
4797 vlan - When set to a value < 4095 the traffic over
4798 Ethernet is encapsulated/received over 802.1q
4801 The following image location variables contain the location of images
4802 used in booting. The "Image" column gives the role of the image and is
4803 not an environment variable name. The other columns are environment
4804 variable names. "File Name" gives the name of the file on a TFTP
4805 server, "RAM Address" gives the location in RAM the image will be
4806 loaded to, and "Flash Location" gives the image's address in NOR
4807 flash or offset in NAND flash.
4809 *Note* - these variables don't have to be defined for all boards, some
4810 boards currenlty use other variables for these purposes, and some
4811 boards use these variables for other purposes.
4813 Image File Name RAM Address Flash Location
4814 ----- --------- ----------- --------------
4815 u-boot u-boot u-boot_addr_r u-boot_addr
4816 Linux kernel bootfile kernel_addr_r kernel_addr
4817 device tree blob fdtfile fdt_addr_r fdt_addr
4818 ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
4820 The following environment variables may be used and automatically
4821 updated by the network boot commands ("bootp" and "rarpboot"),
4822 depending the information provided by your boot server:
4824 bootfile - see above
4825 dnsip - IP address of your Domain Name Server
4826 dnsip2 - IP address of your secondary Domain Name Server
4827 gatewayip - IP address of the Gateway (Router) to use
4828 hostname - Target hostname
4830 netmask - Subnet Mask
4831 rootpath - Pathname of the root filesystem on the NFS server
4832 serverip - see above
4835 There are two special Environment Variables:
4837 serial# - contains hardware identification information such
4838 as type string and/or serial number
4839 ethaddr - Ethernet address
4841 These variables can be set only once (usually during manufacturing of
4842 the board). U-Boot refuses to delete or overwrite these variables
4843 once they have been set once.
4846 Further special Environment Variables:
4848 ver - Contains the U-Boot version string as printed
4849 with the "version" command. This variable is
4850 readonly (see CONFIG_VERSION_VARIABLE).
4853 Please note that changes to some configuration parameters may take
4854 only effect after the next boot (yes, that's just like Windoze :-).
4857 Callback functions for environment variables:
4858 ---------------------------------------------
4860 For some environment variables, the behavior of u-boot needs to change
4861 when their values are changed. This functionailty allows functions to
4862 be associated with arbitrary variables. On creation, overwrite, or
4863 deletion, the callback will provide the opportunity for some side
4864 effect to happen or for the change to be rejected.
4866 The callbacks are named and associated with a function using the
4867 U_BOOT_ENV_CALLBACK macro in your board or driver code.
4869 These callbacks are associated with variables in one of two ways. The
4870 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4871 in the board configuration to a string that defines a list of
4872 associations. The list must be in the following format:
4874 entry = variable_name[:callback_name]
4877 If the callback name is not specified, then the callback is deleted.
4878 Spaces are also allowed anywhere in the list.
4880 Callbacks can also be associated by defining the ".callbacks" variable
4881 with the same list format above. Any association in ".callbacks" will
4882 override any association in the static list. You can define
4883 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4884 ".callbacks" envirnoment variable in the default or embedded environment.
4887 Command Line Parsing:
4888 =====================
4890 There are two different command line parsers available with U-Boot:
4891 the old "simple" one, and the much more powerful "hush" shell:
4893 Old, simple command line parser:
4894 --------------------------------
4896 - supports environment variables (through setenv / saveenv commands)
4897 - several commands on one line, separated by ';'
4898 - variable substitution using "... ${name} ..." syntax
4899 - special characters ('$', ';') can be escaped by prefixing with '\',
4901 setenv bootcmd bootm \${address}
4902 - You can also escape text by enclosing in single apostrophes, for example:
4903 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4908 - similar to Bourne shell, with control structures like
4909 if...then...else...fi, for...do...done; while...do...done,
4910 until...do...done, ...
4911 - supports environment ("global") variables (through setenv / saveenv
4912 commands) and local shell variables (through standard shell syntax
4913 "name=value"); only environment variables can be used with "run"
4919 (1) If a command line (or an environment variable executed by a "run"
4920 command) contains several commands separated by semicolon, and
4921 one of these commands fails, then the remaining commands will be
4924 (2) If you execute several variables with one call to run (i. e.
4925 calling run with a list of variables as arguments), any failing
4926 command will cause "run" to terminate, i. e. the remaining
4927 variables are not executed.
4929 Note for Redundant Ethernet Interfaces:
4930 =======================================
4932 Some boards come with redundant Ethernet interfaces; U-Boot supports
4933 such configurations and is capable of automatic selection of a
4934 "working" interface when needed. MAC assignment works as follows:
4936 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4937 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4938 "eth1addr" (=>eth1), "eth2addr", ...
4940 If the network interface stores some valid MAC address (for instance
4941 in SROM), this is used as default address if there is NO correspon-
4942 ding setting in the environment; if the corresponding environment
4943 variable is set, this overrides the settings in the card; that means:
4945 o If the SROM has a valid MAC address, and there is no address in the
4946 environment, the SROM's address is used.
4948 o If there is no valid address in the SROM, and a definition in the
4949 environment exists, then the value from the environment variable is
4952 o If both the SROM and the environment contain a MAC address, and
4953 both addresses are the same, this MAC address is used.
4955 o If both the SROM and the environment contain a MAC address, and the
4956 addresses differ, the value from the environment is used and a
4959 o If neither SROM nor the environment contain a MAC address, an error
4962 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4963 will be programmed into hardware as part of the initialization process. This
4964 may be skipped by setting the appropriate 'ethmacskip' environment variable.
4965 The naming convention is as follows:
4966 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4971 U-Boot is capable of booting (and performing other auxiliary operations on)
4972 images in two formats:
4974 New uImage format (FIT)
4975 -----------------------
4977 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4978 to Flattened Device Tree). It allows the use of images with multiple
4979 components (several kernels, ramdisks, etc.), with contents protected by
4980 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4986 Old image format is based on binary files which can be basically anything,
4987 preceded by a special header; see the definitions in include/image.h for
4988 details; basically, the header defines the following image properties:
4990 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4991 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4992 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4993 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4995 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4996 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4997 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4998 * Compression Type (uncompressed, gzip, bzip2)
5004 The header is marked by a special Magic Number, and both the header
5005 and the data portions of the image are secured against corruption by
5012 Although U-Boot should support any OS or standalone application
5013 easily, the main focus has always been on Linux during the design of
5016 U-Boot includes many features that so far have been part of some
5017 special "boot loader" code within the Linux kernel. Also, any
5018 "initrd" images to be used are no longer part of one big Linux image;
5019 instead, kernel and "initrd" are separate images. This implementation
5020 serves several purposes:
5022 - the same features can be used for other OS or standalone
5023 applications (for instance: using compressed images to reduce the
5024 Flash memory footprint)
5026 - it becomes much easier to port new Linux kernel versions because
5027 lots of low-level, hardware dependent stuff are done by U-Boot
5029 - the same Linux kernel image can now be used with different "initrd"
5030 images; of course this also means that different kernel images can
5031 be run with the same "initrd". This makes testing easier (you don't
5032 have to build a new "zImage.initrd" Linux image when you just
5033 change a file in your "initrd"). Also, a field-upgrade of the
5034 software is easier now.
5040 Porting Linux to U-Boot based systems:
5041 ---------------------------------------
5043 U-Boot cannot save you from doing all the necessary modifications to
5044 configure the Linux device drivers for use with your target hardware
5045 (no, we don't intend to provide a full virtual machine interface to
5048 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5050 Just make sure your machine specific header file (for instance
5051 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
5052 Information structure as we define in include/asm-<arch>/u-boot.h,
5053 and make sure that your definition of IMAP_ADDR uses the same value
5054 as your U-Boot configuration in CONFIG_SYS_IMMR.
5057 Configuring the Linux kernel:
5058 -----------------------------
5060 No specific requirements for U-Boot. Make sure you have some root
5061 device (initial ramdisk, NFS) for your target system.
5064 Building a Linux Image:
5065 -----------------------
5067 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5068 not used. If you use recent kernel source, a new build target
5069 "uImage" will exist which automatically builds an image usable by
5070 U-Boot. Most older kernels also have support for a "pImage" target,
5071 which was introduced for our predecessor project PPCBoot and uses a
5072 100% compatible format.
5081 The "uImage" build target uses a special tool (in 'tools/mkimage') to
5082 encapsulate a compressed Linux kernel image with header information,
5083 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
5085 * build a standard "vmlinux" kernel image (in ELF binary format):
5087 * convert the kernel into a raw binary image:
5089 ${CROSS_COMPILE}-objcopy -O binary \
5090 -R .note -R .comment \
5091 -S vmlinux linux.bin
5093 * compress the binary image:
5097 * package compressed binary image for U-Boot:
5099 mkimage -A ppc -O linux -T kernel -C gzip \
5100 -a 0 -e 0 -n "Linux Kernel Image" \
5101 -d linux.bin.gz uImage
5104 The "mkimage" tool can also be used to create ramdisk images for use
5105 with U-Boot, either separated from the Linux kernel image, or
5106 combined into one file. "mkimage" encapsulates the images with a 64
5107 byte header containing information about target architecture,
5108 operating system, image type, compression method, entry points, time
5109 stamp, CRC32 checksums, etc.
5111 "mkimage" can be called in two ways: to verify existing images and
5112 print the header information, or to build new images.
5114 In the first form (with "-l" option) mkimage lists the information
5115 contained in the header of an existing U-Boot image; this includes
5116 checksum verification:
5118 tools/mkimage -l image
5119 -l ==> list image header information
5121 The second form (with "-d" option) is used to build a U-Boot image
5122 from a "data file" which is used as image payload:
5124 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5125 -n name -d data_file image
5126 -A ==> set architecture to 'arch'
5127 -O ==> set operating system to 'os'
5128 -T ==> set image type to 'type'
5129 -C ==> set compression type 'comp'
5130 -a ==> set load address to 'addr' (hex)
5131 -e ==> set entry point to 'ep' (hex)
5132 -n ==> set image name to 'name'
5133 -d ==> use image data from 'datafile'
5135 Right now, all Linux kernels for PowerPC systems use the same load
5136 address (0x00000000), but the entry point address depends on the
5139 - 2.2.x kernels have the entry point at 0x0000000C,
5140 - 2.3.x and later kernels have the entry point at 0x00000000.
5142 So a typical call to build a U-Boot image would read:
5144 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5145 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5146 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
5147 > examples/uImage.TQM850L
5148 Image Name: 2.4.4 kernel for TQM850L
5149 Created: Wed Jul 19 02:34:59 2000
5150 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5151 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5152 Load Address: 0x00000000
5153 Entry Point: 0x00000000
5155 To verify the contents of the image (or check for corruption):
5157 -> tools/mkimage -l examples/uImage.TQM850L
5158 Image Name: 2.4.4 kernel for TQM850L
5159 Created: Wed Jul 19 02:34:59 2000
5160 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5161 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5162 Load Address: 0x00000000
5163 Entry Point: 0x00000000
5165 NOTE: for embedded systems where boot time is critical you can trade
5166 speed for memory and install an UNCOMPRESSED image instead: this
5167 needs more space in Flash, but boots much faster since it does not
5168 need to be uncompressed:
5170 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
5171 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5172 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5173 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
5174 > examples/uImage.TQM850L-uncompressed
5175 Image Name: 2.4.4 kernel for TQM850L
5176 Created: Wed Jul 19 02:34:59 2000
5177 Image Type: PowerPC Linux Kernel Image (uncompressed)
5178 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5179 Load Address: 0x00000000
5180 Entry Point: 0x00000000
5183 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5184 when your kernel is intended to use an initial ramdisk:
5186 -> tools/mkimage -n 'Simple Ramdisk Image' \
5187 > -A ppc -O linux -T ramdisk -C gzip \
5188 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5189 Image Name: Simple Ramdisk Image
5190 Created: Wed Jan 12 14:01:50 2000
5191 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5192 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5193 Load Address: 0x00000000
5194 Entry Point: 0x00000000
5197 Installing a Linux Image:
5198 -------------------------
5200 To downloading a U-Boot image over the serial (console) interface,
5201 you must convert the image to S-Record format:
5203 objcopy -I binary -O srec examples/image examples/image.srec
5205 The 'objcopy' does not understand the information in the U-Boot
5206 image header, so the resulting S-Record file will be relative to
5207 address 0x00000000. To load it to a given address, you need to
5208 specify the target address as 'offset' parameter with the 'loads'
5211 Example: install the image to address 0x40100000 (which on the
5212 TQM8xxL is in the first Flash bank):
5214 => erase 40100000 401FFFFF
5220 ## Ready for S-Record download ...
5221 ~>examples/image.srec
5222 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5224 15989 15990 15991 15992
5225 [file transfer complete]
5227 ## Start Addr = 0x00000000
5230 You can check the success of the download using the 'iminfo' command;
5231 this includes a checksum verification so you can be sure no data
5232 corruption happened:
5236 ## Checking Image at 40100000 ...
5237 Image Name: 2.2.13 for initrd on TQM850L
5238 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5239 Data Size: 335725 Bytes = 327 kB = 0 MB
5240 Load Address: 00000000
5241 Entry Point: 0000000c
5242 Verifying Checksum ... OK
5248 The "bootm" command is used to boot an application that is stored in
5249 memory (RAM or Flash). In case of a Linux kernel image, the contents
5250 of the "bootargs" environment variable is passed to the kernel as
5251 parameters. You can check and modify this variable using the
5252 "printenv" and "setenv" commands:
5255 => printenv bootargs
5256 bootargs=root=/dev/ram
5258 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5260 => printenv bootargs
5261 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5264 ## Booting Linux kernel at 40020000 ...
5265 Image Name: 2.2.13 for NFS on TQM850L
5266 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5267 Data Size: 381681 Bytes = 372 kB = 0 MB
5268 Load Address: 00000000
5269 Entry Point: 0000000c
5270 Verifying Checksum ... OK
5271 Uncompressing Kernel Image ... OK
5272 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
5273 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5274 time_init: decrementer frequency = 187500000/60
5275 Calibrating delay loop... 49.77 BogoMIPS
5276 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5279 If you want to boot a Linux kernel with initial RAM disk, you pass
5280 the memory addresses of both the kernel and the initrd image (PPBCOOT
5281 format!) to the "bootm" command:
5283 => imi 40100000 40200000
5285 ## Checking Image at 40100000 ...
5286 Image Name: 2.2.13 for initrd on TQM850L
5287 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5288 Data Size: 335725 Bytes = 327 kB = 0 MB
5289 Load Address: 00000000
5290 Entry Point: 0000000c
5291 Verifying Checksum ... OK
5293 ## Checking Image at 40200000 ...
5294 Image Name: Simple Ramdisk Image
5295 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5296 Data Size: 566530 Bytes = 553 kB = 0 MB
5297 Load Address: 00000000
5298 Entry Point: 00000000
5299 Verifying Checksum ... OK
5301 => bootm 40100000 40200000
5302 ## Booting Linux kernel at 40100000 ...
5303 Image Name: 2.2.13 for initrd on TQM850L
5304 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5305 Data Size: 335725 Bytes = 327 kB = 0 MB
5306 Load Address: 00000000
5307 Entry Point: 0000000c
5308 Verifying Checksum ... OK
5309 Uncompressing Kernel Image ... OK
5310 ## Loading RAMDisk Image at 40200000 ...
5311 Image Name: Simple Ramdisk Image
5312 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5313 Data Size: 566530 Bytes = 553 kB = 0 MB
5314 Load Address: 00000000
5315 Entry Point: 00000000
5316 Verifying Checksum ... OK
5317 Loading Ramdisk ... OK
5318 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
5319 Boot arguments: root=/dev/ram
5320 time_init: decrementer frequency = 187500000/60
5321 Calibrating delay loop... 49.77 BogoMIPS
5323 RAMDISK: Compressed image found at block 0
5324 VFS: Mounted root (ext2 filesystem).
5328 Boot Linux and pass a flat device tree:
5331 First, U-Boot must be compiled with the appropriate defines. See the section
5332 titled "Linux Kernel Interface" above for a more in depth explanation. The
5333 following is an example of how to start a kernel and pass an updated
5339 oft=oftrees/mpc8540ads.dtb
5340 => tftp $oftaddr $oft
5341 Speed: 1000, full duplex
5343 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5344 Filename 'oftrees/mpc8540ads.dtb'.
5345 Load address: 0x300000
5348 Bytes transferred = 4106 (100a hex)
5349 => tftp $loadaddr $bootfile
5350 Speed: 1000, full duplex
5352 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5354 Load address: 0x200000
5355 Loading:############
5357 Bytes transferred = 1029407 (fb51f hex)
5362 => bootm $loadaddr - $oftaddr
5363 ## Booting image at 00200000 ...
5364 Image Name: Linux-2.6.17-dirty
5365 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5366 Data Size: 1029343 Bytes = 1005.2 kB
5367 Load Address: 00000000
5368 Entry Point: 00000000
5369 Verifying Checksum ... OK
5370 Uncompressing Kernel Image ... OK
5371 Booting using flat device tree at 0x300000
5372 Using MPC85xx ADS machine description
5373 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5377 More About U-Boot Image Types:
5378 ------------------------------
5380 U-Boot supports the following image types:
5382 "Standalone Programs" are directly runnable in the environment
5383 provided by U-Boot; it is expected that (if they behave
5384 well) you can continue to work in U-Boot after return from
5385 the Standalone Program.
5386 "OS Kernel Images" are usually images of some Embedded OS which
5387 will take over control completely. Usually these programs
5388 will install their own set of exception handlers, device
5389 drivers, set up the MMU, etc. - this means, that you cannot
5390 expect to re-enter U-Boot except by resetting the CPU.
5391 "RAMDisk Images" are more or less just data blocks, and their
5392 parameters (address, size) are passed to an OS kernel that is
5394 "Multi-File Images" contain several images, typically an OS
5395 (Linux) kernel image and one or more data images like
5396 RAMDisks. This construct is useful for instance when you want
5397 to boot over the network using BOOTP etc., where the boot
5398 server provides just a single image file, but you want to get
5399 for instance an OS kernel and a RAMDisk image.
5401 "Multi-File Images" start with a list of image sizes, each
5402 image size (in bytes) specified by an "uint32_t" in network
5403 byte order. This list is terminated by an "(uint32_t)0".
5404 Immediately after the terminating 0 follow the images, one by
5405 one, all aligned on "uint32_t" boundaries (size rounded up to
5406 a multiple of 4 bytes).
5408 "Firmware Images" are binary images containing firmware (like
5409 U-Boot or FPGA images) which usually will be programmed to
5412 "Script files" are command sequences that will be executed by
5413 U-Boot's command interpreter; this feature is especially
5414 useful when you configure U-Boot to use a real shell (hush)
5415 as command interpreter.
5417 Booting the Linux zImage:
5418 -------------------------
5420 On some platforms, it's possible to boot Linux zImage. This is done
5421 using the "bootz" command. The syntax of "bootz" command is the same
5422 as the syntax of "bootm" command.
5424 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5425 kernel with raw initrd images. The syntax is slightly different, the
5426 address of the initrd must be augmented by it's size, in the following
5427 format: "<initrd addres>:<initrd size>".
5433 One of the features of U-Boot is that you can dynamically load and
5434 run "standalone" applications, which can use some resources of
5435 U-Boot like console I/O functions or interrupt services.
5437 Two simple examples are included with the sources:
5442 'examples/hello_world.c' contains a small "Hello World" Demo
5443 application; it is automatically compiled when you build U-Boot.
5444 It's configured to run at address 0x00040004, so you can play with it
5448 ## Ready for S-Record download ...
5449 ~>examples/hello_world.srec
5450 1 2 3 4 5 6 7 8 9 10 11 ...
5451 [file transfer complete]
5453 ## Start Addr = 0x00040004
5455 => go 40004 Hello World! This is a test.
5456 ## Starting application at 0x00040004 ...
5467 Hit any key to exit ...
5469 ## Application terminated, rc = 0x0
5471 Another example, which demonstrates how to register a CPM interrupt
5472 handler with the U-Boot code, can be found in 'examples/timer.c'.
5473 Here, a CPM timer is set up to generate an interrupt every second.
5474 The interrupt service routine is trivial, just printing a '.'
5475 character, but this is just a demo program. The application can be
5476 controlled by the following keys:
5478 ? - print current values og the CPM Timer registers
5479 b - enable interrupts and start timer
5480 e - stop timer and disable interrupts
5481 q - quit application
5484 ## Ready for S-Record download ...
5485 ~>examples/timer.srec
5486 1 2 3 4 5 6 7 8 9 10 11 ...
5487 [file transfer complete]
5489 ## Start Addr = 0x00040004
5492 ## Starting application at 0x00040004 ...
5495 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5498 [q, b, e, ?] Set interval 1000000 us
5501 [q, b, e, ?] ........
5502 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5505 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5508 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5511 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5513 [q, b, e, ?] ...Stopping timer
5515 [q, b, e, ?] ## Application terminated, rc = 0x0
5521 Over time, many people have reported problems when trying to use the
5522 "minicom" terminal emulation program for serial download. I (wd)
5523 consider minicom to be broken, and recommend not to use it. Under
5524 Unix, I recommend to use C-Kermit for general purpose use (and
5525 especially for kermit binary protocol download ("loadb" command), and
5526 use "cu" for S-Record download ("loads" command). See
5527 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5528 for help with kermit.
5531 Nevertheless, if you absolutely want to use it try adding this
5532 configuration to your "File transfer protocols" section:
5534 Name Program Name U/D FullScr IO-Red. Multi
5535 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5536 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
5542 Starting at version 0.9.2, U-Boot supports NetBSD both as host
5543 (build U-Boot) and target system (boots NetBSD/mpc8xx).
5545 Building requires a cross environment; it is known to work on
5546 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5547 need gmake since the Makefiles are not compatible with BSD make).
5548 Note that the cross-powerpc package does not install include files;
5549 attempting to build U-Boot will fail because <machine/ansi.h> is
5550 missing. This file has to be installed and patched manually:
5552 # cd /usr/pkg/cross/powerpc-netbsd/include
5554 # ln -s powerpc machine
5555 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5556 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
5558 Native builds *don't* work due to incompatibilities between native
5559 and U-Boot include files.
5561 Booting assumes that (the first part of) the image booted is a
5562 stage-2 loader which in turn loads and then invokes the kernel
5563 proper. Loader sources will eventually appear in the NetBSD source
5564 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
5565 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5568 Implementation Internals:
5569 =========================
5571 The following is not intended to be a complete description of every
5572 implementation detail. However, it should help to understand the
5573 inner workings of U-Boot and make it easier to port it to custom
5577 Initial Stack, Global Data:
5578 ---------------------------
5580 The implementation of U-Boot is complicated by the fact that U-Boot
5581 starts running out of ROM (flash memory), usually without access to
5582 system RAM (because the memory controller is not initialized yet).
5583 This means that we don't have writable Data or BSS segments, and BSS
5584 is not initialized as zero. To be able to get a C environment working
5585 at all, we have to allocate at least a minimal stack. Implementation
5586 options for this are defined and restricted by the CPU used: Some CPU
5587 models provide on-chip memory (like the IMMR area on MPC8xx and
5588 MPC826x processors), on others (parts of) the data cache can be
5589 locked as (mis-) used as memory, etc.
5591 Chris Hallinan posted a good summary of these issues to the
5592 U-Boot mailing list:
5594 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5595 From: "Chris Hallinan" <clh@net1plus.com>
5596 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5599 Correct me if I'm wrong, folks, but the way I understand it
5600 is this: Using DCACHE as initial RAM for Stack, etc, does not
5601 require any physical RAM backing up the cache. The cleverness
5602 is that the cache is being used as a temporary supply of
5603 necessary storage before the SDRAM controller is setup. It's
5604 beyond the scope of this list to explain the details, but you
5605 can see how this works by studying the cache architecture and
5606 operation in the architecture and processor-specific manuals.
5608 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5609 is another option for the system designer to use as an
5610 initial stack/RAM area prior to SDRAM being available. Either
5611 option should work for you. Using CS 4 should be fine if your
5612 board designers haven't used it for something that would
5613 cause you grief during the initial boot! It is frequently not
5616 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
5617 with your processor/board/system design. The default value
5618 you will find in any recent u-boot distribution in
5619 walnut.h should work for you. I'd set it to a value larger
5620 than your SDRAM module. If you have a 64MB SDRAM module, set
5621 it above 400_0000. Just make sure your board has no resources
5622 that are supposed to respond to that address! That code in
5623 start.S has been around a while and should work as is when
5624 you get the config right.
5629 It is essential to remember this, since it has some impact on the C
5630 code for the initialization procedures:
5632 * Initialized global data (data segment) is read-only. Do not attempt
5635 * Do not use any uninitialized global data (or implicitely initialized
5636 as zero data - BSS segment) at all - this is undefined, initiali-
5637 zation is performed later (when relocating to RAM).
5639 * Stack space is very limited. Avoid big data buffers or things like
5642 Having only the stack as writable memory limits means we cannot use
5643 normal global data to share information beween the code. But it
5644 turned out that the implementation of U-Boot can be greatly
5645 simplified by making a global data structure (gd_t) available to all
5646 functions. We could pass a pointer to this data as argument to _all_
5647 functions, but this would bloat the code. Instead we use a feature of
5648 the GCC compiler (Global Register Variables) to share the data: we
5649 place a pointer (gd) to the global data into a register which we
5650 reserve for this purpose.
5652 When choosing a register for such a purpose we are restricted by the
5653 relevant (E)ABI specifications for the current architecture, and by
5654 GCC's implementation.
5656 For PowerPC, the following registers have specific use:
5658 R2: reserved for system use
5659 R3-R4: parameter passing and return values
5660 R5-R10: parameter passing
5661 R13: small data area pointer
5665 (U-Boot also uses R12 as internal GOT pointer. r12
5666 is a volatile register so r12 needs to be reset when
5667 going back and forth between asm and C)
5669 ==> U-Boot will use R2 to hold a pointer to the global data
5671 Note: on PPC, we could use a static initializer (since the
5672 address of the global data structure is known at compile time),
5673 but it turned out that reserving a register results in somewhat
5674 smaller code - although the code savings are not that big (on
5675 average for all boards 752 bytes for the whole U-Boot image,
5676 624 text + 127 data).
5678 On Blackfin, the normal C ABI (except for P3) is followed as documented here:
5679 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5681 ==> U-Boot will use P3 to hold a pointer to the global data
5683 On ARM, the following registers are used:
5685 R0: function argument word/integer result
5686 R1-R3: function argument word
5687 R9: platform specific
5688 R10: stack limit (used only if stack checking is enabled)
5689 R11: argument (frame) pointer
5690 R12: temporary workspace
5693 R15: program counter
5695 ==> U-Boot will use R9 to hold a pointer to the global data
5697 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5699 On Nios II, the ABI is documented here:
5700 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5702 ==> U-Boot will use gp to hold a pointer to the global data
5704 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5705 to access small data sections, so gp is free.
5707 On NDS32, the following registers are used:
5709 R0-R1: argument/return
5711 R15: temporary register for assembler
5712 R16: trampoline register
5713 R28: frame pointer (FP)
5714 R29: global pointer (GP)
5715 R30: link register (LP)
5716 R31: stack pointer (SP)
5717 PC: program counter (PC)
5719 ==> U-Boot will use R10 to hold a pointer to the global data
5721 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5722 or current versions of GCC may "optimize" the code too much.
5727 U-Boot runs in system state and uses physical addresses, i.e. the
5728 MMU is not used either for address mapping nor for memory protection.
5730 The available memory is mapped to fixed addresses using the memory
5731 controller. In this process, a contiguous block is formed for each
5732 memory type (Flash, SDRAM, SRAM), even when it consists of several
5733 physical memory banks.
5735 U-Boot is installed in the first 128 kB of the first Flash bank (on
5736 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5737 booting and sizing and initializing DRAM, the code relocates itself
5738 to the upper end of DRAM. Immediately below the U-Boot code some
5739 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5740 configuration setting]. Below that, a structure with global Board
5741 Info data is placed, followed by the stack (growing downward).
5743 Additionally, some exception handler code is copied to the low 8 kB
5744 of DRAM (0x00000000 ... 0x00001FFF).
5746 So a typical memory configuration with 16 MB of DRAM could look like
5749 0x0000 0000 Exception Vector code
5752 0x0000 2000 Free for Application Use
5758 0x00FB FF20 Monitor Stack (Growing downward)
5759 0x00FB FFAC Board Info Data and permanent copy of global data
5760 0x00FC 0000 Malloc Arena
5763 0x00FE 0000 RAM Copy of Monitor Code
5764 ... eventually: LCD or video framebuffer
5765 ... eventually: pRAM (Protected RAM - unchanged by reset)
5766 0x00FF FFFF [End of RAM]
5769 System Initialization:
5770 ----------------------
5772 In the reset configuration, U-Boot starts at the reset entry point
5773 (on most PowerPC systems at address 0x00000100). Because of the reset
5774 configuration for CS0# this is a mirror of the onboard Flash memory.
5775 To be able to re-map memory U-Boot then jumps to its link address.
5776 To be able to implement the initialization code in C, a (small!)
5777 initial stack is set up in the internal Dual Ported RAM (in case CPUs
5778 which provide such a feature like MPC8xx or MPC8260), or in a locked
5779 part of the data cache. After that, U-Boot initializes the CPU core,
5780 the caches and the SIU.
5782 Next, all (potentially) available memory banks are mapped using a
5783 preliminary mapping. For example, we put them on 512 MB boundaries
5784 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5785 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5786 programmed for SDRAM access. Using the temporary configuration, a
5787 simple memory test is run that determines the size of the SDRAM
5790 When there is more than one SDRAM bank, and the banks are of
5791 different size, the largest is mapped first. For equal size, the first
5792 bank (CS2#) is mapped first. The first mapping is always for address
5793 0x00000000, with any additional banks following immediately to create
5794 contiguous memory starting from 0.
5796 Then, the monitor installs itself at the upper end of the SDRAM area
5797 and allocates memory for use by malloc() and for the global Board
5798 Info data; also, the exception vector code is copied to the low RAM
5799 pages, and the final stack is set up.
5801 Only after this relocation will you have a "normal" C environment;
5802 until that you are restricted in several ways, mostly because you are
5803 running from ROM, and because the code will have to be relocated to a
5807 U-Boot Porting Guide:
5808 ----------------------
5810 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5814 int main(int argc, char *argv[])
5816 sighandler_t no_more_time;
5818 signal(SIGALRM, no_more_time);
5819 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5821 if (available_money > available_manpower) {
5822 Pay consultant to port U-Boot;
5826 Download latest U-Boot source;
5828 Subscribe to u-boot mailing list;
5831 email("Hi, I am new to U-Boot, how do I get started?");
5834 Read the README file in the top level directory;
5835 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5836 Read applicable doc/*.README;
5837 Read the source, Luke;
5838 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
5841 if (available_money > toLocalCurrency ($2500))
5844 Add a lot of aggravation and time;
5846 if (a similar board exists) { /* hopefully... */
5847 cp -a board/<similar> board/<myboard>
5848 cp include/configs/<similar>.h include/configs/<myboard>.h
5850 Create your own board support subdirectory;
5851 Create your own board include/configs/<myboard>.h file;
5853 Edit new board/<myboard> files
5854 Edit new include/configs/<myboard>.h
5859 Add / modify source code;
5863 email("Hi, I am having problems...");
5865 Send patch file to the U-Boot email list;
5866 if (reasonable critiques)
5867 Incorporate improvements from email list code review;
5869 Defend code as written;
5875 void no_more_time (int sig)
5884 All contributions to U-Boot should conform to the Linux kernel
5885 coding style; see the file "Documentation/CodingStyle" and the script
5886 "scripts/Lindent" in your Linux kernel source directory.
5888 Source files originating from a different project (for example the
5889 MTD subsystem) are generally exempt from these guidelines and are not
5890 reformated to ease subsequent migration to newer versions of those
5893 Please note that U-Boot is implemented in C (and to some small parts in
5894 Assembler); no C++ is used, so please do not use C++ style comments (//)
5897 Please also stick to the following formatting rules:
5898 - remove any trailing white space
5899 - use TAB characters for indentation and vertical alignment, not spaces
5900 - make sure NOT to use DOS '\r\n' line feeds
5901 - do not add more than 2 consecutive empty lines to source files
5902 - do not add trailing empty lines to source files
5904 Submissions which do not conform to the standards may be returned
5905 with a request to reformat the changes.
5911 Since the number of patches for U-Boot is growing, we need to
5912 establish some rules. Submissions which do not conform to these rules
5913 may be rejected, even when they contain important and valuable stuff.
5915 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
5917 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5918 see http://lists.denx.de/mailman/listinfo/u-boot
5920 When you send a patch, please include the following information with
5923 * For bug fixes: a description of the bug and how your patch fixes
5924 this bug. Please try to include a way of demonstrating that the
5925 patch actually fixes something.
5927 * For new features: a description of the feature and your
5930 * A CHANGELOG entry as plaintext (separate from the patch)
5932 * For major contributions, your entry to the CREDITS file
5934 * When you add support for a new board, don't forget to add a
5935 maintainer e-mail address to the boards.cfg file, too.
5937 * If your patch adds new configuration options, don't forget to
5938 document these in the README file.
5940 * The patch itself. If you are using git (which is *strongly*
5941 recommended) you can easily generate the patch using the
5942 "git format-patch". If you then use "git send-email" to send it to
5943 the U-Boot mailing list, you will avoid most of the common problems
5944 with some other mail clients.
5946 If you cannot use git, use "diff -purN OLD NEW". If your version of
5947 diff does not support these options, then get the latest version of
5950 The current directory when running this command shall be the parent
5951 directory of the U-Boot source tree (i. e. please make sure that
5952 your patch includes sufficient directory information for the
5955 We prefer patches as plain text. MIME attachments are discouraged,
5956 and compressed attachments must not be used.
5958 * If one logical set of modifications affects or creates several
5959 files, all these changes shall be submitted in a SINGLE patch file.
5961 * Changesets that contain different, unrelated modifications shall be
5962 submitted as SEPARATE patches, one patch per changeset.
5967 * Before sending the patch, run the MAKEALL script on your patched
5968 source tree and make sure that no errors or warnings are reported
5969 for any of the boards.
5971 * Keep your modifications to the necessary minimum: A patch
5972 containing several unrelated changes or arbitrary reformats will be
5973 returned with a request to re-formatting / split it.
5975 * If you modify existing code, make sure that your new code does not
5976 add to the memory footprint of the code ;-) Small is beautiful!
5977 When adding new features, these should compile conditionally only
5978 (using #ifdef), and the resulting code with the new feature
5979 disabled must not need more memory than the old code without your
5982 * Remember that there is a size limit of 100 kB per message on the
5983 u-boot mailing list. Bigger patches will be moderated. If they are
5984 reasonable and not too big, they will be acknowledged. But patches
5985 bigger than the size limit should be avoided.
projects / people / ms / u-boot.git / blob