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