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