]> git.ipfire.org Git - people/ms/u-boot.git/blob - README
fsl-layerscape: Consolidate registers space defination for CCI-400 bus
[people/ms/u-boot.git] / README
1 #
2 # (C) Copyright 2000 - 2013
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 #
5 # SPDX-License-Identifier: GPL-2.0+
6 #
7
8 Summary:
9 ========
10
11 This directory contains the source code for U-Boot, a boot loader for
12 Embedded boards based on PowerPC, ARM, MIPS and several other
13 processors, which can be installed in a boot ROM and used to
14 initialize and test the hardware or to download and run application
15 code.
16
17 The development of U-Boot is closely related to Linux: some parts of
18 the source code originate in the Linux source tree, we have some
19 header files in common, and special provision has been made to
20 support booting of Linux images.
21
22 Some attention has been paid to make this software easily
23 configurable and extendable. For instance, all monitor commands are
24 implemented with the same call interface, so that it's very easy to
25 add new commands. Also, instead of permanently adding rarely used
26 code (for instance hardware test utilities) to the monitor, you can
27 load and run it dynamically.
28
29
30 Status:
31 =======
32
33 In general, all boards for which a configuration option exists in the
34 Makefile have been tested to some extent and can be considered
35 "working". In fact, many of them are used in production systems.
36
37 In case of problems see the CHANGELOG file to find out who contributed
38 the specific port. In addition, there are various MAINTAINERS files
39 scattered throughout the U-Boot source identifying the people or
40 companies responsible for various boards and subsystems.
41
42 Note: As of August, 2010, there is no longer a CHANGELOG file in the
43 actual U-Boot source tree; however, it can be created dynamically
44 from the Git log using:
45
46 make CHANGELOG
47
48
49 Where to get help:
50 ==================
51
52 In case you have questions about, problems with or contributions for
53 U-Boot, you should send a message to the U-Boot mailing list at
54 <u-boot@lists.denx.de>. There is also an archive of previous traffic
55 on the mailing list - please search the archive before asking FAQ's.
56 Please see http://lists.denx.de/pipermail/u-boot and
57 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58
59
60 Where to get source code:
61 =========================
62
63 The U-Boot source code is maintained in the Git repository at
64 git://www.denx.de/git/u-boot.git ; you can browse it online at
65 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67 The "snapshot" links on this page allow you to download tarballs of
68 any version you might be interested in. Official releases are also
69 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70 directory.
71
72 Pre-built (and tested) images are available from
73 ftp://ftp.denx.de/pub/u-boot/images/
74
75
76 Where we come from:
77 ===================
78
79 - start from 8xxrom sources
80 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
81 - clean up code
82 - make it easier to add custom boards
83 - make it possible to add other [PowerPC] CPUs
84 - extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
88 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
89 - create ARMBoot project (http://sourceforge.net/projects/armboot)
90 - add other CPU families (starting with ARM)
91 - create U-Boot project (http://sourceforge.net/projects/u-boot)
92 - current project page: see http://www.denx.de/wiki/U-Boot
93
94
95 Names and Spelling:
96 ===================
97
98 The "official" name of this project is "Das U-Boot". The spelling
99 "U-Boot" shall be used in all written text (documentation, comments
100 in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104 File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110 Variable names, preprocessor constants etc. shall be either based on
111 the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
116
117 Versioning:
118 ===========
119
120 Starting with the release in October 2008, the names of the releases
121 were changed from numerical release numbers without deeper meaning
122 into a time stamp based numbering. Regular releases are identified by
123 names consisting of the calendar year and month of the release date.
124 Additional fields (if present) indicate release candidates or bug fix
125 releases in "stable" maintenance trees.
126
127 Examples:
128 U-Boot v2009.11 - Release November 2009
129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
131
132
133 Directory Hierarchy:
134 ====================
135
136 /arch Architecture specific files
137 /arc Files generic to ARC architecture
138 /arm Files generic to ARM architecture
139 /m68k Files generic to m68k architecture
140 /microblaze Files generic to microblaze architecture
141 /mips Files generic to MIPS architecture
142 /nds32 Files generic to NDS32 architecture
143 /nios2 Files generic to Altera NIOS2 architecture
144 /openrisc Files generic to OpenRISC architecture
145 /powerpc Files generic to PowerPC architecture
146 /sandbox Files generic to HW-independent "sandbox"
147 /sh Files generic to SH architecture
148 /x86 Files generic to x86 architecture
149 /api Machine/arch independent API for external apps
150 /board Board dependent files
151 /cmd U-Boot commands functions
152 /common Misc architecture independent functions
153 /configs Board default configuration files
154 /disk Code for disk drive partition handling
155 /doc Documentation (don't expect too much)
156 /drivers Commonly used device drivers
157 /dts Contains Makefile for building internal U-Boot fdt.
158 /examples Example code for standalone applications, etc.
159 /fs Filesystem code (cramfs, ext2, jffs2, etc.)
160 /include Header Files
161 /lib Library routines generic to all architectures
162 /Licenses Various license files
163 /net Networking code
164 /post Power On Self Test
165 /scripts Various build scripts and Makefiles
166 /test Various unit test files
167 /tools Tools to build S-Record or U-Boot images, etc.
168
169 Software Configuration:
170 =======================
171
172 Configuration is usually done using C preprocessor defines; the
173 rationale behind that is to avoid dead code whenever possible.
174
175 There are two classes of configuration variables:
176
177 * Configuration _OPTIONS_:
178 These are selectable by the user and have names beginning with
179 "CONFIG_".
180
181 * Configuration _SETTINGS_:
182 These depend on the hardware etc. and should not be meddled with if
183 you don't know what you're doing; they have names beginning with
184 "CONFIG_SYS_".
185
186 Previously, all configuration was done by hand, which involved creating
187 symbolic links and editing configuration files manually. More recently,
188 U-Boot has added the Kbuild infrastructure used by the Linux kernel,
189 allowing you to use the "make menuconfig" command to configure your
190 build.
191
192
193 Selection of Processor Architecture and Board Type:
194 ---------------------------------------------------
195
196 For all supported boards there are ready-to-use default
197 configurations available; just type "make <board_name>_defconfig".
198
199 Example: For a TQM823L module type:
200
201 cd u-boot
202 make TQM823L_defconfig
203
204 Note: If you're looking for the default configuration file for a board
205 you're sure used to be there but is now missing, check the file
206 doc/README.scrapyard for a list of no longer supported boards.
207
208 Sandbox Environment:
209 --------------------
210
211 U-Boot can be built natively to run on a Linux host using the 'sandbox'
212 board. This allows feature development which is not board- or architecture-
213 specific to be undertaken on a native platform. The sandbox is also used to
214 run some of U-Boot's tests.
215
216 See board/sandbox/README.sandbox for more details.
217
218
219 Board Initialisation Flow:
220 --------------------------
221
222 This is the intended start-up flow for boards. This should apply for both
223 SPL and U-Boot proper (i.e. they both follow the same rules).
224
225 Note: "SPL" stands for "Secondary Program Loader," which is explained in
226 more detail later in this file.
227
228 At present, SPL mostly uses a separate code path, but the function names
229 and roles of each function are the same. Some boards or architectures
230 may not conform to this. At least most ARM boards which use
231 CONFIG_SPL_FRAMEWORK conform to this.
232
233 Execution typically starts with an architecture-specific (and possibly
234 CPU-specific) start.S file, such as:
235
236 - arch/arm/cpu/armv7/start.S
237 - arch/powerpc/cpu/mpc83xx/start.S
238 - arch/mips/cpu/start.S
239
240 and so on. From there, three functions are called; the purpose and
241 limitations of each of these functions are described below.
242
243 lowlevel_init():
244 - purpose: essential init to permit execution to reach board_init_f()
245 - no global_data or BSS
246 - there is no stack (ARMv7 may have one but it will soon be removed)
247 - must not set up SDRAM or use console
248 - must only do the bare minimum to allow execution to continue to
249 board_init_f()
250 - this is almost never needed
251 - return normally from this function
252
253 board_init_f():
254 - purpose: set up the machine ready for running board_init_r():
255 i.e. SDRAM and serial UART
256 - global_data is available
257 - stack is in SRAM
258 - BSS is not available, so you cannot use global/static variables,
259 only stack variables and global_data
260
261 Non-SPL-specific notes:
262 - dram_init() is called to set up DRAM. If already done in SPL this
263 can do nothing
264
265 SPL-specific notes:
266 - you can override the entire board_init_f() function with your own
267 version as needed.
268 - preloader_console_init() can be called here in extremis
269 - should set up SDRAM, and anything needed to make the UART work
270 - these is no need to clear BSS, it will be done by crt0.S
271 - must return normally from this function (don't call board_init_r()
272 directly)
273
274 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
275 this point the stack and global_data are relocated to below
276 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
277 memory.
278
279 board_init_r():
280 - purpose: main execution, common code
281 - global_data is available
282 - SDRAM is available
283 - BSS is available, all static/global variables can be used
284 - execution eventually continues to main_loop()
285
286 Non-SPL-specific notes:
287 - U-Boot is relocated to the top of memory and is now running from
288 there.
289
290 SPL-specific notes:
291 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
292 CONFIG_SPL_STACK_R_ADDR points into SDRAM
293 - preloader_console_init() can be called here - typically this is
294 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
295 spl_board_init() function containing this call
296 - loads U-Boot or (in falcon mode) Linux
297
298
299
300 Configuration Options:
301 ----------------------
302
303 Configuration depends on the combination of board and CPU type; all
304 such information is kept in a configuration file
305 "include/configs/<board_name>.h".
306
307 Example: For a TQM823L module, all configuration settings are in
308 "include/configs/TQM823L.h".
309
310
311 Many of the options are named exactly as the corresponding Linux
312 kernel configuration options. The intention is to make it easier to
313 build a config tool - later.
314
315 - ARM Platform Bus Type(CCI):
316 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
317 provides full cache coherency between two clusters of multi-core
318 CPUs and I/O coherency for devices and I/O masters
319
320 CONFIG_SYS_FSL_HAS_CCI400
321
322 Defined For SoC that has cache coherent interconnect
323 CCN-400
324
325 The following options need to be configured:
326
327 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
328
329 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
330
331 - Marvell Family Member
332 CONFIG_SYS_MVFS - define it if you want to enable
333 multiple fs option at one time
334 for marvell soc family
335
336 - 85xx CPU Options:
337 CONFIG_SYS_PPC64
338
339 Specifies that the core is a 64-bit PowerPC implementation (implements
340 the "64" category of the Power ISA). This is necessary for ePAPR
341 compliance, among other possible reasons.
342
343 CONFIG_SYS_FSL_TBCLK_DIV
344
345 Defines the core time base clock divider ratio compared to the
346 system clock. On most PQ3 devices this is 8, on newer QorIQ
347 devices it can be 16 or 32. The ratio varies from SoC to Soc.
348
349 CONFIG_SYS_FSL_PCIE_COMPAT
350
351 Defines the string to utilize when trying to match PCIe device
352 tree nodes for the given platform.
353
354 CONFIG_SYS_FSL_ERRATUM_A004510
355
356 Enables a workaround for erratum A004510. If set,
357 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
358 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
359
360 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
361 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
362
363 Defines one or two SoC revisions (low 8 bits of SVR)
364 for which the A004510 workaround should be applied.
365
366 The rest of SVR is either not relevant to the decision
367 of whether the erratum is present (e.g. p2040 versus
368 p2041) or is implied by the build target, which controls
369 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
370
371 See Freescale App Note 4493 for more information about
372 this erratum.
373
374 CONFIG_A003399_NOR_WORKAROUND
375 Enables a workaround for IFC erratum A003399. It is only
376 required during NOR boot.
377
378 CONFIG_A008044_WORKAROUND
379 Enables a workaround for T1040/T1042 erratum A008044. It is only
380 required during NAND boot and valid for Rev 1.0 SoC revision
381
382 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
383
384 This is the value to write into CCSR offset 0x18600
385 according to the A004510 workaround.
386
387 CONFIG_SYS_FSL_DSP_DDR_ADDR
388 This value denotes start offset of DDR memory which is
389 connected exclusively to the DSP cores.
390
391 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
392 This value denotes start offset of M2 memory
393 which is directly connected to the DSP core.
394
395 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
396 This value denotes start offset of M3 memory which is directly
397 connected to the DSP core.
398
399 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
400 This value denotes start offset of DSP CCSR space.
401
402 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
403 Single Source Clock is clocking mode present in some of FSL SoC's.
404 In this mode, a single differential clock is used to supply
405 clocks to the sysclock, ddrclock and usbclock.
406
407 CONFIG_SYS_CPC_REINIT_F
408 This CONFIG is defined when the CPC is configured as SRAM at the
409 time of U-Boot entry and is required to be re-initialized.
410
411 CONFIG_DEEP_SLEEP
412 Indicates this SoC supports deep sleep feature. If deep sleep is
413 supported, core will start to execute uboot when wakes up.
414
415 - Generic CPU options:
416 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
417
418 Defines the endianess of the CPU. Implementation of those
419 values is arch specific.
420
421 CONFIG_SYS_FSL_DDR
422 Freescale DDR driver in use. This type of DDR controller is
423 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
424 SoCs.
425
426 CONFIG_SYS_FSL_DDR_ADDR
427 Freescale DDR memory-mapped register base.
428
429 CONFIG_SYS_FSL_DDR_EMU
430 Specify emulator support for DDR. Some DDR features such as
431 deskew training are not available.
432
433 CONFIG_SYS_FSL_DDRC_GEN1
434 Freescale DDR1 controller.
435
436 CONFIG_SYS_FSL_DDRC_GEN2
437 Freescale DDR2 controller.
438
439 CONFIG_SYS_FSL_DDRC_GEN3
440 Freescale DDR3 controller.
441
442 CONFIG_SYS_FSL_DDRC_GEN4
443 Freescale DDR4 controller.
444
445 CONFIG_SYS_FSL_DDRC_ARM_GEN3
446 Freescale DDR3 controller for ARM-based SoCs.
447
448 CONFIG_SYS_FSL_DDR1
449 Board config to use DDR1. It can be enabled for SoCs with
450 Freescale DDR1 or DDR2 controllers, depending on the board
451 implemetation.
452
453 CONFIG_SYS_FSL_DDR2
454 Board config to use DDR2. It can be enabled for SoCs with
455 Freescale DDR2 or DDR3 controllers, depending on the board
456 implementation.
457
458 CONFIG_SYS_FSL_DDR3
459 Board config to use DDR3. It can be enabled for SoCs with
460 Freescale DDR3 or DDR3L controllers.
461
462 CONFIG_SYS_FSL_DDR3L
463 Board config to use DDR3L. It can be enabled for SoCs with
464 DDR3L controllers.
465
466 CONFIG_SYS_FSL_DDR4
467 Board config to use DDR4. It can be enabled for SoCs with
468 DDR4 controllers.
469
470 CONFIG_SYS_FSL_IFC_BE
471 Defines the IFC controller register space as Big Endian
472
473 CONFIG_SYS_FSL_IFC_LE
474 Defines the IFC controller register space as Little Endian
475
476 CONFIG_SYS_FSL_IFC_CLK_DIV
477 Defines divider of platform clock(clock input to IFC controller).
478
479 CONFIG_SYS_FSL_LBC_CLK_DIV
480 Defines divider of platform clock(clock input to eLBC controller).
481
482 CONFIG_SYS_FSL_PBL_PBI
483 It enables addition of RCW (Power on reset configuration) in built image.
484 Please refer doc/README.pblimage for more details
485
486 CONFIG_SYS_FSL_PBL_RCW
487 It adds PBI(pre-boot instructions) commands in u-boot build image.
488 PBI commands can be used to configure SoC before it starts the execution.
489 Please refer doc/README.pblimage for more details
490
491 CONFIG_SPL_FSL_PBL
492 It adds a target to create boot binary having SPL binary in PBI format
493 concatenated with u-boot binary.
494
495 CONFIG_SYS_FSL_DDR_BE
496 Defines the DDR controller register space as Big Endian
497
498 CONFIG_SYS_FSL_DDR_LE
499 Defines the DDR controller register space as Little Endian
500
501 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
502 Physical address from the view of DDR controllers. It is the
503 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
504 it could be different for ARM SoCs.
505
506 CONFIG_SYS_FSL_DDR_INTLV_256B
507 DDR controller interleaving on 256-byte. This is a special
508 interleaving mode, handled by Dickens for Freescale layerscape
509 SoCs with ARM core.
510
511 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
512 Number of controllers used as main memory.
513
514 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
515 Number of controllers used for other than main memory.
516
517 CONFIG_SYS_FSL_HAS_DP_DDR
518 Defines the SoC has DP-DDR used for DPAA.
519
520 CONFIG_SYS_FSL_SEC_BE
521 Defines the SEC controller register space as Big Endian
522
523 CONFIG_SYS_FSL_SEC_LE
524 Defines the SEC controller register space as Little Endian
525
526 - MIPS CPU options:
527 CONFIG_SYS_INIT_SP_OFFSET
528
529 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
530 pointer. This is needed for the temporary stack before
531 relocation.
532
533 CONFIG_SYS_MIPS_CACHE_MODE
534
535 Cache operation mode for the MIPS CPU.
536 See also arch/mips/include/asm/mipsregs.h.
537 Possible values are:
538 CONF_CM_CACHABLE_NO_WA
539 CONF_CM_CACHABLE_WA
540 CONF_CM_UNCACHED
541 CONF_CM_CACHABLE_NONCOHERENT
542 CONF_CM_CACHABLE_CE
543 CONF_CM_CACHABLE_COW
544 CONF_CM_CACHABLE_CUW
545 CONF_CM_CACHABLE_ACCELERATED
546
547 CONFIG_SYS_XWAY_EBU_BOOTCFG
548
549 Special option for Lantiq XWAY SoCs for booting from NOR flash.
550 See also arch/mips/cpu/mips32/start.S.
551
552 CONFIG_XWAY_SWAP_BYTES
553
554 Enable compilation of tools/xway-swap-bytes needed for Lantiq
555 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
556 be swapped if a flash programmer is used.
557
558 - ARM options:
559 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
560
561 Select high exception vectors of the ARM core, e.g., do not
562 clear the V bit of the c1 register of CP15.
563
564 COUNTER_FREQUENCY
565 Generic timer clock source frequency.
566
567 COUNTER_FREQUENCY_REAL
568 Generic timer clock source frequency if the real clock is
569 different from COUNTER_FREQUENCY, and can only be determined
570 at run time.
571
572 - Tegra SoC options:
573 CONFIG_TEGRA_SUPPORT_NON_SECURE
574
575 Support executing U-Boot in non-secure (NS) mode. Certain
576 impossible actions will be skipped if the CPU is in NS mode,
577 such as ARM architectural timer initialization.
578
579 - Linux Kernel Interface:
580 CONFIG_CLOCKS_IN_MHZ
581
582 U-Boot stores all clock information in Hz
583 internally. For binary compatibility with older Linux
584 kernels (which expect the clocks passed in the
585 bd_info data to be in MHz) the environment variable
586 "clocks_in_mhz" can be defined so that U-Boot
587 converts clock data to MHZ before passing it to the
588 Linux kernel.
589 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
590 "clocks_in_mhz=1" is automatically included in the
591 default environment.
592
593 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
594
595 When transferring memsize parameter to Linux, some versions
596 expect it to be in bytes, others in MB.
597 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
598
599 CONFIG_OF_LIBFDT
600
601 New kernel versions are expecting firmware settings to be
602 passed using flattened device trees (based on open firmware
603 concepts).
604
605 CONFIG_OF_LIBFDT
606 * New libfdt-based support
607 * Adds the "fdt" command
608 * The bootm command automatically updates the fdt
609
610 OF_TBCLK - The timebase frequency.
611 OF_STDOUT_PATH - The path to the console device
612
613 boards with QUICC Engines require OF_QE to set UCC MAC
614 addresses
615
616 CONFIG_OF_BOARD_SETUP
617
618 Board code has addition modification that it wants to make
619 to the flat device tree before handing it off to the kernel
620
621 CONFIG_OF_SYSTEM_SETUP
622
623 Other code has addition modification that it wants to make
624 to the flat device tree before handing it off to the kernel.
625 This causes ft_system_setup() to be called before booting
626 the kernel.
627
628 CONFIG_OF_IDE_FIXUP
629
630 U-Boot can detect if an IDE device is present or not.
631 If not, and this new config option is activated, U-Boot
632 removes the ATA node from the DTS before booting Linux,
633 so the Linux IDE driver does not probe the device and
634 crash. This is needed for buggy hardware (uc101) where
635 no pull down resistor is connected to the signal IDE5V_DD7.
636
637 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
638
639 This setting is mandatory for all boards that have only one
640 machine type and must be used to specify the machine type
641 number as it appears in the ARM machine registry
642 (see http://www.arm.linux.org.uk/developer/machines/).
643 Only boards that have multiple machine types supported
644 in a single configuration file and the machine type is
645 runtime discoverable, do not have to use this setting.
646
647 - vxWorks boot parameters:
648
649 bootvx constructs a valid bootline using the following
650 environments variables: bootdev, bootfile, ipaddr, netmask,
651 serverip, gatewayip, hostname, othbootargs.
652 It loads the vxWorks image pointed bootfile.
653
654 Note: If a "bootargs" environment is defined, it will overwride
655 the defaults discussed just above.
656
657 - Cache Configuration:
658 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
659 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
660 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
661
662 - Cache Configuration for ARM:
663 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
664 controller
665 CONFIG_SYS_PL310_BASE - Physical base address of PL310
666 controller register space
667
668 - Serial Ports:
669 CONFIG_PL010_SERIAL
670
671 Define this if you want support for Amba PrimeCell PL010 UARTs.
672
673 CONFIG_PL011_SERIAL
674
675 Define this if you want support for Amba PrimeCell PL011 UARTs.
676
677 CONFIG_PL011_CLOCK
678
679 If you have Amba PrimeCell PL011 UARTs, set this variable to
680 the clock speed of the UARTs.
681
682 CONFIG_PL01x_PORTS
683
684 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
685 define this to a list of base addresses for each (supported)
686 port. See e.g. include/configs/versatile.h
687
688 CONFIG_SERIAL_HW_FLOW_CONTROL
689
690 Define this variable to enable hw flow control in serial driver.
691 Current user of this option is drivers/serial/nsl16550.c driver
692
693 - Console Baudrate:
694 CONFIG_BAUDRATE - in bps
695 Select one of the baudrates listed in
696 CONFIG_SYS_BAUDRATE_TABLE, see below.
697
698 - Autoboot Command:
699 CONFIG_BOOTCOMMAND
700 Only needed when CONFIG_BOOTDELAY is enabled;
701 define a command string that is automatically executed
702 when no character is read on the console interface
703 within "Boot Delay" after reset.
704
705 CONFIG_RAMBOOT and CONFIG_NFSBOOT
706 The value of these goes into the environment as
707 "ramboot" and "nfsboot" respectively, and can be used
708 as a convenience, when switching between booting from
709 RAM and NFS.
710
711 - Bootcount:
712 CONFIG_BOOTCOUNT_LIMIT
713 Implements a mechanism for detecting a repeating reboot
714 cycle, see:
715 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
716
717 CONFIG_BOOTCOUNT_ENV
718 If no softreset save registers are found on the hardware
719 "bootcount" is stored in the environment. To prevent a
720 saveenv on all reboots, the environment variable
721 "upgrade_available" is used. If "upgrade_available" is
722 0, "bootcount" is always 0, if "upgrade_available" is
723 1 "bootcount" is incremented in the environment.
724 So the Userspace Applikation must set the "upgrade_available"
725 and "bootcount" variable to 0, if a boot was successfully.
726
727 - Pre-Boot Commands:
728 CONFIG_PREBOOT
729
730 When this option is #defined, the existence of the
731 environment variable "preboot" will be checked
732 immediately before starting the CONFIG_BOOTDELAY
733 countdown and/or running the auto-boot command resp.
734 entering interactive mode.
735
736 This feature is especially useful when "preboot" is
737 automatically generated or modified. For an example
738 see the LWMON board specific code: here "preboot" is
739 modified when the user holds down a certain
740 combination of keys on the (special) keyboard when
741 booting the systems
742
743 - Serial Download Echo Mode:
744 CONFIG_LOADS_ECHO
745 If defined to 1, all characters received during a
746 serial download (using the "loads" command) are
747 echoed back. This might be needed by some terminal
748 emulations (like "cu"), but may as well just take
749 time on others. This setting #define's the initial
750 value of the "loads_echo" environment variable.
751
752 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
753 CONFIG_KGDB_BAUDRATE
754 Select one of the baudrates listed in
755 CONFIG_SYS_BAUDRATE_TABLE, see below.
756
757 - Removal of commands
758 If no commands are needed to boot, you can disable
759 CONFIG_CMDLINE to remove them. In this case, the command line
760 will not be available, and when U-Boot wants to execute the
761 boot command (on start-up) it will call board_run_command()
762 instead. This can reduce image size significantly for very
763 simple boot procedures.
764
765 - Regular expression support:
766 CONFIG_REGEX
767 If this variable is defined, U-Boot is linked against
768 the SLRE (Super Light Regular Expression) library,
769 which adds regex support to some commands, as for
770 example "env grep" and "setexpr".
771
772 - Device tree:
773 CONFIG_OF_CONTROL
774 If this variable is defined, U-Boot will use a device tree
775 to configure its devices, instead of relying on statically
776 compiled #defines in the board file. This option is
777 experimental and only available on a few boards. The device
778 tree is available in the global data as gd->fdt_blob.
779
780 U-Boot needs to get its device tree from somewhere. This can
781 be done using one of the three options below:
782
783 CONFIG_OF_EMBED
784 If this variable is defined, U-Boot will embed a device tree
785 binary in its image. This device tree file should be in the
786 board directory and called <soc>-<board>.dts. The binary file
787 is then picked up in board_init_f() and made available through
788 the global data structure as gd->fdt_blob.
789
790 CONFIG_OF_SEPARATE
791 If this variable is defined, U-Boot will build a device tree
792 binary. It will be called u-boot.dtb. Architecture-specific
793 code will locate it at run-time. Generally this works by:
794
795 cat u-boot.bin u-boot.dtb >image.bin
796
797 and in fact, U-Boot does this for you, creating a file called
798 u-boot-dtb.bin which is useful in the common case. You can
799 still use the individual files if you need something more
800 exotic.
801
802 CONFIG_OF_BOARD
803 If this variable is defined, U-Boot will use the device tree
804 provided by the board at runtime instead of embedding one with
805 the image. Only boards defining board_fdt_blob_setup() support
806 this option (see include/fdtdec.h file).
807
808 - Watchdog:
809 CONFIG_WATCHDOG
810 If this variable is defined, it enables watchdog
811 support for the SoC. There must be support in the SoC
812 specific code for a watchdog. For the 8xx
813 CPUs, the SIU Watchdog feature is enabled in the SYPCR
814 register. When supported for a specific SoC is
815 available, then no further board specific code should
816 be needed to use it.
817
818 CONFIG_HW_WATCHDOG
819 When using a watchdog circuitry external to the used
820 SoC, then define this variable and provide board
821 specific code for the "hw_watchdog_reset" function.
822
823 CONFIG_AT91_HW_WDT_TIMEOUT
824 specify the timeout in seconds. default 2 seconds.
825
826 - U-Boot Version:
827 CONFIG_VERSION_VARIABLE
828 If this variable is defined, an environment variable
829 named "ver" is created by U-Boot showing the U-Boot
830 version as printed by the "version" command.
831 Any change to this variable will be reverted at the
832 next reset.
833
834 - Real-Time Clock:
835
836 When CONFIG_CMD_DATE is selected, the type of the RTC
837 has to be selected, too. Define exactly one of the
838 following options:
839
840 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
841 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
842 CONFIG_RTC_MC146818 - use MC146818 RTC
843 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
844 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
845 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
846 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
847 CONFIG_RTC_DS164x - use Dallas DS164x RTC
848 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
849 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
850 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
851 CONFIG_SYS_RV3029_TCR - enable trickle charger on
852 RV3029 RTC.
853
854 Note that if the RTC uses I2C, then the I2C interface
855 must also be configured. See I2C Support, below.
856
857 - GPIO Support:
858 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
859
860 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
861 chip-ngpio pairs that tell the PCA953X driver the number of
862 pins supported by a particular chip.
863
864 Note that if the GPIO device uses I2C, then the I2C interface
865 must also be configured. See I2C Support, below.
866
867 - I/O tracing:
868 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
869 accesses and can checksum them or write a list of them out
870 to memory. See the 'iotrace' command for details. This is
871 useful for testing device drivers since it can confirm that
872 the driver behaves the same way before and after a code
873 change. Currently this is supported on sandbox and arm. To
874 add support for your architecture, add '#include <iotrace.h>'
875 to the bottom of arch/<arch>/include/asm/io.h and test.
876
877 Example output from the 'iotrace stats' command is below.
878 Note that if the trace buffer is exhausted, the checksum will
879 still continue to operate.
880
881 iotrace is enabled
882 Start: 10000000 (buffer start address)
883 Size: 00010000 (buffer size)
884 Offset: 00000120 (current buffer offset)
885 Output: 10000120 (start + offset)
886 Count: 00000018 (number of trace records)
887 CRC32: 9526fb66 (CRC32 of all trace records)
888
889 - Timestamp Support:
890
891 When CONFIG_TIMESTAMP is selected, the timestamp
892 (date and time) of an image is printed by image
893 commands like bootm or iminfo. This option is
894 automatically enabled when you select CONFIG_CMD_DATE .
895
896 - Partition Labels (disklabels) Supported:
897 Zero or more of the following:
898 CONFIG_MAC_PARTITION Apple's MacOS partition table.
899 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
900 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
901 bootloader. Note 2TB partition limit; see
902 disk/part_efi.c
903 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
904
905 If IDE or SCSI support is enabled (CONFIG_IDE or
906 CONFIG_SCSI) you must configure support for at
907 least one non-MTD partition type as well.
908
909 - IDE Reset method:
910 CONFIG_IDE_RESET_ROUTINE - this is defined in several
911 board configurations files but used nowhere!
912
913 CONFIG_IDE_RESET - is this is defined, IDE Reset will
914 be performed by calling the function
915 ide_set_reset(int reset)
916 which has to be defined in a board specific file
917
918 - ATAPI Support:
919 CONFIG_ATAPI
920
921 Set this to enable ATAPI support.
922
923 - LBA48 Support
924 CONFIG_LBA48
925
926 Set this to enable support for disks larger than 137GB
927 Also look at CONFIG_SYS_64BIT_LBA.
928 Whithout these , LBA48 support uses 32bit variables and will 'only'
929 support disks up to 2.1TB.
930
931 CONFIG_SYS_64BIT_LBA:
932 When enabled, makes the IDE subsystem use 64bit sector addresses.
933 Default is 32bit.
934
935 - SCSI Support:
936 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
937 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
938 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
939 maximum numbers of LUNs, SCSI ID's and target
940 devices.
941
942 The environment variable 'scsidevs' is set to the number of
943 SCSI devices found during the last scan.
944
945 - NETWORK Support (PCI):
946 CONFIG_E1000
947 Support for Intel 8254x/8257x gigabit chips.
948
949 CONFIG_E1000_SPI
950 Utility code for direct access to the SPI bus on Intel 8257x.
951 This does not do anything useful unless you set at least one
952 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
953
954 CONFIG_E1000_SPI_GENERIC
955 Allow generic access to the SPI bus on the Intel 8257x, for
956 example with the "sspi" command.
957
958 CONFIG_EEPRO100
959 Support for Intel 82557/82559/82559ER chips.
960 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
961 write routine for first time initialisation.
962
963 CONFIG_TULIP
964 Support for Digital 2114x chips.
965 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
966 modem chip initialisation (KS8761/QS6611).
967
968 CONFIG_NATSEMI
969 Support for National dp83815 chips.
970
971 CONFIG_NS8382X
972 Support for National dp8382[01] gigabit chips.
973
974 - NETWORK Support (other):
975
976 CONFIG_DRIVER_AT91EMAC
977 Support for AT91RM9200 EMAC.
978
979 CONFIG_RMII
980 Define this to use reduced MII inteface
981
982 CONFIG_DRIVER_AT91EMAC_QUIET
983 If this defined, the driver is quiet.
984 The driver doen't show link status messages.
985
986 CONFIG_CALXEDA_XGMAC
987 Support for the Calxeda XGMAC device
988
989 CONFIG_LAN91C96
990 Support for SMSC's LAN91C96 chips.
991
992 CONFIG_LAN91C96_USE_32_BIT
993 Define this to enable 32 bit addressing
994
995 CONFIG_SMC91111
996 Support for SMSC's LAN91C111 chip
997
998 CONFIG_SMC91111_BASE
999 Define this to hold the physical address
1000 of the device (I/O space)
1001
1002 CONFIG_SMC_USE_32_BIT
1003 Define this if data bus is 32 bits
1004
1005 CONFIG_SMC_USE_IOFUNCS
1006 Define this to use i/o functions instead of macros
1007 (some hardware wont work with macros)
1008
1009 CONFIG_DRIVER_TI_EMAC
1010 Support for davinci emac
1011
1012 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1013 Define this if you have more then 3 PHYs.
1014
1015 CONFIG_FTGMAC100
1016 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1017
1018 CONFIG_FTGMAC100_EGIGA
1019 Define this to use GE link update with gigabit PHY.
1020 Define this if FTGMAC100 is connected to gigabit PHY.
1021 If your system has 10/100 PHY only, it might not occur
1022 wrong behavior. Because PHY usually return timeout or
1023 useless data when polling gigabit status and gigabit
1024 control registers. This behavior won't affect the
1025 correctnessof 10/100 link speed update.
1026
1027 CONFIG_SMC911X
1028 Support for SMSC's LAN911x and LAN921x chips
1029
1030 CONFIG_SMC911X_BASE
1031 Define this to hold the physical address
1032 of the device (I/O space)
1033
1034 CONFIG_SMC911X_32_BIT
1035 Define this if data bus is 32 bits
1036
1037 CONFIG_SMC911X_16_BIT
1038 Define this if data bus is 16 bits. If your processor
1039 automatically converts one 32 bit word to two 16 bit
1040 words you may also try CONFIG_SMC911X_32_BIT.
1041
1042 CONFIG_SH_ETHER
1043 Support for Renesas on-chip Ethernet controller
1044
1045 CONFIG_SH_ETHER_USE_PORT
1046 Define the number of ports to be used
1047
1048 CONFIG_SH_ETHER_PHY_ADDR
1049 Define the ETH PHY's address
1050
1051 CONFIG_SH_ETHER_CACHE_WRITEBACK
1052 If this option is set, the driver enables cache flush.
1053
1054 - PWM Support:
1055 CONFIG_PWM_IMX
1056 Support for PWM module on the imx6.
1057
1058 - TPM Support:
1059 CONFIG_TPM
1060 Support TPM devices.
1061
1062 CONFIG_TPM_TIS_INFINEON
1063 Support for Infineon i2c bus TPM devices. Only one device
1064 per system is supported at this time.
1065
1066 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1067 Define the burst count bytes upper limit
1068
1069 CONFIG_TPM_ST33ZP24
1070 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1071
1072 CONFIG_TPM_ST33ZP24_I2C
1073 Support for STMicroelectronics ST33ZP24 I2C devices.
1074 Requires TPM_ST33ZP24 and I2C.
1075
1076 CONFIG_TPM_ST33ZP24_SPI
1077 Support for STMicroelectronics ST33ZP24 SPI devices.
1078 Requires TPM_ST33ZP24 and SPI.
1079
1080 CONFIG_TPM_ATMEL_TWI
1081 Support for Atmel TWI TPM device. Requires I2C support.
1082
1083 CONFIG_TPM_TIS_LPC
1084 Support for generic parallel port TPM devices. Only one device
1085 per system is supported at this time.
1086
1087 CONFIG_TPM_TIS_BASE_ADDRESS
1088 Base address where the generic TPM device is mapped
1089 to. Contemporary x86 systems usually map it at
1090 0xfed40000.
1091
1092 CONFIG_TPM
1093 Define this to enable the TPM support library which provides
1094 functional interfaces to some TPM commands.
1095 Requires support for a TPM device.
1096
1097 CONFIG_TPM_AUTH_SESSIONS
1098 Define this to enable authorized functions in the TPM library.
1099 Requires CONFIG_TPM and CONFIG_SHA1.
1100
1101 - USB Support:
1102 At the moment only the UHCI host controller is
1103 supported (PIP405, MIP405); define
1104 CONFIG_USB_UHCI to enable it.
1105 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1106 and define CONFIG_USB_STORAGE to enable the USB
1107 storage devices.
1108 Note:
1109 Supported are USB Keyboards and USB Floppy drives
1110 (TEAC FD-05PUB).
1111
1112 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1113 txfilltuning field in the EHCI controller on reset.
1114
1115 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1116 HW module registers.
1117
1118 - USB Device:
1119 Define the below if you wish to use the USB console.
1120 Once firmware is rebuilt from a serial console issue the
1121 command "setenv stdin usbtty; setenv stdout usbtty" and
1122 attach your USB cable. The Unix command "dmesg" should print
1123 it has found a new device. The environment variable usbtty
1124 can be set to gserial or cdc_acm to enable your device to
1125 appear to a USB host as a Linux gserial device or a
1126 Common Device Class Abstract Control Model serial device.
1127 If you select usbtty = gserial you should be able to enumerate
1128 a Linux host by
1129 # modprobe usbserial vendor=0xVendorID product=0xProductID
1130 else if using cdc_acm, simply setting the environment
1131 variable usbtty to be cdc_acm should suffice. The following
1132 might be defined in YourBoardName.h
1133
1134 CONFIG_USB_DEVICE
1135 Define this to build a UDC device
1136
1137 CONFIG_USB_TTY
1138 Define this to have a tty type of device available to
1139 talk to the UDC device
1140
1141 CONFIG_USBD_HS
1142 Define this to enable the high speed support for usb
1143 device and usbtty. If this feature is enabled, a routine
1144 int is_usbd_high_speed(void)
1145 also needs to be defined by the driver to dynamically poll
1146 whether the enumeration has succeded at high speed or full
1147 speed.
1148
1149 CONFIG_SYS_CONSOLE_IS_IN_ENV
1150 Define this if you want stdin, stdout &/or stderr to
1151 be set to usbtty.
1152
1153 If you have a USB-IF assigned VendorID then you may wish to
1154 define your own vendor specific values either in BoardName.h
1155 or directly in usbd_vendor_info.h. If you don't define
1156 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1157 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1158 should pretend to be a Linux device to it's target host.
1159
1160 CONFIG_USBD_MANUFACTURER
1161 Define this string as the name of your company for
1162 - CONFIG_USBD_MANUFACTURER "my company"
1163
1164 CONFIG_USBD_PRODUCT_NAME
1165 Define this string as the name of your product
1166 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1167
1168 CONFIG_USBD_VENDORID
1169 Define this as your assigned Vendor ID from the USB
1170 Implementors Forum. This *must* be a genuine Vendor ID
1171 to avoid polluting the USB namespace.
1172 - CONFIG_USBD_VENDORID 0xFFFF
1173
1174 CONFIG_USBD_PRODUCTID
1175 Define this as the unique Product ID
1176 for your device
1177 - CONFIG_USBD_PRODUCTID 0xFFFF
1178
1179 - ULPI Layer Support:
1180 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1181 the generic ULPI layer. The generic layer accesses the ULPI PHY
1182 via the platform viewport, so you need both the genric layer and
1183 the viewport enabled. Currently only Chipidea/ARC based
1184 viewport is supported.
1185 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1186 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1187 If your ULPI phy needs a different reference clock than the
1188 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1189 the appropriate value in Hz.
1190
1191 - MMC Support:
1192 The MMC controller on the Intel PXA is supported. To
1193 enable this define CONFIG_MMC. The MMC can be
1194 accessed from the boot prompt by mapping the device
1195 to physical memory similar to flash. Command line is
1196 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1197 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1198
1199 CONFIG_SH_MMCIF
1200 Support for Renesas on-chip MMCIF controller
1201
1202 CONFIG_SH_MMCIF_ADDR
1203 Define the base address of MMCIF registers
1204
1205 CONFIG_SH_MMCIF_CLK
1206 Define the clock frequency for MMCIF
1207
1208 CONFIG_SUPPORT_EMMC_BOOT
1209 Enable some additional features of the eMMC boot partitions.
1210
1211 CONFIG_SUPPORT_EMMC_RPMB
1212 Enable the commands for reading, writing and programming the
1213 key for the Replay Protection Memory Block partition in eMMC.
1214
1215 - USB Device Firmware Update (DFU) class support:
1216 CONFIG_USB_FUNCTION_DFU
1217 This enables the USB portion of the DFU USB class
1218
1219 CONFIG_DFU_MMC
1220 This enables support for exposing (e)MMC devices via DFU.
1221
1222 CONFIG_DFU_NAND
1223 This enables support for exposing NAND devices via DFU.
1224
1225 CONFIG_DFU_RAM
1226 This enables support for exposing RAM via DFU.
1227 Note: DFU spec refer to non-volatile memory usage, but
1228 allow usages beyond the scope of spec - here RAM usage,
1229 one that would help mostly the developer.
1230
1231 CONFIG_SYS_DFU_DATA_BUF_SIZE
1232 Dfu transfer uses a buffer before writing data to the
1233 raw storage device. Make the size (in bytes) of this buffer
1234 configurable. The size of this buffer is also configurable
1235 through the "dfu_bufsiz" environment variable.
1236
1237 CONFIG_SYS_DFU_MAX_FILE_SIZE
1238 When updating files rather than the raw storage device,
1239 we use a static buffer to copy the file into and then write
1240 the buffer once we've been given the whole file. Define
1241 this to the maximum filesize (in bytes) for the buffer.
1242 Default is 4 MiB if undefined.
1243
1244 DFU_DEFAULT_POLL_TIMEOUT
1245 Poll timeout [ms], is the timeout a device can send to the
1246 host. The host must wait for this timeout before sending
1247 a subsequent DFU_GET_STATUS request to the device.
1248
1249 DFU_MANIFEST_POLL_TIMEOUT
1250 Poll timeout [ms], which the device sends to the host when
1251 entering dfuMANIFEST state. Host waits this timeout, before
1252 sending again an USB request to the device.
1253
1254 - Journaling Flash filesystem support:
1255 CONFIG_JFFS2_NAND
1256 Define these for a default partition on a NAND device
1257
1258 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1259 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1260 Define these for a default partition on a NOR device
1261
1262 - Keyboard Support:
1263 See Kconfig help for available keyboard drivers.
1264
1265 CONFIG_KEYBOARD
1266
1267 Define this to enable a custom keyboard support.
1268 This simply calls drv_keyboard_init() which must be
1269 defined in your board-specific files. This option is deprecated
1270 and is only used by novena. For new boards, use driver model
1271 instead.
1272
1273 - Video support:
1274 CONFIG_FSL_DIU_FB
1275 Enable the Freescale DIU video driver. Reference boards for
1276 SOCs that have a DIU should define this macro to enable DIU
1277 support, and should also define these other macros:
1278
1279 CONFIG_SYS_DIU_ADDR
1280 CONFIG_VIDEO
1281 CONFIG_CFB_CONSOLE
1282 CONFIG_VIDEO_SW_CURSOR
1283 CONFIG_VGA_AS_SINGLE_DEVICE
1284 CONFIG_VIDEO_LOGO
1285 CONFIG_VIDEO_BMP_LOGO
1286
1287 The DIU driver will look for the 'video-mode' environment
1288 variable, and if defined, enable the DIU as a console during
1289 boot. See the documentation file doc/README.video for a
1290 description of this variable.
1291
1292 - LCD Support: CONFIG_LCD
1293
1294 Define this to enable LCD support (for output to LCD
1295 display); also select one of the supported displays
1296 by defining one of these:
1297
1298 CONFIG_ATMEL_LCD:
1299
1300 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1301
1302 CONFIG_NEC_NL6448AC33:
1303
1304 NEC NL6448AC33-18. Active, color, single scan.
1305
1306 CONFIG_NEC_NL6448BC20
1307
1308 NEC NL6448BC20-08. 6.5", 640x480.
1309 Active, color, single scan.
1310
1311 CONFIG_NEC_NL6448BC33_54
1312
1313 NEC NL6448BC33-54. 10.4", 640x480.
1314 Active, color, single scan.
1315
1316 CONFIG_SHARP_16x9
1317
1318 Sharp 320x240. Active, color, single scan.
1319 It isn't 16x9, and I am not sure what it is.
1320
1321 CONFIG_SHARP_LQ64D341
1322
1323 Sharp LQ64D341 display, 640x480.
1324 Active, color, single scan.
1325
1326 CONFIG_HLD1045
1327
1328 HLD1045 display, 640x480.
1329 Active, color, single scan.
1330
1331 CONFIG_OPTREX_BW
1332
1333 Optrex CBL50840-2 NF-FW 99 22 M5
1334 or
1335 Hitachi LMG6912RPFC-00T
1336 or
1337 Hitachi SP14Q002
1338
1339 320x240. Black & white.
1340
1341 CONFIG_LCD_ALIGNMENT
1342
1343 Normally the LCD is page-aligned (typically 4KB). If this is
1344 defined then the LCD will be aligned to this value instead.
1345 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1346 here, since it is cheaper to change data cache settings on
1347 a per-section basis.
1348
1349
1350 CONFIG_LCD_ROTATION
1351
1352 Sometimes, for example if the display is mounted in portrait
1353 mode or even if it's mounted landscape but rotated by 180degree,
1354 we need to rotate our content of the display relative to the
1355 framebuffer, so that user can read the messages which are
1356 printed out.
1357 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1358 initialized with a given rotation from "vl_rot" out of
1359 "vidinfo_t" which is provided by the board specific code.
1360 The value for vl_rot is coded as following (matching to
1361 fbcon=rotate:<n> linux-kernel commandline):
1362 0 = no rotation respectively 0 degree
1363 1 = 90 degree rotation
1364 2 = 180 degree rotation
1365 3 = 270 degree rotation
1366
1367 If CONFIG_LCD_ROTATION is not defined, the console will be
1368 initialized with 0degree rotation.
1369
1370 CONFIG_LCD_BMP_RLE8
1371
1372 Support drawing of RLE8-compressed bitmaps on the LCD.
1373
1374 CONFIG_I2C_EDID
1375
1376 Enables an 'i2c edid' command which can read EDID
1377 information over I2C from an attached LCD display.
1378
1379 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1380
1381 If this option is set, the environment is checked for
1382 a variable "splashimage". If found, the usual display
1383 of logo, copyright and system information on the LCD
1384 is suppressed and the BMP image at the address
1385 specified in "splashimage" is loaded instead. The
1386 console is redirected to the "nulldev", too. This
1387 allows for a "silent" boot where a splash screen is
1388 loaded very quickly after power-on.
1389
1390 CONFIG_SPLASHIMAGE_GUARD
1391
1392 If this option is set, then U-Boot will prevent the environment
1393 variable "splashimage" from being set to a problematic address
1394 (see doc/README.displaying-bmps).
1395 This option is useful for targets where, due to alignment
1396 restrictions, an improperly aligned BMP image will cause a data
1397 abort. If you think you will not have problems with unaligned
1398 accesses (for example because your toolchain prevents them)
1399 there is no need to set this option.
1400
1401 CONFIG_SPLASH_SCREEN_ALIGN
1402
1403 If this option is set the splash image can be freely positioned
1404 on the screen. Environment variable "splashpos" specifies the
1405 position as "x,y". If a positive number is given it is used as
1406 number of pixel from left/top. If a negative number is given it
1407 is used as number of pixel from right/bottom. You can also
1408 specify 'm' for centering the image.
1409
1410 Example:
1411 setenv splashpos m,m
1412 => image at center of screen
1413
1414 setenv splashpos 30,20
1415 => image at x = 30 and y = 20
1416
1417 setenv splashpos -10,m
1418 => vertically centered image
1419 at x = dspWidth - bmpWidth - 9
1420
1421 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1422
1423 If this option is set, additionally to standard BMP
1424 images, gzipped BMP images can be displayed via the
1425 splashscreen support or the bmp command.
1426
1427 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1428
1429 If this option is set, 8-bit RLE compressed BMP images
1430 can be displayed via the splashscreen support or the
1431 bmp command.
1432
1433 - Compression support:
1434 CONFIG_GZIP
1435
1436 Enabled by default to support gzip compressed images.
1437
1438 CONFIG_BZIP2
1439
1440 If this option is set, support for bzip2 compressed
1441 images is included. If not, only uncompressed and gzip
1442 compressed images are supported.
1443
1444 NOTE: the bzip2 algorithm requires a lot of RAM, so
1445 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1446 be at least 4MB.
1447
1448 - MII/PHY support:
1449 CONFIG_PHY_ADDR
1450
1451 The address of PHY on MII bus.
1452
1453 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1454
1455 The clock frequency of the MII bus
1456
1457 CONFIG_PHY_RESET_DELAY
1458
1459 Some PHY like Intel LXT971A need extra delay after
1460 reset before any MII register access is possible.
1461 For such PHY, set this option to the usec delay
1462 required. (minimum 300usec for LXT971A)
1463
1464 CONFIG_PHY_CMD_DELAY (ppc4xx)
1465
1466 Some PHY like Intel LXT971A need extra delay after
1467 command issued before MII status register can be read
1468
1469 - IP address:
1470 CONFIG_IPADDR
1471
1472 Define a default value for the IP address to use for
1473 the default Ethernet interface, in case this is not
1474 determined through e.g. bootp.
1475 (Environment variable "ipaddr")
1476
1477 - Server IP address:
1478 CONFIG_SERVERIP
1479
1480 Defines a default value for the IP address of a TFTP
1481 server to contact when using the "tftboot" command.
1482 (Environment variable "serverip")
1483
1484 CONFIG_KEEP_SERVERADDR
1485
1486 Keeps the server's MAC address, in the env 'serveraddr'
1487 for passing to bootargs (like Linux's netconsole option)
1488
1489 - Gateway IP address:
1490 CONFIG_GATEWAYIP
1491
1492 Defines a default value for the IP address of the
1493 default router where packets to other networks are
1494 sent to.
1495 (Environment variable "gatewayip")
1496
1497 - Subnet mask:
1498 CONFIG_NETMASK
1499
1500 Defines a default value for the subnet mask (or
1501 routing prefix) which is used to determine if an IP
1502 address belongs to the local subnet or needs to be
1503 forwarded through a router.
1504 (Environment variable "netmask")
1505
1506 - Multicast TFTP Mode:
1507 CONFIG_MCAST_TFTP
1508
1509 Defines whether you want to support multicast TFTP as per
1510 rfc-2090; for example to work with atftp. Lets lots of targets
1511 tftp down the same boot image concurrently. Note: the Ethernet
1512 driver in use must provide a function: mcast() to join/leave a
1513 multicast group.
1514
1515 - BOOTP Recovery Mode:
1516 CONFIG_BOOTP_RANDOM_DELAY
1517
1518 If you have many targets in a network that try to
1519 boot using BOOTP, you may want to avoid that all
1520 systems send out BOOTP requests at precisely the same
1521 moment (which would happen for instance at recovery
1522 from a power failure, when all systems will try to
1523 boot, thus flooding the BOOTP server. Defining
1524 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1525 inserted before sending out BOOTP requests. The
1526 following delays are inserted then:
1527
1528 1st BOOTP request: delay 0 ... 1 sec
1529 2nd BOOTP request: delay 0 ... 2 sec
1530 3rd BOOTP request: delay 0 ... 4 sec
1531 4th and following
1532 BOOTP requests: delay 0 ... 8 sec
1533
1534 CONFIG_BOOTP_ID_CACHE_SIZE
1535
1536 BOOTP packets are uniquely identified using a 32-bit ID. The
1537 server will copy the ID from client requests to responses and
1538 U-Boot will use this to determine if it is the destination of
1539 an incoming response. Some servers will check that addresses
1540 aren't in use before handing them out (usually using an ARP
1541 ping) and therefore take up to a few hundred milliseconds to
1542 respond. Network congestion may also influence the time it
1543 takes for a response to make it back to the client. If that
1544 time is too long, U-Boot will retransmit requests. In order
1545 to allow earlier responses to still be accepted after these
1546 retransmissions, U-Boot's BOOTP client keeps a small cache of
1547 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1548 cache. The default is to keep IDs for up to four outstanding
1549 requests. Increasing this will allow U-Boot to accept offers
1550 from a BOOTP client in networks with unusually high latency.
1551
1552 - DHCP Advanced Options:
1553 You can fine tune the DHCP functionality by defining
1554 CONFIG_BOOTP_* symbols:
1555
1556 CONFIG_BOOTP_SUBNETMASK
1557 CONFIG_BOOTP_GATEWAY
1558 CONFIG_BOOTP_HOSTNAME
1559 CONFIG_BOOTP_NISDOMAIN
1560 CONFIG_BOOTP_BOOTPATH
1561 CONFIG_BOOTP_BOOTFILESIZE
1562 CONFIG_BOOTP_DNS
1563 CONFIG_BOOTP_DNS2
1564 CONFIG_BOOTP_SEND_HOSTNAME
1565 CONFIG_BOOTP_NTPSERVER
1566 CONFIG_BOOTP_TIMEOFFSET
1567 CONFIG_BOOTP_VENDOREX
1568 CONFIG_BOOTP_MAY_FAIL
1569
1570 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1571 environment variable, not the BOOTP server.
1572
1573 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1574 after the configured retry count, the call will fail
1575 instead of starting over. This can be used to fail over
1576 to Link-local IP address configuration if the DHCP server
1577 is not available.
1578
1579 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1580 serverip from a DHCP server, it is possible that more
1581 than one DNS serverip is offered to the client.
1582 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1583 serverip will be stored in the additional environment
1584 variable "dnsip2". The first DNS serverip is always
1585 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1586 is defined.
1587
1588 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1589 to do a dynamic update of a DNS server. To do this, they
1590 need the hostname of the DHCP requester.
1591 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1592 of the "hostname" environment variable is passed as
1593 option 12 to the DHCP server.
1594
1595 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1596
1597 A 32bit value in microseconds for a delay between
1598 receiving a "DHCP Offer" and sending the "DHCP Request".
1599 This fixes a problem with certain DHCP servers that don't
1600 respond 100% of the time to a "DHCP request". E.g. On an
1601 AT91RM9200 processor running at 180MHz, this delay needed
1602 to be *at least* 15,000 usec before a Windows Server 2003
1603 DHCP server would reply 100% of the time. I recommend at
1604 least 50,000 usec to be safe. The alternative is to hope
1605 that one of the retries will be successful but note that
1606 the DHCP timeout and retry process takes a longer than
1607 this delay.
1608
1609 - Link-local IP address negotiation:
1610 Negotiate with other link-local clients on the local network
1611 for an address that doesn't require explicit configuration.
1612 This is especially useful if a DHCP server cannot be guaranteed
1613 to exist in all environments that the device must operate.
1614
1615 See doc/README.link-local for more information.
1616
1617 - CDP Options:
1618 CONFIG_CDP_DEVICE_ID
1619
1620 The device id used in CDP trigger frames.
1621
1622 CONFIG_CDP_DEVICE_ID_PREFIX
1623
1624 A two character string which is prefixed to the MAC address
1625 of the device.
1626
1627 CONFIG_CDP_PORT_ID
1628
1629 A printf format string which contains the ascii name of
1630 the port. Normally is set to "eth%d" which sets
1631 eth0 for the first Ethernet, eth1 for the second etc.
1632
1633 CONFIG_CDP_CAPABILITIES
1634
1635 A 32bit integer which indicates the device capabilities;
1636 0x00000010 for a normal host which does not forwards.
1637
1638 CONFIG_CDP_VERSION
1639
1640 An ascii string containing the version of the software.
1641
1642 CONFIG_CDP_PLATFORM
1643
1644 An ascii string containing the name of the platform.
1645
1646 CONFIG_CDP_TRIGGER
1647
1648 A 32bit integer sent on the trigger.
1649
1650 CONFIG_CDP_POWER_CONSUMPTION
1651
1652 A 16bit integer containing the power consumption of the
1653 device in .1 of milliwatts.
1654
1655 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1656
1657 A byte containing the id of the VLAN.
1658
1659 - Status LED: CONFIG_LED_STATUS
1660
1661 Several configurations allow to display the current
1662 status using a LED. For instance, the LED will blink
1663 fast while running U-Boot code, stop blinking as
1664 soon as a reply to a BOOTP request was received, and
1665 start blinking slow once the Linux kernel is running
1666 (supported by a status LED driver in the Linux
1667 kernel). Defining CONFIG_LED_STATUS enables this
1668 feature in U-Boot.
1669
1670 Additional options:
1671
1672 CONFIG_LED_STATUS_GPIO
1673 The status LED can be connected to a GPIO pin.
1674 In such cases, the gpio_led driver can be used as a
1675 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1676 to include the gpio_led driver in the U-Boot binary.
1677
1678 CONFIG_GPIO_LED_INVERTED_TABLE
1679 Some GPIO connected LEDs may have inverted polarity in which
1680 case the GPIO high value corresponds to LED off state and
1681 GPIO low value corresponds to LED on state.
1682 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1683 with a list of GPIO LEDs that have inverted polarity.
1684
1685 - I2C Support: CONFIG_SYS_I2C
1686
1687 This enable the NEW i2c subsystem, and will allow you to use
1688 i2c commands at the u-boot command line (as long as you set
1689 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1690 based realtime clock chips or other i2c devices. See
1691 common/cmd_i2c.c for a description of the command line
1692 interface.
1693
1694 ported i2c driver to the new framework:
1695 - drivers/i2c/soft_i2c.c:
1696 - activate first bus with CONFIG_SYS_I2C_SOFT define
1697 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1698 for defining speed and slave address
1699 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1700 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1701 for defining speed and slave address
1702 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1703 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1704 for defining speed and slave address
1705 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1706 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1707 for defining speed and slave address
1708
1709 - drivers/i2c/fsl_i2c.c:
1710 - activate i2c driver with CONFIG_SYS_I2C_FSL
1711 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1712 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1713 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1714 bus.
1715 - If your board supports a second fsl i2c bus, define
1716 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1717 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1718 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1719 second bus.
1720
1721 - drivers/i2c/tegra_i2c.c:
1722 - activate this driver with CONFIG_SYS_I2C_TEGRA
1723 - This driver adds 4 i2c buses with a fix speed from
1724 100000 and the slave addr 0!
1725
1726 - drivers/i2c/ppc4xx_i2c.c
1727 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1728 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1729 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1730
1731 - drivers/i2c/i2c_mxc.c
1732 - activate this driver with CONFIG_SYS_I2C_MXC
1733 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1734 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1735 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1736 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1737 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1738 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1739 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1740 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1741 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1742 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
1743 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1744 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1745 If those defines are not set, default value is 100000
1746 for speed, and 0 for slave.
1747
1748 - drivers/i2c/rcar_i2c.c:
1749 - activate this driver with CONFIG_SYS_I2C_RCAR
1750 - This driver adds 4 i2c buses
1751
1752 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1753 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1754 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1755 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1756 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1757 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1758 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1759 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1760 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1761
1762 - drivers/i2c/sh_i2c.c:
1763 - activate this driver with CONFIG_SYS_I2C_SH
1764 - This driver adds from 2 to 5 i2c buses
1765
1766 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1767 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1768 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1769 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1770 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1771 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1772 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1773 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1774 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1775 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1776 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
1777
1778 - drivers/i2c/omap24xx_i2c.c
1779 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1780 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1781 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1782 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1783 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1784 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1785 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1786 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1787 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1788 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1789 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1790
1791 - drivers/i2c/zynq_i2c.c
1792 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1793 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1794 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1795
1796 - drivers/i2c/s3c24x0_i2c.c:
1797 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1798 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1799 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1800 with a fix speed from 100000 and the slave addr 0!
1801
1802 - drivers/i2c/ihs_i2c.c
1803 - activate this driver with CONFIG_SYS_I2C_IHS
1804 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1805 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1806 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1807 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1808 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1809 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1810 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1811 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1812 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1813 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1814 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1815 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
1816 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1817 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1818 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1819 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1820 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1821 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1822 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1823 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1824 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
1825
1826 additional defines:
1827
1828 CONFIG_SYS_NUM_I2C_BUSES
1829 Hold the number of i2c buses you want to use.
1830
1831 CONFIG_SYS_I2C_DIRECT_BUS
1832 define this, if you don't use i2c muxes on your hardware.
1833 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1834 omit this define.
1835
1836 CONFIG_SYS_I2C_MAX_HOPS
1837 define how many muxes are maximal consecutively connected
1838 on one i2c bus. If you not use i2c muxes, omit this
1839 define.
1840
1841 CONFIG_SYS_I2C_BUSES
1842 hold a list of buses you want to use, only used if
1843 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1844 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1845 CONFIG_SYS_NUM_I2C_BUSES = 9:
1846
1847 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1848 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1849 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1850 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1851 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1852 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1853 {1, {I2C_NULL_HOP}}, \
1854 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1855 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1856 }
1857
1858 which defines
1859 bus 0 on adapter 0 without a mux
1860 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1861 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1862 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1863 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1864 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
1865 bus 6 on adapter 1 without a mux
1866 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1867 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
1868
1869 If you do not have i2c muxes on your board, omit this define.
1870
1871 - Legacy I2C Support:
1872 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1873 then the following macros need to be defined (examples are
1874 from include/configs/lwmon.h):
1875
1876 I2C_INIT
1877
1878 (Optional). Any commands necessary to enable the I2C
1879 controller or configure ports.
1880
1881 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1882
1883 I2C_ACTIVE
1884
1885 The code necessary to make the I2C data line active
1886 (driven). If the data line is open collector, this
1887 define can be null.
1888
1889 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1890
1891 I2C_TRISTATE
1892
1893 The code necessary to make the I2C data line tri-stated
1894 (inactive). If the data line is open collector, this
1895 define can be null.
1896
1897 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1898
1899 I2C_READ
1900
1901 Code that returns true if the I2C data line is high,
1902 false if it is low.
1903
1904 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1905
1906 I2C_SDA(bit)
1907
1908 If <bit> is true, sets the I2C data line high. If it
1909 is false, it clears it (low).
1910
1911 eg: #define I2C_SDA(bit) \
1912 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1913 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1914
1915 I2C_SCL(bit)
1916
1917 If <bit> is true, sets the I2C clock line high. If it
1918 is false, it clears it (low).
1919
1920 eg: #define I2C_SCL(bit) \
1921 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1922 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1923
1924 I2C_DELAY
1925
1926 This delay is invoked four times per clock cycle so this
1927 controls the rate of data transfer. The data rate thus
1928 is 1 / (I2C_DELAY * 4). Often defined to be something
1929 like:
1930
1931 #define I2C_DELAY udelay(2)
1932
1933 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1934
1935 If your arch supports the generic GPIO framework (asm/gpio.h),
1936 then you may alternatively define the two GPIOs that are to be
1937 used as SCL / SDA. Any of the previous I2C_xxx macros will
1938 have GPIO-based defaults assigned to them as appropriate.
1939
1940 You should define these to the GPIO value as given directly to
1941 the generic GPIO functions.
1942
1943 CONFIG_SYS_I2C_INIT_BOARD
1944
1945 When a board is reset during an i2c bus transfer
1946 chips might think that the current transfer is still
1947 in progress. On some boards it is possible to access
1948 the i2c SCLK line directly, either by using the
1949 processor pin as a GPIO or by having a second pin
1950 connected to the bus. If this option is defined a
1951 custom i2c_init_board() routine in boards/xxx/board.c
1952 is run early in the boot sequence.
1953
1954 CONFIG_I2C_MULTI_BUS
1955
1956 This option allows the use of multiple I2C buses, each of which
1957 must have a controller. At any point in time, only one bus is
1958 active. To switch to a different bus, use the 'i2c dev' command.
1959 Note that bus numbering is zero-based.
1960
1961 CONFIG_SYS_I2C_NOPROBES
1962
1963 This option specifies a list of I2C devices that will be skipped
1964 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1965 is set, specify a list of bus-device pairs. Otherwise, specify
1966 a 1D array of device addresses
1967
1968 e.g.
1969 #undef CONFIG_I2C_MULTI_BUS
1970 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1971
1972 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1973
1974 #define CONFIG_I2C_MULTI_BUS
1975 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1976
1977 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1978
1979 CONFIG_SYS_SPD_BUS_NUM
1980
1981 If defined, then this indicates the I2C bus number for DDR SPD.
1982 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1983
1984 CONFIG_SYS_RTC_BUS_NUM
1985
1986 If defined, then this indicates the I2C bus number for the RTC.
1987 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1988
1989 CONFIG_SOFT_I2C_READ_REPEATED_START
1990
1991 defining this will force the i2c_read() function in
1992 the soft_i2c driver to perform an I2C repeated start
1993 between writing the address pointer and reading the
1994 data. If this define is omitted the default behaviour
1995 of doing a stop-start sequence will be used. Most I2C
1996 devices can use either method, but some require one or
1997 the other.
1998
1999 - SPI Support: CONFIG_SPI
2000
2001 Enables SPI driver (so far only tested with
2002 SPI EEPROM, also an instance works with Crystal A/D and
2003 D/As on the SACSng board)
2004
2005 CONFIG_SH_SPI
2006
2007 Enables the driver for SPI controller on SuperH. Currently
2008 only SH7757 is supported.
2009
2010 CONFIG_SOFT_SPI
2011
2012 Enables a software (bit-bang) SPI driver rather than
2013 using hardware support. This is a general purpose
2014 driver that only requires three general I/O port pins
2015 (two outputs, one input) to function. If this is
2016 defined, the board configuration must define several
2017 SPI configuration items (port pins to use, etc). For
2018 an example, see include/configs/sacsng.h.
2019
2020 CONFIG_HARD_SPI
2021
2022 Enables a hardware SPI driver for general-purpose reads
2023 and writes. As with CONFIG_SOFT_SPI, the board configuration
2024 must define a list of chip-select function pointers.
2025 Currently supported on some MPC8xxx processors. For an
2026 example, see include/configs/mpc8349emds.h.
2027
2028 CONFIG_MXC_SPI
2029
2030 Enables the driver for the SPI controllers on i.MX and MXC
2031 SoCs. Currently i.MX31/35/51 are supported.
2032
2033 CONFIG_SYS_SPI_MXC_WAIT
2034 Timeout for waiting until spi transfer completed.
2035 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2036
2037 - FPGA Support: CONFIG_FPGA
2038
2039 Enables FPGA subsystem.
2040
2041 CONFIG_FPGA_<vendor>
2042
2043 Enables support for specific chip vendors.
2044 (ALTERA, XILINX)
2045
2046 CONFIG_FPGA_<family>
2047
2048 Enables support for FPGA family.
2049 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2050
2051 CONFIG_FPGA_COUNT
2052
2053 Specify the number of FPGA devices to support.
2054
2055 CONFIG_SYS_FPGA_PROG_FEEDBACK
2056
2057 Enable printing of hash marks during FPGA configuration.
2058
2059 CONFIG_SYS_FPGA_CHECK_BUSY
2060
2061 Enable checks on FPGA configuration interface busy
2062 status by the configuration function. This option
2063 will require a board or device specific function to
2064 be written.
2065
2066 CONFIG_FPGA_DELAY
2067
2068 If defined, a function that provides delays in the FPGA
2069 configuration driver.
2070
2071 CONFIG_SYS_FPGA_CHECK_CTRLC
2072 Allow Control-C to interrupt FPGA configuration
2073
2074 CONFIG_SYS_FPGA_CHECK_ERROR
2075
2076 Check for configuration errors during FPGA bitfile
2077 loading. For example, abort during Virtex II
2078 configuration if the INIT_B line goes low (which
2079 indicated a CRC error).
2080
2081 CONFIG_SYS_FPGA_WAIT_INIT
2082
2083 Maximum time to wait for the INIT_B line to de-assert
2084 after PROB_B has been de-asserted during a Virtex II
2085 FPGA configuration sequence. The default time is 500
2086 ms.
2087
2088 CONFIG_SYS_FPGA_WAIT_BUSY
2089
2090 Maximum time to wait for BUSY to de-assert during
2091 Virtex II FPGA configuration. The default is 5 ms.
2092
2093 CONFIG_SYS_FPGA_WAIT_CONFIG
2094
2095 Time to wait after FPGA configuration. The default is
2096 200 ms.
2097
2098 - Configuration Management:
2099 CONFIG_BUILD_TARGET
2100
2101 Some SoCs need special image types (e.g. U-Boot binary
2102 with a special header) as build targets. By defining
2103 CONFIG_BUILD_TARGET in the SoC / board header, this
2104 special image will be automatically built upon calling
2105 make / buildman.
2106
2107 CONFIG_IDENT_STRING
2108
2109 If defined, this string will be added to the U-Boot
2110 version information (U_BOOT_VERSION)
2111
2112 - Vendor Parameter Protection:
2113
2114 U-Boot considers the values of the environment
2115 variables "serial#" (Board Serial Number) and
2116 "ethaddr" (Ethernet Address) to be parameters that
2117 are set once by the board vendor / manufacturer, and
2118 protects these variables from casual modification by
2119 the user. Once set, these variables are read-only,
2120 and write or delete attempts are rejected. You can
2121 change this behaviour:
2122
2123 If CONFIG_ENV_OVERWRITE is #defined in your config
2124 file, the write protection for vendor parameters is
2125 completely disabled. Anybody can change or delete
2126 these parameters.
2127
2128 Alternatively, if you define _both_ an ethaddr in the
2129 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2130 Ethernet address is installed in the environment,
2131 which can be changed exactly ONCE by the user. [The
2132 serial# is unaffected by this, i. e. it remains
2133 read-only.]
2134
2135 The same can be accomplished in a more flexible way
2136 for any variable by configuring the type of access
2137 to allow for those variables in the ".flags" variable
2138 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2139
2140 - Protected RAM:
2141 CONFIG_PRAM
2142
2143 Define this variable to enable the reservation of
2144 "protected RAM", i. e. RAM which is not overwritten
2145 by U-Boot. Define CONFIG_PRAM to hold the number of
2146 kB you want to reserve for pRAM. You can overwrite
2147 this default value by defining an environment
2148 variable "pram" to the number of kB you want to
2149 reserve. Note that the board info structure will
2150 still show the full amount of RAM. If pRAM is
2151 reserved, a new environment variable "mem" will
2152 automatically be defined to hold the amount of
2153 remaining RAM in a form that can be passed as boot
2154 argument to Linux, for instance like that:
2155
2156 setenv bootargs ... mem=\${mem}
2157 saveenv
2158
2159 This way you can tell Linux not to use this memory,
2160 either, which results in a memory region that will
2161 not be affected by reboots.
2162
2163 *WARNING* If your board configuration uses automatic
2164 detection of the RAM size, you must make sure that
2165 this memory test is non-destructive. So far, the
2166 following board configurations are known to be
2167 "pRAM-clean":
2168
2169 IVMS8, IVML24, SPD8xx,
2170 HERMES, IP860, RPXlite, LWMON,
2171 FLAGADM
2172
2173 - Access to physical memory region (> 4GB)
2174 Some basic support is provided for operations on memory not
2175 normally accessible to U-Boot - e.g. some architectures
2176 support access to more than 4GB of memory on 32-bit
2177 machines using physical address extension or similar.
2178 Define CONFIG_PHYSMEM to access this basic support, which
2179 currently only supports clearing the memory.
2180
2181 - Error Recovery:
2182 CONFIG_PANIC_HANG
2183
2184 Define this variable to stop the system in case of a
2185 fatal error, so that you have to reset it manually.
2186 This is probably NOT a good idea for an embedded
2187 system where you want the system to reboot
2188 automatically as fast as possible, but it may be
2189 useful during development since you can try to debug
2190 the conditions that lead to the situation.
2191
2192 CONFIG_NET_RETRY_COUNT
2193
2194 This variable defines the number of retries for
2195 network operations like ARP, RARP, TFTP, or BOOTP
2196 before giving up the operation. If not defined, a
2197 default value of 5 is used.
2198
2199 CONFIG_ARP_TIMEOUT
2200
2201 Timeout waiting for an ARP reply in milliseconds.
2202
2203 CONFIG_NFS_TIMEOUT
2204
2205 Timeout in milliseconds used in NFS protocol.
2206 If you encounter "ERROR: Cannot umount" in nfs command,
2207 try longer timeout such as
2208 #define CONFIG_NFS_TIMEOUT 10000UL
2209
2210 - Command Interpreter:
2211 CONFIG_AUTO_COMPLETE
2212
2213 Enable auto completion of commands using TAB.
2214
2215 CONFIG_SYS_PROMPT_HUSH_PS2
2216
2217 This defines the secondary prompt string, which is
2218 printed when the command interpreter needs more input
2219 to complete a command. Usually "> ".
2220
2221 Note:
2222
2223 In the current implementation, the local variables
2224 space and global environment variables space are
2225 separated. Local variables are those you define by
2226 simply typing `name=value'. To access a local
2227 variable later on, you have write `$name' or
2228 `${name}'; to execute the contents of a variable
2229 directly type `$name' at the command prompt.
2230
2231 Global environment variables are those you use
2232 setenv/printenv to work with. To run a command stored
2233 in such a variable, you need to use the run command,
2234 and you must not use the '$' sign to access them.
2235
2236 To store commands and special characters in a
2237 variable, please use double quotation marks
2238 surrounding the whole text of the variable, instead
2239 of the backslashes before semicolons and special
2240 symbols.
2241
2242 - Command Line Editing and History:
2243 CONFIG_CMDLINE_EDITING
2244
2245 Enable editing and History functions for interactive
2246 command line input operations
2247
2248 - Command Line PS1/PS2 support:
2249 CONFIG_CMDLINE_PS_SUPPORT
2250
2251 Enable support for changing the command prompt string
2252 at run-time. Only static string is supported so far.
2253 The string is obtained from environment variables PS1
2254 and PS2.
2255
2256 - Default Environment:
2257 CONFIG_EXTRA_ENV_SETTINGS
2258
2259 Define this to contain any number of null terminated
2260 strings (variable = value pairs) that will be part of
2261 the default environment compiled into the boot image.
2262
2263 For example, place something like this in your
2264 board's config file:
2265
2266 #define CONFIG_EXTRA_ENV_SETTINGS \
2267 "myvar1=value1\0" \
2268 "myvar2=value2\0"
2269
2270 Warning: This method is based on knowledge about the
2271 internal format how the environment is stored by the
2272 U-Boot code. This is NOT an official, exported
2273 interface! Although it is unlikely that this format
2274 will change soon, there is no guarantee either.
2275 You better know what you are doing here.
2276
2277 Note: overly (ab)use of the default environment is
2278 discouraged. Make sure to check other ways to preset
2279 the environment like the "source" command or the
2280 boot command first.
2281
2282 CONFIG_ENV_VARS_UBOOT_CONFIG
2283
2284 Define this in order to add variables describing the
2285 U-Boot build configuration to the default environment.
2286 These will be named arch, cpu, board, vendor, and soc.
2287
2288 Enabling this option will cause the following to be defined:
2289
2290 - CONFIG_SYS_ARCH
2291 - CONFIG_SYS_CPU
2292 - CONFIG_SYS_BOARD
2293 - CONFIG_SYS_VENDOR
2294 - CONFIG_SYS_SOC
2295
2296 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2297
2298 Define this in order to add variables describing certain
2299 run-time determined information about the hardware to the
2300 environment. These will be named board_name, board_rev.
2301
2302 CONFIG_DELAY_ENVIRONMENT
2303
2304 Normally the environment is loaded when the board is
2305 initialised so that it is available to U-Boot. This inhibits
2306 that so that the environment is not available until
2307 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2308 this is instead controlled by the value of
2309 /config/load-environment.
2310
2311 - DataFlash Support:
2312 CONFIG_HAS_DATAFLASH
2313
2314 Defining this option enables DataFlash features and
2315 allows to read/write in Dataflash via the standard
2316 commands cp, md...
2317
2318 - Serial Flash support
2319 Usage requires an initial 'sf probe' to define the serial
2320 flash parameters, followed by read/write/erase/update
2321 commands.
2322
2323 The following defaults may be provided by the platform
2324 to handle the common case when only a single serial
2325 flash is present on the system.
2326
2327 CONFIG_SF_DEFAULT_BUS Bus identifier
2328 CONFIG_SF_DEFAULT_CS Chip-select
2329 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2330 CONFIG_SF_DEFAULT_SPEED in Hz
2331
2332 CONFIG_SYSTEMACE
2333
2334 Adding this option adds support for Xilinx SystemACE
2335 chips attached via some sort of local bus. The address
2336 of the chip must also be defined in the
2337 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2338
2339 #define CONFIG_SYSTEMACE
2340 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2341
2342 When SystemACE support is added, the "ace" device type
2343 becomes available to the fat commands, i.e. fatls.
2344
2345 - TFTP Fixed UDP Port:
2346 CONFIG_TFTP_PORT
2347
2348 If this is defined, the environment variable tftpsrcp
2349 is used to supply the TFTP UDP source port value.
2350 If tftpsrcp isn't defined, the normal pseudo-random port
2351 number generator is used.
2352
2353 Also, the environment variable tftpdstp is used to supply
2354 the TFTP UDP destination port value. If tftpdstp isn't
2355 defined, the normal port 69 is used.
2356
2357 The purpose for tftpsrcp is to allow a TFTP server to
2358 blindly start the TFTP transfer using the pre-configured
2359 target IP address and UDP port. This has the effect of
2360 "punching through" the (Windows XP) firewall, allowing
2361 the remainder of the TFTP transfer to proceed normally.
2362 A better solution is to properly configure the firewall,
2363 but sometimes that is not allowed.
2364
2365 - bootcount support:
2366 CONFIG_BOOTCOUNT_LIMIT
2367
2368 This enables the bootcounter support, see:
2369 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2370
2371 CONFIG_AT91SAM9XE
2372 enable special bootcounter support on at91sam9xe based boards.
2373 CONFIG_SOC_DA8XX
2374 enable special bootcounter support on da850 based boards.
2375 CONFIG_BOOTCOUNT_RAM
2376 enable support for the bootcounter in RAM
2377 CONFIG_BOOTCOUNT_I2C
2378 enable support for the bootcounter on an i2c (like RTC) device.
2379 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2380 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2381 the bootcounter.
2382 CONFIG_BOOTCOUNT_ALEN = address len
2383
2384 - Show boot progress:
2385 CONFIG_SHOW_BOOT_PROGRESS
2386
2387 Defining this option allows to add some board-
2388 specific code (calling a user-provided function
2389 "show_boot_progress(int)") that enables you to show
2390 the system's boot progress on some display (for
2391 example, some LED's) on your board. At the moment,
2392 the following checkpoints are implemented:
2393
2394
2395 Legacy uImage format:
2396
2397 Arg Where When
2398 1 common/cmd_bootm.c before attempting to boot an image
2399 -1 common/cmd_bootm.c Image header has bad magic number
2400 2 common/cmd_bootm.c Image header has correct magic number
2401 -2 common/cmd_bootm.c Image header has bad checksum
2402 3 common/cmd_bootm.c Image header has correct checksum
2403 -3 common/cmd_bootm.c Image data has bad checksum
2404 4 common/cmd_bootm.c Image data has correct checksum
2405 -4 common/cmd_bootm.c Image is for unsupported architecture
2406 5 common/cmd_bootm.c Architecture check OK
2407 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
2408 6 common/cmd_bootm.c Image Type check OK
2409 -6 common/cmd_bootm.c gunzip uncompression error
2410 -7 common/cmd_bootm.c Unimplemented compression type
2411 7 common/cmd_bootm.c Uncompression OK
2412 8 common/cmd_bootm.c No uncompress/copy overwrite error
2413 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
2414
2415 9 common/image.c Start initial ramdisk verification
2416 -10 common/image.c Ramdisk header has bad magic number
2417 -11 common/image.c Ramdisk header has bad checksum
2418 10 common/image.c Ramdisk header is OK
2419 -12 common/image.c Ramdisk data has bad checksum
2420 11 common/image.c Ramdisk data has correct checksum
2421 12 common/image.c Ramdisk verification complete, start loading
2422 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
2423 13 common/image.c Start multifile image verification
2424 14 common/image.c No initial ramdisk, no multifile, continue.
2425
2426 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2427
2428 -30 arch/powerpc/lib/board.c Fatal error, hang the system
2429 -31 post/post.c POST test failed, detected by post_output_backlog()
2430 -32 post/post.c POST test failed, detected by post_run_single()
2431
2432 34 common/cmd_doc.c before loading a Image from a DOC device
2433 -35 common/cmd_doc.c Bad usage of "doc" command
2434 35 common/cmd_doc.c correct usage of "doc" command
2435 -36 common/cmd_doc.c No boot device
2436 36 common/cmd_doc.c correct boot device
2437 -37 common/cmd_doc.c Unknown Chip ID on boot device
2438 37 common/cmd_doc.c correct chip ID found, device available
2439 -38 common/cmd_doc.c Read Error on boot device
2440 38 common/cmd_doc.c reading Image header from DOC device OK
2441 -39 common/cmd_doc.c Image header has bad magic number
2442 39 common/cmd_doc.c Image header has correct magic number
2443 -40 common/cmd_doc.c Error reading Image from DOC device
2444 40 common/cmd_doc.c Image header has correct magic number
2445 41 common/cmd_ide.c before loading a Image from a IDE device
2446 -42 common/cmd_ide.c Bad usage of "ide" command
2447 42 common/cmd_ide.c correct usage of "ide" command
2448 -43 common/cmd_ide.c No boot device
2449 43 common/cmd_ide.c boot device found
2450 -44 common/cmd_ide.c Device not available
2451 44 common/cmd_ide.c Device available
2452 -45 common/cmd_ide.c wrong partition selected
2453 45 common/cmd_ide.c partition selected
2454 -46 common/cmd_ide.c Unknown partition table
2455 46 common/cmd_ide.c valid partition table found
2456 -47 common/cmd_ide.c Invalid partition type
2457 47 common/cmd_ide.c correct partition type
2458 -48 common/cmd_ide.c Error reading Image Header on boot device
2459 48 common/cmd_ide.c reading Image Header from IDE device OK
2460 -49 common/cmd_ide.c Image header has bad magic number
2461 49 common/cmd_ide.c Image header has correct magic number
2462 -50 common/cmd_ide.c Image header has bad checksum
2463 50 common/cmd_ide.c Image header has correct checksum
2464 -51 common/cmd_ide.c Error reading Image from IDE device
2465 51 common/cmd_ide.c reading Image from IDE device OK
2466 52 common/cmd_nand.c before loading a Image from a NAND device
2467 -53 common/cmd_nand.c Bad usage of "nand" command
2468 53 common/cmd_nand.c correct usage of "nand" command
2469 -54 common/cmd_nand.c No boot device
2470 54 common/cmd_nand.c boot device found
2471 -55 common/cmd_nand.c Unknown Chip ID on boot device
2472 55 common/cmd_nand.c correct chip ID found, device available
2473 -56 common/cmd_nand.c Error reading Image Header on boot device
2474 56 common/cmd_nand.c reading Image Header from NAND device OK
2475 -57 common/cmd_nand.c Image header has bad magic number
2476 57 common/cmd_nand.c Image header has correct magic number
2477 -58 common/cmd_nand.c Error reading Image from NAND device
2478 58 common/cmd_nand.c reading Image from NAND device OK
2479
2480 -60 common/env_common.c Environment has a bad CRC, using default
2481
2482 64 net/eth.c starting with Ethernet configuration.
2483 -64 net/eth.c no Ethernet found.
2484 65 net/eth.c Ethernet found.
2485
2486 -80 common/cmd_net.c usage wrong
2487 80 common/cmd_net.c before calling net_loop()
2488 -81 common/cmd_net.c some error in net_loop() occurred
2489 81 common/cmd_net.c net_loop() back without error
2490 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2491 82 common/cmd_net.c trying automatic boot
2492 83 common/cmd_net.c running "source" command
2493 -83 common/cmd_net.c some error in automatic boot or "source" command
2494 84 common/cmd_net.c end without errors
2495
2496 FIT uImage format:
2497
2498 Arg Where When
2499 100 common/cmd_bootm.c Kernel FIT Image has correct format
2500 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2501 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2502 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2503 102 common/cmd_bootm.c Kernel unit name specified
2504 -103 common/cmd_bootm.c Can't get kernel subimage node offset
2505 103 common/cmd_bootm.c Found configuration node
2506 104 common/cmd_bootm.c Got kernel subimage node offset
2507 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2508 105 common/cmd_bootm.c Kernel subimage hash verification OK
2509 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2510 106 common/cmd_bootm.c Architecture check OK
2511 -106 common/cmd_bootm.c Kernel subimage has wrong type
2512 107 common/cmd_bootm.c Kernel subimage type OK
2513 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2514 108 common/cmd_bootm.c Got kernel subimage data/size
2515 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2516 -109 common/cmd_bootm.c Can't get kernel subimage type
2517 -110 common/cmd_bootm.c Can't get kernel subimage comp
2518 -111 common/cmd_bootm.c Can't get kernel subimage os
2519 -112 common/cmd_bootm.c Can't get kernel subimage load address
2520 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2521
2522 120 common/image.c Start initial ramdisk verification
2523 -120 common/image.c Ramdisk FIT image has incorrect format
2524 121 common/image.c Ramdisk FIT image has correct format
2525 122 common/image.c No ramdisk subimage unit name, using configuration
2526 -122 common/image.c Can't get configuration for ramdisk subimage
2527 123 common/image.c Ramdisk unit name specified
2528 -124 common/image.c Can't get ramdisk subimage node offset
2529 125 common/image.c Got ramdisk subimage node offset
2530 -125 common/image.c Ramdisk subimage hash verification failed
2531 126 common/image.c Ramdisk subimage hash verification OK
2532 -126 common/image.c Ramdisk subimage for unsupported architecture
2533 127 common/image.c Architecture check OK
2534 -127 common/image.c Can't get ramdisk subimage data/size
2535 128 common/image.c Got ramdisk subimage data/size
2536 129 common/image.c Can't get ramdisk load address
2537 -129 common/image.c Got ramdisk load address
2538
2539 -130 common/cmd_doc.c Incorrect FIT image format
2540 131 common/cmd_doc.c FIT image format OK
2541
2542 -140 common/cmd_ide.c Incorrect FIT image format
2543 141 common/cmd_ide.c FIT image format OK
2544
2545 -150 common/cmd_nand.c Incorrect FIT image format
2546 151 common/cmd_nand.c FIT image format OK
2547
2548 - legacy image format:
2549 CONFIG_IMAGE_FORMAT_LEGACY
2550 enables the legacy image format support in U-Boot.
2551
2552 Default:
2553 enabled if CONFIG_FIT_SIGNATURE is not defined.
2554
2555 CONFIG_DISABLE_IMAGE_LEGACY
2556 disable the legacy image format
2557
2558 This define is introduced, as the legacy image format is
2559 enabled per default for backward compatibility.
2560
2561 - Standalone program support:
2562 CONFIG_STANDALONE_LOAD_ADDR
2563
2564 This option defines a board specific value for the
2565 address where standalone program gets loaded, thus
2566 overwriting the architecture dependent default
2567 settings.
2568
2569 - Frame Buffer Address:
2570 CONFIG_FB_ADDR
2571
2572 Define CONFIG_FB_ADDR if you want to use specific
2573 address for frame buffer. This is typically the case
2574 when using a graphics controller has separate video
2575 memory. U-Boot will then place the frame buffer at
2576 the given address instead of dynamically reserving it
2577 in system RAM by calling lcd_setmem(), which grabs
2578 the memory for the frame buffer depending on the
2579 configured panel size.
2580
2581 Please see board_init_f function.
2582
2583 - Automatic software updates via TFTP server
2584 CONFIG_UPDATE_TFTP
2585 CONFIG_UPDATE_TFTP_CNT_MAX
2586 CONFIG_UPDATE_TFTP_MSEC_MAX
2587
2588 These options enable and control the auto-update feature;
2589 for a more detailed description refer to doc/README.update.
2590
2591 - MTD Support (mtdparts command, UBI support)
2592 CONFIG_MTD_DEVICE
2593
2594 Adds the MTD device infrastructure from the Linux kernel.
2595 Needed for mtdparts command support.
2596
2597 CONFIG_MTD_PARTITIONS
2598
2599 Adds the MTD partitioning infrastructure from the Linux
2600 kernel. Needed for UBI support.
2601
2602 - UBI support
2603 CONFIG_UBI_SILENCE_MSG
2604
2605 Make the verbose messages from UBI stop printing. This leaves
2606 warnings and errors enabled.
2607
2608
2609 CONFIG_MTD_UBI_WL_THRESHOLD
2610 This parameter defines the maximum difference between the highest
2611 erase counter value and the lowest erase counter value of eraseblocks
2612 of UBI devices. When this threshold is exceeded, UBI starts performing
2613 wear leveling by means of moving data from eraseblock with low erase
2614 counter to eraseblocks with high erase counter.
2615
2616 The default value should be OK for SLC NAND flashes, NOR flashes and
2617 other flashes which have eraseblock life-cycle 100000 or more.
2618 However, in case of MLC NAND flashes which typically have eraseblock
2619 life-cycle less than 10000, the threshold should be lessened (e.g.,
2620 to 128 or 256, although it does not have to be power of 2).
2621
2622 default: 4096
2623
2624 CONFIG_MTD_UBI_BEB_LIMIT
2625 This option specifies the maximum bad physical eraseblocks UBI
2626 expects on the MTD device (per 1024 eraseblocks). If the
2627 underlying flash does not admit of bad eraseblocks (e.g. NOR
2628 flash), this value is ignored.
2629
2630 NAND datasheets often specify the minimum and maximum NVM
2631 (Number of Valid Blocks) for the flashes' endurance lifetime.
2632 The maximum expected bad eraseblocks per 1024 eraseblocks
2633 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2634 which gives 20 for most NANDs (MaxNVB is basically the total
2635 count of eraseblocks on the chip).
2636
2637 To put it differently, if this value is 20, UBI will try to
2638 reserve about 1.9% of physical eraseblocks for bad blocks
2639 handling. And that will be 1.9% of eraseblocks on the entire
2640 NAND chip, not just the MTD partition UBI attaches. This means
2641 that if you have, say, a NAND flash chip admits maximum 40 bad
2642 eraseblocks, and it is split on two MTD partitions of the same
2643 size, UBI will reserve 40 eraseblocks when attaching a
2644 partition.
2645
2646 default: 20
2647
2648 CONFIG_MTD_UBI_FASTMAP
2649 Fastmap is a mechanism which allows attaching an UBI device
2650 in nearly constant time. Instead of scanning the whole MTD device it
2651 only has to locate a checkpoint (called fastmap) on the device.
2652 The on-flash fastmap contains all information needed to attach
2653 the device. Using fastmap makes only sense on large devices where
2654 attaching by scanning takes long. UBI will not automatically install
2655 a fastmap on old images, but you can set the UBI parameter
2656 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2657 that fastmap-enabled images are still usable with UBI implementations
2658 without fastmap support. On typical flash devices the whole fastmap
2659 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2660
2661 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2662 Set this parameter to enable fastmap automatically on images
2663 without a fastmap.
2664 default: 0
2665
2666 CONFIG_MTD_UBI_FM_DEBUG
2667 Enable UBI fastmap debug
2668 default: 0
2669
2670 - UBIFS support
2671 CONFIG_UBIFS_SILENCE_MSG
2672
2673 Make the verbose messages from UBIFS stop printing. This leaves
2674 warnings and errors enabled.
2675
2676 - SPL framework
2677 CONFIG_SPL
2678 Enable building of SPL globally.
2679
2680 CONFIG_SPL_LDSCRIPT
2681 LDSCRIPT for linking the SPL binary.
2682
2683 CONFIG_SPL_MAX_FOOTPRINT
2684 Maximum size in memory allocated to the SPL, BSS included.
2685 When defined, the linker checks that the actual memory
2686 used by SPL from _start to __bss_end does not exceed it.
2687 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2688 must not be both defined at the same time.
2689
2690 CONFIG_SPL_MAX_SIZE
2691 Maximum size of the SPL image (text, data, rodata, and
2692 linker lists sections), BSS excluded.
2693 When defined, the linker checks that the actual size does
2694 not exceed it.
2695
2696 CONFIG_SPL_TEXT_BASE
2697 TEXT_BASE for linking the SPL binary.
2698
2699 CONFIG_SPL_RELOC_TEXT_BASE
2700 Address to relocate to. If unspecified, this is equal to
2701 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2702
2703 CONFIG_SPL_BSS_START_ADDR
2704 Link address for the BSS within the SPL binary.
2705
2706 CONFIG_SPL_BSS_MAX_SIZE
2707 Maximum size in memory allocated to the SPL BSS.
2708 When defined, the linker checks that the actual memory used
2709 by SPL from __bss_start to __bss_end does not exceed it.
2710 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2711 must not be both defined at the same time.
2712
2713 CONFIG_SPL_STACK
2714 Adress of the start of the stack SPL will use
2715
2716 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2717 When defined, SPL will panic() if the image it has
2718 loaded does not have a signature.
2719 Defining this is useful when code which loads images
2720 in SPL cannot guarantee that absolutely all read errors
2721 will be caught.
2722 An example is the LPC32XX MLC NAND driver, which will
2723 consider that a completely unreadable NAND block is bad,
2724 and thus should be skipped silently.
2725
2726 CONFIG_SPL_RELOC_STACK
2727 Adress of the start of the stack SPL will use after
2728 relocation. If unspecified, this is equal to
2729 CONFIG_SPL_STACK.
2730
2731 CONFIG_SYS_SPL_MALLOC_START
2732 Starting address of the malloc pool used in SPL.
2733 When this option is set the full malloc is used in SPL and
2734 it is set up by spl_init() and before that, the simple malloc()
2735 can be used if CONFIG_SYS_MALLOC_F is defined.
2736
2737 CONFIG_SYS_SPL_MALLOC_SIZE
2738 The size of the malloc pool used in SPL.
2739
2740 CONFIG_SPL_FRAMEWORK
2741 Enable the SPL framework under common/. This framework
2742 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2743 NAND loading of the Linux Kernel.
2744
2745 CONFIG_SPL_OS_BOOT
2746 Enable booting directly to an OS from SPL.
2747 See also: doc/README.falcon
2748
2749 CONFIG_SPL_DISPLAY_PRINT
2750 For ARM, enable an optional function to print more information
2751 about the running system.
2752
2753 CONFIG_SPL_INIT_MINIMAL
2754 Arch init code should be built for a very small image
2755
2756 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2757 Partition on the MMC to load U-Boot from when the MMC is being
2758 used in raw mode
2759
2760 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2761 Sector to load kernel uImage from when MMC is being
2762 used in raw mode (for Falcon mode)
2763
2764 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2765 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2766 Sector and number of sectors to load kernel argument
2767 parameters from when MMC is being used in raw mode
2768 (for falcon mode)
2769
2770 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2771 Partition on the MMC to load U-Boot from when the MMC is being
2772 used in fs mode
2773
2774 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2775 Filename to read to load U-Boot when reading from filesystem
2776
2777 CONFIG_SPL_FS_LOAD_KERNEL_NAME
2778 Filename to read to load kernel uImage when reading
2779 from filesystem (for Falcon mode)
2780
2781 CONFIG_SPL_FS_LOAD_ARGS_NAME
2782 Filename to read to load kernel argument parameters
2783 when reading from filesystem (for Falcon mode)
2784
2785 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2786 Set this for NAND SPL on PPC mpc83xx targets, so that
2787 start.S waits for the rest of the SPL to load before
2788 continuing (the hardware starts execution after just
2789 loading the first page rather than the full 4K).
2790
2791 CONFIG_SPL_SKIP_RELOCATE
2792 Avoid SPL relocation
2793
2794 CONFIG_SPL_NAND_BASE
2795 Include nand_base.c in the SPL. Requires
2796 CONFIG_SPL_NAND_DRIVERS.
2797
2798 CONFIG_SPL_NAND_DRIVERS
2799 SPL uses normal NAND drivers, not minimal drivers.
2800
2801 CONFIG_SPL_NAND_ECC
2802 Include standard software ECC in the SPL
2803
2804 CONFIG_SPL_NAND_SIMPLE
2805 Support for NAND boot using simple NAND drivers that
2806 expose the cmd_ctrl() interface.
2807
2808 CONFIG_SPL_UBI
2809 Support for a lightweight UBI (fastmap) scanner and
2810 loader
2811
2812 CONFIG_SPL_NAND_RAW_ONLY
2813 Support to boot only raw u-boot.bin images. Use this only
2814 if you need to save space.
2815
2816 CONFIG_SPL_COMMON_INIT_DDR
2817 Set for common ddr init with serial presence detect in
2818 SPL binary.
2819
2820 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2821 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2822 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2823 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2824 CONFIG_SYS_NAND_ECCBYTES
2825 Defines the size and behavior of the NAND that SPL uses
2826 to read U-Boot
2827
2828 CONFIG_SPL_NAND_BOOT
2829 Add support NAND boot
2830
2831 CONFIG_SYS_NAND_U_BOOT_OFFS
2832 Location in NAND to read U-Boot from
2833
2834 CONFIG_SYS_NAND_U_BOOT_DST
2835 Location in memory to load U-Boot to
2836
2837 CONFIG_SYS_NAND_U_BOOT_SIZE
2838 Size of image to load
2839
2840 CONFIG_SYS_NAND_U_BOOT_START
2841 Entry point in loaded image to jump to
2842
2843 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2844 Define this if you need to first read the OOB and then the
2845 data. This is used, for example, on davinci platforms.
2846
2847 CONFIG_SPL_RAM_DEVICE
2848 Support for running image already present in ram, in SPL binary
2849
2850 CONFIG_SPL_PAD_TO
2851 Image offset to which the SPL should be padded before appending
2852 the SPL payload. By default, this is defined as
2853 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2854 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2855 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2856
2857 CONFIG_SPL_TARGET
2858 Final target image containing SPL and payload. Some SPLs
2859 use an arch-specific makefile fragment instead, for
2860 example if more than one image needs to be produced.
2861
2862 CONFIG_FIT_SPL_PRINT
2863 Printing information about a FIT image adds quite a bit of
2864 code to SPL. So this is normally disabled in SPL. Use this
2865 option to re-enable it. This will affect the output of the
2866 bootm command when booting a FIT image.
2867
2868 - TPL framework
2869 CONFIG_TPL
2870 Enable building of TPL globally.
2871
2872 CONFIG_TPL_PAD_TO
2873 Image offset to which the TPL should be padded before appending
2874 the TPL payload. By default, this is defined as
2875 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2876 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2877 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2878
2879 - Interrupt support (PPC):
2880
2881 There are common interrupt_init() and timer_interrupt()
2882 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2883 for CPU specific initialization. interrupt_init_cpu()
2884 should set decrementer_count to appropriate value. If
2885 CPU resets decrementer automatically after interrupt
2886 (ppc4xx) it should set decrementer_count to zero.
2887 timer_interrupt() calls timer_interrupt_cpu() for CPU
2888 specific handling. If board has watchdog / status_led
2889 / other_activity_monitor it works automatically from
2890 general timer_interrupt().
2891
2892
2893 Board initialization settings:
2894 ------------------------------
2895
2896 During Initialization u-boot calls a number of board specific functions
2897 to allow the preparation of board specific prerequisites, e.g. pin setup
2898 before drivers are initialized. To enable these callbacks the
2899 following configuration macros have to be defined. Currently this is
2900 architecture specific, so please check arch/your_architecture/lib/board.c
2901 typically in board_init_f() and board_init_r().
2902
2903 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2904 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2905 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
2906 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2907
2908 Configuration Settings:
2909 -----------------------
2910
2911 - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2912 Optionally it can be defined to support 64-bit memory commands.
2913
2914 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2915 undefine this when you're short of memory.
2916
2917 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2918 width of the commands listed in the 'help' command output.
2919
2920 - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
2921 prompt for user input.
2922
2923 - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
2924
2925 - CONFIG_SYS_PBSIZE: Buffer size for Console output
2926
2927 - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
2928
2929 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2930 the application (usually a Linux kernel) when it is
2931 booted
2932
2933 - CONFIG_SYS_BAUDRATE_TABLE:
2934 List of legal baudrate settings for this board.
2935
2936 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2937 Begin and End addresses of the area used by the
2938 simple memory test.
2939
2940 - CONFIG_SYS_ALT_MEMTEST:
2941 Enable an alternate, more extensive memory test.
2942
2943 - CONFIG_SYS_MEMTEST_SCRATCH:
2944 Scratch address used by the alternate memory test
2945 You only need to set this if address zero isn't writeable
2946
2947 - CONFIG_SYS_MEM_RESERVE_SECURE
2948 Only implemented for ARMv8 for now.
2949 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2950 is substracted from total RAM and won't be reported to OS.
2951 This memory can be used as secure memory. A variable
2952 gd->arch.secure_ram is used to track the location. In systems
2953 the RAM base is not zero, or RAM is divided into banks,
2954 this variable needs to be recalcuated to get the address.
2955
2956 - CONFIG_SYS_MEM_TOP_HIDE:
2957 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2958 this specified memory area will get subtracted from the top
2959 (end) of RAM and won't get "touched" at all by U-Boot. By
2960 fixing up gd->ram_size the Linux kernel should gets passed
2961 the now "corrected" memory size and won't touch it either.
2962 This should work for arch/ppc and arch/powerpc. Only Linux
2963 board ports in arch/powerpc with bootwrapper support that
2964 recalculate the memory size from the SDRAM controller setup
2965 will have to get fixed in Linux additionally.
2966
2967 This option can be used as a workaround for the 440EPx/GRx
2968 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2969 be touched.
2970
2971 WARNING: Please make sure that this value is a multiple of
2972 the Linux page size (normally 4k). If this is not the case,
2973 then the end address of the Linux memory will be located at a
2974 non page size aligned address and this could cause major
2975 problems.
2976
2977 - CONFIG_SYS_LOADS_BAUD_CHANGE:
2978 Enable temporary baudrate change while serial download
2979
2980 - CONFIG_SYS_SDRAM_BASE:
2981 Physical start address of SDRAM. _Must_ be 0 here.
2982
2983 - CONFIG_SYS_FLASH_BASE:
2984 Physical start address of Flash memory.
2985
2986 - CONFIG_SYS_MONITOR_BASE:
2987 Physical start address of boot monitor code (set by
2988 make config files to be same as the text base address
2989 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
2990 CONFIG_SYS_FLASH_BASE when booting from flash.
2991
2992 - CONFIG_SYS_MONITOR_LEN:
2993 Size of memory reserved for monitor code, used to
2994 determine _at_compile_time_ (!) if the environment is
2995 embedded within the U-Boot image, or in a separate
2996 flash sector.
2997
2998 - CONFIG_SYS_MALLOC_LEN:
2999 Size of DRAM reserved for malloc() use.
3000
3001 - CONFIG_SYS_MALLOC_F_LEN
3002 Size of the malloc() pool for use before relocation. If
3003 this is defined, then a very simple malloc() implementation
3004 will become available before relocation. The address is just
3005 below the global data, and the stack is moved down to make
3006 space.
3007
3008 This feature allocates regions with increasing addresses
3009 within the region. calloc() is supported, but realloc()
3010 is not available. free() is supported but does nothing.
3011 The memory will be freed (or in fact just forgotten) when
3012 U-Boot relocates itself.
3013
3014 - CONFIG_SYS_MALLOC_SIMPLE
3015 Provides a simple and small malloc() and calloc() for those
3016 boards which do not use the full malloc in SPL (which is
3017 enabled with CONFIG_SYS_SPL_MALLOC_START).
3018
3019 - CONFIG_SYS_NONCACHED_MEMORY:
3020 Size of non-cached memory area. This area of memory will be
3021 typically located right below the malloc() area and mapped
3022 uncached in the MMU. This is useful for drivers that would
3023 otherwise require a lot of explicit cache maintenance. For
3024 some drivers it's also impossible to properly maintain the
3025 cache. For example if the regions that need to be flushed
3026 are not a multiple of the cache-line size, *and* padding
3027 cannot be allocated between the regions to align them (i.e.
3028 if the HW requires a contiguous array of regions, and the
3029 size of each region is not cache-aligned), then a flush of
3030 one region may result in overwriting data that hardware has
3031 written to another region in the same cache-line. This can
3032 happen for example in network drivers where descriptors for
3033 buffers are typically smaller than the CPU cache-line (e.g.
3034 16 bytes vs. 32 or 64 bytes).
3035
3036 Non-cached memory is only supported on 32-bit ARM at present.
3037
3038 - CONFIG_SYS_BOOTM_LEN:
3039 Normally compressed uImages are limited to an
3040 uncompressed size of 8 MBytes. If this is not enough,
3041 you can define CONFIG_SYS_BOOTM_LEN in your board config file
3042 to adjust this setting to your needs.
3043
3044 - CONFIG_SYS_BOOTMAPSZ:
3045 Maximum size of memory mapped by the startup code of
3046 the Linux kernel; all data that must be processed by
3047 the Linux kernel (bd_info, boot arguments, FDT blob if
3048 used) must be put below this limit, unless "bootm_low"
3049 environment variable is defined and non-zero. In such case
3050 all data for the Linux kernel must be between "bootm_low"
3051 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
3052 variable "bootm_mapsize" will override the value of
3053 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3054 then the value in "bootm_size" will be used instead.
3055
3056 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
3057 Enable initrd_high functionality. If defined then the
3058 initrd_high feature is enabled and the bootm ramdisk subcommand
3059 is enabled.
3060
3061 - CONFIG_SYS_BOOT_GET_CMDLINE:
3062 Enables allocating and saving kernel cmdline in space between
3063 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3064
3065 - CONFIG_SYS_BOOT_GET_KBD:
3066 Enables allocating and saving a kernel copy of the bd_info in
3067 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3068
3069 - CONFIG_SYS_MAX_FLASH_BANKS:
3070 Max number of Flash memory banks
3071
3072 - CONFIG_SYS_MAX_FLASH_SECT:
3073 Max number of sectors on a Flash chip
3074
3075 - CONFIG_SYS_FLASH_ERASE_TOUT:
3076 Timeout for Flash erase operations (in ms)
3077
3078 - CONFIG_SYS_FLASH_WRITE_TOUT:
3079 Timeout for Flash write operations (in ms)
3080
3081 - CONFIG_SYS_FLASH_LOCK_TOUT
3082 Timeout for Flash set sector lock bit operation (in ms)
3083
3084 - CONFIG_SYS_FLASH_UNLOCK_TOUT
3085 Timeout for Flash clear lock bits operation (in ms)
3086
3087 - CONFIG_SYS_FLASH_PROTECTION
3088 If defined, hardware flash sectors protection is used
3089 instead of U-Boot software protection.
3090
3091 - CONFIG_SYS_DIRECT_FLASH_TFTP:
3092
3093 Enable TFTP transfers directly to flash memory;
3094 without this option such a download has to be
3095 performed in two steps: (1) download to RAM, and (2)
3096 copy from RAM to flash.
3097
3098 The two-step approach is usually more reliable, since
3099 you can check if the download worked before you erase
3100 the flash, but in some situations (when system RAM is
3101 too limited to allow for a temporary copy of the
3102 downloaded image) this option may be very useful.
3103
3104 - CONFIG_SYS_FLASH_CFI:
3105 Define if the flash driver uses extra elements in the
3106 common flash structure for storing flash geometry.
3107
3108 - CONFIG_FLASH_CFI_DRIVER
3109 This option also enables the building of the cfi_flash driver
3110 in the drivers directory
3111
3112 - CONFIG_FLASH_CFI_MTD
3113 This option enables the building of the cfi_mtd driver
3114 in the drivers directory. The driver exports CFI flash
3115 to the MTD layer.
3116
3117 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3118 Use buffered writes to flash.
3119
3120 - CONFIG_FLASH_SPANSION_S29WS_N
3121 s29ws-n MirrorBit flash has non-standard addresses for buffered
3122 write commands.
3123
3124 - CONFIG_SYS_FLASH_QUIET_TEST
3125 If this option is defined, the common CFI flash doesn't
3126 print it's warning upon not recognized FLASH banks. This
3127 is useful, if some of the configured banks are only
3128 optionally available.
3129
3130 - CONFIG_FLASH_SHOW_PROGRESS
3131 If defined (must be an integer), print out countdown
3132 digits and dots. Recommended value: 45 (9..1) for 80
3133 column displays, 15 (3..1) for 40 column displays.
3134
3135 - CONFIG_FLASH_VERIFY
3136 If defined, the content of the flash (destination) is compared
3137 against the source after the write operation. An error message
3138 will be printed when the contents are not identical.
3139 Please note that this option is useless in nearly all cases,
3140 since such flash programming errors usually are detected earlier
3141 while unprotecting/erasing/programming. Please only enable
3142 this option if you really know what you are doing.
3143
3144 - CONFIG_SYS_RX_ETH_BUFFER:
3145 Defines the number of Ethernet receive buffers. On some
3146 Ethernet controllers it is recommended to set this value
3147 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3148 buffers can be full shortly after enabling the interface
3149 on high Ethernet traffic.
3150 Defaults to 4 if not defined.
3151
3152 - CONFIG_ENV_MAX_ENTRIES
3153
3154 Maximum number of entries in the hash table that is used
3155 internally to store the environment settings. The default
3156 setting is supposed to be generous and should work in most
3157 cases. This setting can be used to tune behaviour; see
3158 lib/hashtable.c for details.
3159
3160 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3161 - CONFIG_ENV_FLAGS_LIST_STATIC
3162 Enable validation of the values given to environment variables when
3163 calling env set. Variables can be restricted to only decimal,
3164 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3165 the variables can also be restricted to IP address or MAC address.
3166
3167 The format of the list is:
3168 type_attribute = [s|d|x|b|i|m]
3169 access_attribute = [a|r|o|c]
3170 attributes = type_attribute[access_attribute]
3171 entry = variable_name[:attributes]
3172 list = entry[,list]
3173
3174 The type attributes are:
3175 s - String (default)
3176 d - Decimal
3177 x - Hexadecimal
3178 b - Boolean ([1yYtT|0nNfF])
3179 i - IP address
3180 m - MAC address
3181
3182 The access attributes are:
3183 a - Any (default)
3184 r - Read-only
3185 o - Write-once
3186 c - Change-default
3187
3188 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3189 Define this to a list (string) to define the ".flags"
3190 environment variable in the default or embedded environment.
3191
3192 - CONFIG_ENV_FLAGS_LIST_STATIC
3193 Define this to a list (string) to define validation that
3194 should be done if an entry is not found in the ".flags"
3195 environment variable. To override a setting in the static
3196 list, simply add an entry for the same variable name to the
3197 ".flags" variable.
3198
3199 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3200 regular expression. This allows multiple variables to define the same
3201 flags without explicitly listing them for each variable.
3202
3203 - CONFIG_ENV_ACCESS_IGNORE_FORCE
3204 If defined, don't allow the -f switch to env set override variable
3205 access flags.
3206
3207 - CONFIG_USE_STDINT
3208 If stdint.h is available with your toolchain you can define this
3209 option to enable it. You can provide option 'USE_STDINT=1' when
3210 building U-Boot to enable this.
3211
3212 The following definitions that deal with the placement and management
3213 of environment data (variable area); in general, we support the
3214 following configurations:
3215
3216 - CONFIG_BUILD_ENVCRC:
3217
3218 Builds up envcrc with the target environment so that external utils
3219 may easily extract it and embed it in final U-Boot images.
3220
3221 BE CAREFUL! The first access to the environment happens quite early
3222 in U-Boot initialization (when we try to get the setting of for the
3223 console baudrate). You *MUST* have mapped your NVRAM area then, or
3224 U-Boot will hang.
3225
3226 Please note that even with NVRAM we still use a copy of the
3227 environment in RAM: we could work on NVRAM directly, but we want to
3228 keep settings there always unmodified except somebody uses "saveenv"
3229 to save the current settings.
3230
3231 BE CAREFUL! For some special cases, the local device can not use
3232 "saveenv" command. For example, the local device will get the
3233 environment stored in a remote NOR flash by SRIO or PCIE link,
3234 but it can not erase, write this NOR flash by SRIO or PCIE interface.
3235
3236 - CONFIG_NAND_ENV_DST
3237
3238 Defines address in RAM to which the nand_spl code should copy the
3239 environment. If redundant environment is used, it will be copied to
3240 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3241
3242 Please note that the environment is read-only until the monitor
3243 has been relocated to RAM and a RAM copy of the environment has been
3244 created; also, when using EEPROM you will have to use env_get_f()
3245 until then to read environment variables.
3246
3247 The environment is protected by a CRC32 checksum. Before the monitor
3248 is relocated into RAM, as a result of a bad CRC you will be working
3249 with the compiled-in default environment - *silently*!!! [This is
3250 necessary, because the first environment variable we need is the
3251 "baudrate" setting for the console - if we have a bad CRC, we don't
3252 have any device yet where we could complain.]
3253
3254 Note: once the monitor has been relocated, then it will complain if
3255 the default environment is used; a new CRC is computed as soon as you
3256 use the "saveenv" command to store a valid environment.
3257
3258 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3259 Echo the inverted Ethernet link state to the fault LED.
3260
3261 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3262 also needs to be defined.
3263
3264 - CONFIG_SYS_FAULT_MII_ADDR:
3265 MII address of the PHY to check for the Ethernet link state.
3266
3267 - CONFIG_NS16550_MIN_FUNCTIONS:
3268 Define this if you desire to only have use of the NS16550_init
3269 and NS16550_putc functions for the serial driver located at
3270 drivers/serial/ns16550.c. This option is useful for saving
3271 space for already greatly restricted images, including but not
3272 limited to NAND_SPL configurations.
3273
3274 - CONFIG_DISPLAY_BOARDINFO
3275 Display information about the board that U-Boot is running on
3276 when U-Boot starts up. The board function checkboard() is called
3277 to do this.
3278
3279 - CONFIG_DISPLAY_BOARDINFO_LATE
3280 Similar to the previous option, but display this information
3281 later, once stdio is running and output goes to the LCD, if
3282 present.
3283
3284 - CONFIG_BOARD_SIZE_LIMIT:
3285 Maximum size of the U-Boot image. When defined, the
3286 build system checks that the actual size does not
3287 exceed it.
3288
3289 Low Level (hardware related) configuration options:
3290 ---------------------------------------------------
3291
3292 - CONFIG_SYS_CACHELINE_SIZE:
3293 Cache Line Size of the CPU.
3294
3295 - CONFIG_SYS_CCSRBAR_DEFAULT:
3296 Default (power-on reset) physical address of CCSR on Freescale
3297 PowerPC SOCs.
3298
3299 - CONFIG_SYS_CCSRBAR:
3300 Virtual address of CCSR. On a 32-bit build, this is typically
3301 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3302
3303 - CONFIG_SYS_CCSRBAR_PHYS:
3304 Physical address of CCSR. CCSR can be relocated to a new
3305 physical address, if desired. In this case, this macro should
3306 be set to that address. Otherwise, it should be set to the
3307 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3308 is typically relocated on 36-bit builds. It is recommended
3309 that this macro be defined via the _HIGH and _LOW macros:
3310
3311 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3312 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3313
3314 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3315 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3316 either 0 (32-bit build) or 0xF (36-bit build). This macro is
3317 used in assembly code, so it must not contain typecasts or
3318 integer size suffixes (e.g. "ULL").
3319
3320 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
3321 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3322 used in assembly code, so it must not contain typecasts or
3323 integer size suffixes (e.g. "ULL").
3324
3325 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3326 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3327 forced to a value that ensures that CCSR is not relocated.
3328
3329 - Floppy Disk Support:
3330 CONFIG_SYS_FDC_DRIVE_NUMBER
3331
3332 the default drive number (default value 0)
3333
3334 CONFIG_SYS_ISA_IO_STRIDE
3335
3336 defines the spacing between FDC chipset registers
3337 (default value 1)
3338
3339 CONFIG_SYS_ISA_IO_OFFSET
3340
3341 defines the offset of register from address. It
3342 depends on which part of the data bus is connected to
3343 the FDC chipset. (default value 0)
3344
3345 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3346 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
3347 default value.
3348
3349 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
3350 fdc_hw_init() is called at the beginning of the FDC
3351 setup. fdc_hw_init() must be provided by the board
3352 source code. It is used to make hardware-dependent
3353 initializations.
3354
3355 - CONFIG_IDE_AHB:
3356 Most IDE controllers were designed to be connected with PCI
3357 interface. Only few of them were designed for AHB interface.
3358 When software is doing ATA command and data transfer to
3359 IDE devices through IDE-AHB controller, some additional
3360 registers accessing to these kind of IDE-AHB controller
3361 is required.
3362
3363 - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
3364 DO NOT CHANGE unless you know exactly what you're
3365 doing! (11-4) [MPC8xx systems only]
3366
3367 - CONFIG_SYS_INIT_RAM_ADDR:
3368
3369 Start address of memory area that can be used for
3370 initial data and stack; please note that this must be
3371 writable memory that is working WITHOUT special
3372 initialization, i. e. you CANNOT use normal RAM which
3373 will become available only after programming the
3374 memory controller and running certain initialization
3375 sequences.
3376
3377 U-Boot uses the following memory types:
3378 - MPC8xx: IMMR (internal memory of the CPU)
3379
3380 - CONFIG_SYS_GBL_DATA_OFFSET:
3381
3382 Offset of the initial data structure in the memory
3383 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3384 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3385 data is located at the end of the available space
3386 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3387 GENERATED_GBL_DATA_SIZE), and the initial stack is just
3388 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3389 CONFIG_SYS_GBL_DATA_OFFSET) downward.
3390
3391 Note:
3392 On the MPC824X (or other systems that use the data
3393 cache for initial memory) the address chosen for
3394 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3395 point to an otherwise UNUSED address space between
3396 the top of RAM and the start of the PCI space.
3397
3398 - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
3399
3400 - CONFIG_SYS_OR_TIMING_SDRAM:
3401 SDRAM timing
3402
3403 - CONFIG_SYS_MAMR_PTA:
3404 periodic timer for refresh
3405
3406 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3407 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3408 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3409 CONFIG_SYS_BR1_PRELIM:
3410 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3411
3412 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
3413 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3414 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3415 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3416
3417 - CONFIG_PCI_ENUM_ONLY
3418 Only scan through and get the devices on the buses.
3419 Don't do any setup work, presumably because someone or
3420 something has already done it, and we don't need to do it
3421 a second time. Useful for platforms that are pre-booted
3422 by coreboot or similar.
3423
3424 - CONFIG_PCI_INDIRECT_BRIDGE:
3425 Enable support for indirect PCI bridges.
3426
3427 - CONFIG_SYS_SRIO:
3428 Chip has SRIO or not
3429
3430 - CONFIG_SRIO1:
3431 Board has SRIO 1 port available
3432
3433 - CONFIG_SRIO2:
3434 Board has SRIO 2 port available
3435
3436 - CONFIG_SRIO_PCIE_BOOT_MASTER
3437 Board can support master function for Boot from SRIO and PCIE
3438
3439 - CONFIG_SYS_SRIOn_MEM_VIRT:
3440 Virtual Address of SRIO port 'n' memory region
3441
3442 - CONFIG_SYS_SRIOn_MEM_PHYS:
3443 Physical Address of SRIO port 'n' memory region
3444
3445 - CONFIG_SYS_SRIOn_MEM_SIZE:
3446 Size of SRIO port 'n' memory region
3447
3448 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
3449 Defined to tell the NAND controller that the NAND chip is using
3450 a 16 bit bus.
3451 Not all NAND drivers use this symbol.
3452 Example of drivers that use it:
3453 - drivers/mtd/nand/ndfc.c
3454 - drivers/mtd/nand/mxc_nand.c
3455
3456 - CONFIG_SYS_NDFC_EBC0_CFG
3457 Sets the EBC0_CFG register for the NDFC. If not defined
3458 a default value will be used.
3459
3460 - CONFIG_SPD_EEPROM
3461 Get DDR timing information from an I2C EEPROM. Common
3462 with pluggable memory modules such as SODIMMs
3463
3464 SPD_EEPROM_ADDRESS
3465 I2C address of the SPD EEPROM
3466
3467 - CONFIG_SYS_SPD_BUS_NUM
3468 If SPD EEPROM is on an I2C bus other than the first
3469 one, specify here. Note that the value must resolve
3470 to something your driver can deal with.
3471
3472 - CONFIG_SYS_DDR_RAW_TIMING
3473 Get DDR timing information from other than SPD. Common with
3474 soldered DDR chips onboard without SPD. DDR raw timing
3475 parameters are extracted from datasheet and hard-coded into
3476 header files or board specific files.
3477
3478 - CONFIG_FSL_DDR_INTERACTIVE
3479 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3480
3481 - CONFIG_FSL_DDR_SYNC_REFRESH
3482 Enable sync of refresh for multiple controllers.
3483
3484 - CONFIG_FSL_DDR_BIST
3485 Enable built-in memory test for Freescale DDR controllers.
3486
3487 - CONFIG_SYS_83XX_DDR_USES_CS0
3488 Only for 83xx systems. If specified, then DDR should
3489 be configured using CS0 and CS1 instead of CS2 and CS3.
3490
3491 - CONFIG_RMII
3492 Enable RMII mode for all FECs.
3493 Note that this is a global option, we can't
3494 have one FEC in standard MII mode and another in RMII mode.
3495
3496 - CONFIG_CRC32_VERIFY
3497 Add a verify option to the crc32 command.
3498 The syntax is:
3499
3500 => crc32 -v <address> <count> <crc32>
3501
3502 Where address/count indicate a memory area
3503 and crc32 is the correct crc32 which the
3504 area should have.
3505
3506 - CONFIG_LOOPW
3507 Add the "loopw" memory command. This only takes effect if
3508 the memory commands are activated globally (CONFIG_CMD_MEMORY).
3509
3510 - CONFIG_MX_CYCLIC
3511 Add the "mdc" and "mwc" memory commands. These are cyclic
3512 "md/mw" commands.
3513 Examples:
3514
3515 => mdc.b 10 4 500
3516 This command will print 4 bytes (10,11,12,13) each 500 ms.
3517
3518 => mwc.l 100 12345678 10
3519 This command will write 12345678 to address 100 all 10 ms.
3520
3521 This only takes effect if the memory commands are activated
3522 globally (CONFIG_CMD_MEMORY).
3523
3524 - CONFIG_SKIP_LOWLEVEL_INIT
3525 [ARM, NDS32, MIPS only] If this variable is defined, then certain
3526 low level initializations (like setting up the memory
3527 controller) are omitted and/or U-Boot does not
3528 relocate itself into RAM.
3529
3530 Normally this variable MUST NOT be defined. The only
3531 exception is when U-Boot is loaded (to RAM) by some
3532 other boot loader or by a debugger which performs
3533 these initializations itself.
3534
3535 - CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3536 [ARM926EJ-S only] This allows just the call to lowlevel_init()
3537 to be skipped. The normal CP15 init (such as enabling the
3538 instruction cache) is still performed.
3539
3540 - CONFIG_SPL_BUILD
3541 Modifies the behaviour of start.S when compiling a loader
3542 that is executed before the actual U-Boot. E.g. when
3543 compiling a NAND SPL.
3544
3545 - CONFIG_TPL_BUILD
3546 Modifies the behaviour of start.S when compiling a loader
3547 that is executed after the SPL and before the actual U-Boot.
3548 It is loaded by the SPL.
3549
3550 - CONFIG_SYS_MPC85XX_NO_RESETVEC
3551 Only for 85xx systems. If this variable is specified, the section
3552 .resetvec is not kept and the section .bootpg is placed in the
3553 previous 4k of the .text section.
3554
3555 - CONFIG_ARCH_MAP_SYSMEM
3556 Generally U-Boot (and in particular the md command) uses
3557 effective address. It is therefore not necessary to regard
3558 U-Boot address as virtual addresses that need to be translated
3559 to physical addresses. However, sandbox requires this, since
3560 it maintains its own little RAM buffer which contains all
3561 addressable memory. This option causes some memory accesses
3562 to be mapped through map_sysmem() / unmap_sysmem().
3563
3564 - CONFIG_X86_RESET_VECTOR
3565 If defined, the x86 reset vector code is included. This is not
3566 needed when U-Boot is running from Coreboot.
3567
3568 - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3569 Enables the RTC32K OSC on AM33xx based plattforms
3570
3571 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3572 Option to disable subpage write in NAND driver
3573 driver that uses this:
3574 drivers/mtd/nand/davinci_nand.c
3575
3576 Freescale QE/FMAN Firmware Support:
3577 -----------------------------------
3578
3579 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3580 loading of "firmware", which is encoded in the QE firmware binary format.
3581 This firmware often needs to be loaded during U-Boot booting, so macros
3582 are used to identify the storage device (NOR flash, SPI, etc) and the address
3583 within that device.
3584
3585 - CONFIG_SYS_FMAN_FW_ADDR
3586 The address in the storage device where the FMAN microcode is located. The
3587 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3588 is also specified.
3589
3590 - CONFIG_SYS_QE_FW_ADDR
3591 The address in the storage device where the QE microcode is located. The
3592 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3593 is also specified.
3594
3595 - CONFIG_SYS_QE_FMAN_FW_LENGTH
3596 The maximum possible size of the firmware. The firmware binary format
3597 has a field that specifies the actual size of the firmware, but it
3598 might not be possible to read any part of the firmware unless some
3599 local storage is allocated to hold the entire firmware first.
3600
3601 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
3602 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3603 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3604 virtual address in NOR flash.
3605
3606 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
3607 Specifies that QE/FMAN firmware is located in NAND flash.
3608 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3609
3610 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
3611 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3612 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3613
3614 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3615 Specifies that QE/FMAN firmware is located in the remote (master)
3616 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3617 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3618 window->master inbound window->master LAW->the ucode address in
3619 master's memory space.
3620
3621 Freescale Layerscape Management Complex Firmware Support:
3622 ---------------------------------------------------------
3623 The Freescale Layerscape Management Complex (MC) supports the loading of
3624 "firmware".
3625 This firmware often needs to be loaded during U-Boot booting, so macros
3626 are used to identify the storage device (NOR flash, SPI, etc) and the address
3627 within that device.
3628
3629 - CONFIG_FSL_MC_ENET
3630 Enable the MC driver for Layerscape SoCs.
3631
3632 Freescale Layerscape Debug Server Support:
3633 -------------------------------------------
3634 The Freescale Layerscape Debug Server Support supports the loading of
3635 "Debug Server firmware" and triggering SP boot-rom.
3636 This firmware often needs to be loaded during U-Boot booting.
3637
3638 - CONFIG_SYS_MC_RSV_MEM_ALIGN
3639 Define alignment of reserved memory MC requires
3640
3641 Reproducible builds
3642 -------------------
3643
3644 In order to achieve reproducible builds, timestamps used in the U-Boot build
3645 process have to be set to a fixed value.
3646
3647 This is done using the SOURCE_DATE_EPOCH environment variable.
3648 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3649 option for U-Boot or an environment variable in U-Boot.
3650
3651 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3652
3653 Building the Software:
3654 ======================
3655
3656 Building U-Boot has been tested in several native build environments
3657 and in many different cross environments. Of course we cannot support
3658 all possibly existing versions of cross development tools in all
3659 (potentially obsolete) versions. In case of tool chain problems we
3660 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3661 which is extensively used to build and test U-Boot.
3662
3663 If you are not using a native environment, it is assumed that you
3664 have GNU cross compiling tools available in your path. In this case,
3665 you must set the environment variable CROSS_COMPILE in your shell.
3666 Note that no changes to the Makefile or any other source files are
3667 necessary. For example using the ELDK on a 4xx CPU, please enter:
3668
3669 $ CROSS_COMPILE=ppc_4xx-
3670 $ export CROSS_COMPILE
3671
3672 Note: If you wish to generate Windows versions of the utilities in
3673 the tools directory you can use the MinGW toolchain
3674 (http://www.mingw.org). Set your HOST tools to the MinGW
3675 toolchain and execute 'make tools'. For example:
3676
3677 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3678
3679 Binaries such as tools/mkimage.exe will be created which can
3680 be executed on computers running Windows.
3681
3682 U-Boot is intended to be simple to build. After installing the
3683 sources you must configure U-Boot for one specific board type. This
3684 is done by typing:
3685
3686 make NAME_defconfig
3687
3688 where "NAME_defconfig" is the name of one of the existing configu-
3689 rations; see boards.cfg for supported names.
3690
3691 Note: for some board special configuration names may exist; check if
3692 additional information is available from the board vendor; for
3693 instance, the TQM823L systems are available without (standard)
3694 or with LCD support. You can select such additional "features"
3695 when choosing the configuration, i. e.
3696
3697 make TQM823L_defconfig
3698 - will configure for a plain TQM823L, i. e. no LCD support
3699
3700 make TQM823L_LCD_defconfig
3701 - will configure for a TQM823L with U-Boot console on LCD
3702
3703 etc.
3704
3705
3706 Finally, type "make all", and you should get some working U-Boot
3707 images ready for download to / installation on your system:
3708
3709 - "u-boot.bin" is a raw binary image
3710 - "u-boot" is an image in ELF binary format
3711 - "u-boot.srec" is in Motorola S-Record format
3712
3713 By default the build is performed locally and the objects are saved
3714 in the source directory. One of the two methods can be used to change
3715 this behavior and build U-Boot to some external directory:
3716
3717 1. Add O= to the make command line invocations:
3718
3719 make O=/tmp/build distclean
3720 make O=/tmp/build NAME_defconfig
3721 make O=/tmp/build all
3722
3723 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
3724
3725 export KBUILD_OUTPUT=/tmp/build
3726 make distclean
3727 make NAME_defconfig
3728 make all
3729
3730 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
3731 variable.
3732
3733
3734 Please be aware that the Makefiles assume you are using GNU make, so
3735 for instance on NetBSD you might need to use "gmake" instead of
3736 native "make".
3737
3738
3739 If the system board that you have is not listed, then you will need
3740 to port U-Boot to your hardware platform. To do this, follow these
3741 steps:
3742
3743 1. Create a new directory to hold your board specific code. Add any
3744 files you need. In your board directory, you will need at least
3745 the "Makefile" and a "<board>.c".
3746 2. Create a new configuration file "include/configs/<board>.h" for
3747 your board.
3748 3. If you're porting U-Boot to a new CPU, then also create a new
3749 directory to hold your CPU specific code. Add any files you need.
3750 4. Run "make <board>_defconfig" with your new name.
3751 5. Type "make", and you should get a working "u-boot.srec" file
3752 to be installed on your target system.
3753 6. Debug and solve any problems that might arise.
3754 [Of course, this last step is much harder than it sounds.]
3755
3756
3757 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3758 ==============================================================
3759
3760 If you have modified U-Boot sources (for instance added a new board
3761 or support for new devices, a new CPU, etc.) you are expected to
3762 provide feedback to the other developers. The feedback normally takes
3763 the form of a "patch", i. e. a context diff against a certain (latest
3764 official or latest in the git repository) version of U-Boot sources.
3765
3766 But before you submit such a patch, please verify that your modifi-
3767 cation did not break existing code. At least make sure that *ALL* of
3768 the supported boards compile WITHOUT ANY compiler warnings. To do so,
3769 just run the buildman script (tools/buildman/buildman), which will
3770 configure and build U-Boot for ALL supported system. Be warned, this
3771 will take a while. Please see the buildman README, or run 'buildman -H'
3772 for documentation.
3773
3774
3775 See also "U-Boot Porting Guide" below.
3776
3777
3778 Monitor Commands - Overview:
3779 ============================
3780
3781 go - start application at address 'addr'
3782 run - run commands in an environment variable
3783 bootm - boot application image from memory
3784 bootp - boot image via network using BootP/TFTP protocol
3785 bootz - boot zImage from memory
3786 tftpboot- boot image via network using TFTP protocol
3787 and env variables "ipaddr" and "serverip"
3788 (and eventually "gatewayip")
3789 tftpput - upload a file via network using TFTP protocol
3790 rarpboot- boot image via network using RARP/TFTP protocol
3791 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3792 loads - load S-Record file over serial line
3793 loadb - load binary file over serial line (kermit mode)
3794 md - memory display
3795 mm - memory modify (auto-incrementing)
3796 nm - memory modify (constant address)
3797 mw - memory write (fill)
3798 cp - memory copy
3799 cmp - memory compare
3800 crc32 - checksum calculation
3801 i2c - I2C sub-system
3802 sspi - SPI utility commands
3803 base - print or set address offset
3804 printenv- print environment variables
3805 setenv - set environment variables
3806 saveenv - save environment variables to persistent storage
3807 protect - enable or disable FLASH write protection
3808 erase - erase FLASH memory
3809 flinfo - print FLASH memory information
3810 nand - NAND memory operations (see doc/README.nand)
3811 bdinfo - print Board Info structure
3812 iminfo - print header information for application image
3813 coninfo - print console devices and informations
3814 ide - IDE sub-system
3815 loop - infinite loop on address range
3816 loopw - infinite write loop on address range
3817 mtest - simple RAM test
3818 icache - enable or disable instruction cache
3819 dcache - enable or disable data cache
3820 reset - Perform RESET of the CPU
3821 echo - echo args to console
3822 version - print monitor version
3823 help - print online help
3824 ? - alias for 'help'
3825
3826
3827 Monitor Commands - Detailed Description:
3828 ========================================
3829
3830 TODO.
3831
3832 For now: just type "help <command>".
3833
3834
3835 Environment Variables:
3836 ======================
3837
3838 U-Boot supports user configuration using Environment Variables which
3839 can be made persistent by saving to Flash memory.
3840
3841 Environment Variables are set using "setenv", printed using
3842 "printenv", and saved to Flash using "saveenv". Using "setenv"
3843 without a value can be used to delete a variable from the
3844 environment. As long as you don't save the environment you are
3845 working with an in-memory copy. In case the Flash area containing the
3846 environment is erased by accident, a default environment is provided.
3847
3848 Some configuration options can be set using Environment Variables.
3849
3850 List of environment variables (most likely not complete):
3851
3852 baudrate - see CONFIG_BAUDRATE
3853
3854 bootdelay - see CONFIG_BOOTDELAY
3855
3856 bootcmd - see CONFIG_BOOTCOMMAND
3857
3858 bootargs - Boot arguments when booting an RTOS image
3859
3860 bootfile - Name of the image to load with TFTP
3861
3862 bootm_low - Memory range available for image processing in the bootm
3863 command can be restricted. This variable is given as
3864 a hexadecimal number and defines lowest address allowed
3865 for use by the bootm command. See also "bootm_size"
3866 environment variable. Address defined by "bootm_low" is
3867 also the base of the initial memory mapping for the Linux
3868 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3869 bootm_mapsize.
3870
3871 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3872 This variable is given as a hexadecimal number and it
3873 defines the size of the memory region starting at base
3874 address bootm_low that is accessible by the Linux kernel
3875 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3876 as the default value if it is defined, and bootm_size is
3877 used otherwise.
3878
3879 bootm_size - Memory range available for image processing in the bootm
3880 command can be restricted. This variable is given as
3881 a hexadecimal number and defines the size of the region
3882 allowed for use by the bootm command. See also "bootm_low"
3883 environment variable.
3884
3885 updatefile - Location of the software update file on a TFTP server, used
3886 by the automatic software update feature. Please refer to
3887 documentation in doc/README.update for more details.
3888
3889 autoload - if set to "no" (any string beginning with 'n'),
3890 "bootp" will just load perform a lookup of the
3891 configuration from the BOOTP server, but not try to
3892 load any image using TFTP
3893
3894 autostart - if set to "yes", an image loaded using the "bootp",
3895 "rarpboot", "tftpboot" or "diskboot" commands will
3896 be automatically started (by internally calling
3897 "bootm")
3898
3899 If set to "no", a standalone image passed to the
3900 "bootm" command will be copied to the load address
3901 (and eventually uncompressed), but NOT be started.
3902 This can be used to load and uncompress arbitrary
3903 data.
3904
3905 fdt_high - if set this restricts the maximum address that the
3906 flattened device tree will be copied into upon boot.
3907 For example, if you have a system with 1 GB memory
3908 at physical address 0x10000000, while Linux kernel
3909 only recognizes the first 704 MB as low memory, you
3910 may need to set fdt_high as 0x3C000000 to have the
3911 device tree blob be copied to the maximum address
3912 of the 704 MB low memory, so that Linux kernel can
3913 access it during the boot procedure.
3914
3915 If this is set to the special value 0xFFFFFFFF then
3916 the fdt will not be copied at all on boot. For this
3917 to work it must reside in writable memory, have
3918 sufficient padding on the end of it for u-boot to
3919 add the information it needs into it, and the memory
3920 must be accessible by the kernel.
3921
3922 fdtcontroladdr- if set this is the address of the control flattened
3923 device tree used by U-Boot when CONFIG_OF_CONTROL is
3924 defined.
3925
3926 i2cfast - (PPC405GP|PPC405EP only)
3927 if set to 'y' configures Linux I2C driver for fast
3928 mode (400kHZ). This environment variable is used in
3929 initialization code. So, for changes to be effective
3930 it must be saved and board must be reset.
3931
3932 initrd_high - restrict positioning of initrd images:
3933 If this variable is not set, initrd images will be
3934 copied to the highest possible address in RAM; this
3935 is usually what you want since it allows for
3936 maximum initrd size. If for some reason you want to
3937 make sure that the initrd image is loaded below the
3938 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3939 variable to a value of "no" or "off" or "0".
3940 Alternatively, you can set it to a maximum upper
3941 address to use (U-Boot will still check that it
3942 does not overwrite the U-Boot stack and data).
3943
3944 For instance, when you have a system with 16 MB
3945 RAM, and want to reserve 4 MB from use by Linux,
3946 you can do this by adding "mem=12M" to the value of
3947 the "bootargs" variable. However, now you must make
3948 sure that the initrd image is placed in the first
3949 12 MB as well - this can be done with
3950
3951 setenv initrd_high 00c00000
3952
3953 If you set initrd_high to 0xFFFFFFFF, this is an
3954 indication to U-Boot that all addresses are legal
3955 for the Linux kernel, including addresses in flash
3956 memory. In this case U-Boot will NOT COPY the
3957 ramdisk at all. This may be useful to reduce the
3958 boot time on your system, but requires that this
3959 feature is supported by your Linux kernel.
3960
3961 ipaddr - IP address; needed for tftpboot command
3962
3963 loadaddr - Default load address for commands like "bootp",
3964 "rarpboot", "tftpboot", "loadb" or "diskboot"
3965
3966 loads_echo - see CONFIG_LOADS_ECHO
3967
3968 serverip - TFTP server IP address; needed for tftpboot command
3969
3970 bootretry - see CONFIG_BOOT_RETRY_TIME
3971
3972 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
3973
3974 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
3975
3976 ethprime - controls which interface is used first.
3977
3978 ethact - controls which interface is currently active.
3979 For example you can do the following
3980
3981 => setenv ethact FEC
3982 => ping 192.168.0.1 # traffic sent on FEC
3983 => setenv ethact SCC
3984 => ping 10.0.0.1 # traffic sent on SCC
3985
3986 ethrotate - When set to "no" U-Boot does not go through all
3987 available network interfaces.
3988 It just stays at the currently selected interface.
3989
3990 netretry - When set to "no" each network operation will
3991 either succeed or fail without retrying.
3992 When set to "once" the network operation will
3993 fail when all the available network interfaces
3994 are tried once without success.
3995 Useful on scripts which control the retry operation
3996 themselves.
3997
3998 npe_ucode - set load address for the NPE microcode
3999
4000 silent_linux - If set then Linux will be told to boot silently, by
4001 changing the console to be empty. If "yes" it will be
4002 made silent. If "no" it will not be made silent. If
4003 unset, then it will be made silent if the U-Boot console
4004 is silent.
4005
4006 tftpsrcp - If this is set, the value is used for TFTP's
4007 UDP source port.
4008
4009 tftpdstp - If this is set, the value is used for TFTP's UDP
4010 destination port instead of the Well Know Port 69.
4011
4012 tftpblocksize - Block size to use for TFTP transfers; if not set,
4013 we use the TFTP server's default block size
4014
4015 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4016 seconds, minimum value is 1000 = 1 second). Defines
4017 when a packet is considered to be lost so it has to
4018 be retransmitted. The default is 5000 = 5 seconds.
4019 Lowering this value may make downloads succeed
4020 faster in networks with high packet loss rates or
4021 with unreliable TFTP servers.
4022
4023 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4024 unit, minimum value = 0). Defines how many timeouts
4025 can happen during a single file transfer before that
4026 transfer is aborted. The default is 10, and 0 means
4027 'no timeouts allowed'. Increasing this value may help
4028 downloads succeed with high packet loss rates, or with
4029 unreliable TFTP servers or client hardware.
4030
4031 vlan - When set to a value < 4095 the traffic over
4032 Ethernet is encapsulated/received over 802.1q
4033 VLAN tagged frames.
4034
4035 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4036 Unsigned value, in milliseconds. If not set, the period will
4037 be either the default (28000), or a value based on
4038 CONFIG_NET_RETRY_COUNT, if defined. This value has
4039 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4040
4041 The following image location variables contain the location of images
4042 used in booting. The "Image" column gives the role of the image and is
4043 not an environment variable name. The other columns are environment
4044 variable names. "File Name" gives the name of the file on a TFTP
4045 server, "RAM Address" gives the location in RAM the image will be
4046 loaded to, and "Flash Location" gives the image's address in NOR
4047 flash or offset in NAND flash.
4048
4049 *Note* - these variables don't have to be defined for all boards, some
4050 boards currently use other variables for these purposes, and some
4051 boards use these variables for other purposes.
4052
4053 Image File Name RAM Address Flash Location
4054 ----- --------- ----------- --------------
4055 u-boot u-boot u-boot_addr_r u-boot_addr
4056 Linux kernel bootfile kernel_addr_r kernel_addr
4057 device tree blob fdtfile fdt_addr_r fdt_addr
4058 ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
4059
4060 The following environment variables may be used and automatically
4061 updated by the network boot commands ("bootp" and "rarpboot"),
4062 depending the information provided by your boot server:
4063
4064 bootfile - see above
4065 dnsip - IP address of your Domain Name Server
4066 dnsip2 - IP address of your secondary Domain Name Server
4067 gatewayip - IP address of the Gateway (Router) to use
4068 hostname - Target hostname
4069 ipaddr - see above
4070 netmask - Subnet Mask
4071 rootpath - Pathname of the root filesystem on the NFS server
4072 serverip - see above
4073
4074
4075 There are two special Environment Variables:
4076
4077 serial# - contains hardware identification information such
4078 as type string and/or serial number
4079 ethaddr - Ethernet address
4080
4081 These variables can be set only once (usually during manufacturing of
4082 the board). U-Boot refuses to delete or overwrite these variables
4083 once they have been set once.
4084
4085
4086 Further special Environment Variables:
4087
4088 ver - Contains the U-Boot version string as printed
4089 with the "version" command. This variable is
4090 readonly (see CONFIG_VERSION_VARIABLE).
4091
4092
4093 Please note that changes to some configuration parameters may take
4094 only effect after the next boot (yes, that's just like Windoze :-).
4095
4096
4097 Callback functions for environment variables:
4098 ---------------------------------------------
4099
4100 For some environment variables, the behavior of u-boot needs to change
4101 when their values are changed. This functionality allows functions to
4102 be associated with arbitrary variables. On creation, overwrite, or
4103 deletion, the callback will provide the opportunity for some side
4104 effect to happen or for the change to be rejected.
4105
4106 The callbacks are named and associated with a function using the
4107 U_BOOT_ENV_CALLBACK macro in your board or driver code.
4108
4109 These callbacks are associated with variables in one of two ways. The
4110 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4111 in the board configuration to a string that defines a list of
4112 associations. The list must be in the following format:
4113
4114 entry = variable_name[:callback_name]
4115 list = entry[,list]
4116
4117 If the callback name is not specified, then the callback is deleted.
4118 Spaces are also allowed anywhere in the list.
4119
4120 Callbacks can also be associated by defining the ".callbacks" variable
4121 with the same list format above. Any association in ".callbacks" will
4122 override any association in the static list. You can define
4123 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4124 ".callbacks" environment variable in the default or embedded environment.
4125
4126 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4127 regular expression. This allows multiple variables to be connected to
4128 the same callback without explicitly listing them all out.
4129
4130
4131 Command Line Parsing:
4132 =====================
4133
4134 There are two different command line parsers available with U-Boot:
4135 the old "simple" one, and the much more powerful "hush" shell:
4136
4137 Old, simple command line parser:
4138 --------------------------------
4139
4140 - supports environment variables (through setenv / saveenv commands)
4141 - several commands on one line, separated by ';'
4142 - variable substitution using "... ${name} ..." syntax
4143 - special characters ('$', ';') can be escaped by prefixing with '\',
4144 for example:
4145 setenv bootcmd bootm \${address}
4146 - You can also escape text by enclosing in single apostrophes, for example:
4147 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4148
4149 Hush shell:
4150 -----------
4151
4152 - similar to Bourne shell, with control structures like
4153 if...then...else...fi, for...do...done; while...do...done,
4154 until...do...done, ...
4155 - supports environment ("global") variables (through setenv / saveenv
4156 commands) and local shell variables (through standard shell syntax
4157 "name=value"); only environment variables can be used with "run"
4158 command
4159
4160 General rules:
4161 --------------
4162
4163 (1) If a command line (or an environment variable executed by a "run"
4164 command) contains several commands separated by semicolon, and
4165 one of these commands fails, then the remaining commands will be
4166 executed anyway.
4167
4168 (2) If you execute several variables with one call to run (i. e.
4169 calling run with a list of variables as arguments), any failing
4170 command will cause "run" to terminate, i. e. the remaining
4171 variables are not executed.
4172
4173 Note for Redundant Ethernet Interfaces:
4174 =======================================
4175
4176 Some boards come with redundant Ethernet interfaces; U-Boot supports
4177 such configurations and is capable of automatic selection of a
4178 "working" interface when needed. MAC assignment works as follows:
4179
4180 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4181 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4182 "eth1addr" (=>eth1), "eth2addr", ...
4183
4184 If the network interface stores some valid MAC address (for instance
4185 in SROM), this is used as default address if there is NO correspon-
4186 ding setting in the environment; if the corresponding environment
4187 variable is set, this overrides the settings in the card; that means:
4188
4189 o If the SROM has a valid MAC address, and there is no address in the
4190 environment, the SROM's address is used.
4191
4192 o If there is no valid address in the SROM, and a definition in the
4193 environment exists, then the value from the environment variable is
4194 used.
4195
4196 o If both the SROM and the environment contain a MAC address, and
4197 both addresses are the same, this MAC address is used.
4198
4199 o If both the SROM and the environment contain a MAC address, and the
4200 addresses differ, the value from the environment is used and a
4201 warning is printed.
4202
4203 o If neither SROM nor the environment contain a MAC address, an error
4204 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4205 a random, locally-assigned MAC is used.
4206
4207 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4208 will be programmed into hardware as part of the initialization process. This
4209 may be skipped by setting the appropriate 'ethmacskip' environment variable.
4210 The naming convention is as follows:
4211 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4212
4213 Image Formats:
4214 ==============
4215
4216 U-Boot is capable of booting (and performing other auxiliary operations on)
4217 images in two formats:
4218
4219 New uImage format (FIT)
4220 -----------------------
4221
4222 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4223 to Flattened Device Tree). It allows the use of images with multiple
4224 components (several kernels, ramdisks, etc.), with contents protected by
4225 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4226
4227
4228 Old uImage format
4229 -----------------
4230
4231 Old image format is based on binary files which can be basically anything,
4232 preceded by a special header; see the definitions in include/image.h for
4233 details; basically, the header defines the following image properties:
4234
4235 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4236 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4237 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4238 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4239 INTEGRITY).
4240 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
4241 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4242 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4243 * Compression Type (uncompressed, gzip, bzip2)
4244 * Load Address
4245 * Entry Point
4246 * Image Name
4247 * Image Timestamp
4248
4249 The header is marked by a special Magic Number, and both the header
4250 and the data portions of the image are secured against corruption by
4251 CRC32 checksums.
4252
4253
4254 Linux Support:
4255 ==============
4256
4257 Although U-Boot should support any OS or standalone application
4258 easily, the main focus has always been on Linux during the design of
4259 U-Boot.
4260
4261 U-Boot includes many features that so far have been part of some
4262 special "boot loader" code within the Linux kernel. Also, any
4263 "initrd" images to be used are no longer part of one big Linux image;
4264 instead, kernel and "initrd" are separate images. This implementation
4265 serves several purposes:
4266
4267 - the same features can be used for other OS or standalone
4268 applications (for instance: using compressed images to reduce the
4269 Flash memory footprint)
4270
4271 - it becomes much easier to port new Linux kernel versions because
4272 lots of low-level, hardware dependent stuff are done by U-Boot
4273
4274 - the same Linux kernel image can now be used with different "initrd"
4275 images; of course this also means that different kernel images can
4276 be run with the same "initrd". This makes testing easier (you don't
4277 have to build a new "zImage.initrd" Linux image when you just
4278 change a file in your "initrd"). Also, a field-upgrade of the
4279 software is easier now.
4280
4281
4282 Linux HOWTO:
4283 ============
4284
4285 Porting Linux to U-Boot based systems:
4286 ---------------------------------------
4287
4288 U-Boot cannot save you from doing all the necessary modifications to
4289 configure the Linux device drivers for use with your target hardware
4290 (no, we don't intend to provide a full virtual machine interface to
4291 Linux :-).
4292
4293 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4294
4295 Just make sure your machine specific header file (for instance
4296 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
4297 Information structure as we define in include/asm-<arch>/u-boot.h,
4298 and make sure that your definition of IMAP_ADDR uses the same value
4299 as your U-Boot configuration in CONFIG_SYS_IMMR.
4300
4301 Note that U-Boot now has a driver model, a unified model for drivers.
4302 If you are adding a new driver, plumb it into driver model. If there
4303 is no uclass available, you are encouraged to create one. See
4304 doc/driver-model.
4305
4306
4307 Configuring the Linux kernel:
4308 -----------------------------
4309
4310 No specific requirements for U-Boot. Make sure you have some root
4311 device (initial ramdisk, NFS) for your target system.
4312
4313
4314 Building a Linux Image:
4315 -----------------------
4316
4317 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4318 not used. If you use recent kernel source, a new build target
4319 "uImage" will exist which automatically builds an image usable by
4320 U-Boot. Most older kernels also have support for a "pImage" target,
4321 which was introduced for our predecessor project PPCBoot and uses a
4322 100% compatible format.
4323
4324 Example:
4325
4326 make TQM850L_defconfig
4327 make oldconfig
4328 make dep
4329 make uImage
4330
4331 The "uImage" build target uses a special tool (in 'tools/mkimage') to
4332 encapsulate a compressed Linux kernel image with header information,
4333 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
4334
4335 * build a standard "vmlinux" kernel image (in ELF binary format):
4336
4337 * convert the kernel into a raw binary image:
4338
4339 ${CROSS_COMPILE}-objcopy -O binary \
4340 -R .note -R .comment \
4341 -S vmlinux linux.bin
4342
4343 * compress the binary image:
4344
4345 gzip -9 linux.bin
4346
4347 * package compressed binary image for U-Boot:
4348
4349 mkimage -A ppc -O linux -T kernel -C gzip \
4350 -a 0 -e 0 -n "Linux Kernel Image" \
4351 -d linux.bin.gz uImage
4352
4353
4354 The "mkimage" tool can also be used to create ramdisk images for use
4355 with U-Boot, either separated from the Linux kernel image, or
4356 combined into one file. "mkimage" encapsulates the images with a 64
4357 byte header containing information about target architecture,
4358 operating system, image type, compression method, entry points, time
4359 stamp, CRC32 checksums, etc.
4360
4361 "mkimage" can be called in two ways: to verify existing images and
4362 print the header information, or to build new images.
4363
4364 In the first form (with "-l" option) mkimage lists the information
4365 contained in the header of an existing U-Boot image; this includes
4366 checksum verification:
4367
4368 tools/mkimage -l image
4369 -l ==> list image header information
4370
4371 The second form (with "-d" option) is used to build a U-Boot image
4372 from a "data file" which is used as image payload:
4373
4374 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4375 -n name -d data_file image
4376 -A ==> set architecture to 'arch'
4377 -O ==> set operating system to 'os'
4378 -T ==> set image type to 'type'
4379 -C ==> set compression type 'comp'
4380 -a ==> set load address to 'addr' (hex)
4381 -e ==> set entry point to 'ep' (hex)
4382 -n ==> set image name to 'name'
4383 -d ==> use image data from 'datafile'
4384
4385 Right now, all Linux kernels for PowerPC systems use the same load
4386 address (0x00000000), but the entry point address depends on the
4387 kernel version:
4388
4389 - 2.2.x kernels have the entry point at 0x0000000C,
4390 - 2.3.x and later kernels have the entry point at 0x00000000.
4391
4392 So a typical call to build a U-Boot image would read:
4393
4394 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4395 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4396 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
4397 > examples/uImage.TQM850L
4398 Image Name: 2.4.4 kernel for TQM850L
4399 Created: Wed Jul 19 02:34:59 2000
4400 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4401 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4402 Load Address: 0x00000000
4403 Entry Point: 0x00000000
4404
4405 To verify the contents of the image (or check for corruption):
4406
4407 -> tools/mkimage -l examples/uImage.TQM850L
4408 Image Name: 2.4.4 kernel for TQM850L
4409 Created: Wed Jul 19 02:34:59 2000
4410 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4411 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4412 Load Address: 0x00000000
4413 Entry Point: 0x00000000
4414
4415 NOTE: for embedded systems where boot time is critical you can trade
4416 speed for memory and install an UNCOMPRESSED image instead: this
4417 needs more space in Flash, but boots much faster since it does not
4418 need to be uncompressed:
4419
4420 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
4421 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4422 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4423 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
4424 > examples/uImage.TQM850L-uncompressed
4425 Image Name: 2.4.4 kernel for TQM850L
4426 Created: Wed Jul 19 02:34:59 2000
4427 Image Type: PowerPC Linux Kernel Image (uncompressed)
4428 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4429 Load Address: 0x00000000
4430 Entry Point: 0x00000000
4431
4432
4433 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4434 when your kernel is intended to use an initial ramdisk:
4435
4436 -> tools/mkimage -n 'Simple Ramdisk Image' \
4437 > -A ppc -O linux -T ramdisk -C gzip \
4438 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4439 Image Name: Simple Ramdisk Image
4440 Created: Wed Jan 12 14:01:50 2000
4441 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4442 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4443 Load Address: 0x00000000
4444 Entry Point: 0x00000000
4445
4446 The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4447 option performs the converse operation of the mkimage's second form (the "-d"
4448 option). Given an image built by mkimage, the dumpimage extracts a "data file"
4449 from the image:
4450
4451 tools/dumpimage -i image -T type -p position data_file
4452 -i ==> extract from the 'image' a specific 'data_file'
4453 -T ==> set image type to 'type'
4454 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
4455
4456
4457 Installing a Linux Image:
4458 -------------------------
4459
4460 To downloading a U-Boot image over the serial (console) interface,
4461 you must convert the image to S-Record format:
4462
4463 objcopy -I binary -O srec examples/image examples/image.srec
4464
4465 The 'objcopy' does not understand the information in the U-Boot
4466 image header, so the resulting S-Record file will be relative to
4467 address 0x00000000. To load it to a given address, you need to
4468 specify the target address as 'offset' parameter with the 'loads'
4469 command.
4470
4471 Example: install the image to address 0x40100000 (which on the
4472 TQM8xxL is in the first Flash bank):
4473
4474 => erase 40100000 401FFFFF
4475
4476 .......... done
4477 Erased 8 sectors
4478
4479 => loads 40100000
4480 ## Ready for S-Record download ...
4481 ~>examples/image.srec
4482 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4483 ...
4484 15989 15990 15991 15992
4485 [file transfer complete]
4486 [connected]
4487 ## Start Addr = 0x00000000
4488
4489
4490 You can check the success of the download using the 'iminfo' command;
4491 this includes a checksum verification so you can be sure no data
4492 corruption happened:
4493
4494 => imi 40100000
4495
4496 ## Checking Image at 40100000 ...
4497 Image Name: 2.2.13 for initrd on TQM850L
4498 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4499 Data Size: 335725 Bytes = 327 kB = 0 MB
4500 Load Address: 00000000
4501 Entry Point: 0000000c
4502 Verifying Checksum ... OK
4503
4504
4505 Boot Linux:
4506 -----------
4507
4508 The "bootm" command is used to boot an application that is stored in
4509 memory (RAM or Flash). In case of a Linux kernel image, the contents
4510 of the "bootargs" environment variable is passed to the kernel as
4511 parameters. You can check and modify this variable using the
4512 "printenv" and "setenv" commands:
4513
4514
4515 => printenv bootargs
4516 bootargs=root=/dev/ram
4517
4518 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4519
4520 => printenv bootargs
4521 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4522
4523 => bootm 40020000
4524 ## Booting Linux kernel at 40020000 ...
4525 Image Name: 2.2.13 for NFS on TQM850L
4526 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4527 Data Size: 381681 Bytes = 372 kB = 0 MB
4528 Load Address: 00000000
4529 Entry Point: 0000000c
4530 Verifying Checksum ... OK
4531 Uncompressing Kernel Image ... OK
4532 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
4533 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4534 time_init: decrementer frequency = 187500000/60
4535 Calibrating delay loop... 49.77 BogoMIPS
4536 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4537 ...
4538
4539 If you want to boot a Linux kernel with initial RAM disk, you pass
4540 the memory addresses of both the kernel and the initrd image (PPBCOOT
4541 format!) to the "bootm" command:
4542
4543 => imi 40100000 40200000
4544
4545 ## Checking Image at 40100000 ...
4546 Image Name: 2.2.13 for initrd on TQM850L
4547 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4548 Data Size: 335725 Bytes = 327 kB = 0 MB
4549 Load Address: 00000000
4550 Entry Point: 0000000c
4551 Verifying Checksum ... OK
4552
4553 ## Checking Image at 40200000 ...
4554 Image Name: Simple Ramdisk Image
4555 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4556 Data Size: 566530 Bytes = 553 kB = 0 MB
4557 Load Address: 00000000
4558 Entry Point: 00000000
4559 Verifying Checksum ... OK
4560
4561 => bootm 40100000 40200000
4562 ## Booting Linux kernel at 40100000 ...
4563 Image Name: 2.2.13 for initrd on TQM850L
4564 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4565 Data Size: 335725 Bytes = 327 kB = 0 MB
4566 Load Address: 00000000
4567 Entry Point: 0000000c
4568 Verifying Checksum ... OK
4569 Uncompressing Kernel Image ... OK
4570 ## Loading RAMDisk Image at 40200000 ...
4571 Image Name: Simple Ramdisk Image
4572 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4573 Data Size: 566530 Bytes = 553 kB = 0 MB
4574 Load Address: 00000000
4575 Entry Point: 00000000
4576 Verifying Checksum ... OK
4577 Loading Ramdisk ... OK
4578 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
4579 Boot arguments: root=/dev/ram
4580 time_init: decrementer frequency = 187500000/60
4581 Calibrating delay loop... 49.77 BogoMIPS
4582 ...
4583 RAMDISK: Compressed image found at block 0
4584 VFS: Mounted root (ext2 filesystem).
4585
4586 bash#
4587
4588 Boot Linux and pass a flat device tree:
4589 -----------
4590
4591 First, U-Boot must be compiled with the appropriate defines. See the section
4592 titled "Linux Kernel Interface" above for a more in depth explanation. The
4593 following is an example of how to start a kernel and pass an updated
4594 flat device tree:
4595
4596 => print oftaddr
4597 oftaddr=0x300000
4598 => print oft
4599 oft=oftrees/mpc8540ads.dtb
4600 => tftp $oftaddr $oft
4601 Speed: 1000, full duplex
4602 Using TSEC0 device
4603 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4604 Filename 'oftrees/mpc8540ads.dtb'.
4605 Load address: 0x300000
4606 Loading: #
4607 done
4608 Bytes transferred = 4106 (100a hex)
4609 => tftp $loadaddr $bootfile
4610 Speed: 1000, full duplex
4611 Using TSEC0 device
4612 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4613 Filename 'uImage'.
4614 Load address: 0x200000
4615 Loading:############
4616 done
4617 Bytes transferred = 1029407 (fb51f hex)
4618 => print loadaddr
4619 loadaddr=200000
4620 => print oftaddr
4621 oftaddr=0x300000
4622 => bootm $loadaddr - $oftaddr
4623 ## Booting image at 00200000 ...
4624 Image Name: Linux-2.6.17-dirty
4625 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4626 Data Size: 1029343 Bytes = 1005.2 kB
4627 Load Address: 00000000
4628 Entry Point: 00000000
4629 Verifying Checksum ... OK
4630 Uncompressing Kernel Image ... OK
4631 Booting using flat device tree at 0x300000
4632 Using MPC85xx ADS machine description
4633 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4634 [snip]
4635
4636
4637 More About U-Boot Image Types:
4638 ------------------------------
4639
4640 U-Boot supports the following image types:
4641
4642 "Standalone Programs" are directly runnable in the environment
4643 provided by U-Boot; it is expected that (if they behave
4644 well) you can continue to work in U-Boot after return from
4645 the Standalone Program.
4646 "OS Kernel Images" are usually images of some Embedded OS which
4647 will take over control completely. Usually these programs
4648 will install their own set of exception handlers, device
4649 drivers, set up the MMU, etc. - this means, that you cannot
4650 expect to re-enter U-Boot except by resetting the CPU.
4651 "RAMDisk Images" are more or less just data blocks, and their
4652 parameters (address, size) are passed to an OS kernel that is
4653 being started.
4654 "Multi-File Images" contain several images, typically an OS
4655 (Linux) kernel image and one or more data images like
4656 RAMDisks. This construct is useful for instance when you want
4657 to boot over the network using BOOTP etc., where the boot
4658 server provides just a single image file, but you want to get
4659 for instance an OS kernel and a RAMDisk image.
4660
4661 "Multi-File Images" start with a list of image sizes, each
4662 image size (in bytes) specified by an "uint32_t" in network
4663 byte order. This list is terminated by an "(uint32_t)0".
4664 Immediately after the terminating 0 follow the images, one by
4665 one, all aligned on "uint32_t" boundaries (size rounded up to
4666 a multiple of 4 bytes).
4667
4668 "Firmware Images" are binary images containing firmware (like
4669 U-Boot or FPGA images) which usually will be programmed to
4670 flash memory.
4671
4672 "Script files" are command sequences that will be executed by
4673 U-Boot's command interpreter; this feature is especially
4674 useful when you configure U-Boot to use a real shell (hush)
4675 as command interpreter.
4676
4677 Booting the Linux zImage:
4678 -------------------------
4679
4680 On some platforms, it's possible to boot Linux zImage. This is done
4681 using the "bootz" command. The syntax of "bootz" command is the same
4682 as the syntax of "bootm" command.
4683
4684 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
4685 kernel with raw initrd images. The syntax is slightly different, the
4686 address of the initrd must be augmented by it's size, in the following
4687 format: "<initrd addres>:<initrd size>".
4688
4689
4690 Standalone HOWTO:
4691 =================
4692
4693 One of the features of U-Boot is that you can dynamically load and
4694 run "standalone" applications, which can use some resources of
4695 U-Boot like console I/O functions or interrupt services.
4696
4697 Two simple examples are included with the sources:
4698
4699 "Hello World" Demo:
4700 -------------------
4701
4702 'examples/hello_world.c' contains a small "Hello World" Demo
4703 application; it is automatically compiled when you build U-Boot.
4704 It's configured to run at address 0x00040004, so you can play with it
4705 like that:
4706
4707 => loads
4708 ## Ready for S-Record download ...
4709 ~>examples/hello_world.srec
4710 1 2 3 4 5 6 7 8 9 10 11 ...
4711 [file transfer complete]
4712 [connected]
4713 ## Start Addr = 0x00040004
4714
4715 => go 40004 Hello World! This is a test.
4716 ## Starting application at 0x00040004 ...
4717 Hello World
4718 argc = 7
4719 argv[0] = "40004"
4720 argv[1] = "Hello"
4721 argv[2] = "World!"
4722 argv[3] = "This"
4723 argv[4] = "is"
4724 argv[5] = "a"
4725 argv[6] = "test."
4726 argv[7] = "<NULL>"
4727 Hit any key to exit ...
4728
4729 ## Application terminated, rc = 0x0
4730
4731 Another example, which demonstrates how to register a CPM interrupt
4732 handler with the U-Boot code, can be found in 'examples/timer.c'.
4733 Here, a CPM timer is set up to generate an interrupt every second.
4734 The interrupt service routine is trivial, just printing a '.'
4735 character, but this is just a demo program. The application can be
4736 controlled by the following keys:
4737
4738 ? - print current values og the CPM Timer registers
4739 b - enable interrupts and start timer
4740 e - stop timer and disable interrupts
4741 q - quit application
4742
4743 => loads
4744 ## Ready for S-Record download ...
4745 ~>examples/timer.srec
4746 1 2 3 4 5 6 7 8 9 10 11 ...
4747 [file transfer complete]
4748 [connected]
4749 ## Start Addr = 0x00040004
4750
4751 => go 40004
4752 ## Starting application at 0x00040004 ...
4753 TIMERS=0xfff00980
4754 Using timer 1
4755 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4756
4757 Hit 'b':
4758 [q, b, e, ?] Set interval 1000000 us
4759 Enabling timer
4760 Hit '?':
4761 [q, b, e, ?] ........
4762 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4763 Hit '?':
4764 [q, b, e, ?] .
4765 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4766 Hit '?':
4767 [q, b, e, ?] .
4768 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4769 Hit '?':
4770 [q, b, e, ?] .
4771 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4772 Hit 'e':
4773 [q, b, e, ?] ...Stopping timer
4774 Hit 'q':
4775 [q, b, e, ?] ## Application terminated, rc = 0x0
4776
4777
4778 Minicom warning:
4779 ================
4780
4781 Over time, many people have reported problems when trying to use the
4782 "minicom" terminal emulation program for serial download. I (wd)
4783 consider minicom to be broken, and recommend not to use it. Under
4784 Unix, I recommend to use C-Kermit for general purpose use (and
4785 especially for kermit binary protocol download ("loadb" command), and
4786 use "cu" for S-Record download ("loads" command). See
4787 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4788 for help with kermit.
4789
4790
4791 Nevertheless, if you absolutely want to use it try adding this
4792 configuration to your "File transfer protocols" section:
4793
4794 Name Program Name U/D FullScr IO-Red. Multi
4795 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4796 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
4797
4798
4799 NetBSD Notes:
4800 =============
4801
4802 Starting at version 0.9.2, U-Boot supports NetBSD both as host
4803 (build U-Boot) and target system (boots NetBSD/mpc8xx).
4804
4805 Building requires a cross environment; it is known to work on
4806 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4807 need gmake since the Makefiles are not compatible with BSD make).
4808 Note that the cross-powerpc package does not install include files;
4809 attempting to build U-Boot will fail because <machine/ansi.h> is
4810 missing. This file has to be installed and patched manually:
4811
4812 # cd /usr/pkg/cross/powerpc-netbsd/include
4813 # mkdir powerpc
4814 # ln -s powerpc machine
4815 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4816 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
4817
4818 Native builds *don't* work due to incompatibilities between native
4819 and U-Boot include files.
4820
4821 Booting assumes that (the first part of) the image booted is a
4822 stage-2 loader which in turn loads and then invokes the kernel
4823 proper. Loader sources will eventually appear in the NetBSD source
4824 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
4825 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4826
4827
4828 Implementation Internals:
4829 =========================
4830
4831 The following is not intended to be a complete description of every
4832 implementation detail. However, it should help to understand the
4833 inner workings of U-Boot and make it easier to port it to custom
4834 hardware.
4835
4836
4837 Initial Stack, Global Data:
4838 ---------------------------
4839
4840 The implementation of U-Boot is complicated by the fact that U-Boot
4841 starts running out of ROM (flash memory), usually without access to
4842 system RAM (because the memory controller is not initialized yet).
4843 This means that we don't have writable Data or BSS segments, and BSS
4844 is not initialized as zero. To be able to get a C environment working
4845 at all, we have to allocate at least a minimal stack. Implementation
4846 options for this are defined and restricted by the CPU used: Some CPU
4847 models provide on-chip memory (like the IMMR area on MPC8xx and
4848 MPC826x processors), on others (parts of) the data cache can be
4849 locked as (mis-) used as memory, etc.
4850
4851 Chris Hallinan posted a good summary of these issues to the
4852 U-Boot mailing list:
4853
4854 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4855 From: "Chris Hallinan" <clh@net1plus.com>
4856 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4857 ...
4858
4859 Correct me if I'm wrong, folks, but the way I understand it
4860 is this: Using DCACHE as initial RAM for Stack, etc, does not
4861 require any physical RAM backing up the cache. The cleverness
4862 is that the cache is being used as a temporary supply of
4863 necessary storage before the SDRAM controller is setup. It's
4864 beyond the scope of this list to explain the details, but you
4865 can see how this works by studying the cache architecture and
4866 operation in the architecture and processor-specific manuals.
4867
4868 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4869 is another option for the system designer to use as an
4870 initial stack/RAM area prior to SDRAM being available. Either
4871 option should work for you. Using CS 4 should be fine if your
4872 board designers haven't used it for something that would
4873 cause you grief during the initial boot! It is frequently not
4874 used.
4875
4876 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
4877 with your processor/board/system design. The default value
4878 you will find in any recent u-boot distribution in
4879 walnut.h should work for you. I'd set it to a value larger
4880 than your SDRAM module. If you have a 64MB SDRAM module, set
4881 it above 400_0000. Just make sure your board has no resources
4882 that are supposed to respond to that address! That code in
4883 start.S has been around a while and should work as is when
4884 you get the config right.
4885
4886 -Chris Hallinan
4887 DS4.COM, Inc.
4888
4889 It is essential to remember this, since it has some impact on the C
4890 code for the initialization procedures:
4891
4892 * Initialized global data (data segment) is read-only. Do not attempt
4893 to write it.
4894
4895 * Do not use any uninitialized global data (or implicitly initialized
4896 as zero data - BSS segment) at all - this is undefined, initiali-
4897 zation is performed later (when relocating to RAM).
4898
4899 * Stack space is very limited. Avoid big data buffers or things like
4900 that.
4901
4902 Having only the stack as writable memory limits means we cannot use
4903 normal global data to share information between the code. But it
4904 turned out that the implementation of U-Boot can be greatly
4905 simplified by making a global data structure (gd_t) available to all
4906 functions. We could pass a pointer to this data as argument to _all_
4907 functions, but this would bloat the code. Instead we use a feature of
4908 the GCC compiler (Global Register Variables) to share the data: we
4909 place a pointer (gd) to the global data into a register which we
4910 reserve for this purpose.
4911
4912 When choosing a register for such a purpose we are restricted by the
4913 relevant (E)ABI specifications for the current architecture, and by
4914 GCC's implementation.
4915
4916 For PowerPC, the following registers have specific use:
4917 R1: stack pointer
4918 R2: reserved for system use
4919 R3-R4: parameter passing and return values
4920 R5-R10: parameter passing
4921 R13: small data area pointer
4922 R30: GOT pointer
4923 R31: frame pointer
4924
4925 (U-Boot also uses R12 as internal GOT pointer. r12
4926 is a volatile register so r12 needs to be reset when
4927 going back and forth between asm and C)
4928
4929 ==> U-Boot will use R2 to hold a pointer to the global data
4930
4931 Note: on PPC, we could use a static initializer (since the
4932 address of the global data structure is known at compile time),
4933 but it turned out that reserving a register results in somewhat
4934 smaller code - although the code savings are not that big (on
4935 average for all boards 752 bytes for the whole U-Boot image,
4936 624 text + 127 data).
4937
4938 On ARM, the following registers are used:
4939
4940 R0: function argument word/integer result
4941 R1-R3: function argument word
4942 R9: platform specific
4943 R10: stack limit (used only if stack checking is enabled)
4944 R11: argument (frame) pointer
4945 R12: temporary workspace
4946 R13: stack pointer
4947 R14: link register
4948 R15: program counter
4949
4950 ==> U-Boot will use R9 to hold a pointer to the global data
4951
4952 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
4953
4954 On Nios II, the ABI is documented here:
4955 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4956
4957 ==> U-Boot will use gp to hold a pointer to the global data
4958
4959 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4960 to access small data sections, so gp is free.
4961
4962 On NDS32, the following registers are used:
4963
4964 R0-R1: argument/return
4965 R2-R5: argument
4966 R15: temporary register for assembler
4967 R16: trampoline register
4968 R28: frame pointer (FP)
4969 R29: global pointer (GP)
4970 R30: link register (LP)
4971 R31: stack pointer (SP)
4972 PC: program counter (PC)
4973
4974 ==> U-Boot will use R10 to hold a pointer to the global data
4975
4976 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4977 or current versions of GCC may "optimize" the code too much.
4978
4979 Memory Management:
4980 ------------------
4981
4982 U-Boot runs in system state and uses physical addresses, i.e. the
4983 MMU is not used either for address mapping nor for memory protection.
4984
4985 The available memory is mapped to fixed addresses using the memory
4986 controller. In this process, a contiguous block is formed for each
4987 memory type (Flash, SDRAM, SRAM), even when it consists of several
4988 physical memory banks.
4989
4990 U-Boot is installed in the first 128 kB of the first Flash bank (on
4991 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4992 booting and sizing and initializing DRAM, the code relocates itself
4993 to the upper end of DRAM. Immediately below the U-Boot code some
4994 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4995 configuration setting]. Below that, a structure with global Board
4996 Info data is placed, followed by the stack (growing downward).
4997
4998 Additionally, some exception handler code is copied to the low 8 kB
4999 of DRAM (0x00000000 ... 0x00001FFF).
5000
5001 So a typical memory configuration with 16 MB of DRAM could look like
5002 this:
5003
5004 0x0000 0000 Exception Vector code
5005 :
5006 0x0000 1FFF
5007 0x0000 2000 Free for Application Use
5008 :
5009 :
5010
5011 :
5012 :
5013 0x00FB FF20 Monitor Stack (Growing downward)
5014 0x00FB FFAC Board Info Data and permanent copy of global data
5015 0x00FC 0000 Malloc Arena
5016 :
5017 0x00FD FFFF
5018 0x00FE 0000 RAM Copy of Monitor Code
5019 ... eventually: LCD or video framebuffer
5020 ... eventually: pRAM (Protected RAM - unchanged by reset)
5021 0x00FF FFFF [End of RAM]
5022
5023
5024 System Initialization:
5025 ----------------------
5026
5027 In the reset configuration, U-Boot starts at the reset entry point
5028 (on most PowerPC systems at address 0x00000100). Because of the reset
5029 configuration for CS0# this is a mirror of the on board Flash memory.
5030 To be able to re-map memory U-Boot then jumps to its link address.
5031 To be able to implement the initialization code in C, a (small!)
5032 initial stack is set up in the internal Dual Ported RAM (in case CPUs
5033 which provide such a feature like), or in a locked part of the data
5034 cache. After that, U-Boot initializes the CPU core, the caches and
5035 the SIU.
5036
5037 Next, all (potentially) available memory banks are mapped using a
5038 preliminary mapping. For example, we put them on 512 MB boundaries
5039 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5040 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5041 programmed for SDRAM access. Using the temporary configuration, a
5042 simple memory test is run that determines the size of the SDRAM
5043 banks.
5044
5045 When there is more than one SDRAM bank, and the banks are of
5046 different size, the largest is mapped first. For equal size, the first
5047 bank (CS2#) is mapped first. The first mapping is always for address
5048 0x00000000, with any additional banks following immediately to create
5049 contiguous memory starting from 0.
5050
5051 Then, the monitor installs itself at the upper end of the SDRAM area
5052 and allocates memory for use by malloc() and for the global Board
5053 Info data; also, the exception vector code is copied to the low RAM
5054 pages, and the final stack is set up.
5055
5056 Only after this relocation will you have a "normal" C environment;
5057 until that you are restricted in several ways, mostly because you are
5058 running from ROM, and because the code will have to be relocated to a
5059 new address in RAM.
5060
5061
5062 U-Boot Porting Guide:
5063 ----------------------
5064
5065 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5066 list, October 2002]
5067
5068
5069 int main(int argc, char *argv[])
5070 {
5071 sighandler_t no_more_time;
5072
5073 signal(SIGALRM, no_more_time);
5074 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5075
5076 if (available_money > available_manpower) {
5077 Pay consultant to port U-Boot;
5078 return 0;
5079 }
5080
5081 Download latest U-Boot source;
5082
5083 Subscribe to u-boot mailing list;
5084
5085 if (clueless)
5086 email("Hi, I am new to U-Boot, how do I get started?");
5087
5088 while (learning) {
5089 Read the README file in the top level directory;
5090 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5091 Read applicable doc/*.README;
5092 Read the source, Luke;
5093 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
5094 }
5095
5096 if (available_money > toLocalCurrency ($2500))
5097 Buy a BDI3000;
5098 else
5099 Add a lot of aggravation and time;
5100
5101 if (a similar board exists) { /* hopefully... */
5102 cp -a board/<similar> board/<myboard>
5103 cp include/configs/<similar>.h include/configs/<myboard>.h
5104 } else {
5105 Create your own board support subdirectory;
5106 Create your own board include/configs/<myboard>.h file;
5107 }
5108 Edit new board/<myboard> files
5109 Edit new include/configs/<myboard>.h
5110
5111 while (!accepted) {
5112 while (!running) {
5113 do {
5114 Add / modify source code;
5115 } until (compiles);
5116 Debug;
5117 if (clueless)
5118 email("Hi, I am having problems...");
5119 }
5120 Send patch file to the U-Boot email list;
5121 if (reasonable critiques)
5122 Incorporate improvements from email list code review;
5123 else
5124 Defend code as written;
5125 }
5126
5127 return 0;
5128 }
5129
5130 void no_more_time (int sig)
5131 {
5132 hire_a_guru();
5133 }
5134
5135
5136 Coding Standards:
5137 -----------------
5138
5139 All contributions to U-Boot should conform to the Linux kernel
5140 coding style; see the file "Documentation/CodingStyle" and the script
5141 "scripts/Lindent" in your Linux kernel source directory.
5142
5143 Source files originating from a different project (for example the
5144 MTD subsystem) are generally exempt from these guidelines and are not
5145 reformatted to ease subsequent migration to newer versions of those
5146 sources.
5147
5148 Please note that U-Boot is implemented in C (and to some small parts in
5149 Assembler); no C++ is used, so please do not use C++ style comments (//)
5150 in your code.
5151
5152 Please also stick to the following formatting rules:
5153 - remove any trailing white space
5154 - use TAB characters for indentation and vertical alignment, not spaces
5155 - make sure NOT to use DOS '\r\n' line feeds
5156 - do not add more than 2 consecutive empty lines to source files
5157 - do not add trailing empty lines to source files
5158
5159 Submissions which do not conform to the standards may be returned
5160 with a request to reformat the changes.
5161
5162
5163 Submitting Patches:
5164 -------------------
5165
5166 Since the number of patches for U-Boot is growing, we need to
5167 establish some rules. Submissions which do not conform to these rules
5168 may be rejected, even when they contain important and valuable stuff.
5169
5170 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
5171
5172 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5173 see http://lists.denx.de/mailman/listinfo/u-boot
5174
5175 When you send a patch, please include the following information with
5176 it:
5177
5178 * For bug fixes: a description of the bug and how your patch fixes
5179 this bug. Please try to include a way of demonstrating that the
5180 patch actually fixes something.
5181
5182 * For new features: a description of the feature and your
5183 implementation.
5184
5185 * A CHANGELOG entry as plaintext (separate from the patch)
5186
5187 * For major contributions, add a MAINTAINERS file with your
5188 information and associated file and directory references.
5189
5190 * When you add support for a new board, don't forget to add a
5191 maintainer e-mail address to the boards.cfg file, too.
5192
5193 * If your patch adds new configuration options, don't forget to
5194 document these in the README file.
5195
5196 * The patch itself. If you are using git (which is *strongly*
5197 recommended) you can easily generate the patch using the
5198 "git format-patch". If you then use "git send-email" to send it to
5199 the U-Boot mailing list, you will avoid most of the common problems
5200 with some other mail clients.
5201
5202 If you cannot use git, use "diff -purN OLD NEW". If your version of
5203 diff does not support these options, then get the latest version of
5204 GNU diff.
5205
5206 The current directory when running this command shall be the parent
5207 directory of the U-Boot source tree (i. e. please make sure that
5208 your patch includes sufficient directory information for the
5209 affected files).
5210
5211 We prefer patches as plain text. MIME attachments are discouraged,
5212 and compressed attachments must not be used.
5213
5214 * If one logical set of modifications affects or creates several
5215 files, all these changes shall be submitted in a SINGLE patch file.
5216
5217 * Changesets that contain different, unrelated modifications shall be
5218 submitted as SEPARATE patches, one patch per changeset.
5219
5220
5221 Notes:
5222
5223 * Before sending the patch, run the buildman script on your patched
5224 source tree and make sure that no errors or warnings are reported
5225 for any of the boards.
5226
5227 * Keep your modifications to the necessary minimum: A patch
5228 containing several unrelated changes or arbitrary reformats will be
5229 returned with a request to re-formatting / split it.
5230
5231 * If you modify existing code, make sure that your new code does not
5232 add to the memory footprint of the code ;-) Small is beautiful!
5233 When adding new features, these should compile conditionally only
5234 (using #ifdef), and the resulting code with the new feature
5235 disabled must not need more memory than the old code without your
5236 modification.
5237
5238 * Remember that there is a size limit of 100 kB per message on the
5239 u-boot mailing list. Bigger patches will be moderated. If they are
5240 reasonable and not too big, they will be acknowledged. But patches
5241 bigger than the size limit should be avoided.