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