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