wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1 | # |
Detlev Zundel | 6aa4d7b | 2011-04-27 05:25:59 +0000 | [diff] [blame] | 2 | # (C) Copyright 2000 - 2011 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3 | # Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
| 4 | # |
| 5 | # See file CREDITS for list of people who contributed to this |
| 6 | # project. |
| 7 | # |
| 8 | # This program is free software; you can redistribute it and/or |
| 9 | # modify it under the terms of the GNU General Public License as |
| 10 | # published by the Free Software Foundation; either version 2 of |
| 11 | # the License, or (at your option) any later version. |
| 12 | # |
| 13 | # This program is distributed in the hope that it will be useful, |
| 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | # GNU General Public License for more details. |
| 17 | # |
| 18 | # You should have received a copy of the GNU General Public License |
| 19 | # along with this program; if not, write to the Free Software |
| 20 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, |
| 21 | # MA 02111-1307 USA |
| 22 | # |
| 23 | |
| 24 | Summary: |
| 25 | ======== |
| 26 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 27 | This directory contains the source code for U-Boot, a boot loader for |
wdenk | ce4832c | 2004-10-17 21:12:06 +0000 | [diff] [blame] | 28 | Embedded boards based on PowerPC, ARM, MIPS and several other |
| 29 | processors, which can be installed in a boot ROM and used to |
| 30 | initialize and test the hardware or to download and run application |
| 31 | code. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 32 | |
| 33 | The development of U-Boot is closely related to Linux: some parts of |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 34 | the source code originate in the Linux source tree, we have some |
| 35 | header files in common, and special provision has been made to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 36 | support booting of Linux images. |
| 37 | |
| 38 | Some attention has been paid to make this software easily |
| 39 | configurable and extendable. For instance, all monitor commands are |
| 40 | implemented with the same call interface, so that it's very easy to |
| 41 | add new commands. Also, instead of permanently adding rarely used |
| 42 | code (for instance hardware test utilities) to the monitor, you can |
| 43 | load and run it dynamically. |
| 44 | |
| 45 | |
| 46 | Status: |
| 47 | ======= |
| 48 | |
| 49 | In general, all boards for which a configuration option exists in the |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 50 | Makefile have been tested to some extent and can be considered |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 51 | "working". In fact, many of them are used in production systems. |
| 52 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 53 | In case of problems see the CHANGELOG and CREDITS files to find out |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 54 | who contributed the specific port. The MAINTAINERS file lists board |
| 55 | maintainers. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 56 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 57 | |
| 58 | Where to get help: |
| 59 | ================== |
| 60 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 61 | In case you have questions about, problems with or contributions for |
| 62 | 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] | 63 | <u-boot@lists.denx.de>. There is also an archive of previous traffic |
| 64 | on the mailing list - please search the archive before asking FAQ's. |
| 65 | Please see http://lists.denx.de/pipermail/u-boot and |
| 66 | http://dir.gmane.org/gmane.comp.boot-loaders.u-boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 67 | |
| 68 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 69 | Where to get source code: |
| 70 | ========================= |
| 71 | |
| 72 | The U-Boot source code is maintained in the git repository at |
| 73 | git://www.denx.de/git/u-boot.git ; you can browse it online at |
| 74 | http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary |
| 75 | |
| 76 | The "snapshot" links on this page allow you to download tarballs of |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 77 | any version you might be interested in. Official releases are also |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 78 | available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ |
| 79 | directory. |
| 80 | |
Anatolij Gustschin | 08337f3 | 2008-03-26 18:13:33 +0100 | [diff] [blame] | 81 | Pre-built (and tested) images are available from |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 82 | ftp://ftp.denx.de/pub/u-boot/images/ |
| 83 | |
| 84 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 85 | Where we come from: |
| 86 | =================== |
| 87 | |
| 88 | - start from 8xxrom sources |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 89 | - create PPCBoot project (http://sourceforge.net/projects/ppcboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 90 | - clean up code |
| 91 | - make it easier to add custom boards |
| 92 | - make it possible to add other [PowerPC] CPUs |
| 93 | - extend functions, especially: |
| 94 | * Provide extended interface to Linux boot loader |
| 95 | * S-Record download |
| 96 | * network boot |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 97 | * PCMCIA / CompactFlash / ATA disk / SCSI ... boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 98 | - create ARMBoot project (http://sourceforge.net/projects/armboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 99 | - add other CPU families (starting with ARM) |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 100 | - create U-Boot project (http://sourceforge.net/projects/u-boot) |
Magnus Lilja | f3b287b | 2008-08-06 19:32:33 +0200 | [diff] [blame] | 101 | - current project page: see http://www.denx.de/wiki/U-Boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 102 | |
| 103 | |
| 104 | Names and Spelling: |
| 105 | =================== |
| 106 | |
| 107 | The "official" name of this project is "Das U-Boot". The spelling |
| 108 | "U-Boot" shall be used in all written text (documentation, comments |
| 109 | in source files etc.). Example: |
| 110 | |
| 111 | This is the README file for the U-Boot project. |
| 112 | |
| 113 | File names etc. shall be based on the string "u-boot". Examples: |
| 114 | |
| 115 | include/asm-ppc/u-boot.h |
| 116 | |
| 117 | #include <asm/u-boot.h> |
| 118 | |
| 119 | Variable names, preprocessor constants etc. shall be either based on |
| 120 | the string "u_boot" or on "U_BOOT". Example: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 121 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 122 | U_BOOT_VERSION u_boot_logo |
| 123 | IH_OS_U_BOOT u_boot_hush_start |
| 124 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 125 | |
wdenk | 7474aca | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 126 | Versioning: |
| 127 | =========== |
| 128 | |
Thomas Weber | e89e628 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 129 | Starting with the release in October 2008, the names of the releases |
| 130 | were changed from numerical release numbers without deeper meaning |
| 131 | into a time stamp based numbering. Regular releases are identified by |
| 132 | names consisting of the calendar year and month of the release date. |
| 133 | Additional fields (if present) indicate release candidates or bug fix |
| 134 | releases in "stable" maintenance trees. |
wdenk | 7474aca | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 135 | |
Thomas Weber | e89e628 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 136 | Examples: |
| 137 | U-Boot v2009.11 - Release November 2009 |
| 138 | U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree |
| 139 | U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release |
wdenk | 7474aca | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 140 | |
| 141 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 142 | Directory Hierarchy: |
| 143 | ==================== |
| 144 | |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 145 | /arch Architecture specific files |
| 146 | /arm Files generic to ARM architecture |
| 147 | /cpu CPU specific files |
| 148 | /arm720t Files specific to ARM 720 CPUs |
| 149 | /arm920t Files specific to ARM 920 CPUs |
Andreas Bießmann | d9a9d56 | 2011-07-18 09:41:08 +0000 | [diff] [blame] | 150 | /at91 Files specific to Atmel AT91RM9200 CPU |
Wolfgang Denk | 16fa98a | 2010-06-13 17:48:15 +0200 | [diff] [blame] | 151 | /imx Files specific to Freescale MC9328 i.MX CPUs |
| 152 | /s3c24x0 Files specific to Samsung S3C24X0 CPUs |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 153 | /arm925t Files specific to ARM 925 CPUs |
| 154 | /arm926ejs Files specific to ARM 926 CPUs |
| 155 | /arm1136 Files specific to ARM 1136 CPUs |
| 156 | /ixp Files specific to Intel XScale IXP CPUs |
| 157 | /pxa Files specific to Intel XScale PXA CPUs |
| 158 | /s3c44b0 Files specific to Samsung S3C44B0 CPUs |
| 159 | /sa1100 Files specific to Intel StrongARM SA1100 CPUs |
| 160 | /lib Architecture specific library files |
| 161 | /avr32 Files generic to AVR32 architecture |
| 162 | /cpu CPU specific files |
| 163 | /lib Architecture specific library files |
| 164 | /blackfin Files generic to Analog Devices Blackfin architecture |
| 165 | /cpu CPU specific files |
| 166 | /lib Architecture specific library files |
Graeme Russ | cbfce1d | 2011-04-13 19:43:28 +1000 | [diff] [blame] | 167 | /x86 Files generic to x86 architecture |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 168 | /cpu CPU specific files |
| 169 | /lib Architecture specific library files |
| 170 | /m68k Files generic to m68k architecture |
| 171 | /cpu CPU specific files |
| 172 | /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs |
| 173 | /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs |
| 174 | /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs |
| 175 | /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs |
| 176 | /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs |
| 177 | /lib Architecture specific library files |
| 178 | /microblaze Files generic to microblaze architecture |
| 179 | /cpu CPU specific files |
| 180 | /lib Architecture specific library files |
| 181 | /mips Files generic to MIPS architecture |
| 182 | /cpu CPU specific files |
Daniel Schwierzeck | d52a623 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 183 | /mips32 Files specific to MIPS32 CPUs |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 184 | /lib Architecture specific library files |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 185 | /nios2 Files generic to Altera NIOS2 architecture |
| 186 | /cpu CPU specific files |
| 187 | /lib Architecture specific library files |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 188 | /powerpc Files generic to PowerPC architecture |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 189 | /cpu CPU specific files |
| 190 | /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs |
| 191 | /mpc5xx Files specific to Freescale MPC5xx CPUs |
| 192 | /mpc5xxx Files specific to Freescale MPC5xxx CPUs |
| 193 | /mpc8xx Files specific to Freescale MPC8xx CPUs |
| 194 | /mpc8220 Files specific to Freescale MPC8220 CPUs |
| 195 | /mpc824x Files specific to Freescale MPC824x CPUs |
| 196 | /mpc8260 Files specific to Freescale MPC8260 CPUs |
| 197 | /mpc85xx Files specific to Freescale MPC85xx CPUs |
| 198 | /ppc4xx Files specific to AMCC PowerPC 4xx CPUs |
| 199 | /lib Architecture specific library files |
| 200 | /sh Files generic to SH architecture |
| 201 | /cpu CPU specific files |
| 202 | /sh2 Files specific to sh2 CPUs |
| 203 | /sh3 Files specific to sh3 CPUs |
| 204 | /sh4 Files specific to sh4 CPUs |
| 205 | /lib Architecture specific library files |
| 206 | /sparc Files generic to SPARC architecture |
| 207 | /cpu CPU specific files |
| 208 | /leon2 Files specific to Gaisler LEON2 SPARC CPU |
| 209 | /leon3 Files specific to Gaisler LEON3 SPARC CPU |
| 210 | /lib Architecture specific library files |
| 211 | /api Machine/arch independent API for external apps |
| 212 | /board Board dependent files |
| 213 | /common Misc architecture independent functions |
| 214 | /disk Code for disk drive partition handling |
| 215 | /doc Documentation (don't expect too much) |
| 216 | /drivers Commonly used device drivers |
| 217 | /examples Example code for standalone applications, etc. |
| 218 | /fs Filesystem code (cramfs, ext2, jffs2, etc.) |
| 219 | /include Header Files |
| 220 | /lib Files generic to all architectures |
| 221 | /libfdt Library files to support flattened device trees |
| 222 | /lzma Library files to support LZMA decompression |
| 223 | /lzo Library files to support LZO decompression |
| 224 | /net Networking code |
| 225 | /post Power On Self Test |
| 226 | /rtc Real Time Clock drivers |
| 227 | /tools Tools to build S-Record or U-Boot images, etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 228 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 229 | Software Configuration: |
| 230 | ======================= |
| 231 | |
| 232 | Configuration is usually done using C preprocessor defines; the |
| 233 | rationale behind that is to avoid dead code whenever possible. |
| 234 | |
| 235 | There are two classes of configuration variables: |
| 236 | |
| 237 | * Configuration _OPTIONS_: |
| 238 | These are selectable by the user and have names beginning with |
| 239 | "CONFIG_". |
| 240 | |
| 241 | * Configuration _SETTINGS_: |
| 242 | These depend on the hardware etc. and should not be meddled with if |
| 243 | you don't know what you're doing; they have names beginning with |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 244 | "CONFIG_SYS_". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 245 | |
| 246 | Later we will add a configuration tool - probably similar to or even |
| 247 | identical to what's used for the Linux kernel. Right now, we have to |
| 248 | do the configuration by hand, which means creating some symbolic |
| 249 | links and editing some configuration files. We use the TQM8xxL boards |
| 250 | as an example here. |
| 251 | |
| 252 | |
| 253 | Selection of Processor Architecture and Board Type: |
| 254 | --------------------------------------------------- |
| 255 | |
| 256 | For all supported boards there are ready-to-use default |
| 257 | configurations available; just type "make <board_name>_config". |
| 258 | |
| 259 | Example: For a TQM823L module type: |
| 260 | |
| 261 | cd u-boot |
| 262 | make TQM823L_config |
| 263 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 264 | For the Cogent platform, you need to specify the CPU type as well; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 265 | e.g. "make cogent_mpc8xx_config". And also configure the cogent |
| 266 | directory according to the instructions in cogent/README. |
| 267 | |
| 268 | |
| 269 | Configuration Options: |
| 270 | ---------------------- |
| 271 | |
| 272 | Configuration depends on the combination of board and CPU type; all |
| 273 | such information is kept in a configuration file |
| 274 | "include/configs/<board_name>.h". |
| 275 | |
| 276 | Example: For a TQM823L module, all configuration settings are in |
| 277 | "include/configs/TQM823L.h". |
| 278 | |
| 279 | |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 280 | Many of the options are named exactly as the corresponding Linux |
| 281 | kernel configuration options. The intention is to make it easier to |
| 282 | build a config tool - later. |
| 283 | |
| 284 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 285 | The following options need to be configured: |
| 286 | |
Kim Phillips | 203fee3 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 287 | - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 288 | |
Kim Phillips | 203fee3 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 289 | - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. |
Wolfgang Denk | 994ad96 | 2006-10-24 14:42:37 +0200 | [diff] [blame] | 290 | |
| 291 | - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) |
Haavard Skinnemoen | 9d5a43f | 2007-11-01 12:44:20 +0100 | [diff] [blame] | 292 | Define exactly one, e.g. CONFIG_ATSTK1002 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 293 | |
| 294 | - CPU Module Type: (if CONFIG_COGENT is defined) |
| 295 | Define exactly one of |
| 296 | CONFIG_CMA286_60_OLD |
| 297 | --- FIXME --- not tested yet: |
| 298 | CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, |
| 299 | CONFIG_CMA287_23, CONFIG_CMA287_50 |
| 300 | |
| 301 | - Motherboard Type: (if CONFIG_COGENT is defined) |
| 302 | Define exactly one of |
| 303 | CONFIG_CMA101, CONFIG_CMA102 |
| 304 | |
| 305 | - Motherboard I/O Modules: (if CONFIG_COGENT is defined) |
| 306 | Define one or more of |
| 307 | CONFIG_CMA302 |
| 308 | |
| 309 | - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) |
| 310 | Define one or more of |
| 311 | CONFIG_LCD_HEARTBEAT - update a character position on |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 312 | the LCD display every second with |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 313 | a "rotator" |\-/|\-/ |
| 314 | |
wdenk | 2bb1105 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 315 | - Board flavour: (if CONFIG_MPC8260ADS is defined) |
| 316 | CONFIG_ADSTYPE |
| 317 | Possible values are: |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 318 | CONFIG_SYS_8260ADS - original MPC8260ADS |
| 319 | CONFIG_SYS_8266ADS - MPC8266ADS |
| 320 | CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR |
| 321 | CONFIG_SYS_8272ADS - MPC8272ADS |
wdenk | 2bb1105 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 322 | |
Lei Wen | 2001476 | 2011-02-09 18:06:58 +0530 | [diff] [blame] | 323 | - Marvell Family Member |
| 324 | CONFIG_SYS_MVFS - define it if you want to enable |
| 325 | multiple fs option at one time |
| 326 | for marvell soc family |
| 327 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 328 | - MPC824X Family Member (if CONFIG_MPC824X is defined) |
wdenk | 9b7f384 | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 329 | Define exactly one of |
| 330 | CONFIG_MPC8240, CONFIG_MPC8245 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 331 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 332 | - 8xx CPU Options: (if using an MPC8xx CPU) |
wdenk | 20bddb3 | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 333 | CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if |
| 334 | get_gclk_freq() cannot work |
wdenk | 9b7f384 | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 335 | e.g. if there is no 32KHz |
| 336 | reference PIT/RTC clock |
wdenk | 20bddb3 | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 337 | CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK |
| 338 | or XTAL/EXTAL) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 339 | |
wdenk | 20bddb3 | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 340 | - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 341 | CONFIG_SYS_8xx_CPUCLK_MIN |
| 342 | CONFIG_SYS_8xx_CPUCLK_MAX |
wdenk | 20bddb3 | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 343 | CONFIG_8xx_CPUCLK_DEFAULT |
wdenk | fde3704 | 2004-01-31 20:06:54 +0000 | [diff] [blame] | 344 | See doc/README.MPC866 |
| 345 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 346 | CONFIG_SYS_MEASURE_CPUCLK |
wdenk | fde3704 | 2004-01-31 20:06:54 +0000 | [diff] [blame] | 347 | |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 348 | Define this to measure the actual CPU clock instead |
| 349 | of relying on the correctness of the configured |
| 350 | values. Mostly useful for board bringup to make sure |
| 351 | the PLL is locked at the intended frequency. Note |
| 352 | that this requires a (stable) reference clock (32 kHz |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 353 | RTC clock or CONFIG_SYS_8XX_XIN) |
wdenk | fde3704 | 2004-01-31 20:06:54 +0000 | [diff] [blame] | 354 | |
Heiko Schocher | 734f027 | 2009-03-12 07:37:15 +0100 | [diff] [blame] | 355 | CONFIG_SYS_DELAYED_ICACHE |
| 356 | |
| 357 | Define this option if you want to enable the |
| 358 | ICache only when Code runs from RAM. |
| 359 | |
Kumar Gala | f4fb90f | 2011-02-18 05:40:54 -0600 | [diff] [blame] | 360 | - 85xx CPU Options: |
| 361 | CONFIG_SYS_FSL_TBCLK_DIV |
| 362 | |
| 363 | Defines the core time base clock divider ratio compared to the |
| 364 | system clock. On most PQ3 devices this is 8, on newer QorIQ |
| 365 | devices it can be 16 or 32. The ratio varies from SoC to Soc. |
| 366 | |
Kumar Gala | 179b1b2 | 2011-05-20 00:39:21 -0500 | [diff] [blame] | 367 | CONFIG_SYS_FSL_PCIE_COMPAT |
| 368 | |
| 369 | Defines the string to utilize when trying to match PCIe device |
| 370 | tree nodes for the given platform. |
| 371 | |
Markus Klotzbuecher | 6e5c19a | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 372 | - Intel Monahans options: |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 373 | CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO |
Markus Klotzbuecher | 6e5c19a | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 374 | |
| 375 | Defines the Monahans run mode to oscillator |
| 376 | ratio. Valid values are 8, 16, 24, 31. The core |
| 377 | frequency is this value multiplied by 13 MHz. |
| 378 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 379 | CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO |
Wolfgang Denk | ebd3deb | 2006-04-16 10:51:58 +0200 | [diff] [blame] | 380 | |
Markus Klotzbuecher | 6e5c19a | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 381 | Defines the Monahans turbo mode to oscillator |
| 382 | ratio. Valid values are 1 (default if undefined) and |
Wolfgang Denk | ebd3deb | 2006-04-16 10:51:58 +0200 | [diff] [blame] | 383 | 2. The core frequency as calculated above is multiplied |
Markus Klotzbuecher | 6e5c19a | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 384 | by this value. |
Wolfgang Denk | ebd3deb | 2006-04-16 10:51:58 +0200 | [diff] [blame] | 385 | |
Daniel Schwierzeck | d52a623 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 386 | - MIPS CPU options: |
| 387 | CONFIG_SYS_INIT_SP_OFFSET |
| 388 | |
| 389 | Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack |
| 390 | pointer. This is needed for the temporary stack before |
| 391 | relocation. |
| 392 | |
| 393 | CONFIG_SYS_MIPS_CACHE_MODE |
| 394 | |
| 395 | Cache operation mode for the MIPS CPU. |
| 396 | See also arch/mips/include/asm/mipsregs.h. |
| 397 | Possible values are: |
| 398 | CONF_CM_CACHABLE_NO_WA |
| 399 | CONF_CM_CACHABLE_WA |
| 400 | CONF_CM_UNCACHED |
| 401 | CONF_CM_CACHABLE_NONCOHERENT |
| 402 | CONF_CM_CACHABLE_CE |
| 403 | CONF_CM_CACHABLE_COW |
| 404 | CONF_CM_CACHABLE_CUW |
| 405 | CONF_CM_CACHABLE_ACCELERATED |
| 406 | |
| 407 | CONFIG_SYS_XWAY_EBU_BOOTCFG |
| 408 | |
| 409 | Special option for Lantiq XWAY SoCs for booting from NOR flash. |
| 410 | See also arch/mips/cpu/mips32/start.S. |
| 411 | |
| 412 | CONFIG_XWAY_SWAP_BYTES |
| 413 | |
| 414 | Enable compilation of tools/xway-swap-bytes needed for Lantiq |
| 415 | XWAY SoCs for booting from NOR flash. The U-Boot image needs to |
| 416 | be swapped if a flash programmer is used. |
| 417 | |
wdenk | 9b7f384 | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 418 | - Linux Kernel Interface: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 419 | CONFIG_CLOCKS_IN_MHZ |
| 420 | |
| 421 | U-Boot stores all clock information in Hz |
| 422 | internally. For binary compatibility with older Linux |
| 423 | kernels (which expect the clocks passed in the |
| 424 | bd_info data to be in MHz) the environment variable |
| 425 | "clocks_in_mhz" can be defined so that U-Boot |
| 426 | converts clock data to MHZ before passing it to the |
| 427 | Linux kernel. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 428 | When CONFIG_CLOCKS_IN_MHZ is defined, a definition of |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 429 | "clocks_in_mhz=1" is automatically included in the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 430 | default environment. |
| 431 | |
wdenk | 9b7f384 | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 432 | CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] |
| 433 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 434 | When transferring memsize parameter to linux, some versions |
wdenk | 9b7f384 | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 435 | expect it to be in bytes, others in MB. |
| 436 | Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. |
| 437 | |
Gerald Van Baren | fcd91bb | 2008-06-03 20:34:45 -0400 | [diff] [blame] | 438 | CONFIG_OF_LIBFDT |
Wolfgang Denk | 27a5b0b | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 439 | |
| 440 | New kernel versions are expecting firmware settings to be |
Gerald Van Baren | d6abef4 | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 441 | passed using flattened device trees (based on open firmware |
| 442 | concepts). |
| 443 | |
| 444 | CONFIG_OF_LIBFDT |
| 445 | * New libfdt-based support |
| 446 | * Adds the "fdt" command |
Kim Phillips | 9b46eb6 | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 447 | * The bootm command automatically updates the fdt |
Gerald Van Baren | d6abef4 | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 448 | |
Marcel Ziswiler | b29bc71 | 2009-09-09 21:18:41 +0200 | [diff] [blame] | 449 | OF_CPU - The proper name of the cpus node (only required for |
| 450 | MPC512X and MPC5xxx based boards). |
| 451 | OF_SOC - The proper name of the soc node (only required for |
| 452 | MPC512X and MPC5xxx based boards). |
Wolfgang Denk | 27a5b0b | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 453 | OF_TBCLK - The timebase frequency. |
Kumar Gala | e40c2b5 | 2006-01-11 13:59:02 -0600 | [diff] [blame] | 454 | OF_STDOUT_PATH - The path to the console device |
Wolfgang Denk | 27a5b0b | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 455 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 456 | boards with QUICC Engines require OF_QE to set UCC MAC |
| 457 | addresses |
Kim Phillips | 9b46eb6 | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 458 | |
Kumar Gala | 1e26aa5 | 2006-01-11 13:54:17 -0600 | [diff] [blame] | 459 | CONFIG_OF_BOARD_SETUP |
| 460 | |
| 461 | Board code has addition modification that it wants to make |
| 462 | to the flat device tree before handing it off to the kernel |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 463 | |
Matthew McClintock | efae4ca | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 464 | CONFIG_OF_BOOT_CPU |
| 465 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 466 | This define fills in the correct boot CPU in the boot |
Matthew McClintock | efae4ca | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 467 | param header, the default value is zero if undefined. |
| 468 | |
Heiko Schocher | ffb293a | 2009-09-23 07:56:08 +0200 | [diff] [blame] | 469 | CONFIG_OF_IDE_FIXUP |
| 470 | |
| 471 | U-Boot can detect if an IDE device is present or not. |
| 472 | If not, and this new config option is activated, U-Boot |
| 473 | removes the ATA node from the DTS before booting Linux, |
| 474 | so the Linux IDE driver does not probe the device and |
| 475 | crash. This is needed for buggy hardware (uc101) where |
| 476 | no pull down resistor is connected to the signal IDE5V_DD7. |
| 477 | |
Igor Grinberg | 0689067 | 2011-07-14 05:45:07 +0000 | [diff] [blame] | 478 | CONFIG_MACH_TYPE [relevant for ARM only][mandatory] |
| 479 | |
| 480 | This setting is mandatory for all boards that have only one |
| 481 | machine type and must be used to specify the machine type |
| 482 | number as it appears in the ARM machine registry |
| 483 | (see http://www.arm.linux.org.uk/developer/machines/). |
| 484 | Only boards that have multiple machine types supported |
| 485 | in a single configuration file and the machine type is |
| 486 | runtime discoverable, do not have to use this setting. |
| 487 | |
Niklaus Giger | 0ab978d | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 488 | - vxWorks boot parameters: |
| 489 | |
| 490 | bootvx constructs a valid bootline using the following |
| 491 | environments variables: bootfile, ipaddr, serverip, hostname. |
| 492 | It loads the vxWorks image pointed bootfile. |
| 493 | |
| 494 | CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name |
| 495 | CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address |
| 496 | CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server |
| 497 | CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters |
| 498 | |
| 499 | CONFIG_SYS_VXWORKS_ADD_PARAMS |
| 500 | |
| 501 | Add it at the end of the bootline. E.g "u=username pw=secret" |
| 502 | |
| 503 | Note: If a "bootargs" environment is defined, it will overwride |
| 504 | the defaults discussed just above. |
| 505 | |
Aneesh V | 960f5c0 | 2011-06-16 23:30:47 +0000 | [diff] [blame] | 506 | - Cache Configuration: |
| 507 | CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot |
| 508 | CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot |
| 509 | CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot |
| 510 | |
Aneesh V | 686a075 | 2011-06-16 23:30:51 +0000 | [diff] [blame] | 511 | - Cache Configuration for ARM: |
| 512 | CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache |
| 513 | controller |
| 514 | CONFIG_SYS_PL310_BASE - Physical base address of PL310 |
| 515 | controller register space |
| 516 | |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 517 | - Serial Ports: |
Andreas Engel | 0813b12 | 2008-09-08 14:30:53 +0200 | [diff] [blame] | 518 | CONFIG_PL010_SERIAL |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 519 | |
| 520 | Define this if you want support for Amba PrimeCell PL010 UARTs. |
| 521 | |
Andreas Engel | 0813b12 | 2008-09-08 14:30:53 +0200 | [diff] [blame] | 522 | CONFIG_PL011_SERIAL |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 523 | |
| 524 | Define this if you want support for Amba PrimeCell PL011 UARTs. |
| 525 | |
| 526 | CONFIG_PL011_CLOCK |
| 527 | |
| 528 | If you have Amba PrimeCell PL011 UARTs, set this variable to |
| 529 | the clock speed of the UARTs. |
| 530 | |
| 531 | CONFIG_PL01x_PORTS |
| 532 | |
| 533 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, |
| 534 | define this to a list of base addresses for each (supported) |
| 535 | port. See e.g. include/configs/versatile.h |
| 536 | |
John Rigby | 34e21ee | 2011-04-19 10:42:39 +0000 | [diff] [blame] | 537 | CONFIG_PL011_SERIAL_RLCR |
| 538 | |
| 539 | Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) |
| 540 | have separate receive and transmit line control registers. Set |
| 541 | this variable to initialize the extra register. |
| 542 | |
| 543 | CONFIG_PL011_SERIAL_FLUSH_ON_INIT |
| 544 | |
| 545 | On some platforms (e.g. U8500) U-Boot is loaded by a second stage |
| 546 | boot loader that has already initialized the UART. Define this |
| 547 | variable to flush the UART at init time. |
| 548 | |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 549 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 550 | - Console Interface: |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 551 | Depending on board, define exactly one serial port |
| 552 | (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, |
| 553 | CONFIG_8xx_CONS_SCC1, ...), or switch off the serial |
| 554 | console by defining CONFIG_8xx_CONS_NONE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 555 | |
| 556 | Note: if CONFIG_8xx_CONS_NONE is defined, the serial |
| 557 | port routines must be defined elsewhere |
| 558 | (i.e. serial_init(), serial_getc(), ...) |
| 559 | |
| 560 | CONFIG_CFB_CONSOLE |
| 561 | Enables console device for a color framebuffer. Needs following |
| 562 | defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) |
| 563 | VIDEO_FB_LITTLE_ENDIAN graphic memory organisation |
| 564 | (default big endian) |
| 565 | VIDEO_HW_RECTFILL graphic chip supports |
| 566 | rectangle fill |
| 567 | (cf. smiLynxEM) |
| 568 | VIDEO_HW_BITBLT graphic chip supports |
| 569 | bit-blit (cf. smiLynxEM) |
| 570 | VIDEO_VISIBLE_COLS visible pixel columns |
| 571 | (cols=pitch) |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 572 | VIDEO_VISIBLE_ROWS visible pixel rows |
| 573 | VIDEO_PIXEL_SIZE bytes per pixel |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 574 | VIDEO_DATA_FORMAT graphic data format |
| 575 | (0-5, cf. cfb_console.c) |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 576 | VIDEO_FB_ADRS framebuffer address |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 577 | VIDEO_KBD_INIT_FCT keyboard int fct |
| 578 | (i.e. i8042_kbd_init()) |
| 579 | VIDEO_TSTC_FCT test char fct |
| 580 | (i.e. i8042_tstc) |
| 581 | VIDEO_GETC_FCT get char fct |
| 582 | (i.e. i8042_getc) |
| 583 | CONFIG_CONSOLE_CURSOR cursor drawing on/off |
| 584 | (requires blink timer |
| 585 | cf. i8042.c) |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 586 | CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 587 | CONFIG_CONSOLE_TIME display time/date info in |
| 588 | upper right corner |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 589 | (requires CONFIG_CMD_DATE) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 590 | CONFIG_VIDEO_LOGO display Linux logo in |
| 591 | upper left corner |
wdenk | 9dd2b88 | 2002-12-03 21:28:10 +0000 | [diff] [blame] | 592 | CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of |
| 593 | linux_logo.h for logo. |
| 594 | Requires CONFIG_VIDEO_LOGO |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 595 | CONFIG_CONSOLE_EXTRA_INFO |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 596 | additional board info beside |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 597 | the logo |
| 598 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 599 | When CONFIG_CFB_CONSOLE is defined, video console is |
| 600 | default i/o. Serial console can be forced with |
| 601 | environment 'console=serial'. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 602 | |
wdenk | 1ebf41e | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 603 | When CONFIG_SILENT_CONSOLE is defined, all console |
| 604 | messages (by U-Boot and Linux!) can be silenced with |
| 605 | the "silent" environment variable. See |
| 606 | doc/README.silent for more information. |
wdenk | 3da587e | 2003-10-19 23:22:11 +0000 | [diff] [blame] | 607 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 608 | - Console Baudrate: |
| 609 | CONFIG_BAUDRATE - in bps |
| 610 | Select one of the baudrates listed in |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 611 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
| 612 | CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 613 | |
Heiko Schocher | 327480a | 2009-01-30 12:55:38 +0100 | [diff] [blame] | 614 | - Console Rx buffer length |
| 615 | With CONFIG_SYS_SMC_RXBUFLEN it is possible to define |
| 616 | the maximum receive buffer length for the SMC. |
Heiko Schocher | 362447f | 2009-02-10 09:31:47 +0100 | [diff] [blame] | 617 | This option is actual only for 82xx and 8xx possible. |
Heiko Schocher | 327480a | 2009-01-30 12:55:38 +0100 | [diff] [blame] | 618 | If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE |
| 619 | must be defined, to setup the maximum idle timeout for |
| 620 | the SMC. |
| 621 | |
Graeme Russ | 3c28f48 | 2011-09-01 00:48:27 +0000 | [diff] [blame^] | 622 | - Pre-Console Buffer: |
| 623 | Prior to the console being initialised (i.e. serial UART |
| 624 | initialised etc) all console output is silently discarded. |
| 625 | Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to |
| 626 | buffer any console messages prior to the console being |
| 627 | initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ |
| 628 | bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is |
| 629 | a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ |
| 630 | bytes are output before the console is initialised, the |
| 631 | earlier bytes are discarded. |
| 632 | |
| 633 | 'Sane' compilers will generate smaller code if |
| 634 | CONFIG_PRE_CON_BUF_SZ is a power of 2 |
| 635 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 636 | - Boot Delay: CONFIG_BOOTDELAY - in seconds |
| 637 | Delay before automatically booting the default image; |
| 638 | set to -1 to disable autoboot. |
| 639 | |
| 640 | See doc/README.autoboot for these options that |
| 641 | work with CONFIG_BOOTDELAY. None are required. |
| 642 | CONFIG_BOOT_RETRY_TIME |
| 643 | CONFIG_BOOT_RETRY_MIN |
| 644 | CONFIG_AUTOBOOT_KEYED |
| 645 | CONFIG_AUTOBOOT_PROMPT |
| 646 | CONFIG_AUTOBOOT_DELAY_STR |
| 647 | CONFIG_AUTOBOOT_STOP_STR |
| 648 | CONFIG_AUTOBOOT_DELAY_STR2 |
| 649 | CONFIG_AUTOBOOT_STOP_STR2 |
| 650 | CONFIG_ZERO_BOOTDELAY_CHECK |
| 651 | CONFIG_RESET_TO_RETRY |
| 652 | |
| 653 | - Autoboot Command: |
| 654 | CONFIG_BOOTCOMMAND |
| 655 | Only needed when CONFIG_BOOTDELAY is enabled; |
| 656 | define a command string that is automatically executed |
| 657 | when no character is read on the console interface |
| 658 | within "Boot Delay" after reset. |
| 659 | |
| 660 | CONFIG_BOOTARGS |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 661 | This can be used to pass arguments to the bootm |
| 662 | command. The value of CONFIG_BOOTARGS goes into the |
| 663 | environment value "bootargs". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 664 | |
| 665 | CONFIG_RAMBOOT and CONFIG_NFSBOOT |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 666 | The value of these goes into the environment as |
| 667 | "ramboot" and "nfsboot" respectively, and can be used |
| 668 | as a convenience, when switching between booting from |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 669 | RAM and NFS. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 670 | |
| 671 | - Pre-Boot Commands: |
| 672 | CONFIG_PREBOOT |
| 673 | |
| 674 | When this option is #defined, the existence of the |
| 675 | environment variable "preboot" will be checked |
| 676 | immediately before starting the CONFIG_BOOTDELAY |
| 677 | countdown and/or running the auto-boot command resp. |
| 678 | entering interactive mode. |
| 679 | |
| 680 | This feature is especially useful when "preboot" is |
| 681 | automatically generated or modified. For an example |
| 682 | see the LWMON board specific code: here "preboot" is |
| 683 | modified when the user holds down a certain |
| 684 | combination of keys on the (special) keyboard when |
| 685 | booting the systems |
| 686 | |
| 687 | - Serial Download Echo Mode: |
| 688 | CONFIG_LOADS_ECHO |
| 689 | If defined to 1, all characters received during a |
| 690 | serial download (using the "loads" command) are |
| 691 | echoed back. This might be needed by some terminal |
| 692 | emulations (like "cu"), but may as well just take |
| 693 | time on others. This setting #define's the initial |
| 694 | value of the "loads_echo" environment variable. |
| 695 | |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 696 | - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 697 | CONFIG_KGDB_BAUDRATE |
| 698 | Select one of the baudrates listed in |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 699 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 700 | |
| 701 | - Monitor Functions: |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 702 | Monitor commands can be included or excluded |
| 703 | from the build by using the #include files |
| 704 | "config_cmd_all.h" and #undef'ing unwanted |
| 705 | commands, or using "config_cmd_default.h" |
| 706 | and augmenting with additional #define's |
| 707 | for wanted commands. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 708 | |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 709 | The default command configuration includes all commands |
| 710 | except those marked below with a "*". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 711 | |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 712 | CONFIG_CMD_ASKENV * ask for env variable |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 713 | CONFIG_CMD_BDI bdinfo |
| 714 | CONFIG_CMD_BEDBUG * Include BedBug Debugger |
| 715 | CONFIG_CMD_BMP * BMP support |
| 716 | CONFIG_CMD_BSP * Board specific commands |
| 717 | CONFIG_CMD_BOOTD bootd |
| 718 | CONFIG_CMD_CACHE * icache, dcache |
| 719 | CONFIG_CMD_CONSOLE coninfo |
Mike Frysinger | 321ab9e | 2010-12-21 14:19:51 -0500 | [diff] [blame] | 720 | CONFIG_CMD_CRC32 * crc32 |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 721 | CONFIG_CMD_DATE * support for RTC, date/time... |
| 722 | CONFIG_CMD_DHCP * DHCP support |
| 723 | CONFIG_CMD_DIAG * Diagnostics |
Peter Tyser | 1525804 | 2008-12-17 16:36:22 -0600 | [diff] [blame] | 724 | CONFIG_CMD_DS4510 * ds4510 I2C gpio commands |
| 725 | CONFIG_CMD_DS4510_INFO * ds4510 I2C info command |
| 726 | CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd |
| 727 | CONFIG_CMD_DS4510_RST * ds4510 I2C rst command |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 728 | CONFIG_CMD_DTT * Digital Therm and Thermostat |
| 729 | CONFIG_CMD_ECHO echo arguments |
Peter Tyser | 0deafa2 | 2009-10-25 15:12:56 -0500 | [diff] [blame] | 730 | CONFIG_CMD_EDITENV edit env variable |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 731 | CONFIG_CMD_EEPROM * EEPROM read/write support |
| 732 | CONFIG_CMD_ELF * bootelf, bootvx |
Mike Frysinger | f3ddf20 | 2010-12-26 23:09:45 -0500 | [diff] [blame] | 733 | CONFIG_CMD_EXPORTENV * export the environment |
Mike Frysinger | 78dcaf4 | 2009-01-28 19:08:14 -0500 | [diff] [blame] | 734 | CONFIG_CMD_SAVEENV saveenv |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 735 | CONFIG_CMD_FDC * Floppy Disk Support |
| 736 | CONFIG_CMD_FAT * FAT partition support |
| 737 | CONFIG_CMD_FDOS * Dos diskette Support |
| 738 | CONFIG_CMD_FLASH flinfo, erase, protect |
| 739 | CONFIG_CMD_FPGA FPGA device initialization support |
Mike Frysinger | 2ed0241 | 2010-12-26 23:32:22 -0500 | [diff] [blame] | 740 | CONFIG_CMD_GO * the 'go' command (exec code) |
Kim Phillips | f0c9d53 | 2011-04-05 07:15:14 +0000 | [diff] [blame] | 741 | CONFIG_CMD_GREPENV * search environment |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 742 | CONFIG_CMD_HWFLOW * RTS/CTS hw flow control |
| 743 | CONFIG_CMD_I2C * I2C serial bus support |
| 744 | CONFIG_CMD_IDE * IDE harddisk support |
| 745 | CONFIG_CMD_IMI iminfo |
| 746 | CONFIG_CMD_IMLS List all found images |
| 747 | CONFIG_CMD_IMMAP * IMMR dump support |
Mike Frysinger | f3ddf20 | 2010-12-26 23:09:45 -0500 | [diff] [blame] | 748 | CONFIG_CMD_IMPORTENV * import an environment |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 749 | CONFIG_CMD_IRQ * irqinfo |
| 750 | CONFIG_CMD_ITEST Integer/string test of 2 values |
| 751 | CONFIG_CMD_JFFS2 * JFFS2 Support |
| 752 | CONFIG_CMD_KGDB * kgdb |
Mike Frysinger | fc6508a | 2010-12-26 12:34:49 -0500 | [diff] [blame] | 753 | CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 754 | CONFIG_CMD_LOADB loadb |
| 755 | CONFIG_CMD_LOADS loads |
Robin Getz | 93d6cb0 | 2009-07-27 00:07:59 -0400 | [diff] [blame] | 756 | CONFIG_CMD_MD5SUM print md5 message digest |
| 757 | (requires CONFIG_CMD_MEMORY and CONFIG_MD5) |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 758 | CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, |
| 759 | loop, loopw, mtest |
| 760 | CONFIG_CMD_MISC Misc functions like sleep etc |
| 761 | CONFIG_CMD_MMC * MMC memory mapped support |
| 762 | CONFIG_CMD_MII * MII utility commands |
Stefan Roese | b1423dd | 2009-03-19 13:30:36 +0100 | [diff] [blame] | 763 | CONFIG_CMD_MTDPARTS * MTD partition support |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 764 | CONFIG_CMD_NAND * NAND support |
| 765 | CONFIG_CMD_NET bootp, tftpboot, rarpboot |
Peter Tyser | 9902e42 | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 766 | CONFIG_CMD_PCA953X * PCA953x I2C gpio commands |
| 767 | CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 768 | CONFIG_CMD_PCI * pciinfo |
| 769 | CONFIG_CMD_PCMCIA * PCMCIA support |
| 770 | CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network |
| 771 | host |
| 772 | CONFIG_CMD_PORTIO * Port I/O |
| 773 | CONFIG_CMD_REGINFO * Register dump |
| 774 | CONFIG_CMD_RUN run command in env variable |
| 775 | CONFIG_CMD_SAVES * save S record dump |
| 776 | CONFIG_CMD_SCSI * SCSI Support |
| 777 | CONFIG_CMD_SDRAM * print SDRAM configuration information |
| 778 | (requires CONFIG_CMD_I2C) |
| 779 | CONFIG_CMD_SETGETDCR Support for DCR Register access |
| 780 | (4xx only) |
Alexander Holler | 37ef539 | 2011-01-18 09:48:08 +0100 | [diff] [blame] | 781 | CONFIG_CMD_SHA1SUM print sha1 memory digest |
Robin Getz | 93d6cb0 | 2009-07-27 00:07:59 -0400 | [diff] [blame] | 782 | (requires CONFIG_CMD_MEMORY) |
Wolfgang Denk | 85c25df | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 783 | CONFIG_CMD_SOURCE "source" command Support |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 784 | CONFIG_CMD_SPI * SPI serial bus support |
Luca Ceresoli | 7aa81a4 | 2011-05-17 00:03:40 +0000 | [diff] [blame] | 785 | CONFIG_CMD_TFTPSRV * TFTP transfer in server mode |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 786 | CONFIG_CMD_USB * USB support |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 787 | CONFIG_CMD_CDP * Cisco Discover Protocol support |
| 788 | CONFIG_CMD_FSL * Microblaze FSL support |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 789 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 790 | |
| 791 | EXAMPLE: If you want all functions except of network |
| 792 | support you can write: |
| 793 | |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 794 | #include "config_cmd_all.h" |
| 795 | #undef CONFIG_CMD_NET |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 796 | |
Gerald Van Baren | d6abef4 | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 797 | Other Commands: |
| 798 | fdt (flattened device tree) command: CONFIG_OF_LIBFDT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 799 | |
| 800 | Note: Don't enable the "icache" and "dcache" commands |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 801 | (configuration option CONFIG_CMD_CACHE) unless you know |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 802 | what you (and your U-Boot users) are doing. Data |
| 803 | cache cannot be enabled on systems like the 8xx or |
| 804 | 8260 (where accesses to the IMMR region must be |
| 805 | uncached), and it cannot be disabled on all other |
| 806 | systems where we (mis-) use the data cache to hold an |
| 807 | initial stack and some data. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 808 | |
| 809 | |
| 810 | XXX - this list needs to get updated! |
| 811 | |
| 812 | - Watchdog: |
| 813 | CONFIG_WATCHDOG |
| 814 | If this variable is defined, it enables watchdog |
Detlev Zundel | 6aa4d7b | 2011-04-27 05:25:59 +0000 | [diff] [blame] | 815 | support for the SoC. There must be support in the SoC |
| 816 | specific code for a watchdog. For the 8xx and 8260 |
| 817 | CPUs, the SIU Watchdog feature is enabled in the SYPCR |
| 818 | register. When supported for a specific SoC is |
| 819 | available, then no further board specific code should |
| 820 | be needed to use it. |
| 821 | |
| 822 | CONFIG_HW_WATCHDOG |
| 823 | When using a watchdog circuitry external to the used |
| 824 | SoC, then define this variable and provide board |
| 825 | specific code for the "hw_watchdog_reset" function. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 826 | |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 827 | - U-Boot Version: |
| 828 | CONFIG_VERSION_VARIABLE |
| 829 | If this variable is defined, an environment variable |
| 830 | named "ver" is created by U-Boot showing the U-Boot |
| 831 | version as printed by the "version" command. |
| 832 | This variable is readonly. |
| 833 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 834 | - Real-Time Clock: |
| 835 | |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 836 | When CONFIG_CMD_DATE is selected, the type of the RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 837 | has to be selected, too. Define exactly one of the |
| 838 | following options: |
| 839 | |
| 840 | CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx |
| 841 | CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC |
Guennadi Liakhovetski | d438749 | 2008-04-15 14:15:30 +0200 | [diff] [blame] | 842 | CONFIG_RTC_MC13783 - use MC13783 RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 843 | CONFIG_RTC_MC146818 - use MC146818 RTC |
wdenk | 1fe2c70 | 2003-03-06 21:55:29 +0000 | [diff] [blame] | 844 | CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 845 | CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC |
wdenk | 0893c47 | 2003-05-20 14:25:27 +0000 | [diff] [blame] | 846 | CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC |
wdenk | ef5fe75 | 2003-03-12 10:41:04 +0000 | [diff] [blame] | 847 | CONFIG_RTC_DS164x - use Dallas DS164x RTC |
Tor Krill | b27939b | 2008-03-15 15:40:26 +0100 | [diff] [blame] | 848 | CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC |
wdenk | aeba06f | 2004-06-09 17:34:58 +0000 | [diff] [blame] | 849 | CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 850 | CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 |
Heiko Schocher | 1f1b701 | 2011-03-28 09:24:22 +0200 | [diff] [blame] | 851 | CONFIG_SYS_RV3029_TCR - enable trickle charger on |
| 852 | RV3029 RTC. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 853 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 854 | Note that if the RTC uses I2C, then the I2C interface |
| 855 | must also be configured. See I2C Support, below. |
| 856 | |
Peter Tyser | 9902e42 | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 857 | - GPIO Support: |
| 858 | CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO |
| 859 | CONFIG_PCA953X_INFO - enable pca953x info command |
| 860 | |
Chris Packham | 9b38320 | 2010-12-19 10:12:13 +0000 | [diff] [blame] | 861 | The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of |
| 862 | chip-ngpio pairs that tell the PCA953X driver the number of |
| 863 | pins supported by a particular chip. |
| 864 | |
Peter Tyser | 9902e42 | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 865 | Note that if the GPIO device uses I2C, then the I2C interface |
| 866 | must also be configured. See I2C Support, below. |
| 867 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 868 | - Timestamp Support: |
| 869 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 870 | When CONFIG_TIMESTAMP is selected, the timestamp |
| 871 | (date and time) of an image is printed by image |
| 872 | commands like bootm or iminfo. This option is |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 873 | automatically enabled when you select CONFIG_CMD_DATE . |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 874 | |
| 875 | - Partition Support: |
| 876 | CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION |
richardretanubun | e674559 | 2008-09-26 11:13:22 -0400 | [diff] [blame] | 877 | and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 878 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 879 | If IDE or SCSI support is enabled (CONFIG_CMD_IDE or |
| 880 | CONFIG_CMD_SCSI) you must configure support for at |
| 881 | least one partition type as well. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 882 | |
| 883 | - IDE Reset method: |
wdenk | 369d43d | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 884 | CONFIG_IDE_RESET_ROUTINE - this is defined in several |
| 885 | board configurations files but used nowhere! |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 886 | |
wdenk | 369d43d | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 887 | CONFIG_IDE_RESET - is this is defined, IDE Reset will |
| 888 | be performed by calling the function |
| 889 | ide_set_reset(int reset) |
| 890 | which has to be defined in a board specific file |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 891 | |
| 892 | - ATAPI Support: |
| 893 | CONFIG_ATAPI |
| 894 | |
| 895 | Set this to enable ATAPI support. |
| 896 | |
wdenk | f602aa0 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 897 | - LBA48 Support |
| 898 | CONFIG_LBA48 |
| 899 | |
| 900 | Set this to enable support for disks larger than 137GB |
Heiko Schocher | 0f602e1 | 2009-12-03 11:21:21 +0100 | [diff] [blame] | 901 | Also look at CONFIG_SYS_64BIT_LBA. |
wdenk | f602aa0 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 902 | Whithout these , LBA48 support uses 32bit variables and will 'only' |
| 903 | support disks up to 2.1TB. |
| 904 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 905 | CONFIG_SYS_64BIT_LBA: |
wdenk | f602aa0 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 906 | When enabled, makes the IDE subsystem use 64bit sector addresses. |
| 907 | Default is 32bit. |
| 908 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 909 | - SCSI Support: |
| 910 | At the moment only there is only support for the |
| 911 | SYM53C8XX SCSI controller; define |
| 912 | CONFIG_SCSI_SYM53C8XX to enable it. |
| 913 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 914 | CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and |
| 915 | CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * |
| 916 | CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 917 | maximum numbers of LUNs, SCSI ID's and target |
| 918 | devices. |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 919 | CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 920 | |
| 921 | - NETWORK Support (PCI): |
wdenk | 4e112c1 | 2003-06-03 23:54:09 +0000 | [diff] [blame] | 922 | CONFIG_E1000 |
| 923 | Support for Intel 8254x gigabit chips. |
stroese | 94ef1cf | 2003-06-05 15:39:44 +0000 | [diff] [blame] | 924 | |
Andre Schwarz | 68c2a30 | 2008-03-06 16:45:44 +0100 | [diff] [blame] | 925 | CONFIG_E1000_FALLBACK_MAC |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 926 | default MAC for empty EEPROM after production. |
Andre Schwarz | 68c2a30 | 2008-03-06 16:45:44 +0100 | [diff] [blame] | 927 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 928 | CONFIG_EEPRO100 |
| 929 | Support for Intel 82557/82559/82559ER chips. |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 930 | Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 931 | write routine for first time initialisation. |
| 932 | |
| 933 | CONFIG_TULIP |
| 934 | Support for Digital 2114x chips. |
| 935 | Optional CONFIG_TULIP_SELECT_MEDIA for board specific |
| 936 | modem chip initialisation (KS8761/QS6611). |
| 937 | |
| 938 | CONFIG_NATSEMI |
| 939 | Support for National dp83815 chips. |
| 940 | |
| 941 | CONFIG_NS8382X |
| 942 | Support for National dp8382[01] gigabit chips. |
| 943 | |
wdenk | aa60336 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 944 | - NETWORK Support (other): |
| 945 | |
Jens Scharsig | dab7cb8 | 2010-01-23 12:03:45 +0100 | [diff] [blame] | 946 | CONFIG_DRIVER_AT91EMAC |
| 947 | Support for AT91RM9200 EMAC. |
| 948 | |
| 949 | CONFIG_RMII |
| 950 | Define this to use reduced MII inteface |
| 951 | |
| 952 | CONFIG_DRIVER_AT91EMAC_QUIET |
| 953 | If this defined, the driver is quiet. |
| 954 | The driver doen't show link status messages. |
| 955 | |
wdenk | aa60336 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 956 | CONFIG_DRIVER_LAN91C96 |
| 957 | Support for SMSC's LAN91C96 chips. |
| 958 | |
| 959 | CONFIG_LAN91C96_BASE |
| 960 | Define this to hold the physical address |
| 961 | of the LAN91C96's I/O space |
| 962 | |
| 963 | CONFIG_LAN91C96_USE_32_BIT |
| 964 | Define this to enable 32 bit addressing |
| 965 | |
wdenk | 3c71176 | 2004-06-09 13:37:52 +0000 | [diff] [blame] | 966 | CONFIG_DRIVER_SMC91111 |
| 967 | Support for SMSC's LAN91C111 chip |
| 968 | |
| 969 | CONFIG_SMC91111_BASE |
| 970 | Define this to hold the physical address |
| 971 | of the device (I/O space) |
| 972 | |
| 973 | CONFIG_SMC_USE_32_BIT |
| 974 | Define this if data bus is 32 bits |
| 975 | |
| 976 | CONFIG_SMC_USE_IOFUNCS |
| 977 | Define this to use i/o functions instead of macros |
| 978 | (some hardware wont work with macros) |
| 979 | |
Macpaul Lin | 199c625 | 2010-12-21 16:59:46 +0800 | [diff] [blame] | 980 | CONFIG_FTGMAC100 |
| 981 | Support for Faraday's FTGMAC100 Gigabit SoC Ethernet |
| 982 | |
| 983 | CONFIG_FTGMAC100_EGIGA |
| 984 | Define this to use GE link update with gigabit PHY. |
| 985 | Define this if FTGMAC100 is connected to gigabit PHY. |
| 986 | If your system has 10/100 PHY only, it might not occur |
| 987 | wrong behavior. Because PHY usually return timeout or |
| 988 | useless data when polling gigabit status and gigabit |
| 989 | control registers. This behavior won't affect the |
| 990 | correctnessof 10/100 link speed update. |
| 991 | |
Mike Rapoport | f4761af | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 992 | CONFIG_SMC911X |
Jens Gehrlein | 1dd4825 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 993 | Support for SMSC's LAN911x and LAN921x chips |
| 994 | |
Mike Rapoport | f4761af | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 995 | CONFIG_SMC911X_BASE |
Jens Gehrlein | 1dd4825 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 996 | Define this to hold the physical address |
| 997 | of the device (I/O space) |
| 998 | |
Mike Rapoport | f4761af | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 999 | CONFIG_SMC911X_32_BIT |
Jens Gehrlein | 1dd4825 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1000 | Define this if data bus is 32 bits |
| 1001 | |
Mike Rapoport | f4761af | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1002 | CONFIG_SMC911X_16_BIT |
Jens Gehrlein | 1dd4825 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1003 | Define this if data bus is 16 bits. If your processor |
| 1004 | automatically converts one 32 bit word to two 16 bit |
Mike Rapoport | f4761af | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1005 | words you may also try CONFIG_SMC911X_32_BIT. |
Jens Gehrlein | 1dd4825 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1006 | |
Yoshihiro Shimoda | ed4cea0 | 2011-01-27 10:06:03 +0900 | [diff] [blame] | 1007 | CONFIG_SH_ETHER |
| 1008 | Support for Renesas on-chip Ethernet controller |
| 1009 | |
| 1010 | CONFIG_SH_ETHER_USE_PORT |
| 1011 | Define the number of ports to be used |
| 1012 | |
| 1013 | CONFIG_SH_ETHER_PHY_ADDR |
| 1014 | Define the ETH PHY's address |
| 1015 | |
Yoshihiro Shimoda | 281aa05 | 2011-01-27 10:06:08 +0900 | [diff] [blame] | 1016 | CONFIG_SH_ETHER_CACHE_WRITEBACK |
| 1017 | If this option is set, the driver enables cache flush. |
| 1018 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1019 | - USB Support: |
| 1020 | At the moment only the UHCI host controller is |
wdenk | 369d43d | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1021 | supported (PIP405, MIP405, MPC5200); define |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1022 | CONFIG_USB_UHCI to enable it. |
| 1023 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard |
wdenk | fb30b4c | 2004-10-09 22:44:59 +0000 | [diff] [blame] | 1024 | and define CONFIG_USB_STORAGE to enable the USB |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1025 | storage devices. |
| 1026 | Note: |
| 1027 | Supported are USB Keyboards and USB Floppy drives |
| 1028 | (TEAC FD-05PUB). |
wdenk | 369d43d | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1029 | MPC5200 USB requires additional defines: |
| 1030 | CONFIG_USB_CLOCK |
| 1031 | for 528 MHz Clock: 0x0001bbbb |
Eric Millbrandt | 0284852 | 2009-08-13 08:32:37 -0500 | [diff] [blame] | 1032 | CONFIG_PSC3_USB |
| 1033 | for USB on PSC3 |
wdenk | 369d43d | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1034 | CONFIG_USB_CONFIG |
| 1035 | for differential drivers: 0x00001000 |
| 1036 | for single ended drivers: 0x00005000 |
Eric Millbrandt | 0284852 | 2009-08-13 08:32:37 -0500 | [diff] [blame] | 1037 | for differential drivers on PSC3: 0x00000100 |
| 1038 | for single ended drivers on PSC3: 0x00004100 |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1039 | CONFIG_SYS_USB_EVENT_POLL |
Zhang Wei | 063f9ff | 2007-06-06 10:08:13 +0200 | [diff] [blame] | 1040 | May be defined to allow interrupt polling |
| 1041 | instead of using asynchronous interrupts |
wdenk | 369d43d | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1042 | |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1043 | - USB Device: |
| 1044 | Define the below if you wish to use the USB console. |
| 1045 | Once firmware is rebuilt from a serial console issue the |
| 1046 | command "setenv stdin usbtty; setenv stdout usbtty" and |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1047 | attach your USB cable. The Unix command "dmesg" should print |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1048 | it has found a new device. The environment variable usbtty |
| 1049 | 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] | 1050 | appear to a USB host as a Linux gserial device or a |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1051 | Common Device Class Abstract Control Model serial device. |
| 1052 | If you select usbtty = gserial you should be able to enumerate |
| 1053 | a Linux host by |
| 1054 | # modprobe usbserial vendor=0xVendorID product=0xProductID |
| 1055 | else if using cdc_acm, simply setting the environment |
| 1056 | variable usbtty to be cdc_acm should suffice. The following |
| 1057 | might be defined in YourBoardName.h |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1058 | |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1059 | CONFIG_USB_DEVICE |
| 1060 | Define this to build a UDC device |
| 1061 | |
| 1062 | CONFIG_USB_TTY |
| 1063 | Define this to have a tty type of device available to |
| 1064 | talk to the UDC device |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1065 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1066 | CONFIG_SYS_CONSOLE_IS_IN_ENV |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1067 | Define this if you want stdin, stdout &/or stderr to |
| 1068 | be set to usbtty. |
| 1069 | |
| 1070 | mpc8xx: |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1071 | CONFIG_SYS_USB_EXTC_CLK 0xBLAH |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1072 | Derive USB clock from external clock "blah" |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1073 | - CONFIG_SYS_USB_EXTC_CLK 0x02 |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1074 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1075 | CONFIG_SYS_USB_BRG_CLK 0xBLAH |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1076 | Derive USB clock from brgclk |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1077 | - CONFIG_SYS_USB_BRG_CLK 0x04 |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1078 | |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1079 | 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] | 1080 | define your own vendor specific values either in BoardName.h |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1081 | or directly in usbd_vendor_info.h. If you don't define |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1082 | CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, |
| 1083 | CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot |
| 1084 | should pretend to be a Linux device to it's target host. |
| 1085 | |
| 1086 | CONFIG_USBD_MANUFACTURER |
| 1087 | Define this string as the name of your company for |
| 1088 | - CONFIG_USBD_MANUFACTURER "my company" |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1089 | |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1090 | CONFIG_USBD_PRODUCT_NAME |
| 1091 | Define this string as the name of your product |
| 1092 | - CONFIG_USBD_PRODUCT_NAME "acme usb device" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1093 | |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1094 | CONFIG_USBD_VENDORID |
| 1095 | Define this as your assigned Vendor ID from the USB |
| 1096 | Implementors Forum. This *must* be a genuine Vendor ID |
| 1097 | to avoid polluting the USB namespace. |
| 1098 | - CONFIG_USBD_VENDORID 0xFFFF |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1099 | |
Wolfgang Denk | 3f0137b | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1100 | CONFIG_USBD_PRODUCTID |
| 1101 | Define this as the unique Product ID |
| 1102 | for your device |
| 1103 | - CONFIG_USBD_PRODUCTID 0xFFFF |
Wolfgang Denk | e260182 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1104 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1105 | |
wdenk | 7a428cc | 2003-06-15 22:40:42 +0000 | [diff] [blame] | 1106 | - MMC Support: |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1107 | The MMC controller on the Intel PXA is supported. To |
| 1108 | enable this define CONFIG_MMC. The MMC can be |
| 1109 | accessed from the boot prompt by mapping the device |
wdenk | 7a428cc | 2003-06-15 22:40:42 +0000 | [diff] [blame] | 1110 | to physical memory similar to flash. Command line is |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1111 | enabled with CONFIG_CMD_MMC. The MMC driver also works with |
| 1112 | the FAT fs. This is enabled with CONFIG_CMD_FAT. |
wdenk | 7a428cc | 2003-06-15 22:40:42 +0000 | [diff] [blame] | 1113 | |
Yoshihiro Shimoda | db7717b | 2011-07-04 22:21:22 +0000 | [diff] [blame] | 1114 | CONFIG_SH_MMCIF |
| 1115 | Support for Renesas on-chip MMCIF controller |
| 1116 | |
| 1117 | CONFIG_SH_MMCIF_ADDR |
| 1118 | Define the base address of MMCIF registers |
| 1119 | |
| 1120 | CONFIG_SH_MMCIF_CLK |
| 1121 | Define the clock frequency for MMCIF |
| 1122 | |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1123 | - Journaling Flash filesystem support: |
| 1124 | CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, |
| 1125 | CONFIG_JFFS2_NAND_DEV |
| 1126 | Define these for a default partition on a NAND device |
| 1127 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1128 | CONFIG_SYS_JFFS2_FIRST_SECTOR, |
| 1129 | CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1130 | Define these for a default partition on a NOR device |
| 1131 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1132 | CONFIG_SYS_JFFS_CUSTOM_PART |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1133 | Define this to create an own partition. You have to provide a |
| 1134 | function struct part_info* jffs2_part_info(int part_num) |
| 1135 | |
| 1136 | If you define only one JFFS2 partition you may also want to |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1137 | #define CONFIG_SYS_JFFS_SINGLE_PART 1 |
wdenk | da04a8b | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1138 | to disable the command chpart. This is the default when you |
| 1139 | have not defined a custom partition |
| 1140 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1141 | - Keyboard Support: |
| 1142 | CONFIG_ISA_KEYBOARD |
| 1143 | |
| 1144 | Define this to enable standard (PC-Style) keyboard |
| 1145 | support |
| 1146 | |
| 1147 | CONFIG_I8042_KBD |
| 1148 | Standard PC keyboard driver with US (is default) and |
| 1149 | GERMAN key layout (switch via environment 'keymap=de') support. |
| 1150 | Export function i8042_kbd_init, i8042_tstc and i8042_getc |
| 1151 | for cfb_console. Supports cursor blinking. |
| 1152 | |
| 1153 | - Video support: |
| 1154 | CONFIG_VIDEO |
| 1155 | |
| 1156 | Define this to enable video support (for output to |
| 1157 | video). |
| 1158 | |
| 1159 | CONFIG_VIDEO_CT69000 |
| 1160 | |
| 1161 | Enable Chips & Technologies 69000 Video chip |
| 1162 | |
| 1163 | CONFIG_VIDEO_SMI_LYNXEM |
wdenk | d360213 | 2004-03-25 15:14:43 +0000 | [diff] [blame] | 1164 | Enable Silicon Motion SMI 712/710/810 Video chip. The |
wdenk | aea86e4 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1165 | video output is selected via environment 'videoout' |
| 1166 | (1 = LCD and 2 = CRT). If videoout is undefined, CRT is |
| 1167 | assumed. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1168 | |
wdenk | d360213 | 2004-03-25 15:14:43 +0000 | [diff] [blame] | 1169 | For the CT69000 and SMI_LYNXEM drivers, videomode is |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1170 | selected via environment 'videomode'. Two different ways |
wdenk | aea86e4 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1171 | are possible: |
| 1172 | - "videomode=num" 'num' is a standard LiLo mode numbers. |
wdenk | 0593920 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 1173 | Following standard modes are supported (* is default): |
wdenk | aea86e4 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1174 | |
| 1175 | Colors 640x480 800x600 1024x768 1152x864 1280x1024 |
| 1176 | -------------+--------------------------------------------- |
| 1177 | 8 bits | 0x301* 0x303 0x305 0x161 0x307 |
| 1178 | 15 bits | 0x310 0x313 0x316 0x162 0x319 |
| 1179 | 16 bits | 0x311 0x314 0x317 0x163 0x31A |
| 1180 | 24 bits | 0x312 0x315 0x318 ? 0x31B |
| 1181 | -------------+--------------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1182 | (i.e. setenv videomode 317; saveenv; reset;) |
| 1183 | |
wdenk | d360213 | 2004-03-25 15:14:43 +0000 | [diff] [blame] | 1184 | - "videomode=bootargs" all the video parameters are parsed |
Marcel Ziswiler | aea6856 | 2007-12-30 03:30:46 +0100 | [diff] [blame] | 1185 | from the bootargs. (See drivers/video/videomodes.c) |
wdenk | aea86e4 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1186 | |
| 1187 | |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 1188 | CONFIG_VIDEO_SED13806 |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1189 | Enable Epson SED13806 driver. This driver supports 8bpp |
wdenk | 9dd2b88 | 2002-12-03 21:28:10 +0000 | [diff] [blame] | 1190 | and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP |
| 1191 | or CONFIG_VIDEO_SED13806_16BPP |
| 1192 | |
Timur Tabi | 020edd2 | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1193 | CONFIG_FSL_DIU_FB |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 1194 | Enable the Freescale DIU video driver. Reference boards for |
Timur Tabi | 020edd2 | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1195 | SOCs that have a DIU should define this macro to enable DIU |
| 1196 | support, and should also define these other macros: |
| 1197 | |
| 1198 | CONFIG_SYS_DIU_ADDR |
| 1199 | CONFIG_VIDEO |
| 1200 | CONFIG_CMD_BMP |
| 1201 | CONFIG_CFB_CONSOLE |
| 1202 | CONFIG_VIDEO_SW_CURSOR |
| 1203 | CONFIG_VGA_AS_SINGLE_DEVICE |
| 1204 | CONFIG_VIDEO_LOGO |
| 1205 | CONFIG_VIDEO_BMP_LOGO |
| 1206 | |
Timur Tabi | 32f709e | 2011-04-11 14:18:22 -0500 | [diff] [blame] | 1207 | The DIU driver will look for the 'video-mode' environment |
| 1208 | variable, and if defined, enable the DIU as a console during |
| 1209 | boot. See the documentation file README.video for a |
| 1210 | description of this variable. |
Timur Tabi | 020edd2 | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1211 | |
wdenk | 4e112c1 | 2003-06-03 23:54:09 +0000 | [diff] [blame] | 1212 | - Keyboard Support: |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1213 | CONFIG_KEYBOARD |
wdenk | 4e112c1 | 2003-06-03 23:54:09 +0000 | [diff] [blame] | 1214 | |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1215 | Define this to enable a custom keyboard support. |
| 1216 | This simply calls drv_keyboard_init() which must be |
| 1217 | defined in your board-specific files. |
| 1218 | The only board using this so far is RBC823. |
wdenk | 9dd2b88 | 2002-12-03 21:28:10 +0000 | [diff] [blame] | 1219 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1220 | - LCD Support: CONFIG_LCD |
| 1221 | |
| 1222 | Define this to enable LCD support (for output to LCD |
| 1223 | display); also select one of the supported displays |
| 1224 | by defining one of these: |
| 1225 | |
Stelian Pop | f6f8665 | 2008-05-09 21:57:18 +0200 | [diff] [blame] | 1226 | CONFIG_ATMEL_LCD: |
| 1227 | |
| 1228 | HITACHI TX09D70VM1CCA, 3.5", 240x320. |
| 1229 | |
wdenk | c0d54ae | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1230 | CONFIG_NEC_NL6448AC33: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1231 | |
wdenk | c0d54ae | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1232 | NEC NL6448AC33-18. Active, color, single scan. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1233 | |
wdenk | c0d54ae | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1234 | CONFIG_NEC_NL6448BC20 |
| 1235 | |
| 1236 | NEC NL6448BC20-08. 6.5", 640x480. |
| 1237 | Active, color, single scan. |
| 1238 | |
| 1239 | CONFIG_NEC_NL6448BC33_54 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1240 | |
wdenk | c0d54ae | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1241 | NEC NL6448BC33-54. 10.4", 640x480. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1242 | Active, color, single scan. |
| 1243 | |
| 1244 | CONFIG_SHARP_16x9 |
| 1245 | |
| 1246 | Sharp 320x240. Active, color, single scan. |
| 1247 | It isn't 16x9, and I am not sure what it is. |
| 1248 | |
| 1249 | CONFIG_SHARP_LQ64D341 |
| 1250 | |
| 1251 | Sharp LQ64D341 display, 640x480. |
| 1252 | Active, color, single scan. |
| 1253 | |
| 1254 | CONFIG_HLD1045 |
| 1255 | |
| 1256 | HLD1045 display, 640x480. |
| 1257 | Active, color, single scan. |
| 1258 | |
| 1259 | CONFIG_OPTREX_BW |
| 1260 | |
| 1261 | Optrex CBL50840-2 NF-FW 99 22 M5 |
| 1262 | or |
| 1263 | Hitachi LMG6912RPFC-00T |
| 1264 | or |
| 1265 | Hitachi SP14Q002 |
| 1266 | |
| 1267 | 320x240. Black & white. |
| 1268 | |
| 1269 | Normally display is black on white background; define |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1270 | CONFIG_SYS_WHITE_ON_BLACK to get it inverted. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1271 | |
wdenk | eb20ad3 | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1272 | - Splash Screen Support: CONFIG_SPLASH_SCREEN |
wdenk | 92bbe3f | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1273 | |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1274 | If this option is set, the environment is checked for |
| 1275 | a variable "splashimage". If found, the usual display |
| 1276 | of logo, copyright and system information on the LCD |
wdenk | 0168663 | 2004-06-30 22:59:18 +0000 | [diff] [blame] | 1277 | is suppressed and the BMP image at the address |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1278 | specified in "splashimage" is loaded instead. The |
| 1279 | console is redirected to the "nulldev", too. This |
| 1280 | allows for a "silent" boot where a splash screen is |
| 1281 | loaded very quickly after power-on. |
wdenk | 92bbe3f | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1282 | |
Matthias Weisser | 5388418 | 2009-07-09 16:07:30 +0200 | [diff] [blame] | 1283 | CONFIG_SPLASH_SCREEN_ALIGN |
| 1284 | |
| 1285 | If this option is set the splash image can be freely positioned |
| 1286 | on the screen. Environment variable "splashpos" specifies the |
| 1287 | position as "x,y". If a positive number is given it is used as |
| 1288 | number of pixel from left/top. If a negative number is given it |
| 1289 | is used as number of pixel from right/bottom. You can also |
| 1290 | specify 'm' for centering the image. |
| 1291 | |
| 1292 | Example: |
| 1293 | setenv splashpos m,m |
| 1294 | => image at center of screen |
| 1295 | |
| 1296 | setenv splashpos 30,20 |
| 1297 | => image at x = 30 and y = 20 |
| 1298 | |
| 1299 | setenv splashpos -10,m |
| 1300 | => vertically centered image |
| 1301 | at x = dspWidth - bmpWidth - 9 |
| 1302 | |
Stefan Roese | d9d9774 | 2005-09-22 09:04:17 +0200 | [diff] [blame] | 1303 | - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP |
| 1304 | |
| 1305 | If this option is set, additionally to standard BMP |
| 1306 | images, gzipped BMP images can be displayed via the |
| 1307 | splashscreen support or the bmp command. |
| 1308 | |
Anatolij Gustschin | 6b4e4fc | 2010-03-15 14:50:25 +0100 | [diff] [blame] | 1309 | - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 |
| 1310 | |
| 1311 | If this option is set, 8-bit RLE compressed BMP images |
| 1312 | can be displayed via the splashscreen support or the |
| 1313 | bmp command. |
| 1314 | |
wdenk | 710e350 | 2003-08-29 20:57:53 +0000 | [diff] [blame] | 1315 | - Compression support: |
| 1316 | CONFIG_BZIP2 |
| 1317 | |
| 1318 | If this option is set, support for bzip2 compressed |
| 1319 | images is included. If not, only uncompressed and gzip |
| 1320 | compressed images are supported. |
| 1321 | |
wdenk | 9c53f40 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1322 | NOTE: the bzip2 algorithm requires a lot of RAM, so |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1323 | the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should |
wdenk | 9c53f40 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1324 | be at least 4MB. |
wdenk | 92bbe3f | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1325 | |
Luigi 'Comio' Mantellini | 35afc06 | 2008-09-08 02:46:13 +0200 | [diff] [blame] | 1326 | CONFIG_LZMA |
| 1327 | |
| 1328 | If this option is set, support for lzma compressed |
| 1329 | images is included. |
| 1330 | |
| 1331 | Note: The LZMA algorithm adds between 2 and 4KB of code and it |
| 1332 | requires an amount of dynamic memory that is given by the |
| 1333 | formula: |
| 1334 | |
| 1335 | (1846 + 768 << (lc + lp)) * sizeof(uint16) |
| 1336 | |
| 1337 | Where lc and lp stand for, respectively, Literal context bits |
| 1338 | and Literal pos bits. |
| 1339 | |
| 1340 | This value is upper-bounded by 14MB in the worst case. Anyway, |
| 1341 | for a ~4MB large kernel image, we have lc=3 and lp=0 for a |
| 1342 | total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is |
| 1343 | a very small buffer. |
| 1344 | |
| 1345 | Use the lzmainfo tool to determinate the lc and lp values and |
| 1346 | then calculate the amount of needed dynamic memory (ensuring |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1347 | the appropriate CONFIG_SYS_MALLOC_LEN value). |
Luigi 'Comio' Mantellini | 35afc06 | 2008-09-08 02:46:13 +0200 | [diff] [blame] | 1348 | |
wdenk | 0e2bd9c | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 1349 | - MII/PHY support: |
| 1350 | CONFIG_PHY_ADDR |
| 1351 | |
| 1352 | The address of PHY on MII bus. |
| 1353 | |
| 1354 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) |
| 1355 | |
| 1356 | The clock frequency of the MII bus |
| 1357 | |
| 1358 | CONFIG_PHY_GIGE |
| 1359 | |
| 1360 | If this option is set, support for speed/duplex |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1361 | detection of gigabit PHY is included. |
wdenk | 0e2bd9c | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 1362 | |
| 1363 | CONFIG_PHY_RESET_DELAY |
| 1364 | |
| 1365 | Some PHY like Intel LXT971A need extra delay after |
| 1366 | reset before any MII register access is possible. |
| 1367 | For such PHY, set this option to the usec delay |
| 1368 | required. (minimum 300usec for LXT971A) |
| 1369 | |
| 1370 | CONFIG_PHY_CMD_DELAY (ppc4xx) |
| 1371 | |
| 1372 | Some PHY like Intel LXT971A need extra delay after |
| 1373 | command issued before MII status register can be read |
| 1374 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1375 | - Ethernet address: |
| 1376 | CONFIG_ETHADDR |
richardretanubun | e5167f1 | 2008-09-29 18:28:23 -0400 | [diff] [blame] | 1377 | CONFIG_ETH1ADDR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1378 | CONFIG_ETH2ADDR |
| 1379 | CONFIG_ETH3ADDR |
richardretanubun | e5167f1 | 2008-09-29 18:28:23 -0400 | [diff] [blame] | 1380 | CONFIG_ETH4ADDR |
| 1381 | CONFIG_ETH5ADDR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1382 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1383 | Define a default value for Ethernet address to use |
| 1384 | for the respective Ethernet interface, in case this |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1385 | is not determined automatically. |
| 1386 | |
| 1387 | - IP address: |
| 1388 | CONFIG_IPADDR |
| 1389 | |
| 1390 | Define a default value for the IP address to use for |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1391 | the default Ethernet interface, in case this is not |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1392 | determined through e.g. bootp. |
| 1393 | |
| 1394 | - Server IP address: |
| 1395 | CONFIG_SERVERIP |
| 1396 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1397 | Defines a default value for the IP address of a TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1398 | server to contact when using the "tftboot" command. |
| 1399 | |
Robin Getz | 470a6d4 | 2009-07-21 12:15:28 -0400 | [diff] [blame] | 1400 | CONFIG_KEEP_SERVERADDR |
| 1401 | |
| 1402 | Keeps the server's MAC address, in the env 'serveraddr' |
| 1403 | for passing to bootargs (like Linux's netconsole option) |
| 1404 | |
David Updegraff | 7280da7 | 2007-06-11 10:41:07 -0500 | [diff] [blame] | 1405 | - Multicast TFTP Mode: |
| 1406 | CONFIG_MCAST_TFTP |
| 1407 | |
| 1408 | Defines whether you want to support multicast TFTP as per |
| 1409 | rfc-2090; for example to work with atftp. Lets lots of targets |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1410 | tftp down the same boot image concurrently. Note: the Ethernet |
David Updegraff | 7280da7 | 2007-06-11 10:41:07 -0500 | [diff] [blame] | 1411 | driver in use must provide a function: mcast() to join/leave a |
| 1412 | multicast group. |
| 1413 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1414 | - BOOTP Recovery Mode: |
| 1415 | CONFIG_BOOTP_RANDOM_DELAY |
| 1416 | |
| 1417 | If you have many targets in a network that try to |
| 1418 | boot using BOOTP, you may want to avoid that all |
| 1419 | systems send out BOOTP requests at precisely the same |
| 1420 | moment (which would happen for instance at recovery |
| 1421 | from a power failure, when all systems will try to |
| 1422 | boot, thus flooding the BOOTP server. Defining |
| 1423 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be |
| 1424 | inserted before sending out BOOTP requests. The |
Wolfgang Denk | b65aaf9 | 2007-08-06 23:21:05 +0200 | [diff] [blame] | 1425 | following delays are inserted then: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1426 | |
| 1427 | 1st BOOTP request: delay 0 ... 1 sec |
| 1428 | 2nd BOOTP request: delay 0 ... 2 sec |
| 1429 | 3rd BOOTP request: delay 0 ... 4 sec |
| 1430 | 4th and following |
| 1431 | BOOTP requests: delay 0 ... 8 sec |
| 1432 | |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1433 | - DHCP Advanced Options: |
Jon Loeliger | 5336a76 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1434 | You can fine tune the DHCP functionality by defining |
| 1435 | CONFIG_BOOTP_* symbols: |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1436 | |
Jon Loeliger | 5336a76 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1437 | CONFIG_BOOTP_SUBNETMASK |
| 1438 | CONFIG_BOOTP_GATEWAY |
| 1439 | CONFIG_BOOTP_HOSTNAME |
| 1440 | CONFIG_BOOTP_NISDOMAIN |
| 1441 | CONFIG_BOOTP_BOOTPATH |
| 1442 | CONFIG_BOOTP_BOOTFILESIZE |
| 1443 | CONFIG_BOOTP_DNS |
| 1444 | CONFIG_BOOTP_DNS2 |
| 1445 | CONFIG_BOOTP_SEND_HOSTNAME |
| 1446 | CONFIG_BOOTP_NTPSERVER |
| 1447 | CONFIG_BOOTP_TIMEOFFSET |
| 1448 | CONFIG_BOOTP_VENDOREX |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1449 | |
Wilson Callan | 22bcd6e | 2007-07-28 10:56:13 -0400 | [diff] [blame] | 1450 | CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip |
| 1451 | environment variable, not the BOOTP server. |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1452 | |
| 1453 | CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS |
| 1454 | serverip from a DHCP server, it is possible that more |
| 1455 | than one DNS serverip is offered to the client. |
| 1456 | If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS |
| 1457 | serverip will be stored in the additional environment |
| 1458 | variable "dnsip2". The first DNS serverip is always |
| 1459 | stored in the variable "dnsip", when CONFIG_BOOTP_DNS |
Jon Loeliger | 5336a76 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1460 | is defined. |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1461 | |
| 1462 | CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable |
| 1463 | to do a dynamic update of a DNS server. To do this, they |
| 1464 | need the hostname of the DHCP requester. |
Wilson Callan | 22bcd6e | 2007-07-28 10:56:13 -0400 | [diff] [blame] | 1465 | If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content |
Jon Loeliger | 5336a76 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 1466 | of the "hostname" environment variable is passed as |
| 1467 | option 12 to the DHCP server. |
stroese | e0aadfb | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 1468 | |
Aras Vaichas | 72aa3f3 | 2008-03-26 09:43:57 +1100 | [diff] [blame] | 1469 | CONFIG_BOOTP_DHCP_REQUEST_DELAY |
| 1470 | |
| 1471 | A 32bit value in microseconds for a delay between |
| 1472 | receiving a "DHCP Offer" and sending the "DHCP Request". |
| 1473 | This fixes a problem with certain DHCP servers that don't |
| 1474 | respond 100% of the time to a "DHCP request". E.g. On an |
| 1475 | AT91RM9200 processor running at 180MHz, this delay needed |
| 1476 | to be *at least* 15,000 usec before a Windows Server 2003 |
| 1477 | DHCP server would reply 100% of the time. I recommend at |
| 1478 | least 50,000 usec to be safe. The alternative is to hope |
| 1479 | that one of the retries will be successful but note that |
| 1480 | the DHCP timeout and retry process takes a longer than |
| 1481 | this delay. |
| 1482 | |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 1483 | - CDP Options: |
wdenk | 0593920 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 1484 | CONFIG_CDP_DEVICE_ID |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 1485 | |
| 1486 | The device id used in CDP trigger frames. |
| 1487 | |
| 1488 | CONFIG_CDP_DEVICE_ID_PREFIX |
| 1489 | |
| 1490 | A two character string which is prefixed to the MAC address |
| 1491 | of the device. |
| 1492 | |
| 1493 | CONFIG_CDP_PORT_ID |
| 1494 | |
| 1495 | A printf format string which contains the ascii name of |
| 1496 | the port. Normally is set to "eth%d" which sets |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1497 | eth0 for the first Ethernet, eth1 for the second etc. |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 1498 | |
| 1499 | CONFIG_CDP_CAPABILITIES |
| 1500 | |
| 1501 | A 32bit integer which indicates the device capabilities; |
| 1502 | 0x00000010 for a normal host which does not forwards. |
| 1503 | |
| 1504 | CONFIG_CDP_VERSION |
| 1505 | |
| 1506 | An ascii string containing the version of the software. |
| 1507 | |
| 1508 | CONFIG_CDP_PLATFORM |
| 1509 | |
| 1510 | An ascii string containing the name of the platform. |
| 1511 | |
| 1512 | CONFIG_CDP_TRIGGER |
| 1513 | |
| 1514 | A 32bit integer sent on the trigger. |
| 1515 | |
| 1516 | CONFIG_CDP_POWER_CONSUMPTION |
| 1517 | |
| 1518 | A 16bit integer containing the power consumption of the |
| 1519 | device in .1 of milliwatts. |
| 1520 | |
| 1521 | CONFIG_CDP_APPLIANCE_VLAN_TYPE |
| 1522 | |
| 1523 | A byte containing the id of the VLAN. |
| 1524 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1525 | - Status LED: CONFIG_STATUS_LED |
| 1526 | |
| 1527 | Several configurations allow to display the current |
| 1528 | status using a LED. For instance, the LED will blink |
| 1529 | fast while running U-Boot code, stop blinking as |
| 1530 | soon as a reply to a BOOTP request was received, and |
| 1531 | start blinking slow once the Linux kernel is running |
| 1532 | (supported by a status LED driver in the Linux |
| 1533 | kernel). Defining CONFIG_STATUS_LED enables this |
| 1534 | feature in U-Boot. |
| 1535 | |
| 1536 | - CAN Support: CONFIG_CAN_DRIVER |
| 1537 | |
| 1538 | Defining CONFIG_CAN_DRIVER enables CAN driver support |
| 1539 | on those systems that support this (optional) |
| 1540 | feature, like the TQM8xxL modules. |
| 1541 | |
| 1542 | - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C |
| 1543 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1544 | These enable I2C serial bus commands. Defining either of |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1545 | (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1546 | include the appropriate I2C driver for the selected CPU. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1547 | |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1548 | This will allow you to use i2c commands at the u-boot |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1549 | command line (as long as you set CONFIG_CMD_I2C in |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1550 | CONFIG_COMMANDS) and communicate with i2c based realtime |
| 1551 | clock chips. See common/cmd_i2c.c for a description of the |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1552 | command line interface. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1553 | |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1554 | CONFIG_HARD_I2C selects a hardware I2C controller. |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1555 | |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1556 | CONFIG_SOFT_I2C configures u-boot to use a software (aka |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1557 | bit-banging) driver instead of CPM or similar hardware |
| 1558 | support for I2C. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1559 | |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1560 | There are several other quantities that must also be |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1561 | defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1562 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1563 | In both cases you will need to define CONFIG_SYS_I2C_SPEED |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1564 | to be the frequency (in Hz) at which you wish your i2c bus |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1565 | to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1566 | the CPU's i2c node address). |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1567 | |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 1568 | Now, the u-boot i2c code for the mpc8xx |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 1569 | (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node |
Peter Tyser | e4d1abc | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 1570 | and so its address should therefore be cleared to 0 (See, |
| 1571 | eg, MPC823e User's Manual p.16-473). So, set |
| 1572 | CONFIG_SYS_I2C_SLAVE to 0. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1573 | |
Eric Millbrandt | 12990a4 | 2009-09-03 08:09:44 -0500 | [diff] [blame] | 1574 | CONFIG_SYS_I2C_INIT_MPC5XXX |
| 1575 | |
| 1576 | When a board is reset during an i2c bus transfer |
| 1577 | chips might think that the current transfer is still |
| 1578 | in progress. Reset the slave devices by sending start |
| 1579 | commands until the slave device responds. |
| 1580 | |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1581 | That's all that's required for CONFIG_HARD_I2C. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1582 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1583 | If you use the software i2c interface (CONFIG_SOFT_I2C) |
| 1584 | then the following macros need to be defined (examples are |
| 1585 | from include/configs/lwmon.h): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1586 | |
| 1587 | I2C_INIT |
| 1588 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1589 | (Optional). Any commands necessary to enable the I2C |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1590 | controller or configure ports. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1591 | |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 1592 | eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1593 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1594 | I2C_PORT |
| 1595 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1596 | (Only for MPC8260 CPU). The I/O port to use (the code |
| 1597 | assumes both bits are on the same port). Valid values |
| 1598 | are 0..3 for ports A..D. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1599 | |
| 1600 | I2C_ACTIVE |
| 1601 | |
| 1602 | The code necessary to make the I2C data line active |
| 1603 | (driven). If the data line is open collector, this |
| 1604 | define can be null. |
| 1605 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1606 | eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) |
| 1607 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1608 | I2C_TRISTATE |
| 1609 | |
| 1610 | The code necessary to make the I2C data line tri-stated |
| 1611 | (inactive). If the data line is open collector, this |
| 1612 | define can be null. |
| 1613 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1614 | eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) |
| 1615 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1616 | I2C_READ |
| 1617 | |
| 1618 | Code that returns TRUE if the I2C data line is high, |
| 1619 | FALSE if it is low. |
| 1620 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1621 | eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) |
| 1622 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1623 | I2C_SDA(bit) |
| 1624 | |
| 1625 | If <bit> is TRUE, sets the I2C data line high. If it |
| 1626 | is FALSE, it clears it (low). |
| 1627 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1628 | eg: #define I2C_SDA(bit) \ |
wdenk | 2bb1105 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 1629 | if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 1630 | else immr->im_cpm.cp_pbdat &= ~PB_SDA |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1631 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1632 | I2C_SCL(bit) |
| 1633 | |
| 1634 | If <bit> is TRUE, sets the I2C clock line high. If it |
| 1635 | is FALSE, it clears it (low). |
| 1636 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1637 | eg: #define I2C_SCL(bit) \ |
wdenk | 2bb1105 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 1638 | if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 1639 | else immr->im_cpm.cp_pbdat &= ~PB_SCL |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1640 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1641 | I2C_DELAY |
| 1642 | |
| 1643 | This delay is invoked four times per clock cycle so this |
| 1644 | controls the rate of data transfer. The data rate thus |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1645 | is 1 / (I2C_DELAY * 4). Often defined to be something |
wdenk | 21136db | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 1646 | like: |
| 1647 | |
wdenk | b9bbd24 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1648 | #define I2C_DELAY udelay(2) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1649 | |
Mike Frysinger | ee12d54 | 2010-07-21 13:38:02 -0400 | [diff] [blame] | 1650 | CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA |
| 1651 | |
| 1652 | If your arch supports the generic GPIO framework (asm/gpio.h), |
| 1653 | then you may alternatively define the two GPIOs that are to be |
| 1654 | used as SCL / SDA. Any of the previous I2C_xxx macros will |
| 1655 | have GPIO-based defaults assigned to them as appropriate. |
| 1656 | |
| 1657 | You should define these to the GPIO value as given directly to |
| 1658 | the generic GPIO functions. |
| 1659 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1660 | CONFIG_SYS_I2C_INIT_BOARD |
wdenk | cc1e256 | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 1661 | |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1662 | When a board is reset during an i2c bus transfer |
| 1663 | chips might think that the current transfer is still |
| 1664 | in progress. On some boards it is possible to access |
| 1665 | the i2c SCLK line directly, either by using the |
| 1666 | processor pin as a GPIO or by having a second pin |
| 1667 | connected to the bus. If this option is defined a |
| 1668 | custom i2c_init_board() routine in boards/xxx/board.c |
| 1669 | is run early in the boot sequence. |
wdenk | cc1e256 | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 1670 | |
Richard Retanubun | df0149c | 2010-04-12 15:08:17 -0400 | [diff] [blame] | 1671 | CONFIG_SYS_I2C_BOARD_LATE_INIT |
| 1672 | |
| 1673 | An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is |
| 1674 | defined a custom i2c_board_late_init() routine in |
| 1675 | boards/xxx/board.c is run AFTER the operations in i2c_init() |
| 1676 | is completed. This callpoint can be used to unreset i2c bus |
| 1677 | using CPU i2c controller register accesses for CPUs whose i2c |
| 1678 | controller provide such a method. It is called at the end of |
| 1679 | i2c_init() to allow i2c_init operations to setup the i2c bus |
| 1680 | controller on the CPU (e.g. setting bus speed & slave address). |
| 1681 | |
wdenk | 0e2bd9c | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 1682 | CONFIG_I2CFAST (PPC405GP|PPC405EP only) |
| 1683 | |
| 1684 | This option enables configuration of bi_iic_fast[] flags |
| 1685 | in u-boot bd_info structure based on u-boot environment |
| 1686 | variable "i2cfast". (see also i2cfast) |
| 1687 | |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1688 | CONFIG_I2C_MULTI_BUS |
| 1689 | |
| 1690 | This option allows the use of multiple I2C buses, each of which |
| 1691 | must have a controller. At any point in time, only one bus is |
| 1692 | active. To switch to a different bus, use the 'i2c dev' command. |
| 1693 | Note that bus numbering is zero-based. |
| 1694 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1695 | CONFIG_SYS_I2C_NOPROBES |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1696 | |
| 1697 | This option specifies a list of I2C devices that will be skipped |
Peter Tyser | 469cde4 | 2009-04-18 22:34:03 -0500 | [diff] [blame] | 1698 | when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS |
| 1699 | is set, specify a list of bus-device pairs. Otherwise, specify |
| 1700 | a 1D array of device addresses |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1701 | |
| 1702 | e.g. |
| 1703 | #undef CONFIG_I2C_MULTI_BUS |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1704 | #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1705 | |
| 1706 | will skip addresses 0x50 and 0x68 on a board with one I2C bus |
| 1707 | |
| 1708 | #define CONFIG_I2C_MULTI_BUS |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1709 | #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1710 | |
| 1711 | will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 |
| 1712 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1713 | CONFIG_SYS_SPD_BUS_NUM |
Timur Tabi | ab34754 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 1714 | |
| 1715 | If defined, then this indicates the I2C bus number for DDR SPD. |
| 1716 | If not defined, then U-Boot assumes that SPD is on I2C bus 0. |
| 1717 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1718 | CONFIG_SYS_RTC_BUS_NUM |
Stefan Roese | 096cc9b | 2007-02-20 10:51:26 +0100 | [diff] [blame] | 1719 | |
| 1720 | If defined, then this indicates the I2C bus number for the RTC. |
| 1721 | If not defined, then U-Boot assumes that RTC is on I2C bus 0. |
| 1722 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1723 | CONFIG_SYS_DTT_BUS_NUM |
Stefan Roese | 096cc9b | 2007-02-20 10:51:26 +0100 | [diff] [blame] | 1724 | |
| 1725 | If defined, then this indicates the I2C bus number for the DTT. |
| 1726 | If not defined, then U-Boot assumes that DTT is on I2C bus 0. |
| 1727 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1728 | CONFIG_SYS_I2C_DTT_ADDR: |
Victor Gallardo | 31856dd | 2008-09-09 15:13:29 -0700 | [diff] [blame] | 1729 | |
| 1730 | If defined, specifies the I2C address of the DTT device. |
| 1731 | If not defined, then U-Boot uses predefined value for |
| 1732 | specified DTT device. |
| 1733 | |
Timur Tabi | ab34754 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 1734 | CONFIG_FSL_I2C |
| 1735 | |
| 1736 | Define this option if you want to use Freescale's I2C driver in |
Marcel Ziswiler | aea6856 | 2007-12-30 03:30:46 +0100 | [diff] [blame] | 1737 | drivers/i2c/fsl_i2c.c. |
Timur Tabi | ab34754 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 1738 | |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 1739 | CONFIG_I2C_MUX |
| 1740 | |
| 1741 | Define this option if you have I2C devices reached over 1 .. n |
| 1742 | I2C Muxes like the pca9544a. This option addes a new I2C |
| 1743 | Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a |
| 1744 | new I2C Bus to the existing I2C Busses. If you select the |
| 1745 | new Bus with "i2c dev", u-bbot sends first the commandos for |
| 1746 | the muxes to activate this new "bus". |
| 1747 | |
| 1748 | CONFIG_I2C_MULTI_BUS must be also defined, to use this |
| 1749 | feature! |
| 1750 | |
| 1751 | Example: |
| 1752 | Adding a new I2C Bus reached over 2 pca9544a muxes |
| 1753 | The First mux with address 70 and channel 6 |
| 1754 | The Second mux with address 71 and channel 4 |
| 1755 | |
| 1756 | => i2c bus pca9544a:70:6:pca9544a:71:4 |
| 1757 | |
| 1758 | Use the "i2c bus" command without parameter, to get a list |
| 1759 | of I2C Busses with muxes: |
| 1760 | |
| 1761 | => i2c bus |
| 1762 | Busses reached over muxes: |
| 1763 | Bus ID: 2 |
| 1764 | reached over Mux(es): |
| 1765 | pca9544a@70 ch: 4 |
| 1766 | Bus ID: 3 |
| 1767 | reached over Mux(es): |
| 1768 | pca9544a@70 ch: 6 |
| 1769 | pca9544a@71 ch: 4 |
| 1770 | => |
| 1771 | |
| 1772 | If you now switch to the new I2C Bus 3 with "i2c dev 3" |
Michael Jones | 9c5ef8d | 2011-07-14 22:09:28 +0000 | [diff] [blame] | 1773 | u-boot first sends the command to the mux@70 to enable |
| 1774 | channel 6, and then the command to the mux@71 to enable |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 1775 | the channel 4. |
| 1776 | |
| 1777 | After that, you can use the "normal" i2c commands as |
Michael Jones | 9c5ef8d | 2011-07-14 22:09:28 +0000 | [diff] [blame] | 1778 | usual to communicate with your I2C devices behind |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 1779 | the 2 muxes. |
| 1780 | |
| 1781 | This option is actually implemented for the bitbanging |
| 1782 | algorithm in common/soft_i2c.c and for the Hardware I2C |
| 1783 | Bus on the MPC8260. But it should be not so difficult |
| 1784 | to add this option to other architectures. |
| 1785 | |
Andrew Dyer | 58c41f9 | 2008-12-29 17:36:01 -0600 | [diff] [blame] | 1786 | CONFIG_SOFT_I2C_READ_REPEATED_START |
| 1787 | |
| 1788 | defining this will force the i2c_read() function in |
| 1789 | the soft_i2c driver to perform an I2C repeated start |
| 1790 | between writing the address pointer and reading the |
| 1791 | data. If this define is omitted the default behaviour |
| 1792 | of doing a stop-start sequence will be used. Most I2C |
| 1793 | devices can use either method, but some require one or |
| 1794 | the other. |
Timur Tabi | ab34754 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 1795 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1796 | - SPI Support: CONFIG_SPI |
| 1797 | |
| 1798 | Enables SPI driver (so far only tested with |
| 1799 | SPI EEPROM, also an instance works with Crystal A/D and |
| 1800 | D/As on the SACSng board) |
| 1801 | |
Yoshihiro Shimoda | 65bd9b4 | 2011-01-31 16:50:43 +0900 | [diff] [blame] | 1802 | CONFIG_SH_SPI |
| 1803 | |
| 1804 | Enables the driver for SPI controller on SuperH. Currently |
| 1805 | only SH7757 is supported. |
| 1806 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1807 | CONFIG_SPI_X |
| 1808 | |
| 1809 | Enables extended (16-bit) SPI EEPROM addressing. |
| 1810 | (symmetrical to CONFIG_I2C_X) |
| 1811 | |
| 1812 | CONFIG_SOFT_SPI |
| 1813 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1814 | Enables a software (bit-bang) SPI driver rather than |
| 1815 | using hardware support. This is a general purpose |
| 1816 | driver that only requires three general I/O port pins |
| 1817 | (two outputs, one input) to function. If this is |
| 1818 | defined, the board configuration must define several |
| 1819 | SPI configuration items (port pins to use, etc). For |
| 1820 | an example, see include/configs/sacsng.h. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1821 | |
Ben Warren | 7efe927 | 2008-01-16 22:37:35 -0500 | [diff] [blame] | 1822 | CONFIG_HARD_SPI |
| 1823 | |
| 1824 | Enables a hardware SPI driver for general-purpose reads |
| 1825 | and writes. As with CONFIG_SOFT_SPI, the board configuration |
| 1826 | must define a list of chip-select function pointers. |
| 1827 | Currently supported on some MPC8xxx processors. For an |
| 1828 | example, see include/configs/mpc8349emds.h. |
| 1829 | |
Guennadi Liakhovetski | 07327a5 | 2008-04-15 14:14:25 +0200 | [diff] [blame] | 1830 | CONFIG_MXC_SPI |
| 1831 | |
| 1832 | Enables the driver for the SPI controllers on i.MX and MXC |
| 1833 | SoCs. Currently only i.MX31 is supported. |
| 1834 | |
Matthias Fuchs | a440087 | 2007-12-27 17:12:34 +0100 | [diff] [blame] | 1835 | - FPGA Support: CONFIG_FPGA |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1836 | |
Matthias Fuchs | a440087 | 2007-12-27 17:12:34 +0100 | [diff] [blame] | 1837 | Enables FPGA subsystem. |
| 1838 | |
| 1839 | CONFIG_FPGA_<vendor> |
| 1840 | |
| 1841 | Enables support for specific chip vendors. |
| 1842 | (ALTERA, XILINX) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1843 | |
Matthias Fuchs | a440087 | 2007-12-27 17:12:34 +0100 | [diff] [blame] | 1844 | CONFIG_FPGA_<family> |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1845 | |
Matthias Fuchs | a440087 | 2007-12-27 17:12:34 +0100 | [diff] [blame] | 1846 | Enables support for FPGA family. |
| 1847 | (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) |
| 1848 | |
| 1849 | CONFIG_FPGA_COUNT |
| 1850 | |
| 1851 | Specify the number of FPGA devices to support. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1852 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1853 | CONFIG_SYS_FPGA_PROG_FEEDBACK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1854 | |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1855 | Enable printing of hash marks during FPGA configuration. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1856 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1857 | CONFIG_SYS_FPGA_CHECK_BUSY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1858 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1859 | Enable checks on FPGA configuration interface busy |
| 1860 | status by the configuration function. This option |
| 1861 | will require a board or device specific function to |
| 1862 | be written. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1863 | |
| 1864 | CONFIG_FPGA_DELAY |
| 1865 | |
| 1866 | If defined, a function that provides delays in the FPGA |
| 1867 | configuration driver. |
| 1868 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1869 | CONFIG_SYS_FPGA_CHECK_CTRLC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1870 | Allow Control-C to interrupt FPGA configuration |
| 1871 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1872 | CONFIG_SYS_FPGA_CHECK_ERROR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1873 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1874 | Check for configuration errors during FPGA bitfile |
| 1875 | loading. For example, abort during Virtex II |
| 1876 | configuration if the INIT_B line goes low (which |
| 1877 | indicated a CRC error). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1878 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1879 | CONFIG_SYS_FPGA_WAIT_INIT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1880 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1881 | Maximum time to wait for the INIT_B line to deassert |
| 1882 | after PROB_B has been deasserted during a Virtex II |
| 1883 | FPGA configuration sequence. The default time is 500 |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1884 | ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1885 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1886 | CONFIG_SYS_FPGA_WAIT_BUSY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1887 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1888 | Maximum time to wait for BUSY to deassert during |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1889 | Virtex II FPGA configuration. The default is 5 ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1890 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1891 | CONFIG_SYS_FPGA_WAIT_CONFIG |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1892 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1893 | Time to wait after FPGA configuration. The default is |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1894 | 200 ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1895 | |
| 1896 | - Configuration Management: |
| 1897 | CONFIG_IDENT_STRING |
| 1898 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1899 | If defined, this string will be added to the U-Boot |
| 1900 | version information (U_BOOT_VERSION) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1901 | |
| 1902 | - Vendor Parameter Protection: |
| 1903 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1904 | U-Boot considers the values of the environment |
| 1905 | variables "serial#" (Board Serial Number) and |
wdenk | eb20ad3 | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1906 | "ethaddr" (Ethernet Address) to be parameters that |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1907 | are set once by the board vendor / manufacturer, and |
| 1908 | protects these variables from casual modification by |
| 1909 | the user. Once set, these variables are read-only, |
| 1910 | and write or delete attempts are rejected. You can |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1911 | change this behaviour: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1912 | |
| 1913 | If CONFIG_ENV_OVERWRITE is #defined in your config |
| 1914 | file, the write protection for vendor parameters is |
wdenk | cc1e256 | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 1915 | completely disabled. Anybody can change or delete |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1916 | these parameters. |
| 1917 | |
| 1918 | Alternatively, if you #define _both_ CONFIG_ETHADDR |
| 1919 | _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1920 | Ethernet address is installed in the environment, |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1921 | which can be changed exactly ONCE by the user. [The |
| 1922 | serial# is unaffected by this, i. e. it remains |
| 1923 | read-only.] |
| 1924 | |
| 1925 | - Protected RAM: |
| 1926 | CONFIG_PRAM |
| 1927 | |
| 1928 | Define this variable to enable the reservation of |
| 1929 | "protected RAM", i. e. RAM which is not overwritten |
| 1930 | by U-Boot. Define CONFIG_PRAM to hold the number of |
| 1931 | kB you want to reserve for pRAM. You can overwrite |
| 1932 | this default value by defining an environment |
| 1933 | variable "pram" to the number of kB you want to |
| 1934 | reserve. Note that the board info structure will |
| 1935 | still show the full amount of RAM. If pRAM is |
| 1936 | reserved, a new environment variable "mem" will |
| 1937 | automatically be defined to hold the amount of |
| 1938 | remaining RAM in a form that can be passed as boot |
| 1939 | argument to Linux, for instance like that: |
| 1940 | |
Wolfgang Denk | 86eb3b7 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 1941 | setenv bootargs ... mem=\${mem} |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1942 | saveenv |
| 1943 | |
| 1944 | This way you can tell Linux not to use this memory, |
| 1945 | either, which results in a memory region that will |
| 1946 | not be affected by reboots. |
| 1947 | |
| 1948 | *WARNING* If your board configuration uses automatic |
| 1949 | detection of the RAM size, you must make sure that |
| 1950 | this memory test is non-destructive. So far, the |
| 1951 | following board configurations are known to be |
| 1952 | "pRAM-clean": |
| 1953 | |
| 1954 | ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, |
| 1955 | HERMES, IP860, RPXlite, LWMON, LANTEC, |
Wolfgang Denk | cd4e42e | 2010-10-05 22:54:53 +0200 | [diff] [blame] | 1956 | FLAGADM, TQM8260 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1957 | |
| 1958 | - Error Recovery: |
| 1959 | CONFIG_PANIC_HANG |
| 1960 | |
| 1961 | Define this variable to stop the system in case of a |
| 1962 | fatal error, so that you have to reset it manually. |
| 1963 | This is probably NOT a good idea for an embedded |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1964 | system where you want the system to reboot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1965 | automatically as fast as possible, but it may be |
| 1966 | useful during development since you can try to debug |
| 1967 | the conditions that lead to the situation. |
| 1968 | |
| 1969 | CONFIG_NET_RETRY_COUNT |
| 1970 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1971 | This variable defines the number of retries for |
| 1972 | network operations like ARP, RARP, TFTP, or BOOTP |
| 1973 | before giving up the operation. If not defined, a |
| 1974 | default value of 5 is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1975 | |
Guennadi Liakhovetski | b38c2b3 | 2008-04-03 17:04:19 +0200 | [diff] [blame] | 1976 | CONFIG_ARP_TIMEOUT |
| 1977 | |
| 1978 | Timeout waiting for an ARP reply in milliseconds. |
| 1979 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1980 | - Command Interpreter: |
Wolfgang Denk | 81352ed | 2006-10-28 02:28:02 +0200 | [diff] [blame] | 1981 | CONFIG_AUTO_COMPLETE |
wdenk | 3902d70 | 2004-04-15 18:22:41 +0000 | [diff] [blame] | 1982 | |
| 1983 | Enable auto completion of commands using TAB. |
| 1984 | |
Wolfgang Denk | 018147d | 2006-11-27 15:32:42 +0100 | [diff] [blame] | 1985 | Note that this feature has NOT been implemented yet |
| 1986 | for the "hush" shell. |
Wolfgang Denk | 81352ed | 2006-10-28 02:28:02 +0200 | [diff] [blame] | 1987 | |
| 1988 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1989 | CONFIG_SYS_HUSH_PARSER |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1990 | |
| 1991 | Define this variable to enable the "hush" shell (from |
| 1992 | Busybox) as command line interpreter, thus enabling |
| 1993 | powerful command line syntax like |
| 1994 | if...then...else...fi conditionals or `&&' and '||' |
| 1995 | constructs ("shell scripts"). |
| 1996 | |
| 1997 | If undefined, you get the old, much simpler behaviour |
| 1998 | with a somewhat smaller memory footprint. |
| 1999 | |
| 2000 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2001 | CONFIG_SYS_PROMPT_HUSH_PS2 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2002 | |
| 2003 | This defines the secondary prompt string, which is |
| 2004 | printed when the command interpreter needs more input |
| 2005 | to complete a command. Usually "> ". |
| 2006 | |
| 2007 | Note: |
| 2008 | |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2009 | In the current implementation, the local variables |
| 2010 | space and global environment variables space are |
| 2011 | separated. Local variables are those you define by |
| 2012 | simply typing `name=value'. To access a local |
| 2013 | variable later on, you have write `$name' or |
| 2014 | `${name}'; to execute the contents of a variable |
| 2015 | directly type `$name' at the command prompt. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2016 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2017 | Global environment variables are those you use |
| 2018 | setenv/printenv to work with. To run a command stored |
| 2019 | in such a variable, you need to use the run command, |
| 2020 | and you must not use the '$' sign to access them. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2021 | |
| 2022 | To store commands and special characters in a |
| 2023 | variable, please use double quotation marks |
| 2024 | surrounding the whole text of the variable, instead |
| 2025 | of the backslashes before semicolons and special |
| 2026 | symbols. |
| 2027 | |
Wolfgang Denk | 2039a07 | 2006-07-21 11:35:21 +0200 | [diff] [blame] | 2028 | - Commandline Editing and History: |
| 2029 | CONFIG_CMDLINE_EDITING |
| 2030 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2031 | Enable editing and History functions for interactive |
Wolfgang Denk | c80857e | 2006-07-21 11:56:05 +0200 | [diff] [blame] | 2032 | commandline input operations |
Wolfgang Denk | 2039a07 | 2006-07-21 11:35:21 +0200 | [diff] [blame] | 2033 | |
wdenk | c0aa5c5 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2034 | - Default Environment: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2035 | CONFIG_EXTRA_ENV_SETTINGS |
| 2036 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2037 | Define this to contain any number of null terminated |
| 2038 | strings (variable = value pairs) that will be part of |
wdenk | eb20ad3 | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 2039 | the default environment compiled into the boot image. |
wdenk | 591dda5 | 2002-11-18 00:14:45 +0000 | [diff] [blame] | 2040 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2041 | For example, place something like this in your |
| 2042 | board's config file: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2043 | |
| 2044 | #define CONFIG_EXTRA_ENV_SETTINGS \ |
| 2045 | "myvar1=value1\0" \ |
| 2046 | "myvar2=value2\0" |
| 2047 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2048 | Warning: This method is based on knowledge about the |
| 2049 | internal format how the environment is stored by the |
| 2050 | U-Boot code. This is NOT an official, exported |
| 2051 | interface! Although it is unlikely that this format |
wdenk | eb20ad3 | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 2052 | will change soon, there is no guarantee either. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2053 | You better know what you are doing here. |
| 2054 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2055 | Note: overly (ab)use of the default environment is |
| 2056 | discouraged. Make sure to check other ways to preset |
Wolfgang Denk | 85c25df | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 2057 | the environment like the "source" command or the |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2058 | boot command first. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2059 | |
wdenk | c0aa5c5 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2060 | - DataFlash Support: |
wdenk | 381669a | 2003-06-16 23:50:08 +0000 | [diff] [blame] | 2061 | CONFIG_HAS_DATAFLASH |
| 2062 | |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2063 | Defining this option enables DataFlash features and |
| 2064 | allows to read/write in Dataflash via the standard |
| 2065 | commands cp, md... |
wdenk | 381669a | 2003-06-16 23:50:08 +0000 | [diff] [blame] | 2066 | |
wdenk | ef89394 | 2004-02-23 16:11:30 +0000 | [diff] [blame] | 2067 | - SystemACE Support: |
| 2068 | CONFIG_SYSTEMACE |
| 2069 | |
| 2070 | Adding this option adds support for Xilinx SystemACE |
| 2071 | chips attached via some sort of local bus. The address |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2072 | of the chip must also be defined in the |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2073 | CONFIG_SYS_SYSTEMACE_BASE macro. For example: |
wdenk | ef89394 | 2004-02-23 16:11:30 +0000 | [diff] [blame] | 2074 | |
| 2075 | #define CONFIG_SYSTEMACE |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2076 | #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 |
wdenk | ef89394 | 2004-02-23 16:11:30 +0000 | [diff] [blame] | 2077 | |
| 2078 | When SystemACE support is added, the "ace" device type |
| 2079 | becomes available to the fat commands, i.e. fatls. |
| 2080 | |
Wolfgang Denk | e3cfce5 | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2081 | - TFTP Fixed UDP Port: |
| 2082 | CONFIG_TFTP_PORT |
| 2083 | |
Wolfgang Denk | 227b519 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 2084 | If this is defined, the environment variable tftpsrcp |
Wolfgang Denk | e3cfce5 | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2085 | is used to supply the TFTP UDP source port value. |
Wolfgang Denk | 227b519 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 2086 | If tftpsrcp isn't defined, the normal pseudo-random port |
Wolfgang Denk | e3cfce5 | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2087 | number generator is used. |
| 2088 | |
Wolfgang Denk | 227b519 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 2089 | Also, the environment variable tftpdstp is used to supply |
| 2090 | the TFTP UDP destination port value. If tftpdstp isn't |
| 2091 | defined, the normal port 69 is used. |
| 2092 | |
| 2093 | The purpose for tftpsrcp is to allow a TFTP server to |
Wolfgang Denk | e3cfce5 | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 2094 | blindly start the TFTP transfer using the pre-configured |
| 2095 | target IP address and UDP port. This has the effect of |
| 2096 | "punching through" the (Windows XP) firewall, allowing |
| 2097 | the remainder of the TFTP transfer to proceed normally. |
| 2098 | A better solution is to properly configure the firewall, |
| 2099 | but sometimes that is not allowed. |
| 2100 | |
wdenk | c0aa5c5 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2101 | - Show boot progress: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2102 | CONFIG_SHOW_BOOT_PROGRESS |
| 2103 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2104 | Defining this option allows to add some board- |
| 2105 | specific code (calling a user-provided function |
| 2106 | "show_boot_progress(int)") that enables you to show |
| 2107 | the system's boot progress on some display (for |
| 2108 | example, some LED's) on your board. At the moment, |
| 2109 | the following checkpoints are implemented: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2110 | |
Wolfgang Denk | 33a5734 | 2011-02-04 14:25:17 +0100 | [diff] [blame] | 2111 | - Standalone program support: |
| 2112 | CONFIG_STANDALONE_LOAD_ADDR |
| 2113 | |
| 2114 | This option allows to define board specific values |
| 2115 | for the address where standalone program gets loaded, |
| 2116 | thus overwriting the architecutre dependent default |
| 2117 | settings. |
| 2118 | |
Minkyu Kang | 50777c4 | 2011-04-24 22:22:34 +0000 | [diff] [blame] | 2119 | - Frame Buffer Address: |
| 2120 | CONFIG_FB_ADDR |
| 2121 | |
| 2122 | Define CONFIG_FB_ADDR if you want to use specific address for |
| 2123 | frame buffer. |
| 2124 | Then system will reserve the frame buffer address to defined address |
| 2125 | instead of lcd_setmem (this function grab the memory for frame buffer |
| 2126 | by panel's size). |
| 2127 | |
| 2128 | Please see board_init_f function. |
| 2129 | |
| 2130 | If you want this config option then, |
| 2131 | please define it at your board config file |
| 2132 | |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2133 | Legacy uImage format: |
| 2134 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2135 | Arg Where When |
| 2136 | 1 common/cmd_bootm.c before attempting to boot an image |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2137 | -1 common/cmd_bootm.c Image header has bad magic number |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2138 | 2 common/cmd_bootm.c Image header has correct magic number |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2139 | -2 common/cmd_bootm.c Image header has bad checksum |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2140 | 3 common/cmd_bootm.c Image header has correct checksum |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2141 | -3 common/cmd_bootm.c Image data has bad checksum |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2142 | 4 common/cmd_bootm.c Image data has correct checksum |
| 2143 | -4 common/cmd_bootm.c Image is for unsupported architecture |
| 2144 | 5 common/cmd_bootm.c Architecture check OK |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2145 | -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2146 | 6 common/cmd_bootm.c Image Type check OK |
| 2147 | -6 common/cmd_bootm.c gunzip uncompression error |
| 2148 | -7 common/cmd_bootm.c Unimplemented compression type |
| 2149 | 7 common/cmd_bootm.c Uncompression OK |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2150 | 8 common/cmd_bootm.c No uncompress/copy overwrite error |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2151 | -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2152 | |
| 2153 | 9 common/image.c Start initial ramdisk verification |
| 2154 | -10 common/image.c Ramdisk header has bad magic number |
| 2155 | -11 common/image.c Ramdisk header has bad checksum |
| 2156 | 10 common/image.c Ramdisk header is OK |
| 2157 | -12 common/image.c Ramdisk data has bad checksum |
| 2158 | 11 common/image.c Ramdisk data has correct checksum |
| 2159 | 12 common/image.c Ramdisk verification complete, start loading |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2160 | -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2161 | 13 common/image.c Start multifile image verification |
| 2162 | 14 common/image.c No initial ramdisk, no multifile, continue. |
| 2163 | |
Peter Tyser | cede5d8 | 2010-04-12 22:28:04 -0500 | [diff] [blame] | 2164 | 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2165 | |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 2166 | -30 arch/powerpc/lib/board.c Fatal error, hang the system |
wdenk | d729d30 | 2004-02-27 00:07:27 +0000 | [diff] [blame] | 2167 | -31 post/post.c POST test failed, detected by post_output_backlog() |
| 2168 | -32 post/post.c POST test failed, detected by post_run_single() |
wdenk | e97d3d9 | 2004-02-23 22:22:28 +0000 | [diff] [blame] | 2169 | |
Heiko Schocher | 633e03a | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2170 | 34 common/cmd_doc.c before loading a Image from a DOC device |
| 2171 | -35 common/cmd_doc.c Bad usage of "doc" command |
| 2172 | 35 common/cmd_doc.c correct usage of "doc" command |
| 2173 | -36 common/cmd_doc.c No boot device |
| 2174 | 36 common/cmd_doc.c correct boot device |
| 2175 | -37 common/cmd_doc.c Unknown Chip ID on boot device |
| 2176 | 37 common/cmd_doc.c correct chip ID found, device available |
| 2177 | -38 common/cmd_doc.c Read Error on boot device |
| 2178 | 38 common/cmd_doc.c reading Image header from DOC device OK |
| 2179 | -39 common/cmd_doc.c Image header has bad magic number |
| 2180 | 39 common/cmd_doc.c Image header has correct magic number |
| 2181 | -40 common/cmd_doc.c Error reading Image from DOC device |
| 2182 | 40 common/cmd_doc.c Image header has correct magic number |
| 2183 | 41 common/cmd_ide.c before loading a Image from a IDE device |
| 2184 | -42 common/cmd_ide.c Bad usage of "ide" command |
| 2185 | 42 common/cmd_ide.c correct usage of "ide" command |
| 2186 | -43 common/cmd_ide.c No boot device |
| 2187 | 43 common/cmd_ide.c boot device found |
| 2188 | -44 common/cmd_ide.c Device not available |
| 2189 | 44 common/cmd_ide.c Device available |
| 2190 | -45 common/cmd_ide.c wrong partition selected |
| 2191 | 45 common/cmd_ide.c partition selected |
| 2192 | -46 common/cmd_ide.c Unknown partition table |
| 2193 | 46 common/cmd_ide.c valid partition table found |
| 2194 | -47 common/cmd_ide.c Invalid partition type |
| 2195 | 47 common/cmd_ide.c correct partition type |
| 2196 | -48 common/cmd_ide.c Error reading Image Header on boot device |
| 2197 | 48 common/cmd_ide.c reading Image Header from IDE device OK |
| 2198 | -49 common/cmd_ide.c Image header has bad magic number |
| 2199 | 49 common/cmd_ide.c Image header has correct magic number |
| 2200 | -50 common/cmd_ide.c Image header has bad checksum |
| 2201 | 50 common/cmd_ide.c Image header has correct checksum |
| 2202 | -51 common/cmd_ide.c Error reading Image from IDE device |
| 2203 | 51 common/cmd_ide.c reading Image from IDE device OK |
| 2204 | 52 common/cmd_nand.c before loading a Image from a NAND device |
| 2205 | -53 common/cmd_nand.c Bad usage of "nand" command |
| 2206 | 53 common/cmd_nand.c correct usage of "nand" command |
| 2207 | -54 common/cmd_nand.c No boot device |
| 2208 | 54 common/cmd_nand.c boot device found |
| 2209 | -55 common/cmd_nand.c Unknown Chip ID on boot device |
| 2210 | 55 common/cmd_nand.c correct chip ID found, device available |
| 2211 | -56 common/cmd_nand.c Error reading Image Header on boot device |
| 2212 | 56 common/cmd_nand.c reading Image Header from NAND device OK |
| 2213 | -57 common/cmd_nand.c Image header has bad magic number |
| 2214 | 57 common/cmd_nand.c Image header has correct magic number |
| 2215 | -58 common/cmd_nand.c Error reading Image from NAND device |
| 2216 | 58 common/cmd_nand.c reading Image from NAND device OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2217 | |
Heiko Schocher | 633e03a | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2218 | -60 common/env_common.c Environment has a bad CRC, using default |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2219 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2220 | 64 net/eth.c starting with Ethernet configuration. |
Heiko Schocher | 633e03a | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2221 | -64 net/eth.c no Ethernet found. |
| 2222 | 65 net/eth.c Ethernet found. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2223 | |
Heiko Schocher | 633e03a | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2224 | -80 common/cmd_net.c usage wrong |
| 2225 | 80 common/cmd_net.c before calling NetLoop() |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2226 | -81 common/cmd_net.c some error in NetLoop() occurred |
Heiko Schocher | 633e03a | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2227 | 81 common/cmd_net.c NetLoop() back without error |
| 2228 | -82 common/cmd_net.c size == 0 (File with size 0 loaded) |
| 2229 | 82 common/cmd_net.c trying automatic boot |
Wolfgang Denk | 85c25df | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 2230 | 83 common/cmd_net.c running "source" command |
| 2231 | -83 common/cmd_net.c some error in automatic boot or "source" command |
Heiko Schocher | 633e03a | 2007-06-22 19:11:54 +0200 | [diff] [blame] | 2232 | 84 common/cmd_net.c end without errors |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2233 | |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2234 | FIT uImage format: |
| 2235 | |
| 2236 | Arg Where When |
| 2237 | 100 common/cmd_bootm.c Kernel FIT Image has correct format |
| 2238 | -100 common/cmd_bootm.c Kernel FIT Image has incorrect format |
| 2239 | 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration |
| 2240 | -101 common/cmd_bootm.c Can't get configuration for kernel subimage |
| 2241 | 102 common/cmd_bootm.c Kernel unit name specified |
| 2242 | -103 common/cmd_bootm.c Can't get kernel subimage node offset |
Marian Balakowicz | 0cd4f3d | 2008-03-12 10:35:46 +0100 | [diff] [blame] | 2243 | 103 common/cmd_bootm.c Found configuration node |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2244 | 104 common/cmd_bootm.c Got kernel subimage node offset |
| 2245 | -104 common/cmd_bootm.c Kernel subimage hash verification failed |
| 2246 | 105 common/cmd_bootm.c Kernel subimage hash verification OK |
| 2247 | -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture |
| 2248 | 106 common/cmd_bootm.c Architecture check OK |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2249 | -106 common/cmd_bootm.c Kernel subimage has wrong type |
| 2250 | 107 common/cmd_bootm.c Kernel subimage type OK |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2251 | -107 common/cmd_bootm.c Can't get kernel subimage data/size |
| 2252 | 108 common/cmd_bootm.c Got kernel subimage data/size |
| 2253 | -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) |
| 2254 | -109 common/cmd_bootm.c Can't get kernel subimage type |
| 2255 | -110 common/cmd_bootm.c Can't get kernel subimage comp |
| 2256 | -111 common/cmd_bootm.c Can't get kernel subimage os |
| 2257 | -112 common/cmd_bootm.c Can't get kernel subimage load address |
| 2258 | -113 common/cmd_bootm.c Image uncompress/copy overwrite error |
| 2259 | |
| 2260 | 120 common/image.c Start initial ramdisk verification |
| 2261 | -120 common/image.c Ramdisk FIT image has incorrect format |
| 2262 | 121 common/image.c Ramdisk FIT image has correct format |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2263 | 122 common/image.c No ramdisk subimage unit name, using configuration |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2264 | -122 common/image.c Can't get configuration for ramdisk subimage |
| 2265 | 123 common/image.c Ramdisk unit name specified |
| 2266 | -124 common/image.c Can't get ramdisk subimage node offset |
| 2267 | 125 common/image.c Got ramdisk subimage node offset |
| 2268 | -125 common/image.c Ramdisk subimage hash verification failed |
| 2269 | 126 common/image.c Ramdisk subimage hash verification OK |
| 2270 | -126 common/image.c Ramdisk subimage for unsupported architecture |
| 2271 | 127 common/image.c Architecture check OK |
| 2272 | -127 common/image.c Can't get ramdisk subimage data/size |
| 2273 | 128 common/image.c Got ramdisk subimage data/size |
| 2274 | 129 common/image.c Can't get ramdisk load address |
| 2275 | -129 common/image.c Got ramdisk load address |
| 2276 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2277 | -130 common/cmd_doc.c Incorrect FIT image format |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2278 | 131 common/cmd_doc.c FIT image format OK |
| 2279 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2280 | -140 common/cmd_ide.c Incorrect FIT image format |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2281 | 141 common/cmd_ide.c FIT image format OK |
| 2282 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2283 | -150 common/cmd_nand.c Incorrect FIT image format |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2284 | 151 common/cmd_nand.c FIT image format OK |
| 2285 | |
Detlev Zundel | 0ecb611 | 2009-12-01 17:16:19 +0100 | [diff] [blame] | 2286 | - Automatic software updates via TFTP server |
| 2287 | CONFIG_UPDATE_TFTP |
| 2288 | CONFIG_UPDATE_TFTP_CNT_MAX |
| 2289 | CONFIG_UPDATE_TFTP_MSEC_MAX |
| 2290 | |
| 2291 | These options enable and control the auto-update feature; |
| 2292 | for a more detailed description refer to doc/README.update. |
| 2293 | |
| 2294 | - MTD Support (mtdparts command, UBI support) |
| 2295 | CONFIG_MTD_DEVICE |
| 2296 | |
| 2297 | Adds the MTD device infrastructure from the Linux kernel. |
| 2298 | Needed for mtdparts command support. |
| 2299 | |
| 2300 | CONFIG_MTD_PARTITIONS |
| 2301 | |
| 2302 | Adds the MTD partitioning infrastructure from the Linux |
| 2303 | kernel. Needed for UBI support. |
| 2304 | |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2305 | - SPL framework |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2306 | CONFIG_SPL |
| 2307 | Enable building of SPL globally. |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2308 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2309 | CONFIG_SPL_TEXT_BASE |
| 2310 | TEXT_BASE for linking the SPL binary. |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2311 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2312 | CONFIG_SPL_LDSCRIPT |
| 2313 | LDSCRIPT for linking the SPL binary. |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2314 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2315 | CONFIG_SPL_LIBCOMMON_SUPPORT |
| 2316 | Support for common/libcommon.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2317 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2318 | CONFIG_SPL_LIBDISK_SUPPORT |
| 2319 | Support for disk/libdisk.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2320 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2321 | CONFIG_SPL_I2C_SUPPORT |
| 2322 | Support for drivers/i2c/libi2c.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2323 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2324 | CONFIG_SPL_GPIO_SUPPORT |
| 2325 | Support for drivers/gpio/libgpio.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2326 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2327 | CONFIG_SPL_MMC_SUPPORT |
| 2328 | Support for drivers/mmc/libmmc.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2329 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2330 | CONFIG_SPL_SERIAL_SUPPORT |
| 2331 | Support for drivers/serial/libserial.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2332 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2333 | CONFIG_SPL_SPI_FLASH_SUPPORT |
| 2334 | Support for drivers/mtd/spi/libspi_flash.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2335 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2336 | CONFIG_SPL_SPI_SUPPORT |
| 2337 | Support for drivers/spi/libspi.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2338 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2339 | CONFIG_SPL_FAT_SUPPORT |
| 2340 | Support for fs/fat/libfat.o in SPL binary |
Daniel Schwierzeck | 39ca08e | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 2341 | |
Wolfgang Denk | 825223d | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 2342 | CONFIG_SPL_LIBGENERIC_SUPPORT |
| 2343 | Support for lib/libgeneric.o in SPL binary |
Marian Balakowicz | 74eb4ae | 2008-03-12 10:33:01 +0100 | [diff] [blame] | 2344 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2345 | Modem Support: |
| 2346 | -------------- |
| 2347 | |
Wolfgang Denk | 8f399b3 | 2011-05-01 20:44:23 +0200 | [diff] [blame] | 2348 | [so far only for SMDK2400 boards] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2349 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2350 | - Modem support enable: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2351 | CONFIG_MODEM_SUPPORT |
| 2352 | |
| 2353 | - RTS/CTS Flow control enable: |
| 2354 | CONFIG_HWFLOW |
| 2355 | |
| 2356 | - Modem debug support: |
| 2357 | CONFIG_MODEM_SUPPORT_DEBUG |
| 2358 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2359 | Enables debugging stuff (char screen[1024], dbg()) |
| 2360 | for modem support. Useful only with BDI2000. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2361 | |
wdenk | c0aa5c5 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2362 | - Interrupt support (PPC): |
| 2363 | |
wdenk | 1ebf41e | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2364 | There are common interrupt_init() and timer_interrupt() |
| 2365 | for all PPC archs. interrupt_init() calls interrupt_init_cpu() |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2366 | for CPU specific initialization. interrupt_init_cpu() |
wdenk | 1ebf41e | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2367 | should set decrementer_count to appropriate value. If |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2368 | CPU resets decrementer automatically after interrupt |
wdenk | 1ebf41e | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2369 | (ppc4xx) it should set decrementer_count to zero. |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2370 | timer_interrupt() calls timer_interrupt_cpu() for CPU |
wdenk | 1ebf41e | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2371 | specific handling. If board has watchdog / status_led |
| 2372 | / other_activity_monitor it works automatically from |
| 2373 | general timer_interrupt(). |
wdenk | c0aa5c5 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 2374 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2375 | - General: |
| 2376 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2377 | In the target system modem support is enabled when a |
| 2378 | specific key (key combination) is pressed during |
| 2379 | power-on. Otherwise U-Boot will boot normally |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2380 | (autoboot). The key_pressed() function is called from |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2381 | board_init(). Currently key_pressed() is a dummy |
| 2382 | function, returning 1 and thus enabling modem |
| 2383 | initialization. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2384 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2385 | If there are no modem init strings in the |
| 2386 | environment, U-Boot proceed to autoboot; the |
| 2387 | previous output (banner, info printfs) will be |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2388 | suppressed, though. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2389 | |
| 2390 | See also: doc/README.Modem |
| 2391 | |
| 2392 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2393 | Configuration Settings: |
| 2394 | ----------------------- |
| 2395 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2396 | - CONFIG_SYS_LONGHELP: Defined when you want long help messages included; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2397 | undefine this when you're short of memory. |
| 2398 | |
Peter Tyser | dfb72b8 | 2009-01-27 18:03:12 -0600 | [diff] [blame] | 2399 | - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default |
| 2400 | width of the commands listed in the 'help' command output. |
| 2401 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2402 | - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2403 | prompt for user input. |
| 2404 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2405 | - CONFIG_SYS_CBSIZE: Buffer size for input from the Console |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2406 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2407 | - CONFIG_SYS_PBSIZE: Buffer size for Console output |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2408 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2409 | - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2410 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2411 | - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2412 | the application (usually a Linux kernel) when it is |
| 2413 | booted |
| 2414 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2415 | - CONFIG_SYS_BAUDRATE_TABLE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2416 | List of legal baudrate settings for this board. |
| 2417 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2418 | - CONFIG_SYS_CONSOLE_INFO_QUIET |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2419 | Suppress display of console information at boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2420 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2421 | - CONFIG_SYS_CONSOLE_IS_IN_ENV |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2422 | If the board specific function |
| 2423 | extern int overwrite_console (void); |
| 2424 | returns 1, the stdin, stderr and stdout are switched to the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2425 | serial port, else the settings in the environment are used. |
| 2426 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2427 | - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2428 | Enable the call to overwrite_console(). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2429 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2430 | - CONFIG_SYS_CONSOLE_ENV_OVERWRITE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2431 | Enable overwrite of previous console environment settings. |
| 2432 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2433 | - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2434 | Begin and End addresses of the area used by the |
| 2435 | simple memory test. |
| 2436 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2437 | - CONFIG_SYS_ALT_MEMTEST: |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2438 | Enable an alternate, more extensive memory test. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2439 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2440 | - CONFIG_SYS_MEMTEST_SCRATCH: |
wdenk | 5958f4a | 2003-09-18 09:21:33 +0000 | [diff] [blame] | 2441 | Scratch address used by the alternate memory test |
| 2442 | You only need to set this if address zero isn't writeable |
| 2443 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2444 | - CONFIG_SYS_MEM_TOP_HIDE (PPC only): |
| 2445 | If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, |
Stefan Roese | a13709f | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2446 | this specified memory area will get subtracted from the top |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2447 | (end) of RAM and won't get "touched" at all by U-Boot. By |
Stefan Roese | a13709f | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2448 | fixing up gd->ram_size the Linux kernel should gets passed |
| 2449 | the now "corrected" memory size and won't touch it either. |
| 2450 | This should work for arch/ppc and arch/powerpc. Only Linux |
Stefan Roese | 37f31bf | 2008-03-28 11:02:53 +0100 | [diff] [blame] | 2451 | board ports in arch/powerpc with bootwrapper support that |
Stefan Roese | a13709f | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2452 | recalculate the memory size from the SDRAM controller setup |
Stefan Roese | 37f31bf | 2008-03-28 11:02:53 +0100 | [diff] [blame] | 2453 | will have to get fixed in Linux additionally. |
Stefan Roese | a13709f | 2008-03-26 10:14:11 +0100 | [diff] [blame] | 2454 | |
| 2455 | This option can be used as a workaround for the 440EPx/GRx |
| 2456 | CHIP 11 errata where the last 256 bytes in SDRAM shouldn't |
| 2457 | be touched. |
| 2458 | |
| 2459 | WARNING: Please make sure that this value is a multiple of |
| 2460 | the Linux page size (normally 4k). If this is not the case, |
| 2461 | then the end address of the Linux memory will be located at a |
| 2462 | non page size aligned address and this could cause major |
| 2463 | problems. |
| 2464 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2465 | - CONFIG_SYS_TFTP_LOADADDR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2466 | Default load address for network file downloads |
| 2467 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2468 | - CONFIG_SYS_LOADS_BAUD_CHANGE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2469 | Enable temporary baudrate change while serial download |
| 2470 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2471 | - CONFIG_SYS_SDRAM_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2472 | Physical start address of SDRAM. _Must_ be 0 here. |
| 2473 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2474 | - CONFIG_SYS_MBIO_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2475 | Physical start address of Motherboard I/O (if using a |
| 2476 | Cogent motherboard) |
| 2477 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2478 | - CONFIG_SYS_FLASH_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2479 | Physical start address of Flash memory. |
| 2480 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2481 | - CONFIG_SYS_MONITOR_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2482 | Physical start address of boot monitor code (set by |
| 2483 | make config files to be same as the text base address |
Wolfgang Denk | 0708bc6 | 2010-10-07 21:51:12 +0200 | [diff] [blame] | 2484 | (CONFIG_SYS_TEXT_BASE) used when linking) - same as |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2485 | CONFIG_SYS_FLASH_BASE when booting from flash. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2486 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2487 | - CONFIG_SYS_MONITOR_LEN: |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 2488 | Size of memory reserved for monitor code, used to |
| 2489 | determine _at_compile_time_ (!) if the environment is |
| 2490 | embedded within the U-Boot image, or in a separate |
| 2491 | flash sector. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2492 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2493 | - CONFIG_SYS_MALLOC_LEN: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2494 | Size of DRAM reserved for malloc() use. |
| 2495 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2496 | - CONFIG_SYS_BOOTM_LEN: |
Stefan Roese | 5d5ce29 | 2006-03-13 11:16:36 +0100 | [diff] [blame] | 2497 | Normally compressed uImages are limited to an |
| 2498 | uncompressed size of 8 MBytes. If this is not enough, |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2499 | you can define CONFIG_SYS_BOOTM_LEN in your board config file |
Stefan Roese | 5d5ce29 | 2006-03-13 11:16:36 +0100 | [diff] [blame] | 2500 | to adjust this setting to your needs. |
| 2501 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2502 | - CONFIG_SYS_BOOTMAPSZ: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2503 | Maximum size of memory mapped by the startup code of |
| 2504 | the Linux kernel; all data that must be processed by |
Bartlomiej Sieka | c5648c8 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 2505 | the Linux kernel (bd_info, boot arguments, FDT blob if |
| 2506 | used) must be put below this limit, unless "bootm_low" |
| 2507 | enviroment variable is defined and non-zero. In such case |
| 2508 | all data for the Linux kernel must be between "bootm_low" |
Grant Likely | 2639638 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 2509 | and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment |
| 2510 | variable "bootm_mapsize" will override the value of |
| 2511 | CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, |
| 2512 | then the value in "bootm_size" will be used instead. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2513 | |
John Rigby | eea8e69 | 2010-10-13 13:57:35 -0600 | [diff] [blame] | 2514 | - CONFIG_SYS_BOOT_RAMDISK_HIGH: |
| 2515 | Enable initrd_high functionality. If defined then the |
| 2516 | initrd_high feature is enabled and the bootm ramdisk subcommand |
| 2517 | is enabled. |
| 2518 | |
| 2519 | - CONFIG_SYS_BOOT_GET_CMDLINE: |
| 2520 | Enables allocating and saving kernel cmdline in space between |
| 2521 | "bootm_low" and "bootm_low" + BOOTMAPSZ. |
| 2522 | |
| 2523 | - CONFIG_SYS_BOOT_GET_KBD: |
| 2524 | Enables allocating and saving a kernel copy of the bd_info in |
| 2525 | space between "bootm_low" and "bootm_low" + BOOTMAPSZ. |
| 2526 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2527 | - CONFIG_SYS_MAX_FLASH_BANKS: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2528 | Max number of Flash memory banks |
| 2529 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2530 | - CONFIG_SYS_MAX_FLASH_SECT: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2531 | Max number of sectors on a Flash chip |
| 2532 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2533 | - CONFIG_SYS_FLASH_ERASE_TOUT: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2534 | Timeout for Flash erase operations (in ms) |
| 2535 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2536 | - CONFIG_SYS_FLASH_WRITE_TOUT: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2537 | Timeout for Flash write operations (in ms) |
| 2538 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2539 | - CONFIG_SYS_FLASH_LOCK_TOUT |
wdenk | dccbda0 | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 2540 | Timeout for Flash set sector lock bit operation (in ms) |
| 2541 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2542 | - CONFIG_SYS_FLASH_UNLOCK_TOUT |
wdenk | dccbda0 | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 2543 | Timeout for Flash clear lock bits operation (in ms) |
| 2544 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2545 | - CONFIG_SYS_FLASH_PROTECTION |
wdenk | dccbda0 | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 2546 | If defined, hardware flash sectors protection is used |
| 2547 | instead of U-Boot software protection. |
| 2548 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2549 | - CONFIG_SYS_DIRECT_FLASH_TFTP: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2550 | |
| 2551 | Enable TFTP transfers directly to flash memory; |
| 2552 | without this option such a download has to be |
| 2553 | performed in two steps: (1) download to RAM, and (2) |
| 2554 | copy from RAM to flash. |
| 2555 | |
| 2556 | The two-step approach is usually more reliable, since |
| 2557 | you can check if the download worked before you erase |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2558 | the flash, but in some situations (when system RAM is |
| 2559 | too limited to allow for a temporary copy of the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2560 | downloaded image) this option may be very useful. |
| 2561 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2562 | - CONFIG_SYS_FLASH_CFI: |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2563 | Define if the flash driver uses extra elements in the |
wdenk | 2cefd15 | 2004-02-08 22:55:38 +0000 | [diff] [blame] | 2564 | common flash structure for storing flash geometry. |
| 2565 | |
Jean-Christophe PLAGNIOL-VILLARD | 8d94c23 | 2008-08-13 01:40:42 +0200 | [diff] [blame] | 2566 | - CONFIG_FLASH_CFI_DRIVER |
wdenk | 2cefd15 | 2004-02-08 22:55:38 +0000 | [diff] [blame] | 2567 | This option also enables the building of the cfi_flash driver |
| 2568 | in the drivers directory |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2569 | |
Piotr Ziecik | 3e939e9 | 2008-11-17 15:57:58 +0100 | [diff] [blame] | 2570 | - CONFIG_FLASH_CFI_MTD |
| 2571 | This option enables the building of the cfi_mtd driver |
| 2572 | in the drivers directory. The driver exports CFI flash |
| 2573 | to the MTD layer. |
| 2574 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2575 | - CONFIG_SYS_FLASH_USE_BUFFER_WRITE |
Guennadi Liakhovetski | 183284f | 2008-04-03 13:36:02 +0200 | [diff] [blame] | 2576 | Use buffered writes to flash. |
| 2577 | |
| 2578 | - CONFIG_FLASH_SPANSION_S29WS_N |
| 2579 | s29ws-n MirrorBit flash has non-standard addresses for buffered |
| 2580 | write commands. |
| 2581 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2582 | - CONFIG_SYS_FLASH_QUIET_TEST |
Stefan Roese | c443fe9 | 2005-11-22 13:20:42 +0100 | [diff] [blame] | 2583 | If this option is defined, the common CFI flash doesn't |
| 2584 | print it's warning upon not recognized FLASH banks. This |
| 2585 | is useful, if some of the configured banks are only |
| 2586 | optionally available. |
| 2587 | |
Jerry Van Baren | aae7357 | 2008-03-08 13:48:01 -0500 | [diff] [blame] | 2588 | - CONFIG_FLASH_SHOW_PROGRESS |
| 2589 | If defined (must be an integer), print out countdown |
| 2590 | digits and dots. Recommended value: 45 (9..1) for 80 |
| 2591 | column displays, 15 (3..1) for 40 column displays. |
| 2592 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2593 | - CONFIG_SYS_RX_ETH_BUFFER: |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2594 | Defines the number of Ethernet receive buffers. On some |
| 2595 | Ethernet controllers it is recommended to set this value |
stroese | 94ef1cf | 2003-06-05 15:39:44 +0000 | [diff] [blame] | 2596 | to 8 or even higher (EEPRO100 or 405 EMAC), since all |
| 2597 | buffers can be full shortly after enabling the interface |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2598 | on high Ethernet traffic. |
stroese | 94ef1cf | 2003-06-05 15:39:44 +0000 | [diff] [blame] | 2599 | Defaults to 4 if not defined. |
| 2600 | |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 2601 | - CONFIG_ENV_MAX_ENTRIES |
| 2602 | |
Wolfgang Denk | 1136f69 | 2010-10-27 22:48:30 +0200 | [diff] [blame] | 2603 | Maximum number of entries in the hash table that is used |
| 2604 | internally to store the environment settings. The default |
| 2605 | setting is supposed to be generous and should work in most |
| 2606 | cases. This setting can be used to tune behaviour; see |
| 2607 | lib/hashtable.c for details. |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 2608 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2609 | The following definitions that deal with the placement and management |
| 2610 | of environment data (variable area); in general, we support the |
| 2611 | following configurations: |
| 2612 | |
Mike Frysinger | 63b8f12 | 2011-07-08 10:44:25 +0000 | [diff] [blame] | 2613 | - CONFIG_BUILD_ENVCRC: |
| 2614 | |
| 2615 | Builds up envcrc with the target environment so that external utils |
| 2616 | may easily extract it and embed it in final U-Boot images. |
| 2617 | |
Jean-Christophe PLAGNIOL-VILLARD | 53db4cd | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 2618 | - CONFIG_ENV_IS_IN_FLASH: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2619 | |
| 2620 | Define this if the environment is in flash memory. |
| 2621 | |
| 2622 | a) The environment occupies one whole flash sector, which is |
| 2623 | "embedded" in the text segment with the U-Boot code. This |
| 2624 | happens usually with "bottom boot sector" or "top boot |
| 2625 | sector" type flash chips, which have several smaller |
| 2626 | sectors at the start or the end. For instance, such a |
| 2627 | layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In |
| 2628 | such a case you would place the environment in one of the |
| 2629 | 4 kB sectors - with U-Boot code before and after it. With |
| 2630 | "top boot sector" type flash chips, you would put the |
| 2631 | environment in one of the last sectors, leaving a gap |
| 2632 | between U-Boot and the environment. |
| 2633 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2634 | - CONFIG_ENV_OFFSET: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2635 | |
| 2636 | Offset of environment data (variable area) to the |
| 2637 | beginning of flash memory; for instance, with bottom boot |
| 2638 | type flash chips the second sector can be used: the offset |
| 2639 | for this sector is given here. |
| 2640 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2641 | CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2642 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2643 | - CONFIG_ENV_ADDR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2644 | |
| 2645 | This is just another way to specify the start address of |
| 2646 | the flash sector containing the environment (instead of |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2647 | CONFIG_ENV_OFFSET). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2648 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2649 | - CONFIG_ENV_SECT_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2650 | |
| 2651 | Size of the sector containing the environment. |
| 2652 | |
| 2653 | |
| 2654 | b) Sometimes flash chips have few, equal sized, BIG sectors. |
| 2655 | In such a case you don't want to spend a whole sector for |
| 2656 | the environment. |
| 2657 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2658 | - CONFIG_ENV_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2659 | |
Jean-Christophe PLAGNIOL-VILLARD | 53db4cd | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 2660 | If you use this in combination with CONFIG_ENV_IS_IN_FLASH |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2661 | and CONFIG_ENV_SECT_SIZE, you can specify to use only a part |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2662 | of this flash sector for the environment. This saves |
| 2663 | memory for the RAM copy of the environment. |
| 2664 | |
| 2665 | It may also save flash memory if you decide to use this |
| 2666 | when your environment is "embedded" within U-Boot code, |
| 2667 | since then the remainder of the flash sector could be used |
| 2668 | for U-Boot code. It should be pointed out that this is |
| 2669 | STRONGLY DISCOURAGED from a robustness point of view: |
| 2670 | updating the environment in flash makes it always |
| 2671 | necessary to erase the WHOLE sector. If something goes |
| 2672 | wrong before the contents has been restored from a copy in |
| 2673 | RAM, your target system will be dead. |
| 2674 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2675 | - CONFIG_ENV_ADDR_REDUND |
| 2676 | CONFIG_ENV_SIZE_REDUND |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2677 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2678 | These settings describe a second storage area used to hold |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2679 | a redundant copy of the environment data, so that there is |
wdenk | b02744a | 2003-04-05 00:53:31 +0000 | [diff] [blame] | 2680 | a valid backup copy in case there is a power failure during |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2681 | a "saveenv" operation. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2682 | |
| 2683 | BE CAREFUL! Any changes to the flash layout, and some changes to the |
| 2684 | source code will make it necessary to adapt <board>/u-boot.lds* |
| 2685 | accordingly! |
| 2686 | |
| 2687 | |
Jean-Christophe PLAGNIOL-VILLARD | fdb79c3 | 2008-09-10 22:47:59 +0200 | [diff] [blame] | 2688 | - CONFIG_ENV_IS_IN_NVRAM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2689 | |
| 2690 | Define this if you have some non-volatile memory device |
| 2691 | (NVRAM, battery buffered SRAM) which you want to use for the |
| 2692 | environment. |
| 2693 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2694 | - CONFIG_ENV_ADDR: |
| 2695 | - CONFIG_ENV_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2696 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2697 | These two #defines are used to determine the memory area you |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2698 | want to use for environment. It is assumed that this memory |
| 2699 | can just be read and written to, without any special |
| 2700 | provision. |
| 2701 | |
| 2702 | BE CAREFUL! The first access to the environment happens quite early |
| 2703 | in U-Boot initalization (when we try to get the setting of for the |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2704 | console baudrate). You *MUST* have mapped your NVRAM area then, or |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2705 | U-Boot will hang. |
| 2706 | |
| 2707 | Please note that even with NVRAM we still use a copy of the |
| 2708 | environment in RAM: we could work on NVRAM directly, but we want to |
| 2709 | keep settings there always unmodified except somebody uses "saveenv" |
| 2710 | to save the current settings. |
| 2711 | |
| 2712 | |
Jean-Christophe PLAGNIOL-VILLARD | e46af64 | 2008-09-05 09:19:30 +0200 | [diff] [blame] | 2713 | - CONFIG_ENV_IS_IN_EEPROM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2714 | |
| 2715 | Use this if you have an EEPROM or similar serial access |
| 2716 | device and a driver for it. |
| 2717 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2718 | - CONFIG_ENV_OFFSET: |
| 2719 | - CONFIG_ENV_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2720 | |
| 2721 | These two #defines specify the offset and size of the |
| 2722 | environment area within the total memory of your EEPROM. |
| 2723 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2724 | - CONFIG_SYS_I2C_EEPROM_ADDR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2725 | If defined, specified the chip address of the EEPROM device. |
| 2726 | The default address is zero. |
| 2727 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2728 | - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2729 | If defined, the number of bits used to address bytes in a |
| 2730 | single page in the EEPROM device. A 64 byte page, for example |
| 2731 | would require six bits. |
| 2732 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2733 | - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2734 | If defined, the number of milliseconds to delay between |
wdenk | 544e973 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 2735 | page writes. The default is zero milliseconds. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2736 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2737 | - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2738 | The length in bytes of the EEPROM memory array address. Note |
| 2739 | that this is NOT the chip address length! |
| 2740 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2741 | - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: |
wdenk | 20c98a6 | 2004-04-23 20:32:05 +0000 | [diff] [blame] | 2742 | EEPROM chips that implement "address overflow" are ones |
| 2743 | like Catalyst 24WC04/08/16 which has 9/10/11 bits of |
| 2744 | address and the extra bits end up in the "chip address" bit |
| 2745 | slots. This makes a 24WC08 (1Kbyte) chip look like four 256 |
| 2746 | byte chips. |
| 2747 | |
| 2748 | Note that we consider the length of the address field to |
| 2749 | still be one byte because the extra address bits are hidden |
| 2750 | in the chip address. |
| 2751 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2752 | - CONFIG_SYS_EEPROM_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2753 | The size in bytes of the EEPROM device. |
| 2754 | |
Heiko Schocher | 9bb0dd5 | 2010-01-07 08:55:40 +0100 | [diff] [blame] | 2755 | - CONFIG_ENV_EEPROM_IS_ON_I2C |
| 2756 | define this, if you have I2C and SPI activated, and your |
| 2757 | EEPROM, which holds the environment, is on the I2C bus. |
| 2758 | |
| 2759 | - CONFIG_I2C_ENV_EEPROM_BUS |
| 2760 | if you have an Environment on an EEPROM reached over |
| 2761 | I2C muxes, you can define here, how to reach this |
| 2762 | EEPROM. For example: |
| 2763 | |
Wolfgang Denk | 16fa98a | 2010-06-13 17:48:15 +0200 | [diff] [blame] | 2764 | #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" |
Heiko Schocher | 9bb0dd5 | 2010-01-07 08:55:40 +0100 | [diff] [blame] | 2765 | |
| 2766 | EEPROM which holds the environment, is reached over |
| 2767 | a pca9547 i2c mux with address 0x70, channel 3. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2768 | |
Jean-Christophe PLAGNIOL-VILLARD | 2b14d2b | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 2769 | - CONFIG_ENV_IS_IN_DATAFLASH: |
wdenk | 8676590 | 2003-12-06 23:55:10 +0000 | [diff] [blame] | 2770 | |
wdenk | 1ebf41e | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 2771 | Define this if you have a DataFlash memory device which you |
wdenk | 8676590 | 2003-12-06 23:55:10 +0000 | [diff] [blame] | 2772 | want to use for the environment. |
| 2773 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2774 | - CONFIG_ENV_OFFSET: |
| 2775 | - CONFIG_ENV_ADDR: |
| 2776 | - CONFIG_ENV_SIZE: |
wdenk | 8676590 | 2003-12-06 23:55:10 +0000 | [diff] [blame] | 2777 | |
| 2778 | These three #defines specify the offset and size of the |
| 2779 | environment area within the total memory of your DataFlash placed |
| 2780 | at the specified address. |
| 2781 | |
Jean-Christophe PLAGNIOL-VILLARD | dda84dd | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 2782 | - CONFIG_ENV_IS_IN_NAND: |
wdenk | 79b5937 | 2004-06-09 14:58:14 +0000 | [diff] [blame] | 2783 | |
| 2784 | Define this if you have a NAND device which you want to use |
| 2785 | for the environment. |
| 2786 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2787 | - CONFIG_ENV_OFFSET: |
| 2788 | - CONFIG_ENV_SIZE: |
wdenk | 79b5937 | 2004-06-09 14:58:14 +0000 | [diff] [blame] | 2789 | |
| 2790 | These two #defines specify the offset and size of the environment |
Scott Wood | 0823932 | 2010-09-17 14:38:37 -0500 | [diff] [blame] | 2791 | area within the first NAND device. CONFIG_ENV_OFFSET must be |
| 2792 | aligned to an erase block boundary. |
wdenk | 8676590 | 2003-12-06 23:55:10 +0000 | [diff] [blame] | 2793 | |
Scott Wood | 0823932 | 2010-09-17 14:38:37 -0500 | [diff] [blame] | 2794 | - CONFIG_ENV_OFFSET_REDUND (optional): |
Markus Klotzbuecher | 5d113e0 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 2795 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 2796 | This setting describes a second storage area of CONFIG_ENV_SIZE |
Scott Wood | 0823932 | 2010-09-17 14:38:37 -0500 | [diff] [blame] | 2797 | size used to hold a redundant copy of the environment data, so |
| 2798 | that there is a valid backup copy in case there is a power failure |
| 2799 | during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be |
| 2800 | aligned to an erase block boundary. |
| 2801 | |
| 2802 | - CONFIG_ENV_RANGE (optional): |
| 2803 | |
| 2804 | Specifies the length of the region in which the environment |
| 2805 | can be written. This should be a multiple of the NAND device's |
| 2806 | block size. Specifying a range with more erase blocks than |
| 2807 | are needed to hold CONFIG_ENV_SIZE allows bad blocks within |
| 2808 | the range to be avoided. |
| 2809 | |
| 2810 | - CONFIG_ENV_OFFSET_OOB (optional): |
Markus Klotzbuecher | 5d113e0 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 2811 | |
Scott Wood | 0823932 | 2010-09-17 14:38:37 -0500 | [diff] [blame] | 2812 | Enables support for dynamically retrieving the offset of the |
| 2813 | environment from block zero's out-of-band data. The |
| 2814 | "nand env.oob" command can be used to record this offset. |
| 2815 | Currently, CONFIG_ENV_OFFSET_REDUND is not supported when |
| 2816 | using CONFIG_ENV_OFFSET_OOB. |
Markus Klotzbuecher | 5d113e0 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 2817 | |
Guennadi Liakhovetski | fad2444 | 2009-05-18 16:07:22 +0200 | [diff] [blame] | 2818 | - CONFIG_NAND_ENV_DST |
| 2819 | |
| 2820 | Defines address in RAM to which the nand_spl code should copy the |
| 2821 | environment. If redundant environment is used, it will be copied to |
| 2822 | CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. |
| 2823 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2824 | - CONFIG_SYS_SPI_INIT_OFFSET |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2825 | |
| 2826 | Defines offset to the initial SPI buffer area in DPRAM. The |
| 2827 | area is used at an early stage (ROM part) if the environment |
| 2828 | is configured to reside in the SPI EEPROM: We need a 520 byte |
| 2829 | scratch DPRAM area. It is used between the two initialization |
| 2830 | calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems |
| 2831 | to be a good choice since it makes it far enough from the |
| 2832 | start of the data area as well as from the stack pointer. |
| 2833 | |
Bruce Adler | edecc94 | 2007-11-02 13:15:42 -0700 | [diff] [blame] | 2834 | Please note that the environment is read-only until the monitor |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2835 | has been relocated to RAM and a RAM copy of the environment has been |
Wolfgang Denk | 76af278 | 2010-07-24 21:55:43 +0200 | [diff] [blame] | 2836 | created; also, when using EEPROM you will have to use getenv_f() |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2837 | until then to read environment variables. |
| 2838 | |
wdenk | 8dba050 | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 2839 | The environment is protected by a CRC32 checksum. Before the monitor |
| 2840 | is relocated into RAM, as a result of a bad CRC you will be working |
| 2841 | with the compiled-in default environment - *silently*!!! [This is |
| 2842 | necessary, because the first environment variable we need is the |
| 2843 | "baudrate" setting for the console - if we have a bad CRC, we don't |
| 2844 | have any device yet where we could complain.] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2845 | |
| 2846 | Note: once the monitor has been relocated, then it will complain if |
| 2847 | 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] | 2848 | use the "saveenv" command to store a valid environment. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2849 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2850 | - CONFIG_SYS_FAULT_ECHO_LINK_DOWN: |
wdenk | 9c53f40 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 2851 | Echo the inverted Ethernet link state to the fault LED. |
wdenk | 49c3f67 | 2003-10-08 22:33:00 +0000 | [diff] [blame] | 2852 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2853 | Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR |
wdenk | 49c3f67 | 2003-10-08 22:33:00 +0000 | [diff] [blame] | 2854 | also needs to be defined. |
| 2855 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2856 | - CONFIG_SYS_FAULT_MII_ADDR: |
wdenk | 9c53f40 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 2857 | MII address of the PHY to check for the Ethernet link state. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2858 | |
Ron Madrid | dfa028a | 2009-02-18 14:30:44 -0800 | [diff] [blame] | 2859 | - CONFIG_NS16550_MIN_FUNCTIONS: |
| 2860 | Define this if you desire to only have use of the NS16550_init |
| 2861 | and NS16550_putc functions for the serial driver located at |
| 2862 | drivers/serial/ns16550.c. This option is useful for saving |
| 2863 | space for already greatly restricted images, including but not |
| 2864 | limited to NAND_SPL configurations. |
| 2865 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2866 | Low Level (hardware related) configuration options: |
wdenk | c8434db | 2003-03-26 06:55:25 +0000 | [diff] [blame] | 2867 | --------------------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2868 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2869 | - CONFIG_SYS_CACHELINE_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2870 | Cache Line Size of the CPU. |
| 2871 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2872 | - CONFIG_SYS_DEFAULT_IMMR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2873 | Default address of the IMMR after system reset. |
wdenk | 2bb1105 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 2874 | |
wdenk | 9c53f40 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 2875 | Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, |
| 2876 | and RPXsuper) to be able to adjust the position of |
| 2877 | the IMMR register after a reset. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2878 | |
Timur Tabi | d8f341c | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 2879 | - CONFIG_SYS_CCSRBAR_DEFAULT: |
| 2880 | Default (power-on reset) physical address of CCSR on Freescale |
| 2881 | PowerPC SOCs. |
| 2882 | |
| 2883 | - CONFIG_SYS_CCSRBAR: |
| 2884 | Virtual address of CCSR. On a 32-bit build, this is typically |
| 2885 | the same value as CONFIG_SYS_CCSRBAR_DEFAULT. |
| 2886 | |
| 2887 | CONFIG_SYS_DEFAULT_IMMR must also be set to this value, |
| 2888 | for cross-platform code that uses that macro instead. |
| 2889 | |
| 2890 | - CONFIG_SYS_CCSRBAR_PHYS: |
| 2891 | Physical address of CCSR. CCSR can be relocated to a new |
| 2892 | physical address, if desired. In this case, this macro should |
| 2893 | be set to that address. Otherwise, it should be set to the |
| 2894 | same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR |
| 2895 | is typically relocated on 36-bit builds. It is recommended |
| 2896 | that this macro be defined via the _HIGH and _LOW macros: |
| 2897 | |
| 2898 | #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH |
| 2899 | * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) |
| 2900 | |
| 2901 | - CONFIG_SYS_CCSRBAR_PHYS_HIGH: |
| 2902 | Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically |
| 2903 | either 0 (32-bit build) or 0xF (36-bit build). This macro is |
| 2904 | used in assembly code, so it must not contain typecasts or |
| 2905 | integer size suffixes (e.g. "ULL"). |
| 2906 | |
| 2907 | - CONFIG_SYS_CCSRBAR_PHYS_LOW: |
| 2908 | Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is |
| 2909 | used in assembly code, so it must not contain typecasts or |
| 2910 | integer size suffixes (e.g. "ULL"). |
| 2911 | |
| 2912 | - CONFIG_SYS_CCSR_DO_NOT_RELOCATE: |
| 2913 | If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be |
| 2914 | forced to a value that ensures that CCSR is not relocated. |
| 2915 | |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2916 | - Floppy Disk Support: |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2917 | CONFIG_SYS_FDC_DRIVE_NUMBER |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2918 | |
| 2919 | the default drive number (default value 0) |
| 2920 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2921 | CONFIG_SYS_ISA_IO_STRIDE |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2922 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2923 | defines the spacing between FDC chipset registers |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2924 | (default value 1) |
| 2925 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2926 | CONFIG_SYS_ISA_IO_OFFSET |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2927 | |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2928 | defines the offset of register from address. It |
| 2929 | depends on which part of the data bus is connected to |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2930 | the FDC chipset. (default value 0) |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2931 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2932 | If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and |
| 2933 | CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2934 | default value. |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2935 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2936 | if CONFIG_SYS_FDC_HW_INIT is defined, then the function |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2937 | fdc_hw_init() is called at the beginning of the FDC |
| 2938 | setup. fdc_hw_init() must be provided by the board |
| 2939 | source code. It is used to make hardware dependant |
| 2940 | initializations. |
wdenk | 1272e23 | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 2941 | |
Macpaul Lin | d1e4994 | 2011-04-11 20:45:32 +0000 | [diff] [blame] | 2942 | - CONFIG_IDE_AHB: |
| 2943 | Most IDE controllers were designed to be connected with PCI |
| 2944 | interface. Only few of them were designed for AHB interface. |
| 2945 | When software is doing ATA command and data transfer to |
| 2946 | IDE devices through IDE-AHB controller, some additional |
| 2947 | registers accessing to these kind of IDE-AHB controller |
| 2948 | is requierd. |
| 2949 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2950 | - CONFIG_SYS_IMMR: Physical address of the Internal Memory. |
wdenk | 07d7e6b | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 2951 | DO NOT CHANGE unless you know exactly what you're |
wdenk | b3a4a70 | 2004-12-10 11:40:40 +0000 | [diff] [blame] | 2952 | doing! (11-4) [MPC8xx/82xx systems only] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2953 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2954 | - CONFIG_SYS_INIT_RAM_ADDR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2955 | |
wdenk | eb20ad3 | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 2956 | Start address of memory area that can be used for |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2957 | initial data and stack; please note that this must be |
| 2958 | writable memory that is working WITHOUT special |
| 2959 | initialization, i. e. you CANNOT use normal RAM which |
| 2960 | will become available only after programming the |
| 2961 | memory controller and running certain initialization |
| 2962 | sequences. |
| 2963 | |
| 2964 | U-Boot uses the following memory types: |
| 2965 | - MPC8xx and MPC8260: IMMR (internal memory of the CPU) |
| 2966 | - MPC824X: data cache |
| 2967 | - PPC4xx: data cache |
| 2968 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2969 | - CONFIG_SYS_GBL_DATA_OFFSET: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2970 | |
| 2971 | Offset of the initial data structure in the memory |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2972 | area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually |
| 2973 | CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2974 | data is located at the end of the available space |
Wolfgang Denk | 1c2e98e | 2010-10-26 13:32:32 +0200 | [diff] [blame] | 2975 | (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2976 | CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just |
| 2977 | below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + |
| 2978 | CONFIG_SYS_GBL_DATA_OFFSET) downward. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2979 | |
| 2980 | Note: |
| 2981 | On the MPC824X (or other systems that use the data |
| 2982 | cache for initial memory) the address chosen for |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2983 | CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2984 | point to an otherwise UNUSED address space between |
| 2985 | the top of RAM and the start of the PCI space. |
| 2986 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2987 | - CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2988 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2989 | - CONFIG_SYS_SYPCR: System Protection Control (11-9) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2990 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2991 | - CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2992 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2993 | - CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2994 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2995 | - CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2996 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2997 | - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2998 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2999 | - CONFIG_SYS_OR_TIMING_SDRAM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3000 | SDRAM timing |
| 3001 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3002 | - CONFIG_SYS_MAMR_PTA: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3003 | periodic timer for refresh |
| 3004 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3005 | - CONFIG_SYS_DER: Debug Event Register (37-47) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3006 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3007 | - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, |
| 3008 | CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, |
| 3009 | CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, |
| 3010 | CONFIG_SYS_BR1_PRELIM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3011 | Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) |
| 3012 | |
| 3013 | - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3014 | CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, |
| 3015 | CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3016 | Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) |
| 3017 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3018 | - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, |
| 3019 | CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3020 | Machine Mode Register and Memory Periodic Timer |
| 3021 | Prescaler definitions (SDRAM timing) |
| 3022 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3023 | - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3024 | enable I2C microcode relocation patch (MPC8xx); |
| 3025 | define relocation offset in DPRAM [DSP2] |
| 3026 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3027 | - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: |
Heiko Schocher | c8148ed | 2008-01-11 01:12:07 +0100 | [diff] [blame] | 3028 | enable SMC microcode relocation patch (MPC8xx); |
| 3029 | define relocation offset in DPRAM [SMC1] |
| 3030 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3031 | - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3032 | enable SPI microcode relocation patch (MPC8xx); |
| 3033 | define relocation offset in DPRAM [SCC4] |
| 3034 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3035 | - CONFIG_SYS_USE_OSCCLK: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3036 | Use OSCM clock mode on MBX8xx board. Be careful, |
| 3037 | wrong setting might damage your board. Read |
| 3038 | doc/README.MBX before setting this variable! |
| 3039 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3040 | - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 3041 | Offset of the bootmode word in DPRAM used by post |
| 3042 | (Power On Self Tests). This definition overrides |
| 3043 | #define'd default value in commproc.h resp. |
| 3044 | cpm_8260.h. |
wdenk | 2029f4d | 2002-11-21 23:11:29 +0000 | [diff] [blame] | 3045 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3046 | - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, |
| 3047 | CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, |
| 3048 | CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, |
| 3049 | CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, |
| 3050 | CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, |
| 3051 | CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, |
| 3052 | CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, |
| 3053 | CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 3054 | Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. |
wdenk | bf2f8c9 | 2003-05-22 22:52:13 +0000 | [diff] [blame] | 3055 | |
Dirk Eibach | 378d1ca | 2009-02-09 08:18:34 +0100 | [diff] [blame] | 3056 | - CONFIG_PCI_DISABLE_PCIE: |
| 3057 | Disable PCI-Express on systems where it is supported but not |
| 3058 | required. |
| 3059 | |
Kumar Gala | 8975d7a | 2010-12-30 12:09:53 -0600 | [diff] [blame] | 3060 | - CONFIG_SYS_SRIO: |
| 3061 | Chip has SRIO or not |
| 3062 | |
| 3063 | - CONFIG_SRIO1: |
| 3064 | Board has SRIO 1 port available |
| 3065 | |
| 3066 | - CONFIG_SRIO2: |
| 3067 | Board has SRIO 2 port available |
| 3068 | |
| 3069 | - CONFIG_SYS_SRIOn_MEM_VIRT: |
| 3070 | Virtual Address of SRIO port 'n' memory region |
| 3071 | |
| 3072 | - CONFIG_SYS_SRIOn_MEM_PHYS: |
| 3073 | Physical Address of SRIO port 'n' memory region |
| 3074 | |
| 3075 | - CONFIG_SYS_SRIOn_MEM_SIZE: |
| 3076 | Size of SRIO port 'n' memory region |
| 3077 | |
Alex Waterman | cd6aae3 | 2011-05-19 15:08:36 -0400 | [diff] [blame] | 3078 | - CONFIG_SYS_NDFC_16 |
| 3079 | Defined to tell the NDFC that the NAND chip is using a |
| 3080 | 16 bit bus. |
| 3081 | |
| 3082 | - CONFIG_SYS_NDFC_EBC0_CFG |
| 3083 | Sets the EBC0_CFG register for the NDFC. If not defined |
| 3084 | a default value will be used. |
| 3085 | |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 3086 | - CONFIG_SPD_EEPROM |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3087 | Get DDR timing information from an I2C EEPROM. Common |
| 3088 | with pluggable memory modules such as SODIMMs |
| 3089 | |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 3090 | SPD_EEPROM_ADDRESS |
| 3091 | I2C address of the SPD EEPROM |
| 3092 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3093 | - CONFIG_SYS_SPD_BUS_NUM |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3094 | If SPD EEPROM is on an I2C bus other than the first |
| 3095 | one, specify here. Note that the value must resolve |
| 3096 | to something your driver can deal with. |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 3097 | |
York Sun | e73cc04 | 2011-06-07 09:42:16 +0800 | [diff] [blame] | 3098 | - CONFIG_SYS_DDR_RAW_TIMING |
| 3099 | Get DDR timing information from other than SPD. Common with |
| 3100 | soldered DDR chips onboard without SPD. DDR raw timing |
| 3101 | parameters are extracted from datasheet and hard-coded into |
| 3102 | header files or board specific files. |
| 3103 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3104 | - CONFIG_SYS_83XX_DDR_USES_CS0 |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3105 | Only for 83xx systems. If specified, then DDR should |
| 3106 | be configured using CS0 and CS1 instead of CS2 and CS3. |
Timur Tabi | 054838e | 2006-10-31 18:44:42 -0600 | [diff] [blame] | 3107 | |
wdenk | 6203e40 | 2004-04-18 10:13:26 +0000 | [diff] [blame] | 3108 | - CONFIG_ETHER_ON_FEC[12] |
| 3109 | Define to enable FEC[12] on a 8xx series processor. |
| 3110 | |
| 3111 | - CONFIG_FEC[12]_PHY |
| 3112 | Define to the hardcoded PHY address which corresponds |
wdenk | 0593920 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 3113 | to the given FEC; i. e. |
| 3114 | #define CONFIG_FEC1_PHY 4 |
wdenk | 6203e40 | 2004-04-18 10:13:26 +0000 | [diff] [blame] | 3115 | means that the PHY with address 4 is connected to FEC1 |
| 3116 | |
| 3117 | When set to -1, means to probe for first available. |
| 3118 | |
| 3119 | - CONFIG_FEC[12]_PHY_NORXERR |
| 3120 | The PHY does not have a RXERR line (RMII only). |
| 3121 | (so program the FEC to ignore it). |
| 3122 | |
| 3123 | - CONFIG_RMII |
| 3124 | Enable RMII mode for all FECs. |
| 3125 | Note that this is a global option, we can't |
| 3126 | have one FEC in standard MII mode and another in RMII mode. |
| 3127 | |
wdenk | 20c98a6 | 2004-04-23 20:32:05 +0000 | [diff] [blame] | 3128 | - CONFIG_CRC32_VERIFY |
| 3129 | Add a verify option to the crc32 command. |
| 3130 | The syntax is: |
| 3131 | |
| 3132 | => crc32 -v <address> <count> <crc32> |
| 3133 | |
| 3134 | Where address/count indicate a memory area |
| 3135 | and crc32 is the correct crc32 which the |
| 3136 | area should have. |
| 3137 | |
wdenk | 6451936 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 3138 | - CONFIG_LOOPW |
| 3139 | Add the "loopw" memory command. This only takes effect if |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 3140 | the memory commands are activated globally (CONFIG_CMD_MEM). |
wdenk | 6451936 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 3141 | |
stroese | cc3af83 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3142 | - CONFIG_MX_CYCLIC |
| 3143 | Add the "mdc" and "mwc" memory commands. These are cyclic |
| 3144 | "md/mw" commands. |
| 3145 | Examples: |
| 3146 | |
wdenk | 07d7e6b | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3147 | => mdc.b 10 4 500 |
stroese | cc3af83 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3148 | This command will print 4 bytes (10,11,12,13) each 500 ms. |
| 3149 | |
wdenk | 07d7e6b | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3150 | => mwc.l 100 12345678 10 |
stroese | cc3af83 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3151 | This command will write 12345678 to address 100 all 10 ms. |
| 3152 | |
wdenk | 07d7e6b | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 3153 | This only takes effect if the memory commands are activated |
Jon Loeliger | c1da5c9 | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 3154 | globally (CONFIG_CMD_MEM). |
stroese | cc3af83 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 3155 | |
wdenk | 3d3d99f | 2005-04-04 12:44:11 +0000 | [diff] [blame] | 3156 | - CONFIG_SKIP_LOWLEVEL_INIT |
Daniel Schwierzeck | d52a623 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 3157 | [ARM, MIPS only] If this variable is defined, then certain |
Wolfgang Denk | 302141d | 2010-11-27 23:30:56 +0100 | [diff] [blame] | 3158 | low level initializations (like setting up the memory |
| 3159 | controller) are omitted and/or U-Boot does not |
| 3160 | relocate itself into RAM. |
wdenk | 3d3d99f | 2005-04-04 12:44:11 +0000 | [diff] [blame] | 3161 | |
Wolfgang Denk | 302141d | 2010-11-27 23:30:56 +0100 | [diff] [blame] | 3162 | Normally this variable MUST NOT be defined. The only |
| 3163 | exception is when U-Boot is loaded (to RAM) by some |
| 3164 | other boot loader or by a debugger which performs |
| 3165 | these initializations itself. |
wdenk | 3d3d99f | 2005-04-04 12:44:11 +0000 | [diff] [blame] | 3166 | |
Aneesh V | 552a319 | 2011-07-13 05:11:07 +0000 | [diff] [blame] | 3167 | - CONFIG_SPL_BUILD |
Magnus Lilja | 1ec96d8 | 2009-06-13 20:50:00 +0200 | [diff] [blame] | 3168 | Modifies the behaviour of start.S when compiling a loader |
| 3169 | that is executed before the actual U-Boot. E.g. when |
| 3170 | compiling a NAND SPL. |
wdenk | 336b2bc | 2005-04-02 23:52:25 +0000 | [diff] [blame] | 3171 | |
Matthias Weisser | 93416c1 | 2011-03-10 21:36:32 +0000 | [diff] [blame] | 3172 | - CONFIG_USE_ARCH_MEMCPY |
| 3173 | CONFIG_USE_ARCH_MEMSET |
| 3174 | If these options are used a optimized version of memcpy/memset will |
| 3175 | be used if available. These functions may be faster under some |
| 3176 | conditions but may increase the binary size. |
| 3177 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3178 | Building the Software: |
| 3179 | ====================== |
| 3180 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3181 | Building U-Boot has been tested in several native build environments |
| 3182 | and in many different cross environments. Of course we cannot support |
| 3183 | all possibly existing versions of cross development tools in all |
| 3184 | (potentially obsolete) versions. In case of tool chain problems we |
| 3185 | recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) |
| 3186 | which is extensively used to build and test U-Boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3187 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3188 | If you are not using a native environment, it is assumed that you |
| 3189 | have GNU cross compiling tools available in your path. In this case, |
| 3190 | you must set the environment variable CROSS_COMPILE in your shell. |
| 3191 | Note that no changes to the Makefile or any other source files are |
| 3192 | necessary. For example using the ELDK on a 4xx CPU, please enter: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3193 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3194 | $ CROSS_COMPILE=ppc_4xx- |
| 3195 | $ export CROSS_COMPILE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3196 | |
Peter Tyser | b06976d | 2009-03-13 18:54:51 -0500 | [diff] [blame] | 3197 | Note: If you wish to generate Windows versions of the utilities in |
| 3198 | the tools directory you can use the MinGW toolchain |
| 3199 | (http://www.mingw.org). Set your HOST tools to the MinGW |
| 3200 | toolchain and execute 'make tools'. For example: |
| 3201 | |
| 3202 | $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools |
| 3203 | |
| 3204 | Binaries such as tools/mkimage.exe will be created which can |
| 3205 | be executed on computers running Windows. |
| 3206 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3207 | U-Boot is intended to be simple to build. After installing the |
| 3208 | sources you must configure U-Boot for one specific board type. This |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3209 | is done by typing: |
| 3210 | |
| 3211 | make NAME_config |
| 3212 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3213 | where "NAME_config" is the name of one of the existing configu- |
| 3214 | rations; see the main Makefile for supported names. |
wdenk | 2f0812d | 2003-10-08 22:45:44 +0000 | [diff] [blame] | 3215 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3216 | Note: for some board special configuration names may exist; check if |
| 3217 | additional information is available from the board vendor; for |
| 3218 | instance, the TQM823L systems are available without (standard) |
| 3219 | or with LCD support. You can select such additional "features" |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3220 | when choosing the configuration, i. e. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3221 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3222 | make TQM823L_config |
| 3223 | - will configure for a plain TQM823L, i. e. no LCD support |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3224 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3225 | make TQM823L_LCD_config |
| 3226 | - will configure for a TQM823L with U-Boot console on LCD |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3227 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3228 | etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3229 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3230 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3231 | Finally, type "make all", and you should get some working U-Boot |
| 3232 | images ready for download to / installation on your system: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3233 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3234 | - "u-boot.bin" is a raw binary image |
| 3235 | - "u-boot" is an image in ELF binary format |
| 3236 | - "u-boot.srec" is in Motorola S-Record format |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3237 | |
Marian Balakowicz | efe063f | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3238 | By default the build is performed locally and the objects are saved |
| 3239 | in the source directory. One of the two methods can be used to change |
| 3240 | this behavior and build U-Boot to some external directory: |
| 3241 | |
| 3242 | 1. Add O= to the make command line invocations: |
| 3243 | |
| 3244 | make O=/tmp/build distclean |
| 3245 | make O=/tmp/build NAME_config |
| 3246 | make O=/tmp/build all |
| 3247 | |
| 3248 | 2. Set environment variable BUILD_DIR to point to the desired location: |
| 3249 | |
| 3250 | export BUILD_DIR=/tmp/build |
| 3251 | make distclean |
| 3252 | make NAME_config |
| 3253 | make all |
| 3254 | |
| 3255 | Note that the command line "O=" setting overrides the BUILD_DIR environment |
| 3256 | variable. |
| 3257 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3258 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3259 | Please be aware that the Makefiles assume you are using GNU make, so |
| 3260 | for instance on NetBSD you might need to use "gmake" instead of |
| 3261 | native "make". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3262 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3263 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3264 | If the system board that you have is not listed, then you will need |
| 3265 | to port U-Boot to your hardware platform. To do this, follow these |
| 3266 | steps: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3267 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3268 | 1. Add a new configuration option for your board to the toplevel |
| 3269 | "Makefile" and to the "MAKEALL" script, using the existing |
| 3270 | entries as examples. Note that here and at many other places |
| 3271 | boards and other names are listed in alphabetical sort order. Please |
| 3272 | keep this order. |
| 3273 | 2. Create a new directory to hold your board specific code. Add any |
| 3274 | files you need. In your board directory, you will need at least |
| 3275 | the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". |
| 3276 | 3. Create a new configuration file "include/configs/<board>.h" for |
| 3277 | your board |
| 3278 | 3. If you're porting U-Boot to a new CPU, then also create a new |
| 3279 | directory to hold your CPU specific code. Add any files you need. |
| 3280 | 4. Run "make <board>_config" with your new name. |
| 3281 | 5. Type "make", and you should get a working "u-boot.srec" file |
| 3282 | to be installed on your target system. |
| 3283 | 6. Debug and solve any problems that might arise. |
| 3284 | [Of course, this last step is much harder than it sounds.] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3285 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3286 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3287 | Testing of U-Boot Modifications, Ports to New Hardware, etc.: |
| 3288 | ============================================================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3289 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3290 | If you have modified U-Boot sources (for instance added a new board |
| 3291 | or support for new devices, a new CPU, etc.) you are expected to |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3292 | provide feedback to the other developers. The feedback normally takes |
| 3293 | 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] | 3294 | official or latest in the git repository) version of U-Boot sources. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3295 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3296 | But before you submit such a patch, please verify that your modifi- |
| 3297 | cation did not break existing code. At least make sure that *ALL* of |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3298 | the supported boards compile WITHOUT ANY compiler warnings. To do so, |
| 3299 | just run the "MAKEALL" script, which will configure and build U-Boot |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3300 | for ALL supported system. Be warned, this will take a while. You can |
| 3301 | select which (cross) compiler to use by passing a `CROSS_COMPILE' |
| 3302 | environment variable to the script, i. e. to use the ELDK cross tools |
| 3303 | you can type |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3304 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3305 | CROSS_COMPILE=ppc_8xx- MAKEALL |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3306 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3307 | or to build on a native PowerPC system you can type |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3308 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3309 | CROSS_COMPILE=' ' MAKEALL |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3310 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3311 | When using the MAKEALL script, the default behaviour is to build |
| 3312 | U-Boot in the source directory. This location can be changed by |
| 3313 | setting the BUILD_DIR environment variable. Also, for each target |
| 3314 | built, the MAKEALL script saves two log files (<target>.ERR and |
| 3315 | <target>.MAKEALL) in the <source dir>/LOG directory. This default |
| 3316 | location can be changed by setting the MAKEALL_LOGDIR environment |
| 3317 | variable. For example: |
Marian Balakowicz | efe063f | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3318 | |
| 3319 | export BUILD_DIR=/tmp/build |
| 3320 | export MAKEALL_LOGDIR=/tmp/log |
| 3321 | CROSS_COMPILE=ppc_8xx- MAKEALL |
| 3322 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3323 | With the above settings build objects are saved in the /tmp/build, |
| 3324 | log files are saved in the /tmp/log and the source tree remains clean |
| 3325 | during the whole build process. |
Marian Balakowicz | efe063f | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 3326 | |
| 3327 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3328 | See also "U-Boot Porting Guide" below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3329 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3330 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3331 | Monitor Commands - Overview: |
| 3332 | ============================ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3333 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3334 | go - start application at address 'addr' |
| 3335 | run - run commands in an environment variable |
| 3336 | bootm - boot application image from memory |
| 3337 | bootp - boot image via network using BootP/TFTP protocol |
| 3338 | tftpboot- boot image via network using TFTP protocol |
| 3339 | and env variables "ipaddr" and "serverip" |
| 3340 | (and eventually "gatewayip") |
| 3341 | rarpboot- boot image via network using RARP/TFTP protocol |
| 3342 | diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' |
| 3343 | loads - load S-Record file over serial line |
| 3344 | loadb - load binary file over serial line (kermit mode) |
| 3345 | md - memory display |
| 3346 | mm - memory modify (auto-incrementing) |
| 3347 | nm - memory modify (constant address) |
| 3348 | mw - memory write (fill) |
| 3349 | cp - memory copy |
| 3350 | cmp - memory compare |
| 3351 | crc32 - checksum calculation |
Peter Tyser | 469cde4 | 2009-04-18 22:34:03 -0500 | [diff] [blame] | 3352 | i2c - I2C sub-system |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3353 | sspi - SPI utility commands |
| 3354 | base - print or set address offset |
| 3355 | printenv- print environment variables |
| 3356 | setenv - set environment variables |
| 3357 | saveenv - save environment variables to persistent storage |
| 3358 | protect - enable or disable FLASH write protection |
| 3359 | erase - erase FLASH memory |
| 3360 | flinfo - print FLASH memory information |
| 3361 | bdinfo - print Board Info structure |
| 3362 | iminfo - print header information for application image |
| 3363 | coninfo - print console devices and informations |
| 3364 | ide - IDE sub-system |
| 3365 | loop - infinite loop on address range |
wdenk | 6451936 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 3366 | loopw - infinite write loop on address range |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3367 | mtest - simple RAM test |
| 3368 | icache - enable or disable instruction cache |
| 3369 | dcache - enable or disable data cache |
| 3370 | reset - Perform RESET of the CPU |
| 3371 | echo - echo args to console |
| 3372 | version - print monitor version |
| 3373 | help - print online help |
| 3374 | ? - alias for 'help' |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3375 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3376 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3377 | Monitor Commands - Detailed Description: |
| 3378 | ======================================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3379 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3380 | TODO. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3381 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3382 | For now: just type "help <command>". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3383 | |
| 3384 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3385 | Environment Variables: |
| 3386 | ====================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3387 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3388 | U-Boot supports user configuration using Environment Variables which |
| 3389 | can be made persistent by saving to Flash memory. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3390 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3391 | Environment Variables are set using "setenv", printed using |
| 3392 | "printenv", and saved to Flash using "saveenv". Using "setenv" |
| 3393 | without a value can be used to delete a variable from the |
| 3394 | environment. As long as you don't save the environment you are |
| 3395 | working with an in-memory copy. In case the Flash area containing the |
| 3396 | environment is erased by accident, a default environment is provided. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3397 | |
Wolfgang Denk | b233bd7 | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 3398 | Some configuration options can be set using Environment Variables. |
| 3399 | |
| 3400 | List of environment variables (most likely not complete): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3401 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3402 | baudrate - see CONFIG_BAUDRATE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3403 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3404 | bootdelay - see CONFIG_BOOTDELAY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3405 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3406 | bootcmd - see CONFIG_BOOTCOMMAND |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3407 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3408 | bootargs - Boot arguments when booting an RTOS image |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3409 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3410 | bootfile - Name of the image to load with TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3411 | |
Bartlomiej Sieka | c5648c8 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 3412 | bootm_low - Memory range available for image processing in the bootm |
| 3413 | command can be restricted. This variable is given as |
| 3414 | a hexadecimal number and defines lowest address allowed |
| 3415 | for use by the bootm command. See also "bootm_size" |
| 3416 | environment variable. Address defined by "bootm_low" is |
| 3417 | also the base of the initial memory mapping for the Linux |
Grant Likely | 2639638 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 3418 | kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and |
| 3419 | bootm_mapsize. |
| 3420 | |
| 3421 | bootm_mapsize - Size of the initial memory mapping for the Linux kernel. |
| 3422 | This variable is given as a hexadecimal number and it |
| 3423 | defines the size of the memory region starting at base |
| 3424 | address bootm_low that is accessible by the Linux kernel |
| 3425 | during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used |
| 3426 | as the default value if it is defined, and bootm_size is |
| 3427 | used otherwise. |
Bartlomiej Sieka | c5648c8 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 3428 | |
| 3429 | bootm_size - Memory range available for image processing in the bootm |
| 3430 | command can be restricted. This variable is given as |
| 3431 | a hexadecimal number and defines the size of the region |
| 3432 | allowed for use by the bootm command. See also "bootm_low" |
| 3433 | environment variable. |
| 3434 | |
Bartlomiej Sieka | e273e9f | 2008-10-01 15:26:31 +0200 | [diff] [blame] | 3435 | updatefile - Location of the software update file on a TFTP server, used |
| 3436 | by the automatic software update feature. Please refer to |
| 3437 | documentation in doc/README.update for more details. |
| 3438 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3439 | autoload - if set to "no" (any string beginning with 'n'), |
| 3440 | "bootp" will just load perform a lookup of the |
| 3441 | configuration from the BOOTP server, but not try to |
| 3442 | load any image using TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3443 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3444 | autostart - if set to "yes", an image loaded using the "bootp", |
| 3445 | "rarpboot", "tftpboot" or "diskboot" commands will |
| 3446 | be automatically started (by internally calling |
| 3447 | "bootm") |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3448 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3449 | If set to "no", a standalone image passed to the |
| 3450 | "bootm" command will be copied to the load address |
| 3451 | (and eventually uncompressed), but NOT be started. |
| 3452 | This can be used to load and uncompress arbitrary |
| 3453 | data. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3454 | |
David A. Long | d558a4e | 2011-07-09 16:40:19 -0400 | [diff] [blame] | 3455 | fdt_high - if set this restricts the maximum address that the |
| 3456 | flattened device tree will be copied into upon boot. |
| 3457 | If this is set to the special value 0xFFFFFFFF then |
| 3458 | the fdt will not be copied at all on boot. For this |
| 3459 | to work it must reside in writable memory, have |
| 3460 | sufficient padding on the end of it for u-boot to |
| 3461 | add the information it needs into it, and the memory |
| 3462 | must be accessible by the kernel. |
| 3463 | |
wdenk | 0e2bd9c | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 3464 | i2cfast - (PPC405GP|PPC405EP only) |
| 3465 | if set to 'y' configures Linux I2C driver for fast |
| 3466 | mode (400kHZ). This environment variable is used in |
| 3467 | initialization code. So, for changes to be effective |
| 3468 | it must be saved and board must be reset. |
| 3469 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3470 | initrd_high - restrict positioning of initrd images: |
| 3471 | If this variable is not set, initrd images will be |
| 3472 | copied to the highest possible address in RAM; this |
| 3473 | is usually what you want since it allows for |
| 3474 | maximum initrd size. If for some reason you want to |
| 3475 | make sure that the initrd image is loaded below the |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 3476 | CONFIG_SYS_BOOTMAPSZ limit, you can set this environment |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3477 | variable to a value of "no" or "off" or "0". |
| 3478 | Alternatively, you can set it to a maximum upper |
| 3479 | address to use (U-Boot will still check that it |
| 3480 | does not overwrite the U-Boot stack and data). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3481 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3482 | For instance, when you have a system with 16 MB |
| 3483 | RAM, and want to reserve 4 MB from use by Linux, |
| 3484 | you can do this by adding "mem=12M" to the value of |
| 3485 | the "bootargs" variable. However, now you must make |
| 3486 | sure that the initrd image is placed in the first |
| 3487 | 12 MB as well - this can be done with |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3488 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3489 | setenv initrd_high 00c00000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3490 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3491 | If you set initrd_high to 0xFFFFFFFF, this is an |
| 3492 | indication to U-Boot that all addresses are legal |
| 3493 | for the Linux kernel, including addresses in flash |
| 3494 | memory. In this case U-Boot will NOT COPY the |
| 3495 | ramdisk at all. This may be useful to reduce the |
| 3496 | boot time on your system, but requires that this |
| 3497 | feature is supported by your Linux kernel. |
wdenk | 3f9ab98 | 2003-04-12 23:38:12 +0000 | [diff] [blame] | 3498 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3499 | ipaddr - IP address; needed for tftpboot command |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3500 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3501 | loadaddr - Default load address for commands like "bootp", |
| 3502 | "rarpboot", "tftpboot", "loadb" or "diskboot" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3503 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3504 | loads_echo - see CONFIG_LOADS_ECHO |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3505 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3506 | serverip - TFTP server IP address; needed for tftpboot command |
wdenk | 6f770ed | 2003-05-23 23:18:21 +0000 | [diff] [blame] | 3507 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3508 | bootretry - see CONFIG_BOOT_RETRY_TIME |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3509 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3510 | bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3511 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3512 | bootstopkey - see CONFIG_AUTOBOOT_STOP_STR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3513 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3514 | ethprime - When CONFIG_NET_MULTI is enabled controls which |
| 3515 | interface is used first. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3516 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3517 | ethact - When CONFIG_NET_MULTI is enabled controls which |
| 3518 | interface is currently active. For example you |
| 3519 | can do the following |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3520 | |
Heiko Schocher | c5e8405 | 2010-07-20 17:45:02 +0200 | [diff] [blame] | 3521 | => setenv ethact FEC |
| 3522 | => ping 192.168.0.1 # traffic sent on FEC |
| 3523 | => setenv ethact SCC |
| 3524 | => ping 10.0.0.1 # traffic sent on SCC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3525 | |
Matthias Fuchs | 204f0ec | 2008-01-17 07:45:05 +0100 | [diff] [blame] | 3526 | ethrotate - When set to "no" U-Boot does not go through all |
| 3527 | available network interfaces. |
| 3528 | It just stays at the currently selected interface. |
| 3529 | |
Wolfgang Denk | b233bd7 | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 3530 | netretry - When set to "no" each network operation will |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3531 | either succeed or fail without retrying. |
| 3532 | When set to "once" the network operation will |
| 3533 | fail when all the available network interfaces |
| 3534 | are tried once without success. |
| 3535 | Useful on scripts which control the retry operation |
| 3536 | themselves. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3537 | |
Jean-Christophe PLAGNIOL-VILLARD | 1948d6c | 2009-01-31 09:53:39 +0100 | [diff] [blame] | 3538 | npe_ucode - set load address for the NPE microcode |
Jean-Christophe PLAGNIOL-VILLARD | d2164ef | 2008-01-07 08:41:34 +0100 | [diff] [blame] | 3539 | |
Wolfgang Denk | 227b519 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 3540 | tftpsrcport - If this is set, the value is used for TFTP's |
Wolfgang Denk | e3cfce5 | 2005-09-24 22:37:32 +0200 | [diff] [blame] | 3541 | UDP source port. |
| 3542 | |
Wolfgang Denk | 227b519 | 2005-09-24 23:25:46 +0200 | [diff] [blame] | 3543 | tftpdstport - If this is set, the value is used for TFTP's UDP |
| 3544 | destination port instead of the Well Know Port 69. |
| 3545 | |
Wolfgang Denk | b233bd7 | 2010-01-17 23:55:53 +0100 | [diff] [blame] | 3546 | tftpblocksize - Block size to use for TFTP transfers; if not set, |
| 3547 | we use the TFTP server's default block size |
| 3548 | |
| 3549 | tftptimeout - Retransmission timeout for TFTP packets (in milli- |
| 3550 | seconds, minimum value is 1000 = 1 second). Defines |
| 3551 | when a packet is considered to be lost so it has to |
| 3552 | be retransmitted. The default is 5000 = 5 seconds. |
| 3553 | Lowering this value may make downloads succeed |
| 3554 | faster in networks with high packet loss rates or |
| 3555 | with unreliable TFTP servers. |
| 3556 | |
| 3557 | vlan - When set to a value < 4095 the traffic over |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3558 | Ethernet is encapsulated/received over 802.1q |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3559 | VLAN tagged frames. |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 3560 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3561 | The following environment variables may be used and automatically |
| 3562 | updated by the network boot commands ("bootp" and "rarpboot"), |
| 3563 | depending the information provided by your boot server: |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 3564 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3565 | bootfile - see above |
| 3566 | dnsip - IP address of your Domain Name Server |
| 3567 | dnsip2 - IP address of your secondary Domain Name Server |
| 3568 | gatewayip - IP address of the Gateway (Router) to use |
| 3569 | hostname - Target hostname |
| 3570 | ipaddr - see above |
| 3571 | netmask - Subnet Mask |
| 3572 | rootpath - Pathname of the root filesystem on the NFS server |
| 3573 | serverip - see above |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 3574 | |
wdenk | 145d2c1 | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 3575 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3576 | There are two special Environment Variables: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3577 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3578 | serial# - contains hardware identification information such |
| 3579 | as type string and/or serial number |
| 3580 | ethaddr - Ethernet address |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3581 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3582 | These variables can be set only once (usually during manufacturing of |
| 3583 | the board). U-Boot refuses to delete or overwrite these variables |
| 3584 | once they have been set once. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3585 | |
| 3586 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3587 | Further special Environment Variables: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3588 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3589 | ver - Contains the U-Boot version string as printed |
| 3590 | with the "version" command. This variable is |
| 3591 | readonly (see CONFIG_VERSION_VARIABLE). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3592 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3593 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3594 | Please note that changes to some configuration parameters may take |
| 3595 | only effect after the next boot (yes, that's just like Windoze :-). |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 3596 | |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 3597 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3598 | Command Line Parsing: |
| 3599 | ===================== |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 3600 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3601 | There are two different command line parsers available with U-Boot: |
| 3602 | the old "simple" one, and the much more powerful "hush" shell: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3603 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3604 | Old, simple command line parser: |
| 3605 | -------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3606 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3607 | - supports environment variables (through setenv / saveenv commands) |
| 3608 | - several commands on one line, separated by ';' |
Wolfgang Denk | 86eb3b7 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 3609 | - variable substitution using "... ${name} ..." syntax |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3610 | - special characters ('$', ';') can be escaped by prefixing with '\', |
| 3611 | for example: |
Wolfgang Denk | 86eb3b7 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 3612 | setenv bootcmd bootm \${address} |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3613 | - You can also escape text by enclosing in single apostrophes, for example: |
| 3614 | setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3615 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3616 | Hush shell: |
| 3617 | ----------- |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3618 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3619 | - similar to Bourne shell, with control structures like |
| 3620 | if...then...else...fi, for...do...done; while...do...done, |
| 3621 | until...do...done, ... |
| 3622 | - supports environment ("global") variables (through setenv / saveenv |
| 3623 | commands) and local shell variables (through standard shell syntax |
| 3624 | "name=value"); only environment variables can be used with "run" |
| 3625 | command |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3626 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3627 | General rules: |
| 3628 | -------------- |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3629 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3630 | (1) If a command line (or an environment variable executed by a "run" |
| 3631 | command) contains several commands separated by semicolon, and |
| 3632 | one of these commands fails, then the remaining commands will be |
| 3633 | executed anyway. |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3634 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3635 | (2) If you execute several variables with one call to run (i. e. |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3636 | calling run with a list of variables as arguments), any failing |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3637 | command will cause "run" to terminate, i. e. the remaining |
| 3638 | variables are not executed. |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3639 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3640 | Note for Redundant Ethernet Interfaces: |
| 3641 | ======================================= |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3642 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3643 | Some boards come with redundant Ethernet interfaces; U-Boot supports |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3644 | such configurations and is capable of automatic selection of a |
| 3645 | "working" interface when needed. MAC assignment works as follows: |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3646 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3647 | Network interfaces are numbered eth0, eth1, eth2, ... Corresponding |
| 3648 | MAC addresses can be stored in the environment as "ethaddr" (=>eth0), |
| 3649 | "eth1addr" (=>eth1), "eth2addr", ... |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3650 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3651 | If the network interface stores some valid MAC address (for instance |
| 3652 | in SROM), this is used as default address if there is NO correspon- |
| 3653 | ding setting in the environment; if the corresponding environment |
| 3654 | variable is set, this overrides the settings in the card; that means: |
wdenk | f4688a2 | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 3655 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3656 | o If the SROM has a valid MAC address, and there is no address in the |
| 3657 | environment, the SROM's address is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3658 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3659 | o If there is no valid address in the SROM, and a definition in the |
| 3660 | environment exists, then the value from the environment variable is |
| 3661 | used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3662 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3663 | o If both the SROM and the environment contain a MAC address, and |
| 3664 | both addresses are the same, this MAC address is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3665 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3666 | o If both the SROM and the environment contain a MAC address, and the |
| 3667 | addresses differ, the value from the environment is used and a |
| 3668 | warning is printed. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3669 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3670 | o If neither SROM nor the environment contain a MAC address, an error |
| 3671 | is raised. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3672 | |
Ben Warren | 6db991a | 2010-04-26 11:11:46 -0700 | [diff] [blame] | 3673 | If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses |
| 3674 | will be programmed into hardware as part of the initialization process. This |
| 3675 | may be skipped by setting the appropriate 'ethmacskip' environment variable. |
| 3676 | The naming convention is as follows: |
| 3677 | "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3678 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3679 | Image Formats: |
| 3680 | ============== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3681 | |
Marian Balakowicz | 18710b8 | 2008-03-12 12:13:13 +0100 | [diff] [blame] | 3682 | U-Boot is capable of booting (and performing other auxiliary operations on) |
| 3683 | images in two formats: |
| 3684 | |
| 3685 | New uImage format (FIT) |
| 3686 | ----------------------- |
| 3687 | |
| 3688 | Flexible and powerful format based on Flattened Image Tree -- FIT (similar |
| 3689 | to Flattened Device Tree). It allows the use of images with multiple |
| 3690 | components (several kernels, ramdisks, etc.), with contents protected by |
| 3691 | SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. |
| 3692 | |
| 3693 | |
| 3694 | Old uImage format |
| 3695 | ----------------- |
| 3696 | |
| 3697 | Old image format is based on binary files which can be basically anything, |
| 3698 | preceded by a special header; see the definitions in include/image.h for |
| 3699 | details; basically, the header defines the following image properties: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3700 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3701 | * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, |
| 3702 | 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, |
Peter Tyser | 56b8dd1 | 2008-09-08 14:56:49 -0500 | [diff] [blame] | 3703 | LynxOS, pSOS, QNX, RTEMS, INTEGRITY; |
| 3704 | Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, |
| 3705 | INTEGRITY). |
Wolfgang Denk | 83c1585 | 2006-10-24 14:21:16 +0200 | [diff] [blame] | 3706 | * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, |
Thomas Chou | 56fff49 | 2010-05-28 10:56:50 +0800 | [diff] [blame] | 3707 | IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; |
| 3708 | Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC). |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3709 | * Compression Type (uncompressed, gzip, bzip2) |
| 3710 | * Load Address |
| 3711 | * Entry Point |
| 3712 | * Image Name |
| 3713 | * Image Timestamp |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3714 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3715 | The header is marked by a special Magic Number, and both the header |
| 3716 | and the data portions of the image are secured against corruption by |
| 3717 | CRC32 checksums. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3718 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3719 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3720 | Linux Support: |
| 3721 | ============== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3722 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3723 | Although U-Boot should support any OS or standalone application |
| 3724 | easily, the main focus has always been on Linux during the design of |
| 3725 | U-Boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3726 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3727 | U-Boot includes many features that so far have been part of some |
| 3728 | special "boot loader" code within the Linux kernel. Also, any |
| 3729 | "initrd" images to be used are no longer part of one big Linux image; |
| 3730 | instead, kernel and "initrd" are separate images. This implementation |
| 3731 | serves several purposes: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3732 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3733 | - the same features can be used for other OS or standalone |
| 3734 | applications (for instance: using compressed images to reduce the |
| 3735 | Flash memory footprint) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3736 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3737 | - it becomes much easier to port new Linux kernel versions because |
| 3738 | lots of low-level, hardware dependent stuff are done by U-Boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3739 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3740 | - the same Linux kernel image can now be used with different "initrd" |
| 3741 | images; of course this also means that different kernel images can |
| 3742 | be run with the same "initrd". This makes testing easier (you don't |
| 3743 | have to build a new "zImage.initrd" Linux image when you just |
| 3744 | change a file in your "initrd"). Also, a field-upgrade of the |
| 3745 | software is easier now. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3746 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3747 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3748 | Linux HOWTO: |
| 3749 | ============ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3750 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3751 | Porting Linux to U-Boot based systems: |
| 3752 | --------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3753 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3754 | U-Boot cannot save you from doing all the necessary modifications to |
| 3755 | configure the Linux device drivers for use with your target hardware |
| 3756 | (no, we don't intend to provide a full virtual machine interface to |
| 3757 | Linux :-). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3758 | |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 3759 | But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3760 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3761 | Just make sure your machine specific header file (for instance |
| 3762 | include/asm-ppc/tqm8xx.h) includes the same definition of the Board |
Markus Heidelberg | 4716757 | 2008-09-07 20:18:27 +0200 | [diff] [blame] | 3763 | Information structure as we define in include/asm-<arch>/u-boot.h, |
| 3764 | 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] | 3765 | as your U-Boot configuration in CONFIG_SYS_IMMR. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3766 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3767 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3768 | Configuring the Linux kernel: |
| 3769 | ----------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3770 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3771 | No specific requirements for U-Boot. Make sure you have some root |
| 3772 | device (initial ramdisk, NFS) for your target system. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3773 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3774 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3775 | Building a Linux Image: |
| 3776 | ----------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3777 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3778 | With U-Boot, "normal" build targets like "zImage" or "bzImage" are |
| 3779 | not used. If you use recent kernel source, a new build target |
| 3780 | "uImage" will exist which automatically builds an image usable by |
| 3781 | U-Boot. Most older kernels also have support for a "pImage" target, |
| 3782 | which was introduced for our predecessor project PPCBoot and uses a |
| 3783 | 100% compatible format. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3784 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3785 | Example: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3786 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3787 | make TQM850L_config |
| 3788 | make oldconfig |
| 3789 | make dep |
| 3790 | make uImage |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3791 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3792 | The "uImage" build target uses a special tool (in 'tools/mkimage') to |
| 3793 | encapsulate a compressed Linux kernel image with header information, |
| 3794 | 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] | 3795 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3796 | * build a standard "vmlinux" kernel image (in ELF binary format): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3797 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3798 | * convert the kernel into a raw binary image: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3799 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3800 | ${CROSS_COMPILE}-objcopy -O binary \ |
| 3801 | -R .note -R .comment \ |
| 3802 | -S vmlinux linux.bin |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3803 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3804 | * compress the binary image: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3805 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3806 | gzip -9 linux.bin |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3807 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3808 | * package compressed binary image for U-Boot: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3809 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3810 | mkimage -A ppc -O linux -T kernel -C gzip \ |
| 3811 | -a 0 -e 0 -n "Linux Kernel Image" \ |
| 3812 | -d linux.bin.gz uImage |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3813 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3814 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3815 | The "mkimage" tool can also be used to create ramdisk images for use |
| 3816 | with U-Boot, either separated from the Linux kernel image, or |
| 3817 | combined into one file. "mkimage" encapsulates the images with a 64 |
| 3818 | byte header containing information about target architecture, |
| 3819 | operating system, image type, compression method, entry points, time |
| 3820 | stamp, CRC32 checksums, etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3821 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3822 | "mkimage" can be called in two ways: to verify existing images and |
| 3823 | print the header information, or to build new images. |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3824 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3825 | In the first form (with "-l" option) mkimage lists the information |
| 3826 | contained in the header of an existing U-Boot image; this includes |
| 3827 | checksum verification: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3828 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3829 | tools/mkimage -l image |
| 3830 | -l ==> list image header information |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3831 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3832 | The second form (with "-d" option) is used to build a U-Boot image |
| 3833 | from a "data file" which is used as image payload: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3834 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3835 | tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ |
| 3836 | -n name -d data_file image |
| 3837 | -A ==> set architecture to 'arch' |
| 3838 | -O ==> set operating system to 'os' |
| 3839 | -T ==> set image type to 'type' |
| 3840 | -C ==> set compression type 'comp' |
| 3841 | -a ==> set load address to 'addr' (hex) |
| 3842 | -e ==> set entry point to 'ep' (hex) |
| 3843 | -n ==> set image name to 'name' |
| 3844 | -d ==> use image data from 'datafile' |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 3845 | |
wdenk | cd91445 | 2004-05-29 16:53:29 +0000 | [diff] [blame] | 3846 | Right now, all Linux kernels for PowerPC systems use the same load |
| 3847 | address (0x00000000), but the entry point address depends on the |
| 3848 | kernel version: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3849 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3850 | - 2.2.x kernels have the entry point at 0x0000000C, |
| 3851 | - 2.3.x and later kernels have the entry point at 0x00000000. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3852 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3853 | So a typical call to build a U-Boot image would read: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3854 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3855 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
| 3856 | > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 3857 | > -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] | 3858 | > examples/uImage.TQM850L |
| 3859 | Image Name: 2.4.4 kernel for TQM850L |
| 3860 | Created: Wed Jul 19 02:34:59 2000 |
| 3861 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 3862 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB |
| 3863 | Load Address: 0x00000000 |
| 3864 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3865 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3866 | To verify the contents of the image (or check for corruption): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3867 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3868 | -> tools/mkimage -l examples/uImage.TQM850L |
| 3869 | Image Name: 2.4.4 kernel for TQM850L |
| 3870 | Created: Wed Jul 19 02:34:59 2000 |
| 3871 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 3872 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB |
| 3873 | Load Address: 0x00000000 |
| 3874 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3875 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3876 | NOTE: for embedded systems where boot time is critical you can trade |
| 3877 | speed for memory and install an UNCOMPRESSED image instead: this |
| 3878 | needs more space in Flash, but boots much faster since it does not |
| 3879 | need to be uncompressed: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3880 | |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 3881 | -> 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] | 3882 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
| 3883 | > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ |
Stefan Roese | 88fbf93 | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 3884 | > -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] | 3885 | > examples/uImage.TQM850L-uncompressed |
| 3886 | Image Name: 2.4.4 kernel for TQM850L |
| 3887 | Created: Wed Jul 19 02:34:59 2000 |
| 3888 | Image Type: PowerPC Linux Kernel Image (uncompressed) |
| 3889 | Data Size: 792160 Bytes = 773.59 kB = 0.76 MB |
| 3890 | Load Address: 0x00000000 |
| 3891 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3892 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3893 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3894 | Similar you can build U-Boot images from a 'ramdisk.image.gz' file |
| 3895 | when your kernel is intended to use an initial ramdisk: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3896 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3897 | -> tools/mkimage -n 'Simple Ramdisk Image' \ |
| 3898 | > -A ppc -O linux -T ramdisk -C gzip \ |
| 3899 | > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd |
| 3900 | Image Name: Simple Ramdisk Image |
| 3901 | Created: Wed Jan 12 14:01:50 2000 |
| 3902 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 3903 | Data Size: 566530 Bytes = 553.25 kB = 0.54 MB |
| 3904 | Load Address: 0x00000000 |
| 3905 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3906 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3907 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3908 | Installing a Linux Image: |
| 3909 | ------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3910 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3911 | To downloading a U-Boot image over the serial (console) interface, |
| 3912 | you must convert the image to S-Record format: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3913 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3914 | objcopy -I binary -O srec examples/image examples/image.srec |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3915 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3916 | The 'objcopy' does not understand the information in the U-Boot |
| 3917 | image header, so the resulting S-Record file will be relative to |
| 3918 | address 0x00000000. To load it to a given address, you need to |
| 3919 | specify the target address as 'offset' parameter with the 'loads' |
| 3920 | command. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3921 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3922 | Example: install the image to address 0x40100000 (which on the |
| 3923 | TQM8xxL is in the first Flash bank): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3924 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3925 | => erase 40100000 401FFFFF |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3926 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3927 | .......... done |
| 3928 | Erased 8 sectors |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3929 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3930 | => loads 40100000 |
| 3931 | ## Ready for S-Record download ... |
| 3932 | ~>examples/image.srec |
| 3933 | 1 2 3 4 5 6 7 8 9 10 11 12 13 ... |
| 3934 | ... |
| 3935 | 15989 15990 15991 15992 |
| 3936 | [file transfer complete] |
| 3937 | [connected] |
| 3938 | ## Start Addr = 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3939 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3940 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3941 | You can check the success of the download using the 'iminfo' command; |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 3942 | this includes a checksum verification so you can be sure no data |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3943 | corruption happened: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3944 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3945 | => imi 40100000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3946 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3947 | ## Checking Image at 40100000 ... |
| 3948 | Image Name: 2.2.13 for initrd on TQM850L |
| 3949 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 3950 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 3951 | Load Address: 00000000 |
| 3952 | Entry Point: 0000000c |
| 3953 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3954 | |
| 3955 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3956 | Boot Linux: |
| 3957 | ----------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3958 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3959 | The "bootm" command is used to boot an application that is stored in |
| 3960 | memory (RAM or Flash). In case of a Linux kernel image, the contents |
| 3961 | of the "bootargs" environment variable is passed to the kernel as |
| 3962 | parameters. You can check and modify this variable using the |
| 3963 | "printenv" and "setenv" commands: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3964 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3965 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3966 | => printenv bootargs |
| 3967 | bootargs=root=/dev/ram |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3968 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3969 | => 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] | 3970 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3971 | => printenv bootargs |
| 3972 | 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] | 3973 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3974 | => bootm 40020000 |
| 3975 | ## Booting Linux kernel at 40020000 ... |
| 3976 | Image Name: 2.2.13 for NFS on TQM850L |
| 3977 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 3978 | Data Size: 381681 Bytes = 372 kB = 0 MB |
| 3979 | Load Address: 00000000 |
| 3980 | Entry Point: 0000000c |
| 3981 | Verifying Checksum ... OK |
| 3982 | Uncompressing Kernel Image ... OK |
| 3983 | 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 |
| 3984 | Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 |
| 3985 | time_init: decrementer frequency = 187500000/60 |
| 3986 | Calibrating delay loop... 49.77 BogoMIPS |
| 3987 | Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] |
| 3988 | ... |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3989 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 3990 | 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] | 3991 | the memory addresses of both the kernel and the initrd image (PPBCOOT |
| 3992 | format!) to the "bootm" command: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3993 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3994 | => imi 40100000 40200000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3995 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 3996 | ## Checking Image at 40100000 ... |
| 3997 | Image Name: 2.2.13 for initrd on TQM850L |
| 3998 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 3999 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 4000 | Load Address: 00000000 |
| 4001 | Entry Point: 0000000c |
| 4002 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4003 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4004 | ## Checking Image at 40200000 ... |
| 4005 | Image Name: Simple Ramdisk Image |
| 4006 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 4007 | Data Size: 566530 Bytes = 553 kB = 0 MB |
| 4008 | Load Address: 00000000 |
| 4009 | Entry Point: 00000000 |
| 4010 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4011 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4012 | => bootm 40100000 40200000 |
| 4013 | ## Booting Linux kernel at 40100000 ... |
| 4014 | Image Name: 2.2.13 for initrd on TQM850L |
| 4015 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4016 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 4017 | Load Address: 00000000 |
| 4018 | Entry Point: 0000000c |
| 4019 | Verifying Checksum ... OK |
| 4020 | Uncompressing Kernel Image ... OK |
| 4021 | ## Loading RAMDisk Image at 40200000 ... |
| 4022 | Image Name: Simple Ramdisk Image |
| 4023 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 4024 | Data Size: 566530 Bytes = 553 kB = 0 MB |
| 4025 | Load Address: 00000000 |
| 4026 | Entry Point: 00000000 |
| 4027 | Verifying Checksum ... OK |
| 4028 | Loading Ramdisk ... OK |
| 4029 | 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 |
| 4030 | Boot arguments: root=/dev/ram |
| 4031 | time_init: decrementer frequency = 187500000/60 |
| 4032 | Calibrating delay loop... 49.77 BogoMIPS |
| 4033 | ... |
| 4034 | RAMDISK: Compressed image found at block 0 |
| 4035 | VFS: Mounted root (ext2 filesystem). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4036 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4037 | bash# |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4038 | |
Matthew McClintock | efae4ca | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 4039 | Boot Linux and pass a flat device tree: |
| 4040 | ----------- |
| 4041 | |
| 4042 | First, U-Boot must be compiled with the appropriate defines. See the section |
| 4043 | titled "Linux Kernel Interface" above for a more in depth explanation. The |
| 4044 | following is an example of how to start a kernel and pass an updated |
| 4045 | flat device tree: |
| 4046 | |
| 4047 | => print oftaddr |
| 4048 | oftaddr=0x300000 |
| 4049 | => print oft |
| 4050 | oft=oftrees/mpc8540ads.dtb |
| 4051 | => tftp $oftaddr $oft |
| 4052 | Speed: 1000, full duplex |
| 4053 | Using TSEC0 device |
| 4054 | TFTP from server 192.168.1.1; our IP address is 192.168.1.101 |
| 4055 | Filename 'oftrees/mpc8540ads.dtb'. |
| 4056 | Load address: 0x300000 |
| 4057 | Loading: # |
| 4058 | done |
| 4059 | Bytes transferred = 4106 (100a hex) |
| 4060 | => tftp $loadaddr $bootfile |
| 4061 | Speed: 1000, full duplex |
| 4062 | Using TSEC0 device |
| 4063 | TFTP from server 192.168.1.1; our IP address is 192.168.1.2 |
| 4064 | Filename 'uImage'. |
| 4065 | Load address: 0x200000 |
| 4066 | Loading:############ |
| 4067 | done |
| 4068 | Bytes transferred = 1029407 (fb51f hex) |
| 4069 | => print loadaddr |
| 4070 | loadaddr=200000 |
| 4071 | => print oftaddr |
| 4072 | oftaddr=0x300000 |
| 4073 | => bootm $loadaddr - $oftaddr |
| 4074 | ## Booting image at 00200000 ... |
Wolfgang Denk | 018147d | 2006-11-27 15:32:42 +0100 | [diff] [blame] | 4075 | Image Name: Linux-2.6.17-dirty |
| 4076 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 4077 | Data Size: 1029343 Bytes = 1005.2 kB |
Matthew McClintock | efae4ca | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 4078 | Load Address: 00000000 |
Wolfgang Denk | 018147d | 2006-11-27 15:32:42 +0100 | [diff] [blame] | 4079 | Entry Point: 00000000 |
Matthew McClintock | efae4ca | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 4080 | Verifying Checksum ... OK |
| 4081 | Uncompressing Kernel Image ... OK |
| 4082 | Booting using flat device tree at 0x300000 |
| 4083 | Using MPC85xx ADS machine description |
| 4084 | Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb |
| 4085 | [snip] |
| 4086 | |
| 4087 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4088 | More About U-Boot Image Types: |
| 4089 | ------------------------------ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4090 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4091 | U-Boot supports the following image types: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4092 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4093 | "Standalone Programs" are directly runnable in the environment |
| 4094 | provided by U-Boot; it is expected that (if they behave |
| 4095 | well) you can continue to work in U-Boot after return from |
| 4096 | the Standalone Program. |
| 4097 | "OS Kernel Images" are usually images of some Embedded OS which |
| 4098 | will take over control completely. Usually these programs |
| 4099 | will install their own set of exception handlers, device |
| 4100 | drivers, set up the MMU, etc. - this means, that you cannot |
| 4101 | expect to re-enter U-Boot except by resetting the CPU. |
| 4102 | "RAMDisk Images" are more or less just data blocks, and their |
| 4103 | parameters (address, size) are passed to an OS kernel that is |
| 4104 | being started. |
| 4105 | "Multi-File Images" contain several images, typically an OS |
| 4106 | (Linux) kernel image and one or more data images like |
| 4107 | RAMDisks. This construct is useful for instance when you want |
| 4108 | to boot over the network using BOOTP etc., where the boot |
| 4109 | server provides just a single image file, but you want to get |
| 4110 | for instance an OS kernel and a RAMDisk image. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4111 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4112 | "Multi-File Images" start with a list of image sizes, each |
| 4113 | image size (in bytes) specified by an "uint32_t" in network |
| 4114 | byte order. This list is terminated by an "(uint32_t)0". |
| 4115 | Immediately after the terminating 0 follow the images, one by |
| 4116 | one, all aligned on "uint32_t" boundaries (size rounded up to |
| 4117 | a multiple of 4 bytes). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4118 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4119 | "Firmware Images" are binary images containing firmware (like |
| 4120 | U-Boot or FPGA images) which usually will be programmed to |
| 4121 | flash memory. |
wdenk | 4fc9569 | 2003-02-28 00:49:47 +0000 | [diff] [blame] | 4122 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4123 | "Script files" are command sequences that will be executed by |
| 4124 | U-Boot's command interpreter; this feature is especially |
| 4125 | useful when you configure U-Boot to use a real shell (hush) |
| 4126 | as command interpreter. |
wdenk | 4fc9569 | 2003-02-28 00:49:47 +0000 | [diff] [blame] | 4127 | |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4128 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4129 | Standalone HOWTO: |
| 4130 | ================= |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4131 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4132 | One of the features of U-Boot is that you can dynamically load and |
| 4133 | run "standalone" applications, which can use some resources of |
| 4134 | U-Boot like console I/O functions or interrupt services. |
stroese | b9c17c5 | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 4135 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4136 | Two simple examples are included with the sources: |
wdenk | 4fc9569 | 2003-02-28 00:49:47 +0000 | [diff] [blame] | 4137 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4138 | "Hello World" Demo: |
| 4139 | ------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4140 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4141 | 'examples/hello_world.c' contains a small "Hello World" Demo |
| 4142 | application; it is automatically compiled when you build U-Boot. |
| 4143 | It's configured to run at address 0x00040004, so you can play with it |
| 4144 | like that: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4145 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4146 | => loads |
| 4147 | ## Ready for S-Record download ... |
| 4148 | ~>examples/hello_world.srec |
| 4149 | 1 2 3 4 5 6 7 8 9 10 11 ... |
| 4150 | [file transfer complete] |
| 4151 | [connected] |
| 4152 | ## Start Addr = 0x00040004 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4153 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4154 | => go 40004 Hello World! This is a test. |
| 4155 | ## Starting application at 0x00040004 ... |
| 4156 | Hello World |
| 4157 | argc = 7 |
| 4158 | argv[0] = "40004" |
| 4159 | argv[1] = "Hello" |
| 4160 | argv[2] = "World!" |
| 4161 | argv[3] = "This" |
| 4162 | argv[4] = "is" |
| 4163 | argv[5] = "a" |
| 4164 | argv[6] = "test." |
| 4165 | argv[7] = "<NULL>" |
| 4166 | Hit any key to exit ... |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4167 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4168 | ## Application terminated, rc = 0x0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4169 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4170 | Another example, which demonstrates how to register a CPM interrupt |
| 4171 | handler with the U-Boot code, can be found in 'examples/timer.c'. |
| 4172 | Here, a CPM timer is set up to generate an interrupt every second. |
| 4173 | The interrupt service routine is trivial, just printing a '.' |
| 4174 | character, but this is just a demo program. The application can be |
| 4175 | controlled by the following keys: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4176 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4177 | ? - print current values og the CPM Timer registers |
| 4178 | b - enable interrupts and start timer |
| 4179 | e - stop timer and disable interrupts |
| 4180 | q - quit application |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4181 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4182 | => loads |
| 4183 | ## Ready for S-Record download ... |
| 4184 | ~>examples/timer.srec |
| 4185 | 1 2 3 4 5 6 7 8 9 10 11 ... |
| 4186 | [file transfer complete] |
| 4187 | [connected] |
| 4188 | ## Start Addr = 0x00040004 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4189 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4190 | => go 40004 |
| 4191 | ## Starting application at 0x00040004 ... |
| 4192 | TIMERS=0xfff00980 |
| 4193 | Using timer 1 |
| 4194 | tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4195 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4196 | Hit 'b': |
| 4197 | [q, b, e, ?] Set interval 1000000 us |
| 4198 | Enabling timer |
| 4199 | Hit '?': |
| 4200 | [q, b, e, ?] ........ |
| 4201 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 |
| 4202 | Hit '?': |
| 4203 | [q, b, e, ?] . |
| 4204 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 |
| 4205 | Hit '?': |
| 4206 | [q, b, e, ?] . |
| 4207 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 |
| 4208 | Hit '?': |
| 4209 | [q, b, e, ?] . |
| 4210 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 |
| 4211 | Hit 'e': |
| 4212 | [q, b, e, ?] ...Stopping timer |
| 4213 | Hit 'q': |
| 4214 | [q, b, e, ?] ## Application terminated, rc = 0x0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4215 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4216 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4217 | Minicom warning: |
| 4218 | ================ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4219 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4220 | Over time, many people have reported problems when trying to use the |
| 4221 | "minicom" terminal emulation program for serial download. I (wd) |
| 4222 | consider minicom to be broken, and recommend not to use it. Under |
| 4223 | Unix, I recommend to use C-Kermit for general purpose use (and |
| 4224 | especially for kermit binary protocol download ("loadb" command), and |
| 4225 | use "cu" for S-Record download ("loads" command). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4226 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4227 | Nevertheless, if you absolutely want to use it try adding this |
| 4228 | configuration to your "File transfer protocols" section: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4229 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4230 | Name Program Name U/D FullScr IO-Red. Multi |
| 4231 | X kermit /usr/bin/kermit -i -l %l -s Y U Y N N |
| 4232 | 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] | 4233 | |
wdenk | 8dba050 | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 4234 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4235 | NetBSD Notes: |
| 4236 | ============= |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4237 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4238 | Starting at version 0.9.2, U-Boot supports NetBSD both as host |
| 4239 | (build U-Boot) and target system (boots NetBSD/mpc8xx). |
wdenk | 88e72a3 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4240 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4241 | Building requires a cross environment; it is known to work on |
| 4242 | NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also |
| 4243 | need gmake since the Makefiles are not compatible with BSD make). |
| 4244 | Note that the cross-powerpc package does not install include files; |
| 4245 | attempting to build U-Boot will fail because <machine/ansi.h> is |
| 4246 | missing. This file has to be installed and patched manually: |
wdenk | 88e72a3 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4247 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4248 | # cd /usr/pkg/cross/powerpc-netbsd/include |
| 4249 | # mkdir powerpc |
| 4250 | # ln -s powerpc machine |
| 4251 | # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h |
| 4252 | # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST |
wdenk | 88e72a3 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4253 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4254 | Native builds *don't* work due to incompatibilities between native |
| 4255 | and U-Boot include files. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4256 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4257 | Booting assumes that (the first part of) the image booted is a |
| 4258 | stage-2 loader which in turn loads and then invokes the kernel |
| 4259 | proper. Loader sources will eventually appear in the NetBSD source |
| 4260 | tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the |
wdenk | d0245fc | 2005-04-13 10:02:42 +0000 | [diff] [blame] | 4261 | meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4262 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4263 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4264 | Implementation Internals: |
| 4265 | ========================= |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4266 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4267 | The following is not intended to be a complete description of every |
| 4268 | implementation detail. However, it should help to understand the |
| 4269 | inner workings of U-Boot and make it easier to port it to custom |
| 4270 | hardware. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4271 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4272 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4273 | Initial Stack, Global Data: |
| 4274 | --------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4275 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4276 | The implementation of U-Boot is complicated by the fact that U-Boot |
| 4277 | starts running out of ROM (flash memory), usually without access to |
| 4278 | system RAM (because the memory controller is not initialized yet). |
| 4279 | This means that we don't have writable Data or BSS segments, and BSS |
| 4280 | is not initialized as zero. To be able to get a C environment working |
| 4281 | at all, we have to allocate at least a minimal stack. Implementation |
| 4282 | options for this are defined and restricted by the CPU used: Some CPU |
| 4283 | models provide on-chip memory (like the IMMR area on MPC8xx and |
| 4284 | MPC826x processors), on others (parts of) the data cache can be |
| 4285 | locked as (mis-) used as memory, etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4286 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4287 | Chris Hallinan posted a good summary of these issues to the |
Wolfgang Denk | 290ae6b | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 4288 | U-Boot mailing list: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4289 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4290 | Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? |
| 4291 | From: "Chris Hallinan" <clh@net1plus.com> |
| 4292 | Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) |
| 4293 | ... |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4294 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4295 | Correct me if I'm wrong, folks, but the way I understand it |
| 4296 | is this: Using DCACHE as initial RAM for Stack, etc, does not |
| 4297 | require any physical RAM backing up the cache. The cleverness |
| 4298 | is that the cache is being used as a temporary supply of |
| 4299 | necessary storage before the SDRAM controller is setup. It's |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4300 | beyond the scope of this list to explain the details, but you |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4301 | can see how this works by studying the cache architecture and |
| 4302 | operation in the architecture and processor-specific manuals. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4303 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4304 | OCM is On Chip Memory, which I believe the 405GP has 4K. It |
| 4305 | is another option for the system designer to use as an |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4306 | initial stack/RAM area prior to SDRAM being available. Either |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4307 | option should work for you. Using CS 4 should be fine if your |
| 4308 | board designers haven't used it for something that would |
| 4309 | cause you grief during the initial boot! It is frequently not |
| 4310 | used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4311 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 4312 | CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4313 | with your processor/board/system design. The default value |
| 4314 | you will find in any recent u-boot distribution in |
Stefan Roese | 3e1f1b3 | 2005-08-01 16:49:12 +0200 | [diff] [blame] | 4315 | 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] | 4316 | than your SDRAM module. If you have a 64MB SDRAM module, set |
| 4317 | it above 400_0000. Just make sure your board has no resources |
| 4318 | that are supposed to respond to that address! That code in |
| 4319 | start.S has been around a while and should work as is when |
| 4320 | you get the config right. |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4321 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4322 | -Chris Hallinan |
| 4323 | DS4.COM, Inc. |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4324 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4325 | It is essential to remember this, since it has some impact on the C |
| 4326 | code for the initialization procedures: |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4327 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4328 | * Initialized global data (data segment) is read-only. Do not attempt |
| 4329 | to write it. |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4330 | |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4331 | * Do not use any uninitialized global data (or implicitely initialized |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4332 | as zero data - BSS segment) at all - this is undefined, initiali- |
| 4333 | zation is performed later (when relocating to RAM). |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4334 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4335 | * Stack space is very limited. Avoid big data buffers or things like |
| 4336 | that. |
wdenk | 4a5c8a7 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 4337 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4338 | Having only the stack as writable memory limits means we cannot use |
| 4339 | normal global data to share information beween the code. But it |
| 4340 | turned out that the implementation of U-Boot can be greatly |
| 4341 | simplified by making a global data structure (gd_t) available to all |
| 4342 | functions. We could pass a pointer to this data as argument to _all_ |
| 4343 | functions, but this would bloat the code. Instead we use a feature of |
| 4344 | the GCC compiler (Global Register Variables) to share the data: we |
| 4345 | place a pointer (gd) to the global data into a register which we |
| 4346 | reserve for this purpose. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4347 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4348 | When choosing a register for such a purpose we are restricted by the |
| 4349 | relevant (E)ABI specifications for the current architecture, and by |
| 4350 | GCC's implementation. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4351 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4352 | For PowerPC, the following registers have specific use: |
| 4353 | R1: stack pointer |
Wolfgang Denk | 69c0964 | 2008-02-14 22:43:22 +0100 | [diff] [blame] | 4354 | R2: reserved for system use |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4355 | R3-R4: parameter passing and return values |
| 4356 | R5-R10: parameter passing |
| 4357 | R13: small data area pointer |
| 4358 | R30: GOT pointer |
| 4359 | R31: frame pointer |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4360 | |
Joakim Tjernlund | 693c0c1 | 2010-01-19 14:41:58 +0100 | [diff] [blame] | 4361 | (U-Boot also uses R12 as internal GOT pointer. r12 |
| 4362 | is a volatile register so r12 needs to be reset when |
| 4363 | going back and forth between asm and C) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4364 | |
Wolfgang Denk | 69c0964 | 2008-02-14 22:43:22 +0100 | [diff] [blame] | 4365 | ==> U-Boot will use R2 to hold a pointer to the global data |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4366 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4367 | Note: on PPC, we could use a static initializer (since the |
| 4368 | address of the global data structure is known at compile time), |
| 4369 | but it turned out that reserving a register results in somewhat |
| 4370 | smaller code - although the code savings are not that big (on |
| 4371 | average for all boards 752 bytes for the whole U-Boot image, |
| 4372 | 624 text + 127 data). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4373 | |
Robin Getz | 2773d5f | 2009-08-17 15:23:02 +0000 | [diff] [blame] | 4374 | On Blackfin, the normal C ABI (except for P3) is followed as documented here: |
Mike Frysinger | 60f0930 | 2008-02-04 19:26:54 -0500 | [diff] [blame] | 4375 | http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface |
| 4376 | |
Robin Getz | 2773d5f | 2009-08-17 15:23:02 +0000 | [diff] [blame] | 4377 | ==> U-Boot will use P3 to hold a pointer to the global data |
Mike Frysinger | 60f0930 | 2008-02-04 19:26:54 -0500 | [diff] [blame] | 4378 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4379 | On ARM, the following registers are used: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4380 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4381 | R0: function argument word/integer result |
| 4382 | R1-R3: function argument word |
| 4383 | R9: GOT pointer |
| 4384 | R10: stack limit (used only if stack checking if enabled) |
| 4385 | R11: argument (frame) pointer |
| 4386 | R12: temporary workspace |
| 4387 | R13: stack pointer |
| 4388 | R14: link register |
| 4389 | R15: program counter |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4390 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4391 | ==> U-Boot will use R8 to hold a pointer to the global data |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4392 | |
Thomas Chou | 8fa3858 | 2010-05-21 11:08:03 +0800 | [diff] [blame] | 4393 | On Nios II, the ABI is documented here: |
| 4394 | http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf |
| 4395 | |
| 4396 | ==> U-Boot will use gp to hold a pointer to the global data |
| 4397 | |
| 4398 | Note: on Nios II, we give "-G0" option to gcc and don't use gp |
| 4399 | to access small data sections, so gp is free. |
| 4400 | |
Wolfgang Denk | 6405a15 | 2006-03-31 18:32:53 +0200 | [diff] [blame] | 4401 | NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, |
| 4402 | or current versions of GCC may "optimize" the code too much. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4403 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4404 | Memory Management: |
| 4405 | ------------------ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4406 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4407 | U-Boot runs in system state and uses physical addresses, i.e. the |
| 4408 | MMU is not used either for address mapping nor for memory protection. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4409 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4410 | The available memory is mapped to fixed addresses using the memory |
| 4411 | controller. In this process, a contiguous block is formed for each |
| 4412 | memory type (Flash, SDRAM, SRAM), even when it consists of several |
| 4413 | physical memory banks. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4414 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4415 | U-Boot is installed in the first 128 kB of the first Flash bank (on |
| 4416 | TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After |
| 4417 | booting and sizing and initializing DRAM, the code relocates itself |
| 4418 | 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] | 4419 | memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4420 | configuration setting]. Below that, a structure with global Board |
| 4421 | Info data is placed, followed by the stack (growing downward). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4422 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4423 | Additionally, some exception handler code is copied to the low 8 kB |
| 4424 | of DRAM (0x00000000 ... 0x00001FFF). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4425 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4426 | So a typical memory configuration with 16 MB of DRAM could look like |
| 4427 | this: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4428 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4429 | 0x0000 0000 Exception Vector code |
| 4430 | : |
| 4431 | 0x0000 1FFF |
| 4432 | 0x0000 2000 Free for Application Use |
| 4433 | : |
| 4434 | : |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4435 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4436 | : |
| 4437 | : |
| 4438 | 0x00FB FF20 Monitor Stack (Growing downward) |
| 4439 | 0x00FB FFAC Board Info Data and permanent copy of global data |
| 4440 | 0x00FC 0000 Malloc Arena |
| 4441 | : |
| 4442 | 0x00FD FFFF |
| 4443 | 0x00FE 0000 RAM Copy of Monitor Code |
| 4444 | ... eventually: LCD or video framebuffer |
| 4445 | ... eventually: pRAM (Protected RAM - unchanged by reset) |
| 4446 | 0x00FF FFFF [End of RAM] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4447 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4448 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4449 | System Initialization: |
| 4450 | ---------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4451 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4452 | In the reset configuration, U-Boot starts at the reset entry point |
Marcel Ziswiler | abd8dcb | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 4453 | (on most PowerPC systems at address 0x00000100). Because of the reset |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4454 | configuration for CS0# this is a mirror of the onboard Flash memory. |
| 4455 | To be able to re-map memory U-Boot then jumps to its link address. |
| 4456 | To be able to implement the initialization code in C, a (small!) |
| 4457 | initial stack is set up in the internal Dual Ported RAM (in case CPUs |
| 4458 | which provide such a feature like MPC8xx or MPC8260), or in a locked |
| 4459 | part of the data cache. After that, U-Boot initializes the CPU core, |
| 4460 | the caches and the SIU. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4461 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4462 | Next, all (potentially) available memory banks are mapped using a |
| 4463 | preliminary mapping. For example, we put them on 512 MB boundaries |
| 4464 | (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash |
| 4465 | on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is |
| 4466 | programmed for SDRAM access. Using the temporary configuration, a |
| 4467 | simple memory test is run that determines the size of the SDRAM |
| 4468 | banks. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4469 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4470 | When there is more than one SDRAM bank, and the banks are of |
| 4471 | different size, the largest is mapped first. For equal size, the first |
| 4472 | bank (CS2#) is mapped first. The first mapping is always for address |
| 4473 | 0x00000000, with any additional banks following immediately to create |
| 4474 | contiguous memory starting from 0. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4475 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4476 | Then, the monitor installs itself at the upper end of the SDRAM area |
| 4477 | and allocates memory for use by malloc() and for the global Board |
| 4478 | Info data; also, the exception vector code is copied to the low RAM |
| 4479 | pages, and the final stack is set up. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4480 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4481 | Only after this relocation will you have a "normal" C environment; |
| 4482 | until that you are restricted in several ways, mostly because you are |
| 4483 | running from ROM, and because the code will have to be relocated to a |
| 4484 | new address in RAM. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4485 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4486 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4487 | U-Boot Porting Guide: |
| 4488 | ---------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4489 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4490 | [Based on messages by Jerry Van Baren in the U-Boot-Users mailing |
| 4491 | list, October 2002] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4492 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4493 | |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4494 | int main(int argc, char *argv[]) |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4495 | { |
| 4496 | sighandler_t no_more_time; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4497 | |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4498 | signal(SIGALRM, no_more_time); |
| 4499 | alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4500 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4501 | if (available_money > available_manpower) { |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4502 | Pay consultant to port U-Boot; |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4503 | return 0; |
| 4504 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4505 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4506 | Download latest U-Boot source; |
wdenk | 34b613e | 2002-12-17 01:51:00 +0000 | [diff] [blame] | 4507 | |
Wolfgang Denk | 290ae6b | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 4508 | Subscribe to u-boot mailing list; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4509 | |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4510 | if (clueless) |
| 4511 | email("Hi, I am new to U-Boot, how do I get started?"); |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4512 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4513 | while (learning) { |
| 4514 | Read the README file in the top level directory; |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4515 | Read http://www.denx.de/twiki/bin/view/DULG/Manual; |
| 4516 | Read applicable doc/*.README; |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4517 | Read the source, Luke; |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4518 | /* find . -name "*.[chS]" | xargs grep -i <keyword> */ |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4519 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4520 | |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4521 | if (available_money > toLocalCurrency ($2500)) |
| 4522 | Buy a BDI3000; |
| 4523 | else |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4524 | Add a lot of aggravation and time; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4525 | |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4526 | if (a similar board exists) { /* hopefully... */ |
| 4527 | cp -a board/<similar> board/<myboard> |
| 4528 | cp include/configs/<similar>.h include/configs/<myboard>.h |
| 4529 | } else { |
| 4530 | Create your own board support subdirectory; |
| 4531 | Create your own board include/configs/<myboard>.h file; |
| 4532 | } |
| 4533 | Edit new board/<myboard> files |
| 4534 | Edit new include/configs/<myboard>.h |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4535 | |
Jerry Van Baren | ba0687c | 2009-07-15 20:42:59 -0400 | [diff] [blame] | 4536 | while (!accepted) { |
| 4537 | while (!running) { |
| 4538 | do { |
| 4539 | Add / modify source code; |
| 4540 | } until (compiles); |
| 4541 | Debug; |
| 4542 | if (clueless) |
| 4543 | email("Hi, I am having problems..."); |
| 4544 | } |
| 4545 | Send patch file to the U-Boot email list; |
| 4546 | if (reasonable critiques) |
| 4547 | Incorporate improvements from email list code review; |
| 4548 | else |
| 4549 | Defend code as written; |
wdenk | 634d2f7 | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 4550 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4551 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4552 | return 0; |
| 4553 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4554 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4555 | void no_more_time (int sig) |
| 4556 | { |
| 4557 | hire_a_guru(); |
| 4558 | } |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4559 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4560 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4561 | Coding Standards: |
| 4562 | ----------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4563 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4564 | All contributions to U-Boot should conform to the Linux kernel |
Detlev Zundel | aa63d48 | 2006-09-01 15:39:02 +0200 | [diff] [blame] | 4565 | coding style; see the file "Documentation/CodingStyle" and the script |
Wolfgang Denk | 20bd2a6 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 4566 | "scripts/Lindent" in your Linux kernel source directory. |
Detlev Zundel | aa63d48 | 2006-09-01 15:39:02 +0200 | [diff] [blame] | 4567 | |
| 4568 | Source files originating from a different project (for example the |
| 4569 | MTD subsystem) are generally exempt from these guidelines and are not |
| 4570 | reformated to ease subsequent migration to newer versions of those |
| 4571 | sources. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4572 | |
Detlev Zundel | aa63d48 | 2006-09-01 15:39:02 +0200 | [diff] [blame] | 4573 | Please note that U-Boot is implemented in C (and to some small parts in |
| 4574 | Assembler); no C++ is used, so please do not use C++ style comments (//) |
| 4575 | in your code. |
wdenk | ad276f2 | 2004-01-04 16:28:35 +0000 | [diff] [blame] | 4576 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4577 | Please also stick to the following formatting rules: |
| 4578 | - remove any trailing white space |
Wolfgang Denk | 20bd2a6 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 4579 | - use TAB characters for indentation and vertical alignment, not spaces |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4580 | - make sure NOT to use DOS '\r\n' line feeds |
Wolfgang Denk | 20bd2a6 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 4581 | - do not add more than 2 consecutive empty lines to source files |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4582 | - do not add trailing empty lines to source files |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4583 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4584 | Submissions which do not conform to the standards may be returned |
| 4585 | with a request to reformat the changes. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4586 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4587 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4588 | Submitting Patches: |
| 4589 | ------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4590 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4591 | Since the number of patches for U-Boot is growing, we need to |
| 4592 | establish some rules. Submissions which do not conform to these rules |
| 4593 | may be rejected, even when they contain important and valuable stuff. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4594 | |
Magnus Lilja | f3b287b | 2008-08-06 19:32:33 +0200 | [diff] [blame] | 4595 | Please see http://www.denx.de/wiki/U-Boot/Patches for details. |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4596 | |
Wolfgang Denk | 290ae6b | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 4597 | Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; |
| 4598 | see http://lists.denx.de/mailman/listinfo/u-boot |
| 4599 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4600 | When you send a patch, please include the following information with |
| 4601 | it: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4602 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4603 | * For bug fixes: a description of the bug and how your patch fixes |
| 4604 | this bug. Please try to include a way of demonstrating that the |
| 4605 | patch actually fixes something. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4606 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4607 | * For new features: a description of the feature and your |
| 4608 | implementation. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4609 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4610 | * A CHANGELOG entry as plaintext (separate from the patch) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4611 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4612 | * For major contributions, your entry to the CREDITS file |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4613 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4614 | * When you add support for a new board, don't forget to add this |
Wolfgang Denk | 20bd2a6 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 4615 | board to the MAINTAINERS file, too. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4616 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4617 | * If your patch adds new configuration options, don't forget to |
| 4618 | document these in the README file. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4619 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4620 | * The patch itself. If you are using git (which is *strongly* |
| 4621 | recommended) you can easily generate the patch using the |
Wolfgang Denk | 20bd2a6 | 2011-07-27 10:59:55 +0000 | [diff] [blame] | 4622 | "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] | 4623 | the U-Boot mailing list, you will avoid most of the common problems |
| 4624 | with some other mail clients. |
wdenk | ca9bc76 | 2003-07-15 07:45:49 +0000 | [diff] [blame] | 4625 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4626 | If you cannot use git, use "diff -purN OLD NEW". If your version of |
| 4627 | diff does not support these options, then get the latest version of |
| 4628 | GNU diff. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4629 | |
Wolfgang Denk | b240aef | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 4630 | The current directory when running this command shall be the parent |
| 4631 | directory of the U-Boot source tree (i. e. please make sure that |
| 4632 | your patch includes sufficient directory information for the |
| 4633 | affected files). |
| 4634 | |
| 4635 | We prefer patches as plain text. MIME attachments are discouraged, |
| 4636 | and compressed attachments must not be used. |
wdenk | 88e72a3 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4637 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4638 | * If one logical set of modifications affects or creates several |
| 4639 | files, all these changes shall be submitted in a SINGLE patch file. |
wdenk | 57b2d80 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 4640 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4641 | * Changesets that contain different, unrelated modifications shall be |
| 4642 | submitted as SEPARATE patches, one patch per changeset. |
wdenk | 88e72a3 | 2003-06-19 23:04:19 +0000 | [diff] [blame] | 4643 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4644 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4645 | Notes: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4646 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4647 | * Before sending the patch, run the MAKEALL script on your patched |
| 4648 | source tree and make sure that no errors or warnings are reported |
| 4649 | for any of the boards. |
| 4650 | |
| 4651 | * Keep your modifications to the necessary minimum: A patch |
| 4652 | containing several unrelated changes or arbitrary reformats will be |
| 4653 | returned with a request to re-formatting / split it. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4654 | |
wdenk | 6c59edc | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 4655 | * If you modify existing code, make sure that your new code does not |
| 4656 | add to the memory footprint of the code ;-) Small is beautiful! |
| 4657 | When adding new features, these should compile conditionally only |
| 4658 | (using #ifdef), and the resulting code with the new feature |
| 4659 | disabled must not need more memory than the old code without your |
| 4660 | modification. |
wdenk | cbc49a5 | 2005-05-03 14:12:25 +0000 | [diff] [blame] | 4661 | |
Wolfgang Denk | 290ae6b | 2008-12-30 22:56:11 +0100 | [diff] [blame] | 4662 | * Remember that there is a size limit of 100 kB per message on the |
| 4663 | u-boot mailing list. Bigger patches will be moderated. If they are |
| 4664 | reasonable and not too big, they will be acknowledged. But patches |
| 4665 | bigger than the size limit should be avoided. |