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