wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1 | # |
Wolfgang Denk | eca3aeb | 2013-06-21 10:22:36 +0200 | [diff] [blame] | 2 | # (C) Copyright 2000 - 2013 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3 | # Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
| 4 | # |
Wolfgang Denk | eca3aeb | 2013-06-21 10:22:36 +0200 | [diff] [blame] | 5 | # SPDX-License-Identifier: GPL-2.0+ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 6 | # |
| 7 | |
| 8 | Summary: |
| 9 | ======== |
| 10 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 11 | This directory contains the source code for U-Boot, a boot loader for |
wdenk | e86e5a0 | 2004-10-17 21:12:06 +0000 | [diff] [blame] | 12 | Embedded boards based on PowerPC, ARM, MIPS and several other |
| 13 | processors, which can be installed in a boot ROM and used to |
| 14 | initialize and test the hardware or to download and run application |
| 15 | code. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 16 | |
| 17 | The development of U-Boot is closely related to Linux: some parts of |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 18 | the source code originate in the Linux source tree, we have some |
| 19 | header files in common, and special provision has been made to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 20 | support booting of Linux images. |
| 21 | |
| 22 | Some attention has been paid to make this software easily |
| 23 | configurable and extendable. For instance, all monitor commands are |
| 24 | implemented with the same call interface, so that it's very easy to |
| 25 | add new commands. Also, instead of permanently adding rarely used |
| 26 | code (for instance hardware test utilities) to the monitor, you can |
| 27 | load and run it dynamically. |
| 28 | |
| 29 | |
| 30 | Status: |
| 31 | ======= |
| 32 | |
| 33 | In general, all boards for which a configuration option exists in the |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 34 | Makefile have been tested to some extent and can be considered |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 35 | "working". In fact, many of them are used in production systems. |
| 36 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 37 | In case of problems see the CHANGELOG file to find out who contributed |
| 38 | the specific port. In addition, there are various MAINTAINERS files |
| 39 | scattered throughout the U-Boot source identifying the people or |
| 40 | companies responsible for various boards and subsystems. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 41 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 42 | Note: As of August, 2010, there is no longer a CHANGELOG file in the |
| 43 | actual U-Boot source tree; however, it can be created dynamically |
| 44 | from the Git log using: |
Robert P. J. Day | adb9d85 | 2012-11-14 02:03:20 +0000 | [diff] [blame] | 45 | |
| 46 | make CHANGELOG |
| 47 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 48 | |
| 49 | Where to get help: |
| 50 | ================== |
| 51 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 52 | In case you have questions about, problems with or contributions for |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 53 | U-Boot, you should send a message to the U-Boot mailing list at |
Peter Tyser | 0c32565 | 2008-09-10 09:18:34 -0500 | [diff] [blame] | 54 | <u-boot@lists.denx.de>. There is also an archive of previous traffic |
| 55 | on the mailing list - please search the archive before asking FAQ's. |
| 56 | Please see http://lists.denx.de/pipermail/u-boot and |
| 57 | http://dir.gmane.org/gmane.comp.boot-loaders.u-boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 58 | |
| 59 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 60 | Where to get source code: |
| 61 | ========================= |
| 62 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 63 | The U-Boot source code is maintained in the Git repository at |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 64 | git://www.denx.de/git/u-boot.git ; you can browse it online at |
| 65 | http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary |
| 66 | |
| 67 | The "snapshot" links on this page allow you to download tarballs of |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 68 | any version you might be interested in. Official releases are also |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 69 | available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ |
| 70 | directory. |
| 71 | |
Anatolij Gustschin | d4ee711 | 2008-03-26 18:13:33 +0100 | [diff] [blame] | 72 | Pre-built (and tested) images are available from |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 73 | ftp://ftp.denx.de/pub/u-boot/images/ |
| 74 | |
| 75 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 76 | Where we come from: |
| 77 | =================== |
| 78 | |
| 79 | - start from 8xxrom sources |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 80 | - create PPCBoot project (http://sourceforge.net/projects/ppcboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 81 | - clean up code |
| 82 | - make it easier to add custom boards |
| 83 | - make it possible to add other [PowerPC] CPUs |
| 84 | - extend functions, especially: |
| 85 | * Provide extended interface to Linux boot loader |
| 86 | * S-Record download |
| 87 | * network boot |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 88 | * PCMCIA / CompactFlash / ATA disk / SCSI ... boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 89 | - create ARMBoot project (http://sourceforge.net/projects/armboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 90 | - add other CPU families (starting with ARM) |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 91 | - create U-Boot project (http://sourceforge.net/projects/u-boot) |
Magnus Lilja | 0d28f34 | 2008-08-06 19:32:33 +0200 | [diff] [blame] | 92 | - current project page: see http://www.denx.de/wiki/U-Boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 93 | |
| 94 | |
| 95 | Names and Spelling: |
| 96 | =================== |
| 97 | |
| 98 | The "official" name of this project is "Das U-Boot". The spelling |
| 99 | "U-Boot" shall be used in all written text (documentation, comments |
| 100 | in source files etc.). Example: |
| 101 | |
| 102 | This is the README file for the U-Boot project. |
| 103 | |
| 104 | File names etc. shall be based on the string "u-boot". Examples: |
| 105 | |
| 106 | include/asm-ppc/u-boot.h |
| 107 | |
| 108 | #include <asm/u-boot.h> |
| 109 | |
| 110 | Variable names, preprocessor constants etc. shall be either based on |
| 111 | the string "u_boot" or on "U_BOOT". Example: |
| 112 | |
| 113 | U_BOOT_VERSION u_boot_logo |
| 114 | IH_OS_U_BOOT u_boot_hush_start |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 115 | |
| 116 | |
wdenk | 93f19cc | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 117 | Versioning: |
| 118 | =========== |
| 119 | |
Thomas Weber | 360d883 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 120 | Starting with the release in October 2008, the names of the releases |
| 121 | were changed from numerical release numbers without deeper meaning |
| 122 | into a time stamp based numbering. Regular releases are identified by |
| 123 | names consisting of the calendar year and month of the release date. |
| 124 | Additional fields (if present) indicate release candidates or bug fix |
| 125 | releases in "stable" maintenance trees. |
wdenk | 93f19cc | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 126 | |
Thomas Weber | 360d883 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 127 | Examples: |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 128 | U-Boot v2009.11 - Release November 2009 |
Thomas Weber | 360d883 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 129 | U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree |
Jelle van der Waa | 0de21ec | 2016-10-30 17:30:30 +0100 | [diff] [blame] | 130 | U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release |
wdenk | 93f19cc | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 131 | |
| 132 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 133 | Directory Hierarchy: |
| 134 | ==================== |
| 135 | |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 136 | /arch Architecture specific files |
Masahiro Yamada | 6eae68e | 2014-03-07 18:02:02 +0900 | [diff] [blame] | 137 | /arc Files generic to ARC architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 138 | /arm Files generic to ARM architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 139 | /m68k Files generic to m68k architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 140 | /microblaze Files generic to microblaze architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 141 | /mips Files generic to MIPS architecture |
Macpaul Lin | afc1ce8 | 2011-10-19 20:41:11 +0000 | [diff] [blame] | 142 | /nds32 Files generic to NDS32 architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 143 | /nios2 Files generic to Altera NIOS2 architecture |
Robert P. J. Day | 33c7731 | 2013-09-15 18:34:15 -0400 | [diff] [blame] | 144 | /openrisc Files generic to OpenRISC architecture |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 145 | /powerpc Files generic to PowerPC architecture |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 146 | /sandbox Files generic to HW-independent "sandbox" |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 147 | /sh Files generic to SH architecture |
Robert P. J. Day | 33c7731 | 2013-09-15 18:34:15 -0400 | [diff] [blame] | 148 | /x86 Files generic to x86 architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 149 | /api Machine/arch independent API for external apps |
| 150 | /board Board dependent files |
Xu Ziyuan | 740f7e5 | 2016-08-26 19:54:49 +0800 | [diff] [blame] | 151 | /cmd U-Boot commands functions |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 152 | /common Misc architecture independent functions |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 153 | /configs Board default configuration files |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 154 | /disk Code for disk drive partition handling |
| 155 | /doc Documentation (don't expect too much) |
| 156 | /drivers Commonly used device drivers |
Robert P. J. Day | 33c7731 | 2013-09-15 18:34:15 -0400 | [diff] [blame] | 157 | /dts Contains Makefile for building internal U-Boot fdt. |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 158 | /examples Example code for standalone applications, etc. |
| 159 | /fs Filesystem code (cramfs, ext2, jffs2, etc.) |
| 160 | /include Header Files |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 161 | /lib Library routines generic to all architectures |
| 162 | /Licenses Various license files |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 163 | /net Networking code |
| 164 | /post Power On Self Test |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 165 | /scripts Various build scripts and Makefiles |
| 166 | /test Various unit test files |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 167 | /tools Tools to build S-Record or U-Boot images, etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 168 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 169 | Software Configuration: |
| 170 | ======================= |
| 171 | |
| 172 | Configuration is usually done using C preprocessor defines; the |
| 173 | rationale behind that is to avoid dead code whenever possible. |
| 174 | |
| 175 | There are two classes of configuration variables: |
| 176 | |
| 177 | * Configuration _OPTIONS_: |
| 178 | These are selectable by the user and have names beginning with |
| 179 | "CONFIG_". |
| 180 | |
| 181 | * Configuration _SETTINGS_: |
| 182 | These depend on the hardware etc. and should not be meddled with if |
| 183 | you don't know what you're doing; they have names beginning with |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 184 | "CONFIG_SYS_". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 185 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 186 | Previously, all configuration was done by hand, which involved creating |
| 187 | symbolic links and editing configuration files manually. More recently, |
| 188 | U-Boot has added the Kbuild infrastructure used by the Linux kernel, |
| 189 | allowing you to use the "make menuconfig" command to configure your |
| 190 | build. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 191 | |
| 192 | |
| 193 | Selection of Processor Architecture and Board Type: |
| 194 | --------------------------------------------------- |
| 195 | |
| 196 | For all supported boards there are ready-to-use default |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 197 | configurations available; just type "make <board_name>_defconfig". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 198 | |
| 199 | Example: For a TQM823L module type: |
| 200 | |
| 201 | cd u-boot |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 202 | make TQM823L_defconfig |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 203 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 204 | Note: If you're looking for the default configuration file for a board |
| 205 | you're sure used to be there but is now missing, check the file |
| 206 | doc/README.scrapyard for a list of no longer supported boards. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 207 | |
Simon Glass | 75b3c3a | 2014-03-22 17:12:59 -0600 | [diff] [blame] | 208 | Sandbox Environment: |
| 209 | -------------------- |
| 210 | |
| 211 | U-Boot can be built natively to run on a Linux host using the 'sandbox' |
| 212 | board. This allows feature development which is not board- or architecture- |
| 213 | specific to be undertaken on a native platform. The sandbox is also used to |
| 214 | run some of U-Boot's tests. |
| 215 | |
Jagannadha Sutradharudu Teki | 6b1978f | 2014-08-31 21:19:43 +0530 | [diff] [blame] | 216 | See board/sandbox/README.sandbox for more details. |
Simon Glass | 75b3c3a | 2014-03-22 17:12:59 -0600 | [diff] [blame] | 217 | |
| 218 | |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 219 | Board Initialisation Flow: |
| 220 | -------------------------- |
| 221 | |
| 222 | This is the intended start-up flow for boards. This should apply for both |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 223 | SPL and U-Boot proper (i.e. they both follow the same rules). |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 224 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 225 | Note: "SPL" stands for "Secondary Program Loader," which is explained in |
| 226 | more detail later in this file. |
| 227 | |
| 228 | At present, SPL mostly uses a separate code path, but the function names |
| 229 | and roles of each function are the same. Some boards or architectures |
| 230 | may not conform to this. At least most ARM boards which use |
| 231 | CONFIG_SPL_FRAMEWORK conform to this. |
| 232 | |
| 233 | Execution typically starts with an architecture-specific (and possibly |
| 234 | CPU-specific) start.S file, such as: |
| 235 | |
| 236 | - arch/arm/cpu/armv7/start.S |
| 237 | - arch/powerpc/cpu/mpc83xx/start.S |
| 238 | - arch/mips/cpu/start.S |
| 239 | |
| 240 | and so on. From there, three functions are called; the purpose and |
| 241 | limitations of each of these functions are described below. |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 242 | |
| 243 | lowlevel_init(): |
| 244 | - purpose: essential init to permit execution to reach board_init_f() |
| 245 | - no global_data or BSS |
| 246 | - there is no stack (ARMv7 may have one but it will soon be removed) |
| 247 | - must not set up SDRAM or use console |
| 248 | - must only do the bare minimum to allow execution to continue to |
| 249 | board_init_f() |
| 250 | - this is almost never needed |
| 251 | - return normally from this function |
| 252 | |
| 253 | board_init_f(): |
| 254 | - purpose: set up the machine ready for running board_init_r(): |
| 255 | i.e. SDRAM and serial UART |
| 256 | - global_data is available |
| 257 | - stack is in SRAM |
| 258 | - BSS is not available, so you cannot use global/static variables, |
| 259 | only stack variables and global_data |
| 260 | |
| 261 | Non-SPL-specific notes: |
| 262 | - dram_init() is called to set up DRAM. If already done in SPL this |
| 263 | can do nothing |
| 264 | |
| 265 | SPL-specific notes: |
| 266 | - you can override the entire board_init_f() function with your own |
| 267 | version as needed. |
| 268 | - preloader_console_init() can be called here in extremis |
| 269 | - should set up SDRAM, and anything needed to make the UART work |
| 270 | - these is no need to clear BSS, it will be done by crt0.S |
| 271 | - must return normally from this function (don't call board_init_r() |
| 272 | directly) |
| 273 | |
| 274 | Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at |
| 275 | this point the stack and global_data are relocated to below |
| 276 | CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of |
| 277 | memory. |
| 278 | |
| 279 | board_init_r(): |
| 280 | - purpose: main execution, common code |
| 281 | - global_data is available |
| 282 | - SDRAM is available |
| 283 | - BSS is available, all static/global variables can be used |
| 284 | - execution eventually continues to main_loop() |
| 285 | |
| 286 | Non-SPL-specific notes: |
| 287 | - U-Boot is relocated to the top of memory and is now running from |
| 288 | there. |
| 289 | |
| 290 | SPL-specific notes: |
| 291 | - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and |
| 292 | CONFIG_SPL_STACK_R_ADDR points into SDRAM |
| 293 | - preloader_console_init() can be called here - typically this is |
Ley Foon Tan | 0680f1b | 2017-05-03 17:13:32 +0800 | [diff] [blame] | 294 | done by selecting CONFIG_SPL_BOARD_INIT and then supplying a |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 295 | spl_board_init() function containing this call |
| 296 | - loads U-Boot or (in falcon mode) Linux |
| 297 | |
| 298 | |
| 299 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 300 | Configuration Options: |
| 301 | ---------------------- |
| 302 | |
| 303 | Configuration depends on the combination of board and CPU type; all |
| 304 | such information is kept in a configuration file |
| 305 | "include/configs/<board_name>.h". |
| 306 | |
| 307 | Example: For a TQM823L module, all configuration settings are in |
| 308 | "include/configs/TQM823L.h". |
| 309 | |
| 310 | |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 311 | Many of the options are named exactly as the corresponding Linux |
| 312 | kernel configuration options. The intention is to make it easier to |
| 313 | build a config tool - later. |
| 314 | |
Ashish Kumar | 63b2316 | 2017-08-11 11:09:14 +0530 | [diff] [blame] | 315 | - ARM Platform Bus Type(CCI): |
| 316 | CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which |
| 317 | provides full cache coherency between two clusters of multi-core |
| 318 | CPUs and I/O coherency for devices and I/O masters |
| 319 | |
| 320 | CONFIG_SYS_FSL_HAS_CCI400 |
| 321 | |
| 322 | Defined For SoC that has cache coherent interconnect |
| 323 | CCN-400 |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 324 | |
Ashish Kumar | c055cee | 2017-08-18 10:54:36 +0530 | [diff] [blame] | 325 | CONFIG_SYS_FSL_HAS_CCN504 |
| 326 | |
| 327 | Defined for SoC that has cache coherent interconnect CCN-504 |
| 328 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 329 | The following options need to be configured: |
| 330 | |
Kim Phillips | 2628114 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 331 | - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 332 | |
Kim Phillips | 2628114 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 333 | - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. |
Wolfgang Denk | 6ccec44 | 2006-10-24 14:42:37 +0200 | [diff] [blame] | 334 | |
Lei Wen | cf946c6 | 2011-02-09 18:06:58 +0530 | [diff] [blame] | 335 | - Marvell Family Member |
| 336 | CONFIG_SYS_MVFS - define it if you want to enable |
| 337 | multiple fs option at one time |
| 338 | for marvell soc family |
| 339 | |
Kumar Gala | 66412c6 | 2011-02-18 05:40:54 -0600 | [diff] [blame] | 340 | - 85xx CPU Options: |
York Sun | ffd06e0 | 2012-10-08 07:44:30 +0000 | [diff] [blame] | 341 | CONFIG_SYS_PPC64 |
| 342 | |
| 343 | Specifies that the core is a 64-bit PowerPC implementation (implements |
| 344 | the "64" category of the Power ISA). This is necessary for ePAPR |
| 345 | compliance, among other possible reasons. |
| 346 | |
Kumar Gala | 66412c6 | 2011-02-18 05:40:54 -0600 | [diff] [blame] | 347 | CONFIG_SYS_FSL_TBCLK_DIV |
| 348 | |
| 349 | Defines the core time base clock divider ratio compared to the |
| 350 | system clock. On most PQ3 devices this is 8, on newer QorIQ |
| 351 | devices it can be 16 or 32. The ratio varies from SoC to Soc. |
| 352 | |
Kumar Gala | 8f29084 | 2011-05-20 00:39:21 -0500 | [diff] [blame] | 353 | CONFIG_SYS_FSL_PCIE_COMPAT |
| 354 | |
| 355 | Defines the string to utilize when trying to match PCIe device |
| 356 | tree nodes for the given platform. |
| 357 | |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 358 | CONFIG_SYS_FSL_ERRATUM_A004510 |
| 359 | |
| 360 | Enables a workaround for erratum A004510. If set, |
| 361 | then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and |
| 362 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. |
| 363 | |
| 364 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV |
| 365 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) |
| 366 | |
| 367 | Defines one or two SoC revisions (low 8 bits of SVR) |
| 368 | for which the A004510 workaround should be applied. |
| 369 | |
| 370 | The rest of SVR is either not relevant to the decision |
| 371 | of whether the erratum is present (e.g. p2040 versus |
| 372 | p2041) or is implied by the build target, which controls |
| 373 | whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. |
| 374 | |
| 375 | See Freescale App Note 4493 for more information about |
| 376 | this erratum. |
| 377 | |
Prabhakar Kushwaha | 74fa22e | 2013-04-16 13:27:44 +0530 | [diff] [blame] | 378 | CONFIG_A003399_NOR_WORKAROUND |
| 379 | Enables a workaround for IFC erratum A003399. It is only |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 380 | required during NOR boot. |
Prabhakar Kushwaha | 74fa22e | 2013-04-16 13:27:44 +0530 | [diff] [blame] | 381 | |
Prabhakar Kushwaha | 9f074e6 | 2014-10-29 22:33:09 +0530 | [diff] [blame] | 382 | CONFIG_A008044_WORKAROUND |
| 383 | Enables a workaround for T1040/T1042 erratum A008044. It is only |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 384 | required during NAND boot and valid for Rev 1.0 SoC revision |
Prabhakar Kushwaha | 9f074e6 | 2014-10-29 22:33:09 +0530 | [diff] [blame] | 385 | |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 386 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY |
| 387 | |
| 388 | This is the value to write into CCSR offset 0x18600 |
| 389 | according to the A004510 workaround. |
| 390 | |
Priyanka Jain | 64501c6 | 2013-07-02 09:21:04 +0530 | [diff] [blame] | 391 | CONFIG_SYS_FSL_DSP_DDR_ADDR |
| 392 | This value denotes start offset of DDR memory which is |
| 393 | connected exclusively to the DSP cores. |
| 394 | |
Priyanka Jain | 765b0bd | 2013-04-04 09:31:54 +0530 | [diff] [blame] | 395 | CONFIG_SYS_FSL_DSP_M2_RAM_ADDR |
| 396 | This value denotes start offset of M2 memory |
| 397 | which is directly connected to the DSP core. |
| 398 | |
Priyanka Jain | 64501c6 | 2013-07-02 09:21:04 +0530 | [diff] [blame] | 399 | CONFIG_SYS_FSL_DSP_M3_RAM_ADDR |
| 400 | This value denotes start offset of M3 memory which is directly |
| 401 | connected to the DSP core. |
| 402 | |
Priyanka Jain | 765b0bd | 2013-04-04 09:31:54 +0530 | [diff] [blame] | 403 | CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT |
| 404 | This value denotes start offset of DSP CCSR space. |
| 405 | |
Priyanka Jain | b135991 | 2013-12-17 14:25:52 +0530 | [diff] [blame] | 406 | CONFIG_SYS_FSL_SINGLE_SOURCE_CLK |
| 407 | Single Source Clock is clocking mode present in some of FSL SoC's. |
| 408 | In this mode, a single differential clock is used to supply |
| 409 | clocks to the sysclock, ddrclock and usbclock. |
| 410 | |
Aneesh Bansal | fb4a240 | 2014-03-18 23:40:26 +0530 | [diff] [blame] | 411 | CONFIG_SYS_CPC_REINIT_F |
| 412 | This CONFIG is defined when the CPC is configured as SRAM at the |
Bin Meng | a187559 | 2016-02-05 19:30:11 -0800 | [diff] [blame] | 413 | time of U-Boot entry and is required to be re-initialized. |
Aneesh Bansal | fb4a240 | 2014-03-18 23:40:26 +0530 | [diff] [blame] | 414 | |
Tang Yuantian | aade200 | 2014-04-17 15:33:46 +0800 | [diff] [blame] | 415 | CONFIG_DEEP_SLEEP |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 416 | Indicates this SoC supports deep sleep feature. If deep sleep is |
Tang Yuantian | aade200 | 2014-04-17 15:33:46 +0800 | [diff] [blame] | 417 | supported, core will start to execute uboot when wakes up. |
| 418 | |
Daniel Schwierzeck | 6cb461b | 2012-04-02 02:57:56 +0000 | [diff] [blame] | 419 | - Generic CPU options: |
| 420 | CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN |
| 421 | |
| 422 | Defines the endianess of the CPU. Implementation of those |
| 423 | values is arch specific. |
| 424 | |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 425 | CONFIG_SYS_FSL_DDR |
| 426 | Freescale DDR driver in use. This type of DDR controller is |
| 427 | found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core |
| 428 | SoCs. |
| 429 | |
| 430 | CONFIG_SYS_FSL_DDR_ADDR |
| 431 | Freescale DDR memory-mapped register base. |
| 432 | |
| 433 | CONFIG_SYS_FSL_DDR_EMU |
| 434 | Specify emulator support for DDR. Some DDR features such as |
| 435 | deskew training are not available. |
| 436 | |
| 437 | CONFIG_SYS_FSL_DDRC_GEN1 |
| 438 | Freescale DDR1 controller. |
| 439 | |
| 440 | CONFIG_SYS_FSL_DDRC_GEN2 |
| 441 | Freescale DDR2 controller. |
| 442 | |
| 443 | CONFIG_SYS_FSL_DDRC_GEN3 |
| 444 | Freescale DDR3 controller. |
| 445 | |
York Sun | 34e026f | 2014-03-27 17:54:47 -0700 | [diff] [blame] | 446 | CONFIG_SYS_FSL_DDRC_GEN4 |
| 447 | Freescale DDR4 controller. |
| 448 | |
York Sun | 9ac4ffb | 2013-09-30 14:20:51 -0700 | [diff] [blame] | 449 | CONFIG_SYS_FSL_DDRC_ARM_GEN3 |
| 450 | Freescale DDR3 controller for ARM-based SoCs. |
| 451 | |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 452 | CONFIG_SYS_FSL_DDR1 |
| 453 | Board config to use DDR1. It can be enabled for SoCs with |
| 454 | Freescale DDR1 or DDR2 controllers, depending on the board |
| 455 | implemetation. |
| 456 | |
| 457 | CONFIG_SYS_FSL_DDR2 |
Robert P. J. Day | 62a3b7d | 2016-07-15 13:44:45 -0400 | [diff] [blame] | 458 | Board config to use DDR2. It can be enabled for SoCs with |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 459 | Freescale DDR2 or DDR3 controllers, depending on the board |
| 460 | implementation. |
| 461 | |
| 462 | CONFIG_SYS_FSL_DDR3 |
| 463 | Board config to use DDR3. It can be enabled for SoCs with |
York Sun | 34e026f | 2014-03-27 17:54:47 -0700 | [diff] [blame] | 464 | Freescale DDR3 or DDR3L controllers. |
| 465 | |
| 466 | CONFIG_SYS_FSL_DDR3L |
| 467 | Board config to use DDR3L. It can be enabled for SoCs with |
| 468 | DDR3L controllers. |
| 469 | |
| 470 | CONFIG_SYS_FSL_DDR4 |
| 471 | Board config to use DDR4. It can be enabled for SoCs with |
| 472 | DDR4 controllers. |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 473 | |
Prabhakar Kushwaha | 1b4175d | 2014-01-18 12:28:30 +0530 | [diff] [blame] | 474 | CONFIG_SYS_FSL_IFC_BE |
| 475 | Defines the IFC controller register space as Big Endian |
| 476 | |
| 477 | CONFIG_SYS_FSL_IFC_LE |
| 478 | Defines the IFC controller register space as Little Endian |
| 479 | |
Prabhakar Kushwaha | 1c40707 | 2017-02-02 15:01:26 +0530 | [diff] [blame] | 480 | CONFIG_SYS_FSL_IFC_CLK_DIV |
| 481 | Defines divider of platform clock(clock input to IFC controller). |
| 482 | |
Prabhakar Kushwaha | add63f9 | 2017-02-02 15:02:00 +0530 | [diff] [blame] | 483 | CONFIG_SYS_FSL_LBC_CLK_DIV |
| 484 | Defines divider of platform clock(clock input to eLBC controller). |
| 485 | |
Prabhakar Kushwaha | 690e425 | 2014-01-13 11:28:04 +0530 | [diff] [blame] | 486 | CONFIG_SYS_FSL_PBL_PBI |
| 487 | It enables addition of RCW (Power on reset configuration) in built image. |
| 488 | Please refer doc/README.pblimage for more details |
| 489 | |
| 490 | CONFIG_SYS_FSL_PBL_RCW |
| 491 | It adds PBI(pre-boot instructions) commands in u-boot build image. |
| 492 | PBI commands can be used to configure SoC before it starts the execution. |
| 493 | Please refer doc/README.pblimage for more details |
| 494 | |
Prabhakar Kushwaha | 89ad7be | 2014-04-08 19:13:34 +0530 | [diff] [blame] | 495 | CONFIG_SPL_FSL_PBL |
| 496 | It adds a target to create boot binary having SPL binary in PBI format |
| 497 | concatenated with u-boot binary. |
| 498 | |
York Sun | 4e5b1bd | 2014-02-10 13:59:42 -0800 | [diff] [blame] | 499 | CONFIG_SYS_FSL_DDR_BE |
| 500 | Defines the DDR controller register space as Big Endian |
| 501 | |
| 502 | CONFIG_SYS_FSL_DDR_LE |
| 503 | Defines the DDR controller register space as Little Endian |
| 504 | |
York Sun | 6b9e309 | 2014-02-10 13:59:43 -0800 | [diff] [blame] | 505 | CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY |
| 506 | Physical address from the view of DDR controllers. It is the |
| 507 | same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But |
| 508 | it could be different for ARM SoCs. |
| 509 | |
York Sun | 6b1e125 | 2014-02-10 13:59:44 -0800 | [diff] [blame] | 510 | CONFIG_SYS_FSL_DDR_INTLV_256B |
| 511 | DDR controller interleaving on 256-byte. This is a special |
| 512 | interleaving mode, handled by Dickens for Freescale layerscape |
| 513 | SoCs with ARM core. |
| 514 | |
York Sun | 1d71efb | 2014-08-01 15:51:00 -0700 | [diff] [blame] | 515 | CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS |
| 516 | Number of controllers used as main memory. |
| 517 | |
| 518 | CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS |
| 519 | Number of controllers used for other than main memory. |
| 520 | |
Prabhakar Kushwaha | 4493721 | 2015-11-09 16:42:07 +0530 | [diff] [blame] | 521 | CONFIG_SYS_FSL_HAS_DP_DDR |
| 522 | Defines the SoC has DP-DDR used for DPAA. |
| 523 | |
Ruchika Gupta | 028dbb8 | 2014-09-09 11:50:31 +0530 | [diff] [blame] | 524 | CONFIG_SYS_FSL_SEC_BE |
| 525 | Defines the SEC controller register space as Big Endian |
| 526 | |
| 527 | CONFIG_SYS_FSL_SEC_LE |
| 528 | Defines the SEC controller register space as Little Endian |
| 529 | |
Daniel Schwierzeck | 92bbd64 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 530 | - MIPS CPU options: |
| 531 | CONFIG_SYS_INIT_SP_OFFSET |
| 532 | |
| 533 | Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack |
| 534 | pointer. This is needed for the temporary stack before |
| 535 | relocation. |
| 536 | |
| 537 | CONFIG_SYS_MIPS_CACHE_MODE |
| 538 | |
| 539 | Cache operation mode for the MIPS CPU. |
| 540 | See also arch/mips/include/asm/mipsregs.h. |
| 541 | Possible values are: |
| 542 | CONF_CM_CACHABLE_NO_WA |
| 543 | CONF_CM_CACHABLE_WA |
| 544 | CONF_CM_UNCACHED |
| 545 | CONF_CM_CACHABLE_NONCOHERENT |
| 546 | CONF_CM_CACHABLE_CE |
| 547 | CONF_CM_CACHABLE_COW |
| 548 | CONF_CM_CACHABLE_CUW |
| 549 | CONF_CM_CACHABLE_ACCELERATED |
| 550 | |
| 551 | CONFIG_SYS_XWAY_EBU_BOOTCFG |
| 552 | |
| 553 | Special option for Lantiq XWAY SoCs for booting from NOR flash. |
| 554 | See also arch/mips/cpu/mips32/start.S. |
| 555 | |
| 556 | CONFIG_XWAY_SWAP_BYTES |
| 557 | |
| 558 | Enable compilation of tools/xway-swap-bytes needed for Lantiq |
| 559 | XWAY SoCs for booting from NOR flash. The U-Boot image needs to |
| 560 | be swapped if a flash programmer is used. |
| 561 | |
Christian Riesch | b67d881 | 2012-02-02 00:44:39 +0000 | [diff] [blame] | 562 | - ARM options: |
| 563 | CONFIG_SYS_EXCEPTION_VECTORS_HIGH |
| 564 | |
| 565 | Select high exception vectors of the ARM core, e.g., do not |
| 566 | clear the V bit of the c1 register of CP15. |
| 567 | |
York Sun | 207774b | 2015-03-20 19:28:08 -0700 | [diff] [blame] | 568 | COUNTER_FREQUENCY |
| 569 | Generic timer clock source frequency. |
| 570 | |
| 571 | COUNTER_FREQUENCY_REAL |
| 572 | Generic timer clock source frequency if the real clock is |
| 573 | different from COUNTER_FREQUENCY, and can only be determined |
| 574 | at run time. |
| 575 | |
Stephen Warren | 73c3893 | 2015-01-19 16:25:52 -0700 | [diff] [blame] | 576 | - Tegra SoC options: |
| 577 | CONFIG_TEGRA_SUPPORT_NON_SECURE |
| 578 | |
| 579 | Support executing U-Boot in non-secure (NS) mode. Certain |
| 580 | impossible actions will be skipped if the CPU is in NS mode, |
| 581 | such as ARM architectural timer initialization. |
| 582 | |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 583 | - Linux Kernel Interface: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 584 | CONFIG_CLOCKS_IN_MHZ |
| 585 | |
| 586 | U-Boot stores all clock information in Hz |
| 587 | internally. For binary compatibility with older Linux |
| 588 | kernels (which expect the clocks passed in the |
| 589 | bd_info data to be in MHz) the environment variable |
| 590 | "clocks_in_mhz" can be defined so that U-Boot |
| 591 | converts clock data to MHZ before passing it to the |
| 592 | Linux kernel. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 593 | When CONFIG_CLOCKS_IN_MHZ is defined, a definition of |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 594 | "clocks_in_mhz=1" is automatically included in the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 595 | default environment. |
| 596 | |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 597 | CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] |
| 598 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 599 | When transferring memsize parameter to Linux, some versions |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 600 | expect it to be in bytes, others in MB. |
| 601 | Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. |
| 602 | |
Gerald Van Baren | fec6d9e | 2008-06-03 20:34:45 -0400 | [diff] [blame] | 603 | CONFIG_OF_LIBFDT |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 604 | |
| 605 | New kernel versions are expecting firmware settings to be |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 606 | passed using flattened device trees (based on open firmware |
| 607 | concepts). |
| 608 | |
| 609 | CONFIG_OF_LIBFDT |
| 610 | * New libfdt-based support |
| 611 | * Adds the "fdt" command |
Kim Phillips | 3bb342f | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 612 | * The bootm command automatically updates the fdt |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 613 | |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 614 | OF_TBCLK - The timebase frequency. |
Kumar Gala | c2871f0 | 2006-01-11 13:59:02 -0600 | [diff] [blame] | 615 | OF_STDOUT_PATH - The path to the console device |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 616 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 617 | boards with QUICC Engines require OF_QE to set UCC MAC |
| 618 | addresses |
Kim Phillips | 3bb342f | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 619 | |
Kumar Gala | 4e25313 | 2006-01-11 13:54:17 -0600 | [diff] [blame] | 620 | CONFIG_OF_BOARD_SETUP |
| 621 | |
| 622 | Board code has addition modification that it wants to make |
| 623 | to the flat device tree before handing it off to the kernel |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 624 | |
Simon Glass | c654b51 | 2014-10-23 18:58:54 -0600 | [diff] [blame] | 625 | CONFIG_OF_SYSTEM_SETUP |
| 626 | |
| 627 | Other code has addition modification that it wants to make |
| 628 | to the flat device tree before handing it off to the kernel. |
| 629 | This causes ft_system_setup() to be called before booting |
| 630 | the kernel. |
| 631 | |
Heiko Schocher | 3887c3f | 2009-09-23 07:56:08 +0200 | [diff] [blame] | 632 | CONFIG_OF_IDE_FIXUP |
| 633 | |
| 634 | U-Boot can detect if an IDE device is present or not. |
| 635 | If not, and this new config option is activated, U-Boot |
| 636 | removes the ATA node from the DTS before booting Linux, |
| 637 | so the Linux IDE driver does not probe the device and |
| 638 | crash. This is needed for buggy hardware (uc101) where |
| 639 | no pull down resistor is connected to the signal IDE5V_DD7. |
| 640 | |
Igor Grinberg | 7eb2939 | 2011-07-14 05:45:07 +0000 | [diff] [blame] | 641 | CONFIG_MACH_TYPE [relevant for ARM only][mandatory] |
| 642 | |
| 643 | This setting is mandatory for all boards that have only one |
| 644 | machine type and must be used to specify the machine type |
| 645 | number as it appears in the ARM machine registry |
| 646 | (see http://www.arm.linux.org.uk/developer/machines/). |
| 647 | Only boards that have multiple machine types supported |
| 648 | in a single configuration file and the machine type is |
| 649 | runtime discoverable, do not have to use this setting. |
| 650 | |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 651 | - vxWorks boot parameters: |
| 652 | |
| 653 | bootvx constructs a valid bootline using the following |
Bin Meng | 9e98b7e | 2015-10-07 20:19:17 -0700 | [diff] [blame] | 654 | environments variables: bootdev, bootfile, ipaddr, netmask, |
| 655 | serverip, gatewayip, hostname, othbootargs. |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 656 | It loads the vxWorks image pointed bootfile. |
| 657 | |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 658 | Note: If a "bootargs" environment is defined, it will overwride |
| 659 | the defaults discussed just above. |
| 660 | |
Aneesh V | 2c451f7 | 2011-06-16 23:30:47 +0000 | [diff] [blame] | 661 | - Cache Configuration: |
| 662 | CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot |
| 663 | CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot |
| 664 | CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot |
| 665 | |
Aneesh V | 93bc219 | 2011-06-16 23:30:51 +0000 | [diff] [blame] | 666 | - Cache Configuration for ARM: |
| 667 | CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache |
| 668 | controller |
| 669 | CONFIG_SYS_PL310_BASE - Physical base address of PL310 |
| 670 | controller register space |
| 671 | |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 672 | - Serial Ports: |
Andreas Engel | 48d0192 | 2008-09-08 14:30:53 +0200 | [diff] [blame] | 673 | CONFIG_PL010_SERIAL |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 674 | |
| 675 | Define this if you want support for Amba PrimeCell PL010 UARTs. |
| 676 | |
Andreas Engel | 48d0192 | 2008-09-08 14:30:53 +0200 | [diff] [blame] | 677 | CONFIG_PL011_SERIAL |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 678 | |
| 679 | Define this if you want support for Amba PrimeCell PL011 UARTs. |
| 680 | |
| 681 | CONFIG_PL011_CLOCK |
| 682 | |
| 683 | If you have Amba PrimeCell PL011 UARTs, set this variable to |
| 684 | the clock speed of the UARTs. |
| 685 | |
| 686 | CONFIG_PL01x_PORTS |
| 687 | |
| 688 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, |
| 689 | define this to a list of base addresses for each (supported) |
| 690 | port. See e.g. include/configs/versatile.h |
| 691 | |
Karicheri, Muralidharan | d57dee5 | 2014-04-09 15:38:46 -0400 | [diff] [blame] | 692 | CONFIG_SERIAL_HW_FLOW_CONTROL |
| 693 | |
| 694 | Define this variable to enable hw flow control in serial driver. |
| 695 | Current user of this option is drivers/serial/nsl16550.c driver |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 696 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 697 | - Console Baudrate: |
| 698 | CONFIG_BAUDRATE - in bps |
| 699 | Select one of the baudrates listed in |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 700 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 701 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 702 | - Autoboot Command: |
| 703 | CONFIG_BOOTCOMMAND |
| 704 | Only needed when CONFIG_BOOTDELAY is enabled; |
| 705 | define a command string that is automatically executed |
| 706 | when no character is read on the console interface |
| 707 | within "Boot Delay" after reset. |
| 708 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 709 | CONFIG_RAMBOOT and CONFIG_NFSBOOT |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 710 | The value of these goes into the environment as |
| 711 | "ramboot" and "nfsboot" respectively, and can be used |
| 712 | as a convenience, when switching between booting from |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 713 | RAM and NFS. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 714 | |
Heiko Schocher | eda0ba3 | 2013-11-04 14:04:59 +0100 | [diff] [blame] | 715 | - Bootcount: |
| 716 | CONFIG_BOOTCOUNT_LIMIT |
| 717 | Implements a mechanism for detecting a repeating reboot |
| 718 | cycle, see: |
| 719 | http://www.denx.de/wiki/view/DULG/UBootBootCountLimit |
| 720 | |
| 721 | CONFIG_BOOTCOUNT_ENV |
| 722 | If no softreset save registers are found on the hardware |
| 723 | "bootcount" is stored in the environment. To prevent a |
| 724 | saveenv on all reboots, the environment variable |
| 725 | "upgrade_available" is used. If "upgrade_available" is |
| 726 | 0, "bootcount" is always 0, if "upgrade_available" is |
| 727 | 1 "bootcount" is incremented in the environment. |
| 728 | So the Userspace Applikation must set the "upgrade_available" |
| 729 | and "bootcount" variable to 0, if a boot was successfully. |
| 730 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 731 | - Pre-Boot Commands: |
| 732 | CONFIG_PREBOOT |
| 733 | |
| 734 | When this option is #defined, the existence of the |
| 735 | environment variable "preboot" will be checked |
| 736 | immediately before starting the CONFIG_BOOTDELAY |
| 737 | countdown and/or running the auto-boot command resp. |
| 738 | entering interactive mode. |
| 739 | |
| 740 | This feature is especially useful when "preboot" is |
| 741 | automatically generated or modified. For an example |
| 742 | see the LWMON board specific code: here "preboot" is |
| 743 | modified when the user holds down a certain |
| 744 | combination of keys on the (special) keyboard when |
| 745 | booting the systems |
| 746 | |
| 747 | - Serial Download Echo Mode: |
| 748 | CONFIG_LOADS_ECHO |
| 749 | If defined to 1, all characters received during a |
| 750 | serial download (using the "loads" command) are |
| 751 | echoed back. This might be needed by some terminal |
| 752 | emulations (like "cu"), but may as well just take |
| 753 | time on others. This setting #define's the initial |
| 754 | value of the "loads_echo" environment variable. |
| 755 | |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 756 | - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 757 | CONFIG_KGDB_BAUDRATE |
| 758 | Select one of the baudrates listed in |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 759 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 760 | |
Simon Glass | 302a648 | 2016-03-13 19:07:28 -0600 | [diff] [blame] | 761 | - Removal of commands |
| 762 | If no commands are needed to boot, you can disable |
| 763 | CONFIG_CMDLINE to remove them. In this case, the command line |
| 764 | will not be available, and when U-Boot wants to execute the |
| 765 | boot command (on start-up) it will call board_run_command() |
| 766 | instead. This can reduce image size significantly for very |
| 767 | simple boot procedures. |
| 768 | |
Wolfgang Denk | a5ecbe6 | 2013-03-23 23:50:31 +0000 | [diff] [blame] | 769 | - Regular expression support: |
| 770 | CONFIG_REGEX |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 771 | If this variable is defined, U-Boot is linked against |
| 772 | the SLRE (Super Light Regular Expression) library, |
| 773 | which adds regex support to some commands, as for |
| 774 | example "env grep" and "setexpr". |
Wolfgang Denk | a5ecbe6 | 2013-03-23 23:50:31 +0000 | [diff] [blame] | 775 | |
Simon Glass | 45ba807 | 2011-10-15 05:48:20 +0000 | [diff] [blame] | 776 | - Device tree: |
| 777 | CONFIG_OF_CONTROL |
| 778 | If this variable is defined, U-Boot will use a device tree |
| 779 | to configure its devices, instead of relying on statically |
| 780 | compiled #defines in the board file. This option is |
| 781 | experimental and only available on a few boards. The device |
| 782 | tree is available in the global data as gd->fdt_blob. |
| 783 | |
Simon Glass | 2c0f79e | 2011-10-24 19:15:31 +0000 | [diff] [blame] | 784 | U-Boot needs to get its device tree from somewhere. This can |
Alex Deymo | 82f766d | 2017-04-02 01:25:20 -0700 | [diff] [blame] | 785 | be done using one of the three options below: |
Simon Glass | bbb0b12 | 2011-10-15 05:48:21 +0000 | [diff] [blame] | 786 | |
| 787 | CONFIG_OF_EMBED |
| 788 | If this variable is defined, U-Boot will embed a device tree |
| 789 | binary in its image. This device tree file should be in the |
| 790 | board directory and called <soc>-<board>.dts. The binary file |
| 791 | is then picked up in board_init_f() and made available through |
Nobuhiro Iwamatsu | eb3eb60 | 2017-08-26 07:34:14 +0900 | [diff] [blame] | 792 | the global data structure as gd->fdt_blob. |
Simon Glass | 45ba807 | 2011-10-15 05:48:20 +0000 | [diff] [blame] | 793 | |
Simon Glass | 2c0f79e | 2011-10-24 19:15:31 +0000 | [diff] [blame] | 794 | CONFIG_OF_SEPARATE |
| 795 | If this variable is defined, U-Boot will build a device tree |
| 796 | binary. It will be called u-boot.dtb. Architecture-specific |
| 797 | code will locate it at run-time. Generally this works by: |
| 798 | |
| 799 | cat u-boot.bin u-boot.dtb >image.bin |
| 800 | |
| 801 | and in fact, U-Boot does this for you, creating a file called |
| 802 | u-boot-dtb.bin which is useful in the common case. You can |
| 803 | still use the individual files if you need something more |
| 804 | exotic. |
| 805 | |
Alex Deymo | 82f766d | 2017-04-02 01:25:20 -0700 | [diff] [blame] | 806 | CONFIG_OF_BOARD |
| 807 | If this variable is defined, U-Boot will use the device tree |
| 808 | provided by the board at runtime instead of embedding one with |
| 809 | the image. Only boards defining board_fdt_blob_setup() support |
| 810 | this option (see include/fdtdec.h file). |
| 811 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 812 | - Watchdog: |
| 813 | CONFIG_WATCHDOG |
| 814 | If this variable is defined, it enables watchdog |
Detlev Zundel | 6abe6fb | 2011-04-27 05:25:59 +0000 | [diff] [blame] | 815 | support for the SoC. There must be support in the SoC |
Christophe Leroy | 907208c | 2017-07-06 10:23:22 +0200 | [diff] [blame] | 816 | specific code for a watchdog. For the 8xx |
| 817 | CPUs, the SIU Watchdog feature is enabled in the SYPCR |
| 818 | register. When supported for a specific SoC is |
| 819 | available, then no further board specific code should |
| 820 | be needed to use it. |
Detlev Zundel | 6abe6fb | 2011-04-27 05:25:59 +0000 | [diff] [blame] | 821 | |
| 822 | CONFIG_HW_WATCHDOG |
| 823 | When using a watchdog circuitry external to the used |
| 824 | SoC, then define this variable and provide board |
| 825 | specific code for the "hw_watchdog_reset" function. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 826 | |
Heiko Schocher | 7bae0d6 | 2015-01-21 08:38:22 +0100 | [diff] [blame] | 827 | CONFIG_AT91_HW_WDT_TIMEOUT |
| 828 | specify the timeout in seconds. default 2 seconds. |
| 829 | |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 830 | - U-Boot Version: |
| 831 | CONFIG_VERSION_VARIABLE |
| 832 | If this variable is defined, an environment variable |
| 833 | named "ver" is created by U-Boot showing the U-Boot |
| 834 | version as printed by the "version" command. |
Benoît Thébaudeau | a1ea8e51 | 2012-08-13 15:01:14 +0200 | [diff] [blame] | 835 | Any change to this variable will be reverted at the |
| 836 | next reset. |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 837 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 838 | - Real-Time Clock: |
| 839 | |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 840 | When CONFIG_CMD_DATE is selected, the type of the RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 841 | has to be selected, too. Define exactly one of the |
| 842 | following options: |
| 843 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 844 | CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC |
Fabio Estevam | 4e8b754 | 2011-10-24 06:44:15 +0000 | [diff] [blame] | 845 | CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 846 | CONFIG_RTC_MC146818 - use MC146818 RTC |
wdenk | 1cb8e98 | 2003-03-06 21:55:29 +0000 | [diff] [blame] | 847 | CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 848 | CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC |
wdenk | 7f70e85 | 2003-05-20 14:25:27 +0000 | [diff] [blame] | 849 | CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC |
Markus Niebel | 412921d | 2014-07-21 11:06:16 +0200 | [diff] [blame] | 850 | CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC |
wdenk | 3bac351 | 2003-03-12 10:41:04 +0000 | [diff] [blame] | 851 | CONFIG_RTC_DS164x - use Dallas DS164x RTC |
Tor Krill | 9536dfc | 2008-03-15 15:40:26 +0100 | [diff] [blame] | 852 | CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC |
wdenk | 4c0d4c3 | 2004-06-09 17:34:58 +0000 | [diff] [blame] | 853 | CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC |
Chris Packham | 2bd3cab | 2017-05-30 12:03:33 +1200 | [diff] [blame] | 854 | CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 |
Heiko Schocher | 71d19f3 | 2011-03-28 09:24:22 +0200 | [diff] [blame] | 855 | CONFIG_SYS_RV3029_TCR - enable trickle charger on |
| 856 | RV3029 RTC. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 857 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 858 | Note that if the RTC uses I2C, then the I2C interface |
| 859 | must also be configured. See I2C Support, below. |
| 860 | |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 861 | - GPIO Support: |
| 862 | CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 863 | |
Chris Packham | 5dec49c | 2010-12-19 10:12:13 +0000 | [diff] [blame] | 864 | The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of |
| 865 | chip-ngpio pairs that tell the PCA953X driver the number of |
| 866 | pins supported by a particular chip. |
| 867 | |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 868 | Note that if the GPIO device uses I2C, then the I2C interface |
| 869 | must also be configured. See I2C Support, below. |
| 870 | |
Simon Glass | aa53233 | 2014-06-11 23:29:41 -0600 | [diff] [blame] | 871 | - I/O tracing: |
| 872 | When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O |
| 873 | accesses and can checksum them or write a list of them out |
| 874 | to memory. See the 'iotrace' command for details. This is |
| 875 | useful for testing device drivers since it can confirm that |
| 876 | the driver behaves the same way before and after a code |
| 877 | change. Currently this is supported on sandbox and arm. To |
| 878 | add support for your architecture, add '#include <iotrace.h>' |
| 879 | to the bottom of arch/<arch>/include/asm/io.h and test. |
| 880 | |
| 881 | Example output from the 'iotrace stats' command is below. |
| 882 | Note that if the trace buffer is exhausted, the checksum will |
| 883 | still continue to operate. |
| 884 | |
| 885 | iotrace is enabled |
| 886 | Start: 10000000 (buffer start address) |
| 887 | Size: 00010000 (buffer size) |
| 888 | Offset: 00000120 (current buffer offset) |
| 889 | Output: 10000120 (start + offset) |
| 890 | Count: 00000018 (number of trace records) |
| 891 | CRC32: 9526fb66 (CRC32 of all trace records) |
| 892 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 893 | - Timestamp Support: |
| 894 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 895 | When CONFIG_TIMESTAMP is selected, the timestamp |
| 896 | (date and time) of an image is printed by image |
| 897 | commands like bootm or iminfo. This option is |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 898 | automatically enabled when you select CONFIG_CMD_DATE . |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 899 | |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 900 | - Partition Labels (disklabels) Supported: |
| 901 | Zero or more of the following: |
| 902 | CONFIG_MAC_PARTITION Apple's MacOS partition table. |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 903 | CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. |
| 904 | CONFIG_EFI_PARTITION GPT partition table, common when EFI is the |
| 905 | bootloader. Note 2TB partition limit; see |
| 906 | disk/part_efi.c |
| 907 | CONFIG_MTD_PARTITIONS Memory Technology Device partition table. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 908 | |
Simon Glass | fc843a0 | 2017-05-17 03:25:30 -0600 | [diff] [blame] | 909 | If IDE or SCSI support is enabled (CONFIG_IDE or |
Simon Glass | c649e3c | 2016-05-01 11:36:02 -0600 | [diff] [blame] | 910 | CONFIG_SCSI) you must configure support for at |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 911 | least one non-MTD partition type as well. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 912 | |
| 913 | - IDE Reset method: |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 914 | CONFIG_IDE_RESET_ROUTINE - this is defined in several |
| 915 | board configurations files but used nowhere! |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 916 | |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 917 | CONFIG_IDE_RESET - is this is defined, IDE Reset will |
| 918 | be performed by calling the function |
| 919 | ide_set_reset(int reset) |
| 920 | which has to be defined in a board specific file |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 921 | |
| 922 | - ATAPI Support: |
| 923 | CONFIG_ATAPI |
| 924 | |
| 925 | Set this to enable ATAPI support. |
| 926 | |
wdenk | c40b295 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 927 | - LBA48 Support |
| 928 | CONFIG_LBA48 |
| 929 | |
| 930 | Set this to enable support for disks larger than 137GB |
Heiko Schocher | 4b142fe | 2009-12-03 11:21:21 +0100 | [diff] [blame] | 931 | Also look at CONFIG_SYS_64BIT_LBA. |
wdenk | c40b295 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 932 | Whithout these , LBA48 support uses 32bit variables and will 'only' |
| 933 | support disks up to 2.1TB. |
| 934 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 935 | CONFIG_SYS_64BIT_LBA: |
wdenk | c40b295 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 936 | When enabled, makes the IDE subsystem use 64bit sector addresses. |
| 937 | Default is 32bit. |
| 938 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 939 | - SCSI Support: |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 940 | CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and |
| 941 | CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * |
| 942 | CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 943 | maximum numbers of LUNs, SCSI ID's and target |
| 944 | devices. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 945 | |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 946 | The environment variable 'scsidevs' is set to the number of |
| 947 | SCSI devices found during the last scan. |
Stefan Reinauer | 447c031 | 2012-10-29 05:23:48 +0000 | [diff] [blame] | 948 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 949 | - NETWORK Support (PCI): |
wdenk | 682011f | 2003-06-03 23:54:09 +0000 | [diff] [blame] | 950 | CONFIG_E1000 |
Kyle Moffett | ce5207e | 2011-10-18 11:05:29 +0000 | [diff] [blame] | 951 | Support for Intel 8254x/8257x gigabit chips. |
| 952 | |
| 953 | CONFIG_E1000_SPI |
| 954 | Utility code for direct access to the SPI bus on Intel 8257x. |
| 955 | This does not do anything useful unless you set at least one |
| 956 | of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. |
| 957 | |
| 958 | CONFIG_E1000_SPI_GENERIC |
| 959 | Allow generic access to the SPI bus on the Intel 8257x, for |
| 960 | example with the "sspi" command. |
| 961 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 962 | CONFIG_EEPRO100 |
| 963 | Support for Intel 82557/82559/82559ER chips. |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 964 | Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 965 | write routine for first time initialisation. |
| 966 | |
| 967 | CONFIG_TULIP |
| 968 | Support for Digital 2114x chips. |
| 969 | Optional CONFIG_TULIP_SELECT_MEDIA for board specific |
| 970 | modem chip initialisation (KS8761/QS6611). |
| 971 | |
| 972 | CONFIG_NATSEMI |
| 973 | Support for National dp83815 chips. |
| 974 | |
| 975 | CONFIG_NS8382X |
| 976 | Support for National dp8382[01] gigabit chips. |
| 977 | |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 978 | - NETWORK Support (other): |
| 979 | |
Jens Scharsig | c041e9d | 2010-01-23 12:03:45 +0100 | [diff] [blame] | 980 | CONFIG_DRIVER_AT91EMAC |
| 981 | Support for AT91RM9200 EMAC. |
| 982 | |
| 983 | CONFIG_RMII |
| 984 | Define this to use reduced MII inteface |
| 985 | |
| 986 | CONFIG_DRIVER_AT91EMAC_QUIET |
| 987 | If this defined, the driver is quiet. |
| 988 | The driver doen't show link status messages. |
| 989 | |
Rob Herring | efdd731 | 2011-12-15 11:15:49 +0000 | [diff] [blame] | 990 | CONFIG_CALXEDA_XGMAC |
| 991 | Support for the Calxeda XGMAC device |
| 992 | |
Ashok | 3bb46d2 | 2012-10-15 06:20:47 +0000 | [diff] [blame] | 993 | CONFIG_LAN91C96 |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 994 | Support for SMSC's LAN91C96 chips. |
| 995 | |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 996 | CONFIG_LAN91C96_USE_32_BIT |
| 997 | Define this to enable 32 bit addressing |
| 998 | |
Ashok | 3bb46d2 | 2012-10-15 06:20:47 +0000 | [diff] [blame] | 999 | CONFIG_SMC91111 |
wdenk | f39748a | 2004-06-09 13:37:52 +0000 | [diff] [blame] | 1000 | Support for SMSC's LAN91C111 chip |
| 1001 | |
| 1002 | CONFIG_SMC91111_BASE |
| 1003 | Define this to hold the physical address |
| 1004 | of the device (I/O space) |
| 1005 | |
| 1006 | CONFIG_SMC_USE_32_BIT |
| 1007 | Define this if data bus is 32 bits |
| 1008 | |
| 1009 | CONFIG_SMC_USE_IOFUNCS |
| 1010 | Define this to use i/o functions instead of macros |
| 1011 | (some hardware wont work with macros) |
| 1012 | |
Heiko Schocher | dc02bad | 2011-11-15 10:00:04 -0500 | [diff] [blame] | 1013 | CONFIG_DRIVER_TI_EMAC |
| 1014 | Support for davinci emac |
| 1015 | |
| 1016 | CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT |
| 1017 | Define this if you have more then 3 PHYs. |
| 1018 | |
Macpaul Lin | b3dbf4a5 | 2010-12-21 16:59:46 +0800 | [diff] [blame] | 1019 | CONFIG_FTGMAC100 |
| 1020 | Support for Faraday's FTGMAC100 Gigabit SoC Ethernet |
| 1021 | |
| 1022 | CONFIG_FTGMAC100_EGIGA |
| 1023 | Define this to use GE link update with gigabit PHY. |
| 1024 | Define this if FTGMAC100 is connected to gigabit PHY. |
| 1025 | If your system has 10/100 PHY only, it might not occur |
| 1026 | wrong behavior. Because PHY usually return timeout or |
| 1027 | useless data when polling gigabit status and gigabit |
| 1028 | control registers. This behavior won't affect the |
| 1029 | correctnessof 10/100 link speed update. |
| 1030 | |
Yoshihiro Shimoda | 3d0075f | 2011-01-27 10:06:03 +0900 | [diff] [blame] | 1031 | CONFIG_SH_ETHER |
| 1032 | Support for Renesas on-chip Ethernet controller |
| 1033 | |
| 1034 | CONFIG_SH_ETHER_USE_PORT |
| 1035 | Define the number of ports to be used |
| 1036 | |
| 1037 | CONFIG_SH_ETHER_PHY_ADDR |
| 1038 | Define the ETH PHY's address |
| 1039 | |
Yoshihiro Shimoda | 68260aa | 2011-01-27 10:06:08 +0900 | [diff] [blame] | 1040 | CONFIG_SH_ETHER_CACHE_WRITEBACK |
| 1041 | If this option is set, the driver enables cache flush. |
| 1042 | |
Heiko Schocher | b2f97cf | 2014-07-18 06:07:19 +0200 | [diff] [blame] | 1043 | - PWM Support: |
| 1044 | CONFIG_PWM_IMX |
Robert P. J. Day | 5052e81 | 2016-09-13 08:35:18 -0400 | [diff] [blame] | 1045 | Support for PWM module on the imx6. |
Heiko Schocher | b2f97cf | 2014-07-18 06:07:19 +0200 | [diff] [blame] | 1046 | |
Vadim Bendebury | 5e12472 | 2011-10-17 08:36:14 +0000 | [diff] [blame] | 1047 | - TPM Support: |
Che-liang Chiou | 90899cc | 2013-04-12 11:04:34 +0000 | [diff] [blame] | 1048 | CONFIG_TPM |
| 1049 | Support TPM devices. |
| 1050 | |
Christophe Ricard | 0766ad2 | 2015-10-06 22:54:41 +0200 | [diff] [blame] | 1051 | CONFIG_TPM_TIS_INFINEON |
| 1052 | Support for Infineon i2c bus TPM devices. Only one device |
Tom Wai-Hong Tam | 1b393db | 2013-04-12 11:04:37 +0000 | [diff] [blame] | 1053 | per system is supported at this time. |
| 1054 | |
Tom Wai-Hong Tam | 1b393db | 2013-04-12 11:04:37 +0000 | [diff] [blame] | 1055 | CONFIG_TPM_TIS_I2C_BURST_LIMITATION |
| 1056 | Define the burst count bytes upper limit |
| 1057 | |
Christophe Ricard | 3aa7408 | 2016-01-21 23:27:13 +0100 | [diff] [blame] | 1058 | CONFIG_TPM_ST33ZP24 |
| 1059 | Support for STMicroelectronics TPM devices. Requires DM_TPM support. |
| 1060 | |
| 1061 | CONFIG_TPM_ST33ZP24_I2C |
| 1062 | Support for STMicroelectronics ST33ZP24 I2C devices. |
| 1063 | Requires TPM_ST33ZP24 and I2C. |
| 1064 | |
Christophe Ricard | b75fdc1 | 2016-01-21 23:27:14 +0100 | [diff] [blame] | 1065 | CONFIG_TPM_ST33ZP24_SPI |
| 1066 | Support for STMicroelectronics ST33ZP24 SPI devices. |
| 1067 | Requires TPM_ST33ZP24 and SPI. |
| 1068 | |
Dirk Eibach | c01939c | 2013-06-26 15:55:15 +0200 | [diff] [blame] | 1069 | CONFIG_TPM_ATMEL_TWI |
| 1070 | Support for Atmel TWI TPM device. Requires I2C support. |
| 1071 | |
Che-liang Chiou | 90899cc | 2013-04-12 11:04:34 +0000 | [diff] [blame] | 1072 | CONFIG_TPM_TIS_LPC |
Vadim Bendebury | 5e12472 | 2011-10-17 08:36:14 +0000 | [diff] [blame] | 1073 | Support for generic parallel port TPM devices. Only one device |
| 1074 | per system is supported at this time. |
| 1075 | |
| 1076 | CONFIG_TPM_TIS_BASE_ADDRESS |
| 1077 | Base address where the generic TPM device is mapped |
| 1078 | to. Contemporary x86 systems usually map it at |
| 1079 | 0xfed40000. |
| 1080 | |
Reinhard Pfau | be6c152 | 2013-06-26 15:55:13 +0200 | [diff] [blame] | 1081 | CONFIG_TPM |
| 1082 | Define this to enable the TPM support library which provides |
| 1083 | functional interfaces to some TPM commands. |
| 1084 | Requires support for a TPM device. |
| 1085 | |
| 1086 | CONFIG_TPM_AUTH_SESSIONS |
| 1087 | Define this to enable authorized functions in the TPM library. |
| 1088 | Requires CONFIG_TPM and CONFIG_SHA1. |
| 1089 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1090 | - USB Support: |
| 1091 | At the moment only the UHCI host controller is |
Heiko Schocher | 064b55c | 2017-06-14 05:49:40 +0200 | [diff] [blame] | 1092 | supported (PIP405, MIP405); define |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1093 | CONFIG_USB_UHCI to enable it. |
| 1094 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard |
wdenk | 30d56fa | 2004-10-09 22:44:59 +0000 | [diff] [blame] | 1095 | and define CONFIG_USB_STORAGE to enable the USB |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1096 | storage devices. |
| 1097 | Note: |
| 1098 | Supported are USB Keyboards and USB Floppy drives |
| 1099 | (TEAC FD-05PUB). |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1100 | |
Simon Glass | 9ab4ce2 | 2012-02-27 10:52:47 +0000 | [diff] [blame] | 1101 | CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the |
| 1102 | txfilltuning field in the EHCI controller on reset. |
| 1103 | |
Oleksandr Tymoshenko | 6e9e062 | 2014-02-01 21:51:25 -0700 | [diff] [blame] | 1104 | CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 |
| 1105 | HW module registers. |
| 1106 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1107 | - USB Device: |
| 1108 | Define the below if you wish to use the USB console. |
| 1109 | Once firmware is rebuilt from a serial console issue the |
| 1110 | command "setenv stdin usbtty; setenv stdout usbtty" and |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1111 | attach your USB cable. The Unix command "dmesg" should print |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1112 | it has found a new device. The environment variable usbtty |
| 1113 | can be set to gserial or cdc_acm to enable your device to |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1114 | appear to a USB host as a Linux gserial device or a |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1115 | Common Device Class Abstract Control Model serial device. |
| 1116 | If you select usbtty = gserial you should be able to enumerate |
| 1117 | a Linux host by |
| 1118 | # modprobe usbserial vendor=0xVendorID product=0xProductID |
| 1119 | else if using cdc_acm, simply setting the environment |
| 1120 | variable usbtty to be cdc_acm should suffice. The following |
| 1121 | might be defined in YourBoardName.h |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1122 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1123 | CONFIG_USB_DEVICE |
| 1124 | Define this to build a UDC device |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1125 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1126 | CONFIG_USB_TTY |
| 1127 | Define this to have a tty type of device available to |
| 1128 | talk to the UDC device |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1129 | |
Vipin KUMAR | f9da0f8 | 2012-03-26 15:38:06 +0530 | [diff] [blame] | 1130 | CONFIG_USBD_HS |
| 1131 | Define this to enable the high speed support for usb |
| 1132 | device and usbtty. If this feature is enabled, a routine |
| 1133 | int is_usbd_high_speed(void) |
| 1134 | also needs to be defined by the driver to dynamically poll |
| 1135 | whether the enumeration has succeded at high speed or full |
| 1136 | speed. |
| 1137 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1138 | CONFIG_SYS_CONSOLE_IS_IN_ENV |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1139 | Define this if you want stdin, stdout &/or stderr to |
| 1140 | be set to usbtty. |
| 1141 | |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1142 | If you have a USB-IF assigned VendorID then you may wish to |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1143 | define your own vendor specific values either in BoardName.h |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1144 | or directly in usbd_vendor_info.h. If you don't define |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1145 | CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, |
| 1146 | CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot |
| 1147 | should pretend to be a Linux device to it's target host. |
| 1148 | |
| 1149 | CONFIG_USBD_MANUFACTURER |
| 1150 | Define this string as the name of your company for |
| 1151 | - CONFIG_USBD_MANUFACTURER "my company" |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1152 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1153 | CONFIG_USBD_PRODUCT_NAME |
| 1154 | Define this string as the name of your product |
| 1155 | - CONFIG_USBD_PRODUCT_NAME "acme usb device" |
| 1156 | |
| 1157 | CONFIG_USBD_VENDORID |
| 1158 | Define this as your assigned Vendor ID from the USB |
| 1159 | Implementors Forum. This *must* be a genuine Vendor ID |
| 1160 | to avoid polluting the USB namespace. |
| 1161 | - CONFIG_USBD_VENDORID 0xFFFF |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1162 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1163 | CONFIG_USBD_PRODUCTID |
| 1164 | Define this as the unique Product ID |
| 1165 | for your device |
| 1166 | - CONFIG_USBD_PRODUCTID 0xFFFF |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1167 | |
Igor Grinberg | d70a560 | 2011-12-12 12:08:35 +0200 | [diff] [blame] | 1168 | - ULPI Layer Support: |
| 1169 | The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via |
| 1170 | the generic ULPI layer. The generic layer accesses the ULPI PHY |
| 1171 | via the platform viewport, so you need both the genric layer and |
| 1172 | the viewport enabled. Currently only Chipidea/ARC based |
| 1173 | viewport is supported. |
| 1174 | To enable the ULPI layer support, define CONFIG_USB_ULPI and |
| 1175 | CONFIG_USB_ULPI_VIEWPORT in your board configuration file. |
Lucas Stach | 6d365ea | 2012-10-01 00:44:35 +0200 | [diff] [blame] | 1176 | If your ULPI phy needs a different reference clock than the |
| 1177 | standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to |
| 1178 | the appropriate value in Hz. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1179 | |
| 1180 | - MMC Support: |
| 1181 | The MMC controller on the Intel PXA is supported. To |
| 1182 | enable this define CONFIG_MMC. The MMC can be |
| 1183 | accessed from the boot prompt by mapping the device |
| 1184 | to physical memory similar to flash. Command line is |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1185 | enabled with CONFIG_CMD_MMC. The MMC driver also works with |
| 1186 | the FAT fs. This is enabled with CONFIG_CMD_FAT. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1187 | |
Yoshihiro Shimoda | afb3566 | 2011-07-04 22:21:22 +0000 | [diff] [blame] | 1188 | CONFIG_SH_MMCIF |
| 1189 | Support for Renesas on-chip MMCIF controller |
| 1190 | |
| 1191 | CONFIG_SH_MMCIF_ADDR |
| 1192 | Define the base address of MMCIF registers |
| 1193 | |
| 1194 | CONFIG_SH_MMCIF_CLK |
| 1195 | Define the clock frequency for MMCIF |
| 1196 | |
Pierre Aubert | 1fd93c6 | 2014-04-24 10:30:08 +0200 | [diff] [blame] | 1197 | CONFIG_SUPPORT_EMMC_BOOT |
| 1198 | Enable some additional features of the eMMC boot partitions. |
| 1199 | |
| 1200 | CONFIG_SUPPORT_EMMC_RPMB |
| 1201 | Enable the commands for reading, writing and programming the |
| 1202 | key for the Replay Protection Memory Block partition in eMMC. |
| 1203 | |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 1204 | - USB Device Firmware Update (DFU) class support: |
Paul Kocialkowski | 01acd6a | 2015-06-12 19:56:58 +0200 | [diff] [blame] | 1205 | CONFIG_USB_FUNCTION_DFU |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 1206 | This enables the USB portion of the DFU USB class |
| 1207 | |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 1208 | CONFIG_DFU_MMC |
| 1209 | This enables support for exposing (e)MMC devices via DFU. |
| 1210 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 1211 | CONFIG_DFU_NAND |
| 1212 | This enables support for exposing NAND devices via DFU. |
| 1213 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 1214 | CONFIG_DFU_RAM |
| 1215 | This enables support for exposing RAM via DFU. |
| 1216 | Note: DFU spec refer to non-volatile memory usage, but |
| 1217 | allow usages beyond the scope of spec - here RAM usage, |
| 1218 | one that would help mostly the developer. |
| 1219 | |
Heiko Schocher | e7e75c7 | 2013-06-12 06:05:51 +0200 | [diff] [blame] | 1220 | CONFIG_SYS_DFU_DATA_BUF_SIZE |
| 1221 | Dfu transfer uses a buffer before writing data to the |
| 1222 | raw storage device. Make the size (in bytes) of this buffer |
| 1223 | configurable. The size of this buffer is also configurable |
| 1224 | through the "dfu_bufsiz" environment variable. |
| 1225 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 1226 | CONFIG_SYS_DFU_MAX_FILE_SIZE |
| 1227 | When updating files rather than the raw storage device, |
| 1228 | we use a static buffer to copy the file into and then write |
| 1229 | the buffer once we've been given the whole file. Define |
| 1230 | this to the maximum filesize (in bytes) for the buffer. |
| 1231 | Default is 4 MiB if undefined. |
| 1232 | |
Heiko Schocher | 001a831 | 2014-03-18 08:09:56 +0100 | [diff] [blame] | 1233 | DFU_DEFAULT_POLL_TIMEOUT |
| 1234 | Poll timeout [ms], is the timeout a device can send to the |
| 1235 | host. The host must wait for this timeout before sending |
| 1236 | a subsequent DFU_GET_STATUS request to the device. |
| 1237 | |
| 1238 | DFU_MANIFEST_POLL_TIMEOUT |
| 1239 | Poll timeout [ms], which the device sends to the host when |
| 1240 | entering dfuMANIFEST state. Host waits this timeout, before |
| 1241 | sending again an USB request to the device. |
| 1242 | |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1243 | - Journaling Flash filesystem support: |
Simon Glass | b2482df | 2016-10-02 18:00:59 -0600 | [diff] [blame] | 1244 | CONFIG_JFFS2_NAND |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1245 | Define these for a default partition on a NAND device |
| 1246 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1247 | CONFIG_SYS_JFFS2_FIRST_SECTOR, |
| 1248 | CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1249 | Define these for a default partition on a NOR device |
| 1250 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1251 | - Keyboard Support: |
Simon Glass | 39f615e | 2015-11-11 10:05:47 -0700 | [diff] [blame] | 1252 | See Kconfig help for available keyboard drivers. |
| 1253 | |
| 1254 | CONFIG_KEYBOARD |
| 1255 | |
| 1256 | Define this to enable a custom keyboard support. |
| 1257 | This simply calls drv_keyboard_init() which must be |
| 1258 | defined in your board-specific files. This option is deprecated |
| 1259 | and is only used by novena. For new boards, use driver model |
| 1260 | instead. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1261 | |
| 1262 | - Video support: |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1263 | CONFIG_FSL_DIU_FB |
Wolfgang Denk | 04e5ae7 | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 1264 | Enable the Freescale DIU video driver. Reference boards for |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1265 | SOCs that have a DIU should define this macro to enable DIU |
| 1266 | support, and should also define these other macros: |
| 1267 | |
| 1268 | CONFIG_SYS_DIU_ADDR |
| 1269 | CONFIG_VIDEO |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1270 | CONFIG_CFB_CONSOLE |
| 1271 | CONFIG_VIDEO_SW_CURSOR |
| 1272 | CONFIG_VGA_AS_SINGLE_DEVICE |
| 1273 | CONFIG_VIDEO_LOGO |
| 1274 | CONFIG_VIDEO_BMP_LOGO |
| 1275 | |
Timur Tabi | ba8e76b | 2011-04-11 14:18:22 -0500 | [diff] [blame] | 1276 | The DIU driver will look for the 'video-mode' environment |
| 1277 | variable, and if defined, enable the DIU as a console during |
Fabio Estevam | 8eca943 | 2016-04-02 11:53:18 -0300 | [diff] [blame] | 1278 | boot. See the documentation file doc/README.video for a |
Timur Tabi | ba8e76b | 2011-04-11 14:18:22 -0500 | [diff] [blame] | 1279 | description of this variable. |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1280 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1281 | - LCD Support: CONFIG_LCD |
| 1282 | |
| 1283 | Define this to enable LCD support (for output to LCD |
| 1284 | display); also select one of the supported displays |
| 1285 | by defining one of these: |
| 1286 | |
Stelian Pop | 39cf480 | 2008-05-09 21:57:18 +0200 | [diff] [blame] | 1287 | CONFIG_ATMEL_LCD: |
| 1288 | |
| 1289 | HITACHI TX09D70VM1CCA, 3.5", 240x320. |
| 1290 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1291 | CONFIG_NEC_NL6448AC33: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1292 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1293 | NEC NL6448AC33-18. Active, color, single scan. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1294 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1295 | CONFIG_NEC_NL6448BC20 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1296 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1297 | NEC NL6448BC20-08. 6.5", 640x480. |
| 1298 | Active, color, single scan. |
| 1299 | |
| 1300 | CONFIG_NEC_NL6448BC33_54 |
| 1301 | |
| 1302 | NEC NL6448BC33-54. 10.4", 640x480. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1303 | Active, color, single scan. |
| 1304 | |
| 1305 | CONFIG_SHARP_16x9 |
| 1306 | |
| 1307 | Sharp 320x240. Active, color, single scan. |
| 1308 | It isn't 16x9, and I am not sure what it is. |
| 1309 | |
| 1310 | CONFIG_SHARP_LQ64D341 |
| 1311 | |
| 1312 | Sharp LQ64D341 display, 640x480. |
| 1313 | Active, color, single scan. |
| 1314 | |
| 1315 | CONFIG_HLD1045 |
| 1316 | |
| 1317 | HLD1045 display, 640x480. |
| 1318 | Active, color, single scan. |
| 1319 | |
| 1320 | CONFIG_OPTREX_BW |
| 1321 | |
| 1322 | Optrex CBL50840-2 NF-FW 99 22 M5 |
| 1323 | or |
| 1324 | Hitachi LMG6912RPFC-00T |
| 1325 | or |
| 1326 | Hitachi SP14Q002 |
| 1327 | |
| 1328 | 320x240. Black & white. |
| 1329 | |
Simon Glass | 676d319 | 2012-10-17 13:24:54 +0000 | [diff] [blame] | 1330 | CONFIG_LCD_ALIGNMENT |
| 1331 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1332 | Normally the LCD is page-aligned (typically 4KB). If this is |
Simon Glass | 676d319 | 2012-10-17 13:24:54 +0000 | [diff] [blame] | 1333 | defined then the LCD will be aligned to this value instead. |
| 1334 | For ARM it is sometimes useful to use MMU_SECTION_SIZE |
| 1335 | here, since it is cheaper to change data cache settings on |
| 1336 | a per-section basis. |
| 1337 | |
| 1338 | |
Hannes Petermaier | 604c7d4 | 2015-03-27 08:01:38 +0100 | [diff] [blame] | 1339 | CONFIG_LCD_ROTATION |
| 1340 | |
| 1341 | Sometimes, for example if the display is mounted in portrait |
| 1342 | mode or even if it's mounted landscape but rotated by 180degree, |
| 1343 | we need to rotate our content of the display relative to the |
| 1344 | framebuffer, so that user can read the messages which are |
| 1345 | printed out. |
| 1346 | Once CONFIG_LCD_ROTATION is defined, the lcd_console will be |
| 1347 | initialized with a given rotation from "vl_rot" out of |
| 1348 | "vidinfo_t" which is provided by the board specific code. |
| 1349 | The value for vl_rot is coded as following (matching to |
| 1350 | fbcon=rotate:<n> linux-kernel commandline): |
| 1351 | 0 = no rotation respectively 0 degree |
| 1352 | 1 = 90 degree rotation |
| 1353 | 2 = 180 degree rotation |
| 1354 | 3 = 270 degree rotation |
| 1355 | |
| 1356 | If CONFIG_LCD_ROTATION is not defined, the console will be |
| 1357 | initialized with 0degree rotation. |
| 1358 | |
Tom Wai-Hong Tam | 45d7f52 | 2012-09-28 15:11:16 +0000 | [diff] [blame] | 1359 | CONFIG_LCD_BMP_RLE8 |
| 1360 | |
| 1361 | Support drawing of RLE8-compressed bitmaps on the LCD. |
| 1362 | |
Tom Wai-Hong Tam | 735987c | 2012-12-05 14:46:40 +0000 | [diff] [blame] | 1363 | CONFIG_I2C_EDID |
| 1364 | |
| 1365 | Enables an 'i2c edid' command which can read EDID |
| 1366 | information over I2C from an attached LCD display. |
| 1367 | |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1368 | - Splash Screen Support: CONFIG_SPLASH_SCREEN |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1369 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1370 | If this option is set, the environment is checked for |
| 1371 | a variable "splashimage". If found, the usual display |
| 1372 | of logo, copyright and system information on the LCD |
wdenk | e94d2cd | 2004-06-30 22:59:18 +0000 | [diff] [blame] | 1373 | is suppressed and the BMP image at the address |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1374 | specified in "splashimage" is loaded instead. The |
| 1375 | console is redirected to the "nulldev", too. This |
| 1376 | allows for a "silent" boot where a splash screen is |
| 1377 | loaded very quickly after power-on. |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1378 | |
Nikita Kiryanov | c088048 | 2013-02-24 21:28:43 +0000 | [diff] [blame] | 1379 | CONFIG_SPLASHIMAGE_GUARD |
| 1380 | |
| 1381 | If this option is set, then U-Boot will prevent the environment |
| 1382 | variable "splashimage" from being set to a problematic address |
Fabio Estevam | ab5645f | 2016-03-23 12:46:12 -0300 | [diff] [blame] | 1383 | (see doc/README.displaying-bmps). |
Nikita Kiryanov | c088048 | 2013-02-24 21:28:43 +0000 | [diff] [blame] | 1384 | This option is useful for targets where, due to alignment |
| 1385 | restrictions, an improperly aligned BMP image will cause a data |
| 1386 | abort. If you think you will not have problems with unaligned |
| 1387 | accesses (for example because your toolchain prevents them) |
| 1388 | there is no need to set this option. |
| 1389 | |
Matthias Weisser | 1ca298c | 2009-07-09 16:07:30 +0200 | [diff] [blame] | 1390 | CONFIG_SPLASH_SCREEN_ALIGN |
| 1391 | |
| 1392 | If this option is set the splash image can be freely positioned |
| 1393 | on the screen. Environment variable "splashpos" specifies the |
| 1394 | position as "x,y". If a positive number is given it is used as |
| 1395 | number of pixel from left/top. If a negative number is given it |
| 1396 | is used as number of pixel from right/bottom. You can also |
| 1397 | specify 'm' for centering the image. |
| 1398 | |
| 1399 | Example: |
| 1400 | setenv splashpos m,m |
| 1401 | => image at center of screen |
| 1402 | |
| 1403 | setenv splashpos 30,20 |
| 1404 | => image at x = 30 and y = 20 |
| 1405 | |
| 1406 | setenv splashpos -10,m |
| 1407 | => vertically centered image |
| 1408 | at x = dspWidth - bmpWidth - 9 |
| 1409 | |
Stefan Roese | 98f4a3d | 2005-09-22 09:04:17 +0200 | [diff] [blame] | 1410 | - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP |
| 1411 | |
| 1412 | If this option is set, additionally to standard BMP |
| 1413 | images, gzipped BMP images can be displayed via the |
| 1414 | splashscreen support or the bmp command. |
| 1415 | |
Anatolij Gustschin | d501176 | 2010-03-15 14:50:25 +0100 | [diff] [blame] | 1416 | - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 |
| 1417 | |
| 1418 | If this option is set, 8-bit RLE compressed BMP images |
| 1419 | can be displayed via the splashscreen support or the |
| 1420 | bmp command. |
| 1421 | |
wdenk | c29fdfc | 2003-08-29 20:57:53 +0000 | [diff] [blame] | 1422 | - Compression support: |
Kees Cook | 8ef7047 | 2013-08-16 07:59:12 -0700 | [diff] [blame] | 1423 | CONFIG_GZIP |
| 1424 | |
| 1425 | Enabled by default to support gzip compressed images. |
| 1426 | |
wdenk | c29fdfc | 2003-08-29 20:57:53 +0000 | [diff] [blame] | 1427 | CONFIG_BZIP2 |
| 1428 | |
| 1429 | If this option is set, support for bzip2 compressed |
| 1430 | images is included. If not, only uncompressed and gzip |
| 1431 | compressed images are supported. |
| 1432 | |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1433 | NOTE: the bzip2 algorithm requires a lot of RAM, so |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1434 | the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1435 | be at least 4MB. |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1436 | |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 1437 | - MII/PHY support: |
| 1438 | CONFIG_PHY_ADDR |
| 1439 | |
| 1440 | The address of PHY on MII bus. |
| 1441 | |
| 1442 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) |
| 1443 | |
| 1444 | The clock frequency of the MII bus |
| 1445 | |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 1446 | CONFIG_PHY_RESET_DELAY |
| 1447 | |
| 1448 | Some PHY like Intel LXT971A need extra delay after |
| 1449 | reset before any MII register access is possible. |
| 1450 | For such PHY, set this option to the usec delay |
| 1451 | required. (minimum 300usec for LXT971A) |
| 1452 | |
| 1453 | CONFIG_PHY_CMD_DELAY (ppc4xx) |
| 1454 | |
| 1455 | Some PHY like Intel LXT971A need extra delay after |
| 1456 | command issued before MII status register can be read |
| 1457 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1458 | - IP address: |
| 1459 | CONFIG_IPADDR |
| 1460 | |
| 1461 | Define a default value for the IP address to use for |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1462 | the default Ethernet interface, in case this is not |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1463 | determined through e.g. bootp. |
Wolfgang Denk | 1ebcd65 | 2011-10-26 10:21:22 +0000 | [diff] [blame] | 1464 | (Environment variable "ipaddr") |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1465 | |
| 1466 | - Server IP address: |
| 1467 | CONFIG_SERVERIP |
| 1468 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1469 | Defines a default value for the IP address of a TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1470 | server to contact when using the "tftboot" command. |
Wolfgang Denk | 1ebcd65 | 2011-10-26 10:21:22 +0000 | [diff] [blame] | 1471 | (Environment variable "serverip") |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1472 | |
Robin Getz | 97cfe86 | 2009-07-21 12:15:28 -0400 | [diff] [blame] | 1473 | CONFIG_KEEP_SERVERADDR |
| 1474 | |
| 1475 | Keeps the server's MAC address, in the env 'serveraddr' |
| 1476 | for passing to bootargs (like Linux's netconsole option) |
| 1477 | |
Wolfgang Denk | 1ebcd65 | 2011-10-26 10:21:22 +0000 | [diff] [blame] | 1478 | - Gateway IP address: |
| 1479 | CONFIG_GATEWAYIP |
| 1480 | |
| 1481 | Defines a default value for the IP address of the |
| 1482 | default router where packets to other networks are |
| 1483 | sent to. |
| 1484 | (Environment variable "gatewayip") |
| 1485 | |
| 1486 | - Subnet mask: |
| 1487 | CONFIG_NETMASK |
| 1488 | |
| 1489 | Defines a default value for the subnet mask (or |
| 1490 | routing prefix) which is used to determine if an IP |
| 1491 | address belongs to the local subnet or needs to be |
| 1492 | forwarded through a router. |
| 1493 | (Environment variable "netmask") |
| 1494 | |
David Updegraff | 53a5c42 | 2007-06-11 10:41:07 -0500 | [diff] [blame] | 1495 | - Multicast TFTP Mode: |
| 1496 | CONFIG_MCAST_TFTP |
| 1497 | |
| 1498 | Defines whether you want to support multicast TFTP as per |
| 1499 | rfc-2090; for example to work with atftp. Lets lots of targets |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1500 | tftp down the same boot image concurrently. Note: the Ethernet |
David Updegraff | 53a5c42 | 2007-06-11 10:41:07 -0500 | [diff] [blame] | 1501 | driver in use must provide a function: mcast() to join/leave a |
| 1502 | multicast group. |
| 1503 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1504 | - BOOTP Recovery Mode: |
| 1505 | CONFIG_BOOTP_RANDOM_DELAY |
| 1506 | |
| 1507 | If you have many targets in a network that try to |
| 1508 | boot using BOOTP, you may want to avoid that all |
| 1509 | systems send out BOOTP requests at precisely the same |
| 1510 | moment (which would happen for instance at recovery |
| 1511 | from a power failure, when all systems will try to |
| 1512 | boot, thus flooding the BOOTP server. Defining |
| 1513 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be |
| 1514 | inserted before sending out BOOTP requests. The |
Wolfgang Denk | 6c33c78 | 2007-08-06 23:21:05 +0200 | [diff] [blame] | 1515 | following delays are inserted then: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1516 | |
| 1517 | 1st BOOTP request: delay 0 ... 1 sec |
| 1518 | 2nd BOOTP request: delay 0 ... 2 sec |
| 1519 | 3rd BOOTP request: delay 0 ... 4 sec |
| 1520 | 4th and following |
| 1521 | BOOTP requests: delay 0 ... 8 sec |
| 1522 | |
Thierry Reding | 92ac8ac | 2014-08-19 10:21:24 +0200 | [diff] [blame] | 1523 | CONFIG_BOOTP_ID_CACHE_SIZE |
| 1524 | |
| 1525 | BOOTP packets are uniquely identified using a 32-bit ID. The |
| 1526 | server will copy the ID from client requests to responses and |
| 1527 | U-Boot will use this to determine if it is the destination of |
| 1528 | an incoming response. Some servers will check that addresses |
| 1529 | aren't in use before handing them out (usually using an ARP |
| 1530 | ping) and therefore take up to a few hundred milliseconds to |
| 1531 | respond. Network congestion may also influence the time it |
| 1532 | takes for a response to make it back to the client. If that |
| 1533 | time is too long, U-Boot will retransmit requests. In order |
| 1534 | to allow earlier responses to still be accepted after these |
| 1535 | retransmissions, U-Boot's BOOTP client keeps a small cache of |
| 1536 | IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this |
| 1537 | cache. The default is to keep IDs for up to four outstanding |
| 1538 | requests. Increasing this will allow U-Boot to accept offers |
| 1539 | from a BOOTP client in networks with unusually high latency. |
| 1540 | |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1541 | - DHCP Advanced Options: |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1542 | You can fine tune the DHCP functionality by defining |
| 1543 | CONFIG_BOOTP_* symbols: |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1544 | |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1545 | CONFIG_BOOTP_SUBNETMASK |
| 1546 | CONFIG_BOOTP_GATEWAY |
| 1547 | CONFIG_BOOTP_HOSTNAME |
| 1548 | CONFIG_BOOTP_NISDOMAIN |
| 1549 | CONFIG_BOOTP_BOOTPATH |
| 1550 | CONFIG_BOOTP_BOOTFILESIZE |
| 1551 | CONFIG_BOOTP_DNS |
| 1552 | CONFIG_BOOTP_DNS2 |
| 1553 | CONFIG_BOOTP_SEND_HOSTNAME |
| 1554 | CONFIG_BOOTP_NTPSERVER |
| 1555 | CONFIG_BOOTP_TIMEOFFSET |
| 1556 | CONFIG_BOOTP_VENDOREX |
Joe Hershberger | 2c00e09 | 2012-05-23 07:59:19 +0000 | [diff] [blame] | 1557 | CONFIG_BOOTP_MAY_FAIL |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1558 | |
Wilson Callan | 5d110f0 | 2007-07-28 10:56:13 -0400 | [diff] [blame] | 1559 | CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip |
| 1560 | environment variable, not the BOOTP server. |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1561 | |
Joe Hershberger | 2c00e09 | 2012-05-23 07:59:19 +0000 | [diff] [blame] | 1562 | CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found |
| 1563 | after the configured retry count, the call will fail |
| 1564 | instead of starting over. This can be used to fail over |
| 1565 | to Link-local IP address configuration if the DHCP server |
| 1566 | is not available. |
| 1567 | |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1568 | CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS |
| 1569 | serverip from a DHCP server, it is possible that more |
| 1570 | than one DNS serverip is offered to the client. |
| 1571 | If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS |
| 1572 | serverip will be stored in the additional environment |
| 1573 | variable "dnsip2". The first DNS serverip is always |
| 1574 | stored in the variable "dnsip", when CONFIG_BOOTP_DNS |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1575 | is defined. |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1576 | |
| 1577 | CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable |
| 1578 | to do a dynamic update of a DNS server. To do this, they |
| 1579 | need the hostname of the DHCP requester. |
Wilson Callan | 5d110f0 | 2007-07-28 10:56:13 -0400 | [diff] [blame] | 1580 | If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1581 | of the "hostname" environment variable is passed as |
| 1582 | option 12 to the DHCP server. |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1583 | |
Aras Vaichas | d9a2f41 | 2008-03-26 09:43:57 +1100 | [diff] [blame] | 1584 | CONFIG_BOOTP_DHCP_REQUEST_DELAY |
| 1585 | |
| 1586 | A 32bit value in microseconds for a delay between |
| 1587 | receiving a "DHCP Offer" and sending the "DHCP Request". |
| 1588 | This fixes a problem with certain DHCP servers that don't |
| 1589 | respond 100% of the time to a "DHCP request". E.g. On an |
| 1590 | AT91RM9200 processor running at 180MHz, this delay needed |
| 1591 | to be *at least* 15,000 usec before a Windows Server 2003 |
| 1592 | DHCP server would reply 100% of the time. I recommend at |
| 1593 | least 50,000 usec to be safe. The alternative is to hope |
| 1594 | that one of the retries will be successful but note that |
| 1595 | the DHCP timeout and retry process takes a longer than |
| 1596 | this delay. |
| 1597 | |
Joe Hershberger | d22c338 | 2012-05-23 08:00:12 +0000 | [diff] [blame] | 1598 | - Link-local IP address negotiation: |
| 1599 | Negotiate with other link-local clients on the local network |
| 1600 | for an address that doesn't require explicit configuration. |
| 1601 | This is especially useful if a DHCP server cannot be guaranteed |
| 1602 | to exist in all environments that the device must operate. |
| 1603 | |
| 1604 | See doc/README.link-local for more information. |
| 1605 | |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 1606 | - CDP Options: |
wdenk | 6e59238 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 1607 | CONFIG_CDP_DEVICE_ID |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 1608 | |
| 1609 | The device id used in CDP trigger frames. |
| 1610 | |
| 1611 | CONFIG_CDP_DEVICE_ID_PREFIX |
| 1612 | |
| 1613 | A two character string which is prefixed to the MAC address |
| 1614 | of the device. |
| 1615 | |
| 1616 | CONFIG_CDP_PORT_ID |
| 1617 | |
| 1618 | A printf format string which contains the ascii name of |
| 1619 | the port. Normally is set to "eth%d" which sets |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1620 | eth0 for the first Ethernet, eth1 for the second etc. |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 1621 | |
| 1622 | CONFIG_CDP_CAPABILITIES |
| 1623 | |
| 1624 | A 32bit integer which indicates the device capabilities; |
| 1625 | 0x00000010 for a normal host which does not forwards. |
| 1626 | |
| 1627 | CONFIG_CDP_VERSION |
| 1628 | |
| 1629 | An ascii string containing the version of the software. |
| 1630 | |
| 1631 | CONFIG_CDP_PLATFORM |
| 1632 | |
| 1633 | An ascii string containing the name of the platform. |
| 1634 | |
| 1635 | CONFIG_CDP_TRIGGER |
| 1636 | |
| 1637 | A 32bit integer sent on the trigger. |
| 1638 | |
| 1639 | CONFIG_CDP_POWER_CONSUMPTION |
| 1640 | |
| 1641 | A 16bit integer containing the power consumption of the |
| 1642 | device in .1 of milliwatts. |
| 1643 | |
| 1644 | CONFIG_CDP_APPLIANCE_VLAN_TYPE |
| 1645 | |
| 1646 | A byte containing the id of the VLAN. |
| 1647 | |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 1648 | - Status LED: CONFIG_LED_STATUS |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1649 | |
| 1650 | Several configurations allow to display the current |
| 1651 | status using a LED. For instance, the LED will blink |
| 1652 | fast while running U-Boot code, stop blinking as |
| 1653 | soon as a reply to a BOOTP request was received, and |
| 1654 | start blinking slow once the Linux kernel is running |
| 1655 | (supported by a status LED driver in the Linux |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 1656 | kernel). Defining CONFIG_LED_STATUS enables this |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1657 | feature in U-Boot. |
| 1658 | |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 1659 | Additional options: |
| 1660 | |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 1661 | CONFIG_LED_STATUS_GPIO |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 1662 | The status LED can be connected to a GPIO pin. |
| 1663 | In such cases, the gpio_led driver can be used as a |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 1664 | status LED backend implementation. Define CONFIG_LED_STATUS_GPIO |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 1665 | to include the gpio_led driver in the U-Boot binary. |
| 1666 | |
Igor Grinberg | 9dfdcdf | 2013-11-08 01:03:52 +0200 | [diff] [blame] | 1667 | CONFIG_GPIO_LED_INVERTED_TABLE |
| 1668 | Some GPIO connected LEDs may have inverted polarity in which |
| 1669 | case the GPIO high value corresponds to LED off state and |
| 1670 | GPIO low value corresponds to LED on state. |
| 1671 | In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined |
| 1672 | with a list of GPIO LEDs that have inverted polarity. |
| 1673 | |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1674 | - I2C Support: CONFIG_SYS_I2C |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1675 | |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1676 | This enable the NEW i2c subsystem, and will allow you to use |
| 1677 | i2c commands at the u-boot command line (as long as you set |
| 1678 | CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c |
| 1679 | based realtime clock chips or other i2c devices. See |
| 1680 | common/cmd_i2c.c for a description of the command line |
| 1681 | interface. |
| 1682 | |
| 1683 | ported i2c driver to the new framework: |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 1684 | - drivers/i2c/soft_i2c.c: |
| 1685 | - activate first bus with CONFIG_SYS_I2C_SOFT define |
| 1686 | CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE |
| 1687 | for defining speed and slave address |
| 1688 | - activate second bus with I2C_SOFT_DECLARATIONS2 define |
| 1689 | CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 |
| 1690 | for defining speed and slave address |
| 1691 | - activate third bus with I2C_SOFT_DECLARATIONS3 define |
| 1692 | CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 |
| 1693 | for defining speed and slave address |
| 1694 | - activate fourth bus with I2C_SOFT_DECLARATIONS4 define |
| 1695 | CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 |
| 1696 | for defining speed and slave address |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1697 | |
Heiko Schocher | 00f792e | 2012-10-24 13:48:22 +0200 | [diff] [blame] | 1698 | - drivers/i2c/fsl_i2c.c: |
| 1699 | - activate i2c driver with CONFIG_SYS_I2C_FSL |
| 1700 | define CONFIG_SYS_FSL_I2C_OFFSET for setting the register |
| 1701 | offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and |
| 1702 | CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first |
| 1703 | bus. |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 1704 | - If your board supports a second fsl i2c bus, define |
Heiko Schocher | 00f792e | 2012-10-24 13:48:22 +0200 | [diff] [blame] | 1705 | CONFIG_SYS_FSL_I2C2_OFFSET for the register offset |
| 1706 | CONFIG_SYS_FSL_I2C2_SPEED for the speed and |
| 1707 | CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the |
| 1708 | second bus. |
| 1709 | |
Simon Glass | 1f2ba72 | 2012-10-30 07:28:53 +0000 | [diff] [blame] | 1710 | - drivers/i2c/tegra_i2c.c: |
Nobuhiro Iwamatsu | 10cee51 | 2013-10-11 16:23:53 +0900 | [diff] [blame] | 1711 | - activate this driver with CONFIG_SYS_I2C_TEGRA |
| 1712 | - This driver adds 4 i2c buses with a fix speed from |
| 1713 | 100000 and the slave addr 0! |
Simon Glass | 1f2ba72 | 2012-10-30 07:28:53 +0000 | [diff] [blame] | 1714 | |
Dirk Eibach | 880540d | 2013-04-25 02:40:01 +0000 | [diff] [blame] | 1715 | - drivers/i2c/ppc4xx_i2c.c |
| 1716 | - activate this driver with CONFIG_SYS_I2C_PPC4XX |
| 1717 | - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 |
| 1718 | - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 |
| 1719 | |
trem | fac9640 | 2013-09-21 18:13:35 +0200 | [diff] [blame] | 1720 | - drivers/i2c/i2c_mxc.c |
| 1721 | - activate this driver with CONFIG_SYS_I2C_MXC |
Albert ARIBAUD \\(3ADEV\\) | 03544c6 | 2015-09-21 22:43:38 +0200 | [diff] [blame] | 1722 | - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 |
| 1723 | - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 |
| 1724 | - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 |
| 1725 | - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 |
trem | fac9640 | 2013-09-21 18:13:35 +0200 | [diff] [blame] | 1726 | - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED |
| 1727 | - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE |
| 1728 | - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED |
| 1729 | - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE |
| 1730 | - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED |
| 1731 | - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE |
Albert ARIBAUD \\(3ADEV\\) | 03544c6 | 2015-09-21 22:43:38 +0200 | [diff] [blame] | 1732 | - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED |
| 1733 | - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1734 | If those defines are not set, default value is 100000 |
trem | fac9640 | 2013-09-21 18:13:35 +0200 | [diff] [blame] | 1735 | for speed, and 0 for slave. |
| 1736 | |
Nobuhiro Iwamatsu | 1086bfa | 2013-09-27 16:58:30 +0900 | [diff] [blame] | 1737 | - drivers/i2c/rcar_i2c.c: |
| 1738 | - activate this driver with CONFIG_SYS_I2C_RCAR |
| 1739 | - This driver adds 4 i2c buses |
| 1740 | |
| 1741 | - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 |
| 1742 | - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 |
| 1743 | - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 |
| 1744 | - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 |
| 1745 | - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 |
| 1746 | - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 |
| 1747 | - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 |
| 1748 | - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 |
| 1749 | - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses |
| 1750 | |
Nobuhiro Iwamatsu | 2035d77 | 2013-10-29 13:33:51 +0900 | [diff] [blame] | 1751 | - drivers/i2c/sh_i2c.c: |
| 1752 | - activate this driver with CONFIG_SYS_I2C_SH |
| 1753 | - This driver adds from 2 to 5 i2c buses |
| 1754 | |
| 1755 | - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 |
| 1756 | - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 |
| 1757 | - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 |
| 1758 | - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 |
| 1759 | - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 |
| 1760 | - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 |
| 1761 | - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 |
| 1762 | - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 |
| 1763 | - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 |
| 1764 | - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1765 | - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses |
Nobuhiro Iwamatsu | 2035d77 | 2013-10-29 13:33:51 +0900 | [diff] [blame] | 1766 | |
Heiko Schocher | 6789e84 | 2013-10-22 11:03:18 +0200 | [diff] [blame] | 1767 | - drivers/i2c/omap24xx_i2c.c |
| 1768 | - activate this driver with CONFIG_SYS_I2C_OMAP24XX |
| 1769 | - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 |
| 1770 | - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 |
| 1771 | - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 |
| 1772 | - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 |
| 1773 | - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 |
| 1774 | - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 |
| 1775 | - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 |
| 1776 | - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 |
| 1777 | - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 |
| 1778 | - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 |
| 1779 | |
Heiko Schocher | 0bdffe7 | 2013-11-08 07:30:53 +0100 | [diff] [blame] | 1780 | - drivers/i2c/zynq_i2c.c |
| 1781 | - activate this driver with CONFIG_SYS_I2C_ZYNQ |
| 1782 | - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting |
| 1783 | - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr |
| 1784 | |
Naveen Krishna Ch | e717fc6 | 2013-12-06 12:12:38 +0530 | [diff] [blame] | 1785 | - drivers/i2c/s3c24x0_i2c.c: |
| 1786 | - activate this driver with CONFIG_SYS_I2C_S3C24X0 |
| 1787 | - This driver adds i2c buses (11 for Exynos5250, Exynos5420 |
| 1788 | 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) |
| 1789 | with a fix speed from 100000 and the slave addr 0! |
| 1790 | |
Dirk Eibach | b46226b | 2014-07-03 09:28:18 +0200 | [diff] [blame] | 1791 | - drivers/i2c/ihs_i2c.c |
| 1792 | - activate this driver with CONFIG_SYS_I2C_IHS |
| 1793 | - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 |
| 1794 | - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 |
| 1795 | - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 |
| 1796 | - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 |
| 1797 | - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 |
| 1798 | - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 |
| 1799 | - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 |
| 1800 | - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 |
| 1801 | - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 |
| 1802 | - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 |
| 1803 | - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 |
| 1804 | - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 |
Dirk Eibach | 071be89 | 2015-10-28 11:46:22 +0100 | [diff] [blame] | 1805 | - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL |
| 1806 | - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 |
| 1807 | - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 |
| 1808 | - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 |
| 1809 | - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 |
| 1810 | - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 |
| 1811 | - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 |
| 1812 | - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 |
| 1813 | - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 |
Dirk Eibach | b46226b | 2014-07-03 09:28:18 +0200 | [diff] [blame] | 1814 | |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1815 | additional defines: |
| 1816 | |
| 1817 | CONFIG_SYS_NUM_I2C_BUSES |
Simon Glass | 945a18e | 2016-10-02 18:01:05 -0600 | [diff] [blame] | 1818 | Hold the number of i2c buses you want to use. |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1819 | |
| 1820 | CONFIG_SYS_I2C_DIRECT_BUS |
| 1821 | define this, if you don't use i2c muxes on your hardware. |
| 1822 | if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can |
| 1823 | omit this define. |
| 1824 | |
| 1825 | CONFIG_SYS_I2C_MAX_HOPS |
| 1826 | define how many muxes are maximal consecutively connected |
| 1827 | on one i2c bus. If you not use i2c muxes, omit this |
| 1828 | define. |
| 1829 | |
| 1830 | CONFIG_SYS_I2C_BUSES |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1831 | hold a list of buses you want to use, only used if |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1832 | CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example |
| 1833 | a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and |
| 1834 | CONFIG_SYS_NUM_I2C_BUSES = 9: |
| 1835 | |
| 1836 | CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ |
| 1837 | {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ |
| 1838 | {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ |
| 1839 | {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ |
| 1840 | {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ |
| 1841 | {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ |
| 1842 | {1, {I2C_NULL_HOP}}, \ |
| 1843 | {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ |
| 1844 | {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ |
| 1845 | } |
| 1846 | |
| 1847 | which defines |
| 1848 | bus 0 on adapter 0 without a mux |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 1849 | bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 |
| 1850 | bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 |
| 1851 | bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 |
| 1852 | bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 |
| 1853 | bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1854 | bus 6 on adapter 1 without a mux |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 1855 | bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 |
| 1856 | bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 1857 | |
| 1858 | If you do not have i2c muxes on your board, omit this define. |
| 1859 | |
Simon Glass | ce3b5d6 | 2017-05-12 21:10:00 -0600 | [diff] [blame] | 1860 | - Legacy I2C Support: |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 1861 | If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1862 | then the following macros need to be defined (examples are |
| 1863 | from include/configs/lwmon.h): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1864 | |
| 1865 | I2C_INIT |
| 1866 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1867 | (Optional). Any commands necessary to enable the I2C |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1868 | controller or configure ports. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1869 | |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 1870 | eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1871 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1872 | I2C_ACTIVE |
| 1873 | |
| 1874 | The code necessary to make the I2C data line active |
| 1875 | (driven). If the data line is open collector, this |
| 1876 | define can be null. |
| 1877 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1878 | eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) |
| 1879 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1880 | I2C_TRISTATE |
| 1881 | |
| 1882 | The code necessary to make the I2C data line tri-stated |
| 1883 | (inactive). If the data line is open collector, this |
| 1884 | define can be null. |
| 1885 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1886 | eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) |
| 1887 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1888 | I2C_READ |
| 1889 | |
York Sun | 472d546 | 2013-04-01 11:29:11 -0700 | [diff] [blame] | 1890 | Code that returns true if the I2C data line is high, |
| 1891 | false if it is low. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1892 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1893 | eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) |
| 1894 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1895 | I2C_SDA(bit) |
| 1896 | |
York Sun | 472d546 | 2013-04-01 11:29:11 -0700 | [diff] [blame] | 1897 | If <bit> is true, sets the I2C data line high. If it |
| 1898 | is false, it clears it (low). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1899 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1900 | eg: #define I2C_SDA(bit) \ |
wdenk | 2535d60 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 1901 | if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 1902 | else immr->im_cpm.cp_pbdat &= ~PB_SDA |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1903 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1904 | I2C_SCL(bit) |
| 1905 | |
York Sun | 472d546 | 2013-04-01 11:29:11 -0700 | [diff] [blame] | 1906 | If <bit> is true, sets the I2C clock line high. If it |
| 1907 | is false, it clears it (low). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1908 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1909 | eg: #define I2C_SCL(bit) \ |
wdenk | 2535d60 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 1910 | if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 1911 | else immr->im_cpm.cp_pbdat &= ~PB_SCL |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1912 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1913 | I2C_DELAY |
| 1914 | |
| 1915 | This delay is invoked four times per clock cycle so this |
| 1916 | controls the rate of data transfer. The data rate thus |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1917 | is 1 / (I2C_DELAY * 4). Often defined to be something |
wdenk | 945af8d | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1918 | like: |
| 1919 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1920 | #define I2C_DELAY udelay(2) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1921 | |
Mike Frysinger | 793b572 | 2010-07-21 13:38:02 -0400 | [diff] [blame] | 1922 | CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA |
| 1923 | |
| 1924 | If your arch supports the generic GPIO framework (asm/gpio.h), |
| 1925 | then you may alternatively define the two GPIOs that are to be |
| 1926 | used as SCL / SDA. Any of the previous I2C_xxx macros will |
| 1927 | have GPIO-based defaults assigned to them as appropriate. |
| 1928 | |
| 1929 | You should define these to the GPIO value as given directly to |
| 1930 | the generic GPIO functions. |
| 1931 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1932 | CONFIG_SYS_I2C_INIT_BOARD |
wdenk | 47cd00f | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 1933 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1934 | When a board is reset during an i2c bus transfer |
| 1935 | chips might think that the current transfer is still |
| 1936 | in progress. On some boards it is possible to access |
| 1937 | the i2c SCLK line directly, either by using the |
| 1938 | processor pin as a GPIO or by having a second pin |
| 1939 | connected to the bus. If this option is defined a |
| 1940 | custom i2c_init_board() routine in boards/xxx/board.c |
| 1941 | is run early in the boot sequence. |
wdenk | 47cd00f | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 1942 | |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1943 | CONFIG_I2C_MULTI_BUS |
| 1944 | |
| 1945 | This option allows the use of multiple I2C buses, each of which |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1946 | must have a controller. At any point in time, only one bus is |
| 1947 | active. To switch to a different bus, use the 'i2c dev' command. |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1948 | Note that bus numbering is zero-based. |
| 1949 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1950 | CONFIG_SYS_I2C_NOPROBES |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1951 | |
| 1952 | This option specifies a list of I2C devices that will be skipped |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1953 | when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS |
Peter Tyser | 0f89c54 | 2009-04-18 22:34:03 -0500 | [diff] [blame] | 1954 | is set, specify a list of bus-device pairs. Otherwise, specify |
| 1955 | a 1D array of device addresses |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1956 | |
| 1957 | e.g. |
| 1958 | #undef CONFIG_I2C_MULTI_BUS |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1959 | #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1960 | |
| 1961 | will skip addresses 0x50 and 0x68 on a board with one I2C bus |
| 1962 | |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1963 | #define CONFIG_I2C_MULTI_BUS |
Simon Glass | 945a18e | 2016-10-02 18:01:05 -0600 | [diff] [blame] | 1964 | #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1965 | |
| 1966 | will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 |
| 1967 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1968 | CONFIG_SYS_SPD_BUS_NUM |
Timur Tabi | be5e618 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 1969 | |
| 1970 | If defined, then this indicates the I2C bus number for DDR SPD. |
| 1971 | If not defined, then U-Boot assumes that SPD is on I2C bus 0. |
| 1972 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1973 | CONFIG_SYS_RTC_BUS_NUM |
Stefan Roese | 0dc018e | 2007-02-20 10:51:26 +0100 | [diff] [blame] | 1974 | |
| 1975 | If defined, then this indicates the I2C bus number for the RTC. |
| 1976 | If not defined, then U-Boot assumes that RTC is on I2C bus 0. |
| 1977 | |
Andrew Dyer | 2ac6985 | 2008-12-29 17:36:01 -0600 | [diff] [blame] | 1978 | CONFIG_SOFT_I2C_READ_REPEATED_START |
| 1979 | |
| 1980 | defining this will force the i2c_read() function in |
| 1981 | the soft_i2c driver to perform an I2C repeated start |
| 1982 | between writing the address pointer and reading the |
| 1983 | data. If this define is omitted the default behaviour |
| 1984 | of doing a stop-start sequence will be used. Most I2C |
| 1985 | devices can use either method, but some require one or |
| 1986 | the other. |
Timur Tabi | be5e618 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 1987 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1988 | - SPI Support: CONFIG_SPI |
| 1989 | |
| 1990 | Enables SPI driver (so far only tested with |
| 1991 | SPI EEPROM, also an instance works with Crystal A/D and |
| 1992 | D/As on the SACSng board) |
| 1993 | |
Yoshihiro Shimoda | 6639562 | 2011-01-31 16:50:43 +0900 | [diff] [blame] | 1994 | CONFIG_SH_SPI |
| 1995 | |
| 1996 | Enables the driver for SPI controller on SuperH. Currently |
| 1997 | only SH7757 is supported. |
| 1998 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1999 | CONFIG_SOFT_SPI |
| 2000 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2001 | Enables a software (bit-bang) SPI driver rather than |
| 2002 | using hardware support. This is a general purpose |
| 2003 | driver that only requires three general I/O port pins |
| 2004 | (two outputs, one input) to function. If this is |
| 2005 | defined, the board configuration must define several |
| 2006 | SPI configuration items (port pins to use, etc). For |
| 2007 | an example, see include/configs/sacsng.h. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2008 | |
Ben Warren | 04a9e11 | 2008-01-16 22:37:35 -0500 | [diff] [blame] | 2009 | CONFIG_HARD_SPI |
| 2010 | |
| 2011 | Enables a hardware SPI driver for general-purpose reads |
| 2012 | and writes. As with CONFIG_SOFT_SPI, the board configuration |
| 2013 | must define a list of chip-select function pointers. |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 2014 | Currently supported on some MPC8xxx processors. For an |
Ben Warren | 04a9e11 | 2008-01-16 22:37:35 -0500 | [diff] [blame] | 2015 | example, see include/configs/mpc8349emds.h. |
| 2016 | |
Guennadi Liakhovetski | 38254f4 | 2008-04-15 14:14:25 +0200 | [diff] [blame] | 2017 | CONFIG_MXC_SPI |
| 2018 | |
| 2019 | Enables the driver for the SPI controllers on i.MX and MXC |
Fabio Estevam | 2e3cd1c | 2011-10-28 08:57:46 +0000 | [diff] [blame] | 2020 | SoCs. Currently i.MX31/35/51 are supported. |
Guennadi Liakhovetski | 38254f4 | 2008-04-15 14:14:25 +0200 | [diff] [blame] | 2021 | |
Heiko Schocher | f659b57 | 2014-07-14 10:22:11 +0200 | [diff] [blame] | 2022 | CONFIG_SYS_SPI_MXC_WAIT |
| 2023 | Timeout for waiting until spi transfer completed. |
| 2024 | default: (CONFIG_SYS_HZ/100) /* 10 ms */ |
| 2025 | |
Matthias Fuchs | 0133502 | 2007-12-27 17:12:34 +0100 | [diff] [blame] | 2026 | - FPGA Support: CONFIG_FPGA |
| 2027 | |
| 2028 | Enables FPGA subsystem. |
| 2029 | |
| 2030 | CONFIG_FPGA_<vendor> |
| 2031 | |
| 2032 | Enables support for specific chip vendors. |
| 2033 | (ALTERA, XILINX) |
| 2034 | |
| 2035 | CONFIG_FPGA_<family> |
| 2036 | |
| 2037 | Enables support for FPGA family. |
| 2038 | (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) |
| 2039 | |
| 2040 | CONFIG_FPGA_COUNT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2041 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2042 | Specify the number of FPGA devices to support. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2043 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2044 | CONFIG_SYS_FPGA_PROG_FEEDBACK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2045 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2046 | Enable printing of hash marks during FPGA configuration. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2047 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2048 | CONFIG_SYS_FPGA_CHECK_BUSY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2049 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2050 | Enable checks on FPGA configuration interface busy |
| 2051 | status by the configuration function. This option |
| 2052 | will require a board or device specific function to |
| 2053 | be written. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2054 | |
| 2055 | CONFIG_FPGA_DELAY |
| 2056 | |
| 2057 | If defined, a function that provides delays in the FPGA |
| 2058 | configuration driver. |
| 2059 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2060 | CONFIG_SYS_FPGA_CHECK_CTRLC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2061 | Allow Control-C to interrupt FPGA configuration |
| 2062 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2063 | CONFIG_SYS_FPGA_CHECK_ERROR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2064 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2065 | Check for configuration errors during FPGA bitfile |
| 2066 | loading. For example, abort during Virtex II |
| 2067 | configuration if the INIT_B line goes low (which |
| 2068 | indicated a CRC error). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2069 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2070 | CONFIG_SYS_FPGA_WAIT_INIT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2071 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2072 | Maximum time to wait for the INIT_B line to de-assert |
| 2073 | after PROB_B has been de-asserted during a Virtex II |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2074 | FPGA configuration sequence. The default time is 500 |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2075 | ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2076 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2077 | CONFIG_SYS_FPGA_WAIT_BUSY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2078 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2079 | Maximum time to wait for BUSY to de-assert during |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2080 | Virtex II FPGA configuration. The default is 5 ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2081 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2082 | CONFIG_SYS_FPGA_WAIT_CONFIG |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2083 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2084 | Time to wait after FPGA configuration. The default is |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2085 | 200 ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2086 | |
| 2087 | - Configuration Management: |
Stefan Roese | b2b8a69 | 2014-10-22 12:13:24 +0200 | [diff] [blame] | 2088 | CONFIG_BUILD_TARGET |
| 2089 | |
| 2090 | Some SoCs need special image types (e.g. U-Boot binary |
| 2091 | with a special header) as build targets. By defining |
| 2092 | CONFIG_BUILD_TARGET in the SoC / board header, this |
| 2093 | special image will be automatically built upon calling |
Simon Glass | 6de80f2 | 2016-07-27 20:33:08 -0600 | [diff] [blame] | 2094 | make / buildman. |
Stefan Roese | b2b8a69 | 2014-10-22 12:13:24 +0200 | [diff] [blame] | 2095 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2096 | CONFIG_IDENT_STRING |
| 2097 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2098 | If defined, this string will be added to the U-Boot |
| 2099 | version information (U_BOOT_VERSION) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2100 | |
| 2101 | - Vendor Parameter Protection: |
| 2102 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2103 | U-Boot considers the values of the environment |
| 2104 | variables "serial#" (Board Serial Number) and |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 2105 | "ethaddr" (Ethernet Address) to be parameters that |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2106 | are set once by the board vendor / manufacturer, and |
| 2107 | protects these variables from casual modification by |
| 2108 | the user. Once set, these variables are read-only, |
| 2109 | and write or delete attempts are rejected. You can |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2110 | change this behaviour: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2111 | |
| 2112 | If CONFIG_ENV_OVERWRITE is #defined in your config |
| 2113 | file, the write protection for vendor parameters is |
wdenk | 47cd00f | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 2114 | completely disabled. Anybody can change or delete |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2115 | these parameters. |
| 2116 | |
Joe Hershberger | 92ac520 | 2015-05-04 14:55:14 -0500 | [diff] [blame] | 2117 | Alternatively, if you define _both_ an ethaddr in the |
| 2118 | default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2119 | Ethernet address is installed in the environment, |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2120 | which can be changed exactly ONCE by the user. [The |
| 2121 | serial# is unaffected by this, i. e. it remains |
| 2122 | read-only.] |
| 2123 | |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 2124 | The same can be accomplished in a more flexible way |
| 2125 | for any variable by configuring the type of access |
| 2126 | to allow for those variables in the ".flags" variable |
| 2127 | or define CONFIG_ENV_FLAGS_LIST_STATIC. |
| 2128 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2129 | - Protected RAM: |
| 2130 | CONFIG_PRAM |
| 2131 | |
| 2132 | Define this variable to enable the reservation of |
| 2133 | "protected RAM", i. e. RAM which is not overwritten |
| 2134 | by U-Boot. Define CONFIG_PRAM to hold the number of |
| 2135 | kB you want to reserve for pRAM. You can overwrite |
| 2136 | this default value by defining an environment |
| 2137 | variable "pram" to the number of kB you want to |
| 2138 | reserve. Note that the board info structure will |
| 2139 | still show the full amount of RAM. If pRAM is |
| 2140 | reserved, a new environment variable "mem" will |
| 2141 | automatically be defined to hold the amount of |
| 2142 | remaining RAM in a form that can be passed as boot |
| 2143 | argument to Linux, for instance like that: |
| 2144 | |
Wolfgang Denk | fe126d8 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 2145 | setenv bootargs ... mem=\${mem} |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2146 | saveenv |
| 2147 | |
| 2148 | This way you can tell Linux not to use this memory, |
| 2149 | either, which results in a memory region that will |
| 2150 | not be affected by reboots. |
| 2151 | |
| 2152 | *WARNING* If your board configuration uses automatic |
| 2153 | detection of the RAM size, you must make sure that |
| 2154 | this memory test is non-destructive. So far, the |
| 2155 | following board configurations are known to be |
| 2156 | "pRAM-clean": |
| 2157 | |
Heiko Schocher | 5b8e76c | 2017-06-07 17:33:09 +0200 | [diff] [blame] | 2158 | IVMS8, IVML24, SPD8xx, |
Wolfgang Denk | 1b0757e | 2012-10-24 02:36:15 +0000 | [diff] [blame] | 2159 | HERMES, IP860, RPXlite, LWMON, |
Heiko Schocher | 2eb48ff | 2017-06-07 17:33:10 +0200 | [diff] [blame] | 2160 | FLAGADM |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2161 | |
Gabe Black | 40fef04 | 2012-12-02 04:55:18 +0000 | [diff] [blame] | 2162 | - Access to physical memory region (> 4GB) |
| 2163 | Some basic support is provided for operations on memory not |
| 2164 | normally accessible to U-Boot - e.g. some architectures |
| 2165 | support access to more than 4GB of memory on 32-bit |
| 2166 | machines using physical address extension or similar. |
| 2167 | Define CONFIG_PHYSMEM to access this basic support, which |
| 2168 | currently only supports clearing the memory. |
| 2169 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2170 | - Error Recovery: |
| 2171 | CONFIG_PANIC_HANG |
| 2172 | |
| 2173 | Define this variable to stop the system in case of a |
| 2174 | fatal error, so that you have to reset it manually. |
| 2175 | This is probably NOT a good idea for an embedded |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2176 | system where you want the system to reboot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2177 | automatically as fast as possible, but it may be |
| 2178 | useful during development since you can try to debug |
| 2179 | the conditions that lead to the situation. |
| 2180 | |
| 2181 | CONFIG_NET_RETRY_COUNT |
| 2182 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2183 | This variable defines the number of retries for |
| 2184 | network operations like ARP, RARP, TFTP, or BOOTP |
| 2185 | before giving up the operation. If not defined, a |
| 2186 | default value of 5 is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2187 | |
Guennadi Liakhovetski | 40cb90e | 2008-04-03 17:04:19 +0200 | [diff] [blame] | 2188 | CONFIG_ARP_TIMEOUT |
| 2189 | |
| 2190 | Timeout waiting for an ARP reply in milliseconds. |
| 2191 | |
Tetsuyuki Kobayashi | 48a3e99 | 2012-07-03 22:25:21 +0000 | [diff] [blame] | 2192 | CONFIG_NFS_TIMEOUT |
| 2193 | |
| 2194 | Timeout in milliseconds used in NFS protocol. |
| 2195 | If you encounter "ERROR: Cannot umount" in nfs command, |
| 2196 | try longer timeout such as |
| 2197 | #define CONFIG_NFS_TIMEOUT 10000UL |
| 2198 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2199 | - Command Interpreter: |
Wolfgang Denk | 8078f1a | 2006-10-28 02:28:02 +0200 | [diff] [blame] | 2200 | CONFIG_AUTO_COMPLETE |
wdenk | 04a85b3 | 2004-04-15 18:22:41 +0000 | [diff] [blame] | 2201 | |
| 2202 | Enable auto completion of commands using TAB. |
| 2203 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2204 | CONFIG_SYS_PROMPT_HUSH_PS2 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2205 | |
| 2206 | This defines the secondary prompt string, which is |
| 2207 | printed when the command interpreter needs more input |
| 2208 | to complete a command. Usually "> ". |
| 2209 | |
| 2210 | Note: |
| 2211 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2212 | In the current implementation, the local variables |
| 2213 | space and global environment variables space are |
| 2214 | separated. Local variables are those you define by |
| 2215 | simply typing `name=value'. To access a local |
| 2216 | variable later on, you have write `$name' or |
| 2217 | `${name}'; to execute the contents of a variable |
| 2218 | directly type `$name' at the command prompt. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2219 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2220 | Global environment variables are those you use |
| 2221 | setenv/printenv to work with. To run a command stored |
| 2222 | in such a variable, you need to use the run command, |
| 2223 | and you must not use the '$' sign to access them. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2224 | |
| 2225 | To store commands and special characters in a |
| 2226 | variable, please use double quotation marks |
| 2227 | surrounding the whole text of the variable, instead |
| 2228 | of the backslashes before semicolons and special |
| 2229 | symbols. |
| 2230 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2231 | - Command Line Editing and History: |
Wolfgang Denk | aa0c71a | 2006-07-21 11:35:21 +0200 | [diff] [blame] | 2232 | CONFIG_CMDLINE_EDITING |
| 2233 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2234 | Enable editing and History functions for interactive |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2235 | command line input operations |
Wolfgang Denk | aa0c71a | 2006-07-21 11:35:21 +0200 | [diff] [blame] | 2236 | |
Marek Vasut | f3b267b | 2016-01-27 04:47:55 +0100 | [diff] [blame] | 2237 | - Command Line PS1/PS2 support: |
| 2238 | CONFIG_CMDLINE_PS_SUPPORT |
| 2239 | |
| 2240 | Enable support for changing the command prompt string |
| 2241 | at run-time. Only static string is supported so far. |
| 2242 | The string is obtained from environment variables PS1 |
| 2243 | and PS2. |
| 2244 | |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2245 | - Default Environment: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2246 | CONFIG_EXTRA_ENV_SETTINGS |
| 2247 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2248 | Define this to contain any number of null terminated |
| 2249 | strings (variable = value pairs) that will be part of |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 2250 | the default environment compiled into the boot image. |
wdenk | 2262cfe | 2002-11-18 00:14:45 +0000 | [diff] [blame] | 2251 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2252 | For example, place something like this in your |
| 2253 | board's config file: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2254 | |
| 2255 | #define CONFIG_EXTRA_ENV_SETTINGS \ |
| 2256 | "myvar1=value1\0" \ |
| 2257 | "myvar2=value2\0" |
| 2258 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2259 | Warning: This method is based on knowledge about the |
| 2260 | internal format how the environment is stored by the |
| 2261 | U-Boot code. This is NOT an official, exported |
| 2262 | interface! Although it is unlikely that this format |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 2263 | will change soon, there is no guarantee either. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2264 | You better know what you are doing here. |
| 2265 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2266 | Note: overly (ab)use of the default environment is |
| 2267 | discouraged. Make sure to check other ways to preset |
Wolfgang Denk | 74de7ae | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 2268 | the environment like the "source" command or the |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2269 | boot command first. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2270 | |
Stephen Warren | 5e724ca | 2012-05-22 09:21:54 +0000 | [diff] [blame] | 2271 | CONFIG_ENV_VARS_UBOOT_CONFIG |
| 2272 | |
| 2273 | Define this in order to add variables describing the |
| 2274 | U-Boot build configuration to the default environment. |
| 2275 | These will be named arch, cpu, board, vendor, and soc. |
| 2276 | |
| 2277 | Enabling this option will cause the following to be defined: |
| 2278 | |
| 2279 | - CONFIG_SYS_ARCH |
| 2280 | - CONFIG_SYS_CPU |
| 2281 | - CONFIG_SYS_BOARD |
| 2282 | - CONFIG_SYS_VENDOR |
| 2283 | - CONFIG_SYS_SOC |
| 2284 | |
Tom Rini | 7e27f89 | 2012-10-24 07:28:16 +0000 | [diff] [blame] | 2285 | CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG |
| 2286 | |
| 2287 | Define this in order to add variables describing certain |
| 2288 | run-time determined information about the hardware to the |
| 2289 | environment. These will be named board_name, board_rev. |
| 2290 | |
Simon Glass | 06fd853 | 2012-11-30 13:01:17 +0000 | [diff] [blame] | 2291 | CONFIG_DELAY_ENVIRONMENT |
| 2292 | |
| 2293 | Normally the environment is loaded when the board is |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2294 | initialised so that it is available to U-Boot. This inhibits |
Simon Glass | 06fd853 | 2012-11-30 13:01:17 +0000 | [diff] [blame] | 2295 | that so that the environment is not available until |
| 2296 | explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL |
| 2297 | this is instead controlled by the value of |
| 2298 | /config/load-environment. |
| 2299 | |
Eric Nelson | f61ec45 | 2012-01-31 10:52:08 -0700 | [diff] [blame] | 2300 | - Serial Flash support |
Simon Glass | 00fd59d | 2017-08-04 16:35:06 -0600 | [diff] [blame] | 2301 | Usage requires an initial 'sf probe' to define the serial |
Eric Nelson | f61ec45 | 2012-01-31 10:52:08 -0700 | [diff] [blame] | 2302 | flash parameters, followed by read/write/erase/update |
| 2303 | commands. |
| 2304 | |
| 2305 | The following defaults may be provided by the platform |
| 2306 | to handle the common case when only a single serial |
| 2307 | flash is present on the system. |
| 2308 | |
| 2309 | CONFIG_SF_DEFAULT_BUS Bus identifier |
| 2310 | CONFIG_SF_DEFAULT_CS Chip-select |
| 2311 | CONFIG_SF_DEFAULT_MODE (see include/spi.h) |
| 2312 | CONFIG_SF_DEFAULT_SPEED in Hz |
| 2313 | |
wdenk | 3f85ce2 | 2004-02-23 16:11:30 +0000 | [diff] [blame] | 2314 | CONFIG_SYSTEMACE |
| 2315 | |
| 2316 | Adding this option adds support for Xilinx SystemACE |
| 2317 | chips attached via some sort of local bus. The address |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2318 | of the chip must also be defined in the |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2319 | CONFIG_SYS_SYSTEMACE_BASE macro. For example: |
wdenk | 3f85ce2 | 2004-02-23 16:11:30 +0000 | [diff] [blame] | 2320 | |
| 2321 | #define CONFIG_SYSTEMACE |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2322 | #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 |
wdenk | 3f85ce2 | 2004-02-23 16:11:30 +0000 | [diff] [blame] | 2323 | |
| 2324 | When SystemACE support is added, the "ace" device type |
| 2325 | becomes available to the fat commands, i.e. fatls. |
| 2326 | |
Wolfgang Denk | ecb0ccd | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2327 | - TFTP Fixed UDP Port: |
| 2328 | CONFIG_TFTP_PORT |
| 2329 | |
Wolfgang Denk | 28cb937 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 2330 | If this is defined, the environment variable tftpsrcp |
Wolfgang Denk | ecb0ccd | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2331 | is used to supply the TFTP UDP source port value. |
Wolfgang Denk | 28cb937 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 2332 | If tftpsrcp isn't defined, the normal pseudo-random port |
Wolfgang Denk | ecb0ccd | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2333 | number generator is used. |
| 2334 | |
Wolfgang Denk | 28cb937 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 2335 | Also, the environment variable tftpdstp is used to supply |
| 2336 | the TFTP UDP destination port value. If tftpdstp isn't |
| 2337 | defined, the normal port 69 is used. |
| 2338 | |
| 2339 | The purpose for tftpsrcp is to allow a TFTP server to |
Wolfgang Denk | ecb0ccd | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2340 | blindly start the TFTP transfer using the pre-configured |
| 2341 | target IP address and UDP port. This has the effect of |
| 2342 | "punching through" the (Windows XP) firewall, allowing |
| 2343 | the remainder of the TFTP transfer to proceed normally. |
| 2344 | A better solution is to properly configure the firewall, |
| 2345 | but sometimes that is not allowed. |
| 2346 | |
Heiko Schocher | 9e50c40 | 2014-01-25 07:27:13 +0100 | [diff] [blame] | 2347 | - bootcount support: |
| 2348 | CONFIG_BOOTCOUNT_LIMIT |
| 2349 | |
| 2350 | This enables the bootcounter support, see: |
| 2351 | http://www.denx.de/wiki/DULG/UBootBootCountLimit |
| 2352 | |
| 2353 | CONFIG_AT91SAM9XE |
| 2354 | enable special bootcounter support on at91sam9xe based boards. |
Heiko Schocher | 9e50c40 | 2014-01-25 07:27:13 +0100 | [diff] [blame] | 2355 | CONFIG_SOC_DA8XX |
| 2356 | enable special bootcounter support on da850 based boards. |
| 2357 | CONFIG_BOOTCOUNT_RAM |
| 2358 | enable support for the bootcounter in RAM |
| 2359 | CONFIG_BOOTCOUNT_I2C |
| 2360 | enable support for the bootcounter on an i2c (like RTC) device. |
| 2361 | CONFIG_SYS_I2C_RTC_ADDR = i2c chip address |
| 2362 | CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for |
| 2363 | the bootcounter. |
| 2364 | CONFIG_BOOTCOUNT_ALEN = address len |
Simon Glass | 19c402a | 2013-06-13 15:10:02 -0700 | [diff] [blame] | 2365 | |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2366 | - Show boot progress: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2367 | CONFIG_SHOW_BOOT_PROGRESS |
| 2368 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2369 | Defining this option allows to add some board- |
| 2370 | specific code (calling a user-provided function |
| 2371 | "show_boot_progress(int)") that enables you to show |
| 2372 | the system's boot progress on some display (for |
| 2373 | example, some LED's) on your board. At the moment, |
| 2374 | the following checkpoints are implemented: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2375 | |
Simon Glass | 94fd131 | 2012-09-28 08:56:37 +0000 | [diff] [blame] | 2376 | |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2377 | Legacy uImage format: |
| 2378 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2379 | Arg Where When |
| 2380 | 1 common/cmd_bootm.c before attempting to boot an image |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2381 | -1 common/cmd_bootm.c Image header has bad magic number |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2382 | 2 common/cmd_bootm.c Image header has correct magic number |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2383 | -2 common/cmd_bootm.c Image header has bad checksum |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2384 | 3 common/cmd_bootm.c Image header has correct checksum |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2385 | -3 common/cmd_bootm.c Image data has bad checksum |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2386 | 4 common/cmd_bootm.c Image data has correct checksum |
| 2387 | -4 common/cmd_bootm.c Image is for unsupported architecture |
| 2388 | 5 common/cmd_bootm.c Architecture check OK |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2389 | -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2390 | 6 common/cmd_bootm.c Image Type check OK |
| 2391 | -6 common/cmd_bootm.c gunzip uncompression error |
| 2392 | -7 common/cmd_bootm.c Unimplemented compression type |
| 2393 | 7 common/cmd_bootm.c Uncompression OK |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2394 | 8 common/cmd_bootm.c No uncompress/copy overwrite error |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2395 | -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2396 | |
| 2397 | 9 common/image.c Start initial ramdisk verification |
| 2398 | -10 common/image.c Ramdisk header has bad magic number |
| 2399 | -11 common/image.c Ramdisk header has bad checksum |
| 2400 | 10 common/image.c Ramdisk header is OK |
| 2401 | -12 common/image.c Ramdisk data has bad checksum |
| 2402 | 11 common/image.c Ramdisk data has correct checksum |
| 2403 | 12 common/image.c Ramdisk verification complete, start loading |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2404 | -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2405 | 13 common/image.c Start multifile image verification |
| 2406 | 14 common/image.c No initial ramdisk, no multifile, continue. |
| 2407 | |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 2408 | 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2409 | |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 2410 | -30 arch/powerpc/lib/board.c Fatal error, hang the system |
wdenk | 11dadd54 | 2004-02-27 00:07:27 +0000 | [diff] [blame] | 2411 | -31 post/post.c POST test failed, detected by post_output_backlog() |
| 2412 | -32 post/post.c POST test failed, detected by post_run_single() |
wdenk | 63e73c9 | 2004-02-23 22:22:28 +0000 | [diff] [blame] | 2413 | |
Heiko Schocher | 566a494 | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2414 | 34 common/cmd_doc.c before loading a Image from a DOC device |
| 2415 | -35 common/cmd_doc.c Bad usage of "doc" command |
| 2416 | 35 common/cmd_doc.c correct usage of "doc" command |
| 2417 | -36 common/cmd_doc.c No boot device |
| 2418 | 36 common/cmd_doc.c correct boot device |
| 2419 | -37 common/cmd_doc.c Unknown Chip ID on boot device |
| 2420 | 37 common/cmd_doc.c correct chip ID found, device available |
| 2421 | -38 common/cmd_doc.c Read Error on boot device |
| 2422 | 38 common/cmd_doc.c reading Image header from DOC device OK |
| 2423 | -39 common/cmd_doc.c Image header has bad magic number |
| 2424 | 39 common/cmd_doc.c Image header has correct magic number |
| 2425 | -40 common/cmd_doc.c Error reading Image from DOC device |
| 2426 | 40 common/cmd_doc.c Image header has correct magic number |
| 2427 | 41 common/cmd_ide.c before loading a Image from a IDE device |
| 2428 | -42 common/cmd_ide.c Bad usage of "ide" command |
| 2429 | 42 common/cmd_ide.c correct usage of "ide" command |
| 2430 | -43 common/cmd_ide.c No boot device |
| 2431 | 43 common/cmd_ide.c boot device found |
| 2432 | -44 common/cmd_ide.c Device not available |
| 2433 | 44 common/cmd_ide.c Device available |
| 2434 | -45 common/cmd_ide.c wrong partition selected |
| 2435 | 45 common/cmd_ide.c partition selected |
| 2436 | -46 common/cmd_ide.c Unknown partition table |
| 2437 | 46 common/cmd_ide.c valid partition table found |
| 2438 | -47 common/cmd_ide.c Invalid partition type |
| 2439 | 47 common/cmd_ide.c correct partition type |
| 2440 | -48 common/cmd_ide.c Error reading Image Header on boot device |
| 2441 | 48 common/cmd_ide.c reading Image Header from IDE device OK |
| 2442 | -49 common/cmd_ide.c Image header has bad magic number |
| 2443 | 49 common/cmd_ide.c Image header has correct magic number |
| 2444 | -50 common/cmd_ide.c Image header has bad checksum |
| 2445 | 50 common/cmd_ide.c Image header has correct checksum |
| 2446 | -51 common/cmd_ide.c Error reading Image from IDE device |
| 2447 | 51 common/cmd_ide.c reading Image from IDE device OK |
| 2448 | 52 common/cmd_nand.c before loading a Image from a NAND device |
| 2449 | -53 common/cmd_nand.c Bad usage of "nand" command |
| 2450 | 53 common/cmd_nand.c correct usage of "nand" command |
| 2451 | -54 common/cmd_nand.c No boot device |
| 2452 | 54 common/cmd_nand.c boot device found |
| 2453 | -55 common/cmd_nand.c Unknown Chip ID on boot device |
| 2454 | 55 common/cmd_nand.c correct chip ID found, device available |
| 2455 | -56 common/cmd_nand.c Error reading Image Header on boot device |
| 2456 | 56 common/cmd_nand.c reading Image Header from NAND device OK |
| 2457 | -57 common/cmd_nand.c Image header has bad magic number |
| 2458 | 57 common/cmd_nand.c Image header has correct magic number |
| 2459 | -58 common/cmd_nand.c Error reading Image from NAND device |
| 2460 | 58 common/cmd_nand.c reading Image from NAND device OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2461 | |
Heiko Schocher | 566a494 | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2462 | -60 common/env_common.c Environment has a bad CRC, using default |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2463 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2464 | 64 net/eth.c starting with Ethernet configuration. |
Heiko Schocher | 566a494 | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2465 | -64 net/eth.c no Ethernet found. |
| 2466 | 65 net/eth.c Ethernet found. |
wdenk | 206c60c | 2003-09-18 10:02:25 +0000 | [diff] [blame] | 2467 | |
Heiko Schocher | 566a494 | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2468 | -80 common/cmd_net.c usage wrong |
Joe Hershberger | bc0571f | 2015-04-08 01:41:21 -0500 | [diff] [blame] | 2469 | 80 common/cmd_net.c before calling net_loop() |
| 2470 | -81 common/cmd_net.c some error in net_loop() occurred |
| 2471 | 81 common/cmd_net.c net_loop() back without error |
Heiko Schocher | 566a494 | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2472 | -82 common/cmd_net.c size == 0 (File with size 0 loaded) |
| 2473 | 82 common/cmd_net.c trying automatic boot |
Wolfgang Denk | 74de7ae | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 2474 | 83 common/cmd_net.c running "source" command |
| 2475 | -83 common/cmd_net.c some error in automatic boot or "source" command |
Heiko Schocher | 566a494 | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2476 | 84 common/cmd_net.c end without errors |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2477 | |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2478 | FIT uImage format: |
| 2479 | |
| 2480 | Arg Where When |
| 2481 | 100 common/cmd_bootm.c Kernel FIT Image has correct format |
| 2482 | -100 common/cmd_bootm.c Kernel FIT Image has incorrect format |
| 2483 | 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration |
| 2484 | -101 common/cmd_bootm.c Can't get configuration for kernel subimage |
| 2485 | 102 common/cmd_bootm.c Kernel unit name specified |
| 2486 | -103 common/cmd_bootm.c Can't get kernel subimage node offset |
Marian Balakowicz | f773bea | 2008-03-12 10:35:46 +0100 | [diff] [blame] | 2487 | 103 common/cmd_bootm.c Found configuration node |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2488 | 104 common/cmd_bootm.c Got kernel subimage node offset |
| 2489 | -104 common/cmd_bootm.c Kernel subimage hash verification failed |
| 2490 | 105 common/cmd_bootm.c Kernel subimage hash verification OK |
| 2491 | -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture |
| 2492 | 106 common/cmd_bootm.c Architecture check OK |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2493 | -106 common/cmd_bootm.c Kernel subimage has wrong type |
| 2494 | 107 common/cmd_bootm.c Kernel subimage type OK |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2495 | -107 common/cmd_bootm.c Can't get kernel subimage data/size |
| 2496 | 108 common/cmd_bootm.c Got kernel subimage data/size |
| 2497 | -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) |
| 2498 | -109 common/cmd_bootm.c Can't get kernel subimage type |
| 2499 | -110 common/cmd_bootm.c Can't get kernel subimage comp |
| 2500 | -111 common/cmd_bootm.c Can't get kernel subimage os |
| 2501 | -112 common/cmd_bootm.c Can't get kernel subimage load address |
| 2502 | -113 common/cmd_bootm.c Image uncompress/copy overwrite error |
| 2503 | |
| 2504 | 120 common/image.c Start initial ramdisk verification |
| 2505 | -120 common/image.c Ramdisk FIT image has incorrect format |
| 2506 | 121 common/image.c Ramdisk FIT image has correct format |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2507 | 122 common/image.c No ramdisk subimage unit name, using configuration |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2508 | -122 common/image.c Can't get configuration for ramdisk subimage |
| 2509 | 123 common/image.c Ramdisk unit name specified |
| 2510 | -124 common/image.c Can't get ramdisk subimage node offset |
| 2511 | 125 common/image.c Got ramdisk subimage node offset |
| 2512 | -125 common/image.c Ramdisk subimage hash verification failed |
| 2513 | 126 common/image.c Ramdisk subimage hash verification OK |
| 2514 | -126 common/image.c Ramdisk subimage for unsupported architecture |
| 2515 | 127 common/image.c Architecture check OK |
| 2516 | -127 common/image.c Can't get ramdisk subimage data/size |
| 2517 | 128 common/image.c Got ramdisk subimage data/size |
| 2518 | 129 common/image.c Can't get ramdisk load address |
| 2519 | -129 common/image.c Got ramdisk load address |
| 2520 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2521 | -130 common/cmd_doc.c Incorrect FIT image format |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2522 | 131 common/cmd_doc.c FIT image format OK |
| 2523 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2524 | -140 common/cmd_ide.c Incorrect FIT image format |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2525 | 141 common/cmd_ide.c FIT image format OK |
| 2526 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2527 | -150 common/cmd_nand.c Incorrect FIT image format |
Marian Balakowicz | 1372cce | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2528 | 151 common/cmd_nand.c FIT image format OK |
| 2529 | |
Heiko Schocher | 21d29f7 | 2014-05-28 11:33:33 +0200 | [diff] [blame] | 2530 | - legacy image format: |
| 2531 | CONFIG_IMAGE_FORMAT_LEGACY |
| 2532 | enables the legacy image format support in U-Boot. |
| 2533 | |
| 2534 | Default: |
| 2535 | enabled if CONFIG_FIT_SIGNATURE is not defined. |
| 2536 | |
| 2537 | CONFIG_DISABLE_IMAGE_LEGACY |
| 2538 | disable the legacy image format |
| 2539 | |
| 2540 | This define is introduced, as the legacy image format is |
| 2541 | enabled per default for backward compatibility. |
| 2542 | |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 2543 | - Standalone program support: |
| 2544 | CONFIG_STANDALONE_LOAD_ADDR |
| 2545 | |
Wolfgang Denk | 6feff89 | 2011-10-09 21:06:34 +0200 | [diff] [blame] | 2546 | This option defines a board specific value for the |
| 2547 | address where standalone program gets loaded, thus |
| 2548 | overwriting the architecture dependent default |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 2549 | settings. |
| 2550 | |
| 2551 | - Frame Buffer Address: |
| 2552 | CONFIG_FB_ADDR |
| 2553 | |
| 2554 | Define CONFIG_FB_ADDR if you want to use specific |
Wolfgang Denk | 44a53b5 | 2013-01-03 00:43:59 +0000 | [diff] [blame] | 2555 | address for frame buffer. This is typically the case |
| 2556 | when using a graphics controller has separate video |
| 2557 | memory. U-Boot will then place the frame buffer at |
| 2558 | the given address instead of dynamically reserving it |
| 2559 | in system RAM by calling lcd_setmem(), which grabs |
| 2560 | the memory for the frame buffer depending on the |
| 2561 | configured panel size. |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 2562 | |
| 2563 | Please see board_init_f function. |
| 2564 | |
Detlev Zundel | cccfc2a | 2009-12-01 17:16:19 +0100 | [diff] [blame] | 2565 | - Automatic software updates via TFTP server |
| 2566 | CONFIG_UPDATE_TFTP |
| 2567 | CONFIG_UPDATE_TFTP_CNT_MAX |
| 2568 | CONFIG_UPDATE_TFTP_MSEC_MAX |
| 2569 | |
| 2570 | These options enable and control the auto-update feature; |
| 2571 | for a more detailed description refer to doc/README.update. |
| 2572 | |
| 2573 | - MTD Support (mtdparts command, UBI support) |
| 2574 | CONFIG_MTD_DEVICE |
| 2575 | |
| 2576 | Adds the MTD device infrastructure from the Linux kernel. |
| 2577 | Needed for mtdparts command support. |
| 2578 | |
| 2579 | CONFIG_MTD_PARTITIONS |
| 2580 | |
| 2581 | Adds the MTD partitioning infrastructure from the Linux |
| 2582 | kernel. Needed for UBI support. |
| 2583 | |
Joe Hershberger | 70c219c | 2013-04-08 10:32:48 +0000 | [diff] [blame] | 2584 | - UBI support |
Joe Hershberger | 147162d | 2013-04-08 10:32:49 +0000 | [diff] [blame] | 2585 | CONFIG_UBI_SILENCE_MSG |
| 2586 | |
| 2587 | Make the verbose messages from UBI stop printing. This leaves |
| 2588 | warnings and errors enabled. |
| 2589 | |
Heiko Schocher | ff94bc4 | 2014-06-24 10:10:04 +0200 | [diff] [blame] | 2590 | |
| 2591 | CONFIG_MTD_UBI_WL_THRESHOLD |
| 2592 | This parameter defines the maximum difference between the highest |
| 2593 | erase counter value and the lowest erase counter value of eraseblocks |
| 2594 | of UBI devices. When this threshold is exceeded, UBI starts performing |
| 2595 | wear leveling by means of moving data from eraseblock with low erase |
| 2596 | counter to eraseblocks with high erase counter. |
| 2597 | |
| 2598 | The default value should be OK for SLC NAND flashes, NOR flashes and |
| 2599 | other flashes which have eraseblock life-cycle 100000 or more. |
| 2600 | However, in case of MLC NAND flashes which typically have eraseblock |
| 2601 | life-cycle less than 10000, the threshold should be lessened (e.g., |
| 2602 | to 128 or 256, although it does not have to be power of 2). |
| 2603 | |
| 2604 | default: 4096 |
Simon Glass | c654b51 | 2014-10-23 18:58:54 -0600 | [diff] [blame] | 2605 | |
Heiko Schocher | ff94bc4 | 2014-06-24 10:10:04 +0200 | [diff] [blame] | 2606 | CONFIG_MTD_UBI_BEB_LIMIT |
| 2607 | This option specifies the maximum bad physical eraseblocks UBI |
| 2608 | expects on the MTD device (per 1024 eraseblocks). If the |
| 2609 | underlying flash does not admit of bad eraseblocks (e.g. NOR |
| 2610 | flash), this value is ignored. |
| 2611 | |
| 2612 | NAND datasheets often specify the minimum and maximum NVM |
| 2613 | (Number of Valid Blocks) for the flashes' endurance lifetime. |
| 2614 | The maximum expected bad eraseblocks per 1024 eraseblocks |
| 2615 | then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", |
| 2616 | which gives 20 for most NANDs (MaxNVB is basically the total |
| 2617 | count of eraseblocks on the chip). |
| 2618 | |
| 2619 | To put it differently, if this value is 20, UBI will try to |
| 2620 | reserve about 1.9% of physical eraseblocks for bad blocks |
| 2621 | handling. And that will be 1.9% of eraseblocks on the entire |
| 2622 | NAND chip, not just the MTD partition UBI attaches. This means |
| 2623 | that if you have, say, a NAND flash chip admits maximum 40 bad |
| 2624 | eraseblocks, and it is split on two MTD partitions of the same |
| 2625 | size, UBI will reserve 40 eraseblocks when attaching a |
| 2626 | partition. |
| 2627 | |
| 2628 | default: 20 |
| 2629 | |
| 2630 | CONFIG_MTD_UBI_FASTMAP |
| 2631 | Fastmap is a mechanism which allows attaching an UBI device |
| 2632 | in nearly constant time. Instead of scanning the whole MTD device it |
| 2633 | only has to locate a checkpoint (called fastmap) on the device. |
| 2634 | The on-flash fastmap contains all information needed to attach |
| 2635 | the device. Using fastmap makes only sense on large devices where |
| 2636 | attaching by scanning takes long. UBI will not automatically install |
| 2637 | a fastmap on old images, but you can set the UBI parameter |
| 2638 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note |
| 2639 | that fastmap-enabled images are still usable with UBI implementations |
| 2640 | without fastmap support. On typical flash devices the whole fastmap |
| 2641 | fits into one PEB. UBI will reserve PEBs to hold two fastmaps. |
| 2642 | |
| 2643 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT |
| 2644 | Set this parameter to enable fastmap automatically on images |
| 2645 | without a fastmap. |
| 2646 | default: 0 |
| 2647 | |
Heiko Schocher | 0195a7b | 2015-10-22 06:19:21 +0200 | [diff] [blame] | 2648 | CONFIG_MTD_UBI_FM_DEBUG |
| 2649 | Enable UBI fastmap debug |
| 2650 | default: 0 |
| 2651 | |
Joe Hershberger | 70c219c | 2013-04-08 10:32:48 +0000 | [diff] [blame] | 2652 | - UBIFS support |
Joe Hershberger | 147162d | 2013-04-08 10:32:49 +0000 | [diff] [blame] | 2653 | CONFIG_UBIFS_SILENCE_MSG |
| 2654 | |
| 2655 | Make the verbose messages from UBIFS stop printing. This leaves |
| 2656 | warnings and errors enabled. |
| 2657 | |
Daniel Schwierzeck | 6a11cf4 | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2658 | - SPL framework |
Wolfgang Denk | 04e5ae7 | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2659 | CONFIG_SPL |
| 2660 | Enable building of SPL globally. |
Daniel Schwierzeck | 6a11cf4 | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2661 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2662 | CONFIG_SPL_LDSCRIPT |
| 2663 | LDSCRIPT for linking the SPL binary. |
| 2664 | |
Albert ARIBAUD | 6ebc346 | 2013-04-12 05:14:30 +0000 | [diff] [blame] | 2665 | CONFIG_SPL_MAX_FOOTPRINT |
| 2666 | Maximum size in memory allocated to the SPL, BSS included. |
| 2667 | When defined, the linker checks that the actual memory |
| 2668 | used by SPL from _start to __bss_end does not exceed it. |
Albert ARIBAUD | 8960af8 | 2013-04-14 04:48:38 +0000 | [diff] [blame] | 2669 | CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE |
Albert ARIBAUD | 6ebc346 | 2013-04-12 05:14:30 +0000 | [diff] [blame] | 2670 | must not be both defined at the same time. |
| 2671 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2672 | CONFIG_SPL_MAX_SIZE |
Albert ARIBAUD | 6ebc346 | 2013-04-12 05:14:30 +0000 | [diff] [blame] | 2673 | Maximum size of the SPL image (text, data, rodata, and |
| 2674 | linker lists sections), BSS excluded. |
| 2675 | When defined, the linker checks that the actual size does |
| 2676 | not exceed it. |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2677 | |
Wolfgang Denk | 04e5ae7 | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2678 | CONFIG_SPL_TEXT_BASE |
| 2679 | TEXT_BASE for linking the SPL binary. |
Daniel Schwierzeck | 6a11cf4 | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2680 | |
Scott Wood | 94a45bb | 2012-09-20 19:05:12 -0500 | [diff] [blame] | 2681 | CONFIG_SPL_RELOC_TEXT_BASE |
| 2682 | Address to relocate to. If unspecified, this is equal to |
| 2683 | CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). |
| 2684 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2685 | CONFIG_SPL_BSS_START_ADDR |
| 2686 | Link address for the BSS within the SPL binary. |
| 2687 | |
| 2688 | CONFIG_SPL_BSS_MAX_SIZE |
Albert ARIBAUD | 6ebc346 | 2013-04-12 05:14:30 +0000 | [diff] [blame] | 2689 | Maximum size in memory allocated to the SPL BSS. |
| 2690 | When defined, the linker checks that the actual memory used |
| 2691 | by SPL from __bss_start to __bss_end does not exceed it. |
Albert ARIBAUD | 8960af8 | 2013-04-14 04:48:38 +0000 | [diff] [blame] | 2692 | CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE |
Albert ARIBAUD | 6ebc346 | 2013-04-12 05:14:30 +0000 | [diff] [blame] | 2693 | must not be both defined at the same time. |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2694 | |
| 2695 | CONFIG_SPL_STACK |
| 2696 | Adress of the start of the stack SPL will use |
| 2697 | |
Albert ARIBAUD \(3ADEV\) | 8c80eb3 | 2015-03-31 11:40:50 +0200 | [diff] [blame] | 2698 | CONFIG_SPL_PANIC_ON_RAW_IMAGE |
| 2699 | When defined, SPL will panic() if the image it has |
| 2700 | loaded does not have a signature. |
| 2701 | Defining this is useful when code which loads images |
| 2702 | in SPL cannot guarantee that absolutely all read errors |
| 2703 | will be caught. |
| 2704 | An example is the LPC32XX MLC NAND driver, which will |
| 2705 | consider that a completely unreadable NAND block is bad, |
| 2706 | and thus should be skipped silently. |
| 2707 | |
Scott Wood | 94a45bb | 2012-09-20 19:05:12 -0500 | [diff] [blame] | 2708 | CONFIG_SPL_RELOC_STACK |
| 2709 | Adress of the start of the stack SPL will use after |
| 2710 | relocation. If unspecified, this is equal to |
| 2711 | CONFIG_SPL_STACK. |
| 2712 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2713 | CONFIG_SYS_SPL_MALLOC_START |
| 2714 | Starting address of the malloc pool used in SPL. |
Fabio Estevam | 9ac4fc8 | 2015-11-12 12:30:19 -0200 | [diff] [blame] | 2715 | When this option is set the full malloc is used in SPL and |
| 2716 | it is set up by spl_init() and before that, the simple malloc() |
| 2717 | can be used if CONFIG_SYS_MALLOC_F is defined. |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2718 | |
| 2719 | CONFIG_SYS_SPL_MALLOC_SIZE |
| 2720 | The size of the malloc pool used in SPL. |
Daniel Schwierzeck | 6a11cf4 | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2721 | |
Tom Rini | 47f7bca | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 2722 | CONFIG_SPL_FRAMEWORK |
| 2723 | Enable the SPL framework under common/. This framework |
| 2724 | supports MMC, NAND and YMODEM loading of U-Boot and NAND |
| 2725 | NAND loading of the Linux Kernel. |
| 2726 | |
Tom Rini | 9607faf | 2014-03-28 12:03:39 -0400 | [diff] [blame] | 2727 | CONFIG_SPL_OS_BOOT |
| 2728 | Enable booting directly to an OS from SPL. |
| 2729 | See also: doc/README.falcon |
| 2730 | |
Tom Rini | 861a86f | 2012-08-13 11:37:56 -0700 | [diff] [blame] | 2731 | CONFIG_SPL_DISPLAY_PRINT |
| 2732 | For ARM, enable an optional function to print more information |
| 2733 | about the running system. |
| 2734 | |
Scott Wood | 4b91972 | 2012-09-20 16:35:21 -0500 | [diff] [blame] | 2735 | CONFIG_SPL_INIT_MINIMAL |
| 2736 | Arch init code should be built for a very small image |
| 2737 | |
Paul Kocialkowski | b97300b | 2014-11-08 23:14:56 +0100 | [diff] [blame] | 2738 | CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION |
| 2739 | Partition on the MMC to load U-Boot from when the MMC is being |
| 2740 | used in raw mode |
| 2741 | |
Peter Korsgaard | 2b75b0a | 2013-05-13 08:36:29 +0000 | [diff] [blame] | 2742 | CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR |
| 2743 | Sector to load kernel uImage from when MMC is being |
| 2744 | used in raw mode (for Falcon mode) |
| 2745 | |
| 2746 | CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, |
| 2747 | CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS |
| 2748 | Sector and number of sectors to load kernel argument |
| 2749 | parameters from when MMC is being used in raw mode |
| 2750 | (for falcon mode) |
| 2751 | |
Paul Kocialkowski | e2ccdf8 | 2014-11-08 23:14:55 +0100 | [diff] [blame] | 2752 | CONFIG_SYS_MMCSD_FS_BOOT_PARTITION |
| 2753 | Partition on the MMC to load U-Boot from when the MMC is being |
| 2754 | used in fs mode |
| 2755 | |
Guillaume GARDET | fae81c7 | 2014-10-15 17:53:13 +0200 | [diff] [blame] | 2756 | CONFIG_SPL_FS_LOAD_PAYLOAD_NAME |
| 2757 | Filename to read to load U-Boot when reading from filesystem |
| 2758 | |
| 2759 | CONFIG_SPL_FS_LOAD_KERNEL_NAME |
Peter Korsgaard | 7ad2cc7 | 2013-05-13 08:36:27 +0000 | [diff] [blame] | 2760 | Filename to read to load kernel uImage when reading |
Guillaume GARDET | fae81c7 | 2014-10-15 17:53:13 +0200 | [diff] [blame] | 2761 | from filesystem (for Falcon mode) |
Peter Korsgaard | 7ad2cc7 | 2013-05-13 08:36:27 +0000 | [diff] [blame] | 2762 | |
Guillaume GARDET | fae81c7 | 2014-10-15 17:53:13 +0200 | [diff] [blame] | 2763 | CONFIG_SPL_FS_LOAD_ARGS_NAME |
Peter Korsgaard | 7ad2cc7 | 2013-05-13 08:36:27 +0000 | [diff] [blame] | 2764 | Filename to read to load kernel argument parameters |
Guillaume GARDET | fae81c7 | 2014-10-15 17:53:13 +0200 | [diff] [blame] | 2765 | when reading from filesystem (for Falcon mode) |
Peter Korsgaard | 7ad2cc7 | 2013-05-13 08:36:27 +0000 | [diff] [blame] | 2766 | |
Scott Wood | 06f60ae | 2012-12-06 13:33:17 +0000 | [diff] [blame] | 2767 | CONFIG_SPL_MPC83XX_WAIT_FOR_NAND |
| 2768 | Set this for NAND SPL on PPC mpc83xx targets, so that |
| 2769 | start.S waits for the rest of the SPL to load before |
| 2770 | continuing (the hardware starts execution after just |
| 2771 | loading the first page rather than the full 4K). |
| 2772 | |
Prabhakar Kushwaha | 651fcf6 | 2014-04-08 19:12:31 +0530 | [diff] [blame] | 2773 | CONFIG_SPL_SKIP_RELOCATE |
| 2774 | Avoid SPL relocation |
| 2775 | |
Scott Wood | 6f2f01b | 2012-09-20 19:09:07 -0500 | [diff] [blame] | 2776 | CONFIG_SPL_NAND_BASE |
| 2777 | Include nand_base.c in the SPL. Requires |
| 2778 | CONFIG_SPL_NAND_DRIVERS. |
| 2779 | |
| 2780 | CONFIG_SPL_NAND_DRIVERS |
| 2781 | SPL uses normal NAND drivers, not minimal drivers. |
| 2782 | |
| 2783 | CONFIG_SPL_NAND_ECC |
| 2784 | Include standard software ECC in the SPL |
| 2785 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2786 | CONFIG_SPL_NAND_SIMPLE |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 2787 | Support for NAND boot using simple NAND drivers that |
| 2788 | expose the cmd_ctrl() interface. |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2789 | |
Thomas Gleixner | 6f4e7d3 | 2016-07-12 20:28:12 +0200 | [diff] [blame] | 2790 | CONFIG_SPL_UBI |
| 2791 | Support for a lightweight UBI (fastmap) scanner and |
| 2792 | loader |
| 2793 | |
Heiko Schocher | 0c3117b | 2014-10-31 08:31:00 +0100 | [diff] [blame] | 2794 | CONFIG_SPL_NAND_RAW_ONLY |
| 2795 | Support to boot only raw u-boot.bin images. Use this only |
| 2796 | if you need to save space. |
| 2797 | |
Ying Zhang | 7c8eea5 | 2013-08-16 15:16:12 +0800 | [diff] [blame] | 2798 | CONFIG_SPL_COMMON_INIT_DDR |
| 2799 | Set for common ddr init with serial presence detect in |
| 2800 | SPL binary. |
| 2801 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2802 | CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, |
| 2803 | CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, |
| 2804 | CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, |
| 2805 | CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, |
| 2806 | CONFIG_SYS_NAND_ECCBYTES |
| 2807 | Defines the size and behavior of the NAND that SPL uses |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 2808 | to read U-Boot |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2809 | |
Prabhakar Kushwaha | fbe76ae | 2013-12-11 12:42:11 +0530 | [diff] [blame] | 2810 | CONFIG_SPL_NAND_BOOT |
| 2811 | Add support NAND boot |
| 2812 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2813 | CONFIG_SYS_NAND_U_BOOT_OFFS |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 2814 | Location in NAND to read U-Boot from |
| 2815 | |
| 2816 | CONFIG_SYS_NAND_U_BOOT_DST |
| 2817 | Location in memory to load U-Boot to |
| 2818 | |
| 2819 | CONFIG_SYS_NAND_U_BOOT_SIZE |
| 2820 | Size of image to load |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2821 | |
| 2822 | CONFIG_SYS_NAND_U_BOOT_START |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 2823 | Entry point in loaded image to jump to |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2824 | |
| 2825 | CONFIG_SYS_NAND_HW_ECC_OOBFIRST |
| 2826 | Define this if you need to first read the OOB and then the |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2827 | data. This is used, for example, on davinci platforms. |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 2828 | |
Pavel Machek | c57b953 | 2012-08-30 22:42:11 +0200 | [diff] [blame] | 2829 | CONFIG_SPL_RAM_DEVICE |
| 2830 | Support for running image already present in ram, in SPL binary |
| 2831 | |
Scott Wood | 74752ba | 2012-12-06 13:33:16 +0000 | [diff] [blame] | 2832 | CONFIG_SPL_PAD_TO |
Benoît Thébaudeau | 6113d3f | 2013-04-11 09:35:49 +0000 | [diff] [blame] | 2833 | Image offset to which the SPL should be padded before appending |
| 2834 | the SPL payload. By default, this is defined as |
| 2835 | CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. |
| 2836 | CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL |
| 2837 | payload without any padding, or >= CONFIG_SPL_MAX_SIZE. |
Scott Wood | 74752ba | 2012-12-06 13:33:16 +0000 | [diff] [blame] | 2838 | |
Scott Wood | ca2fca2 | 2012-09-21 16:27:32 -0500 | [diff] [blame] | 2839 | CONFIG_SPL_TARGET |
| 2840 | Final target image containing SPL and payload. Some SPLs |
| 2841 | use an arch-specific makefile fragment instead, for |
| 2842 | example if more than one image needs to be produced. |
| 2843 | |
Simon Glass | 87ebee3 | 2013-05-08 08:05:59 +0000 | [diff] [blame] | 2844 | CONFIG_FIT_SPL_PRINT |
| 2845 | Printing information about a FIT image adds quite a bit of |
| 2846 | code to SPL. So this is normally disabled in SPL. Use this |
| 2847 | option to re-enable it. This will affect the output of the |
| 2848 | bootm command when booting a FIT image. |
| 2849 | |
Ying Zhang | 3aa29de | 2013-08-16 15:16:15 +0800 | [diff] [blame] | 2850 | - TPL framework |
| 2851 | CONFIG_TPL |
| 2852 | Enable building of TPL globally. |
| 2853 | |
| 2854 | CONFIG_TPL_PAD_TO |
| 2855 | Image offset to which the TPL should be padded before appending |
| 2856 | the TPL payload. By default, this is defined as |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 2857 | CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. |
| 2858 | CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL |
| 2859 | payload without any padding, or >= CONFIG_SPL_MAX_SIZE. |
Ying Zhang | 3aa29de | 2013-08-16 15:16:15 +0800 | [diff] [blame] | 2860 | |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2861 | - Interrupt support (PPC): |
| 2862 | |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2863 | There are common interrupt_init() and timer_interrupt() |
| 2864 | for all PPC archs. interrupt_init() calls interrupt_init_cpu() |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2865 | for CPU specific initialization. interrupt_init_cpu() |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2866 | should set decrementer_count to appropriate value. If |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2867 | CPU resets decrementer automatically after interrupt |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2868 | (ppc4xx) it should set decrementer_count to zero. |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2869 | timer_interrupt() calls timer_interrupt_cpu() for CPU |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2870 | specific handling. If board has watchdog / status_led |
| 2871 | / other_activity_monitor it works automatically from |
| 2872 | general timer_interrupt(). |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2873 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2874 | |
Helmut Raiger | 9660e44 | 2011-10-20 04:19:47 +0000 | [diff] [blame] | 2875 | Board initialization settings: |
| 2876 | ------------------------------ |
| 2877 | |
| 2878 | During Initialization u-boot calls a number of board specific functions |
| 2879 | to allow the preparation of board specific prerequisites, e.g. pin setup |
| 2880 | before drivers are initialized. To enable these callbacks the |
| 2881 | following configuration macros have to be defined. Currently this is |
| 2882 | architecture specific, so please check arch/your_architecture/lib/board.c |
| 2883 | typically in board_init_f() and board_init_r(). |
| 2884 | |
| 2885 | - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() |
| 2886 | - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() |
| 2887 | - CONFIG_BOARD_LATE_INIT: Call board_late_init() |
| 2888 | - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2889 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2890 | Configuration Settings: |
| 2891 | ----------------------- |
| 2892 | |
York Sun | 4d1fd7f | 2014-02-26 17:03:19 -0800 | [diff] [blame] | 2893 | - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. |
| 2894 | Optionally it can be defined to support 64-bit memory commands. |
| 2895 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2896 | - CONFIG_SYS_LONGHELP: Defined when you want long help messages included; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2897 | undefine this when you're short of memory. |
| 2898 | |
Peter Tyser | 2fb2604 | 2009-01-27 18:03:12 -0600 | [diff] [blame] | 2899 | - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default |
| 2900 | width of the commands listed in the 'help' command output. |
| 2901 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2902 | - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2903 | prompt for user input. |
| 2904 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2905 | - CONFIG_SYS_CBSIZE: Buffer size for input from the Console |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2906 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2907 | - CONFIG_SYS_PBSIZE: Buffer size for Console output |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2908 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2909 | - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2910 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2911 | - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2912 | the application (usually a Linux kernel) when it is |
| 2913 | booted |
| 2914 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2915 | - CONFIG_SYS_BAUDRATE_TABLE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2916 | List of legal baudrate settings for this board. |
| 2917 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2918 | - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2919 | Begin and End addresses of the area used by the |
| 2920 | simple memory test. |
| 2921 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2922 | - CONFIG_SYS_ALT_MEMTEST: |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2923 | Enable an alternate, more extensive memory test. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2924 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2925 | - CONFIG_SYS_MEMTEST_SCRATCH: |
wdenk | 5f535fe | 2003-09-18 09:21:33 +0000 | [diff] [blame] | 2926 | Scratch address used by the alternate memory test |
| 2927 | You only need to set this if address zero isn't writeable |
| 2928 | |
York Sun | e814952 | 2015-12-04 11:57:07 -0800 | [diff] [blame] | 2929 | - CONFIG_SYS_MEM_RESERVE_SECURE |
York Sun | e61a753 | 2016-06-24 16:46:18 -0700 | [diff] [blame] | 2930 | Only implemented for ARMv8 for now. |
York Sun | e814952 | 2015-12-04 11:57:07 -0800 | [diff] [blame] | 2931 | If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory |
| 2932 | is substracted from total RAM and won't be reported to OS. |
| 2933 | This memory can be used as secure memory. A variable |
York Sun | e61a753 | 2016-06-24 16:46:18 -0700 | [diff] [blame] | 2934 | gd->arch.secure_ram is used to track the location. In systems |
York Sun | e814952 | 2015-12-04 11:57:07 -0800 | [diff] [blame] | 2935 | the RAM base is not zero, or RAM is divided into banks, |
| 2936 | this variable needs to be recalcuated to get the address. |
| 2937 | |
York Sun | aabd7dd | 2015-12-07 11:05:29 -0800 | [diff] [blame] | 2938 | - CONFIG_SYS_MEM_TOP_HIDE: |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2939 | If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, |
Stefan Roese | 14f73ca | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2940 | this specified memory area will get subtracted from the top |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2941 | (end) of RAM and won't get "touched" at all by U-Boot. By |
Stefan Roese | 14f73ca | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2942 | fixing up gd->ram_size the Linux kernel should gets passed |
| 2943 | the now "corrected" memory size and won't touch it either. |
| 2944 | This should work for arch/ppc and arch/powerpc. Only Linux |
Stefan Roese | 5e12e75 | 2008-03-28 11:02:53 +0100 | [diff] [blame] | 2945 | board ports in arch/powerpc with bootwrapper support that |
Stefan Roese | 14f73ca | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2946 | recalculate the memory size from the SDRAM controller setup |
Stefan Roese | 5e12e75 | 2008-03-28 11:02:53 +0100 | [diff] [blame] | 2947 | will have to get fixed in Linux additionally. |
Stefan Roese | 14f73ca | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2948 | |
| 2949 | This option can be used as a workaround for the 440EPx/GRx |
| 2950 | CHIP 11 errata where the last 256 bytes in SDRAM shouldn't |
| 2951 | be touched. |
| 2952 | |
| 2953 | WARNING: Please make sure that this value is a multiple of |
| 2954 | the Linux page size (normally 4k). If this is not the case, |
| 2955 | then the end address of the Linux memory will be located at a |
| 2956 | non page size aligned address and this could cause major |
| 2957 | problems. |
| 2958 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2959 | - CONFIG_SYS_LOADS_BAUD_CHANGE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2960 | Enable temporary baudrate change while serial download |
| 2961 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2962 | - CONFIG_SYS_SDRAM_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2963 | Physical start address of SDRAM. _Must_ be 0 here. |
| 2964 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2965 | - CONFIG_SYS_FLASH_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2966 | Physical start address of Flash memory. |
| 2967 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2968 | - CONFIG_SYS_MONITOR_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2969 | Physical start address of boot monitor code (set by |
| 2970 | make config files to be same as the text base address |
Wolfgang Denk | 14d0a02 | 2010-10-07 21:51:12 +0200 | [diff] [blame] | 2971 | (CONFIG_SYS_TEXT_BASE) used when linking) - same as |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2972 | CONFIG_SYS_FLASH_BASE when booting from flash. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2973 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2974 | - CONFIG_SYS_MONITOR_LEN: |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2975 | Size of memory reserved for monitor code, used to |
| 2976 | determine _at_compile_time_ (!) if the environment is |
| 2977 | embedded within the U-Boot image, or in a separate |
| 2978 | flash sector. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2979 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2980 | - CONFIG_SYS_MALLOC_LEN: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2981 | Size of DRAM reserved for malloc() use. |
| 2982 | |
Simon Glass | d59476b | 2014-07-10 22:23:28 -0600 | [diff] [blame] | 2983 | - CONFIG_SYS_MALLOC_F_LEN |
| 2984 | Size of the malloc() pool for use before relocation. If |
| 2985 | this is defined, then a very simple malloc() implementation |
| 2986 | will become available before relocation. The address is just |
| 2987 | below the global data, and the stack is moved down to make |
| 2988 | space. |
| 2989 | |
| 2990 | This feature allocates regions with increasing addresses |
| 2991 | within the region. calloc() is supported, but realloc() |
| 2992 | is not available. free() is supported but does nothing. |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2993 | The memory will be freed (or in fact just forgotten) when |
Simon Glass | d59476b | 2014-07-10 22:23:28 -0600 | [diff] [blame] | 2994 | U-Boot relocates itself. |
| 2995 | |
Simon Glass | 38687ae | 2014-11-10 17:16:54 -0700 | [diff] [blame] | 2996 | - CONFIG_SYS_MALLOC_SIMPLE |
| 2997 | Provides a simple and small malloc() and calloc() for those |
| 2998 | boards which do not use the full malloc in SPL (which is |
| 2999 | enabled with CONFIG_SYS_SPL_MALLOC_START). |
| 3000 | |
Thierry Reding | 1dfdd9b | 2014-12-09 22:25:22 -0700 | [diff] [blame] | 3001 | - CONFIG_SYS_NONCACHED_MEMORY: |
| 3002 | Size of non-cached memory area. This area of memory will be |
| 3003 | typically located right below the malloc() area and mapped |
| 3004 | uncached in the MMU. This is useful for drivers that would |
| 3005 | otherwise require a lot of explicit cache maintenance. For |
| 3006 | some drivers it's also impossible to properly maintain the |
| 3007 | cache. For example if the regions that need to be flushed |
| 3008 | are not a multiple of the cache-line size, *and* padding |
| 3009 | cannot be allocated between the regions to align them (i.e. |
| 3010 | if the HW requires a contiguous array of regions, and the |
| 3011 | size of each region is not cache-aligned), then a flush of |
| 3012 | one region may result in overwriting data that hardware has |
| 3013 | written to another region in the same cache-line. This can |
| 3014 | happen for example in network drivers where descriptors for |
| 3015 | buffers are typically smaller than the CPU cache-line (e.g. |
| 3016 | 16 bytes vs. 32 or 64 bytes). |
| 3017 | |
| 3018 | Non-cached memory is only supported on 32-bit ARM at present. |
| 3019 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3020 | - CONFIG_SYS_BOOTM_LEN: |
Stefan Roese | 15940c9 | 2006-03-13 11:16:36 +0100 | [diff] [blame] | 3021 | Normally compressed uImages are limited to an |
| 3022 | uncompressed size of 8 MBytes. If this is not enough, |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3023 | you can define CONFIG_SYS_BOOTM_LEN in your board config file |
Stefan Roese | 15940c9 | 2006-03-13 11:16:36 +0100 | [diff] [blame] | 3024 | to adjust this setting to your needs. |
| 3025 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3026 | - CONFIG_SYS_BOOTMAPSZ: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3027 | Maximum size of memory mapped by the startup code of |
| 3028 | the Linux kernel; all data that must be processed by |
Bartlomiej Sieka | 7d721e3 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 3029 | the Linux kernel (bd_info, boot arguments, FDT blob if |
| 3030 | used) must be put below this limit, unless "bootm_low" |
Robert P. J. Day | 1bce2ae | 2013-09-16 07:15:45 -0400 | [diff] [blame] | 3031 | environment variable is defined and non-zero. In such case |
Bartlomiej Sieka | 7d721e3 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 3032 | all data for the Linux kernel must be between "bootm_low" |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 3033 | and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment |
Grant Likely | c3624e6 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 3034 | variable "bootm_mapsize" will override the value of |
| 3035 | CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, |
| 3036 | then the value in "bootm_size" will be used instead. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3037 | |
John Rigby | fca43cc | 2010-10-13 13:57:35 -0600 | [diff] [blame] | 3038 | - CONFIG_SYS_BOOT_RAMDISK_HIGH: |
| 3039 | Enable initrd_high functionality. If defined then the |
| 3040 | initrd_high feature is enabled and the bootm ramdisk subcommand |
| 3041 | is enabled. |
| 3042 | |
| 3043 | - CONFIG_SYS_BOOT_GET_CMDLINE: |
| 3044 | Enables allocating and saving kernel cmdline in space between |
| 3045 | "bootm_low" and "bootm_low" + BOOTMAPSZ. |
| 3046 | |
| 3047 | - CONFIG_SYS_BOOT_GET_KBD: |
| 3048 | Enables allocating and saving a kernel copy of the bd_info in |
| 3049 | space between "bootm_low" and "bootm_low" + BOOTMAPSZ. |
| 3050 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3051 | - CONFIG_SYS_MAX_FLASH_BANKS: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3052 | Max number of Flash memory banks |
| 3053 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3054 | - CONFIG_SYS_MAX_FLASH_SECT: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3055 | Max number of sectors on a Flash chip |
| 3056 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3057 | - CONFIG_SYS_FLASH_ERASE_TOUT: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3058 | Timeout for Flash erase operations (in ms) |
| 3059 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3060 | - CONFIG_SYS_FLASH_WRITE_TOUT: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3061 | Timeout for Flash write operations (in ms) |
| 3062 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3063 | - CONFIG_SYS_FLASH_LOCK_TOUT |
wdenk | 8564acf | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 3064 | Timeout for Flash set sector lock bit operation (in ms) |
| 3065 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3066 | - CONFIG_SYS_FLASH_UNLOCK_TOUT |
wdenk | 8564acf | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 3067 | Timeout for Flash clear lock bits operation (in ms) |
| 3068 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3069 | - CONFIG_SYS_FLASH_PROTECTION |
wdenk | 8564acf | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 3070 | If defined, hardware flash sectors protection is used |
| 3071 | instead of U-Boot software protection. |
| 3072 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3073 | - CONFIG_SYS_DIRECT_FLASH_TFTP: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3074 | |
| 3075 | Enable TFTP transfers directly to flash memory; |
| 3076 | without this option such a download has to be |
| 3077 | performed in two steps: (1) download to RAM, and (2) |
| 3078 | copy from RAM to flash. |
| 3079 | |
| 3080 | The two-step approach is usually more reliable, since |
| 3081 | you can check if the download worked before you erase |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3082 | the flash, but in some situations (when system RAM is |
| 3083 | too limited to allow for a temporary copy of the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3084 | downloaded image) this option may be very useful. |
| 3085 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3086 | - CONFIG_SYS_FLASH_CFI: |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 3087 | Define if the flash driver uses extra elements in the |
wdenk | 5653fc3 | 2004-02-08 22:55:38 +0000 | [diff] [blame] | 3088 | common flash structure for storing flash geometry. |
| 3089 | |
Jean-Christophe PLAGNIOL-VILLARD | 00b1883 | 2008-08-13 01:40:42 +0200 | [diff] [blame] | 3090 | - CONFIG_FLASH_CFI_DRIVER |
wdenk | 5653fc3 | 2004-02-08 22:55:38 +0000 | [diff] [blame] | 3091 | This option also enables the building of the cfi_flash driver |
| 3092 | in the drivers directory |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3093 | |
Piotr Ziecik | 91809ed | 2008-11-17 15:57:58 +0100 | [diff] [blame] | 3094 | - CONFIG_FLASH_CFI_MTD |
| 3095 | This option enables the building of the cfi_mtd driver |
| 3096 | in the drivers directory. The driver exports CFI flash |
| 3097 | to the MTD layer. |
| 3098 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3099 | - CONFIG_SYS_FLASH_USE_BUFFER_WRITE |
Guennadi Liakhovetski | 96ef831 | 2008-04-03 13:36:02 +0200 | [diff] [blame] | 3100 | Use buffered writes to flash. |
| 3101 | |
| 3102 | - CONFIG_FLASH_SPANSION_S29WS_N |
| 3103 | s29ws-n MirrorBit flash has non-standard addresses for buffered |
| 3104 | write commands. |
| 3105 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3106 | - CONFIG_SYS_FLASH_QUIET_TEST |
Stefan Roese | 5568e61 | 2005-11-22 13:20:42 +0100 | [diff] [blame] | 3107 | If this option is defined, the common CFI flash doesn't |
| 3108 | print it's warning upon not recognized FLASH banks. This |
| 3109 | is useful, if some of the configured banks are only |
| 3110 | optionally available. |
| 3111 | |
Jerry Van Baren | 9a042e9 | 2008-03-08 13:48:01 -0500 | [diff] [blame] | 3112 | - CONFIG_FLASH_SHOW_PROGRESS |
| 3113 | If defined (must be an integer), print out countdown |
| 3114 | digits and dots. Recommended value: 45 (9..1) for 80 |
| 3115 | column displays, 15 (3..1) for 40 column displays. |
| 3116 | |
Stefan Roese | 352ef3f | 2013-04-04 15:53:14 +0200 | [diff] [blame] | 3117 | - CONFIG_FLASH_VERIFY |
| 3118 | If defined, the content of the flash (destination) is compared |
| 3119 | against the source after the write operation. An error message |
| 3120 | will be printed when the contents are not identical. |
| 3121 | Please note that this option is useless in nearly all cases, |
| 3122 | since such flash programming errors usually are detected earlier |
| 3123 | while unprotecting/erasing/programming. Please only enable |
| 3124 | this option if you really know what you are doing. |
| 3125 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3126 | - CONFIG_SYS_RX_ETH_BUFFER: |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3127 | Defines the number of Ethernet receive buffers. On some |
| 3128 | Ethernet controllers it is recommended to set this value |
stroese | 53cf943 | 2003-06-05 15:39:44 +0000 | [diff] [blame] | 3129 | to 8 or even higher (EEPRO100 or 405 EMAC), since all |
| 3130 | buffers can be full shortly after enabling the interface |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3131 | on high Ethernet traffic. |
stroese | 53cf943 | 2003-06-05 15:39:44 +0000 | [diff] [blame] | 3132 | Defaults to 4 if not defined. |
| 3133 | |
Wolfgang Denk | ea882ba | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 3134 | - CONFIG_ENV_MAX_ENTRIES |
| 3135 | |
Wolfgang Denk | 071bc92 | 2010-10-27 22:48:30 +0200 | [diff] [blame] | 3136 | Maximum number of entries in the hash table that is used |
| 3137 | internally to store the environment settings. The default |
| 3138 | setting is supposed to be generous and should work in most |
| 3139 | cases. This setting can be used to tune behaviour; see |
| 3140 | lib/hashtable.c for details. |
Wolfgang Denk | ea882ba | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 3141 | |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 3142 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
| 3143 | - CONFIG_ENV_FLAGS_LIST_STATIC |
Robert P. J. Day | 1bce2ae | 2013-09-16 07:15:45 -0400 | [diff] [blame] | 3144 | Enable validation of the values given to environment variables when |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 3145 | calling env set. Variables can be restricted to only decimal, |
| 3146 | hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, |
| 3147 | the variables can also be restricted to IP address or MAC address. |
| 3148 | |
| 3149 | The format of the list is: |
| 3150 | type_attribute = [s|d|x|b|i|m] |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3151 | access_attribute = [a|r|o|c] |
| 3152 | attributes = type_attribute[access_attribute] |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 3153 | entry = variable_name[:attributes] |
| 3154 | list = entry[,list] |
| 3155 | |
| 3156 | The type attributes are: |
| 3157 | s - String (default) |
| 3158 | d - Decimal |
| 3159 | x - Hexadecimal |
| 3160 | b - Boolean ([1yYtT|0nNfF]) |
| 3161 | i - IP address |
| 3162 | m - MAC address |
| 3163 | |
Joe Hershberger | 267541f | 2012-12-11 22:16:34 -0600 | [diff] [blame] | 3164 | The access attributes are: |
| 3165 | a - Any (default) |
| 3166 | r - Read-only |
| 3167 | o - Write-once |
| 3168 | c - Change-default |
| 3169 | |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 3170 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
| 3171 | Define this to a list (string) to define the ".flags" |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3172 | environment variable in the default or embedded environment. |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 3173 | |
| 3174 | - CONFIG_ENV_FLAGS_LIST_STATIC |
| 3175 | Define this to a list (string) to define validation that |
| 3176 | should be done if an entry is not found in the ".flags" |
| 3177 | environment variable. To override a setting in the static |
| 3178 | list, simply add an entry for the same variable name to the |
| 3179 | ".flags" variable. |
| 3180 | |
Joe Hershberger | bdf1fe4 | 2015-05-20 14:27:20 -0500 | [diff] [blame] | 3181 | If CONFIG_REGEX is defined, the variable_name above is evaluated as a |
| 3182 | regular expression. This allows multiple variables to define the same |
| 3183 | flags without explicitly listing them for each variable. |
| 3184 | |
Joe Hershberger | 267541f | 2012-12-11 22:16:34 -0600 | [diff] [blame] | 3185 | - CONFIG_ENV_ACCESS_IGNORE_FORCE |
| 3186 | If defined, don't allow the -f switch to env set override variable |
| 3187 | access flags. |
| 3188 | |
Gabe Black | 0d296cc | 2014-10-15 04:38:30 -0600 | [diff] [blame] | 3189 | - CONFIG_USE_STDINT |
| 3190 | If stdint.h is available with your toolchain you can define this |
| 3191 | option to enable it. You can provide option 'USE_STDINT=1' when |
| 3192 | building U-Boot to enable this. |
| 3193 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3194 | The following definitions that deal with the placement and management |
| 3195 | of environment data (variable area); in general, we support the |
| 3196 | following configurations: |
| 3197 | |
Mike Frysinger | c3eb3fe | 2011-07-08 10:44:25 +0000 | [diff] [blame] | 3198 | - CONFIG_BUILD_ENVCRC: |
| 3199 | |
| 3200 | Builds up envcrc with the target environment so that external utils |
| 3201 | may easily extract it and embed it in final U-Boot images. |
| 3202 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3203 | BE CAREFUL! The first access to the environment happens quite early |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3204 | in U-Boot initialization (when we try to get the setting of for the |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3205 | console baudrate). You *MUST* have mapped your NVRAM area then, or |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3206 | U-Boot will hang. |
| 3207 | |
| 3208 | Please note that even with NVRAM we still use a copy of the |
| 3209 | environment in RAM: we could work on NVRAM directly, but we want to |
| 3210 | keep settings there always unmodified except somebody uses "saveenv" |
| 3211 | to save the current settings. |
| 3212 | |
Liu Gang | 0a85a9e | 2012-03-08 00:33:20 +0000 | [diff] [blame] | 3213 | BE CAREFUL! For some special cases, the local device can not use |
| 3214 | "saveenv" command. For example, the local device will get the |
Liu Gang | fc54c7f | 2012-08-09 05:10:01 +0000 | [diff] [blame] | 3215 | environment stored in a remote NOR flash by SRIO or PCIE link, |
| 3216 | but it can not erase, write this NOR flash by SRIO or PCIE interface. |
Liu Gang | 0a85a9e | 2012-03-08 00:33:20 +0000 | [diff] [blame] | 3217 | |
Guennadi Liakhovetski | b74ab73 | 2009-05-18 16:07:22 +0200 | [diff] [blame] | 3218 | - CONFIG_NAND_ENV_DST |
| 3219 | |
| 3220 | Defines address in RAM to which the nand_spl code should copy the |
| 3221 | environment. If redundant environment is used, it will be copied to |
| 3222 | CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. |
| 3223 | |
Bruce Adler | e881cb5 | 2007-11-02 13:15:42 -0700 | [diff] [blame] | 3224 | Please note that the environment is read-only until the monitor |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3225 | has been relocated to RAM and a RAM copy of the environment has been |
Simon Glass | 00caae6 | 2017-08-03 12:22:12 -0600 | [diff] [blame] | 3226 | created; also, when using EEPROM you will have to use env_get_f() |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3227 | until then to read environment variables. |
| 3228 | |
wdenk | 85ec0bc | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 3229 | The environment is protected by a CRC32 checksum. Before the monitor |
| 3230 | is relocated into RAM, as a result of a bad CRC you will be working |
| 3231 | with the compiled-in default environment - *silently*!!! [This is |
| 3232 | necessary, because the first environment variable we need is the |
| 3233 | "baudrate" setting for the console - if we have a bad CRC, we don't |
| 3234 | have any device yet where we could complain.] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3235 | |
| 3236 | Note: once the monitor has been relocated, then it will complain if |
| 3237 | the default environment is used; a new CRC is computed as soon as you |
wdenk | 85ec0bc | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 3238 | use the "saveenv" command to store a valid environment. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3239 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3240 | - CONFIG_SYS_FAULT_ECHO_LINK_DOWN: |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 3241 | Echo the inverted Ethernet link state to the fault LED. |
wdenk | fc3e216 | 2003-10-08 22:33:00 +0000 | [diff] [blame] | 3242 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3243 | Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR |
wdenk | fc3e216 | 2003-10-08 22:33:00 +0000 | [diff] [blame] | 3244 | also needs to be defined. |
| 3245 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3246 | - CONFIG_SYS_FAULT_MII_ADDR: |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 3247 | MII address of the PHY to check for the Ethernet link state. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3248 | |
Ron Madrid | f5675aa | 2009-02-18 14:30:44 -0800 | [diff] [blame] | 3249 | - CONFIG_NS16550_MIN_FUNCTIONS: |
| 3250 | Define this if you desire to only have use of the NS16550_init |
| 3251 | and NS16550_putc functions for the serial driver located at |
| 3252 | drivers/serial/ns16550.c. This option is useful for saving |
| 3253 | space for already greatly restricted images, including but not |
| 3254 | limited to NAND_SPL configurations. |
| 3255 | |
Simon Glass | b2b92f5 | 2012-11-30 13:01:18 +0000 | [diff] [blame] | 3256 | - CONFIG_DISPLAY_BOARDINFO |
| 3257 | Display information about the board that U-Boot is running on |
| 3258 | when U-Boot starts up. The board function checkboard() is called |
| 3259 | to do this. |
| 3260 | |
Simon Glass | e2e3e2b | 2012-11-30 13:01:19 +0000 | [diff] [blame] | 3261 | - CONFIG_DISPLAY_BOARDINFO_LATE |
| 3262 | Similar to the previous option, but display this information |
| 3263 | later, once stdio is running and output goes to the LCD, if |
| 3264 | present. |
| 3265 | |
Sascha Silbe | feb8580 | 2013-08-11 16:40:43 +0200 | [diff] [blame] | 3266 | - CONFIG_BOARD_SIZE_LIMIT: |
| 3267 | Maximum size of the U-Boot image. When defined, the |
| 3268 | build system checks that the actual size does not |
| 3269 | exceed it. |
| 3270 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3271 | Low Level (hardware related) configuration options: |
wdenk | dc7c9a1 | 2003-03-26 06:55:25 +0000 | [diff] [blame] | 3272 | --------------------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3273 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3274 | - CONFIG_SYS_CACHELINE_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3275 | Cache Line Size of the CPU. |
| 3276 | |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 3277 | - CONFIG_SYS_CCSRBAR_DEFAULT: |
| 3278 | Default (power-on reset) physical address of CCSR on Freescale |
| 3279 | PowerPC SOCs. |
| 3280 | |
| 3281 | - CONFIG_SYS_CCSRBAR: |
| 3282 | Virtual address of CCSR. On a 32-bit build, this is typically |
| 3283 | the same value as CONFIG_SYS_CCSRBAR_DEFAULT. |
| 3284 | |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 3285 | - CONFIG_SYS_CCSRBAR_PHYS: |
| 3286 | Physical address of CCSR. CCSR can be relocated to a new |
| 3287 | physical address, if desired. In this case, this macro should |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 3288 | be set to that address. Otherwise, it should be set to the |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 3289 | same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR |
| 3290 | is typically relocated on 36-bit builds. It is recommended |
| 3291 | that this macro be defined via the _HIGH and _LOW macros: |
| 3292 | |
| 3293 | #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH |
| 3294 | * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) |
| 3295 | |
| 3296 | - CONFIG_SYS_CCSRBAR_PHYS_HIGH: |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 3297 | Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically |
| 3298 | either 0 (32-bit build) or 0xF (36-bit build). This macro is |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 3299 | used in assembly code, so it must not contain typecasts or |
| 3300 | integer size suffixes (e.g. "ULL"). |
| 3301 | |
| 3302 | - CONFIG_SYS_CCSRBAR_PHYS_LOW: |
| 3303 | Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is |
| 3304 | used in assembly code, so it must not contain typecasts or |
| 3305 | integer size suffixes (e.g. "ULL"). |
| 3306 | |
| 3307 | - CONFIG_SYS_CCSR_DO_NOT_RELOCATE: |
| 3308 | If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be |
| 3309 | forced to a value that ensures that CCSR is not relocated. |
| 3310 | |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3311 | - Floppy Disk Support: |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3312 | CONFIG_SYS_FDC_DRIVE_NUMBER |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3313 | |
| 3314 | the default drive number (default value 0) |
| 3315 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3316 | CONFIG_SYS_ISA_IO_STRIDE |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3317 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3318 | defines the spacing between FDC chipset registers |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3319 | (default value 1) |
| 3320 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3321 | CONFIG_SYS_ISA_IO_OFFSET |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3322 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 3323 | defines the offset of register from address. It |
| 3324 | depends on which part of the data bus is connected to |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3325 | the FDC chipset. (default value 0) |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3326 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3327 | If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and |
| 3328 | CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 3329 | default value. |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3330 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3331 | if CONFIG_SYS_FDC_HW_INIT is defined, then the function |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 3332 | fdc_hw_init() is called at the beginning of the FDC |
| 3333 | setup. fdc_hw_init() must be provided by the board |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3334 | source code. It is used to make hardware-dependent |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 3335 | initializations. |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 3336 | |
Macpaul Lin | 0abddf8 | 2011-04-11 20:45:32 +0000 | [diff] [blame] | 3337 | - CONFIG_IDE_AHB: |
| 3338 | Most IDE controllers were designed to be connected with PCI |
| 3339 | interface. Only few of them were designed for AHB interface. |
| 3340 | When software is doing ATA command and data transfer to |
| 3341 | IDE devices through IDE-AHB controller, some additional |
| 3342 | registers accessing to these kind of IDE-AHB controller |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3343 | is required. |
Macpaul Lin | 0abddf8 | 2011-04-11 20:45:32 +0000 | [diff] [blame] | 3344 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3345 | - CONFIG_SYS_IMMR: Physical address of the Internal Memory. |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3346 | DO NOT CHANGE unless you know exactly what you're |
Christophe Leroy | 907208c | 2017-07-06 10:23:22 +0200 | [diff] [blame] | 3347 | doing! (11-4) [MPC8xx systems only] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3348 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3349 | - CONFIG_SYS_INIT_RAM_ADDR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3350 | |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 3351 | Start address of memory area that can be used for |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3352 | initial data and stack; please note that this must be |
| 3353 | writable memory that is working WITHOUT special |
| 3354 | initialization, i. e. you CANNOT use normal RAM which |
| 3355 | will become available only after programming the |
| 3356 | memory controller and running certain initialization |
| 3357 | sequences. |
| 3358 | |
| 3359 | U-Boot uses the following memory types: |
Christophe Leroy | 907208c | 2017-07-06 10:23:22 +0200 | [diff] [blame] | 3360 | - MPC8xx: IMMR (internal memory of the CPU) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3361 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3362 | - CONFIG_SYS_GBL_DATA_OFFSET: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3363 | |
| 3364 | Offset of the initial data structure in the memory |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3365 | area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually |
| 3366 | CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3367 | data is located at the end of the available space |
Wolfgang Denk | 553f098 | 2010-10-26 13:32:32 +0200 | [diff] [blame] | 3368 | (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - |
Simon Glass | acd51f9 | 2016-10-02 18:01:06 -0600 | [diff] [blame] | 3369 | GENERATED_GBL_DATA_SIZE), and the initial stack is just |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3370 | below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + |
| 3371 | CONFIG_SYS_GBL_DATA_OFFSET) downward. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3372 | |
| 3373 | Note: |
| 3374 | On the MPC824X (or other systems that use the data |
| 3375 | cache for initial memory) the address chosen for |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3376 | CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3377 | point to an otherwise UNUSED address space between |
| 3378 | the top of RAM and the start of the PCI space. |
| 3379 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3380 | - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3381 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3382 | - CONFIG_SYS_OR_TIMING_SDRAM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3383 | SDRAM timing |
| 3384 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3385 | - CONFIG_SYS_MAMR_PTA: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3386 | periodic timer for refresh |
| 3387 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3388 | - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, |
| 3389 | CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, |
| 3390 | CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, |
| 3391 | CONFIG_SYS_BR1_PRELIM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3392 | Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) |
| 3393 | |
| 3394 | - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3395 | CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, |
| 3396 | CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3397 | Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) |
| 3398 | |
Andrew Sharp | 69fd2d3 | 2012-08-29 14:16:32 +0000 | [diff] [blame] | 3399 | - CONFIG_PCI_ENUM_ONLY |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3400 | Only scan through and get the devices on the buses. |
Andrew Sharp | 69fd2d3 | 2012-08-29 14:16:32 +0000 | [diff] [blame] | 3401 | Don't do any setup work, presumably because someone or |
| 3402 | something has already done it, and we don't need to do it |
| 3403 | a second time. Useful for platforms that are pre-booted |
| 3404 | by coreboot or similar. |
| 3405 | |
Gabor Juhos | 842033e | 2013-05-30 07:06:12 +0000 | [diff] [blame] | 3406 | - CONFIG_PCI_INDIRECT_BRIDGE: |
| 3407 | Enable support for indirect PCI bridges. |
| 3408 | |
Kumar Gala | a09b9b6 | 2010-12-30 12:09:53 -0600 | [diff] [blame] | 3409 | - CONFIG_SYS_SRIO: |
| 3410 | Chip has SRIO or not |
| 3411 | |
| 3412 | - CONFIG_SRIO1: |
| 3413 | Board has SRIO 1 port available |
| 3414 | |
| 3415 | - CONFIG_SRIO2: |
| 3416 | Board has SRIO 2 port available |
| 3417 | |
Liu Gang | c8b2815 | 2013-05-07 16:30:46 +0800 | [diff] [blame] | 3418 | - CONFIG_SRIO_PCIE_BOOT_MASTER |
| 3419 | Board can support master function for Boot from SRIO and PCIE |
| 3420 | |
Kumar Gala | a09b9b6 | 2010-12-30 12:09:53 -0600 | [diff] [blame] | 3421 | - CONFIG_SYS_SRIOn_MEM_VIRT: |
| 3422 | Virtual Address of SRIO port 'n' memory region |
| 3423 | |
| 3424 | - CONFIG_SYS_SRIOn_MEM_PHYS: |
| 3425 | Physical Address of SRIO port 'n' memory region |
| 3426 | |
| 3427 | - CONFIG_SYS_SRIOn_MEM_SIZE: |
| 3428 | Size of SRIO port 'n' memory region |
| 3429 | |
Fabio Estevam | 66bd184 | 2013-04-11 09:35:34 +0000 | [diff] [blame] | 3430 | - CONFIG_SYS_NAND_BUSWIDTH_16BIT |
| 3431 | Defined to tell the NAND controller that the NAND chip is using |
| 3432 | a 16 bit bus. |
| 3433 | Not all NAND drivers use this symbol. |
Fabio Estevam | a430e91 | 2013-04-11 09:35:35 +0000 | [diff] [blame] | 3434 | Example of drivers that use it: |
Fabio Estevam | 66bd184 | 2013-04-11 09:35:34 +0000 | [diff] [blame] | 3435 | - drivers/mtd/nand/ndfc.c |
Fabio Estevam | a430e91 | 2013-04-11 09:35:35 +0000 | [diff] [blame] | 3436 | - drivers/mtd/nand/mxc_nand.c |
Alex Waterman | eced462 | 2011-05-19 15:08:36 -0400 | [diff] [blame] | 3437 | |
| 3438 | - CONFIG_SYS_NDFC_EBC0_CFG |
| 3439 | Sets the EBC0_CFG register for the NDFC. If not defined |
| 3440 | a default value will be used. |
| 3441 | |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 3442 | - CONFIG_SPD_EEPROM |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3443 | Get DDR timing information from an I2C EEPROM. Common |
| 3444 | with pluggable memory modules such as SODIMMs |
| 3445 | |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 3446 | SPD_EEPROM_ADDRESS |
| 3447 | I2C address of the SPD EEPROM |
| 3448 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3449 | - CONFIG_SYS_SPD_BUS_NUM |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3450 | If SPD EEPROM is on an I2C bus other than the first |
| 3451 | one, specify here. Note that the value must resolve |
| 3452 | to something your driver can deal with. |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 3453 | |
York Sun | 1b3e3c4 | 2011-06-07 09:42:16 +0800 | [diff] [blame] | 3454 | - CONFIG_SYS_DDR_RAW_TIMING |
| 3455 | Get DDR timing information from other than SPD. Common with |
| 3456 | soldered DDR chips onboard without SPD. DDR raw timing |
| 3457 | parameters are extracted from datasheet and hard-coded into |
| 3458 | header files or board specific files. |
| 3459 | |
York Sun | 6f5e1dc | 2011-09-16 13:21:35 -0700 | [diff] [blame] | 3460 | - CONFIG_FSL_DDR_INTERACTIVE |
| 3461 | Enable interactive DDR debugging. See doc/README.fsl-ddr. |
| 3462 | |
York Sun | e32d59a | 2015-01-06 13:18:55 -0800 | [diff] [blame] | 3463 | - CONFIG_FSL_DDR_SYNC_REFRESH |
| 3464 | Enable sync of refresh for multiple controllers. |
| 3465 | |
York Sun | 4516ff8 | 2015-03-19 09:30:28 -0700 | [diff] [blame] | 3466 | - CONFIG_FSL_DDR_BIST |
| 3467 | Enable built-in memory test for Freescale DDR controllers. |
| 3468 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3469 | - CONFIG_SYS_83XX_DDR_USES_CS0 |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3470 | Only for 83xx systems. If specified, then DDR should |
| 3471 | be configured using CS0 and CS1 instead of CS2 and CS3. |
Timur Tabi | 2ad6b51 | 2006-10-31 18:44:42 -0600 | [diff] [blame] | 3472 | |
wdenk | c26e454 | 2004-04-18 10:13:26 +0000 | [diff] [blame] | 3473 | - CONFIG_RMII |
| 3474 | Enable RMII mode for all FECs. |
| 3475 | Note that this is a global option, we can't |
| 3476 | have one FEC in standard MII mode and another in RMII mode. |
| 3477 | |
wdenk | 5cf91d6 | 2004-04-23 20:32:05 +0000 | [diff] [blame] | 3478 | - CONFIG_CRC32_VERIFY |
| 3479 | Add a verify option to the crc32 command. |
| 3480 | The syntax is: |
| 3481 | |
| 3482 | => crc32 -v <address> <count> <crc32> |
| 3483 | |
| 3484 | Where address/count indicate a memory area |
| 3485 | and crc32 is the correct crc32 which the |
| 3486 | area should have. |
| 3487 | |
wdenk | 56523f1 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 3488 | - CONFIG_LOOPW |
| 3489 | Add the "loopw" memory command. This only takes effect if |
Simon Glass | 493f420 | 2017-08-04 16:34:27 -0600 | [diff] [blame] | 3490 | the memory commands are activated globally (CONFIG_CMD_MEMORY). |
wdenk | 56523f1 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 3491 | |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3492 | - CONFIG_MX_CYCLIC |
| 3493 | Add the "mdc" and "mwc" memory commands. These are cyclic |
| 3494 | "md/mw" commands. |
| 3495 | Examples: |
| 3496 | |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3497 | => mdc.b 10 4 500 |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3498 | This command will print 4 bytes (10,11,12,13) each 500 ms. |
| 3499 | |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3500 | => mwc.l 100 12345678 10 |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3501 | This command will write 12345678 to address 100 all 10 ms. |
| 3502 | |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3503 | This only takes effect if the memory commands are activated |
Simon Glass | 493f420 | 2017-08-04 16:34:27 -0600 | [diff] [blame] | 3504 | globally (CONFIG_CMD_MEMORY). |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3505 | |
wdenk | 8aa1a2d | 2005-04-04 12:44:11 +0000 | [diff] [blame] | 3506 | - CONFIG_SKIP_LOWLEVEL_INIT |
Macpaul Lin | afc1ce8 | 2011-10-19 20:41:11 +0000 | [diff] [blame] | 3507 | [ARM, NDS32, MIPS only] If this variable is defined, then certain |
Wolfgang Denk | 844f07d | 2010-11-27 23:30:56 +0100 | [diff] [blame] | 3508 | low level initializations (like setting up the memory |
| 3509 | controller) are omitted and/or U-Boot does not |
| 3510 | relocate itself into RAM. |
wdenk | 8aa1a2d | 2005-04-04 12:44:11 +0000 | [diff] [blame] | 3511 | |
Wolfgang Denk | 844f07d | 2010-11-27 23:30:56 +0100 | [diff] [blame] | 3512 | Normally this variable MUST NOT be defined. The only |
| 3513 | exception is when U-Boot is loaded (to RAM) by some |
| 3514 | other boot loader or by a debugger which performs |
| 3515 | these initializations itself. |
wdenk | 8aa1a2d | 2005-04-04 12:44:11 +0000 | [diff] [blame] | 3516 | |
Simon Glass | b5bd098 | 2016-05-05 07:28:06 -0600 | [diff] [blame] | 3517 | - CONFIG_SKIP_LOWLEVEL_INIT_ONLY |
| 3518 | [ARM926EJ-S only] This allows just the call to lowlevel_init() |
yeongjun Kim | 90211f7 | 2016-07-20 22:56:12 +0900 | [diff] [blame] | 3519 | to be skipped. The normal CP15 init (such as enabling the |
Simon Glass | b5bd098 | 2016-05-05 07:28:06 -0600 | [diff] [blame] | 3520 | instruction cache) is still performed. |
| 3521 | |
Aneesh V | 401bb30 | 2011-07-13 05:11:07 +0000 | [diff] [blame] | 3522 | - CONFIG_SPL_BUILD |
Magnus Lilja | df81238 | 2009-06-13 20:50:00 +0200 | [diff] [blame] | 3523 | Modifies the behaviour of start.S when compiling a loader |
| 3524 | that is executed before the actual U-Boot. E.g. when |
| 3525 | compiling a NAND SPL. |
wdenk | 400558b | 2005-04-02 23:52:25 +0000 | [diff] [blame] | 3526 | |
Ying Zhang | 3aa29de | 2013-08-16 15:16:15 +0800 | [diff] [blame] | 3527 | - CONFIG_TPL_BUILD |
| 3528 | Modifies the behaviour of start.S when compiling a loader |
| 3529 | that is executed after the SPL and before the actual U-Boot. |
| 3530 | It is loaded by the SPL. |
| 3531 | |
Ying Zhang | 5df572f | 2013-05-20 14:07:23 +0800 | [diff] [blame] | 3532 | - CONFIG_SYS_MPC85XX_NO_RESETVEC |
| 3533 | Only for 85xx systems. If this variable is specified, the section |
| 3534 | .resetvec is not kept and the section .bootpg is placed in the |
| 3535 | previous 4k of the .text section. |
| 3536 | |
Simon Glass | 4213fc2 | 2013-02-24 17:33:14 +0000 | [diff] [blame] | 3537 | - CONFIG_ARCH_MAP_SYSMEM |
| 3538 | Generally U-Boot (and in particular the md command) uses |
| 3539 | effective address. It is therefore not necessary to regard |
| 3540 | U-Boot address as virtual addresses that need to be translated |
| 3541 | to physical addresses. However, sandbox requires this, since |
| 3542 | it maintains its own little RAM buffer which contains all |
| 3543 | addressable memory. This option causes some memory accesses |
| 3544 | to be mapped through map_sysmem() / unmap_sysmem(). |
| 3545 | |
Simon Glass | 588a13f | 2013-02-14 04:18:54 +0000 | [diff] [blame] | 3546 | - CONFIG_X86_RESET_VECTOR |
| 3547 | If defined, the x86 reset vector code is included. This is not |
| 3548 | needed when U-Boot is running from Coreboot. |
Gabe Black | b16f521 | 2012-11-27 21:08:06 +0000 | [diff] [blame] | 3549 | |
Heiko Schocher | 16678eb | 2013-11-04 14:05:00 +0100 | [diff] [blame] | 3550 | - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: |
| 3551 | Enables the RTC32K OSC on AM33xx based plattforms |
| 3552 | |
Karicheri, Muralidharan | 999d7d3 | 2014-04-04 13:16:50 -0400 | [diff] [blame] | 3553 | - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE |
| 3554 | Option to disable subpage write in NAND driver |
| 3555 | driver that uses this: |
| 3556 | drivers/mtd/nand/davinci_nand.c |
| 3557 | |
Timur Tabi | f2717b4 | 2011-11-22 09:21:25 -0600 | [diff] [blame] | 3558 | Freescale QE/FMAN Firmware Support: |
| 3559 | ----------------------------------- |
| 3560 | |
| 3561 | The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the |
| 3562 | loading of "firmware", which is encoded in the QE firmware binary format. |
| 3563 | This firmware often needs to be loaded during U-Boot booting, so macros |
| 3564 | are used to identify the storage device (NOR flash, SPI, etc) and the address |
| 3565 | within that device. |
| 3566 | |
Zhao Qiang | dcf1d77 | 2014-03-21 16:21:44 +0800 | [diff] [blame] | 3567 | - CONFIG_SYS_FMAN_FW_ADDR |
| 3568 | The address in the storage device where the FMAN microcode is located. The |
| 3569 | meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro |
| 3570 | is also specified. |
| 3571 | |
| 3572 | - CONFIG_SYS_QE_FW_ADDR |
| 3573 | The address in the storage device where the QE microcode is located. The |
Timur Tabi | f2717b4 | 2011-11-22 09:21:25 -0600 | [diff] [blame] | 3574 | meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro |
| 3575 | is also specified. |
| 3576 | |
| 3577 | - CONFIG_SYS_QE_FMAN_FW_LENGTH |
| 3578 | The maximum possible size of the firmware. The firmware binary format |
| 3579 | has a field that specifies the actual size of the firmware, but it |
| 3580 | might not be possible to read any part of the firmware unless some |
| 3581 | local storage is allocated to hold the entire firmware first. |
| 3582 | |
| 3583 | - CONFIG_SYS_QE_FMAN_FW_IN_NOR |
| 3584 | Specifies that QE/FMAN firmware is located in NOR flash, mapped as |
| 3585 | normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the |
| 3586 | virtual address in NOR flash. |
| 3587 | |
| 3588 | - CONFIG_SYS_QE_FMAN_FW_IN_NAND |
| 3589 | Specifies that QE/FMAN firmware is located in NAND flash. |
| 3590 | CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. |
| 3591 | |
| 3592 | - CONFIG_SYS_QE_FMAN_FW_IN_MMC |
| 3593 | Specifies that QE/FMAN firmware is located on the primary SD/MMC |
| 3594 | device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. |
| 3595 | |
Liu Gang | 292dc6c | 2012-03-08 00:33:18 +0000 | [diff] [blame] | 3596 | - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE |
| 3597 | Specifies that QE/FMAN firmware is located in the remote (master) |
| 3598 | memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which |
Liu Gang | fc54c7f | 2012-08-09 05:10:01 +0000 | [diff] [blame] | 3599 | can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound |
| 3600 | window->master inbound window->master LAW->the ucode address in |
| 3601 | master's memory space. |
Timur Tabi | f2717b4 | 2011-11-22 09:21:25 -0600 | [diff] [blame] | 3602 | |
J. German Rivera | b940ca6 | 2014-06-23 15:15:55 -0700 | [diff] [blame] | 3603 | Freescale Layerscape Management Complex Firmware Support: |
| 3604 | --------------------------------------------------------- |
| 3605 | The Freescale Layerscape Management Complex (MC) supports the loading of |
| 3606 | "firmware". |
| 3607 | This firmware often needs to be loaded during U-Boot booting, so macros |
| 3608 | are used to identify the storage device (NOR flash, SPI, etc) and the address |
| 3609 | within that device. |
| 3610 | |
| 3611 | - CONFIG_FSL_MC_ENET |
| 3612 | Enable the MC driver for Layerscape SoCs. |
| 3613 | |
Prabhakar Kushwaha | 5c05508 | 2015-06-02 10:55:52 +0530 | [diff] [blame] | 3614 | Freescale Layerscape Debug Server Support: |
| 3615 | ------------------------------------------- |
| 3616 | The Freescale Layerscape Debug Server Support supports the loading of |
| 3617 | "Debug Server firmware" and triggering SP boot-rom. |
| 3618 | This firmware often needs to be loaded during U-Boot booting. |
| 3619 | |
York Sun | c049214 | 2015-12-07 11:08:58 -0800 | [diff] [blame] | 3620 | - CONFIG_SYS_MC_RSV_MEM_ALIGN |
| 3621 | Define alignment of reserved memory MC requires |
Prabhakar Kushwaha | 5c05508 | 2015-06-02 10:55:52 +0530 | [diff] [blame] | 3622 | |
Paul Kocialkowski | f3f431a | 2015-07-26 18:48:15 +0200 | [diff] [blame] | 3623 | Reproducible builds |
| 3624 | ------------------- |
| 3625 | |
| 3626 | In order to achieve reproducible builds, timestamps used in the U-Boot build |
| 3627 | process have to be set to a fixed value. |
| 3628 | |
| 3629 | This is done using the SOURCE_DATE_EPOCH environment variable. |
| 3630 | SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration |
| 3631 | option for U-Boot or an environment variable in U-Boot. |
| 3632 | |
| 3633 | SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. |
| 3634 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3635 | Building the Software: |
| 3636 | ====================== |
| 3637 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3638 | Building U-Boot has been tested in several native build environments |
| 3639 | and in many different cross environments. Of course we cannot support |
| 3640 | all possibly existing versions of cross development tools in all |
| 3641 | (potentially obsolete) versions. In case of tool chain problems we |
| 3642 | recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) |
| 3643 | which is extensively used to build and test U-Boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3644 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3645 | If you are not using a native environment, it is assumed that you |
| 3646 | have GNU cross compiling tools available in your path. In this case, |
| 3647 | you must set the environment variable CROSS_COMPILE in your shell. |
| 3648 | Note that no changes to the Makefile or any other source files are |
| 3649 | necessary. For example using the ELDK on a 4xx CPU, please enter: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3650 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3651 | $ CROSS_COMPILE=ppc_4xx- |
| 3652 | $ export CROSS_COMPILE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3653 | |
Peter Tyser | 2f8d396 | 2009-03-13 18:54:51 -0500 | [diff] [blame] | 3654 | Note: If you wish to generate Windows versions of the utilities in |
| 3655 | the tools directory you can use the MinGW toolchain |
| 3656 | (http://www.mingw.org). Set your HOST tools to the MinGW |
| 3657 | toolchain and execute 'make tools'. For example: |
| 3658 | |
| 3659 | $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools |
| 3660 | |
| 3661 | Binaries such as tools/mkimage.exe will be created which can |
| 3662 | be executed on computers running Windows. |
| 3663 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3664 | U-Boot is intended to be simple to build. After installing the |
| 3665 | sources you must configure U-Boot for one specific board type. This |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3666 | is done by typing: |
| 3667 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3668 | make NAME_defconfig |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3669 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3670 | where "NAME_defconfig" is the name of one of the existing configu- |
Michael Jones | 4d675ae | 2012-03-15 22:48:10 +0000 | [diff] [blame] | 3671 | rations; see boards.cfg for supported names. |
wdenk | 54387ac | 2003-10-08 22:45:44 +0000 | [diff] [blame] | 3672 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3673 | Note: for some board special configuration names may exist; check if |
| 3674 | additional information is available from the board vendor; for |
| 3675 | instance, the TQM823L systems are available without (standard) |
| 3676 | or with LCD support. You can select such additional "features" |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3677 | when choosing the configuration, i. e. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3678 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3679 | make TQM823L_defconfig |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3680 | - will configure for a plain TQM823L, i. e. no LCD support |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3681 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3682 | make TQM823L_LCD_defconfig |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3683 | - will configure for a TQM823L with U-Boot console on LCD |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3684 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3685 | etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3686 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3687 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3688 | Finally, type "make all", and you should get some working U-Boot |
| 3689 | images ready for download to / installation on your system: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3690 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3691 | - "u-boot.bin" is a raw binary image |
| 3692 | - "u-boot" is an image in ELF binary format |
| 3693 | - "u-boot.srec" is in Motorola S-Record format |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3694 | |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3695 | By default the build is performed locally and the objects are saved |
| 3696 | in the source directory. One of the two methods can be used to change |
| 3697 | this behavior and build U-Boot to some external directory: |
| 3698 | |
| 3699 | 1. Add O= to the make command line invocations: |
| 3700 | |
| 3701 | make O=/tmp/build distclean |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3702 | make O=/tmp/build NAME_defconfig |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3703 | make O=/tmp/build all |
| 3704 | |
Timo Ketola | adbba99 | 2014-11-06 14:39:05 +0200 | [diff] [blame] | 3705 | 2. Set environment variable KBUILD_OUTPUT to point to the desired location: |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3706 | |
Timo Ketola | adbba99 | 2014-11-06 14:39:05 +0200 | [diff] [blame] | 3707 | export KBUILD_OUTPUT=/tmp/build |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3708 | make distclean |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3709 | make NAME_defconfig |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3710 | make all |
| 3711 | |
Timo Ketola | adbba99 | 2014-11-06 14:39:05 +0200 | [diff] [blame] | 3712 | Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3713 | variable. |
| 3714 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3715 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3716 | Please be aware that the Makefiles assume you are using GNU make, so |
| 3717 | for instance on NetBSD you might need to use "gmake" instead of |
| 3718 | native "make". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3719 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3720 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3721 | If the system board that you have is not listed, then you will need |
| 3722 | to port U-Boot to your hardware platform. To do this, follow these |
| 3723 | steps: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3724 | |
Phil Sutter | 3c1496c | 2015-12-25 14:41:18 +0100 | [diff] [blame] | 3725 | 1. Create a new directory to hold your board specific code. Add any |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3726 | files you need. In your board directory, you will need at least |
Phil Sutter | 3c1496c | 2015-12-25 14:41:18 +0100 | [diff] [blame] | 3727 | the "Makefile" and a "<board>.c". |
| 3728 | 2. Create a new configuration file "include/configs/<board>.h" for |
| 3729 | your board. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3730 | 3. If you're porting U-Boot to a new CPU, then also create a new |
| 3731 | directory to hold your CPU specific code. Add any files you need. |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 3732 | 4. Run "make <board>_defconfig" with your new name. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3733 | 5. Type "make", and you should get a working "u-boot.srec" file |
| 3734 | to be installed on your target system. |
| 3735 | 6. Debug and solve any problems that might arise. |
| 3736 | [Of course, this last step is much harder than it sounds.] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3737 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3738 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3739 | Testing of U-Boot Modifications, Ports to New Hardware, etc.: |
| 3740 | ============================================================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3741 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3742 | If you have modified U-Boot sources (for instance added a new board |
| 3743 | or support for new devices, a new CPU, etc.) you are expected to |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3744 | provide feedback to the other developers. The feedback normally takes |
| 3745 | the form of a "patch", i. e. a context diff against a certain (latest |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3746 | official or latest in the git repository) version of U-Boot sources. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3747 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3748 | But before you submit such a patch, please verify that your modifi- |
| 3749 | cation did not break existing code. At least make sure that *ALL* of |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3750 | the supported boards compile WITHOUT ANY compiler warnings. To do so, |
Simon Glass | 6de80f2 | 2016-07-27 20:33:08 -0600 | [diff] [blame] | 3751 | just run the buildman script (tools/buildman/buildman), which will |
| 3752 | configure and build U-Boot for ALL supported system. Be warned, this |
| 3753 | will take a while. Please see the buildman README, or run 'buildman -H' |
| 3754 | for documentation. |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3755 | |
| 3756 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3757 | See also "U-Boot Porting Guide" below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3758 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3759 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3760 | Monitor Commands - Overview: |
| 3761 | ============================ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3762 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3763 | go - start application at address 'addr' |
| 3764 | run - run commands in an environment variable |
| 3765 | bootm - boot application image from memory |
| 3766 | bootp - boot image via network using BootP/TFTP protocol |
Marek Vasut | 44f074c | 2012-03-14 21:52:45 +0000 | [diff] [blame] | 3767 | bootz - boot zImage from memory |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3768 | tftpboot- boot image via network using TFTP protocol |
| 3769 | and env variables "ipaddr" and "serverip" |
| 3770 | (and eventually "gatewayip") |
Simon Glass | 1fb7cd4 | 2011-10-24 18:00:07 +0000 | [diff] [blame] | 3771 | tftpput - upload a file via network using TFTP protocol |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3772 | rarpboot- boot image via network using RARP/TFTP protocol |
| 3773 | diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' |
| 3774 | loads - load S-Record file over serial line |
| 3775 | loadb - load binary file over serial line (kermit mode) |
| 3776 | md - memory display |
| 3777 | mm - memory modify (auto-incrementing) |
| 3778 | nm - memory modify (constant address) |
| 3779 | mw - memory write (fill) |
| 3780 | cp - memory copy |
| 3781 | cmp - memory compare |
| 3782 | crc32 - checksum calculation |
Peter Tyser | 0f89c54 | 2009-04-18 22:34:03 -0500 | [diff] [blame] | 3783 | i2c - I2C sub-system |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3784 | sspi - SPI utility commands |
| 3785 | base - print or set address offset |
| 3786 | printenv- print environment variables |
| 3787 | setenv - set environment variables |
| 3788 | saveenv - save environment variables to persistent storage |
| 3789 | protect - enable or disable FLASH write protection |
| 3790 | erase - erase FLASH memory |
| 3791 | flinfo - print FLASH memory information |
Karl O. Pinc | 10635af | 2012-08-03 05:57:21 +0000 | [diff] [blame] | 3792 | nand - NAND memory operations (see doc/README.nand) |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3793 | bdinfo - print Board Info structure |
| 3794 | iminfo - print header information for application image |
| 3795 | coninfo - print console devices and informations |
| 3796 | ide - IDE sub-system |
| 3797 | loop - infinite loop on address range |
wdenk | 56523f1 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 3798 | loopw - infinite write loop on address range |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3799 | mtest - simple RAM test |
| 3800 | icache - enable or disable instruction cache |
| 3801 | dcache - enable or disable data cache |
| 3802 | reset - Perform RESET of the CPU |
| 3803 | echo - echo args to console |
| 3804 | version - print monitor version |
| 3805 | help - print online help |
| 3806 | ? - alias for 'help' |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3807 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3808 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3809 | Monitor Commands - Detailed Description: |
| 3810 | ======================================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3811 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3812 | TODO. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3813 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3814 | For now: just type "help <command>". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3815 | |
| 3816 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3817 | Environment Variables: |
| 3818 | ====================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3819 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3820 | U-Boot supports user configuration using Environment Variables which |
| 3821 | can be made persistent by saving to Flash memory. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3822 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3823 | Environment Variables are set using "setenv", printed using |
| 3824 | "printenv", and saved to Flash using "saveenv". Using "setenv" |
| 3825 | without a value can be used to delete a variable from the |
| 3826 | environment. As long as you don't save the environment you are |
| 3827 | working with an in-memory copy. In case the Flash area containing the |
| 3828 | environment is erased by accident, a default environment is provided. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3829 | |
Wolfgang Denk | c96f86e | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 3830 | Some configuration options can be set using Environment Variables. |
| 3831 | |
| 3832 | List of environment variables (most likely not complete): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3833 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3834 | baudrate - see CONFIG_BAUDRATE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3835 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3836 | bootdelay - see CONFIG_BOOTDELAY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3837 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3838 | bootcmd - see CONFIG_BOOTCOMMAND |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3839 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3840 | bootargs - Boot arguments when booting an RTOS image |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3841 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3842 | bootfile - Name of the image to load with TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3843 | |
Bartlomiej Sieka | 7d721e3 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 3844 | bootm_low - Memory range available for image processing in the bootm |
| 3845 | command can be restricted. This variable is given as |
| 3846 | a hexadecimal number and defines lowest address allowed |
| 3847 | for use by the bootm command. See also "bootm_size" |
| 3848 | environment variable. Address defined by "bootm_low" is |
| 3849 | also the base of the initial memory mapping for the Linux |
Grant Likely | c3624e6 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 3850 | kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and |
| 3851 | bootm_mapsize. |
| 3852 | |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 3853 | bootm_mapsize - Size of the initial memory mapping for the Linux kernel. |
Grant Likely | c3624e6 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 3854 | This variable is given as a hexadecimal number and it |
| 3855 | defines the size of the memory region starting at base |
| 3856 | address bootm_low that is accessible by the Linux kernel |
| 3857 | during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used |
| 3858 | as the default value if it is defined, and bootm_size is |
| 3859 | used otherwise. |
Bartlomiej Sieka | 7d721e3 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 3860 | |
| 3861 | bootm_size - Memory range available for image processing in the bootm |
| 3862 | command can be restricted. This variable is given as |
| 3863 | a hexadecimal number and defines the size of the region |
| 3864 | allowed for use by the bootm command. See also "bootm_low" |
| 3865 | environment variable. |
| 3866 | |
Bartlomiej Sieka | 4bae909 | 2008-10-01 15:26:31 +0200 | [diff] [blame] | 3867 | updatefile - Location of the software update file on a TFTP server, used |
| 3868 | by the automatic software update feature. Please refer to |
| 3869 | documentation in doc/README.update for more details. |
| 3870 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3871 | autoload - if set to "no" (any string beginning with 'n'), |
| 3872 | "bootp" will just load perform a lookup of the |
| 3873 | configuration from the BOOTP server, but not try to |
| 3874 | load any image using TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3875 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3876 | autostart - if set to "yes", an image loaded using the "bootp", |
| 3877 | "rarpboot", "tftpboot" or "diskboot" commands will |
| 3878 | be automatically started (by internally calling |
| 3879 | "bootm") |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3880 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3881 | If set to "no", a standalone image passed to the |
| 3882 | "bootm" command will be copied to the load address |
| 3883 | (and eventually uncompressed), but NOT be started. |
| 3884 | This can be used to load and uncompress arbitrary |
| 3885 | data. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3886 | |
David A. Long | a28afca | 2011-07-09 16:40:19 -0400 | [diff] [blame] | 3887 | fdt_high - if set this restricts the maximum address that the |
| 3888 | flattened device tree will be copied into upon boot. |
Shawn Guo | fa34f6b | 2012-01-09 21:54:08 +0000 | [diff] [blame] | 3889 | For example, if you have a system with 1 GB memory |
| 3890 | at physical address 0x10000000, while Linux kernel |
| 3891 | only recognizes the first 704 MB as low memory, you |
| 3892 | may need to set fdt_high as 0x3C000000 to have the |
| 3893 | device tree blob be copied to the maximum address |
| 3894 | of the 704 MB low memory, so that Linux kernel can |
| 3895 | access it during the boot procedure. |
| 3896 | |
David A. Long | a28afca | 2011-07-09 16:40:19 -0400 | [diff] [blame] | 3897 | If this is set to the special value 0xFFFFFFFF then |
| 3898 | the fdt will not be copied at all on boot. For this |
| 3899 | to work it must reside in writable memory, have |
| 3900 | sufficient padding on the end of it for u-boot to |
| 3901 | add the information it needs into it, and the memory |
| 3902 | must be accessible by the kernel. |
| 3903 | |
Simon Glass | eea63e0 | 2011-10-24 19:15:34 +0000 | [diff] [blame] | 3904 | fdtcontroladdr- if set this is the address of the control flattened |
| 3905 | device tree used by U-Boot when CONFIG_OF_CONTROL is |
| 3906 | defined. |
| 3907 | |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 3908 | i2cfast - (PPC405GP|PPC405EP only) |
| 3909 | if set to 'y' configures Linux I2C driver for fast |
| 3910 | mode (400kHZ). This environment variable is used in |
| 3911 | initialization code. So, for changes to be effective |
| 3912 | it must be saved and board must be reset. |
| 3913 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3914 | initrd_high - restrict positioning of initrd images: |
| 3915 | If this variable is not set, initrd images will be |
| 3916 | copied to the highest possible address in RAM; this |
| 3917 | is usually what you want since it allows for |
| 3918 | maximum initrd size. If for some reason you want to |
| 3919 | make sure that the initrd image is loaded below the |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3920 | CONFIG_SYS_BOOTMAPSZ limit, you can set this environment |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3921 | variable to a value of "no" or "off" or "0". |
| 3922 | Alternatively, you can set it to a maximum upper |
| 3923 | address to use (U-Boot will still check that it |
| 3924 | does not overwrite the U-Boot stack and data). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3925 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3926 | For instance, when you have a system with 16 MB |
| 3927 | RAM, and want to reserve 4 MB from use by Linux, |
| 3928 | you can do this by adding "mem=12M" to the value of |
| 3929 | the "bootargs" variable. However, now you must make |
| 3930 | sure that the initrd image is placed in the first |
| 3931 | 12 MB as well - this can be done with |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3932 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3933 | setenv initrd_high 00c00000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3934 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3935 | If you set initrd_high to 0xFFFFFFFF, this is an |
| 3936 | indication to U-Boot that all addresses are legal |
| 3937 | for the Linux kernel, including addresses in flash |
| 3938 | memory. In this case U-Boot will NOT COPY the |
| 3939 | ramdisk at all. This may be useful to reduce the |
| 3940 | boot time on your system, but requires that this |
| 3941 | feature is supported by your Linux kernel. |
wdenk | 4a6fd34 | 2003-04-12 23:38:12 +0000 | [diff] [blame] | 3942 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3943 | ipaddr - IP address; needed for tftpboot command |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3944 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3945 | loadaddr - Default load address for commands like "bootp", |
| 3946 | "rarpboot", "tftpboot", "loadb" or "diskboot" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3947 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3948 | loads_echo - see CONFIG_LOADS_ECHO |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3949 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3950 | serverip - TFTP server IP address; needed for tftpboot command |
wdenk | 38b9926 | 2003-05-23 23:18:21 +0000 | [diff] [blame] | 3951 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3952 | bootretry - see CONFIG_BOOT_RETRY_TIME |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3953 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3954 | bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3955 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3956 | bootstopkey - see CONFIG_AUTOBOOT_STOP_STR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3957 | |
Mike Frysinger | e2a5345 | 2011-10-02 10:01:27 +0000 | [diff] [blame] | 3958 | ethprime - controls which interface is used first. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3959 | |
Mike Frysinger | e2a5345 | 2011-10-02 10:01:27 +0000 | [diff] [blame] | 3960 | ethact - controls which interface is currently active. |
| 3961 | For example you can do the following |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3962 | |
Heiko Schocher | 48690d8 | 2010-07-20 17:45:02 +0200 | [diff] [blame] | 3963 | => setenv ethact FEC |
| 3964 | => ping 192.168.0.1 # traffic sent on FEC |
| 3965 | => setenv ethact SCC |
| 3966 | => ping 10.0.0.1 # traffic sent on SCC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3967 | |
Matthias Fuchs | e169257 | 2008-01-17 07:45:05 +0100 | [diff] [blame] | 3968 | ethrotate - When set to "no" U-Boot does not go through all |
| 3969 | available network interfaces. |
| 3970 | It just stays at the currently selected interface. |
| 3971 | |
Wolfgang Denk | c96f86e | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 3972 | netretry - When set to "no" each network operation will |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3973 | either succeed or fail without retrying. |
| 3974 | When set to "once" the network operation will |
| 3975 | fail when all the available network interfaces |
| 3976 | are tried once without success. |
| 3977 | Useful on scripts which control the retry operation |
| 3978 | themselves. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3979 | |
Jean-Christophe PLAGNIOL-VILLARD | b4e2f89 | 2009-01-31 09:53:39 +0100 | [diff] [blame] | 3980 | npe_ucode - set load address for the NPE microcode |
Jean-Christophe PLAGNIOL-VILLARD | a1cf027 | 2008-01-07 08:41:34 +0100 | [diff] [blame] | 3981 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 3982 | silent_linux - If set then Linux will be told to boot silently, by |
Simon Glass | 8d51aac | 2013-07-16 20:10:00 -0700 | [diff] [blame] | 3983 | changing the console to be empty. If "yes" it will be |
| 3984 | made silent. If "no" it will not be made silent. If |
| 3985 | unset, then it will be made silent if the U-Boot console |
| 3986 | is silent. |
| 3987 | |
Albert ARIBAUD \(3ADEV\) | f5fb734 | 2015-10-12 00:02:57 +0200 | [diff] [blame] | 3988 | tftpsrcp - If this is set, the value is used for TFTP's |
Wolfgang Denk | ecb0ccd | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 3989 | UDP source port. |
| 3990 | |
Albert ARIBAUD \(3ADEV\) | f5fb734 | 2015-10-12 00:02:57 +0200 | [diff] [blame] | 3991 | tftpdstp - If this is set, the value is used for TFTP's UDP |
Wolfgang Denk | 28cb937 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 3992 | destination port instead of the Well Know Port 69. |
| 3993 | |
Wolfgang Denk | c96f86e | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 3994 | tftpblocksize - Block size to use for TFTP transfers; if not set, |
| 3995 | we use the TFTP server's default block size |
| 3996 | |
| 3997 | tftptimeout - Retransmission timeout for TFTP packets (in milli- |
| 3998 | seconds, minimum value is 1000 = 1 second). Defines |
| 3999 | when a packet is considered to be lost so it has to |
| 4000 | be retransmitted. The default is 5000 = 5 seconds. |
| 4001 | Lowering this value may make downloads succeed |
| 4002 | faster in networks with high packet loss rates or |
| 4003 | with unreliable TFTP servers. |
| 4004 | |
Albert ARIBAUD \(3ADEV\) | f5fb734 | 2015-10-12 00:02:57 +0200 | [diff] [blame] | 4005 | tftptimeoutcountmax - maximum count of TFTP timeouts (no |
| 4006 | unit, minimum value = 0). Defines how many timeouts |
| 4007 | can happen during a single file transfer before that |
| 4008 | transfer is aborted. The default is 10, and 0 means |
| 4009 | 'no timeouts allowed'. Increasing this value may help |
| 4010 | downloads succeed with high packet loss rates, or with |
| 4011 | unreliable TFTP servers or client hardware. |
| 4012 | |
Wolfgang Denk | c96f86e | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 4013 | vlan - When set to a value < 4095 the traffic over |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4014 | Ethernet is encapsulated/received over 802.1q |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4015 | VLAN tagged frames. |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 4016 | |
Alexandre Messier | 50768f5 | 2016-02-01 17:08:57 -0500 | [diff] [blame] | 4017 | bootpretryperiod - Period during which BOOTP/DHCP sends retries. |
| 4018 | Unsigned value, in milliseconds. If not set, the period will |
| 4019 | be either the default (28000), or a value based on |
| 4020 | CONFIG_NET_RETRY_COUNT, if defined. This value has |
| 4021 | precedence over the valu based on CONFIG_NET_RETRY_COUNT. |
| 4022 | |
Jason Hobbs | dc0b7b0 | 2011-08-31 05:37:28 +0000 | [diff] [blame] | 4023 | The following image location variables contain the location of images |
| 4024 | used in booting. The "Image" column gives the role of the image and is |
| 4025 | not an environment variable name. The other columns are environment |
| 4026 | variable names. "File Name" gives the name of the file on a TFTP |
| 4027 | server, "RAM Address" gives the location in RAM the image will be |
| 4028 | loaded to, and "Flash Location" gives the image's address in NOR |
| 4029 | flash or offset in NAND flash. |
| 4030 | |
| 4031 | *Note* - these variables don't have to be defined for all boards, some |
Fabio Estevam | aed9fed | 2015-04-25 18:53:10 -0300 | [diff] [blame] | 4032 | boards currently use other variables for these purposes, and some |
Jason Hobbs | dc0b7b0 | 2011-08-31 05:37:28 +0000 | [diff] [blame] | 4033 | boards use these variables for other purposes. |
| 4034 | |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 4035 | Image File Name RAM Address Flash Location |
| 4036 | ----- --------- ----------- -------------- |
| 4037 | u-boot u-boot u-boot_addr_r u-boot_addr |
| 4038 | Linux kernel bootfile kernel_addr_r kernel_addr |
| 4039 | device tree blob fdtfile fdt_addr_r fdt_addr |
| 4040 | ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr |
Jason Hobbs | dc0b7b0 | 2011-08-31 05:37:28 +0000 | [diff] [blame] | 4041 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4042 | The following environment variables may be used and automatically |
| 4043 | updated by the network boot commands ("bootp" and "rarpboot"), |
| 4044 | depending the information provided by your boot server: |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 4045 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4046 | bootfile - see above |
| 4047 | dnsip - IP address of your Domain Name Server |
| 4048 | dnsip2 - IP address of your secondary Domain Name Server |
| 4049 | gatewayip - IP address of the Gateway (Router) to use |
| 4050 | hostname - Target hostname |
| 4051 | ipaddr - see above |
| 4052 | netmask - Subnet Mask |
| 4053 | rootpath - Pathname of the root filesystem on the NFS server |
| 4054 | serverip - see above |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 4055 | |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 4056 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4057 | There are two special Environment Variables: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4058 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4059 | serial# - contains hardware identification information such |
| 4060 | as type string and/or serial number |
| 4061 | ethaddr - Ethernet address |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4062 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4063 | These variables can be set only once (usually during manufacturing of |
| 4064 | the board). U-Boot refuses to delete or overwrite these variables |
| 4065 | once they have been set once. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4066 | |
| 4067 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4068 | Further special Environment Variables: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4069 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4070 | ver - Contains the U-Boot version string as printed |
| 4071 | with the "version" command. This variable is |
| 4072 | readonly (see CONFIG_VERSION_VARIABLE). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4073 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4074 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4075 | Please note that changes to some configuration parameters may take |
| 4076 | only effect after the next boot (yes, that's just like Windoze :-). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4077 | |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4078 | |
Joe Hershberger | 170ab11 | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 4079 | Callback functions for environment variables: |
| 4080 | --------------------------------------------- |
| 4081 | |
| 4082 | For some environment variables, the behavior of u-boot needs to change |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 4083 | when their values are changed. This functionality allows functions to |
Joe Hershberger | 170ab11 | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 4084 | be associated with arbitrary variables. On creation, overwrite, or |
| 4085 | deletion, the callback will provide the opportunity for some side |
| 4086 | effect to happen or for the change to be rejected. |
| 4087 | |
| 4088 | The callbacks are named and associated with a function using the |
| 4089 | U_BOOT_ENV_CALLBACK macro in your board or driver code. |
| 4090 | |
| 4091 | These callbacks are associated with variables in one of two ways. The |
| 4092 | static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC |
| 4093 | in the board configuration to a string that defines a list of |
| 4094 | associations. The list must be in the following format: |
| 4095 | |
| 4096 | entry = variable_name[:callback_name] |
| 4097 | list = entry[,list] |
| 4098 | |
| 4099 | If the callback name is not specified, then the callback is deleted. |
| 4100 | Spaces are also allowed anywhere in the list. |
| 4101 | |
| 4102 | Callbacks can also be associated by defining the ".callbacks" variable |
| 4103 | with the same list format above. Any association in ".callbacks" will |
| 4104 | override any association in the static list. You can define |
| 4105 | CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 4106 | ".callbacks" environment variable in the default or embedded environment. |
Joe Hershberger | 170ab11 | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 4107 | |
Joe Hershberger | bdf1fe4 | 2015-05-20 14:27:20 -0500 | [diff] [blame] | 4108 | If CONFIG_REGEX is defined, the variable_name above is evaluated as a |
| 4109 | regular expression. This allows multiple variables to be connected to |
| 4110 | the same callback without explicitly listing them all out. |
| 4111 | |
Joe Hershberger | 170ab11 | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 4112 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4113 | Command Line Parsing: |
| 4114 | ===================== |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4115 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4116 | There are two different command line parsers available with U-Boot: |
| 4117 | the old "simple" one, and the much more powerful "hush" shell: |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4118 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4119 | Old, simple command line parser: |
| 4120 | -------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4121 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4122 | - supports environment variables (through setenv / saveenv commands) |
| 4123 | - several commands on one line, separated by ';' |
Wolfgang Denk | fe126d8 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 4124 | - variable substitution using "... ${name} ..." syntax |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4125 | - special characters ('$', ';') can be escaped by prefixing with '\', |
| 4126 | for example: |
Wolfgang Denk | fe126d8 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 4127 | setenv bootcmd bootm \${address} |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4128 | - You can also escape text by enclosing in single apostrophes, for example: |
| 4129 | setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4130 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4131 | Hush shell: |
| 4132 | ----------- |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4133 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4134 | - similar to Bourne shell, with control structures like |
| 4135 | if...then...else...fi, for...do...done; while...do...done, |
| 4136 | until...do...done, ... |
| 4137 | - supports environment ("global") variables (through setenv / saveenv |
| 4138 | commands) and local shell variables (through standard shell syntax |
| 4139 | "name=value"); only environment variables can be used with "run" |
| 4140 | command |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4141 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4142 | General rules: |
| 4143 | -------------- |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4144 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4145 | (1) If a command line (or an environment variable executed by a "run" |
| 4146 | command) contains several commands separated by semicolon, and |
| 4147 | one of these commands fails, then the remaining commands will be |
| 4148 | executed anyway. |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4149 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4150 | (2) If you execute several variables with one call to run (i. e. |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4151 | calling run with a list of variables as arguments), any failing |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4152 | command will cause "run" to terminate, i. e. the remaining |
| 4153 | variables are not executed. |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4154 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4155 | Note for Redundant Ethernet Interfaces: |
| 4156 | ======================================= |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4157 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4158 | Some boards come with redundant Ethernet interfaces; U-Boot supports |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4159 | such configurations and is capable of automatic selection of a |
| 4160 | "working" interface when needed. MAC assignment works as follows: |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4161 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4162 | Network interfaces are numbered eth0, eth1, eth2, ... Corresponding |
| 4163 | MAC addresses can be stored in the environment as "ethaddr" (=>eth0), |
| 4164 | "eth1addr" (=>eth1), "eth2addr", ... |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4165 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4166 | If the network interface stores some valid MAC address (for instance |
| 4167 | in SROM), this is used as default address if there is NO correspon- |
| 4168 | ding setting in the environment; if the corresponding environment |
| 4169 | variable is set, this overrides the settings in the card; that means: |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 4170 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4171 | o If the SROM has a valid MAC address, and there is no address in the |
| 4172 | environment, the SROM's address is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4173 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4174 | o If there is no valid address in the SROM, and a definition in the |
| 4175 | environment exists, then the value from the environment variable is |
| 4176 | used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4177 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4178 | o If both the SROM and the environment contain a MAC address, and |
| 4179 | both addresses are the same, this MAC address is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4180 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4181 | o If both the SROM and the environment contain a MAC address, and the |
| 4182 | addresses differ, the value from the environment is used and a |
| 4183 | warning is printed. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4184 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4185 | o If neither SROM nor the environment contain a MAC address, an error |
Joe Hershberger | bef1014 | 2015-05-04 14:55:13 -0500 | [diff] [blame] | 4186 | is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case |
| 4187 | a random, locally-assigned MAC is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4188 | |
Ben Warren | ecee932 | 2010-04-26 11:11:46 -0700 | [diff] [blame] | 4189 | If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 4190 | will be programmed into hardware as part of the initialization process. This |
Ben Warren | ecee932 | 2010-04-26 11:11:46 -0700 | [diff] [blame] | 4191 | may be skipped by setting the appropriate 'ethmacskip' environment variable. |
| 4192 | The naming convention is as follows: |
| 4193 | "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4194 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4195 | Image Formats: |
| 4196 | ============== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4197 | |
Marian Balakowicz | 3310c54 | 2008-03-12 12:13:13 +0100 | [diff] [blame] | 4198 | U-Boot is capable of booting (and performing other auxiliary operations on) |
| 4199 | images in two formats: |
| 4200 | |
| 4201 | New uImage format (FIT) |
| 4202 | ----------------------- |
| 4203 | |
| 4204 | Flexible and powerful format based on Flattened Image Tree -- FIT (similar |
| 4205 | to Flattened Device Tree). It allows the use of images with multiple |
| 4206 | components (several kernels, ramdisks, etc.), with contents protected by |
| 4207 | SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. |
| 4208 | |
| 4209 | |
| 4210 | Old uImage format |
| 4211 | ----------------- |
| 4212 | |
| 4213 | Old image format is based on binary files which can be basically anything, |
| 4214 | preceded by a special header; see the definitions in include/image.h for |
| 4215 | details; basically, the header defines the following image properties: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4216 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4217 | * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, |
| 4218 | 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, |
Peter Tyser | f5ed9e3 | 2008-09-08 14:56:49 -0500 | [diff] [blame] | 4219 | LynxOS, pSOS, QNX, RTEMS, INTEGRITY; |
| 4220 | Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, |
| 4221 | INTEGRITY). |
Andy Shevchenko | daab59a | 2017-07-05 16:25:22 +0300 | [diff] [blame] | 4222 | * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, |
Macpaul Lin | afc1ce8 | 2011-10-19 20:41:11 +0000 | [diff] [blame] | 4223 | IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; |
Andy Shevchenko | daab59a | 2017-07-05 16:25:22 +0300 | [diff] [blame] | 4224 | Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC). |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4225 | * Compression Type (uncompressed, gzip, bzip2) |
| 4226 | * Load Address |
| 4227 | * Entry Point |
| 4228 | * Image Name |
| 4229 | * Image Timestamp |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4230 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4231 | The header is marked by a special Magic Number, and both the header |
| 4232 | and the data portions of the image are secured against corruption by |
| 4233 | CRC32 checksums. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4234 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4235 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4236 | Linux Support: |
| 4237 | ============== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4238 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4239 | Although U-Boot should support any OS or standalone application |
| 4240 | easily, the main focus has always been on Linux during the design of |
| 4241 | U-Boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4242 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4243 | U-Boot includes many features that so far have been part of some |
| 4244 | special "boot loader" code within the Linux kernel. Also, any |
| 4245 | "initrd" images to be used are no longer part of one big Linux image; |
| 4246 | instead, kernel and "initrd" are separate images. This implementation |
| 4247 | serves several purposes: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4248 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4249 | - the same features can be used for other OS or standalone |
| 4250 | applications (for instance: using compressed images to reduce the |
| 4251 | Flash memory footprint) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4252 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4253 | - it becomes much easier to port new Linux kernel versions because |
| 4254 | lots of low-level, hardware dependent stuff are done by U-Boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4255 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4256 | - the same Linux kernel image can now be used with different "initrd" |
| 4257 | images; of course this also means that different kernel images can |
| 4258 | be run with the same "initrd". This makes testing easier (you don't |
| 4259 | have to build a new "zImage.initrd" Linux image when you just |
| 4260 | change a file in your "initrd"). Also, a field-upgrade of the |
| 4261 | software is easier now. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4262 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4263 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4264 | Linux HOWTO: |
| 4265 | ============ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4266 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4267 | Porting Linux to U-Boot based systems: |
| 4268 | --------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4269 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4270 | U-Boot cannot save you from doing all the necessary modifications to |
| 4271 | configure the Linux device drivers for use with your target hardware |
| 4272 | (no, we don't intend to provide a full virtual machine interface to |
| 4273 | Linux :-). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4274 | |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 4275 | But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4276 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4277 | Just make sure your machine specific header file (for instance |
| 4278 | include/asm-ppc/tqm8xx.h) includes the same definition of the Board |
Markus Heidelberg | 1dc3069 | 2008-09-07 20:18:27 +0200 | [diff] [blame] | 4279 | Information structure as we define in include/asm-<arch>/u-boot.h, |
| 4280 | and make sure that your definition of IMAP_ADDR uses the same value |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 4281 | as your U-Boot configuration in CONFIG_SYS_IMMR. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4282 | |
Simon Glass | 2eb31b1 | 2014-06-11 23:29:46 -0600 | [diff] [blame] | 4283 | Note that U-Boot now has a driver model, a unified model for drivers. |
| 4284 | If you are adding a new driver, plumb it into driver model. If there |
| 4285 | is no uclass available, you are encouraged to create one. See |
| 4286 | doc/driver-model. |
| 4287 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4288 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4289 | Configuring the Linux kernel: |
| 4290 | ----------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4291 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4292 | No specific requirements for U-Boot. Make sure you have some root |
| 4293 | device (initial ramdisk, NFS) for your target system. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4294 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4295 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4296 | Building a Linux Image: |
| 4297 | ----------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4298 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4299 | With U-Boot, "normal" build targets like "zImage" or "bzImage" are |
| 4300 | not used. If you use recent kernel source, a new build target |
| 4301 | "uImage" will exist which automatically builds an image usable by |
| 4302 | U-Boot. Most older kernels also have support for a "pImage" target, |
| 4303 | which was introduced for our predecessor project PPCBoot and uses a |
| 4304 | 100% compatible format. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4305 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4306 | Example: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4307 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 4308 | make TQM850L_defconfig |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4309 | make oldconfig |
| 4310 | make dep |
| 4311 | make uImage |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4312 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4313 | The "uImage" build target uses a special tool (in 'tools/mkimage') to |
| 4314 | encapsulate a compressed Linux kernel image with header information, |
| 4315 | 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] | 4316 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4317 | * build a standard "vmlinux" kernel image (in ELF binary format): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4318 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4319 | * convert the kernel into a raw binary image: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4320 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4321 | ${CROSS_COMPILE}-objcopy -O binary \ |
| 4322 | -R .note -R .comment \ |
| 4323 | -S vmlinux linux.bin |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4324 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4325 | * compress the binary image: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4326 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4327 | gzip -9 linux.bin |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4328 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4329 | * package compressed binary image for U-Boot: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4330 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4331 | mkimage -A ppc -O linux -T kernel -C gzip \ |
| 4332 | -a 0 -e 0 -n "Linux Kernel Image" \ |
| 4333 | -d linux.bin.gz uImage |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4334 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4335 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4336 | The "mkimage" tool can also be used to create ramdisk images for use |
| 4337 | with U-Boot, either separated from the Linux kernel image, or |
| 4338 | combined into one file. "mkimage" encapsulates the images with a 64 |
| 4339 | byte header containing information about target architecture, |
| 4340 | operating system, image type, compression method, entry points, time |
| 4341 | stamp, CRC32 checksums, etc. |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4342 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4343 | "mkimage" can be called in two ways: to verify existing images and |
| 4344 | print the header information, or to build new images. |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4345 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4346 | In the first form (with "-l" option) mkimage lists the information |
| 4347 | contained in the header of an existing U-Boot image; this includes |
| 4348 | checksum verification: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4349 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4350 | tools/mkimage -l image |
| 4351 | -l ==> list image header information |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4352 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4353 | The second form (with "-d" option) is used to build a U-Boot image |
| 4354 | from a "data file" which is used as image payload: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4355 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4356 | tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ |
| 4357 | -n name -d data_file image |
| 4358 | -A ==> set architecture to 'arch' |
| 4359 | -O ==> set operating system to 'os' |
| 4360 | -T ==> set image type to 'type' |
| 4361 | -C ==> set compression type 'comp' |
| 4362 | -a ==> set load address to 'addr' (hex) |
| 4363 | -e ==> set entry point to 'ep' (hex) |
| 4364 | -n ==> set image name to 'name' |
| 4365 | -d ==> use image data from 'datafile' |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 4366 | |
wdenk | 6945979 | 2004-05-29 16:53:29 +0000 | [diff] [blame] | 4367 | Right now, all Linux kernels for PowerPC systems use the same load |
| 4368 | address (0x00000000), but the entry point address depends on the |
| 4369 | kernel version: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4370 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4371 | - 2.2.x kernels have the entry point at 0x0000000C, |
| 4372 | - 2.3.x and later kernels have the entry point at 0x00000000. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4373 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4374 | So a typical call to build a U-Boot image would read: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4375 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4376 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
| 4377 | > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 4378 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4379 | > examples/uImage.TQM850L |
| 4380 | Image Name: 2.4.4 kernel for TQM850L |
| 4381 | Created: Wed Jul 19 02:34:59 2000 |
| 4382 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4383 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB |
| 4384 | Load Address: 0x00000000 |
| 4385 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4386 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4387 | To verify the contents of the image (or check for corruption): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4388 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4389 | -> tools/mkimage -l examples/uImage.TQM850L |
| 4390 | Image Name: 2.4.4 kernel for TQM850L |
| 4391 | Created: Wed Jul 19 02:34:59 2000 |
| 4392 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4393 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB |
| 4394 | Load Address: 0x00000000 |
| 4395 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4396 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4397 | NOTE: for embedded systems where boot time is critical you can trade |
| 4398 | speed for memory and install an UNCOMPRESSED image instead: this |
| 4399 | needs more space in Flash, but boots much faster since it does not |
| 4400 | need to be uncompressed: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4401 | |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 4402 | -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4403 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
| 4404 | > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 4405 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4406 | > examples/uImage.TQM850L-uncompressed |
| 4407 | Image Name: 2.4.4 kernel for TQM850L |
| 4408 | Created: Wed Jul 19 02:34:59 2000 |
| 4409 | Image Type: PowerPC Linux Kernel Image (uncompressed) |
| 4410 | Data Size: 792160 Bytes = 773.59 kB = 0.76 MB |
| 4411 | Load Address: 0x00000000 |
| 4412 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4413 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4414 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4415 | Similar you can build U-Boot images from a 'ramdisk.image.gz' file |
| 4416 | when your kernel is intended to use an initial ramdisk: |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4417 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4418 | -> tools/mkimage -n 'Simple Ramdisk Image' \ |
| 4419 | > -A ppc -O linux -T ramdisk -C gzip \ |
| 4420 | > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd |
| 4421 | Image Name: Simple Ramdisk Image |
| 4422 | Created: Wed Jan 12 14:01:50 2000 |
| 4423 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 4424 | Data Size: 566530 Bytes = 553.25 kB = 0.54 MB |
| 4425 | Load Address: 0x00000000 |
| 4426 | Entry Point: 0x00000000 |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4427 | |
Guilherme Maciel Ferreira | a804b5c | 2013-12-01 12:43:11 -0700 | [diff] [blame] | 4428 | The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" |
| 4429 | option performs the converse operation of the mkimage's second form (the "-d" |
| 4430 | option). Given an image built by mkimage, the dumpimage extracts a "data file" |
| 4431 | from the image: |
| 4432 | |
Guilherme Maciel Ferreira | f41f5b7 | 2015-01-15 02:54:40 -0200 | [diff] [blame] | 4433 | tools/dumpimage -i image -T type -p position data_file |
| 4434 | -i ==> extract from the 'image' a specific 'data_file' |
| 4435 | -T ==> set image type to 'type' |
| 4436 | -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' |
Guilherme Maciel Ferreira | a804b5c | 2013-12-01 12:43:11 -0700 | [diff] [blame] | 4437 | |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4438 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4439 | Installing a Linux Image: |
| 4440 | ------------------------- |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4441 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4442 | To downloading a U-Boot image over the serial (console) interface, |
| 4443 | you must convert the image to S-Record format: |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4444 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4445 | objcopy -I binary -O srec examples/image examples/image.srec |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4446 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4447 | The 'objcopy' does not understand the information in the U-Boot |
| 4448 | image header, so the resulting S-Record file will be relative to |
| 4449 | address 0x00000000. To load it to a given address, you need to |
| 4450 | specify the target address as 'offset' parameter with the 'loads' |
| 4451 | command. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4452 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4453 | Example: install the image to address 0x40100000 (which on the |
| 4454 | TQM8xxL is in the first Flash bank): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4455 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4456 | => erase 40100000 401FFFFF |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4457 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4458 | .......... done |
| 4459 | Erased 8 sectors |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4460 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4461 | => loads 40100000 |
| 4462 | ## Ready for S-Record download ... |
| 4463 | ~>examples/image.srec |
| 4464 | 1 2 3 4 5 6 7 8 9 10 11 12 13 ... |
| 4465 | ... |
| 4466 | 15989 15990 15991 15992 |
| 4467 | [file transfer complete] |
| 4468 | [connected] |
| 4469 | ## Start Addr = 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4470 | |
| 4471 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4472 | You can check the success of the download using the 'iminfo' command; |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4473 | this includes a checksum verification so you can be sure no data |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4474 | corruption happened: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4475 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4476 | => imi 40100000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4477 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4478 | ## Checking Image at 40100000 ... |
| 4479 | Image Name: 2.2.13 for initrd on TQM850L |
| 4480 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4481 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 4482 | Load Address: 00000000 |
| 4483 | Entry Point: 0000000c |
| 4484 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4485 | |
| 4486 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4487 | Boot Linux: |
| 4488 | ----------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4489 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4490 | The "bootm" command is used to boot an application that is stored in |
| 4491 | memory (RAM or Flash). In case of a Linux kernel image, the contents |
| 4492 | of the "bootargs" environment variable is passed to the kernel as |
| 4493 | parameters. You can check and modify this variable using the |
| 4494 | "printenv" and "setenv" commands: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4495 | |
| 4496 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4497 | => printenv bootargs |
| 4498 | bootargs=root=/dev/ram |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4499 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4500 | => 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] | 4501 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4502 | => printenv bootargs |
| 4503 | 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] | 4504 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4505 | => bootm 40020000 |
| 4506 | ## Booting Linux kernel at 40020000 ... |
| 4507 | Image Name: 2.2.13 for NFS on TQM850L |
| 4508 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4509 | Data Size: 381681 Bytes = 372 kB = 0 MB |
| 4510 | Load Address: 00000000 |
| 4511 | Entry Point: 0000000c |
| 4512 | Verifying Checksum ... OK |
| 4513 | Uncompressing Kernel Image ... OK |
| 4514 | 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 |
| 4515 | Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 |
| 4516 | time_init: decrementer frequency = 187500000/60 |
| 4517 | Calibrating delay loop... 49.77 BogoMIPS |
| 4518 | Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] |
| 4519 | ... |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4520 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4521 | If you want to boot a Linux kernel with initial RAM disk, you pass |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4522 | the memory addresses of both the kernel and the initrd image (PPBCOOT |
| 4523 | format!) to the "bootm" command: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4524 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4525 | => imi 40100000 40200000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4526 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4527 | ## Checking Image at 40100000 ... |
| 4528 | Image Name: 2.2.13 for initrd on TQM850L |
| 4529 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4530 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 4531 | Load Address: 00000000 |
| 4532 | Entry Point: 0000000c |
| 4533 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4534 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4535 | ## Checking Image at 40200000 ... |
| 4536 | Image Name: Simple Ramdisk Image |
| 4537 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 4538 | Data Size: 566530 Bytes = 553 kB = 0 MB |
| 4539 | Load Address: 00000000 |
| 4540 | Entry Point: 00000000 |
| 4541 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4542 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4543 | => bootm 40100000 40200000 |
| 4544 | ## Booting Linux kernel at 40100000 ... |
| 4545 | Image Name: 2.2.13 for initrd on TQM850L |
| 4546 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4547 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 4548 | Load Address: 00000000 |
| 4549 | Entry Point: 0000000c |
| 4550 | Verifying Checksum ... OK |
| 4551 | Uncompressing Kernel Image ... OK |
| 4552 | ## Loading RAMDisk Image at 40200000 ... |
| 4553 | Image Name: Simple Ramdisk Image |
| 4554 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 4555 | Data Size: 566530 Bytes = 553 kB = 0 MB |
| 4556 | Load Address: 00000000 |
| 4557 | Entry Point: 00000000 |
| 4558 | Verifying Checksum ... OK |
| 4559 | Loading Ramdisk ... OK |
| 4560 | 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 |
| 4561 | Boot arguments: root=/dev/ram |
| 4562 | time_init: decrementer frequency = 187500000/60 |
| 4563 | Calibrating delay loop... 49.77 BogoMIPS |
| 4564 | ... |
| 4565 | RAMDISK: Compressed image found at block 0 |
| 4566 | VFS: Mounted root (ext2 filesystem). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4567 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4568 | bash# |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4569 | |
Matthew McClintock | 0267768 | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 4570 | Boot Linux and pass a flat device tree: |
| 4571 | ----------- |
| 4572 | |
| 4573 | First, U-Boot must be compiled with the appropriate defines. See the section |
| 4574 | titled "Linux Kernel Interface" above for a more in depth explanation. The |
| 4575 | following is an example of how to start a kernel and pass an updated |
| 4576 | flat device tree: |
| 4577 | |
| 4578 | => print oftaddr |
| 4579 | oftaddr=0x300000 |
| 4580 | => print oft |
| 4581 | oft=oftrees/mpc8540ads.dtb |
| 4582 | => tftp $oftaddr $oft |
| 4583 | Speed: 1000, full duplex |
| 4584 | Using TSEC0 device |
| 4585 | TFTP from server 192.168.1.1; our IP address is 192.168.1.101 |
| 4586 | Filename 'oftrees/mpc8540ads.dtb'. |
| 4587 | Load address: 0x300000 |
| 4588 | Loading: # |
| 4589 | done |
| 4590 | Bytes transferred = 4106 (100a hex) |
| 4591 | => tftp $loadaddr $bootfile |
| 4592 | Speed: 1000, full duplex |
| 4593 | Using TSEC0 device |
| 4594 | TFTP from server 192.168.1.1; our IP address is 192.168.1.2 |
| 4595 | Filename 'uImage'. |
| 4596 | Load address: 0x200000 |
| 4597 | Loading:############ |
| 4598 | done |
| 4599 | Bytes transferred = 1029407 (fb51f hex) |
| 4600 | => print loadaddr |
| 4601 | loadaddr=200000 |
| 4602 | => print oftaddr |
| 4603 | oftaddr=0x300000 |
| 4604 | => bootm $loadaddr - $oftaddr |
| 4605 | ## Booting image at 00200000 ... |
Wolfgang Denk | a9398e0 | 2006-11-27 15:32:42 +0100 | [diff] [blame] | 4606 | Image Name: Linux-2.6.17-dirty |
| 4607 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4608 | Data Size: 1029343 Bytes = 1005.2 kB |
Matthew McClintock | 0267768 | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 4609 | Load Address: 00000000 |
Wolfgang Denk | a9398e0 | 2006-11-27 15:32:42 +0100 | [diff] [blame] | 4610 | Entry Point: 00000000 |
Matthew McClintock | 0267768 | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 4611 | Verifying Checksum ... OK |
| 4612 | Uncompressing Kernel Image ... OK |
| 4613 | Booting using flat device tree at 0x300000 |
| 4614 | Using MPC85xx ADS machine description |
| 4615 | Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb |
| 4616 | [snip] |
| 4617 | |
| 4618 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4619 | More About U-Boot Image Types: |
| 4620 | ------------------------------ |
wdenk | 6069ff2 | 2003-02-28 00:49:47 +0000 | [diff] [blame] | 4621 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4622 | U-Boot supports the following image types: |
wdenk | 6069ff2 | 2003-02-28 00:49:47 +0000 | [diff] [blame] | 4623 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4624 | "Standalone Programs" are directly runnable in the environment |
| 4625 | provided by U-Boot; it is expected that (if they behave |
| 4626 | well) you can continue to work in U-Boot after return from |
| 4627 | the Standalone Program. |
| 4628 | "OS Kernel Images" are usually images of some Embedded OS which |
| 4629 | will take over control completely. Usually these programs |
| 4630 | will install their own set of exception handlers, device |
| 4631 | drivers, set up the MMU, etc. - this means, that you cannot |
| 4632 | expect to re-enter U-Boot except by resetting the CPU. |
| 4633 | "RAMDisk Images" are more or less just data blocks, and their |
| 4634 | parameters (address, size) are passed to an OS kernel that is |
| 4635 | being started. |
| 4636 | "Multi-File Images" contain several images, typically an OS |
| 4637 | (Linux) kernel image and one or more data images like |
| 4638 | RAMDisks. This construct is useful for instance when you want |
| 4639 | to boot over the network using BOOTP etc., where the boot |
| 4640 | server provides just a single image file, but you want to get |
| 4641 | for instance an OS kernel and a RAMDisk image. |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4642 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4643 | "Multi-File Images" start with a list of image sizes, each |
| 4644 | image size (in bytes) specified by an "uint32_t" in network |
| 4645 | byte order. This list is terminated by an "(uint32_t)0". |
| 4646 | Immediately after the terminating 0 follow the images, one by |
| 4647 | one, all aligned on "uint32_t" boundaries (size rounded up to |
| 4648 | a multiple of 4 bytes). |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4649 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4650 | "Firmware Images" are binary images containing firmware (like |
| 4651 | U-Boot or FPGA images) which usually will be programmed to |
| 4652 | flash memory. |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4653 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4654 | "Script files" are command sequences that will be executed by |
| 4655 | U-Boot's command interpreter; this feature is especially |
| 4656 | useful when you configure U-Boot to use a real shell (hush) |
| 4657 | as command interpreter. |
wdenk | 6069ff2 | 2003-02-28 00:49:47 +0000 | [diff] [blame] | 4658 | |
Marek Vasut | 44f074c | 2012-03-14 21:52:45 +0000 | [diff] [blame] | 4659 | Booting the Linux zImage: |
| 4660 | ------------------------- |
| 4661 | |
| 4662 | On some platforms, it's possible to boot Linux zImage. This is done |
| 4663 | using the "bootz" command. The syntax of "bootz" command is the same |
| 4664 | as the syntax of "bootm" command. |
| 4665 | |
Tom Rini | 8ac2856 | 2013-05-16 11:40:11 -0400 | [diff] [blame] | 4666 | Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply |
Marek Vasut | 017e1f3 | 2012-03-18 11:47:58 +0000 | [diff] [blame] | 4667 | kernel with raw initrd images. The syntax is slightly different, the |
| 4668 | address of the initrd must be augmented by it's size, in the following |
| 4669 | format: "<initrd addres>:<initrd size>". |
| 4670 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4671 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4672 | Standalone HOWTO: |
| 4673 | ================= |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4674 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4675 | One of the features of U-Boot is that you can dynamically load and |
| 4676 | run "standalone" applications, which can use some resources of |
| 4677 | U-Boot like console I/O functions or interrupt services. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4678 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4679 | Two simple examples are included with the sources: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4680 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4681 | "Hello World" Demo: |
| 4682 | ------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4683 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4684 | 'examples/hello_world.c' contains a small "Hello World" Demo |
| 4685 | application; it is automatically compiled when you build U-Boot. |
| 4686 | It's configured to run at address 0x00040004, so you can play with it |
| 4687 | like that: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4688 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4689 | => loads |
| 4690 | ## Ready for S-Record download ... |
| 4691 | ~>examples/hello_world.srec |
| 4692 | 1 2 3 4 5 6 7 8 9 10 11 ... |
| 4693 | [file transfer complete] |
| 4694 | [connected] |
| 4695 | ## Start Addr = 0x00040004 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4696 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4697 | => go 40004 Hello World! This is a test. |
| 4698 | ## Starting application at 0x00040004 ... |
| 4699 | Hello World |
| 4700 | argc = 7 |
| 4701 | argv[0] = "40004" |
| 4702 | argv[1] = "Hello" |
| 4703 | argv[2] = "World!" |
| 4704 | argv[3] = "This" |
| 4705 | argv[4] = "is" |
| 4706 | argv[5] = "a" |
| 4707 | argv[6] = "test." |
| 4708 | argv[7] = "<NULL>" |
| 4709 | Hit any key to exit ... |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4710 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4711 | ## Application terminated, rc = 0x0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4712 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4713 | Another example, which demonstrates how to register a CPM interrupt |
| 4714 | handler with the U-Boot code, can be found in 'examples/timer.c'. |
| 4715 | Here, a CPM timer is set up to generate an interrupt every second. |
| 4716 | The interrupt service routine is trivial, just printing a '.' |
| 4717 | character, but this is just a demo program. The application can be |
| 4718 | controlled by the following keys: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4719 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4720 | ? - print current values og the CPM Timer registers |
| 4721 | b - enable interrupts and start timer |
| 4722 | e - stop timer and disable interrupts |
| 4723 | q - quit application |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4724 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4725 | => loads |
| 4726 | ## Ready for S-Record download ... |
| 4727 | ~>examples/timer.srec |
| 4728 | 1 2 3 4 5 6 7 8 9 10 11 ... |
| 4729 | [file transfer complete] |
| 4730 | [connected] |
| 4731 | ## Start Addr = 0x00040004 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4732 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4733 | => go 40004 |
| 4734 | ## Starting application at 0x00040004 ... |
| 4735 | TIMERS=0xfff00980 |
| 4736 | Using timer 1 |
| 4737 | tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4738 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4739 | Hit 'b': |
| 4740 | [q, b, e, ?] Set interval 1000000 us |
| 4741 | Enabling timer |
| 4742 | Hit '?': |
| 4743 | [q, b, e, ?] ........ |
| 4744 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 |
| 4745 | Hit '?': |
| 4746 | [q, b, e, ?] . |
| 4747 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 |
| 4748 | Hit '?': |
| 4749 | [q, b, e, ?] . |
| 4750 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 |
| 4751 | Hit '?': |
| 4752 | [q, b, e, ?] . |
| 4753 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 |
| 4754 | Hit 'e': |
| 4755 | [q, b, e, ?] ...Stopping timer |
| 4756 | Hit 'q': |
| 4757 | [q, b, e, ?] ## Application terminated, rc = 0x0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4758 | |
| 4759 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4760 | Minicom warning: |
| 4761 | ================ |
wdenk | 85ec0bc | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 4762 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4763 | Over time, many people have reported problems when trying to use the |
| 4764 | "minicom" terminal emulation program for serial download. I (wd) |
| 4765 | consider minicom to be broken, and recommend not to use it. Under |
| 4766 | Unix, I recommend to use C-Kermit for general purpose use (and |
| 4767 | especially for kermit binary protocol download ("loadb" command), and |
Karl O. Pinc | e53515a | 2012-10-01 05:11:56 +0000 | [diff] [blame] | 4768 | use "cu" for S-Record download ("loads" command). See |
| 4769 | http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. |
| 4770 | for help with kermit. |
| 4771 | |
wdenk | 85ec0bc | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 4772 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4773 | Nevertheless, if you absolutely want to use it try adding this |
| 4774 | configuration to your "File transfer protocols" section: |
wdenk | 52f52c1 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4775 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4776 | Name Program Name U/D FullScr IO-Red. Multi |
| 4777 | X kermit /usr/bin/kermit -i -l %l -s Y U Y N N |
| 4778 | Y kermit /usr/bin/kermit -i -l %l -r N D Y N N |
wdenk | 52f52c1 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4779 | |
| 4780 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4781 | NetBSD Notes: |
| 4782 | ============= |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4783 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4784 | Starting at version 0.9.2, U-Boot supports NetBSD both as host |
| 4785 | (build U-Boot) and target system (boots NetBSD/mpc8xx). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4786 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4787 | Building requires a cross environment; it is known to work on |
| 4788 | NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also |
| 4789 | need gmake since the Makefiles are not compatible with BSD make). |
| 4790 | Note that the cross-powerpc package does not install include files; |
| 4791 | attempting to build U-Boot will fail because <machine/ansi.h> is |
| 4792 | missing. This file has to be installed and patched manually: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4793 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4794 | # cd /usr/pkg/cross/powerpc-netbsd/include |
| 4795 | # mkdir powerpc |
| 4796 | # ln -s powerpc machine |
| 4797 | # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h |
| 4798 | # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4799 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4800 | Native builds *don't* work due to incompatibilities between native |
| 4801 | and U-Boot include files. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4802 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4803 | Booting assumes that (the first part of) the image booted is a |
| 4804 | stage-2 loader which in turn loads and then invokes the kernel |
| 4805 | proper. Loader sources will eventually appear in the NetBSD source |
| 4806 | tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the |
wdenk | 2a8af18 | 2005-04-13 10:02:42 +0000 | [diff] [blame] | 4807 | meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4808 | |
| 4809 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4810 | Implementation Internals: |
| 4811 | ========================= |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4812 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4813 | The following is not intended to be a complete description of every |
| 4814 | implementation detail. However, it should help to understand the |
| 4815 | inner workings of U-Boot and make it easier to port it to custom |
| 4816 | hardware. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4817 | |
| 4818 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4819 | Initial Stack, Global Data: |
| 4820 | --------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4821 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4822 | The implementation of U-Boot is complicated by the fact that U-Boot |
| 4823 | starts running out of ROM (flash memory), usually without access to |
| 4824 | system RAM (because the memory controller is not initialized yet). |
| 4825 | This means that we don't have writable Data or BSS segments, and BSS |
| 4826 | is not initialized as zero. To be able to get a C environment working |
| 4827 | at all, we have to allocate at least a minimal stack. Implementation |
| 4828 | options for this are defined and restricted by the CPU used: Some CPU |
| 4829 | models provide on-chip memory (like the IMMR area on MPC8xx and |
| 4830 | MPC826x processors), on others (parts of) the data cache can be |
| 4831 | locked as (mis-) used as memory, etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4832 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4833 | Chris Hallinan posted a good summary of these issues to the |
Wolfgang Denk | 0668236 | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 4834 | U-Boot mailing list: |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4835 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4836 | Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? |
| 4837 | From: "Chris Hallinan" <clh@net1plus.com> |
| 4838 | Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) |
| 4839 | ... |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4840 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4841 | Correct me if I'm wrong, folks, but the way I understand it |
| 4842 | is this: Using DCACHE as initial RAM for Stack, etc, does not |
| 4843 | require any physical RAM backing up the cache. The cleverness |
| 4844 | is that the cache is being used as a temporary supply of |
| 4845 | necessary storage before the SDRAM controller is setup. It's |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4846 | beyond the scope of this list to explain the details, but you |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4847 | can see how this works by studying the cache architecture and |
| 4848 | operation in the architecture and processor-specific manuals. |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4849 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4850 | OCM is On Chip Memory, which I believe the 405GP has 4K. It |
| 4851 | is another option for the system designer to use as an |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4852 | initial stack/RAM area prior to SDRAM being available. Either |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4853 | option should work for you. Using CS 4 should be fine if your |
| 4854 | board designers haven't used it for something that would |
| 4855 | cause you grief during the initial boot! It is frequently not |
| 4856 | used. |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4857 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 4858 | CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4859 | with your processor/board/system design. The default value |
| 4860 | you will find in any recent u-boot distribution in |
Stefan Roese | 8a316c9 | 2005-08-01 16:49:12 +0200 | [diff] [blame] | 4861 | walnut.h should work for you. I'd set it to a value larger |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4862 | than your SDRAM module. If you have a 64MB SDRAM module, set |
| 4863 | it above 400_0000. Just make sure your board has no resources |
| 4864 | that are supposed to respond to that address! That code in |
| 4865 | start.S has been around a while and should work as is when |
| 4866 | you get the config right. |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4867 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4868 | -Chris Hallinan |
| 4869 | DS4.COM, Inc. |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4870 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4871 | It is essential to remember this, since it has some impact on the C |
| 4872 | code for the initialization procedures: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4873 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4874 | * Initialized global data (data segment) is read-only. Do not attempt |
| 4875 | to write it. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4876 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 4877 | * Do not use any uninitialized global data (or implicitly initialized |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4878 | as zero data - BSS segment) at all - this is undefined, initiali- |
| 4879 | zation is performed later (when relocating to RAM). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4880 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4881 | * Stack space is very limited. Avoid big data buffers or things like |
| 4882 | that. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4883 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4884 | Having only the stack as writable memory limits means we cannot use |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 4885 | normal global data to share information between the code. But it |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4886 | turned out that the implementation of U-Boot can be greatly |
| 4887 | simplified by making a global data structure (gd_t) available to all |
| 4888 | functions. We could pass a pointer to this data as argument to _all_ |
| 4889 | functions, but this would bloat the code. Instead we use a feature of |
| 4890 | the GCC compiler (Global Register Variables) to share the data: we |
| 4891 | place a pointer (gd) to the global data into a register which we |
| 4892 | reserve for this purpose. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4893 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4894 | When choosing a register for such a purpose we are restricted by the |
| 4895 | relevant (E)ABI specifications for the current architecture, and by |
| 4896 | GCC's implementation. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4897 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4898 | For PowerPC, the following registers have specific use: |
| 4899 | R1: stack pointer |
Wolfgang Denk | e7670f6 | 2008-02-14 22:43:22 +0100 | [diff] [blame] | 4900 | R2: reserved for system use |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4901 | R3-R4: parameter passing and return values |
| 4902 | R5-R10: parameter passing |
| 4903 | R13: small data area pointer |
| 4904 | R30: GOT pointer |
| 4905 | R31: frame pointer |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4906 | |
Joakim Tjernlund | e6bee80 | 2010-01-19 14:41:58 +0100 | [diff] [blame] | 4907 | (U-Boot also uses R12 as internal GOT pointer. r12 |
| 4908 | is a volatile register so r12 needs to be reset when |
| 4909 | going back and forth between asm and C) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4910 | |
Wolfgang Denk | e7670f6 | 2008-02-14 22:43:22 +0100 | [diff] [blame] | 4911 | ==> U-Boot will use R2 to hold a pointer to the global data |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4912 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4913 | Note: on PPC, we could use a static initializer (since the |
| 4914 | address of the global data structure is known at compile time), |
| 4915 | but it turned out that reserving a register results in somewhat |
| 4916 | smaller code - although the code savings are not that big (on |
| 4917 | average for all boards 752 bytes for the whole U-Boot image, |
| 4918 | 624 text + 127 data). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4919 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4920 | On ARM, the following registers are used: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4921 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4922 | R0: function argument word/integer result |
| 4923 | R1-R3: function argument word |
Jeroen Hofstee | 12eba1b | 2013-09-21 14:04:42 +0200 | [diff] [blame] | 4924 | R9: platform specific |
| 4925 | R10: stack limit (used only if stack checking is enabled) |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4926 | R11: argument (frame) pointer |
| 4927 | R12: temporary workspace |
| 4928 | R13: stack pointer |
| 4929 | R14: link register |
| 4930 | R15: program counter |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4931 | |
Jeroen Hofstee | 12eba1b | 2013-09-21 14:04:42 +0200 | [diff] [blame] | 4932 | ==> U-Boot will use R9 to hold a pointer to the global data |
| 4933 | |
| 4934 | Note: on ARM, only R_ARM_RELATIVE relocations are supported. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4935 | |
Thomas Chou | 0df01fd3 | 2010-05-21 11:08:03 +0800 | [diff] [blame] | 4936 | On Nios II, the ABI is documented here: |
| 4937 | http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf |
| 4938 | |
| 4939 | ==> U-Boot will use gp to hold a pointer to the global data |
| 4940 | |
| 4941 | Note: on Nios II, we give "-G0" option to gcc and don't use gp |
| 4942 | to access small data sections, so gp is free. |
| 4943 | |
Macpaul Lin | afc1ce8 | 2011-10-19 20:41:11 +0000 | [diff] [blame] | 4944 | On NDS32, the following registers are used: |
| 4945 | |
| 4946 | R0-R1: argument/return |
| 4947 | R2-R5: argument |
| 4948 | R15: temporary register for assembler |
| 4949 | R16: trampoline register |
| 4950 | R28: frame pointer (FP) |
| 4951 | R29: global pointer (GP) |
| 4952 | R30: link register (LP) |
| 4953 | R31: stack pointer (SP) |
| 4954 | PC: program counter (PC) |
| 4955 | |
| 4956 | ==> U-Boot will use R10 to hold a pointer to the global data |
| 4957 | |
Wolfgang Denk | d87080b | 2006-03-31 18:32:53 +0200 | [diff] [blame] | 4958 | NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, |
| 4959 | or current versions of GCC may "optimize" the code too much. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4960 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4961 | Memory Management: |
| 4962 | ------------------ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4963 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4964 | U-Boot runs in system state and uses physical addresses, i.e. the |
| 4965 | MMU is not used either for address mapping nor for memory protection. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4966 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4967 | The available memory is mapped to fixed addresses using the memory |
| 4968 | controller. In this process, a contiguous block is formed for each |
| 4969 | memory type (Flash, SDRAM, SRAM), even when it consists of several |
| 4970 | physical memory banks. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4971 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4972 | U-Boot is installed in the first 128 kB of the first Flash bank (on |
| 4973 | TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After |
| 4974 | booting and sizing and initializing DRAM, the code relocates itself |
| 4975 | to the upper end of DRAM. Immediately below the U-Boot code some |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 4976 | memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4977 | configuration setting]. Below that, a structure with global Board |
| 4978 | Info data is placed, followed by the stack (growing downward). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4979 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4980 | Additionally, some exception handler code is copied to the low 8 kB |
| 4981 | of DRAM (0x00000000 ... 0x00001FFF). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4982 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4983 | So a typical memory configuration with 16 MB of DRAM could look like |
| 4984 | this: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4985 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4986 | 0x0000 0000 Exception Vector code |
| 4987 | : |
| 4988 | 0x0000 1FFF |
| 4989 | 0x0000 2000 Free for Application Use |
| 4990 | : |
| 4991 | : |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4992 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4993 | : |
| 4994 | : |
| 4995 | 0x00FB FF20 Monitor Stack (Growing downward) |
| 4996 | 0x00FB FFAC Board Info Data and permanent copy of global data |
| 4997 | 0x00FC 0000 Malloc Arena |
| 4998 | : |
| 4999 | 0x00FD FFFF |
| 5000 | 0x00FE 0000 RAM Copy of Monitor Code |
| 5001 | ... eventually: LCD or video framebuffer |
| 5002 | ... eventually: pRAM (Protected RAM - unchanged by reset) |
| 5003 | 0x00FF FFFF [End of RAM] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5004 | |
| 5005 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5006 | System Initialization: |
| 5007 | ---------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5008 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5009 | In the reset configuration, U-Boot starts at the reset entry point |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 5010 | (on most PowerPC systems at address 0x00000100). Because of the reset |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 5011 | configuration for CS0# this is a mirror of the on board Flash memory. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5012 | To be able to re-map memory U-Boot then jumps to its link address. |
| 5013 | To be able to implement the initialization code in C, a (small!) |
| 5014 | initial stack is set up in the internal Dual Ported RAM (in case CPUs |
Heiko Schocher | 2eb48ff | 2017-06-07 17:33:10 +0200 | [diff] [blame] | 5015 | which provide such a feature like), or in a locked part of the data |
| 5016 | cache. After that, U-Boot initializes the CPU core, the caches and |
| 5017 | the SIU. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5018 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5019 | Next, all (potentially) available memory banks are mapped using a |
| 5020 | preliminary mapping. For example, we put them on 512 MB boundaries |
| 5021 | (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash |
| 5022 | on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is |
| 5023 | programmed for SDRAM access. Using the temporary configuration, a |
| 5024 | simple memory test is run that determines the size of the SDRAM |
| 5025 | banks. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5026 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5027 | When there is more than one SDRAM bank, and the banks are of |
| 5028 | different size, the largest is mapped first. For equal size, the first |
| 5029 | bank (CS2#) is mapped first. The first mapping is always for address |
| 5030 | 0x00000000, with any additional banks following immediately to create |
| 5031 | contiguous memory starting from 0. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5032 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5033 | Then, the monitor installs itself at the upper end of the SDRAM area |
| 5034 | and allocates memory for use by malloc() and for the global Board |
| 5035 | Info data; also, the exception vector code is copied to the low RAM |
| 5036 | pages, and the final stack is set up. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5037 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5038 | Only after this relocation will you have a "normal" C environment; |
| 5039 | until that you are restricted in several ways, mostly because you are |
| 5040 | running from ROM, and because the code will have to be relocated to a |
| 5041 | new address in RAM. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5042 | |
| 5043 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5044 | U-Boot Porting Guide: |
| 5045 | ---------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5046 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5047 | [Based on messages by Jerry Van Baren in the U-Boot-Users mailing |
| 5048 | list, October 2002] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5049 | |
| 5050 | |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5051 | int main(int argc, char *argv[]) |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5052 | { |
| 5053 | sighandler_t no_more_time; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5054 | |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5055 | signal(SIGALRM, no_more_time); |
| 5056 | alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5057 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5058 | if (available_money > available_manpower) { |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5059 | Pay consultant to port U-Boot; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5060 | return 0; |
| 5061 | } |
| 5062 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5063 | Download latest U-Boot source; |
| 5064 | |
Wolfgang Denk | 0668236 | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 5065 | Subscribe to u-boot mailing list; |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5066 | |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5067 | if (clueless) |
| 5068 | email("Hi, I am new to U-Boot, how do I get started?"); |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5069 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5070 | while (learning) { |
| 5071 | Read the README file in the top level directory; |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5072 | Read http://www.denx.de/twiki/bin/view/DULG/Manual; |
| 5073 | Read applicable doc/*.README; |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5074 | Read the source, Luke; |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5075 | /* find . -name "*.[chS]" | xargs grep -i <keyword> */ |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5076 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5077 | |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5078 | if (available_money > toLocalCurrency ($2500)) |
| 5079 | Buy a BDI3000; |
| 5080 | else |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5081 | Add a lot of aggravation and time; |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5082 | |
| 5083 | if (a similar board exists) { /* hopefully... */ |
| 5084 | cp -a board/<similar> board/<myboard> |
| 5085 | cp include/configs/<similar>.h include/configs/<myboard>.h |
| 5086 | } else { |
| 5087 | Create your own board support subdirectory; |
| 5088 | Create your own board include/configs/<myboard>.h file; |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5089 | } |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5090 | Edit new board/<myboard> files |
| 5091 | Edit new include/configs/<myboard>.h |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5092 | |
Jerry Van Baren | 6c3fef2 | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 5093 | while (!accepted) { |
| 5094 | while (!running) { |
| 5095 | do { |
| 5096 | Add / modify source code; |
| 5097 | } until (compiles); |
| 5098 | Debug; |
| 5099 | if (clueless) |
| 5100 | email("Hi, I am having problems..."); |
| 5101 | } |
| 5102 | Send patch file to the U-Boot email list; |
| 5103 | if (reasonable critiques) |
| 5104 | Incorporate improvements from email list code review; |
| 5105 | else |
| 5106 | Defend code as written; |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5107 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5108 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5109 | return 0; |
| 5110 | } |
| 5111 | |
| 5112 | void no_more_time (int sig) |
| 5113 | { |
| 5114 | hire_a_guru(); |
| 5115 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5116 | |
| 5117 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5118 | Coding Standards: |
| 5119 | ----------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5120 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5121 | All contributions to U-Boot should conform to the Linux kernel |
Detlev Zundel | 2c05165 | 2006-09-01 15:39:02 +0200 | [diff] [blame] | 5122 | coding style; see the file "Documentation/CodingStyle" and the script |
Wolfgang Denk | 7ca9296 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 5123 | "scripts/Lindent" in your Linux kernel source directory. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5124 | |
Detlev Zundel | 2c05165 | 2006-09-01 15:39:02 +0200 | [diff] [blame] | 5125 | Source files originating from a different project (for example the |
| 5126 | MTD subsystem) are generally exempt from these guidelines and are not |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 5127 | reformatted to ease subsequent migration to newer versions of those |
Detlev Zundel | 2c05165 | 2006-09-01 15:39:02 +0200 | [diff] [blame] | 5128 | sources. |
| 5129 | |
| 5130 | Please note that U-Boot is implemented in C (and to some small parts in |
| 5131 | Assembler); no C++ is used, so please do not use C++ style comments (//) |
| 5132 | in your code. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5133 | |
| 5134 | Please also stick to the following formatting rules: |
| 5135 | - remove any trailing white space |
Wolfgang Denk | 7ca9296 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 5136 | - use TAB characters for indentation and vertical alignment, not spaces |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5137 | - make sure NOT to use DOS '\r\n' line feeds |
Wolfgang Denk | 7ca9296 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 5138 | - do not add more than 2 consecutive empty lines to source files |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5139 | - do not add trailing empty lines to source files |
| 5140 | |
| 5141 | Submissions which do not conform to the standards may be returned |
| 5142 | with a request to reformat the changes. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5143 | |
| 5144 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5145 | Submitting Patches: |
| 5146 | ------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5147 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5148 | Since the number of patches for U-Boot is growing, we need to |
| 5149 | establish some rules. Submissions which do not conform to these rules |
| 5150 | may be rejected, even when they contain important and valuable stuff. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5151 | |
Magnus Lilja | 0d28f34 | 2008-08-06 19:32:33 +0200 | [diff] [blame] | 5152 | Please see http://www.denx.de/wiki/U-Boot/Patches for details. |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 5153 | |
Wolfgang Denk | 0668236 | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 5154 | Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; |
| 5155 | see http://lists.denx.de/mailman/listinfo/u-boot |
| 5156 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5157 | When you send a patch, please include the following information with |
| 5158 | it: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5159 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5160 | * For bug fixes: a description of the bug and how your patch fixes |
| 5161 | this bug. Please try to include a way of demonstrating that the |
| 5162 | patch actually fixes something. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5163 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5164 | * For new features: a description of the feature and your |
| 5165 | implementation. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5166 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5167 | * A CHANGELOG entry as plaintext (separate from the patch) |
| 5168 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 5169 | * For major contributions, add a MAINTAINERS file with your |
| 5170 | information and associated file and directory references. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5171 | |
Albert ARIBAUD | 27af930 | 2013-09-11 15:52:51 +0200 | [diff] [blame] | 5172 | * When you add support for a new board, don't forget to add a |
| 5173 | maintainer e-mail address to the boards.cfg file, too. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5174 | |
| 5175 | * If your patch adds new configuration options, don't forget to |
| 5176 | document these in the README file. |
| 5177 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 5178 | * The patch itself. If you are using git (which is *strongly* |
| 5179 | recommended) you can easily generate the patch using the |
Wolfgang Denk | 7ca9296 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 5180 | "git format-patch". If you then use "git send-email" to send it to |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 5181 | the U-Boot mailing list, you will avoid most of the common problems |
| 5182 | with some other mail clients. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5183 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 5184 | If you cannot use git, use "diff -purN OLD NEW". If your version of |
| 5185 | diff does not support these options, then get the latest version of |
| 5186 | GNU diff. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5187 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 5188 | The current directory when running this command shall be the parent |
| 5189 | directory of the U-Boot source tree (i. e. please make sure that |
| 5190 | your patch includes sufficient directory information for the |
| 5191 | affected files). |
| 5192 | |
| 5193 | We prefer patches as plain text. MIME attachments are discouraged, |
| 5194 | and compressed attachments must not be used. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5195 | |
| 5196 | * If one logical set of modifications affects or creates several |
| 5197 | files, all these changes shall be submitted in a SINGLE patch file. |
| 5198 | |
| 5199 | * Changesets that contain different, unrelated modifications shall be |
| 5200 | submitted as SEPARATE patches, one patch per changeset. |
| 5201 | |
| 5202 | |
| 5203 | Notes: |
| 5204 | |
Simon Glass | 6de80f2 | 2016-07-27 20:33:08 -0600 | [diff] [blame] | 5205 | * Before sending the patch, run the buildman script on your patched |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 5206 | source tree and make sure that no errors or warnings are reported |
| 5207 | for any of the boards. |
| 5208 | |
| 5209 | * Keep your modifications to the necessary minimum: A patch |
| 5210 | containing several unrelated changes or arbitrary reformats will be |
| 5211 | returned with a request to re-formatting / split it. |
| 5212 | |
| 5213 | * If you modify existing code, make sure that your new code does not |
| 5214 | add to the memory footprint of the code ;-) Small is beautiful! |
| 5215 | When adding new features, these should compile conditionally only |
| 5216 | (using #ifdef), and the resulting code with the new feature |
| 5217 | disabled must not need more memory than the old code without your |
| 5218 | modification. |
wdenk | 90dc670 | 2005-05-03 14:12:25 +0000 | [diff] [blame] | 5219 | |
Wolfgang Denk | 0668236 | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 5220 | * Remember that there is a size limit of 100 kB per message on the |
| 5221 | u-boot mailing list. Bigger patches will be moderated. If they are |
| 5222 | reasonable and not too big, they will be acknowledged. But patches |
| 5223 | bigger than the size limit should be avoided. |