Tom Rini | 83d290c | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | # SPDX-License-Identifier: GPL-2.0+ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2 | # |
Wolfgang Denk | eca3aeb | 2013-06-21 10:22:36 +0200 | [diff] [blame] | 3 | # (C) Copyright 2000 - 2013 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 4 | # Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 5 | |
| 6 | Summary: |
| 7 | ======== |
| 8 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 9 | This directory contains the source code for U-Boot, a boot loader for |
wdenk | e86e5a0 | 2004-10-17 21:12:06 +0000 | [diff] [blame] | 10 | Embedded boards based on PowerPC, ARM, MIPS and several other |
| 11 | processors, which can be installed in a boot ROM and used to |
| 12 | initialize and test the hardware or to download and run application |
| 13 | code. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 14 | |
| 15 | The development of U-Boot is closely related to Linux: some parts of |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 16 | the source code originate in the Linux source tree, we have some |
| 17 | header files in common, and special provision has been made to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 18 | support booting of Linux images. |
| 19 | |
| 20 | Some attention has been paid to make this software easily |
| 21 | configurable and extendable. For instance, all monitor commands are |
| 22 | implemented with the same call interface, so that it's very easy to |
| 23 | add new commands. Also, instead of permanently adding rarely used |
| 24 | code (for instance hardware test utilities) to the monitor, you can |
| 25 | load and run it dynamically. |
| 26 | |
| 27 | |
| 28 | Status: |
| 29 | ======= |
| 30 | |
Heinrich Schuchardt | 0c4759f | 2023-01-25 19:14:59 +0100 | [diff] [blame] | 31 | In general, all boards for which a default configuration file exists in the |
| 32 | configs/ directory have been tested to some extent and can be considered |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 33 | "working". In fact, many of them are used in production systems. |
| 34 | |
Heinrich Schuchardt | 0c4759f | 2023-01-25 19:14:59 +0100 | [diff] [blame] | 35 | In case of problems you can use |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 36 | |
Heinrich Schuchardt | 0c4759f | 2023-01-25 19:14:59 +0100 | [diff] [blame] | 37 | scripts/get_maintainer.pl <path> |
Robert P. J. Day | adb9d85 | 2012-11-14 02:03:20 +0000 | [diff] [blame] | 38 | |
Heinrich Schuchardt | 0c4759f | 2023-01-25 19:14:59 +0100 | [diff] [blame] | 39 | to identify the people or companies responsible for various boards and |
| 40 | subsystems. Or have a look at the git log. |
Robert P. J. Day | adb9d85 | 2012-11-14 02:03:20 +0000 | [diff] [blame] | 41 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 42 | |
| 43 | Where to get help: |
| 44 | ================== |
| 45 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 46 | 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] | 47 | 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] | 48 | <u-boot@lists.denx.de>. There is also an archive of previous traffic |
| 49 | on the mailing list - please search the archive before asking FAQ's. |
Naoki Hayama | 6681bbb | 2020-10-08 13:16:18 +0900 | [diff] [blame] | 50 | Please see https://lists.denx.de/pipermail/u-boot and |
| 51 | https://marc.info/?l=u-boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 52 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 53 | Where to get source code: |
| 54 | ========================= |
| 55 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 56 | The U-Boot source code is maintained in the Git repository at |
Heinrich Schuchardt | a3bbd0b | 2021-02-24 13:19:04 +0100 | [diff] [blame] | 57 | https://source.denx.de/u-boot/u-boot.git ; you can browse it online at |
| 58 | https://source.denx.de/u-boot/u-boot |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 59 | |
Naoki Hayama | c4bd51e | 2020-10-08 13:16:25 +0900 | [diff] [blame] | 60 | The "Tags" links on this page allow you to download tarballs of |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 61 | any version you might be interested in. Official releases are also |
Naoki Hayama | c4bd51e | 2020-10-08 13:16:25 +0900 | [diff] [blame] | 62 | available from the DENX file server through HTTPS or FTP. |
| 63 | https://ftp.denx.de/pub/u-boot/ |
| 64 | ftp://ftp.denx.de/pub/u-boot/ |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 65 | |
| 66 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 67 | Where we come from: |
| 68 | =================== |
| 69 | |
| 70 | - start from 8xxrom sources |
Naoki Hayama | 047f6ec | 2020-10-08 13:17:16 +0900 | [diff] [blame] | 71 | - create PPCBoot project (https://sourceforge.net/projects/ppcboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 72 | - clean up code |
| 73 | - make it easier to add custom boards |
| 74 | - make it possible to add other [PowerPC] CPUs |
| 75 | - extend functions, especially: |
| 76 | * Provide extended interface to Linux boot loader |
| 77 | * S-Record download |
| 78 | * network boot |
Simon Glass | 9e5616d | 2019-08-01 09:47:14 -0600 | [diff] [blame] | 79 | * ATA disk / SCSI ... boot |
Naoki Hayama | 047f6ec | 2020-10-08 13:17:16 +0900 | [diff] [blame] | 80 | - create ARMBoot project (https://sourceforge.net/projects/armboot) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 81 | - add other CPU families (starting with ARM) |
Naoki Hayama | 047f6ec | 2020-10-08 13:17:16 +0900 | [diff] [blame] | 82 | - create U-Boot project (https://sourceforge.net/projects/u-boot) |
| 83 | - current project page: see https://www.denx.de/wiki/U-Boot |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 84 | |
| 85 | |
| 86 | Names and Spelling: |
| 87 | =================== |
| 88 | |
| 89 | The "official" name of this project is "Das U-Boot". The spelling |
| 90 | "U-Boot" shall be used in all written text (documentation, comments |
| 91 | in source files etc.). Example: |
| 92 | |
| 93 | This is the README file for the U-Boot project. |
| 94 | |
| 95 | File names etc. shall be based on the string "u-boot". Examples: |
| 96 | |
| 97 | include/asm-ppc/u-boot.h |
| 98 | |
| 99 | #include <asm/u-boot.h> |
| 100 | |
| 101 | Variable names, preprocessor constants etc. shall be either based on |
| 102 | the string "u_boot" or on "U_BOOT". Example: |
| 103 | |
| 104 | U_BOOT_VERSION u_boot_logo |
| 105 | IH_OS_U_BOOT u_boot_hush_start |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 106 | |
| 107 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 108 | Software Configuration: |
| 109 | ======================= |
| 110 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 111 | Selection of Processor Architecture and Board Type: |
| 112 | --------------------------------------------------- |
| 113 | |
| 114 | For all supported boards there are ready-to-use default |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 115 | configurations available; just type "make <board_name>_defconfig". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 116 | |
| 117 | Example: For a TQM823L module type: |
| 118 | |
| 119 | cd u-boot |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 120 | make TQM823L_defconfig |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 121 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 122 | Note: If you're looking for the default configuration file for a board |
| 123 | you're sure used to be there but is now missing, check the file |
| 124 | doc/README.scrapyard for a list of no longer supported boards. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 125 | |
Simon Glass | 75b3c3a | 2014-03-22 17:12:59 -0600 | [diff] [blame] | 126 | Sandbox Environment: |
| 127 | -------------------- |
| 128 | |
| 129 | U-Boot can be built natively to run on a Linux host using the 'sandbox' |
| 130 | board. This allows feature development which is not board- or architecture- |
| 131 | specific to be undertaken on a native platform. The sandbox is also used to |
| 132 | run some of U-Boot's tests. |
| 133 | |
Heinrich Schuchardt | cf69dc7 | 2023-01-25 19:14:56 +0100 | [diff] [blame] | 134 | See doc/arch/sandbox/sandbox.rst for more details. |
Simon Glass | 75b3c3a | 2014-03-22 17:12:59 -0600 | [diff] [blame] | 135 | |
| 136 | |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 137 | Board Initialisation Flow: |
| 138 | -------------------------- |
| 139 | |
| 140 | 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] | 141 | 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] | 142 | |
Robert P. J. Day | 7207b36 | 2015-12-19 07:16:10 -0500 | [diff] [blame] | 143 | Note: "SPL" stands for "Secondary Program Loader," which is explained in |
| 144 | more detail later in this file. |
| 145 | |
| 146 | At present, SPL mostly uses a separate code path, but the function names |
| 147 | and roles of each function are the same. Some boards or architectures |
| 148 | may not conform to this. At least most ARM boards which use |
| 149 | CONFIG_SPL_FRAMEWORK conform to this. |
| 150 | |
| 151 | Execution typically starts with an architecture-specific (and possibly |
| 152 | CPU-specific) start.S file, such as: |
| 153 | |
| 154 | - arch/arm/cpu/armv7/start.S |
| 155 | - arch/powerpc/cpu/mpc83xx/start.S |
| 156 | - arch/mips/cpu/start.S |
| 157 | |
| 158 | and so on. From there, three functions are called; the purpose and |
| 159 | limitations of each of these functions are described below. |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 160 | |
| 161 | lowlevel_init(): |
| 162 | - purpose: essential init to permit execution to reach board_init_f() |
| 163 | - no global_data or BSS |
| 164 | - there is no stack (ARMv7 may have one but it will soon be removed) |
| 165 | - must not set up SDRAM or use console |
| 166 | - must only do the bare minimum to allow execution to continue to |
| 167 | board_init_f() |
| 168 | - this is almost never needed |
| 169 | - return normally from this function |
| 170 | |
| 171 | board_init_f(): |
| 172 | - purpose: set up the machine ready for running board_init_r(): |
| 173 | i.e. SDRAM and serial UART |
| 174 | - global_data is available |
| 175 | - stack is in SRAM |
| 176 | - BSS is not available, so you cannot use global/static variables, |
| 177 | only stack variables and global_data |
| 178 | |
| 179 | Non-SPL-specific notes: |
| 180 | - dram_init() is called to set up DRAM. If already done in SPL this |
| 181 | can do nothing |
| 182 | |
| 183 | SPL-specific notes: |
| 184 | - you can override the entire board_init_f() function with your own |
| 185 | version as needed. |
| 186 | - preloader_console_init() can be called here in extremis |
| 187 | - should set up SDRAM, and anything needed to make the UART work |
Naoki Hayama | 499696e | 2020-09-24 15:57:19 +0900 | [diff] [blame] | 188 | - there is no need to clear BSS, it will be done by crt0.S |
Andreas Dannenberg | 1425465 | 2019-08-08 12:54:49 -0500 | [diff] [blame] | 189 | - for specific scenarios on certain architectures an early BSS *can* |
| 190 | be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing |
| 191 | of BSS prior to entering board_init_f()) but doing so is discouraged. |
| 192 | Instead it is strongly recommended to architect any code changes |
| 193 | or additions such to not depend on the availability of BSS during |
| 194 | board_init_f() as indicated in other sections of this README to |
| 195 | maintain compatibility and consistency across the entire code base. |
Simon Glass | db91035 | 2015-03-03 08:03:00 -0700 | [diff] [blame] | 196 | - must return normally from this function (don't call board_init_r() |
| 197 | directly) |
| 198 | |
| 199 | Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at |
| 200 | this point the stack and global_data are relocated to below |
| 201 | CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of |
| 202 | memory. |
| 203 | |
| 204 | board_init_r(): |
| 205 | - purpose: main execution, common code |
| 206 | - global_data is available |
| 207 | - SDRAM is available |
| 208 | - BSS is available, all static/global variables can be used |
| 209 | - execution eventually continues to main_loop() |
| 210 | |
| 211 | Non-SPL-specific notes: |
| 212 | - U-Boot is relocated to the top of memory and is now running from |
| 213 | there. |
| 214 | |
| 215 | SPL-specific notes: |
| 216 | - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and |
Ashish Kumar | 63b2316 | 2017-08-11 11:09:14 +0530 | [diff] [blame] | 217 | CONFIG_SYS_FSL_HAS_CCI400 |
| 218 | |
| 219 | Defined For SoC that has cache coherent interconnect |
| 220 | CCN-400 |
wdenk | 7f6c2cb | 2002-11-10 22:06:23 +0000 | [diff] [blame] | 221 | |
Ashish Kumar | c055cee | 2017-08-18 10:54:36 +0530 | [diff] [blame] | 222 | CONFIG_SYS_FSL_HAS_CCN504 |
| 223 | |
| 224 | Defined for SoC that has cache coherent interconnect CCN-504 |
| 225 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 226 | The following options need to be configured: |
| 227 | |
Kim Phillips | 2628114 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 228 | - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 229 | |
Kim Phillips | 2628114 | 2007-08-10 13:28:25 -0500 | [diff] [blame] | 230 | - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. |
Wolfgang Denk | 6ccec44 | 2006-10-24 14:42:37 +0200 | [diff] [blame] | 231 | |
Kumar Gala | 66412c6 | 2011-02-18 05:40:54 -0600 | [diff] [blame] | 232 | - 85xx CPU Options: |
York Sun | ffd06e0 | 2012-10-08 07:44:30 +0000 | [diff] [blame] | 233 | CONFIG_SYS_PPC64 |
| 234 | |
| 235 | Specifies that the core is a 64-bit PowerPC implementation (implements |
| 236 | the "64" category of the Power ISA). This is necessary for ePAPR |
| 237 | compliance, among other possible reasons. |
| 238 | |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 239 | CONFIG_SYS_FSL_ERRATUM_A004510 |
| 240 | |
| 241 | Enables a workaround for erratum A004510. If set, |
| 242 | then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and |
Tom Rini | 6cc0454 | 2022-10-28 20:27:13 -0400 | [diff] [blame] | 243 | CFG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 244 | |
| 245 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV |
| 246 | CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) |
| 247 | |
| 248 | Defines one or two SoC revisions (low 8 bits of SVR) |
| 249 | for which the A004510 workaround should be applied. |
| 250 | |
| 251 | The rest of SVR is either not relevant to the decision |
| 252 | of whether the erratum is present (e.g. p2040 versus |
| 253 | p2041) or is implied by the build target, which controls |
| 254 | whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. |
| 255 | |
| 256 | See Freescale App Note 4493 for more information about |
| 257 | this erratum. |
| 258 | |
Tom Rini | 6cc0454 | 2022-10-28 20:27:13 -0400 | [diff] [blame] | 259 | CFG_SYS_FSL_CORENET_SNOOPVEC_COREONLY |
Scott Wood | 33eee33 | 2012-08-14 10:14:53 +0000 | [diff] [blame] | 260 | |
| 261 | This is the value to write into CCSR offset 0x18600 |
| 262 | according to the A004510 workaround. |
| 263 | |
Priyanka Jain | b135991 | 2013-12-17 14:25:52 +0530 | [diff] [blame] | 264 | CONFIG_SYS_FSL_SINGLE_SOURCE_CLK |
| 265 | Single Source Clock is clocking mode present in some of FSL SoC's. |
| 266 | In this mode, a single differential clock is used to supply |
| 267 | clocks to the sysclock, ddrclock and usbclock. |
| 268 | |
Daniel Schwierzeck | 6cb461b | 2012-04-02 02:57:56 +0000 | [diff] [blame] | 269 | - Generic CPU options: |
Daniel Schwierzeck | 6cb461b | 2012-04-02 02:57:56 +0000 | [diff] [blame] | 270 | |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 271 | CONFIG_SYS_FSL_DDR |
| 272 | Freescale DDR driver in use. This type of DDR controller is |
Tom Rini | 1c58857 | 2021-05-14 21:34:26 -0400 | [diff] [blame] | 273 | found in mpc83xx, mpc85xx as well as some ARM core SoCs. |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 274 | |
Tom Rini | 6cc0454 | 2022-10-28 20:27:13 -0400 | [diff] [blame] | 275 | CFG_SYS_FSL_DDR_ADDR |
York Sun | 5614e71 | 2013-09-30 09:22:09 -0700 | [diff] [blame] | 276 | Freescale DDR memory-mapped register base. |
| 277 | |
Prabhakar Kushwaha | 1c40707 | 2017-02-02 15:01:26 +0530 | [diff] [blame] | 278 | CONFIG_SYS_FSL_IFC_CLK_DIV |
| 279 | Defines divider of platform clock(clock input to IFC controller). |
| 280 | |
Prabhakar Kushwaha | add63f9 | 2017-02-02 15:02:00 +0530 | [diff] [blame] | 281 | CONFIG_SYS_FSL_LBC_CLK_DIV |
| 282 | Defines divider of platform clock(clock input to eLBC controller). |
| 283 | |
Tom Rini | 6cc0454 | 2022-10-28 20:27:13 -0400 | [diff] [blame] | 284 | CFG_SYS_FSL_DDR_SDRAM_BASE_PHY |
York Sun | 6b9e309 | 2014-02-10 13:59:43 -0800 | [diff] [blame] | 285 | Physical address from the view of DDR controllers. It is the |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 286 | same as CFG_SYS_DDR_SDRAM_BASE for all Power SoCs. But |
York Sun | 6b9e309 | 2014-02-10 13:59:43 -0800 | [diff] [blame] | 287 | it could be different for ARM SoCs. |
| 288 | |
Daniel Schwierzeck | 92bbd64 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 289 | - MIPS CPU options: |
Daniel Schwierzeck | 92bbd64 | 2011-07-27 13:22:39 +0200 | [diff] [blame] | 290 | CONFIG_XWAY_SWAP_BYTES |
| 291 | |
| 292 | Enable compilation of tools/xway-swap-bytes needed for Lantiq |
| 293 | XWAY SoCs for booting from NOR flash. The U-Boot image needs to |
| 294 | be swapped if a flash programmer is used. |
| 295 | |
Christian Riesch | b67d881 | 2012-02-02 00:44:39 +0000 | [diff] [blame] | 296 | - ARM options: |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 297 | CFG_SYS_EXCEPTION_VECTORS_HIGH |
Christian Riesch | b67d881 | 2012-02-02 00:44:39 +0000 | [diff] [blame] | 298 | |
| 299 | Select high exception vectors of the ARM core, e.g., do not |
| 300 | clear the V bit of the c1 register of CP15. |
| 301 | |
York Sun | 207774b | 2015-03-20 19:28:08 -0700 | [diff] [blame] | 302 | COUNTER_FREQUENCY |
| 303 | Generic timer clock source frequency. |
| 304 | |
| 305 | COUNTER_FREQUENCY_REAL |
| 306 | Generic timer clock source frequency if the real clock is |
| 307 | different from COUNTER_FREQUENCY, and can only be determined |
| 308 | at run time. |
| 309 | |
Stephen Warren | 73c3893 | 2015-01-19 16:25:52 -0700 | [diff] [blame] | 310 | - Tegra SoC options: |
| 311 | CONFIG_TEGRA_SUPPORT_NON_SECURE |
| 312 | |
| 313 | Support executing U-Boot in non-secure (NS) mode. Certain |
| 314 | impossible actions will be skipped if the CPU is in NS mode, |
| 315 | such as ARM architectural timer initialization. |
| 316 | |
wdenk | 5da627a | 2003-10-09 20:09:04 +0000 | [diff] [blame] | 317 | - Linux Kernel Interface: |
Gerald Van Baren | fec6d9e | 2008-06-03 20:34:45 -0400 | [diff] [blame] | 318 | CONFIG_OF_LIBFDT |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 319 | |
| 320 | New kernel versions are expecting firmware settings to be |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 321 | passed using flattened device trees (based on open firmware |
| 322 | concepts). |
| 323 | |
| 324 | CONFIG_OF_LIBFDT |
| 325 | * New libfdt-based support |
| 326 | * Adds the "fdt" command |
Kim Phillips | 3bb342f | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 327 | * The bootm command automatically updates the fdt |
Gerald Van Baren | 213bf8c | 2007-03-31 12:23:51 -0400 | [diff] [blame] | 328 | |
Wolfgang Denk | f57f70a | 2005-10-13 01:45:54 +0200 | [diff] [blame] | 329 | OF_TBCLK - The timebase frequency. |
| 330 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 331 | boards with QUICC Engines require OF_QE to set UCC MAC |
| 332 | addresses |
Kim Phillips | 3bb342f | 2007-08-10 14:34:14 -0500 | [diff] [blame] | 333 | |
Heiko Schocher | 3887c3f | 2009-09-23 07:56:08 +0200 | [diff] [blame] | 334 | CONFIG_OF_IDE_FIXUP |
| 335 | |
| 336 | U-Boot can detect if an IDE device is present or not. |
| 337 | If not, and this new config option is activated, U-Boot |
| 338 | removes the ATA node from the DTS before booting Linux, |
| 339 | so the Linux IDE driver does not probe the device and |
| 340 | crash. This is needed for buggy hardware (uc101) where |
| 341 | no pull down resistor is connected to the signal IDE5V_DD7. |
| 342 | |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 343 | - vxWorks boot parameters: |
| 344 | |
| 345 | bootvx constructs a valid bootline using the following |
Bin Meng | 9e98b7e | 2015-10-07 20:19:17 -0700 | [diff] [blame] | 346 | environments variables: bootdev, bootfile, ipaddr, netmask, |
| 347 | serverip, gatewayip, hostname, othbootargs. |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 348 | It loads the vxWorks image pointed bootfile. |
| 349 | |
Naoki Hayama | 81a05d9 | 2020-10-08 13:17:08 +0900 | [diff] [blame] | 350 | Note: If a "bootargs" environment is defined, it will override |
Niklaus Giger | 0b2f4ec | 2008-11-03 22:13:47 +0100 | [diff] [blame] | 351 | the defaults discussed just above. |
| 352 | |
Aneesh V | 93bc219 | 2011-06-16 23:30:51 +0000 | [diff] [blame] | 353 | - Cache Configuration for ARM: |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 354 | CFG_SYS_PL310_BASE - Physical base address of PL310 |
Aneesh V | 93bc219 | 2011-06-16 23:30:51 +0000 | [diff] [blame] | 355 | controller register space |
| 356 | |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 357 | - Serial Ports: |
Tom Rini | f410d0a | 2022-12-04 10:13:30 -0500 | [diff] [blame] | 358 | CFG_PL011_CLOCK |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 359 | |
| 360 | If you have Amba PrimeCell PL011 UARTs, set this variable to |
| 361 | the clock speed of the UARTs. |
| 362 | |
Tom Rini | b861574 | 2022-12-04 10:13:31 -0500 | [diff] [blame] | 363 | CFG_PL01x_PORTS |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 364 | |
| 365 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, |
| 366 | define this to a list of base addresses for each (supported) |
| 367 | port. See e.g. include/configs/versatile.h |
| 368 | |
Karicheri, Muralidharan | d57dee5 | 2014-04-09 15:38:46 -0400 | [diff] [blame] | 369 | CONFIG_SERIAL_HW_FLOW_CONTROL |
| 370 | |
| 371 | Define this variable to enable hw flow control in serial driver. |
| 372 | Current user of this option is drivers/serial/nsl16550.c driver |
wdenk | 6705d81 | 2004-08-02 23:22:59 +0000 | [diff] [blame] | 373 | |
Simon Glass | 302a648 | 2016-03-13 19:07:28 -0600 | [diff] [blame] | 374 | - Removal of commands |
| 375 | If no commands are needed to boot, you can disable |
| 376 | CONFIG_CMDLINE to remove them. In this case, the command line |
| 377 | will not be available, and when U-Boot wants to execute the |
| 378 | boot command (on start-up) it will call board_run_command() |
| 379 | instead. This can reduce image size significantly for very |
| 380 | simple boot procedures. |
| 381 | |
Wolfgang Denk | a5ecbe6 | 2013-03-23 23:50:31 +0000 | [diff] [blame] | 382 | - Regular expression support: |
| 383 | CONFIG_REGEX |
Wolfgang Denk | 93e1459 | 2013-10-04 17:43:24 +0200 | [diff] [blame] | 384 | If this variable is defined, U-Boot is linked against |
| 385 | the SLRE (Super Light Regular Expression) library, |
| 386 | which adds regex support to some commands, as for |
| 387 | example "env grep" and "setexpr". |
Wolfgang Denk | a5ecbe6 | 2013-03-23 23:50:31 +0000 | [diff] [blame] | 388 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 389 | - Watchdog: |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 390 | CFG_SYS_WATCHDOG_FREQ |
Rasmus Villemoes | 933ada5 | 2021-04-14 09:18:22 +0200 | [diff] [blame] | 391 | Some platforms automatically call WATCHDOG_RESET() |
| 392 | from the timer interrupt handler every |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 393 | CFG_SYS_WATCHDOG_FREQ interrupts. If not set by the |
Rasmus Villemoes | 933ada5 | 2021-04-14 09:18:22 +0200 | [diff] [blame] | 394 | board configuration file, a default of CONFIG_SYS_HZ/2 |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 395 | (i.e. 500) is used. Setting CFG_SYS_WATCHDOG_FREQ |
Rasmus Villemoes | 933ada5 | 2021-04-14 09:18:22 +0200 | [diff] [blame] | 396 | to 0 disables calling WATCHDOG_RESET() from the timer |
| 397 | interrupt. |
| 398 | |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 399 | - GPIO Support: |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 400 | The CFG_SYS_I2C_PCA953X_WIDTH option specifies a list of |
Chris Packham | 5dec49c | 2010-12-19 10:12:13 +0000 | [diff] [blame] | 401 | chip-ngpio pairs that tell the PCA953X driver the number of |
| 402 | pins supported by a particular chip. |
| 403 | |
Peter Tyser | e92739d | 2008-12-17 16:36:21 -0600 | [diff] [blame] | 404 | Note that if the GPIO device uses I2C, then the I2C interface |
| 405 | must also be configured. See I2C Support, below. |
| 406 | |
Simon Glass | aa53233 | 2014-06-11 23:29:41 -0600 | [diff] [blame] | 407 | - I/O tracing: |
| 408 | When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O |
| 409 | accesses and can checksum them or write a list of them out |
| 410 | to memory. See the 'iotrace' command for details. This is |
| 411 | useful for testing device drivers since it can confirm that |
| 412 | the driver behaves the same way before and after a code |
| 413 | change. Currently this is supported on sandbox and arm. To |
| 414 | add support for your architecture, add '#include <iotrace.h>' |
| 415 | to the bottom of arch/<arch>/include/asm/io.h and test. |
| 416 | |
| 417 | Example output from the 'iotrace stats' command is below. |
| 418 | Note that if the trace buffer is exhausted, the checksum will |
| 419 | still continue to operate. |
| 420 | |
| 421 | iotrace is enabled |
| 422 | Start: 10000000 (buffer start address) |
| 423 | Size: 00010000 (buffer size) |
| 424 | Offset: 00000120 (current buffer offset) |
| 425 | Output: 10000120 (start + offset) |
| 426 | Count: 00000018 (number of trace records) |
| 427 | CRC32: 9526fb66 (CRC32 of all trace records) |
| 428 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 429 | - Timestamp Support: |
| 430 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 431 | When CONFIG_TIMESTAMP is selected, the timestamp |
| 432 | (date and time) of an image is printed by image |
| 433 | commands like bootm or iminfo. This option is |
Jon Loeliger | 602ad3b | 2007-06-11 19:03:39 -0500 | [diff] [blame] | 434 | automatically enabled when you select CONFIG_CMD_DATE . |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 435 | |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 436 | - Partition Labels (disklabels) Supported: |
| 437 | Zero or more of the following: |
| 438 | CONFIG_MAC_PARTITION Apple's MacOS partition table. |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 439 | CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. |
| 440 | CONFIG_EFI_PARTITION GPT partition table, common when EFI is the |
| 441 | bootloader. Note 2TB partition limit; see |
| 442 | disk/part_efi.c |
Simon Glass | c649e3c | 2016-05-01 11:36:02 -0600 | [diff] [blame] | 443 | CONFIG_SCSI) you must configure support for at |
Karl O. Pinc | 923c46f | 2012-08-16 06:20:15 +0000 | [diff] [blame] | 444 | least one non-MTD partition type as well. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 445 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 446 | - NETWORK Support (PCI): |
Kyle Moffett | ce5207e | 2011-10-18 11:05:29 +0000 | [diff] [blame] | 447 | CONFIG_E1000_SPI |
| 448 | Utility code for direct access to the SPI bus on Intel 8257x. |
| 449 | This does not do anything useful unless you set at least one |
| 450 | of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. |
| 451 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 452 | CONFIG_NATSEMI |
| 453 | Support for National dp83815 chips. |
| 454 | |
| 455 | CONFIG_NS8382X |
| 456 | Support for National dp8382[01] gigabit chips. |
| 457 | |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 458 | - NETWORK Support (other): |
Rob Herring | efdd731 | 2011-12-15 11:15:49 +0000 | [diff] [blame] | 459 | CONFIG_CALXEDA_XGMAC |
| 460 | Support for the Calxeda XGMAC device |
| 461 | |
Ashok | 3bb46d2 | 2012-10-15 06:20:47 +0000 | [diff] [blame] | 462 | CONFIG_LAN91C96 |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 463 | Support for SMSC's LAN91C96 chips. |
| 464 | |
wdenk | 45219c4 | 2003-05-12 21:50:16 +0000 | [diff] [blame] | 465 | CONFIG_LAN91C96_USE_32_BIT |
| 466 | Define this to enable 32 bit addressing |
| 467 | |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 468 | CFG_SYS_DAVINCI_EMAC_PHY_COUNT |
Heiko Schocher | dc02bad | 2011-11-15 10:00:04 -0500 | [diff] [blame] | 469 | Define this if you have more then 3 PHYs. |
| 470 | |
Macpaul Lin | b3dbf4a5 | 2010-12-21 16:59:46 +0800 | [diff] [blame] | 471 | CONFIG_FTGMAC100 |
| 472 | Support for Faraday's FTGMAC100 Gigabit SoC Ethernet |
| 473 | |
| 474 | CONFIG_FTGMAC100_EGIGA |
| 475 | Define this to use GE link update with gigabit PHY. |
| 476 | Define this if FTGMAC100 is connected to gigabit PHY. |
| 477 | If your system has 10/100 PHY only, it might not occur |
| 478 | wrong behavior. Because PHY usually return timeout or |
| 479 | useless data when polling gigabit status and gigabit |
| 480 | control registers. This behavior won't affect the |
| 481 | correctnessof 10/100 link speed update. |
| 482 | |
Yoshihiro Shimoda | 3d0075f | 2011-01-27 10:06:03 +0900 | [diff] [blame] | 483 | CONFIG_SH_ETHER |
| 484 | Support for Renesas on-chip Ethernet controller |
| 485 | |
Tom Rini | 97148cb | 2022-12-04 10:13:52 -0500 | [diff] [blame] | 486 | CFG_SH_ETHER_USE_PORT |
Yoshihiro Shimoda | 3d0075f | 2011-01-27 10:06:03 +0900 | [diff] [blame] | 487 | Define the number of ports to be used |
| 488 | |
Tom Rini | 7c480ba | 2022-12-04 10:13:50 -0500 | [diff] [blame] | 489 | CFG_SH_ETHER_PHY_ADDR |
Yoshihiro Shimoda | 3d0075f | 2011-01-27 10:06:03 +0900 | [diff] [blame] | 490 | Define the ETH PHY's address |
| 491 | |
Tom Rini | ff53ecc | 2022-12-04 10:13:49 -0500 | [diff] [blame] | 492 | CFG_SH_ETHER_CACHE_WRITEBACK |
Yoshihiro Shimoda | 68260aa | 2011-01-27 10:06:08 +0900 | [diff] [blame] | 493 | If this option is set, the driver enables cache flush. |
| 494 | |
Vadim Bendebury | 5e12472 | 2011-10-17 08:36:14 +0000 | [diff] [blame] | 495 | - TPM Support: |
Che-liang Chiou | 90899cc | 2013-04-12 11:04:34 +0000 | [diff] [blame] | 496 | CONFIG_TPM |
| 497 | Support TPM devices. |
| 498 | |
Christophe Ricard | 0766ad2 | 2015-10-06 22:54:41 +0200 | [diff] [blame] | 499 | CONFIG_TPM_TIS_INFINEON |
| 500 | Support for Infineon i2c bus TPM devices. Only one device |
Tom Wai-Hong Tam | 1b393db | 2013-04-12 11:04:37 +0000 | [diff] [blame] | 501 | per system is supported at this time. |
| 502 | |
Tom Wai-Hong Tam | 1b393db | 2013-04-12 11:04:37 +0000 | [diff] [blame] | 503 | CONFIG_TPM_TIS_I2C_BURST_LIMITATION |
| 504 | Define the burst count bytes upper limit |
| 505 | |
Christophe Ricard | 3aa7408 | 2016-01-21 23:27:13 +0100 | [diff] [blame] | 506 | CONFIG_TPM_ST33ZP24 |
| 507 | Support for STMicroelectronics TPM devices. Requires DM_TPM support. |
| 508 | |
| 509 | CONFIG_TPM_ST33ZP24_I2C |
| 510 | Support for STMicroelectronics ST33ZP24 I2C devices. |
| 511 | Requires TPM_ST33ZP24 and I2C. |
| 512 | |
Christophe Ricard | b75fdc1 | 2016-01-21 23:27:14 +0100 | [diff] [blame] | 513 | CONFIG_TPM_ST33ZP24_SPI |
| 514 | Support for STMicroelectronics ST33ZP24 SPI devices. |
| 515 | Requires TPM_ST33ZP24 and SPI. |
| 516 | |
Dirk Eibach | c01939c | 2013-06-26 15:55:15 +0200 | [diff] [blame] | 517 | CONFIG_TPM_ATMEL_TWI |
| 518 | Support for Atmel TWI TPM device. Requires I2C support. |
| 519 | |
Che-liang Chiou | 90899cc | 2013-04-12 11:04:34 +0000 | [diff] [blame] | 520 | CONFIG_TPM_TIS_LPC |
Vadim Bendebury | 5e12472 | 2011-10-17 08:36:14 +0000 | [diff] [blame] | 521 | Support for generic parallel port TPM devices. Only one device |
| 522 | per system is supported at this time. |
| 523 | |
Reinhard Pfau | be6c152 | 2013-06-26 15:55:13 +0200 | [diff] [blame] | 524 | CONFIG_TPM |
| 525 | Define this to enable the TPM support library which provides |
| 526 | functional interfaces to some TPM commands. |
| 527 | Requires support for a TPM device. |
| 528 | |
| 529 | CONFIG_TPM_AUTH_SESSIONS |
| 530 | Define this to enable authorized functions in the TPM library. |
| 531 | Requires CONFIG_TPM and CONFIG_SHA1. |
| 532 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 533 | - USB Support: |
| 534 | At the moment only the UHCI host controller is |
Heiko Schocher | 064b55c | 2017-06-14 05:49:40 +0200 | [diff] [blame] | 535 | supported (PIP405, MIP405); define |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 536 | CONFIG_USB_UHCI to enable it. |
| 537 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard |
wdenk | 30d56fa | 2004-10-09 22:44:59 +0000 | [diff] [blame] | 538 | and define CONFIG_USB_STORAGE to enable the USB |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 539 | storage devices. |
| 540 | Note: |
| 541 | Supported are USB Keyboards and USB Floppy drives |
| 542 | (TEAC FD-05PUB). |
wdenk | 4d13cba | 2004-03-14 14:09:05 +0000 | [diff] [blame] | 543 | |
Oleksandr Tymoshenko | 6e9e062 | 2014-02-01 21:51:25 -0700 | [diff] [blame] | 544 | CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 |
| 545 | HW module registers. |
| 546 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 547 | - USB Device: |
| 548 | Define the below if you wish to use the USB console. |
| 549 | Once firmware is rebuilt from a serial console issue the |
| 550 | command "setenv stdin usbtty; setenv stdout usbtty" and |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 551 | attach your USB cable. The Unix command "dmesg" should print |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 552 | it has found a new device. The environment variable usbtty |
| 553 | 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] | 554 | appear to a USB host as a Linux gserial device or a |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 555 | Common Device Class Abstract Control Model serial device. |
| 556 | If you select usbtty = gserial you should be able to enumerate |
| 557 | a Linux host by |
| 558 | # modprobe usbserial vendor=0xVendorID product=0xProductID |
| 559 | else if using cdc_acm, simply setting the environment |
| 560 | variable usbtty to be cdc_acm should suffice. The following |
| 561 | might be defined in YourBoardName.h |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 562 | |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 563 | 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] | 564 | define your own vendor specific values either in BoardName.h |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 565 | or directly in usbd_vendor_info.h. If you don't define |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 566 | CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, |
| 567 | CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot |
| 568 | should pretend to be a Linux device to it's target host. |
| 569 | |
| 570 | CONFIG_USBD_MANUFACTURER |
| 571 | Define this string as the name of your company for |
| 572 | - CONFIG_USBD_MANUFACTURER "my company" |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 573 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 574 | CONFIG_USBD_PRODUCT_NAME |
| 575 | Define this string as the name of your product |
| 576 | - CONFIG_USBD_PRODUCT_NAME "acme usb device" |
| 577 | |
| 578 | CONFIG_USBD_VENDORID |
| 579 | Define this as your assigned Vendor ID from the USB |
| 580 | Implementors Forum. This *must* be a genuine Vendor ID |
| 581 | to avoid polluting the USB namespace. |
| 582 | - CONFIG_USBD_VENDORID 0xFFFF |
Wolfgang Denk | 386eda0 | 2006-06-14 18:14:56 +0200 | [diff] [blame] | 583 | |
Wolfgang Denk | 16c8d5e | 2006-06-14 17:45:53 +0200 | [diff] [blame] | 584 | CONFIG_USBD_PRODUCTID |
| 585 | Define this as the unique Product ID |
| 586 | for your device |
| 587 | - CONFIG_USBD_PRODUCTID 0xFFFF |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 588 | |
Igor Grinberg | d70a560 | 2011-12-12 12:08:35 +0200 | [diff] [blame] | 589 | - ULPI Layer Support: |
| 590 | The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via |
| 591 | the generic ULPI layer. The generic layer accesses the ULPI PHY |
| 592 | via the platform viewport, so you need both the genric layer and |
| 593 | the viewport enabled. Currently only Chipidea/ARC based |
| 594 | viewport is supported. |
| 595 | To enable the ULPI layer support, define CONFIG_USB_ULPI and |
| 596 | CONFIG_USB_ULPI_VIEWPORT in your board configuration file. |
Lucas Stach | 6d365ea | 2012-10-01 00:44:35 +0200 | [diff] [blame] | 597 | If your ULPI phy needs a different reference clock than the |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 598 | standard 24 MHz then you have to define CFG_ULPI_REF_CLK to |
Lucas Stach | 6d365ea | 2012-10-01 00:44:35 +0200 | [diff] [blame] | 599 | the appropriate value in Hz. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 600 | |
| 601 | - MMC Support: |
Yoshihiro Shimoda | afb3566 | 2011-07-04 22:21:22 +0000 | [diff] [blame] | 602 | CONFIG_SH_MMCIF |
| 603 | Support for Renesas on-chip MMCIF controller |
| 604 | |
| 605 | CONFIG_SH_MMCIF_ADDR |
| 606 | Define the base address of MMCIF registers |
| 607 | |
| 608 | CONFIG_SH_MMCIF_CLK |
| 609 | Define the clock frequency for MMCIF |
| 610 | |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 611 | - USB Device Firmware Update (DFU) class support: |
Marek Vasut | bb4059a | 2018-02-16 16:41:18 +0100 | [diff] [blame] | 612 | CONFIG_DFU_OVER_USB |
Tom Rini | b3ba6e9 | 2013-03-14 05:32:47 +0000 | [diff] [blame] | 613 | This enables the USB portion of the DFU USB class |
| 614 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 615 | CONFIG_DFU_NAND |
| 616 | This enables support for exposing NAND devices via DFU. |
| 617 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 618 | CONFIG_DFU_RAM |
| 619 | This enables support for exposing RAM via DFU. |
| 620 | Note: DFU spec refer to non-volatile memory usage, but |
| 621 | allow usages beyond the scope of spec - here RAM usage, |
| 622 | one that would help mostly the developer. |
| 623 | |
Heiko Schocher | e7e75c7 | 2013-06-12 06:05:51 +0200 | [diff] [blame] | 624 | CONFIG_SYS_DFU_DATA_BUF_SIZE |
| 625 | Dfu transfer uses a buffer before writing data to the |
| 626 | raw storage device. Make the size (in bytes) of this buffer |
| 627 | configurable. The size of this buffer is also configurable |
| 628 | through the "dfu_bufsiz" environment variable. |
| 629 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 630 | CONFIG_SYS_DFU_MAX_FILE_SIZE |
| 631 | When updating files rather than the raw storage device, |
| 632 | we use a static buffer to copy the file into and then write |
| 633 | the buffer once we've been given the whole file. Define |
| 634 | this to the maximum filesize (in bytes) for the buffer. |
| 635 | Default is 4 MiB if undefined. |
| 636 | |
Heiko Schocher | 001a831 | 2014-03-18 08:09:56 +0100 | [diff] [blame] | 637 | DFU_DEFAULT_POLL_TIMEOUT |
| 638 | Poll timeout [ms], is the timeout a device can send to the |
| 639 | host. The host must wait for this timeout before sending |
| 640 | a subsequent DFU_GET_STATUS request to the device. |
| 641 | |
| 642 | DFU_MANIFEST_POLL_TIMEOUT |
| 643 | Poll timeout [ms], which the device sends to the host when |
| 644 | entering dfuMANIFEST state. Host waits this timeout, before |
| 645 | sending again an USB request to the device. |
| 646 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 647 | - Keyboard Support: |
Simon Glass | 39f615e | 2015-11-11 10:05:47 -0700 | [diff] [blame] | 648 | See Kconfig help for available keyboard drivers. |
| 649 | |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 650 | - MII/PHY support: |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 651 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) |
| 652 | |
| 653 | The clock frequency of the MII bus |
| 654 | |
wdenk | 17ea117 | 2004-06-06 21:51:03 +0000 | [diff] [blame] | 655 | CONFIG_PHY_CMD_DELAY (ppc4xx) |
| 656 | |
| 657 | Some PHY like Intel LXT971A need extra delay after |
| 658 | command issued before MII status register can be read |
| 659 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 660 | - BOOTP Recovery Mode: |
| 661 | CONFIG_BOOTP_RANDOM_DELAY |
| 662 | |
| 663 | If you have many targets in a network that try to |
| 664 | boot using BOOTP, you may want to avoid that all |
| 665 | systems send out BOOTP requests at precisely the same |
| 666 | moment (which would happen for instance at recovery |
| 667 | from a power failure, when all systems will try to |
| 668 | boot, thus flooding the BOOTP server. Defining |
| 669 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be |
| 670 | inserted before sending out BOOTP requests. The |
Wolfgang Denk | 6c33c78 | 2007-08-06 23:21:05 +0200 | [diff] [blame] | 671 | following delays are inserted then: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 672 | |
| 673 | 1st BOOTP request: delay 0 ... 1 sec |
| 674 | 2nd BOOTP request: delay 0 ... 2 sec |
| 675 | 3rd BOOTP request: delay 0 ... 4 sec |
| 676 | 4th and following |
| 677 | BOOTP requests: delay 0 ... 8 sec |
| 678 | |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 679 | CFG_BOOTP_ID_CACHE_SIZE |
Thierry Reding | 92ac8ac | 2014-08-19 10:21:24 +0200 | [diff] [blame] | 680 | |
| 681 | BOOTP packets are uniquely identified using a 32-bit ID. The |
| 682 | server will copy the ID from client requests to responses and |
| 683 | U-Boot will use this to determine if it is the destination of |
| 684 | an incoming response. Some servers will check that addresses |
| 685 | aren't in use before handing them out (usually using an ARP |
| 686 | ping) and therefore take up to a few hundred milliseconds to |
| 687 | respond. Network congestion may also influence the time it |
| 688 | takes for a response to make it back to the client. If that |
| 689 | time is too long, U-Boot will retransmit requests. In order |
| 690 | to allow earlier responses to still be accepted after these |
| 691 | retransmissions, U-Boot's BOOTP client keeps a small cache of |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 692 | IDs. The CFG_BOOTP_ID_CACHE_SIZE controls the size of this |
Thierry Reding | 92ac8ac | 2014-08-19 10:21:24 +0200 | [diff] [blame] | 693 | cache. The default is to keep IDs for up to four outstanding |
| 694 | requests. Increasing this will allow U-Boot to accept offers |
| 695 | from a BOOTP client in networks with unusually high latency. |
| 696 | |
stroese | fe389a8 | 2003-08-28 14:17:32 +0000 | [diff] [blame] | 697 | - DHCP Advanced Options: |
Joe Hershberger | 2c00e09 | 2012-05-23 07:59:19 +0000 | [diff] [blame] | 698 | |
Joe Hershberger | d22c338 | 2012-05-23 08:00:12 +0000 | [diff] [blame] | 699 | - Link-local IP address negotiation: |
| 700 | Negotiate with other link-local clients on the local network |
| 701 | for an address that doesn't require explicit configuration. |
| 702 | This is especially useful if a DHCP server cannot be guaranteed |
| 703 | to exist in all environments that the device must operate. |
| 704 | |
| 705 | See doc/README.link-local for more information. |
| 706 | |
Prabhakar Kushwaha | 24acb83 | 2017-11-23 16:51:32 +0530 | [diff] [blame] | 707 | - MAC address from environment variables |
| 708 | |
| 709 | FDT_SEQ_MACADDR_FROM_ENV |
| 710 | |
| 711 | Fix-up device tree with MAC addresses fetched sequentially from |
| 712 | environment variables. This config work on assumption that |
| 713 | non-usable ethernet node of device-tree are either not present |
| 714 | or their status has been marked as "disabled". |
| 715 | |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 716 | - CDP Options: |
wdenk | 6e59238 | 2004-04-18 17:39:38 +0000 | [diff] [blame] | 717 | CONFIG_CDP_DEVICE_ID |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 718 | |
| 719 | The device id used in CDP trigger frames. |
| 720 | |
| 721 | CONFIG_CDP_DEVICE_ID_PREFIX |
| 722 | |
| 723 | A two character string which is prefixed to the MAC address |
| 724 | of the device. |
| 725 | |
| 726 | CONFIG_CDP_PORT_ID |
| 727 | |
| 728 | A printf format string which contains the ascii name of |
| 729 | the port. Normally is set to "eth%d" which sets |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 730 | eth0 for the first Ethernet, eth1 for the second etc. |
wdenk | a3d991b | 2004-04-15 21:48:45 +0000 | [diff] [blame] | 731 | |
| 732 | CONFIG_CDP_CAPABILITIES |
| 733 | |
| 734 | A 32bit integer which indicates the device capabilities; |
| 735 | 0x00000010 for a normal host which does not forwards. |
| 736 | |
| 737 | CONFIG_CDP_VERSION |
| 738 | |
| 739 | An ascii string containing the version of the software. |
| 740 | |
| 741 | CONFIG_CDP_PLATFORM |
| 742 | |
| 743 | An ascii string containing the name of the platform. |
| 744 | |
| 745 | CONFIG_CDP_TRIGGER |
| 746 | |
| 747 | A 32bit integer sent on the trigger. |
| 748 | |
| 749 | CONFIG_CDP_POWER_CONSUMPTION |
| 750 | |
| 751 | A 16bit integer containing the power consumption of the |
| 752 | device in .1 of milliwatts. |
| 753 | |
| 754 | CONFIG_CDP_APPLIANCE_VLAN_TYPE |
| 755 | |
| 756 | A byte containing the id of the VLAN. |
| 757 | |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 758 | - Status LED: CONFIG_LED_STATUS |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 759 | |
| 760 | Several configurations allow to display the current |
| 761 | status using a LED. For instance, the LED will blink |
| 762 | fast while running U-Boot code, stop blinking as |
| 763 | soon as a reply to a BOOTP request was received, and |
| 764 | start blinking slow once the Linux kernel is running |
| 765 | (supported by a status LED driver in the Linux |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 766 | kernel). Defining CONFIG_LED_STATUS enables this |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 767 | feature in U-Boot. |
| 768 | |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 769 | Additional options: |
| 770 | |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 771 | CONFIG_LED_STATUS_GPIO |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 772 | The status LED can be connected to a GPIO pin. |
| 773 | In such cases, the gpio_led driver can be used as a |
Uri Mashiach | 79267ed | 2017-01-19 10:51:05 +0200 | [diff] [blame] | 774 | status LED backend implementation. Define CONFIG_LED_STATUS_GPIO |
Igor Grinberg | 1df7bbb | 2013-11-08 01:03:50 +0200 | [diff] [blame] | 775 | to include the gpio_led driver in the U-Boot binary. |
| 776 | |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 777 | CFG_GPIO_LED_INVERTED_TABLE |
Igor Grinberg | 9dfdcdf | 2013-11-08 01:03:52 +0200 | [diff] [blame] | 778 | Some GPIO connected LEDs may have inverted polarity in which |
| 779 | case the GPIO high value corresponds to LED off state and |
| 780 | GPIO low value corresponds to LED on state. |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 781 | In such cases CFG_GPIO_LED_INVERTED_TABLE may be defined |
Igor Grinberg | 9dfdcdf | 2013-11-08 01:03:52 +0200 | [diff] [blame] | 782 | with a list of GPIO LEDs that have inverted polarity. |
| 783 | |
Tom Rini | 55dabcc | 2021-08-18 23:12:24 -0400 | [diff] [blame] | 784 | - I2C Support: |
Tom Rini | cdc5ed8 | 2022-11-16 13:10:29 -0500 | [diff] [blame] | 785 | CFG_SYS_NUM_I2C_BUSES |
Simon Glass | 945a18e | 2016-10-02 18:01:05 -0600 | [diff] [blame] | 786 | Hold the number of i2c buses you want to use. |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 787 | |
Tom Rini | d8964b3 | 2022-12-04 10:13:57 -0500 | [diff] [blame] | 788 | CFG_SYS_I2C_DIRECT_BUS |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 789 | define this, if you don't use i2c muxes on your hardware. |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 790 | if CFG_SYS_I2C_MAX_HOPS is not defined or == 0 you can |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 791 | omit this define. |
| 792 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 793 | CFG_SYS_I2C_MAX_HOPS |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 794 | define how many muxes are maximal consecutively connected |
| 795 | on one i2c bus. If you not use i2c muxes, omit this |
| 796 | define. |
| 797 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 798 | CFG_SYS_I2C_BUSES |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 799 | hold a list of buses you want to use, only used if |
Tom Rini | d8964b3 | 2022-12-04 10:13:57 -0500 | [diff] [blame] | 800 | CFG_SYS_I2C_DIRECT_BUS is not defined, for example |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 801 | a board with CFG_SYS_I2C_MAX_HOPS = 1 and |
Tom Rini | cdc5ed8 | 2022-11-16 13:10:29 -0500 | [diff] [blame] | 802 | CFG_SYS_NUM_I2C_BUSES = 9: |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 803 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 804 | CFG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ |
Heiko Schocher | 3f4978c | 2012-01-16 21:12:24 +0000 | [diff] [blame] | 805 | {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ |
| 806 | {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ |
| 807 | {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ |
| 808 | {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ |
| 809 | {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ |
| 810 | {1, {I2C_NULL_HOP}}, \ |
| 811 | {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ |
| 812 | {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ |
| 813 | } |
| 814 | |
| 815 | which defines |
| 816 | bus 0 on adapter 0 without a mux |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 817 | bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 |
| 818 | bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 |
| 819 | bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 |
| 820 | bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 |
| 821 | 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] | 822 | bus 6 on adapter 1 without a mux |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 823 | bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 |
| 824 | 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] | 825 | |
| 826 | If you do not have i2c muxes on your board, omit this define. |
| 827 | |
Simon Glass | ce3b5d6 | 2017-05-12 21:10:00 -0600 | [diff] [blame] | 828 | - Legacy I2C Support: |
Heiko Schocher | ea818db | 2013-01-29 08:53:15 +0100 | [diff] [blame] | 829 | If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 830 | then the following macros need to be defined (examples are |
| 831 | from include/configs/lwmon.h): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 832 | |
| 833 | I2C_INIT |
| 834 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 835 | (Optional). Any commands necessary to enable the I2C |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 836 | controller or configure ports. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 837 | |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 838 | eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 839 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 840 | I2C_ACTIVE |
| 841 | |
| 842 | The code necessary to make the I2C data line active |
| 843 | (driven). If the data line is open collector, this |
| 844 | define can be null. |
| 845 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 846 | eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) |
| 847 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 848 | I2C_TRISTATE |
| 849 | |
| 850 | The code necessary to make the I2C data line tri-stated |
| 851 | (inactive). If the data line is open collector, this |
| 852 | define can be null. |
| 853 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 854 | eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) |
| 855 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 856 | I2C_READ |
| 857 | |
York Sun | 472d546 | 2013-04-01 11:29:11 -0700 | [diff] [blame] | 858 | Code that returns true if the I2C data line is high, |
| 859 | false if it is low. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 860 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 861 | eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) |
| 862 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 863 | I2C_SDA(bit) |
| 864 | |
York Sun | 472d546 | 2013-04-01 11:29:11 -0700 | [diff] [blame] | 865 | If <bit> is true, sets the I2C data line high. If it |
| 866 | is false, it clears it (low). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 867 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 868 | eg: #define I2C_SDA(bit) \ |
wdenk | 2535d60 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 869 | if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 870 | else immr->im_cpm.cp_pbdat &= ~PB_SDA |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 871 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 872 | I2C_SCL(bit) |
| 873 | |
York Sun | 472d546 | 2013-04-01 11:29:11 -0700 | [diff] [blame] | 874 | If <bit> is true, sets the I2C clock line high. If it |
| 875 | is false, it clears it (low). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 876 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 877 | eg: #define I2C_SCL(bit) \ |
wdenk | 2535d60 | 2003-07-17 23:16:40 +0000 | [diff] [blame] | 878 | if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ |
wdenk | ba56f62 | 2004-02-06 23:19:44 +0000 | [diff] [blame] | 879 | else immr->im_cpm.cp_pbdat &= ~PB_SCL |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 880 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 881 | I2C_DELAY |
| 882 | |
| 883 | This delay is invoked four times per clock cycle so this |
| 884 | controls the rate of data transfer. The data rate thus |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 885 | is 1 / (I2C_DELAY * 4). Often defined to be something |
wdenk | 945af8d | 2003-07-16 21:53:01 +0000 | [diff] [blame] | 886 | like: |
| 887 | |
wdenk | b37c7e5 | 2003-06-30 16:24:52 +0000 | [diff] [blame] | 888 | #define I2C_DELAY udelay(2) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 889 | |
Mike Frysinger | 793b572 | 2010-07-21 13:38:02 -0400 | [diff] [blame] | 890 | CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA |
| 891 | |
| 892 | If your arch supports the generic GPIO framework (asm/gpio.h), |
| 893 | then you may alternatively define the two GPIOs that are to be |
| 894 | used as SCL / SDA. Any of the previous I2C_xxx macros will |
| 895 | have GPIO-based defaults assigned to them as appropriate. |
| 896 | |
| 897 | You should define these to the GPIO value as given directly to |
| 898 | the generic GPIO functions. |
| 899 | |
Tom Rini | e06b9b8 | 2022-12-04 10:04:08 -0500 | [diff] [blame] | 900 | CFG_I2C_MULTI_BUS |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 901 | |
| 902 | This option allows the use of multiple I2C buses, each of which |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 903 | must have a controller. At any point in time, only one bus is |
| 904 | active. To switch to a different bus, use the 'i2c dev' command. |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 905 | Note that bus numbering is zero-based. |
| 906 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 907 | CFG_SYS_I2C_NOPROBES |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 908 | |
| 909 | This option specifies a list of I2C devices that will be skipped |
Tom Rini | 1353b25 | 2022-12-02 16:42:30 -0500 | [diff] [blame] | 910 | when the 'i2c probe' command is issued. |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 911 | |
| 912 | e.g. |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 913 | #define CFG_SYS_I2C_NOPROBES {0x50,0x68} |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 914 | |
| 915 | will skip addresses 0x50 and 0x68 on a board with one I2C bus |
| 916 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 917 | CFG_SYS_RTC_BUS_NUM |
Stefan Roese | 0dc018e | 2007-02-20 10:51:26 +0100 | [diff] [blame] | 918 | |
| 919 | If defined, then this indicates the I2C bus number for the RTC. |
| 920 | If not defined, then U-Boot assumes that RTC is on I2C bus 0. |
| 921 | |
Andrew Dyer | 2ac6985 | 2008-12-29 17:36:01 -0600 | [diff] [blame] | 922 | CONFIG_SOFT_I2C_READ_REPEATED_START |
| 923 | |
| 924 | defining this will force the i2c_read() function in |
| 925 | the soft_i2c driver to perform an I2C repeated start |
| 926 | between writing the address pointer and reading the |
| 927 | data. If this define is omitted the default behaviour |
| 928 | of doing a stop-start sequence will be used. Most I2C |
| 929 | devices can use either method, but some require one or |
| 930 | the other. |
Timur Tabi | be5e618 | 2006-11-03 19:15:00 -0600 | [diff] [blame] | 931 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 932 | - SPI Support: CONFIG_SPI |
| 933 | |
| 934 | Enables SPI driver (so far only tested with |
| 935 | SPI EEPROM, also an instance works with Crystal A/D and |
| 936 | D/As on the SACSng board) |
| 937 | |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 938 | CFG_SYS_SPI_MXC_WAIT |
Heiko Schocher | f659b57 | 2014-07-14 10:22:11 +0200 | [diff] [blame] | 939 | Timeout for waiting until spi transfer completed. |
| 940 | default: (CONFIG_SYS_HZ/100) /* 10 ms */ |
| 941 | |
Matthias Fuchs | 0133502 | 2007-12-27 17:12:34 +0100 | [diff] [blame] | 942 | - FPGA Support: CONFIG_FPGA |
| 943 | |
| 944 | Enables FPGA subsystem. |
| 945 | |
| 946 | CONFIG_FPGA_<vendor> |
| 947 | |
| 948 | Enables support for specific chip vendors. |
| 949 | (ALTERA, XILINX) |
| 950 | |
| 951 | CONFIG_FPGA_<family> |
| 952 | |
| 953 | Enables support for FPGA family. |
| 954 | (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) |
| 955 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 956 | CONFIG_SYS_FPGA_CHECK_BUSY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 957 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 958 | Enable checks on FPGA configuration interface busy |
| 959 | status by the configuration function. This option |
| 960 | will require a board or device specific function to |
| 961 | be written. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 962 | |
Tom Rini | 72fc264 | 2022-12-04 10:03:57 -0500 | [diff] [blame] | 963 | CFG_FPGA_DELAY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 964 | |
| 965 | If defined, a function that provides delays in the FPGA |
| 966 | configuration driver. |
| 967 | |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 968 | CFG_SYS_FPGA_CHECK_ERROR |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 969 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 970 | Check for configuration errors during FPGA bitfile |
| 971 | loading. For example, abort during Virtex II |
| 972 | configuration if the INIT_B line goes low (which |
| 973 | indicated a CRC error). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 974 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 975 | CFG_SYS_FPGA_WAIT_INIT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 976 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 977 | Maximum time to wait for the INIT_B line to de-assert |
| 978 | after PROB_B has been de-asserted during a Virtex II |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 979 | FPGA configuration sequence. The default time is 500 |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 980 | ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 981 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 982 | CFG_SYS_FPGA_WAIT_BUSY |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 983 | |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 984 | Maximum time to wait for BUSY to de-assert during |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 985 | Virtex II FPGA configuration. The default is 5 ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 986 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 987 | CFG_SYS_FPGA_WAIT_CONFIG |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 988 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 989 | Time to wait after FPGA configuration. The default is |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 990 | 200 ms. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 991 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 992 | - Vendor Parameter Protection: |
| 993 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 994 | U-Boot considers the values of the environment |
| 995 | variables "serial#" (Board Serial Number) and |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 996 | "ethaddr" (Ethernet Address) to be parameters that |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 997 | are set once by the board vendor / manufacturer, and |
| 998 | protects these variables from casual modification by |
| 999 | the user. Once set, these variables are read-only, |
| 1000 | and write or delete attempts are rejected. You can |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1001 | change this behaviour: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1002 | |
| 1003 | If CONFIG_ENV_OVERWRITE is #defined in your config |
| 1004 | file, the write protection for vendor parameters is |
wdenk | 47cd00f | 2003-03-06 13:39:27 +0000 | [diff] [blame] | 1005 | completely disabled. Anybody can change or delete |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1006 | these parameters. |
| 1007 | |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1008 | The same can be accomplished in a more flexible way |
| 1009 | for any variable by configuring the type of access |
| 1010 | to allow for those variables in the ".flags" variable |
Tom Rini | acf29d8 | 2022-12-04 10:03:40 -0500 | [diff] [blame] | 1011 | or define CFG_ENV_FLAGS_LIST_STATIC. |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1012 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1013 | - Protected RAM: |
Tom Rini | 7c5c137 | 2022-12-04 10:13:37 -0500 | [diff] [blame] | 1014 | CFG_PRAM |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1015 | |
| 1016 | Define this variable to enable the reservation of |
| 1017 | "protected RAM", i. e. RAM which is not overwritten |
Tom Rini | 7c5c137 | 2022-12-04 10:13:37 -0500 | [diff] [blame] | 1018 | by U-Boot. Define CFG_PRAM to hold the number of |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1019 | kB you want to reserve for pRAM. You can overwrite |
| 1020 | this default value by defining an environment |
| 1021 | variable "pram" to the number of kB you want to |
| 1022 | reserve. Note that the board info structure will |
| 1023 | still show the full amount of RAM. If pRAM is |
| 1024 | reserved, a new environment variable "mem" will |
| 1025 | automatically be defined to hold the amount of |
| 1026 | remaining RAM in a form that can be passed as boot |
| 1027 | argument to Linux, for instance like that: |
| 1028 | |
Wolfgang Denk | fe126d8 | 2005-11-20 21:40:11 +0100 | [diff] [blame] | 1029 | setenv bootargs ... mem=\${mem} |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1030 | saveenv |
| 1031 | |
| 1032 | This way you can tell Linux not to use this memory, |
| 1033 | either, which results in a memory region that will |
| 1034 | not be affected by reboots. |
| 1035 | |
| 1036 | *WARNING* If your board configuration uses automatic |
| 1037 | detection of the RAM size, you must make sure that |
| 1038 | this memory test is non-destructive. So far, the |
| 1039 | following board configurations are known to be |
| 1040 | "pRAM-clean": |
| 1041 | |
Heiko Schocher | 5b8e76c | 2017-06-07 17:33:09 +0200 | [diff] [blame] | 1042 | IVMS8, IVML24, SPD8xx, |
Wolfgang Denk | 1b0757e | 2012-10-24 02:36:15 +0000 | [diff] [blame] | 1043 | HERMES, IP860, RPXlite, LWMON, |
Heiko Schocher | 2eb48ff | 2017-06-07 17:33:10 +0200 | [diff] [blame] | 1044 | FLAGADM |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1045 | |
| 1046 | - Error Recovery: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1047 | Note: |
| 1048 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 1049 | In the current implementation, the local variables |
| 1050 | space and global environment variables space are |
| 1051 | separated. Local variables are those you define by |
| 1052 | simply typing `name=value'. To access a local |
| 1053 | variable later on, you have write `$name' or |
| 1054 | `${name}'; to execute the contents of a variable |
| 1055 | directly type `$name' at the command prompt. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1056 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1057 | Global environment variables are those you use |
| 1058 | setenv/printenv to work with. To run a command stored |
| 1059 | in such a variable, you need to use the run command, |
| 1060 | and you must not use the '$' sign to access them. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1061 | |
| 1062 | To store commands and special characters in a |
| 1063 | variable, please use double quotation marks |
| 1064 | surrounding the whole text of the variable, instead |
| 1065 | of the backslashes before semicolons and special |
| 1066 | symbols. |
| 1067 | |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 1068 | - Default Environment: |
Tom Rini | 0613c36 | 2022-12-04 10:03:50 -0500 | [diff] [blame] | 1069 | CFG_EXTRA_ENV_SETTINGS |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1070 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1071 | Define this to contain any number of null terminated |
| 1072 | strings (variable = value pairs) that will be part of |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1073 | the default environment compiled into the boot image. |
wdenk | 2262cfe | 2002-11-18 00:14:45 +0000 | [diff] [blame] | 1074 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1075 | For example, place something like this in your |
| 1076 | board's config file: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1077 | |
Tom Rini | 0613c36 | 2022-12-04 10:03:50 -0500 | [diff] [blame] | 1078 | #define CFG_EXTRA_ENV_SETTINGS \ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1079 | "myvar1=value1\0" \ |
| 1080 | "myvar2=value2\0" |
| 1081 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1082 | Warning: This method is based on knowledge about the |
| 1083 | internal format how the environment is stored by the |
| 1084 | U-Boot code. This is NOT an official, exported |
| 1085 | interface! Although it is unlikely that this format |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1086 | will change soon, there is no guarantee either. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1087 | You better know what you are doing here. |
| 1088 | |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1089 | Note: overly (ab)use of the default environment is |
| 1090 | discouraged. Make sure to check other ways to preset |
Wolfgang Denk | 74de7ae | 2009-04-01 23:34:12 +0200 | [diff] [blame] | 1091 | the environment like the "source" command or the |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1092 | boot command first. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1093 | |
Simon Glass | 06fd853 | 2012-11-30 13:01:17 +0000 | [diff] [blame] | 1094 | CONFIG_DELAY_ENVIRONMENT |
| 1095 | |
| 1096 | Normally the environment is loaded when the board is |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1097 | initialised so that it is available to U-Boot. This inhibits |
Simon Glass | 06fd853 | 2012-11-30 13:01:17 +0000 | [diff] [blame] | 1098 | that so that the environment is not available until |
| 1099 | explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL |
| 1100 | this is instead controlled by the value of |
| 1101 | /config/load-environment. |
| 1102 | |
Detlev Zundel | cccfc2a | 2009-12-01 17:16:19 +0100 | [diff] [blame] | 1103 | - Automatic software updates via TFTP server |
| 1104 | CONFIG_UPDATE_TFTP |
| 1105 | CONFIG_UPDATE_TFTP_CNT_MAX |
| 1106 | CONFIG_UPDATE_TFTP_MSEC_MAX |
| 1107 | |
| 1108 | These options enable and control the auto-update feature; |
| 1109 | for a more detailed description refer to doc/README.update. |
| 1110 | |
| 1111 | - MTD Support (mtdparts command, UBI support) |
Heiko Schocher | ff94bc4 | 2014-06-24 10:10:04 +0200 | [diff] [blame] | 1112 | CONFIG_MTD_UBI_WL_THRESHOLD |
| 1113 | This parameter defines the maximum difference between the highest |
| 1114 | erase counter value and the lowest erase counter value of eraseblocks |
| 1115 | of UBI devices. When this threshold is exceeded, UBI starts performing |
| 1116 | wear leveling by means of moving data from eraseblock with low erase |
| 1117 | counter to eraseblocks with high erase counter. |
| 1118 | |
| 1119 | The default value should be OK for SLC NAND flashes, NOR flashes and |
| 1120 | other flashes which have eraseblock life-cycle 100000 or more. |
| 1121 | However, in case of MLC NAND flashes which typically have eraseblock |
| 1122 | life-cycle less than 10000, the threshold should be lessened (e.g., |
| 1123 | to 128 or 256, although it does not have to be power of 2). |
| 1124 | |
| 1125 | default: 4096 |
Simon Glass | c654b51 | 2014-10-23 18:58:54 -0600 | [diff] [blame] | 1126 | |
Heiko Schocher | ff94bc4 | 2014-06-24 10:10:04 +0200 | [diff] [blame] | 1127 | CONFIG_MTD_UBI_BEB_LIMIT |
| 1128 | This option specifies the maximum bad physical eraseblocks UBI |
| 1129 | expects on the MTD device (per 1024 eraseblocks). If the |
| 1130 | underlying flash does not admit of bad eraseblocks (e.g. NOR |
| 1131 | flash), this value is ignored. |
| 1132 | |
| 1133 | NAND datasheets often specify the minimum and maximum NVM |
| 1134 | (Number of Valid Blocks) for the flashes' endurance lifetime. |
| 1135 | The maximum expected bad eraseblocks per 1024 eraseblocks |
| 1136 | then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", |
| 1137 | which gives 20 for most NANDs (MaxNVB is basically the total |
| 1138 | count of eraseblocks on the chip). |
| 1139 | |
| 1140 | To put it differently, if this value is 20, UBI will try to |
| 1141 | reserve about 1.9% of physical eraseblocks for bad blocks |
| 1142 | handling. And that will be 1.9% of eraseblocks on the entire |
| 1143 | NAND chip, not just the MTD partition UBI attaches. This means |
| 1144 | that if you have, say, a NAND flash chip admits maximum 40 bad |
| 1145 | eraseblocks, and it is split on two MTD partitions of the same |
| 1146 | size, UBI will reserve 40 eraseblocks when attaching a |
| 1147 | partition. |
| 1148 | |
| 1149 | default: 20 |
| 1150 | |
| 1151 | CONFIG_MTD_UBI_FASTMAP |
| 1152 | Fastmap is a mechanism which allows attaching an UBI device |
| 1153 | in nearly constant time. Instead of scanning the whole MTD device it |
| 1154 | only has to locate a checkpoint (called fastmap) on the device. |
| 1155 | The on-flash fastmap contains all information needed to attach |
| 1156 | the device. Using fastmap makes only sense on large devices where |
| 1157 | attaching by scanning takes long. UBI will not automatically install |
| 1158 | a fastmap on old images, but you can set the UBI parameter |
| 1159 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note |
| 1160 | that fastmap-enabled images are still usable with UBI implementations |
| 1161 | without fastmap support. On typical flash devices the whole fastmap |
| 1162 | fits into one PEB. UBI will reserve PEBs to hold two fastmaps. |
| 1163 | |
| 1164 | CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT |
| 1165 | Set this parameter to enable fastmap automatically on images |
| 1166 | without a fastmap. |
| 1167 | default: 0 |
| 1168 | |
Heiko Schocher | 0195a7b | 2015-10-22 06:19:21 +0200 | [diff] [blame] | 1169 | CONFIG_MTD_UBI_FM_DEBUG |
| 1170 | Enable UBI fastmap debug |
| 1171 | default: 0 |
| 1172 | |
Daniel Schwierzeck | 6a11cf4 | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 1173 | - SPL framework |
Wolfgang Denk | 04e5ae7 | 2011-09-11 21:24:09 +0200 | [diff] [blame] | 1174 | CONFIG_SPL |
| 1175 | Enable building of SPL globally. |
Daniel Schwierzeck | 6a11cf4 | 2011-07-18 07:48:07 +0000 | [diff] [blame] | 1176 | |
Albert ARIBAUD \(3ADEV\) | 8c80eb3 | 2015-03-31 11:40:50 +0200 | [diff] [blame] | 1177 | CONFIG_SPL_PANIC_ON_RAW_IMAGE |
| 1178 | When defined, SPL will panic() if the image it has |
| 1179 | loaded does not have a signature. |
| 1180 | Defining this is useful when code which loads images |
| 1181 | in SPL cannot guarantee that absolutely all read errors |
| 1182 | will be caught. |
| 1183 | An example is the LPC32XX MLC NAND driver, which will |
| 1184 | consider that a completely unreadable NAND block is bad, |
| 1185 | and thus should be skipped silently. |
| 1186 | |
Tom Rini | 861a86f | 2012-08-13 11:37:56 -0700 | [diff] [blame] | 1187 | CONFIG_SPL_DISPLAY_PRINT |
| 1188 | For ARM, enable an optional function to print more information |
| 1189 | about the running system. |
| 1190 | |
Scott Wood | 06f60ae | 2012-12-06 13:33:17 +0000 | [diff] [blame] | 1191 | CONFIG_SPL_MPC83XX_WAIT_FOR_NAND |
| 1192 | Set this for NAND SPL on PPC mpc83xx targets, so that |
| 1193 | start.S waits for the rest of the SPL to load before |
| 1194 | continuing (the hardware starts execution after just |
| 1195 | loading the first page rather than the full 4K). |
| 1196 | |
Thomas Gleixner | 6f4e7d3 | 2016-07-12 20:28:12 +0200 | [diff] [blame] | 1197 | CONFIG_SPL_UBI |
| 1198 | Support for a lightweight UBI (fastmap) scanner and |
| 1199 | loader |
| 1200 | |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 1201 | CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, |
| 1202 | CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, |
| 1203 | CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, |
Tom Rini | 4e59094 | 2022-11-12 17:36:51 -0500 | [diff] [blame] | 1204 | CFG_SYS_NAND_ECCPOS, CFG_SYS_NAND_ECCSIZE, |
| 1205 | CFG_SYS_NAND_ECCBYTES |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 1206 | Defines the size and behavior of the NAND that SPL uses |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 1207 | to read U-Boot |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 1208 | |
Tom Rini | 4e59094 | 2022-11-12 17:36:51 -0500 | [diff] [blame] | 1209 | CFG_SYS_NAND_U_BOOT_DST |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 1210 | Location in memory to load U-Boot to |
| 1211 | |
Tom Rini | 4e59094 | 2022-11-12 17:36:51 -0500 | [diff] [blame] | 1212 | CFG_SYS_NAND_U_BOOT_SIZE |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 1213 | Size of image to load |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 1214 | |
Tom Rini | 4e59094 | 2022-11-12 17:36:51 -0500 | [diff] [blame] | 1215 | CFG_SYS_NAND_U_BOOT_START |
Scott Wood | 7d4b795 | 2012-09-21 18:35:27 -0500 | [diff] [blame] | 1216 | Entry point in loaded image to jump to |
Tom Rini | 9557979 | 2012-02-14 07:29:40 +0000 | [diff] [blame] | 1217 | |
Pavel Machek | c57b953 | 2012-08-30 22:42:11 +0200 | [diff] [blame] | 1218 | CONFIG_SPL_RAM_DEVICE |
| 1219 | Support for running image already present in ram, in SPL binary |
| 1220 | |
Marek Vasut | b527b9c | 2018-05-13 00:22:52 +0200 | [diff] [blame] | 1221 | CONFIG_SPL_FIT_PRINT |
Simon Glass | 87ebee3 | 2013-05-08 08:05:59 +0000 | [diff] [blame] | 1222 | Printing information about a FIT image adds quite a bit of |
| 1223 | code to SPL. So this is normally disabled in SPL. Use this |
| 1224 | option to re-enable it. This will affect the output of the |
| 1225 | bootm command when booting a FIT image. |
| 1226 | |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 1227 | - Interrupt support (PPC): |
| 1228 | |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 1229 | There are common interrupt_init() and timer_interrupt() |
| 1230 | for all PPC archs. interrupt_init() calls interrupt_init_cpu() |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1231 | for CPU specific initialization. interrupt_init_cpu() |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 1232 | should set decrementer_count to appropriate value. If |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1233 | CPU resets decrementer automatically after interrupt |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 1234 | (ppc4xx) it should set decrementer_count to zero. |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1235 | timer_interrupt() calls timer_interrupt_cpu() for CPU |
wdenk | d4ca31c | 2004-01-02 14:00:00 +0000 | [diff] [blame] | 1236 | specific handling. If board has watchdog / status_led |
| 1237 | / other_activity_monitor it works automatically from |
| 1238 | general timer_interrupt(). |
wdenk | a8c7c70 | 2003-12-06 19:49:23 +0000 | [diff] [blame] | 1239 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1240 | |
Helmut Raiger | 9660e44 | 2011-10-20 04:19:47 +0000 | [diff] [blame] | 1241 | Board initialization settings: |
| 1242 | ------------------------------ |
| 1243 | |
| 1244 | During Initialization u-boot calls a number of board specific functions |
| 1245 | to allow the preparation of board specific prerequisites, e.g. pin setup |
| 1246 | before drivers are initialized. To enable these callbacks the |
| 1247 | following configuration macros have to be defined. Currently this is |
| 1248 | architecture specific, so please check arch/your_architecture/lib/board.c |
| 1249 | typically in board_init_f() and board_init_r(). |
| 1250 | |
| 1251 | - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() |
| 1252 | - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() |
| 1253 | - CONFIG_BOARD_LATE_INIT: Call board_late_init() |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1254 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1255 | Configuration Settings: |
| 1256 | ----------------------- |
| 1257 | |
Simon Glass | 4d979bf | 2019-12-28 10:45:10 -0700 | [diff] [blame] | 1258 | - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. |
York Sun | 4d1fd7f | 2014-02-26 17:03:19 -0800 | [diff] [blame] | 1259 | Optionally it can be defined to support 64-bit memory commands. |
| 1260 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1261 | - CONFIG_SYS_LONGHELP: Defined when you want long help messages included; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1262 | undefine this when you're short of memory. |
| 1263 | |
Tom Rini | 6e7df1d | 2023-01-10 11:19:45 -0500 | [diff] [blame] | 1264 | - CFG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default |
Peter Tyser | 2fb2604 | 2009-01-27 18:03:12 -0600 | [diff] [blame] | 1265 | width of the commands listed in the 'help' command output. |
| 1266 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1267 | - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1268 | prompt for user input. |
| 1269 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1270 | - CFG_SYS_BAUDRATE_TABLE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1271 | List of legal baudrate settings for this board. |
| 1272 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1273 | - CFG_SYS_MEM_RESERVE_SECURE |
York Sun | e61a753 | 2016-06-24 16:46:18 -0700 | [diff] [blame] | 1274 | Only implemented for ARMv8 for now. |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1275 | If defined, the size of CFG_SYS_MEM_RESERVE_SECURE memory |
York Sun | e814952 | 2015-12-04 11:57:07 -0800 | [diff] [blame] | 1276 | is substracted from total RAM and won't be reported to OS. |
| 1277 | This memory can be used as secure memory. A variable |
York Sun | e61a753 | 2016-06-24 16:46:18 -0700 | [diff] [blame] | 1278 | gd->arch.secure_ram is used to track the location. In systems |
York Sun | e814952 | 2015-12-04 11:57:07 -0800 | [diff] [blame] | 1279 | the RAM base is not zero, or RAM is divided into banks, |
| 1280 | this variable needs to be recalcuated to get the address. |
| 1281 | |
Tom Rini | aa6e94d | 2022-11-16 13:10:37 -0500 | [diff] [blame] | 1282 | - CFG_SYS_SDRAM_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1283 | Physical start address of SDRAM. _Must_ be 0 here. |
| 1284 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1285 | - CFG_SYS_FLASH_BASE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1286 | Physical start address of Flash memory. |
| 1287 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1288 | - CONFIG_SYS_MALLOC_LEN: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1289 | Size of DRAM reserved for malloc() use. |
| 1290 | |
Simon Glass | d59476b | 2014-07-10 22:23:28 -0600 | [diff] [blame] | 1291 | - CONFIG_SYS_MALLOC_F_LEN |
| 1292 | Size of the malloc() pool for use before relocation. If |
| 1293 | this is defined, then a very simple malloc() implementation |
| 1294 | will become available before relocation. The address is just |
| 1295 | below the global data, and the stack is moved down to make |
| 1296 | space. |
| 1297 | |
| 1298 | This feature allocates regions with increasing addresses |
| 1299 | within the region. calloc() is supported, but realloc() |
| 1300 | is not available. free() is supported but does nothing. |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1301 | The memory will be freed (or in fact just forgotten) when |
Simon Glass | d59476b | 2014-07-10 22:23:28 -0600 | [diff] [blame] | 1302 | U-Boot relocates itself. |
| 1303 | |
Simon Glass | 38687ae | 2014-11-10 17:16:54 -0700 | [diff] [blame] | 1304 | - CONFIG_SYS_MALLOC_SIMPLE |
| 1305 | Provides a simple and small malloc() and calloc() for those |
| 1306 | boards which do not use the full malloc in SPL (which is |
Tom Rini | 10f6e4d | 2022-05-27 12:48:32 -0400 | [diff] [blame] | 1307 | enabled with CONFIG_SYS_SPL_MALLOC). |
Simon Glass | 38687ae | 2014-11-10 17:16:54 -0700 | [diff] [blame] | 1308 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1309 | - CFG_SYS_BOOTMAPSZ: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1310 | Maximum size of memory mapped by the startup code of |
| 1311 | the Linux kernel; all data that must be processed by |
Bartlomiej Sieka | 7d721e3 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 1312 | the Linux kernel (bd_info, boot arguments, FDT blob if |
| 1313 | used) must be put below this limit, unless "bootm_low" |
Robert P. J. Day | 1bce2ae | 2013-09-16 07:15:45 -0400 | [diff] [blame] | 1314 | environment variable is defined and non-zero. In such case |
Bartlomiej Sieka | 7d721e3 | 2008-04-14 15:44:16 +0200 | [diff] [blame] | 1315 | all data for the Linux kernel must be between "bootm_low" |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1316 | and "bootm_low" + CFG_SYS_BOOTMAPSZ. The environment |
Grant Likely | c3624e6 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 1317 | variable "bootm_mapsize" will override the value of |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1318 | CFG_SYS_BOOTMAPSZ. If CFG_SYS_BOOTMAPSZ is undefined, |
Grant Likely | c3624e6 | 2011-03-28 09:58:43 +0000 | [diff] [blame] | 1319 | then the value in "bootm_size" will be used instead. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1320 | |
John Rigby | fca43cc | 2010-10-13 13:57:35 -0600 | [diff] [blame] | 1321 | - CONFIG_SYS_BOOT_GET_CMDLINE: |
| 1322 | Enables allocating and saving kernel cmdline in space between |
| 1323 | "bootm_low" and "bootm_low" + BOOTMAPSZ. |
| 1324 | |
| 1325 | - CONFIG_SYS_BOOT_GET_KBD: |
| 1326 | Enables allocating and saving a kernel copy of the bd_info in |
| 1327 | space between "bootm_low" and "bootm_low" + BOOTMAPSZ. |
| 1328 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1329 | - CONFIG_SYS_FLASH_PROTECTION |
wdenk | 8564acf | 2003-07-14 22:13:32 +0000 | [diff] [blame] | 1330 | If defined, hardware flash sectors protection is used |
| 1331 | instead of U-Boot software protection. |
| 1332 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1333 | - CONFIG_SYS_FLASH_CFI: |
wdenk | 43d9616 | 2003-03-06 00:02:04 +0000 | [diff] [blame] | 1334 | Define if the flash driver uses extra elements in the |
wdenk | 5653fc3 | 2004-02-08 22:55:38 +0000 | [diff] [blame] | 1335 | common flash structure for storing flash geometry. |
| 1336 | |
Jean-Christophe PLAGNIOL-VILLARD | 00b1883 | 2008-08-13 01:40:42 +0200 | [diff] [blame] | 1337 | - CONFIG_FLASH_CFI_DRIVER |
wdenk | 5653fc3 | 2004-02-08 22:55:38 +0000 | [diff] [blame] | 1338 | This option also enables the building of the cfi_flash driver |
| 1339 | in the drivers directory |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1340 | |
Piotr Ziecik | 91809ed | 2008-11-17 15:57:58 +0100 | [diff] [blame] | 1341 | - CONFIG_FLASH_CFI_MTD |
| 1342 | This option enables the building of the cfi_mtd driver |
| 1343 | in the drivers directory. The driver exports CFI flash |
| 1344 | to the MTD layer. |
| 1345 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1346 | - CONFIG_SYS_FLASH_USE_BUFFER_WRITE |
Guennadi Liakhovetski | 96ef831 | 2008-04-03 13:36:02 +0200 | [diff] [blame] | 1347 | Use buffered writes to flash. |
| 1348 | |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1349 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
Tom Rini | acf29d8 | 2022-12-04 10:03:40 -0500 | [diff] [blame] | 1350 | - CFG_ENV_FLAGS_LIST_STATIC |
Robert P. J. Day | 1bce2ae | 2013-09-16 07:15:45 -0400 | [diff] [blame] | 1351 | Enable validation of the values given to environment variables when |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1352 | calling env set. Variables can be restricted to only decimal, |
| 1353 | hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, |
| 1354 | the variables can also be restricted to IP address or MAC address. |
| 1355 | |
| 1356 | The format of the list is: |
| 1357 | type_attribute = [s|d|x|b|i|m] |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1358 | access_attribute = [a|r|o|c] |
| 1359 | attributes = type_attribute[access_attribute] |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1360 | entry = variable_name[:attributes] |
| 1361 | list = entry[,list] |
| 1362 | |
| 1363 | The type attributes are: |
| 1364 | s - String (default) |
| 1365 | d - Decimal |
| 1366 | x - Hexadecimal |
| 1367 | b - Boolean ([1yYtT|0nNfF]) |
| 1368 | i - IP address |
| 1369 | m - MAC address |
| 1370 | |
Joe Hershberger | 267541f | 2012-12-11 22:16:34 -0600 | [diff] [blame] | 1371 | The access attributes are: |
| 1372 | a - Any (default) |
| 1373 | r - Read-only |
| 1374 | o - Write-once |
| 1375 | c - Change-default |
| 1376 | |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1377 | - CONFIG_ENV_FLAGS_LIST_DEFAULT |
| 1378 | Define this to a list (string) to define the ".flags" |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1379 | environment variable in the default or embedded environment. |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1380 | |
Tom Rini | acf29d8 | 2022-12-04 10:03:40 -0500 | [diff] [blame] | 1381 | - CFG_ENV_FLAGS_LIST_STATIC |
Joe Hershberger | 2598090 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 1382 | Define this to a list (string) to define validation that |
| 1383 | should be done if an entry is not found in the ".flags" |
| 1384 | environment variable. To override a setting in the static |
| 1385 | list, simply add an entry for the same variable name to the |
| 1386 | ".flags" variable. |
| 1387 | |
Joe Hershberger | bdf1fe4 | 2015-05-20 14:27:20 -0500 | [diff] [blame] | 1388 | If CONFIG_REGEX is defined, the variable_name above is evaluated as a |
| 1389 | regular expression. This allows multiple variables to define the same |
| 1390 | flags without explicitly listing them for each variable. |
| 1391 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1392 | The following definitions that deal with the placement and management |
| 1393 | of environment data (variable area); in general, we support the |
| 1394 | following configurations: |
| 1395 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1396 | BE CAREFUL! The first access to the environment happens quite early |
Jeremiah Mahler | b445bbb | 2015-01-04 18:56:50 -0800 | [diff] [blame] | 1397 | in U-Boot initialization (when we try to get the setting of for the |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1398 | console baudrate). You *MUST* have mapped your NVRAM area then, or |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1399 | U-Boot will hang. |
| 1400 | |
| 1401 | Please note that even with NVRAM we still use a copy of the |
| 1402 | environment in RAM: we could work on NVRAM directly, but we want to |
| 1403 | keep settings there always unmodified except somebody uses "saveenv" |
| 1404 | to save the current settings. |
| 1405 | |
Liu Gang | 0a85a9e | 2012-03-08 00:33:20 +0000 | [diff] [blame] | 1406 | BE CAREFUL! For some special cases, the local device can not use |
| 1407 | "saveenv" command. For example, the local device will get the |
Liu Gang | fc54c7f | 2012-08-09 05:10:01 +0000 | [diff] [blame] | 1408 | environment stored in a remote NOR flash by SRIO or PCIE link, |
| 1409 | but it can not erase, write this NOR flash by SRIO or PCIE interface. |
Liu Gang | 0a85a9e | 2012-03-08 00:33:20 +0000 | [diff] [blame] | 1410 | |
Guennadi Liakhovetski | b74ab73 | 2009-05-18 16:07:22 +0200 | [diff] [blame] | 1411 | - CONFIG_NAND_ENV_DST |
| 1412 | |
| 1413 | Defines address in RAM to which the nand_spl code should copy the |
| 1414 | environment. If redundant environment is used, it will be copied to |
| 1415 | CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. |
| 1416 | |
Bruce Adler | e881cb5 | 2007-11-02 13:15:42 -0700 | [diff] [blame] | 1417 | Please note that the environment is read-only until the monitor |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1418 | has been relocated to RAM and a RAM copy of the environment has been |
Simon Glass | 00caae6 | 2017-08-03 12:22:12 -0600 | [diff] [blame] | 1419 | created; also, when using EEPROM you will have to use env_get_f() |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1420 | until then to read environment variables. |
| 1421 | |
wdenk | 85ec0bc | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 1422 | The environment is protected by a CRC32 checksum. Before the monitor |
| 1423 | is relocated into RAM, as a result of a bad CRC you will be working |
| 1424 | with the compiled-in default environment - *silently*!!! [This is |
| 1425 | necessary, because the first environment variable we need is the |
| 1426 | "baudrate" setting for the console - if we have a bad CRC, we don't |
| 1427 | have any device yet where we could complain.] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1428 | |
| 1429 | Note: once the monitor has been relocated, then it will complain if |
| 1430 | the default environment is used; a new CRC is computed as soon as you |
wdenk | 85ec0bc | 2003-03-31 16:34:49 +0000 | [diff] [blame] | 1431 | use the "saveenv" command to store a valid environment. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1432 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1433 | - CONFIG_SYS_FAULT_MII_ADDR: |
wdenk | 42d1f03 | 2003-10-15 23:53:47 +0000 | [diff] [blame] | 1434 | MII address of the PHY to check for the Ethernet link state. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1435 | |
Simon Glass | b2b92f5 | 2012-11-30 13:01:18 +0000 | [diff] [blame] | 1436 | - CONFIG_DISPLAY_BOARDINFO |
| 1437 | Display information about the board that U-Boot is running on |
| 1438 | when U-Boot starts up. The board function checkboard() is called |
| 1439 | to do this. |
| 1440 | |
Simon Glass | e2e3e2b | 2012-11-30 13:01:19 +0000 | [diff] [blame] | 1441 | - CONFIG_DISPLAY_BOARDINFO_LATE |
| 1442 | Similar to the previous option, but display this information |
| 1443 | later, once stdio is running and output goes to the LCD, if |
| 1444 | present. |
| 1445 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1446 | Low Level (hardware related) configuration options: |
wdenk | dc7c9a1 | 2003-03-26 06:55:25 +0000 | [diff] [blame] | 1447 | --------------------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1448 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1449 | - CONFIG_SYS_CACHELINE_SIZE: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1450 | Cache Line Size of the CPU. |
| 1451 | |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1452 | - CONFIG_SYS_CCSRBAR_DEFAULT: |
| 1453 | Default (power-on reset) physical address of CCSR on Freescale |
| 1454 | PowerPC SOCs. |
| 1455 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1456 | - CFG_SYS_CCSRBAR: |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1457 | Virtual address of CCSR. On a 32-bit build, this is typically |
| 1458 | the same value as CONFIG_SYS_CCSRBAR_DEFAULT. |
| 1459 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1460 | - CFG_SYS_CCSRBAR_PHYS: |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1461 | Physical address of CCSR. CCSR can be relocated to a new |
| 1462 | physical address, if desired. In this case, this macro should |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1463 | be set to that address. Otherwise, it should be set to the |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1464 | same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR |
| 1465 | is typically relocated on 36-bit builds. It is recommended |
| 1466 | that this macro be defined via the _HIGH and _LOW macros: |
| 1467 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1468 | #define CFG_SYS_CCSRBAR_PHYS ((CFG_SYS_CCSRBAR_PHYS_HIGH |
| 1469 | * 1ull) << 32 | CFG_SYS_CCSRBAR_PHYS_LOW) |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1470 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1471 | - CFG_SYS_CCSRBAR_PHYS_HIGH: |
| 1472 | Bits 33-36 of CFG_SYS_CCSRBAR_PHYS. This value is typically |
Wolfgang Denk | 4cf2609 | 2011-10-07 09:58:21 +0200 | [diff] [blame] | 1473 | either 0 (32-bit build) or 0xF (36-bit build). This macro is |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1474 | used in assembly code, so it must not contain typecasts or |
| 1475 | integer size suffixes (e.g. "ULL"). |
| 1476 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1477 | - CFG_SYS_CCSRBAR_PHYS_LOW: |
| 1478 | Lower 32-bits of CFG_SYS_CCSRBAR_PHYS. This macro is |
Timur Tabi | e46fedf | 2011-08-04 18:03:41 -0500 | [diff] [blame] | 1479 | used in assembly code, so it must not contain typecasts or |
| 1480 | integer size suffixes (e.g. "ULL"). |
| 1481 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1482 | - CONFIG_SYS_IMMR: Physical address of the Internal Memory. |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 1483 | DO NOT CHANGE unless you know exactly what you're |
Christophe Leroy | 907208c | 2017-07-06 10:23:22 +0200 | [diff] [blame] | 1484 | doing! (11-4) [MPC8xx systems only] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1485 | |
Tom Rini | 65cc0e2 | 2022-11-16 13:10:41 -0500 | [diff] [blame] | 1486 | - CFG_SYS_INIT_RAM_ADDR: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1487 | |
wdenk | 7152b1d | 2003-09-05 23:19:14 +0000 | [diff] [blame] | 1488 | Start address of memory area that can be used for |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1489 | initial data and stack; please note that this must be |
| 1490 | writable memory that is working WITHOUT special |
| 1491 | initialization, i. e. you CANNOT use normal RAM which |
| 1492 | will become available only after programming the |
| 1493 | memory controller and running certain initialization |
| 1494 | sequences. |
| 1495 | |
| 1496 | U-Boot uses the following memory types: |
Christophe Leroy | 907208c | 2017-07-06 10:23:22 +0200 | [diff] [blame] | 1497 | - MPC8xx: IMMR (internal memory of the CPU) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1498 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1499 | - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1500 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1501 | - CONFIG_SYS_OR_TIMING_SDRAM: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1502 | SDRAM timing |
| 1503 | |
Kumar Gala | a09b9b6 | 2010-12-30 12:09:53 -0600 | [diff] [blame] | 1504 | - CONFIG_SYS_SRIOn_MEM_VIRT: |
| 1505 | Virtual Address of SRIO port 'n' memory region |
| 1506 | |
Simon Glass | 62f9b65 | 2019-11-14 12:57:09 -0700 | [diff] [blame] | 1507 | - CONFIG_SYS_SRIOn_MEM_PHYxS: |
Kumar Gala | a09b9b6 | 2010-12-30 12:09:53 -0600 | [diff] [blame] | 1508 | Physical Address of SRIO port 'n' memory region |
| 1509 | |
| 1510 | - CONFIG_SYS_SRIOn_MEM_SIZE: |
| 1511 | Size of SRIO port 'n' memory region |
| 1512 | |
Fabio Estevam | 66bd184 | 2013-04-11 09:35:34 +0000 | [diff] [blame] | 1513 | - CONFIG_SYS_NAND_BUSWIDTH_16BIT |
| 1514 | Defined to tell the NAND controller that the NAND chip is using |
| 1515 | a 16 bit bus. |
| 1516 | Not all NAND drivers use this symbol. |
Fabio Estevam | a430e91 | 2013-04-11 09:35:35 +0000 | [diff] [blame] | 1517 | Example of drivers that use it: |
Miquel Raynal | a430fa0 | 2018-08-16 17:30:07 +0200 | [diff] [blame] | 1518 | - drivers/mtd/nand/raw/ndfc.c |
| 1519 | - drivers/mtd/nand/raw/mxc_nand.c |
Alex Waterman | eced462 | 2011-05-19 15:08:36 -0400 | [diff] [blame] | 1520 | |
| 1521 | - CONFIG_SYS_NDFC_EBC0_CFG |
| 1522 | Sets the EBC0_CFG register for the NDFC. If not defined |
| 1523 | a default value will be used. |
| 1524 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1525 | - CONFIG_SYS_SPD_BUS_NUM |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1526 | If SPD EEPROM is on an I2C bus other than the first |
| 1527 | one, specify here. Note that the value must resolve |
| 1528 | to something your driver can deal with. |
Ben Warren | bb99ad6 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 1529 | |
York Sun | 6f5e1dc | 2011-09-16 13:21:35 -0700 | [diff] [blame] | 1530 | - CONFIG_FSL_DDR_INTERACTIVE |
| 1531 | Enable interactive DDR debugging. See doc/README.fsl-ddr. |
| 1532 | |
York Sun | e32d59a | 2015-01-06 13:18:55 -0800 | [diff] [blame] | 1533 | - CONFIG_FSL_DDR_SYNC_REFRESH |
| 1534 | Enable sync of refresh for multiple controllers. |
| 1535 | |
York Sun | 4516ff8 | 2015-03-19 09:30:28 -0700 | [diff] [blame] | 1536 | - CONFIG_FSL_DDR_BIST |
| 1537 | Enable built-in memory test for Freescale DDR controllers. |
| 1538 | |
wdenk | c26e454 | 2004-04-18 10:13:26 +0000 | [diff] [blame] | 1539 | - CONFIG_RMII |
| 1540 | Enable RMII mode for all FECs. |
| 1541 | Note that this is a global option, we can't |
| 1542 | have one FEC in standard MII mode and another in RMII mode. |
| 1543 | |
wdenk | 5cf91d6 | 2004-04-23 20:32:05 +0000 | [diff] [blame] | 1544 | - CONFIG_CRC32_VERIFY |
| 1545 | Add a verify option to the crc32 command. |
| 1546 | The syntax is: |
| 1547 | |
| 1548 | => crc32 -v <address> <count> <crc32> |
| 1549 | |
| 1550 | Where address/count indicate a memory area |
| 1551 | and crc32 is the correct crc32 which the |
| 1552 | area should have. |
| 1553 | |
wdenk | 56523f1 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 1554 | - CONFIG_LOOPW |
| 1555 | Add the "loopw" memory command. This only takes effect if |
Simon Glass | 493f420 | 2017-08-04 16:34:27 -0600 | [diff] [blame] | 1556 | the memory commands are activated globally (CONFIG_CMD_MEMORY). |
wdenk | 56523f1 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 1557 | |
Joel Johnson | 7273231 | 2020-01-29 09:17:18 -0700 | [diff] [blame] | 1558 | - CONFIG_CMD_MX_CYCLIC |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 1559 | Add the "mdc" and "mwc" memory commands. These are cyclic |
| 1560 | "md/mw" commands. |
| 1561 | Examples: |
| 1562 | |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 1563 | => mdc.b 10 4 500 |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 1564 | This command will print 4 bytes (10,11,12,13) each 500 ms. |
| 1565 | |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 1566 | => mwc.l 100 12345678 10 |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 1567 | This command will write 12345678 to address 100 all 10 ms. |
| 1568 | |
wdenk | efe2a4d | 2004-12-16 21:44:03 +0000 | [diff] [blame] | 1569 | This only takes effect if the memory commands are activated |
Simon Glass | 493f420 | 2017-08-04 16:34:27 -0600 | [diff] [blame] | 1570 | globally (CONFIG_CMD_MEMORY). |
stroese | 7b46664 | 2004-12-16 18:46:55 +0000 | [diff] [blame] | 1571 | |
Aneesh V | 401bb30 | 2011-07-13 05:11:07 +0000 | [diff] [blame] | 1572 | - CONFIG_SPL_BUILD |
Thomas Hebb | 32f2ca2 | 2019-11-13 18:18:03 -0800 | [diff] [blame] | 1573 | Set when the currently-running compilation is for an artifact |
| 1574 | that will end up in the SPL (as opposed to the TPL or U-Boot |
| 1575 | proper). Code that needs stage-specific behavior should check |
| 1576 | this. |
wdenk | 400558b | 2005-04-02 23:52:25 +0000 | [diff] [blame] | 1577 | |
Ying Zhang | 3aa29de | 2013-08-16 15:16:15 +0800 | [diff] [blame] | 1578 | - CONFIG_TPL_BUILD |
Thomas Hebb | 32f2ca2 | 2019-11-13 18:18:03 -0800 | [diff] [blame] | 1579 | Set when the currently-running compilation is for an artifact |
| 1580 | that will end up in the TPL (as opposed to the SPL or U-Boot |
| 1581 | proper). Code that needs stage-specific behavior should check |
| 1582 | this. |
Ying Zhang | 3aa29de | 2013-08-16 15:16:15 +0800 | [diff] [blame] | 1583 | |
Simon Glass | 4213fc2 | 2013-02-24 17:33:14 +0000 | [diff] [blame] | 1584 | - CONFIG_ARCH_MAP_SYSMEM |
| 1585 | Generally U-Boot (and in particular the md command) uses |
| 1586 | effective address. It is therefore not necessary to regard |
| 1587 | U-Boot address as virtual addresses that need to be translated |
| 1588 | to physical addresses. However, sandbox requires this, since |
| 1589 | it maintains its own little RAM buffer which contains all |
| 1590 | addressable memory. This option causes some memory accesses |
| 1591 | to be mapped through map_sysmem() / unmap_sysmem(). |
| 1592 | |
Simon Glass | 588a13f | 2013-02-14 04:18:54 +0000 | [diff] [blame] | 1593 | - CONFIG_X86_RESET_VECTOR |
| 1594 | If defined, the x86 reset vector code is included. This is not |
| 1595 | needed when U-Boot is running from Coreboot. |
Gabe Black | b16f521 | 2012-11-27 21:08:06 +0000 | [diff] [blame] | 1596 | |
Timur Tabi | f2717b4 | 2011-11-22 09:21:25 -0600 | [diff] [blame] | 1597 | Freescale QE/FMAN Firmware Support: |
| 1598 | ----------------------------------- |
| 1599 | |
| 1600 | The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the |
| 1601 | loading of "firmware", which is encoded in the QE firmware binary format. |
| 1602 | This firmware often needs to be loaded during U-Boot booting, so macros |
| 1603 | are used to identify the storage device (NOR flash, SPI, etc) and the address |
| 1604 | within that device. |
| 1605 | |
Zhao Qiang | dcf1d77 | 2014-03-21 16:21:44 +0800 | [diff] [blame] | 1606 | - CONFIG_SYS_FMAN_FW_ADDR |
| 1607 | The address in the storage device where the FMAN microcode is located. The |
Tom Rini | cc1e98b | 2019-05-12 07:59:12 -0400 | [diff] [blame] | 1608 | meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro |
Zhao Qiang | dcf1d77 | 2014-03-21 16:21:44 +0800 | [diff] [blame] | 1609 | is also specified. |
| 1610 | |
| 1611 | - CONFIG_SYS_QE_FW_ADDR |
| 1612 | The address in the storage device where the QE microcode is located. The |
Tom Rini | cc1e98b | 2019-05-12 07:59:12 -0400 | [diff] [blame] | 1613 | meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro |
Timur Tabi | f2717b4 | 2011-11-22 09:21:25 -0600 | [diff] [blame] | 1614 | is also specified. |
| 1615 | |
| 1616 | - CONFIG_SYS_QE_FMAN_FW_LENGTH |
| 1617 | The maximum possible size of the firmware. The firmware binary format |
| 1618 | has a field that specifies the actual size of the firmware, but it |
| 1619 | might not be possible to read any part of the firmware unless some |
| 1620 | local storage is allocated to hold the entire firmware first. |
| 1621 | |
| 1622 | - CONFIG_SYS_QE_FMAN_FW_IN_NOR |
| 1623 | Specifies that QE/FMAN firmware is located in NOR flash, mapped as |
| 1624 | normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the |
| 1625 | virtual address in NOR flash. |
| 1626 | |
| 1627 | - CONFIG_SYS_QE_FMAN_FW_IN_NAND |
| 1628 | Specifies that QE/FMAN firmware is located in NAND flash. |
| 1629 | CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. |
| 1630 | |
| 1631 | - CONFIG_SYS_QE_FMAN_FW_IN_MMC |
| 1632 | Specifies that QE/FMAN firmware is located on the primary SD/MMC |
| 1633 | device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. |
| 1634 | |
Liu Gang | 292dc6c | 2012-03-08 00:33:18 +0000 | [diff] [blame] | 1635 | - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE |
| 1636 | Specifies that QE/FMAN firmware is located in the remote (master) |
| 1637 | memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which |
Liu Gang | fc54c7f | 2012-08-09 05:10:01 +0000 | [diff] [blame] | 1638 | can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound |
| 1639 | window->master inbound window->master LAW->the ucode address in |
| 1640 | master's memory space. |
Timur Tabi | f2717b4 | 2011-11-22 09:21:25 -0600 | [diff] [blame] | 1641 | |
J. German Rivera | b940ca6 | 2014-06-23 15:15:55 -0700 | [diff] [blame] | 1642 | Freescale Layerscape Management Complex Firmware Support: |
| 1643 | --------------------------------------------------------- |
| 1644 | The Freescale Layerscape Management Complex (MC) supports the loading of |
| 1645 | "firmware". |
| 1646 | This firmware often needs to be loaded during U-Boot booting, so macros |
| 1647 | are used to identify the storage device (NOR flash, SPI, etc) and the address |
| 1648 | within that device. |
| 1649 | |
| 1650 | - CONFIG_FSL_MC_ENET |
| 1651 | Enable the MC driver for Layerscape SoCs. |
| 1652 | |
Prabhakar Kushwaha | 5c05508 | 2015-06-02 10:55:52 +0530 | [diff] [blame] | 1653 | Freescale Layerscape Debug Server Support: |
| 1654 | ------------------------------------------- |
| 1655 | The Freescale Layerscape Debug Server Support supports the loading of |
| 1656 | "Debug Server firmware" and triggering SP boot-rom. |
| 1657 | This firmware often needs to be loaded during U-Boot booting. |
| 1658 | |
York Sun | c049214 | 2015-12-07 11:08:58 -0800 | [diff] [blame] | 1659 | - CONFIG_SYS_MC_RSV_MEM_ALIGN |
| 1660 | Define alignment of reserved memory MC requires |
Prabhakar Kushwaha | 5c05508 | 2015-06-02 10:55:52 +0530 | [diff] [blame] | 1661 | |
Paul Kocialkowski | f3f431a | 2015-07-26 18:48:15 +0200 | [diff] [blame] | 1662 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1663 | Building the Software: |
| 1664 | ====================== |
| 1665 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1666 | Building U-Boot has been tested in several native build environments |
| 1667 | and in many different cross environments. Of course we cannot support |
| 1668 | all possibly existing versions of cross development tools in all |
| 1669 | (potentially obsolete) versions. In case of tool chain problems we |
Naoki Hayama | 047f6ec | 2020-10-08 13:17:16 +0900 | [diff] [blame] | 1670 | recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK) |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1671 | which is extensively used to build and test U-Boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1672 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1673 | If you are not using a native environment, it is assumed that you |
| 1674 | have GNU cross compiling tools available in your path. In this case, |
| 1675 | you must set the environment variable CROSS_COMPILE in your shell. |
| 1676 | Note that no changes to the Makefile or any other source files are |
| 1677 | necessary. For example using the ELDK on a 4xx CPU, please enter: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1678 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1679 | $ CROSS_COMPILE=ppc_4xx- |
| 1680 | $ export CROSS_COMPILE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1681 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1682 | U-Boot is intended to be simple to build. After installing the |
| 1683 | sources you must configure U-Boot for one specific board type. This |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1684 | is done by typing: |
| 1685 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1686 | make NAME_defconfig |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1687 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1688 | where "NAME_defconfig" is the name of one of the existing configu- |
Heinrich Schuchardt | ecb3a0a | 2020-02-24 18:36:30 +0100 | [diff] [blame] | 1689 | rations; see configs/*_defconfig for supported names. |
wdenk | 54387ac | 2003-10-08 22:45:44 +0000 | [diff] [blame] | 1690 | |
Heinrich Schuchardt | ecb3a0a | 2020-02-24 18:36:30 +0100 | [diff] [blame] | 1691 | Note: for some boards special configuration names may exist; check if |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1692 | additional information is available from the board vendor; for |
| 1693 | instance, the TQM823L systems are available without (standard) |
| 1694 | or with LCD support. You can select such additional "features" |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1695 | when choosing the configuration, i. e. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1696 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1697 | make TQM823L_defconfig |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1698 | - will configure for a plain TQM823L, i. e. no LCD support |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1699 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1700 | make TQM823L_LCD_defconfig |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1701 | - will configure for a TQM823L with U-Boot console on LCD |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1702 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1703 | etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1704 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1705 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1706 | Finally, type "make all", and you should get some working U-Boot |
| 1707 | images ready for download to / installation on your system: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1708 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1709 | - "u-boot.bin" is a raw binary image |
| 1710 | - "u-boot" is an image in ELF binary format |
| 1711 | - "u-boot.srec" is in Motorola S-Record format |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1712 | |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1713 | By default the build is performed locally and the objects are saved |
| 1714 | in the source directory. One of the two methods can be used to change |
| 1715 | this behavior and build U-Boot to some external directory: |
| 1716 | |
| 1717 | 1. Add O= to the make command line invocations: |
| 1718 | |
| 1719 | make O=/tmp/build distclean |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1720 | make O=/tmp/build NAME_defconfig |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1721 | make O=/tmp/build all |
| 1722 | |
Timo Ketola | adbba99 | 2014-11-06 14:39:05 +0200 | [diff] [blame] | 1723 | 2. Set environment variable KBUILD_OUTPUT to point to the desired location: |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1724 | |
Timo Ketola | adbba99 | 2014-11-06 14:39:05 +0200 | [diff] [blame] | 1725 | export KBUILD_OUTPUT=/tmp/build |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1726 | make distclean |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1727 | make NAME_defconfig |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1728 | make all |
| 1729 | |
Timo Ketola | adbba99 | 2014-11-06 14:39:05 +0200 | [diff] [blame] | 1730 | Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1731 | variable. |
| 1732 | |
Daniel Schwierzeck | 215bb1c | 2018-01-26 16:31:04 +0100 | [diff] [blame] | 1733 | User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by |
| 1734 | setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS. |
| 1735 | For example to treat all compiler warnings as errors: |
| 1736 | |
| 1737 | make KCFLAGS=-Werror |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1738 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1739 | Please be aware that the Makefiles assume you are using GNU make, so |
| 1740 | for instance on NetBSD you might need to use "gmake" instead of |
| 1741 | native "make". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1742 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1743 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1744 | If the system board that you have is not listed, then you will need |
| 1745 | to port U-Boot to your hardware platform. To do this, follow these |
| 1746 | steps: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1747 | |
Phil Sutter | 3c1496c | 2015-12-25 14:41:18 +0100 | [diff] [blame] | 1748 | 1. Create a new directory to hold your board specific code. Add any |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1749 | files you need. In your board directory, you will need at least |
Phil Sutter | 3c1496c | 2015-12-25 14:41:18 +0100 | [diff] [blame] | 1750 | the "Makefile" and a "<board>.c". |
| 1751 | 2. Create a new configuration file "include/configs/<board>.h" for |
| 1752 | your board. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1753 | 3. If you're porting U-Boot to a new CPU, then also create a new |
| 1754 | directory to hold your CPU specific code. Add any files you need. |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1755 | 4. Run "make <board>_defconfig" with your new name. |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1756 | 5. Type "make", and you should get a working "u-boot.srec" file |
| 1757 | to be installed on your target system. |
| 1758 | 6. Debug and solve any problems that might arise. |
| 1759 | [Of course, this last step is much harder than it sounds.] |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1760 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1761 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1762 | Testing of U-Boot Modifications, Ports to New Hardware, etc.: |
| 1763 | ============================================================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1764 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1765 | If you have modified U-Boot sources (for instance added a new board |
| 1766 | or support for new devices, a new CPU, etc.) you are expected to |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1767 | provide feedback to the other developers. The feedback normally takes |
Thomas Hebb | 32f2ca2 | 2019-11-13 18:18:03 -0800 | [diff] [blame] | 1768 | the form of a "patch", i.e. a context diff against a certain (latest |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1769 | official or latest in the git repository) version of U-Boot sources. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1770 | |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 1771 | But before you submit such a patch, please verify that your modifi- |
| 1772 | cation did not break existing code. At least make sure that *ALL* of |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1773 | the supported boards compile WITHOUT ANY compiler warnings. To do so, |
Simon Glass | 6de80f2 | 2016-07-27 20:33:08 -0600 | [diff] [blame] | 1774 | just run the buildman script (tools/buildman/buildman), which will |
| 1775 | configure and build U-Boot for ALL supported system. Be warned, this |
| 1776 | will take a while. Please see the buildman README, or run 'buildman -H' |
| 1777 | for documentation. |
Marian Balakowicz | baf3124 | 2006-09-07 17:25:40 +0200 | [diff] [blame] | 1778 | |
| 1779 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1780 | See also "U-Boot Porting Guide" below. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1781 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1782 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1783 | Monitor Commands - Overview: |
| 1784 | ============================ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1785 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1786 | go - start application at address 'addr' |
| 1787 | run - run commands in an environment variable |
| 1788 | bootm - boot application image from memory |
| 1789 | bootp - boot image via network using BootP/TFTP protocol |
Marek Vasut | 44f074c | 2012-03-14 21:52:45 +0000 | [diff] [blame] | 1790 | bootz - boot zImage from memory |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1791 | tftpboot- boot image via network using TFTP protocol |
| 1792 | and env variables "ipaddr" and "serverip" |
| 1793 | (and eventually "gatewayip") |
Simon Glass | 1fb7cd4 | 2011-10-24 18:00:07 +0000 | [diff] [blame] | 1794 | tftpput - upload a file via network using TFTP protocol |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1795 | rarpboot- boot image via network using RARP/TFTP protocol |
| 1796 | diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' |
| 1797 | loads - load S-Record file over serial line |
| 1798 | loadb - load binary file over serial line (kermit mode) |
Rui Miguel Silva | bfef72e | 2022-05-11 10:55:40 +0100 | [diff] [blame] | 1799 | loadm - load binary blob from source address to destination address |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1800 | md - memory display |
| 1801 | mm - memory modify (auto-incrementing) |
| 1802 | nm - memory modify (constant address) |
| 1803 | mw - memory write (fill) |
Simon Glass | bdded20 | 2020-06-02 19:26:49 -0600 | [diff] [blame] | 1804 | ms - memory search |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1805 | cp - memory copy |
| 1806 | cmp - memory compare |
| 1807 | crc32 - checksum calculation |
Peter Tyser | 0f89c54 | 2009-04-18 22:34:03 -0500 | [diff] [blame] | 1808 | i2c - I2C sub-system |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1809 | sspi - SPI utility commands |
| 1810 | base - print or set address offset |
| 1811 | printenv- print environment variables |
Pragnesh Patel | 9e9a530 | 2020-12-22 11:30:05 +0530 | [diff] [blame] | 1812 | pwm - control pwm channels |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1813 | setenv - set environment variables |
| 1814 | saveenv - save environment variables to persistent storage |
| 1815 | protect - enable or disable FLASH write protection |
| 1816 | erase - erase FLASH memory |
| 1817 | flinfo - print FLASH memory information |
Karl O. Pinc | 10635af | 2012-08-03 05:57:21 +0000 | [diff] [blame] | 1818 | nand - NAND memory operations (see doc/README.nand) |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1819 | bdinfo - print Board Info structure |
| 1820 | iminfo - print header information for application image |
| 1821 | coninfo - print console devices and informations |
| 1822 | ide - IDE sub-system |
| 1823 | loop - infinite loop on address range |
wdenk | 56523f1 | 2004-07-11 17:40:54 +0000 | [diff] [blame] | 1824 | loopw - infinite write loop on address range |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1825 | mtest - simple RAM test |
| 1826 | icache - enable or disable instruction cache |
| 1827 | dcache - enable or disable data cache |
| 1828 | reset - Perform RESET of the CPU |
| 1829 | echo - echo args to console |
| 1830 | version - print monitor version |
| 1831 | help - print online help |
| 1832 | ? - alias for 'help' |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1833 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1834 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1835 | Monitor Commands - Detailed Description: |
| 1836 | ======================================== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1837 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1838 | TODO. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1839 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1840 | For now: just type "help <command>". |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1841 | |
| 1842 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1843 | Note for Redundant Ethernet Interfaces: |
| 1844 | ======================================= |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 1845 | |
Marcel Ziswiler | 11ccc33 | 2008-07-09 08:17:15 +0200 | [diff] [blame] | 1846 | Some boards come with redundant Ethernet interfaces; U-Boot supports |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1847 | such configurations and is capable of automatic selection of a |
| 1848 | "working" interface when needed. MAC assignment works as follows: |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 1849 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1850 | Network interfaces are numbered eth0, eth1, eth2, ... Corresponding |
| 1851 | MAC addresses can be stored in the environment as "ethaddr" (=>eth0), |
| 1852 | "eth1addr" (=>eth1), "eth2addr", ... |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 1853 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1854 | If the network interface stores some valid MAC address (for instance |
| 1855 | in SROM), this is used as default address if there is NO correspon- |
| 1856 | ding setting in the environment; if the corresponding environment |
| 1857 | variable is set, this overrides the settings in the card; that means: |
wdenk | f07771c | 2003-05-28 08:06:31 +0000 | [diff] [blame] | 1858 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1859 | o If the SROM has a valid MAC address, and there is no address in the |
| 1860 | environment, the SROM's address is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1861 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1862 | o If there is no valid address in the SROM, and a definition in the |
| 1863 | environment exists, then the value from the environment variable is |
| 1864 | used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1865 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1866 | o If both the SROM and the environment contain a MAC address, and |
| 1867 | both addresses are the same, this MAC address is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1868 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1869 | o If both the SROM and the environment contain a MAC address, and the |
| 1870 | addresses differ, the value from the environment is used and a |
| 1871 | warning is printed. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1872 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1873 | o If neither SROM nor the environment contain a MAC address, an error |
Joe Hershberger | bef1014 | 2015-05-04 14:55:13 -0500 | [diff] [blame] | 1874 | is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case |
| 1875 | a random, locally-assigned MAC is used. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1876 | |
Ben Warren | ecee932 | 2010-04-26 11:11:46 -0700 | [diff] [blame] | 1877 | If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses |
Wolfgang Denk | c0f4085 | 2011-10-26 10:21:21 +0000 | [diff] [blame] | 1878 | will be programmed into hardware as part of the initialization process. This |
Ben Warren | ecee932 | 2010-04-26 11:11:46 -0700 | [diff] [blame] | 1879 | may be skipped by setting the appropriate 'ethmacskip' environment variable. |
| 1880 | The naming convention is as follows: |
| 1881 | "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1882 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1883 | Image Formats: |
| 1884 | ============== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1885 | |
Marian Balakowicz | 3310c54 | 2008-03-12 12:13:13 +0100 | [diff] [blame] | 1886 | U-Boot is capable of booting (and performing other auxiliary operations on) |
| 1887 | images in two formats: |
| 1888 | |
| 1889 | New uImage format (FIT) |
| 1890 | ----------------------- |
| 1891 | |
| 1892 | Flexible and powerful format based on Flattened Image Tree -- FIT (similar |
| 1893 | to Flattened Device Tree). It allows the use of images with multiple |
| 1894 | components (several kernels, ramdisks, etc.), with contents protected by |
| 1895 | SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. |
| 1896 | |
| 1897 | |
| 1898 | Old uImage format |
| 1899 | ----------------- |
| 1900 | |
| 1901 | Old image format is based on binary files which can be basically anything, |
| 1902 | preceded by a special header; see the definitions in include/image.h for |
| 1903 | details; basically, the header defines the following image properties: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1904 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1905 | * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, |
| 1906 | 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, |
Peter Tyser | f5ed9e3 | 2008-09-08 14:56:49 -0500 | [diff] [blame] | 1907 | LynxOS, pSOS, QNX, RTEMS, INTEGRITY; |
Thomas Huth | 0797e73 | 2021-11-13 18:13:50 +0100 | [diff] [blame] | 1908 | Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY). |
Andy Shevchenko | daab59a | 2017-07-05 16:25:22 +0300 | [diff] [blame] | 1909 | * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, |
Tom Rini | 1123213 | 2022-04-06 09:21:25 -0400 | [diff] [blame] | 1910 | IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; |
| 1911 | Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC). |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1912 | * Compression Type (uncompressed, gzip, bzip2) |
| 1913 | * Load Address |
| 1914 | * Entry Point |
| 1915 | * Image Name |
| 1916 | * Image Timestamp |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1917 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1918 | The header is marked by a special Magic Number, and both the header |
| 1919 | and the data portions of the image are secured against corruption by |
| 1920 | CRC32 checksums. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1921 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1922 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1923 | Linux Support: |
| 1924 | ============== |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1925 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1926 | Although U-Boot should support any OS or standalone application |
| 1927 | easily, the main focus has always been on Linux during the design of |
| 1928 | U-Boot. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1929 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1930 | U-Boot includes many features that so far have been part of some |
| 1931 | special "boot loader" code within the Linux kernel. Also, any |
| 1932 | "initrd" images to be used are no longer part of one big Linux image; |
| 1933 | instead, kernel and "initrd" are separate images. This implementation |
| 1934 | serves several purposes: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1935 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1936 | - the same features can be used for other OS or standalone |
| 1937 | applications (for instance: using compressed images to reduce the |
| 1938 | Flash memory footprint) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1939 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1940 | - it becomes much easier to port new Linux kernel versions because |
| 1941 | lots of low-level, hardware dependent stuff are done by U-Boot |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1942 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1943 | - the same Linux kernel image can now be used with different "initrd" |
| 1944 | images; of course this also means that different kernel images can |
| 1945 | be run with the same "initrd". This makes testing easier (you don't |
| 1946 | have to build a new "zImage.initrd" Linux image when you just |
| 1947 | change a file in your "initrd"). Also, a field-upgrade of the |
| 1948 | software is easier now. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1949 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1950 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1951 | Linux HOWTO: |
| 1952 | ============ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1953 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1954 | Porting Linux to U-Boot based systems: |
| 1955 | --------------------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1956 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1957 | U-Boot cannot save you from doing all the necessary modifications to |
| 1958 | configure the Linux device drivers for use with your target hardware |
| 1959 | (no, we don't intend to provide a full virtual machine interface to |
| 1960 | Linux :-). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1961 | |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 1962 | But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1963 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1964 | Just make sure your machine specific header file (for instance |
| 1965 | include/asm-ppc/tqm8xx.h) includes the same definition of the Board |
Markus Heidelberg | 1dc3069 | 2008-09-07 20:18:27 +0200 | [diff] [blame] | 1966 | Information structure as we define in include/asm-<arch>/u-boot.h, |
| 1967 | and make sure that your definition of IMAP_ADDR uses the same value |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 1968 | as your U-Boot configuration in CONFIG_SYS_IMMR. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1969 | |
Simon Glass | 2eb31b1 | 2014-06-11 23:29:46 -0600 | [diff] [blame] | 1970 | Note that U-Boot now has a driver model, a unified model for drivers. |
| 1971 | If you are adding a new driver, plumb it into driver model. If there |
| 1972 | is no uclass available, you are encouraged to create one. See |
| 1973 | doc/driver-model. |
| 1974 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1975 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1976 | Configuring the Linux kernel: |
| 1977 | ----------------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1978 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1979 | No specific requirements for U-Boot. Make sure you have some root |
| 1980 | device (initial ramdisk, NFS) for your target system. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1981 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1982 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1983 | Building a Linux Image: |
| 1984 | ----------------------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1985 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1986 | With U-Boot, "normal" build targets like "zImage" or "bzImage" are |
| 1987 | not used. If you use recent kernel source, a new build target |
| 1988 | "uImage" will exist which automatically builds an image usable by |
| 1989 | U-Boot. Most older kernels also have support for a "pImage" target, |
| 1990 | which was introduced for our predecessor project PPCBoot and uses a |
| 1991 | 100% compatible format. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1992 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1993 | Example: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1994 | |
Holger Freyther | ab584d6 | 2014-08-04 09:26:05 +0200 | [diff] [blame] | 1995 | make TQM850L_defconfig |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 1996 | make oldconfig |
| 1997 | make dep |
| 1998 | make uImage |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 1999 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2000 | The "uImage" build target uses a special tool (in 'tools/mkimage') to |
| 2001 | encapsulate a compressed Linux kernel image with header information, |
| 2002 | CRC32 checksum etc. for use with U-Boot. This is what we are doing: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2003 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2004 | * build a standard "vmlinux" kernel image (in ELF binary format): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2005 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2006 | * convert the kernel into a raw binary image: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2007 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2008 | ${CROSS_COMPILE}-objcopy -O binary \ |
| 2009 | -R .note -R .comment \ |
| 2010 | -S vmlinux linux.bin |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2011 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2012 | * compress the binary image: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2013 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2014 | gzip -9 linux.bin |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2015 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2016 | * package compressed binary image for U-Boot: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2017 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2018 | mkimage -A ppc -O linux -T kernel -C gzip \ |
| 2019 | -a 0 -e 0 -n "Linux Kernel Image" \ |
| 2020 | -d linux.bin.gz uImage |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2021 | |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2022 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2023 | The "mkimage" tool can also be used to create ramdisk images for use |
| 2024 | with U-Boot, either separated from the Linux kernel image, or |
| 2025 | combined into one file. "mkimage" encapsulates the images with a 64 |
| 2026 | byte header containing information about target architecture, |
| 2027 | operating system, image type, compression method, entry points, time |
| 2028 | stamp, CRC32 checksums, etc. |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2029 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2030 | "mkimage" can be called in two ways: to verify existing images and |
| 2031 | print the header information, or to build new images. |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2032 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2033 | In the first form (with "-l" option) mkimage lists the information |
| 2034 | contained in the header of an existing U-Boot image; this includes |
| 2035 | checksum verification: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2036 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2037 | tools/mkimage -l image |
| 2038 | -l ==> list image header information |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2039 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2040 | The second form (with "-d" option) is used to build a U-Boot image |
| 2041 | from a "data file" which is used as image payload: |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2042 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2043 | tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ |
| 2044 | -n name -d data_file image |
| 2045 | -A ==> set architecture to 'arch' |
| 2046 | -O ==> set operating system to 'os' |
| 2047 | -T ==> set image type to 'type' |
| 2048 | -C ==> set compression type 'comp' |
| 2049 | -a ==> set load address to 'addr' (hex) |
| 2050 | -e ==> set entry point to 'ep' (hex) |
| 2051 | -n ==> set image name to 'name' |
| 2052 | -d ==> use image data from 'datafile' |
wdenk | 24ee89b | 2002-11-03 17:56:27 +0000 | [diff] [blame] | 2053 | |
wdenk | 6945979 | 2004-05-29 16:53:29 +0000 | [diff] [blame] | 2054 | Right now, all Linux kernels for PowerPC systems use the same load |
| 2055 | address (0x00000000), but the entry point address depends on the |
| 2056 | kernel version: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2057 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2058 | - 2.2.x kernels have the entry point at 0x0000000C, |
| 2059 | - 2.3.x and later kernels have the entry point at 0x00000000. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2060 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2061 | So a typical call to build a U-Boot image would read: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2062 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2063 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
| 2064 | > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 2065 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2066 | > examples/uImage.TQM850L |
| 2067 | Image Name: 2.4.4 kernel for TQM850L |
| 2068 | Created: Wed Jul 19 02:34:59 2000 |
| 2069 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 2070 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB |
| 2071 | Load Address: 0x00000000 |
| 2072 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2073 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2074 | To verify the contents of the image (or check for corruption): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2075 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2076 | -> tools/mkimage -l examples/uImage.TQM850L |
| 2077 | Image Name: 2.4.4 kernel for TQM850L |
| 2078 | Created: Wed Jul 19 02:34:59 2000 |
| 2079 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 2080 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB |
| 2081 | Load Address: 0x00000000 |
| 2082 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2083 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2084 | NOTE: for embedded systems where boot time is critical you can trade |
| 2085 | speed for memory and install an UNCOMPRESSED image instead: this |
| 2086 | needs more space in Flash, but boots much faster since it does not |
| 2087 | need to be uncompressed: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2088 | |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 2089 | -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2090 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ |
| 2091 | > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ |
Stefan Roese | a47a12b | 2010-04-15 16:07:28 +0200 | [diff] [blame] | 2092 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2093 | > examples/uImage.TQM850L-uncompressed |
| 2094 | Image Name: 2.4.4 kernel for TQM850L |
| 2095 | Created: Wed Jul 19 02:34:59 2000 |
| 2096 | Image Type: PowerPC Linux Kernel Image (uncompressed) |
| 2097 | Data Size: 792160 Bytes = 773.59 kB = 0.76 MB |
| 2098 | Load Address: 0x00000000 |
| 2099 | Entry Point: 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2100 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2101 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2102 | Similar you can build U-Boot images from a 'ramdisk.image.gz' file |
| 2103 | when your kernel is intended to use an initial ramdisk: |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 2104 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2105 | -> tools/mkimage -n 'Simple Ramdisk Image' \ |
| 2106 | > -A ppc -O linux -T ramdisk -C gzip \ |
| 2107 | > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd |
| 2108 | Image Name: Simple Ramdisk Image |
| 2109 | Created: Wed Jan 12 14:01:50 2000 |
| 2110 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) |
| 2111 | Data Size: 566530 Bytes = 553.25 kB = 0.54 MB |
| 2112 | Load Address: 0x00000000 |
| 2113 | Entry Point: 0x00000000 |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 2114 | |
Tyler Hicks | e157a11 | 2020-10-26 10:40:24 -0500 | [diff] [blame] | 2115 | The "dumpimage" tool can be used to disassemble or list the contents of images |
| 2116 | built by mkimage. See dumpimage's help output (-h) for details. |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 2117 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2118 | Installing a Linux Image: |
| 2119 | ------------------------- |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 2120 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2121 | To downloading a U-Boot image over the serial (console) interface, |
| 2122 | you must convert the image to S-Record format: |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 2123 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2124 | objcopy -I binary -O srec examples/image examples/image.srec |
wdenk | db01a2e | 2004-04-15 23:14:49 +0000 | [diff] [blame] | 2125 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2126 | The 'objcopy' does not understand the information in the U-Boot |
| 2127 | image header, so the resulting S-Record file will be relative to |
| 2128 | address 0x00000000. To load it to a given address, you need to |
| 2129 | specify the target address as 'offset' parameter with the 'loads' |
| 2130 | command. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2131 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2132 | Example: install the image to address 0x40100000 (which on the |
| 2133 | TQM8xxL is in the first Flash bank): |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2134 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2135 | => erase 40100000 401FFFFF |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2136 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2137 | .......... done |
| 2138 | Erased 8 sectors |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2139 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2140 | => loads 40100000 |
| 2141 | ## Ready for S-Record download ... |
| 2142 | ~>examples/image.srec |
| 2143 | 1 2 3 4 5 6 7 8 9 10 11 12 13 ... |
| 2144 | ... |
| 2145 | 15989 15990 15991 15992 |
| 2146 | [file transfer complete] |
| 2147 | [connected] |
| 2148 | ## Start Addr = 0x00000000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2149 | |
| 2150 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2151 | You can check the success of the download using the 'iminfo' command; |
Wolfgang Denk | 218ca72 | 2008-03-26 10:40:12 +0100 | [diff] [blame] | 2152 | this includes a checksum verification so you can be sure no data |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2153 | corruption happened: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2154 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2155 | => imi 40100000 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2156 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2157 | ## Checking Image at 40100000 ... |
| 2158 | Image Name: 2.2.13 for initrd on TQM850L |
| 2159 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 2160 | Data Size: 335725 Bytes = 327 kB = 0 MB |
| 2161 | Load Address: 00000000 |
| 2162 | Entry Point: 0000000c |
| 2163 | Verifying Checksum ... OK |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2164 | |
| 2165 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2166 | Boot Linux: |
| 2167 | ----------- |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2168 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2169 | The "bootm" command is used to boot an application that is stored in |
| 2170 | memory (RAM or Flash). In case of a Linux kernel image, the contents |
| 2171 | of the "bootargs" environment variable is passed to the kernel as |
| 2172 | parameters. You can check and modify this variable using the |
| 2173 | "printenv" and "setenv" commands: |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2174 | |
| 2175 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2176 | => printenv bootargs |
| 2177 | bootargs=root=/dev/ram |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2178 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2179 | => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2180 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2181 | => printenv bootargs |
| 2182 | bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2183 | |
wdenk | 2729af9 | 2004-05-03 20:45:30 +0000 | [diff] [blame] | 2184 | => bootm 40020000 |
| 2185 | ## Booting Linux kernel at 40020000 ... |
| 2186 | Image Name: 2.2.13 for NFS on TQM850L |
| 2187 | Image Type: PowerPC Linux Kernel Image (gzip compressed) |
| 2188 | Data Size: 381681 Bytes = 372 kB = 0 MB |
| 2189 | Load Address: 00000000 |
| 2190 | Entry Point: 0000000c |
| 2191 | Verifying Checksum ... OK |
| 2192 | Uncompressing Kernel Image ... OK |
| 2193 | Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000 |
| 2194 | Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 |
| 2195 | time_init: decrementer frequency = 187500000/60 |
| 2196 | Calibrating delay loop... 49.77 BogoMIPS |
| 2197 | Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] |
| |