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