Merge branch 'master' of https://source.denx.de/u-boot/custodians/u-boot-spi.git
[platform/kernel/u-boot.git] / README
1 # SPDX-License-Identifier: GPL-2.0+
2 #
3 # (C) Copyright 2000 - 2013
4 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5
6 Summary:
7 ========
8
9 This directory contains the source code for U-Boot, a boot loader for
10 Embedded boards based on PowerPC, ARM, MIPS and several other
11 processors, which can be installed in a boot ROM and used to
12 initialize and test the hardware or to download and run application
13 code.
14
15 The development of U-Boot is closely related to Linux: some parts of
16 the source code originate in the Linux source tree, we have some
17 header files in common, and special provision has been made to
18 support booting of Linux images.
19
20 Some attention has been paid to make this software easily
21 configurable and extendable. For instance, all monitor commands are
22 implemented with the same call interface, so that it's very easy to
23 add new commands. Also, instead of permanently adding rarely used
24 code (for instance hardware test utilities) to the monitor, you can
25 load and run it dynamically.
26
27
28 Status:
29 =======
30
31 In general, all boards for which a configuration option exists in the
32 Makefile have been tested to some extent and can be considered
33 "working". In fact, many of them are used in production systems.
34
35 In case of problems see the CHANGELOG file to find out who contributed
36 the specific port. In addition, there are various MAINTAINERS files
37 scattered throughout the U-Boot source identifying the people or
38 companies responsible for various boards and subsystems.
39
40 Note: As of August, 2010, there is no longer a CHANGELOG file in the
41 actual U-Boot source tree; however, it can be created dynamically
42 from the Git log using:
43
44         make CHANGELOG
45
46
47 Where to get help:
48 ==================
49
50 In case you have questions about, problems with or contributions for
51 U-Boot, you should send a message to the U-Boot mailing list at
52 <u-boot@lists.denx.de>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's.
54 Please see https://lists.denx.de/pipermail/u-boot and
55 https://marc.info/?l=u-boot
56
57 Where to get source code:
58 =========================
59
60 The U-Boot source code is maintained in the Git repository at
61 https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62 https://source.denx.de/u-boot/u-boot
63
64 The "Tags" links on this page allow you to download tarballs of
65 any version you might be interested in. Official releases are also
66 available from the DENX file server through HTTPS or FTP.
67 https://ftp.denx.de/pub/u-boot/
68 ftp://ftp.denx.de/pub/u-boot/
69
70
71 Where we come from:
72 ===================
73
74 - start from 8xxrom sources
75 - create PPCBoot project (https://sourceforge.net/projects/ppcboot)
76 - clean up code
77 - make it easier to add custom boards
78 - make it possible to add other [PowerPC] CPUs
79 - extend functions, especially:
80   * Provide extended interface to Linux boot loader
81   * S-Record download
82   * network boot
83   * ATA disk / SCSI ... boot
84 - create ARMBoot project (https://sourceforge.net/projects/armboot)
85 - add other CPU families (starting with ARM)
86 - create U-Boot project (https://sourceforge.net/projects/u-boot)
87 - current project page: see https://www.denx.de/wiki/U-Boot
88
89
90 Names and Spelling:
91 ===================
92
93 The "official" name of this project is "Das U-Boot". The spelling
94 "U-Boot" shall be used in all written text (documentation, comments
95 in source files etc.). Example:
96
97         This is the README file for the U-Boot project.
98
99 File names etc. shall be based on the string "u-boot". Examples:
100
101         include/asm-ppc/u-boot.h
102
103         #include <asm/u-boot.h>
104
105 Variable names, preprocessor constants etc. shall be either based on
106 the string "u_boot" or on "U_BOOT". Example:
107
108         U_BOOT_VERSION          u_boot_logo
109         IH_OS_U_BOOT            u_boot_hush_start
110
111
112 Versioning:
113 ===========
114
115 Starting with the release in October 2008, the names of the releases
116 were changed from numerical release numbers without deeper meaning
117 into a time stamp based numbering. Regular releases are identified by
118 names consisting of the calendar year and month of the release date.
119 Additional fields (if present) indicate release candidates or bug fix
120 releases in "stable" maintenance trees.
121
122 Examples:
123         U-Boot v2009.11     - Release November 2009
124         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
125         U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
126
127
128 Directory Hierarchy:
129 ====================
130
131 /arch                   Architecture-specific files
132   /arc                  Files generic to ARC architecture
133   /arm                  Files generic to ARM architecture
134   /m68k                 Files generic to m68k architecture
135   /microblaze           Files generic to microblaze architecture
136   /mips                 Files generic to MIPS architecture
137   /nios2                Files generic to Altera NIOS2 architecture
138   /powerpc              Files generic to PowerPC architecture
139   /riscv                Files generic to RISC-V architecture
140   /sandbox              Files generic to HW-independent "sandbox"
141   /sh                   Files generic to SH architecture
142   /x86                  Files generic to x86 architecture
143   /xtensa               Files generic to Xtensa architecture
144 /api                    Machine/arch-independent API for external apps
145 /board                  Board-dependent files
146 /boot                   Support for images and booting
147 /cmd                    U-Boot commands functions
148 /common                 Misc architecture-independent functions
149 /configs                Board default configuration files
150 /disk                   Code for disk drive partition handling
151 /doc                    Documentation (a mix of ReST and READMEs)
152 /drivers                Device drivers
153 /dts                    Makefile for building internal U-Boot fdt.
154 /env                    Environment support
155 /examples               Example code for standalone applications, etc.
156 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
157 /include                Header Files
158 /lib                    Library routines generic to all architectures
159 /Licenses               Various license files
160 /net                    Networking code
161 /post                   Power On Self Test
162 /scripts                Various build scripts and Makefiles
163 /test                   Various unit test files
164 /tools                  Tools to build and sign FIT images, etc.
165
166 Software Configuration:
167 =======================
168
169 Selection of Processor Architecture and Board Type:
170 ---------------------------------------------------
171
172 For all supported boards there are ready-to-use default
173 configurations available; just type "make <board_name>_defconfig".
174
175 Example: For a TQM823L module type:
176
177         cd u-boot
178         make TQM823L_defconfig
179
180 Note: If you're looking for the default configuration file for a board
181 you're sure used to be there but is now missing, check the file
182 doc/README.scrapyard for a list of no longer supported boards.
183
184 Sandbox Environment:
185 --------------------
186
187 U-Boot can be built natively to run on a Linux host using the 'sandbox'
188 board. This allows feature development which is not board- or architecture-
189 specific to be undertaken on a native platform. The sandbox is also used to
190 run some of U-Boot's tests.
191
192 See doc/arch/sandbox.rst for more details.
193
194
195 Board Initialisation Flow:
196 --------------------------
197
198 This is the intended start-up flow for boards. This should apply for both
199 SPL and U-Boot proper (i.e. they both follow the same rules).
200
201 Note: "SPL" stands for "Secondary Program Loader," which is explained in
202 more detail later in this file.
203
204 At present, SPL mostly uses a separate code path, but the function names
205 and roles of each function are the same. Some boards or architectures
206 may not conform to this.  At least most ARM boards which use
207 CONFIG_SPL_FRAMEWORK conform to this.
208
209 Execution typically starts with an architecture-specific (and possibly
210 CPU-specific) start.S file, such as:
211
212         - arch/arm/cpu/armv7/start.S
213         - arch/powerpc/cpu/mpc83xx/start.S
214         - arch/mips/cpu/start.S
215
216 and so on. From there, three functions are called; the purpose and
217 limitations of each of these functions are described below.
218
219 lowlevel_init():
220         - purpose: essential init to permit execution to reach board_init_f()
221         - no global_data or BSS
222         - there is no stack (ARMv7 may have one but it will soon be removed)
223         - must not set up SDRAM or use console
224         - must only do the bare minimum to allow execution to continue to
225                 board_init_f()
226         - this is almost never needed
227         - return normally from this function
228
229 board_init_f():
230         - purpose: set up the machine ready for running board_init_r():
231                 i.e. SDRAM and serial UART
232         - global_data is available
233         - stack is in SRAM
234         - BSS is not available, so you cannot use global/static variables,
235                 only stack variables and global_data
236
237         Non-SPL-specific notes:
238         - dram_init() is called to set up DRAM. If already done in SPL this
239                 can do nothing
240
241         SPL-specific notes:
242         - you can override the entire board_init_f() function with your own
243                 version as needed.
244         - preloader_console_init() can be called here in extremis
245         - should set up SDRAM, and anything needed to make the UART work
246         - there is no need to clear BSS, it will be done by crt0.S
247         - for specific scenarios on certain architectures an early BSS *can*
248           be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
249           of BSS prior to entering board_init_f()) but doing so is discouraged.
250           Instead it is strongly recommended to architect any code changes
251           or additions such to not depend on the availability of BSS during
252           board_init_f() as indicated in other sections of this README to
253           maintain compatibility and consistency across the entire code base.
254         - must return normally from this function (don't call board_init_r()
255                 directly)
256
257 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
258 this point the stack and global_data are relocated to below
259 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
260 memory.
261
262 board_init_r():
263         - purpose: main execution, common code
264         - global_data is available
265         - SDRAM is available
266         - BSS is available, all static/global variables can be used
267         - execution eventually continues to main_loop()
268
269         Non-SPL-specific notes:
270         - U-Boot is relocated to the top of memory and is now running from
271                 there.
272
273         SPL-specific notes:
274         - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
275                 CONFIG_SYS_FSL_HAS_CCI400
276
277                 Defined For SoC that has cache coherent interconnect
278                 CCN-400
279
280                 CONFIG_SYS_FSL_HAS_CCN504
281
282                 Defined for SoC that has cache coherent interconnect CCN-504
283
284 The following options need to be configured:
285
286 - CPU Type:     Define exactly one, e.g. CONFIG_MPC85XX.
287
288 - Board Type:   Define exactly one, e.g. CONFIG_MPC8540ADS.
289
290 - 85xx CPU Options:
291                 CONFIG_SYS_PPC64
292
293                 Specifies that the core is a 64-bit PowerPC implementation (implements
294                 the "64" category of the Power ISA). This is necessary for ePAPR
295                 compliance, among other possible reasons.
296
297                 CONFIG_SYS_FSL_ERRATUM_A004510
298
299                 Enables a workaround for erratum A004510.  If set,
300                 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
301                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
302
303                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
304                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
305
306                 Defines one or two SoC revisions (low 8 bits of SVR)
307                 for which the A004510 workaround should be applied.
308
309                 The rest of SVR is either not relevant to the decision
310                 of whether the erratum is present (e.g. p2040 versus
311                 p2041) or is implied by the build target, which controls
312                 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
313
314                 See Freescale App Note 4493 for more information about
315                 this erratum.
316
317                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
318
319                 This is the value to write into CCSR offset 0x18600
320                 according to the A004510 workaround.
321
322                 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
323                 Single Source Clock is clocking mode present in some of FSL SoC's.
324                 In this mode, a single differential clock is used to supply
325                 clocks to the sysclock, ddrclock and usbclock.
326
327 - Generic CPU options:
328
329                 CONFIG_SYS_FSL_DDR
330                 Freescale DDR driver in use. This type of DDR controller is
331                 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
332
333                 CONFIG_SYS_FSL_DDR_ADDR
334                 Freescale DDR memory-mapped register base.
335
336                 CONFIG_SYS_FSL_IFC_CLK_DIV
337                 Defines divider of platform clock(clock input to IFC controller).
338
339                 CONFIG_SYS_FSL_LBC_CLK_DIV
340                 Defines divider of platform clock(clock input to eLBC controller).
341
342                 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
343                 Physical address from the view of DDR controllers. It is the
344                 same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
345                 it could be different for ARM SoCs.
346
347 - MIPS CPU options:
348                 CONFIG_XWAY_SWAP_BYTES
349
350                 Enable compilation of tools/xway-swap-bytes needed for Lantiq
351                 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
352                 be swapped if a flash programmer is used.
353
354 - ARM options:
355                 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
356
357                 Select high exception vectors of the ARM core, e.g., do not
358                 clear the V bit of the c1 register of CP15.
359
360                 COUNTER_FREQUENCY
361                 Generic timer clock source frequency.
362
363                 COUNTER_FREQUENCY_REAL
364                 Generic timer clock source frequency if the real clock is
365                 different from COUNTER_FREQUENCY, and can only be determined
366                 at run time.
367
368 - Tegra SoC options:
369                 CONFIG_TEGRA_SUPPORT_NON_SECURE
370
371                 Support executing U-Boot in non-secure (NS) mode. Certain
372                 impossible actions will be skipped if the CPU is in NS mode,
373                 such as ARM architectural timer initialization.
374
375 - Linux Kernel Interface:
376                 CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
377
378                 When transferring memsize parameter to Linux, some versions
379                 expect it to be in bytes, others in MB.
380                 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
381
382                 CONFIG_OF_LIBFDT
383
384                 New kernel versions are expecting firmware settings to be
385                 passed using flattened device trees (based on open firmware
386                 concepts).
387
388                 CONFIG_OF_LIBFDT
389                  * New libfdt-based support
390                  * Adds the "fdt" command
391                  * The bootm command automatically updates the fdt
392
393                 OF_TBCLK - The timebase frequency.
394
395                 boards with QUICC Engines require OF_QE to set UCC MAC
396                 addresses
397
398                 CONFIG_OF_IDE_FIXUP
399
400                 U-Boot can detect if an IDE device is present or not.
401                 If not, and this new config option is activated, U-Boot
402                 removes the ATA node from the DTS before booting Linux,
403                 so the Linux IDE driver does not probe the device and
404                 crash. This is needed for buggy hardware (uc101) where
405                 no pull down resistor is connected to the signal IDE5V_DD7.
406
407 - vxWorks boot parameters:
408
409                 bootvx constructs a valid bootline using the following
410                 environments variables: bootdev, bootfile, ipaddr, netmask,
411                 serverip, gatewayip, hostname, othbootargs.
412                 It loads the vxWorks image pointed bootfile.
413
414                 Note: If a "bootargs" environment is defined, it will override
415                 the defaults discussed just above.
416
417 - Cache Configuration for ARM:
418                 CONFIG_SYS_PL310_BASE - Physical base address of PL310
419                                         controller register space
420
421 - Serial Ports:
422                 CONFIG_PL011_CLOCK
423
424                 If you have Amba PrimeCell PL011 UARTs, set this variable to
425                 the clock speed of the UARTs.
426
427                 CONFIG_PL01x_PORTS
428
429                 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
430                 define this to a list of base addresses for each (supported)
431                 port. See e.g. include/configs/versatile.h
432
433                 CONFIG_SERIAL_HW_FLOW_CONTROL
434
435                 Define this variable to enable hw flow control in serial driver.
436                 Current user of this option is drivers/serial/nsl16550.c driver
437
438 - Serial Download Echo Mode:
439                 CONFIG_LOADS_ECHO
440                 If defined to 1, all characters received during a
441                 serial download (using the "loads" command) are
442                 echoed back. This might be needed by some terminal
443                 emulations (like "cu"), but may as well just take
444                 time on others. This setting #define's the initial
445                 value of the "loads_echo" environment variable.
446
447 - Removal of commands
448                 If no commands are needed to boot, you can disable
449                 CONFIG_CMDLINE to remove them. In this case, the command line
450                 will not be available, and when U-Boot wants to execute the
451                 boot command (on start-up) it will call board_run_command()
452                 instead. This can reduce image size significantly for very
453                 simple boot procedures.
454
455 - Regular expression support:
456                 CONFIG_REGEX
457                 If this variable is defined, U-Boot is linked against
458                 the SLRE (Super Light Regular Expression) library,
459                 which adds regex support to some commands, as for
460                 example "env grep" and "setexpr".
461
462 - Watchdog:
463                 CONFIG_SYS_WATCHDOG_FREQ
464                 Some platforms automatically call WATCHDOG_RESET()
465                 from the timer interrupt handler every
466                 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
467                 board configuration file, a default of CONFIG_SYS_HZ/2
468                 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
469                 to 0 disables calling WATCHDOG_RESET() from the timer
470                 interrupt.
471
472 - Real-Time Clock:
473
474                 When CONFIG_CMD_DATE is selected, the type of the RTC
475                 has to be selected, too. Define exactly one of the
476                 following options:
477
478                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
479                 CONFIG_RTC_MC13XXX      - use MC13783 or MC13892 RTC
480                 CONFIG_RTC_MC146818     - use MC146818 RTC
481                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
482                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
483                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
484                 CONFIG_RTC_DS1339       - use Maxim, Inc. DS1339 RTC
485                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
486                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
487                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
488                 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
489                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
490                                           RV3029 RTC.
491
492                 Note that if the RTC uses I2C, then the I2C interface
493                 must also be configured. See I2C Support, below.
494
495 - GPIO Support:
496                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
497
498                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
499                 chip-ngpio pairs that tell the PCA953X driver the number of
500                 pins supported by a particular chip.
501
502                 Note that if the GPIO device uses I2C, then the I2C interface
503                 must also be configured. See I2C Support, below.
504
505 - I/O tracing:
506                 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
507                 accesses and can checksum them or write a list of them out
508                 to memory. See the 'iotrace' command for details. This is
509                 useful for testing device drivers since it can confirm that
510                 the driver behaves the same way before and after a code
511                 change. Currently this is supported on sandbox and arm. To
512                 add support for your architecture, add '#include <iotrace.h>'
513                 to the bottom of arch/<arch>/include/asm/io.h and test.
514
515                 Example output from the 'iotrace stats' command is below.
516                 Note that if the trace buffer is exhausted, the checksum will
517                 still continue to operate.
518
519                         iotrace is enabled
520                         Start:  10000000        (buffer start address)
521                         Size:   00010000        (buffer size)
522                         Offset: 00000120        (current buffer offset)
523                         Output: 10000120        (start + offset)
524                         Count:  00000018        (number of trace records)
525                         CRC32:  9526fb66        (CRC32 of all trace records)
526
527 - Timestamp Support:
528
529                 When CONFIG_TIMESTAMP is selected, the timestamp
530                 (date and time) of an image is printed by image
531                 commands like bootm or iminfo. This option is
532                 automatically enabled when you select CONFIG_CMD_DATE .
533
534 - Partition Labels (disklabels) Supported:
535                 Zero or more of the following:
536                 CONFIG_MAC_PARTITION   Apple's MacOS partition table.
537                 CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
538                 CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
539                                        bootloader.  Note 2TB partition limit; see
540                                        disk/part_efi.c
541                 CONFIG_SCSI) you must configure support for at
542                 least one non-MTD partition type as well.
543
544 - NETWORK Support (PCI):
545                 CONFIG_E1000_SPI
546                 Utility code for direct access to the SPI bus on Intel 8257x.
547                 This does not do anything useful unless you set at least one
548                 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
549
550                 CONFIG_NATSEMI
551                 Support for National dp83815 chips.
552
553                 CONFIG_NS8382X
554                 Support for National dp8382[01] gigabit chips.
555
556 - NETWORK Support (other):
557                 CONFIG_CALXEDA_XGMAC
558                 Support for the Calxeda XGMAC device
559
560                 CONFIG_LAN91C96
561                 Support for SMSC's LAN91C96 chips.
562
563                         CONFIG_LAN91C96_USE_32_BIT
564                         Define this to enable 32 bit addressing
565
566                         CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
567                         Define this if you have more then 3 PHYs.
568
569                 CONFIG_FTGMAC100
570                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
571
572                         CONFIG_FTGMAC100_EGIGA
573                         Define this to use GE link update with gigabit PHY.
574                         Define this if FTGMAC100 is connected to gigabit PHY.
575                         If your system has 10/100 PHY only, it might not occur
576                         wrong behavior. Because PHY usually return timeout or
577                         useless data when polling gigabit status and gigabit
578                         control registers. This behavior won't affect the
579                         correctnessof 10/100 link speed update.
580
581                 CONFIG_SH_ETHER
582                 Support for Renesas on-chip Ethernet controller
583
584                         CONFIG_SH_ETHER_USE_PORT
585                         Define the number of ports to be used
586
587                         CONFIG_SH_ETHER_PHY_ADDR
588                         Define the ETH PHY's address
589
590                         CONFIG_SH_ETHER_CACHE_WRITEBACK
591                         If this option is set, the driver enables cache flush.
592
593 - TPM Support:
594                 CONFIG_TPM
595                 Support TPM devices.
596
597                 CONFIG_TPM_TIS_INFINEON
598                 Support for Infineon i2c bus TPM devices. Only one device
599                 per system is supported at this time.
600
601                         CONFIG_TPM_TIS_I2C_BURST_LIMITATION
602                         Define the burst count bytes upper limit
603
604                 CONFIG_TPM_ST33ZP24
605                 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
606
607                         CONFIG_TPM_ST33ZP24_I2C
608                         Support for STMicroelectronics ST33ZP24 I2C devices.
609                         Requires TPM_ST33ZP24 and I2C.
610
611                         CONFIG_TPM_ST33ZP24_SPI
612                         Support for STMicroelectronics ST33ZP24 SPI devices.
613                         Requires TPM_ST33ZP24 and SPI.
614
615                 CONFIG_TPM_ATMEL_TWI
616                 Support for Atmel TWI TPM device. Requires I2C support.
617
618                 CONFIG_TPM_TIS_LPC
619                 Support for generic parallel port TPM devices. Only one device
620                 per system is supported at this time.
621
622                         CONFIG_TPM_TIS_BASE_ADDRESS
623                         Base address where the generic TPM device is mapped
624                         to. Contemporary x86 systems usually map it at
625                         0xfed40000.
626
627                 CONFIG_TPM
628                 Define this to enable the TPM support library which provides
629                 functional interfaces to some TPM commands.
630                 Requires support for a TPM device.
631
632                 CONFIG_TPM_AUTH_SESSIONS
633                 Define this to enable authorized functions in the TPM library.
634                 Requires CONFIG_TPM and CONFIG_SHA1.
635
636 - USB Support:
637                 At the moment only the UHCI host controller is
638                 supported (PIP405, MIP405); define
639                 CONFIG_USB_UHCI to enable it.
640                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
641                 and define CONFIG_USB_STORAGE to enable the USB
642                 storage devices.
643                 Note:
644                 Supported are USB Keyboards and USB Floppy drives
645                 (TEAC FD-05PUB).
646
647                 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
648                 HW module registers.
649
650 - USB Device:
651                 Define the below if you wish to use the USB console.
652                 Once firmware is rebuilt from a serial console issue the
653                 command "setenv stdin usbtty; setenv stdout usbtty" and
654                 attach your USB cable. The Unix command "dmesg" should print
655                 it has found a new device. The environment variable usbtty
656                 can be set to gserial or cdc_acm to enable your device to
657                 appear to a USB host as a Linux gserial device or a
658                 Common Device Class Abstract Control Model serial device.
659                 If you select usbtty = gserial you should be able to enumerate
660                 a Linux host by
661                 # modprobe usbserial vendor=0xVendorID product=0xProductID
662                 else if using cdc_acm, simply setting the environment
663                 variable usbtty to be cdc_acm should suffice. The following
664                 might be defined in YourBoardName.h
665
666                         CONFIG_USB_DEVICE
667                         Define this to build a UDC device
668
669                         CONFIG_USB_TTY
670                         Define this to have a tty type of device available to
671                         talk to the UDC device
672
673                         CONFIG_USBD_HS
674                         Define this to enable the high speed support for usb
675                         device and usbtty. If this feature is enabled, a routine
676                         int is_usbd_high_speed(void)
677                         also needs to be defined by the driver to dynamically poll
678                         whether the enumeration has succeded at high speed or full
679                         speed.
680
681                 If you have a USB-IF assigned VendorID then you may wish to
682                 define your own vendor specific values either in BoardName.h
683                 or directly in usbd_vendor_info.h. If you don't define
684                 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
685                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
686                 should pretend to be a Linux device to it's target host.
687
688                         CONFIG_USBD_MANUFACTURER
689                         Define this string as the name of your company for
690                         - CONFIG_USBD_MANUFACTURER "my company"
691
692                         CONFIG_USBD_PRODUCT_NAME
693                         Define this string as the name of your product
694                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
695
696                         CONFIG_USBD_VENDORID
697                         Define this as your assigned Vendor ID from the USB
698                         Implementors Forum. This *must* be a genuine Vendor ID
699                         to avoid polluting the USB namespace.
700                         - CONFIG_USBD_VENDORID 0xFFFF
701
702                         CONFIG_USBD_PRODUCTID
703                         Define this as the unique Product ID
704                         for your device
705                         - CONFIG_USBD_PRODUCTID 0xFFFF
706
707 - ULPI Layer Support:
708                 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
709                 the generic ULPI layer. The generic layer accesses the ULPI PHY
710                 via the platform viewport, so you need both the genric layer and
711                 the viewport enabled. Currently only Chipidea/ARC based
712                 viewport is supported.
713                 To enable the ULPI layer support, define CONFIG_USB_ULPI and
714                 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
715                 If your ULPI phy needs a different reference clock than the
716                 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
717                 the appropriate value in Hz.
718
719 - MMC Support:
720                 CONFIG_SH_MMCIF
721                 Support for Renesas on-chip MMCIF controller
722
723                         CONFIG_SH_MMCIF_ADDR
724                         Define the base address of MMCIF registers
725
726                         CONFIG_SH_MMCIF_CLK
727                         Define the clock frequency for MMCIF
728
729 - USB Device Firmware Update (DFU) class support:
730                 CONFIG_DFU_OVER_USB
731                 This enables the USB portion of the DFU USB class
732
733                 CONFIG_DFU_NAND
734                 This enables support for exposing NAND devices via DFU.
735
736                 CONFIG_DFU_RAM
737                 This enables support for exposing RAM via DFU.
738                 Note: DFU spec refer to non-volatile memory usage, but
739                 allow usages beyond the scope of spec - here RAM usage,
740                 one that would help mostly the developer.
741
742                 CONFIG_SYS_DFU_DATA_BUF_SIZE
743                 Dfu transfer uses a buffer before writing data to the
744                 raw storage device. Make the size (in bytes) of this buffer
745                 configurable. The size of this buffer is also configurable
746                 through the "dfu_bufsiz" environment variable.
747
748                 CONFIG_SYS_DFU_MAX_FILE_SIZE
749                 When updating files rather than the raw storage device,
750                 we use a static buffer to copy the file into and then write
751                 the buffer once we've been given the whole file.  Define
752                 this to the maximum filesize (in bytes) for the buffer.
753                 Default is 4 MiB if undefined.
754
755                 DFU_DEFAULT_POLL_TIMEOUT
756                 Poll timeout [ms], is the timeout a device can send to the
757                 host. The host must wait for this timeout before sending
758                 a subsequent DFU_GET_STATUS request to the device.
759
760                 DFU_MANIFEST_POLL_TIMEOUT
761                 Poll timeout [ms], which the device sends to the host when
762                 entering dfuMANIFEST state. Host waits this timeout, before
763                 sending again an USB request to the device.
764
765 - Journaling Flash filesystem support:
766                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
767                 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
768                 Define these for a default partition on a NOR device
769
770 - Keyboard Support:
771                 See Kconfig help for available keyboard drivers.
772
773 - MII/PHY support:
774                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
775
776                 The clock frequency of the MII bus
777
778                 CONFIG_PHY_CMD_DELAY (ppc4xx)
779
780                 Some PHY like Intel LXT971A need extra delay after
781                 command issued before MII status register can be read
782
783 - IP address:
784                 CONFIG_IPADDR
785
786                 Define a default value for the IP address to use for
787                 the default Ethernet interface, in case this is not
788                 determined through e.g. bootp.
789                 (Environment variable "ipaddr")
790
791 - Server IP address:
792                 CONFIG_SERVERIP
793
794                 Defines a default value for the IP address of a TFTP
795                 server to contact when using the "tftboot" command.
796                 (Environment variable "serverip")
797
798 - Gateway IP address:
799                 CONFIG_GATEWAYIP
800
801                 Defines a default value for the IP address of the
802                 default router where packets to other networks are
803                 sent to.
804                 (Environment variable "gatewayip")
805
806 - Subnet mask:
807                 CONFIG_NETMASK
808
809                 Defines a default value for the subnet mask (or
810                 routing prefix) which is used to determine if an IP
811                 address belongs to the local subnet or needs to be
812                 forwarded through a router.
813                 (Environment variable "netmask")
814
815 - BOOTP Recovery Mode:
816                 CONFIG_BOOTP_RANDOM_DELAY
817
818                 If you have many targets in a network that try to
819                 boot using BOOTP, you may want to avoid that all
820                 systems send out BOOTP requests at precisely the same
821                 moment (which would happen for instance at recovery
822                 from a power failure, when all systems will try to
823                 boot, thus flooding the BOOTP server. Defining
824                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
825                 inserted before sending out BOOTP requests. The
826                 following delays are inserted then:
827
828                 1st BOOTP request:      delay 0 ... 1 sec
829                 2nd BOOTP request:      delay 0 ... 2 sec
830                 3rd BOOTP request:      delay 0 ... 4 sec
831                 4th and following
832                 BOOTP requests:         delay 0 ... 8 sec
833
834                 CONFIG_BOOTP_ID_CACHE_SIZE
835
836                 BOOTP packets are uniquely identified using a 32-bit ID. The
837                 server will copy the ID from client requests to responses and
838                 U-Boot will use this to determine if it is the destination of
839                 an incoming response. Some servers will check that addresses
840                 aren't in use before handing them out (usually using an ARP
841                 ping) and therefore take up to a few hundred milliseconds to
842                 respond. Network congestion may also influence the time it
843                 takes for a response to make it back to the client. If that
844                 time is too long, U-Boot will retransmit requests. In order
845                 to allow earlier responses to still be accepted after these
846                 retransmissions, U-Boot's BOOTP client keeps a small cache of
847                 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
848                 cache. The default is to keep IDs for up to four outstanding
849                 requests. Increasing this will allow U-Boot to accept offers
850                 from a BOOTP client in networks with unusually high latency.
851
852 - DHCP Advanced Options:
853
854  - Link-local IP address negotiation:
855                 Negotiate with other link-local clients on the local network
856                 for an address that doesn't require explicit configuration.
857                 This is especially useful if a DHCP server cannot be guaranteed
858                 to exist in all environments that the device must operate.
859
860                 See doc/README.link-local for more information.
861
862  - MAC address from environment variables
863
864                 FDT_SEQ_MACADDR_FROM_ENV
865
866                 Fix-up device tree with MAC addresses fetched sequentially from
867                 environment variables. This config work on assumption that
868                 non-usable ethernet node of device-tree are either not present
869                 or their status has been marked as "disabled".
870
871  - CDP Options:
872                 CONFIG_CDP_DEVICE_ID
873
874                 The device id used in CDP trigger frames.
875
876                 CONFIG_CDP_DEVICE_ID_PREFIX
877
878                 A two character string which is prefixed to the MAC address
879                 of the device.
880
881                 CONFIG_CDP_PORT_ID
882
883                 A printf format string which contains the ascii name of
884                 the port. Normally is set to "eth%d" which sets
885                 eth0 for the first Ethernet, eth1 for the second etc.
886
887                 CONFIG_CDP_CAPABILITIES
888
889                 A 32bit integer which indicates the device capabilities;
890                 0x00000010 for a normal host which does not forwards.
891
892                 CONFIG_CDP_VERSION
893
894                 An ascii string containing the version of the software.
895
896                 CONFIG_CDP_PLATFORM
897
898                 An ascii string containing the name of the platform.
899
900                 CONFIG_CDP_TRIGGER
901
902                 A 32bit integer sent on the trigger.
903
904                 CONFIG_CDP_POWER_CONSUMPTION
905
906                 A 16bit integer containing the power consumption of the
907                 device in .1 of milliwatts.
908
909                 CONFIG_CDP_APPLIANCE_VLAN_TYPE
910
911                 A byte containing the id of the VLAN.
912
913 - Status LED:   CONFIG_LED_STATUS
914
915                 Several configurations allow to display the current
916                 status using a LED. For instance, the LED will blink
917                 fast while running U-Boot code, stop blinking as
918                 soon as a reply to a BOOTP request was received, and
919                 start blinking slow once the Linux kernel is running
920                 (supported by a status LED driver in the Linux
921                 kernel). Defining CONFIG_LED_STATUS enables this
922                 feature in U-Boot.
923
924                 Additional options:
925
926                 CONFIG_LED_STATUS_GPIO
927                 The status LED can be connected to a GPIO pin.
928                 In such cases, the gpio_led driver can be used as a
929                 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
930                 to include the gpio_led driver in the U-Boot binary.
931
932                 CONFIG_GPIO_LED_INVERTED_TABLE
933                 Some GPIO connected LEDs may have inverted polarity in which
934                 case the GPIO high value corresponds to LED off state and
935                 GPIO low value corresponds to LED on state.
936                 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
937                 with a list of GPIO LEDs that have inverted polarity.
938
939 - I2C Support:
940                 CONFIG_SYS_NUM_I2C_BUSES
941                 Hold the number of i2c buses you want to use.
942
943                 CONFIG_SYS_I2C_DIRECT_BUS
944                 define this, if you don't use i2c muxes on your hardware.
945                 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
946                 omit this define.
947
948                 CONFIG_SYS_I2C_MAX_HOPS
949                 define how many muxes are maximal consecutively connected
950                 on one i2c bus. If you not use i2c muxes, omit this
951                 define.
952
953                 CONFIG_SYS_I2C_BUSES
954                 hold a list of buses you want to use, only used if
955                 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
956                 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
957                 CONFIG_SYS_NUM_I2C_BUSES = 9:
958
959                  CONFIG_SYS_I2C_BUSES   {{0, {I2C_NULL_HOP}}, \
960                                         {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
961                                         {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
962                                         {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
963                                         {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
964                                         {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
965                                         {1, {I2C_NULL_HOP}}, \
966                                         {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
967                                         {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
968                                         }
969
970                 which defines
971                         bus 0 on adapter 0 without a mux
972                         bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
973                         bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
974                         bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
975                         bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
976                         bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
977                         bus 6 on adapter 1 without a mux
978                         bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
979                         bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
980
981                 If you do not have i2c muxes on your board, omit this define.
982
983 - Legacy I2C Support:
984                 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
985                 then the following macros need to be defined (examples are
986                 from include/configs/lwmon.h):
987
988                 I2C_INIT
989
990                 (Optional). Any commands necessary to enable the I2C
991                 controller or configure ports.
992
993                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
994
995                 I2C_ACTIVE
996
997                 The code necessary to make the I2C data line active
998                 (driven).  If the data line is open collector, this
999                 define can be null.
1000
1001                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1002
1003                 I2C_TRISTATE
1004
1005                 The code necessary to make the I2C data line tri-stated
1006                 (inactive).  If the data line is open collector, this
1007                 define can be null.
1008
1009                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1010
1011                 I2C_READ
1012
1013                 Code that returns true if the I2C data line is high,
1014                 false if it is low.
1015
1016                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1017
1018                 I2C_SDA(bit)
1019
1020                 If <bit> is true, sets the I2C data line high. If it
1021                 is false, it clears it (low).
1022
1023                 eg: #define I2C_SDA(bit) \
1024                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1025                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
1026
1027                 I2C_SCL(bit)
1028
1029                 If <bit> is true, sets the I2C clock line high. If it
1030                 is false, it clears it (low).
1031
1032                 eg: #define I2C_SCL(bit) \
1033                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1034                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
1035
1036                 I2C_DELAY
1037
1038                 This delay is invoked four times per clock cycle so this
1039                 controls the rate of data transfer.  The data rate thus
1040                 is 1 / (I2C_DELAY * 4). Often defined to be something
1041                 like:
1042
1043                 #define I2C_DELAY  udelay(2)
1044
1045                 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1046
1047                 If your arch supports the generic GPIO framework (asm/gpio.h),
1048                 then you may alternatively define the two GPIOs that are to be
1049                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
1050                 have GPIO-based defaults assigned to them as appropriate.
1051
1052                 You should define these to the GPIO value as given directly to
1053                 the generic GPIO functions.
1054
1055                 CONFIG_SYS_I2C_INIT_BOARD
1056
1057                 When a board is reset during an i2c bus transfer
1058                 chips might think that the current transfer is still
1059                 in progress. On some boards it is possible to access
1060                 the i2c SCLK line directly, either by using the
1061                 processor pin as a GPIO or by having a second pin
1062                 connected to the bus. If this option is defined a
1063                 custom i2c_init_board() routine in boards/xxx/board.c
1064                 is run early in the boot sequence.
1065
1066                 CONFIG_I2C_MULTI_BUS
1067
1068                 This option allows the use of multiple I2C buses, each of which
1069                 must have a controller.  At any point in time, only one bus is
1070                 active.  To switch to a different bus, use the 'i2c dev' command.
1071                 Note that bus numbering is zero-based.
1072
1073                 CONFIG_SYS_I2C_NOPROBES
1074
1075                 This option specifies a list of I2C devices that will be skipped
1076                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
1077                 is set, specify a list of bus-device pairs.  Otherwise, specify
1078                 a 1D array of device addresses
1079
1080                 e.g.
1081                         #undef  CONFIG_I2C_MULTI_BUS
1082                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1083
1084                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1085
1086                         #define CONFIG_I2C_MULTI_BUS
1087                         #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1088
1089                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1090
1091                 CONFIG_SYS_RTC_BUS_NUM
1092
1093                 If defined, then this indicates the I2C bus number for the RTC.
1094                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1095
1096                 CONFIG_SOFT_I2C_READ_REPEATED_START
1097
1098                 defining this will force the i2c_read() function in
1099                 the soft_i2c driver to perform an I2C repeated start
1100                 between writing the address pointer and reading the
1101                 data.  If this define is omitted the default behaviour
1102                 of doing a stop-start sequence will be used.  Most I2C
1103                 devices can use either method, but some require one or
1104                 the other.
1105
1106 - SPI Support:  CONFIG_SPI
1107
1108                 Enables SPI driver (so far only tested with
1109                 SPI EEPROM, also an instance works with Crystal A/D and
1110                 D/As on the SACSng board)
1111
1112                 CONFIG_SYS_SPI_MXC_WAIT
1113                 Timeout for waiting until spi transfer completed.
1114                 default: (CONFIG_SYS_HZ/100)     /* 10 ms */
1115
1116 - FPGA Support: CONFIG_FPGA
1117
1118                 Enables FPGA subsystem.
1119
1120                 CONFIG_FPGA_<vendor>
1121
1122                 Enables support for specific chip vendors.
1123                 (ALTERA, XILINX)
1124
1125                 CONFIG_FPGA_<family>
1126
1127                 Enables support for FPGA family.
1128                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1129
1130                 CONFIG_SYS_FPGA_CHECK_BUSY
1131
1132                 Enable checks on FPGA configuration interface busy
1133                 status by the configuration function. This option
1134                 will require a board or device specific function to
1135                 be written.
1136
1137                 CONFIG_FPGA_DELAY
1138
1139                 If defined, a function that provides delays in the FPGA
1140                 configuration driver.
1141
1142                 CONFIG_SYS_FPGA_CHECK_ERROR
1143
1144                 Check for configuration errors during FPGA bitfile
1145                 loading. For example, abort during Virtex II
1146                 configuration if the INIT_B line goes low (which
1147                 indicated a CRC error).
1148
1149                 CONFIG_SYS_FPGA_WAIT_INIT
1150
1151                 Maximum time to wait for the INIT_B line to de-assert
1152                 after PROB_B has been de-asserted during a Virtex II
1153                 FPGA configuration sequence. The default time is 500
1154                 ms.
1155
1156                 CONFIG_SYS_FPGA_WAIT_BUSY
1157
1158                 Maximum time to wait for BUSY to de-assert during
1159                 Virtex II FPGA configuration. The default is 5 ms.
1160
1161                 CONFIG_SYS_FPGA_WAIT_CONFIG
1162
1163                 Time to wait after FPGA configuration. The default is
1164                 200 ms.
1165
1166 - Vendor Parameter Protection:
1167
1168                 U-Boot considers the values of the environment
1169                 variables "serial#" (Board Serial Number) and
1170                 "ethaddr" (Ethernet Address) to be parameters that
1171                 are set once by the board vendor / manufacturer, and
1172                 protects these variables from casual modification by
1173                 the user. Once set, these variables are read-only,
1174                 and write or delete attempts are rejected. You can
1175                 change this behaviour:
1176
1177                 If CONFIG_ENV_OVERWRITE is #defined in your config
1178                 file, the write protection for vendor parameters is
1179                 completely disabled. Anybody can change or delete
1180                 these parameters.
1181
1182                 Alternatively, if you define _both_ an ethaddr in the
1183                 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1184                 Ethernet address is installed in the environment,
1185                 which can be changed exactly ONCE by the user. [The
1186                 serial# is unaffected by this, i. e. it remains
1187                 read-only.]
1188
1189                 The same can be accomplished in a more flexible way
1190                 for any variable by configuring the type of access
1191                 to allow for those variables in the ".flags" variable
1192                 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1193
1194 - Protected RAM:
1195                 CONFIG_PRAM
1196
1197                 Define this variable to enable the reservation of
1198                 "protected RAM", i. e. RAM which is not overwritten
1199                 by U-Boot. Define CONFIG_PRAM to hold the number of
1200                 kB you want to reserve for pRAM. You can overwrite
1201                 this default value by defining an environment
1202                 variable "pram" to the number of kB you want to
1203                 reserve. Note that the board info structure will
1204                 still show the full amount of RAM. If pRAM is
1205                 reserved, a new environment variable "mem" will
1206                 automatically be defined to hold the amount of
1207                 remaining RAM in a form that can be passed as boot
1208                 argument to Linux, for instance like that:
1209
1210                         setenv bootargs ... mem=\${mem}
1211                         saveenv
1212
1213                 This way you can tell Linux not to use this memory,
1214                 either, which results in a memory region that will
1215                 not be affected by reboots.
1216
1217                 *WARNING* If your board configuration uses automatic
1218                 detection of the RAM size, you must make sure that
1219                 this memory test is non-destructive. So far, the
1220                 following board configurations are known to be
1221                 "pRAM-clean":
1222
1223                         IVMS8, IVML24, SPD8xx,
1224                         HERMES, IP860, RPXlite, LWMON,
1225                         FLAGADM
1226
1227 - Error Recovery:
1228         Note:
1229
1230                 In the current implementation, the local variables
1231                 space and global environment variables space are
1232                 separated. Local variables are those you define by
1233                 simply typing `name=value'. To access a local
1234                 variable later on, you have write `$name' or
1235                 `${name}'; to execute the contents of a variable
1236                 directly type `$name' at the command prompt.
1237
1238                 Global environment variables are those you use
1239                 setenv/printenv to work with. To run a command stored
1240                 in such a variable, you need to use the run command,
1241                 and you must not use the '$' sign to access them.
1242
1243                 To store commands and special characters in a
1244                 variable, please use double quotation marks
1245                 surrounding the whole text of the variable, instead
1246                 of the backslashes before semicolons and special
1247                 symbols.
1248
1249 - Default Environment:
1250                 CONFIG_EXTRA_ENV_SETTINGS
1251
1252                 Define this to contain any number of null terminated
1253                 strings (variable = value pairs) that will be part of
1254                 the default environment compiled into the boot image.
1255
1256                 For example, place something like this in your
1257                 board's config file:
1258
1259                 #define CONFIG_EXTRA_ENV_SETTINGS \
1260                         "myvar1=value1\0" \
1261                         "myvar2=value2\0"
1262
1263                 Warning: This method is based on knowledge about the
1264                 internal format how the environment is stored by the
1265                 U-Boot code. This is NOT an official, exported
1266                 interface! Although it is unlikely that this format
1267                 will change soon, there is no guarantee either.
1268                 You better know what you are doing here.
1269
1270                 Note: overly (ab)use of the default environment is
1271                 discouraged. Make sure to check other ways to preset
1272                 the environment like the "source" command or the
1273                 boot command first.
1274
1275                 CONFIG_DELAY_ENVIRONMENT
1276
1277                 Normally the environment is loaded when the board is
1278                 initialised so that it is available to U-Boot. This inhibits
1279                 that so that the environment is not available until
1280                 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1281                 this is instead controlled by the value of
1282                 /config/load-environment.
1283
1284                 CONFIG_STANDALONE_LOAD_ADDR
1285
1286                 This option defines a board specific value for the
1287                 address where standalone program gets loaded, thus
1288                 overwriting the architecture dependent default
1289                 settings.
1290
1291 - Automatic software updates via TFTP server
1292                 CONFIG_UPDATE_TFTP
1293                 CONFIG_UPDATE_TFTP_CNT_MAX
1294                 CONFIG_UPDATE_TFTP_MSEC_MAX
1295
1296                 These options enable and control the auto-update feature;
1297                 for a more detailed description refer to doc/README.update.
1298
1299 - MTD Support (mtdparts command, UBI support)
1300                 CONFIG_MTD_UBI_WL_THRESHOLD
1301                 This parameter defines the maximum difference between the highest
1302                 erase counter value and the lowest erase counter value of eraseblocks
1303                 of UBI devices. When this threshold is exceeded, UBI starts performing
1304                 wear leveling by means of moving data from eraseblock with low erase
1305                 counter to eraseblocks with high erase counter.
1306
1307                 The default value should be OK for SLC NAND flashes, NOR flashes and
1308                 other flashes which have eraseblock life-cycle 100000 or more.
1309                 However, in case of MLC NAND flashes which typically have eraseblock
1310                 life-cycle less than 10000, the threshold should be lessened (e.g.,
1311                 to 128 or 256, although it does not have to be power of 2).
1312
1313                 default: 4096
1314
1315                 CONFIG_MTD_UBI_BEB_LIMIT
1316                 This option specifies the maximum bad physical eraseblocks UBI
1317                 expects on the MTD device (per 1024 eraseblocks). If the
1318                 underlying flash does not admit of bad eraseblocks (e.g. NOR
1319                 flash), this value is ignored.
1320
1321                 NAND datasheets often specify the minimum and maximum NVM
1322                 (Number of Valid Blocks) for the flashes' endurance lifetime.
1323                 The maximum expected bad eraseblocks per 1024 eraseblocks
1324                 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1325                 which gives 20 for most NANDs (MaxNVB is basically the total
1326                 count of eraseblocks on the chip).
1327
1328                 To put it differently, if this value is 20, UBI will try to
1329                 reserve about 1.9% of physical eraseblocks for bad blocks
1330                 handling. And that will be 1.9% of eraseblocks on the entire
1331                 NAND chip, not just the MTD partition UBI attaches. This means
1332                 that if you have, say, a NAND flash chip admits maximum 40 bad
1333                 eraseblocks, and it is split on two MTD partitions of the same
1334                 size, UBI will reserve 40 eraseblocks when attaching a
1335                 partition.
1336
1337                 default: 20
1338
1339                 CONFIG_MTD_UBI_FASTMAP
1340                 Fastmap is a mechanism which allows attaching an UBI device
1341                 in nearly constant time. Instead of scanning the whole MTD device it
1342                 only has to locate a checkpoint (called fastmap) on the device.
1343                 The on-flash fastmap contains all information needed to attach
1344                 the device. Using fastmap makes only sense on large devices where
1345                 attaching by scanning takes long. UBI will not automatically install
1346                 a fastmap on old images, but you can set the UBI parameter
1347                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1348                 that fastmap-enabled images are still usable with UBI implementations
1349                 without fastmap support. On typical flash devices the whole fastmap
1350                 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1351
1352                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1353                 Set this parameter to enable fastmap automatically on images
1354                 without a fastmap.
1355                 default: 0
1356
1357                 CONFIG_MTD_UBI_FM_DEBUG
1358                 Enable UBI fastmap debug
1359                 default: 0
1360
1361 - SPL framework
1362                 CONFIG_SPL
1363                 Enable building of SPL globally.
1364
1365                 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1366                 When defined, SPL will panic() if the image it has
1367                 loaded does not have a signature.
1368                 Defining this is useful when code which loads images
1369                 in SPL cannot guarantee that absolutely all read errors
1370                 will be caught.
1371                 An example is the LPC32XX MLC NAND driver, which will
1372                 consider that a completely unreadable NAND block is bad,
1373                 and thus should be skipped silently.
1374
1375                 CONFIG_SPL_DISPLAY_PRINT
1376                 For ARM, enable an optional function to print more information
1377                 about the running system.
1378
1379                 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1380                 Set this for NAND SPL on PPC mpc83xx targets, so that
1381                 start.S waits for the rest of the SPL to load before
1382                 continuing (the hardware starts execution after just
1383                 loading the first page rather than the full 4K).
1384
1385                 CONFIG_SPL_UBI
1386                 Support for a lightweight UBI (fastmap) scanner and
1387                 loader
1388
1389                 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1390                 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1391                 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1392                 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1393                 CONFIG_SYS_NAND_ECCBYTES
1394                 Defines the size and behavior of the NAND that SPL uses
1395                 to read U-Boot
1396
1397                 CONFIG_SYS_NAND_U_BOOT_DST
1398                 Location in memory to load U-Boot to
1399
1400                 CONFIG_SYS_NAND_U_BOOT_SIZE
1401                 Size of image to load
1402
1403                 CONFIG_SYS_NAND_U_BOOT_START
1404                 Entry point in loaded image to jump to
1405
1406                 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1407                 Define this if you need to first read the OOB and then the
1408                 data. This is used, for example, on davinci platforms.
1409
1410                 CONFIG_SPL_RAM_DEVICE
1411                 Support for running image already present in ram, in SPL binary
1412
1413                 CONFIG_SPL_FIT_PRINT
1414                 Printing information about a FIT image adds quite a bit of
1415                 code to SPL. So this is normally disabled in SPL. Use this
1416                 option to re-enable it. This will affect the output of the
1417                 bootm command when booting a FIT image.
1418
1419 - Interrupt support (PPC):
1420
1421                 There are common interrupt_init() and timer_interrupt()
1422                 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1423                 for CPU specific initialization. interrupt_init_cpu()
1424                 should set decrementer_count to appropriate value. If
1425                 CPU resets decrementer automatically after interrupt
1426                 (ppc4xx) it should set decrementer_count to zero.
1427                 timer_interrupt() calls timer_interrupt_cpu() for CPU
1428                 specific handling. If board has watchdog / status_led
1429                 / other_activity_monitor it works automatically from
1430                 general timer_interrupt().
1431
1432
1433 Board initialization settings:
1434 ------------------------------
1435
1436 During Initialization u-boot calls a number of board specific functions
1437 to allow the preparation of board specific prerequisites, e.g. pin setup
1438 before drivers are initialized. To enable these callbacks the
1439 following configuration macros have to be defined. Currently this is
1440 architecture specific, so please check arch/your_architecture/lib/board.c
1441 typically in board_init_f() and board_init_r().
1442
1443 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1444 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1445 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
1446
1447 Configuration Settings:
1448 -----------------------
1449
1450 - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
1451                 Optionally it can be defined to support 64-bit memory commands.
1452
1453 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
1454                 undefine this when you're short of memory.
1455
1456 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
1457                 width of the commands listed in the 'help' command output.
1458
1459 - CONFIG_SYS_PROMPT:    This is what U-Boot prints on the console to
1460                 prompt for user input.
1461
1462 - CONFIG_SYS_BAUDRATE_TABLE:
1463                 List of legal baudrate settings for this board.
1464
1465 - CONFIG_SYS_MEM_RESERVE_SECURE
1466                 Only implemented for ARMv8 for now.
1467                 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
1468                 is substracted from total RAM and won't be reported to OS.
1469                 This memory can be used as secure memory. A variable
1470                 gd->arch.secure_ram is used to track the location. In systems
1471                 the RAM base is not zero, or RAM is divided into banks,
1472                 this variable needs to be recalcuated to get the address.
1473
1474 - CONFIG_SYS_LOADS_BAUD_CHANGE:
1475                 Enable temporary baudrate change while serial download
1476
1477 - CONFIG_SYS_SDRAM_BASE:
1478                 Physical start address of SDRAM. _Must_ be 0 here.
1479
1480 - CONFIG_SYS_FLASH_BASE:
1481                 Physical start address of Flash memory.
1482
1483 - CONFIG_SYS_MONITOR_LEN:
1484                 Size of memory reserved for monitor code, used to
1485                 determine _at_compile_time_ (!) if the environment is
1486                 embedded within the U-Boot image, or in a separate
1487                 flash sector.
1488
1489 - CONFIG_SYS_MALLOC_LEN:
1490                 Size of DRAM reserved for malloc() use.
1491
1492 - CONFIG_SYS_MALLOC_F_LEN
1493                 Size of the malloc() pool for use before relocation. If
1494                 this is defined, then a very simple malloc() implementation
1495                 will become available before relocation. The address is just
1496                 below the global data, and the stack is moved down to make
1497                 space.
1498
1499                 This feature allocates regions with increasing addresses
1500                 within the region. calloc() is supported, but realloc()
1501                 is not available. free() is supported but does nothing.
1502                 The memory will be freed (or in fact just forgotten) when
1503                 U-Boot relocates itself.
1504
1505 - CONFIG_SYS_MALLOC_SIMPLE
1506                 Provides a simple and small malloc() and calloc() for those
1507                 boards which do not use the full malloc in SPL (which is
1508                 enabled with CONFIG_SYS_SPL_MALLOC).
1509
1510 - CONFIG_SYS_NONCACHED_MEMORY:
1511                 Size of non-cached memory area. This area of memory will be
1512                 typically located right below the malloc() area and mapped
1513                 uncached in the MMU. This is useful for drivers that would
1514                 otherwise require a lot of explicit cache maintenance. For
1515                 some drivers it's also impossible to properly maintain the
1516                 cache. For example if the regions that need to be flushed
1517                 are not a multiple of the cache-line size, *and* padding
1518                 cannot be allocated between the regions to align them (i.e.
1519                 if the HW requires a contiguous array of regions, and the
1520                 size of each region is not cache-aligned), then a flush of
1521                 one region may result in overwriting data that hardware has
1522                 written to another region in the same cache-line. This can
1523                 happen for example in network drivers where descriptors for
1524                 buffers are typically smaller than the CPU cache-line (e.g.
1525                 16 bytes vs. 32 or 64 bytes).
1526
1527                 Non-cached memory is only supported on 32-bit ARM at present.
1528
1529 - CONFIG_SYS_BOOTMAPSZ:
1530                 Maximum size of memory mapped by the startup code of
1531                 the Linux kernel; all data that must be processed by
1532                 the Linux kernel (bd_info, boot arguments, FDT blob if
1533                 used) must be put below this limit, unless "bootm_low"
1534                 environment variable is defined and non-zero. In such case
1535                 all data for the Linux kernel must be between "bootm_low"
1536                 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
1537                 variable "bootm_mapsize" will override the value of
1538                 CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
1539                 then the value in "bootm_size" will be used instead.
1540
1541 - CONFIG_SYS_BOOT_GET_CMDLINE:
1542                 Enables allocating and saving kernel cmdline in space between
1543                 "bootm_low" and "bootm_low" + BOOTMAPSZ.
1544
1545 - CONFIG_SYS_BOOT_GET_KBD:
1546                 Enables allocating and saving a kernel copy of the bd_info in
1547                 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
1548
1549 - CONFIG_SYS_FLASH_PROTECTION
1550                 If defined, hardware flash sectors protection is used
1551                 instead of U-Boot software protection.
1552
1553 - CONFIG_SYS_FLASH_CFI:
1554                 Define if the flash driver uses extra elements in the
1555                 common flash structure for storing flash geometry.
1556
1557 - CONFIG_FLASH_CFI_DRIVER
1558                 This option also enables the building of the cfi_flash driver
1559                 in the drivers directory
1560
1561 - CONFIG_FLASH_CFI_MTD
1562                 This option enables the building of the cfi_mtd driver
1563                 in the drivers directory. The driver exports CFI flash
1564                 to the MTD layer.
1565
1566 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
1567                 Use buffered writes to flash.
1568
1569 - CONFIG_FLASH_SPANSION_S29WS_N
1570                 s29ws-n MirrorBit flash has non-standard addresses for buffered
1571                 write commands.
1572
1573 - CONFIG_FLASH_SHOW_PROGRESS
1574                 If defined (must be an integer), print out countdown
1575                 digits and dots.  Recommended value: 45 (9..1) for 80
1576                 column displays, 15 (3..1) for 40 column displays.
1577
1578 - CONFIG_FLASH_VERIFY
1579                 If defined, the content of the flash (destination) is compared
1580                 against the source after the write operation. An error message
1581                 will be printed when the contents are not identical.
1582                 Please note that this option is useless in nearly all cases,
1583                 since such flash programming errors usually are detected earlier
1584                 while unprotecting/erasing/programming. Please only enable
1585                 this option if you really know what you are doing.
1586
1587 - CONFIG_ENV_FLAGS_LIST_DEFAULT
1588 - CONFIG_ENV_FLAGS_LIST_STATIC
1589         Enable validation of the values given to environment variables when
1590         calling env set.  Variables can be restricted to only decimal,
1591         hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
1592         the variables can also be restricted to IP address or MAC address.
1593
1594         The format of the list is:
1595                 type_attribute = [s|d|x|b|i|m]
1596                 access_attribute = [a|r|o|c]
1597                 attributes = type_attribute[access_attribute]
1598                 entry = variable_name[:attributes]
1599                 list = entry[,list]
1600
1601         The type attributes are:
1602                 s - String (default)
1603                 d - Decimal
1604                 x - Hexadecimal
1605                 b - Boolean ([1yYtT|0nNfF])
1606                 i - IP address
1607                 m - MAC address
1608
1609         The access attributes are:
1610                 a - Any (default)
1611                 r - Read-only
1612                 o - Write-once
1613                 c - Change-default
1614
1615         - CONFIG_ENV_FLAGS_LIST_DEFAULT
1616                 Define this to a list (string) to define the ".flags"
1617                 environment variable in the default or embedded environment.
1618
1619         - CONFIG_ENV_FLAGS_LIST_STATIC
1620                 Define this to a list (string) to define validation that
1621                 should be done if an entry is not found in the ".flags"
1622                 environment variable.  To override a setting in the static
1623                 list, simply add an entry for the same variable name to the
1624                 ".flags" variable.
1625
1626         If CONFIG_REGEX is defined, the variable_name above is evaluated as a
1627         regular expression. This allows multiple variables to define the same
1628         flags without explicitly listing them for each variable.
1629
1630 The following definitions that deal with the placement and management
1631 of environment data (variable area); in general, we support the
1632 following configurations:
1633
1634 - CONFIG_BUILD_ENVCRC:
1635
1636         Builds up envcrc with the target environment so that external utils
1637         may easily extract it and embed it in final U-Boot images.
1638
1639 BE CAREFUL! The first access to the environment happens quite early
1640 in U-Boot initialization (when we try to get the setting of for the
1641 console baudrate). You *MUST* have mapped your NVRAM area then, or
1642 U-Boot will hang.
1643
1644 Please note that even with NVRAM we still use a copy of the
1645 environment in RAM: we could work on NVRAM directly, but we want to
1646 keep settings there always unmodified except somebody uses "saveenv"
1647 to save the current settings.
1648
1649 BE CAREFUL! For some special cases, the local device can not use
1650 "saveenv" command. For example, the local device will get the
1651 environment stored in a remote NOR flash by SRIO or PCIE link,
1652 but it can not erase, write this NOR flash by SRIO or PCIE interface.
1653
1654 - CONFIG_NAND_ENV_DST
1655
1656         Defines address in RAM to which the nand_spl code should copy the
1657         environment. If redundant environment is used, it will be copied to
1658         CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
1659
1660 Please note that the environment is read-only until the monitor
1661 has been relocated to RAM and a RAM copy of the environment has been
1662 created; also, when using EEPROM you will have to use env_get_f()
1663 until then to read environment variables.
1664
1665 The environment is protected by a CRC32 checksum. Before the monitor
1666 is relocated into RAM, as a result of a bad CRC you will be working
1667 with the compiled-in default environment - *silently*!!! [This is
1668 necessary, because the first environment variable we need is the
1669 "baudrate" setting for the console - if we have a bad CRC, we don't
1670 have any device yet where we could complain.]
1671
1672 Note: once the monitor has been relocated, then it will complain if
1673 the default environment is used; a new CRC is computed as soon as you
1674 use the "saveenv" command to store a valid environment.
1675
1676 - CONFIG_SYS_FAULT_MII_ADDR:
1677                 MII address of the PHY to check for the Ethernet link state.
1678
1679 - CONFIG_NS16550_MIN_FUNCTIONS:
1680                 Define this if you desire to only have use of the NS16550_init
1681                 and NS16550_putc functions for the serial driver located at
1682                 drivers/serial/ns16550.c.  This option is useful for saving
1683                 space for already greatly restricted images, including but not
1684                 limited to NAND_SPL configurations.
1685
1686 - CONFIG_DISPLAY_BOARDINFO
1687                 Display information about the board that U-Boot is running on
1688                 when U-Boot starts up. The board function checkboard() is called
1689                 to do this.
1690
1691 - CONFIG_DISPLAY_BOARDINFO_LATE
1692                 Similar to the previous option, but display this information
1693                 later, once stdio is running and output goes to the LCD, if
1694                 present.
1695
1696 Low Level (hardware related) configuration options:
1697 ---------------------------------------------------
1698
1699 - CONFIG_SYS_CACHELINE_SIZE:
1700                 Cache Line Size of the CPU.
1701
1702 - CONFIG_SYS_CCSRBAR_DEFAULT:
1703                 Default (power-on reset) physical address of CCSR on Freescale
1704                 PowerPC SOCs.
1705
1706 - CONFIG_SYS_CCSRBAR:
1707                 Virtual address of CCSR.  On a 32-bit build, this is typically
1708                 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
1709
1710 - CONFIG_SYS_CCSRBAR_PHYS:
1711                 Physical address of CCSR.  CCSR can be relocated to a new
1712                 physical address, if desired.  In this case, this macro should
1713                 be set to that address.  Otherwise, it should be set to the
1714                 same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
1715                 is typically relocated on 36-bit builds.  It is recommended
1716                 that this macro be defined via the _HIGH and _LOW macros:
1717
1718                 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
1719                         * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
1720
1721 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
1722                 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
1723                 either 0 (32-bit build) or 0xF (36-bit build).  This macro is
1724                 used in assembly code, so it must not contain typecasts or
1725                 integer size suffixes (e.g. "ULL").
1726
1727 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
1728                 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
1729                 used in assembly code, so it must not contain typecasts or
1730                 integer size suffixes (e.g. "ULL").
1731
1732 - CONFIG_SYS_IMMR:      Physical address of the Internal Memory.
1733                 DO NOT CHANGE unless you know exactly what you're
1734                 doing! (11-4) [MPC8xx systems only]
1735
1736 - CONFIG_SYS_INIT_RAM_ADDR:
1737
1738                 Start address of memory area that can be used for
1739                 initial data and stack; please note that this must be
1740                 writable memory that is working WITHOUT special
1741                 initialization, i. e. you CANNOT use normal RAM which
1742                 will become available only after programming the
1743                 memory controller and running certain initialization
1744                 sequences.
1745
1746                 U-Boot uses the following memory types:
1747                 - MPC8xx: IMMR (internal memory of the CPU)
1748
1749 - CONFIG_SYS_SCCR:      System Clock and reset Control Register (15-27)
1750
1751 - CONFIG_SYS_OR_TIMING_SDRAM:
1752                 SDRAM timing
1753
1754 - CONFIG_SYS_MAMR_PTA:
1755                 periodic timer for refresh
1756
1757 - CONFIG_SYS_SRIO:
1758                 Chip has SRIO or not
1759
1760 - CONFIG_SRIO1:
1761                 Board has SRIO 1 port available
1762
1763 - CONFIG_SRIO2:
1764                 Board has SRIO 2 port available
1765
1766 - CONFIG_SRIO_PCIE_BOOT_MASTER
1767                 Board can support master function for Boot from SRIO and PCIE
1768
1769 - CONFIG_SYS_SRIOn_MEM_VIRT:
1770                 Virtual Address of SRIO port 'n' memory region
1771
1772 - CONFIG_SYS_SRIOn_MEM_PHYxS:
1773                 Physical Address of SRIO port 'n' memory region
1774
1775 - CONFIG_SYS_SRIOn_MEM_SIZE:
1776                 Size of SRIO port 'n' memory region
1777
1778 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
1779                 Defined to tell the NAND controller that the NAND chip is using
1780                 a 16 bit bus.
1781                 Not all NAND drivers use this symbol.
1782                 Example of drivers that use it:
1783                 - drivers/mtd/nand/raw/ndfc.c
1784                 - drivers/mtd/nand/raw/mxc_nand.c
1785
1786 - CONFIG_SYS_NDFC_EBC0_CFG
1787                 Sets the EBC0_CFG register for the NDFC. If not defined
1788                 a default value will be used.
1789
1790 - CONFIG_SPD_EEPROM
1791                 Get DDR timing information from an I2C EEPROM. Common
1792                 with pluggable memory modules such as SODIMMs
1793
1794   SPD_EEPROM_ADDRESS
1795                 I2C address of the SPD EEPROM
1796
1797 - CONFIG_SYS_SPD_BUS_NUM
1798                 If SPD EEPROM is on an I2C bus other than the first
1799                 one, specify here. Note that the value must resolve
1800                 to something your driver can deal with.
1801
1802 - CONFIG_FSL_DDR_INTERACTIVE
1803                 Enable interactive DDR debugging. See doc/README.fsl-ddr.
1804
1805 - CONFIG_FSL_DDR_SYNC_REFRESH
1806                 Enable sync of refresh for multiple controllers.
1807
1808 - CONFIG_FSL_DDR_BIST
1809                 Enable built-in memory test for Freescale DDR controllers.
1810
1811 - CONFIG_RMII
1812                 Enable RMII mode for all FECs.
1813                 Note that this is a global option, we can't
1814                 have one FEC in standard MII mode and another in RMII mode.
1815
1816 - CONFIG_CRC32_VERIFY
1817                 Add a verify option to the crc32 command.
1818                 The syntax is:
1819
1820                 => crc32 -v <address> <count> <crc32>
1821
1822                 Where address/count indicate a memory area
1823                 and crc32 is the correct crc32 which the
1824                 area should have.
1825
1826 - CONFIG_LOOPW
1827                 Add the "loopw" memory command. This only takes effect if
1828                 the memory commands are activated globally (CONFIG_CMD_MEMORY).
1829
1830 - CONFIG_CMD_MX_CYCLIC
1831                 Add the "mdc" and "mwc" memory commands. These are cyclic
1832                 "md/mw" commands.
1833                 Examples:
1834
1835                 => mdc.b 10 4 500
1836                 This command will print 4 bytes (10,11,12,13) each 500 ms.
1837
1838                 => mwc.l 100 12345678 10
1839                 This command will write 12345678 to address 100 all 10 ms.
1840
1841                 This only takes effect if the memory commands are activated
1842                 globally (CONFIG_CMD_MEMORY).
1843
1844 - CONFIG_SPL_BUILD
1845                 Set when the currently-running compilation is for an artifact
1846                 that will end up in the SPL (as opposed to the TPL or U-Boot
1847                 proper). Code that needs stage-specific behavior should check
1848                 this.
1849
1850 - CONFIG_TPL_BUILD
1851                 Set when the currently-running compilation is for an artifact
1852                 that will end up in the TPL (as opposed to the SPL or U-Boot
1853                 proper). Code that needs stage-specific behavior should check
1854                 this.
1855
1856 - CONFIG_ARCH_MAP_SYSMEM
1857                 Generally U-Boot (and in particular the md command) uses
1858                 effective address. It is therefore not necessary to regard
1859                 U-Boot address as virtual addresses that need to be translated
1860                 to physical addresses. However, sandbox requires this, since
1861                 it maintains its own little RAM buffer which contains all
1862                 addressable memory. This option causes some memory accesses
1863                 to be mapped through map_sysmem() / unmap_sysmem().
1864
1865 - CONFIG_X86_RESET_VECTOR
1866                 If defined, the x86 reset vector code is included. This is not
1867                 needed when U-Boot is running from Coreboot.
1868
1869 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
1870                 Option to disable subpage write in NAND driver
1871                 driver that uses this:
1872                 drivers/mtd/nand/raw/davinci_nand.c
1873
1874 Freescale QE/FMAN Firmware Support:
1875 -----------------------------------
1876
1877 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
1878 loading of "firmware", which is encoded in the QE firmware binary format.
1879 This firmware often needs to be loaded during U-Boot booting, so macros
1880 are used to identify the storage device (NOR flash, SPI, etc) and the address
1881 within that device.
1882
1883 - CONFIG_SYS_FMAN_FW_ADDR
1884         The address in the storage device where the FMAN microcode is located.  The
1885         meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
1886         is also specified.
1887
1888 - CONFIG_SYS_QE_FW_ADDR
1889         The address in the storage device where the QE microcode is located.  The
1890         meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
1891         is also specified.
1892
1893 - CONFIG_SYS_QE_FMAN_FW_LENGTH
1894         The maximum possible size of the firmware.  The firmware binary format
1895         has a field that specifies the actual size of the firmware, but it
1896         might not be possible to read any part of the firmware unless some
1897         local storage is allocated to hold the entire firmware first.
1898
1899 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
1900         Specifies that QE/FMAN firmware is located in NOR flash, mapped as
1901         normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
1902         virtual address in NOR flash.
1903
1904 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
1905         Specifies that QE/FMAN firmware is located in NAND flash.
1906         CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
1907
1908 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
1909         Specifies that QE/FMAN firmware is located on the primary SD/MMC
1910         device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
1911
1912 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
1913         Specifies that QE/FMAN firmware is located in the remote (master)
1914         memory space.   CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
1915         can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
1916         window->master inbound window->master LAW->the ucode address in
1917         master's memory space.
1918
1919 Freescale Layerscape Management Complex Firmware Support:
1920 ---------------------------------------------------------
1921 The Freescale Layerscape Management Complex (MC) supports the loading of
1922 "firmware".
1923 This firmware often needs to be loaded during U-Boot booting, so macros
1924 are used to identify the storage device (NOR flash, SPI, etc) and the address
1925 within that device.
1926
1927 - CONFIG_FSL_MC_ENET
1928         Enable the MC driver for Layerscape SoCs.
1929
1930 Freescale Layerscape Debug Server Support:
1931 -------------------------------------------
1932 The Freescale Layerscape Debug Server Support supports the loading of
1933 "Debug Server firmware" and triggering SP boot-rom.
1934 This firmware often needs to be loaded during U-Boot booting.
1935
1936 - CONFIG_SYS_MC_RSV_MEM_ALIGN
1937         Define alignment of reserved memory MC requires
1938
1939 Reproducible builds
1940 -------------------
1941
1942 In order to achieve reproducible builds, timestamps used in the U-Boot build
1943 process have to be set to a fixed value.
1944
1945 This is done using the SOURCE_DATE_EPOCH environment variable.
1946 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
1947 option for U-Boot or an environment variable in U-Boot.
1948
1949 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
1950
1951 Building the Software:
1952 ======================
1953
1954 Building U-Boot has been tested in several native build environments
1955 and in many different cross environments. Of course we cannot support
1956 all possibly existing versions of cross development tools in all
1957 (potentially obsolete) versions. In case of tool chain problems we
1958 recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
1959 which is extensively used to build and test U-Boot.
1960
1961 If you are not using a native environment, it is assumed that you
1962 have GNU cross compiling tools available in your path. In this case,
1963 you must set the environment variable CROSS_COMPILE in your shell.
1964 Note that no changes to the Makefile or any other source files are
1965 necessary. For example using the ELDK on a 4xx CPU, please enter:
1966
1967         $ CROSS_COMPILE=ppc_4xx-
1968         $ export CROSS_COMPILE
1969
1970 U-Boot is intended to be simple to build. After installing the
1971 sources you must configure U-Boot for one specific board type. This
1972 is done by typing:
1973
1974         make NAME_defconfig
1975
1976 where "NAME_defconfig" is the name of one of the existing configu-
1977 rations; see configs/*_defconfig for supported names.
1978
1979 Note: for some boards special configuration names may exist; check if
1980       additional information is available from the board vendor; for
1981       instance, the TQM823L systems are available without (standard)
1982       or with LCD support. You can select such additional "features"
1983       when choosing the configuration, i. e.
1984
1985       make TQM823L_defconfig
1986         - will configure for a plain TQM823L, i. e. no LCD support
1987
1988       make TQM823L_LCD_defconfig
1989         - will configure for a TQM823L with U-Boot console on LCD
1990
1991       etc.
1992
1993
1994 Finally, type "make all", and you should get some working U-Boot
1995 images ready for download to / installation on your system:
1996
1997 - "u-boot.bin" is a raw binary image
1998 - "u-boot" is an image in ELF binary format
1999 - "u-boot.srec" is in Motorola S-Record format
2000
2001 By default the build is performed locally and the objects are saved
2002 in the source directory. One of the two methods can be used to change
2003 this behavior and build U-Boot to some external directory:
2004
2005 1. Add O= to the make command line invocations:
2006
2007         make O=/tmp/build distclean
2008         make O=/tmp/build NAME_defconfig
2009         make O=/tmp/build all
2010
2011 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
2012
2013         export KBUILD_OUTPUT=/tmp/build
2014         make distclean
2015         make NAME_defconfig
2016         make all
2017
2018 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
2019 variable.
2020
2021 User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2022 setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2023 For example to treat all compiler warnings as errors:
2024
2025         make KCFLAGS=-Werror
2026
2027 Please be aware that the Makefiles assume you are using GNU make, so
2028 for instance on NetBSD you might need to use "gmake" instead of
2029 native "make".
2030
2031
2032 If the system board that you have is not listed, then you will need
2033 to port U-Boot to your hardware platform. To do this, follow these
2034 steps:
2035
2036 1.  Create a new directory to hold your board specific code. Add any
2037     files you need. In your board directory, you will need at least
2038     the "Makefile" and a "<board>.c".
2039 2.  Create a new configuration file "include/configs/<board>.h" for
2040     your board.
2041 3.  If you're porting U-Boot to a new CPU, then also create a new
2042     directory to hold your CPU specific code. Add any files you need.
2043 4.  Run "make <board>_defconfig" with your new name.
2044 5.  Type "make", and you should get a working "u-boot.srec" file
2045     to be installed on your target system.
2046 6.  Debug and solve any problems that might arise.
2047     [Of course, this last step is much harder than it sounds.]
2048
2049
2050 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2051 ==============================================================
2052
2053 If you have modified U-Boot sources (for instance added a new board
2054 or support for new devices, a new CPU, etc.) you are expected to
2055 provide feedback to the other developers. The feedback normally takes
2056 the form of a "patch", i.e. a context diff against a certain (latest
2057 official or latest in the git repository) version of U-Boot sources.
2058
2059 But before you submit such a patch, please verify that your modifi-
2060 cation did not break existing code. At least make sure that *ALL* of
2061 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2062 just run the buildman script (tools/buildman/buildman), which will
2063 configure and build U-Boot for ALL supported system. Be warned, this
2064 will take a while. Please see the buildman README, or run 'buildman -H'
2065 for documentation.
2066
2067
2068 See also "U-Boot Porting Guide" below.
2069
2070
2071 Monitor Commands - Overview:
2072 ============================
2073
2074 go      - start application at address 'addr'
2075 run     - run commands in an environment variable
2076 bootm   - boot application image from memory
2077 bootp   - boot image via network using BootP/TFTP protocol
2078 bootz   - boot zImage from memory
2079 tftpboot- boot image via network using TFTP protocol
2080                and env variables "ipaddr" and "serverip"
2081                (and eventually "gatewayip")
2082 tftpput - upload a file via network using TFTP protocol
2083 rarpboot- boot image via network using RARP/TFTP protocol
2084 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2085 loads   - load S-Record file over serial line
2086 loadb   - load binary file over serial line (kermit mode)
2087 loadm   - load binary blob from source address to destination address
2088 md      - memory display
2089 mm      - memory modify (auto-incrementing)
2090 nm      - memory modify (constant address)
2091 mw      - memory write (fill)
2092 ms      - memory search
2093 cp      - memory copy
2094 cmp     - memory compare
2095 crc32   - checksum calculation
2096 i2c     - I2C sub-system
2097 sspi    - SPI utility commands
2098 base    - print or set address offset
2099 printenv- print environment variables
2100 pwm     - control pwm channels
2101 setenv  - set environment variables
2102 saveenv - save environment variables to persistent storage
2103 protect - enable or disable FLASH write protection
2104 erase   - erase FLASH memory
2105 flinfo  - print FLASH memory information
2106 nand    - NAND memory operations (see doc/README.nand)
2107 bdinfo  - print Board Info structure
2108 iminfo  - print header information for application image
2109 coninfo - print console devices and informations
2110 ide     - IDE sub-system
2111 loop    - infinite loop on address range
2112 loopw   - infinite write loop on address range
2113 mtest   - simple RAM test
2114 icache  - enable or disable instruction cache
2115 dcache  - enable or disable data cache
2116 reset   - Perform RESET of the CPU
2117 echo    - echo args to console
2118 version - print monitor version
2119 help    - print online help
2120 ?       - alias for 'help'
2121
2122
2123 Monitor Commands - Detailed Description:
2124 ========================================
2125
2126 TODO.
2127
2128 For now: just type "help <command>".
2129
2130
2131 Note for Redundant Ethernet Interfaces:
2132 =======================================
2133
2134 Some boards come with redundant Ethernet interfaces; U-Boot supports
2135 such configurations and is capable of automatic selection of a
2136 "working" interface when needed. MAC assignment works as follows:
2137
2138 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2139 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2140 "eth1addr" (=>eth1), "eth2addr", ...
2141
2142 If the network interface stores some valid MAC address (for instance
2143 in SROM), this is used as default address if there is NO correspon-
2144 ding setting in the environment; if the corresponding environment
2145 variable is set, this overrides the settings in the card; that means:
2146
2147 o If the SROM has a valid MAC address, and there is no address in the
2148   environment, the SROM's address is used.
2149
2150 o If there is no valid address in the SROM, and a definition in the
2151   environment exists, then the value from the environment variable is
2152   used.
2153
2154 o If both the SROM and the environment contain a MAC address, and
2155   both addresses are the same, this MAC address is used.
2156
2157 o If both the SROM and the environment contain a MAC address, and the
2158   addresses differ, the value from the environment is used and a
2159   warning is printed.
2160
2161 o If neither SROM nor the environment contain a MAC address, an error
2162   is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2163   a random, locally-assigned MAC is used.
2164
2165 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
2166 will be programmed into hardware as part of the initialization process.  This
2167 may be skipped by setting the appropriate 'ethmacskip' environment variable.
2168 The naming convention is as follows:
2169 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
2170
2171 Image Formats:
2172 ==============
2173
2174 U-Boot is capable of booting (and performing other auxiliary operations on)
2175 images in two formats:
2176
2177 New uImage format (FIT)
2178 -----------------------
2179
2180 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2181 to Flattened Device Tree). It allows the use of images with multiple
2182 components (several kernels, ramdisks, etc.), with contents protected by
2183 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2184
2185
2186 Old uImage format
2187 -----------------
2188
2189 Old image format is based on binary files which can be basically anything,
2190 preceded by a special header; see the definitions in include/image.h for
2191 details; basically, the header defines the following image properties:
2192
2193 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2194   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2195   LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
2196   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
2197 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2198   IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2199   Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC).
2200 * Compression Type (uncompressed, gzip, bzip2)
2201 * Load Address
2202 * Entry Point
2203 * Image Name
2204 * Image Timestamp
2205
2206 The header is marked by a special Magic Number, and both the header
2207 and the data portions of the image are secured against corruption by
2208 CRC32 checksums.
2209
2210
2211 Linux Support:
2212 ==============
2213
2214 Although U-Boot should support any OS or standalone application
2215 easily, the main focus has always been on Linux during the design of
2216 U-Boot.
2217
2218 U-Boot includes many features that so far have been part of some
2219 special "boot loader" code within the Linux kernel. Also, any
2220 "initrd" images to be used are no longer part of one big Linux image;
2221 instead, kernel and "initrd" are separate images. This implementation
2222 serves several purposes:
2223
2224 - the same features can be used for other OS or standalone
2225   applications (for instance: using compressed images to reduce the
2226   Flash memory footprint)
2227
2228 - it becomes much easier to port new Linux kernel versions because
2229   lots of low-level, hardware dependent stuff are done by U-Boot
2230
2231 - the same Linux kernel image can now be used with different "initrd"
2232   images; of course this also means that different kernel images can
2233   be run with the same "initrd". This makes testing easier (you don't
2234   have to build a new "zImage.initrd" Linux image when you just
2235   change a file in your "initrd"). Also, a field-upgrade of the
2236   software is easier now.
2237
2238
2239 Linux HOWTO:
2240 ============
2241
2242 Porting Linux to U-Boot based systems:
2243 ---------------------------------------
2244
2245 U-Boot cannot save you from doing all the necessary modifications to
2246 configure the Linux device drivers for use with your target hardware
2247 (no, we don't intend to provide a full virtual machine interface to
2248 Linux :-).
2249
2250 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
2251
2252 Just make sure your machine specific header file (for instance
2253 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2254 Information structure as we define in include/asm-<arch>/u-boot.h,
2255 and make sure that your definition of IMAP_ADDR uses the same value
2256 as your U-Boot configuration in CONFIG_SYS_IMMR.
2257
2258 Note that U-Boot now has a driver model, a unified model for drivers.
2259 If you are adding a new driver, plumb it into driver model. If there
2260 is no uclass available, you are encouraged to create one. See
2261 doc/driver-model.
2262
2263
2264 Configuring the Linux kernel:
2265 -----------------------------
2266
2267 No specific requirements for U-Boot. Make sure you have some root
2268 device (initial ramdisk, NFS) for your target system.
2269
2270
2271 Building a Linux Image:
2272 -----------------------
2273
2274 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2275 not used. If you use recent kernel source, a new build target
2276 "uImage" will exist which automatically builds an image usable by
2277 U-Boot. Most older kernels also have support for a "pImage" target,
2278 which was introduced for our predecessor project PPCBoot and uses a
2279 100% compatible format.
2280
2281 Example:
2282
2283         make TQM850L_defconfig
2284         make oldconfig
2285         make dep
2286         make uImage
2287
2288 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2289 encapsulate a compressed Linux kernel image with header  information,
2290 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2291
2292 * build a standard "vmlinux" kernel image (in ELF binary format):
2293
2294 * convert the kernel into a raw binary image:
2295
2296         ${CROSS_COMPILE}-objcopy -O binary \
2297                                  -R .note -R .comment \
2298                                  -S vmlinux linux.bin
2299
2300 * compress the binary image:
2301
2302         gzip -9 linux.bin
2303
2304 * package compressed binary image for U-Boot:
2305
2306         mkimage -A ppc -O linux -T kernel -C gzip \
2307                 -a 0 -e 0 -n "Linux Kernel Image" \
2308                 -d linux.bin.gz uImage
2309
2310
2311 The "mkimage" tool can also be used to create ramdisk images for use
2312 with U-Boot, either separated from the Linux kernel image, or
2313 combined into one file. "mkimage" encapsulates the images with a 64
2314 byte header containing information about target architecture,
2315 operating system, image type, compression method, entry points, time
2316 stamp, CRC32 checksums, etc.
2317
2318 "mkimage" can be called in two ways: to verify existing images and
2319 print the header information, or to build new images.
2320
2321 In the first form (with "-l" option) mkimage lists the information
2322 contained in the header of an existing U-Boot image; this includes
2323 checksum verification:
2324
2325         tools/mkimage -l image
2326           -l ==> list image header information
2327
2328 The second form (with "-d" option) is used to build a U-Boot image
2329 from a "data file" which is used as image payload:
2330
2331         tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2332                       -n name -d data_file image
2333           -A ==> set architecture to 'arch'
2334           -O ==> set operating system to 'os'
2335           -T ==> set image type to 'type'
2336           -C ==> set compression type 'comp'
2337           -a ==> set load address to 'addr' (hex)
2338           -e ==> set entry point to 'ep' (hex)
2339           -n ==> set image name to 'name'
2340           -d ==> use image data from 'datafile'
2341
2342 Right now, all Linux kernels for PowerPC systems use the same load
2343 address (0x00000000), but the entry point address depends on the
2344 kernel version:
2345
2346 - 2.2.x kernels have the entry point at 0x0000000C,
2347 - 2.3.x and later kernels have the entry point at 0x00000000.
2348
2349 So a typical call to build a U-Boot image would read:
2350
2351         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2352         > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2353         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2354         > examples/uImage.TQM850L
2355         Image Name:   2.4.4 kernel for TQM850L
2356         Created:      Wed Jul 19 02:34:59 2000
2357         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2358         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2359         Load Address: 0x00000000
2360         Entry Point:  0x00000000
2361
2362 To verify the contents of the image (or check for corruption):
2363
2364         -> tools/mkimage -l examples/uImage.TQM850L
2365         Image Name:   2.4.4 kernel for TQM850L
2366         Created:      Wed Jul 19 02:34:59 2000
2367         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2368         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2369         Load Address: 0x00000000
2370         Entry Point:  0x00000000
2371
2372 NOTE: for embedded systems where boot time is critical you can trade
2373 speed for memory and install an UNCOMPRESSED image instead: this
2374 needs more space in Flash, but boots much faster since it does not
2375 need to be uncompressed:
2376
2377         -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2378         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2379         > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2380         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2381         > examples/uImage.TQM850L-uncompressed
2382         Image Name:   2.4.4 kernel for TQM850L
2383         Created:      Wed Jul 19 02:34:59 2000
2384         Image Type:   PowerPC Linux Kernel Image (uncompressed)
2385         Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2386         Load Address: 0x00000000
2387         Entry Point:  0x00000000
2388
2389
2390 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2391 when your kernel is intended to use an initial ramdisk:
2392
2393         -> tools/mkimage -n 'Simple Ramdisk Image' \
2394         > -A ppc -O linux -T ramdisk -C gzip \
2395         > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2396         Image Name:   Simple Ramdisk Image
2397         Created:      Wed Jan 12 14:01:50 2000
2398         Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2399         Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2400         Load Address: 0x00000000
2401         Entry Point:  0x00000000
2402
2403 The "dumpimage" tool can be used to disassemble or list the contents of images
2404 built by mkimage. See dumpimage's help output (-h) for details.
2405
2406 Installing a Linux Image:
2407 -------------------------
2408
2409 To downloading a U-Boot image over the serial (console) interface,
2410 you must convert the image to S-Record format:
2411
2412         objcopy -I binary -O srec examples/image examples/image.srec
2413
2414 The 'objcopy' does not understand the information in the U-Boot
2415 image header, so the resulting S-Record file will be relative to
2416 address 0x00000000. To load it to a given address, you need to
2417 specify the target address as 'offset' parameter with the 'loads'
2418 command.
2419
2420 Example: install the image to address 0x40100000 (which on the
2421 TQM8xxL is in the first Flash bank):
2422
2423         => erase 40100000 401FFFFF
2424
2425         .......... done
2426         Erased 8 sectors
2427
2428         => loads 40100000
2429         ## Ready for S-Record download ...
2430         ~>examples/image.srec
2431         1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2432         ...
2433         15989 15990 15991 15992
2434         [file transfer complete]
2435         [connected]
2436         ## Start Addr = 0x00000000
2437
2438
2439 You can check the success of the download using the 'iminfo' command;
2440 this includes a checksum verification so you can be sure no data
2441 corruption happened:
2442
2443         => imi 40100000
2444
2445         ## Checking Image at 40100000 ...
2446            Image Name:   2.2.13 for initrd on TQM850L
2447            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2448            Data Size:    335725 Bytes = 327 kB = 0 MB
2449            Load Address: 00000000
2450            Entry Point:  0000000c
2451            Verifying Checksum ... OK
2452
2453
2454 Boot Linux:
2455 -----------
2456
2457 The "bootm" command is used to boot an application that is stored in
2458 memory (RAM or Flash). In case of a Linux kernel image, the contents
2459 of the "bootargs" environment variable is passed to the kernel as
2460 parameters. You can check and modify this variable using the
2461 "printenv" and "setenv" commands:
2462
2463
2464         => printenv bootargs
2465         bootargs=root=/dev/ram
2466
2467         => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2468
2469         => printenv bootargs
2470         bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2471
2472         => bootm 40020000
2473         ## Booting Linux kernel at 40020000 ...
2474            Image Name:   2.2.13 for NFS on TQM850L
2475            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2476            Data Size:    381681 Bytes = 372 kB = 0 MB
2477            Load Address: 00000000
2478            Entry Point:  0000000c
2479            Verifying Checksum ... OK
2480            Uncompressing Kernel Image ... OK
2481         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
2482         Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2483         time_init: decrementer frequency = 187500000/60
2484         Calibrating delay loop... 49.77 BogoMIPS
2485         Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2486         ...
2487
2488 If you want to boot a Linux kernel with initial RAM disk, you pass
2489 the memory addresses of both the kernel and the initrd image (PPBCOOT
2490 format!) to the "bootm" command:
2491
2492         => imi 40100000 40200000
2493
2494         ## Checking Image at 40100000 ...
2495            Image Name:   2.2.13 for initrd on TQM850L
2496            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2497            Data Size:    335725 Bytes = 327 kB = 0 MB
2498            Load Address: 00000000
2499            Entry Point:  0000000c
2500            Verifying Checksum ... OK
2501
2502         ## Checking Image at 40200000 ...
2503            Image Name:   Simple Ramdisk Image
2504            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2505            Data Size:    566530 Bytes = 553 kB = 0 MB
2506            Load Address: 00000000
2507            Entry Point:  00000000
2508            Verifying Checksum ... OK
2509
2510         => bootm 40100000 40200000
2511         ## Booting Linux kernel at 40100000 ...
2512            Image Name:   2.2.13 for initrd on TQM850L
2513            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2514            Data Size:    335725 Bytes = 327 kB = 0 MB
2515            Load Address: 00000000
2516            Entry Point:  0000000c
2517            Verifying Checksum ... OK
2518            Uncompressing Kernel Image ... OK
2519         ## Loading RAMDisk Image at 40200000 ...
2520            Image Name:   Simple Ramdisk Image
2521            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2522            Data Size:    566530 Bytes = 553 kB = 0 MB
2523            Load Address: 00000000
2524            Entry Point:  00000000
2525            Verifying Checksum ... OK
2526            Loading Ramdisk ... OK
2527         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
2528         Boot arguments: root=/dev/ram
2529         time_init: decrementer frequency = 187500000/60
2530         Calibrating delay loop... 49.77 BogoMIPS
2531         ...
2532         RAMDISK: Compressed image found at block 0
2533         VFS: Mounted root (ext2 filesystem).
2534
2535         bash#
2536
2537 Boot Linux and pass a flat device tree:
2538 -----------
2539
2540 First, U-Boot must be compiled with the appropriate defines. See the section
2541 titled "Linux Kernel Interface" above for a more in depth explanation. The
2542 following is an example of how to start a kernel and pass an updated
2543 flat device tree:
2544
2545 => print oftaddr
2546 oftaddr=0x300000
2547 => print oft
2548 oft=oftrees/mpc8540ads.dtb
2549 => tftp $oftaddr $oft
2550 Speed: 1000, full duplex
2551 Using TSEC0 device
2552 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
2553 Filename 'oftrees/mpc8540ads.dtb'.
2554 Load address: 0x300000
2555 Loading: #
2556 done
2557 Bytes transferred = 4106 (100a hex)
2558 => tftp $loadaddr $bootfile
2559 Speed: 1000, full duplex
2560 Using TSEC0 device
2561 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
2562 Filename 'uImage'.
2563 Load address: 0x200000
2564 Loading:############
2565 done
2566 Bytes transferred = 1029407 (fb51f hex)
2567 => print loadaddr
2568 loadaddr=200000
2569 => print oftaddr
2570 oftaddr=0x300000
2571 => bootm $loadaddr - $oftaddr
2572 ## Booting image at 00200000 ...
2573    Image Name:   Linux-2.6.17-dirty
2574    Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2575    Data Size:    1029343 Bytes = 1005.2 kB
2576    Load Address: 00000000
2577    Entry Point:  00000000
2578    Verifying Checksum ... OK
2579    Uncompressing Kernel Image ... OK
2580 Booting using flat device tree at 0x300000
2581 Using MPC85xx ADS machine description
2582 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
2583 [snip]
2584
2585
2586 More About U-Boot Image Types:
2587 ------------------------------
2588
2589 U-Boot supports the following image types:
2590
2591    "Standalone Programs" are directly runnable in the environment
2592         provided by U-Boot; it is expected that (if they behave
2593         well) you can continue to work in U-Boot after return from
2594         the Standalone Program.
2595    "OS Kernel Images" are usually images of some Embedded OS which
2596         will take over control completely. Usually these programs
2597         will install their own set of exception handlers, device
2598         drivers, set up the MMU, etc. - this means, that you cannot
2599         expect to re-enter U-Boot except by resetting the CPU.
2600    "RAMDisk Images" are more or less just data blocks, and their
2601         parameters (address, size) are passed to an OS kernel that is
2602         being started.
2603    "Multi-File Images" contain several images, typically an OS
2604         (Linux) kernel image and one or more data images like
2605         RAMDisks. This construct is useful for instance when you want
2606         to boot over the network using BOOTP etc., where the boot
2607         server provides just a single image file, but you want to get
2608         for instance an OS kernel and a RAMDisk image.
2609
2610         "Multi-File Images" start with a list of image sizes, each
2611         image size (in bytes) specified by an "uint32_t" in network
2612         byte order. This list is terminated by an "(uint32_t)0".
2613         Immediately after the terminating 0 follow the images, one by
2614         one, all aligned on "uint32_t" boundaries (size rounded up to
2615         a multiple of 4 bytes).
2616
2617    "Firmware Images" are binary images containing firmware (like
2618         U-Boot or FPGA images) which usually will be programmed to
2619         flash memory.
2620
2621    "Script files" are command sequences that will be executed by
2622         U-Boot's command interpreter; this feature is especially
2623         useful when you configure U-Boot to use a real shell (hush)
2624         as command interpreter.
2625
2626 Booting the Linux zImage:
2627 -------------------------
2628
2629 On some platforms, it's possible to boot Linux zImage. This is done
2630 using the "bootz" command. The syntax of "bootz" command is the same
2631 as the syntax of "bootm" command.
2632
2633 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
2634 kernel with raw initrd images. The syntax is slightly different, the
2635 address of the initrd must be augmented by it's size, in the following
2636 format: "<initrd addres>:<initrd size>".
2637
2638
2639 Standalone HOWTO:
2640 =================
2641
2642 One of the features of U-Boot is that you can dynamically load and
2643 run "standalone" applications, which can use some resources of
2644 U-Boot like console I/O functions or interrupt services.
2645
2646 Two simple examples are included with the sources:
2647
2648 "Hello World" Demo:
2649 -------------------
2650
2651 'examples/hello_world.c' contains a small "Hello World" Demo
2652 application; it is automatically compiled when you build U-Boot.
2653 It's configured to run at address 0x00040004, so you can play with it
2654 like that:
2655
2656         => loads
2657         ## Ready for S-Record download ...
2658         ~>examples/hello_world.srec
2659         1 2 3 4 5 6 7 8 9 10 11 ...
2660         [file transfer complete]
2661         [connected]
2662         ## Start Addr = 0x00040004
2663
2664         => go 40004 Hello World! This is a test.
2665         ## Starting application at 0x00040004 ...
2666         Hello World
2667         argc = 7
2668         argv[0] = "40004"
2669         argv[1] = "Hello"
2670         argv[2] = "World!"
2671         argv[3] = "This"
2672         argv[4] = "is"
2673         argv[5] = "a"
2674         argv[6] = "test."
2675         argv[7] = "<NULL>"
2676         Hit any key to exit ...
2677
2678         ## Application terminated, rc = 0x0
2679
2680 Another example, which demonstrates how to register a CPM interrupt
2681 handler with the U-Boot code, can be found in 'examples/timer.c'.
2682 Here, a CPM timer is set up to generate an interrupt every second.
2683 The interrupt service routine is trivial, just printing a '.'
2684 character, but this is just a demo program. The application can be
2685 controlled by the following keys:
2686
2687         ? - print current values og the CPM Timer registers
2688         b - enable interrupts and start timer
2689         e - stop timer and disable interrupts
2690         q - quit application
2691
2692         => loads
2693         ## Ready for S-Record download ...
2694         ~>examples/timer.srec
2695         1 2 3 4 5 6 7 8 9 10 11 ...
2696         [file transfer complete]
2697         [connected]
2698         ## Start Addr = 0x00040004
2699
2700         => go 40004
2701         ## Starting application at 0x00040004 ...
2702         TIMERS=0xfff00980
2703         Using timer 1
2704           tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
2705
2706 Hit 'b':
2707         [q, b, e, ?] Set interval 1000000 us
2708         Enabling timer
2709 Hit '?':
2710         [q, b, e, ?] ........
2711         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2712 Hit '?':
2713         [q, b, e, ?] .
2714         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2715 Hit '?':
2716         [q, b, e, ?] .
2717         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2718 Hit '?':
2719         [q, b, e, ?] .
2720         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2721 Hit 'e':
2722         [q, b, e, ?] ...Stopping timer
2723 Hit 'q':
2724         [q, b, e, ?] ## Application terminated, rc = 0x0
2725
2726
2727 Minicom warning:
2728 ================
2729
2730 Over time, many people have reported problems when trying to use the
2731 "minicom" terminal emulation program for serial download. I (wd)
2732 consider minicom to be broken, and recommend not to use it. Under
2733 Unix, I recommend to use C-Kermit for general purpose use (and
2734 especially for kermit binary protocol download ("loadb" command), and
2735 use "cu" for S-Record download ("loads" command).  See
2736 https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
2737 for help with kermit.
2738
2739
2740 Nevertheless, if you absolutely want to use it try adding this
2741 configuration to your "File transfer protocols" section:
2742
2743            Name    Program                      Name U/D FullScr IO-Red. Multi
2744         X  kermit  /usr/bin/kermit -i -l %l -s   Y    U    Y       N      N
2745         Y  kermit  /usr/bin/kermit -i -l %l -r   N    D    Y       N      N
2746
2747
2748 NetBSD Notes:
2749 =============
2750
2751 Starting at version 0.9.2, U-Boot supports NetBSD both as host
2752 (build U-Boot) and target system (boots NetBSD/mpc8xx).
2753
2754 Building requires a cross environment; it is known to work on
2755 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
2756 need gmake since the Makefiles are not compatible with BSD make).
2757 Note that the cross-powerpc package does not install include files;
2758 attempting to build U-Boot will fail because <machine/ansi.h> is
2759 missing.  This file has to be installed and patched manually:
2760
2761         # cd /usr/pkg/cross/powerpc-netbsd/include
2762         # mkdir powerpc
2763         # ln -s powerpc machine
2764         # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
2765         # ${EDIT} powerpc/ansi.h        ## must remove __va_list, _BSD_VA_LIST
2766
2767 Native builds *don't* work due to incompatibilities between native
2768 and U-Boot include files.
2769
2770 Booting assumes that (the first part of) the image booted is a
2771 stage-2 loader which in turn loads and then invokes the kernel
2772 proper. Loader sources will eventually appear in the NetBSD source
2773 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2774 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2775
2776
2777 Implementation Internals:
2778 =========================
2779
2780 The following is not intended to be a complete description of every
2781 implementation detail. However, it should help to understand the
2782 inner workings of U-Boot and make it easier to port it to custom
2783 hardware.
2784
2785
2786 Initial Stack, Global Data:
2787 ---------------------------
2788
2789 The implementation of U-Boot is complicated by the fact that U-Boot
2790 starts running out of ROM (flash memory), usually without access to
2791 system RAM (because the memory controller is not initialized yet).
2792 This means that we don't have writable Data or BSS segments, and BSS
2793 is not initialized as zero. To be able to get a C environment working
2794 at all, we have to allocate at least a minimal stack. Implementation
2795 options for this are defined and restricted by the CPU used: Some CPU
2796 models provide on-chip memory (like the IMMR area on MPC8xx and
2797 MPC826x processors), on others (parts of) the data cache can be
2798 locked as (mis-) used as memory, etc.
2799
2800         Chris Hallinan posted a good summary of these issues to the
2801         U-Boot mailing list:
2802
2803         Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
2804         From: "Chris Hallinan" <clh@net1plus.com>
2805         Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
2806         ...
2807
2808         Correct me if I'm wrong, folks, but the way I understand it
2809         is this: Using DCACHE as initial RAM for Stack, etc, does not
2810         require any physical RAM backing up the cache. The cleverness
2811         is that the cache is being used as a temporary supply of
2812         necessary storage before the SDRAM controller is setup. It's
2813         beyond the scope of this list to explain the details, but you
2814         can see how this works by studying the cache architecture and
2815         operation in the architecture and processor-specific manuals.
2816
2817         OCM is On Chip Memory, which I believe the 405GP has 4K. It
2818         is another option for the system designer to use as an
2819         initial stack/RAM area prior to SDRAM being available. Either
2820         option should work for you. Using CS 4 should be fine if your
2821         board designers haven't used it for something that would
2822         cause you grief during the initial boot! It is frequently not
2823         used.
2824
2825         CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2826         with your processor/board/system design. The default value
2827         you will find in any recent u-boot distribution in
2828         walnut.h should work for you. I'd set it to a value larger
2829         than your SDRAM module. If you have a 64MB SDRAM module, set
2830         it above 400_0000. Just make sure your board has no resources
2831         that are supposed to respond to that address! That code in
2832         start.S has been around a while and should work as is when
2833         you get the config right.
2834
2835         -Chris Hallinan
2836         DS4.COM, Inc.
2837
2838 It is essential to remember this, since it has some impact on the C
2839 code for the initialization procedures:
2840
2841 * Initialized global data (data segment) is read-only. Do not attempt
2842   to write it.
2843
2844 * Do not use any uninitialized global data (or implicitly initialized
2845   as zero data - BSS segment) at all - this is undefined, initiali-
2846   zation is performed later (when relocating to RAM).
2847
2848 * Stack space is very limited. Avoid big data buffers or things like
2849   that.
2850
2851 Having only the stack as writable memory limits means we cannot use
2852 normal global data to share information between the code. But it
2853 turned out that the implementation of U-Boot can be greatly
2854 simplified by making a global data structure (gd_t) available to all
2855 functions. We could pass a pointer to this data as argument to _all_
2856 functions, but this would bloat the code. Instead we use a feature of
2857 the GCC compiler (Global Register Variables) to share the data: we
2858 place a pointer (gd) to the global data into a register which we
2859 reserve for this purpose.
2860
2861 When choosing a register for such a purpose we are restricted by the
2862 relevant  (E)ABI  specifications for the current architecture, and by
2863 GCC's implementation.
2864
2865 For PowerPC, the following registers have specific use:
2866         R1:     stack pointer
2867         R2:     reserved for system use
2868         R3-R4:  parameter passing and return values
2869         R5-R10: parameter passing
2870         R13:    small data area pointer
2871         R30:    GOT pointer
2872         R31:    frame pointer
2873
2874         (U-Boot also uses R12 as internal GOT pointer. r12
2875         is a volatile register so r12 needs to be reset when
2876         going back and forth between asm and C)
2877
2878     ==> U-Boot will use R2 to hold a pointer to the global data
2879
2880     Note: on PPC, we could use a static initializer (since the
2881     address of the global data structure is known at compile time),
2882     but it turned out that reserving a register results in somewhat
2883     smaller code - although the code savings are not that big (on
2884     average for all boards 752 bytes for the whole U-Boot image,
2885     624 text + 127 data).
2886
2887 On ARM, the following registers are used:
2888
2889         R0:     function argument word/integer result
2890         R1-R3:  function argument word
2891         R9:     platform specific
2892         R10:    stack limit (used only if stack checking is enabled)
2893         R11:    argument (frame) pointer
2894         R12:    temporary workspace
2895         R13:    stack pointer
2896         R14:    link register
2897         R15:    program counter
2898
2899     ==> U-Boot will use R9 to hold a pointer to the global data
2900
2901     Note: on ARM, only R_ARM_RELATIVE relocations are supported.
2902
2903 On Nios II, the ABI is documented here:
2904         https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
2905
2906     ==> U-Boot will use gp to hold a pointer to the global data
2907
2908     Note: on Nios II, we give "-G0" option to gcc and don't use gp
2909     to access small data sections, so gp is free.
2910
2911 On RISC-V, the following registers are used:
2912
2913         x0: hard-wired zero (zero)
2914         x1: return address (ra)
2915         x2:     stack pointer (sp)
2916         x3:     global pointer (gp)
2917         x4:     thread pointer (tp)
2918         x5:     link register (t0)
2919         x8:     frame pointer (fp)
2920         x10-x11:        arguments/return values (a0-1)
2921         x12-x17:        arguments (a2-7)
2922         x28-31:  temporaries (t3-6)
2923         pc:     program counter (pc)
2924
2925     ==> U-Boot will use gp to hold a pointer to the global data
2926
2927 Memory Management:
2928 ------------------
2929
2930 U-Boot runs in system state and uses physical addresses, i.e. the
2931 MMU is not used either for address mapping nor for memory protection.
2932
2933 The available memory is mapped to fixed addresses using the memory
2934 controller. In this process, a contiguous block is formed for each
2935 memory type (Flash, SDRAM, SRAM), even when it consists of several
2936 physical memory banks.
2937
2938 U-Boot is installed in the first 128 kB of the first Flash bank (on
2939 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
2940 booting and sizing and initializing DRAM, the code relocates itself
2941 to the upper end of DRAM. Immediately below the U-Boot code some
2942 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2943 configuration setting]. Below that, a structure with global Board
2944 Info data is placed, followed by the stack (growing downward).
2945
2946 Additionally, some exception handler code is copied to the low 8 kB
2947 of DRAM (0x00000000 ... 0x00001FFF).
2948
2949 So a typical memory configuration with 16 MB of DRAM could look like
2950 this:
2951
2952         0x0000 0000     Exception Vector code
2953               :
2954         0x0000 1FFF
2955         0x0000 2000     Free for Application Use
2956               :
2957               :
2958
2959               :
2960               :
2961         0x00FB FF20     Monitor Stack (Growing downward)
2962         0x00FB FFAC     Board Info Data and permanent copy of global data
2963         0x00FC 0000     Malloc Arena
2964               :
2965         0x00FD FFFF
2966         0x00FE 0000     RAM Copy of Monitor Code
2967         ...             eventually: LCD or video framebuffer
2968         ...             eventually: pRAM (Protected RAM - unchanged by reset)
2969         0x00FF FFFF     [End of RAM]
2970
2971
2972 System Initialization:
2973 ----------------------
2974
2975 In the reset configuration, U-Boot starts at the reset entry point
2976 (on most PowerPC systems at address 0x00000100). Because of the reset
2977 configuration for CS0# this is a mirror of the on board Flash memory.
2978 To be able to re-map memory U-Boot then jumps to its link address.
2979 To be able to implement the initialization code in C, a (small!)
2980 initial stack is set up in the internal Dual Ported RAM (in case CPUs
2981 which provide such a feature like), or in a locked part of the data
2982 cache. After that, U-Boot initializes the CPU core, the caches and
2983 the SIU.
2984
2985 Next, all (potentially) available memory banks are mapped using a
2986 preliminary mapping. For example, we put them on 512 MB boundaries
2987 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
2988 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
2989 programmed for SDRAM access. Using the temporary configuration, a
2990 simple memory test is run that determines the size of the SDRAM
2991 banks.
2992
2993 When there is more than one SDRAM bank, and the banks are of
2994 different size, the largest is mapped first. For equal size, the first
2995 bank (CS2#) is mapped first. The first mapping is always for address
2996 0x00000000, with any additional banks following immediately to create
2997 contiguous memory starting from 0.
2998
2999 Then, the monitor installs itself at the upper end of the SDRAM area
3000 and allocates memory for use by malloc() and for the global Board
3001 Info data; also, the exception vector code is copied to the low RAM
3002 pages, and the final stack is set up.
3003
3004 Only after this relocation will you have a "normal" C environment;
3005 until that you are restricted in several ways, mostly because you are
3006 running from ROM, and because the code will have to be relocated to a
3007 new address in RAM.
3008
3009
3010 U-Boot Porting Guide:
3011 ----------------------
3012
3013 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3014 list, October 2002]
3015
3016
3017 int main(int argc, char *argv[])
3018 {
3019         sighandler_t no_more_time;
3020
3021         signal(SIGALRM, no_more_time);
3022         alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
3023
3024         if (available_money > available_manpower) {
3025                 Pay consultant to port U-Boot;
3026                 return 0;
3027         }
3028
3029         Download latest U-Boot source;
3030
3031         Subscribe to u-boot mailing list;
3032
3033         if (clueless)
3034                 email("Hi, I am new to U-Boot, how do I get started?");
3035
3036         while (learning) {
3037                 Read the README file in the top level directory;
3038                 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
3039                 Read applicable doc/README.*;
3040                 Read the source, Luke;
3041                 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
3042         }
3043
3044         if (available_money > toLocalCurrency ($2500))
3045                 Buy a BDI3000;
3046         else
3047                 Add a lot of aggravation and time;
3048
3049         if (a similar board exists) {   /* hopefully... */
3050                 cp -a board/<similar> board/<myboard>
3051                 cp include/configs/<similar>.h include/configs/<myboard>.h
3052         } else {
3053                 Create your own board support subdirectory;
3054                 Create your own board include/configs/<myboard>.h file;
3055         }
3056         Edit new board/<myboard> files
3057         Edit new include/configs/<myboard>.h
3058
3059         while (!accepted) {
3060                 while (!running) {
3061                         do {
3062                                 Add / modify source code;
3063                         } until (compiles);
3064                         Debug;
3065                         if (clueless)
3066                                 email("Hi, I am having problems...");
3067                 }
3068                 Send patch file to the U-Boot email list;
3069                 if (reasonable critiques)
3070                         Incorporate improvements from email list code review;
3071                 else
3072                         Defend code as written;
3073         }
3074
3075         return 0;
3076 }
3077
3078 void no_more_time (int sig)
3079 {
3080       hire_a_guru();
3081 }
3082
3083
3084 Coding Standards:
3085 -----------------
3086
3087 All contributions to U-Boot should conform to the Linux kernel
3088 coding style; see the kernel coding style guide at
3089 https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3090 script "scripts/Lindent" in your Linux kernel source directory.
3091
3092 Source files originating from a different project (for example the
3093 MTD subsystem) are generally exempt from these guidelines and are not
3094 reformatted to ease subsequent migration to newer versions of those
3095 sources.
3096
3097 Please note that U-Boot is implemented in C (and to some small parts in
3098 Assembler); no C++ is used, so please do not use C++ style comments (//)
3099 in your code.
3100
3101 Please also stick to the following formatting rules:
3102 - remove any trailing white space
3103 - use TAB characters for indentation and vertical alignment, not spaces
3104 - make sure NOT to use DOS '\r\n' line feeds
3105 - do not add more than 2 consecutive empty lines to source files
3106 - do not add trailing empty lines to source files
3107
3108 Submissions which do not conform to the standards may be returned
3109 with a request to reformat the changes.
3110
3111
3112 Submitting Patches:
3113 -------------------
3114
3115 Since the number of patches for U-Boot is growing, we need to
3116 establish some rules. Submissions which do not conform to these rules
3117 may be rejected, even when they contain important and valuable stuff.
3118
3119 Please see https://www.denx.de/wiki/U-Boot/Patches for details.
3120
3121 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
3122 see https://lists.denx.de/listinfo/u-boot
3123
3124 When you send a patch, please include the following information with
3125 it:
3126
3127 * For bug fixes: a description of the bug and how your patch fixes
3128   this bug. Please try to include a way of demonstrating that the
3129   patch actually fixes something.
3130
3131 * For new features: a description of the feature and your
3132   implementation.
3133
3134 * For major contributions, add a MAINTAINERS file with your
3135   information and associated file and directory references.
3136
3137 * When you add support for a new board, don't forget to add a
3138   maintainer e-mail address to the boards.cfg file, too.
3139
3140 * If your patch adds new configuration options, don't forget to
3141   document these in the README file.
3142
3143 * The patch itself. If you are using git (which is *strongly*
3144   recommended) you can easily generate the patch using the
3145   "git format-patch". If you then use "git send-email" to send it to
3146   the U-Boot mailing list, you will avoid most of the common problems
3147   with some other mail clients.
3148
3149   If you cannot use git, use "diff -purN OLD NEW". If your version of
3150   diff does not support these options, then get the latest version of
3151   GNU diff.
3152
3153   The current directory when running this command shall be the parent
3154   directory of the U-Boot source tree (i. e. please make sure that
3155   your patch includes sufficient directory information for the
3156   affected files).
3157
3158   We prefer patches as plain text. MIME attachments are discouraged,
3159   and compressed attachments must not be used.
3160
3161 * If one logical set of modifications affects or creates several
3162   files, all these changes shall be submitted in a SINGLE patch file.
3163
3164 * Changesets that contain different, unrelated modifications shall be
3165   submitted as SEPARATE patches, one patch per changeset.
3166
3167
3168 Notes:
3169
3170 * Before sending the patch, run the buildman script on your patched
3171   source tree and make sure that no errors or warnings are reported
3172   for any of the boards.
3173
3174 * Keep your modifications to the necessary minimum: A patch
3175   containing several unrelated changes or arbitrary reformats will be
3176   returned with a request to re-formatting / split it.
3177
3178 * If you modify existing code, make sure that your new code does not
3179   add to the memory footprint of the code ;-) Small is beautiful!
3180   When adding new features, these should compile conditionally only
3181   (using #ifdef), and the resulting code with the new feature
3182   disabled must not need more memory than the old code without your
3183   modification.
3184
3185 * Remember that there is a size limit of 100 kB per message on the
3186   u-boot mailing list. Bigger patches will be moderated. If they are
3187   reasonable and not too big, they will be acknowledged. But patches
3188   bigger than the size limit should be avoided.