wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1 | # |
Wolfgang Denk | eca3aeb | 2013-06-21 10:22:36 +0200 | [diff] [blame] | 2 | # (C) Copyright 2000 - 2013 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 3 | # Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
| 4 | # |
Wolfgang Denk | eca3aeb | 2013-06-21 10:22:36 +0200 | [diff] [blame] | 5 | # SPDX-License-Identifier: GPL-2.0+ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 6 | # |
| 7 | |
| 8 | Summary: |
| 9 | ======== |
| 10 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 11 | This directory contains the source code for U-Boot, a boot loader for |
wdenk | e86e5a0 | 2004-10-17 21:12:06 +0000 | [diff] [blame] | 12 | Embedded boards based on PowerPC, ARM, MIPS and several other |
| 13 | processors, which can be installed in a boot ROM and used to |
| 14 | initialize and test the hardware or to download and run application |
| 15 | code. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 16 | |
| 17 | The development of U-Boot is closely related to Linux: some parts of |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 18 | the source code originate in the Linux source tree, we have some |
| 19 | header files in common, and special provision has been made to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 20 | support booting of Linux images. |
| 21 | |
| 22 | Some attention has been paid to make this software easily |
| 23 | configurable and extendable. For instance, all monitor commands are |
| 24 | implemented with the same call interface, so that it's very easy to |
| 25 | add new commands. Also, instead of permanently adding rarely used |
| 26 | code (for instance hardware test utilities) to the monitor, you can |
| 27 | load and run it dynamically. |
| 28 | |
| 29 | |
| 30 | Status: |
| 31 | ======= |
| 32 | |
| 33 | In general, all boards for which a configuration option exists in the |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 34 | Makefile have been tested to some extent and can be considered |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 35 | "working". In fact, many of them are used in production systems. |
| 36 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 37 | In case of problems see the CHANGELOG file to find out who contributed |
| 38 | the specific port. In addition, there are various MAINTAINERS files |
| 39 | scattered throughout the U-Boot source identifying the people or |
| 40 | companies responsible for various boards and subsystems. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 41 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 42 | Note: As of August, 2010, there is no longer a CHANGELOG file in the |
| 43 | actual U-Boot source tree; however, it can be created dynamically |
| 44 | from the Git log using: |
Robert P. J. Day | adb9d85 | 2012-11-14 02:03:20 +0000 | [diff] [blame] | 45 | |
| 46 | make CHANGELOG |
| 47 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 48 | |
| 49 | Where to get help: |
| 50 | ================== |
| 51 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 52 | In case you have questions about, problems with or contributions for |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 53 | U-Boot, you should send a message to the U-Boot mailing list at |
Peter Tyser | 0c32565 | 2008-09-10 09:18:34 -0500 | [diff] [blame] | 54 | <u-boot@lists.denx.de>. There is also an archive of previous traffic |
| 55 | on the mailing list - please search the archive before asking FAQ's. |
| 56 | Please see http://lists.denx.de/pipermail/u-boot and |
| 57 | http://dir.gmane.org/gmane.comp.boot-loaders.u-boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 58 | |
| 59 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 60 | Where to get source code: |
| 61 | ========================= |
| 62 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 63 | The U-Boot source code is maintained in the Git repository at |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 64 | git://www.denx.de/git/u-boot.git ; you can browse it online at |
| 65 | http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary |
| 66 | |
| 67 | The "snapshot" links on this page allow you to download tarballs of |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 68 | any version you might be interested in. Official releases are also |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 69 | available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ |
| 70 | directory. |
| 71 | |
Anatolij Gustschin | d4ee711 | 2008-03-26 18:13:33 +0100 | [diff] [blame] | 72 | Pre-built (and tested) images are available from |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 73 | ftp://ftp.denx.de/pub/u-boot/images/ |
| 74 | |
| 75 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 76 | Where we come from: |
| 77 | =================== |
| 78 | |
| 79 | - start from 8xxrom sources |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 80 | - create PPCBoot project (http://sourceforge.net/projects/ppcboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 81 | - clean up code |
| 82 | - make it easier to add custom boards |
| 83 | - make it possible to add other [PowerPC] CPUs |
| 84 | - extend functions, especially: |
| 85 | * Provide extended interface to Linux boot loader |
| 86 | * S-Record download |
| 87 | * network boot |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 88 | * PCMCIA / CompactFlash / ATA disk / SCSI ... boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 89 | - create ARMBoot project (http://sourceforge.net/projects/armboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 90 | - add other CPU families (starting with ARM) |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 91 | - create U-Boot project (http://sourceforge.net/projects/u-boot) |
Magnus Lilja | 0d28f34 | 2008-08-06 19:32:33 +0200 | [diff] [blame] | 92 | - current project page: see http://www.denx.de/wiki/U-Boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 93 | |
| 94 | |
| 95 | Names and Spelling: |
| 96 | =================== |
| 97 | |
| 98 | The "official" name of this project is "Das U-Boot". The spelling |
| 99 | "U-Boot" shall be used in all written text (documentation, comments |
| 100 | in source files etc.). Example: |
| 101 | |
| 102 | This is the README file for the U-Boot project. |
| 103 | |
| 104 | File names etc. shall be based on the string "u-boot". Examples: |
| 105 | |
| 106 | include/asm-ppc/u-boot.h |
| 107 | |
| 108 | #include <asm/u-boot.h> |
| 109 | |
| 110 | Variable names, preprocessor constants etc. shall be either based on |
| 111 | the string "u_boot" or on "U_BOOT". Example: |
| 112 | |
| 113 | U_BOOT_VERSION u_boot_logo |
| 114 | IH_OS_U_BOOT u_boot_hush_start |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 115 | |
| 116 | |
wdenk | 93f19cc | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 117 | Versioning: |
| 118 | =========== |
| 119 | |
Thomas Weber | 360d883 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 120 | Starting with the release in October 2008, the names of the releases |
| 121 | were changed from numerical release numbers without deeper meaning |
| 122 | into a time stamp based numbering. Regular releases are identified by |
| 123 | names consisting of the calendar year and month of the release date. |
| 124 | Additional fields (if present) indicate release candidates or bug fix |
| 125 | releases in "stable" maintenance trees. |
wdenk | 93f19cc | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 126 | |
Thomas Weber | 360d883 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 127 | Examples: |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 128 | U-Boot v2009.11 - Release November 2009 |
Thomas Weber | 360d883 | 2010-09-28 08:06:25 +0200 | [diff] [blame] | 129 | U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree |
| 130 | U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release |
wdenk | 93f19cc | 2002-12-17 17:55:09 +0000 | [diff] [blame] | 131 | |
| 132 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 133 | Directory Hierarchy: |
| 134 | ==================== |
| 135 | |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 136 | /arch Architecture specific files |
Masahiro Yamada | 6eae68e | 2014-03-07 18:02:02 +0900 | [diff] [blame] | 137 | /arc Files generic to ARC architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 138 | /arm Files generic to ARM architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 139 | /avr32 Files generic to AVR32 architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 140 | /blackfin Files generic to Analog Devices Blackfin architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 141 | /m68k Files generic to m68k architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 142 | /microblaze Files generic to microblaze architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 143 | /mips Files generic to MIPS architecture |
Macpaul Lin | afc1ce8 | 2011-10-19 20:41:11 +0000 | [diff] [blame] | 144 | /nds32 Files generic to NDS32 architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 145 | /nios2 Files generic to Altera NIOS2 architecture |
Robert P. J. Day | 33c7731 | 2013-09-15 18:34:15 -0400 | [diff] [blame] | 146 | /openrisc Files generic to OpenRISC architecture |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 147 | /powerpc Files generic to PowerPC architecture |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 148 | /sandbox Files generic to HW-independent "sandbox" |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 149 | /sh Files generic to SH architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 150 | /sparc Files generic to SPARC architecture |
Robert P. J. Day | 33c7731 | 2013-09-15 18:34:15 -0400 | [diff] [blame] | 151 | /x86 Files generic to x86 architecture |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 152 | /api Machine/arch independent API for external apps |
| 153 | /board Board dependent files |
| 154 | /common Misc architecture independent functions |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 155 | /configs Board default configuration files |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 156 | /disk Code for disk drive partition handling |
| 157 | /doc Documentation (don't expect too much) |
| 158 | /drivers Commonly used device drivers |
Robert P. J. Day | 33c7731 | 2013-09-15 18:34:15 -0400 | [diff] [blame] | 159 | /dts Contains Makefile for building internal U-Boot fdt. |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 160 | /examples Example code for standalone applications, etc. |
| 161 | /fs Filesystem code (cramfs, ext2, jffs2, etc.) |
| 162 | /include Header Files |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 163 | /lib Library routines generic to all architectures |
| 164 | /Licenses Various license files |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 165 | /net Networking code |
| 166 | /post Power On Self Test |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 167 | /scripts Various build scripts and Makefiles |
| 168 | /test Various unit test files |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 169 | /tools Tools to build S-Record or U-Boot images, etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 170 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 171 | Software Configuration: |
| 172 | ======================= |
| 173 | |
| 174 | Configuration is usually done using C preprocessor defines; the |
| 175 | rationale behind that is to avoid dead code whenever possible. |
| 176 | |
| 177 | There are two classes of configuration variables: |
| 178 | |
| 179 | * Configuration _OPTIONS_: |
| 180 | These are selectable by the user and have names beginning with |
| 181 | "CONFIG_". |
| 182 | |
| 183 | * Configuration _SETTINGS_: |
| 184 | These depend on the hardware etc. and should not be meddled with if |
| 185 | you don't know what you're doing; they have names beginning with |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 186 | "CONFIG_SYS_". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 187 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 188 | Previously, all configuration was done by hand, which involved creating |
| 189 | symbolic links and editing configuration files manually. More recently, |
| 190 | U-Boot has added the Kbuild infrastructure used by the Linux kernel, |
| 191 | allowing you to use the "make menuconfig" command to configure your |
| 192 | build. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 193 | |
| 194 | |
| 195 | Selection of Processor Architecture and Board Type: |
| 196 | --------------------------------------------------- |
| 197 | |
| 198 | For all supported boards there are ready-to-use default |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 199 | configurations available; just type "make <board_name>_defconfig". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 200 | |
| 201 | Example: For a TQM823L module type: |
| 202 | |
| 203 | cd u-boot |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 204 | make TQM823L_defconfig |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 205 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 206 | Note: If you're looking for the default configuration file for a board |
| 207 | you're sure used to be there but is now missing, check the file |
| 208 | doc/README.scrapyard for a list of no longer supported boards. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 209 | |
Simon Glass | 75b3c3a | 2014-03-22 17:12:59 -0600 | [diff] [blame] | 210 | Sandbox Environment: |
| 211 | -------------------- |
| 212 | |
| 213 | U-Boot can be built natively to run on a Linux host using the 'sandbox' |
| 214 | board. This allows feature development which is not board- or architecture- |
| 215 | specific to be undertaken on a native platform. The sandbox is also used to |
| 216 | run some of U-Boot's tests. |
| 217 | |
Jagannadha Sutradharudu Teki | 6b1978f | 2014-08-31 21:19:43 +0530 | [diff] [blame] | 218 | See board/sandbox/README.sandbox for more details. |
Simon Glass | 75b3c3a | 2014-03-22 17:12:59 -0600 | [diff] [blame] | 219 | |
| 220 | |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 221 | Board Initialisation Flow: |
| 222 | -------------------------- |
| 223 | |
| 224 | This is the intended start-up flow for boards. This should apply for both |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 225 | SPL and U-Boot proper (i.e. they both follow the same rules). |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 226 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 227 | Note: "SPL" stands for "Secondary Program Loader," which is explained in |
| 228 | more detail later in this file. |
| 229 | |
| 230 | At present, SPL mostly uses a separate code path, but the function names |
| 231 | and roles of each function are the same. Some boards or architectures |
| 232 | may not conform to this. At least most ARM boards which use |
| 233 | CONFIG_SPL_FRAMEWORK conform to this. |
| 234 | |
| 235 | Execution typically starts with an architecture-specific (and possibly |
| 236 | CPU-specific) start.S file, such as: |
| 237 | |
| 238 | - arch/arm/cpu/armv7/start.S |
| 239 | - arch/powerpc/cpu/mpc83xx/start.S |
| 240 | - arch/mips/cpu/start.S |
| 241 | |
| 242 | and so on. From there, three functions are called; the purpose and |
| 243 | limitations of each of these functions are described below. |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 244 | |
| 245 | lowlevel_init(): |
| 246 | - purpose: essential init to permit execution to reach board_init_f() |
| 247 | - no global_data or BSS |
| 248 | - there is no stack (ARMv7 may have one but it will soon be removed) |
| 249 | - must not set up SDRAM or use console |
| 250 | - must only do the bare minimum to allow execution to continue to |
| 251 | board_init_f() |
| 252 | - this is almost never needed |
| 253 | - return normally from this function |
| 254 | |
| 255 | board_init_f(): |
| 256 | - purpose: set up the machine ready for running board_init_r(): |
| 257 | i.e. SDRAM and serial UART |
| 258 | - global_data is available |
| 259 | - stack is in SRAM |
| 260 | - BSS is not available, so you cannot use global/static variables, |
| 261 | only stack variables and global_data |
| 262 | |
| 263 | Non-SPL-specific notes: |
| 264 | - dram_init() is called to set up DRAM. If already done in SPL this |
| 265 | can do nothing |
| 266 | |
| 267 | SPL-specific notes: |
| 268 | - you can override the entire board_init_f() function with your own |
| 269 | version as needed. |
| 270 | - preloader_console_init() can be called here in extremis |
| 271 | - should set up SDRAM, and anything needed to make the UART work |
| 272 | - these is no need to clear BSS, it will be done by crt0.S |
| 273 | - must return normally from this function (don't call board_init_r() |
| 274 | directly) |
| 275 | |
| 276 | Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at |
| 277 | this point the stack and global_data are relocated to below |
| 278 | CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of |
| 279 | memory. |
| 280 | |
| 281 | board_init_r(): |
| 282 | - purpose: main execution, common code |
| 283 | - global_data is available |
| 284 | - SDRAM is available |
| 285 | - BSS is available, all static/global variables can be used |
| 286 | - execution eventually continues to main_loop() |
| 287 | |
| 288 | Non-SPL-specific notes: |
| 289 | - U-Boot is relocated to the top of memory and is now running from |
| 290 | there. |
| 291 | |
| 292 | SPL-specific notes: |
| 293 | - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and |
| 294 | CONFIG_SPL_STACK_R_ADDR points into SDRAM |
| 295 | - preloader_console_init() can be called here - typically this is |
| 296 | done by defining CONFIG_SPL_BOARD_INIT and then supplying a |
| 297 | spl_board_init() function containing this call |
| 298 | - loads U-Boot or (in falcon mode) Linux |
| 299 | |
| 300 | |
| 301 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 302 | Configuration Options: |
| 303 | ---------------------- |
| 304 | |
| 305 | Configuration depends on the combination of board and CPU type; all |
| 306 | such information is kept in a configuration file |
| 307 | "include/configs/<board_name>.h". |
| 308 | |
| 309 | Example: For a TQM823L module, all configuration settings are in |
| 310 | "include/configs/TQM823L.h". |
| 311 | |
| 312 | |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 313 | Many of the options are named exactly as the corresponding Linux |
| 314 | kernel configuration options. The intention is to make it easier to |
| 315 | build a config tool - later. |
| 316 | |
| 317 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 318 | The following options need to be configured: |
| 319 | |
Kim Phillips | 2628114 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 320 | - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 321 | |
Kim Phillips | 2628114 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 322 | - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. |
Wolfgang Denk | 6ccec44 | 2006-10-24 14:42:37 +0200 | [diff] [blame] | 323 | |
| 324 | - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) |
Haavard Skinnemoen | 09ea0de | 2007-11-01 12:44:20 +0100 | [diff] [blame] | 325 | Define exactly one, e.g. CONFIG_ATSTK1002 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 326 | |
| 327 | - CPU Module Type: (if CONFIG_COGENT is defined) |
| 328 | Define exactly one of |
| 329 | CONFIG_CMA286_60_OLD |
| 330 | --- FIXME --- not tested yet: |
| 331 | CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, |
| 332 | CONFIG_CMA287_23, CONFIG_CMA287_50 |
| 333 | |
| 334 | - Motherboard Type: (if CONFIG_COGENT is defined) |
| 335 | Define exactly one of |
| 336 | CONFIG_CMA101, CONFIG_CMA102 |
| 337 | |
| 338 | - Motherboard I/O Modules: (if CONFIG_COGENT is defined) |
| 339 | Define one or more of |
| 340 | CONFIG_CMA302 |
| 341 | |
| 342 | - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) |
| 343 | Define one or more of |
| 344 | CONFIG_LCD_HEARTBEAT - update a character position on |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 345 | the LCD display every second with |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 346 | a "rotator" |\-/|\-/ |
| 347 | |
Lei Wen | cf946c6 | 2011-02-09 18:06:58 +0530 | [diff] [blame] | 348 | - Marvell Family Member |
| 349 | CONFIG_SYS_MVFS - define it if you want to enable |
| 350 | multiple fs option at one time |
| 351 | for marvell soc family |
| 352 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 353 | - 8xx CPU Options: (if using an MPC8xx CPU) |
wdenk | 66ca92a | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 354 | CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if |
| 355 | get_gclk_freq() cannot work |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 356 | e.g. if there is no 32KHz |
| 357 | reference PIT/RTC clock |
wdenk | 66ca92a | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 358 | CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK |
| 359 | or XTAL/EXTAL) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 360 | |
wdenk | 66ca92a | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 361 | - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 362 | CONFIG_SYS_8xx_CPUCLK_MIN |
| 363 | CONFIG_SYS_8xx_CPUCLK_MAX |
wdenk | 66ca92a | 2004-09-28 17:59:53 +0000 | [diff] [blame] | 364 | CONFIG_8xx_CPUCLK_DEFAULT |
wdenk | 75d1ea7 | 2004-01-31 20:06:54 +0000 | [diff] [blame] | 365 | See doc/README.MPC866 |
| 366 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 367 | CONFIG_SYS_MEASURE_CPUCLK |
wdenk | 75d1ea7 | 2004-01-31 20:06:54 +0000 | [diff] [blame] | 368 | |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 369 | Define this to measure the actual CPU clock instead |
| 370 | of relying on the correctness of the configured |
| 371 | values. Mostly useful for board bringup to make sure |
| 372 | the PLL is locked at the intended frequency. Note |
| 373 | that this requires a (stable) reference clock (32 kHz |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 374 | RTC clock or CONFIG_SYS_8XX_XIN) |
wdenk | 75d1ea7 | 2004-01-31 20:06:54 +0000 | [diff] [blame] | 375 | |
Heiko Schocher | 506f391 | 2009-03-12 07:37:15 +0100 | [diff] [blame] | 376 | CONFIG_SYS_DELAYED_ICACHE |
| 377 | |
| 378 | Define this option if you want to enable the |
| 379 | ICache only when Code runs from RAM. |
| 380 | |
Kumar Gala | 66412c6 | 2011-02-18 05:40:54 -0600 | [diff] [blame] | 381 | - 85xx CPU Options: |
York Sun | ffd06e0 | 2012-10-08 07:44:30 +0000 | [diff] [blame] | 382 | CONFIG_SYS_PPC64 |
| 383 | |
| 384 | Specifies that the core is a 64-bit PowerPC implementation (implements |
| 385 | the "64" category of the Power ISA). This is necessary for ePAPR |
| 386 | compliance, among other possible reasons. |
| 387 | |
Kumar Gala | 66412c6 | 2011-02-18 05:40:54 -0600 | [diff] [blame] | 388 | CONFIG_SYS_FSL_TBCLK_DIV |
| 389 | |
| 390 | Defines the core time base clock divider ratio compared to the |
| 391 | system clock. On most PQ3 devices this is 8, on newer QorIQ |
| 392 | devices it can be 16 or 32. The ratio varies from SoC to Soc. |
| 393 | |
Kumar Gala | 8f29084 | 2011-05-20 00:39:21 -0500 | [diff] [blame] | 394 | CONFIG_SYS_FSL_PCIE_COMPAT |
| 395 | |
| 396 | Defines the string to utilize when trying to match PCIe device |
| 397 | tree nodes for the given platform. |
| 398 | |
Prabhakar Kushwaha | afa6b55 | 2012-04-29 23:56:13 +0000 | [diff] [blame] | 399 | CONFIG_SYS_PPC_E500_DEBUG_TLB |
| 400 | |
| 401 | Enables a temporary TLB entry to be used during boot to work |
| 402 | around limitations in e500v1 and e500v2 external debugger |
| 403 | support. This reduces the portions of the boot code where |
| 404 | breakpoints and single stepping do not work. The value of this |
| 405 | symbol should be set to the TLB1 entry to be used for this |
| 406 | purpose. |
| 407 | |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 408 | CONFIG_SYS_FSL_ERRATUM_A004510 |
| 409 | |
| 410 | Enables a workaround for erratum A004510. If set, |
| 411 | then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and |
| 412 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. |
| 413 | |
| 414 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV |
| 415 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) |
| 416 | |
| 417 | Defines one or two SoC revisions (low 8 bits of SVR) |
| 418 | for which the A004510 workaround should be applied. |
| 419 | |
| 420 | The rest of SVR is either not relevant to the decision |
| 421 | of whether the erratum is present (e.g. p2040 versus |
| 422 | p2041) or is implied by the build target, which controls |
| 423 | whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. |
| 424 | |
| 425 | See Freescale App Note 4493 for more information about |
| 426 | this erratum. |
| 427 | |
Prabhakar Kushwaha | 74fa22e | 2013-04-16 13:27:44 +0530 | [diff] [blame] | 428 | CONFIG_A003399_NOR_WORKAROUND |
| 429 | Enables a workaround for IFC erratum A003399. It is only |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 430 | required during NOR boot. |
Prabhakar Kushwaha | 74fa22e | 2013-04-16 13:27:44 +0530 | [diff] [blame] | 431 | |
Prabhakar Kushwaha | 9f074e6 | 2014-10-29 22:33:09 +0530 | [diff] [blame] | 432 | CONFIG_A008044_WORKAROUND |
| 433 | Enables a workaround for T1040/T1042 erratum A008044. It is only |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 434 | required during NAND boot and valid for Rev 1.0 SoC revision |
Prabhakar Kushwaha | 9f074e6 | 2014-10-29 22:33:09 +0530 | [diff] [blame] | 435 | |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 436 | CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY |
| 437 | |
| 438 | This is the value to write into CCSR offset 0x18600 |
| 439 | according to the A004510 workaround. |
| 440 | |
Priyanka Jain | 64501c6 | 2013-07-02 09:21:04 +0530 | [diff] [blame] | 441 | CONFIG_SYS_FSL_DSP_DDR_ADDR |
| 442 | This value denotes start offset of DDR memory which is |
| 443 | connected exclusively to the DSP cores. |
| 444 | |
Priyanka Jain | 765b0bd | 2013-04-04 09:31:54 +0530 | [diff] [blame] | 445 | CONFIG_SYS_FSL_DSP_M2_RAM_ADDR |
| 446 | This value denotes start offset of M2 memory |
| 447 | which is directly connected to the DSP core. |
| 448 | |
Priyanka Jain | 64501c6 | 2013-07-02 09:21:04 +0530 | [diff] [blame] | 449 | CONFIG_SYS_FSL_DSP_M3_RAM_ADDR |
| 450 | This value denotes start offset of M3 memory which is directly |
| 451 | connected to the DSP core. |
| 452 | |
Priyanka Jain | 765b0bd | 2013-04-04 09:31:54 +0530 | [diff] [blame] | 453 | CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT |
| 454 | This value denotes start offset of DSP CCSR space. |
| 455 | |
Priyanka Jain | b135991 | 2013-12-17 14:25:52 +0530 | [diff] [blame] | 456 | CONFIG_SYS_FSL_SINGLE_SOURCE_CLK |
| 457 | Single Source Clock is clocking mode present in some of FSL SoC's. |
| 458 | In this mode, a single differential clock is used to supply |
| 459 | clocks to the sysclock, ddrclock and usbclock. |
| 460 | |
Aneesh Bansal | fb4a240 | 2014-03-18 23:40:26 +0530 | [diff] [blame] | 461 | CONFIG_SYS_CPC_REINIT_F |
| 462 | This CONFIG is defined when the CPC is configured as SRAM at the |
Bin Meng | a187559 | 2016-02-05 19:30:11 -0800 | [diff] [blame] | 463 | time of U-Boot entry and is required to be re-initialized. |
Aneesh Bansal | fb4a240 | 2014-03-18 23:40:26 +0530 | [diff] [blame] | 464 | |
Tang Yuantian | aade200 | 2014-04-17 15:33:46 +0800 | [diff] [blame] | 465 | CONFIG_DEEP_SLEEP |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 466 | Indicates this SoC supports deep sleep feature. If deep sleep is |
Tang Yuantian | aade200 | 2014-04-17 15:33:46 +0800 | [diff] [blame] | 467 | supported, core will start to execute uboot when wakes up. |
| 468 | |
Daniel Schwierzeck | 6cb461b | 2012-04-02 02:57:56 +0000 | [diff] [blame] | 469 | - Generic CPU options: |
York Sun | 2a1680e | 2014-05-02 17:28:04 -0700 | [diff] [blame] | 470 | CONFIG_SYS_GENERIC_GLOBAL_DATA |
| 471 | Defines global data is initialized in generic board board_init_f(). |
| 472 | If this macro is defined, global data is created and cleared in |
| 473 | generic board board_init_f(). Without this macro, architecture/board |
| 474 | should initialize global data before calling board_init_f(). |
| 475 | |
Daniel Schwierzeck | 6cb461b | 2012-04-02 02:57:56 +0000 | [diff] [blame] | 476 | CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN |
| 477 | |
| 478 | Defines the endianess of the CPU. Implementation of those |
| 479 | values is arch specific. |
| 480 | |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 481 | CONFIG_SYS_FSL_DDR |
| 482 | Freescale DDR driver in use. This type of DDR controller is |
| 483 | found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core |
| 484 | SoCs. |
| 485 | |
| 486 | CONFIG_SYS_FSL_DDR_ADDR |
| 487 | Freescale DDR memory-mapped register base. |
| 488 | |
| 489 | CONFIG_SYS_FSL_DDR_EMU |
| 490 | Specify emulator support for DDR. Some DDR features such as |
| 491 | deskew training are not available. |
| 492 | |
| 493 | CONFIG_SYS_FSL_DDRC_GEN1 |
| 494 | Freescale DDR1 controller. |
| 495 | |
| 496 | CONFIG_SYS_FSL_DDRC_GEN2 |
| 497 | Freescale DDR2 controller. |
| 498 | |
| 499 | CONFIG_SYS_FSL_DDRC_GEN3 |
| 500 | Freescale DDR3 controller. |
| 501 | |
York Sun | 34e026f | 2014-03-27 17:54:47 -0700 | [diff] [blame] | 502 | CONFIG_SYS_FSL_DDRC_GEN4 |
| 503 | Freescale DDR4 controller. |
| 504 | |
York Sun | 9ac4ffb | 2013-09-30 14:20:51 -0700 | [diff] [blame] | 505 | CONFIG_SYS_FSL_DDRC_ARM_GEN3 |
| 506 | Freescale DDR3 controller for ARM-based SoCs. |
| 507 | |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 508 | CONFIG_SYS_FSL_DDR1 |
| 509 | Board config to use DDR1. It can be enabled for SoCs with |
| 510 | Freescale DDR1 or DDR2 controllers, depending on the board |
| 511 | implemetation. |
| 512 | |
| 513 | CONFIG_SYS_FSL_DDR2 |
| 514 | Board config to use DDR2. It can be eanbeld for SoCs with |
| 515 | Freescale DDR2 or DDR3 controllers, depending on the board |
| 516 | implementation. |
| 517 | |
| 518 | CONFIG_SYS_FSL_DDR3 |
| 519 | Board config to use DDR3. It can be enabled for SoCs with |
York Sun | 34e026f | 2014-03-27 17:54:47 -0700 | [diff] [blame] | 520 | Freescale DDR3 or DDR3L controllers. |
| 521 | |
| 522 | CONFIG_SYS_FSL_DDR3L |
| 523 | Board config to use DDR3L. It can be enabled for SoCs with |
| 524 | DDR3L controllers. |
| 525 | |
| 526 | CONFIG_SYS_FSL_DDR4 |
| 527 | Board config to use DDR4. It can be enabled for SoCs with |
| 528 | DDR4 controllers. |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 529 | |
Prabhakar Kushwaha | 1b4175d | 2014-01-18 12:28:30 +0530 | [diff] [blame] | 530 | CONFIG_SYS_FSL_IFC_BE |
| 531 | Defines the IFC controller register space as Big Endian |
| 532 | |
| 533 | CONFIG_SYS_FSL_IFC_LE |
| 534 | Defines the IFC controller register space as Little Endian |
| 535 | |
Prabhakar Kushwaha | 690e425 | 2014-01-13 11:28:04 +0530 | [diff] [blame] | 536 | CONFIG_SYS_FSL_PBL_PBI |
| 537 | It enables addition of RCW (Power on reset configuration) in built image. |
| 538 | Please refer doc/README.pblimage for more details |
| 539 | |
| 540 | CONFIG_SYS_FSL_PBL_RCW |
| 541 | It adds PBI(pre-boot instructions) commands in u-boot build image. |
| 542 | PBI commands can be used to configure SoC before it starts the execution. |
| 543 | Please refer doc/README.pblimage for more details |
| 544 | |
Prabhakar Kushwaha | 89ad7be | 2014-04-08 19:13:34 +0530 | [diff] [blame] | 545 | CONFIG_SPL_FSL_PBL |
| 546 | It adds a target to create boot binary having SPL binary in PBI format |
| 547 | concatenated with u-boot binary. |
| 548 | |
York Sun | 4e5b1bd | 2014-02-10 13:59:42 -0800 | [diff] [blame] | 549 | CONFIG_SYS_FSL_DDR_BE |
| 550 | Defines the DDR controller register space as Big Endian |
| 551 | |
| 552 | CONFIG_SYS_FSL_DDR_LE |
| 553 | Defines the DDR controller register space as Little Endian |
| 554 | |
York Sun | 6b9e309 | 2014-02-10 13:59:43 -0800 | [diff] [blame] | 555 | CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY |
| 556 | Physical address from the view of DDR controllers. It is the |
| 557 | same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But |
| 558 | it could be different for ARM SoCs. |
| 559 | |
York Sun | 6b1e125 | 2014-02-10 13:59:44 -0800 | [diff] [blame] | 560 | CONFIG_SYS_FSL_DDR_INTLV_256B |
| 561 | DDR controller interleaving on 256-byte. This is a special |
| 562 | interleaving mode, handled by Dickens for Freescale layerscape |
| 563 | SoCs with ARM core. |
| 564 | |
York Sun | 1d71efb | 2014-08-01 15:51:00 -0700 | [diff] [blame] | 565 | CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS |
| 566 | Number of controllers used as main memory. |
| 567 | |
| 568 | CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS |
| 569 | Number of controllers used for other than main memory. |
| 570 | |
Prabhakar Kushwaha | 4493721 | 2015-11-09 16:42:07 +0530 | [diff] [blame] | 571 | CONFIG_SYS_FSL_HAS_DP_DDR |
| 572 | Defines the SoC has DP-DDR used for DPAA. |
| 573 | |
Ruchika Gupta | 028dbb8 | 2014-09-09 11:50:31 +0530 | [diff] [blame] | 574 | CONFIG_SYS_FSL_SEC_BE |
| 575 | Defines the SEC controller register space as Big Endian |
| 576 | |
| 577 | CONFIG_SYS_FSL_SEC_LE |
| 578 | Defines the SEC controller register space as Little Endian |
| 579 | |
Markus Klotzbuecher | 0b953ff | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 580 | - Intel Monahans options: |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 581 | CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO |
Markus Klotzbuecher | 0b953ff | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 582 | |
| 583 | Defines the Monahans run mode to oscillator |
| 584 | ratio. Valid values are 8, 16, 24, 31. The core |
| 585 | frequency is this value multiplied by 13 MHz. |
| 586 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 587 | CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO |
Wolfgang Denk | cf48eb9 | 2006-04-16 10:51:58 +0200 | [diff] [blame] | 588 | |
Markus Klotzbuecher | 0b953ff | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 589 | Defines the Monahans turbo mode to oscillator |
| 590 | ratio. Valid values are 1 (default if undefined) and |
Wolfgang Denk | cf48eb9 | 2006-04-16 10:51:58 +0200 | [diff] [blame] | 591 | 2. The core frequency as calculated above is multiplied |
Markus Klotzbuecher | 0b953ff | 2006-03-24 15:28:02 +0100 | [diff] [blame] | 592 | by this value. |
Wolfgang Denk | cf48eb9 | 2006-04-16 10:51:58 +0200 | [diff] [blame] | 593 | |
Daniel Schwierzeck | 92bbd64 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 594 | - MIPS CPU options: |
| 595 | CONFIG_SYS_INIT_SP_OFFSET |
| 596 | |
| 597 | Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack |
| 598 | pointer. This is needed for the temporary stack before |
| 599 | relocation. |
| 600 | |
| 601 | CONFIG_SYS_MIPS_CACHE_MODE |
| 602 | |
| 603 | Cache operation mode for the MIPS CPU. |
| 604 | See also arch/mips/include/asm/mipsregs.h. |
| 605 | Possible values are: |
| 606 | CONF_CM_CACHABLE_NO_WA |
| 607 | CONF_CM_CACHABLE_WA |
| 608 | CONF_CM_UNCACHED |
| 609 | CONF_CM_CACHABLE_NONCOHERENT |
| 610 | CONF_CM_CACHABLE_CE |
| 611 | CONF_CM_CACHABLE_COW |
| 612 | CONF_CM_CACHABLE_CUW |
| 613 | CONF_CM_CACHABLE_ACCELERATED |
| 614 | |
| 615 | CONFIG_SYS_XWAY_EBU_BOOTCFG |
| 616 | |
| 617 | Special option for Lantiq XWAY SoCs for booting from NOR flash. |
| 618 | See also arch/mips/cpu/mips32/start.S. |
| 619 | |
| 620 | CONFIG_XWAY_SWAP_BYTES |
| 621 | |
| 622 | Enable compilation of tools/xway-swap-bytes needed for Lantiq |
| 623 | XWAY SoCs for booting from NOR flash. The U-Boot image needs to |
| 624 | be swapped if a flash programmer is used. |
| 625 | |
Christian Riesch | b67d881 | 2012-02-02 00:44:39 +0000 | [diff] [blame] | 626 | - ARM options: |
| 627 | CONFIG_SYS_EXCEPTION_VECTORS_HIGH |
| 628 | |
| 629 | Select high exception vectors of the ARM core, e.g., do not |
| 630 | clear the V bit of the c1 register of CP15. |
| 631 | |
Aneesh V | 5356f54 | 2012-03-08 07:20:19 +0000 | [diff] [blame] | 632 | CONFIG_SYS_THUMB_BUILD |
| 633 | |
| 634 | Use this flag to build U-Boot using the Thumb instruction |
| 635 | set for ARM architectures. Thumb instruction set provides |
| 636 | better code density. For ARM architectures that support |
| 637 | Thumb2 this flag will result in Thumb2 code generated by |
| 638 | GCC. |
| 639 | |
Stephen Warren | c5d4752 | 2013-03-04 13:29:40 +0000 | [diff] [blame] | 640 | CONFIG_ARM_ERRATA_716044 |
Stephen Warren | 0678587 | 2013-02-26 12:28:27 +0000 | [diff] [blame] | 641 | CONFIG_ARM_ERRATA_742230 |
| 642 | CONFIG_ARM_ERRATA_743622 |
| 643 | CONFIG_ARM_ERRATA_751472 |
Nitin Garg | b7588e3 | 2014-04-02 08:55:02 -0500 | [diff] [blame] | 644 | CONFIG_ARM_ERRATA_761320 |
Ian Campbell | e392b92 | 2015-09-29 10:27:09 +0100 | [diff] [blame] | 645 | CONFIG_ARM_ERRATA_773022 |
| 646 | CONFIG_ARM_ERRATA_774769 |
| 647 | CONFIG_ARM_ERRATA_794072 |
Stephen Warren | 0678587 | 2013-02-26 12:28:27 +0000 | [diff] [blame] | 648 | |
| 649 | If set, the workarounds for these ARM errata are applied early |
| 650 | during U-Boot startup. Note that these options force the |
| 651 | workarounds to be applied; no CPU-type/version detection |
| 652 | exists, unlike the similar options in the Linux kernel. Do not |
| 653 | set these options unless they apply! |
| 654 | |
York Sun | 207774b | 2015-03-20 19:28:08 -0700 | [diff] [blame] | 655 | COUNTER_FREQUENCY |
| 656 | Generic timer clock source frequency. |
| 657 | |
| 658 | COUNTER_FREQUENCY_REAL |
| 659 | Generic timer clock source frequency if the real clock is |
| 660 | different from COUNTER_FREQUENCY, and can only be determined |
| 661 | at run time. |
| 662 | |
Nishanth Menon | c616a0d | 2015-03-09 17:11:59 -0500 | [diff] [blame] | 663 | NOTE: The following can be machine specific errata. These |
| 664 | do have ability to provide rudimentary version and machine |
| 665 | specific checks, but expect no product checks. |
Nishanth Menon | 5902f4c | 2015-03-09 17:12:01 -0500 | [diff] [blame] | 666 | CONFIG_ARM_ERRATA_430973 |
Nishanth Menon | b45c48a | 2015-03-09 17:12:00 -0500 | [diff] [blame] | 667 | CONFIG_ARM_ERRATA_454179 |
Nishanth Menon | 9b4d65f | 2015-03-09 17:12:02 -0500 | [diff] [blame] | 668 | CONFIG_ARM_ERRATA_621766 |
Nishanth Menon | c616a0d | 2015-03-09 17:11:59 -0500 | [diff] [blame] | 669 | CONFIG_ARM_ERRATA_798870 |
Nishanth Menon | a615d0b | 2015-07-27 16:26:05 -0500 | [diff] [blame] | 670 | CONFIG_ARM_ERRATA_801819 |
Nishanth Menon | c616a0d | 2015-03-09 17:11:59 -0500 | [diff] [blame] | 671 | |
Stephen Warren | 73c3893 | 2015-01-19 16:25:52 -0700 | [diff] [blame] | 672 | - Tegra SoC options: |
| 673 | CONFIG_TEGRA_SUPPORT_NON_SECURE |
| 674 | |
| 675 | Support executing U-Boot in non-secure (NS) mode. Certain |
| 676 | impossible actions will be skipped if the CPU is in NS mode, |
| 677 | such as ARM architectural timer initialization. |
| 678 | |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 679 | - Linux Kernel Interface: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 680 | CONFIG_CLOCKS_IN_MHZ |
| 681 | |
| 682 | U-Boot stores all clock information in Hz |
| 683 | internally. For binary compatibility with older Linux |
| 684 | kernels (which expect the clocks passed in the |
| 685 | bd_info data to be in MHz) the environment variable |
| 686 | "clocks_in_mhz" can be defined so that U-Boot |
| 687 | converts clock data to MHZ before passing it to the |
| 688 | Linux kernel. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 689 | When CONFIG_CLOCKS_IN_MHZ is defined, a definition of |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 690 | "clocks_in_mhz=1" is automatically included in the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 691 | default environment. |
| 692 | |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 693 | CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] |
| 694 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 695 | When transferring memsize parameter to Linux, some versions |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 696 | expect it to be in bytes, others in MB. |
| 697 | Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. |
| 698 | |
Gerald Van Baren | fec6d9e | 2008-06-03 20:34:45 -0400 | [diff] [blame] | 699 | CONFIG_OF_LIBFDT |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 700 | |
| 701 | New kernel versions are expecting firmware settings to be |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 702 | passed using flattened device trees (based on open firmware |
| 703 | concepts). |
| 704 | |
| 705 | CONFIG_OF_LIBFDT |
| 706 | * New libfdt-based support |
| 707 | * Adds the "fdt" command |
Kim Phillips | 3bb342f | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 708 | * The bootm command automatically updates the fdt |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 709 | |
Marcel Ziswiler | b55ae40 | 2009-09-09 21:18:41 +0200 | [diff] [blame] | 710 | OF_CPU - The proper name of the cpus node (only required for |
| 711 | MPC512X and MPC5xxx based boards). |
| 712 | OF_SOC - The proper name of the soc node (only required for |
| 713 | MPC512X and MPC5xxx based boards). |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 714 | OF_TBCLK - The timebase frequency. |
Kumar Gala | c2871f0 | 2006-01-11 13:59:02 -0600 | [diff] [blame] | 715 | OF_STDOUT_PATH - The path to the console device |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 716 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 717 | boards with QUICC Engines require OF_QE to set UCC MAC |
| 718 | addresses |
Kim Phillips | 3bb342f | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 719 | |
Kumar Gala | 4e25313 | 2006-01-11 13:54:17 -0600 | [diff] [blame] | 720 | CONFIG_OF_BOARD_SETUP |
| 721 | |
| 722 | Board code has addition modification that it wants to make |
| 723 | to the flat device tree before handing it off to the kernel |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 724 | |
Simon Glass | c654b51 | 2014-10-23 18:58:54 -0600 | [diff] [blame] | 725 | CONFIG_OF_SYSTEM_SETUP |
| 726 | |
| 727 | Other code has addition modification that it wants to make |
| 728 | to the flat device tree before handing it off to the kernel. |
| 729 | This causes ft_system_setup() to be called before booting |
| 730 | the kernel. |
| 731 | |
Matthew McClintock | 0267768 | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 732 | CONFIG_OF_BOOT_CPU |
| 733 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 734 | This define fills in the correct boot CPU in the boot |
Matthew McClintock | 0267768 | 2006-06-28 10:41:37 -0500 | [diff] [blame] | 735 | param header, the default value is zero if undefined. |
| 736 | |
Heiko Schocher | 3887c3f | 2009-09-23 07:56:08 +0200 | [diff] [blame] | 737 | CONFIG_OF_IDE_FIXUP |
| 738 | |
| 739 | U-Boot can detect if an IDE device is present or not. |
| 740 | If not, and this new config option is activated, U-Boot |
| 741 | removes the ATA node from the DTS before booting Linux, |
| 742 | so the Linux IDE driver does not probe the device and |
| 743 | crash. This is needed for buggy hardware (uc101) where |
| 744 | no pull down resistor is connected to the signal IDE5V_DD7. |
| 745 | |
Igor Grinberg | 7eb2939 | 2011-07-14 05:45:07 +0000 | [diff] [blame] | 746 | CONFIG_MACH_TYPE [relevant for ARM only][mandatory] |
| 747 | |
| 748 | This setting is mandatory for all boards that have only one |
| 749 | machine type and must be used to specify the machine type |
| 750 | number as it appears in the ARM machine registry |
| 751 | (see http://www.arm.linux.org.uk/developer/machines/). |
| 752 | Only boards that have multiple machine types supported |
| 753 | in a single configuration file and the machine type is |
| 754 | runtime discoverable, do not have to use this setting. |
| 755 | |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 756 | - vxWorks boot parameters: |
| 757 | |
| 758 | bootvx constructs a valid bootline using the following |
Bin Meng | 9e98b7e | 2015-10-07 20:19:17 -0700 | [diff] [blame] | 759 | environments variables: bootdev, bootfile, ipaddr, netmask, |
| 760 | serverip, gatewayip, hostname, othbootargs. |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 761 | It loads the vxWorks image pointed bootfile. |
| 762 | |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 763 | Note: If a "bootargs" environment is defined, it will overwride |
| 764 | the defaults discussed just above. |
| 765 | |
Aneesh V | 2c451f7 | 2011-06-16 23:30:47 +0000 | [diff] [blame] | 766 | - Cache Configuration: |
| 767 | CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot |
| 768 | CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot |
| 769 | CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot |
| 770 | |
Aneesh V | 93bc219 | 2011-06-16 23:30:51 +0000 | [diff] [blame] | 771 | - Cache Configuration for ARM: |
| 772 | CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache |
| 773 | controller |
| 774 | CONFIG_SYS_PL310_BASE - Physical base address of PL310 |
| 775 | controller register space |
| 776 | |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 777 | - Serial Ports: |
Andreas Engel | 48d0192 | 2008-09-08 14:30:53 +0200 | [diff] [blame] | 778 | CONFIG_PL010_SERIAL |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 779 | |
| 780 | Define this if you want support for Amba PrimeCell PL010 UARTs. |
| 781 | |
Andreas Engel | 48d0192 | 2008-09-08 14:30:53 +0200 | [diff] [blame] | 782 | CONFIG_PL011_SERIAL |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 783 | |
| 784 | Define this if you want support for Amba PrimeCell PL011 UARTs. |
| 785 | |
| 786 | CONFIG_PL011_CLOCK |
| 787 | |
| 788 | If you have Amba PrimeCell PL011 UARTs, set this variable to |
| 789 | the clock speed of the UARTs. |
| 790 | |
| 791 | CONFIG_PL01x_PORTS |
| 792 | |
| 793 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, |
| 794 | define this to a list of base addresses for each (supported) |
| 795 | port. See e.g. include/configs/versatile.h |
| 796 | |
Karicheri, Muralidharan | d57dee5 | 2014-04-09 15:38:46 -0400 | [diff] [blame] | 797 | CONFIG_SERIAL_HW_FLOW_CONTROL |
| 798 | |
| 799 | Define this variable to enable hw flow control in serial driver. |
| 800 | Current user of this option is drivers/serial/nsl16550.c driver |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 801 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 802 | - Console Interface: |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 803 | Depending on board, define exactly one serial port |
| 804 | (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, |
| 805 | CONFIG_8xx_CONS_SCC1, ...), or switch off the serial |
| 806 | console by defining CONFIG_8xx_CONS_NONE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 807 | |
| 808 | Note: if CONFIG_8xx_CONS_NONE is defined, the serial |
| 809 | port routines must be defined elsewhere |
| 810 | (i.e. serial_init(), serial_getc(), ...) |
| 811 | |
| 812 | CONFIG_CFB_CONSOLE |
| 813 | Enables console device for a color framebuffer. Needs following |
Wolfgang Denk | c53043b | 2011-12-07 12:19:20 +0000 | [diff] [blame] | 814 | defines (cf. smiLynxEM, i8042) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 815 | VIDEO_FB_LITTLE_ENDIAN graphic memory organisation |
| 816 | (default big endian) |
| 817 | VIDEO_HW_RECTFILL graphic chip supports |
| 818 | rectangle fill |
| 819 | (cf. smiLynxEM) |
| 820 | VIDEO_HW_BITBLT graphic chip supports |
| 821 | bit-blit (cf. smiLynxEM) |
| 822 | VIDEO_VISIBLE_COLS visible pixel columns |
| 823 | (cols=pitch) |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 824 | VIDEO_VISIBLE_ROWS visible pixel rows |
| 825 | VIDEO_PIXEL_SIZE bytes per pixel |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 826 | VIDEO_DATA_FORMAT graphic data format |
| 827 | (0-5, cf. cfb_console.c) |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 828 | VIDEO_FB_ADRS framebuffer address |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 829 | VIDEO_KBD_INIT_FCT keyboard int fct |
Simon Glass | 39f615e | 2015-11-11 10:05:47 -0700 | [diff] [blame] | 830 | (i.e. rx51_kp_init()) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 831 | VIDEO_TSTC_FCT test char fct |
Simon Glass | 39f615e | 2015-11-11 10:05:47 -0700 | [diff] [blame] | 832 | (i.e. rx51_kp_tstc) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 833 | VIDEO_GETC_FCT get char fct |
Simon Glass | 39f615e | 2015-11-11 10:05:47 -0700 | [diff] [blame] | 834 | (i.e. rx51_kp_getc) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 835 | CONFIG_VIDEO_LOGO display Linux logo in |
| 836 | upper left corner |
wdenk | a6c7ad2 | 2002-12-03 21:28:10 +0000 | [diff] [blame] | 837 | CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of |
| 838 | linux_logo.h for logo. |
| 839 | Requires CONFIG_VIDEO_LOGO |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 840 | CONFIG_CONSOLE_EXTRA_INFO |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 841 | additional board info beside |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 842 | the logo |
| 843 | |
Pali Rohár | 33a35bb | 2012-10-19 13:30:09 +0000 | [diff] [blame] | 844 | When CONFIG_CFB_CONSOLE_ANSI is defined, console will support |
| 845 | a limited number of ANSI escape sequences (cursor control, |
| 846 | erase functions and limited graphics rendition control). |
| 847 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 848 | When CONFIG_CFB_CONSOLE is defined, video console is |
| 849 | default i/o. Serial console can be forced with |
| 850 | environment 'console=serial'. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 851 | |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 852 | When CONFIG_SILENT_CONSOLE is defined, all console |
| 853 | messages (by U-Boot and Linux!) can be silenced with |
| 854 | the "silent" environment variable. See |
| 855 | doc/README.silent for more information. |
wdenk | a3ad8e2 | 2003-10-19 23:22:11 +0000 | [diff] [blame] | 856 | |
Heiko Schocher | 45ae254 | 2013-10-22 11:06:06 +0200 | [diff] [blame] | 857 | CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default |
| 858 | is 0x00. |
| 859 | CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default |
| 860 | is 0xa0. |
| 861 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 862 | - Console Baudrate: |
| 863 | CONFIG_BAUDRATE - in bps |
| 864 | Select one of the baudrates listed in |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 865 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
| 866 | CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 867 | |
Heiko Schocher | c92fac9 | 2009-01-30 12:55:38 +0100 | [diff] [blame] | 868 | - Console Rx buffer length |
| 869 | With CONFIG_SYS_SMC_RXBUFLEN it is possible to define |
| 870 | the maximum receive buffer length for the SMC. |
Heiko Schocher | 2b3f12c | 2009-02-10 09:31:47 +0100 | [diff] [blame] | 871 | This option is actual only for 82xx and 8xx possible. |
Heiko Schocher | c92fac9 | 2009-01-30 12:55:38 +0100 | [diff] [blame] | 872 | If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE |
| 873 | must be defined, to setup the maximum idle timeout for |
| 874 | the SMC. |
| 875 | |
Graeme Russ | 9558b48 | 2011-09-01 00:48:27 +0000 | [diff] [blame] | 876 | - Pre-Console Buffer: |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 877 | Prior to the console being initialised (i.e. serial UART |
| 878 | initialised etc) all console output is silently discarded. |
| 879 | Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to |
| 880 | buffer any console messages prior to the console being |
| 881 | initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ |
| 882 | bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is |
| 883 | a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ |
Wolfgang Denk | 6feff89 | 2011-10-09 21:06:34 +0200 | [diff] [blame] | 884 | bytes are output before the console is initialised, the |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 885 | earlier bytes are discarded. |
Graeme Russ | 9558b48 | 2011-09-01 00:48:27 +0000 | [diff] [blame] | 886 | |
Hans de Goede | a8552c7 | 2015-05-05 13:13:36 +0200 | [diff] [blame] | 887 | Note that when printing the buffer a copy is made on the |
| 888 | stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack. |
| 889 | |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 890 | 'Sane' compilers will generate smaller code if |
| 891 | CONFIG_PRE_CON_BUF_SZ is a power of 2 |
Graeme Russ | 9558b48 | 2011-09-01 00:48:27 +0000 | [diff] [blame] | 892 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 893 | - Boot Delay: CONFIG_BOOTDELAY - in seconds |
| 894 | Delay before automatically booting the default image; |
| 895 | set to -1 to disable autoboot. |
Joe Hershberger | 93d7212 | 2012-08-17 10:53:12 +0000 | [diff] [blame] | 896 | set to -2 to autoboot with no delay and not check for abort |
| 897 | (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 898 | |
| 899 | See doc/README.autoboot for these options that |
| 900 | work with CONFIG_BOOTDELAY. None are required. |
| 901 | CONFIG_BOOT_RETRY_TIME |
| 902 | CONFIG_BOOT_RETRY_MIN |
| 903 | CONFIG_AUTOBOOT_KEYED |
| 904 | CONFIG_AUTOBOOT_PROMPT |
| 905 | CONFIG_AUTOBOOT_DELAY_STR |
| 906 | CONFIG_AUTOBOOT_STOP_STR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 907 | CONFIG_ZERO_BOOTDELAY_CHECK |
| 908 | CONFIG_RESET_TO_RETRY |
| 909 | |
| 910 | - Autoboot Command: |
| 911 | CONFIG_BOOTCOMMAND |
| 912 | Only needed when CONFIG_BOOTDELAY is enabled; |
| 913 | define a command string that is automatically executed |
| 914 | when no character is read on the console interface |
| 915 | within "Boot Delay" after reset. |
| 916 | |
| 917 | CONFIG_BOOTARGS |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 918 | This can be used to pass arguments to the bootm |
| 919 | command. The value of CONFIG_BOOTARGS goes into the |
| 920 | environment value "bootargs". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 921 | |
| 922 | CONFIG_RAMBOOT and CONFIG_NFSBOOT |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 923 | The value of these goes into the environment as |
| 924 | "ramboot" and "nfsboot" respectively, and can be used |
| 925 | as a convenience, when switching between booting from |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 926 | RAM and NFS. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 927 | |
Heiko Schocher | eda0ba3 | 2013-11-04 14:04:59 +0100 | [diff] [blame] | 928 | - Bootcount: |
| 929 | CONFIG_BOOTCOUNT_LIMIT |
| 930 | Implements a mechanism for detecting a repeating reboot |
| 931 | cycle, see: |
| 932 | http://www.denx.de/wiki/view/DULG/UBootBootCountLimit |
| 933 | |
| 934 | CONFIG_BOOTCOUNT_ENV |
| 935 | If no softreset save registers are found on the hardware |
| 936 | "bootcount" is stored in the environment. To prevent a |
| 937 | saveenv on all reboots, the environment variable |
| 938 | "upgrade_available" is used. If "upgrade_available" is |
| 939 | 0, "bootcount" is always 0, if "upgrade_available" is |
| 940 | 1 "bootcount" is incremented in the environment. |
| 941 | So the Userspace Applikation must set the "upgrade_available" |
| 942 | and "bootcount" variable to 0, if a boot was successfully. |
| 943 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 944 | - Pre-Boot Commands: |
| 945 | CONFIG_PREBOOT |
| 946 | |
| 947 | When this option is #defined, the existence of the |
| 948 | environment variable "preboot" will be checked |
| 949 | immediately before starting the CONFIG_BOOTDELAY |
| 950 | countdown and/or running the auto-boot command resp. |
| 951 | entering interactive mode. |
| 952 | |
| 953 | This feature is especially useful when "preboot" is |
| 954 | automatically generated or modified. For an example |
| 955 | see the LWMON board specific code: here "preboot" is |
| 956 | modified when the user holds down a certain |
| 957 | combination of keys on the (special) keyboard when |
| 958 | booting the systems |
| 959 | |
| 960 | - Serial Download Echo Mode: |
| 961 | CONFIG_LOADS_ECHO |
| 962 | If defined to 1, all characters received during a |
| 963 | serial download (using the "loads" command) are |
| 964 | echoed back. This might be needed by some terminal |
| 965 | emulations (like "cu"), but may as well just take |
| 966 | time on others. This setting #define's the initial |
| 967 | value of the "loads_echo" environment variable. |
| 968 | |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 969 | - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 970 | CONFIG_KGDB_BAUDRATE |
| 971 | Select one of the baudrates listed in |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 972 | CONFIG_SYS_BAUDRATE_TABLE, see below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 973 | |
| 974 | - Monitor Functions: |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 975 | Monitor commands can be included or excluded |
| 976 | from the build by using the #include files |
Stephen Warren | c6c621b | 2012-08-05 16:07:19 +0000 | [diff] [blame] | 977 | <config_cmd_all.h> and #undef'ing unwanted |
Joe Hershberger | ef0f2f5 | 2015-06-22 16:15:30 -0500 | [diff] [blame] | 978 | commands, or adding #define's for wanted commands. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 979 | |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 980 | The default command configuration includes all commands |
| 981 | except those marked below with a "*". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 982 | |
Marek Vasut | b401b73 | 2014-03-05 19:58:39 +0100 | [diff] [blame] | 983 | CONFIG_CMD_AES AES 128 CBC encrypt/decrypt |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 984 | CONFIG_CMD_ASKENV * ask for env variable |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 985 | CONFIG_CMD_BDI bdinfo |
| 986 | CONFIG_CMD_BEDBUG * Include BedBug Debugger |
| 987 | CONFIG_CMD_BMP * BMP support |
| 988 | CONFIG_CMD_BSP * Board specific commands |
| 989 | CONFIG_CMD_BOOTD bootd |
Tom Rini | d2b2ffe | 2014-08-14 06:42:36 -0400 | [diff] [blame] | 990 | CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 991 | CONFIG_CMD_CACHE * icache, dcache |
Michal Simek | 08d0d6f | 2013-11-21 13:39:02 -0800 | [diff] [blame] | 992 | CONFIG_CMD_CLK * clock command support |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 993 | CONFIG_CMD_CONSOLE coninfo |
Mike Frysinger | 710b993 | 2010-12-21 14:19:51 -0500 | [diff] [blame] | 994 | CONFIG_CMD_CRC32 * crc32 |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 995 | CONFIG_CMD_DATE * support for RTC, date/time... |
| 996 | CONFIG_CMD_DHCP * DHCP support |
| 997 | CONFIG_CMD_DIAG * Diagnostics |
Peter Tyser | a7c9310 | 2008-12-17 16:36:22 -0600 | [diff] [blame] | 998 | CONFIG_CMD_DS4510 * ds4510 I2C gpio commands |
| 999 | CONFIG_CMD_DS4510_INFO * ds4510 I2C info command |
| 1000 | CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd |
| 1001 | CONFIG_CMD_DS4510_RST * ds4510 I2C rst command |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1002 | CONFIG_CMD_DTT * Digital Therm and Thermostat |
| 1003 | CONFIG_CMD_ECHO echo arguments |
Peter Tyser | 246c692 | 2009-10-25 15:12:56 -0500 | [diff] [blame] | 1004 | CONFIG_CMD_EDITENV edit env variable |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1005 | CONFIG_CMD_EEPROM * EEPROM read/write support |
| 1006 | CONFIG_CMD_ELF * bootelf, bootvx |
Joe Hershberger | 5e2b3e0 | 2012-12-11 22:16:25 -0600 | [diff] [blame] | 1007 | CONFIG_CMD_ENV_CALLBACK * display details about env callbacks |
Joe Hershberger | fffad71 | 2012-12-11 22:16:33 -0600 | [diff] [blame] | 1008 | CONFIG_CMD_ENV_FLAGS * display details about env flags |
Andrew Ruder | 88733e2 | 2013-10-22 19:07:34 -0500 | [diff] [blame] | 1009 | CONFIG_CMD_ENV_EXISTS * check existence of env variable |
Mike Frysinger | 0c79cda | 2010-12-26 23:09:45 -0500 | [diff] [blame] | 1010 | CONFIG_CMD_EXPORTENV * export the environment |
Stephen Warren | 03e2ecf | 2012-10-22 06:43:50 +0000 | [diff] [blame] | 1011 | CONFIG_CMD_EXT2 * ext2 command support |
| 1012 | CONFIG_CMD_EXT4 * ext4 command support |
Stephen Warren | 16f4d93 | 2014-01-24 20:46:37 -0700 | [diff] [blame] | 1013 | CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) |
| 1014 | that work for multiple fs types |
Christian Gmeiner | 59e890e | 2014-11-12 14:35:04 +0100 | [diff] [blame] | 1015 | CONFIG_CMD_FS_UUID * Look up a filesystem UUID |
Mike Frysinger | bdab39d | 2009-01-28 19:08:14 -0500 | [diff] [blame] | 1016 | CONFIG_CMD_SAVEENV saveenv |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1017 | CONFIG_CMD_FDC * Floppy Disk Support |
Stephen Warren | 03e2ecf | 2012-10-22 06:43:50 +0000 | [diff] [blame] | 1018 | CONFIG_CMD_FAT * FAT command support |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1019 | CONFIG_CMD_FLASH flinfo, erase, protect |
| 1020 | CONFIG_CMD_FPGA FPGA device initialization support |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1021 | CONFIG_CMD_FUSE * Device fuse support |
Anton Staaf | 53fdc7e | 2012-12-05 14:46:29 +0000 | [diff] [blame] | 1022 | CONFIG_CMD_GETTIME * Get time since boot |
Mike Frysinger | a641b97 | 2010-12-26 23:32:22 -0500 | [diff] [blame] | 1023 | CONFIG_CMD_GO * the 'go' command (exec code) |
Kim Phillips | a000b79 | 2011-04-05 07:15:14 +0000 | [diff] [blame] | 1024 | CONFIG_CMD_GREPENV * search environment |
Simon Glass | bf36c5d | 2012-12-05 14:46:38 +0000 | [diff] [blame] | 1025 | CONFIG_CMD_HASH * calculate hash / digest |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1026 | CONFIG_CMD_I2C * I2C serial bus support |
| 1027 | CONFIG_CMD_IDE * IDE harddisk support |
| 1028 | CONFIG_CMD_IMI iminfo |
Vipin Kumar | 8fdf1e0 | 2012-12-16 22:32:48 +0000 | [diff] [blame] | 1029 | CONFIG_CMD_IMLS List all images found in NOR flash |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1030 | CONFIG_CMD_IMLS_NAND * List all images found in NAND flash |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1031 | CONFIG_CMD_IMMAP * IMMR dump support |
Simon Glass | aa53233 | 2014-06-11 23:29:41 -0600 | [diff] [blame] | 1032 | CONFIG_CMD_IOTRACE * I/O tracing for debugging |
Mike Frysinger | 0c79cda | 2010-12-26 23:09:45 -0500 | [diff] [blame] | 1033 | CONFIG_CMD_IMPORTENV * import an environment |
Joe Hershberger | c167cc0 | 2012-10-03 11:15:51 +0000 | [diff] [blame] | 1034 | CONFIG_CMD_INI * import data from an ini file into the env |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1035 | CONFIG_CMD_IRQ * irqinfo |
| 1036 | CONFIG_CMD_ITEST Integer/string test of 2 values |
| 1037 | CONFIG_CMD_JFFS2 * JFFS2 Support |
| 1038 | CONFIG_CMD_KGDB * kgdb |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1039 | CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) |
Joe Hershberger | d22c338 | 2012-05-23 08:00:12 +0000 | [diff] [blame] | 1040 | CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration |
| 1041 | (169.254.*.*) |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1042 | CONFIG_CMD_LOADB loadb |
| 1043 | CONFIG_CMD_LOADS loads |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1044 | CONFIG_CMD_MD5SUM * print md5 message digest |
Robin Getz | 02c9aa1 | 2009-07-27 00:07:59 -0400 | [diff] [blame] | 1045 | (requires CONFIG_CMD_MEMORY and CONFIG_MD5) |
Simon Glass | 15a33e4 | 2012-11-30 13:01:20 +0000 | [diff] [blame] | 1046 | CONFIG_CMD_MEMINFO * Display detailed memory information |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1047 | CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, |
Wolfgang Denk | a268170 | 2013-03-08 10:51:32 +0000 | [diff] [blame] | 1048 | loop, loopw |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1049 | CONFIG_CMD_MEMTEST * mtest |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1050 | CONFIG_CMD_MISC Misc functions like sleep etc |
| 1051 | CONFIG_CMD_MMC * MMC memory mapped support |
| 1052 | CONFIG_CMD_MII * MII utility commands |
Stefan Roese | 68d7d65 | 2009-03-19 13:30:36 +0100 | [diff] [blame] | 1053 | CONFIG_CMD_MTDPARTS * MTD partition support |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1054 | CONFIG_CMD_NAND * NAND support |
| 1055 | CONFIG_CMD_NET bootp, tftpboot, rarpboot |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1056 | CONFIG_CMD_NFS NFS support |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 1057 | CONFIG_CMD_PCA953X * PCA953x I2C gpio commands |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1058 | CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1059 | CONFIG_CMD_PCI * pciinfo |
| 1060 | CONFIG_CMD_PCMCIA * PCMCIA support |
| 1061 | CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network |
| 1062 | host |
| 1063 | CONFIG_CMD_PORTIO * Port I/O |
Kenneth Waters | ff048ea | 2012-12-05 14:46:30 +0000 | [diff] [blame] | 1064 | CONFIG_CMD_READ * Read raw data from partition |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1065 | CONFIG_CMD_REGINFO * Register dump |
| 1066 | CONFIG_CMD_RUN run command in env variable |
Simon Glass | d304931 | 2012-12-26 09:53:36 +0000 | [diff] [blame] | 1067 | CONFIG_CMD_SANDBOX * sb command to access sandbox features |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1068 | CONFIG_CMD_SAVES * save S record dump |
| 1069 | CONFIG_CMD_SCSI * SCSI Support |
| 1070 | CONFIG_CMD_SDRAM * print SDRAM configuration information |
| 1071 | (requires CONFIG_CMD_I2C) |
| 1072 | CONFIG_CMD_SETGETDCR Support for DCR Register access |
| 1073 | (4xx only) |
Eric Nelson | f61ec45 | 2012-01-31 10:52:08 -0700 | [diff] [blame] | 1074 | CONFIG_CMD_SF * Read/write/erase SPI NOR flash |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1075 | CONFIG_CMD_SHA1SUM * print sha1 memory digest |
Robin Getz | 02c9aa1 | 2009-07-27 00:07:59 -0400 | [diff] [blame] | 1076 | (requires CONFIG_CMD_MEMORY) |
Bob Liu | 7d861d9 | 2013-02-05 19:05:41 +0800 | [diff] [blame] | 1077 | CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x |
Wolfgang Denk | 74de7ae | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 1078 | CONFIG_CMD_SOURCE "source" command Support |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1079 | CONFIG_CMD_SPI * SPI serial bus support |
Luca Ceresoli | 7a83af0 | 2011-05-17 00:03:40 +0000 | [diff] [blame] | 1080 | CONFIG_CMD_TFTPSRV * TFTP transfer in server mode |
Simon Glass | 1fb7cd4 | 2011-10-24 18:00:07 +0000 | [diff] [blame] | 1081 | CONFIG_CMD_TFTPPUT * TFTP put command (upload) |
Joe Hershberger | da83bcd | 2012-10-03 12:14:57 +0000 | [diff] [blame] | 1082 | CONFIG_CMD_TIME * run command and report execution time (ARM specific) |
| 1083 | CONFIG_CMD_TIMER * access to the system tick timer |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1084 | CONFIG_CMD_USB * USB support |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1085 | CONFIG_CMD_CDP * Cisco Discover Protocol support |
Marek Vasut | c8339f5 | 2012-03-31 07:47:16 +0000 | [diff] [blame] | 1086 | CONFIG_CMD_MFSL * Microblaze FSL support |
Vincent Stehlé | 4d98b5c | 2013-06-20 18:14:22 +0200 | [diff] [blame] | 1087 | CONFIG_CMD_XIMG Load part of Multi Image |
Przemyslaw Marczak | 89c8230 | 2014-04-02 10:20:05 +0200 | [diff] [blame] | 1088 | CONFIG_CMD_UUID * Generate random UUID or GUID string |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1089 | |
| 1090 | EXAMPLE: If you want all functions except of network |
| 1091 | support you can write: |
| 1092 | |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1093 | #include "config_cmd_all.h" |
| 1094 | #undef CONFIG_CMD_NET |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1095 | |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 1096 | Other Commands: |
| 1097 | fdt (flattened device tree) command: CONFIG_OF_LIBFDT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1098 | |
| 1099 | Note: Don't enable the "icache" and "dcache" commands |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1100 | (configuration option CONFIG_CMD_CACHE) unless you know |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1101 | what you (and your U-Boot users) are doing. Data |
| 1102 | cache cannot be enabled on systems like the 8xx or |
| 1103 | 8260 (where accesses to the IMMR region must be |
| 1104 | uncached), and it cannot be disabled on all other |
| 1105 | systems where we (mis-) use the data cache to hold an |
| 1106 | initial stack and some data. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1107 | |
| 1108 | |
| 1109 | XXX - this list needs to get updated! |
| 1110 | |
Wolfgang Denk | a5ecbe6 | 2013-03-23 23:50:31 +0000 | [diff] [blame] | 1111 | - Regular expression support: |
| 1112 | CONFIG_REGEX |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 1113 | If this variable is defined, U-Boot is linked against |
| 1114 | the SLRE (Super Light Regular Expression) library, |
| 1115 | which adds regex support to some commands, as for |
| 1116 | example "env grep" and "setexpr". |
Wolfgang Denk | a5ecbe6 | 2013-03-23 23:50:31 +0000 | [diff] [blame] | 1117 | |
Simon Glass | 45ba807 | 2011-10-15 05:48:20 +0000 | [diff] [blame] | 1118 | - Device tree: |
| 1119 | CONFIG_OF_CONTROL |
| 1120 | If this variable is defined, U-Boot will use a device tree |
| 1121 | to configure its devices, instead of relying on statically |
| 1122 | compiled #defines in the board file. This option is |
| 1123 | experimental and only available on a few boards. The device |
| 1124 | tree is available in the global data as gd->fdt_blob. |
| 1125 | |
Simon Glass | 2c0f79e | 2011-10-24 19:15:31 +0000 | [diff] [blame] | 1126 | U-Boot needs to get its device tree from somewhere. This can |
| 1127 | be done using one of the two options below: |
Simon Glass | bbb0b12 | 2011-10-15 05:48:21 +0000 | [diff] [blame] | 1128 | |
| 1129 | CONFIG_OF_EMBED |
| 1130 | If this variable is defined, U-Boot will embed a device tree |
| 1131 | binary in its image. This device tree file should be in the |
| 1132 | board directory and called <soc>-<board>.dts. The binary file |
| 1133 | is then picked up in board_init_f() and made available through |
| 1134 | the global data structure as gd->blob. |
Simon Glass | 45ba807 | 2011-10-15 05:48:20 +0000 | [diff] [blame] | 1135 | |
Simon Glass | 2c0f79e | 2011-10-24 19:15:31 +0000 | [diff] [blame] | 1136 | CONFIG_OF_SEPARATE |
| 1137 | If this variable is defined, U-Boot will build a device tree |
| 1138 | binary. It will be called u-boot.dtb. Architecture-specific |
| 1139 | code will locate it at run-time. Generally this works by: |
| 1140 | |
| 1141 | cat u-boot.bin u-boot.dtb >image.bin |
| 1142 | |
| 1143 | and in fact, U-Boot does this for you, creating a file called |
| 1144 | u-boot-dtb.bin which is useful in the common case. You can |
| 1145 | still use the individual files if you need something more |
| 1146 | exotic. |
| 1147 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1148 | - Watchdog: |
| 1149 | CONFIG_WATCHDOG |
| 1150 | If this variable is defined, it enables watchdog |
Detlev Zundel | 6abe6fb | 2011-04-27 05:25:59 +0000 | [diff] [blame] | 1151 | support for the SoC. There must be support in the SoC |
| 1152 | specific code for a watchdog. For the 8xx and 8260 |
| 1153 | CPUs, the SIU Watchdog feature is enabled in the SYPCR |
| 1154 | register. When supported for a specific SoC is |
| 1155 | available, then no further board specific code should |
| 1156 | be needed to use it. |
| 1157 | |
| 1158 | CONFIG_HW_WATCHDOG |
| 1159 | When using a watchdog circuitry external to the used |
| 1160 | SoC, then define this variable and provide board |
| 1161 | specific code for the "hw_watchdog_reset" function. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1162 | |
Heiko Schocher | 7bae0d6 | 2015-01-21 08:38:22 +0100 | [diff] [blame] | 1163 | CONFIG_AT91_HW_WDT_TIMEOUT |
| 1164 | specify the timeout in seconds. default 2 seconds. |
| 1165 | |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 1166 | - U-Boot Version: |
| 1167 | CONFIG_VERSION_VARIABLE |
| 1168 | If this variable is defined, an environment variable |
| 1169 | named "ver" is created by U-Boot showing the U-Boot |
| 1170 | version as printed by the "version" command. |
Benoît Thébaudeau | a1ea8e5 | 2012-08-13 15:01:14 +0200 | [diff] [blame] | 1171 | Any change to this variable will be reverted at the |
| 1172 | next reset. |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 1173 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1174 | - Real-Time Clock: |
| 1175 | |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1176 | When CONFIG_CMD_DATE is selected, the type of the RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1177 | has to be selected, too. Define exactly one of the |
| 1178 | following options: |
| 1179 | |
| 1180 | CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx |
| 1181 | CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC |
Fabio Estevam | 4e8b754 | 2011-10-24 06:44:15 +0000 | [diff] [blame] | 1182 | CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1183 | CONFIG_RTC_MC146818 - use MC146818 RTC |
wdenk | 1cb8e98 | 2003-03-06 21:55:29 +0000 | [diff] [blame] | 1184 | CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1185 | CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC |
wdenk | 7f70e85 | 2003-05-20 14:25:27 +0000 | [diff] [blame] | 1186 | CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC |
Markus Niebel | 412921d | 2014-07-21 11:06:16 +0200 | [diff] [blame] | 1187 | CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC |
wdenk | 3bac351 | 2003-03-12 10:41:04 +0000 | [diff] [blame] | 1188 | CONFIG_RTC_DS164x - use Dallas DS164x RTC |
Tor Krill | 9536dfc | 2008-03-15 15:40:26 +0100 | [diff] [blame] | 1189 | CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC |
wdenk | 4c0d4c3 | 2004-06-09 17:34:58 +0000 | [diff] [blame] | 1190 | CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1191 | CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 |
Heiko Schocher | 71d19f3 | 2011-03-28 09:24:22 +0200 | [diff] [blame] | 1192 | CONFIG_SYS_RV3029_TCR - enable trickle charger on |
| 1193 | RV3029 RTC. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1194 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 1195 | Note that if the RTC uses I2C, then the I2C interface |
| 1196 | must also be configured. See I2C Support, below. |
| 1197 | |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 1198 | - GPIO Support: |
| 1199 | CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 1200 | |
Chris Packham | 5dec49c | 2010-12-19 10:12:13 +0000 | [diff] [blame] | 1201 | The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of |
| 1202 | chip-ngpio pairs that tell the PCA953X driver the number of |
| 1203 | pins supported by a particular chip. |
| 1204 | |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 1205 | Note that if the GPIO device uses I2C, then the I2C interface |
| 1206 | must also be configured. See I2C Support, below. |
| 1207 | |
Simon Glass | aa53233 | 2014-06-11 23:29:41 -0600 | [diff] [blame] | 1208 | - I/O tracing: |
| 1209 | When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O |
| 1210 | accesses and can checksum them or write a list of them out |
| 1211 | to memory. See the 'iotrace' command for details. This is |
| 1212 | useful for testing device drivers since it can confirm that |
| 1213 | the driver behaves the same way before and after a code |
| 1214 | change. Currently this is supported on sandbox and arm. To |
| 1215 | add support for your architecture, add '#include <iotrace.h>' |
| 1216 | to the bottom of arch/<arch>/include/asm/io.h and test. |
| 1217 | |
| 1218 | Example output from the 'iotrace stats' command is below. |
| 1219 | Note that if the trace buffer is exhausted, the checksum will |
| 1220 | still continue to operate. |
| 1221 | |
| 1222 | iotrace is enabled |
| 1223 | Start: 10000000 (buffer start address) |
| 1224 | Size: 00010000 (buffer size) |
| 1225 | Offset: 00000120 (current buffer offset) |
| 1226 | Output: 10000120 (start + offset) |
| 1227 | Count: 00000018 (number of trace records) |
| 1228 | CRC32: 9526fb66 (CRC32 of all trace records) |
| 1229 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1230 | - Timestamp Support: |
| 1231 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1232 | When CONFIG_TIMESTAMP is selected, the timestamp |
| 1233 | (date and time) of an image is printed by image |
| 1234 | commands like bootm or iminfo. This option is |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1235 | automatically enabled when you select CONFIG_CMD_DATE . |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1236 | |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 1237 | - Partition Labels (disklabels) Supported: |
| 1238 | Zero or more of the following: |
| 1239 | CONFIG_MAC_PARTITION Apple's MacOS partition table. |
| 1240 | CONFIG_DOS_PARTITION MS Dos partition table, traditional on the |
| 1241 | Intel architecture, USB sticks, etc. |
| 1242 | CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. |
| 1243 | CONFIG_EFI_PARTITION GPT partition table, common when EFI is the |
| 1244 | bootloader. Note 2TB partition limit; see |
| 1245 | disk/part_efi.c |
| 1246 | CONFIG_MTD_PARTITIONS Memory Technology Device partition table. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1247 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1248 | If IDE or SCSI support is enabled (CONFIG_CMD_IDE or |
| 1249 | CONFIG_CMD_SCSI) you must configure support for at |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 1250 | least one non-MTD partition type as well. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1251 | |
| 1252 | - IDE Reset method: |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1253 | CONFIG_IDE_RESET_ROUTINE - this is defined in several |
| 1254 | board configurations files but used nowhere! |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1255 | |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1256 | CONFIG_IDE_RESET - is this is defined, IDE Reset will |
| 1257 | be performed by calling the function |
| 1258 | ide_set_reset(int reset) |
| 1259 | which has to be defined in a board specific file |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1260 | |
| 1261 | - ATAPI Support: |
| 1262 | CONFIG_ATAPI |
| 1263 | |
| 1264 | Set this to enable ATAPI support. |
| 1265 | |
wdenk | c40b295 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 1266 | - LBA48 Support |
| 1267 | CONFIG_LBA48 |
| 1268 | |
| 1269 | Set this to enable support for disks larger than 137GB |
Heiko Schocher | 4b142fe | 2009-12-03 11:21:21 +0100 | [diff] [blame] | 1270 | Also look at CONFIG_SYS_64BIT_LBA. |
wdenk | c40b295 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 1271 | Whithout these , LBA48 support uses 32bit variables and will 'only' |
| 1272 | support disks up to 2.1TB. |
| 1273 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1274 | CONFIG_SYS_64BIT_LBA: |
wdenk | c40b295 | 2004-03-13 23:29:43 +0000 | [diff] [blame] | 1275 | When enabled, makes the IDE subsystem use 64bit sector addresses. |
| 1276 | Default is 32bit. |
| 1277 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1278 | - SCSI Support: |
| 1279 | At the moment only there is only support for the |
| 1280 | SYM53C8XX SCSI controller; define |
| 1281 | CONFIG_SCSI_SYM53C8XX to enable it. |
| 1282 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1283 | CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and |
| 1284 | CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * |
| 1285 | CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1286 | maximum numbers of LUNs, SCSI ID's and target |
| 1287 | devices. |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1288 | CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1289 | |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 1290 | The environment variable 'scsidevs' is set to the number of |
| 1291 | SCSI devices found during the last scan. |
Stefan Reinauer | 447c031 | 2012-10-29 05:23:48 +0000 | [diff] [blame] | 1292 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1293 | - NETWORK Support (PCI): |
wdenk | 682011f | 2003-06-03 23:54:09 +0000 | [diff] [blame] | 1294 | CONFIG_E1000 |
Kyle Moffett | ce5207e | 2011-10-18 11:05:29 +0000 | [diff] [blame] | 1295 | Support for Intel 8254x/8257x gigabit chips. |
| 1296 | |
| 1297 | CONFIG_E1000_SPI |
| 1298 | Utility code for direct access to the SPI bus on Intel 8257x. |
| 1299 | This does not do anything useful unless you set at least one |
| 1300 | of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. |
| 1301 | |
| 1302 | CONFIG_E1000_SPI_GENERIC |
| 1303 | Allow generic access to the SPI bus on the Intel 8257x, for |
| 1304 | example with the "sspi" command. |
| 1305 | |
| 1306 | CONFIG_CMD_E1000 |
| 1307 | Management command for E1000 devices. When used on devices |
| 1308 | with SPI support you can reprogram the EEPROM from U-Boot. |
stroese | 53cf943 | 2003-06-05 15:39:44 +0000 | [diff] [blame] | 1309 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1310 | CONFIG_EEPRO100 |
| 1311 | Support for Intel 82557/82559/82559ER chips. |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1312 | Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1313 | write routine for first time initialisation. |
| 1314 | |
| 1315 | CONFIG_TULIP |
| 1316 | Support for Digital 2114x chips. |
| 1317 | Optional CONFIG_TULIP_SELECT_MEDIA for board specific |
| 1318 | modem chip initialisation (KS8761/QS6611). |
| 1319 | |
| 1320 | CONFIG_NATSEMI |
| 1321 | Support for National dp83815 chips. |
| 1322 | |
| 1323 | CONFIG_NS8382X |
| 1324 | Support for National dp8382[01] gigabit chips. |
| 1325 | |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 1326 | - NETWORK Support (other): |
| 1327 | |
Jens Scharsig | c041e9d | 2010-01-23 12:03:45 +0100 | [diff] [blame] | 1328 | CONFIG_DRIVER_AT91EMAC |
| 1329 | Support for AT91RM9200 EMAC. |
| 1330 | |
| 1331 | CONFIG_RMII |
| 1332 | Define this to use reduced MII inteface |
| 1333 | |
| 1334 | CONFIG_DRIVER_AT91EMAC_QUIET |
| 1335 | If this defined, the driver is quiet. |
| 1336 | The driver doen't show link status messages. |
| 1337 | |
Rob Herring | efdd731 | 2011-12-15 11:15:49 +0000 | [diff] [blame] | 1338 | CONFIG_CALXEDA_XGMAC |
| 1339 | Support for the Calxeda XGMAC device |
| 1340 | |
Ashok | 3bb46d2 | 2012-10-15 06:20:47 +0000 | [diff] [blame] | 1341 | CONFIG_LAN91C96 |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 1342 | Support for SMSC's LAN91C96 chips. |
| 1343 | |
| 1344 | CONFIG_LAN91C96_BASE |
| 1345 | Define this to hold the physical address |
| 1346 | of the LAN91C96's I/O space |
| 1347 | |
| 1348 | CONFIG_LAN91C96_USE_32_BIT |
| 1349 | Define this to enable 32 bit addressing |
| 1350 | |
Ashok | 3bb46d2 | 2012-10-15 06:20:47 +0000 | [diff] [blame] | 1351 | CONFIG_SMC91111 |
wdenk | f39748a | 2004-06-09 13:37:52 +0000 | [diff] [blame] | 1352 | Support for SMSC's LAN91C111 chip |
| 1353 | |
| 1354 | CONFIG_SMC91111_BASE |
| 1355 | Define this to hold the physical address |
| 1356 | of the device (I/O space) |
| 1357 | |
| 1358 | CONFIG_SMC_USE_32_BIT |
| 1359 | Define this if data bus is 32 bits |
| 1360 | |
| 1361 | CONFIG_SMC_USE_IOFUNCS |
| 1362 | Define this to use i/o functions instead of macros |
| 1363 | (some hardware wont work with macros) |
| 1364 | |
Heiko Schocher | dc02bad | 2011-11-15 10:00:04 -0500 | [diff] [blame] | 1365 | CONFIG_DRIVER_TI_EMAC |
| 1366 | Support for davinci emac |
| 1367 | |
| 1368 | CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT |
| 1369 | Define this if you have more then 3 PHYs. |
| 1370 | |
Macpaul Lin | b3dbf4a5 | 2010-12-21 16:59:46 +0800 | [diff] [blame] | 1371 | CONFIG_FTGMAC100 |
| 1372 | Support for Faraday's FTGMAC100 Gigabit SoC Ethernet |
| 1373 | |
| 1374 | CONFIG_FTGMAC100_EGIGA |
| 1375 | Define this to use GE link update with gigabit PHY. |
| 1376 | Define this if FTGMAC100 is connected to gigabit PHY. |
| 1377 | If your system has 10/100 PHY only, it might not occur |
| 1378 | wrong behavior. Because PHY usually return timeout or |
| 1379 | useless data when polling gigabit status and gigabit |
| 1380 | control registers. This behavior won't affect the |
| 1381 | correctnessof 10/100 link speed update. |
| 1382 | |
Mike Rapoport | c2fff33 | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1383 | CONFIG_SMC911X |
Jens Gehrlein | 557b377 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1384 | Support for SMSC's LAN911x and LAN921x chips |
| 1385 | |
Mike Rapoport | c2fff33 | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1386 | CONFIG_SMC911X_BASE |
Jens Gehrlein | 557b377 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1387 | Define this to hold the physical address |
| 1388 | of the device (I/O space) |
| 1389 | |
Mike Rapoport | c2fff33 | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1390 | CONFIG_SMC911X_32_BIT |
Jens Gehrlein | 557b377 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1391 | Define this if data bus is 32 bits |
| 1392 | |
Mike Rapoport | c2fff33 | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1393 | CONFIG_SMC911X_16_BIT |
Jens Gehrlein | 557b377 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1394 | Define this if data bus is 16 bits. If your processor |
| 1395 | automatically converts one 32 bit word to two 16 bit |
Mike Rapoport | c2fff33 | 2009-11-11 10:03:03 +0200 | [diff] [blame] | 1396 | words you may also try CONFIG_SMC911X_32_BIT. |
Jens Gehrlein | 557b377 | 2008-05-05 14:06:11 +0200 | [diff] [blame] | 1397 | |
Yoshihiro Shimoda | 3d0075f | 2011-01-27 10:06:03 +0900 | [diff] [blame] | 1398 | CONFIG_SH_ETHER |
| 1399 | Support for Renesas on-chip Ethernet controller |
| 1400 | |
| 1401 | CONFIG_SH_ETHER_USE_PORT |
| 1402 | Define the number of ports to be used |
| 1403 | |
| 1404 | CONFIG_SH_ETHER_PHY_ADDR |
| 1405 | Define the ETH PHY's address |
| 1406 | |
Yoshihiro Shimoda | 68260aa | 2011-01-27 10:06:08 +0900 | [diff] [blame] | 1407 | CONFIG_SH_ETHER_CACHE_WRITEBACK |
| 1408 | If this option is set, the driver enables cache flush. |
| 1409 | |
Heiko Schocher | b2f97cf | 2014-07-18 06:07:19 +0200 | [diff] [blame] | 1410 | - PWM Support: |
| 1411 | CONFIG_PWM_IMX |
| 1412 | Support for PWM modul on the imx6. |
| 1413 | |
Vadim Bendebury | 5e12472 | 2011-10-17 08:36:14 +0000 | [diff] [blame] | 1414 | - TPM Support: |
Che-liang Chiou | 90899cc | 2013-04-12 11:04:34 +0000 | [diff] [blame] | 1415 | CONFIG_TPM |
| 1416 | Support TPM devices. |
| 1417 | |
Christophe Ricard | 0766ad2 | 2015-10-06 22:54:41 +0200 | [diff] [blame] | 1418 | CONFIG_TPM_TIS_INFINEON |
| 1419 | Support for Infineon i2c bus TPM devices. Only one device |
Tom Wai-Hong Tam | 1b393db | 2013-04-12 11:04:37 +0000 | [diff] [blame] | 1420 | per system is supported at this time. |
| 1421 | |
Tom Wai-Hong Tam | 1b393db | 2013-04-12 11:04:37 +0000 | [diff] [blame] | 1422 | CONFIG_TPM_TIS_I2C_BURST_LIMITATION |
| 1423 | Define the burst count bytes upper limit |
| 1424 | |
Christophe Ricard | 3aa7408 | 2016-01-21 23:27:13 +0100 | [diff] [blame] | 1425 | CONFIG_TPM_ST33ZP24 |
| 1426 | Support for STMicroelectronics TPM devices. Requires DM_TPM support. |
| 1427 | |
| 1428 | CONFIG_TPM_ST33ZP24_I2C |
| 1429 | Support for STMicroelectronics ST33ZP24 I2C devices. |
| 1430 | Requires TPM_ST33ZP24 and I2C. |
| 1431 | |
Christophe Ricard | b75fdc1 | 2016-01-21 23:27:14 +0100 | [diff] [blame] | 1432 | CONFIG_TPM_ST33ZP24_SPI |
| 1433 | Support for STMicroelectronics ST33ZP24 SPI devices. |
| 1434 | Requires TPM_ST33ZP24 and SPI. |
| 1435 | |
Dirk Eibach | c01939c | 2013-06-26 15:55:15 +0200 | [diff] [blame] | 1436 | CONFIG_TPM_ATMEL_TWI |
| 1437 | Support for Atmel TWI TPM device. Requires I2C support. |
| 1438 | |
Che-liang Chiou | 90899cc | 2013-04-12 11:04:34 +0000 | [diff] [blame] | 1439 | CONFIG_TPM_TIS_LPC |
Vadim Bendebury | 5e12472 | 2011-10-17 08:36:14 +0000 | [diff] [blame] | 1440 | Support for generic parallel port TPM devices. Only one device |
| 1441 | per system is supported at this time. |
| 1442 | |
| 1443 | CONFIG_TPM_TIS_BASE_ADDRESS |
| 1444 | Base address where the generic TPM device is mapped |
| 1445 | to. Contemporary x86 systems usually map it at |
| 1446 | 0xfed40000. |
| 1447 | |
Reinhard Pfau | be6c152 | 2013-06-26 15:55:13 +0200 | [diff] [blame] | 1448 | CONFIG_CMD_TPM |
| 1449 | Add tpm monitor functions. |
| 1450 | Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also |
| 1451 | provides monitor access to authorized functions. |
| 1452 | |
| 1453 | CONFIG_TPM |
| 1454 | Define this to enable the TPM support library which provides |
| 1455 | functional interfaces to some TPM commands. |
| 1456 | Requires support for a TPM device. |
| 1457 | |
| 1458 | CONFIG_TPM_AUTH_SESSIONS |
| 1459 | Define this to enable authorized functions in the TPM library. |
| 1460 | Requires CONFIG_TPM and CONFIG_SHA1. |
| 1461 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1462 | - USB Support: |
| 1463 | At the moment only the UHCI host controller is |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1464 | supported (PIP405, MIP405, MPC5200); define |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1465 | CONFIG_USB_UHCI to enable it. |
| 1466 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard |
wdenk | 30d56fa | 2004-10-09 22:44:59 +0000 | [diff] [blame] | 1467 | and define CONFIG_USB_STORAGE to enable the USB |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1468 | storage devices. |
| 1469 | Note: |
| 1470 | Supported are USB Keyboards and USB Floppy drives |
| 1471 | (TEAC FD-05PUB). |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1472 | MPC5200 USB requires additional defines: |
| 1473 | CONFIG_USB_CLOCK |
| 1474 | for 528 MHz Clock: 0x0001bbbb |
Eric Millbrandt | 307ecb6 | 2009-08-13 08:32:37 -0500 | [diff] [blame] | 1475 | CONFIG_PSC3_USB |
| 1476 | for USB on PSC3 |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1477 | CONFIG_USB_CONFIG |
| 1478 | for differential drivers: 0x00001000 |
| 1479 | for single ended drivers: 0x00005000 |
Eric Millbrandt | 307ecb6 | 2009-08-13 08:32:37 -0500 | [diff] [blame] | 1480 | for differential drivers on PSC3: 0x00000100 |
| 1481 | for single ended drivers on PSC3: 0x00004100 |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1482 | CONFIG_SYS_USB_EVENT_POLL |
Zhang Wei | fdcfaa1 | 2007-06-06 10:08:13 +0200 | [diff] [blame] | 1483 | May be defined to allow interrupt polling |
| 1484 | instead of using asynchronous interrupts |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 1485 | |
Simon Glass | 9ab4ce2 | 2012-02-27 10:52:47 +0000 | [diff] [blame] | 1486 | CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the |
| 1487 | txfilltuning field in the EHCI controller on reset. |
| 1488 | |
Oleksandr Tymoshenko | 6e9e062 | 2014-02-01 21:51:25 -0700 | [diff] [blame] | 1489 | CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 |
| 1490 | HW module registers. |
| 1491 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1492 | - USB Device: |
| 1493 | Define the below if you wish to use the USB console. |
| 1494 | Once firmware is rebuilt from a serial console issue the |
| 1495 | command "setenv stdin usbtty; setenv stdout usbtty" and |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1496 | attach your USB cable. The Unix command "dmesg" should print |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1497 | it has found a new device. The environment variable usbtty |
| 1498 | can be set to gserial or cdc_acm to enable your device to |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1499 | appear to a USB host as a Linux gserial device or a |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1500 | Common Device Class Abstract Control Model serial device. |
| 1501 | If you select usbtty = gserial you should be able to enumerate |
| 1502 | a Linux host by |
| 1503 | # modprobe usbserial vendor=0xVendorID product=0xProductID |
| 1504 | else if using cdc_acm, simply setting the environment |
| 1505 | variable usbtty to be cdc_acm should suffice. The following |
| 1506 | might be defined in YourBoardName.h |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1507 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1508 | CONFIG_USB_DEVICE |
| 1509 | Define this to build a UDC device |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1510 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1511 | CONFIG_USB_TTY |
| 1512 | Define this to have a tty type of device available to |
| 1513 | talk to the UDC device |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1514 | |
Vipin KUMAR | f9da0f8 | 2012-03-26 15:38:06 +0530 | [diff] [blame] | 1515 | CONFIG_USBD_HS |
| 1516 | Define this to enable the high speed support for usb |
| 1517 | device and usbtty. If this feature is enabled, a routine |
| 1518 | int is_usbd_high_speed(void) |
| 1519 | also needs to be defined by the driver to dynamically poll |
| 1520 | whether the enumeration has succeded at high speed or full |
| 1521 | speed. |
| 1522 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1523 | CONFIG_SYS_CONSOLE_IS_IN_ENV |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1524 | Define this if you want stdin, stdout &/or stderr to |
| 1525 | be set to usbtty. |
| 1526 | |
| 1527 | mpc8xx: |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1528 | CONFIG_SYS_USB_EXTC_CLK 0xBLAH |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1529 | Derive USB clock from external clock "blah" |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1530 | - CONFIG_SYS_USB_EXTC_CLK 0x02 |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1531 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1532 | CONFIG_SYS_USB_BRG_CLK 0xBLAH |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1533 | Derive USB clock from brgclk |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1534 | - CONFIG_SYS_USB_BRG_CLK 0x04 |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1535 | |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1536 | If you have a USB-IF assigned VendorID then you may wish to |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1537 | define your own vendor specific values either in BoardName.h |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1538 | or directly in usbd_vendor_info.h. If you don't define |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1539 | CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, |
| 1540 | CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot |
| 1541 | should pretend to be a Linux device to it's target host. |
| 1542 | |
| 1543 | CONFIG_USBD_MANUFACTURER |
| 1544 | Define this string as the name of your company for |
| 1545 | - CONFIG_USBD_MANUFACTURER "my company" |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1546 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1547 | CONFIG_USBD_PRODUCT_NAME |
| 1548 | Define this string as the name of your product |
| 1549 | - CONFIG_USBD_PRODUCT_NAME "acme usb device" |
| 1550 | |
| 1551 | CONFIG_USBD_VENDORID |
| 1552 | Define this as your assigned Vendor ID from the USB |
| 1553 | Implementors Forum. This *must* be a genuine Vendor ID |
| 1554 | to avoid polluting the USB namespace. |
| 1555 | - CONFIG_USBD_VENDORID 0xFFFF |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 1556 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 1557 | CONFIG_USBD_PRODUCTID |
| 1558 | Define this as the unique Product ID |
| 1559 | for your device |
| 1560 | - CONFIG_USBD_PRODUCTID 0xFFFF |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1561 | |
Igor Grinberg | d70a560 | 2011-12-12 12:08:35 +0200 | [diff] [blame] | 1562 | - ULPI Layer Support: |
| 1563 | The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via |
| 1564 | the generic ULPI layer. The generic layer accesses the ULPI PHY |
| 1565 | via the platform viewport, so you need both the genric layer and |
| 1566 | the viewport enabled. Currently only Chipidea/ARC based |
| 1567 | viewport is supported. |
| 1568 | To enable the ULPI layer support, define CONFIG_USB_ULPI and |
| 1569 | CONFIG_USB_ULPI_VIEWPORT in your board configuration file. |
Lucas Stach | 6d365ea | 2012-10-01 00:44:35 +0200 | [diff] [blame] | 1570 | If your ULPI phy needs a different reference clock than the |
| 1571 | standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to |
| 1572 | the appropriate value in Hz. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1573 | |
| 1574 | - MMC Support: |
| 1575 | The MMC controller on the Intel PXA is supported. To |
| 1576 | enable this define CONFIG_MMC. The MMC can be |
| 1577 | accessed from the boot prompt by mapping the device |
| 1578 | to physical memory similar to flash. Command line is |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 1579 | enabled with CONFIG_CMD_MMC. The MMC driver also works with |
| 1580 | the FAT fs. This is enabled with CONFIG_CMD_FAT. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1581 | |
Yoshihiro Shimoda | afb3566 | 2011-07-04 22:21:22 +0000 | [diff] [blame] | 1582 | CONFIG_SH_MMCIF |
| 1583 | Support for Renesas on-chip MMCIF controller |
| 1584 | |
| 1585 | CONFIG_SH_MMCIF_ADDR |
| 1586 | Define the base address of MMCIF registers |
| 1587 | |
| 1588 | CONFIG_SH_MMCIF_CLK |
| 1589 | Define the clock frequency for MMCIF |
| 1590 | |
Pierre Aubert | 1fd93c6 | 2014-04-24 10:30:08 +0200 | [diff] [blame] | 1591 | CONFIG_GENERIC_MMC |
| 1592 | Enable the generic MMC driver |
| 1593 | |
| 1594 | CONFIG_SUPPORT_EMMC_BOOT |
| 1595 | Enable some additional features of the eMMC boot partitions. |
| 1596 | |
| 1597 | CONFIG_SUPPORT_EMMC_RPMB |
| 1598 | Enable the commands for reading, writing and programming the |
| 1599 | key for the Replay Protection Memory Block partition in eMMC. |
| 1600 | |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 1601 | - USB Device Firmware Update (DFU) class support: |
Paul Kocialkowski | 01acd6a | 2015-06-12 19:56:58 +0200 | [diff] [blame] | 1602 | CONFIG_USB_FUNCTION_DFU |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 1603 | This enables the USB portion of the DFU USB class |
| 1604 | |
| 1605 | CONFIG_CMD_DFU |
| 1606 | This enables the command "dfu" which is used to have |
| 1607 | U-Boot create a DFU class device via USB. This command |
| 1608 | requires that the "dfu_alt_info" environment variable be |
| 1609 | set and define the alt settings to expose to the host. |
| 1610 | |
| 1611 | CONFIG_DFU_MMC |
| 1612 | This enables support for exposing (e)MMC devices via DFU. |
| 1613 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 1614 | CONFIG_DFU_NAND |
| 1615 | This enables support for exposing NAND devices via DFU. |
| 1616 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 1617 | CONFIG_DFU_RAM |
| 1618 | This enables support for exposing RAM via DFU. |
| 1619 | Note: DFU spec refer to non-volatile memory usage, but |
| 1620 | allow usages beyond the scope of spec - here RAM usage, |
| 1621 | one that would help mostly the developer. |
| 1622 | |
Heiko Schocher | e7e75c7 | 2013-06-12 06:05:51 +0200 | [diff] [blame] | 1623 | CONFIG_SYS_DFU_DATA_BUF_SIZE |
| 1624 | Dfu transfer uses a buffer before writing data to the |
| 1625 | raw storage device. Make the size (in bytes) of this buffer |
| 1626 | configurable. The size of this buffer is also configurable |
| 1627 | through the "dfu_bufsiz" environment variable. |
| 1628 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 1629 | CONFIG_SYS_DFU_MAX_FILE_SIZE |
| 1630 | When updating files rather than the raw storage device, |
| 1631 | we use a static buffer to copy the file into and then write |
| 1632 | the buffer once we've been given the whole file. Define |
| 1633 | this to the maximum filesize (in bytes) for the buffer. |
| 1634 | Default is 4 MiB if undefined. |
| 1635 | |
Heiko Schocher | 001a831 | 2014-03-18 08:09:56 +0100 | [diff] [blame] | 1636 | DFU_DEFAULT_POLL_TIMEOUT |
| 1637 | Poll timeout [ms], is the timeout a device can send to the |
| 1638 | host. The host must wait for this timeout before sending |
| 1639 | a subsequent DFU_GET_STATUS request to the device. |
| 1640 | |
| 1641 | DFU_MANIFEST_POLL_TIMEOUT |
| 1642 | Poll timeout [ms], which the device sends to the host when |
| 1643 | entering dfuMANIFEST state. Host waits this timeout, before |
| 1644 | sending again an USB request to the device. |
| 1645 | |
Sebastian Siewior | 3aab70a | 2014-05-05 15:08:10 -0500 | [diff] [blame] | 1646 | - USB Device Android Fastboot support: |
Paul Kocialkowski | 17da3c0 | 2015-06-12 19:56:59 +0200 | [diff] [blame] | 1647 | CONFIG_USB_FUNCTION_FASTBOOT |
| 1648 | This enables the USB part of the fastboot gadget |
| 1649 | |
Sebastian Siewior | 3aab70a | 2014-05-05 15:08:10 -0500 | [diff] [blame] | 1650 | CONFIG_CMD_FASTBOOT |
| 1651 | This enables the command "fastboot" which enables the Android |
| 1652 | fastboot mode for the platform's USB device. Fastboot is a USB |
| 1653 | protocol for downloading images, flashing and device control |
| 1654 | used on Android devices. |
| 1655 | See doc/README.android-fastboot for more information. |
| 1656 | |
| 1657 | CONFIG_ANDROID_BOOT_IMAGE |
| 1658 | This enables support for booting images which use the Android |
| 1659 | image format header. |
| 1660 | |
Paul Kocialkowski | a588d99 | 2015-07-20 12:38:22 +0200 | [diff] [blame] | 1661 | CONFIG_FASTBOOT_BUF_ADDR |
Sebastian Siewior | 3aab70a | 2014-05-05 15:08:10 -0500 | [diff] [blame] | 1662 | The fastboot protocol requires a large memory buffer for |
| 1663 | downloads. Define this to the starting RAM address to use for |
| 1664 | downloaded images. |
| 1665 | |
Paul Kocialkowski | a588d99 | 2015-07-20 12:38:22 +0200 | [diff] [blame] | 1666 | CONFIG_FASTBOOT_BUF_SIZE |
Sebastian Siewior | 3aab70a | 2014-05-05 15:08:10 -0500 | [diff] [blame] | 1667 | The fastboot protocol requires a large memory buffer for |
| 1668 | downloads. This buffer should be as large as possible for a |
| 1669 | platform. Define this to the size available RAM for fastboot. |
| 1670 | |
Steve Rae | d1b5ed0 | 2014-08-26 11:47:28 -0700 | [diff] [blame] | 1671 | CONFIG_FASTBOOT_FLASH |
| 1672 | The fastboot protocol includes a "flash" command for writing |
| 1673 | the downloaded image to a non-volatile storage device. Define |
| 1674 | this to enable the "fastboot flash" command. |
| 1675 | |
| 1676 | CONFIG_FASTBOOT_FLASH_MMC_DEV |
| 1677 | The fastboot "flash" command requires additional information |
| 1678 | regarding the non-volatile storage device. Define this to |
| 1679 | the eMMC device that fastboot should use to store the image. |
| 1680 | |
Steve Rae | 0ff7e58 | 2014-12-12 15:51:54 -0800 | [diff] [blame] | 1681 | CONFIG_FASTBOOT_GPT_NAME |
| 1682 | The fastboot "flash" command supports writing the downloaded |
| 1683 | image to the Protective MBR and the Primary GUID Partition |
| 1684 | Table. (Additionally, this downloaded image is post-processed |
| 1685 | to generate and write the Backup GUID Partition Table.) |
| 1686 | This occurs when the specified "partition name" on the |
| 1687 | "fastboot flash" command line matches this value. |
| 1688 | Default is GPT_ENTRY_NAME (currently "gpt") if undefined. |
| 1689 | |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1690 | - Journaling Flash filesystem support: |
| 1691 | CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, |
| 1692 | CONFIG_JFFS2_NAND_DEV |
| 1693 | Define these for a default partition on a NAND device |
| 1694 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1695 | CONFIG_SYS_JFFS2_FIRST_SECTOR, |
| 1696 | CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1697 | Define these for a default partition on a NOR device |
| 1698 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1699 | CONFIG_SYS_JFFS_CUSTOM_PART |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1700 | Define this to create an own partition. You have to provide a |
| 1701 | function struct part_info* jffs2_part_info(int part_num) |
| 1702 | |
| 1703 | If you define only one JFFS2 partition you may also want to |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1704 | #define CONFIG_SYS_JFFS_SINGLE_PART 1 |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 1705 | to disable the command chpart. This is the default when you |
| 1706 | have not defined a custom partition |
| 1707 | |
Donggeun Kim | c30a15e | 2011-10-24 21:15:28 +0000 | [diff] [blame] | 1708 | - FAT(File Allocation Table) filesystem write function support: |
| 1709 | CONFIG_FAT_WRITE |
Donggeun Kim | 656f4c6 | 2012-03-22 04:38:56 +0000 | [diff] [blame] | 1710 | |
| 1711 | Define this to enable support for saving memory data as a |
| 1712 | file in FAT formatted partition. |
| 1713 | |
| 1714 | This will also enable the command "fatwrite" enabling the |
| 1715 | user to write files to FAT. |
Donggeun Kim | c30a15e | 2011-10-24 21:15:28 +0000 | [diff] [blame] | 1716 | |
Gabe Black | 84cd932 | 2012-10-12 14:26:11 +0000 | [diff] [blame] | 1717 | CBFS (Coreboot Filesystem) support |
| 1718 | CONFIG_CMD_CBFS |
| 1719 | |
| 1720 | Define this to enable support for reading from a Coreboot |
| 1721 | filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls |
| 1722 | and cbfsload. |
| 1723 | |
Siva Durga Prasad Paladugu | 4f0d1a2 | 2014-05-26 19:18:37 +0530 | [diff] [blame] | 1724 | - FAT(File Allocation Table) filesystem cluster size: |
| 1725 | CONFIG_FS_FAT_MAX_CLUSTSIZE |
| 1726 | |
| 1727 | Define the max cluster size for fat operations else |
| 1728 | a default value of 65536 will be defined. |
| 1729 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1730 | - Keyboard Support: |
Simon Glass | 39f615e | 2015-11-11 10:05:47 -0700 | [diff] [blame] | 1731 | See Kconfig help for available keyboard drivers. |
| 1732 | |
| 1733 | CONFIG_KEYBOARD |
| 1734 | |
| 1735 | Define this to enable a custom keyboard support. |
| 1736 | This simply calls drv_keyboard_init() which must be |
| 1737 | defined in your board-specific files. This option is deprecated |
| 1738 | and is only used by novena. For new boards, use driver model |
| 1739 | instead. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1740 | |
| 1741 | - Video support: |
| 1742 | CONFIG_VIDEO |
| 1743 | |
| 1744 | Define this to enable video support (for output to |
| 1745 | video). |
| 1746 | |
| 1747 | CONFIG_VIDEO_CT69000 |
| 1748 | |
| 1749 | Enable Chips & Technologies 69000 Video chip |
| 1750 | |
| 1751 | CONFIG_VIDEO_SMI_LYNXEM |
wdenk | b79a11c | 2004-03-25 15:14:43 +0000 | [diff] [blame] | 1752 | Enable Silicon Motion SMI 712/710/810 Video chip. The |
wdenk | eeb1b77 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1753 | video output is selected via environment 'videoout' |
| 1754 | (1 = LCD and 2 = CRT). If videoout is undefined, CRT is |
| 1755 | assumed. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1756 | |
wdenk | b79a11c | 2004-03-25 15:14:43 +0000 | [diff] [blame] | 1757 | For the CT69000 and SMI_LYNXEM drivers, videomode is |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1758 | selected via environment 'videomode'. Two different ways |
wdenk | eeb1b77 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1759 | are possible: |
| 1760 | - "videomode=num" 'num' is a standard LiLo mode numbers. |
wdenk | 6e59238 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 1761 | Following standard modes are supported (* is default): |
wdenk | eeb1b77 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1762 | |
| 1763 | Colors 640x480 800x600 1024x768 1152x864 1280x1024 |
| 1764 | -------------+--------------------------------------------- |
| 1765 | 8 bits | 0x301* 0x303 0x305 0x161 0x307 |
| 1766 | 15 bits | 0x310 0x313 0x316 0x162 0x319 |
| 1767 | 16 bits | 0x311 0x314 0x317 0x163 0x31A |
| 1768 | 24 bits | 0x312 0x315 0x318 ? 0x31B |
| 1769 | -------------+--------------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1770 | (i.e. setenv videomode 317; saveenv; reset;) |
| 1771 | |
wdenk | b79a11c | 2004-03-25 15:14:43 +0000 | [diff] [blame] | 1772 | - "videomode=bootargs" all the video parameters are parsed |
Marcel Ziswiler | 7817cb2 | 2007-12-30 03:30:46 +0100 | [diff] [blame] | 1773 | from the bootargs. (See drivers/video/videomodes.c) |
wdenk | eeb1b77 | 2004-03-23 22:53:55 +0000 | [diff] [blame] | 1774 | |
| 1775 | |
stroese | c1551ea | 2003-04-04 15:53:41 +0000 | [diff] [blame] | 1776 | CONFIG_VIDEO_SED13806 |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1777 | Enable Epson SED13806 driver. This driver supports 8bpp |
wdenk | a6c7ad2 | 2002-12-03 21:28:10 +0000 | [diff] [blame] | 1778 | and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP |
| 1779 | or CONFIG_VIDEO_SED13806_16BPP |
| 1780 | |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1781 | CONFIG_FSL_DIU_FB |
Wolfgang Denk | 04e5ae7 | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 1782 | Enable the Freescale DIU video driver. Reference boards for |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1783 | SOCs that have a DIU should define this macro to enable DIU |
| 1784 | support, and should also define these other macros: |
| 1785 | |
| 1786 | CONFIG_SYS_DIU_ADDR |
| 1787 | CONFIG_VIDEO |
| 1788 | CONFIG_CMD_BMP |
| 1789 | CONFIG_CFB_CONSOLE |
| 1790 | CONFIG_VIDEO_SW_CURSOR |
| 1791 | CONFIG_VGA_AS_SINGLE_DEVICE |
| 1792 | CONFIG_VIDEO_LOGO |
| 1793 | CONFIG_VIDEO_BMP_LOGO |
| 1794 | |
Timur Tabi | ba8e76b | 2011-04-11 14:18:22 -0500 | [diff] [blame] | 1795 | The DIU driver will look for the 'video-mode' environment |
| 1796 | variable, and if defined, enable the DIU as a console during |
| 1797 | boot. See the documentation file README.video for a |
| 1798 | description of this variable. |
Timur Tabi | 7d3053f | 2011-02-15 17:09:19 -0600 | [diff] [blame] | 1799 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1800 | - LCD Support: CONFIG_LCD |
| 1801 | |
| 1802 | Define this to enable LCD support (for output to LCD |
| 1803 | display); also select one of the supported displays |
| 1804 | by defining one of these: |
| 1805 | |
Stelian Pop | 39cf480 | 2008-05-09 21:57:18 +0200 | [diff] [blame] | 1806 | CONFIG_ATMEL_LCD: |
| 1807 | |
| 1808 | HITACHI TX09D70VM1CCA, 3.5", 240x320. |
| 1809 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1810 | CONFIG_NEC_NL6448AC33: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1811 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1812 | NEC NL6448AC33-18. Active, color, single scan. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1813 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1814 | CONFIG_NEC_NL6448BC20 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1815 | |
wdenk | fd3103b | 2003-11-25 16:55:19 +0000 | [diff] [blame] | 1816 | NEC NL6448BC20-08. 6.5", 640x480. |
| 1817 | Active, color, single scan. |
| 1818 | |
| 1819 | CONFIG_NEC_NL6448BC33_54 |
| 1820 | |
| 1821 | NEC NL6448BC33-54. 10.4", 640x480. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1822 | Active, color, single scan. |
| 1823 | |
| 1824 | CONFIG_SHARP_16x9 |
| 1825 | |
| 1826 | Sharp 320x240. Active, color, single scan. |
| 1827 | It isn't 16x9, and I am not sure what it is. |
| 1828 | |
| 1829 | CONFIG_SHARP_LQ64D341 |
| 1830 | |
| 1831 | Sharp LQ64D341 display, 640x480. |
| 1832 | Active, color, single scan. |
| 1833 | |
| 1834 | CONFIG_HLD1045 |
| 1835 | |
| 1836 | HLD1045 display, 640x480. |
| 1837 | Active, color, single scan. |
| 1838 | |
| 1839 | CONFIG_OPTREX_BW |
| 1840 | |
| 1841 | Optrex CBL50840-2 NF-FW 99 22 M5 |
| 1842 | or |
| 1843 | Hitachi LMG6912RPFC-00T |
| 1844 | or |
| 1845 | Hitachi SP14Q002 |
| 1846 | |
| 1847 | 320x240. Black & white. |
| 1848 | |
| 1849 | Normally display is black on white background; define |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1850 | CONFIG_SYS_WHITE_ON_BLACK to get it inverted. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1851 | |
Simon Glass | 676d319 | 2012-10-17 13:24:54 +0000 | [diff] [blame] | 1852 | CONFIG_LCD_ALIGNMENT |
| 1853 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1854 | Normally the LCD is page-aligned (typically 4KB). If this is |
Simon Glass | 676d319 | 2012-10-17 13:24:54 +0000 | [diff] [blame] | 1855 | defined then the LCD will be aligned to this value instead. |
| 1856 | For ARM it is sometimes useful to use MMU_SECTION_SIZE |
| 1857 | here, since it is cheaper to change data cache settings on |
| 1858 | a per-section basis. |
| 1859 | |
Simon Glass | 0d89efe | 2012-10-17 13:24:59 +0000 | [diff] [blame] | 1860 | CONFIG_CONSOLE_SCROLL_LINES |
| 1861 | |
| 1862 | When the console need to be scrolled, this is the number of |
| 1863 | lines to scroll by. It defaults to 1. Increasing this makes |
| 1864 | the console jump but can help speed up operation when scrolling |
| 1865 | is slow. |
Simon Glass | 676d319 | 2012-10-17 13:24:54 +0000 | [diff] [blame] | 1866 | |
Hannes Petermaier | 604c7d4 | 2015-03-27 08:01:38 +0100 | [diff] [blame] | 1867 | CONFIG_LCD_ROTATION |
| 1868 | |
| 1869 | Sometimes, for example if the display is mounted in portrait |
| 1870 | mode or even if it's mounted landscape but rotated by 180degree, |
| 1871 | we need to rotate our content of the display relative to the |
| 1872 | framebuffer, so that user can read the messages which are |
| 1873 | printed out. |
| 1874 | Once CONFIG_LCD_ROTATION is defined, the lcd_console will be |
| 1875 | initialized with a given rotation from "vl_rot" out of |
| 1876 | "vidinfo_t" which is provided by the board specific code. |
| 1877 | The value for vl_rot is coded as following (matching to |
| 1878 | fbcon=rotate:<n> linux-kernel commandline): |
| 1879 | 0 = no rotation respectively 0 degree |
| 1880 | 1 = 90 degree rotation |
| 1881 | 2 = 180 degree rotation |
| 1882 | 3 = 270 degree rotation |
| 1883 | |
| 1884 | If CONFIG_LCD_ROTATION is not defined, the console will be |
| 1885 | initialized with 0degree rotation. |
| 1886 | |
Tom Wai-Hong Tam | 45d7f52 | 2012-09-28 15:11:16 +0000 | [diff] [blame] | 1887 | CONFIG_LCD_BMP_RLE8 |
| 1888 | |
| 1889 | Support drawing of RLE8-compressed bitmaps on the LCD. |
| 1890 | |
Tom Wai-Hong Tam | 735987c | 2012-12-05 14:46:40 +0000 | [diff] [blame] | 1891 | CONFIG_I2C_EDID |
| 1892 | |
| 1893 | Enables an 'i2c edid' command which can read EDID |
| 1894 | information over I2C from an attached LCD display. |
| 1895 | |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1896 | - Splash Screen Support: CONFIG_SPLASH_SCREEN |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1897 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1898 | If this option is set, the environment is checked for |
| 1899 | a variable "splashimage". If found, the usual display |
| 1900 | of logo, copyright and system information on the LCD |
wdenk | e94d2cd | 2004-06-30 22:59:18 +0000 | [diff] [blame] | 1901 | is suppressed and the BMP image at the address |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1902 | specified in "splashimage" is loaded instead. The |
| 1903 | console is redirected to the "nulldev", too. This |
| 1904 | allows for a "silent" boot where a splash screen is |
| 1905 | loaded very quickly after power-on. |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1906 | |
Nikita Kiryanov | c088048 | 2013-02-24 21:28:43 +0000 | [diff] [blame] | 1907 | CONFIG_SPLASHIMAGE_GUARD |
| 1908 | |
| 1909 | If this option is set, then U-Boot will prevent the environment |
| 1910 | variable "splashimage" from being set to a problematic address |
Tom Rini | 1551df3 | 2014-02-25 10:27:01 -0500 | [diff] [blame] | 1911 | (see README.displaying-bmps). |
Nikita Kiryanov | c088048 | 2013-02-24 21:28:43 +0000 | [diff] [blame] | 1912 | This option is useful for targets where, due to alignment |
| 1913 | restrictions, an improperly aligned BMP image will cause a data |
| 1914 | abort. If you think you will not have problems with unaligned |
| 1915 | accesses (for example because your toolchain prevents them) |
| 1916 | there is no need to set this option. |
| 1917 | |
Matthias Weisser | 1ca298c | 2009-07-09 16:07:30 +0200 | [diff] [blame] | 1918 | CONFIG_SPLASH_SCREEN_ALIGN |
| 1919 | |
| 1920 | If this option is set the splash image can be freely positioned |
| 1921 | on the screen. Environment variable "splashpos" specifies the |
| 1922 | position as "x,y". If a positive number is given it is used as |
| 1923 | number of pixel from left/top. If a negative number is given it |
| 1924 | is used as number of pixel from right/bottom. You can also |
| 1925 | specify 'm' for centering the image. |
| 1926 | |
| 1927 | Example: |
| 1928 | setenv splashpos m,m |
| 1929 | => image at center of screen |
| 1930 | |
| 1931 | setenv splashpos 30,20 |
| 1932 | => image at x = 30 and y = 20 |
| 1933 | |
| 1934 | setenv splashpos -10,m |
| 1935 | => vertically centered image |
| 1936 | at x = dspWidth - bmpWidth - 9 |
| 1937 | |
Stefan Roese | 98f4a3d | 2005-09-22 09:04:17 +0200 | [diff] [blame] | 1938 | - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP |
| 1939 | |
| 1940 | If this option is set, additionally to standard BMP |
| 1941 | images, gzipped BMP images can be displayed via the |
| 1942 | splashscreen support or the bmp command. |
| 1943 | |
Anatolij Gustschin | d501176 | 2010-03-15 14:50:25 +0100 | [diff] [blame] | 1944 | - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 |
| 1945 | |
| 1946 | If this option is set, 8-bit RLE compressed BMP images |
| 1947 | can be displayed via the splashscreen support or the |
| 1948 | bmp command. |
| 1949 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1950 | - Do compressing for memory range: |
Lei Wen | f2b96df | 2012-09-28 04:26:47 +0000 | [diff] [blame] | 1951 | CONFIG_CMD_ZIP |
| 1952 | |
| 1953 | If this option is set, it would use zlib deflate method |
| 1954 | to compress the specified memory at its best effort. |
| 1955 | |
wdenk | c29fdfc | 2003-08-29 20:57:53 +0000 | [diff] [blame] | 1956 | - Compression support: |
Kees Cook | 8ef7047 | 2013-08-16 07:59:12 -0700 | [diff] [blame] | 1957 | CONFIG_GZIP |
| 1958 | |
| 1959 | Enabled by default to support gzip compressed images. |
| 1960 | |
wdenk | c29fdfc | 2003-08-29 20:57:53 +0000 | [diff] [blame] | 1961 | CONFIG_BZIP2 |
| 1962 | |
| 1963 | If this option is set, support for bzip2 compressed |
| 1964 | images is included. If not, only uncompressed and gzip |
| 1965 | compressed images are supported. |
| 1966 | |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1967 | NOTE: the bzip2 algorithm requires a lot of RAM, so |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1968 | the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1969 | be at least 4MB. |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 1970 | |
Luigi 'Comio' Mantellini | fc9c172 | 2008-09-08 02:46:13 +0200 | [diff] [blame] | 1971 | CONFIG_LZMA |
| 1972 | |
| 1973 | If this option is set, support for lzma compressed |
| 1974 | images is included. |
| 1975 | |
| 1976 | Note: The LZMA algorithm adds between 2 and 4KB of code and it |
| 1977 | requires an amount of dynamic memory that is given by the |
| 1978 | formula: |
| 1979 | |
| 1980 | (1846 + 768 << (lc + lp)) * sizeof(uint16) |
| 1981 | |
| 1982 | Where lc and lp stand for, respectively, Literal context bits |
| 1983 | and Literal pos bits. |
| 1984 | |
| 1985 | This value is upper-bounded by 14MB in the worst case. Anyway, |
| 1986 | for a ~4MB large kernel image, we have lc=3 and lp=0 for a |
| 1987 | total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is |
| 1988 | a very small buffer. |
| 1989 | |
| 1990 | Use the lzmainfo tool to determinate the lc and lp values and |
| 1991 | then calculate the amount of needed dynamic memory (ensuring |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1992 | the appropriate CONFIG_SYS_MALLOC_LEN value). |
Luigi 'Comio' Mantellini | fc9c172 | 2008-09-08 02:46:13 +0200 | [diff] [blame] | 1993 | |
Kees Cook | 8ef7047 | 2013-08-16 07:59:12 -0700 | [diff] [blame] | 1994 | CONFIG_LZO |
| 1995 | |
| 1996 | If this option is set, support for LZO compressed images |
| 1997 | is included. |
| 1998 | |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 1999 | - MII/PHY support: |
| 2000 | CONFIG_PHY_ADDR |
| 2001 | |
| 2002 | The address of PHY on MII bus. |
| 2003 | |
| 2004 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) |
| 2005 | |
| 2006 | The clock frequency of the MII bus |
| 2007 | |
| 2008 | CONFIG_PHY_GIGE |
| 2009 | |
| 2010 | If this option is set, support for speed/duplex |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2011 | detection of gigabit PHY is included. |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 2012 | |
| 2013 | CONFIG_PHY_RESET_DELAY |
| 2014 | |
| 2015 | Some PHY like Intel LXT971A need extra delay after |
| 2016 | reset before any MII register access is possible. |
| 2017 | For such PHY, set this option to the usec delay |
| 2018 | required. (minimum 300usec for LXT971A) |
| 2019 | |
| 2020 | CONFIG_PHY_CMD_DELAY (ppc4xx) |
| 2021 | |
| 2022 | Some PHY like Intel LXT971A need extra delay after |
| 2023 | command issued before MII status register can be read |
| 2024 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2025 | - IP address: |
| 2026 | CONFIG_IPADDR |
| 2027 | |
| 2028 | Define a default value for the IP address to use for |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2029 | the default Ethernet interface, in case this is not |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2030 | determined through e.g. bootp. |
Wolfgang Denk | 1ebcd65 | 2011-10-26 10:21:22 +0000 | [diff] [blame] | 2031 | (Environment variable "ipaddr") |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2032 | |
| 2033 | - Server IP address: |
| 2034 | CONFIG_SERVERIP |
| 2035 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2036 | Defines a default value for the IP address of a TFTP |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2037 | server to contact when using the "tftboot" command. |
Wolfgang Denk | 1ebcd65 | 2011-10-26 10:21:22 +0000 | [diff] [blame] | 2038 | (Environment variable "serverip") |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2039 | |
Robin Getz | 97cfe86 | 2009-07-21 12:15:28 -0400 | [diff] [blame] | 2040 | CONFIG_KEEP_SERVERADDR |
| 2041 | |
| 2042 | Keeps the server's MAC address, in the env 'serveraddr' |
| 2043 | for passing to bootargs (like Linux's netconsole option) |
| 2044 | |
Wolfgang Denk | 1ebcd65 | 2011-10-26 10:21:22 +0000 | [diff] [blame] | 2045 | - Gateway IP address: |
| 2046 | CONFIG_GATEWAYIP |
| 2047 | |
| 2048 | Defines a default value for the IP address of the |
| 2049 | default router where packets to other networks are |
| 2050 | sent to. |
| 2051 | (Environment variable "gatewayip") |
| 2052 | |
| 2053 | - Subnet mask: |
| 2054 | CONFIG_NETMASK |
| 2055 | |
| 2056 | Defines a default value for the subnet mask (or |
| 2057 | routing prefix) which is used to determine if an IP |
| 2058 | address belongs to the local subnet or needs to be |
| 2059 | forwarded through a router. |
| 2060 | (Environment variable "netmask") |
| 2061 | |
David Updegraff | 53a5c42 | 2007-06-11 10:41:07 -0500 | [diff] [blame] | 2062 | - Multicast TFTP Mode: |
| 2063 | CONFIG_MCAST_TFTP |
| 2064 | |
| 2065 | Defines whether you want to support multicast TFTP as per |
| 2066 | rfc-2090; for example to work with atftp. Lets lots of targets |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2067 | tftp down the same boot image concurrently. Note: the Ethernet |
David Updegraff | 53a5c42 | 2007-06-11 10:41:07 -0500 | [diff] [blame] | 2068 | driver in use must provide a function: mcast() to join/leave a |
| 2069 | multicast group. |
| 2070 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2071 | - BOOTP Recovery Mode: |
| 2072 | CONFIG_BOOTP_RANDOM_DELAY |
| 2073 | |
| 2074 | If you have many targets in a network that try to |
| 2075 | boot using BOOTP, you may want to avoid that all |
| 2076 | systems send out BOOTP requests at precisely the same |
| 2077 | moment (which would happen for instance at recovery |
| 2078 | from a power failure, when all systems will try to |
| 2079 | boot, thus flooding the BOOTP server. Defining |
| 2080 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be |
| 2081 | inserted before sending out BOOTP requests. The |
Wolfgang Denk | 6c33c78 | 2007-08-06 23:21:05 +0200 | [diff] [blame] | 2082 | following delays are inserted then: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2083 | |
| 2084 | 1st BOOTP request: delay 0 ... 1 sec |
| 2085 | 2nd BOOTP request: delay 0 ... 2 sec |
| 2086 | 3rd BOOTP request: delay 0 ... 4 sec |
| 2087 | 4th and following |
| 2088 | BOOTP requests: delay 0 ... 8 sec |
| 2089 | |
Thierry Reding | 92ac8ac | 2014-08-19 10:21:24 +0200 | [diff] [blame] | 2090 | CONFIG_BOOTP_ID_CACHE_SIZE |
| 2091 | |
| 2092 | BOOTP packets are uniquely identified using a 32-bit ID. The |
| 2093 | server will copy the ID from client requests to responses and |
| 2094 | U-Boot will use this to determine if it is the destination of |
| 2095 | an incoming response. Some servers will check that addresses |
| 2096 | aren't in use before handing them out (usually using an ARP |
| 2097 | ping) and therefore take up to a few hundred milliseconds to |
| 2098 | respond. Network congestion may also influence the time it |
| 2099 | takes for a response to make it back to the client. If that |
| 2100 | time is too long, U-Boot will retransmit requests. In order |
| 2101 | to allow earlier responses to still be accepted after these |
| 2102 | retransmissions, U-Boot's BOOTP client keeps a small cache of |
| 2103 | IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this |
| 2104 | cache. The default is to keep IDs for up to four outstanding |
| 2105 | requests. Increasing this will allow U-Boot to accept offers |
| 2106 | from a BOOTP client in networks with unusually high latency. |
| 2107 | |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2108 | - DHCP Advanced Options: |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 2109 | You can fine tune the DHCP functionality by defining |
| 2110 | CONFIG_BOOTP_* symbols: |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2111 | |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 2112 | CONFIG_BOOTP_SUBNETMASK |
| 2113 | CONFIG_BOOTP_GATEWAY |
| 2114 | CONFIG_BOOTP_HOSTNAME |
| 2115 | CONFIG_BOOTP_NISDOMAIN |
| 2116 | CONFIG_BOOTP_BOOTPATH |
| 2117 | CONFIG_BOOTP_BOOTFILESIZE |
| 2118 | CONFIG_BOOTP_DNS |
| 2119 | CONFIG_BOOTP_DNS2 |
| 2120 | CONFIG_BOOTP_SEND_HOSTNAME |
| 2121 | CONFIG_BOOTP_NTPSERVER |
| 2122 | CONFIG_BOOTP_TIMEOFFSET |
| 2123 | CONFIG_BOOTP_VENDOREX |
Joe Hershberger | 2c00e09 | 2012-05-23 07:59:19 +0000 | [diff] [blame] | 2124 | CONFIG_BOOTP_MAY_FAIL |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2125 | |
Wilson Callan | 5d110f0 | 2007-07-28 10:56:13 -0400 | [diff] [blame] | 2126 | CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip |
| 2127 | environment variable, not the BOOTP server. |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2128 | |
Joe Hershberger | 2c00e09 | 2012-05-23 07:59:19 +0000 | [diff] [blame] | 2129 | CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found |
| 2130 | after the configured retry count, the call will fail |
| 2131 | instead of starting over. This can be used to fail over |
| 2132 | to Link-local IP address configuration if the DHCP server |
| 2133 | is not available. |
| 2134 | |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2135 | CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS |
| 2136 | serverip from a DHCP server, it is possible that more |
| 2137 | than one DNS serverip is offered to the client. |
| 2138 | If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS |
| 2139 | serverip will be stored in the additional environment |
| 2140 | variable "dnsip2". The first DNS serverip is always |
| 2141 | stored in the variable "dnsip", when CONFIG_BOOTP_DNS |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 2142 | is defined. |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2143 | |
| 2144 | CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable |
| 2145 | to do a dynamic update of a DNS server. To do this, they |
| 2146 | need the hostname of the DHCP requester. |
Wilson Callan | 5d110f0 | 2007-07-28 10:56:13 -0400 | [diff] [blame] | 2147 | If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content |
Jon Loeliger | 1fe80d7 | 2007-07-09 22:08:34 -0500 | [diff] [blame] | 2148 | of the "hostname" environment variable is passed as |
| 2149 | option 12 to the DHCP server. |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 2150 | |
Aras Vaichas | d9a2f41 | 2008-03-26 09:43:57 +1100 | [diff] [blame] | 2151 | CONFIG_BOOTP_DHCP_REQUEST_DELAY |
| 2152 | |
| 2153 | A 32bit value in microseconds for a delay between |
| 2154 | receiving a "DHCP Offer" and sending the "DHCP Request". |
| 2155 | This fixes a problem with certain DHCP servers that don't |
| 2156 | respond 100% of the time to a "DHCP request". E.g. On an |
| 2157 | AT91RM9200 processor running at 180MHz, this delay needed |
| 2158 | to be *at least* 15,000 usec before a Windows Server 2003 |
| 2159 | DHCP server would reply 100% of the time. I recommend at |
| 2160 | least 50,000 usec to be safe. The alternative is to hope |
| 2161 | that one of the retries will be successful but note that |
| 2162 | the DHCP timeout and retry process takes a longer than |
| 2163 | this delay. |
| 2164 | |
Joe Hershberger | d22c338 | 2012-05-23 08:00:12 +0000 | [diff] [blame] | 2165 | - Link-local IP address negotiation: |
| 2166 | Negotiate with other link-local clients on the local network |
| 2167 | for an address that doesn't require explicit configuration. |
| 2168 | This is especially useful if a DHCP server cannot be guaranteed |
| 2169 | to exist in all environments that the device must operate. |
| 2170 | |
| 2171 | See doc/README.link-local for more information. |
| 2172 | |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 2173 | - CDP Options: |
wdenk | 6e59238 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 2174 | CONFIG_CDP_DEVICE_ID |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 2175 | |
| 2176 | The device id used in CDP trigger frames. |
| 2177 | |
| 2178 | CONFIG_CDP_DEVICE_ID_PREFIX |
| 2179 | |
| 2180 | A two character string which is prefixed to the MAC address |
| 2181 | of the device. |
| 2182 | |
| 2183 | CONFIG_CDP_PORT_ID |
| 2184 | |
| 2185 | A printf format string which contains the ascii name of |
| 2186 | the port. Normally is set to "eth%d" which sets |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2187 | eth0 for the first Ethernet, eth1 for the second etc. |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 2188 | |
| 2189 | CONFIG_CDP_CAPABILITIES |
| 2190 | |
| 2191 | A 32bit integer which indicates the device capabilities; |
| 2192 | 0x00000010 for a normal host which does not forwards. |
| 2193 | |
| 2194 | CONFIG_CDP_VERSION |
| 2195 | |
| 2196 | An ascii string containing the version of the software. |
| 2197 | |
| 2198 | CONFIG_CDP_PLATFORM |
| 2199 | |
| 2200 | An ascii string containing the name of the platform. |
| 2201 | |
| 2202 | CONFIG_CDP_TRIGGER |
| 2203 | |
| 2204 | A 32bit integer sent on the trigger. |
| 2205 | |
| 2206 | CONFIG_CDP_POWER_CONSUMPTION |
| 2207 | |
| 2208 | A 16bit integer containing the power consumption of the |
| 2209 | device in .1 of milliwatts. |
| 2210 | |
| 2211 | CONFIG_CDP_APPLIANCE_VLAN_TYPE |
| 2212 | |
| 2213 | A byte containing the id of the VLAN. |
| 2214 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2215 | - Status LED: CONFIG_STATUS_LED |
| 2216 | |
| 2217 | Several configurations allow to display the current |
| 2218 | status using a LED. For instance, the LED will blink |
| 2219 | fast while running U-Boot code, stop blinking as |
| 2220 | soon as a reply to a BOOTP request was received, and |
| 2221 | start blinking slow once the Linux kernel is running |
| 2222 | (supported by a status LED driver in the Linux |
| 2223 | kernel). Defining CONFIG_STATUS_LED enables this |
| 2224 | feature in U-Boot. |
| 2225 | |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 2226 | Additional options: |
| 2227 | |
| 2228 | CONFIG_GPIO_LED |
| 2229 | The status LED can be connected to a GPIO pin. |
| 2230 | In such cases, the gpio_led driver can be used as a |
| 2231 | status LED backend implementation. Define CONFIG_GPIO_LED |
| 2232 | to include the gpio_led driver in the U-Boot binary. |
| 2233 | |
Igor Grinberg | 9dfdcdf | 2013-11-08 01:03:52 +0200 | [diff] [blame] | 2234 | CONFIG_GPIO_LED_INVERTED_TABLE |
| 2235 | Some GPIO connected LEDs may have inverted polarity in which |
| 2236 | case the GPIO high value corresponds to LED off state and |
| 2237 | GPIO low value corresponds to LED on state. |
| 2238 | In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined |
| 2239 | with a list of GPIO LEDs that have inverted polarity. |
| 2240 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2241 | - CAN Support: CONFIG_CAN_DRIVER |
| 2242 | |
| 2243 | Defining CONFIG_CAN_DRIVER enables CAN driver support |
| 2244 | on those systems that support this (optional) |
| 2245 | feature, like the TQM8xxL modules. |
| 2246 | |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2247 | - I2C Support: CONFIG_SYS_I2C |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2248 | |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2249 | This enable the NEW i2c subsystem, and will allow you to use |
| 2250 | i2c commands at the u-boot command line (as long as you set |
| 2251 | CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c |
| 2252 | based realtime clock chips or other i2c devices. See |
| 2253 | common/cmd_i2c.c for a description of the command line |
| 2254 | interface. |
| 2255 | |
| 2256 | ported i2c driver to the new framework: |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 2257 | - drivers/i2c/soft_i2c.c: |
| 2258 | - activate first bus with CONFIG_SYS_I2C_SOFT define |
| 2259 | CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE |
| 2260 | for defining speed and slave address |
| 2261 | - activate second bus with I2C_SOFT_DECLARATIONS2 define |
| 2262 | CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 |
| 2263 | for defining speed and slave address |
| 2264 | - activate third bus with I2C_SOFT_DECLARATIONS3 define |
| 2265 | CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 |
| 2266 | for defining speed and slave address |
| 2267 | - activate fourth bus with I2C_SOFT_DECLARATIONS4 define |
| 2268 | CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 |
| 2269 | for defining speed and slave address |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2270 | |
Heiko Schocher | 00f792e | 2012-10-24 13:48:22 +0200 | [diff] [blame] | 2271 | - drivers/i2c/fsl_i2c.c: |
| 2272 | - activate i2c driver with CONFIG_SYS_I2C_FSL |
| 2273 | define CONFIG_SYS_FSL_I2C_OFFSET for setting the register |
| 2274 | offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and |
| 2275 | CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first |
| 2276 | bus. |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 2277 | - If your board supports a second fsl i2c bus, define |
Heiko Schocher | 00f792e | 2012-10-24 13:48:22 +0200 | [diff] [blame] | 2278 | CONFIG_SYS_FSL_I2C2_OFFSET for the register offset |
| 2279 | CONFIG_SYS_FSL_I2C2_SPEED for the speed and |
| 2280 | CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the |
| 2281 | second bus. |
| 2282 | |
Simon Glass | 1f2ba72 | 2012-10-30 07:28:53 +0000 | [diff] [blame] | 2283 | - drivers/i2c/tegra_i2c.c: |
Nobuhiro Iwamatsu | 10cee51 | 2013-10-11 16:23:53 +0900 | [diff] [blame] | 2284 | - activate this driver with CONFIG_SYS_I2C_TEGRA |
| 2285 | - This driver adds 4 i2c buses with a fix speed from |
| 2286 | 100000 and the slave addr 0! |
Simon Glass | 1f2ba72 | 2012-10-30 07:28:53 +0000 | [diff] [blame] | 2287 | |
Dirk Eibach | 880540d | 2013-04-25 02:40:01 +0000 | [diff] [blame] | 2288 | - drivers/i2c/ppc4xx_i2c.c |
| 2289 | - activate this driver with CONFIG_SYS_I2C_PPC4XX |
| 2290 | - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 |
| 2291 | - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 |
| 2292 | |
trem | fac9640 | 2013-09-21 18:13:35 +0200 | [diff] [blame] | 2293 | - drivers/i2c/i2c_mxc.c |
| 2294 | - activate this driver with CONFIG_SYS_I2C_MXC |
Albert ARIBAUD \\(3ADEV\\) | 03544c6 | 2015-09-21 22:43:38 +0200 | [diff] [blame] | 2295 | - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 |
| 2296 | - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 |
| 2297 | - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 |
| 2298 | - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 |
trem | fac9640 | 2013-09-21 18:13:35 +0200 | [diff] [blame] | 2299 | - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED |
| 2300 | - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE |
| 2301 | - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED |
| 2302 | - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE |
| 2303 | - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED |
| 2304 | - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE |
Albert ARIBAUD \\(3ADEV\\) | 03544c6 | 2015-09-21 22:43:38 +0200 | [diff] [blame] | 2305 | - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED |
| 2306 | - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2307 | If those defines are not set, default value is 100000 |
trem | fac9640 | 2013-09-21 18:13:35 +0200 | [diff] [blame] | 2308 | for speed, and 0 for slave. |
| 2309 | |
Nobuhiro Iwamatsu | 1086bfa | 2013-09-27 16:58:30 +0900 | [diff] [blame] | 2310 | - drivers/i2c/rcar_i2c.c: |
| 2311 | - activate this driver with CONFIG_SYS_I2C_RCAR |
| 2312 | - This driver adds 4 i2c buses |
| 2313 | |
| 2314 | - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 |
| 2315 | - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 |
| 2316 | - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 |
| 2317 | - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 |
| 2318 | - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 |
| 2319 | - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 |
| 2320 | - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 |
| 2321 | - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 |
| 2322 | - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses |
| 2323 | |
Nobuhiro Iwamatsu | 2035d77 | 2013-10-29 13:33:51 +0900 | [diff] [blame] | 2324 | - drivers/i2c/sh_i2c.c: |
| 2325 | - activate this driver with CONFIG_SYS_I2C_SH |
| 2326 | - This driver adds from 2 to 5 i2c buses |
| 2327 | |
| 2328 | - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 |
| 2329 | - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 |
| 2330 | - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 |
| 2331 | - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 |
| 2332 | - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 |
| 2333 | - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 |
| 2334 | - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 |
| 2335 | - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 |
| 2336 | - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 |
| 2337 | - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 |
| 2338 | - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 |
| 2339 | - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2340 | - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses |
Nobuhiro Iwamatsu | 2035d77 | 2013-10-29 13:33:51 +0900 | [diff] [blame] | 2341 | |
Heiko Schocher | 6789e84 | 2013-10-22 11:03:18 +0200 | [diff] [blame] | 2342 | - drivers/i2c/omap24xx_i2c.c |
| 2343 | - activate this driver with CONFIG_SYS_I2C_OMAP24XX |
| 2344 | - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 |
| 2345 | - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 |
| 2346 | - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 |
| 2347 | - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 |
| 2348 | - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 |
| 2349 | - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 |
| 2350 | - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 |
| 2351 | - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 |
| 2352 | - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 |
| 2353 | - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 |
| 2354 | |
Heiko Schocher | 0bdffe7 | 2013-11-08 07:30:53 +0100 | [diff] [blame] | 2355 | - drivers/i2c/zynq_i2c.c |
| 2356 | - activate this driver with CONFIG_SYS_I2C_ZYNQ |
| 2357 | - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting |
| 2358 | - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr |
| 2359 | |
Naveen Krishna Ch | e717fc6 | 2013-12-06 12:12:38 +0530 | [diff] [blame] | 2360 | - drivers/i2c/s3c24x0_i2c.c: |
| 2361 | - activate this driver with CONFIG_SYS_I2C_S3C24X0 |
| 2362 | - This driver adds i2c buses (11 for Exynos5250, Exynos5420 |
| 2363 | 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) |
| 2364 | with a fix speed from 100000 and the slave addr 0! |
| 2365 | |
Dirk Eibach | b46226b | 2014-07-03 09:28:18 +0200 | [diff] [blame] | 2366 | - drivers/i2c/ihs_i2c.c |
| 2367 | - activate this driver with CONFIG_SYS_I2C_IHS |
| 2368 | - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 |
| 2369 | - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 |
| 2370 | - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 |
| 2371 | - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 |
| 2372 | - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 |
| 2373 | - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 |
| 2374 | - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 |
| 2375 | - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 |
| 2376 | - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 |
| 2377 | - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 |
| 2378 | - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 |
| 2379 | - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 |
Dirk Eibach | 071be89 | 2015-10-28 11:46:22 +0100 | [diff] [blame] | 2380 | - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL |
| 2381 | - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 |
| 2382 | - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 |
| 2383 | - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 |
| 2384 | - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 |
| 2385 | - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 |
| 2386 | - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 |
| 2387 | - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 |
| 2388 | - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 |
Dirk Eibach | b46226b | 2014-07-03 09:28:18 +0200 | [diff] [blame] | 2389 | |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2390 | additional defines: |
| 2391 | |
| 2392 | CONFIG_SYS_NUM_I2C_BUSES |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2393 | Hold the number of i2c buses you want to use. If you |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2394 | don't use/have i2c muxes on your i2c bus, this |
| 2395 | is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can |
| 2396 | omit this define. |
| 2397 | |
| 2398 | CONFIG_SYS_I2C_DIRECT_BUS |
| 2399 | define this, if you don't use i2c muxes on your hardware. |
| 2400 | if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can |
| 2401 | omit this define. |
| 2402 | |
| 2403 | CONFIG_SYS_I2C_MAX_HOPS |
| 2404 | define how many muxes are maximal consecutively connected |
| 2405 | on one i2c bus. If you not use i2c muxes, omit this |
| 2406 | define. |
| 2407 | |
| 2408 | CONFIG_SYS_I2C_BUSES |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 2409 | hold a list of buses you want to use, only used if |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2410 | CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example |
| 2411 | a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and |
| 2412 | CONFIG_SYS_NUM_I2C_BUSES = 9: |
| 2413 | |
| 2414 | CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ |
| 2415 | {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ |
| 2416 | {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ |
| 2417 | {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ |
| 2418 | {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ |
| 2419 | {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ |
| 2420 | {1, {I2C_NULL_HOP}}, \ |
| 2421 | {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ |
| 2422 | {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ |
| 2423 | } |
| 2424 | |
| 2425 | which defines |
| 2426 | bus 0 on adapter 0 without a mux |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 2427 | bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 |
| 2428 | bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 |
| 2429 | bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 |
| 2430 | bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 |
| 2431 | bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2432 | bus 6 on adapter 1 without a mux |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 2433 | bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 |
| 2434 | bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2435 | |
| 2436 | If you do not have i2c muxes on your board, omit this define. |
| 2437 | |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 2438 | - Legacy I2C Support: CONFIG_HARD_I2C |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 2439 | |
| 2440 | NOTE: It is intended to move drivers to CONFIG_SYS_I2C which |
| 2441 | provides the following compelling advantages: |
| 2442 | |
| 2443 | - more than one i2c adapter is usable |
| 2444 | - approved multibus support |
| 2445 | - better i2c mux support |
| 2446 | |
| 2447 | ** Please consider updating your I2C driver now. ** |
| 2448 | |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 2449 | These enable legacy I2C serial bus commands. Defining |
| 2450 | CONFIG_HARD_I2C will include the appropriate I2C driver |
| 2451 | for the selected CPU. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2452 | |
wdenk | 945af8d | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 2453 | This will allow you to use i2c commands at the u-boot |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 2454 | command line (as long as you set CONFIG_CMD_I2C in |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 2455 | CONFIG_COMMANDS) and communicate with i2c based realtime |
| 2456 | clock chips. See common/cmd_i2c.c for a description of the |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 2457 | command line interface. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2458 | |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 2459 | CONFIG_HARD_I2C selects a hardware I2C controller. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2460 | |
wdenk | 945af8d | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 2461 | There are several other quantities that must also be |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 2462 | defined when you define CONFIG_HARD_I2C. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2463 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2464 | In both cases you will need to define CONFIG_SYS_I2C_SPEED |
wdenk | 945af8d | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 2465 | to be the frequency (in Hz) at which you wish your i2c bus |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 2466 | to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 2467 | the CPU's i2c node address). |
wdenk | 945af8d | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 2468 | |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 2469 | Now, the u-boot i2c code for the mpc8xx |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 2470 | (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node |
Peter Tyser | 8d321b8 | 2010-04-12 22:28:21 -0500 | [diff] [blame] | 2471 | and so its address should therefore be cleared to 0 (See, |
| 2472 | eg, MPC823e User's Manual p.16-473). So, set |
| 2473 | CONFIG_SYS_I2C_SLAVE to 0. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2474 | |
Eric Millbrandt | 5da71ef | 2009-09-03 08:09:44 -0500 | [diff] [blame] | 2475 | CONFIG_SYS_I2C_INIT_MPC5XXX |
| 2476 | |
| 2477 | When a board is reset during an i2c bus transfer |
| 2478 | chips might think that the current transfer is still |
| 2479 | in progress. Reset the slave devices by sending start |
| 2480 | commands until the slave device responds. |
| 2481 | |
|