Eric Lee / smarc-uboot

Download as
Browse Code ยป

Commit 75b3c3aa843911f152098acf8eb551d6bb9d4f13

Authored by Simon Glass
1 parent ad0e463954
Exists in v2017.01-smarct4x and in 40 other branches 8qm-imx_v2020.04_5.4.70_2.3.0, emb_lf_v2022.04, imx_v2015.04_4.1.15_1.0.0_ga, pitx_8mp_lf_v2020.04, smarc-8m-android-10.0.0_2.6.0, smarc-8m-android-11.0.0_2.0.0, smarc-8mp-android-11.0.0_2.0.0, smarc-imx6_v2018.03_4.14.98_2.0.0_ga, smarc-imx7_v2017.03_4.9.11_1.0.0_ga, smarc-imx7_v2018.03_4.14.98_2.0.0_ga, smarc-imx_v2015.04_4.1.15_1.0.0_ga, smarc-imx_v2017.03_4.9.11_1.0.0_ga, smarc-imx_v2017.03_4.9.88_2.0.0_ga, smarc-imx_v2017.03_o8.1.0_1.3.0_8m, smarc-imx_v2018.03_4.14.78_1.0.0_ga, smarc-m6.0.1_2.1.0-ga, smarc-n7.1.2_2.0.0-ga, smarc-rel_imx_4.1.15_2.0.0_ga, smarc_8m-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8m-imx_v2019.04_4.19.35_1.1.0, smarc_8m_00d0-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8mm-imx_v2018.03_4.14.98_2.0.0_ga, smarc_8mm-imx_v2019.04_4.19.35_1.1.0, smarc_8mm-imx_v2020.04_5.4.24_2.1.0, smarc_8mp_lf_v2020.04, smarc_8mq-imx_v2020.04_5.4.24_2.1.0, smarc_8mq_lf_v2020.04, ti-u-boot-2015.07, v2014.07, v2014.07-smarct33, v2014.07-smartmen, v2015.07-smarct33, v2015.07-smarct33-emmc, v2015.07-smarct4x, v2016.05-dlt, v2016.05-smarct3x, v2016.05-smarct3x-emmc, v2016.05-smarct4x, v2017.01-smarct3x, v2017.01-smarct3x-emmc

sandbox: Update and expand the README 

Now that sandbox has a good base of features, the README is quite out of
date. Update it, and document the new features.

Signed-off-by: Simon Glass <sjg@chromium.org>

Showing 2 changed files with 226 additions and 7 deletions Inline Diff

1 # 1 #
2 # (C) Copyright 2000 - 2013 2 # (C) Copyright 2000 - 2013
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de. 3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 # 4 #
5 # SPDX-License-Identifier: GPL-2.0+ 5 # SPDX-License-Identifier: GPL-2.0+
6 # 6 #
7 7
8 Summary: 8 Summary:
9 ======== 9 ========
10 10
11 This directory contains the source code for U-Boot, a boot loader for 11 This directory contains the source code for U-Boot, a boot loader for
12 Embedded boards based on PowerPC, ARM, MIPS and several other 12 Embedded boards based on PowerPC, ARM, MIPS and several other
13 processors, which can be installed in a boot ROM and used to 13 processors, which can be installed in a boot ROM and used to
14 initialize and test the hardware or to download and run application 14 initialize and test the hardware or to download and run application
15 code. 15 code.
16 16
17 The development of U-Boot is closely related to Linux: some parts of 17 The development of U-Boot is closely related to Linux: some parts of
18 the source code originate in the Linux source tree, we have some 18 the source code originate in the Linux source tree, we have some
19 header files in common, and special provision has been made to 19 header files in common, and special provision has been made to
20 support booting of Linux images. 20 support booting of Linux images.
21 21
22 Some attention has been paid to make this software easily 22 Some attention has been paid to make this software easily
23 configurable and extendable. For instance, all monitor commands are 23 configurable and extendable. For instance, all monitor commands are
24 implemented with the same call interface, so that it's very easy to 24 implemented with the same call interface, so that it's very easy to
25 add new commands. Also, instead of permanently adding rarely used 25 add new commands. Also, instead of permanently adding rarely used
26 code (for instance hardware test utilities) to the monitor, you can 26 code (for instance hardware test utilities) to the monitor, you can
27 load and run it dynamically. 27 load and run it dynamically.
28 28
29 29
30 Status: 30 Status:
31 ======= 31 =======
32 32
33 In general, all boards for which a configuration option exists in the 33 In general, all boards for which a configuration option exists in the
34 Makefile have been tested to some extent and can be considered 34 Makefile have been tested to some extent and can be considered
35 "working". In fact, many of them are used in production systems. 35 "working". In fact, many of them are used in production systems.
36 36
37 In case of problems see the CHANGELOG and CREDITS files to find out 37 In case of problems see the CHANGELOG and CREDITS files to find out
38 who contributed the specific port. The boards.cfg file lists board 38 who contributed the specific port. The boards.cfg file lists board
39 maintainers. 39 maintainers.
40 40
41 Note: There is no CHANGELOG file in the actual U-Boot source tree; 41 Note: There is no CHANGELOG file in the actual U-Boot source tree;
42 it can be created dynamically from the Git log using: 42 it can be created dynamically from the Git log using:
43 43
44 make CHANGELOG 44 make CHANGELOG
45 45
46 46
47 Where to get help: 47 Where to get help:
48 ================== 48 ==================
49 49
50 In case you have questions about, problems with or contributions for 50 In case you have questions about, problems with or contributions for
51 U-Boot you should send a message to the U-Boot mailing list at 51 U-Boot you should send a message to the U-Boot mailing list at
52 <u-boot@lists.denx.de>. There is also an archive of previous traffic 52 <u-boot@lists.denx.de>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's. 53 on the mailing list - please search the archive before asking FAQ's.
54 Please see http://lists.denx.de/pipermail/u-boot and 54 Please see http://lists.denx.de/pipermail/u-boot and
55 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot 55 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56 56
57 57
58 Where to get source code: 58 Where to get source code:
59 ========================= 59 =========================
60 60
61 The U-Boot source code is maintained in the git repository at 61 The U-Boot source code is maintained in the git repository at
62 git://www.denx.de/git/u-boot.git ; you can browse it online at 62 git://www.denx.de/git/u-boot.git ; you can browse it online at
63 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 63 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64 64
65 The "snapshot" links on this page allow you to download tarballs of 65 The "snapshot" links on this page allow you to download tarballs of
66 any version you might be interested in. Official releases are also 66 any version you might be interested in. Official releases are also
67 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 67 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68 directory. 68 directory.
69 69
70 Pre-built (and tested) images are available from 70 Pre-built (and tested) images are available from
71 ftp://ftp.denx.de/pub/u-boot/images/ 71 ftp://ftp.denx.de/pub/u-boot/images/
72 72
73 73
74 Where we come from: 74 Where we come from:
75 =================== 75 ===================
76 76
77 - start from 8xxrom sources 77 - start from 8xxrom sources
78 - create PPCBoot project (http://sourceforge.net/projects/ppcboot) 78 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79 - clean up code 79 - clean up code
80 - make it easier to add custom boards 80 - make it easier to add custom boards
81 - make it possible to add other [PowerPC] CPUs 81 - make it possible to add other [PowerPC] CPUs
82 - extend functions, especially: 82 - extend functions, especially:
83 * Provide extended interface to Linux boot loader 83 * Provide extended interface to Linux boot loader
84 * S-Record download 84 * S-Record download
85 * network boot 85 * network boot
86 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 86 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87 - create ARMBoot project (http://sourceforge.net/projects/armboot) 87 - create ARMBoot project (http://sourceforge.net/projects/armboot)
88 - add other CPU families (starting with ARM) 88 - add other CPU families (starting with ARM)
89 - create U-Boot project (http://sourceforge.net/projects/u-boot) 89 - create U-Boot project (http://sourceforge.net/projects/u-boot)
90 - current project page: see http://www.denx.de/wiki/U-Boot 90 - current project page: see http://www.denx.de/wiki/U-Boot
91 91
92 92
93 Names and Spelling: 93 Names and Spelling:
94 =================== 94 ===================
95 95
96 The "official" name of this project is "Das U-Boot". The spelling 96 The "official" name of this project is "Das U-Boot". The spelling
97 "U-Boot" shall be used in all written text (documentation, comments 97 "U-Boot" shall be used in all written text (documentation, comments
98 in source files etc.). Example: 98 in source files etc.). Example:
99 99
100 This is the README file for the U-Boot project. 100 This is the README file for the U-Boot project.
101 101
102 File names etc. shall be based on the string "u-boot". Examples: 102 File names etc. shall be based on the string "u-boot". Examples:
103 103
104 include/asm-ppc/u-boot.h 104 include/asm-ppc/u-boot.h
105 105
106 #include <asm/u-boot.h> 106 #include <asm/u-boot.h>
107 107
108 Variable names, preprocessor constants etc. shall be either based on 108 Variable names, preprocessor constants etc. shall be either based on
109 the string "u_boot" or on "U_BOOT". Example: 109 the string "u_boot" or on "U_BOOT". Example:
110 110
111 U_BOOT_VERSION u_boot_logo 111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start 112 IH_OS_U_BOOT u_boot_hush_start
113 113
114 114
115 Versioning: 115 Versioning:
116 =========== 116 ===========
117 117
118 Starting with the release in October 2008, the names of the releases 118 Starting with the release in October 2008, the names of the releases
119 were changed from numerical release numbers without deeper meaning 119 were changed from numerical release numbers without deeper meaning
120 into a time stamp based numbering. Regular releases are identified by 120 into a time stamp based numbering. Regular releases are identified by
121 names consisting of the calendar year and month of the release date. 121 names consisting of the calendar year and month of the release date.
122 Additional fields (if present) indicate release candidates or bug fix 122 Additional fields (if present) indicate release candidates or bug fix
123 releases in "stable" maintenance trees. 123 releases in "stable" maintenance trees.
124 124
125 Examples: 125 Examples:
126 U-Boot v2009.11 - Release November 2009 126 U-Boot v2009.11 - Release November 2009
127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
129 129
130 130
131 Directory Hierarchy: 131 Directory Hierarchy:
132 ==================== 132 ====================
133 133
134 /arch Architecture specific files 134 /arch Architecture specific files
135 /arc Files generic to ARC architecture 135 /arc Files generic to ARC architecture
136 /cpu CPU specific files 136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs 137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files 138 /lib Architecture specific library files
139 /arm Files generic to ARM architecture 139 /arm Files generic to ARM architecture
140 /cpu CPU specific files 140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs 141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs 142 /arm920t Files specific to ARM 920 CPUs
143 /at91 Files specific to Atmel AT91RM9200 CPU 143 /at91 Files specific to Atmel AT91RM9200 CPU
144 /imx Files specific to Freescale MC9328 i.MX CPUs 144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs 145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
146 /arm926ejs Files specific to ARM 926 CPUs 146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs 147 /arm1136 Files specific to ARM 1136 CPUs
148 /pxa Files specific to Intel XScale PXA CPUs 148 /pxa Files specific to Intel XScale PXA CPUs
149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs 149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files 150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture 151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files 152 /cpu CPU specific files
153 /lib Architecture specific library files 153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture 154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files 155 /cpu CPU specific files
156 /lib Architecture specific library files 156 /lib Architecture specific library files
157 /m68k Files generic to m68k architecture 157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files 158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files 164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture 165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files 166 /cpu CPU specific files
167 /lib Architecture specific library files 167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture 168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files 169 /cpu CPU specific files
170 /mips32 Files specific to MIPS32 CPUs 170 /mips32 Files specific to MIPS32 CPUs
171 /mips64 Files specific to MIPS64 CPUs 171 /mips64 Files specific to MIPS64 CPUs
172 /lib Architecture specific library files 172 /lib Architecture specific library files
173 /nds32 Files generic to NDS32 architecture 173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files 174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs 175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files 176 /lib Architecture specific library files
177 /nios2 Files generic to Altera NIOS2 architecture 177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files 178 /cpu CPU specific files
179 /lib Architecture specific library files 179 /lib Architecture specific library files
180 /openrisc Files generic to OpenRISC architecture 180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files 181 /cpu CPU specific files
182 /lib Architecture specific library files 182 /lib Architecture specific library files
183 /powerpc Files generic to PowerPC architecture 183 /powerpc Files generic to PowerPC architecture
184 /cpu CPU specific files 184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs 186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs 187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs 188 /mpc8xx Files specific to Freescale MPC8xx CPUs
189 /mpc824x Files specific to Freescale MPC824x CPUs 189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs 190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs 191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files 193 /lib Architecture specific library files
194 /sh Files generic to SH architecture 194 /sh Files generic to SH architecture
195 /cpu CPU specific files 195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs 196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs 197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs 198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files 199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture 200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files 201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU 202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU 203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files 204 /lib Architecture specific library files
205 /x86 Files generic to x86 architecture 205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files 206 /cpu CPU specific files
207 /lib Architecture specific library files 207 /lib Architecture specific library files
208 /api Machine/arch independent API for external apps 208 /api Machine/arch independent API for external apps
209 /board Board dependent files 209 /board Board dependent files
210 /common Misc architecture independent functions 210 /common Misc architecture independent functions
211 /disk Code for disk drive partition handling 211 /disk Code for disk drive partition handling
212 /doc Documentation (don't expect too much) 212 /doc Documentation (don't expect too much)
213 /drivers Commonly used device drivers 213 /drivers Commonly used device drivers
214 /dts Contains Makefile for building internal U-Boot fdt. 214 /dts Contains Makefile for building internal U-Boot fdt.
215 /examples Example code for standalone applications, etc. 215 /examples Example code for standalone applications, etc.
216 /fs Filesystem code (cramfs, ext2, jffs2, etc.) 216 /fs Filesystem code (cramfs, ext2, jffs2, etc.)
217 /include Header Files 217 /include Header Files
218 /lib Files generic to all architectures 218 /lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees 219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression 220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression 221 /lzo Library files to support LZO decompression
222 /net Networking code 222 /net Networking code
223 /post Power On Self Test 223 /post Power On Self Test
224 /spl Secondary Program Loader framework 224 /spl Secondary Program Loader framework
225 /tools Tools to build S-Record or U-Boot images, etc. 225 /tools Tools to build S-Record or U-Boot images, etc.
226 226
227 Software Configuration: 227 Software Configuration:
228 ======================= 228 =======================
229 229
230 Configuration is usually done using C preprocessor defines; the 230 Configuration is usually done using C preprocessor defines; the
231 rationale behind that is to avoid dead code whenever possible. 231 rationale behind that is to avoid dead code whenever possible.
232 232
233 There are two classes of configuration variables: 233 There are two classes of configuration variables:
234 234
235 * Configuration _OPTIONS_: 235 * Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with 236 These are selectable by the user and have names beginning with
237 "CONFIG_". 237 "CONFIG_".
238 238
239 * Configuration _SETTINGS_: 239 * Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if 240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with 241 you don't know what you're doing; they have names beginning with
242 "CONFIG_SYS_". 242 "CONFIG_SYS_".
243 243
244 Later we will add a configuration tool - probably similar to or even 244 Later we will add a configuration tool - probably similar to or even
245 identical to what's used for the Linux kernel. Right now, we have to 245 identical to what's used for the Linux kernel. Right now, we have to
246 do the configuration by hand, which means creating some symbolic 246 do the configuration by hand, which means creating some symbolic
247 links and editing some configuration files. We use the TQM8xxL boards 247 links and editing some configuration files. We use the TQM8xxL boards
248 as an example here. 248 as an example here.
249 249
250 250
251 Selection of Processor Architecture and Board Type: 251 Selection of Processor Architecture and Board Type:
252 --------------------------------------------------- 252 ---------------------------------------------------
253 253
254 For all supported boards there are ready-to-use default 254 For all supported boards there are ready-to-use default
255 configurations available; just type "make <board_name>_config". 255 configurations available; just type "make <board_name>_config".
256 256
257 Example: For a TQM823L module type: 257 Example: For a TQM823L module type:
258 258
259 cd u-boot 259 cd u-boot
260 make TQM823L_config 260 make TQM823L_config
261 261
262 For the Cogent platform, you need to specify the CPU type as well; 262 For the Cogent platform, you need to specify the CPU type as well;
263 e.g. "make cogent_mpc8xx_config". And also configure the cogent 263 e.g. "make cogent_mpc8xx_config". And also configure the cogent
264 directory according to the instructions in cogent/README. 264 directory according to the instructions in cogent/README.
265 265
266 266
267 Sandbox Environment:
268 --------------------
269
270 U-Boot can be built natively to run on a Linux host using the 'sandbox'
271 board. This allows feature development which is not board- or architecture-
272 specific to be undertaken on a native platform. The sandbox is also used to
273 run some of U-Boot's tests.
274
275 See board/sandbox/sandbox/README.sandbox for more details.
276
277
267 Configuration Options: 278 Configuration Options:
268 ---------------------- 279 ----------------------
269 280
270 Configuration depends on the combination of board and CPU type; all 281 Configuration depends on the combination of board and CPU type; all
271 such information is kept in a configuration file 282 such information is kept in a configuration file
272 "include/configs/<board_name>.h". 283 "include/configs/<board_name>.h".
273 284
274 Example: For a TQM823L module, all configuration settings are in 285 Example: For a TQM823L module, all configuration settings are in
275 "include/configs/TQM823L.h". 286 "include/configs/TQM823L.h".
276 287
277 288
278 Many of the options are named exactly as the corresponding Linux 289 Many of the options are named exactly as the corresponding Linux
279 kernel configuration options. The intention is to make it easier to 290 kernel configuration options. The intention is to make it easier to
280 build a config tool - later. 291 build a config tool - later.
281 292
282 293
283 The following options need to be configured: 294 The following options need to be configured:
284 295
285 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 296 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
286 297
287 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 298 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
288 299
289 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 300 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
290 Define exactly one, e.g. CONFIG_ATSTK1002 301 Define exactly one, e.g. CONFIG_ATSTK1002
291 302
292 - CPU Module Type: (if CONFIG_COGENT is defined) 303 - CPU Module Type: (if CONFIG_COGENT is defined)
293 Define exactly one of 304 Define exactly one of
294 CONFIG_CMA286_60_OLD 305 CONFIG_CMA286_60_OLD
295 --- FIXME --- not tested yet: 306 --- FIXME --- not tested yet:
296 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
297 CONFIG_CMA287_23, CONFIG_CMA287_50 308 CONFIG_CMA287_23, CONFIG_CMA287_50
298 309
299 - Motherboard Type: (if CONFIG_COGENT is defined) 310 - Motherboard Type: (if CONFIG_COGENT is defined)
300 Define exactly one of 311 Define exactly one of
301 CONFIG_CMA101, CONFIG_CMA102 312 CONFIG_CMA101, CONFIG_CMA102
302 313
303 - Motherboard I/O Modules: (if CONFIG_COGENT is defined) 314 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
304 Define one or more of 315 Define one or more of
305 CONFIG_CMA302 316 CONFIG_CMA302
306 317
307 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 318 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
308 Define one or more of 319 Define one or more of
309 CONFIG_LCD_HEARTBEAT - update a character position on 320 CONFIG_LCD_HEARTBEAT - update a character position on
310 the LCD display every second with 321 the LCD display every second with
311 a "rotator" |\-/|\-/ 322 a "rotator" |\-/|\-/
312 323
313 - Board flavour: (if CONFIG_MPC8260ADS is defined) 324 - Board flavour: (if CONFIG_MPC8260ADS is defined)
314 CONFIG_ADSTYPE 325 CONFIG_ADSTYPE
315 Possible values are: 326 Possible values are:
316 CONFIG_SYS_8260ADS - original MPC8260ADS 327 CONFIG_SYS_8260ADS - original MPC8260ADS
317 CONFIG_SYS_8266ADS - MPC8266ADS 328 CONFIG_SYS_8266ADS - MPC8266ADS
318 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 329 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
319 CONFIG_SYS_8272ADS - MPC8272ADS 330 CONFIG_SYS_8272ADS - MPC8272ADS
320 331
321 - Marvell Family Member 332 - Marvell Family Member
322 CONFIG_SYS_MVFS - define it if you want to enable 333 CONFIG_SYS_MVFS - define it if you want to enable
323 multiple fs option at one time 334 multiple fs option at one time
324 for marvell soc family 335 for marvell soc family
325 336
326 - MPC824X Family Member (if CONFIG_MPC824X is defined) 337 - MPC824X Family Member (if CONFIG_MPC824X is defined)
327 Define exactly one of 338 Define exactly one of
328 CONFIG_MPC8240, CONFIG_MPC8245 339 CONFIG_MPC8240, CONFIG_MPC8245
329 340
330 - 8xx CPU Options: (if using an MPC8xx CPU) 341 - 8xx CPU Options: (if using an MPC8xx CPU)
331 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 342 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
332 get_gclk_freq() cannot work 343 get_gclk_freq() cannot work
333 e.g. if there is no 32KHz 344 e.g. if there is no 32KHz
334 reference PIT/RTC clock 345 reference PIT/RTC clock
335 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 346 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
336 or XTAL/EXTAL) 347 or XTAL/EXTAL)
337 348
338 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 349 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
339 CONFIG_SYS_8xx_CPUCLK_MIN 350 CONFIG_SYS_8xx_CPUCLK_MIN
340 CONFIG_SYS_8xx_CPUCLK_MAX 351 CONFIG_SYS_8xx_CPUCLK_MAX
341 CONFIG_8xx_CPUCLK_DEFAULT 352 CONFIG_8xx_CPUCLK_DEFAULT
342 See doc/README.MPC866 353 See doc/README.MPC866
343 354
344 CONFIG_SYS_MEASURE_CPUCLK 355 CONFIG_SYS_MEASURE_CPUCLK
345 356
346 Define this to measure the actual CPU clock instead 357 Define this to measure the actual CPU clock instead
347 of relying on the correctness of the configured 358 of relying on the correctness of the configured
348 values. Mostly useful for board bringup to make sure 359 values. Mostly useful for board bringup to make sure
349 the PLL is locked at the intended frequency. Note 360 the PLL is locked at the intended frequency. Note
350 that this requires a (stable) reference clock (32 kHz 361 that this requires a (stable) reference clock (32 kHz
351 RTC clock or CONFIG_SYS_8XX_XIN) 362 RTC clock or CONFIG_SYS_8XX_XIN)
352 363
353 CONFIG_SYS_DELAYED_ICACHE 364 CONFIG_SYS_DELAYED_ICACHE
354 365
355 Define this option if you want to enable the 366 Define this option if you want to enable the
356 ICache only when Code runs from RAM. 367 ICache only when Code runs from RAM.
357 368
358 - 85xx CPU Options: 369 - 85xx CPU Options:
359 CONFIG_SYS_PPC64 370 CONFIG_SYS_PPC64
360 371
361 Specifies that the core is a 64-bit PowerPC implementation (implements 372 Specifies that the core is a 64-bit PowerPC implementation (implements
362 the "64" category of the Power ISA). This is necessary for ePAPR 373 the "64" category of the Power ISA). This is necessary for ePAPR
363 compliance, among other possible reasons. 374 compliance, among other possible reasons.
364 375
365 CONFIG_SYS_FSL_TBCLK_DIV 376 CONFIG_SYS_FSL_TBCLK_DIV
366 377
367 Defines the core time base clock divider ratio compared to the 378 Defines the core time base clock divider ratio compared to the
368 system clock. On most PQ3 devices this is 8, on newer QorIQ 379 system clock. On most PQ3 devices this is 8, on newer QorIQ
369 devices it can be 16 or 32. The ratio varies from SoC to Soc. 380 devices it can be 16 or 32. The ratio varies from SoC to Soc.
370 381
371 CONFIG_SYS_FSL_PCIE_COMPAT 382 CONFIG_SYS_FSL_PCIE_COMPAT
372 383
373 Defines the string to utilize when trying to match PCIe device 384 Defines the string to utilize when trying to match PCIe device
374 tree nodes for the given platform. 385 tree nodes for the given platform.
375 386
376 CONFIG_SYS_PPC_E500_DEBUG_TLB 387 CONFIG_SYS_PPC_E500_DEBUG_TLB
377 388
378 Enables a temporary TLB entry to be used during boot to work 389 Enables a temporary TLB entry to be used during boot to work
379 around limitations in e500v1 and e500v2 external debugger 390 around limitations in e500v1 and e500v2 external debugger
380 support. This reduces the portions of the boot code where 391 support. This reduces the portions of the boot code where
381 breakpoints and single stepping do not work. The value of this 392 breakpoints and single stepping do not work. The value of this
382 symbol should be set to the TLB1 entry to be used for this 393 symbol should be set to the TLB1 entry to be used for this
383 purpose. 394 purpose.
384 395
385 CONFIG_SYS_FSL_ERRATUM_A004510 396 CONFIG_SYS_FSL_ERRATUM_A004510
386 397
387 Enables a workaround for erratum A004510. If set, 398 Enables a workaround for erratum A004510. If set,
388 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 399 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
389 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 400 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
390 401
391 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 402 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
392 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
393 404
394 Defines one or two SoC revisions (low 8 bits of SVR) 405 Defines one or two SoC revisions (low 8 bits of SVR)
395 for which the A004510 workaround should be applied. 406 for which the A004510 workaround should be applied.
396 407
397 The rest of SVR is either not relevant to the decision 408 The rest of SVR is either not relevant to the decision
398 of whether the erratum is present (e.g. p2040 versus 409 of whether the erratum is present (e.g. p2040 versus
399 p2041) or is implied by the build target, which controls 410 p2041) or is implied by the build target, which controls
400 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 411 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
401 412
402 See Freescale App Note 4493 for more information about 413 See Freescale App Note 4493 for more information about
403 this erratum. 414 this erratum.
404 415
405 CONFIG_A003399_NOR_WORKAROUND 416 CONFIG_A003399_NOR_WORKAROUND
406 Enables a workaround for IFC erratum A003399. It is only 417 Enables a workaround for IFC erratum A003399. It is only
407 requred during NOR boot. 418 requred during NOR boot.
408 419
409 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 420 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
410 421
411 This is the value to write into CCSR offset 0x18600 422 This is the value to write into CCSR offset 0x18600
412 according to the A004510 workaround. 423 according to the A004510 workaround.
413 424
414 CONFIG_SYS_FSL_DSP_DDR_ADDR 425 CONFIG_SYS_FSL_DSP_DDR_ADDR
415 This value denotes start offset of DDR memory which is 426 This value denotes start offset of DDR memory which is
416 connected exclusively to the DSP cores. 427 connected exclusively to the DSP cores.
417 428
418 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 429 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
419 This value denotes start offset of M2 memory 430 This value denotes start offset of M2 memory
420 which is directly connected to the DSP core. 431 which is directly connected to the DSP core.
421 432
422 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 433 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
423 This value denotes start offset of M3 memory which is directly 434 This value denotes start offset of M3 memory which is directly
424 connected to the DSP core. 435 connected to the DSP core.
425 436
426 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 437 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
427 This value denotes start offset of DSP CCSR space. 438 This value denotes start offset of DSP CCSR space.
428 439
429 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 440 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
430 Single Source Clock is clocking mode present in some of FSL SoC's. 441 Single Source Clock is clocking mode present in some of FSL SoC's.
431 In this mode, a single differential clock is used to supply 442 In this mode, a single differential clock is used to supply
432 clocks to the sysclock, ddrclock and usbclock. 443 clocks to the sysclock, ddrclock and usbclock.
433 444
434 CONFIG_SYS_CPC_REINIT_F 445 CONFIG_SYS_CPC_REINIT_F
435 This CONFIG is defined when the CPC is configured as SRAM at the 446 This CONFIG is defined when the CPC is configured as SRAM at the
436 time of U-boot entry and is required to be re-initialized. 447 time of U-boot entry and is required to be re-initialized.
437 448
438 CONFIG_DEEP_SLEEP 449 CONFIG_DEEP_SLEEP
439 Inidcates this SoC supports deep sleep feature. If deep sleep is 450 Inidcates this SoC supports deep sleep feature. If deep sleep is
440 supported, core will start to execute uboot when wakes up. 451 supported, core will start to execute uboot when wakes up.
441 452
442 - Generic CPU options: 453 - Generic CPU options:
443 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 454 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
444 455
445 Defines the endianess of the CPU. Implementation of those 456 Defines the endianess of the CPU. Implementation of those
446 values is arch specific. 457 values is arch specific.
447 458
448 CONFIG_SYS_FSL_DDR 459 CONFIG_SYS_FSL_DDR
449 Freescale DDR driver in use. This type of DDR controller is 460 Freescale DDR driver in use. This type of DDR controller is
450 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 461 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
451 SoCs. 462 SoCs.
452 463
453 CONFIG_SYS_FSL_DDR_ADDR 464 CONFIG_SYS_FSL_DDR_ADDR
454 Freescale DDR memory-mapped register base. 465 Freescale DDR memory-mapped register base.
455 466
456 CONFIG_SYS_FSL_DDR_EMU 467 CONFIG_SYS_FSL_DDR_EMU
457 Specify emulator support for DDR. Some DDR features such as 468 Specify emulator support for DDR. Some DDR features such as
458 deskew training are not available. 469 deskew training are not available.
459 470
460 CONFIG_SYS_FSL_DDRC_GEN1 471 CONFIG_SYS_FSL_DDRC_GEN1
461 Freescale DDR1 controller. 472 Freescale DDR1 controller.
462 473
463 CONFIG_SYS_FSL_DDRC_GEN2 474 CONFIG_SYS_FSL_DDRC_GEN2
464 Freescale DDR2 controller. 475 Freescale DDR2 controller.
465 476
466 CONFIG_SYS_FSL_DDRC_GEN3 477 CONFIG_SYS_FSL_DDRC_GEN3
467 Freescale DDR3 controller. 478 Freescale DDR3 controller.
468 479
469 CONFIG_SYS_FSL_DDRC_GEN4 480 CONFIG_SYS_FSL_DDRC_GEN4
470 Freescale DDR4 controller. 481 Freescale DDR4 controller.
471 482
472 CONFIG_SYS_FSL_DDRC_ARM_GEN3 483 CONFIG_SYS_FSL_DDRC_ARM_GEN3
473 Freescale DDR3 controller for ARM-based SoCs. 484 Freescale DDR3 controller for ARM-based SoCs.
474 485
475 CONFIG_SYS_FSL_DDR1 486 CONFIG_SYS_FSL_DDR1
476 Board config to use DDR1. It can be enabled for SoCs with 487 Board config to use DDR1. It can be enabled for SoCs with
477 Freescale DDR1 or DDR2 controllers, depending on the board 488 Freescale DDR1 or DDR2 controllers, depending on the board
478 implemetation. 489 implemetation.
479 490
480 CONFIG_SYS_FSL_DDR2 491 CONFIG_SYS_FSL_DDR2
481 Board config to use DDR2. It can be eanbeld for SoCs with 492 Board config to use DDR2. It can be eanbeld for SoCs with
482 Freescale DDR2 or DDR3 controllers, depending on the board 493 Freescale DDR2 or DDR3 controllers, depending on the board
483 implementation. 494 implementation.
484 495
485 CONFIG_SYS_FSL_DDR3 496 CONFIG_SYS_FSL_DDR3
486 Board config to use DDR3. It can be enabled for SoCs with 497 Board config to use DDR3. It can be enabled for SoCs with
487 Freescale DDR3 or DDR3L controllers. 498 Freescale DDR3 or DDR3L controllers.
488 499
489 CONFIG_SYS_FSL_DDR3L 500 CONFIG_SYS_FSL_DDR3L
490 Board config to use DDR3L. It can be enabled for SoCs with 501 Board config to use DDR3L. It can be enabled for SoCs with
491 DDR3L controllers. 502 DDR3L controllers.
492 503
493 CONFIG_SYS_FSL_DDR4 504 CONFIG_SYS_FSL_DDR4
494 Board config to use DDR4. It can be enabled for SoCs with 505 Board config to use DDR4. It can be enabled for SoCs with
495 DDR4 controllers. 506 DDR4 controllers.
496 507
497 CONFIG_SYS_FSL_IFC_BE 508 CONFIG_SYS_FSL_IFC_BE
498 Defines the IFC controller register space as Big Endian 509 Defines the IFC controller register space as Big Endian
499 510
500 CONFIG_SYS_FSL_IFC_LE 511 CONFIG_SYS_FSL_IFC_LE
501 Defines the IFC controller register space as Little Endian 512 Defines the IFC controller register space as Little Endian
502 513
503 CONFIG_SYS_FSL_PBL_PBI 514 CONFIG_SYS_FSL_PBL_PBI
504 It enables addition of RCW (Power on reset configuration) in built image. 515 It enables addition of RCW (Power on reset configuration) in built image.
505 Please refer doc/README.pblimage for more details 516 Please refer doc/README.pblimage for more details
506 517
507 CONFIG_SYS_FSL_PBL_RCW 518 CONFIG_SYS_FSL_PBL_RCW
508 It adds PBI(pre-boot instructions) commands in u-boot build image. 519 It adds PBI(pre-boot instructions) commands in u-boot build image.
509 PBI commands can be used to configure SoC before it starts the execution. 520 PBI commands can be used to configure SoC before it starts the execution.
510 Please refer doc/README.pblimage for more details 521 Please refer doc/README.pblimage for more details
511 522
512 CONFIG_SPL_FSL_PBL 523 CONFIG_SPL_FSL_PBL
513 It adds a target to create boot binary having SPL binary in PBI format 524 It adds a target to create boot binary having SPL binary in PBI format
514 concatenated with u-boot binary. 525 concatenated with u-boot binary.
515 526
516 CONFIG_SYS_FSL_DDR_BE 527 CONFIG_SYS_FSL_DDR_BE
517 Defines the DDR controller register space as Big Endian 528 Defines the DDR controller register space as Big Endian
518 529
519 CONFIG_SYS_FSL_DDR_LE 530 CONFIG_SYS_FSL_DDR_LE
520 Defines the DDR controller register space as Little Endian 531 Defines the DDR controller register space as Little Endian
521 532
522 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 533 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
523 Physical address from the view of DDR controllers. It is the 534 Physical address from the view of DDR controllers. It is the
524 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 535 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
525 it could be different for ARM SoCs. 536 it could be different for ARM SoCs.
526 537
527 CONFIG_SYS_FSL_DDR_INTLV_256B 538 CONFIG_SYS_FSL_DDR_INTLV_256B
528 DDR controller interleaving on 256-byte. This is a special 539 DDR controller interleaving on 256-byte. This is a special
529 interleaving mode, handled by Dickens for Freescale layerscape 540 interleaving mode, handled by Dickens for Freescale layerscape
530 SoCs with ARM core. 541 SoCs with ARM core.
531 542
532 - Intel Monahans options: 543 - Intel Monahans options:
533 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 544 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
534 545
535 Defines the Monahans run mode to oscillator 546 Defines the Monahans run mode to oscillator
536 ratio. Valid values are 8, 16, 24, 31. The core 547 ratio. Valid values are 8, 16, 24, 31. The core
537 frequency is this value multiplied by 13 MHz. 548 frequency is this value multiplied by 13 MHz.
538 549
539 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 550 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
540 551
541 Defines the Monahans turbo mode to oscillator 552 Defines the Monahans turbo mode to oscillator
542 ratio. Valid values are 1 (default if undefined) and 553 ratio. Valid values are 1 (default if undefined) and
543 2. The core frequency as calculated above is multiplied 554 2. The core frequency as calculated above is multiplied
544 by this value. 555 by this value.
545 556
546 - MIPS CPU options: 557 - MIPS CPU options:
547 CONFIG_SYS_INIT_SP_OFFSET 558 CONFIG_SYS_INIT_SP_OFFSET
548 559
549 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 560 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
550 pointer. This is needed for the temporary stack before 561 pointer. This is needed for the temporary stack before
551 relocation. 562 relocation.
552 563
553 CONFIG_SYS_MIPS_CACHE_MODE 564 CONFIG_SYS_MIPS_CACHE_MODE
554 565
555 Cache operation mode for the MIPS CPU. 566 Cache operation mode for the MIPS CPU.
556 See also arch/mips/include/asm/mipsregs.h. 567 See also arch/mips/include/asm/mipsregs.h.
557 Possible values are: 568 Possible values are:
558 CONF_CM_CACHABLE_NO_WA 569 CONF_CM_CACHABLE_NO_WA
559 CONF_CM_CACHABLE_WA 570 CONF_CM_CACHABLE_WA
560 CONF_CM_UNCACHED 571 CONF_CM_UNCACHED
561 CONF_CM_CACHABLE_NONCOHERENT 572 CONF_CM_CACHABLE_NONCOHERENT
562 CONF_CM_CACHABLE_CE 573 CONF_CM_CACHABLE_CE
563 CONF_CM_CACHABLE_COW 574 CONF_CM_CACHABLE_COW
564 CONF_CM_CACHABLE_CUW 575 CONF_CM_CACHABLE_CUW
565 CONF_CM_CACHABLE_ACCELERATED 576 CONF_CM_CACHABLE_ACCELERATED
566 577
567 CONFIG_SYS_XWAY_EBU_BOOTCFG 578 CONFIG_SYS_XWAY_EBU_BOOTCFG
568 579
569 Special option for Lantiq XWAY SoCs for booting from NOR flash. 580 Special option for Lantiq XWAY SoCs for booting from NOR flash.
570 See also arch/mips/cpu/mips32/start.S. 581 See also arch/mips/cpu/mips32/start.S.
571 582
572 CONFIG_XWAY_SWAP_BYTES 583 CONFIG_XWAY_SWAP_BYTES
573 584
574 Enable compilation of tools/xway-swap-bytes needed for Lantiq 585 Enable compilation of tools/xway-swap-bytes needed for Lantiq
575 XWAY SoCs for booting from NOR flash. The U-Boot image needs to 586 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
576 be swapped if a flash programmer is used. 587 be swapped if a flash programmer is used.
577 588
578 - ARM options: 589 - ARM options:
579 CONFIG_SYS_EXCEPTION_VECTORS_HIGH 590 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
580 591
581 Select high exception vectors of the ARM core, e.g., do not 592 Select high exception vectors of the ARM core, e.g., do not
582 clear the V bit of the c1 register of CP15. 593 clear the V bit of the c1 register of CP15.
583 594
584 CONFIG_SYS_THUMB_BUILD 595 CONFIG_SYS_THUMB_BUILD
585 596
586 Use this flag to build U-Boot using the Thumb instruction 597 Use this flag to build U-Boot using the Thumb instruction
587 set for ARM architectures. Thumb instruction set provides 598 set for ARM architectures. Thumb instruction set provides
588 better code density. For ARM architectures that support 599 better code density. For ARM architectures that support
589 Thumb2 this flag will result in Thumb2 code generated by 600 Thumb2 this flag will result in Thumb2 code generated by
590 GCC. 601 GCC.
591 602
592 CONFIG_ARM_ERRATA_716044 603 CONFIG_ARM_ERRATA_716044
593 CONFIG_ARM_ERRATA_742230 604 CONFIG_ARM_ERRATA_742230
594 CONFIG_ARM_ERRATA_743622 605 CONFIG_ARM_ERRATA_743622
595 CONFIG_ARM_ERRATA_751472 606 CONFIG_ARM_ERRATA_751472
596 CONFIG_ARM_ERRATA_794072 607 CONFIG_ARM_ERRATA_794072
597 CONFIG_ARM_ERRATA_761320 608 CONFIG_ARM_ERRATA_761320
598 609
599 If set, the workarounds for these ARM errata are applied early 610 If set, the workarounds for these ARM errata are applied early
600 during U-Boot startup. Note that these options force the 611 during U-Boot startup. Note that these options force the
601 workarounds to be applied; no CPU-type/version detection 612 workarounds to be applied; no CPU-type/version detection
602 exists, unlike the similar options in the Linux kernel. Do not 613 exists, unlike the similar options in the Linux kernel. Do not
603 set these options unless they apply! 614 set these options unless they apply!
604 615
605 - CPU timer options: 616 - CPU timer options:
606 CONFIG_SYS_HZ 617 CONFIG_SYS_HZ
607 618
608 The frequency of the timer returned by get_timer(). 619 The frequency of the timer returned by get_timer().
609 get_timer() must operate in milliseconds and this CONFIG 620 get_timer() must operate in milliseconds and this CONFIG
610 option must be set to 1000. 621 option must be set to 1000.
611 622
612 - Linux Kernel Interface: 623 - Linux Kernel Interface:
613 CONFIG_CLOCKS_IN_MHZ 624 CONFIG_CLOCKS_IN_MHZ
614 625
615 U-Boot stores all clock information in Hz 626 U-Boot stores all clock information in Hz
616 internally. For binary compatibility with older Linux 627 internally. For binary compatibility with older Linux
617 kernels (which expect the clocks passed in the 628 kernels (which expect the clocks passed in the
618 bd_info data to be in MHz) the environment variable 629 bd_info data to be in MHz) the environment variable
619 "clocks_in_mhz" can be defined so that U-Boot 630 "clocks_in_mhz" can be defined so that U-Boot
620 converts clock data to MHZ before passing it to the 631 converts clock data to MHZ before passing it to the
621 Linux kernel. 632 Linux kernel.
622 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 633 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
623 "clocks_in_mhz=1" is automatically included in the 634 "clocks_in_mhz=1" is automatically included in the
624 default environment. 635 default environment.
625 636
626 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 637 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
627 638
628 When transferring memsize parameter to linux, some versions 639 When transferring memsize parameter to linux, some versions
629 expect it to be in bytes, others in MB. 640 expect it to be in bytes, others in MB.
630 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 641 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
631 642
632 CONFIG_OF_LIBFDT 643 CONFIG_OF_LIBFDT
633 644
634 New kernel versions are expecting firmware settings to be 645 New kernel versions are expecting firmware settings to be
635 passed using flattened device trees (based on open firmware 646 passed using flattened device trees (based on open firmware
636 concepts). 647 concepts).
637 648
638 CONFIG_OF_LIBFDT 649 CONFIG_OF_LIBFDT
639 * New libfdt-based support 650 * New libfdt-based support
640 * Adds the "fdt" command 651 * Adds the "fdt" command
641 * The bootm command automatically updates the fdt 652 * The bootm command automatically updates the fdt
642 653
643 OF_CPU - The proper name of the cpus node (only required for 654 OF_CPU - The proper name of the cpus node (only required for
644 MPC512X and MPC5xxx based boards). 655 MPC512X and MPC5xxx based boards).
645 OF_SOC - The proper name of the soc node (only required for 656 OF_SOC - The proper name of the soc node (only required for
646 MPC512X and MPC5xxx based boards). 657 MPC512X and MPC5xxx based boards).
647 OF_TBCLK - The timebase frequency. 658 OF_TBCLK - The timebase frequency.
648 OF_STDOUT_PATH - The path to the console device 659 OF_STDOUT_PATH - The path to the console device
649 660
650 boards with QUICC Engines require OF_QE to set UCC MAC 661 boards with QUICC Engines require OF_QE to set UCC MAC
651 addresses 662 addresses
652 663
653 CONFIG_OF_BOARD_SETUP 664 CONFIG_OF_BOARD_SETUP
654 665
655 Board code has addition modification that it wants to make 666 Board code has addition modification that it wants to make
656 to the flat device tree before handing it off to the kernel 667 to the flat device tree before handing it off to the kernel
657 668
658 CONFIG_OF_BOOT_CPU 669 CONFIG_OF_BOOT_CPU
659 670
660 This define fills in the correct boot CPU in the boot 671 This define fills in the correct boot CPU in the boot
661 param header, the default value is zero if undefined. 672 param header, the default value is zero if undefined.
662 673
663 CONFIG_OF_IDE_FIXUP 674 CONFIG_OF_IDE_FIXUP
664 675
665 U-Boot can detect if an IDE device is present or not. 676 U-Boot can detect if an IDE device is present or not.
666 If not, and this new config option is activated, U-Boot 677 If not, and this new config option is activated, U-Boot
667 removes the ATA node from the DTS before booting Linux, 678 removes the ATA node from the DTS before booting Linux,
668 so the Linux IDE driver does not probe the device and 679 so the Linux IDE driver does not probe the device and
669 crash. This is needed for buggy hardware (uc101) where 680 crash. This is needed for buggy hardware (uc101) where
670 no pull down resistor is connected to the signal IDE5V_DD7. 681 no pull down resistor is connected to the signal IDE5V_DD7.
671 682
672 CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 683 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
673 684
674 This setting is mandatory for all boards that have only one 685 This setting is mandatory for all boards that have only one
675 machine type and must be used to specify the machine type 686 machine type and must be used to specify the machine type
676 number as it appears in the ARM machine registry 687 number as it appears in the ARM machine registry
677 (see http://www.arm.linux.org.uk/developer/machines/). 688 (see http://www.arm.linux.org.uk/developer/machines/).
678 Only boards that have multiple machine types supported 689 Only boards that have multiple machine types supported
679 in a single configuration file and the machine type is 690 in a single configuration file and the machine type is
680 runtime discoverable, do not have to use this setting. 691 runtime discoverable, do not have to use this setting.
681 692
682 - vxWorks boot parameters: 693 - vxWorks boot parameters:
683 694
684 bootvx constructs a valid bootline using the following 695 bootvx constructs a valid bootline using the following
685 environments variables: bootfile, ipaddr, serverip, hostname. 696 environments variables: bootfile, ipaddr, serverip, hostname.
686 It loads the vxWorks image pointed bootfile. 697 It loads the vxWorks image pointed bootfile.
687 698
688 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 699 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
689 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 700 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
690 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 701 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
691 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 702 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
692 703
693 CONFIG_SYS_VXWORKS_ADD_PARAMS 704 CONFIG_SYS_VXWORKS_ADD_PARAMS
694 705
695 Add it at the end of the bootline. E.g "u=username pw=secret" 706 Add it at the end of the bootline. E.g "u=username pw=secret"
696 707
697 Note: If a "bootargs" environment is defined, it will overwride 708 Note: If a "bootargs" environment is defined, it will overwride
698 the defaults discussed just above. 709 the defaults discussed just above.
699 710
700 - Cache Configuration: 711 - Cache Configuration:
701 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 712 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
702 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 713 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
703 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 714 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
704 715
705 - Cache Configuration for ARM: 716 - Cache Configuration for ARM:
706 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 717 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
707 controller 718 controller
708 CONFIG_SYS_PL310_BASE - Physical base address of PL310 719 CONFIG_SYS_PL310_BASE - Physical base address of PL310
709 controller register space 720 controller register space
710 721
711 - Serial Ports: 722 - Serial Ports:
712 CONFIG_PL010_SERIAL 723 CONFIG_PL010_SERIAL
713 724
714 Define this if you want support for Amba PrimeCell PL010 UARTs. 725 Define this if you want support for Amba PrimeCell PL010 UARTs.
715 726
716 CONFIG_PL011_SERIAL 727 CONFIG_PL011_SERIAL
717 728
718 Define this if you want support for Amba PrimeCell PL011 UARTs. 729 Define this if you want support for Amba PrimeCell PL011 UARTs.
719 730
720 CONFIG_PL011_CLOCK 731 CONFIG_PL011_CLOCK
721 732
722 If you have Amba PrimeCell PL011 UARTs, set this variable to 733 If you have Amba PrimeCell PL011 UARTs, set this variable to
723 the clock speed of the UARTs. 734 the clock speed of the UARTs.
724 735
725 CONFIG_PL01x_PORTS 736 CONFIG_PL01x_PORTS
726 737
727 If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 738 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
728 define this to a list of base addresses for each (supported) 739 define this to a list of base addresses for each (supported)
729 port. See e.g. include/configs/versatile.h 740 port. See e.g. include/configs/versatile.h
730 741
731 CONFIG_PL011_SERIAL_RLCR 742 CONFIG_PL011_SERIAL_RLCR
732 743
733 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 744 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
734 have separate receive and transmit line control registers. Set 745 have separate receive and transmit line control registers. Set
735 this variable to initialize the extra register. 746 this variable to initialize the extra register.
736 747
737 CONFIG_PL011_SERIAL_FLUSH_ON_INIT 748 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
738 749
739 On some platforms (e.g. U8500) U-Boot is loaded by a second stage 750 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
740 boot loader that has already initialized the UART. Define this 751 boot loader that has already initialized the UART. Define this
741 variable to flush the UART at init time. 752 variable to flush the UART at init time.
742 753
743 754
744 - Console Interface: 755 - Console Interface:
745 Depending on board, define exactly one serial port 756 Depending on board, define exactly one serial port
746 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 757 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
747 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 758 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
748 console by defining CONFIG_8xx_CONS_NONE 759 console by defining CONFIG_8xx_CONS_NONE
749 760
750 Note: if CONFIG_8xx_CONS_NONE is defined, the serial 761 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
751 port routines must be defined elsewhere 762 port routines must be defined elsewhere
752 (i.e. serial_init(), serial_getc(), ...) 763 (i.e. serial_init(), serial_getc(), ...)
753 764
754 CONFIG_CFB_CONSOLE 765 CONFIG_CFB_CONSOLE
755 Enables console device for a color framebuffer. Needs following 766 Enables console device for a color framebuffer. Needs following
756 defines (cf. smiLynxEM, i8042) 767 defines (cf. smiLynxEM, i8042)
757 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 768 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
758 (default big endian) 769 (default big endian)
759 VIDEO_HW_RECTFILL graphic chip supports 770 VIDEO_HW_RECTFILL graphic chip supports
760 rectangle fill 771 rectangle fill
761 (cf. smiLynxEM) 772 (cf. smiLynxEM)
762 VIDEO_HW_BITBLT graphic chip supports 773 VIDEO_HW_BITBLT graphic chip supports
763 bit-blit (cf. smiLynxEM) 774 bit-blit (cf. smiLynxEM)
764 VIDEO_VISIBLE_COLS visible pixel columns 775 VIDEO_VISIBLE_COLS visible pixel columns
765 (cols=pitch) 776 (cols=pitch)
766 VIDEO_VISIBLE_ROWS visible pixel rows 777 VIDEO_VISIBLE_ROWS visible pixel rows
767 VIDEO_PIXEL_SIZE bytes per pixel 778 VIDEO_PIXEL_SIZE bytes per pixel
768 VIDEO_DATA_FORMAT graphic data format 779 VIDEO_DATA_FORMAT graphic data format
769 (0-5, cf. cfb_console.c) 780 (0-5, cf. cfb_console.c)
770 VIDEO_FB_ADRS framebuffer address 781 VIDEO_FB_ADRS framebuffer address
771 VIDEO_KBD_INIT_FCT keyboard int fct 782 VIDEO_KBD_INIT_FCT keyboard int fct
772 (i.e. i8042_kbd_init()) 783 (i.e. i8042_kbd_init())
773 VIDEO_TSTC_FCT test char fct 784 VIDEO_TSTC_FCT test char fct
774 (i.e. i8042_tstc) 785 (i.e. i8042_tstc)
775 VIDEO_GETC_FCT get char fct 786 VIDEO_GETC_FCT get char fct
776 (i.e. i8042_getc) 787 (i.e. i8042_getc)
777 CONFIG_CONSOLE_CURSOR cursor drawing on/off 788 CONFIG_CONSOLE_CURSOR cursor drawing on/off
778 (requires blink timer 789 (requires blink timer
779 cf. i8042.c) 790 cf. i8042.c)
780 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 791 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
781 CONFIG_CONSOLE_TIME display time/date info in 792 CONFIG_CONSOLE_TIME display time/date info in
782 upper right corner 793 upper right corner
783 (requires CONFIG_CMD_DATE) 794 (requires CONFIG_CMD_DATE)
784 CONFIG_VIDEO_LOGO display Linux logo in 795 CONFIG_VIDEO_LOGO display Linux logo in
785 upper left corner 796 upper left corner
786 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 797 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
787 linux_logo.h for logo. 798 linux_logo.h for logo.
788 Requires CONFIG_VIDEO_LOGO 799 Requires CONFIG_VIDEO_LOGO
789 CONFIG_CONSOLE_EXTRA_INFO 800 CONFIG_CONSOLE_EXTRA_INFO
790 additional board info beside 801 additional board info beside
791 the logo 802 the logo
792 803
793 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 804 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
794 a limited number of ANSI escape sequences (cursor control, 805 a limited number of ANSI escape sequences (cursor control,
795 erase functions and limited graphics rendition control). 806 erase functions and limited graphics rendition control).
796 807
797 When CONFIG_CFB_CONSOLE is defined, video console is 808 When CONFIG_CFB_CONSOLE is defined, video console is
798 default i/o. Serial console can be forced with 809 default i/o. Serial console can be forced with
799 environment 'console=serial'. 810 environment 'console=serial'.
800 811
801 When CONFIG_SILENT_CONSOLE is defined, all console 812 When CONFIG_SILENT_CONSOLE is defined, all console
802 messages (by U-Boot and Linux!) can be silenced with 813 messages (by U-Boot and Linux!) can be silenced with
803 the "silent" environment variable. See 814 the "silent" environment variable. See
804 doc/README.silent for more information. 815 doc/README.silent for more information.
805 816
806 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 817 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
807 is 0x00. 818 is 0x00.
808 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 819 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
809 is 0xa0. 820 is 0xa0.
810 821
811 - Console Baudrate: 822 - Console Baudrate:
812 CONFIG_BAUDRATE - in bps 823 CONFIG_BAUDRATE - in bps
813 Select one of the baudrates listed in 824 Select one of the baudrates listed in
814 CONFIG_SYS_BAUDRATE_TABLE, see below. 825 CONFIG_SYS_BAUDRATE_TABLE, see below.
815 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 826 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
816 827
817 - Console Rx buffer length 828 - Console Rx buffer length
818 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 829 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
819 the maximum receive buffer length for the SMC. 830 the maximum receive buffer length for the SMC.
820 This option is actual only for 82xx and 8xx possible. 831 This option is actual only for 82xx and 8xx possible.
821 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 832 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
822 must be defined, to setup the maximum idle timeout for 833 must be defined, to setup the maximum idle timeout for
823 the SMC. 834 the SMC.
824 835
825 - Pre-Console Buffer: 836 - Pre-Console Buffer:
826 Prior to the console being initialised (i.e. serial UART 837 Prior to the console being initialised (i.e. serial UART
827 initialised etc) all console output is silently discarded. 838 initialised etc) all console output is silently discarded.
828 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 839 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
829 buffer any console messages prior to the console being 840 buffer any console messages prior to the console being
830 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 841 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
831 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 842 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
832 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 843 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
833 bytes are output before the console is initialised, the 844 bytes are output before the console is initialised, the
834 earlier bytes are discarded. 845 earlier bytes are discarded.
835 846
836 'Sane' compilers will generate smaller code if 847 'Sane' compilers will generate smaller code if
837 CONFIG_PRE_CON_BUF_SZ is a power of 2 848 CONFIG_PRE_CON_BUF_SZ is a power of 2
838 849
839 - Safe printf() functions 850 - Safe printf() functions
840 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 851 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
841 the printf() functions. These are defined in 852 the printf() functions. These are defined in
842 include/vsprintf.h and include snprintf(), vsnprintf() and 853 include/vsprintf.h and include snprintf(), vsnprintf() and
843 so on. Code size increase is approximately 300-500 bytes. 854 so on. Code size increase is approximately 300-500 bytes.
844 If this option is not given then these functions will 855 If this option is not given then these functions will
845 silently discard their buffer size argument - this means 856 silently discard their buffer size argument - this means
846 you are not getting any overflow checking in this case. 857 you are not getting any overflow checking in this case.
847 858
848 - Boot Delay: CONFIG_BOOTDELAY - in seconds 859 - Boot Delay: CONFIG_BOOTDELAY - in seconds
849 Delay before automatically booting the default image; 860 Delay before automatically booting the default image;
850 set to -1 to disable autoboot. 861 set to -1 to disable autoboot.
851 set to -2 to autoboot with no delay and not check for abort 862 set to -2 to autoboot with no delay and not check for abort
852 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 863 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
853 864
854 See doc/README.autoboot for these options that 865 See doc/README.autoboot for these options that
855 work with CONFIG_BOOTDELAY. None are required. 866 work with CONFIG_BOOTDELAY. None are required.
856 CONFIG_BOOT_RETRY_TIME 867 CONFIG_BOOT_RETRY_TIME
857 CONFIG_BOOT_RETRY_MIN 868 CONFIG_BOOT_RETRY_MIN
858 CONFIG_AUTOBOOT_KEYED 869 CONFIG_AUTOBOOT_KEYED
859 CONFIG_AUTOBOOT_PROMPT 870 CONFIG_AUTOBOOT_PROMPT
860 CONFIG_AUTOBOOT_DELAY_STR 871 CONFIG_AUTOBOOT_DELAY_STR
861 CONFIG_AUTOBOOT_STOP_STR 872 CONFIG_AUTOBOOT_STOP_STR
862 CONFIG_AUTOBOOT_DELAY_STR2 873 CONFIG_AUTOBOOT_DELAY_STR2
863 CONFIG_AUTOBOOT_STOP_STR2 874 CONFIG_AUTOBOOT_STOP_STR2
864 CONFIG_ZERO_BOOTDELAY_CHECK 875 CONFIG_ZERO_BOOTDELAY_CHECK
865 CONFIG_RESET_TO_RETRY 876 CONFIG_RESET_TO_RETRY
866 877
867 - Autoboot Command: 878 - Autoboot Command:
868 CONFIG_BOOTCOMMAND 879 CONFIG_BOOTCOMMAND
869 Only needed when CONFIG_BOOTDELAY is enabled; 880 Only needed when CONFIG_BOOTDELAY is enabled;
870 define a command string that is automatically executed 881 define a command string that is automatically executed
871 when no character is read on the console interface 882 when no character is read on the console interface
872 within "Boot Delay" after reset. 883 within "Boot Delay" after reset.
873 884
874 CONFIG_BOOTARGS 885 CONFIG_BOOTARGS
875 This can be used to pass arguments to the bootm 886 This can be used to pass arguments to the bootm
876 command. The value of CONFIG_BOOTARGS goes into the 887 command. The value of CONFIG_BOOTARGS goes into the
877 environment value "bootargs". 888 environment value "bootargs".
878 889
879 CONFIG_RAMBOOT and CONFIG_NFSBOOT 890 CONFIG_RAMBOOT and CONFIG_NFSBOOT
880 The value of these goes into the environment as 891 The value of these goes into the environment as
881 "ramboot" and "nfsboot" respectively, and can be used 892 "ramboot" and "nfsboot" respectively, and can be used
882 as a convenience, when switching between booting from 893 as a convenience, when switching between booting from
883 RAM and NFS. 894 RAM and NFS.
884 895
885 - Bootcount: 896 - Bootcount:
886 CONFIG_BOOTCOUNT_LIMIT 897 CONFIG_BOOTCOUNT_LIMIT
887 Implements a mechanism for detecting a repeating reboot 898 Implements a mechanism for detecting a repeating reboot
888 cycle, see: 899 cycle, see:
889 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 900 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
890 901
891 CONFIG_BOOTCOUNT_ENV 902 CONFIG_BOOTCOUNT_ENV
892 If no softreset save registers are found on the hardware 903 If no softreset save registers are found on the hardware
893 "bootcount" is stored in the environment. To prevent a 904 "bootcount" is stored in the environment. To prevent a
894 saveenv on all reboots, the environment variable 905 saveenv on all reboots, the environment variable
895 "upgrade_available" is used. If "upgrade_available" is 906 "upgrade_available" is used. If "upgrade_available" is
896 0, "bootcount" is always 0, if "upgrade_available" is 907 0, "bootcount" is always 0, if "upgrade_available" is
897 1 "bootcount" is incremented in the environment. 908 1 "bootcount" is incremented in the environment.
898 So the Userspace Applikation must set the "upgrade_available" 909 So the Userspace Applikation must set the "upgrade_available"
899 and "bootcount" variable to 0, if a boot was successfully. 910 and "bootcount" variable to 0, if a boot was successfully.
900 911
901 - Pre-Boot Commands: 912 - Pre-Boot Commands:
902 CONFIG_PREBOOT 913 CONFIG_PREBOOT
903 914
904 When this option is #defined, the existence of the 915 When this option is #defined, the existence of the
905 environment variable "preboot" will be checked 916 environment variable "preboot" will be checked
906 immediately before starting the CONFIG_BOOTDELAY 917 immediately before starting the CONFIG_BOOTDELAY
907 countdown and/or running the auto-boot command resp. 918 countdown and/or running the auto-boot command resp.
908 entering interactive mode. 919 entering interactive mode.
909 920
910 This feature is especially useful when "preboot" is 921 This feature is especially useful when "preboot" is
911 automatically generated or modified. For an example 922 automatically generated or modified. For an example
912 see the LWMON board specific code: here "preboot" is 923 see the LWMON board specific code: here "preboot" is
913 modified when the user holds down a certain 924 modified when the user holds down a certain
914 combination of keys on the (special) keyboard when 925 combination of keys on the (special) keyboard when
915 booting the systems 926 booting the systems
916 927
917 - Serial Download Echo Mode: 928 - Serial Download Echo Mode:
918 CONFIG_LOADS_ECHO 929 CONFIG_LOADS_ECHO
919 If defined to 1, all characters received during a 930 If defined to 1, all characters received during a
920 serial download (using the "loads" command) are 931 serial download (using the "loads" command) are
921 echoed back. This might be needed by some terminal 932 echoed back. This might be needed by some terminal
922 emulations (like "cu"), but may as well just take 933 emulations (like "cu"), but may as well just take
923 time on others. This setting #define's the initial 934 time on others. This setting #define's the initial
924 value of the "loads_echo" environment variable. 935 value of the "loads_echo" environment variable.
925 936
926 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 937 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
927 CONFIG_KGDB_BAUDRATE 938 CONFIG_KGDB_BAUDRATE
928 Select one of the baudrates listed in 939 Select one of the baudrates listed in
929 CONFIG_SYS_BAUDRATE_TABLE, see below. 940 CONFIG_SYS_BAUDRATE_TABLE, see below.
930 941
931 - Monitor Functions: 942 - Monitor Functions:
932 Monitor commands can be included or excluded 943 Monitor commands can be included or excluded
933 from the build by using the #include files 944 from the build by using the #include files
934 <config_cmd_all.h> and #undef'ing unwanted 945 <config_cmd_all.h> and #undef'ing unwanted
935 commands, or using <config_cmd_default.h> 946 commands, or using <config_cmd_default.h>
936 and augmenting with additional #define's 947 and augmenting with additional #define's
937 for wanted commands. 948 for wanted commands.
938 949
939 The default command configuration includes all commands 950 The default command configuration includes all commands
940 except those marked below with a "*". 951 except those marked below with a "*".
941 952
942 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt 953 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
943 CONFIG_CMD_ASKENV * ask for env variable 954 CONFIG_CMD_ASKENV * ask for env variable
944 CONFIG_CMD_BDI bdinfo 955 CONFIG_CMD_BDI bdinfo
945 CONFIG_CMD_BEDBUG * Include BedBug Debugger 956 CONFIG_CMD_BEDBUG * Include BedBug Debugger
946 CONFIG_CMD_BMP * BMP support 957 CONFIG_CMD_BMP * BMP support
947 CONFIG_CMD_BSP * Board specific commands 958 CONFIG_CMD_BSP * Board specific commands
948 CONFIG_CMD_BOOTD bootd 959 CONFIG_CMD_BOOTD bootd
949 CONFIG_CMD_CACHE * icache, dcache 960 CONFIG_CMD_CACHE * icache, dcache
950 CONFIG_CMD_CLK * clock command support 961 CONFIG_CMD_CLK * clock command support
951 CONFIG_CMD_CONSOLE coninfo 962 CONFIG_CMD_CONSOLE coninfo
952 CONFIG_CMD_CRC32 * crc32 963 CONFIG_CMD_CRC32 * crc32
953 CONFIG_CMD_DATE * support for RTC, date/time... 964 CONFIG_CMD_DATE * support for RTC, date/time...
954 CONFIG_CMD_DHCP * DHCP support 965 CONFIG_CMD_DHCP * DHCP support
955 CONFIG_CMD_DIAG * Diagnostics 966 CONFIG_CMD_DIAG * Diagnostics
956 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 967 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
957 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 968 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
958 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 969 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
959 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 970 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
960 CONFIG_CMD_DTT * Digital Therm and Thermostat 971 CONFIG_CMD_DTT * Digital Therm and Thermostat
961 CONFIG_CMD_ECHO echo arguments 972 CONFIG_CMD_ECHO echo arguments
962 CONFIG_CMD_EDITENV edit env variable 973 CONFIG_CMD_EDITENV edit env variable
963 CONFIG_CMD_EEPROM * EEPROM read/write support 974 CONFIG_CMD_EEPROM * EEPROM read/write support
964 CONFIG_CMD_ELF * bootelf, bootvx 975 CONFIG_CMD_ELF * bootelf, bootvx
965 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 976 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
966 CONFIG_CMD_ENV_FLAGS * display details about env flags 977 CONFIG_CMD_ENV_FLAGS * display details about env flags
967 CONFIG_CMD_ENV_EXISTS * check existence of env variable 978 CONFIG_CMD_ENV_EXISTS * check existence of env variable
968 CONFIG_CMD_EXPORTENV * export the environment 979 CONFIG_CMD_EXPORTENV * export the environment
969 CONFIG_CMD_EXT2 * ext2 command support 980 CONFIG_CMD_EXT2 * ext2 command support
970 CONFIG_CMD_EXT4 * ext4 command support 981 CONFIG_CMD_EXT4 * ext4 command support
971 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 982 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
972 that work for multiple fs types 983 that work for multiple fs types
973 CONFIG_CMD_SAVEENV saveenv 984 CONFIG_CMD_SAVEENV saveenv
974 CONFIG_CMD_FDC * Floppy Disk Support 985 CONFIG_CMD_FDC * Floppy Disk Support
975 CONFIG_CMD_FAT * FAT command support 986 CONFIG_CMD_FAT * FAT command support
976 CONFIG_CMD_FLASH flinfo, erase, protect 987 CONFIG_CMD_FLASH flinfo, erase, protect
977 CONFIG_CMD_FPGA FPGA device initialization support 988 CONFIG_CMD_FPGA FPGA device initialization support
978 CONFIG_CMD_FUSE * Device fuse support 989 CONFIG_CMD_FUSE * Device fuse support
979 CONFIG_CMD_GETTIME * Get time since boot 990 CONFIG_CMD_GETTIME * Get time since boot
980 CONFIG_CMD_GO * the 'go' command (exec code) 991 CONFIG_CMD_GO * the 'go' command (exec code)
981 CONFIG_CMD_GREPENV * search environment 992 CONFIG_CMD_GREPENV * search environment
982 CONFIG_CMD_HASH * calculate hash / digest 993 CONFIG_CMD_HASH * calculate hash / digest
983 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 994 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
984 CONFIG_CMD_I2C * I2C serial bus support 995 CONFIG_CMD_I2C * I2C serial bus support
985 CONFIG_CMD_IDE * IDE harddisk support 996 CONFIG_CMD_IDE * IDE harddisk support
986 CONFIG_CMD_IMI iminfo 997 CONFIG_CMD_IMI iminfo
987 CONFIG_CMD_IMLS List all images found in NOR flash 998 CONFIG_CMD_IMLS List all images found in NOR flash
988 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 999 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
989 CONFIG_CMD_IMMAP * IMMR dump support 1000 CONFIG_CMD_IMMAP * IMMR dump support
990 CONFIG_CMD_IMPORTENV * import an environment 1001 CONFIG_CMD_IMPORTENV * import an environment
991 CONFIG_CMD_INI * import data from an ini file into the env 1002 CONFIG_CMD_INI * import data from an ini file into the env
992 CONFIG_CMD_IRQ * irqinfo 1003 CONFIG_CMD_IRQ * irqinfo
993 CONFIG_CMD_ITEST Integer/string test of 2 values 1004 CONFIG_CMD_ITEST Integer/string test of 2 values
994 CONFIG_CMD_JFFS2 * JFFS2 Support 1005 CONFIG_CMD_JFFS2 * JFFS2 Support
995 CONFIG_CMD_KGDB * kgdb 1006 CONFIG_CMD_KGDB * kgdb
996 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 1007 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
997 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 1008 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
998 (169.254.*.*) 1009 (169.254.*.*)
999 CONFIG_CMD_LOADB loadb 1010 CONFIG_CMD_LOADB loadb
1000 CONFIG_CMD_LOADS loads 1011 CONFIG_CMD_LOADS loads
1001 CONFIG_CMD_MD5SUM * print md5 message digest 1012 CONFIG_CMD_MD5SUM * print md5 message digest
1002 (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 1013 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
1003 CONFIG_CMD_MEMINFO * Display detailed memory information 1014 CONFIG_CMD_MEMINFO * Display detailed memory information
1004 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 1015 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
1005 loop, loopw 1016 loop, loopw
1006 CONFIG_CMD_MEMTEST * mtest 1017 CONFIG_CMD_MEMTEST * mtest
1007 CONFIG_CMD_MISC Misc functions like sleep etc 1018 CONFIG_CMD_MISC Misc functions like sleep etc
1008 CONFIG_CMD_MMC * MMC memory mapped support 1019 CONFIG_CMD_MMC * MMC memory mapped support
1009 CONFIG_CMD_MII * MII utility commands 1020 CONFIG_CMD_MII * MII utility commands
1010 CONFIG_CMD_MTDPARTS * MTD partition support 1021 CONFIG_CMD_MTDPARTS * MTD partition support
1011 CONFIG_CMD_NAND * NAND support 1022 CONFIG_CMD_NAND * NAND support
1012 CONFIG_CMD_NET bootp, tftpboot, rarpboot 1023 CONFIG_CMD_NET bootp, tftpboot, rarpboot
1013 CONFIG_CMD_NFS NFS support 1024 CONFIG_CMD_NFS NFS support
1014 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 1025 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
1015 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 1026 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1016 CONFIG_CMD_PCI * pciinfo 1027 CONFIG_CMD_PCI * pciinfo
1017 CONFIG_CMD_PCMCIA * PCMCIA support 1028 CONFIG_CMD_PCMCIA * PCMCIA support
1018 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 1029 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1019 host 1030 host
1020 CONFIG_CMD_PORTIO * Port I/O 1031 CONFIG_CMD_PORTIO * Port I/O
1021 CONFIG_CMD_READ * Read raw data from partition 1032 CONFIG_CMD_READ * Read raw data from partition
1022 CONFIG_CMD_REGINFO * Register dump 1033 CONFIG_CMD_REGINFO * Register dump
1023 CONFIG_CMD_RUN run command in env variable 1034 CONFIG_CMD_RUN run command in env variable
1024 CONFIG_CMD_SANDBOX * sb command to access sandbox features 1035 CONFIG_CMD_SANDBOX * sb command to access sandbox features
1025 CONFIG_CMD_SAVES * save S record dump 1036 CONFIG_CMD_SAVES * save S record dump
1026 CONFIG_CMD_SCSI * SCSI Support 1037 CONFIG_CMD_SCSI * SCSI Support
1027 CONFIG_CMD_SDRAM * print SDRAM configuration information 1038 CONFIG_CMD_SDRAM * print SDRAM configuration information
1028 (requires CONFIG_CMD_I2C) 1039 (requires CONFIG_CMD_I2C)
1029 CONFIG_CMD_SETGETDCR Support for DCR Register access 1040 CONFIG_CMD_SETGETDCR Support for DCR Register access
1030 (4xx only) 1041 (4xx only)
1031 CONFIG_CMD_SF * Read/write/erase SPI NOR flash 1042 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
1032 CONFIG_CMD_SHA1SUM * print sha1 memory digest 1043 CONFIG_CMD_SHA1SUM * print sha1 memory digest
1033 (requires CONFIG_CMD_MEMORY) 1044 (requires CONFIG_CMD_MEMORY)
1034 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 1045 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
1035 CONFIG_CMD_SOURCE "source" command Support 1046 CONFIG_CMD_SOURCE "source" command Support
1036 CONFIG_CMD_SPI * SPI serial bus support 1047 CONFIG_CMD_SPI * SPI serial bus support
1037 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 1048 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
1038 CONFIG_CMD_TFTPPUT * TFTP put command (upload) 1049 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
1039 CONFIG_CMD_TIME * run command and report execution time (ARM specific) 1050 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1040 CONFIG_CMD_TIMER * access to the system tick timer 1051 CONFIG_CMD_TIMER * access to the system tick timer
1041 CONFIG_CMD_USB * USB support 1052 CONFIG_CMD_USB * USB support
1042 CONFIG_CMD_CDP * Cisco Discover Protocol support 1053 CONFIG_CMD_CDP * Cisco Discover Protocol support
1043 CONFIG_CMD_MFSL * Microblaze FSL support 1054 CONFIG_CMD_MFSL * Microblaze FSL support
1044 CONFIG_CMD_XIMG Load part of Multi Image 1055 CONFIG_CMD_XIMG Load part of Multi Image
1045 CONFIG_CMD_UUID * Generate random UUID or GUID string 1056 CONFIG_CMD_UUID * Generate random UUID or GUID string
1046 1057
1047 EXAMPLE: If you want all functions except of network 1058 EXAMPLE: If you want all functions except of network
1048 support you can write: 1059 support you can write:
1049 1060
1050 #include "config_cmd_all.h" 1061 #include "config_cmd_all.h"
1051 #undef CONFIG_CMD_NET 1062 #undef CONFIG_CMD_NET
1052 1063
1053 Other Commands: 1064 Other Commands:
1054 fdt (flattened device tree) command: CONFIG_OF_LIBFDT 1065 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1055 1066
1056 Note: Don't enable the "icache" and "dcache" commands 1067 Note: Don't enable the "icache" and "dcache" commands
1057 (configuration option CONFIG_CMD_CACHE) unless you know 1068 (configuration option CONFIG_CMD_CACHE) unless you know
1058 what you (and your U-Boot users) are doing. Data 1069 what you (and your U-Boot users) are doing. Data
1059 cache cannot be enabled on systems like the 8xx or 1070 cache cannot be enabled on systems like the 8xx or
1060 8260 (where accesses to the IMMR region must be 1071 8260 (where accesses to the IMMR region must be
1061 uncached), and it cannot be disabled on all other 1072 uncached), and it cannot be disabled on all other
1062 systems where we (mis-) use the data cache to hold an 1073 systems where we (mis-) use the data cache to hold an
1063 initial stack and some data. 1074 initial stack and some data.
1064 1075
1065 1076
1066 XXX - this list needs to get updated! 1077 XXX - this list needs to get updated!
1067 1078
1068 - Regular expression support: 1079 - Regular expression support:
1069 CONFIG_REGEX 1080 CONFIG_REGEX
1070 If this variable is defined, U-Boot is linked against 1081 If this variable is defined, U-Boot is linked against
1071 the SLRE (Super Light Regular Expression) library, 1082 the SLRE (Super Light Regular Expression) library,
1072 which adds regex support to some commands, as for 1083 which adds regex support to some commands, as for
1073 example "env grep" and "setexpr". 1084 example "env grep" and "setexpr".
1074 1085
1075 - Device tree: 1086 - Device tree:
1076 CONFIG_OF_CONTROL 1087 CONFIG_OF_CONTROL
1077 If this variable is defined, U-Boot will use a device tree 1088 If this variable is defined, U-Boot will use a device tree
1078 to configure its devices, instead of relying on statically 1089 to configure its devices, instead of relying on statically
1079 compiled #defines in the board file. This option is 1090 compiled #defines in the board file. This option is
1080 experimental and only available on a few boards. The device 1091 experimental and only available on a few boards. The device
1081 tree is available in the global data as gd->fdt_blob. 1092 tree is available in the global data as gd->fdt_blob.
1082 1093
1083 U-Boot needs to get its device tree from somewhere. This can 1094 U-Boot needs to get its device tree from somewhere. This can
1084 be done using one of the two options below: 1095 be done using one of the two options below:
1085 1096
1086 CONFIG_OF_EMBED 1097 CONFIG_OF_EMBED
1087 If this variable is defined, U-Boot will embed a device tree 1098 If this variable is defined, U-Boot will embed a device tree
1088 binary in its image. This device tree file should be in the 1099 binary in its image. This device tree file should be in the
1089 board directory and called <soc>-<board>.dts. The binary file 1100 board directory and called <soc>-<board>.dts. The binary file
1090 is then picked up in board_init_f() and made available through 1101 is then picked up in board_init_f() and made available through
1091 the global data structure as gd->blob. 1102 the global data structure as gd->blob.
1092 1103
1093 CONFIG_OF_SEPARATE 1104 CONFIG_OF_SEPARATE
1094 If this variable is defined, U-Boot will build a device tree 1105 If this variable is defined, U-Boot will build a device tree
1095 binary. It will be called u-boot.dtb. Architecture-specific 1106 binary. It will be called u-boot.dtb. Architecture-specific
1096 code will locate it at run-time. Generally this works by: 1107 code will locate it at run-time. Generally this works by:
1097 1108
1098 cat u-boot.bin u-boot.dtb >image.bin 1109 cat u-boot.bin u-boot.dtb >image.bin
1099 1110
1100 and in fact, U-Boot does this for you, creating a file called 1111 and in fact, U-Boot does this for you, creating a file called
1101 u-boot-dtb.bin which is useful in the common case. You can 1112 u-boot-dtb.bin which is useful in the common case. You can
1102 still use the individual files if you need something more 1113 still use the individual files if you need something more
1103 exotic. 1114 exotic.
1104 1115
1105 - Watchdog: 1116 - Watchdog:
1106 CONFIG_WATCHDOG 1117 CONFIG_WATCHDOG
1107 If this variable is defined, it enables watchdog 1118 If this variable is defined, it enables watchdog
1108 support for the SoC. There must be support in the SoC 1119 support for the SoC. There must be support in the SoC
1109 specific code for a watchdog. For the 8xx and 8260 1120 specific code for a watchdog. For the 8xx and 8260
1110 CPUs, the SIU Watchdog feature is enabled in the SYPCR 1121 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1111 register. When supported for a specific SoC is 1122 register. When supported for a specific SoC is
1112 available, then no further board specific code should 1123 available, then no further board specific code should
1113 be needed to use it. 1124 be needed to use it.
1114 1125
1115 CONFIG_HW_WATCHDOG 1126 CONFIG_HW_WATCHDOG
1116 When using a watchdog circuitry external to the used 1127 When using a watchdog circuitry external to the used
1117 SoC, then define this variable and provide board 1128 SoC, then define this variable and provide board
1118 specific code for the "hw_watchdog_reset" function. 1129 specific code for the "hw_watchdog_reset" function.
1119 1130
1120 - U-Boot Version: 1131 - U-Boot Version:
1121 CONFIG_VERSION_VARIABLE 1132 CONFIG_VERSION_VARIABLE
1122 If this variable is defined, an environment variable 1133 If this variable is defined, an environment variable
1123 named "ver" is created by U-Boot showing the U-Boot 1134 named "ver" is created by U-Boot showing the U-Boot
1124 version as printed by the "version" command. 1135 version as printed by the "version" command.
1125 Any change to this variable will be reverted at the 1136 Any change to this variable will be reverted at the
1126 next reset. 1137 next reset.
1127 1138
1128 - Real-Time Clock: 1139 - Real-Time Clock:
1129 1140
1130 When CONFIG_CMD_DATE is selected, the type of the RTC 1141 When CONFIG_CMD_DATE is selected, the type of the RTC
1131 has to be selected, too. Define exactly one of the 1142 has to be selected, too. Define exactly one of the
1132 following options: 1143 following options:
1133 1144
1134 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1145 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1135 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 1146 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
1136 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1147 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
1137 CONFIG_RTC_MC146818 - use MC146818 RTC 1148 CONFIG_RTC_MC146818 - use MC146818 RTC
1138 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1149 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
1139 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 1150 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
1140 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 1151 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
1141 CONFIG_RTC_DS164x - use Dallas DS164x RTC 1152 CONFIG_RTC_DS164x - use Dallas DS164x RTC
1142 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 1153 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
1143 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 1154 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
1144 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 1155 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
1145 CONFIG_SYS_RV3029_TCR - enable trickle charger on 1156 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1146 RV3029 RTC. 1157 RV3029 RTC.
1147 1158
1148 Note that if the RTC uses I2C, then the I2C interface 1159 Note that if the RTC uses I2C, then the I2C interface
1149 must also be configured. See I2C Support, below. 1160 must also be configured. See I2C Support, below.
1150 1161
1151 - GPIO Support: 1162 - GPIO Support:
1152 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1163 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1153 1164
1154 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 1165 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1155 chip-ngpio pairs that tell the PCA953X driver the number of 1166 chip-ngpio pairs that tell the PCA953X driver the number of
1156 pins supported by a particular chip. 1167 pins supported by a particular chip.
1157 1168
1158 Note that if the GPIO device uses I2C, then the I2C interface 1169 Note that if the GPIO device uses I2C, then the I2C interface
1159 must also be configured. See I2C Support, below. 1170 must also be configured. See I2C Support, below.
1160 1171
1161 - Timestamp Support: 1172 - Timestamp Support:
1162 1173
1163 When CONFIG_TIMESTAMP is selected, the timestamp 1174 When CONFIG_TIMESTAMP is selected, the timestamp
1164 (date and time) of an image is printed by image 1175 (date and time) of an image is printed by image
1165 commands like bootm or iminfo. This option is 1176 commands like bootm or iminfo. This option is
1166 automatically enabled when you select CONFIG_CMD_DATE . 1177 automatically enabled when you select CONFIG_CMD_DATE .
1167 1178
1168 - Partition Labels (disklabels) Supported: 1179 - Partition Labels (disklabels) Supported:
1169 Zero or more of the following: 1180 Zero or more of the following:
1170 CONFIG_MAC_PARTITION Apple's MacOS partition table. 1181 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1171 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1182 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1172 Intel architecture, USB sticks, etc. 1183 Intel architecture, USB sticks, etc.
1173 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1184 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1174 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1185 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1175 bootloader. Note 2TB partition limit; see 1186 bootloader. Note 2TB partition limit; see
1176 disk/part_efi.c 1187 disk/part_efi.c
1177 CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1188 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
1178 1189
1179 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1190 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1180 CONFIG_CMD_SCSI) you must configure support for at 1191 CONFIG_CMD_SCSI) you must configure support for at
1181 least one non-MTD partition type as well. 1192 least one non-MTD partition type as well.
1182 1193
1183 - IDE Reset method: 1194 - IDE Reset method:
1184 CONFIG_IDE_RESET_ROUTINE - this is defined in several 1195 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1185 board configurations files but used nowhere! 1196 board configurations files but used nowhere!
1186 1197
1187 CONFIG_IDE_RESET - is this is defined, IDE Reset will 1198 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1188 be performed by calling the function 1199 be performed by calling the function
1189 ide_set_reset(int reset) 1200 ide_set_reset(int reset)
1190 which has to be defined in a board specific file 1201 which has to be defined in a board specific file
1191 1202
1192 - ATAPI Support: 1203 - ATAPI Support:
1193 CONFIG_ATAPI 1204 CONFIG_ATAPI
1194 1205
1195 Set this to enable ATAPI support. 1206 Set this to enable ATAPI support.
1196 1207
1197 - LBA48 Support 1208 - LBA48 Support
1198 CONFIG_LBA48 1209 CONFIG_LBA48
1199 1210
1200 Set this to enable support for disks larger than 137GB 1211 Set this to enable support for disks larger than 137GB
1201 Also look at CONFIG_SYS_64BIT_LBA. 1212 Also look at CONFIG_SYS_64BIT_LBA.
1202 Whithout these , LBA48 support uses 32bit variables and will 'only' 1213 Whithout these , LBA48 support uses 32bit variables and will 'only'
1203 support disks up to 2.1TB. 1214 support disks up to 2.1TB.
1204 1215
1205 CONFIG_SYS_64BIT_LBA: 1216 CONFIG_SYS_64BIT_LBA:
1206 When enabled, makes the IDE subsystem use 64bit sector addresses. 1217 When enabled, makes the IDE subsystem use 64bit sector addresses.
1207 Default is 32bit. 1218 Default is 32bit.
1208 1219
1209 - SCSI Support: 1220 - SCSI Support:
1210 At the moment only there is only support for the 1221 At the moment only there is only support for the
1211 SYM53C8XX SCSI controller; define 1222 SYM53C8XX SCSI controller; define
1212 CONFIG_SCSI_SYM53C8XX to enable it. 1223 CONFIG_SCSI_SYM53C8XX to enable it.
1213 1224
1214 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 1225 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1215 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 1226 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1216 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1227 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1217 maximum numbers of LUNs, SCSI ID's and target 1228 maximum numbers of LUNs, SCSI ID's and target
1218 devices. 1229 devices.
1219 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1230 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1220 1231
1221 The environment variable 'scsidevs' is set to the number of 1232 The environment variable 'scsidevs' is set to the number of
1222 SCSI devices found during the last scan. 1233 SCSI devices found during the last scan.
1223 1234
1224 - NETWORK Support (PCI): 1235 - NETWORK Support (PCI):
1225 CONFIG_E1000 1236 CONFIG_E1000
1226 Support for Intel 8254x/8257x gigabit chips. 1237 Support for Intel 8254x/8257x gigabit chips.
1227 1238
1228 CONFIG_E1000_SPI 1239 CONFIG_E1000_SPI
1229 Utility code for direct access to the SPI bus on Intel 8257x. 1240 Utility code for direct access to the SPI bus on Intel 8257x.
1230 This does not do anything useful unless you set at least one 1241 This does not do anything useful unless you set at least one
1231 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1242 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1232 1243
1233 CONFIG_E1000_SPI_GENERIC 1244 CONFIG_E1000_SPI_GENERIC
1234 Allow generic access to the SPI bus on the Intel 8257x, for 1245 Allow generic access to the SPI bus on the Intel 8257x, for
1235 example with the "sspi" command. 1246 example with the "sspi" command.
1236 1247
1237 CONFIG_CMD_E1000 1248 CONFIG_CMD_E1000
1238 Management command for E1000 devices. When used on devices 1249 Management command for E1000 devices. When used on devices
1239 with SPI support you can reprogram the EEPROM from U-Boot. 1250 with SPI support you can reprogram the EEPROM from U-Boot.
1240 1251
1241 CONFIG_E1000_FALLBACK_MAC 1252 CONFIG_E1000_FALLBACK_MAC
1242 default MAC for empty EEPROM after production. 1253 default MAC for empty EEPROM after production.
1243 1254
1244 CONFIG_EEPRO100 1255 CONFIG_EEPRO100
1245 Support for Intel 82557/82559/82559ER chips. 1256 Support for Intel 82557/82559/82559ER chips.
1246 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1257 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1247 write routine for first time initialisation. 1258 write routine for first time initialisation.
1248 1259
1249 CONFIG_TULIP 1260 CONFIG_TULIP
1250 Support for Digital 2114x chips. 1261 Support for Digital 2114x chips.
1251 Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1262 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1252 modem chip initialisation (KS8761/QS6611). 1263 modem chip initialisation (KS8761/QS6611).
1253 1264
1254 CONFIG_NATSEMI 1265 CONFIG_NATSEMI
1255 Support for National dp83815 chips. 1266 Support for National dp83815 chips.
1256 1267
1257 CONFIG_NS8382X 1268 CONFIG_NS8382X
1258 Support for National dp8382[01] gigabit chips. 1269 Support for National dp8382[01] gigabit chips.
1259 1270
1260 - NETWORK Support (other): 1271 - NETWORK Support (other):
1261 1272
1262 CONFIG_DRIVER_AT91EMAC 1273 CONFIG_DRIVER_AT91EMAC
1263 Support for AT91RM9200 EMAC. 1274 Support for AT91RM9200 EMAC.
1264 1275
1265 CONFIG_RMII 1276 CONFIG_RMII
1266 Define this to use reduced MII inteface 1277 Define this to use reduced MII inteface
1267 1278
1268 CONFIG_DRIVER_AT91EMAC_QUIET 1279 CONFIG_DRIVER_AT91EMAC_QUIET
1269 If this defined, the driver is quiet. 1280 If this defined, the driver is quiet.
1270 The driver doen't show link status messages. 1281 The driver doen't show link status messages.
1271 1282
1272 CONFIG_CALXEDA_XGMAC 1283 CONFIG_CALXEDA_XGMAC
1273 Support for the Calxeda XGMAC device 1284 Support for the Calxeda XGMAC device
1274 1285
1275 CONFIG_LAN91C96 1286 CONFIG_LAN91C96
1276 Support for SMSC's LAN91C96 chips. 1287 Support for SMSC's LAN91C96 chips.
1277 1288
1278 CONFIG_LAN91C96_BASE 1289 CONFIG_LAN91C96_BASE
1279 Define this to hold the physical address 1290 Define this to hold the physical address
1280 of the LAN91C96's I/O space 1291 of the LAN91C96's I/O space
1281 1292
1282 CONFIG_LAN91C96_USE_32_BIT 1293 CONFIG_LAN91C96_USE_32_BIT
1283 Define this to enable 32 bit addressing 1294 Define this to enable 32 bit addressing
1284 1295
1285 CONFIG_SMC91111 1296 CONFIG_SMC91111
1286 Support for SMSC's LAN91C111 chip 1297 Support for SMSC's LAN91C111 chip
1287 1298
1288 CONFIG_SMC91111_BASE 1299 CONFIG_SMC91111_BASE
1289 Define this to hold the physical address 1300 Define this to hold the physical address
1290 of the device (I/O space) 1301 of the device (I/O space)
1291 1302
1292 CONFIG_SMC_USE_32_BIT 1303 CONFIG_SMC_USE_32_BIT
1293 Define this if data bus is 32 bits 1304 Define this if data bus is 32 bits
1294 1305
1295 CONFIG_SMC_USE_IOFUNCS 1306 CONFIG_SMC_USE_IOFUNCS
1296 Define this to use i/o functions instead of macros 1307 Define this to use i/o functions instead of macros
1297 (some hardware wont work with macros) 1308 (some hardware wont work with macros)
1298 1309
1299 CONFIG_DRIVER_TI_EMAC 1310 CONFIG_DRIVER_TI_EMAC
1300 Support for davinci emac 1311 Support for davinci emac
1301 1312
1302 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1313 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1303 Define this if you have more then 3 PHYs. 1314 Define this if you have more then 3 PHYs.
1304 1315
1305 CONFIG_FTGMAC100 1316 CONFIG_FTGMAC100
1306 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1317 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1307 1318
1308 CONFIG_FTGMAC100_EGIGA 1319 CONFIG_FTGMAC100_EGIGA
1309 Define this to use GE link update with gigabit PHY. 1320 Define this to use GE link update with gigabit PHY.
1310 Define this if FTGMAC100 is connected to gigabit PHY. 1321 Define this if FTGMAC100 is connected to gigabit PHY.
1311 If your system has 10/100 PHY only, it might not occur 1322 If your system has 10/100 PHY only, it might not occur
1312 wrong behavior. Because PHY usually return timeout or 1323 wrong behavior. Because PHY usually return timeout or
1313 useless data when polling gigabit status and gigabit 1324 useless data when polling gigabit status and gigabit
1314 control registers. This behavior won't affect the 1325 control registers. This behavior won't affect the
1315 correctnessof 10/100 link speed update. 1326 correctnessof 10/100 link speed update.
1316 1327
1317 CONFIG_SMC911X 1328 CONFIG_SMC911X
1318 Support for SMSC's LAN911x and LAN921x chips 1329 Support for SMSC's LAN911x and LAN921x chips
1319 1330
1320 CONFIG_SMC911X_BASE 1331 CONFIG_SMC911X_BASE
1321 Define this to hold the physical address 1332 Define this to hold the physical address
1322 of the device (I/O space) 1333 of the device (I/O space)
1323 1334
1324 CONFIG_SMC911X_32_BIT 1335 CONFIG_SMC911X_32_BIT
1325 Define this if data bus is 32 bits 1336 Define this if data bus is 32 bits
1326 1337
1327 CONFIG_SMC911X_16_BIT 1338 CONFIG_SMC911X_16_BIT
1328 Define this if data bus is 16 bits. If your processor 1339 Define this if data bus is 16 bits. If your processor
1329 automatically converts one 32 bit word to two 16 bit 1340 automatically converts one 32 bit word to two 16 bit
1330 words you may also try CONFIG_SMC911X_32_BIT. 1341 words you may also try CONFIG_SMC911X_32_BIT.
1331 1342
1332 CONFIG_SH_ETHER 1343 CONFIG_SH_ETHER
1333 Support for Renesas on-chip Ethernet controller 1344 Support for Renesas on-chip Ethernet controller
1334 1345
1335 CONFIG_SH_ETHER_USE_PORT 1346 CONFIG_SH_ETHER_USE_PORT
1336 Define the number of ports to be used 1347 Define the number of ports to be used
1337 1348
1338 CONFIG_SH_ETHER_PHY_ADDR 1349 CONFIG_SH_ETHER_PHY_ADDR
1339 Define the ETH PHY's address 1350 Define the ETH PHY's address
1340 1351
1341 CONFIG_SH_ETHER_CACHE_WRITEBACK 1352 CONFIG_SH_ETHER_CACHE_WRITEBACK
1342 If this option is set, the driver enables cache flush. 1353 If this option is set, the driver enables cache flush.
1343 1354
1344 - TPM Support: 1355 - TPM Support:
1345 CONFIG_TPM 1356 CONFIG_TPM
1346 Support TPM devices. 1357 Support TPM devices.
1347 1358
1348 CONFIG_TPM_TIS_I2C 1359 CONFIG_TPM_TIS_I2C
1349 Support for i2c bus TPM devices. Only one device 1360 Support for i2c bus TPM devices. Only one device
1350 per system is supported at this time. 1361 per system is supported at this time.
1351 1362
1352 CONFIG_TPM_TIS_I2C_BUS_NUMBER 1363 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1353 Define the the i2c bus number for the TPM device 1364 Define the the i2c bus number for the TPM device
1354 1365
1355 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS 1366 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1356 Define the TPM's address on the i2c bus 1367 Define the TPM's address on the i2c bus
1357 1368
1358 CONFIG_TPM_TIS_I2C_BURST_LIMITATION 1369 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1359 Define the burst count bytes upper limit 1370 Define the burst count bytes upper limit
1360 1371
1361 CONFIG_TPM_ATMEL_TWI 1372 CONFIG_TPM_ATMEL_TWI
1362 Support for Atmel TWI TPM device. Requires I2C support. 1373 Support for Atmel TWI TPM device. Requires I2C support.
1363 1374
1364 CONFIG_TPM_TIS_LPC 1375 CONFIG_TPM_TIS_LPC
1365 Support for generic parallel port TPM devices. Only one device 1376 Support for generic parallel port TPM devices. Only one device
1366 per system is supported at this time. 1377 per system is supported at this time.
1367 1378
1368 CONFIG_TPM_TIS_BASE_ADDRESS 1379 CONFIG_TPM_TIS_BASE_ADDRESS
1369 Base address where the generic TPM device is mapped 1380 Base address where the generic TPM device is mapped
1370 to. Contemporary x86 systems usually map it at 1381 to. Contemporary x86 systems usually map it at
1371 0xfed40000. 1382 0xfed40000.
1372 1383
1373 CONFIG_CMD_TPM 1384 CONFIG_CMD_TPM
1374 Add tpm monitor functions. 1385 Add tpm monitor functions.
1375 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1386 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1376 provides monitor access to authorized functions. 1387 provides monitor access to authorized functions.
1377 1388
1378 CONFIG_TPM 1389 CONFIG_TPM
1379 Define this to enable the TPM support library which provides 1390 Define this to enable the TPM support library which provides
1380 functional interfaces to some TPM commands. 1391 functional interfaces to some TPM commands.
1381 Requires support for a TPM device. 1392 Requires support for a TPM device.
1382 1393
1383 CONFIG_TPM_AUTH_SESSIONS 1394 CONFIG_TPM_AUTH_SESSIONS
1384 Define this to enable authorized functions in the TPM library. 1395 Define this to enable authorized functions in the TPM library.
1385 Requires CONFIG_TPM and CONFIG_SHA1. 1396 Requires CONFIG_TPM and CONFIG_SHA1.
1386 1397
1387 - USB Support: 1398 - USB Support:
1388 At the moment only the UHCI host controller is 1399 At the moment only the UHCI host controller is
1389 supported (PIP405, MIP405, MPC5200); define 1400 supported (PIP405, MIP405, MPC5200); define
1390 CONFIG_USB_UHCI to enable it. 1401 CONFIG_USB_UHCI to enable it.
1391 define CONFIG_USB_KEYBOARD to enable the USB Keyboard 1402 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1392 and define CONFIG_USB_STORAGE to enable the USB 1403 and define CONFIG_USB_STORAGE to enable the USB
1393 storage devices. 1404 storage devices.
1394 Note: 1405 Note:
1395 Supported are USB Keyboards and USB Floppy drives 1406 Supported are USB Keyboards and USB Floppy drives
1396 (TEAC FD-05PUB). 1407 (TEAC FD-05PUB).
1397 MPC5200 USB requires additional defines: 1408 MPC5200 USB requires additional defines:
1398 CONFIG_USB_CLOCK 1409 CONFIG_USB_CLOCK
1399 for 528 MHz Clock: 0x0001bbbb 1410 for 528 MHz Clock: 0x0001bbbb
1400 CONFIG_PSC3_USB 1411 CONFIG_PSC3_USB
1401 for USB on PSC3 1412 for USB on PSC3
1402 CONFIG_USB_CONFIG 1413 CONFIG_USB_CONFIG
1403 for differential drivers: 0x00001000 1414 for differential drivers: 0x00001000
1404 for single ended drivers: 0x00005000 1415 for single ended drivers: 0x00005000
1405 for differential drivers on PSC3: 0x00000100 1416 for differential drivers on PSC3: 0x00000100
1406 for single ended drivers on PSC3: 0x00004100 1417 for single ended drivers on PSC3: 0x00004100
1407 CONFIG_SYS_USB_EVENT_POLL 1418 CONFIG_SYS_USB_EVENT_POLL
1408 May be defined to allow interrupt polling 1419 May be defined to allow interrupt polling
1409 instead of using asynchronous interrupts 1420 instead of using asynchronous interrupts
1410 1421
1411 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 1422 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1412 txfilltuning field in the EHCI controller on reset. 1423 txfilltuning field in the EHCI controller on reset.
1413 1424
1414 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1425 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1415 interval for usb hub power-on delay.(minimum 100msec) 1426 interval for usb hub power-on delay.(minimum 100msec)
1416 1427
1417 - USB Device: 1428 - USB Device:
1418 Define the below if you wish to use the USB console. 1429 Define the below if you wish to use the USB console.
1419 Once firmware is rebuilt from a serial console issue the 1430 Once firmware is rebuilt from a serial console issue the
1420 command "setenv stdin usbtty; setenv stdout usbtty" and 1431 command "setenv stdin usbtty; setenv stdout usbtty" and
1421 attach your USB cable. The Unix command "dmesg" should print 1432 attach your USB cable. The Unix command "dmesg" should print
1422 it has found a new device. The environment variable usbtty 1433 it has found a new device. The environment variable usbtty
1423 can be set to gserial or cdc_acm to enable your device to 1434 can be set to gserial or cdc_acm to enable your device to
1424 appear to a USB host as a Linux gserial device or a 1435 appear to a USB host as a Linux gserial device or a
1425 Common Device Class Abstract Control Model serial device. 1436 Common Device Class Abstract Control Model serial device.
1426 If you select usbtty = gserial you should be able to enumerate 1437 If you select usbtty = gserial you should be able to enumerate
1427 a Linux host by 1438 a Linux host by
1428 # modprobe usbserial vendor=0xVendorID product=0xProductID 1439 # modprobe usbserial vendor=0xVendorID product=0xProductID
1429 else if using cdc_acm, simply setting the environment 1440 else if using cdc_acm, simply setting the environment
1430 variable usbtty to be cdc_acm should suffice. The following 1441 variable usbtty to be cdc_acm should suffice. The following
1431 might be defined in YourBoardName.h 1442 might be defined in YourBoardName.h
1432 1443
1433 CONFIG_USB_DEVICE 1444 CONFIG_USB_DEVICE
1434 Define this to build a UDC device 1445 Define this to build a UDC device
1435 1446
1436 CONFIG_USB_TTY 1447 CONFIG_USB_TTY
1437 Define this to have a tty type of device available to 1448 Define this to have a tty type of device available to
1438 talk to the UDC device 1449 talk to the UDC device
1439 1450
1440 CONFIG_USBD_HS 1451 CONFIG_USBD_HS
1441 Define this to enable the high speed support for usb 1452 Define this to enable the high speed support for usb
1442 device and usbtty. If this feature is enabled, a routine 1453 device and usbtty. If this feature is enabled, a routine
1443 int is_usbd_high_speed(void) 1454 int is_usbd_high_speed(void)
1444 also needs to be defined by the driver to dynamically poll 1455 also needs to be defined by the driver to dynamically poll
1445 whether the enumeration has succeded at high speed or full 1456 whether the enumeration has succeded at high speed or full
1446 speed. 1457 speed.
1447 1458
1448 CONFIG_SYS_CONSOLE_IS_IN_ENV 1459 CONFIG_SYS_CONSOLE_IS_IN_ENV
1449 Define this if you want stdin, stdout &/or stderr to 1460 Define this if you want stdin, stdout &/or stderr to
1450 be set to usbtty. 1461 be set to usbtty.
1451 1462
1452 mpc8xx: 1463 mpc8xx:
1453 CONFIG_SYS_USB_EXTC_CLK 0xBLAH 1464 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1454 Derive USB clock from external clock "blah" 1465 Derive USB clock from external clock "blah"
1455 - CONFIG_SYS_USB_EXTC_CLK 0x02 1466 - CONFIG_SYS_USB_EXTC_CLK 0x02
1456 1467
1457 CONFIG_SYS_USB_BRG_CLK 0xBLAH 1468 CONFIG_SYS_USB_BRG_CLK 0xBLAH
1458 Derive USB clock from brgclk 1469 Derive USB clock from brgclk
1459 - CONFIG_SYS_USB_BRG_CLK 0x04 1470 - CONFIG_SYS_USB_BRG_CLK 0x04
1460 1471
1461 If you have a USB-IF assigned VendorID then you may wish to 1472 If you have a USB-IF assigned VendorID then you may wish to
1462 define your own vendor specific values either in BoardName.h 1473 define your own vendor specific values either in BoardName.h
1463 or directly in usbd_vendor_info.h. If you don't define 1474 or directly in usbd_vendor_info.h. If you don't define
1464 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 1475 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1465 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 1476 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1466 should pretend to be a Linux device to it's target host. 1477 should pretend to be a Linux device to it's target host.
1467 1478
1468 CONFIG_USBD_MANUFACTURER 1479 CONFIG_USBD_MANUFACTURER
1469 Define this string as the name of your company for 1480 Define this string as the name of your company for
1470 - CONFIG_USBD_MANUFACTURER "my company" 1481 - CONFIG_USBD_MANUFACTURER "my company"
1471 1482
1472 CONFIG_USBD_PRODUCT_NAME 1483 CONFIG_USBD_PRODUCT_NAME
1473 Define this string as the name of your product 1484 Define this string as the name of your product
1474 - CONFIG_USBD_PRODUCT_NAME "acme usb device" 1485 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1475 1486
1476 CONFIG_USBD_VENDORID 1487 CONFIG_USBD_VENDORID
1477 Define this as your assigned Vendor ID from the USB 1488 Define this as your assigned Vendor ID from the USB
1478 Implementors Forum. This *must* be a genuine Vendor ID 1489 Implementors Forum. This *must* be a genuine Vendor ID
1479 to avoid polluting the USB namespace. 1490 to avoid polluting the USB namespace.
1480 - CONFIG_USBD_VENDORID 0xFFFF 1491 - CONFIG_USBD_VENDORID 0xFFFF
1481 1492
1482 CONFIG_USBD_PRODUCTID 1493 CONFIG_USBD_PRODUCTID
1483 Define this as the unique Product ID 1494 Define this as the unique Product ID
1484 for your device 1495 for your device
1485 - CONFIG_USBD_PRODUCTID 0xFFFF 1496 - CONFIG_USBD_PRODUCTID 0xFFFF
1486 1497
1487 - ULPI Layer Support: 1498 - ULPI Layer Support:
1488 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1499 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1489 the generic ULPI layer. The generic layer accesses the ULPI PHY 1500 the generic ULPI layer. The generic layer accesses the ULPI PHY
1490 via the platform viewport, so you need both the genric layer and 1501 via the platform viewport, so you need both the genric layer and
1491 the viewport enabled. Currently only Chipidea/ARC based 1502 the viewport enabled. Currently only Chipidea/ARC based
1492 viewport is supported. 1503 viewport is supported.
1493 To enable the ULPI layer support, define CONFIG_USB_ULPI and 1504 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1494 CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 1505 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1495 If your ULPI phy needs a different reference clock than the 1506 If your ULPI phy needs a different reference clock than the
1496 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 1507 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1497 the appropriate value in Hz. 1508 the appropriate value in Hz.
1498 1509
1499 - MMC Support: 1510 - MMC Support:
1500 The MMC controller on the Intel PXA is supported. To 1511 The MMC controller on the Intel PXA is supported. To
1501 enable this define CONFIG_MMC. The MMC can be 1512 enable this define CONFIG_MMC. The MMC can be
1502 accessed from the boot prompt by mapping the device 1513 accessed from the boot prompt by mapping the device
1503 to physical memory similar to flash. Command line is 1514 to physical memory similar to flash. Command line is
1504 enabled with CONFIG_CMD_MMC. The MMC driver also works with 1515 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1505 the FAT fs. This is enabled with CONFIG_CMD_FAT. 1516 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1506 1517
1507 CONFIG_SH_MMCIF 1518 CONFIG_SH_MMCIF
1508 Support for Renesas on-chip MMCIF controller 1519 Support for Renesas on-chip MMCIF controller
1509 1520
1510 CONFIG_SH_MMCIF_ADDR 1521 CONFIG_SH_MMCIF_ADDR
1511 Define the base address of MMCIF registers 1522 Define the base address of MMCIF registers
1512 1523
1513 CONFIG_SH_MMCIF_CLK 1524 CONFIG_SH_MMCIF_CLK
1514 Define the clock frequency for MMCIF 1525 Define the clock frequency for MMCIF
1515 1526
1516 - USB Device Firmware Update (DFU) class support: 1527 - USB Device Firmware Update (DFU) class support:
1517 CONFIG_DFU_FUNCTION 1528 CONFIG_DFU_FUNCTION
1518 This enables the USB portion of the DFU USB class 1529 This enables the USB portion of the DFU USB class
1519 1530
1520 CONFIG_CMD_DFU 1531 CONFIG_CMD_DFU
1521 This enables the command "dfu" which is used to have 1532 This enables the command "dfu" which is used to have
1522 U-Boot create a DFU class device via USB. This command 1533 U-Boot create a DFU class device via USB. This command
1523 requires that the "dfu_alt_info" environment variable be 1534 requires that the "dfu_alt_info" environment variable be
1524 set and define the alt settings to expose to the host. 1535 set and define the alt settings to expose to the host.
1525 1536
1526 CONFIG_DFU_MMC 1537 CONFIG_DFU_MMC
1527 This enables support for exposing (e)MMC devices via DFU. 1538 This enables support for exposing (e)MMC devices via DFU.
1528 1539
1529 CONFIG_DFU_NAND 1540 CONFIG_DFU_NAND
1530 This enables support for exposing NAND devices via DFU. 1541 This enables support for exposing NAND devices via DFU.
1531 1542
1532 CONFIG_DFU_RAM 1543 CONFIG_DFU_RAM
1533 This enables support for exposing RAM via DFU. 1544 This enables support for exposing RAM via DFU.
1534 Note: DFU spec refer to non-volatile memory usage, but 1545 Note: DFU spec refer to non-volatile memory usage, but
1535 allow usages beyond the scope of spec - here RAM usage, 1546 allow usages beyond the scope of spec - here RAM usage,
1536 one that would help mostly the developer. 1547 one that would help mostly the developer.
1537 1548
1538 CONFIG_SYS_DFU_DATA_BUF_SIZE 1549 CONFIG_SYS_DFU_DATA_BUF_SIZE
1539 Dfu transfer uses a buffer before writing data to the 1550 Dfu transfer uses a buffer before writing data to the
1540 raw storage device. Make the size (in bytes) of this buffer 1551 raw storage device. Make the size (in bytes) of this buffer
1541 configurable. The size of this buffer is also configurable 1552 configurable. The size of this buffer is also configurable
1542 through the "dfu_bufsiz" environment variable. 1553 through the "dfu_bufsiz" environment variable.
1543 1554
1544 CONFIG_SYS_DFU_MAX_FILE_SIZE 1555 CONFIG_SYS_DFU_MAX_FILE_SIZE
1545 When updating files rather than the raw storage device, 1556 When updating files rather than the raw storage device,
1546 we use a static buffer to copy the file into and then write 1557 we use a static buffer to copy the file into and then write
1547 the buffer once we've been given the whole file. Define 1558 the buffer once we've been given the whole file. Define
1548 this to the maximum filesize (in bytes) for the buffer. 1559 this to the maximum filesize (in bytes) for the buffer.
1549 Default is 4 MiB if undefined. 1560 Default is 4 MiB if undefined.
1550 1561
1551 DFU_DEFAULT_POLL_TIMEOUT 1562 DFU_DEFAULT_POLL_TIMEOUT
1552 Poll timeout [ms], is the timeout a device can send to the 1563 Poll timeout [ms], is the timeout a device can send to the
1553 host. The host must wait for this timeout before sending 1564 host. The host must wait for this timeout before sending
1554 a subsequent DFU_GET_STATUS request to the device. 1565 a subsequent DFU_GET_STATUS request to the device.
1555 1566
1556 DFU_MANIFEST_POLL_TIMEOUT 1567 DFU_MANIFEST_POLL_TIMEOUT
1557 Poll timeout [ms], which the device sends to the host when 1568 Poll timeout [ms], which the device sends to the host when
1558 entering dfuMANIFEST state. Host waits this timeout, before 1569 entering dfuMANIFEST state. Host waits this timeout, before
1559 sending again an USB request to the device. 1570 sending again an USB request to the device.
1560 1571
1561 - Journaling Flash filesystem support: 1572 - Journaling Flash filesystem support:
1562 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 1573 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1563 CONFIG_JFFS2_NAND_DEV 1574 CONFIG_JFFS2_NAND_DEV
1564 Define these for a default partition on a NAND device 1575 Define these for a default partition on a NAND device
1565 1576
1566 CONFIG_SYS_JFFS2_FIRST_SECTOR, 1577 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1567 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 1578 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1568 Define these for a default partition on a NOR device 1579 Define these for a default partition on a NOR device
1569 1580
1570 CONFIG_SYS_JFFS_CUSTOM_PART 1581 CONFIG_SYS_JFFS_CUSTOM_PART
1571 Define this to create an own partition. You have to provide a 1582 Define this to create an own partition. You have to provide a
1572 function struct part_info* jffs2_part_info(int part_num) 1583 function struct part_info* jffs2_part_info(int part_num)
1573 1584
1574 If you define only one JFFS2 partition you may also want to 1585 If you define only one JFFS2 partition you may also want to
1575 #define CONFIG_SYS_JFFS_SINGLE_PART 1 1586 #define CONFIG_SYS_JFFS_SINGLE_PART 1
1576 to disable the command chpart. This is the default when you 1587 to disable the command chpart. This is the default when you
1577 have not defined a custom partition 1588 have not defined a custom partition
1578 1589
1579 - FAT(File Allocation Table) filesystem write function support: 1590 - FAT(File Allocation Table) filesystem write function support:
1580 CONFIG_FAT_WRITE 1591 CONFIG_FAT_WRITE
1581 1592
1582 Define this to enable support for saving memory data as a 1593 Define this to enable support for saving memory data as a
1583 file in FAT formatted partition. 1594 file in FAT formatted partition.
1584 1595
1585 This will also enable the command "fatwrite" enabling the 1596 This will also enable the command "fatwrite" enabling the
1586 user to write files to FAT. 1597 user to write files to FAT.
1587 1598
1588 CBFS (Coreboot Filesystem) support 1599 CBFS (Coreboot Filesystem) support
1589 CONFIG_CMD_CBFS 1600 CONFIG_CMD_CBFS
1590 1601
1591 Define this to enable support for reading from a Coreboot 1602 Define this to enable support for reading from a Coreboot
1592 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 1603 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1593 and cbfsload. 1604 and cbfsload.
1594 1605
1595 - Keyboard Support: 1606 - Keyboard Support:
1596 CONFIG_ISA_KEYBOARD 1607 CONFIG_ISA_KEYBOARD
1597 1608
1598 Define this to enable standard (PC-Style) keyboard 1609 Define this to enable standard (PC-Style) keyboard
1599 support 1610 support
1600 1611
1601 CONFIG_I8042_KBD 1612 CONFIG_I8042_KBD
1602 Standard PC keyboard driver with US (is default) and 1613 Standard PC keyboard driver with US (is default) and
1603 GERMAN key layout (switch via environment 'keymap=de') support. 1614 GERMAN key layout (switch via environment 'keymap=de') support.
1604 Export function i8042_kbd_init, i8042_tstc and i8042_getc 1615 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1605 for cfb_console. Supports cursor blinking. 1616 for cfb_console. Supports cursor blinking.
1606 1617
1607 CONFIG_CROS_EC_KEYB 1618 CONFIG_CROS_EC_KEYB
1608 Enables a Chrome OS keyboard using the CROS_EC interface. 1619 Enables a Chrome OS keyboard using the CROS_EC interface.
1609 This uses CROS_EC to communicate with a second microcontroller 1620 This uses CROS_EC to communicate with a second microcontroller
1610 which provides key scans on request. 1621 which provides key scans on request.
1611 1622
1612 - Video support: 1623 - Video support:
1613 CONFIG_VIDEO 1624 CONFIG_VIDEO
1614 1625
1615 Define this to enable video support (for output to 1626 Define this to enable video support (for output to
1616 video). 1627 video).
1617 1628
1618 CONFIG_VIDEO_CT69000 1629 CONFIG_VIDEO_CT69000
1619 1630
1620 Enable Chips & Technologies 69000 Video chip 1631 Enable Chips & Technologies 69000 Video chip
1621 1632
1622 CONFIG_VIDEO_SMI_LYNXEM 1633 CONFIG_VIDEO_SMI_LYNXEM
1623 Enable Silicon Motion SMI 712/710/810 Video chip. The 1634 Enable Silicon Motion SMI 712/710/810 Video chip. The
1624 video output is selected via environment 'videoout' 1635 video output is selected via environment 'videoout'
1625 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1636 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1626 assumed. 1637 assumed.
1627 1638
1628 For the CT69000 and SMI_LYNXEM drivers, videomode is 1639 For the CT69000 and SMI_LYNXEM drivers, videomode is
1629 selected via environment 'videomode'. Two different ways 1640 selected via environment 'videomode'. Two different ways
1630 are possible: 1641 are possible:
1631 - "videomode=num" 'num' is a standard LiLo mode numbers. 1642 - "videomode=num" 'num' is a standard LiLo mode numbers.
1632 Following standard modes are supported (* is default): 1643 Following standard modes are supported (* is default):
1633 1644
1634 Colors 640x480 800x600 1024x768 1152x864 1280x1024 1645 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1635 -------------+--------------------------------------------- 1646 -------------+---------------------------------------------
1636 8 bits | 0x301* 0x303 0x305 0x161 0x307 1647 8 bits | 0x301* 0x303 0x305 0x161 0x307
1637 15 bits | 0x310 0x313 0x316 0x162 0x319 1648 15 bits | 0x310 0x313 0x316 0x162 0x319
1638 16 bits | 0x311 0x314 0x317 0x163 0x31A 1649 16 bits | 0x311 0x314 0x317 0x163 0x31A
1639 24 bits | 0x312 0x315 0x318 ? 0x31B 1650 24 bits | 0x312 0x315 0x318 ? 0x31B
1640 -------------+--------------------------------------------- 1651 -------------+---------------------------------------------
1641 (i.e. setenv videomode 317; saveenv; reset;) 1652 (i.e. setenv videomode 317; saveenv; reset;)
1642 1653
1643 - "videomode=bootargs" all the video parameters are parsed 1654 - "videomode=bootargs" all the video parameters are parsed
1644 from the bootargs. (See drivers/video/videomodes.c) 1655 from the bootargs. (See drivers/video/videomodes.c)
1645 1656
1646 1657
1647 CONFIG_VIDEO_SED13806 1658 CONFIG_VIDEO_SED13806
1648 Enable Epson SED13806 driver. This driver supports 8bpp 1659 Enable Epson SED13806 driver. This driver supports 8bpp
1649 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1660 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1650 or CONFIG_VIDEO_SED13806_16BPP 1661 or CONFIG_VIDEO_SED13806_16BPP
1651 1662
1652 CONFIG_FSL_DIU_FB 1663 CONFIG_FSL_DIU_FB
1653 Enable the Freescale DIU video driver. Reference boards for 1664 Enable the Freescale DIU video driver. Reference boards for
1654 SOCs that have a DIU should define this macro to enable DIU 1665 SOCs that have a DIU should define this macro to enable DIU
1655 support, and should also define these other macros: 1666 support, and should also define these other macros:
1656 1667
1657 CONFIG_SYS_DIU_ADDR 1668 CONFIG_SYS_DIU_ADDR
1658 CONFIG_VIDEO 1669 CONFIG_VIDEO
1659 CONFIG_CMD_BMP 1670 CONFIG_CMD_BMP
1660 CONFIG_CFB_CONSOLE 1671 CONFIG_CFB_CONSOLE
1661 CONFIG_VIDEO_SW_CURSOR 1672 CONFIG_VIDEO_SW_CURSOR
1662 CONFIG_VGA_AS_SINGLE_DEVICE 1673 CONFIG_VGA_AS_SINGLE_DEVICE
1663 CONFIG_VIDEO_LOGO 1674 CONFIG_VIDEO_LOGO
1664 CONFIG_VIDEO_BMP_LOGO 1675 CONFIG_VIDEO_BMP_LOGO
1665 1676
1666 The DIU driver will look for the 'video-mode' environment 1677 The DIU driver will look for the 'video-mode' environment
1667 variable, and if defined, enable the DIU as a console during 1678 variable, and if defined, enable the DIU as a console during
1668 boot. See the documentation file README.video for a 1679 boot. See the documentation file README.video for a
1669 description of this variable. 1680 description of this variable.
1670 1681
1671 CONFIG_VIDEO_VGA 1682 CONFIG_VIDEO_VGA
1672 1683
1673 Enable the VGA video / BIOS for x86. The alternative if you 1684 Enable the VGA video / BIOS for x86. The alternative if you
1674 are using coreboot is to use the coreboot frame buffer 1685 are using coreboot is to use the coreboot frame buffer
1675 driver. 1686 driver.
1676 1687
1677 1688
1678 - Keyboard Support: 1689 - Keyboard Support:
1679 CONFIG_KEYBOARD 1690 CONFIG_KEYBOARD
1680 1691
1681 Define this to enable a custom keyboard support. 1692 Define this to enable a custom keyboard support.
1682 This simply calls drv_keyboard_init() which must be 1693 This simply calls drv_keyboard_init() which must be
1683 defined in your board-specific files. 1694 defined in your board-specific files.
1684 The only board using this so far is RBC823. 1695 The only board using this so far is RBC823.
1685 1696
1686 - LCD Support: CONFIG_LCD 1697 - LCD Support: CONFIG_LCD
1687 1698
1688 Define this to enable LCD support (for output to LCD 1699 Define this to enable LCD support (for output to LCD
1689 display); also select one of the supported displays 1700 display); also select one of the supported displays
1690 by defining one of these: 1701 by defining one of these:
1691 1702
1692 CONFIG_ATMEL_LCD: 1703 CONFIG_ATMEL_LCD:
1693 1704
1694 HITACHI TX09D70VM1CCA, 3.5", 240x320. 1705 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1695 1706
1696 CONFIG_NEC_NL6448AC33: 1707 CONFIG_NEC_NL6448AC33:
1697 1708
1698 NEC NL6448AC33-18. Active, color, single scan. 1709 NEC NL6448AC33-18. Active, color, single scan.
1699 1710
1700 CONFIG_NEC_NL6448BC20 1711 CONFIG_NEC_NL6448BC20
1701 1712
1702 NEC NL6448BC20-08. 6.5", 640x480. 1713 NEC NL6448BC20-08. 6.5", 640x480.
1703 Active, color, single scan. 1714 Active, color, single scan.
1704 1715
1705 CONFIG_NEC_NL6448BC33_54 1716 CONFIG_NEC_NL6448BC33_54
1706 1717
1707 NEC NL6448BC33-54. 10.4", 640x480. 1718 NEC NL6448BC33-54. 10.4", 640x480.
1708 Active, color, single scan. 1719 Active, color, single scan.
1709 1720
1710 CONFIG_SHARP_16x9 1721 CONFIG_SHARP_16x9
1711 1722
1712 Sharp 320x240. Active, color, single scan. 1723 Sharp 320x240. Active, color, single scan.
1713 It isn't 16x9, and I am not sure what it is. 1724 It isn't 16x9, and I am not sure what it is.
1714 1725
1715 CONFIG_SHARP_LQ64D341 1726 CONFIG_SHARP_LQ64D341
1716 1727
1717 Sharp LQ64D341 display, 640x480. 1728 Sharp LQ64D341 display, 640x480.
1718 Active, color, single scan. 1729 Active, color, single scan.
1719 1730
1720 CONFIG_HLD1045 1731 CONFIG_HLD1045
1721 1732
1722 HLD1045 display, 640x480. 1733 HLD1045 display, 640x480.
1723 Active, color, single scan. 1734 Active, color, single scan.
1724 1735
1725 CONFIG_OPTREX_BW 1736 CONFIG_OPTREX_BW
1726 1737
1727 Optrex CBL50840-2 NF-FW 99 22 M5 1738 Optrex CBL50840-2 NF-FW 99 22 M5
1728 or 1739 or
1729 Hitachi LMG6912RPFC-00T 1740 Hitachi LMG6912RPFC-00T
1730 or 1741 or
1731 Hitachi SP14Q002 1742 Hitachi SP14Q002
1732 1743
1733 320x240. Black & white. 1744 320x240. Black & white.
1734 1745
1735 Normally display is black on white background; define 1746 Normally display is black on white background; define
1736 CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1747 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1737 1748
1738 CONFIG_LCD_ALIGNMENT 1749 CONFIG_LCD_ALIGNMENT
1739 1750
1740 Normally the LCD is page-aligned (tyically 4KB). If this is 1751 Normally the LCD is page-aligned (tyically 4KB). If this is
1741 defined then the LCD will be aligned to this value instead. 1752 defined then the LCD will be aligned to this value instead.
1742 For ARM it is sometimes useful to use MMU_SECTION_SIZE 1753 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1743 here, since it is cheaper to change data cache settings on 1754 here, since it is cheaper to change data cache settings on
1744 a per-section basis. 1755 a per-section basis.
1745 1756
1746 CONFIG_CONSOLE_SCROLL_LINES 1757 CONFIG_CONSOLE_SCROLL_LINES
1747 1758
1748 When the console need to be scrolled, this is the number of 1759 When the console need to be scrolled, this is the number of
1749 lines to scroll by. It defaults to 1. Increasing this makes 1760 lines to scroll by. It defaults to 1. Increasing this makes
1750 the console jump but can help speed up operation when scrolling 1761 the console jump but can help speed up operation when scrolling
1751 is slow. 1762 is slow.
1752 1763
1753 CONFIG_LCD_BMP_RLE8 1764 CONFIG_LCD_BMP_RLE8
1754 1765
1755 Support drawing of RLE8-compressed bitmaps on the LCD. 1766 Support drawing of RLE8-compressed bitmaps on the LCD.
1756 1767
1757 CONFIG_I2C_EDID 1768 CONFIG_I2C_EDID
1758 1769
1759 Enables an 'i2c edid' command which can read EDID 1770 Enables an 'i2c edid' command which can read EDID
1760 information over I2C from an attached LCD display. 1771 information over I2C from an attached LCD display.
1761 1772
1762 - Splash Screen Support: CONFIG_SPLASH_SCREEN 1773 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1763 1774
1764 If this option is set, the environment is checked for 1775 If this option is set, the environment is checked for
1765 a variable "splashimage". If found, the usual display 1776 a variable "splashimage". If found, the usual display
1766 of logo, copyright and system information on the LCD 1777 of logo, copyright and system information on the LCD
1767 is suppressed and the BMP image at the address 1778 is suppressed and the BMP image at the address
1768 specified in "splashimage" is loaded instead. The 1779 specified in "splashimage" is loaded instead. The
1769 console is redirected to the "nulldev", too. This 1780 console is redirected to the "nulldev", too. This
1770 allows for a "silent" boot where a splash screen is 1781 allows for a "silent" boot where a splash screen is
1771 loaded very quickly after power-on. 1782 loaded very quickly after power-on.
1772 1783
1773 CONFIG_SPLASHIMAGE_GUARD 1784 CONFIG_SPLASHIMAGE_GUARD
1774 1785
1775 If this option is set, then U-Boot will prevent the environment 1786 If this option is set, then U-Boot will prevent the environment
1776 variable "splashimage" from being set to a problematic address 1787 variable "splashimage" from being set to a problematic address
1777 (see README.displaying-bmps). 1788 (see README.displaying-bmps).
1778 This option is useful for targets where, due to alignment 1789 This option is useful for targets where, due to alignment
1779 restrictions, an improperly aligned BMP image will cause a data 1790 restrictions, an improperly aligned BMP image will cause a data
1780 abort. If you think you will not have problems with unaligned 1791 abort. If you think you will not have problems with unaligned
1781 accesses (for example because your toolchain prevents them) 1792 accesses (for example because your toolchain prevents them)
1782 there is no need to set this option. 1793 there is no need to set this option.
1783 1794
1784 CONFIG_SPLASH_SCREEN_ALIGN 1795 CONFIG_SPLASH_SCREEN_ALIGN
1785 1796
1786 If this option is set the splash image can be freely positioned 1797 If this option is set the splash image can be freely positioned
1787 on the screen. Environment variable "splashpos" specifies the 1798 on the screen. Environment variable "splashpos" specifies the
1788 position as "x,y". If a positive number is given it is used as 1799 position as "x,y". If a positive number is given it is used as
1789 number of pixel from left/top. If a negative number is given it 1800 number of pixel from left/top. If a negative number is given it
1790 is used as number of pixel from right/bottom. You can also 1801 is used as number of pixel from right/bottom. You can also
1791 specify 'm' for centering the image. 1802 specify 'm' for centering the image.
1792 1803
1793 Example: 1804 Example:
1794 setenv splashpos m,m 1805 setenv splashpos m,m
1795 => image at center of screen 1806 => image at center of screen
1796 1807
1797 setenv splashpos 30,20 1808 setenv splashpos 30,20
1798 => image at x = 30 and y = 20 1809 => image at x = 30 and y = 20
1799 1810
1800 setenv splashpos -10,m 1811 setenv splashpos -10,m
1801 => vertically centered image 1812 => vertically centered image
1802 at x = dspWidth - bmpWidth - 9 1813 at x = dspWidth - bmpWidth - 9
1803 1814
1804 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 1815 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1805 1816
1806 If this option is set, additionally to standard BMP 1817 If this option is set, additionally to standard BMP
1807 images, gzipped BMP images can be displayed via the 1818 images, gzipped BMP images can be displayed via the
1808 splashscreen support or the bmp command. 1819 splashscreen support or the bmp command.
1809 1820
1810 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1821 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1811 1822
1812 If this option is set, 8-bit RLE compressed BMP images 1823 If this option is set, 8-bit RLE compressed BMP images
1813 can be displayed via the splashscreen support or the 1824 can be displayed via the splashscreen support or the
1814 bmp command. 1825 bmp command.
1815 1826
1816 - Do compresssing for memory range: 1827 - Do compresssing for memory range:
1817 CONFIG_CMD_ZIP 1828 CONFIG_CMD_ZIP
1818 1829
1819 If this option is set, it would use zlib deflate method 1830 If this option is set, it would use zlib deflate method
1820 to compress the specified memory at its best effort. 1831 to compress the specified memory at its best effort.
1821 1832
1822 - Compression support: 1833 - Compression support:
1823 CONFIG_GZIP 1834 CONFIG_GZIP
1824 1835
1825 Enabled by default to support gzip compressed images. 1836 Enabled by default to support gzip compressed images.
1826 1837
1827 CONFIG_BZIP2 1838 CONFIG_BZIP2
1828 1839
1829 If this option is set, support for bzip2 compressed 1840 If this option is set, support for bzip2 compressed
1830 images is included. If not, only uncompressed and gzip 1841 images is included. If not, only uncompressed and gzip
1831 compressed images are supported. 1842 compressed images are supported.
1832 1843
1833 NOTE: the bzip2 algorithm requires a lot of RAM, so 1844 NOTE: the bzip2 algorithm requires a lot of RAM, so
1834 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1845 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1835 be at least 4MB. 1846 be at least 4MB.
1836 1847
1837 CONFIG_LZMA 1848 CONFIG_LZMA
1838 1849
1839 If this option is set, support for lzma compressed 1850 If this option is set, support for lzma compressed
1840 images is included. 1851 images is included.
1841 1852
1842 Note: The LZMA algorithm adds between 2 and 4KB of code and it 1853 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1843 requires an amount of dynamic memory that is given by the 1854 requires an amount of dynamic memory that is given by the
1844 formula: 1855 formula:
1845 1856
1846 (1846 + 768 << (lc + lp)) * sizeof(uint16) 1857 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1847 1858
1848 Where lc and lp stand for, respectively, Literal context bits 1859 Where lc and lp stand for, respectively, Literal context bits
1849 and Literal pos bits. 1860 and Literal pos bits.
1850 1861
1851 This value is upper-bounded by 14MB in the worst case. Anyway, 1862 This value is upper-bounded by 14MB in the worst case. Anyway,
1852 for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1863 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1853 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1864 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1854 a very small buffer. 1865 a very small buffer.
1855 1866
1856 Use the lzmainfo tool to determinate the lc and lp values and 1867 Use the lzmainfo tool to determinate the lc and lp values and
1857 then calculate the amount of needed dynamic memory (ensuring 1868 then calculate the amount of needed dynamic memory (ensuring
1858 the appropriate CONFIG_SYS_MALLOC_LEN value). 1869 the appropriate CONFIG_SYS_MALLOC_LEN value).
1859 1870
1860 CONFIG_LZO 1871 CONFIG_LZO
1861 1872
1862 If this option is set, support for LZO compressed images 1873 If this option is set, support for LZO compressed images
1863 is included. 1874 is included.
1864 1875
1865 - MII/PHY support: 1876 - MII/PHY support:
1866 CONFIG_PHY_ADDR 1877 CONFIG_PHY_ADDR
1867 1878
1868 The address of PHY on MII bus. 1879 The address of PHY on MII bus.
1869 1880
1870 CONFIG_PHY_CLOCK_FREQ (ppc4xx) 1881 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1871 1882
1872 The clock frequency of the MII bus 1883 The clock frequency of the MII bus
1873 1884
1874 CONFIG_PHY_GIGE 1885 CONFIG_PHY_GIGE
1875 1886
1876 If this option is set, support for speed/duplex 1887 If this option is set, support for speed/duplex
1877 detection of gigabit PHY is included. 1888 detection of gigabit PHY is included.
1878 1889
1879 CONFIG_PHY_RESET_DELAY 1890 CONFIG_PHY_RESET_DELAY
1880 1891
1881 Some PHY like Intel LXT971A need extra delay after 1892 Some PHY like Intel LXT971A need extra delay after
1882 reset before any MII register access is possible. 1893 reset before any MII register access is possible.
1883 For such PHY, set this option to the usec delay 1894 For such PHY, set this option to the usec delay
1884 required. (minimum 300usec for LXT971A) 1895 required. (minimum 300usec for LXT971A)
1885 1896
1886 CONFIG_PHY_CMD_DELAY (ppc4xx) 1897 CONFIG_PHY_CMD_DELAY (ppc4xx)
1887 1898
1888 Some PHY like Intel LXT971A need extra delay after 1899 Some PHY like Intel LXT971A need extra delay after
1889 command issued before MII status register can be read 1900 command issued before MII status register can be read
1890 1901
1891 - Ethernet address: 1902 - Ethernet address:
1892 CONFIG_ETHADDR 1903 CONFIG_ETHADDR
1893 CONFIG_ETH1ADDR 1904 CONFIG_ETH1ADDR
1894 CONFIG_ETH2ADDR 1905 CONFIG_ETH2ADDR
1895 CONFIG_ETH3ADDR 1906 CONFIG_ETH3ADDR
1896 CONFIG_ETH4ADDR 1907 CONFIG_ETH4ADDR
1897 CONFIG_ETH5ADDR 1908 CONFIG_ETH5ADDR
1898 1909
1899 Define a default value for Ethernet address to use 1910 Define a default value for Ethernet address to use
1900 for the respective Ethernet interface, in case this 1911 for the respective Ethernet interface, in case this
1901 is not determined automatically. 1912 is not determined automatically.
1902 1913
1903 - IP address: 1914 - IP address:
1904 CONFIG_IPADDR 1915 CONFIG_IPADDR
1905 1916
1906 Define a default value for the IP address to use for 1917 Define a default value for the IP address to use for
1907 the default Ethernet interface, in case this is not 1918 the default Ethernet interface, in case this is not
1908 determined through e.g. bootp. 1919 determined through e.g. bootp.
1909 (Environment variable "ipaddr") 1920 (Environment variable "ipaddr")
1910 1921
1911 - Server IP address: 1922 - Server IP address:
1912 CONFIG_SERVERIP 1923 CONFIG_SERVERIP
1913 1924
1914 Defines a default value for the IP address of a TFTP 1925 Defines a default value for the IP address of a TFTP
1915 server to contact when using the "tftboot" command. 1926 server to contact when using the "tftboot" command.
1916 (Environment variable "serverip") 1927 (Environment variable "serverip")
1917 1928
1918 CONFIG_KEEP_SERVERADDR 1929 CONFIG_KEEP_SERVERADDR
1919 1930
1920 Keeps the server's MAC address, in the env 'serveraddr' 1931 Keeps the server's MAC address, in the env 'serveraddr'
1921 for passing to bootargs (like Linux's netconsole option) 1932 for passing to bootargs (like Linux's netconsole option)
1922 1933
1923 - Gateway IP address: 1934 - Gateway IP address:
1924 CONFIG_GATEWAYIP 1935 CONFIG_GATEWAYIP
1925 1936
1926 Defines a default value for the IP address of the 1937 Defines a default value for the IP address of the
1927 default router where packets to other networks are 1938 default router where packets to other networks are
1928 sent to. 1939 sent to.
1929 (Environment variable "gatewayip") 1940 (Environment variable "gatewayip")
1930 1941
1931 - Subnet mask: 1942 - Subnet mask:
1932 CONFIG_NETMASK 1943 CONFIG_NETMASK
1933 1944
1934 Defines a default value for the subnet mask (or 1945 Defines a default value for the subnet mask (or
1935 routing prefix) which is used to determine if an IP 1946 routing prefix) which is used to determine if an IP
1936 address belongs to the local subnet or needs to be 1947 address belongs to the local subnet or needs to be
1937 forwarded through a router. 1948 forwarded through a router.
1938 (Environment variable "netmask") 1949 (Environment variable "netmask")
1939 1950
1940 - Multicast TFTP Mode: 1951 - Multicast TFTP Mode:
1941 CONFIG_MCAST_TFTP 1952 CONFIG_MCAST_TFTP
1942 1953
1943 Defines whether you want to support multicast TFTP as per 1954 Defines whether you want to support multicast TFTP as per
1944 rfc-2090; for example to work with atftp. Lets lots of targets 1955 rfc-2090; for example to work with atftp. Lets lots of targets
1945 tftp down the same boot image concurrently. Note: the Ethernet 1956 tftp down the same boot image concurrently. Note: the Ethernet
1946 driver in use must provide a function: mcast() to join/leave a 1957 driver in use must provide a function: mcast() to join/leave a
1947 multicast group. 1958 multicast group.
1948 1959
1949 - BOOTP Recovery Mode: 1960 - BOOTP Recovery Mode:
1950 CONFIG_BOOTP_RANDOM_DELAY 1961 CONFIG_BOOTP_RANDOM_DELAY
1951 1962
1952 If you have many targets in a network that try to 1963 If you have many targets in a network that try to
1953 boot using BOOTP, you may want to avoid that all 1964 boot using BOOTP, you may want to avoid that all
1954 systems send out BOOTP requests at precisely the same 1965 systems send out BOOTP requests at precisely the same
1955 moment (which would happen for instance at recovery 1966 moment (which would happen for instance at recovery
1956 from a power failure, when all systems will try to 1967 from a power failure, when all systems will try to
1957 boot, thus flooding the BOOTP server. Defining 1968 boot, thus flooding the BOOTP server. Defining
1958 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1969 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1959 inserted before sending out BOOTP requests. The 1970 inserted before sending out BOOTP requests. The
1960 following delays are inserted then: 1971 following delays are inserted then:
1961 1972
1962 1st BOOTP request: delay 0 ... 1 sec 1973 1st BOOTP request: delay 0 ... 1 sec
1963 2nd BOOTP request: delay 0 ... 2 sec 1974 2nd BOOTP request: delay 0 ... 2 sec
1964 3rd BOOTP request: delay 0 ... 4 sec 1975 3rd BOOTP request: delay 0 ... 4 sec
1965 4th and following 1976 4th and following
1966 BOOTP requests: delay 0 ... 8 sec 1977 BOOTP requests: delay 0 ... 8 sec
1967 1978
1968 - DHCP Advanced Options: 1979 - DHCP Advanced Options:
1969 You can fine tune the DHCP functionality by defining 1980 You can fine tune the DHCP functionality by defining
1970 CONFIG_BOOTP_* symbols: 1981 CONFIG_BOOTP_* symbols:
1971 1982
1972 CONFIG_BOOTP_SUBNETMASK 1983 CONFIG_BOOTP_SUBNETMASK
1973 CONFIG_BOOTP_GATEWAY 1984 CONFIG_BOOTP_GATEWAY
1974 CONFIG_BOOTP_HOSTNAME 1985 CONFIG_BOOTP_HOSTNAME
1975 CONFIG_BOOTP_NISDOMAIN 1986 CONFIG_BOOTP_NISDOMAIN
1976 CONFIG_BOOTP_BOOTPATH 1987 CONFIG_BOOTP_BOOTPATH
1977 CONFIG_BOOTP_BOOTFILESIZE 1988 CONFIG_BOOTP_BOOTFILESIZE
1978 CONFIG_BOOTP_DNS 1989 CONFIG_BOOTP_DNS
1979 CONFIG_BOOTP_DNS2 1990 CONFIG_BOOTP_DNS2
1980 CONFIG_BOOTP_SEND_HOSTNAME 1991 CONFIG_BOOTP_SEND_HOSTNAME
1981 CONFIG_BOOTP_NTPSERVER 1992 CONFIG_BOOTP_NTPSERVER
1982 CONFIG_BOOTP_TIMEOFFSET 1993 CONFIG_BOOTP_TIMEOFFSET
1983 CONFIG_BOOTP_VENDOREX 1994 CONFIG_BOOTP_VENDOREX
1984 CONFIG_BOOTP_MAY_FAIL 1995 CONFIG_BOOTP_MAY_FAIL
1985 1996
1986 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 1997 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1987 environment variable, not the BOOTP server. 1998 environment variable, not the BOOTP server.
1988 1999
1989 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 2000 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1990 after the configured retry count, the call will fail 2001 after the configured retry count, the call will fail
1991 instead of starting over. This can be used to fail over 2002 instead of starting over. This can be used to fail over
1992 to Link-local IP address configuration if the DHCP server 2003 to Link-local IP address configuration if the DHCP server
1993 is not available. 2004 is not available.
1994 2005
1995 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 2006 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1996 serverip from a DHCP server, it is possible that more 2007 serverip from a DHCP server, it is possible that more
1997 than one DNS serverip is offered to the client. 2008 than one DNS serverip is offered to the client.
1998 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 2009 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1999 serverip will be stored in the additional environment 2010 serverip will be stored in the additional environment
2000 variable "dnsip2". The first DNS serverip is always 2011 variable "dnsip2". The first DNS serverip is always
2001 stored in the variable "dnsip", when CONFIG_BOOTP_DNS 2012 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
2002 is defined. 2013 is defined.
2003 2014
2004 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 2015 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2005 to do a dynamic update of a DNS server. To do this, they 2016 to do a dynamic update of a DNS server. To do this, they
2006 need the hostname of the DHCP requester. 2017 need the hostname of the DHCP requester.
2007 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 2018 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
2008 of the "hostname" environment variable is passed as 2019 of the "hostname" environment variable is passed as
2009 option 12 to the DHCP server. 2020 option 12 to the DHCP server.
2010 2021
2011 CONFIG_BOOTP_DHCP_REQUEST_DELAY 2022 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2012 2023
2013 A 32bit value in microseconds for a delay between 2024 A 32bit value in microseconds for a delay between
2014 receiving a "DHCP Offer" and sending the "DHCP Request". 2025 receiving a "DHCP Offer" and sending the "DHCP Request".
2015 This fixes a problem with certain DHCP servers that don't 2026 This fixes a problem with certain DHCP servers that don't
2016 respond 100% of the time to a "DHCP request". E.g. On an 2027 respond 100% of the time to a "DHCP request". E.g. On an
2017 AT91RM9200 processor running at 180MHz, this delay needed 2028 AT91RM9200 processor running at 180MHz, this delay needed
2018 to be *at least* 15,000 usec before a Windows Server 2003 2029 to be *at least* 15,000 usec before a Windows Server 2003
2019 DHCP server would reply 100% of the time. I recommend at 2030 DHCP server would reply 100% of the time. I recommend at
2020 least 50,000 usec to be safe. The alternative is to hope 2031 least 50,000 usec to be safe. The alternative is to hope
2021 that one of the retries will be successful but note that 2032 that one of the retries will be successful but note that
2022 the DHCP timeout and retry process takes a longer than 2033 the DHCP timeout and retry process takes a longer than
2023 this delay. 2034 this delay.
2024 2035
2025 - Link-local IP address negotiation: 2036 - Link-local IP address negotiation:
2026 Negotiate with other link-local clients on the local network 2037 Negotiate with other link-local clients on the local network
2027 for an address that doesn't require explicit configuration. 2038 for an address that doesn't require explicit configuration.
2028 This is especially useful if a DHCP server cannot be guaranteed 2039 This is especially useful if a DHCP server cannot be guaranteed
2029 to exist in all environments that the device must operate. 2040 to exist in all environments that the device must operate.
2030 2041
2031 See doc/README.link-local for more information. 2042 See doc/README.link-local for more information.
2032 2043
2033 - CDP Options: 2044 - CDP Options:
2034 CONFIG_CDP_DEVICE_ID 2045 CONFIG_CDP_DEVICE_ID
2035 2046
2036 The device id used in CDP trigger frames. 2047 The device id used in CDP trigger frames.
2037 2048
2038 CONFIG_CDP_DEVICE_ID_PREFIX 2049 CONFIG_CDP_DEVICE_ID_PREFIX
2039 2050
2040 A two character string which is prefixed to the MAC address 2051 A two character string which is prefixed to the MAC address
2041 of the device. 2052 of the device.
2042 2053
2043 CONFIG_CDP_PORT_ID 2054 CONFIG_CDP_PORT_ID
2044 2055
2045 A printf format string which contains the ascii name of 2056 A printf format string which contains the ascii name of
2046 the port. Normally is set to "eth%d" which sets 2057 the port. Normally is set to "eth%d" which sets
2047 eth0 for the first Ethernet, eth1 for the second etc. 2058 eth0 for the first Ethernet, eth1 for the second etc.
2048 2059
2049 CONFIG_CDP_CAPABILITIES 2060 CONFIG_CDP_CAPABILITIES
2050 2061
2051 A 32bit integer which indicates the device capabilities; 2062 A 32bit integer which indicates the device capabilities;
2052 0x00000010 for a normal host which does not forwards. 2063 0x00000010 for a normal host which does not forwards.
2053 2064
2054 CONFIG_CDP_VERSION 2065 CONFIG_CDP_VERSION
2055 2066
2056 An ascii string containing the version of the software. 2067 An ascii string containing the version of the software.
2057 2068
2058 CONFIG_CDP_PLATFORM 2069 CONFIG_CDP_PLATFORM
2059 2070
2060 An ascii string containing the name of the platform. 2071 An ascii string containing the name of the platform.
2061 2072
2062 CONFIG_CDP_TRIGGER 2073 CONFIG_CDP_TRIGGER
2063 2074
2064 A 32bit integer sent on the trigger. 2075 A 32bit integer sent on the trigger.
2065 2076
2066 CONFIG_CDP_POWER_CONSUMPTION 2077 CONFIG_CDP_POWER_CONSUMPTION
2067 2078
2068 A 16bit integer containing the power consumption of the 2079 A 16bit integer containing the power consumption of the
2069 device in .1 of milliwatts. 2080 device in .1 of milliwatts.
2070 2081
2071 CONFIG_CDP_APPLIANCE_VLAN_TYPE 2082 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2072 2083
2073 A byte containing the id of the VLAN. 2084 A byte containing the id of the VLAN.
2074 2085
2075 - Status LED: CONFIG_STATUS_LED 2086 - Status LED: CONFIG_STATUS_LED
2076 2087
2077 Several configurations allow to display the current 2088 Several configurations allow to display the current
2078 status using a LED. For instance, the LED will blink 2089 status using a LED. For instance, the LED will blink
2079 fast while running U-Boot code, stop blinking as 2090 fast while running U-Boot code, stop blinking as
2080 soon as a reply to a BOOTP request was received, and 2091 soon as a reply to a BOOTP request was received, and
2081 start blinking slow once the Linux kernel is running 2092 start blinking slow once the Linux kernel is running
2082 (supported by a status LED driver in the Linux 2093 (supported by a status LED driver in the Linux
2083 kernel). Defining CONFIG_STATUS_LED enables this 2094 kernel). Defining CONFIG_STATUS_LED enables this
2084 feature in U-Boot. 2095 feature in U-Boot.
2085 2096
2086 Additional options: 2097 Additional options:
2087 2098
2088 CONFIG_GPIO_LED 2099 CONFIG_GPIO_LED
2089 The status LED can be connected to a GPIO pin. 2100 The status LED can be connected to a GPIO pin.
2090 In such cases, the gpio_led driver can be used as a 2101 In such cases, the gpio_led driver can be used as a
2091 status LED backend implementation. Define CONFIG_GPIO_LED 2102 status LED backend implementation. Define CONFIG_GPIO_LED
2092 to include the gpio_led driver in the U-Boot binary. 2103 to include the gpio_led driver in the U-Boot binary.
2093 2104
2094 CONFIG_GPIO_LED_INVERTED_TABLE 2105 CONFIG_GPIO_LED_INVERTED_TABLE
2095 Some GPIO connected LEDs may have inverted polarity in which 2106 Some GPIO connected LEDs may have inverted polarity in which
2096 case the GPIO high value corresponds to LED off state and 2107 case the GPIO high value corresponds to LED off state and
2097 GPIO low value corresponds to LED on state. 2108 GPIO low value corresponds to LED on state.
2098 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 2109 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2099 with a list of GPIO LEDs that have inverted polarity. 2110 with a list of GPIO LEDs that have inverted polarity.
2100 2111
2101 - CAN Support: CONFIG_CAN_DRIVER 2112 - CAN Support: CONFIG_CAN_DRIVER
2102 2113
2103 Defining CONFIG_CAN_DRIVER enables CAN driver support 2114 Defining CONFIG_CAN_DRIVER enables CAN driver support
2104 on those systems that support this (optional) 2115 on those systems that support this (optional)
2105 feature, like the TQM8xxL modules. 2116 feature, like the TQM8xxL modules.
2106 2117
2107 - I2C Support: CONFIG_SYS_I2C 2118 - I2C Support: CONFIG_SYS_I2C
2108 2119
2109 This enable the NEW i2c subsystem, and will allow you to use 2120 This enable the NEW i2c subsystem, and will allow you to use
2110 i2c commands at the u-boot command line (as long as you set 2121 i2c commands at the u-boot command line (as long as you set
2111 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 2122 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2112 based realtime clock chips or other i2c devices. See 2123 based realtime clock chips or other i2c devices. See
2113 common/cmd_i2c.c for a description of the command line 2124 common/cmd_i2c.c for a description of the command line
2114 interface. 2125 interface.
2115 2126
2116 ported i2c driver to the new framework: 2127 ported i2c driver to the new framework:
2117 - drivers/i2c/soft_i2c.c: 2128 - drivers/i2c/soft_i2c.c:
2118 - activate first bus with CONFIG_SYS_I2C_SOFT define 2129 - activate first bus with CONFIG_SYS_I2C_SOFT define
2119 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2130 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2120 for defining speed and slave address 2131 for defining speed and slave address
2121 - activate second bus with I2C_SOFT_DECLARATIONS2 define 2132 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2122 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2133 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2123 for defining speed and slave address 2134 for defining speed and slave address
2124 - activate third bus with I2C_SOFT_DECLARATIONS3 define 2135 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2125 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2136 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2126 for defining speed and slave address 2137 for defining speed and slave address
2127 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2138 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2128 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2139 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2129 for defining speed and slave address 2140 for defining speed and slave address
2130 2141
2131 - drivers/i2c/fsl_i2c.c: 2142 - drivers/i2c/fsl_i2c.c:
2132 - activate i2c driver with CONFIG_SYS_I2C_FSL 2143 - activate i2c driver with CONFIG_SYS_I2C_FSL
2133 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 2144 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2134 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 2145 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2135 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 2146 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2136 bus. 2147 bus.
2137 - If your board supports a second fsl i2c bus, define 2148 - If your board supports a second fsl i2c bus, define
2138 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 2149 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2139 CONFIG_SYS_FSL_I2C2_SPEED for the speed and 2150 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2140 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 2151 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2141 second bus. 2152 second bus.
2142 2153
2143 - drivers/i2c/tegra_i2c.c: 2154 - drivers/i2c/tegra_i2c.c:
2144 - activate this driver with CONFIG_SYS_I2C_TEGRA 2155 - activate this driver with CONFIG_SYS_I2C_TEGRA
2145 - This driver adds 4 i2c buses with a fix speed from 2156 - This driver adds 4 i2c buses with a fix speed from
2146 100000 and the slave addr 0! 2157 100000 and the slave addr 0!
2147 2158
2148 - drivers/i2c/ppc4xx_i2c.c 2159 - drivers/i2c/ppc4xx_i2c.c
2149 - activate this driver with CONFIG_SYS_I2C_PPC4XX 2160 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2150 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2161 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2151 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2162 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2152 2163
2153 - drivers/i2c/i2c_mxc.c 2164 - drivers/i2c/i2c_mxc.c
2154 - activate this driver with CONFIG_SYS_I2C_MXC 2165 - activate this driver with CONFIG_SYS_I2C_MXC
2155 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2166 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2156 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2167 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2157 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2168 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2158 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2169 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2159 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2170 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2160 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 2171 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2161 If thoses defines are not set, default value is 100000 2172 If thoses defines are not set, default value is 100000
2162 for speed, and 0 for slave. 2173 for speed, and 0 for slave.
2163 2174
2164 - drivers/i2c/rcar_i2c.c: 2175 - drivers/i2c/rcar_i2c.c:
2165 - activate this driver with CONFIG_SYS_I2C_RCAR 2176 - activate this driver with CONFIG_SYS_I2C_RCAR
2166 - This driver adds 4 i2c buses 2177 - This driver adds 4 i2c buses
2167 2178
2168 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 2179 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2169 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 2180 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2170 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 2181 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2171 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 2182 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2172 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 2183 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2173 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 2184 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2174 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 2185 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2175 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 2186 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2176 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 2187 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2177 2188
2178 - drivers/i2c/sh_i2c.c: 2189 - drivers/i2c/sh_i2c.c:
2179 - activate this driver with CONFIG_SYS_I2C_SH 2190 - activate this driver with CONFIG_SYS_I2C_SH
2180 - This driver adds from 2 to 5 i2c buses 2191 - This driver adds from 2 to 5 i2c buses
2181 2192
2182 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 2193 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2183 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 2194 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2184 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 2195 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2185 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 2196 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2186 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 2197 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2187 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 2198 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2188 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 2199 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2189 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 2200 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2190 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 2201 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2191 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 2202 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2192 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 2203 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2193 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 2204 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2194 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses 2205 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2195 2206
2196 - drivers/i2c/omap24xx_i2c.c 2207 - drivers/i2c/omap24xx_i2c.c
2197 - activate this driver with CONFIG_SYS_I2C_OMAP24XX 2208 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2198 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 2209 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2199 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 2210 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2200 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 2211 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2201 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 2212 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2202 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 2213 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2203 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 2214 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2204 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 2215 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2205 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 2216 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2206 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 2217 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2207 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 2218 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2208 2219
2209 - drivers/i2c/zynq_i2c.c 2220 - drivers/i2c/zynq_i2c.c
2210 - activate this driver with CONFIG_SYS_I2C_ZYNQ 2221 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2211 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 2222 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2212 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 2223 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2213 2224
2214 - drivers/i2c/s3c24x0_i2c.c: 2225 - drivers/i2c/s3c24x0_i2c.c:
2215 - activate this driver with CONFIG_SYS_I2C_S3C24X0 2226 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2216 - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2227 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2217 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2228 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2218 with a fix speed from 100000 and the slave addr 0! 2229 with a fix speed from 100000 and the slave addr 0!
2219 2230
2220 additional defines: 2231 additional defines:
2221 2232
2222 CONFIG_SYS_NUM_I2C_BUSES 2233 CONFIG_SYS_NUM_I2C_BUSES
2223 Hold the number of i2c busses you want to use. If you 2234 Hold the number of i2c busses you want to use. If you
2224 don't use/have i2c muxes on your i2c bus, this 2235 don't use/have i2c muxes on your i2c bus, this
2225 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 2236 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2226 omit this define. 2237 omit this define.
2227 2238
2228 CONFIG_SYS_I2C_DIRECT_BUS 2239 CONFIG_SYS_I2C_DIRECT_BUS
2229 define this, if you don't use i2c muxes on your hardware. 2240 define this, if you don't use i2c muxes on your hardware.
2230 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 2241 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2231 omit this define. 2242 omit this define.
2232 2243
2233 CONFIG_SYS_I2C_MAX_HOPS 2244 CONFIG_SYS_I2C_MAX_HOPS
2234 define how many muxes are maximal consecutively connected 2245 define how many muxes are maximal consecutively connected
2235 on one i2c bus. If you not use i2c muxes, omit this 2246 on one i2c bus. If you not use i2c muxes, omit this
2236 define. 2247 define.
2237 2248
2238 CONFIG_SYS_I2C_BUSES 2249 CONFIG_SYS_I2C_BUSES
2239 hold a list of busses you want to use, only used if 2250 hold a list of busses you want to use, only used if
2240 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 2251 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2241 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 2252 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2242 CONFIG_SYS_NUM_I2C_BUSES = 9: 2253 CONFIG_SYS_NUM_I2C_BUSES = 9:
2243 2254
2244 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 2255 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2245 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 2256 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2246 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 2257 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2247 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 2258 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2248 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 2259 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2249 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 2260 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2250 {1, {I2C_NULL_HOP}}, \ 2261 {1, {I2C_NULL_HOP}}, \
2251 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 2262 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2252 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 2263 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2253 } 2264 }
2254 2265
2255 which defines 2266 which defines
2256 bus 0 on adapter 0 without a mux 2267 bus 0 on adapter 0 without a mux
2257 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2268 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2258 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2269 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2259 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2270 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2260 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2271 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2261 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 2272 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2262 bus 6 on adapter 1 without a mux 2273 bus 6 on adapter 1 without a mux
2263 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2274 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2264 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 2275 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2265 2276
2266 If you do not have i2c muxes on your board, omit this define. 2277 If you do not have i2c muxes on your board, omit this define.
2267 2278
2268 - Legacy I2C Support: CONFIG_HARD_I2C 2279 - Legacy I2C Support: CONFIG_HARD_I2C
2269 2280
2270 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 2281 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2271 provides the following compelling advantages: 2282 provides the following compelling advantages:
2272 2283
2273 - more than one i2c adapter is usable 2284 - more than one i2c adapter is usable
2274 - approved multibus support 2285 - approved multibus support
2275 - better i2c mux support 2286 - better i2c mux support
2276 2287
2277 ** Please consider updating your I2C driver now. ** 2288 ** Please consider updating your I2C driver now. **
2278 2289
2279 These enable legacy I2C serial bus commands. Defining 2290 These enable legacy I2C serial bus commands. Defining
2280 CONFIG_HARD_I2C will include the appropriate I2C driver 2291 CONFIG_HARD_I2C will include the appropriate I2C driver
2281 for the selected CPU. 2292 for the selected CPU.
2282 2293
2283 This will allow you to use i2c commands at the u-boot 2294 This will allow you to use i2c commands at the u-boot
2284 command line (as long as you set CONFIG_CMD_I2C in 2295 command line (as long as you set CONFIG_CMD_I2C in
2285 CONFIG_COMMANDS) and communicate with i2c based realtime 2296 CONFIG_COMMANDS) and communicate with i2c based realtime
2286 clock chips. See common/cmd_i2c.c for a description of the 2297 clock chips. See common/cmd_i2c.c for a description of the
2287 command line interface. 2298 command line interface.
2288 2299
2289 CONFIG_HARD_I2C selects a hardware I2C controller. 2300 CONFIG_HARD_I2C selects a hardware I2C controller.
2290 2301
2291 There are several other quantities that must also be 2302 There are several other quantities that must also be
2292 defined when you define CONFIG_HARD_I2C. 2303 defined when you define CONFIG_HARD_I2C.
2293 2304
2294 In both cases you will need to define CONFIG_SYS_I2C_SPEED 2305 In both cases you will need to define CONFIG_SYS_I2C_SPEED
2295 to be the frequency (in Hz) at which you wish your i2c bus 2306 to be the frequency (in Hz) at which you wish your i2c bus
2296 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 2307 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2297 the CPU's i2c node address). 2308 the CPU's i2c node address).
2298 2309
2299 Now, the u-boot i2c code for the mpc8xx 2310 Now, the u-boot i2c code for the mpc8xx
2300 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 2311 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2301 and so its address should therefore be cleared to 0 (See, 2312 and so its address should therefore be cleared to 0 (See,
2302 eg, MPC823e User's Manual p.16-473). So, set 2313 eg, MPC823e User's Manual p.16-473). So, set
2303 CONFIG_SYS_I2C_SLAVE to 0. 2314 CONFIG_SYS_I2C_SLAVE to 0.
2304 2315
2305 CONFIG_SYS_I2C_INIT_MPC5XXX 2316 CONFIG_SYS_I2C_INIT_MPC5XXX
2306 2317
2307 When a board is reset during an i2c bus transfer 2318 When a board is reset during an i2c bus transfer
2308 chips might think that the current transfer is still 2319 chips might think that the current transfer is still
2309 in progress. Reset the slave devices by sending start 2320 in progress. Reset the slave devices by sending start
2310 commands until the slave device responds. 2321 commands until the slave device responds.
2311 2322
2312 That's all that's required for CONFIG_HARD_I2C. 2323 That's all that's required for CONFIG_HARD_I2C.
2313 2324
2314 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2325 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2315 then the following macros need to be defined (examples are 2326 then the following macros need to be defined (examples are
2316 from include/configs/lwmon.h): 2327 from include/configs/lwmon.h):
2317 2328
2318 I2C_INIT 2329 I2C_INIT
2319 2330
2320 (Optional). Any commands necessary to enable the I2C 2331 (Optional). Any commands necessary to enable the I2C
2321 controller or configure ports. 2332 controller or configure ports.
2322 2333
2323 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2334 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
2324 2335
2325 I2C_PORT 2336 I2C_PORT
2326 2337
2327 (Only for MPC8260 CPU). The I/O port to use (the code 2338 (Only for MPC8260 CPU). The I/O port to use (the code
2328 assumes both bits are on the same port). Valid values 2339 assumes both bits are on the same port). Valid values
2329 are 0..3 for ports A..D. 2340 are 0..3 for ports A..D.
2330 2341
2331 I2C_ACTIVE 2342 I2C_ACTIVE
2332 2343
2333 The code necessary to make the I2C data line active 2344 The code necessary to make the I2C data line active
2334 (driven). If the data line is open collector, this 2345 (driven). If the data line is open collector, this
2335 define can be null. 2346 define can be null.
2336 2347
2337 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2348 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2338 2349
2339 I2C_TRISTATE 2350 I2C_TRISTATE
2340 2351
2341 The code necessary to make the I2C data line tri-stated 2352 The code necessary to make the I2C data line tri-stated
2342 (inactive). If the data line is open collector, this 2353 (inactive). If the data line is open collector, this
2343 define can be null. 2354 define can be null.
2344 2355
2345 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2356 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2346 2357
2347 I2C_READ 2358 I2C_READ
2348 2359
2349 Code that returns true if the I2C data line is high, 2360 Code that returns true if the I2C data line is high,
2350 false if it is low. 2361 false if it is low.
2351 2362
2352 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2363 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2353 2364
2354 I2C_SDA(bit) 2365 I2C_SDA(bit)
2355 2366
2356 If <bit> is true, sets the I2C data line high. If it 2367 If <bit> is true, sets the I2C data line high. If it
2357 is false, it clears it (low). 2368 is false, it clears it (low).
2358 2369
2359 eg: #define I2C_SDA(bit) \ 2370 eg: #define I2C_SDA(bit) \
2360 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2371 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
2361 else immr->im_cpm.cp_pbdat &= ~PB_SDA 2372 else immr->im_cpm.cp_pbdat &= ~PB_SDA
2362 2373
2363 I2C_SCL(bit) 2374 I2C_SCL(bit)
2364 2375
2365 If <bit> is true, sets the I2C clock line high. If it 2376 If <bit> is true, sets the I2C clock line high. If it
2366 is false, it clears it (low). 2377 is false, it clears it (low).
2367 2378
2368 eg: #define I2C_SCL(bit) \ 2379 eg: #define I2C_SCL(bit) \
2369 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2380 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
2370 else immr->im_cpm.cp_pbdat &= ~PB_SCL 2381 else immr->im_cpm.cp_pbdat &= ~PB_SCL
2371 2382
2372 I2C_DELAY 2383 I2C_DELAY
2373 2384
2374 This delay is invoked four times per clock cycle so this 2385 This delay is invoked four times per clock cycle so this
2375 controls the rate of data transfer. The data rate thus 2386 controls the rate of data transfer. The data rate thus
2376 is 1 / (I2C_DELAY * 4). Often defined to be something 2387 is 1 / (I2C_DELAY * 4). Often defined to be something
2377 like: 2388 like:
2378 2389
2379 #define I2C_DELAY udelay(2) 2390 #define I2C_DELAY udelay(2)
2380 2391
2381 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2392 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2382 2393
2383 If your arch supports the generic GPIO framework (asm/gpio.h), 2394 If your arch supports the generic GPIO framework (asm/gpio.h),
2384 then you may alternatively define the two GPIOs that are to be 2395 then you may alternatively define the two GPIOs that are to be
2385 used as SCL / SDA. Any of the previous I2C_xxx macros will 2396 used as SCL / SDA. Any of the previous I2C_xxx macros will
2386 have GPIO-based defaults assigned to them as appropriate. 2397 have GPIO-based defaults assigned to them as appropriate.
2387 2398
2388 You should define these to the GPIO value as given directly to 2399 You should define these to the GPIO value as given directly to
2389 the generic GPIO functions. 2400 the generic GPIO functions.
2390 2401
2391 CONFIG_SYS_I2C_INIT_BOARD 2402 CONFIG_SYS_I2C_INIT_BOARD
2392 2403
2393 When a board is reset during an i2c bus transfer 2404 When a board is reset during an i2c bus transfer
2394 chips might think that the current transfer is still 2405 chips might think that the current transfer is still
2395 in progress. On some boards it is possible to access 2406 in progress. On some boards it is possible to access
2396 the i2c SCLK line directly, either by using the 2407 the i2c SCLK line directly, either by using the
2397 processor pin as a GPIO or by having a second pin 2408 processor pin as a GPIO or by having a second pin
2398 connected to the bus. If this option is defined a 2409 connected to the bus. If this option is defined a
2399 custom i2c_init_board() routine in boards/xxx/board.c 2410 custom i2c_init_board() routine in boards/xxx/board.c
2400 is run early in the boot sequence. 2411 is run early in the boot sequence.
2401 2412
2402 CONFIG_SYS_I2C_BOARD_LATE_INIT 2413 CONFIG_SYS_I2C_BOARD_LATE_INIT
2403 2414
2404 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 2415 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2405 defined a custom i2c_board_late_init() routine in 2416 defined a custom i2c_board_late_init() routine in
2406 boards/xxx/board.c is run AFTER the operations in i2c_init() 2417 boards/xxx/board.c is run AFTER the operations in i2c_init()
2407 is completed. This callpoint can be used to unreset i2c bus 2418 is completed. This callpoint can be used to unreset i2c bus
2408 using CPU i2c controller register accesses for CPUs whose i2c 2419 using CPU i2c controller register accesses for CPUs whose i2c
2409 controller provide such a method. It is called at the end of 2420 controller provide such a method. It is called at the end of
2410 i2c_init() to allow i2c_init operations to setup the i2c bus 2421 i2c_init() to allow i2c_init operations to setup the i2c bus
2411 controller on the CPU (e.g. setting bus speed & slave address). 2422 controller on the CPU (e.g. setting bus speed & slave address).
2412 2423
2413 CONFIG_I2CFAST (PPC405GP|PPC405EP only) 2424 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2414 2425
2415 This option enables configuration of bi_iic_fast[] flags 2426 This option enables configuration of bi_iic_fast[] flags
2416 in u-boot bd_info structure based on u-boot environment 2427 in u-boot bd_info structure based on u-boot environment
2417 variable "i2cfast". (see also i2cfast) 2428 variable "i2cfast". (see also i2cfast)
2418 2429
2419 CONFIG_I2C_MULTI_BUS 2430 CONFIG_I2C_MULTI_BUS
2420 2431
2421 This option allows the use of multiple I2C buses, each of which 2432 This option allows the use of multiple I2C buses, each of which
2422 must have a controller. At any point in time, only one bus is 2433 must have a controller. At any point in time, only one bus is
2423 active. To switch to a different bus, use the 'i2c dev' command. 2434 active. To switch to a different bus, use the 'i2c dev' command.
2424 Note that bus numbering is zero-based. 2435 Note that bus numbering is zero-based.
2425 2436
2426 CONFIG_SYS_I2C_NOPROBES 2437 CONFIG_SYS_I2C_NOPROBES
2427 2438
2428 This option specifies a list of I2C devices that will be skipped 2439 This option specifies a list of I2C devices that will be skipped
2429 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 2440 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
2430 is set, specify a list of bus-device pairs. Otherwise, specify 2441 is set, specify a list of bus-device pairs. Otherwise, specify
2431 a 1D array of device addresses 2442 a 1D array of device addresses
2432 2443
2433 e.g. 2444 e.g.
2434 #undef CONFIG_I2C_MULTI_BUS 2445 #undef CONFIG_I2C_MULTI_BUS
2435 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2446 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2436 2447
2437 will skip addresses 0x50 and 0x68 on a board with one I2C bus 2448 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2438 2449
2439 #define CONFIG_I2C_MULTI_BUS 2450 #define CONFIG_I2C_MULTI_BUS
2440 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2451 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
2441 2452
2442 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2453 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2443 2454
2444 CONFIG_SYS_SPD_BUS_NUM 2455 CONFIG_SYS_SPD_BUS_NUM
2445 2456
2446 If defined, then this indicates the I2C bus number for DDR SPD. 2457 If defined, then this indicates the I2C bus number for DDR SPD.
2447 If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2458 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2448 2459
2449 CONFIG_SYS_RTC_BUS_NUM 2460 CONFIG_SYS_RTC_BUS_NUM
2450 2461
2451 If defined, then this indicates the I2C bus number for the RTC. 2462 If defined, then this indicates the I2C bus number for the RTC.
2452 If not defined, then U-Boot assumes that RTC is on I2C bus 0. 2463 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2453 2464
2454 CONFIG_SYS_DTT_BUS_NUM 2465 CONFIG_SYS_DTT_BUS_NUM
2455 2466
2456 If defined, then this indicates the I2C bus number for the DTT. 2467 If defined, then this indicates the I2C bus number for the DTT.
2457 If not defined, then U-Boot assumes that DTT is on I2C bus 0. 2468 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2458 2469
2459 CONFIG_SYS_I2C_DTT_ADDR: 2470 CONFIG_SYS_I2C_DTT_ADDR:
2460 2471
2461 If defined, specifies the I2C address of the DTT device. 2472 If defined, specifies the I2C address of the DTT device.
2462 If not defined, then U-Boot uses predefined value for 2473 If not defined, then U-Boot uses predefined value for
2463 specified DTT device. 2474 specified DTT device.
2464 2475
2465 CONFIG_SOFT_I2C_READ_REPEATED_START 2476 CONFIG_SOFT_I2C_READ_REPEATED_START
2466 2477
2467 defining this will force the i2c_read() function in 2478 defining this will force the i2c_read() function in
2468 the soft_i2c driver to perform an I2C repeated start 2479 the soft_i2c driver to perform an I2C repeated start
2469 between writing the address pointer and reading the 2480 between writing the address pointer and reading the
2470 data. If this define is omitted the default behaviour 2481 data. If this define is omitted the default behaviour
2471 of doing a stop-start sequence will be used. Most I2C 2482 of doing a stop-start sequence will be used. Most I2C
2472 devices can use either method, but some require one or 2483 devices can use either method, but some require one or
2473 the other. 2484 the other.
2474 2485
2475 - SPI Support: CONFIG_SPI 2486 - SPI Support: CONFIG_SPI
2476 2487
2477 Enables SPI driver (so far only tested with 2488 Enables SPI driver (so far only tested with
2478 SPI EEPROM, also an instance works with Crystal A/D and 2489 SPI EEPROM, also an instance works with Crystal A/D and
2479 D/As on the SACSng board) 2490 D/As on the SACSng board)
2480 2491
2481 CONFIG_SH_SPI 2492 CONFIG_SH_SPI
2482 2493
2483 Enables the driver for SPI controller on SuperH. Currently 2494 Enables the driver for SPI controller on SuperH. Currently
2484 only SH7757 is supported. 2495 only SH7757 is supported.
2485 2496
2486 CONFIG_SPI_X 2497 CONFIG_SPI_X
2487 2498
2488 Enables extended (16-bit) SPI EEPROM addressing. 2499 Enables extended (16-bit) SPI EEPROM addressing.
2489 (symmetrical to CONFIG_I2C_X) 2500 (symmetrical to CONFIG_I2C_X)
2490 2501
2491 CONFIG_SOFT_SPI 2502 CONFIG_SOFT_SPI
2492 2503
2493 Enables a software (bit-bang) SPI driver rather than 2504 Enables a software (bit-bang) SPI driver rather than
2494 using hardware support. This is a general purpose 2505 using hardware support. This is a general purpose
2495 driver that only requires three general I/O port pins 2506 driver that only requires three general I/O port pins
2496 (two outputs, one input) to function. If this is 2507 (two outputs, one input) to function. If this is
2497 defined, the board configuration must define several 2508 defined, the board configuration must define several
2498 SPI configuration items (port pins to use, etc). For 2509 SPI configuration items (port pins to use, etc). For
2499 an example, see include/configs/sacsng.h. 2510 an example, see include/configs/sacsng.h.
2500 2511
2501 CONFIG_HARD_SPI 2512 CONFIG_HARD_SPI
2502 2513
2503 Enables a hardware SPI driver for general-purpose reads 2514 Enables a hardware SPI driver for general-purpose reads
2504 and writes. As with CONFIG_SOFT_SPI, the board configuration 2515 and writes. As with CONFIG_SOFT_SPI, the board configuration
2505 must define a list of chip-select function pointers. 2516 must define a list of chip-select function pointers.
2506 Currently supported on some MPC8xxx processors. For an 2517 Currently supported on some MPC8xxx processors. For an
2507 example, see include/configs/mpc8349emds.h. 2518 example, see include/configs/mpc8349emds.h.
2508 2519
2509 CONFIG_MXC_SPI 2520 CONFIG_MXC_SPI
2510 2521
2511 Enables the driver for the SPI controllers on i.MX and MXC 2522 Enables the driver for the SPI controllers on i.MX and MXC
2512 SoCs. Currently i.MX31/35/51 are supported. 2523 SoCs. Currently i.MX31/35/51 are supported.
2513 2524
2514 - FPGA Support: CONFIG_FPGA 2525 - FPGA Support: CONFIG_FPGA
2515 2526
2516 Enables FPGA subsystem. 2527 Enables FPGA subsystem.
2517 2528
2518 CONFIG_FPGA_<vendor> 2529 CONFIG_FPGA_<vendor>
2519 2530
2520 Enables support for specific chip vendors. 2531 Enables support for specific chip vendors.
2521 (ALTERA, XILINX) 2532 (ALTERA, XILINX)
2522 2533
2523 CONFIG_FPGA_<family> 2534 CONFIG_FPGA_<family>
2524 2535
2525 Enables support for FPGA family. 2536 Enables support for FPGA family.
2526 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 2537 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2527 2538
2528 CONFIG_FPGA_COUNT 2539 CONFIG_FPGA_COUNT
2529 2540
2530 Specify the number of FPGA devices to support. 2541 Specify the number of FPGA devices to support.
2531 2542
2532 CONFIG_SYS_FPGA_PROG_FEEDBACK 2543 CONFIG_SYS_FPGA_PROG_FEEDBACK
2533 2544
2534 Enable printing of hash marks during FPGA configuration. 2545 Enable printing of hash marks during FPGA configuration.
2535 2546
2536 CONFIG_SYS_FPGA_CHECK_BUSY 2547 CONFIG_SYS_FPGA_CHECK_BUSY
2537 2548
2538 Enable checks on FPGA configuration interface busy 2549 Enable checks on FPGA configuration interface busy
2539 status by the configuration function. This option 2550 status by the configuration function. This option
2540 will require a board or device specific function to 2551 will require a board or device specific function to
2541 be written. 2552 be written.
2542 2553
2543 CONFIG_FPGA_DELAY 2554 CONFIG_FPGA_DELAY
2544 2555
2545 If defined, a function that provides delays in the FPGA 2556 If defined, a function that provides delays in the FPGA
2546 configuration driver. 2557 configuration driver.
2547 2558
2548 CONFIG_SYS_FPGA_CHECK_CTRLC 2559 CONFIG_SYS_FPGA_CHECK_CTRLC
2549 Allow Control-C to interrupt FPGA configuration 2560 Allow Control-C to interrupt FPGA configuration
2550 2561
2551 CONFIG_SYS_FPGA_CHECK_ERROR 2562 CONFIG_SYS_FPGA_CHECK_ERROR
2552 2563
2553 Check for configuration errors during FPGA bitfile 2564 Check for configuration errors during FPGA bitfile
2554 loading. For example, abort during Virtex II 2565 loading. For example, abort during Virtex II
2555 configuration if the INIT_B line goes low (which 2566 configuration if the INIT_B line goes low (which
2556 indicated a CRC error). 2567 indicated a CRC error).
2557 2568
2558 CONFIG_SYS_FPGA_WAIT_INIT 2569 CONFIG_SYS_FPGA_WAIT_INIT
2559 2570
2560 Maximum time to wait for the INIT_B line to deassert 2571 Maximum time to wait for the INIT_B line to deassert
2561 after PROB_B has been deasserted during a Virtex II 2572 after PROB_B has been deasserted during a Virtex II
2562 FPGA configuration sequence. The default time is 500 2573 FPGA configuration sequence. The default time is 500
2563 ms. 2574 ms.
2564 2575
2565 CONFIG_SYS_FPGA_WAIT_BUSY 2576 CONFIG_SYS_FPGA_WAIT_BUSY
2566 2577
2567 Maximum time to wait for BUSY to deassert during 2578 Maximum time to wait for BUSY to deassert during
2568 Virtex II FPGA configuration. The default is 5 ms. 2579 Virtex II FPGA configuration. The default is 5 ms.
2569 2580
2570 CONFIG_SYS_FPGA_WAIT_CONFIG 2581 CONFIG_SYS_FPGA_WAIT_CONFIG
2571 2582
2572 Time to wait after FPGA configuration. The default is 2583 Time to wait after FPGA configuration. The default is
2573 200 ms. 2584 200 ms.
2574 2585
2575 - Configuration Management: 2586 - Configuration Management:
2576 CONFIG_IDENT_STRING 2587 CONFIG_IDENT_STRING
2577 2588
2578 If defined, this string will be added to the U-Boot 2589 If defined, this string will be added to the U-Boot
2579 version information (U_BOOT_VERSION) 2590 version information (U_BOOT_VERSION)
2580 2591
2581 - Vendor Parameter Protection: 2592 - Vendor Parameter Protection:
2582 2593
2583 U-Boot considers the values of the environment 2594 U-Boot considers the values of the environment
2584 variables "serial#" (Board Serial Number) and 2595 variables "serial#" (Board Serial Number) and
2585 "ethaddr" (Ethernet Address) to be parameters that 2596 "ethaddr" (Ethernet Address) to be parameters that
2586 are set once by the board vendor / manufacturer, and 2597 are set once by the board vendor / manufacturer, and
2587 protects these variables from casual modification by 2598 protects these variables from casual modification by
2588 the user. Once set, these variables are read-only, 2599 the user. Once set, these variables are read-only,
2589 and write or delete attempts are rejected. You can 2600 and write or delete attempts are rejected. You can
2590 change this behaviour: 2601 change this behaviour:
2591 2602
2592 If CONFIG_ENV_OVERWRITE is #defined in your config 2603 If CONFIG_ENV_OVERWRITE is #defined in your config
2593 file, the write protection for vendor parameters is 2604 file, the write protection for vendor parameters is
2594 completely disabled. Anybody can change or delete 2605 completely disabled. Anybody can change or delete
2595 these parameters. 2606 these parameters.
2596 2607
2597 Alternatively, if you #define _both_ CONFIG_ETHADDR 2608 Alternatively, if you #define _both_ CONFIG_ETHADDR
2598 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 2609 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2599 Ethernet address is installed in the environment, 2610 Ethernet address is installed in the environment,
2600 which can be changed exactly ONCE by the user. [The 2611 which can be changed exactly ONCE by the user. [The
2601 serial# is unaffected by this, i. e. it remains 2612 serial# is unaffected by this, i. e. it remains
2602 read-only.] 2613 read-only.]
2603 2614
2604 The same can be accomplished in a more flexible way 2615 The same can be accomplished in a more flexible way
2605 for any variable by configuring the type of access 2616 for any variable by configuring the type of access
2606 to allow for those variables in the ".flags" variable 2617 to allow for those variables in the ".flags" variable
2607 or define CONFIG_ENV_FLAGS_LIST_STATIC. 2618 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2608 2619
2609 - Protected RAM: 2620 - Protected RAM:
2610 CONFIG_PRAM 2621 CONFIG_PRAM
2611 2622
2612 Define this variable to enable the reservation of 2623 Define this variable to enable the reservation of
2613 "protected RAM", i. e. RAM which is not overwritten 2624 "protected RAM", i. e. RAM which is not overwritten
2614 by U-Boot. Define CONFIG_PRAM to hold the number of 2625 by U-Boot. Define CONFIG_PRAM to hold the number of
2615 kB you want to reserve for pRAM. You can overwrite 2626 kB you want to reserve for pRAM. You can overwrite
2616 this default value by defining an environment 2627 this default value by defining an environment
2617 variable "pram" to the number of kB you want to 2628 variable "pram" to the number of kB you want to
2618 reserve. Note that the board info structure will 2629 reserve. Note that the board info structure will
2619 still show the full amount of RAM. If pRAM is 2630 still show the full amount of RAM. If pRAM is
2620 reserved, a new environment variable "mem" will 2631 reserved, a new environment variable "mem" will
2621 automatically be defined to hold the amount of 2632 automatically be defined to hold the amount of
2622 remaining RAM in a form that can be passed as boot 2633 remaining RAM in a form that can be passed as boot
2623 argument to Linux, for instance like that: 2634 argument to Linux, for instance like that:
2624 2635
2625 setenv bootargs ... mem=\${mem} 2636 setenv bootargs ... mem=\${mem}
2626 saveenv 2637 saveenv
2627 2638
2628 This way you can tell Linux not to use this memory, 2639 This way you can tell Linux not to use this memory,
2629 either, which results in a memory region that will 2640 either, which results in a memory region that will
2630 not be affected by reboots. 2641 not be affected by reboots.
2631 2642
2632 *WARNING* If your board configuration uses automatic 2643 *WARNING* If your board configuration uses automatic
2633 detection of the RAM size, you must make sure that 2644 detection of the RAM size, you must make sure that
2634 this memory test is non-destructive. So far, the 2645 this memory test is non-destructive. So far, the
2635 following board configurations are known to be 2646 following board configurations are known to be
2636 "pRAM-clean": 2647 "pRAM-clean":
2637 2648
2638 IVMS8, IVML24, SPD8xx, TQM8xxL, 2649 IVMS8, IVML24, SPD8xx, TQM8xxL,
2639 HERMES, IP860, RPXlite, LWMON, 2650 HERMES, IP860, RPXlite, LWMON,
2640 FLAGADM, TQM8260 2651 FLAGADM, TQM8260
2641 2652
2642 - Access to physical memory region (> 4GB) 2653 - Access to physical memory region (> 4GB)
2643 Some basic support is provided for operations on memory not 2654 Some basic support is provided for operations on memory not
2644 normally accessible to U-Boot - e.g. some architectures 2655 normally accessible to U-Boot - e.g. some architectures
2645 support access to more than 4GB of memory on 32-bit 2656 support access to more than 4GB of memory on 32-bit
2646 machines using physical address extension or similar. 2657 machines using physical address extension or similar.
2647 Define CONFIG_PHYSMEM to access this basic support, which 2658 Define CONFIG_PHYSMEM to access this basic support, which
2648 currently only supports clearing the memory. 2659 currently only supports clearing the memory.
2649 2660
2650 - Error Recovery: 2661 - Error Recovery:
2651 CONFIG_PANIC_HANG 2662 CONFIG_PANIC_HANG
2652 2663
2653 Define this variable to stop the system in case of a 2664 Define this variable to stop the system in case of a
2654 fatal error, so that you have to reset it manually. 2665 fatal error, so that you have to reset it manually.
2655 This is probably NOT a good idea for an embedded 2666 This is probably NOT a good idea for an embedded
2656 system where you want the system to reboot 2667 system where you want the system to reboot
2657 automatically as fast as possible, but it may be 2668 automatically as fast as possible, but it may be
2658 useful during development since you can try to debug 2669 useful during development since you can try to debug
2659 the conditions that lead to the situation. 2670 the conditions that lead to the situation.
2660 2671
2661 CONFIG_NET_RETRY_COUNT 2672 CONFIG_NET_RETRY_COUNT
2662 2673
2663 This variable defines the number of retries for 2674 This variable defines the number of retries for
2664 network operations like ARP, RARP, TFTP, or BOOTP 2675 network operations like ARP, RARP, TFTP, or BOOTP
2665 before giving up the operation. If not defined, a 2676 before giving up the operation. If not defined, a
2666 default value of 5 is used. 2677 default value of 5 is used.
2667 2678
2668 CONFIG_ARP_TIMEOUT 2679 CONFIG_ARP_TIMEOUT
2669 2680
2670 Timeout waiting for an ARP reply in milliseconds. 2681 Timeout waiting for an ARP reply in milliseconds.
2671 2682
2672 CONFIG_NFS_TIMEOUT 2683 CONFIG_NFS_TIMEOUT
2673 2684
2674 Timeout in milliseconds used in NFS protocol. 2685 Timeout in milliseconds used in NFS protocol.
2675 If you encounter "ERROR: Cannot umount" in nfs command, 2686 If you encounter "ERROR: Cannot umount" in nfs command,
2676 try longer timeout such as 2687 try longer timeout such as
2677 #define CONFIG_NFS_TIMEOUT 10000UL 2688 #define CONFIG_NFS_TIMEOUT 10000UL
2678 2689
2679 - Command Interpreter: 2690 - Command Interpreter:
2680 CONFIG_AUTO_COMPLETE 2691 CONFIG_AUTO_COMPLETE
2681 2692
2682 Enable auto completion of commands using TAB. 2693 Enable auto completion of commands using TAB.
2683 2694
2684 Note that this feature has NOT been implemented yet 2695 Note that this feature has NOT been implemented yet
2685 for the "hush" shell. 2696 for the "hush" shell.
2686 2697
2687 2698
2688 CONFIG_SYS_HUSH_PARSER 2699 CONFIG_SYS_HUSH_PARSER
2689 2700
2690 Define this variable to enable the "hush" shell (from 2701 Define this variable to enable the "hush" shell (from
2691 Busybox) as command line interpreter, thus enabling 2702 Busybox) as command line interpreter, thus enabling
2692 powerful command line syntax like 2703 powerful command line syntax like
2693 if...then...else...fi conditionals or `&&' and '||' 2704 if...then...else...fi conditionals or `&&' and '||'
2694 constructs ("shell scripts"). 2705 constructs ("shell scripts").
2695 2706
2696 If undefined, you get the old, much simpler behaviour 2707 If undefined, you get the old, much simpler behaviour
2697 with a somewhat smaller memory footprint. 2708 with a somewhat smaller memory footprint.
2698 2709
2699 2710
2700 CONFIG_SYS_PROMPT_HUSH_PS2 2711 CONFIG_SYS_PROMPT_HUSH_PS2
2701 2712
2702 This defines the secondary prompt string, which is 2713 This defines the secondary prompt string, which is
2703 printed when the command interpreter needs more input 2714 printed when the command interpreter needs more input
2704 to complete a command. Usually "> ". 2715 to complete a command. Usually "> ".
2705 2716
2706 Note: 2717 Note:
2707 2718
2708 In the current implementation, the local variables 2719 In the current implementation, the local variables
2709 space and global environment variables space are 2720 space and global environment variables space are
2710 separated. Local variables are those you define by 2721 separated. Local variables are those you define by
2711 simply typing `name=value'. To access a local 2722 simply typing `name=value'. To access a local
2712 variable later on, you have write `$name' or 2723 variable later on, you have write `$name' or
2713 `${name}'; to execute the contents of a variable 2724 `${name}'; to execute the contents of a variable
2714 directly type `$name' at the command prompt. 2725 directly type `$name' at the command prompt.
2715 2726
2716 Global environment variables are those you use 2727 Global environment variables are those you use
2717 setenv/printenv to work with. To run a command stored 2728 setenv/printenv to work with. To run a command stored
2718 in such a variable, you need to use the run command, 2729 in such a variable, you need to use the run command,
2719 and you must not use the '$' sign to access them. 2730 and you must not use the '$' sign to access them.
2720 2731
2721 To store commands and special characters in a 2732 To store commands and special characters in a
2722 variable, please use double quotation marks 2733 variable, please use double quotation marks
2723 surrounding the whole text of the variable, instead 2734 surrounding the whole text of the variable, instead
2724 of the backslashes before semicolons and special 2735 of the backslashes before semicolons and special
2725 symbols. 2736 symbols.
2726 2737
2727 - Commandline Editing and History: 2738 - Commandline Editing and History:
2728 CONFIG_CMDLINE_EDITING 2739 CONFIG_CMDLINE_EDITING
2729 2740
2730 Enable editing and History functions for interactive 2741 Enable editing and History functions for interactive
2731 commandline input operations 2742 commandline input operations
2732 2743
2733 - Default Environment: 2744 - Default Environment:
2734 CONFIG_EXTRA_ENV_SETTINGS 2745 CONFIG_EXTRA_ENV_SETTINGS
2735 2746
2736 Define this to contain any number of null terminated 2747 Define this to contain any number of null terminated
2737 strings (variable = value pairs) that will be part of 2748 strings (variable = value pairs) that will be part of
2738 the default environment compiled into the boot image. 2749 the default environment compiled into the boot image.
2739 2750
2740 For example, place something like this in your 2751 For example, place something like this in your
2741 board's config file: 2752 board's config file:
2742 2753
2743 #define CONFIG_EXTRA_ENV_SETTINGS \ 2754 #define CONFIG_EXTRA_ENV_SETTINGS \
2744 "myvar1=value1\0" \ 2755 "myvar1=value1\0" \
2745 "myvar2=value2\0" 2756 "myvar2=value2\0"
2746 2757
2747 Warning: This method is based on knowledge about the 2758 Warning: This method is based on knowledge about the
2748 internal format how the environment is stored by the 2759 internal format how the environment is stored by the
2749 U-Boot code. This is NOT an official, exported 2760 U-Boot code. This is NOT an official, exported
2750 interface! Although it is unlikely that this format 2761 interface! Although it is unlikely that this format
2751 will change soon, there is no guarantee either. 2762 will change soon, there is no guarantee either.
2752 You better know what you are doing here. 2763 You better know what you are doing here.
2753 2764
2754 Note: overly (ab)use of the default environment is 2765 Note: overly (ab)use of the default environment is
2755 discouraged. Make sure to check other ways to preset 2766 discouraged. Make sure to check other ways to preset
2756 the environment like the "source" command or the 2767 the environment like the "source" command or the
2757 boot command first. 2768 boot command first.
2758 2769
2759 CONFIG_ENV_VARS_UBOOT_CONFIG 2770 CONFIG_ENV_VARS_UBOOT_CONFIG
2760 2771
2761 Define this in order to add variables describing the 2772 Define this in order to add variables describing the
2762 U-Boot build configuration to the default environment. 2773 U-Boot build configuration to the default environment.
2763 These will be named arch, cpu, board, vendor, and soc. 2774 These will be named arch, cpu, board, vendor, and soc.
2764 2775
2765 Enabling this option will cause the following to be defined: 2776 Enabling this option will cause the following to be defined:
2766 2777
2767 - CONFIG_SYS_ARCH 2778 - CONFIG_SYS_ARCH
2768 - CONFIG_SYS_CPU 2779 - CONFIG_SYS_CPU
2769 - CONFIG_SYS_BOARD 2780 - CONFIG_SYS_BOARD
2770 - CONFIG_SYS_VENDOR 2781 - CONFIG_SYS_VENDOR
2771 - CONFIG_SYS_SOC 2782 - CONFIG_SYS_SOC
2772 2783
2773 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 2784 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2774 2785
2775 Define this in order to add variables describing certain 2786 Define this in order to add variables describing certain
2776 run-time determined information about the hardware to the 2787 run-time determined information about the hardware to the
2777 environment. These will be named board_name, board_rev. 2788 environment. These will be named board_name, board_rev.
2778 2789
2779 CONFIG_DELAY_ENVIRONMENT 2790 CONFIG_DELAY_ENVIRONMENT
2780 2791
2781 Normally the environment is loaded when the board is 2792 Normally the environment is loaded when the board is
2782 intialised so that it is available to U-Boot. This inhibits 2793 intialised so that it is available to U-Boot. This inhibits
2783 that so that the environment is not available until 2794 that so that the environment is not available until
2784 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 2795 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2785 this is instead controlled by the value of 2796 this is instead controlled by the value of
2786 /config/load-environment. 2797 /config/load-environment.
2787 2798
2788 - DataFlash Support: 2799 - DataFlash Support:
2789 CONFIG_HAS_DATAFLASH 2800 CONFIG_HAS_DATAFLASH
2790 2801
2791 Defining this option enables DataFlash features and 2802 Defining this option enables DataFlash features and
2792 allows to read/write in Dataflash via the standard 2803 allows to read/write in Dataflash via the standard
2793 commands cp, md... 2804 commands cp, md...
2794 2805
2795 - Serial Flash support 2806 - Serial Flash support
2796 CONFIG_CMD_SF 2807 CONFIG_CMD_SF
2797 2808
2798 Defining this option enables SPI flash commands 2809 Defining this option enables SPI flash commands
2799 'sf probe/read/write/erase/update'. 2810 'sf probe/read/write/erase/update'.
2800 2811
2801 Usage requires an initial 'probe' to define the serial 2812 Usage requires an initial 'probe' to define the serial
2802 flash parameters, followed by read/write/erase/update 2813 flash parameters, followed by read/write/erase/update
2803 commands. 2814 commands.
2804 2815
2805 The following defaults may be provided by the platform 2816 The following defaults may be provided by the platform
2806 to handle the common case when only a single serial 2817 to handle the common case when only a single serial
2807 flash is present on the system. 2818 flash is present on the system.
2808 2819
2809 CONFIG_SF_DEFAULT_BUS Bus identifier 2820 CONFIG_SF_DEFAULT_BUS Bus identifier
2810 CONFIG_SF_DEFAULT_CS Chip-select 2821 CONFIG_SF_DEFAULT_CS Chip-select
2811 CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2822 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2812 CONFIG_SF_DEFAULT_SPEED in Hz 2823 CONFIG_SF_DEFAULT_SPEED in Hz
2813 2824
2814 CONFIG_CMD_SF_TEST 2825 CONFIG_CMD_SF_TEST
2815 2826
2816 Define this option to include a destructive SPI flash 2827 Define this option to include a destructive SPI flash
2817 test ('sf test'). 2828 test ('sf test').
2818 2829
2819 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 2830 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2820 2831
2821 Define this option to use the Bank addr/Extended addr 2832 Define this option to use the Bank addr/Extended addr
2822 support on SPI flashes which has size > 16Mbytes. 2833 support on SPI flashes which has size > 16Mbytes.
2823 2834
2824 CONFIG_SF_DUAL_FLASH Dual flash memories 2835 CONFIG_SF_DUAL_FLASH Dual flash memories
2825 2836
2826 Define this option to use dual flash support where two flash 2837 Define this option to use dual flash support where two flash
2827 memories can be connected with a given cs line. 2838 memories can be connected with a given cs line.
2828 currently Xilinx Zynq qspi support these type of connections. 2839 currently Xilinx Zynq qspi support these type of connections.
2829 2840
2830 - SystemACE Support: 2841 - SystemACE Support:
2831 CONFIG_SYSTEMACE 2842 CONFIG_SYSTEMACE
2832 2843
2833 Adding this option adds support for Xilinx SystemACE 2844 Adding this option adds support for Xilinx SystemACE
2834 chips attached via some sort of local bus. The address 2845 chips attached via some sort of local bus. The address
2835 of the chip must also be defined in the 2846 of the chip must also be defined in the
2836 CONFIG_SYS_SYSTEMACE_BASE macro. For example: 2847 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2837 2848
2838 #define CONFIG_SYSTEMACE 2849 #define CONFIG_SYSTEMACE
2839 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 2850 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2840 2851
2841 When SystemACE support is added, the "ace" device type 2852 When SystemACE support is added, the "ace" device type
2842 becomes available to the fat commands, i.e. fatls. 2853 becomes available to the fat commands, i.e. fatls.
2843 2854
2844 - TFTP Fixed UDP Port: 2855 - TFTP Fixed UDP Port:
2845 CONFIG_TFTP_PORT 2856 CONFIG_TFTP_PORT
2846 2857
2847 If this is defined, the environment variable tftpsrcp 2858 If this is defined, the environment variable tftpsrcp
2848 is used to supply the TFTP UDP source port value. 2859 is used to supply the TFTP UDP source port value.
2849 If tftpsrcp isn't defined, the normal pseudo-random port 2860 If tftpsrcp isn't defined, the normal pseudo-random port
2850 number generator is used. 2861 number generator is used.
2851 2862
2852 Also, the environment variable tftpdstp is used to supply 2863 Also, the environment variable tftpdstp is used to supply
2853 the TFTP UDP destination port value. If tftpdstp isn't 2864 the TFTP UDP destination port value. If tftpdstp isn't
2854 defined, the normal port 69 is used. 2865 defined, the normal port 69 is used.
2855 2866
2856 The purpose for tftpsrcp is to allow a TFTP server to 2867 The purpose for tftpsrcp is to allow a TFTP server to
2857 blindly start the TFTP transfer using the pre-configured 2868 blindly start the TFTP transfer using the pre-configured
2858 target IP address and UDP port. This has the effect of 2869 target IP address and UDP port. This has the effect of
2859 "punching through" the (Windows XP) firewall, allowing 2870 "punching through" the (Windows XP) firewall, allowing
2860 the remainder of the TFTP transfer to proceed normally. 2871 the remainder of the TFTP transfer to proceed normally.
2861 A better solution is to properly configure the firewall, 2872 A better solution is to properly configure the firewall,
2862 but sometimes that is not allowed. 2873 but sometimes that is not allowed.
2863 2874
2864 - Hashing support: 2875 - Hashing support:
2865 CONFIG_CMD_HASH 2876 CONFIG_CMD_HASH
2866 2877
2867 This enables a generic 'hash' command which can produce 2878 This enables a generic 'hash' command which can produce
2868 hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2879 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2869 2880
2870 CONFIG_HASH_VERIFY 2881 CONFIG_HASH_VERIFY
2871 2882
2872 Enable the hash verify command (hash -v). This adds to code 2883 Enable the hash verify command (hash -v). This adds to code
2873 size a little. 2884 size a little.
2874 2885
2875 CONFIG_SHA1 - support SHA1 hashing 2886 CONFIG_SHA1 - support SHA1 hashing
2876 CONFIG_SHA256 - support SHA256 hashing 2887 CONFIG_SHA256 - support SHA256 hashing
2877 2888
2878 Note: There is also a sha1sum command, which should perhaps 2889 Note: There is also a sha1sum command, which should perhaps
2879 be deprecated in favour of 'hash sha1'. 2890 be deprecated in favour of 'hash sha1'.
2880 2891
2881 - Freescale i.MX specific commands: 2892 - Freescale i.MX specific commands:
2882 CONFIG_CMD_HDMIDETECT 2893 CONFIG_CMD_HDMIDETECT
2883 This enables 'hdmidet' command which returns true if an 2894 This enables 'hdmidet' command which returns true if an
2884 HDMI monitor is detected. This command is i.MX 6 specific. 2895 HDMI monitor is detected. This command is i.MX 6 specific.
2885 2896
2886 CONFIG_CMD_BMODE 2897 CONFIG_CMD_BMODE
2887 This enables the 'bmode' (bootmode) command for forcing 2898 This enables the 'bmode' (bootmode) command for forcing
2888 a boot from specific media. 2899 a boot from specific media.
2889 2900
2890 This is useful for forcing the ROM's usb downloader to 2901 This is useful for forcing the ROM's usb downloader to
2891 activate upon a watchdog reset which is nice when iterating 2902 activate upon a watchdog reset which is nice when iterating
2892 on U-Boot. Using the reset button or running bmode normal 2903 on U-Boot. Using the reset button or running bmode normal
2893 will set it back to normal. This command currently 2904 will set it back to normal. This command currently
2894 supports i.MX53 and i.MX6. 2905 supports i.MX53 and i.MX6.
2895 2906
2896 - Signing support: 2907 - Signing support:
2897 CONFIG_RSA 2908 CONFIG_RSA
2898 2909
2899 This enables the RSA algorithm used for FIT image verification 2910 This enables the RSA algorithm used for FIT image verification
2900 in U-Boot. See doc/uImage.FIT/signature.txt for more information. 2911 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
2901 2912
2902 The signing part is build into mkimage regardless of this 2913 The signing part is build into mkimage regardless of this
2903 option. 2914 option.
2904 2915
2905 - bootcount support: 2916 - bootcount support:
2906 CONFIG_BOOTCOUNT_LIMIT 2917 CONFIG_BOOTCOUNT_LIMIT
2907 2918
2908 This enables the bootcounter support, see: 2919 This enables the bootcounter support, see:
2909 http://www.denx.de/wiki/DULG/UBootBootCountLimit 2920 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2910 2921
2911 CONFIG_AT91SAM9XE 2922 CONFIG_AT91SAM9XE
2912 enable special bootcounter support on at91sam9xe based boards. 2923 enable special bootcounter support on at91sam9xe based boards.
2913 CONFIG_BLACKFIN 2924 CONFIG_BLACKFIN
2914 enable special bootcounter support on blackfin based boards. 2925 enable special bootcounter support on blackfin based boards.
2915 CONFIG_SOC_DA8XX 2926 CONFIG_SOC_DA8XX
2916 enable special bootcounter support on da850 based boards. 2927 enable special bootcounter support on da850 based boards.
2917 CONFIG_BOOTCOUNT_RAM 2928 CONFIG_BOOTCOUNT_RAM
2918 enable support for the bootcounter in RAM 2929 enable support for the bootcounter in RAM
2919 CONFIG_BOOTCOUNT_I2C 2930 CONFIG_BOOTCOUNT_I2C
2920 enable support for the bootcounter on an i2c (like RTC) device. 2931 enable support for the bootcounter on an i2c (like RTC) device.
2921 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 2932 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2922 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 2933 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2923 the bootcounter. 2934 the bootcounter.
2924 CONFIG_BOOTCOUNT_ALEN = address len 2935 CONFIG_BOOTCOUNT_ALEN = address len
2925 2936
2926 - Show boot progress: 2937 - Show boot progress:
2927 CONFIG_SHOW_BOOT_PROGRESS 2938 CONFIG_SHOW_BOOT_PROGRESS
2928 2939
2929 Defining this option allows to add some board- 2940 Defining this option allows to add some board-
2930 specific code (calling a user-provided function 2941 specific code (calling a user-provided function
2931 "show_boot_progress(int)") that enables you to show 2942 "show_boot_progress(int)") that enables you to show
2932 the system's boot progress on some display (for 2943 the system's boot progress on some display (for
2933 example, some LED's) on your board. At the moment, 2944 example, some LED's) on your board. At the moment,
2934 the following checkpoints are implemented: 2945 the following checkpoints are implemented:
2935 2946
2936 - Detailed boot stage timing 2947 - Detailed boot stage timing
2937 CONFIG_BOOTSTAGE 2948 CONFIG_BOOTSTAGE
2938 Define this option to get detailed timing of each stage 2949 Define this option to get detailed timing of each stage
2939 of the boot process. 2950 of the boot process.
2940 2951
2941 CONFIG_BOOTSTAGE_USER_COUNT 2952 CONFIG_BOOTSTAGE_USER_COUNT
2942 This is the number of available user bootstage records. 2953 This is the number of available user bootstage records.
2943 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 2954 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2944 a new ID will be allocated from this stash. If you exceed 2955 a new ID will be allocated from this stash. If you exceed
2945 the limit, recording will stop. 2956 the limit, recording will stop.
2946 2957
2947 CONFIG_BOOTSTAGE_REPORT 2958 CONFIG_BOOTSTAGE_REPORT
2948 Define this to print a report before boot, similar to this: 2959 Define this to print a report before boot, similar to this:
2949 2960
2950 Timer summary in microseconds: 2961 Timer summary in microseconds:
2951 Mark Elapsed Stage 2962 Mark Elapsed Stage
2952 0 0 reset 2963 0 0 reset
2953 3,575,678 3,575,678 board_init_f start 2964 3,575,678 3,575,678 board_init_f start
2954 3,575,695 17 arch_cpu_init A9 2965 3,575,695 17 arch_cpu_init A9
2955 3,575,777 82 arch_cpu_init done 2966 3,575,777 82 arch_cpu_init done
2956 3,659,598 83,821 board_init_r start 2967 3,659,598 83,821 board_init_r start
2957 3,910,375 250,777 main_loop 2968 3,910,375 250,777 main_loop
2958 29,916,167 26,005,792 bootm_start 2969 29,916,167 26,005,792 bootm_start
2959 30,361,327 445,160 start_kernel 2970 30,361,327 445,160 start_kernel
2960 2971
2961 CONFIG_CMD_BOOTSTAGE 2972 CONFIG_CMD_BOOTSTAGE
2962 Add a 'bootstage' command which supports printing a report 2973 Add a 'bootstage' command which supports printing a report
2963 and un/stashing of bootstage data. 2974 and un/stashing of bootstage data.
2964 2975
2965 CONFIG_BOOTSTAGE_FDT 2976 CONFIG_BOOTSTAGE_FDT
2966 Stash the bootstage information in the FDT. A root 'bootstage' 2977 Stash the bootstage information in the FDT. A root 'bootstage'
2967 node is created with each bootstage id as a child. Each child 2978 node is created with each bootstage id as a child. Each child
2968 has a 'name' property and either 'mark' containing the 2979 has a 'name' property and either 'mark' containing the
2969 mark time in microsecond, or 'accum' containing the 2980 mark time in microsecond, or 'accum' containing the
2970 accumulated time for that bootstage id in microseconds. 2981 accumulated time for that bootstage id in microseconds.
2971 For example: 2982 For example:
2972 2983
2973 bootstage { 2984 bootstage {
2974 154 { 2985 154 {
2975 name = "board_init_f"; 2986 name = "board_init_f";
2976 mark = <3575678>; 2987 mark = <3575678>;
2977 }; 2988 };
2978 170 { 2989 170 {
2979 name = "lcd"; 2990 name = "lcd";
2980 accum = <33482>; 2991 accum = <33482>;
2981 }; 2992 };
2982 }; 2993 };
2983 2994
2984 Code in the Linux kernel can find this in /proc/devicetree. 2995 Code in the Linux kernel can find this in /proc/devicetree.
2985 2996
2986 Legacy uImage format: 2997 Legacy uImage format:
2987 2998
2988 Arg Where When 2999 Arg Where When
2989 1 common/cmd_bootm.c before attempting to boot an image 3000 1 common/cmd_bootm.c before attempting to boot an image
2990 -1 common/cmd_bootm.c Image header has bad magic number 3001 -1 common/cmd_bootm.c Image header has bad magic number
2991 2 common/cmd_bootm.c Image header has correct magic number 3002 2 common/cmd_bootm.c Image header has correct magic number
2992 -2 common/cmd_bootm.c Image header has bad checksum 3003 -2 common/cmd_bootm.c Image header has bad checksum
2993 3 common/cmd_bootm.c Image header has correct checksum 3004 3 common/cmd_bootm.c Image header has correct checksum
2994 -3 common/cmd_bootm.c Image data has bad checksum 3005 -3 common/cmd_bootm.c Image data has bad checksum
2995 4 common/cmd_bootm.c Image data has correct checksum 3006 4 common/cmd_bootm.c Image data has correct checksum
2996 -4 common/cmd_bootm.c Image is for unsupported architecture 3007 -4 common/cmd_bootm.c Image is for unsupported architecture
2997 5 common/cmd_bootm.c Architecture check OK 3008 5 common/cmd_bootm.c Architecture check OK
2998 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 3009 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
2999 6 common/cmd_bootm.c Image Type check OK 3010 6 common/cmd_bootm.c Image Type check OK
3000 -6 common/cmd_bootm.c gunzip uncompression error 3011 -6 common/cmd_bootm.c gunzip uncompression error
3001 -7 common/cmd_bootm.c Unimplemented compression type 3012 -7 common/cmd_bootm.c Unimplemented compression type
3002 7 common/cmd_bootm.c Uncompression OK 3013 7 common/cmd_bootm.c Uncompression OK
3003 8 common/cmd_bootm.c No uncompress/copy overwrite error 3014 8 common/cmd_bootm.c No uncompress/copy overwrite error
3004 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 3015 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
3005 3016
3006 9 common/image.c Start initial ramdisk verification 3017 9 common/image.c Start initial ramdisk verification
3007 -10 common/image.c Ramdisk header has bad magic number 3018 -10 common/image.c Ramdisk header has bad magic number
3008 -11 common/image.c Ramdisk header has bad checksum 3019 -11 common/image.c Ramdisk header has bad checksum
3009 10 common/image.c Ramdisk header is OK 3020 10 common/image.c Ramdisk header is OK
3010 -12 common/image.c Ramdisk data has bad checksum 3021 -12 common/image.c Ramdisk data has bad checksum
3011 11 common/image.c Ramdisk data has correct checksum 3022 11 common/image.c Ramdisk data has correct checksum
3012 12 common/image.c Ramdisk verification complete, start loading 3023 12 common/image.c Ramdisk verification complete, start loading
3013 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 3024 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
3014 13 common/image.c Start multifile image verification 3025 13 common/image.c Start multifile image verification
3015 14 common/image.c No initial ramdisk, no multifile, continue. 3026 14 common/image.c No initial ramdisk, no multifile, continue.
3016 3027
3017 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 3028 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3018 3029
3019 -30 arch/powerpc/lib/board.c Fatal error, hang the system 3030 -30 arch/powerpc/lib/board.c Fatal error, hang the system
3020 -31 post/post.c POST test failed, detected by post_output_backlog() 3031 -31 post/post.c POST test failed, detected by post_output_backlog()
3021 -32 post/post.c POST test failed, detected by post_run_single() 3032 -32 post/post.c POST test failed, detected by post_run_single()
3022 3033
3023 34 common/cmd_doc.c before loading a Image from a DOC device 3034 34 common/cmd_doc.c before loading a Image from a DOC device
3024 -35 common/cmd_doc.c Bad usage of "doc" command 3035 -35 common/cmd_doc.c Bad usage of "doc" command
3025 35 common/cmd_doc.c correct usage of "doc" command 3036 35 common/cmd_doc.c correct usage of "doc" command
3026 -36 common/cmd_doc.c No boot device 3037 -36 common/cmd_doc.c No boot device
3027 36 common/cmd_doc.c correct boot device 3038 36 common/cmd_doc.c correct boot device
3028 -37 common/cmd_doc.c Unknown Chip ID on boot device 3039 -37 common/cmd_doc.c Unknown Chip ID on boot device
3029 37 common/cmd_doc.c correct chip ID found, device available 3040 37 common/cmd_doc.c correct chip ID found, device available
3030 -38 common/cmd_doc.c Read Error on boot device 3041 -38 common/cmd_doc.c Read Error on boot device
3031 38 common/cmd_doc.c reading Image header from DOC device OK 3042 38 common/cmd_doc.c reading Image header from DOC device OK
3032 -39 common/cmd_doc.c Image header has bad magic number 3043 -39 common/cmd_doc.c Image header has bad magic number
3033 39 common/cmd_doc.c Image header has correct magic number 3044 39 common/cmd_doc.c Image header has correct magic number
3034 -40 common/cmd_doc.c Error reading Image from DOC device 3045 -40 common/cmd_doc.c Error reading Image from DOC device
3035 40 common/cmd_doc.c Image header has correct magic number 3046 40 common/cmd_doc.c Image header has correct magic number
3036 41 common/cmd_ide.c before loading a Image from a IDE device 3047 41 common/cmd_ide.c before loading a Image from a IDE device
3037 -42 common/cmd_ide.c Bad usage of "ide" command 3048 -42 common/cmd_ide.c Bad usage of "ide" command
3038 42 common/cmd_ide.c correct usage of "ide" command 3049 42 common/cmd_ide.c correct usage of "ide" command
3039 -43 common/cmd_ide.c No boot device 3050 -43 common/cmd_ide.c No boot device
3040 43 common/cmd_ide.c boot device found 3051 43 common/cmd_ide.c boot device found
3041 -44 common/cmd_ide.c Device not available 3052 -44 common/cmd_ide.c Device not available
3042 44 common/cmd_ide.c Device available 3053 44 common/cmd_ide.c Device available
3043 -45 common/cmd_ide.c wrong partition selected 3054 -45 common/cmd_ide.c wrong partition selected
3044 45 common/cmd_ide.c partition selected 3055 45 common/cmd_ide.c partition selected
3045 -46 common/cmd_ide.c Unknown partition table 3056 -46 common/cmd_ide.c Unknown partition table
3046 46 common/cmd_ide.c valid partition table found 3057 46 common/cmd_ide.c valid partition table found
3047 -47 common/cmd_ide.c Invalid partition type 3058 -47 common/cmd_ide.c Invalid partition type
3048 47 common/cmd_ide.c correct partition type 3059 47 common/cmd_ide.c correct partition type
3049 -48 common/cmd_ide.c Error reading Image Header on boot device 3060 -48 common/cmd_ide.c Error reading Image Header on boot device
3050 48 common/cmd_ide.c reading Image Header from IDE device OK 3061 48 common/cmd_ide.c reading Image Header from IDE device OK
3051 -49 common/cmd_ide.c Image header has bad magic number 3062 -49 common/cmd_ide.c Image header has bad magic number
3052 49 common/cmd_ide.c Image header has correct magic number 3063 49 common/cmd_ide.c Image header has correct magic number
3053 -50 common/cmd_ide.c Image header has bad checksum 3064 -50 common/cmd_ide.c Image header has bad checksum
3054 50 common/cmd_ide.c Image header has correct checksum 3065 50 common/cmd_ide.c Image header has correct checksum
3055 -51 common/cmd_ide.c Error reading Image from IDE device 3066 -51 common/cmd_ide.c Error reading Image from IDE device
3056 51 common/cmd_ide.c reading Image from IDE device OK 3067 51 common/cmd_ide.c reading Image from IDE device OK
3057 52 common/cmd_nand.c before loading a Image from a NAND device 3068 52 common/cmd_nand.c before loading a Image from a NAND device
3058 -53 common/cmd_nand.c Bad usage of "nand" command 3069 -53 common/cmd_nand.c Bad usage of "nand" command
3059 53 common/cmd_nand.c correct usage of "nand" command 3070 53 common/cmd_nand.c correct usage of "nand" command
3060 -54 common/cmd_nand.c No boot device 3071 -54 common/cmd_nand.c No boot device
3061 54 common/cmd_nand.c boot device found 3072 54 common/cmd_nand.c boot device found
3062 -55 common/cmd_nand.c Unknown Chip ID on boot device 3073 -55 common/cmd_nand.c Unknown Chip ID on boot device
3063 55 common/cmd_nand.c correct chip ID found, device available 3074 55 common/cmd_nand.c correct chip ID found, device available
3064 -56 common/cmd_nand.c Error reading Image Header on boot device 3075 -56 common/cmd_nand.c Error reading Image Header on boot device
3065 56 common/cmd_nand.c reading Image Header from NAND device OK 3076 56 common/cmd_nand.c reading Image Header from NAND device OK
3066 -57 common/cmd_nand.c Image header has bad magic number 3077 -57 common/cmd_nand.c Image header has bad magic number
3067 57 common/cmd_nand.c Image header has correct magic number 3078 57 common/cmd_nand.c Image header has correct magic number
3068 -58 common/cmd_nand.c Error reading Image from NAND device 3079 -58 common/cmd_nand.c Error reading Image from NAND device
3069 58 common/cmd_nand.c reading Image from NAND device OK 3080 58 common/cmd_nand.c reading Image from NAND device OK
3070 3081
3071 -60 common/env_common.c Environment has a bad CRC, using default 3082 -60 common/env_common.c Environment has a bad CRC, using default
3072 3083
3073 64 net/eth.c starting with Ethernet configuration. 3084 64 net/eth.c starting with Ethernet configuration.
3074 -64 net/eth.c no Ethernet found. 3085 -64 net/eth.c no Ethernet found.
3075 65 net/eth.c Ethernet found. 3086 65 net/eth.c Ethernet found.
3076 3087
3077 -80 common/cmd_net.c usage wrong 3088 -80 common/cmd_net.c usage wrong
3078 80 common/cmd_net.c before calling NetLoop() 3089 80 common/cmd_net.c before calling NetLoop()
3079 -81 common/cmd_net.c some error in NetLoop() occurred 3090 -81 common/cmd_net.c some error in NetLoop() occurred
3080 81 common/cmd_net.c NetLoop() back without error 3091 81 common/cmd_net.c NetLoop() back without error
3081 -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3092 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3082 82 common/cmd_net.c trying automatic boot 3093 82 common/cmd_net.c trying automatic boot
3083 83 common/cmd_net.c running "source" command 3094 83 common/cmd_net.c running "source" command
3084 -83 common/cmd_net.c some error in automatic boot or "source" command 3095 -83 common/cmd_net.c some error in automatic boot or "source" command
3085 84 common/cmd_net.c end without errors 3096 84 common/cmd_net.c end without errors
3086 3097
3087 FIT uImage format: 3098 FIT uImage format:
3088 3099
3089 Arg Where When 3100 Arg Where When
3090 100 common/cmd_bootm.c Kernel FIT Image has correct format 3101 100 common/cmd_bootm.c Kernel FIT Image has correct format
3091 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 3102 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3092 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 3103 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3093 -101 common/cmd_bootm.c Can't get configuration for kernel subimage 3104 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3094 102 common/cmd_bootm.c Kernel unit name specified 3105 102 common/cmd_bootm.c Kernel unit name specified
3095 -103 common/cmd_bootm.c Can't get kernel subimage node offset 3106 -103 common/cmd_bootm.c Can't get kernel subimage node offset
3096 103 common/cmd_bootm.c Found configuration node 3107 103 common/cmd_bootm.c Found configuration node
3097 104 common/cmd_bootm.c Got kernel subimage node offset 3108 104 common/cmd_bootm.c Got kernel subimage node offset
3098 -104 common/cmd_bootm.c Kernel subimage hash verification failed 3109 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3099 105 common/cmd_bootm.c Kernel subimage hash verification OK 3110 105 common/cmd_bootm.c Kernel subimage hash verification OK
3100 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 3111 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3101 106 common/cmd_bootm.c Architecture check OK 3112 106 common/cmd_bootm.c Architecture check OK
3102 -106 common/cmd_bootm.c Kernel subimage has wrong type 3113 -106 common/cmd_bootm.c Kernel subimage has wrong type
3103 107 common/cmd_bootm.c Kernel subimage type OK 3114 107 common/cmd_bootm.c Kernel subimage type OK
3104 -107 common/cmd_bootm.c Can't get kernel subimage data/size 3115 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3105 108 common/cmd_bootm.c Got kernel subimage data/size 3116 108 common/cmd_bootm.c Got kernel subimage data/size
3106 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 3117 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3107 -109 common/cmd_bootm.c Can't get kernel subimage type 3118 -109 common/cmd_bootm.c Can't get kernel subimage type
3108 -110 common/cmd_bootm.c Can't get kernel subimage comp 3119 -110 common/cmd_bootm.c Can't get kernel subimage comp
3109 -111 common/cmd_bootm.c Can't get kernel subimage os 3120 -111 common/cmd_bootm.c Can't get kernel subimage os
3110 -112 common/cmd_bootm.c Can't get kernel subimage load address 3121 -112 common/cmd_bootm.c Can't get kernel subimage load address
3111 -113 common/cmd_bootm.c Image uncompress/copy overwrite error 3122 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3112 3123
3113 120 common/image.c Start initial ramdisk verification 3124 120 common/image.c Start initial ramdisk verification
3114 -120 common/image.c Ramdisk FIT image has incorrect format 3125 -120 common/image.c Ramdisk FIT image has incorrect format
3115 121 common/image.c Ramdisk FIT image has correct format 3126 121 common/image.c Ramdisk FIT image has correct format
3116 122 common/image.c No ramdisk subimage unit name, using configuration 3127 122 common/image.c No ramdisk subimage unit name, using configuration
3117 -122 common/image.c Can't get configuration for ramdisk subimage 3128 -122 common/image.c Can't get configuration for ramdisk subimage
3118 123 common/image.c Ramdisk unit name specified 3129 123 common/image.c Ramdisk unit name specified
3119 -124 common/image.c Can't get ramdisk subimage node offset 3130 -124 common/image.c Can't get ramdisk subimage node offset
3120 125 common/image.c Got ramdisk subimage node offset 3131 125 common/image.c Got ramdisk subimage node offset
3121 -125 common/image.c Ramdisk subimage hash verification failed 3132 -125 common/image.c Ramdisk subimage hash verification failed
3122 126 common/image.c Ramdisk subimage hash verification OK 3133 126 common/image.c Ramdisk subimage hash verification OK
3123 -126 common/image.c Ramdisk subimage for unsupported architecture 3134 -126 common/image.c Ramdisk subimage for unsupported architecture
3124 127 common/image.c Architecture check OK 3135 127 common/image.c Architecture check OK
3125 -127 common/image.c Can't get ramdisk subimage data/size 3136 -127 common/image.c Can't get ramdisk subimage data/size
3126 128 common/image.c Got ramdisk subimage data/size 3137 128 common/image.c Got ramdisk subimage data/size
3127 129 common/image.c Can't get ramdisk load address 3138 129 common/image.c Can't get ramdisk load address
3128 -129 common/image.c Got ramdisk load address 3139 -129 common/image.c Got ramdisk load address
3129 3140
3130 -130 common/cmd_doc.c Incorrect FIT image format 3141 -130 common/cmd_doc.c Incorrect FIT image format
3131 131 common/cmd_doc.c FIT image format OK 3142 131 common/cmd_doc.c FIT image format OK
3132 3143
3133 -140 common/cmd_ide.c Incorrect FIT image format 3144 -140 common/cmd_ide.c Incorrect FIT image format
3134 141 common/cmd_ide.c FIT image format OK 3145 141 common/cmd_ide.c FIT image format OK
3135 3146
3136 -150 common/cmd_nand.c Incorrect FIT image format 3147 -150 common/cmd_nand.c Incorrect FIT image format
3137 151 common/cmd_nand.c FIT image format OK 3148 151 common/cmd_nand.c FIT image format OK
3138 3149
3139 - FIT image support: 3150 - FIT image support:
3140 CONFIG_FIT 3151 CONFIG_FIT
3141 Enable support for the FIT uImage format. 3152 Enable support for the FIT uImage format.
3142 3153
3143 CONFIG_FIT_BEST_MATCH 3154 CONFIG_FIT_BEST_MATCH
3144 When no configuration is explicitly selected, default to the 3155 When no configuration is explicitly selected, default to the
3145 one whose fdt's compatibility field best matches that of 3156 one whose fdt's compatibility field best matches that of
3146 U-Boot itself. A match is considered "best" if it matches the 3157 U-Boot itself. A match is considered "best" if it matches the
3147 most specific compatibility entry of U-Boot's fdt's root node. 3158 most specific compatibility entry of U-Boot's fdt's root node.
3148 The order of entries in the configuration's fdt is ignored. 3159 The order of entries in the configuration's fdt is ignored.
3149 3160
3150 CONFIG_FIT_SIGNATURE 3161 CONFIG_FIT_SIGNATURE
3151 This option enables signature verification of FIT uImages, 3162 This option enables signature verification of FIT uImages,
3152 using a hash signed and verified using RSA. See 3163 using a hash signed and verified using RSA. See
3153 doc/uImage.FIT/signature.txt for more details. 3164 doc/uImage.FIT/signature.txt for more details.
3154 3165
3155 - Standalone program support: 3166 - Standalone program support:
3156 CONFIG_STANDALONE_LOAD_ADDR 3167 CONFIG_STANDALONE_LOAD_ADDR
3157 3168
3158 This option defines a board specific value for the 3169 This option defines a board specific value for the
3159 address where standalone program gets loaded, thus 3170 address where standalone program gets loaded, thus
3160 overwriting the architecture dependent default 3171 overwriting the architecture dependent default
3161 settings. 3172 settings.
3162 3173
3163 - Frame Buffer Address: 3174 - Frame Buffer Address:
3164 CONFIG_FB_ADDR 3175 CONFIG_FB_ADDR
3165 3176
3166 Define CONFIG_FB_ADDR if you want to use specific 3177 Define CONFIG_FB_ADDR if you want to use specific
3167 address for frame buffer. This is typically the case 3178 address for frame buffer. This is typically the case
3168 when using a graphics controller has separate video 3179 when using a graphics controller has separate video
3169 memory. U-Boot will then place the frame buffer at 3180 memory. U-Boot will then place the frame buffer at
3170 the given address instead of dynamically reserving it 3181 the given address instead of dynamically reserving it
3171 in system RAM by calling lcd_setmem(), which grabs 3182 in system RAM by calling lcd_setmem(), which grabs
3172 the memory for the frame buffer depending on the 3183 the memory for the frame buffer depending on the
3173 configured panel size. 3184 configured panel size.
3174 3185
3175 Please see board_init_f function. 3186 Please see board_init_f function.
3176 3187
3177 - Automatic software updates via TFTP server 3188 - Automatic software updates via TFTP server
3178 CONFIG_UPDATE_TFTP 3189 CONFIG_UPDATE_TFTP
3179 CONFIG_UPDATE_TFTP_CNT_MAX 3190 CONFIG_UPDATE_TFTP_CNT_MAX
3180 CONFIG_UPDATE_TFTP_MSEC_MAX 3191 CONFIG_UPDATE_TFTP_MSEC_MAX
3181 3192
3182 These options enable and control the auto-update feature; 3193 These options enable and control the auto-update feature;
3183 for a more detailed description refer to doc/README.update. 3194 for a more detailed description refer to doc/README.update.
3184 3195
3185 - MTD Support (mtdparts command, UBI support) 3196 - MTD Support (mtdparts command, UBI support)
3186 CONFIG_MTD_DEVICE 3197 CONFIG_MTD_DEVICE
3187 3198
3188 Adds the MTD device infrastructure from the Linux kernel. 3199 Adds the MTD device infrastructure from the Linux kernel.
3189 Needed for mtdparts command support. 3200 Needed for mtdparts command support.
3190 3201
3191 CONFIG_MTD_PARTITIONS 3202 CONFIG_MTD_PARTITIONS
3192 3203
3193 Adds the MTD partitioning infrastructure from the Linux 3204 Adds the MTD partitioning infrastructure from the Linux
3194 kernel. Needed for UBI support. 3205 kernel. Needed for UBI support.
3195 3206
3196 - UBI support 3207 - UBI support
3197 CONFIG_CMD_UBI 3208 CONFIG_CMD_UBI
3198 3209
3199 Adds commands for interacting with MTD partitions formatted 3210 Adds commands for interacting with MTD partitions formatted
3200 with the UBI flash translation layer 3211 with the UBI flash translation layer
3201 3212
3202 Requires also defining CONFIG_RBTREE 3213 Requires also defining CONFIG_RBTREE
3203 3214
3204 CONFIG_UBI_SILENCE_MSG 3215 CONFIG_UBI_SILENCE_MSG
3205 3216
3206 Make the verbose messages from UBI stop printing. This leaves 3217 Make the verbose messages from UBI stop printing. This leaves
3207 warnings and errors enabled. 3218 warnings and errors enabled.
3208 3219
3209 - UBIFS support 3220 - UBIFS support
3210 CONFIG_CMD_UBIFS 3221 CONFIG_CMD_UBIFS
3211 3222
3212 Adds commands for interacting with UBI volumes formatted as 3223 Adds commands for interacting with UBI volumes formatted as
3213 UBIFS. UBIFS is read-only in u-boot. 3224 UBIFS. UBIFS is read-only in u-boot.
3214 3225
3215 Requires UBI support as well as CONFIG_LZO 3226 Requires UBI support as well as CONFIG_LZO
3216 3227
3217 CONFIG_UBIFS_SILENCE_MSG 3228 CONFIG_UBIFS_SILENCE_MSG
3218 3229
3219 Make the verbose messages from UBIFS stop printing. This leaves 3230 Make the verbose messages from UBIFS stop printing. This leaves
3220 warnings and errors enabled. 3231 warnings and errors enabled.
3221 3232
3222 - SPL framework 3233 - SPL framework
3223 CONFIG_SPL 3234 CONFIG_SPL
3224 Enable building of SPL globally. 3235 Enable building of SPL globally.
3225 3236
3226 CONFIG_SPL_LDSCRIPT 3237 CONFIG_SPL_LDSCRIPT
3227 LDSCRIPT for linking the SPL binary. 3238 LDSCRIPT for linking the SPL binary.
3228 3239
3229 CONFIG_SPL_MAX_FOOTPRINT 3240 CONFIG_SPL_MAX_FOOTPRINT
3230 Maximum size in memory allocated to the SPL, BSS included. 3241 Maximum size in memory allocated to the SPL, BSS included.
3231 When defined, the linker checks that the actual memory 3242 When defined, the linker checks that the actual memory
3232 used by SPL from _start to __bss_end does not exceed it. 3243 used by SPL from _start to __bss_end does not exceed it.
3233 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 3244 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3234 must not be both defined at the same time. 3245 must not be both defined at the same time.
3235 3246
3236 CONFIG_SPL_MAX_SIZE 3247 CONFIG_SPL_MAX_SIZE
3237 Maximum size of the SPL image (text, data, rodata, and 3248 Maximum size of the SPL image (text, data, rodata, and
3238 linker lists sections), BSS excluded. 3249 linker lists sections), BSS excluded.
3239 When defined, the linker checks that the actual size does 3250 When defined, the linker checks that the actual size does
3240 not exceed it. 3251 not exceed it.
3241 3252
3242 CONFIG_SPL_TEXT_BASE 3253 CONFIG_SPL_TEXT_BASE
3243 TEXT_BASE for linking the SPL binary. 3254 TEXT_BASE for linking the SPL binary.
3244 3255
3245 CONFIG_SPL_RELOC_TEXT_BASE 3256 CONFIG_SPL_RELOC_TEXT_BASE
3246 Address to relocate to. If unspecified, this is equal to 3257 Address to relocate to. If unspecified, this is equal to
3247 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 3258 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3248 3259
3249 CONFIG_SPL_BSS_START_ADDR 3260 CONFIG_SPL_BSS_START_ADDR
3250 Link address for the BSS within the SPL binary. 3261 Link address for the BSS within the SPL binary.
3251 3262
3252 CONFIG_SPL_BSS_MAX_SIZE 3263 CONFIG_SPL_BSS_MAX_SIZE
3253 Maximum size in memory allocated to the SPL BSS. 3264 Maximum size in memory allocated to the SPL BSS.
3254 When defined, the linker checks that the actual memory used 3265 When defined, the linker checks that the actual memory used
3255 by SPL from __bss_start to __bss_end does not exceed it. 3266 by SPL from __bss_start to __bss_end does not exceed it.
3256 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 3267 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3257 must not be both defined at the same time. 3268 must not be both defined at the same time.
3258 3269
3259 CONFIG_SPL_STACK 3270 CONFIG_SPL_STACK
3260 Adress of the start of the stack SPL will use 3271 Adress of the start of the stack SPL will use
3261 3272
3262 CONFIG_SPL_RELOC_STACK 3273 CONFIG_SPL_RELOC_STACK
3263 Adress of the start of the stack SPL will use after 3274 Adress of the start of the stack SPL will use after
3264 relocation. If unspecified, this is equal to 3275 relocation. If unspecified, this is equal to
3265 CONFIG_SPL_STACK. 3276 CONFIG_SPL_STACK.
3266 3277
3267 CONFIG_SYS_SPL_MALLOC_START 3278 CONFIG_SYS_SPL_MALLOC_START
3268 Starting address of the malloc pool used in SPL. 3279 Starting address of the malloc pool used in SPL.
3269 3280
3270 CONFIG_SYS_SPL_MALLOC_SIZE 3281 CONFIG_SYS_SPL_MALLOC_SIZE
3271 The size of the malloc pool used in SPL. 3282 The size of the malloc pool used in SPL.
3272 3283
3273 CONFIG_SPL_FRAMEWORK 3284 CONFIG_SPL_FRAMEWORK
3274 Enable the SPL framework under common/. This framework 3285 Enable the SPL framework under common/. This framework
3275 supports MMC, NAND and YMODEM loading of U-Boot and NAND 3286 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3276 NAND loading of the Linux Kernel. 3287 NAND loading of the Linux Kernel.
3277 3288
3278 CONFIG_SPL_DISPLAY_PRINT 3289 CONFIG_SPL_DISPLAY_PRINT
3279 For ARM, enable an optional function to print more information 3290 For ARM, enable an optional function to print more information
3280 about the running system. 3291 about the running system.
3281 3292
3282 CONFIG_SPL_INIT_MINIMAL 3293 CONFIG_SPL_INIT_MINIMAL
3283 Arch init code should be built for a very small image 3294 Arch init code should be built for a very small image
3284 3295
3285 CONFIG_SPL_LIBCOMMON_SUPPORT 3296 CONFIG_SPL_LIBCOMMON_SUPPORT
3286 Support for common/libcommon.o in SPL binary 3297 Support for common/libcommon.o in SPL binary
3287 3298
3288 CONFIG_SPL_LIBDISK_SUPPORT 3299 CONFIG_SPL_LIBDISK_SUPPORT
3289 Support for disk/libdisk.o in SPL binary 3300 Support for disk/libdisk.o in SPL binary
3290 3301
3291 CONFIG_SPL_I2C_SUPPORT 3302 CONFIG_SPL_I2C_SUPPORT
3292 Support for drivers/i2c/libi2c.o in SPL binary 3303 Support for drivers/i2c/libi2c.o in SPL binary
3293 3304
3294 CONFIG_SPL_GPIO_SUPPORT 3305 CONFIG_SPL_GPIO_SUPPORT
3295 Support for drivers/gpio/libgpio.o in SPL binary 3306 Support for drivers/gpio/libgpio.o in SPL binary
3296 3307
3297 CONFIG_SPL_MMC_SUPPORT 3308 CONFIG_SPL_MMC_SUPPORT
3298 Support for drivers/mmc/libmmc.o in SPL binary 3309 Support for drivers/mmc/libmmc.o in SPL binary
3299 3310
3300 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 3311 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3301 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 3312 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3302 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 3313 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3303 Address, size and partition on the MMC to load U-Boot from 3314 Address, size and partition on the MMC to load U-Boot from
3304 when the MMC is being used in raw mode. 3315 when the MMC is being used in raw mode.
3305 3316
3306 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 3317 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3307 Sector to load kernel uImage from when MMC is being 3318 Sector to load kernel uImage from when MMC is being
3308 used in raw mode (for Falcon mode) 3319 used in raw mode (for Falcon mode)
3309 3320
3310 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 3321 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3311 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 3322 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3312 Sector and number of sectors to load kernel argument 3323 Sector and number of sectors to load kernel argument
3313 parameters from when MMC is being used in raw mode 3324 parameters from when MMC is being used in raw mode
3314 (for falcon mode) 3325 (for falcon mode)
3315 3326
3316 CONFIG_SPL_FAT_SUPPORT 3327 CONFIG_SPL_FAT_SUPPORT
3317 Support for fs/fat/libfat.o in SPL binary 3328 Support for fs/fat/libfat.o in SPL binary
3318 3329
3319 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 3330 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3320 Filename to read to load U-Boot when reading from FAT 3331 Filename to read to load U-Boot when reading from FAT
3321 3332
3322 CONFIG_SPL_FAT_LOAD_KERNEL_NAME 3333 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3323 Filename to read to load kernel uImage when reading 3334 Filename to read to load kernel uImage when reading
3324 from FAT (for Falcon mode) 3335 from FAT (for Falcon mode)
3325 3336
3326 CONFIG_SPL_FAT_LOAD_ARGS_NAME 3337 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3327 Filename to read to load kernel argument parameters 3338 Filename to read to load kernel argument parameters
3328 when reading from FAT (for Falcon mode) 3339 when reading from FAT (for Falcon mode)
3329 3340
3330 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 3341 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3331 Set this for NAND SPL on PPC mpc83xx targets, so that 3342 Set this for NAND SPL on PPC mpc83xx targets, so that
3332 start.S waits for the rest of the SPL to load before 3343 start.S waits for the rest of the SPL to load before
3333 continuing (the hardware starts execution after just 3344 continuing (the hardware starts execution after just
3334 loading the first page rather than the full 4K). 3345 loading the first page rather than the full 4K).
3335 3346
3336 CONFIG_SPL_SKIP_RELOCATE 3347 CONFIG_SPL_SKIP_RELOCATE
3337 Avoid SPL relocation 3348 Avoid SPL relocation
3338 3349
3339 CONFIG_SPL_NAND_BASE 3350 CONFIG_SPL_NAND_BASE
3340 Include nand_base.c in the SPL. Requires 3351 Include nand_base.c in the SPL. Requires
3341 CONFIG_SPL_NAND_DRIVERS. 3352 CONFIG_SPL_NAND_DRIVERS.
3342 3353
3343 CONFIG_SPL_NAND_DRIVERS 3354 CONFIG_SPL_NAND_DRIVERS
3344 SPL uses normal NAND drivers, not minimal drivers. 3355 SPL uses normal NAND drivers, not minimal drivers.
3345 3356
3346 CONFIG_SPL_NAND_ECC 3357 CONFIG_SPL_NAND_ECC
3347 Include standard software ECC in the SPL 3358 Include standard software ECC in the SPL
3348 3359
3349 CONFIG_SPL_NAND_SIMPLE 3360 CONFIG_SPL_NAND_SIMPLE
3350 Support for NAND boot using simple NAND drivers that 3361 Support for NAND boot using simple NAND drivers that
3351 expose the cmd_ctrl() interface. 3362 expose the cmd_ctrl() interface.
3352 3363
3353 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3364 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3354 Set for the SPL on PPC mpc8xxx targets, support for 3365 Set for the SPL on PPC mpc8xxx targets, support for
3355 drivers/ddr/fsl/libddr.o in SPL binary. 3366 drivers/ddr/fsl/libddr.o in SPL binary.
3356 3367
3357 CONFIG_SPL_COMMON_INIT_DDR 3368 CONFIG_SPL_COMMON_INIT_DDR
3358 Set for common ddr init with serial presence detect in 3369 Set for common ddr init with serial presence detect in
3359 SPL binary. 3370 SPL binary.
3360 3371
3361 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 3372 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3362 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 3373 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3363 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 3374 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3364 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 3375 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3365 CONFIG_SYS_NAND_ECCBYTES 3376 CONFIG_SYS_NAND_ECCBYTES
3366 Defines the size and behavior of the NAND that SPL uses 3377 Defines the size and behavior of the NAND that SPL uses
3367 to read U-Boot 3378 to read U-Boot
3368 3379
3369 CONFIG_SPL_NAND_BOOT 3380 CONFIG_SPL_NAND_BOOT
3370 Add support NAND boot 3381 Add support NAND boot
3371 3382
3372 CONFIG_SYS_NAND_U_BOOT_OFFS 3383 CONFIG_SYS_NAND_U_BOOT_OFFS
3373 Location in NAND to read U-Boot from 3384 Location in NAND to read U-Boot from
3374 3385
3375 CONFIG_SYS_NAND_U_BOOT_DST 3386 CONFIG_SYS_NAND_U_BOOT_DST
3376 Location in memory to load U-Boot to 3387 Location in memory to load U-Boot to
3377 3388
3378 CONFIG_SYS_NAND_U_BOOT_SIZE 3389 CONFIG_SYS_NAND_U_BOOT_SIZE
3379 Size of image to load 3390 Size of image to load
3380 3391
3381 CONFIG_SYS_NAND_U_BOOT_START 3392 CONFIG_SYS_NAND_U_BOOT_START
3382 Entry point in loaded image to jump to 3393 Entry point in loaded image to jump to
3383 3394
3384 CONFIG_SYS_NAND_HW_ECC_OOBFIRST 3395 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3385 Define this if you need to first read the OOB and then the 3396 Define this if you need to first read the OOB and then the
3386 data. This is used for example on davinci plattforms. 3397 data. This is used for example on davinci plattforms.
3387 3398
3388 CONFIG_SPL_OMAP3_ID_NAND 3399 CONFIG_SPL_OMAP3_ID_NAND
3389 Support for an OMAP3-specific set of functions to return the 3400 Support for an OMAP3-specific set of functions to return the
3390 ID and MFR of the first attached NAND chip, if present. 3401 ID and MFR of the first attached NAND chip, if present.
3391 3402
3392 CONFIG_SPL_SERIAL_SUPPORT 3403 CONFIG_SPL_SERIAL_SUPPORT
3393 Support for drivers/serial/libserial.o in SPL binary 3404 Support for drivers/serial/libserial.o in SPL binary
3394 3405
3395 CONFIG_SPL_SPI_FLASH_SUPPORT 3406 CONFIG_SPL_SPI_FLASH_SUPPORT
3396 Support for drivers/mtd/spi/libspi_flash.o in SPL binary 3407 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
3397 3408
3398 CONFIG_SPL_SPI_SUPPORT 3409 CONFIG_SPL_SPI_SUPPORT
3399 Support for drivers/spi/libspi.o in SPL binary 3410 Support for drivers/spi/libspi.o in SPL binary
3400 3411
3401 CONFIG_SPL_RAM_DEVICE 3412 CONFIG_SPL_RAM_DEVICE
3402 Support for running image already present in ram, in SPL binary 3413 Support for running image already present in ram, in SPL binary
3403 3414
3404 CONFIG_SPL_LIBGENERIC_SUPPORT 3415 CONFIG_SPL_LIBGENERIC_SUPPORT
3405 Support for lib/libgeneric.o in SPL binary 3416 Support for lib/libgeneric.o in SPL binary
3406 3417
3407 CONFIG_SPL_ENV_SUPPORT 3418 CONFIG_SPL_ENV_SUPPORT
3408 Support for the environment operating in SPL binary 3419 Support for the environment operating in SPL binary
3409 3420
3410 CONFIG_SPL_NET_SUPPORT 3421 CONFIG_SPL_NET_SUPPORT
3411 Support for the net/libnet.o in SPL binary. 3422 Support for the net/libnet.o in SPL binary.
3412 It conflicts with SPL env from storage medium specified by 3423 It conflicts with SPL env from storage medium specified by
3413 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3424 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3414 3425
3415 CONFIG_SPL_PAD_TO 3426 CONFIG_SPL_PAD_TO
3416 Image offset to which the SPL should be padded before appending 3427 Image offset to which the SPL should be padded before appending
3417 the SPL payload. By default, this is defined as 3428 the SPL payload. By default, this is defined as
3418 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 3429 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3419 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 3430 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3420 payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 3431 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3421 3432
3422 CONFIG_SPL_TARGET 3433 CONFIG_SPL_TARGET
3423 Final target image containing SPL and payload. Some SPLs 3434 Final target image containing SPL and payload. Some SPLs
3424 use an arch-specific makefile fragment instead, for 3435 use an arch-specific makefile fragment instead, for
3425 example if more than one image needs to be produced. 3436 example if more than one image needs to be produced.
3426 3437
3427 CONFIG_FIT_SPL_PRINT 3438 CONFIG_FIT_SPL_PRINT
3428 Printing information about a FIT image adds quite a bit of 3439 Printing information about a FIT image adds quite a bit of
3429 code to SPL. So this is normally disabled in SPL. Use this 3440 code to SPL. So this is normally disabled in SPL. Use this
3430 option to re-enable it. This will affect the output of the 3441 option to re-enable it. This will affect the output of the
3431 bootm command when booting a FIT image. 3442 bootm command when booting a FIT image.
3432 3443
3433 - TPL framework 3444 - TPL framework
3434 CONFIG_TPL 3445 CONFIG_TPL
3435 Enable building of TPL globally. 3446 Enable building of TPL globally.
3436 3447
3437 CONFIG_TPL_PAD_TO 3448 CONFIG_TPL_PAD_TO
3438 Image offset to which the TPL should be padded before appending 3449 Image offset to which the TPL should be padded before appending
3439 the TPL payload. By default, this is defined as 3450 the TPL payload. By default, this is defined as
3440 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 3451 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3441 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 3452 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3442 payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 3453 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3443 3454
3444 Modem Support: 3455 Modem Support:
3445 -------------- 3456 --------------
3446 3457
3447 [so far only for SMDK2400 boards] 3458 [so far only for SMDK2400 boards]
3448 3459
3449 - Modem support enable: 3460 - Modem support enable:
3450 CONFIG_MODEM_SUPPORT 3461 CONFIG_MODEM_SUPPORT
3451 3462
3452 - RTS/CTS Flow control enable: 3463 - RTS/CTS Flow control enable:
3453 CONFIG_HWFLOW 3464 CONFIG_HWFLOW
3454 3465
3455 - Modem debug support: 3466 - Modem debug support:
3456 CONFIG_MODEM_SUPPORT_DEBUG 3467 CONFIG_MODEM_SUPPORT_DEBUG
3457 3468
3458 Enables debugging stuff (char screen[1024], dbg()) 3469 Enables debugging stuff (char screen[1024], dbg())
3459 for modem support. Useful only with BDI2000. 3470 for modem support. Useful only with BDI2000.
3460 3471
3461 - Interrupt support (PPC): 3472 - Interrupt support (PPC):
3462 3473
3463 There are common interrupt_init() and timer_interrupt() 3474 There are common interrupt_init() and timer_interrupt()
3464 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 3475 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
3465 for CPU specific initialization. interrupt_init_cpu() 3476 for CPU specific initialization. interrupt_init_cpu()
3466 should set decrementer_count to appropriate value. If 3477 should set decrementer_count to appropriate value. If
3467 CPU resets decrementer automatically after interrupt 3478 CPU resets decrementer automatically after interrupt
3468 (ppc4xx) it should set decrementer_count to zero. 3479 (ppc4xx) it should set decrementer_count to zero.
3469 timer_interrupt() calls timer_interrupt_cpu() for CPU 3480 timer_interrupt() calls timer_interrupt_cpu() for CPU
3470 specific handling. If board has watchdog / status_led 3481 specific handling. If board has watchdog / status_led
3471 / other_activity_monitor it works automatically from 3482 / other_activity_monitor it works automatically from
3472 general timer_interrupt(). 3483 general timer_interrupt().
3473 3484
3474 - General: 3485 - General:
3475 3486
3476 In the target system modem support is enabled when a 3487 In the target system modem support is enabled when a
3477 specific key (key combination) is pressed during 3488 specific key (key combination) is pressed during
3478 power-on. Otherwise U-Boot will boot normally 3489 power-on. Otherwise U-Boot will boot normally
3479 (autoboot). The key_pressed() function is called from 3490 (autoboot). The key_pressed() function is called from
3480 board_init(). Currently key_pressed() is a dummy 3491 board_init(). Currently key_pressed() is a dummy
3481 function, returning 1 and thus enabling modem 3492 function, returning 1 and thus enabling modem
3482 initialization. 3493 initialization.
3483 3494
3484 If there are no modem init strings in the 3495 If there are no modem init strings in the
3485 environment, U-Boot proceed to autoboot; the 3496 environment, U-Boot proceed to autoboot; the
3486 previous output (banner, info printfs) will be 3497 previous output (banner, info printfs) will be
3487 suppressed, though. 3498 suppressed, though.
3488 3499
3489 See also: doc/README.Modem 3500 See also: doc/README.Modem
3490 3501
3491 Board initialization settings: 3502 Board initialization settings:
3492 ------------------------------ 3503 ------------------------------
3493 3504
3494 During Initialization u-boot calls a number of board specific functions 3505 During Initialization u-boot calls a number of board specific functions
3495 to allow the preparation of board specific prerequisites, e.g. pin setup 3506 to allow the preparation of board specific prerequisites, e.g. pin setup
3496 before drivers are initialized. To enable these callbacks the 3507 before drivers are initialized. To enable these callbacks the
3497 following configuration macros have to be defined. Currently this is 3508 following configuration macros have to be defined. Currently this is
3498 architecture specific, so please check arch/your_architecture/lib/board.c 3509 architecture specific, so please check arch/your_architecture/lib/board.c
3499 typically in board_init_f() and board_init_r(). 3510 typically in board_init_f() and board_init_r().
3500 3511
3501 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 3512 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3502 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 3513 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3503 - CONFIG_BOARD_LATE_INIT: Call board_late_init() 3514 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
3504 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3515 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3505 3516
3506 Configuration Settings: 3517 Configuration Settings:
3507 ----------------------- 3518 -----------------------
3508 3519
3509 - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 3520 - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3510 Optionally it can be defined to support 64-bit memory commands. 3521 Optionally it can be defined to support 64-bit memory commands.
3511 3522
3512 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3523 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3513 undefine this when you're short of memory. 3524 undefine this when you're short of memory.
3514 3525
3515 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 3526 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3516 width of the commands listed in the 'help' command output. 3527 width of the commands listed in the 'help' command output.
3517 3528
3518 - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3529 - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
3519 prompt for user input. 3530 prompt for user input.
3520 3531
3521 - CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3532 - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
3522 3533
3523 - CONFIG_SYS_PBSIZE: Buffer size for Console output 3534 - CONFIG_SYS_PBSIZE: Buffer size for Console output
3524 3535
3525 - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3536 - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
3526 3537
3527 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3538 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3528 the application (usually a Linux kernel) when it is 3539 the application (usually a Linux kernel) when it is
3529 booted 3540 booted
3530 3541
3531 - CONFIG_SYS_BAUDRATE_TABLE: 3542 - CONFIG_SYS_BAUDRATE_TABLE:
3532 List of legal baudrate settings for this board. 3543 List of legal baudrate settings for this board.
3533 3544
3534 - CONFIG_SYS_CONSOLE_INFO_QUIET 3545 - CONFIG_SYS_CONSOLE_INFO_QUIET
3535 Suppress display of console information at boot. 3546 Suppress display of console information at boot.
3536 3547
3537 - CONFIG_SYS_CONSOLE_IS_IN_ENV 3548 - CONFIG_SYS_CONSOLE_IS_IN_ENV
3538 If the board specific function 3549 If the board specific function
3539 extern int overwrite_console (void); 3550 extern int overwrite_console (void);
3540 returns 1, the stdin, stderr and stdout are switched to the 3551 returns 1, the stdin, stderr and stdout are switched to the
3541 serial port, else the settings in the environment are used. 3552 serial port, else the settings in the environment are used.
3542 3553
3543 - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3554 - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3544 Enable the call to overwrite_console(). 3555 Enable the call to overwrite_console().
3545 3556
3546 - CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3557 - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3547 Enable overwrite of previous console environment settings. 3558 Enable overwrite of previous console environment settings.
3548 3559
3549 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3560 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3550 Begin and End addresses of the area used by the 3561 Begin and End addresses of the area used by the
3551 simple memory test. 3562 simple memory test.
3552 3563
3553 - CONFIG_SYS_ALT_MEMTEST: 3564 - CONFIG_SYS_ALT_MEMTEST:
3554 Enable an alternate, more extensive memory test. 3565 Enable an alternate, more extensive memory test.
3555 3566
3556 - CONFIG_SYS_MEMTEST_SCRATCH: 3567 - CONFIG_SYS_MEMTEST_SCRATCH:
3557 Scratch address used by the alternate memory test 3568 Scratch address used by the alternate memory test
3558 You only need to set this if address zero isn't writeable 3569 You only need to set this if address zero isn't writeable
3559 3570
3560 - CONFIG_SYS_MEM_TOP_HIDE (PPC only): 3571 - CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3561 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 3572 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3562 this specified memory area will get subtracted from the top 3573 this specified memory area will get subtracted from the top
3563 (end) of RAM and won't get "touched" at all by U-Boot. By 3574 (end) of RAM and won't get "touched" at all by U-Boot. By
3564 fixing up gd->ram_size the Linux kernel should gets passed 3575 fixing up gd->ram_size the Linux kernel should gets passed
3565 the now "corrected" memory size and won't touch it either. 3576 the now "corrected" memory size and won't touch it either.
3566 This should work for arch/ppc and arch/powerpc. Only Linux 3577 This should work for arch/ppc and arch/powerpc. Only Linux
3567 board ports in arch/powerpc with bootwrapper support that 3578 board ports in arch/powerpc with bootwrapper support that
3568 recalculate the memory size from the SDRAM controller setup 3579 recalculate the memory size from the SDRAM controller setup
3569 will have to get fixed in Linux additionally. 3580 will have to get fixed in Linux additionally.
3570 3581
3571 This option can be used as a workaround for the 440EPx/GRx 3582 This option can be used as a workaround for the 440EPx/GRx
3572 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 3583 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3573 be touched. 3584 be touched.
3574 3585
3575 WARNING: Please make sure that this value is a multiple of 3586 WARNING: Please make sure that this value is a multiple of
3576 the Linux page size (normally 4k). If this is not the case, 3587 the Linux page size (normally 4k). If this is not the case,
3577 then the end address of the Linux memory will be located at a 3588 then the end address of the Linux memory will be located at a
3578 non page size aligned address and this could cause major 3589 non page size aligned address and this could cause major
3579 problems. 3590 problems.
3580 3591
3581 - CONFIG_SYS_LOADS_BAUD_CHANGE: 3592 - CONFIG_SYS_LOADS_BAUD_CHANGE:
3582 Enable temporary baudrate change while serial download 3593 Enable temporary baudrate change while serial download
3583 3594
3584 - CONFIG_SYS_SDRAM_BASE: 3595 - CONFIG_SYS_SDRAM_BASE:
3585 Physical start address of SDRAM. _Must_ be 0 here. 3596 Physical start address of SDRAM. _Must_ be 0 here.
3586 3597
3587 - CONFIG_SYS_MBIO_BASE: 3598 - CONFIG_SYS_MBIO_BASE:
3588 Physical start address of Motherboard I/O (if using a 3599 Physical start address of Motherboard I/O (if using a
3589 Cogent motherboard) 3600 Cogent motherboard)
3590 3601
3591 - CONFIG_SYS_FLASH_BASE: 3602 - CONFIG_SYS_FLASH_BASE:
3592 Physical start address of Flash memory. 3603 Physical start address of Flash memory.
3593 3604
3594 - CONFIG_SYS_MONITOR_BASE: 3605 - CONFIG_SYS_MONITOR_BASE:
3595 Physical start address of boot monitor code (set by 3606 Physical start address of boot monitor code (set by
3596 make config files to be same as the text base address 3607 make config files to be same as the text base address
3597 (CONFIG_SYS_TEXT_BASE) used when linking) - same as 3608 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
3598 CONFIG_SYS_FLASH_BASE when booting from flash. 3609 CONFIG_SYS_FLASH_BASE when booting from flash.
3599 3610
3600 - CONFIG_SYS_MONITOR_LEN: 3611 - CONFIG_SYS_MONITOR_LEN:
3601 Size of memory reserved for monitor code, used to 3612 Size of memory reserved for monitor code, used to
3602 determine _at_compile_time_ (!) if the environment is 3613 determine _at_compile_time_ (!) if the environment is
3603 embedded within the U-Boot image, or in a separate 3614 embedded within the U-Boot image, or in a separate
3604 flash sector. 3615 flash sector.
3605 3616
3606 - CONFIG_SYS_MALLOC_LEN: 3617 - CONFIG_SYS_MALLOC_LEN:
3607 Size of DRAM reserved for malloc() use. 3618 Size of DRAM reserved for malloc() use.
3608 3619
3609 - CONFIG_SYS_BOOTM_LEN: 3620 - CONFIG_SYS_BOOTM_LEN:
3610 Normally compressed uImages are limited to an 3621 Normally compressed uImages are limited to an
3611 uncompressed size of 8 MBytes. If this is not enough, 3622 uncompressed size of 8 MBytes. If this is not enough,
3612 you can define CONFIG_SYS_BOOTM_LEN in your board config file 3623 you can define CONFIG_SYS_BOOTM_LEN in your board config file
3613 to adjust this setting to your needs. 3624 to adjust this setting to your needs.
3614 3625
3615 - CONFIG_SYS_BOOTMAPSZ: 3626 - CONFIG_SYS_BOOTMAPSZ:
3616 Maximum size of memory mapped by the startup code of 3627 Maximum size of memory mapped by the startup code of
3617 the Linux kernel; all data that must be processed by 3628 the Linux kernel; all data that must be processed by
3618 the Linux kernel (bd_info, boot arguments, FDT blob if 3629 the Linux kernel (bd_info, boot arguments, FDT blob if
3619 used) must be put below this limit, unless "bootm_low" 3630 used) must be put below this limit, unless "bootm_low"
3620 environment variable is defined and non-zero. In such case 3631 environment variable is defined and non-zero. In such case
3621 all data for the Linux kernel must be between "bootm_low" 3632 all data for the Linux kernel must be between "bootm_low"
3622 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3633 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
3623 variable "bootm_mapsize" will override the value of 3634 variable "bootm_mapsize" will override the value of
3624 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3635 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3625 then the value in "bootm_size" will be used instead. 3636 then the value in "bootm_size" will be used instead.
3626 3637
3627 - CONFIG_SYS_BOOT_RAMDISK_HIGH: 3638 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
3628 Enable initrd_high functionality. If defined then the 3639 Enable initrd_high functionality. If defined then the
3629 initrd_high feature is enabled and the bootm ramdisk subcommand 3640 initrd_high feature is enabled and the bootm ramdisk subcommand
3630 is enabled. 3641 is enabled.
3631 3642
3632 - CONFIG_SYS_BOOT_GET_CMDLINE: 3643 - CONFIG_SYS_BOOT_GET_CMDLINE:
3633 Enables allocating and saving kernel cmdline in space between 3644 Enables allocating and saving kernel cmdline in space between
3634 "bootm_low" and "bootm_low" + BOOTMAPSZ. 3645 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3635 3646
3636 - CONFIG_SYS_BOOT_GET_KBD: 3647 - CONFIG_SYS_BOOT_GET_KBD:
3637 Enables allocating and saving a kernel copy of the bd_info in 3648 Enables allocating and saving a kernel copy of the bd_info in
3638 space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3649 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3639 3650
3640 - CONFIG_SYS_MAX_FLASH_BANKS: 3651 - CONFIG_SYS_MAX_FLASH_BANKS:
3641 Max number of Flash memory banks 3652 Max number of Flash memory banks
3642 3653
3643 - CONFIG_SYS_MAX_FLASH_SECT: 3654 - CONFIG_SYS_MAX_FLASH_SECT:
3644 Max number of sectors on a Flash chip 3655 Max number of sectors on a Flash chip
3645 3656
3646 - CONFIG_SYS_FLASH_ERASE_TOUT: 3657 - CONFIG_SYS_FLASH_ERASE_TOUT:
3647 Timeout for Flash erase operations (in ms) 3658 Timeout for Flash erase operations (in ms)
3648 3659
3649 - CONFIG_SYS_FLASH_WRITE_TOUT: 3660 - CONFIG_SYS_FLASH_WRITE_TOUT:
3650 Timeout for Flash write operations (in ms) 3661 Timeout for Flash write operations (in ms)
3651 3662
3652 - CONFIG_SYS_FLASH_LOCK_TOUT 3663 - CONFIG_SYS_FLASH_LOCK_TOUT
3653 Timeout for Flash set sector lock bit operation (in ms) 3664 Timeout for Flash set sector lock bit operation (in ms)
3654 3665
3655 - CONFIG_SYS_FLASH_UNLOCK_TOUT 3666 - CONFIG_SYS_FLASH_UNLOCK_TOUT
3656 Timeout for Flash clear lock bits operation (in ms) 3667 Timeout for Flash clear lock bits operation (in ms)
3657 3668
3658 - CONFIG_SYS_FLASH_PROTECTION 3669 - CONFIG_SYS_FLASH_PROTECTION
3659 If defined, hardware flash sectors protection is used 3670 If defined, hardware flash sectors protection is used
3660 instead of U-Boot software protection. 3671 instead of U-Boot software protection.
3661 3672
3662 - CONFIG_SYS_DIRECT_FLASH_TFTP: 3673 - CONFIG_SYS_DIRECT_FLASH_TFTP:
3663 3674
3664 Enable TFTP transfers directly to flash memory; 3675 Enable TFTP transfers directly to flash memory;
3665 without this option such a download has to be 3676 without this option such a download has to be
3666 performed in two steps: (1) download to RAM, and (2) 3677 performed in two steps: (1) download to RAM, and (2)
3667 copy from RAM to flash. 3678 copy from RAM to flash.
3668 3679
3669 The two-step approach is usually more reliable, since 3680 The two-step approach is usually more reliable, since
3670 you can check if the download worked before you erase 3681 you can check if the download worked before you erase
3671 the flash, but in some situations (when system RAM is 3682 the flash, but in some situations (when system RAM is
3672 too limited to allow for a temporary copy of the 3683 too limited to allow for a temporary copy of the
3673 downloaded image) this option may be very useful. 3684 downloaded image) this option may be very useful.
3674 3685
3675 - CONFIG_SYS_FLASH_CFI: 3686 - CONFIG_SYS_FLASH_CFI:
3676 Define if the flash driver uses extra elements in the 3687 Define if the flash driver uses extra elements in the
3677 common flash structure for storing flash geometry. 3688 common flash structure for storing flash geometry.
3678 3689
3679 - CONFIG_FLASH_CFI_DRIVER 3690 - CONFIG_FLASH_CFI_DRIVER
3680 This option also enables the building of the cfi_flash driver 3691 This option also enables the building of the cfi_flash driver
3681 in the drivers directory 3692 in the drivers directory
3682 3693
3683 - CONFIG_FLASH_CFI_MTD 3694 - CONFIG_FLASH_CFI_MTD
3684 This option enables the building of the cfi_mtd driver 3695 This option enables the building of the cfi_mtd driver
3685 in the drivers directory. The driver exports CFI flash 3696 in the drivers directory. The driver exports CFI flash
3686 to the MTD layer. 3697 to the MTD layer.
3687 3698
3688 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE 3699 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3689 Use buffered writes to flash. 3700 Use buffered writes to flash.
3690 3701
3691 - CONFIG_FLASH_SPANSION_S29WS_N 3702 - CONFIG_FLASH_SPANSION_S29WS_N
3692 s29ws-n MirrorBit flash has non-standard addresses for buffered 3703 s29ws-n MirrorBit flash has non-standard addresses for buffered
3693 write commands. 3704 write commands.
3694 3705
3695 - CONFIG_SYS_FLASH_QUIET_TEST 3706 - CONFIG_SYS_FLASH_QUIET_TEST
3696 If this option is defined, the common CFI flash doesn't 3707 If this option is defined, the common CFI flash doesn't
3697 print it's warning upon not recognized FLASH banks. This 3708 print it's warning upon not recognized FLASH banks. This
3698 is useful, if some of the configured banks are only 3709 is useful, if some of the configured banks are only
3699 optionally available. 3710 optionally available.
3700 3711
3701 - CONFIG_FLASH_SHOW_PROGRESS 3712 - CONFIG_FLASH_SHOW_PROGRESS
3702 If defined (must be an integer), print out countdown 3713 If defined (must be an integer), print out countdown
3703 digits and dots. Recommended value: 45 (9..1) for 80 3714 digits and dots. Recommended value: 45 (9..1) for 80
3704 column displays, 15 (3..1) for 40 column displays. 3715 column displays, 15 (3..1) for 40 column displays.
3705 3716
3706 - CONFIG_FLASH_VERIFY 3717 - CONFIG_FLASH_VERIFY
3707 If defined, the content of the flash (destination) is compared 3718 If defined, the content of the flash (destination) is compared
3708 against the source after the write operation. An error message 3719 against the source after the write operation. An error message
3709 will be printed when the contents are not identical. 3720 will be printed when the contents are not identical.
3710 Please note that this option is useless in nearly all cases, 3721 Please note that this option is useless in nearly all cases,
3711 since such flash programming errors usually are detected earlier 3722 since such flash programming errors usually are detected earlier
3712 while unprotecting/erasing/programming. Please only enable 3723 while unprotecting/erasing/programming. Please only enable
3713 this option if you really know what you are doing. 3724 this option if you really know what you are doing.
3714 3725
3715 - CONFIG_SYS_RX_ETH_BUFFER: 3726 - CONFIG_SYS_RX_ETH_BUFFER:
3716 Defines the number of Ethernet receive buffers. On some 3727 Defines the number of Ethernet receive buffers. On some
3717 Ethernet controllers it is recommended to set this value 3728 Ethernet controllers it is recommended to set this value
3718 to 8 or even higher (EEPRO100 or 405 EMAC), since all 3729 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3719 buffers can be full shortly after enabling the interface 3730 buffers can be full shortly after enabling the interface
3720 on high Ethernet traffic. 3731 on high Ethernet traffic.
3721 Defaults to 4 if not defined. 3732 Defaults to 4 if not defined.
3722 3733
3723 - CONFIG_ENV_MAX_ENTRIES 3734 - CONFIG_ENV_MAX_ENTRIES
3724 3735
3725 Maximum number of entries in the hash table that is used 3736 Maximum number of entries in the hash table that is used
3726 internally to store the environment settings. The default 3737 internally to store the environment settings. The default
3727 setting is supposed to be generous and should work in most 3738 setting is supposed to be generous and should work in most
3728 cases. This setting can be used to tune behaviour; see 3739 cases. This setting can be used to tune behaviour; see
3729 lib/hashtable.c for details. 3740 lib/hashtable.c for details.
3730 3741
3731 - CONFIG_ENV_FLAGS_LIST_DEFAULT 3742 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3732 - CONFIG_ENV_FLAGS_LIST_STATIC 3743 - CONFIG_ENV_FLAGS_LIST_STATIC
3733 Enable validation of the values given to environment variables when 3744 Enable validation of the values given to environment variables when
3734 calling env set. Variables can be restricted to only decimal, 3745 calling env set. Variables can be restricted to only decimal,
3735 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 3746 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3736 the variables can also be restricted to IP address or MAC address. 3747 the variables can also be restricted to IP address or MAC address.
3737 3748
3738 The format of the list is: 3749 The format of the list is:
3739 type_attribute = [s|d|x|b|i|m] 3750 type_attribute = [s|d|x|b|i|m]
3740 access_atribute = [a|r|o|c] 3751 access_atribute = [a|r|o|c]
3741 attributes = type_attribute[access_atribute] 3752 attributes = type_attribute[access_atribute]
3742 entry = variable_name[:attributes] 3753 entry = variable_name[:attributes]
3743 list = entry[,list] 3754 list = entry[,list]
3744 3755
3745 The type attributes are: 3756 The type attributes are:
3746 s - String (default) 3757 s - String (default)
3747 d - Decimal 3758 d - Decimal
3748 x - Hexadecimal 3759 x - Hexadecimal
3749 b - Boolean ([1yYtT|0nNfF]) 3760 b - Boolean ([1yYtT|0nNfF])
3750 i - IP address 3761 i - IP address
3751 m - MAC address 3762 m - MAC address
3752 3763
3753 The access attributes are: 3764 The access attributes are:
3754 a - Any (default) 3765 a - Any (default)
3755 r - Read-only 3766 r - Read-only
3756 o - Write-once 3767 o - Write-once
3757 c - Change-default 3768 c - Change-default
3758 3769
3759 - CONFIG_ENV_FLAGS_LIST_DEFAULT 3770 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3760 Define this to a list (string) to define the ".flags" 3771 Define this to a list (string) to define the ".flags"
3761 envirnoment variable in the default or embedded environment. 3772 envirnoment variable in the default or embedded environment.
3762 3773
3763 - CONFIG_ENV_FLAGS_LIST_STATIC 3774 - CONFIG_ENV_FLAGS_LIST_STATIC
3764 Define this to a list (string) to define validation that 3775 Define this to a list (string) to define validation that
3765 should be done if an entry is not found in the ".flags" 3776 should be done if an entry is not found in the ".flags"
3766 environment variable. To override a setting in the static 3777 environment variable. To override a setting in the static
3767 list, simply add an entry for the same variable name to the 3778 list, simply add an entry for the same variable name to the
3768 ".flags" variable. 3779 ".flags" variable.
3769 3780
3770 - CONFIG_ENV_ACCESS_IGNORE_FORCE 3781 - CONFIG_ENV_ACCESS_IGNORE_FORCE
3771 If defined, don't allow the -f switch to env set override variable 3782 If defined, don't allow the -f switch to env set override variable
3772 access flags. 3783 access flags.
3773 3784
3774 - CONFIG_SYS_GENERIC_BOARD 3785 - CONFIG_SYS_GENERIC_BOARD
3775 This selects the architecture-generic board system instead of the 3786 This selects the architecture-generic board system instead of the
3776 architecture-specific board files. It is intended to move boards 3787 architecture-specific board files. It is intended to move boards
3777 to this new framework over time. Defining this will disable the 3788 to this new framework over time. Defining this will disable the
3778 arch/foo/lib/board.c file and use common/board_f.c and 3789 arch/foo/lib/board.c file and use common/board_f.c and
3779 common/board_r.c instead. To use this option your architecture 3790 common/board_r.c instead. To use this option your architecture
3780 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 3791 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3781 its config.mk file). If you find problems enabling this option on 3792 its config.mk file). If you find problems enabling this option on
3782 your board please report the problem and send patches! 3793 your board please report the problem and send patches!
3783 3794
3784 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 3795 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3785 This is set by OMAP boards for the max time that reset should 3796 This is set by OMAP boards for the max time that reset should
3786 be asserted. See doc/README.omap-reset-time for details on how 3797 be asserted. See doc/README.omap-reset-time for details on how
3787 the value can be calulated on a given board. 3798 the value can be calulated on a given board.
3788 3799
3789 The following definitions that deal with the placement and management 3800 The following definitions that deal with the placement and management
3790 of environment data (variable area); in general, we support the 3801 of environment data (variable area); in general, we support the
3791 following configurations: 3802 following configurations:
3792 3803
3793 - CONFIG_BUILD_ENVCRC: 3804 - CONFIG_BUILD_ENVCRC:
3794 3805
3795 Builds up envcrc with the target environment so that external utils 3806 Builds up envcrc with the target environment so that external utils
3796 may easily extract it and embed it in final U-Boot images. 3807 may easily extract it and embed it in final U-Boot images.
3797 3808
3798 - CONFIG_ENV_IS_IN_FLASH: 3809 - CONFIG_ENV_IS_IN_FLASH:
3799 3810
3800 Define this if the environment is in flash memory. 3811 Define this if the environment is in flash memory.
3801 3812
3802 a) The environment occupies one whole flash sector, which is 3813 a) The environment occupies one whole flash sector, which is
3803 "embedded" in the text segment with the U-Boot code. This 3814 "embedded" in the text segment with the U-Boot code. This
3804 happens usually with "bottom boot sector" or "top boot 3815 happens usually with "bottom boot sector" or "top boot
3805 sector" type flash chips, which have several smaller 3816 sector" type flash chips, which have several smaller
3806 sectors at the start or the end. For instance, such a 3817 sectors at the start or the end. For instance, such a
3807 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3818 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3808 such a case you would place the environment in one of the 3819 such a case you would place the environment in one of the
3809 4 kB sectors - with U-Boot code before and after it. With 3820 4 kB sectors - with U-Boot code before and after it. With
3810 "top boot sector" type flash chips, you would put the 3821 "top boot sector" type flash chips, you would put the
3811 environment in one of the last sectors, leaving a gap 3822 environment in one of the last sectors, leaving a gap
3812 between U-Boot and the environment. 3823 between U-Boot and the environment.
3813 3824
3814 - CONFIG_ENV_OFFSET: 3825 - CONFIG_ENV_OFFSET:
3815 3826
3816 Offset of environment data (variable area) to the 3827 Offset of environment data (variable area) to the
3817 beginning of flash memory; for instance, with bottom boot 3828 beginning of flash memory; for instance, with bottom boot
3818 type flash chips the second sector can be used: the offset 3829 type flash chips the second sector can be used: the offset
3819 for this sector is given here. 3830 for this sector is given here.
3820 3831
3821 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3832 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3822 3833
3823 - CONFIG_ENV_ADDR: 3834 - CONFIG_ENV_ADDR:
3824 3835
3825 This is just another way to specify the start address of 3836 This is just another way to specify the start address of
3826 the flash sector containing the environment (instead of 3837 the flash sector containing the environment (instead of
3827 CONFIG_ENV_OFFSET). 3838 CONFIG_ENV_OFFSET).
3828 3839
3829 - CONFIG_ENV_SECT_SIZE: 3840 - CONFIG_ENV_SECT_SIZE:
3830 3841
3831 Size of the sector containing the environment. 3842 Size of the sector containing the environment.
3832 3843
3833 3844
3834 b) Sometimes flash chips have few, equal sized, BIG sectors. 3845 b) Sometimes flash chips have few, equal sized, BIG sectors.
3835 In such a case you don't want to spend a whole sector for 3846 In such a case you don't want to spend a whole sector for
3836 the environment. 3847 the environment.
3837 3848
3838 - CONFIG_ENV_SIZE: 3849 - CONFIG_ENV_SIZE:
3839 3850
3840 If you use this in combination with CONFIG_ENV_IS_IN_FLASH 3851 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
3841 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3852 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3842 of this flash sector for the environment. This saves 3853 of this flash sector for the environment. This saves
3843 memory for the RAM copy of the environment. 3854 memory for the RAM copy of the environment.
3844 3855
3845 It may also save flash memory if you decide to use this 3856 It may also save flash memory if you decide to use this
3846 when your environment is "embedded" within U-Boot code, 3857 when your environment is "embedded" within U-Boot code,
3847 since then the remainder of the flash sector could be used 3858 since then the remainder of the flash sector could be used
3848 for U-Boot code. It should be pointed out that this is 3859 for U-Boot code. It should be pointed out that this is
3849 STRONGLY DISCOURAGED from a robustness point of view: 3860 STRONGLY DISCOURAGED from a robustness point of view:
3850 updating the environment in flash makes it always 3861 updating the environment in flash makes it always
3851 necessary to erase the WHOLE sector. If something goes 3862 necessary to erase the WHOLE sector. If something goes
3852 wrong before the contents has been restored from a copy in 3863 wrong before the contents has been restored from a copy in
3853 RAM, your target system will be dead. 3864 RAM, your target system will be dead.
3854 3865
3855 - CONFIG_ENV_ADDR_REDUND 3866 - CONFIG_ENV_ADDR_REDUND
3856 CONFIG_ENV_SIZE_REDUND 3867 CONFIG_ENV_SIZE_REDUND
3857 3868
3858 These settings describe a second storage area used to hold 3869 These settings describe a second storage area used to hold
3859 a redundant copy of the environment data, so that there is 3870 a redundant copy of the environment data, so that there is
3860 a valid backup copy in case there is a power failure during 3871 a valid backup copy in case there is a power failure during
3861 a "saveenv" operation. 3872 a "saveenv" operation.
3862 3873
3863 BE CAREFUL! Any changes to the flash layout, and some changes to the 3874 BE CAREFUL! Any changes to the flash layout, and some changes to the
3864 source code will make it necessary to adapt <board>/u-boot.lds* 3875 source code will make it necessary to adapt <board>/u-boot.lds*
3865 accordingly! 3876 accordingly!
3866 3877
3867 3878
3868 - CONFIG_ENV_IS_IN_NVRAM: 3879 - CONFIG_ENV_IS_IN_NVRAM:
3869 3880
3870 Define this if you have some non-volatile memory device 3881 Define this if you have some non-volatile memory device
3871 (NVRAM, battery buffered SRAM) which you want to use for the 3882 (NVRAM, battery buffered SRAM) which you want to use for the
3872 environment. 3883 environment.
3873 3884
3874 - CONFIG_ENV_ADDR: 3885 - CONFIG_ENV_ADDR:
3875 - CONFIG_ENV_SIZE: 3886 - CONFIG_ENV_SIZE:
3876 3887
3877 These two #defines are used to determine the memory area you 3888 These two #defines are used to determine the memory area you
3878 want to use for environment. It is assumed that this memory 3889 want to use for environment. It is assumed that this memory
3879 can just be read and written to, without any special 3890 can just be read and written to, without any special
3880 provision. 3891 provision.
3881 3892
3882 BE CAREFUL! The first access to the environment happens quite early 3893 BE CAREFUL! The first access to the environment happens quite early
3883 in U-Boot initalization (when we try to get the setting of for the 3894 in U-Boot initalization (when we try to get the setting of for the
3884 console baudrate). You *MUST* have mapped your NVRAM area then, or 3895 console baudrate). You *MUST* have mapped your NVRAM area then, or
3885 U-Boot will hang. 3896 U-Boot will hang.
3886 3897
3887 Please note that even with NVRAM we still use a copy of the 3898 Please note that even with NVRAM we still use a copy of the
3888 environment in RAM: we could work on NVRAM directly, but we want to 3899 environment in RAM: we could work on NVRAM directly, but we want to
3889 keep settings there always unmodified except somebody uses "saveenv" 3900 keep settings there always unmodified except somebody uses "saveenv"
3890 to save the current settings. 3901 to save the current settings.
3891 3902
3892 3903
3893 - CONFIG_ENV_IS_IN_EEPROM: 3904 - CONFIG_ENV_IS_IN_EEPROM:
3894 3905
3895 Use this if you have an EEPROM or similar serial access 3906 Use this if you have an EEPROM or similar serial access
3896 device and a driver for it. 3907 device and a driver for it.
3897 3908
3898 - CONFIG_ENV_OFFSET: 3909 - CONFIG_ENV_OFFSET:
3899 - CONFIG_ENV_SIZE: 3910 - CONFIG_ENV_SIZE:
3900 3911
3901 These two #defines specify the offset and size of the 3912 These two #defines specify the offset and size of the
3902 environment area within the total memory of your EEPROM. 3913 environment area within the total memory of your EEPROM.
3903 3914
3904 - CONFIG_SYS_I2C_EEPROM_ADDR: 3915 - CONFIG_SYS_I2C_EEPROM_ADDR:
3905 If defined, specified the chip address of the EEPROM device. 3916 If defined, specified the chip address of the EEPROM device.
3906 The default address is zero. 3917 The default address is zero.
3907 3918
3908 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3919 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3909 If defined, the number of bits used to address bytes in a 3920 If defined, the number of bits used to address bytes in a
3910 single page in the EEPROM device. A 64 byte page, for example 3921 single page in the EEPROM device. A 64 byte page, for example
3911 would require six bits. 3922 would require six bits.
3912 3923
3913 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3924 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3914 If defined, the number of milliseconds to delay between 3925 If defined, the number of milliseconds to delay between
3915 page writes. The default is zero milliseconds. 3926 page writes. The default is zero milliseconds.
3916 3927
3917 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3928 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3918 The length in bytes of the EEPROM memory array address. Note 3929 The length in bytes of the EEPROM memory array address. Note
3919 that this is NOT the chip address length! 3930 that this is NOT the chip address length!
3920 3931
3921 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 3932 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
3922 EEPROM chips that implement "address overflow" are ones 3933 EEPROM chips that implement "address overflow" are ones
3923 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 3934 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3924 address and the extra bits end up in the "chip address" bit 3935 address and the extra bits end up in the "chip address" bit
3925 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 3936 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3926 byte chips. 3937 byte chips.
3927 3938
3928 Note that we consider the length of the address field to 3939 Note that we consider the length of the address field to
3929 still be one byte because the extra address bits are hidden 3940 still be one byte because the extra address bits are hidden
3930 in the chip address. 3941 in the chip address.
3931 3942
3932 - CONFIG_SYS_EEPROM_SIZE: 3943 - CONFIG_SYS_EEPROM_SIZE:
3933 The size in bytes of the EEPROM device. 3944 The size in bytes of the EEPROM device.
3934 3945
3935 - CONFIG_ENV_EEPROM_IS_ON_I2C 3946 - CONFIG_ENV_EEPROM_IS_ON_I2C
3936 define this, if you have I2C and SPI activated, and your 3947 define this, if you have I2C and SPI activated, and your
3937 EEPROM, which holds the environment, is on the I2C bus. 3948 EEPROM, which holds the environment, is on the I2C bus.
3938 3949
3939 - CONFIG_I2C_ENV_EEPROM_BUS 3950 - CONFIG_I2C_ENV_EEPROM_BUS
3940 if you have an Environment on an EEPROM reached over 3951 if you have an Environment on an EEPROM reached over
3941 I2C muxes, you can define here, how to reach this 3952 I2C muxes, you can define here, how to reach this
3942 EEPROM. For example: 3953 EEPROM. For example:
3943 3954
3944 #define CONFIG_I2C_ENV_EEPROM_BUS 1 3955 #define CONFIG_I2C_ENV_EEPROM_BUS 1
3945 3956
3946 EEPROM which holds the environment, is reached over 3957 EEPROM which holds the environment, is reached over
3947 a pca9547 i2c mux with address 0x70, channel 3. 3958 a pca9547 i2c mux with address 0x70, channel 3.
3948 3959
3949 - CONFIG_ENV_IS_IN_DATAFLASH: 3960 - CONFIG_ENV_IS_IN_DATAFLASH:
3950 3961
3951 Define this if you have a DataFlash memory device which you 3962 Define this if you have a DataFlash memory device which you
3952 want to use for the environment. 3963 want to use for the environment.
3953 3964
3954 - CONFIG_ENV_OFFSET: 3965 - CONFIG_ENV_OFFSET:
3955 - CONFIG_ENV_ADDR: 3966 - CONFIG_ENV_ADDR:
3956 - CONFIG_ENV_SIZE: 3967 - CONFIG_ENV_SIZE:
3957 3968
3958 These three #defines specify the offset and size of the 3969 These three #defines specify the offset and size of the
3959 environment area within the total memory of your DataFlash placed 3970 environment area within the total memory of your DataFlash placed
3960 at the specified address. 3971 at the specified address.
3961 3972
3962 - CONFIG_ENV_IS_IN_REMOTE: 3973 - CONFIG_ENV_IS_IN_REMOTE:
3963 3974
3964 Define this if you have a remote memory space which you 3975 Define this if you have a remote memory space which you
3965 want to use for the local device's environment. 3976 want to use for the local device's environment.
3966 3977
3967 - CONFIG_ENV_ADDR: 3978 - CONFIG_ENV_ADDR:
3968 - CONFIG_ENV_SIZE: 3979 - CONFIG_ENV_SIZE:
3969 3980
3970 These two #defines specify the address and size of the 3981 These two #defines specify the address and size of the
3971 environment area within the remote memory space. The 3982 environment area within the remote memory space. The
3972 local device can get the environment from remote memory 3983 local device can get the environment from remote memory
3973 space by SRIO or PCIE links. 3984 space by SRIO or PCIE links.
3974 3985
3975 BE CAREFUL! For some special cases, the local device can not use 3986 BE CAREFUL! For some special cases, the local device can not use
3976 "saveenv" command. For example, the local device will get the 3987 "saveenv" command. For example, the local device will get the
3977 environment stored in a remote NOR flash by SRIO or PCIE link, 3988 environment stored in a remote NOR flash by SRIO or PCIE link,
3978 but it can not erase, write this NOR flash by SRIO or PCIE interface. 3989 but it can not erase, write this NOR flash by SRIO or PCIE interface.
3979 3990
3980 - CONFIG_ENV_IS_IN_NAND: 3991 - CONFIG_ENV_IS_IN_NAND:
3981 3992
3982 Define this if you have a NAND device which you want to use 3993 Define this if you have a NAND device which you want to use
3983 for the environment. 3994 for the environment.
3984 3995
3985 - CONFIG_ENV_OFFSET: 3996 - CONFIG_ENV_OFFSET:
3986 - CONFIG_ENV_SIZE: 3997 - CONFIG_ENV_SIZE:
3987 3998
3988 These two #defines specify the offset and size of the environment 3999 These two #defines specify the offset and size of the environment
3989 area within the first NAND device. CONFIG_ENV_OFFSET must be 4000 area within the first NAND device. CONFIG_ENV_OFFSET must be
3990 aligned to an erase block boundary. 4001 aligned to an erase block boundary.
3991 4002
3992 - CONFIG_ENV_OFFSET_REDUND (optional): 4003 - CONFIG_ENV_OFFSET_REDUND (optional):
3993 4004
3994 This setting describes a second storage area of CONFIG_ENV_SIZE 4005 This setting describes a second storage area of CONFIG_ENV_SIZE
3995 size used to hold a redundant copy of the environment data, so 4006 size used to hold a redundant copy of the environment data, so
3996 that there is a valid backup copy in case there is a power failure 4007 that there is a valid backup copy in case there is a power failure
3997 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4008 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
3998 aligned to an erase block boundary. 4009 aligned to an erase block boundary.
3999 4010
4000 - CONFIG_ENV_RANGE (optional): 4011 - CONFIG_ENV_RANGE (optional):
4001 4012
4002 Specifies the length of the region in which the environment 4013 Specifies the length of the region in which the environment
4003 can be written. This should be a multiple of the NAND device's 4014 can be written. This should be a multiple of the NAND device's
4004 block size. Specifying a range with more erase blocks than 4015 block size. Specifying a range with more erase blocks than
4005 are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4016 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4006 the range to be avoided. 4017 the range to be avoided.
4007 4018
4008 - CONFIG_ENV_OFFSET_OOB (optional): 4019 - CONFIG_ENV_OFFSET_OOB (optional):
4009 4020
4010 Enables support for dynamically retrieving the offset of the 4021 Enables support for dynamically retrieving the offset of the
4011 environment from block zero's out-of-band data. The 4022 environment from block zero's out-of-band data. The
4012 "nand env.oob" command can be used to record this offset. 4023 "nand env.oob" command can be used to record this offset.
4013 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4024 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4014 using CONFIG_ENV_OFFSET_OOB. 4025 using CONFIG_ENV_OFFSET_OOB.
4015 4026
4016 - CONFIG_NAND_ENV_DST 4027 - CONFIG_NAND_ENV_DST
4017 4028
4018 Defines address in RAM to which the nand_spl code should copy the 4029 Defines address in RAM to which the nand_spl code should copy the
4019 environment. If redundant environment is used, it will be copied to 4030 environment. If redundant environment is used, it will be copied to
4020 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4031 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4021 4032
4022 - CONFIG_ENV_IS_IN_UBI: 4033 - CONFIG_ENV_IS_IN_UBI:
4023 4034
4024 Define this if you have an UBI volume that you want to use for the 4035 Define this if you have an UBI volume that you want to use for the
4025 environment. This has the benefit of wear-leveling the environment 4036 environment. This has the benefit of wear-leveling the environment
4026 accesses, which is important on NAND. 4037 accesses, which is important on NAND.
4027 4038
4028 - CONFIG_ENV_UBI_PART: 4039 - CONFIG_ENV_UBI_PART:
4029 4040
4030 Define this to a string that is the mtd partition containing the UBI. 4041 Define this to a string that is the mtd partition containing the UBI.
4031 4042
4032 - CONFIG_ENV_UBI_VOLUME: 4043 - CONFIG_ENV_UBI_VOLUME:
4033 4044
4034 Define this to the name of the volume that you want to store the 4045 Define this to the name of the volume that you want to store the
4035 environment in. 4046 environment in.
4036 4047
4037 - CONFIG_ENV_UBI_VOLUME_REDUND: 4048 - CONFIG_ENV_UBI_VOLUME_REDUND:
4038 4049
4039 Define this to the name of another volume to store a second copy of 4050 Define this to the name of another volume to store a second copy of
4040 the environment in. This will enable redundant environments in UBI. 4051 the environment in. This will enable redundant environments in UBI.
4041 It is assumed that both volumes are in the same MTD partition. 4052 It is assumed that both volumes are in the same MTD partition.
4042 4053
4043 - CONFIG_UBI_SILENCE_MSG 4054 - CONFIG_UBI_SILENCE_MSG
4044 - CONFIG_UBIFS_SILENCE_MSG 4055 - CONFIG_UBIFS_SILENCE_MSG
4045 4056
4046 You will probably want to define these to avoid a really noisy system 4057 You will probably want to define these to avoid a really noisy system
4047 when storing the env in UBI. 4058 when storing the env in UBI.
4048 4059
4049 - CONFIG_ENV_IS_IN_MMC: 4060 - CONFIG_ENV_IS_IN_MMC:
4050 4061
4051 Define this if you have an MMC device which you want to use for the 4062 Define this if you have an MMC device which you want to use for the
4052 environment. 4063 environment.
4053 4064
4054 - CONFIG_SYS_MMC_ENV_DEV: 4065 - CONFIG_SYS_MMC_ENV_DEV:
4055 4066
4056 Specifies which MMC device the environment is stored in. 4067 Specifies which MMC device the environment is stored in.
4057 4068
4058 - CONFIG_SYS_MMC_ENV_PART (optional): 4069 - CONFIG_SYS_MMC_ENV_PART (optional):
4059 4070
4060 Specifies which MMC partition the environment is stored in. If not 4071 Specifies which MMC partition the environment is stored in. If not
4061 set, defaults to partition 0, the user area. Common values might be 4072 set, defaults to partition 0, the user area. Common values might be
4062 1 (first MMC boot partition), 2 (second MMC boot partition). 4073 1 (first MMC boot partition), 2 (second MMC boot partition).
4063 4074
4064 - CONFIG_ENV_OFFSET: 4075 - CONFIG_ENV_OFFSET:
4065 - CONFIG_ENV_SIZE: 4076 - CONFIG_ENV_SIZE:
4066 4077
4067 These two #defines specify the offset and size of the environment 4078 These two #defines specify the offset and size of the environment
4068 area within the specified MMC device. 4079 area within the specified MMC device.
4069 4080
4070 If offset is positive (the usual case), it is treated as relative to 4081 If offset is positive (the usual case), it is treated as relative to
4071 the start of the MMC partition. If offset is negative, it is treated 4082 the start of the MMC partition. If offset is negative, it is treated
4072 as relative to the end of the MMC partition. This can be useful if 4083 as relative to the end of the MMC partition. This can be useful if
4073 your board may be fitted with different MMC devices, which have 4084 your board may be fitted with different MMC devices, which have
4074 different sizes for the MMC partitions, and you always want the 4085 different sizes for the MMC partitions, and you always want the
4075 environment placed at the very end of the partition, to leave the 4086 environment placed at the very end of the partition, to leave the
4076 maximum possible space before it, to store other data. 4087 maximum possible space before it, to store other data.
4077 4088
4078 These two values are in units of bytes, but must be aligned to an 4089 These two values are in units of bytes, but must be aligned to an
4079 MMC sector boundary. 4090 MMC sector boundary.
4080 4091
4081 - CONFIG_ENV_OFFSET_REDUND (optional): 4092 - CONFIG_ENV_OFFSET_REDUND (optional):
4082 4093
4083 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 4094 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4084 hold a redundant copy of the environment data. This provides a 4095 hold a redundant copy of the environment data. This provides a
4085 valid backup copy in case the other copy is corrupted, e.g. due 4096 valid backup copy in case the other copy is corrupted, e.g. due
4086 to a power failure during a "saveenv" operation. 4097 to a power failure during a "saveenv" operation.
4087 4098
4088 This value may also be positive or negative; this is handled in the 4099 This value may also be positive or negative; this is handled in the
4089 same way as CONFIG_ENV_OFFSET. 4100 same way as CONFIG_ENV_OFFSET.
4090 4101
4091 This value is also in units of bytes, but must also be aligned to 4102 This value is also in units of bytes, but must also be aligned to
4092 an MMC sector boundary. 4103 an MMC sector boundary.
4093 4104
4094 - CONFIG_ENV_SIZE_REDUND (optional): 4105 - CONFIG_ENV_SIZE_REDUND (optional):
4095 4106
4096 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 4107 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4097 set. If this value is set, it must be set to the same value as 4108 set. If this value is set, it must be set to the same value as
4098 CONFIG_ENV_SIZE. 4109 CONFIG_ENV_SIZE.
4099 4110
4100 - CONFIG_SYS_SPI_INIT_OFFSET 4111 - CONFIG_SYS_SPI_INIT_OFFSET
4101 4112
4102 Defines offset to the initial SPI buffer area in DPRAM. The 4113 Defines offset to the initial SPI buffer area in DPRAM. The
4103 area is used at an early stage (ROM part) if the environment 4114 area is used at an early stage (ROM part) if the environment
4104 is configured to reside in the SPI EEPROM: We need a 520 byte 4115 is configured to reside in the SPI EEPROM: We need a 520 byte
4105 scratch DPRAM area. It is used between the two initialization 4116 scratch DPRAM area. It is used between the two initialization
4106 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4117 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4107 to be a good choice since it makes it far enough from the 4118 to be a good choice since it makes it far enough from the
4108 start of the data area as well as from the stack pointer. 4119 start of the data area as well as from the stack pointer.
4109 4120
4110 Please note that the environment is read-only until the monitor 4121 Please note that the environment is read-only until the monitor
4111 has been relocated to RAM and a RAM copy of the environment has been 4122 has been relocated to RAM and a RAM copy of the environment has been
4112 created; also, when using EEPROM you will have to use getenv_f() 4123 created; also, when using EEPROM you will have to use getenv_f()
4113 until then to read environment variables. 4124 until then to read environment variables.
4114 4125
4115 The environment is protected by a CRC32 checksum. Before the monitor 4126 The environment is protected by a CRC32 checksum. Before the monitor
4116 is relocated into RAM, as a result of a bad CRC you will be working 4127 is relocated into RAM, as a result of a bad CRC you will be working
4117 with the compiled-in default environment - *silently*!!! [This is 4128 with the compiled-in default environment - *silently*!!! [This is
4118 necessary, because the first environment variable we need is the 4129 necessary, because the first environment variable we need is the
4119 "baudrate" setting for the console - if we have a bad CRC, we don't 4130 "baudrate" setting for the console - if we have a bad CRC, we don't
4120 have any device yet where we could complain.] 4131 have any device yet where we could complain.]
4121 4132
4122 Note: once the monitor has been relocated, then it will complain if 4133 Note: once the monitor has been relocated, then it will complain if
4123 the default environment is used; a new CRC is computed as soon as you 4134 the default environment is used; a new CRC is computed as soon as you
4124 use the "saveenv" command to store a valid environment. 4135 use the "saveenv" command to store a valid environment.
4125 4136
4126 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4137 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4127 Echo the inverted Ethernet link state to the fault LED. 4138 Echo the inverted Ethernet link state to the fault LED.
4128 4139
4129 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4140 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4130 also needs to be defined. 4141 also needs to be defined.
4131 4142
4132 - CONFIG_SYS_FAULT_MII_ADDR: 4143 - CONFIG_SYS_FAULT_MII_ADDR:
4133 MII address of the PHY to check for the Ethernet link state. 4144 MII address of the PHY to check for the Ethernet link state.
4134 4145
4135 - CONFIG_NS16550_MIN_FUNCTIONS: 4146 - CONFIG_NS16550_MIN_FUNCTIONS:
4136 Define this if you desire to only have use of the NS16550_init 4147 Define this if you desire to only have use of the NS16550_init
4137 and NS16550_putc functions for the serial driver located at 4148 and NS16550_putc functions for the serial driver located at
4138 drivers/serial/ns16550.c. This option is useful for saving 4149 drivers/serial/ns16550.c. This option is useful for saving
4139 space for already greatly restricted images, including but not 4150 space for already greatly restricted images, including but not
4140 limited to NAND_SPL configurations. 4151 limited to NAND_SPL configurations.
4141 4152
4142 - CONFIG_DISPLAY_BOARDINFO 4153 - CONFIG_DISPLAY_BOARDINFO
4143 Display information about the board that U-Boot is running on 4154 Display information about the board that U-Boot is running on
4144 when U-Boot starts up. The board function checkboard() is called 4155 when U-Boot starts up. The board function checkboard() is called
4145 to do this. 4156 to do this.
4146 4157
4147 - CONFIG_DISPLAY_BOARDINFO_LATE 4158 - CONFIG_DISPLAY_BOARDINFO_LATE
4148 Similar to the previous option, but display this information 4159 Similar to the previous option, but display this information
4149 later, once stdio is running and output goes to the LCD, if 4160 later, once stdio is running and output goes to the LCD, if
4150 present. 4161 present.
4151 4162
4152 Low Level (hardware related) configuration options: 4163 Low Level (hardware related) configuration options:
4153 --------------------------------------------------- 4164 ---------------------------------------------------
4154 4165
4155 - CONFIG_SYS_CACHELINE_SIZE: 4166 - CONFIG_SYS_CACHELINE_SIZE:
4156 Cache Line Size of the CPU. 4167 Cache Line Size of the CPU.
4157 4168
4158 - CONFIG_SYS_DEFAULT_IMMR: 4169 - CONFIG_SYS_DEFAULT_IMMR:
4159 Default address of the IMMR after system reset. 4170 Default address of the IMMR after system reset.
4160 4171
4161 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 4172 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4162 and RPXsuper) to be able to adjust the position of 4173 and RPXsuper) to be able to adjust the position of
4163 the IMMR register after a reset. 4174 the IMMR register after a reset.
4164 4175
4165 - CONFIG_SYS_CCSRBAR_DEFAULT: 4176 - CONFIG_SYS_CCSRBAR_DEFAULT:
4166 Default (power-on reset) physical address of CCSR on Freescale 4177 Default (power-on reset) physical address of CCSR on Freescale
4167 PowerPC SOCs. 4178 PowerPC SOCs.
4168 4179
4169 - CONFIG_SYS_CCSRBAR: 4180 - CONFIG_SYS_CCSRBAR:
4170 Virtual address of CCSR. On a 32-bit build, this is typically 4181 Virtual address of CCSR. On a 32-bit build, this is typically
4171 the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4182 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4172 4183
4173 CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4184 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4174 for cross-platform code that uses that macro instead. 4185 for cross-platform code that uses that macro instead.
4175 4186
4176 - CONFIG_SYS_CCSRBAR_PHYS: 4187 - CONFIG_SYS_CCSRBAR_PHYS:
4177 Physical address of CCSR. CCSR can be relocated to a new 4188 Physical address of CCSR. CCSR can be relocated to a new
4178 physical address, if desired. In this case, this macro should 4189 physical address, if desired. In this case, this macro should
4179 be set to that address. Otherwise, it should be set to the 4190 be set to that address. Otherwise, it should be set to the
4180 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4191 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4181 is typically relocated on 36-bit builds. It is recommended 4192 is typically relocated on 36-bit builds. It is recommended
4182 that this macro be defined via the _HIGH and _LOW macros: 4193 that this macro be defined via the _HIGH and _LOW macros:
4183 4194
4184 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4195 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4185 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4196 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4186 4197
4187 - CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4198 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4188 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4199 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4189 either 0 (32-bit build) or 0xF (36-bit build). This macro is 4200 either 0 (32-bit build) or 0xF (36-bit build). This macro is
4190 used in assembly code, so it must not contain typecasts or 4201 used in assembly code, so it must not contain typecasts or
4191 integer size suffixes (e.g. "ULL"). 4202 integer size suffixes (e.g. "ULL").
4192 4203
4193 - CONFIG_SYS_CCSRBAR_PHYS_LOW: 4204 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
4194 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4205 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4195 used in assembly code, so it must not contain typecasts or 4206 used in assembly code, so it must not contain typecasts or
4196 integer size suffixes (e.g. "ULL"). 4207 integer size suffixes (e.g. "ULL").
4197 4208
4198 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4209 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4199 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4210 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4200 forced to a value that ensures that CCSR is not relocated. 4211 forced to a value that ensures that CCSR is not relocated.
4201 4212
4202 - Floppy Disk Support: 4213 - Floppy Disk Support:
4203 CONFIG_SYS_FDC_DRIVE_NUMBER 4214 CONFIG_SYS_FDC_DRIVE_NUMBER
4204 4215
4205 the default drive number (default value 0) 4216 the default drive number (default value 0)
4206 4217
4207 CONFIG_SYS_ISA_IO_STRIDE 4218 CONFIG_SYS_ISA_IO_STRIDE
4208 4219
4209 defines the spacing between FDC chipset registers 4220 defines the spacing between FDC chipset registers
4210 (default value 1) 4221 (default value 1)
4211 4222
4212 CONFIG_SYS_ISA_IO_OFFSET 4223 CONFIG_SYS_ISA_IO_OFFSET
4213 4224
4214 defines the offset of register from address. It 4225 defines the offset of register from address. It
4215 depends on which part of the data bus is connected to 4226 depends on which part of the data bus is connected to
4216 the FDC chipset. (default value 0) 4227 the FDC chipset. (default value 0)
4217 4228
4218 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 4229 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4219 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 4230 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
4220 default value. 4231 default value.
4221 4232
4222 if CONFIG_SYS_FDC_HW_INIT is defined, then the function 4233 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
4223 fdc_hw_init() is called at the beginning of the FDC 4234 fdc_hw_init() is called at the beginning of the FDC
4224 setup. fdc_hw_init() must be provided by the board 4235 setup. fdc_hw_init() must be provided by the board
4225 source code. It is used to make hardware dependant 4236 source code. It is used to make hardware dependant
4226 initializations. 4237 initializations.
4227 4238
4228 - CONFIG_IDE_AHB: 4239 - CONFIG_IDE_AHB:
4229 Most IDE controllers were designed to be connected with PCI 4240 Most IDE controllers were designed to be connected with PCI
4230 interface. Only few of them were designed for AHB interface. 4241 interface. Only few of them were designed for AHB interface.
4231 When software is doing ATA command and data transfer to 4242 When software is doing ATA command and data transfer to
4232 IDE devices through IDE-AHB controller, some additional 4243 IDE devices through IDE-AHB controller, some additional
4233 registers accessing to these kind of IDE-AHB controller 4244 registers accessing to these kind of IDE-AHB controller
4234 is requierd. 4245 is requierd.
4235 4246
4236 - CONFIG_SYS_IMMR: Physical address of the Internal Memory. 4247 - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
4237 DO NOT CHANGE unless you know exactly what you're 4248 DO NOT CHANGE unless you know exactly what you're
4238 doing! (11-4) [MPC8xx/82xx systems only] 4249 doing! (11-4) [MPC8xx/82xx systems only]
4239 4250
4240 - CONFIG_SYS_INIT_RAM_ADDR: 4251 - CONFIG_SYS_INIT_RAM_ADDR:
4241 4252
4242 Start address of memory area that can be used for 4253 Start address of memory area that can be used for
4243 initial data and stack; please note that this must be 4254 initial data and stack; please note that this must be
4244 writable memory that is working WITHOUT special 4255 writable memory that is working WITHOUT special
4245 initialization, i. e. you CANNOT use normal RAM which 4256 initialization, i. e. you CANNOT use normal RAM which
4246 will become available only after programming the 4257 will become available only after programming the
4247 memory controller and running certain initialization 4258 memory controller and running certain initialization
4248 sequences. 4259 sequences.
4249 4260
4250 U-Boot uses the following memory types: 4261 U-Boot uses the following memory types:
4251 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4262 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4252 - MPC824X: data cache 4263 - MPC824X: data cache
4253 - PPC4xx: data cache 4264 - PPC4xx: data cache
4254 4265
4255 - CONFIG_SYS_GBL_DATA_OFFSET: 4266 - CONFIG_SYS_GBL_DATA_OFFSET:
4256 4267
4257 Offset of the initial data structure in the memory 4268 Offset of the initial data structure in the memory
4258 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 4269 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4259 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4270 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4260 data is located at the end of the available space 4271 data is located at the end of the available space
4261 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 4272 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4262 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 4273 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4263 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 4274 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4264 CONFIG_SYS_GBL_DATA_OFFSET) downward. 4275 CONFIG_SYS_GBL_DATA_OFFSET) downward.
4265 4276
4266 Note: 4277 Note:
4267 On the MPC824X (or other systems that use the data 4278 On the MPC824X (or other systems that use the data
4268 cache for initial memory) the address chosen for 4279 cache for initial memory) the address chosen for
4269 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4280 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4270 point to an otherwise UNUSED address space between 4281 point to an otherwise UNUSED address space between
4271 the top of RAM and the start of the PCI space. 4282 the top of RAM and the start of the PCI space.
4272 4283
4273 - CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4284 - CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
4274 4285
4275 - CONFIG_SYS_SYPCR: System Protection Control (11-9) 4286 - CONFIG_SYS_SYPCR: System Protection Control (11-9)
4276 4287
4277 - CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4288 - CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
4278 4289
4279 - CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4290 - CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
4280 4291
4281 - CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4292 - CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
4282 4293
4283 - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4294 - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
4284 4295
4285 - CONFIG_SYS_OR_TIMING_SDRAM: 4296 - CONFIG_SYS_OR_TIMING_SDRAM:
4286 SDRAM timing 4297 SDRAM timing
4287 4298
4288 - CONFIG_SYS_MAMR_PTA: 4299 - CONFIG_SYS_MAMR_PTA:
4289 periodic timer for refresh 4300 periodic timer for refresh
4290 4301
4291 - CONFIG_SYS_DER: Debug Event Register (37-47) 4302 - CONFIG_SYS_DER: Debug Event Register (37-47)
4292 4303
4293 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 4304 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4294 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 4305 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4295 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 4306 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4296 CONFIG_SYS_BR1_PRELIM: 4307 CONFIG_SYS_BR1_PRELIM:
4297 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4308 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4298 4309
4299 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 4310 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4300 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 4311 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4301 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4312 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4302 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4313 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4303 4314
4304 - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 4315 - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4305 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4316 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4306 Machine Mode Register and Memory Periodic Timer 4317 Machine Mode Register and Memory Periodic Timer
4307 Prescaler definitions (SDRAM timing) 4318 Prescaler definitions (SDRAM timing)
4308 4319
4309 - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4320 - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4310 enable I2C microcode relocation patch (MPC8xx); 4321 enable I2C microcode relocation patch (MPC8xx);
4311 define relocation offset in DPRAM [DSP2] 4322 define relocation offset in DPRAM [DSP2]
4312 4323
4313 - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4324 - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4314 enable SMC microcode relocation patch (MPC8xx); 4325 enable SMC microcode relocation patch (MPC8xx);
4315 define relocation offset in DPRAM [SMC1] 4326 define relocation offset in DPRAM [SMC1]
4316 4327
4317 - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4328 - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4318 enable SPI microcode relocation patch (MPC8xx); 4329 enable SPI microcode relocation patch (MPC8xx);
4319 define relocation offset in DPRAM [SCC4] 4330 define relocation offset in DPRAM [SCC4]
4320 4331
4321 - CONFIG_SYS_USE_OSCCLK: 4332 - CONFIG_SYS_USE_OSCCLK:
4322 Use OSCM clock mode on MBX8xx board. Be careful, 4333 Use OSCM clock mode on MBX8xx board. Be careful,
4323 wrong setting might damage your board. Read 4334 wrong setting might damage your board. Read
4324 doc/README.MBX before setting this variable! 4335 doc/README.MBX before setting this variable!
4325 4336
4326 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4337 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4327 Offset of the bootmode word in DPRAM used by post 4338 Offset of the bootmode word in DPRAM used by post
4328 (Power On Self Tests). This definition overrides 4339 (Power On Self Tests). This definition overrides
4329 #define'd default value in commproc.h resp. 4340 #define'd default value in commproc.h resp.
4330 cpm_8260.h. 4341 cpm_8260.h.
4331 4342
4332 - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 4343 - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4333 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 4344 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4334 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 4345 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4335 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 4346 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4336 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 4347 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4337 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 4348 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4338 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 4349 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4339 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4350 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4340 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 4351 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
4341 4352
4342 - CONFIG_PCI_DISABLE_PCIE: 4353 - CONFIG_PCI_DISABLE_PCIE:
4343 Disable PCI-Express on systems where it is supported but not 4354 Disable PCI-Express on systems where it is supported but not
4344 required. 4355 required.
4345 4356
4346 - CONFIG_PCI_ENUM_ONLY 4357 - CONFIG_PCI_ENUM_ONLY
4347 Only scan through and get the devices on the busses. 4358 Only scan through and get the devices on the busses.
4348 Don't do any setup work, presumably because someone or 4359 Don't do any setup work, presumably because someone or
4349 something has already done it, and we don't need to do it 4360 something has already done it, and we don't need to do it
4350 a second time. Useful for platforms that are pre-booted 4361 a second time. Useful for platforms that are pre-booted
4351 by coreboot or similar. 4362 by coreboot or similar.
4352 4363
4353 - CONFIG_PCI_INDIRECT_BRIDGE: 4364 - CONFIG_PCI_INDIRECT_BRIDGE:
4354 Enable support for indirect PCI bridges. 4365 Enable support for indirect PCI bridges.
4355 4366
4356 - CONFIG_SYS_SRIO: 4367 - CONFIG_SYS_SRIO:
4357 Chip has SRIO or not 4368 Chip has SRIO or not
4358 4369
4359 - CONFIG_SRIO1: 4370 - CONFIG_SRIO1:
4360 Board has SRIO 1 port available 4371 Board has SRIO 1 port available
4361 4372
4362 - CONFIG_SRIO2: 4373 - CONFIG_SRIO2:
4363 Board has SRIO 2 port available 4374 Board has SRIO 2 port available
4364 4375
4365 - CONFIG_SRIO_PCIE_BOOT_MASTER 4376 - CONFIG_SRIO_PCIE_BOOT_MASTER
4366 Board can support master function for Boot from SRIO and PCIE 4377 Board can support master function for Boot from SRIO and PCIE
4367 4378
4368 - CONFIG_SYS_SRIOn_MEM_VIRT: 4379 - CONFIG_SYS_SRIOn_MEM_VIRT:
4369 Virtual Address of SRIO port 'n' memory region 4380 Virtual Address of SRIO port 'n' memory region
4370 4381
4371 - CONFIG_SYS_SRIOn_MEM_PHYS: 4382 - CONFIG_SYS_SRIOn_MEM_PHYS:
4372 Physical Address of SRIO port 'n' memory region 4383 Physical Address of SRIO port 'n' memory region
4373 4384
4374 - CONFIG_SYS_SRIOn_MEM_SIZE: 4385 - CONFIG_SYS_SRIOn_MEM_SIZE:
4375 Size of SRIO port 'n' memory region 4386 Size of SRIO port 'n' memory region
4376 4387
4377 - CONFIG_SYS_NAND_BUSWIDTH_16BIT 4388 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
4378 Defined to tell the NAND controller that the NAND chip is using 4389 Defined to tell the NAND controller that the NAND chip is using
4379 a 16 bit bus. 4390 a 16 bit bus.
4380 Not all NAND drivers use this symbol. 4391 Not all NAND drivers use this symbol.
4381 Example of drivers that use it: 4392 Example of drivers that use it:
4382 - drivers/mtd/nand/ndfc.c 4393 - drivers/mtd/nand/ndfc.c
4383 - drivers/mtd/nand/mxc_nand.c 4394 - drivers/mtd/nand/mxc_nand.c
4384 4395
4385 - CONFIG_SYS_NDFC_EBC0_CFG 4396 - CONFIG_SYS_NDFC_EBC0_CFG
4386 Sets the EBC0_CFG register for the NDFC. If not defined 4397 Sets the EBC0_CFG register for the NDFC. If not defined
4387 a default value will be used. 4398 a default value will be used.
4388 4399
4389 - CONFIG_SPD_EEPROM 4400 - CONFIG_SPD_EEPROM
4390 Get DDR timing information from an I2C EEPROM. Common 4401 Get DDR timing information from an I2C EEPROM. Common
4391 with pluggable memory modules such as SODIMMs 4402 with pluggable memory modules such as SODIMMs
4392 4403
4393 SPD_EEPROM_ADDRESS 4404 SPD_EEPROM_ADDRESS
4394 I2C address of the SPD EEPROM 4405 I2C address of the SPD EEPROM
4395 4406
4396 - CONFIG_SYS_SPD_BUS_NUM 4407 - CONFIG_SYS_SPD_BUS_NUM
4397 If SPD EEPROM is on an I2C bus other than the first 4408 If SPD EEPROM is on an I2C bus other than the first
4398 one, specify here. Note that the value must resolve 4409 one, specify here. Note that the value must resolve
4399 to something your driver can deal with. 4410 to something your driver can deal with.
4400 4411
4401 - CONFIG_SYS_DDR_RAW_TIMING 4412 - CONFIG_SYS_DDR_RAW_TIMING
4402 Get DDR timing information from other than SPD. Common with 4413 Get DDR timing information from other than SPD. Common with
4403 soldered DDR chips onboard without SPD. DDR raw timing 4414 soldered DDR chips onboard without SPD. DDR raw timing
4404 parameters are extracted from datasheet and hard-coded into 4415 parameters are extracted from datasheet and hard-coded into
4405 header files or board specific files. 4416 header files or board specific files.
4406 4417
4407 - CONFIG_FSL_DDR_INTERACTIVE 4418 - CONFIG_FSL_DDR_INTERACTIVE
4408 Enable interactive DDR debugging. See doc/README.fsl-ddr. 4419 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4409 4420
4410 - CONFIG_SYS_83XX_DDR_USES_CS0 4421 - CONFIG_SYS_83XX_DDR_USES_CS0
4411 Only for 83xx systems. If specified, then DDR should 4422 Only for 83xx systems. If specified, then DDR should
4412 be configured using CS0 and CS1 instead of CS2 and CS3. 4423 be configured using CS0 and CS1 instead of CS2 and CS3.
4413 4424
4414 - CONFIG_ETHER_ON_FEC[12] 4425 - CONFIG_ETHER_ON_FEC[12]
4415 Define to enable FEC[12] on a 8xx series processor. 4426 Define to enable FEC[12] on a 8xx series processor.
4416 4427
4417 - CONFIG_FEC[12]_PHY 4428 - CONFIG_FEC[12]_PHY
4418 Define to the hardcoded PHY address which corresponds 4429 Define to the hardcoded PHY address which corresponds
4419 to the given FEC; i. e. 4430 to the given FEC; i. e.
4420 #define CONFIG_FEC1_PHY 4 4431 #define CONFIG_FEC1_PHY 4
4421 means that the PHY with address 4 is connected to FEC1 4432 means that the PHY with address 4 is connected to FEC1
4422 4433
4423 When set to -1, means to probe for first available. 4434 When set to -1, means to probe for first available.
4424 4435
4425 - CONFIG_FEC[12]_PHY_NORXERR 4436 - CONFIG_FEC[12]_PHY_NORXERR
4426 The PHY does not have a RXERR line (RMII only). 4437 The PHY does not have a RXERR line (RMII only).
4427 (so program the FEC to ignore it). 4438 (so program the FEC to ignore it).
4428 4439
4429 - CONFIG_RMII 4440 - CONFIG_RMII
4430 Enable RMII mode for all FECs. 4441 Enable RMII mode for all FECs.
4431 Note that this is a global option, we can't 4442 Note that this is a global option, we can't
4432 have one FEC in standard MII mode and another in RMII mode. 4443 have one FEC in standard MII mode and another in RMII mode.
4433 4444
4434 - CONFIG_CRC32_VERIFY 4445 - CONFIG_CRC32_VERIFY
4435 Add a verify option to the crc32 command. 4446 Add a verify option to the crc32 command.
4436 The syntax is: 4447 The syntax is:
4437 4448
4438 => crc32 -v <address> <count> <crc32> 4449 => crc32 -v <address> <count> <crc32>
4439 4450
4440 Where address/count indicate a memory area 4451 Where address/count indicate a memory area
4441 and crc32 is the correct crc32 which the 4452 and crc32 is the correct crc32 which the
4442 area should have. 4453 area should have.
4443 4454
4444 - CONFIG_LOOPW 4455 - CONFIG_LOOPW
4445 Add the "loopw" memory command. This only takes effect if 4456 Add the "loopw" memory command. This only takes effect if
4446 the memory commands are activated globally (CONFIG_CMD_MEM). 4457 the memory commands are activated globally (CONFIG_CMD_MEM).
4447 4458
4448 - CONFIG_MX_CYCLIC 4459 - CONFIG_MX_CYCLIC
4449 Add the "mdc" and "mwc" memory commands. These are cyclic 4460 Add the "mdc" and "mwc" memory commands. These are cyclic
4450 "md/mw" commands. 4461 "md/mw" commands.
4451 Examples: 4462 Examples:
4452 4463
4453 => mdc.b 10 4 500 4464 => mdc.b 10 4 500
4454 This command will print 4 bytes (10,11,12,13) each 500 ms. 4465 This command will print 4 bytes (10,11,12,13) each 500 ms.
4455 4466
4456 => mwc.l 100 12345678 10 4467 => mwc.l 100 12345678 10
4457 This command will write 12345678 to address 100 all 10 ms. 4468 This command will write 12345678 to address 100 all 10 ms.
4458 4469
4459 This only takes effect if the memory commands are activated 4470 This only takes effect if the memory commands are activated
4460 globally (CONFIG_CMD_MEM). 4471 globally (CONFIG_CMD_MEM).
4461 4472
4462 - CONFIG_SKIP_LOWLEVEL_INIT 4473 - CONFIG_SKIP_LOWLEVEL_INIT
4463 [ARM, NDS32, MIPS only] If this variable is defined, then certain 4474 [ARM, NDS32, MIPS only] If this variable is defined, then certain
4464 low level initializations (like setting up the memory 4475 low level initializations (like setting up the memory
4465 controller) are omitted and/or U-Boot does not 4476 controller) are omitted and/or U-Boot does not
4466 relocate itself into RAM. 4477 relocate itself into RAM.
4467 4478
4468 Normally this variable MUST NOT be defined. The only 4479 Normally this variable MUST NOT be defined. The only
4469 exception is when U-Boot is loaded (to RAM) by some 4480 exception is when U-Boot is loaded (to RAM) by some
4470 other boot loader or by a debugger which performs 4481 other boot loader or by a debugger which performs
4471 these initializations itself. 4482 these initializations itself.
4472 4483
4473 - CONFIG_SPL_BUILD 4484 - CONFIG_SPL_BUILD
4474 Modifies the behaviour of start.S when compiling a loader 4485 Modifies the behaviour of start.S when compiling a loader
4475 that is executed before the actual U-Boot. E.g. when 4486 that is executed before the actual U-Boot. E.g. when
4476 compiling a NAND SPL. 4487 compiling a NAND SPL.
4477 4488
4478 - CONFIG_TPL_BUILD 4489 - CONFIG_TPL_BUILD
4479 Modifies the behaviour of start.S when compiling a loader 4490 Modifies the behaviour of start.S when compiling a loader
4480 that is executed after the SPL and before the actual U-Boot. 4491 that is executed after the SPL and before the actual U-Boot.
4481 It is loaded by the SPL. 4492 It is loaded by the SPL.
4482 4493
4483 - CONFIG_SYS_MPC85XX_NO_RESETVEC 4494 - CONFIG_SYS_MPC85XX_NO_RESETVEC
4484 Only for 85xx systems. If this variable is specified, the section 4495 Only for 85xx systems. If this variable is specified, the section
4485 .resetvec is not kept and the section .bootpg is placed in the 4496 .resetvec is not kept and the section .bootpg is placed in the
4486 previous 4k of the .text section. 4497 previous 4k of the .text section.
4487 4498
4488 - CONFIG_ARCH_MAP_SYSMEM 4499 - CONFIG_ARCH_MAP_SYSMEM
4489 Generally U-Boot (and in particular the md command) uses 4500 Generally U-Boot (and in particular the md command) uses
4490 effective address. It is therefore not necessary to regard 4501 effective address. It is therefore not necessary to regard
4491 U-Boot address as virtual addresses that need to be translated 4502 U-Boot address as virtual addresses that need to be translated
4492 to physical addresses. However, sandbox requires this, since 4503 to physical addresses. However, sandbox requires this, since
4493 it maintains its own little RAM buffer which contains all 4504 it maintains its own little RAM buffer which contains all
4494 addressable memory. This option causes some memory accesses 4505 addressable memory. This option causes some memory accesses
4495 to be mapped through map_sysmem() / unmap_sysmem(). 4506 to be mapped through map_sysmem() / unmap_sysmem().
4496 4507
4497 - CONFIG_USE_ARCH_MEMCPY 4508 - CONFIG_USE_ARCH_MEMCPY
4498 CONFIG_USE_ARCH_MEMSET 4509 CONFIG_USE_ARCH_MEMSET
4499 If these options are used a optimized version of memcpy/memset will 4510 If these options are used a optimized version of memcpy/memset will
4500 be used if available. These functions may be faster under some 4511 be used if available. These functions may be faster under some
4501 conditions but may increase the binary size. 4512 conditions but may increase the binary size.
4502 4513
4503 - CONFIG_X86_RESET_VECTOR 4514 - CONFIG_X86_RESET_VECTOR
4504 If defined, the x86 reset vector code is included. This is not 4515 If defined, the x86 reset vector code is included. This is not
4505 needed when U-Boot is running from Coreboot. 4516 needed when U-Boot is running from Coreboot.
4506 4517
4507 - CONFIG_SYS_MPUCLK 4518 - CONFIG_SYS_MPUCLK
4508 Defines the MPU clock speed (in MHz). 4519 Defines the MPU clock speed (in MHz).
4509 4520
4510 NOTE : currently only supported on AM335x platforms. 4521 NOTE : currently only supported on AM335x platforms.
4511 4522
4512 - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 4523 - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4513 Enables the RTC32K OSC on AM33xx based plattforms 4524 Enables the RTC32K OSC on AM33xx based plattforms
4514 4525
4515 Freescale QE/FMAN Firmware Support: 4526 Freescale QE/FMAN Firmware Support:
4516 ----------------------------------- 4527 -----------------------------------
4517 4528
4518 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4529 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4519 loading of "firmware", which is encoded in the QE firmware binary format. 4530 loading of "firmware", which is encoded in the QE firmware binary format.
4520 This firmware often needs to be loaded during U-Boot booting, so macros 4531 This firmware often needs to be loaded during U-Boot booting, so macros
4521 are used to identify the storage device (NOR flash, SPI, etc) and the address 4532 are used to identify the storage device (NOR flash, SPI, etc) and the address
4522 within that device. 4533 within that device.
4523 4534
4524 - CONFIG_SYS_FMAN_FW_ADDR 4535 - CONFIG_SYS_FMAN_FW_ADDR
4525 The address in the storage device where the FMAN microcode is located. The 4536 The address in the storage device where the FMAN microcode is located. The
4526 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4537 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4527 is also specified. 4538 is also specified.
4528 4539
4529 - CONFIG_SYS_QE_FW_ADDR 4540 - CONFIG_SYS_QE_FW_ADDR
4530 The address in the storage device where the QE microcode is located. The 4541 The address in the storage device where the QE microcode is located. The
4531 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4542 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4532 is also specified. 4543 is also specified.
4533 4544
4534 - CONFIG_SYS_QE_FMAN_FW_LENGTH 4545 - CONFIG_SYS_QE_FMAN_FW_LENGTH
4535 The maximum possible size of the firmware. The firmware binary format 4546 The maximum possible size of the firmware. The firmware binary format
4536 has a field that specifies the actual size of the firmware, but it 4547 has a field that specifies the actual size of the firmware, but it
4537 might not be possible to read any part of the firmware unless some 4548 might not be possible to read any part of the firmware unless some
4538 local storage is allocated to hold the entire firmware first. 4549 local storage is allocated to hold the entire firmware first.
4539 4550
4540 - CONFIG_SYS_QE_FMAN_FW_IN_NOR 4551 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
4541 Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4552 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4542 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4553 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4543 virtual address in NOR flash. 4554 virtual address in NOR flash.
4544 4555
4545 - CONFIG_SYS_QE_FMAN_FW_IN_NAND 4556 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
4546 Specifies that QE/FMAN firmware is located in NAND flash. 4557 Specifies that QE/FMAN firmware is located in NAND flash.
4547 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4558 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4548 4559
4549 - CONFIG_SYS_QE_FMAN_FW_IN_MMC 4560 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
4550 Specifies that QE/FMAN firmware is located on the primary SD/MMC 4561 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4551 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4562 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4552 4563
4553 - CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4564 - CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4554 Specifies that QE/FMAN firmware is located on the primary SPI 4565 Specifies that QE/FMAN firmware is located on the primary SPI
4555 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4566 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4556 4567
4557 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4568 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4558 Specifies that QE/FMAN firmware is located in the remote (master) 4569 Specifies that QE/FMAN firmware is located in the remote (master)
4559 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4570 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4560 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4571 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4561 window->master inbound window->master LAW->the ucode address in 4572 window->master inbound window->master LAW->the ucode address in
4562 master's memory space. 4573 master's memory space.
4563 4574
4564 Building the Software: 4575 Building the Software:
4565 ====================== 4576 ======================
4566 4577
4567 Building U-Boot has been tested in several native build environments 4578 Building U-Boot has been tested in several native build environments
4568 and in many different cross environments. Of course we cannot support 4579 and in many different cross environments. Of course we cannot support
4569 all possibly existing versions of cross development tools in all 4580 all possibly existing versions of cross development tools in all
4570 (potentially obsolete) versions. In case of tool chain problems we 4581 (potentially obsolete) versions. In case of tool chain problems we
4571 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4582 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4572 which is extensively used to build and test U-Boot. 4583 which is extensively used to build and test U-Boot.
4573 4584
4574 If you are not using a native environment, it is assumed that you 4585 If you are not using a native environment, it is assumed that you
4575 have GNU cross compiling tools available in your path. In this case, 4586 have GNU cross compiling tools available in your path. In this case,
4576 you must set the environment variable CROSS_COMPILE in your shell. 4587 you must set the environment variable CROSS_COMPILE in your shell.
4577 Note that no changes to the Makefile or any other source files are 4588 Note that no changes to the Makefile or any other source files are
4578 necessary. For example using the ELDK on a 4xx CPU, please enter: 4589 necessary. For example using the ELDK on a 4xx CPU, please enter:
4579 4590
4580 $ CROSS_COMPILE=ppc_4xx- 4591 $ CROSS_COMPILE=ppc_4xx-
4581 $ export CROSS_COMPILE 4592 $ export CROSS_COMPILE
4582 4593
4583 Note: If you wish to generate Windows versions of the utilities in 4594 Note: If you wish to generate Windows versions of the utilities in
4584 the tools directory you can use the MinGW toolchain 4595 the tools directory you can use the MinGW toolchain
4585 (http://www.mingw.org). Set your HOST tools to the MinGW 4596 (http://www.mingw.org). Set your HOST tools to the MinGW
4586 toolchain and execute 'make tools'. For example: 4597 toolchain and execute 'make tools'. For example:
4587 4598
4588 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 4599 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4589 4600
4590 Binaries such as tools/mkimage.exe will be created which can 4601 Binaries such as tools/mkimage.exe will be created which can
4591 be executed on computers running Windows. 4602 be executed on computers running Windows.
4592 4603
4593 U-Boot is intended to be simple to build. After installing the 4604 U-Boot is intended to be simple to build. After installing the
4594 sources you must configure U-Boot for one specific board type. This 4605 sources you must configure U-Boot for one specific board type. This
4595 is done by typing: 4606 is done by typing:
4596 4607
4597 make NAME_config 4608 make NAME_config
4598 4609
4599 where "NAME_config" is the name of one of the existing configu- 4610 where "NAME_config" is the name of one of the existing configu-
4600 rations; see boards.cfg for supported names. 4611 rations; see boards.cfg for supported names.
4601 4612
4602 Note: for some board special configuration names may exist; check if 4613 Note: for some board special configuration names may exist; check if
4603 additional information is available from the board vendor; for 4614 additional information is available from the board vendor; for
4604 instance, the TQM823L systems are available without (standard) 4615 instance, the TQM823L systems are available without (standard)
4605 or with LCD support. You can select such additional "features" 4616 or with LCD support. You can select such additional "features"
4606 when choosing the configuration, i. e. 4617 when choosing the configuration, i. e.
4607 4618
4608 make TQM823L_config 4619 make TQM823L_config
4609 - will configure for a plain TQM823L, i. e. no LCD support 4620 - will configure for a plain TQM823L, i. e. no LCD support
4610 4621
4611 make TQM823L_LCD_config 4622 make TQM823L_LCD_config
4612 - will configure for a TQM823L with U-Boot console on LCD 4623 - will configure for a TQM823L with U-Boot console on LCD
4613 4624
4614 etc. 4625 etc.
4615 4626
4616 4627
4617 Finally, type "make all", and you should get some working U-Boot 4628 Finally, type "make all", and you should get some working U-Boot
4618 images ready for download to / installation on your system: 4629 images ready for download to / installation on your system:
4619 4630
4620 - "u-boot.bin" is a raw binary image 4631 - "u-boot.bin" is a raw binary image
4621 - "u-boot" is an image in ELF binary format 4632 - "u-boot" is an image in ELF binary format
4622 - "u-boot.srec" is in Motorola S-Record format 4633 - "u-boot.srec" is in Motorola S-Record format
4623 4634
4624 By default the build is performed locally and the objects are saved 4635 By default the build is performed locally and the objects are saved
4625 in the source directory. One of the two methods can be used to change 4636 in the source directory. One of the two methods can be used to change
4626 this behavior and build U-Boot to some external directory: 4637 this behavior and build U-Boot to some external directory:
4627 4638
4628 1. Add O= to the make command line invocations: 4639 1. Add O= to the make command line invocations:
4629 4640
4630 make O=/tmp/build distclean 4641 make O=/tmp/build distclean
4631 make O=/tmp/build NAME_config 4642 make O=/tmp/build NAME_config
4632 make O=/tmp/build all 4643 make O=/tmp/build all
4633 4644
4634 2. Set environment variable BUILD_DIR to point to the desired location: 4645 2. Set environment variable BUILD_DIR to point to the desired location:
4635 4646
4636 export BUILD_DIR=/tmp/build 4647 export BUILD_DIR=/tmp/build
4637 make distclean 4648 make distclean
4638 make NAME_config 4649 make NAME_config
4639 make all 4650 make all
4640 4651
4641 Note that the command line "O=" setting overrides the BUILD_DIR environment 4652 Note that the command line "O=" setting overrides the BUILD_DIR environment
4642 variable. 4653 variable.
4643 4654
4644 4655
4645 Please be aware that the Makefiles assume you are using GNU make, so 4656 Please be aware that the Makefiles assume you are using GNU make, so
4646 for instance on NetBSD you might need to use "gmake" instead of 4657 for instance on NetBSD you might need to use "gmake" instead of
4647 native "make". 4658 native "make".
4648 4659
4649 4660
4650 If the system board that you have is not listed, then you will need 4661 If the system board that you have is not listed, then you will need
4651 to port U-Boot to your hardware platform. To do this, follow these 4662 to port U-Boot to your hardware platform. To do this, follow these
4652 steps: 4663 steps:
4653 4664
4654 1. Add a new configuration option for your board to the toplevel 4665 1. Add a new configuration option for your board to the toplevel
4655 "boards.cfg" file, using the existing entries as examples. 4666 "boards.cfg" file, using the existing entries as examples.
4656 Follow the instructions there to keep the boards in order. 4667 Follow the instructions there to keep the boards in order.
4657 2. Create a new directory to hold your board specific code. Add any 4668 2. Create a new directory to hold your board specific code. Add any
4658 files you need. In your board directory, you will need at least 4669 files you need. In your board directory, you will need at least
4659 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 4670 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
4660 3. Create a new configuration file "include/configs/<board>.h" for 4671 3. Create a new configuration file "include/configs/<board>.h" for
4661 your board 4672 your board
4662 3. If you're porting U-Boot to a new CPU, then also create a new 4673 3. If you're porting U-Boot to a new CPU, then also create a new
4663 directory to hold your CPU specific code. Add any files you need. 4674 directory to hold your CPU specific code. Add any files you need.
4664 4. Run "make <board>_config" with your new name. 4675 4. Run "make <board>_config" with your new name.
4665 5. Type "make", and you should get a working "u-boot.srec" file 4676 5. Type "make", and you should get a working "u-boot.srec" file
4666 to be installed on your target system. 4677 to be installed on your target system.
4667 6. Debug and solve any problems that might arise. 4678 6. Debug and solve any problems that might arise.
4668 [Of course, this last step is much harder than it sounds.] 4679 [Of course, this last step is much harder than it sounds.]
4669 4680
4670 4681
4671 Testing of U-Boot Modifications, Ports to New Hardware, etc.: 4682 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4672 ============================================================== 4683 ==============================================================
4673 4684
4674 If you have modified U-Boot sources (for instance added a new board 4685 If you have modified U-Boot sources (for instance added a new board
4675 or support for new devices, a new CPU, etc.) you are expected to 4686 or support for new devices, a new CPU, etc.) you are expected to
4676 provide feedback to the other developers. The feedback normally takes 4687 provide feedback to the other developers. The feedback normally takes
4677 the form of a "patch", i. e. a context diff against a certain (latest 4688 the form of a "patch", i. e. a context diff against a certain (latest
4678 official or latest in the git repository) version of U-Boot sources. 4689 official or latest in the git repository) version of U-Boot sources.
4679 4690
4680 But before you submit such a patch, please verify that your modifi- 4691 But before you submit such a patch, please verify that your modifi-
4681 cation did not break existing code. At least make sure that *ALL* of 4692 cation did not break existing code. At least make sure that *ALL* of
4682 the supported boards compile WITHOUT ANY compiler warnings. To do so, 4693 the supported boards compile WITHOUT ANY compiler warnings. To do so,
4683 just run the "MAKEALL" script, which will configure and build U-Boot 4694 just run the "MAKEALL" script, which will configure and build U-Boot
4684 for ALL supported system. Be warned, this will take a while. You can 4695 for ALL supported system. Be warned, this will take a while. You can
4685 select which (cross) compiler to use by passing a `CROSS_COMPILE' 4696 select which (cross) compiler to use by passing a `CROSS_COMPILE'
4686 environment variable to the script, i. e. to use the ELDK cross tools 4697 environment variable to the script, i. e. to use the ELDK cross tools
4687 you can type 4698 you can type
4688 4699
4689 CROSS_COMPILE=ppc_8xx- MAKEALL 4700 CROSS_COMPILE=ppc_8xx- MAKEALL
4690 4701
4691 or to build on a native PowerPC system you can type 4702 or to build on a native PowerPC system you can type
4692 4703
4693 CROSS_COMPILE=' ' MAKEALL 4704 CROSS_COMPILE=' ' MAKEALL
4694 4705
4695 When using the MAKEALL script, the default behaviour is to build 4706 When using the MAKEALL script, the default behaviour is to build
4696 U-Boot in the source directory. This location can be changed by 4707 U-Boot in the source directory. This location can be changed by
4697 setting the BUILD_DIR environment variable. Also, for each target 4708 setting the BUILD_DIR environment variable. Also, for each target
4698 built, the MAKEALL script saves two log files (<target>.ERR and 4709 built, the MAKEALL script saves two log files (<target>.ERR and
4699 <target>.MAKEALL) in the <source dir>/LOG directory. This default 4710 <target>.MAKEALL) in the <source dir>/LOG directory. This default
4700 location can be changed by setting the MAKEALL_LOGDIR environment 4711 location can be changed by setting the MAKEALL_LOGDIR environment
4701 variable. For example: 4712 variable. For example:
4702 4713
4703 export BUILD_DIR=/tmp/build 4714 export BUILD_DIR=/tmp/build
4704 export MAKEALL_LOGDIR=/tmp/log 4715 export MAKEALL_LOGDIR=/tmp/log
4705 CROSS_COMPILE=ppc_8xx- MAKEALL 4716 CROSS_COMPILE=ppc_8xx- MAKEALL
4706 4717
4707 With the above settings build objects are saved in the /tmp/build, 4718 With the above settings build objects are saved in the /tmp/build,
4708 log files are saved in the /tmp/log and the source tree remains clean 4719 log files are saved in the /tmp/log and the source tree remains clean
4709 during the whole build process. 4720 during the whole build process.
4710 4721
4711 4722
4712 See also "U-Boot Porting Guide" below. 4723 See also "U-Boot Porting Guide" below.
4713 4724
4714 4725
4715 Monitor Commands - Overview: 4726 Monitor Commands - Overview:
4716 ============================ 4727 ============================
4717 4728
4718 go - start application at address 'addr' 4729 go - start application at address 'addr'
4719 run - run commands in an environment variable 4730 run - run commands in an environment variable
4720 bootm - boot application image from memory 4731 bootm - boot application image from memory
4721 bootp - boot image via network using BootP/TFTP protocol 4732 bootp - boot image via network using BootP/TFTP protocol
4722 bootz - boot zImage from memory 4733 bootz - boot zImage from memory
4723 tftpboot- boot image via network using TFTP protocol 4734 tftpboot- boot image via network using TFTP protocol
4724 and env variables "ipaddr" and "serverip" 4735 and env variables "ipaddr" and "serverip"
4725 (and eventually "gatewayip") 4736 (and eventually "gatewayip")
4726 tftpput - upload a file via network using TFTP protocol 4737 tftpput - upload a file via network using TFTP protocol
4727 rarpboot- boot image via network using RARP/TFTP protocol 4738 rarpboot- boot image via network using RARP/TFTP protocol
4728 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4739 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4729 loads - load S-Record file over serial line 4740 loads - load S-Record file over serial line
4730 loadb - load binary file over serial line (kermit mode) 4741 loadb - load binary file over serial line (kermit mode)
4731 md - memory display 4742 md - memory display
4732 mm - memory modify (auto-incrementing) 4743 mm - memory modify (auto-incrementing)
4733 nm - memory modify (constant address) 4744 nm - memory modify (constant address)
4734 mw - memory write (fill) 4745 mw - memory write (fill)
4735 cp - memory copy 4746 cp - memory copy
4736 cmp - memory compare 4747 cmp - memory compare
4737 crc32 - checksum calculation 4748 crc32 - checksum calculation
4738 i2c - I2C sub-system 4749 i2c - I2C sub-system
4739 sspi - SPI utility commands 4750 sspi - SPI utility commands
4740 base - print or set address offset 4751 base - print or set address offset
4741 printenv- print environment variables 4752 printenv- print environment variables
4742 setenv - set environment variables 4753 setenv - set environment variables
4743 saveenv - save environment variables to persistent storage 4754 saveenv - save environment variables to persistent storage
4744 protect - enable or disable FLASH write protection 4755 protect - enable or disable FLASH write protection
4745 erase - erase FLASH memory 4756 erase - erase FLASH memory
4746 flinfo - print FLASH memory information 4757 flinfo - print FLASH memory information
4747 nand - NAND memory operations (see doc/README.nand) 4758 nand - NAND memory operations (see doc/README.nand)
4748 bdinfo - print Board Info structure 4759 bdinfo - print Board Info structure
4749 iminfo - print header information for application image 4760 iminfo - print header information for application image
4750 coninfo - print console devices and informations 4761 coninfo - print console devices and informations
4751 ide - IDE sub-system 4762 ide - IDE sub-system
4752 loop - infinite loop on address range 4763 loop - infinite loop on address range
4753 loopw - infinite write loop on address range 4764 loopw - infinite write loop on address range
4754 mtest - simple RAM test 4765 mtest - simple RAM test
4755 icache - enable or disable instruction cache 4766 icache - enable or disable instruction cache
4756 dcache - enable or disable data cache 4767 dcache - enable or disable data cache
4757 reset - Perform RESET of the CPU 4768 reset - Perform RESET of the CPU
4758 echo - echo args to console 4769 echo - echo args to console
4759 version - print monitor version 4770 version - print monitor version
4760 help - print online help 4771 help - print online help
4761 ? - alias for 'help' 4772 ? - alias for 'help'
4762 4773
4763 4774
4764 Monitor Commands - Detailed Description: 4775 Monitor Commands - Detailed Description:
4765 ======================================== 4776 ========================================
4766 4777
4767 TODO. 4778 TODO.
4768 4779
4769 For now: just type "help <command>". 4780 For now: just type "help <command>".
4770 4781
4771 4782
4772 Environment Variables: 4783 Environment Variables:
4773 ====================== 4784 ======================
4774 4785
4775 U-Boot supports user configuration using Environment Variables which 4786 U-Boot supports user configuration using Environment Variables which
4776 can be made persistent by saving to Flash memory. 4787 can be made persistent by saving to Flash memory.
4777 4788
4778 Environment Variables are set using "setenv", printed using 4789 Environment Variables are set using "setenv", printed using
4779 "printenv", and saved to Flash using "saveenv". Using "setenv" 4790 "printenv", and saved to Flash using "saveenv". Using "setenv"
4780 without a value can be used to delete a variable from the 4791 without a value can be used to delete a variable from the
4781 environment. As long as you don't save the environment you are 4792 environment. As long as you don't save the environment you are
4782 working with an in-memory copy. In case the Flash area containing the 4793 working with an in-memory copy. In case the Flash area containing the
4783 environment is erased by accident, a default environment is provided. 4794 environment is erased by accident, a default environment is provided.
4784 4795
4785 Some configuration options can be set using Environment Variables. 4796 Some configuration options can be set using Environment Variables.
4786 4797
4787 List of environment variables (most likely not complete): 4798 List of environment variables (most likely not complete):
4788 4799
4789 baudrate - see CONFIG_BAUDRATE 4800 baudrate - see CONFIG_BAUDRATE
4790 4801
4791 bootdelay - see CONFIG_BOOTDELAY 4802 bootdelay - see CONFIG_BOOTDELAY
4792 4803
4793 bootcmd - see CONFIG_BOOTCOMMAND 4804 bootcmd - see CONFIG_BOOTCOMMAND
4794 4805
4795 bootargs - Boot arguments when booting an RTOS image 4806 bootargs - Boot arguments when booting an RTOS image
4796 4807
4797 bootfile - Name of the image to load with TFTP 4808 bootfile - Name of the image to load with TFTP
4798 4809
4799 bootm_low - Memory range available for image processing in the bootm 4810 bootm_low - Memory range available for image processing in the bootm
4800 command can be restricted. This variable is given as 4811 command can be restricted. This variable is given as
4801 a hexadecimal number and defines lowest address allowed 4812 a hexadecimal number and defines lowest address allowed
4802 for use by the bootm command. See also "bootm_size" 4813 for use by the bootm command. See also "bootm_size"
4803 environment variable. Address defined by "bootm_low" is 4814 environment variable. Address defined by "bootm_low" is
4804 also the base of the initial memory mapping for the Linux 4815 also the base of the initial memory mapping for the Linux
4805 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4816 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4806 bootm_mapsize. 4817 bootm_mapsize.
4807 4818
4808 bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4819 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4809 This variable is given as a hexadecimal number and it 4820 This variable is given as a hexadecimal number and it
4810 defines the size of the memory region starting at base 4821 defines the size of the memory region starting at base
4811 address bootm_low that is accessible by the Linux kernel 4822 address bootm_low that is accessible by the Linux kernel
4812 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4823 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4813 as the default value if it is defined, and bootm_size is 4824 as the default value if it is defined, and bootm_size is
4814 used otherwise. 4825 used otherwise.
4815 4826
4816 bootm_size - Memory range available for image processing in the bootm 4827 bootm_size - Memory range available for image processing in the bootm
4817 command can be restricted. This variable is given as 4828 command can be restricted. This variable is given as
4818 a hexadecimal number and defines the size of the region 4829 a hexadecimal number and defines the size of the region
4819 allowed for use by the bootm command. See also "bootm_low" 4830 allowed for use by the bootm command. See also "bootm_low"
4820 environment variable. 4831 environment variable.
4821 4832
4822 updatefile - Location of the software update file on a TFTP server, used 4833 updatefile - Location of the software update file on a TFTP server, used
4823 by the automatic software update feature. Please refer to 4834 by the automatic software update feature. Please refer to
4824 documentation in doc/README.update for more details. 4835 documentation in doc/README.update for more details.
4825 4836
4826 autoload - if set to "no" (any string beginning with 'n'), 4837 autoload - if set to "no" (any string beginning with 'n'),
4827 "bootp" will just load perform a lookup of the 4838 "bootp" will just load perform a lookup of the
4828 configuration from the BOOTP server, but not try to 4839 configuration from the BOOTP server, but not try to
4829 load any image using TFTP 4840 load any image using TFTP
4830 4841
4831 autostart - if set to "yes", an image loaded using the "bootp", 4842 autostart - if set to "yes", an image loaded using the "bootp",
4832 "rarpboot", "tftpboot" or "diskboot" commands will 4843 "rarpboot", "tftpboot" or "diskboot" commands will
4833 be automatically started (by internally calling 4844 be automatically started (by internally calling
4834 "bootm") 4845 "bootm")
4835 4846
4836 If set to "no", a standalone image passed to the 4847 If set to "no", a standalone image passed to the
4837 "bootm" command will be copied to the load address 4848 "bootm" command will be copied to the load address
4838 (and eventually uncompressed), but NOT be started. 4849 (and eventually uncompressed), but NOT be started.
4839 This can be used to load and uncompress arbitrary 4850 This can be used to load and uncompress arbitrary
4840 data. 4851 data.
4841 4852
4842 fdt_high - if set this restricts the maximum address that the 4853 fdt_high - if set this restricts the maximum address that the
4843 flattened device tree will be copied into upon boot. 4854 flattened device tree will be copied into upon boot.
4844 For example, if you have a system with 1 GB memory 4855 For example, if you have a system with 1 GB memory
4845 at physical address 0x10000000, while Linux kernel 4856 at physical address 0x10000000, while Linux kernel
4846 only recognizes the first 704 MB as low memory, you 4857 only recognizes the first 704 MB as low memory, you
4847 may need to set fdt_high as 0x3C000000 to have the 4858 may need to set fdt_high as 0x3C000000 to have the
4848 device tree blob be copied to the maximum address 4859 device tree blob be copied to the maximum address
4849 of the 704 MB low memory, so that Linux kernel can 4860 of the 704 MB low memory, so that Linux kernel can
4850 access it during the boot procedure. 4861 access it during the boot procedure.
4851 4862
4852 If this is set to the special value 0xFFFFFFFF then 4863 If this is set to the special value 0xFFFFFFFF then
4853 the fdt will not be copied at all on boot. For this 4864 the fdt will not be copied at all on boot. For this
4854 to work it must reside in writable memory, have 4865 to work it must reside in writable memory, have
4855 sufficient padding on the end of it for u-boot to 4866 sufficient padding on the end of it for u-boot to
4856 add the information it needs into it, and the memory 4867 add the information it needs into it, and the memory
4857 must be accessible by the kernel. 4868 must be accessible by the kernel.
4858 4869
4859 fdtcontroladdr- if set this is the address of the control flattened 4870 fdtcontroladdr- if set this is the address of the control flattened
4860 device tree used by U-Boot when CONFIG_OF_CONTROL is 4871 device tree used by U-Boot when CONFIG_OF_CONTROL is
4861 defined. 4872 defined.
4862 4873
4863 i2cfast - (PPC405GP|PPC405EP only) 4874 i2cfast - (PPC405GP|PPC405EP only)
4864 if set to 'y' configures Linux I2C driver for fast 4875 if set to 'y' configures Linux I2C driver for fast
4865 mode (400kHZ). This environment variable is used in 4876 mode (400kHZ). This environment variable is used in
4866 initialization code. So, for changes to be effective 4877 initialization code. So, for changes to be effective
4867 it must be saved and board must be reset. 4878 it must be saved and board must be reset.
4868 4879
4869 initrd_high - restrict positioning of initrd images: 4880 initrd_high - restrict positioning of initrd images:
4870 If this variable is not set, initrd images will be 4881 If this variable is not set, initrd images will be
4871 copied to the highest possible address in RAM; this 4882 copied to the highest possible address in RAM; this
4872 is usually what you want since it allows for 4883 is usually what you want since it allows for
4873 maximum initrd size. If for some reason you want to 4884 maximum initrd size. If for some reason you want to
4874 make sure that the initrd image is loaded below the 4885 make sure that the initrd image is loaded below the
4875 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4886 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4876 variable to a value of "no" or "off" or "0". 4887 variable to a value of "no" or "off" or "0".
4877 Alternatively, you can set it to a maximum upper 4888 Alternatively, you can set it to a maximum upper
4878 address to use (U-Boot will still check that it 4889 address to use (U-Boot will still check that it
4879 does not overwrite the U-Boot stack and data). 4890 does not overwrite the U-Boot stack and data).
4880 4891
4881 For instance, when you have a system with 16 MB 4892 For instance, when you have a system with 16 MB
4882 RAM, and want to reserve 4 MB from use by Linux, 4893 RAM, and want to reserve 4 MB from use by Linux,
4883 you can do this by adding "mem=12M" to the value of 4894 you can do this by adding "mem=12M" to the value of
4884 the "bootargs" variable. However, now you must make 4895 the "bootargs" variable. However, now you must make
4885 sure that the initrd image is placed in the first 4896 sure that the initrd image is placed in the first
4886 12 MB as well - this can be done with 4897 12 MB as well - this can be done with
4887 4898
4888 setenv initrd_high 00c00000 4899 setenv initrd_high 00c00000
4889 4900
4890 If you set initrd_high to 0xFFFFFFFF, this is an 4901 If you set initrd_high to 0xFFFFFFFF, this is an
4891 indication to U-Boot that all addresses are legal 4902 indication to U-Boot that all addresses are legal
4892 for the Linux kernel, including addresses in flash 4903 for the Linux kernel, including addresses in flash
4893 memory. In this case U-Boot will NOT COPY the 4904 memory. In this case U-Boot will NOT COPY the
4894 ramdisk at all. This may be useful to reduce the 4905 ramdisk at all. This may be useful to reduce the
4895 boot time on your system, but requires that this 4906 boot time on your system, but requires that this
4896 feature is supported by your Linux kernel. 4907 feature is supported by your Linux kernel.
4897 4908
4898 ipaddr - IP address; needed for tftpboot command 4909 ipaddr - IP address; needed for tftpboot command
4899 4910
4900 loadaddr - Default load address for commands like "bootp", 4911 loadaddr - Default load address for commands like "bootp",
4901 "rarpboot", "tftpboot", "loadb" or "diskboot" 4912 "rarpboot", "tftpboot", "loadb" or "diskboot"
4902 4913
4903 loads_echo - see CONFIG_LOADS_ECHO 4914 loads_echo - see CONFIG_LOADS_ECHO
4904 4915
4905 serverip - TFTP server IP address; needed for tftpboot command 4916 serverip - TFTP server IP address; needed for tftpboot command
4906 4917
4907 bootretry - see CONFIG_BOOT_RETRY_TIME 4918 bootretry - see CONFIG_BOOT_RETRY_TIME
4908 4919
4909 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4920 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
4910 4921
4911 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4922 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
4912 4923
4913 ethprime - controls which interface is used first. 4924 ethprime - controls which interface is used first.
4914 4925
4915 ethact - controls which interface is currently active. 4926 ethact - controls which interface is currently active.
4916 For example you can do the following 4927 For example you can do the following
4917 4928
4918 => setenv ethact FEC 4929 => setenv ethact FEC
4919 => ping 192.168.0.1 # traffic sent on FEC 4930 => ping 192.168.0.1 # traffic sent on FEC
4920 => setenv ethact SCC 4931 => setenv ethact SCC
4921 => ping 10.0.0.1 # traffic sent on SCC 4932 => ping 10.0.0.1 # traffic sent on SCC
4922 4933
4923 ethrotate - When set to "no" U-Boot does not go through all 4934 ethrotate - When set to "no" U-Boot does not go through all
4924 available network interfaces. 4935 available network interfaces.
4925 It just stays at the currently selected interface. 4936 It just stays at the currently selected interface.
4926 4937
4927 netretry - When set to "no" each network operation will 4938 netretry - When set to "no" each network operation will
4928 either succeed or fail without retrying. 4939 either succeed or fail without retrying.
4929 When set to "once" the network operation will 4940 When set to "once" the network operation will
4930 fail when all the available network interfaces 4941 fail when all the available network interfaces
4931 are tried once without success. 4942 are tried once without success.
4932 Useful on scripts which control the retry operation 4943 Useful on scripts which control the retry operation
4933 themselves. 4944 themselves.
4934 4945
4935 npe_ucode - set load address for the NPE microcode 4946 npe_ucode - set load address for the NPE microcode
4936 4947
4937 silent_linux - If set then linux will be told to boot silently, by 4948 silent_linux - If set then linux will be told to boot silently, by
4938 changing the console to be empty. If "yes" it will be 4949 changing the console to be empty. If "yes" it will be
4939 made silent. If "no" it will not be made silent. If 4950 made silent. If "no" it will not be made silent. If
4940 unset, then it will be made silent if the U-Boot console 4951 unset, then it will be made silent if the U-Boot console
4941 is silent. 4952 is silent.
4942 4953
4943 tftpsrcport - If this is set, the value is used for TFTP's 4954 tftpsrcport - If this is set, the value is used for TFTP's
4944 UDP source port. 4955 UDP source port.
4945 4956
4946 tftpdstport - If this is set, the value is used for TFTP's UDP 4957 tftpdstport - If this is set, the value is used for TFTP's UDP
4947 destination port instead of the Well Know Port 69. 4958 destination port instead of the Well Know Port 69.
4948 4959
4949 tftpblocksize - Block size to use for TFTP transfers; if not set, 4960 tftpblocksize - Block size to use for TFTP transfers; if not set,
4950 we use the TFTP server's default block size 4961 we use the TFTP server's default block size
4951 4962
4952 tftptimeout - Retransmission timeout for TFTP packets (in milli- 4963 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4953 seconds, minimum value is 1000 = 1 second). Defines 4964 seconds, minimum value is 1000 = 1 second). Defines
4954 when a packet is considered to be lost so it has to 4965 when a packet is considered to be lost so it has to
4955 be retransmitted. The default is 5000 = 5 seconds. 4966 be retransmitted. The default is 5000 = 5 seconds.
4956 Lowering this value may make downloads succeed 4967 Lowering this value may make downloads succeed
4957 faster in networks with high packet loss rates or 4968 faster in networks with high packet loss rates or
4958 with unreliable TFTP servers. 4969 with unreliable TFTP servers.
4959 4970
4960 vlan - When set to a value < 4095 the traffic over 4971 vlan - When set to a value < 4095 the traffic over
4961 Ethernet is encapsulated/received over 802.1q 4972 Ethernet is encapsulated/received over 802.1q
4962 VLAN tagged frames. 4973 VLAN tagged frames.
4963 4974
4964 The following image location variables contain the location of images 4975 The following image location variables contain the location of images
4965 used in booting. The "Image" column gives the role of the image and is 4976 used in booting. The "Image" column gives the role of the image and is
4966 not an environment variable name. The other columns are environment 4977 not an environment variable name. The other columns are environment
4967 variable names. "File Name" gives the name of the file on a TFTP 4978 variable names. "File Name" gives the name of the file on a TFTP
4968 server, "RAM Address" gives the location in RAM the image will be 4979 server, "RAM Address" gives the location in RAM the image will be
4969 loaded to, and "Flash Location" gives the image's address in NOR 4980 loaded to, and "Flash Location" gives the image's address in NOR
4970 flash or offset in NAND flash. 4981 flash or offset in NAND flash.
4971 4982
4972 *Note* - these variables don't have to be defined for all boards, some 4983 *Note* - these variables don't have to be defined for all boards, some
4973 boards currenlty use other variables for these purposes, and some 4984 boards currenlty use other variables for these purposes, and some
4974 boards use these variables for other purposes. 4985 boards use these variables for other purposes.
4975 4986
4976 Image File Name RAM Address Flash Location 4987 Image File Name RAM Address Flash Location
4977 ----- --------- ----------- -------------- 4988 ----- --------- ----------- --------------
4978 u-boot u-boot u-boot_addr_r u-boot_addr 4989 u-boot u-boot u-boot_addr_r u-boot_addr
4979 Linux kernel bootfile kernel_addr_r kernel_addr 4990 Linux kernel bootfile kernel_addr_r kernel_addr
4980 device tree blob fdtfile fdt_addr_r fdt_addr 4991 device tree blob fdtfile fdt_addr_r fdt_addr
4981 ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4992 ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
4982 4993
4983 The following environment variables may be used and automatically 4994 The following environment variables may be used and automatically
4984 updated by the network boot commands ("bootp" and "rarpboot"), 4995 updated by the network boot commands ("bootp" and "rarpboot"),
4985 depending the information provided by your boot server: 4996 depending the information provided by your boot server:
4986 4997
4987 bootfile - see above 4998 bootfile - see above
4988 dnsip - IP address of your Domain Name Server 4999 dnsip - IP address of your Domain Name Server
4989 dnsip2 - IP address of your secondary Domain Name Server 5000 dnsip2 - IP address of your secondary Domain Name Server
4990 gatewayip - IP address of the Gateway (Router) to use 5001 gatewayip - IP address of the Gateway (Router) to use
4991 hostname - Target hostname 5002 hostname - Target hostname
4992 ipaddr - see above 5003 ipaddr - see above
4993 netmask - Subnet Mask 5004 netmask - Subnet Mask
4994 rootpath - Pathname of the root filesystem on the NFS server 5005 rootpath - Pathname of the root filesystem on the NFS server
4995 serverip - see above 5006 serverip - see above
4996 5007
4997 5008
4998 There are two special Environment Variables: 5009 There are two special Environment Variables:
4999 5010
5000 serial# - contains hardware identification information such 5011 serial# - contains hardware identification information such
5001 as type string and/or serial number 5012 as type string and/or serial number
5002 ethaddr - Ethernet address 5013 ethaddr - Ethernet address
5003 5014
5004 These variables can be set only once (usually during manufacturing of 5015 These variables can be set only once (usually during manufacturing of
5005 the board). U-Boot refuses to delete or overwrite these variables 5016 the board). U-Boot refuses to delete or overwrite these variables
5006 once they have been set once. 5017 once they have been set once.
5007 5018
5008 5019
5009 Further special Environment Variables: 5020 Further special Environment Variables:
5010 5021
5011 ver - Contains the U-Boot version string as printed 5022 ver - Contains the U-Boot version string as printed
5012 with the "version" command. This variable is 5023 with the "version" command. This variable is
5013 readonly (see CONFIG_VERSION_VARIABLE). 5024 readonly (see CONFIG_VERSION_VARIABLE).
5014 5025
5015 5026
5016 Please note that changes to some configuration parameters may take 5027 Please note that changes to some configuration parameters may take
5017 only effect after the next boot (yes, that's just like Windoze :-). 5028 only effect after the next boot (yes, that's just like Windoze :-).
5018 5029
5019 5030
5020 Callback functions for environment variables: 5031 Callback functions for environment variables:
5021 --------------------------------------------- 5032 ---------------------------------------------
5022 5033
5023 For some environment variables, the behavior of u-boot needs to change 5034 For some environment variables, the behavior of u-boot needs to change
5024 when their values are changed. This functionailty allows functions to 5035 when their values are changed. This functionailty allows functions to
5025 be associated with arbitrary variables. On creation, overwrite, or 5036 be associated with arbitrary variables. On creation, overwrite, or
5026 deletion, the callback will provide the opportunity for some side 5037 deletion, the callback will provide the opportunity for some side
5027 effect to happen or for the change to be rejected. 5038 effect to happen or for the change to be rejected.
5028 5039
5029 The callbacks are named and associated with a function using the 5040 The callbacks are named and associated with a function using the
5030 U_BOOT_ENV_CALLBACK macro in your board or driver code. 5041 U_BOOT_ENV_CALLBACK macro in your board or driver code.
5031 5042
5032 These callbacks are associated with variables in one of two ways. The 5043 These callbacks are associated with variables in one of two ways. The
5033 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5044 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5034 in the board configuration to a string that defines a list of 5045 in the board configuration to a string that defines a list of
5035 associations. The list must be in the following format: 5046 associations. The list must be in the following format:
5036 5047
5037 entry = variable_name[:callback_name] 5048 entry = variable_name[:callback_name]
5038 list = entry[,list] 5049 list = entry[,list]
5039 5050
5040 If the callback name is not specified, then the callback is deleted. 5051 If the callback name is not specified, then the callback is deleted.
5041 Spaces are also allowed anywhere in the list. 5052 Spaces are also allowed anywhere in the list.
5042 5053
5043 Callbacks can also be associated by defining the ".callbacks" variable 5054 Callbacks can also be associated by defining the ".callbacks" variable
5044 with the same list format above. Any association in ".callbacks" will 5055 with the same list format above. Any association in ".callbacks" will
5045 override any association in the static list. You can define 5056 override any association in the static list. You can define
5046 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5057 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5047 ".callbacks" envirnoment variable in the default or embedded environment. 5058 ".callbacks" envirnoment variable in the default or embedded environment.
5048 5059
5049 5060
5050 Command Line Parsing: 5061 Command Line Parsing:
5051 ===================== 5062 =====================
5052 5063
5053 There are two different command line parsers available with U-Boot: 5064 There are two different command line parsers available with U-Boot:
5054 the old "simple" one, and the much more powerful "hush" shell: 5065 the old "simple" one, and the much more powerful "hush" shell:
5055 5066
5056 Old, simple command line parser: 5067 Old, simple command line parser:
5057 -------------------------------- 5068 --------------------------------
5058 5069
5059 - supports environment variables (through setenv / saveenv commands) 5070 - supports environment variables (through setenv / saveenv commands)
5060 - several commands on one line, separated by ';' 5071 - several commands on one line, separated by ';'
5061 - variable substitution using "... ${name} ..." syntax 5072 - variable substitution using "... ${name} ..." syntax
5062 - special characters ('$', ';') can be escaped by prefixing with '\', 5073 - special characters ('$', ';') can be escaped by prefixing with '\',
5063 for example: 5074 for example:
5064 setenv bootcmd bootm \${address} 5075 setenv bootcmd bootm \${address}
5065 - You can also escape text by enclosing in single apostrophes, for example: 5076 - You can also escape text by enclosing in single apostrophes, for example:
5066 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5077 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5067 5078
5068 Hush shell: 5079 Hush shell:
5069 ----------- 5080 -----------
5070 5081
5071 - similar to Bourne shell, with control structures like 5082 - similar to Bourne shell, with control structures like
5072 if...then...else...fi, for...do...done; while...do...done, 5083 if...then...else...fi, for...do...done; while...do...done,
5073 until...do...done, ... 5084 until...do...done, ...
5074 - supports environment ("global") variables (through setenv / saveenv 5085 - supports environment ("global") variables (through setenv / saveenv
5075 commands) and local shell variables (through standard shell syntax 5086 commands) and local shell variables (through standard shell syntax
5076 "name=value"); only environment variables can be used with "run" 5087 "name=value"); only environment variables can be used with "run"
5077 command 5088 command
5078 5089
5079 General rules: 5090 General rules:
5080 -------------- 5091 --------------
5081 5092
5082 (1) If a command line (or an environment variable executed by a "run" 5093 (1) If a command line (or an environment variable executed by a "run"
5083 command) contains several commands separated by semicolon, and 5094 command) contains several commands separated by semicolon, and
5084 one of these commands fails, then the remaining commands will be 5095 one of these commands fails, then the remaining commands will be
5085 executed anyway. 5096 executed anyway.
5086 5097
5087 (2) If you execute several variables with one call to run (i. e. 5098 (2) If you execute several variables with one call to run (i. e.
5088 calling run with a list of variables as arguments), any failing 5099 calling run with a list of variables as arguments), any failing
5089 command will cause "run" to terminate, i. e. the remaining 5100 command will cause "run" to terminate, i. e. the remaining
5090 variables are not executed. 5101 variables are not executed.
5091 5102
5092 Note for Redundant Ethernet Interfaces: 5103 Note for Redundant Ethernet Interfaces:
5093 ======================================= 5104 =======================================
5094 5105
5095 Some boards come with redundant Ethernet interfaces; U-Boot supports 5106 Some boards come with redundant Ethernet interfaces; U-Boot supports
5096 such configurations and is capable of automatic selection of a 5107 such configurations and is capable of automatic selection of a
5097 "working" interface when needed. MAC assignment works as follows: 5108 "working" interface when needed. MAC assignment works as follows:
5098 5109
5099 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 5110 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5100 MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5111 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5101 "eth1addr" (=>eth1), "eth2addr", ... 5112 "eth1addr" (=>eth1), "eth2addr", ...
5102 5113
5103 If the network interface stores some valid MAC address (for instance 5114 If the network interface stores some valid MAC address (for instance
5104 in SROM), this is used as default address if there is NO correspon- 5115 in SROM), this is used as default address if there is NO correspon-
5105 ding setting in the environment; if the corresponding environment 5116 ding setting in the environment; if the corresponding environment
5106 variable is set, this overrides the settings in the card; that means: 5117 variable is set, this overrides the settings in the card; that means:
5107 5118
5108 o If the SROM has a valid MAC address, and there is no address in the 5119 o If the SROM has a valid MAC address, and there is no address in the
5109 environment, the SROM's address is used. 5120 environment, the SROM's address is used.
5110 5121
5111 o If there is no valid address in the SROM, and a definition in the 5122 o If there is no valid address in the SROM, and a definition in the
5112 environment exists, then the value from the environment variable is 5123 environment exists, then the value from the environment variable is
5113 used. 5124 used.
5114 5125
5115 o If both the SROM and the environment contain a MAC address, and 5126 o If both the SROM and the environment contain a MAC address, and
5116 both addresses are the same, this MAC address is used. 5127 both addresses are the same, this MAC address is used.
5117 5128
5118 o If both the SROM and the environment contain a MAC address, and the 5129 o If both the SROM and the environment contain a MAC address, and the
5119 addresses differ, the value from the environment is used and a 5130 addresses differ, the value from the environment is used and a
5120 warning is printed. 5131 warning is printed.
5121 5132
5122 o If neither SROM nor the environment contain a MAC address, an error 5133 o If neither SROM nor the environment contain a MAC address, an error
5123 is raised. 5134 is raised.
5124 5135
5125 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5136 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5126 will be programmed into hardware as part of the initialization process. This 5137 will be programmed into hardware as part of the initialization process. This
5127 may be skipped by setting the appropriate 'ethmacskip' environment variable. 5138 may be skipped by setting the appropriate 'ethmacskip' environment variable.
5128 The naming convention is as follows: 5139 The naming convention is as follows:
5129 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5140 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5130 5141
5131 Image Formats: 5142 Image Formats:
5132 ============== 5143 ==============
5133 5144
5134 U-Boot is capable of booting (and performing other auxiliary operations on) 5145 U-Boot is capable of booting (and performing other auxiliary operations on)
5135 images in two formats: 5146 images in two formats:
5136 5147
5137 New uImage format (FIT) 5148 New uImage format (FIT)
5138 ----------------------- 5149 -----------------------
5139 5150
5140 Flexible and powerful format based on Flattened Image Tree -- FIT (similar 5151 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5141 to Flattened Device Tree). It allows the use of images with multiple 5152 to Flattened Device Tree). It allows the use of images with multiple
5142 components (several kernels, ramdisks, etc.), with contents protected by 5153 components (several kernels, ramdisks, etc.), with contents protected by
5143 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 5154 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5144 5155
5145 5156
5146 Old uImage format 5157 Old uImage format
5147 ----------------- 5158 -----------------
5148 5159
5149 Old image format is based on binary files which can be basically anything, 5160 Old image format is based on binary files which can be basically anything,
5150 preceded by a special header; see the definitions in include/image.h for 5161 preceded by a special header; see the definitions in include/image.h for
5151 details; basically, the header defines the following image properties: 5162 details; basically, the header defines the following image properties:
5152 5163
5153 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5164 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5154 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5165 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5155 LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5166 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5156 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5167 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5157 INTEGRITY). 5168 INTEGRITY).
5158 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5169 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5159 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5170 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5160 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5171 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5161 * Compression Type (uncompressed, gzip, bzip2) 5172 * Compression Type (uncompressed, gzip, bzip2)
5162 * Load Address 5173 * Load Address
5163 * Entry Point 5174 * Entry Point
5164 * Image Name 5175 * Image Name
5165 * Image Timestamp 5176 * Image Timestamp
5166 5177
5167 The header is marked by a special Magic Number, and both the header 5178 The header is marked by a special Magic Number, and both the header
5168 and the data portions of the image are secured against corruption by 5179 and the data portions of the image are secured against corruption by
5169 CRC32 checksums. 5180 CRC32 checksums.
5170 5181
5171 5182
5172 Linux Support: 5183 Linux Support:
5173 ============== 5184 ==============
5174 5185
5175 Although U-Boot should support any OS or standalone application 5186 Although U-Boot should support any OS or standalone application
5176 easily, the main focus has always been on Linux during the design of 5187 easily, the main focus has always been on Linux during the design of
5177 U-Boot. 5188 U-Boot.
5178 5189
5179 U-Boot includes many features that so far have been part of some 5190 U-Boot includes many features that so far have been part of some
5180 special "boot loader" code within the Linux kernel. Also, any 5191 special "boot loader" code within the Linux kernel. Also, any
5181 "initrd" images to be used are no longer part of one big Linux image; 5192 "initrd" images to be used are no longer part of one big Linux image;
5182 instead, kernel and "initrd" are separate images. This implementation 5193 instead, kernel and "initrd" are separate images. This implementation
5183 serves several purposes: 5194 serves several purposes:
5184 5195
5185 - the same features can be used for other OS or standalone 5196 - the same features can be used for other OS or standalone
5186 applications (for instance: using compressed images to reduce the 5197 applications (for instance: using compressed images to reduce the
5187 Flash memory footprint) 5198 Flash memory footprint)
5188 5199
5189 - it becomes much easier to port new Linux kernel versions because 5200 - it becomes much easier to port new Linux kernel versions because
5190 lots of low-level, hardware dependent stuff are done by U-Boot 5201 lots of low-level, hardware dependent stuff are done by U-Boot
5191 5202
5192 - the same Linux kernel image can now be used with different "initrd" 5203 - the same Linux kernel image can now be used with different "initrd"
5193 images; of course this also means that different kernel images can 5204 images; of course this also means that different kernel images can
5194 be run with the same "initrd". This makes testing easier (you don't 5205 be run with the same "initrd". This makes testing easier (you don't
5195 have to build a new "zImage.initrd" Linux image when you just 5206 have to build a new "zImage.initrd" Linux image when you just
5196 change a file in your "initrd"). Also, a field-upgrade of the 5207 change a file in your "initrd"). Also, a field-upgrade of the
5197 software is easier now. 5208 software is easier now.
5198 5209
5199 5210
5200 Linux HOWTO: 5211 Linux HOWTO:
5201 ============ 5212 ============
5202 5213
5203 Porting Linux to U-Boot based systems: 5214 Porting Linux to U-Boot based systems:
5204 --------------------------------------- 5215 ---------------------------------------
5205 5216
5206 U-Boot cannot save you from doing all the necessary modifications to 5217 U-Boot cannot save you from doing all the necessary modifications to
5207 configure the Linux device drivers for use with your target hardware 5218 configure the Linux device drivers for use with your target hardware
5208 (no, we don't intend to provide a full virtual machine interface to 5219 (no, we don't intend to provide a full virtual machine interface to
5209 Linux :-). 5220 Linux :-).
5210 5221
5211 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5222 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5212 5223
5213 Just make sure your machine specific header file (for instance 5224 Just make sure your machine specific header file (for instance
5214 include/asm-ppc/tqm8xx.h) includes the same definition of the Board 5225 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
5215 Information structure as we define in include/asm-<arch>/u-boot.h, 5226 Information structure as we define in include/asm-<arch>/u-boot.h,
5216 and make sure that your definition of IMAP_ADDR uses the same value 5227 and make sure that your definition of IMAP_ADDR uses the same value
5217 as your U-Boot configuration in CONFIG_SYS_IMMR. 5228 as your U-Boot configuration in CONFIG_SYS_IMMR.
5218 5229
5219 5230
5220 Configuring the Linux kernel: 5231 Configuring the Linux kernel:
5221 ----------------------------- 5232 -----------------------------
5222 5233
5223 No specific requirements for U-Boot. Make sure you have some root 5234 No specific requirements for U-Boot. Make sure you have some root
5224 device (initial ramdisk, NFS) for your target system. 5235 device (initial ramdisk, NFS) for your target system.
5225 5236
5226 5237
5227 Building a Linux Image: 5238 Building a Linux Image:
5228 ----------------------- 5239 -----------------------
5229 5240
5230 With U-Boot, "normal" build targets like "zImage" or "bzImage" are 5241 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5231 not used. If you use recent kernel source, a new build target 5242 not used. If you use recent kernel source, a new build target
5232 "uImage" will exist which automatically builds an image usable by 5243 "uImage" will exist which automatically builds an image usable by
5233 U-Boot. Most older kernels also have support for a "pImage" target, 5244 U-Boot. Most older kernels also have support for a "pImage" target,
5234 which was introduced for our predecessor project PPCBoot and uses a 5245 which was introduced for our predecessor project PPCBoot and uses a
5235 100% compatible format. 5246 100% compatible format.
5236 5247
5237 Example: 5248 Example:
5238 5249
5239 make TQM850L_config 5250 make TQM850L_config
5240 make oldconfig 5251 make oldconfig
5241 make dep 5252 make dep
5242 make uImage 5253 make uImage
5243 5254
5244 The "uImage" build target uses a special tool (in 'tools/mkimage') to 5255 The "uImage" build target uses a special tool (in 'tools/mkimage') to
5245 encapsulate a compressed Linux kernel image with header information, 5256 encapsulate a compressed Linux kernel image with header information,
5246 CRC32 checksum etc. for use with U-Boot. This is what we are doing: 5257 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
5247 5258
5248 * build a standard "vmlinux" kernel image (in ELF binary format): 5259 * build a standard "vmlinux" kernel image (in ELF binary format):
5249 5260
5250 * convert the kernel into a raw binary image: 5261 * convert the kernel into a raw binary image:
5251 5262
5252 ${CROSS_COMPILE}-objcopy -O binary \ 5263 ${CROSS_COMPILE}-objcopy -O binary \
5253 -R .note -R .comment \ 5264 -R .note -R .comment \
5254 -S vmlinux linux.bin 5265 -S vmlinux linux.bin
5255 5266
5256 * compress the binary image: 5267 * compress the binary image:
5257 5268
5258 gzip -9 linux.bin 5269 gzip -9 linux.bin
5259 5270
5260 * package compressed binary image for U-Boot: 5271 * package compressed binary image for U-Boot:
5261 5272
5262 mkimage -A ppc -O linux -T kernel -C gzip \ 5273 mkimage -A ppc -O linux -T kernel -C gzip \
5263 -a 0 -e 0 -n "Linux Kernel Image" \ 5274 -a 0 -e 0 -n "Linux Kernel Image" \
5264 -d linux.bin.gz uImage 5275 -d linux.bin.gz uImage
5265 5276
5266 5277
5267 The "mkimage" tool can also be used to create ramdisk images for use 5278 The "mkimage" tool can also be used to create ramdisk images for use
5268 with U-Boot, either separated from the Linux kernel image, or 5279 with U-Boot, either separated from the Linux kernel image, or
5269 combined into one file. "mkimage" encapsulates the images with a 64 5280 combined into one file. "mkimage" encapsulates the images with a 64
5270 byte header containing information about target architecture, 5281 byte header containing information about target architecture,
5271 operating system, image type, compression method, entry points, time 5282 operating system, image type, compression method, entry points, time
5272 stamp, CRC32 checksums, etc. 5283 stamp, CRC32 checksums, etc.
5273 5284
5274 "mkimage" can be called in two ways: to verify existing images and 5285 "mkimage" can be called in two ways: to verify existing images and
5275 print the header information, or to build new images. 5286 print the header information, or to build new images.
5276 5287
5277 In the first form (with "-l" option) mkimage lists the information 5288 In the first form (with "-l" option) mkimage lists the information
5278 contained in the header of an existing U-Boot image; this includes 5289 contained in the header of an existing U-Boot image; this includes
5279 checksum verification: 5290 checksum verification:
5280 5291
5281 tools/mkimage -l image 5292 tools/mkimage -l image
5282 -l ==> list image header information 5293 -l ==> list image header information
5283 5294
5284 The second form (with "-d" option) is used to build a U-Boot image 5295 The second form (with "-d" option) is used to build a U-Boot image
5285 from a "data file" which is used as image payload: 5296 from a "data file" which is used as image payload:
5286 5297
5287 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5298 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5288 -n name -d data_file image 5299 -n name -d data_file image
5289 -A ==> set architecture to 'arch' 5300 -A ==> set architecture to 'arch'
5290 -O ==> set operating system to 'os' 5301 -O ==> set operating system to 'os'
5291 -T ==> set image type to 'type' 5302 -T ==> set image type to 'type'
5292 -C ==> set compression type 'comp' 5303 -C ==> set compression type 'comp'
5293 -a ==> set load address to 'addr' (hex) 5304 -a ==> set load address to 'addr' (hex)
5294 -e ==> set entry point to 'ep' (hex) 5305 -e ==> set entry point to 'ep' (hex)
5295 -n ==> set image name to 'name' 5306 -n ==> set image name to 'name'
5296 -d ==> use image data from 'datafile' 5307 -d ==> use image data from 'datafile'
5297 5308
5298 Right now, all Linux kernels for PowerPC systems use the same load 5309 Right now, all Linux kernels for PowerPC systems use the same load
5299 address (0x00000000), but the entry point address depends on the 5310 address (0x00000000), but the entry point address depends on the
5300 kernel version: 5311 kernel version:
5301 5312
5302 - 2.2.x kernels have the entry point at 0x0000000C, 5313 - 2.2.x kernels have the entry point at 0x0000000C,
5303 - 2.3.x and later kernels have the entry point at 0x00000000. 5314 - 2.3.x and later kernels have the entry point at 0x00000000.
5304 5315
5305 So a typical call to build a U-Boot image would read: 5316 So a typical call to build a U-Boot image would read:
5306 5317
5307 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 5318 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5308 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5319 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5309 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 5320 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
5310 > examples/uImage.TQM850L 5321 > examples/uImage.TQM850L
5311 Image Name: 2.4.4 kernel for TQM850L 5322 Image Name: 2.4.4 kernel for TQM850L
5312 Created: Wed Jul 19 02:34:59 2000 5323 Created: Wed Jul 19 02:34:59 2000
5313 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5324 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5314 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5325 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5315 Load Address: 0x00000000 5326 Load Address: 0x00000000
5316 Entry Point: 0x00000000 5327 Entry Point: 0x00000000
5317 5328
5318 To verify the contents of the image (or check for corruption): 5329 To verify the contents of the image (or check for corruption):
5319 5330
5320 -> tools/mkimage -l examples/uImage.TQM850L 5331 -> tools/mkimage -l examples/uImage.TQM850L
5321 Image Name: 2.4.4 kernel for TQM850L 5332 Image Name: 2.4.4 kernel for TQM850L
5322 Created: Wed Jul 19 02:34:59 2000 5333 Created: Wed Jul 19 02:34:59 2000
5323 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5334 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5324 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5335 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5325 Load Address: 0x00000000 5336 Load Address: 0x00000000
5326 Entry Point: 0x00000000 5337 Entry Point: 0x00000000
5327 5338
5328 NOTE: for embedded systems where boot time is critical you can trade 5339 NOTE: for embedded systems where boot time is critical you can trade
5329 speed for memory and install an UNCOMPRESSED image instead: this 5340 speed for memory and install an UNCOMPRESSED image instead: this
5330 needs more space in Flash, but boots much faster since it does not 5341 needs more space in Flash, but boots much faster since it does not
5331 need to be uncompressed: 5342 need to be uncompressed:
5332 5343
5333 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 5344 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
5334 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 5345 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5335 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5346 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5336 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 5347 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
5337 > examples/uImage.TQM850L-uncompressed 5348 > examples/uImage.TQM850L-uncompressed
5338 Image Name: 2.4.4 kernel for TQM850L 5349 Image Name: 2.4.4 kernel for TQM850L
5339 Created: Wed Jul 19 02:34:59 2000 5350 Created: Wed Jul 19 02:34:59 2000
5340 Image Type: PowerPC Linux Kernel Image (uncompressed) 5351 Image Type: PowerPC Linux Kernel Image (uncompressed)
5341 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5352 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5342 Load Address: 0x00000000 5353 Load Address: 0x00000000
5343 Entry Point: 0x00000000 5354 Entry Point: 0x00000000
5344 5355
5345 5356
5346 Similar you can build U-Boot images from a 'ramdisk.image.gz' file 5357 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5347 when your kernel is intended to use an initial ramdisk: 5358 when your kernel is intended to use an initial ramdisk:
5348 5359
5349 -> tools/mkimage -n 'Simple Ramdisk Image' \ 5360 -> tools/mkimage -n 'Simple Ramdisk Image' \
5350 > -A ppc -O linux -T ramdisk -C gzip \ 5361 > -A ppc -O linux -T ramdisk -C gzip \
5351 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5362 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5352 Image Name: Simple Ramdisk Image 5363 Image Name: Simple Ramdisk Image
5353 Created: Wed Jan 12 14:01:50 2000 5364 Created: Wed Jan 12 14:01:50 2000
5354 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5365 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5355 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5366 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5356 Load Address: 0x00000000 5367 Load Address: 0x00000000
5357 Entry Point: 0x00000000 5368 Entry Point: 0x00000000
5358 5369
5359 The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5370 The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5360 option performs the converse operation of the mkimage's second form (the "-d" 5371 option performs the converse operation of the mkimage's second form (the "-d"
5361 option). Given an image built by mkimage, the dumpimage extracts a "data file" 5372 option). Given an image built by mkimage, the dumpimage extracts a "data file"
5362 from the image: 5373 from the image:
5363 5374
5364 tools/dumpimage -i image -p position data_file 5375 tools/dumpimage -i image -p position data_file
5365 -i ==> extract from the 'image' a specific 'data_file', \ 5376 -i ==> extract from the 'image' a specific 'data_file', \
5366 indexed by 'position' 5377 indexed by 'position'
5367 5378
5368 5379
5369 Installing a Linux Image: 5380 Installing a Linux Image:
5370 ------------------------- 5381 -------------------------
5371 5382
5372 To downloading a U-Boot image over the serial (console) interface, 5383 To downloading a U-Boot image over the serial (console) interface,
5373 you must convert the image to S-Record format: 5384 you must convert the image to S-Record format:
5374 5385
5375 objcopy -I binary -O srec examples/image examples/image.srec 5386 objcopy -I binary -O srec examples/image examples/image.srec
5376 5387
5377 The 'objcopy' does not understand the information in the U-Boot 5388 The 'objcopy' does not understand the information in the U-Boot
5378 image header, so the resulting S-Record file will be relative to 5389 image header, so the resulting S-Record file will be relative to
5379 address 0x00000000. To load it to a given address, you need to 5390 address 0x00000000. To load it to a given address, you need to
5380 specify the target address as 'offset' parameter with the 'loads' 5391 specify the target address as 'offset' parameter with the 'loads'
5381 command. 5392 command.
5382 5393
5383 Example: install the image to address 0x40100000 (which on the 5394 Example: install the image to address 0x40100000 (which on the
5384 TQM8xxL is in the first Flash bank): 5395 TQM8xxL is in the first Flash bank):
5385 5396
5386 => erase 40100000 401FFFFF 5397 => erase 40100000 401FFFFF
5387 5398
5388 .......... done 5399 .......... done
5389 Erased 8 sectors 5400 Erased 8 sectors
5390 5401
5391 => loads 40100000 5402 => loads 40100000
5392 ## Ready for S-Record download ... 5403 ## Ready for S-Record download ...
5393 ~>examples/image.srec 5404 ~>examples/image.srec
5394 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5405 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5395 ... 5406 ...
5396 15989 15990 15991 15992 5407 15989 15990 15991 15992
5397 [file transfer complete] 5408 [file transfer complete]
5398 [connected] 5409 [connected]
5399 ## Start Addr = 0x00000000 5410 ## Start Addr = 0x00000000
5400 5411
5401 5412
5402 You can check the success of the download using the 'iminfo' command; 5413 You can check the success of the download using the 'iminfo' command;
5403 this includes a checksum verification so you can be sure no data 5414 this includes a checksum verification so you can be sure no data
5404 corruption happened: 5415 corruption happened:
5405 5416
5406 => imi 40100000 5417 => imi 40100000
5407 5418
5408 ## Checking Image at 40100000 ... 5419 ## Checking Image at 40100000 ...
5409 Image Name: 2.2.13 for initrd on TQM850L 5420 Image Name: 2.2.13 for initrd on TQM850L
5410 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5421 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5411 Data Size: 335725 Bytes = 327 kB = 0 MB 5422 Data Size: 335725 Bytes = 327 kB = 0 MB
5412 Load Address: 00000000 5423 Load Address: 00000000
5413 Entry Point: 0000000c 5424 Entry Point: 0000000c
5414 Verifying Checksum ... OK 5425 Verifying Checksum ... OK
5415 5426
5416 5427
5417 Boot Linux: 5428 Boot Linux:
5418 ----------- 5429 -----------
5419 5430
5420 The "bootm" command is used to boot an application that is stored in 5431 The "bootm" command is used to boot an application that is stored in
5421 memory (RAM or Flash). In case of a Linux kernel image, the contents 5432 memory (RAM or Flash). In case of a Linux kernel image, the contents
5422 of the "bootargs" environment variable is passed to the kernel as 5433 of the "bootargs" environment variable is passed to the kernel as
5423 parameters. You can check and modify this variable using the 5434 parameters. You can check and modify this variable using the
5424 "printenv" and "setenv" commands: 5435 "printenv" and "setenv" commands:
5425 5436
5426 5437
5427 => printenv bootargs 5438 => printenv bootargs
5428 bootargs=root=/dev/ram 5439 bootargs=root=/dev/ram
5429 5440
5430 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5441 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5431 5442
5432 => printenv bootargs 5443 => printenv bootargs
5433 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5444 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5434 5445
5435 => bootm 40020000 5446 => bootm 40020000
5436 ## Booting Linux kernel at 40020000 ... 5447 ## Booting Linux kernel at 40020000 ...
5437 Image Name: 2.2.13 for NFS on TQM850L 5448 Image Name: 2.2.13 for NFS on TQM850L
5438 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5449 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5439 Data Size: 381681 Bytes = 372 kB = 0 MB 5450 Data Size: 381681 Bytes = 372 kB = 0 MB
5440 Load Address: 00000000 5451 Load Address: 00000000
5441 Entry Point: 0000000c 5452 Entry Point: 0000000c
5442 Verifying Checksum ... OK 5453 Verifying Checksum ... OK
5443 Uncompressing Kernel Image ... OK 5454 Uncompressing Kernel Image ... OK
5444 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 5455 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
5445 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5456 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5446 time_init: decrementer frequency = 187500000/60 5457 time_init: decrementer frequency = 187500000/60
5447 Calibrating delay loop... 49.77 BogoMIPS 5458 Calibrating delay loop... 49.77 BogoMIPS
5448 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5459 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5449 ... 5460 ...
5450 5461
5451 If you want to boot a Linux kernel with initial RAM disk, you pass 5462 If you want to boot a Linux kernel with initial RAM disk, you pass
5452 the memory addresses of both the kernel and the initrd image (PPBCOOT 5463 the memory addresses of both the kernel and the initrd image (PPBCOOT
5453 format!) to the "bootm" command: 5464 format!) to the "bootm" command:
5454 5465
5455 => imi 40100000 40200000 5466 => imi 40100000 40200000
5456 5467
5457 ## Checking Image at 40100000 ... 5468 ## Checking Image at 40100000 ...
5458 Image Name: 2.2.13 for initrd on TQM850L 5469 Image Name: 2.2.13 for initrd on TQM850L
5459 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5470 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5460 Data Size: 335725 Bytes = 327 kB = 0 MB 5471 Data Size: 335725 Bytes = 327 kB = 0 MB
5461 Load Address: 00000000 5472 Load Address: 00000000
5462 Entry Point: 0000000c 5473 Entry Point: 0000000c
5463 Verifying Checksum ... OK 5474 Verifying Checksum ... OK
5464 5475
5465 ## Checking Image at 40200000 ... 5476 ## Checking Image at 40200000 ...
5466 Image Name: Simple Ramdisk Image 5477 Image Name: Simple Ramdisk Image
5467 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5478 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5468 Data Size: 566530 Bytes = 553 kB = 0 MB 5479 Data Size: 566530 Bytes = 553 kB = 0 MB
5469 Load Address: 00000000 5480 Load Address: 00000000
5470 Entry Point: 00000000 5481 Entry Point: 00000000
5471 Verifying Checksum ... OK 5482 Verifying Checksum ... OK
5472 5483
5473 => bootm 40100000 40200000 5484 => bootm 40100000 40200000
5474 ## Booting Linux kernel at 40100000 ... 5485 ## Booting Linux kernel at 40100000 ...
5475 Image Name: 2.2.13 for initrd on TQM850L 5486 Image Name: 2.2.13 for initrd on TQM850L
5476 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5487 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5477 Data Size: 335725 Bytes = 327 kB = 0 MB 5488 Data Size: 335725 Bytes = 327 kB = 0 MB
5478 Load Address: 00000000 5489 Load Address: 00000000
5479 Entry Point: 0000000c 5490 Entry Point: 0000000c
5480 Verifying Checksum ... OK 5491 Verifying Checksum ... OK
5481 Uncompressing Kernel Image ... OK 5492 Uncompressing Kernel Image ... OK
5482 ## Loading RAMDisk Image at 40200000 ... 5493 ## Loading RAMDisk Image at 40200000 ...
5483 Image Name: Simple Ramdisk Image 5494 Image Name: Simple Ramdisk Image
5484 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5495 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5485 Data Size: 566530 Bytes = 553 kB = 0 MB 5496 Data Size: 566530 Bytes = 553 kB = 0 MB
5486 Load Address: 00000000 5497 Load Address: 00000000
5487 Entry Point: 00000000 5498 Entry Point: 00000000
5488 Verifying Checksum ... OK 5499 Verifying Checksum ... OK
5489 Loading Ramdisk ... OK 5500 Loading Ramdisk ... OK
5490 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000 5501 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
5491 Boot arguments: root=/dev/ram 5502 Boot arguments: root=/dev/ram
5492 time_init: decrementer frequency = 187500000/60 5503 time_init: decrementer frequency = 187500000/60
5493 Calibrating delay loop... 49.77 BogoMIPS 5504 Calibrating delay loop... 49.77 BogoMIPS
5494 ... 5505 ...
5495 RAMDISK: Compressed image found at block 0 5506 RAMDISK: Compressed image found at block 0
5496 VFS: Mounted root (ext2 filesystem). 5507 VFS: Mounted root (ext2 filesystem).
5497 5508
5498 bash# 5509 bash#
5499 5510
5500 Boot Linux and pass a flat device tree: 5511 Boot Linux and pass a flat device tree:
5501 ----------- 5512 -----------
5502 5513
5503 First, U-Boot must be compiled with the appropriate defines. See the section 5514 First, U-Boot must be compiled with the appropriate defines. See the section
5504 titled "Linux Kernel Interface" above for a more in depth explanation. The 5515 titled "Linux Kernel Interface" above for a more in depth explanation. The
5505 following is an example of how to start a kernel and pass an updated 5516 following is an example of how to start a kernel and pass an updated
5506 flat device tree: 5517 flat device tree:
5507 5518
5508 => print oftaddr 5519 => print oftaddr
5509 oftaddr=0x300000 5520 oftaddr=0x300000
5510 => print oft 5521 => print oft
5511 oft=oftrees/mpc8540ads.dtb 5522 oft=oftrees/mpc8540ads.dtb
5512 => tftp $oftaddr $oft 5523 => tftp $oftaddr $oft
5513 Speed: 1000, full duplex 5524 Speed: 1000, full duplex
5514 Using TSEC0 device 5525 Using TSEC0 device
5515 TFTP from server 192.168.1.1; our IP address is 192.168.1.101 5526 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5516 Filename 'oftrees/mpc8540ads.dtb'. 5527 Filename 'oftrees/mpc8540ads.dtb'.
5517 Load address: 0x300000 5528 Load address: 0x300000
5518 Loading: # 5529 Loading: #
5519 done 5530 done
5520 Bytes transferred = 4106 (100a hex) 5531 Bytes transferred = 4106 (100a hex)
5521 => tftp $loadaddr $bootfile 5532 => tftp $loadaddr $bootfile
5522 Speed: 1000, full duplex 5533 Speed: 1000, full duplex
5523 Using TSEC0 device 5534 Using TSEC0 device
5524 TFTP from server 192.168.1.1; our IP address is 192.168.1.2 5535 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5525 Filename 'uImage'. 5536 Filename 'uImage'.
5526 Load address: 0x200000 5537 Load address: 0x200000
5527 Loading:############ 5538 Loading:############
5528 done 5539 done
5529 Bytes transferred = 1029407 (fb51f hex) 5540 Bytes transferred = 1029407 (fb51f hex)
5530 => print loadaddr 5541 => print loadaddr
5531 loadaddr=200000 5542 loadaddr=200000
5532 => print oftaddr 5543 => print oftaddr
5533 oftaddr=0x300000 5544 oftaddr=0x300000
5534 => bootm $loadaddr - $oftaddr 5545 => bootm $loadaddr - $oftaddr
5535 ## Booting image at 00200000 ... 5546 ## Booting image at 00200000 ...
5536 Image Name: Linux-2.6.17-dirty 5547 Image Name: Linux-2.6.17-dirty
5537 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5548 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5538 Data Size: 1029343 Bytes = 1005.2 kB 5549 Data Size: 1029343 Bytes = 1005.2 kB
5539 Load Address: 00000000 5550 Load Address: 00000000
5540 Entry Point: 00000000 5551 Entry Point: 00000000
5541 Verifying Checksum ... OK 5552 Verifying Checksum ... OK
5542 Uncompressing Kernel Image ... OK 5553 Uncompressing Kernel Image ... OK
5543 Booting using flat device tree at 0x300000 5554 Booting using flat device tree at 0x300000
5544 Using MPC85xx ADS machine description 5555 Using MPC85xx ADS machine description
5545 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 5556 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5546 [snip] 5557 [snip]
5547 5558
5548 5559
5549 More About U-Boot Image Types: 5560 More About U-Boot Image Types:
5550 ------------------------------ 5561 ------------------------------
5551 5562
5552 U-Boot supports the following image types: 5563 U-Boot supports the following image types:
5553 5564
5554 "Standalone Programs" are directly runnable in the environment 5565 "Standalone Programs" are directly runnable in the environment
5555 provided by U-Boot; it is expected that (if they behave 5566 provided by U-Boot; it is expected that (if they behave
5556 well) you can continue to work in U-Boot after return from 5567 well) you can continue to work in U-Boot after return from
5557 the Standalone Program. 5568 the Standalone Program.
5558 "OS Kernel Images" are usually images of some Embedded OS which 5569 "OS Kernel Images" are usually images of some Embedded OS which
5559 will take over control completely. Usually these programs 5570 will take over control completely. Usually these programs
5560 will install their own set of exception handlers, device 5571 will install their own set of exception handlers, device
5561 drivers, set up the MMU, etc. - this means, that you cannot 5572 drivers, set up the MMU, etc. - this means, that you cannot
5562 expect to re-enter U-Boot except by resetting the CPU. 5573 expect to re-enter U-Boot except by resetting the CPU.
5563 "RAMDisk Images" are more or less just data blocks, and their 5574 "RAMDisk Images" are more or less just data blocks, and their
5564 parameters (address, size) are passed to an OS kernel that is 5575 parameters (address, size) are passed to an OS kernel that is
5565 being started. 5576 being started.
5566 "Multi-File Images" contain several images, typically an OS 5577 "Multi-File Images" contain several images, typically an OS
5567 (Linux) kernel image and one or more data images like 5578 (Linux) kernel image and one or more data images like
5568 RAMDisks. This construct is useful for instance when you want 5579 RAMDisks. This construct is useful for instance when you want
5569 to boot over the network using BOOTP etc., where the boot 5580 to boot over the network using BOOTP etc., where the boot
5570 server provides just a single image file, but you want to get 5581 server provides just a single image file, but you want to get
5571 for instance an OS kernel and a RAMDisk image. 5582 for instance an OS kernel and a RAMDisk image.
5572 5583
5573 "Multi-File Images" start with a list of image sizes, each 5584 "Multi-File Images" start with a list of image sizes, each
5574 image size (in bytes) specified by an "uint32_t" in network 5585 image size (in bytes) specified by an "uint32_t" in network
5575 byte order. This list is terminated by an "(uint32_t)0". 5586 byte order. This list is terminated by an "(uint32_t)0".
5576 Immediately after the terminating 0 follow the images, one by 5587 Immediately after the terminating 0 follow the images, one by
5577 one, all aligned on "uint32_t" boundaries (size rounded up to 5588 one, all aligned on "uint32_t" boundaries (size rounded up to
5578 a multiple of 4 bytes). 5589 a multiple of 4 bytes).
5579 5590
5580 "Firmware Images" are binary images containing firmware (like 5591 "Firmware Images" are binary images containing firmware (like
5581 U-Boot or FPGA images) which usually will be programmed to 5592 U-Boot or FPGA images) which usually will be programmed to
5582 flash memory. 5593 flash memory.
5583 5594
5584 "Script files" are command sequences that will be executed by 5595 "Script files" are command sequences that will be executed by
5585 U-Boot's command interpreter; this feature is especially 5596 U-Boot's command interpreter; this feature is especially
5586 useful when you configure U-Boot to use a real shell (hush) 5597 useful when you configure U-Boot to use a real shell (hush)
5587 as command interpreter. 5598 as command interpreter.
5588 5599
5589 Booting the Linux zImage: 5600 Booting the Linux zImage:
5590 ------------------------- 5601 -------------------------
5591 5602
5592 On some platforms, it's possible to boot Linux zImage. This is done 5603 On some platforms, it's possible to boot Linux zImage. This is done
5593 using the "bootz" command. The syntax of "bootz" command is the same 5604 using the "bootz" command. The syntax of "bootz" command is the same
5594 as the syntax of "bootm" command. 5605 as the syntax of "bootm" command.
5595 5606
5596 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5607 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5597 kernel with raw initrd images. The syntax is slightly different, the 5608 kernel with raw initrd images. The syntax is slightly different, the
5598 address of the initrd must be augmented by it's size, in the following 5609 address of the initrd must be augmented by it's size, in the following
5599 format: "<initrd addres>:<initrd size>". 5610 format: "<initrd addres>:<initrd size>".
5600 5611
5601 5612
5602 Standalone HOWTO: 5613 Standalone HOWTO:
5603 ================= 5614 =================
5604 5615
5605 One of the features of U-Boot is that you can dynamically load and 5616 One of the features of U-Boot is that you can dynamically load and
5606 run "standalone" applications, which can use some resources of 5617 run "standalone" applications, which can use some resources of
5607 U-Boot like console I/O functions or interrupt services. 5618 U-Boot like console I/O functions or interrupt services.
5608 5619
5609 Two simple examples are included with the sources: 5620 Two simple examples are included with the sources:
5610 5621
5611 "Hello World" Demo: 5622 "Hello World" Demo:
5612 ------------------- 5623 -------------------
5613 5624
5614 'examples/hello_world.c' contains a small "Hello World" Demo 5625 'examples/hello_world.c' contains a small "Hello World" Demo
5615 application; it is automatically compiled when you build U-Boot. 5626 application; it is automatically compiled when you build U-Boot.
5616 It's configured to run at address 0x00040004, so you can play with it 5627 It's configured to run at address 0x00040004, so you can play with it
5617 like that: 5628 like that:
5618 5629
5619 => loads 5630 => loads
5620 ## Ready for S-Record download ... 5631 ## Ready for S-Record download ...
5621 ~>examples/hello_world.srec 5632 ~>examples/hello_world.srec
5622 1 2 3 4 5 6 7 8 9 10 11 ... 5633 1 2 3 4 5 6 7 8 9 10 11 ...
5623 [file transfer complete] 5634 [file transfer complete]
5624 [connected] 5635 [connected]
5625 ## Start Addr = 0x00040004 5636 ## Start Addr = 0x00040004
5626 5637
5627 => go 40004 Hello World! This is a test. 5638 => go 40004 Hello World! This is a test.
5628 ## Starting application at 0x00040004 ... 5639 ## Starting application at 0x00040004 ...
5629 Hello World 5640 Hello World
5630 argc = 7 5641 argc = 7
5631 argv[0] = "40004" 5642 argv[0] = "40004"
5632 argv[1] = "Hello" 5643 argv[1] = "Hello"
5633 argv[2] = "World!" 5644 argv[2] = "World!"
5634 argv[3] = "This" 5645 argv[3] = "This"
5635 argv[4] = "is" 5646 argv[4] = "is"
5636 argv[5] = "a" 5647 argv[5] = "a"
5637 argv[6] = "test." 5648 argv[6] = "test."
5638 argv[7] = "<NULL>" 5649 argv[7] = "<NULL>"
5639 Hit any key to exit ... 5650 Hit any key to exit ...
5640 5651
5641 ## Application terminated, rc = 0x0 5652 ## Application terminated, rc = 0x0
5642 5653
5643 Another example, which demonstrates how to register a CPM interrupt 5654 Another example, which demonstrates how to register a CPM interrupt
5644 handler with the U-Boot code, can be found in 'examples/timer.c'. 5655 handler with the U-Boot code, can be found in 'examples/timer.c'.
5645 Here, a CPM timer is set up to generate an interrupt every second. 5656 Here, a CPM timer is set up to generate an interrupt every second.
5646 The interrupt service routine is trivial, just printing a '.' 5657 The interrupt service routine is trivial, just printing a '.'
5647 character, but this is just a demo program. The application can be 5658 character, but this is just a demo program. The application can be
5648 controlled by the following keys: 5659 controlled by the following keys:
5649 5660
5650 ? - print current values og the CPM Timer registers 5661 ? - print current values og the CPM Timer registers
5651 b - enable interrupts and start timer 5662 b - enable interrupts and start timer
5652 e - stop timer and disable interrupts 5663 e - stop timer and disable interrupts
5653 q - quit application 5664 q - quit application
5654 5665
5655 => loads 5666 => loads
5656 ## Ready for S-Record download ... 5667 ## Ready for S-Record download ...
5657 ~>examples/timer.srec 5668 ~>examples/timer.srec
5658 1 2 3 4 5 6 7 8 9 10 11 ... 5669 1 2 3 4 5 6 7 8 9 10 11 ...
5659 [file transfer complete] 5670 [file transfer complete]
5660 [connected] 5671 [connected]
5661 ## Start Addr = 0x00040004 5672 ## Start Addr = 0x00040004
5662 5673
5663 => go 40004 5674 => go 40004
5664 ## Starting application at 0x00040004 ... 5675 ## Starting application at 0x00040004 ...
5665 TIMERS=0xfff00980 5676 TIMERS=0xfff00980
5666 Using timer 1 5677 Using timer 1
5667 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5678 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5668 5679
5669 Hit 'b': 5680 Hit 'b':
5670 [q, b, e, ?] Set interval 1000000 us 5681 [q, b, e, ?] Set interval 1000000 us
5671 Enabling timer 5682 Enabling timer
5672 Hit '?': 5683 Hit '?':
5673 [q, b, e, ?] ........ 5684 [q, b, e, ?] ........
5674 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5685 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5675 Hit '?': 5686 Hit '?':
5676 [q, b, e, ?] . 5687 [q, b, e, ?] .
5677 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5688 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5678 Hit '?': 5689 Hit '?':
5679 [q, b, e, ?] . 5690 [q, b, e, ?] .
5680 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5691 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5681 Hit '?': 5692 Hit '?':
5682 [q, b, e, ?] . 5693 [q, b, e, ?] .
5683 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5694 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5684 Hit 'e': 5695 Hit 'e':
5685 [q, b, e, ?] ...Stopping timer 5696 [q, b, e, ?] ...Stopping timer
5686 Hit 'q': 5697 Hit 'q':
5687 [q, b, e, ?] ## Application terminated, rc = 0x0 5698 [q, b, e, ?] ## Application terminated, rc = 0x0
5688 5699
5689 5700
5690 Minicom warning: 5701 Minicom warning:
5691 ================ 5702 ================
5692 5703
5693 Over time, many people have reported problems when trying to use the 5704 Over time, many people have reported problems when trying to use the
5694 "minicom" terminal emulation program for serial download. I (wd) 5705 "minicom" terminal emulation program for serial download. I (wd)
5695 consider minicom to be broken, and recommend not to use it. Under 5706 consider minicom to be broken, and recommend not to use it. Under
5696 Unix, I recommend to use C-Kermit for general purpose use (and 5707 Unix, I recommend to use C-Kermit for general purpose use (and
5697 especially for kermit binary protocol download ("loadb" command), and 5708 especially for kermit binary protocol download ("loadb" command), and
5698 use "cu" for S-Record download ("loads" command). See 5709 use "cu" for S-Record download ("loads" command). See
5699 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5710 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5700 for help with kermit. 5711 for help with kermit.
5701 5712
5702 5713
5703 Nevertheless, if you absolutely want to use it try adding this 5714 Nevertheless, if you absolutely want to use it try adding this
5704 configuration to your "File transfer protocols" section: 5715 configuration to your "File transfer protocols" section:
5705 5716
5706 Name Program Name U/D FullScr IO-Red. Multi 5717 Name Program Name U/D FullScr IO-Red. Multi
5707 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 5718 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5708 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 5719 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
5709 5720
5710 5721
5711 NetBSD Notes: 5722 NetBSD Notes:
5712 ============= 5723 =============
5713 5724
5714 Starting at version 0.9.2, U-Boot supports NetBSD both as host 5725 Starting at version 0.9.2, U-Boot supports NetBSD both as host
5715 (build U-Boot) and target system (boots NetBSD/mpc8xx). 5726 (build U-Boot) and target system (boots NetBSD/mpc8xx).
5716 5727
5717 Building requires a cross environment; it is known to work on 5728 Building requires a cross environment; it is known to work on
5718 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5729 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5719 need gmake since the Makefiles are not compatible with BSD make). 5730 need gmake since the Makefiles are not compatible with BSD make).
5720 Note that the cross-powerpc package does not install include files; 5731 Note that the cross-powerpc package does not install include files;
5721 attempting to build U-Boot will fail because <machine/ansi.h> is 5732 attempting to build U-Boot will fail because <machine/ansi.h> is
5722 missing. This file has to be installed and patched manually: 5733 missing. This file has to be installed and patched manually:
5723 5734
5724 # cd /usr/pkg/cross/powerpc-netbsd/include 5735 # cd /usr/pkg/cross/powerpc-netbsd/include
5725 # mkdir powerpc 5736 # mkdir powerpc
5726 # ln -s powerpc machine 5737 # ln -s powerpc machine
5727 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5738 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5728 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5739 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
5729 5740
5730 Native builds *don't* work due to incompatibilities between native 5741 Native builds *don't* work due to incompatibilities between native
5731 and U-Boot include files. 5742 and U-Boot include files.
5732 5743
5733 Booting assumes that (the first part of) the image booted is a 5744 Booting assumes that (the first part of) the image booted is a
5734 stage-2 loader which in turn loads and then invokes the kernel 5745 stage-2 loader which in turn loads and then invokes the kernel
5735 proper. Loader sources will eventually appear in the NetBSD source 5746 proper. Loader sources will eventually appear in the NetBSD source
5736 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 5747 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
5737 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5748 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5738 5749
5739 5750
5740 Implementation Internals: 5751 Implementation Internals:
5741 ========================= 5752 =========================
5742 5753
5743 The following is not intended to be a complete description of every 5754 The following is not intended to be a complete description of every
5744 implementation detail. However, it should help to understand the 5755 implementation detail. However, it should help to understand the
5745 inner workings of U-Boot and make it easier to port it to custom 5756 inner workings of U-Boot and make it easier to port it to custom
5746 hardware. 5757 hardware.
5747 5758
5748 5759
5749 Initial Stack, Global Data: 5760 Initial Stack, Global Data:
5750 --------------------------- 5761 ---------------------------
5751 5762
5752 The implementation of U-Boot is complicated by the fact that U-Boot 5763 The implementation of U-Boot is complicated by the fact that U-Boot
5753 starts running out of ROM (flash memory), usually without access to 5764 starts running out of ROM (flash memory), usually without access to
5754 system RAM (because the memory controller is not initialized yet). 5765 system RAM (because the memory controller is not initialized yet).
5755 This means that we don't have writable Data or BSS segments, and BSS 5766 This means that we don't have writable Data or BSS segments, and BSS
5756 is not initialized as zero. To be able to get a C environment working 5767 is not initialized as zero. To be able to get a C environment working
5757 at all, we have to allocate at least a minimal stack. Implementation 5768 at all, we have to allocate at least a minimal stack. Implementation
5758 options for this are defined and restricted by the CPU used: Some CPU 5769 options for this are defined and restricted by the CPU used: Some CPU
5759 models provide on-chip memory (like the IMMR area on MPC8xx and 5770 models provide on-chip memory (like the IMMR area on MPC8xx and
5760 MPC826x processors), on others (parts of) the data cache can be 5771 MPC826x processors), on others (parts of) the data cache can be
5761 locked as (mis-) used as memory, etc. 5772 locked as (mis-) used as memory, etc.
5762 5773
5763 Chris Hallinan posted a good summary of these issues to the 5774 Chris Hallinan posted a good summary of these issues to the
5764 U-Boot mailing list: 5775 U-Boot mailing list:
5765 5776
5766 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 5777 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5767 From: "Chris Hallinan" <clh@net1plus.com> 5778 From: "Chris Hallinan" <clh@net1plus.com>
5768 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 5779 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5769 ... 5780 ...
5770 5781
5771 Correct me if I'm wrong, folks, but the way I understand it 5782 Correct me if I'm wrong, folks, but the way I understand it
5772 is this: Using DCACHE as initial RAM for Stack, etc, does not 5783 is this: Using DCACHE as initial RAM for Stack, etc, does not
5773 require any physical RAM backing up the cache. The cleverness 5784 require any physical RAM backing up the cache. The cleverness
5774 is that the cache is being used as a temporary supply of 5785 is that the cache is being used as a temporary supply of
5775 necessary storage before the SDRAM controller is setup. It's 5786 necessary storage before the SDRAM controller is setup. It's
5776 beyond the scope of this list to explain the details, but you 5787 beyond the scope of this list to explain the details, but you
5777 can see how this works by studying the cache architecture and 5788 can see how this works by studying the cache architecture and
5778 operation in the architecture and processor-specific manuals. 5789 operation in the architecture and processor-specific manuals.
5779 5790
5780 OCM is On Chip Memory, which I believe the 405GP has 4K. It 5791 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5781 is another option for the system designer to use as an 5792 is another option for the system designer to use as an
5782 initial stack/RAM area prior to SDRAM being available. Either 5793 initial stack/RAM area prior to SDRAM being available. Either
5783 option should work for you. Using CS 4 should be fine if your 5794 option should work for you. Using CS 4 should be fine if your
5784 board designers haven't used it for something that would 5795 board designers haven't used it for something that would
5785 cause you grief during the initial boot! It is frequently not 5796 cause you grief during the initial boot! It is frequently not
5786 used. 5797 used.
5787 5798
5788 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 5799 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
5789 with your processor/board/system design. The default value 5800 with your processor/board/system design. The default value
5790 you will find in any recent u-boot distribution in 5801 you will find in any recent u-boot distribution in
5791 walnut.h should work for you. I'd set it to a value larger 5802 walnut.h should work for you. I'd set it to a value larger
5792 than your SDRAM module. If you have a 64MB SDRAM module, set 5803 than your SDRAM module. If you have a 64MB SDRAM module, set
5793 it above 400_0000. Just make sure your board has no resources 5804 it above 400_0000. Just make sure your board has no resources
5794 that are supposed to respond to that address! That code in 5805 that are supposed to respond to that address! That code in
5795 start.S has been around a while and should work as is when 5806 start.S has been around a while and should work as is when
5796 you get the config right. 5807 you get the config right.
5797 5808
5798 -Chris Hallinan 5809 -Chris Hallinan
5799 DS4.COM, Inc. 5810 DS4.COM, Inc.
5800 5811
5801 It is essential to remember this, since it has some impact on the C 5812 It is essential to remember this, since it has some impact on the C
5802 code for the initialization procedures: 5813 code for the initialization procedures:
5803 5814
5804 * Initialized global data (data segment) is read-only. Do not attempt 5815 * Initialized global data (data segment) is read-only. Do not attempt
5805 to write it. 5816 to write it.
5806 5817
5807 * Do not use any uninitialized global data (or implicitely initialized 5818 * Do not use any uninitialized global data (or implicitely initialized
5808 as zero data - BSS segment) at all - this is undefined, initiali- 5819 as zero data - BSS segment) at all - this is undefined, initiali-
5809 zation is performed later (when relocating to RAM). 5820 zation is performed later (when relocating to RAM).
5810 5821
5811 * Stack space is very limited. Avoid big data buffers or things like 5822 * Stack space is very limited. Avoid big data buffers or things like
5812 that. 5823 that.
5813 5824
5814 Having only the stack as writable memory limits means we cannot use 5825 Having only the stack as writable memory limits means we cannot use
5815 normal global data to share information beween the code. But it 5826 normal global data to share information beween the code. But it
5816 turned out that the implementation of U-Boot can be greatly 5827 turned out that the implementation of U-Boot can be greatly
5817 simplified by making a global data structure (gd_t) available to all 5828 simplified by making a global data structure (gd_t) available to all
5818 functions. We could pass a pointer to this data as argument to _all_ 5829 functions. We could pass a pointer to this data as argument to _all_
5819 functions, but this would bloat the code. Instead we use a feature of 5830 functions, but this would bloat the code. Instead we use a feature of
5820 the GCC compiler (Global Register Variables) to share the data: we 5831 the GCC compiler (Global Register Variables) to share the data: we
5821 place a pointer (gd) to the global data into a register which we 5832 place a pointer (gd) to the global data into a register which we
5822 reserve for this purpose. 5833 reserve for this purpose.
5823 5834
5824 When choosing a register for such a purpose we are restricted by the 5835 When choosing a register for such a purpose we are restricted by the
5825 relevant (E)ABI specifications for the current architecture, and by 5836 relevant (E)ABI specifications for the current architecture, and by
5826 GCC's implementation. 5837 GCC's implementation.
5827 5838
5828 For PowerPC, the following registers have specific use: 5839 For PowerPC, the following registers have specific use:
5829 R1: stack pointer 5840 R1: stack pointer
5830 R2: reserved for system use 5841 R2: reserved for system use
5831 R3-R4: parameter passing and return values 5842 R3-R4: parameter passing and return values
5832 R5-R10: parameter passing 5843 R5-R10: parameter passing
5833 R13: small data area pointer 5844 R13: small data area pointer
5834 R30: GOT pointer 5845 R30: GOT pointer
5835 R31: frame pointer 5846 R31: frame pointer
5836 5847
5837 (U-Boot also uses R12 as internal GOT pointer. r12 5848 (U-Boot also uses R12 as internal GOT pointer. r12
5838 is a volatile register so r12 needs to be reset when 5849 is a volatile register so r12 needs to be reset when
5839 going back and forth between asm and C) 5850 going back and forth between asm and C)
5840 5851
5841 ==> U-Boot will use R2 to hold a pointer to the global data 5852 ==> U-Boot will use R2 to hold a pointer to the global data
5842 5853
5843 Note: on PPC, we could use a static initializer (since the 5854 Note: on PPC, we could use a static initializer (since the
5844 address of the global data structure is known at compile time), 5855 address of the global data structure is known at compile time),
5845 but it turned out that reserving a register results in somewhat 5856 but it turned out that reserving a register results in somewhat
5846 smaller code - although the code savings are not that big (on 5857 smaller code - although the code savings are not that big (on
5847 average for all boards 752 bytes for the whole U-Boot image, 5858 average for all boards 752 bytes for the whole U-Boot image,
5848 624 text + 127 data). 5859 624 text + 127 data).
5849 5860
5850 On Blackfin, the normal C ABI (except for P3) is followed as documented here: 5861 On Blackfin, the normal C ABI (except for P3) is followed as documented here:
5851 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 5862 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5852 5863
5853 ==> U-Boot will use P3 to hold a pointer to the global data 5864 ==> U-Boot will use P3 to hold a pointer to the global data
5854 5865
5855 On ARM, the following registers are used: 5866 On ARM, the following registers are used:
5856 5867
5857 R0: function argument word/integer result 5868 R0: function argument word/integer result
5858 R1-R3: function argument word 5869 R1-R3: function argument word
5859 R9: platform specific 5870 R9: platform specific
5860 R10: stack limit (used only if stack checking is enabled) 5871 R10: stack limit (used only if stack checking is enabled)
5861 R11: argument (frame) pointer 5872 R11: argument (frame) pointer
5862 R12: temporary workspace 5873 R12: temporary workspace
5863 R13: stack pointer 5874 R13: stack pointer
5864 R14: link register 5875 R14: link register
5865 R15: program counter 5876 R15: program counter
5866 5877
5867 ==> U-Boot will use R9 to hold a pointer to the global data 5878 ==> U-Boot will use R9 to hold a pointer to the global data
5868 5879
5869 Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5880 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5870 5881
5871 On Nios II, the ABI is documented here: 5882 On Nios II, the ABI is documented here:
5872 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 5883 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5873 5884
5874 ==> U-Boot will use gp to hold a pointer to the global data 5885 ==> U-Boot will use gp to hold a pointer to the global data
5875 5886
5876 Note: on Nios II, we give "-G0" option to gcc and don't use gp 5887 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5877 to access small data sections, so gp is free. 5888 to access small data sections, so gp is free.
5878 5889
5879 On NDS32, the following registers are used: 5890 On NDS32, the following registers are used:
5880 5891
5881 R0-R1: argument/return 5892 R0-R1: argument/return
5882 R2-R5: argument 5893 R2-R5: argument
5883 R15: temporary register for assembler 5894 R15: temporary register for assembler
5884 R16: trampoline register 5895 R16: trampoline register
5885 R28: frame pointer (FP) 5896 R28: frame pointer (FP)
5886 R29: global pointer (GP) 5897 R29: global pointer (GP)
5887 R30: link register (LP) 5898 R30: link register (LP)
5888 R31: stack pointer (SP) 5899 R31: stack pointer (SP)
5889 PC: program counter (PC) 5900 PC: program counter (PC)
5890 5901
5891 ==> U-Boot will use R10 to hold a pointer to the global data 5902 ==> U-Boot will use R10 to hold a pointer to the global data
5892 5903
5893 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5904 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5894 or current versions of GCC may "optimize" the code too much. 5905 or current versions of GCC may "optimize" the code too much.
5895 5906
5896 Memory Management: 5907 Memory Management:
5897 ------------------ 5908 ------------------
5898 5909
5899 U-Boot runs in system state and uses physical addresses, i.e. the 5910 U-Boot runs in system state and uses physical addresses, i.e. the
5900 MMU is not used either for address mapping nor for memory protection. 5911 MMU is not used either for address mapping nor for memory protection.
5901 5912
5902 The available memory is mapped to fixed addresses using the memory 5913 The available memory is mapped to fixed addresses using the memory
5903 controller. In this process, a contiguous block is formed for each 5914 controller. In this process, a contiguous block is formed for each
5904 memory type (Flash, SDRAM, SRAM), even when it consists of several 5915 memory type (Flash, SDRAM, SRAM), even when it consists of several
5905 physical memory banks. 5916 physical memory banks.
5906 5917
5907 U-Boot is installed in the first 128 kB of the first Flash bank (on 5918 U-Boot is installed in the first 128 kB of the first Flash bank (on
5908 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5919 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5909 booting and sizing and initializing DRAM, the code relocates itself 5920 booting and sizing and initializing DRAM, the code relocates itself
5910 to the upper end of DRAM. Immediately below the U-Boot code some 5921 to the upper end of DRAM. Immediately below the U-Boot code some
5911 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5922 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5912 configuration setting]. Below that, a structure with global Board 5923 configuration setting]. Below that, a structure with global Board
5913 Info data is placed, followed by the stack (growing downward). 5924 Info data is placed, followed by the stack (growing downward).
5914 5925
5915 Additionally, some exception handler code is copied to the low 8 kB 5926 Additionally, some exception handler code is copied to the low 8 kB
5916 of DRAM (0x00000000 ... 0x00001FFF). 5927 of DRAM (0x00000000 ... 0x00001FFF).
5917 5928
5918 So a typical memory configuration with 16 MB of DRAM could look like 5929 So a typical memory configuration with 16 MB of DRAM could look like
5919 this: 5930 this:
5920 5931
5921 0x0000 0000 Exception Vector code 5932 0x0000 0000 Exception Vector code
5922 : 5933 :
5923 0x0000 1FFF 5934 0x0000 1FFF
5924 0x0000 2000 Free for Application Use 5935 0x0000 2000 Free for Application Use
5925 : 5936 :
5926 : 5937 :
5927 5938
5928 : 5939 :
5929 : 5940 :
5930 0x00FB FF20 Monitor Stack (Growing downward) 5941 0x00FB FF20 Monitor Stack (Growing downward)
5931 0x00FB FFAC Board Info Data and permanent copy of global data 5942 0x00FB FFAC Board Info Data and permanent copy of global data
5932 0x00FC 0000 Malloc Arena 5943 0x00FC 0000 Malloc Arena
5933 : 5944 :
5934 0x00FD FFFF 5945 0x00FD FFFF
5935 0x00FE 0000 RAM Copy of Monitor Code 5946 0x00FE 0000 RAM Copy of Monitor Code
5936 ... eventually: LCD or video framebuffer 5947 ... eventually: LCD or video framebuffer
5937 ... eventually: pRAM (Protected RAM - unchanged by reset) 5948 ... eventually: pRAM (Protected RAM - unchanged by reset)
5938 0x00FF FFFF [End of RAM] 5949 0x00FF FFFF [End of RAM]
5939 5950
5940 5951
5941 System Initialization: 5952 System Initialization:
5942 ---------------------- 5953 ----------------------
5943 5954
5944 In the reset configuration, U-Boot starts at the reset entry point 5955 In the reset configuration, U-Boot starts at the reset entry point
5945 (on most PowerPC systems at address 0x00000100). Because of the reset 5956 (on most PowerPC systems at address 0x00000100). Because of the reset
5946 configuration for CS0# this is a mirror of the onboard Flash memory. 5957 configuration for CS0# this is a mirror of the onboard Flash memory.
5947 To be able to re-map memory U-Boot then jumps to its link address. 5958 To be able to re-map memory U-Boot then jumps to its link address.
5948 To be able to implement the initialization code in C, a (small!) 5959 To be able to implement the initialization code in C, a (small!)
5949 initial stack is set up in the internal Dual Ported RAM (in case CPUs 5960 initial stack is set up in the internal Dual Ported RAM (in case CPUs
5950 which provide such a feature like MPC8xx or MPC8260), or in a locked 5961 which provide such a feature like MPC8xx or MPC8260), or in a locked
5951 part of the data cache. After that, U-Boot initializes the CPU core, 5962 part of the data cache. After that, U-Boot initializes the CPU core,
5952 the caches and the SIU. 5963 the caches and the SIU.
5953 5964
5954 Next, all (potentially) available memory banks are mapped using a 5965 Next, all (potentially) available memory banks are mapped using a
5955 preliminary mapping. For example, we put them on 512 MB boundaries 5966 preliminary mapping. For example, we put them on 512 MB boundaries
5956 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5967 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5957 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5968 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5958 programmed for SDRAM access. Using the temporary configuration, a 5969 programmed for SDRAM access. Using the temporary configuration, a
5959 simple memory test is run that determines the size of the SDRAM 5970 simple memory test is run that determines the size of the SDRAM
5960 banks. 5971 banks.
5961 5972
5962 When there is more than one SDRAM bank, and the banks are of 5973 When there is more than one SDRAM bank, and the banks are of
5963 different size, the largest is mapped first. For equal size, the first 5974 different size, the largest is mapped first. For equal size, the first
5964 bank (CS2#) is mapped first. The first mapping is always for address 5975 bank (CS2#) is mapped first. The first mapping is always for address
5965 0x00000000, with any additional banks following immediately to create 5976 0x00000000, with any additional banks following immediately to create
5966 contiguous memory starting from 0. 5977 contiguous memory starting from 0.
5967 5978
5968 Then, the monitor installs itself at the upper end of the SDRAM area 5979 Then, the monitor installs itself at the upper end of the SDRAM area
5969 and allocates memory for use by malloc() and for the global Board 5980 and allocates memory for use by malloc() and for the global Board
5970 Info data; also, the exception vector code is copied to the low RAM 5981 Info data; also, the exception vector code is copied to the low RAM
5971 pages, and the final stack is set up. 5982 pages, and the final stack is set up.
5972 5983
5973 Only after this relocation will you have a "normal" C environment; 5984 Only after this relocation will you have a "normal" C environment;
5974 until that you are restricted in several ways, mostly because you are 5985 until that you are restricted in several ways, mostly because you are
5975 running from ROM, and because the code will have to be relocated to a 5986 running from ROM, and because the code will have to be relocated to a
5976 new address in RAM. 5987 new address in RAM.
5977 5988
5978 5989
5979 U-Boot Porting Guide: 5990 U-Boot Porting Guide:
5980 ---------------------- 5991 ----------------------
5981 5992
5982 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing 5993 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5983 list, October 2002] 5994 list, October 2002]
5984 5995
5985 5996
5986 int main(int argc, char *argv[]) 5997 int main(int argc, char *argv[])
5987 { 5998 {
5988 sighandler_t no_more_time; 5999 sighandler_t no_more_time;
5989 6000
5990 signal(SIGALRM, no_more_time); 6001 signal(SIGALRM, no_more_time);
5991 alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6002 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5992 6003
5993 if (available_money > available_manpower) { 6004 if (available_money > available_manpower) {
5994 Pay consultant to port U-Boot; 6005 Pay consultant to port U-Boot;
5995 return 0; 6006 return 0;
5996 } 6007 }
5997 6008
5998 Download latest U-Boot source; 6009 Download latest U-Boot source;
5999 6010
6000 Subscribe to u-boot mailing list; 6011 Subscribe to u-boot mailing list;
6001 6012
6002 if (clueless) 6013 if (clueless)
6003 email("Hi, I am new to U-Boot, how do I get started?"); 6014 email("Hi, I am new to U-Boot, how do I get started?");
6004 6015
6005 while (learning) { 6016 while (learning) {
6006 Read the README file in the top level directory; 6017 Read the README file in the top level directory;
6007 Read http://www.denx.de/twiki/bin/view/DULG/Manual; 6018 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6008 Read applicable doc/*.README; 6019 Read applicable doc/*.README;
6009 Read the source, Luke; 6020 Read the source, Luke;
6010 /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6021 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
6011 } 6022 }
6012 6023
6013 if (available_money > toLocalCurrency ($2500)) 6024 if (available_money > toLocalCurrency ($2500))
6014 Buy a BDI3000; 6025 Buy a BDI3000;
6015 else 6026 else
6016 Add a lot of aggravation and time; 6027 Add a lot of aggravation and time;
6017 6028
6018 if (a similar board exists) { /* hopefully... */ 6029 if (a similar board exists) { /* hopefully... */
6019 cp -a board/<similar> board/<myboard> 6030 cp -a board/<similar> board/<myboard>
6020 cp include/configs/<similar>.h include/configs/<myboard>.h 6031 cp include/configs/<similar>.h include/configs/<myboard>.h
6021 } else { 6032 } else {
6022 Create your own board support subdirectory; 6033 Create your own board support subdirectory;
6023 Create your own board include/configs/<myboard>.h file; 6034 Create your own board include/configs/<myboard>.h file;
6024 } 6035 }
6025 Edit new board/<myboard> files 6036 Edit new board/<myboard> files
6026 Edit new include/configs/<myboard>.h 6037 Edit new include/configs/<myboard>.h
6027 6038
6028 while (!accepted) { 6039 while (!accepted) {
6029 while (!running) { 6040 while (!running) {
6030 do { 6041 do {
6031 Add / modify source code; 6042 Add / modify source code;
6032 } until (compiles); 6043 } until (compiles);
6033 Debug; 6044 Debug;
6034 if (clueless) 6045 if (clueless)
6035 email("Hi, I am having problems..."); 6046 email("Hi, I am having problems...");
6036 } 6047 }
6037 Send patch file to the U-Boot email list; 6048 Send patch file to the U-Boot email list;
6038 if (reasonable critiques) 6049 if (reasonable critiques)
6039 Incorporate improvements from email list code review; 6050 Incorporate improvements from email list code review;
6040 else 6051 else
6041 Defend code as written; 6052 Defend code as written;
6042 } 6053 }
6043 6054
6044 return 0; 6055 return 0;
6045 } 6056 }
6046 6057
6047 void no_more_time (int sig) 6058 void no_more_time (int sig)
6048 { 6059 {
6049 hire_a_guru(); 6060 hire_a_guru();
6050 } 6061 }
6051 6062
6052 6063
6053 Coding Standards: 6064 Coding Standards:
6054 ----------------- 6065 -----------------
6055 6066
6056 All contributions to U-Boot should conform to the Linux kernel 6067 All contributions to U-Boot should conform to the Linux kernel
6057 coding style; see the file "Documentation/CodingStyle" and the script 6068 coding style; see the file "Documentation/CodingStyle" and the script
6058 "scripts/Lindent" in your Linux kernel source directory. 6069 "scripts/Lindent" in your Linux kernel source directory.
6059 6070
6060 Source files originating from a different project (for example the 6071 Source files originating from a different project (for example the
6061 MTD subsystem) are generally exempt from these guidelines and are not 6072 MTD subsystem) are generally exempt from these guidelines and are not
6062 reformated to ease subsequent migration to newer versions of those 6073 reformated to ease subsequent migration to newer versions of those
6063 sources. 6074 sources.
6064 6075
6065 Please note that U-Boot is implemented in C (and to some small parts in 6076 Please note that U-Boot is implemented in C (and to some small parts in
6066 Assembler); no C++ is used, so please do not use C++ style comments (//) 6077 Assembler); no C++ is used, so please do not use C++ style comments (//)
6067 in your code. 6078 in your code.
6068 6079
6069 Please also stick to the following formatting rules: 6080 Please also stick to the following formatting rules:
6070 - remove any trailing white space 6081 - remove any trailing white space
6071 - use TAB characters for indentation and vertical alignment, not spaces 6082 - use TAB characters for indentation and vertical alignment, not spaces
6072 - make sure NOT to use DOS '\r\n' line feeds 6083 - make sure NOT to use DOS '\r\n' line feeds
6073 - do not add more than 2 consecutive empty lines to source files 6084 - do not add more than 2 consecutive empty lines to source files
6074 - do not add trailing empty lines to source files 6085 - do not add trailing empty lines to source files
6075 6086
6076 Submissions which do not conform to the standards may be returned 6087 Submissions which do not conform to the standards may be returned
6077 with a request to reformat the changes. 6088 with a request to reformat the changes.
6078 6089
6079 6090
6080 Submitting Patches: 6091 Submitting Patches:
6081 ------------------- 6092 -------------------
6082 6093
6083 Since the number of patches for U-Boot is growing, we need to 6094 Since the number of patches for U-Boot is growing, we need to
6084 establish some rules. Submissions which do not conform to these rules 6095 establish some rules. Submissions which do not conform to these rules
6085 may be rejected, even when they contain important and valuable stuff. 6096 may be rejected, even when they contain important and valuable stuff.
6086 6097
6087 Please see http://www.denx.de/wiki/U-Boot/Patches for details. 6098 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
6088 6099
6089 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 6100 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6090 see http://lists.denx.de/mailman/listinfo/u-boot 6101 see http://lists.denx.de/mailman/listinfo/u-boot
6091 6102
6092 When you send a patch, please include the following information with 6103 When you send a patch, please include the following information with
6093 it: 6104 it:
6094 6105
6095 * For bug fixes: a description of the bug and how your patch fixes 6106 * For bug fixes: a description of the bug and how your patch fixes
6096 this bug. Please try to include a way of demonstrating that the 6107 this bug. Please try to include a way of demonstrating that the
6097 patch actually fixes something. 6108 patch actually fixes something.
6098 6109
6099 * For new features: a description of the feature and your 6110 * For new features: a description of the feature and your
6100 implementation. 6111 implementation.
6101 6112
6102 * A CHANGELOG entry as plaintext (separate from the patch) 6113 * A CHANGELOG entry as plaintext (separate from the patch)
6103 6114
6104 * For major contributions, your entry to the CREDITS file 6115 * For major contributions, your entry to the CREDITS file
6105 6116
6106 * When you add support for a new board, don't forget to add a 6117 * When you add support for a new board, don't forget to add a
6107 maintainer e-mail address to the boards.cfg file, too. 6118 maintainer e-mail address to the boards.cfg file, too.
6108 6119
6109 * If your patch adds new configuration options, don't forget to 6120 * If your patch adds new configuration options, don't forget to
6110 document these in the README file. 6121 document these in the README file.
6111 6122
6112 * The patch itself. If you are using git (which is *strongly* 6123 * The patch itself. If you are using git (which is *strongly*
6113 recommended) you can easily generate the patch using the 6124 recommended) you can easily generate the patch using the
6114 "git format-patch". If you then use "git send-email" to send it to 6125 "git format-patch". If you then use "git send-email" to send it to
6115 the U-Boot mailing list, you will avoid most of the common problems 6126 the U-Boot mailing list, you will avoid most of the common problems
6116 with some other mail clients. 6127 with some other mail clients.
6117 6128
6118 If you cannot use git, use "diff -purN OLD NEW". If your version of 6129 If you cannot use git, use "diff -purN OLD NEW". If your version of
6119 diff does not support these options, then get the latest version of 6130 diff does not support these options, then get the latest version of
6120 GNU diff. 6131 GNU diff.
6121 6132
6122 The current directory when running this command shall be the parent 6133 The current directory when running this command shall be the parent
6123 directory of the U-Boot source tree (i. e. please make sure that 6134 directory of the U-Boot source tree (i. e. please make sure that
6124 your patch includes sufficient directory information for the 6135 your patch includes sufficient directory information for the
6125 affected files). 6136 affected files).
6126 6137
6127 We prefer patches as plain text. MIME attachments are discouraged, 6138 We prefer patches as plain text. MIME attachments are discouraged,
6128 and compressed attachments must not be used. 6139 and compressed attachments must not be used.
6129 6140
6130 * If one logical set of modifications affects or creates several 6141 * If one logical set of modifications affects or creates several
6131 files, all these changes shall be submitted in a SINGLE patch file. 6142 files, all these changes shall be submitted in a SINGLE patch file.
6132 6143
6133 * Changesets that contain different, unrelated modifications shall be 6144 * Changesets that contain different, unrelated modifications shall be
6134 submitted as SEPARATE patches, one patch per changeset. 6145 submitted as SEPARATE patches, one patch per changeset.
6135 6146
6136 6147
6137 Notes: 6148 Notes:
6138 6149
6139 * Before sending the patch, run the MAKEALL script on your patched 6150 * Before sending the patch, run the MAKEALL script on your patched
6140 source tree and make sure that no errors or warnings are reported 6151 source tree and make sure that no errors or warnings are reported
6141 for any of the boards. 6152 for any of the boards.
6142 6153
6143 * Keep your modifications to the necessary minimum: A patch 6154 * Keep your modifications to the necessary minimum: A patch
6144 containing several unrelated changes or arbitrary reformats will be 6155 containing several unrelated changes or arbitrary reformats will be
6145 returned with a request to re-formatting / split it. 6156 returned with a request to re-formatting / split it.
6146 6157
6147 * If you modify existing code, make sure that your new code does not 6158 * If you modify existing code, make sure that your new code does not
6148 add to the memory footprint of the code ;-) Small is beautiful! 6159 add to the memory footprint of the code ;-) Small is beautiful!
6149 When adding new features, these should compile conditionally only 6160 When adding new features, these should compile conditionally only
6150 (using #ifdef), and the resulting code with the new feature 6161 (using #ifdef), and the resulting code with the new feature
6151 disabled must not need more memory than the old code without your 6162 disabled must not need more memory than the old code without your
6152 modification. 6163 modification.
6153 6164
6154 * Remember that there is a size limit of 100 kB per message on the 6165 * Remember that there is a size limit of 100 kB per message on the
6155 u-boot mailing list. Bigger patches will be moderated. If they are 6166 u-boot mailing list. Bigger patches will be moderated. If they are
6156 reasonable and not too big, they will be acknowledged. But patches 6167 reasonable and not too big, they will be acknowledged. But patches
6157 bigger than the size limit should be avoided. 6168 bigger than the size limit should be avoided.
6158 6169
board/sandbox/sandbox/README.sandbox
Diff comments   View file @ 75b3c3a
1 /* 1 /*
2 * Copyright (c) 2011 The Chromium OS Authors. 2 * Copyright (c) 2014 The Chromium OS Authors.
3 * 3 *
4 * SPDX-License-Identifier: GPL-2.0+ 4 * SPDX-License-Identifier: GPL-2.0+
5 */ 5 */
6 6
7 Native Execution of U-Boot 7 Native Execution of U-Boot
8 ========================== 8 ==========================
9 9
10 The 'sandbox' architecture is designed to allow U-Boot to run under Linux on 10 The 'sandbox' architecture is designed to allow U-Boot to run under Linux on
11 almost any hardware. To achieve this it builds U-Boot (so far as possible) 11 almost any hardware. To achieve this it builds U-Boot (so far as possible)
12 as a normal C application with a main() and normal C libraries. 12 as a normal C application with a main() and normal C libraries.
13 13
14 All of U-Boot's architecture-specific code therefore cannot be built as part 14 All of U-Boot's architecture-specific code therefore cannot be built as part
15 of the sandbox U-Boot. The purpose of running U-Boot under Linux is to test 15 of the sandbox U-Boot. The purpose of running U-Boot under Linux is to test
16 all the generic code, not specific to any one architecture. The idea is to 16 all the generic code, not specific to any one architecture. The idea is to
17 create unit tests which we can run to test this upper level code. 17 create unit tests which we can run to test this upper level code.
18 18
19 CONFIG_SANDBOX is defined when building a native board. 19 CONFIG_SANDBOX is defined when building a native board.
20 20
21 The chosen vendor and board names are also 'sandbox', so there is a single 21 The chosen vendor and board names are also 'sandbox', so there is a single
22 board in board/sandbox/sandbox. 22 board in board/sandbox/sandbox.
23 23
24 CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian 24 CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian
25 machines. 25 machines.
26 26
27 Note that standalone/API support is not available at present. 27 Note that standalone/API support is not available at present.
28 28
29 The serial driver is a very simple implementation which reads and writes to
30 the console. It does not set the terminal into raw mode, so cursor keys and
31 history will not work yet.
32 29
30 Basic Operation
31 ---------------
33 32
33 To run sandbox U-Boot use something like:
34
35 make sandbox_config all
36 ./u-boot
37
38 Note:
39 If you get errors about 'sdl-config: Command not found' you may need to
40 install libsdl1.2-dev or similar to get SDL support. Alternatively you can
41 build sandbox without SDL (i.e. no display/keyboard support) by removing
42 the CONFIG_SANDBOX_SDL line in include/configs/sandbox.h or using:
43
44 make sandbox_config all NO_SDL=1
45 ./u-boot
46
47
48 U-Boot will start on your computer, showing a sandbox emulation of the serial
49 console:
50
51
52 U-Boot 2014.04 (Mar 20 2014 - 19:06:00)
53
54 DRAM: 128 MiB
55 Using default environment
56
57 In: serial
58 Out: lcd
59 Err: lcd
60 =>
61
62 You can issue commands as your would normally. If the command you want is
63 not supported you can add it to include/configs/sandbox.h.
64
65 To exit, type 'reset' or press Ctrl-C.
66
67
68 Console / LCD support
69 ---------------------
70
71 Assuming that CONFIG_SANDBOX_SDL is defined when building, you can run the
72 sandbox with LCD and keyboard emulation, using something like:
73
74 ./u-boot -d u-boot.dtb -l
75
76 This will start U-Boot with a window showing the contents of the LCD. If
77 that window has the focus then you will be able to type commands as you
78 would on the console. You can adjust the display settings in the device
79 tree file - see arch/sandbox/dts/sandbox.dts.
80
81
82 Command-line Options
83 --------------------
84
85 Various options are available, mostly for test purposes. Use -h to see
86 available options. Some of these are described below.
87
88 The terminal is normally in what is called 'raw-with-sigs' mode. This means
89 that you can use arrow keys for command editing and history, but if you
90 press Ctrl-C, U-Boot will exit instead of handling this as a keypress.
91
92 Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked'
93 (where the terminal is in cooked mode and cursor keys will not work, Ctrl-C
94 will exit).
95
96 As mentioned above, -l causes the LCD emulation window to be shown.
97
98 A device tree binary file can be provided with -d. If you edit the source
99 (it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to
100 recreate the binary file.
101
102 To execute commands directly, use the -c option. You can specify a single
103 command, or multiple commands separated by a semicolon, as is normal in
104 U-Boot. Be careful with quoting as the shall will normally process and
105 swallow quotes. When -c is used, U-Boot exists after the command is complete,
106 but you can force it to go to interactive mode instead with -i.
107
108
109 Memory Emulation
110 ----------------
111
112 Memory emulation is supported, with the size set by CONFIG_SYS_SDRAM_SIZE.
113 The -m option can be used to read memory from a file on start-up and write
114 it when shutting down. This allows preserving of memory contents across
115 test runs. You can tell U-Boot to remove the memory file after it is read
116 (on start-up) with the --rm_memory option.
117
118 To access U-Boot's emulated memory within the code, use map_sysmem(). This
119 function is used throughout U-Boot to ensure that emulated memory is used
120 rather than the U-Boot application memory. This provides memory starting
121 at 0 and extending to the size of the emulation.
122
123
124 Storing State
125 -------------
126
127 With sandbox you can write drivers which emulate the operation of drivers on
128 real devices. Some of these drivers may want to record state which is
129 preserved across U-Boot runs. This is particularly useful for testing. For
130 example, the contents of a SPI flash chip should not disappear just because
131 U-Boot exits.
132
133 State is stored in a device tree file in a simple format which is driver-
134 specific. You then use the -s option to specify the state file. Use -r to
135 make U-Boot read the state on start-up (otherwise it starts empty) and -w
136 to write it on exit (otherwise the stored state is left unchanged and any
137 changes U-Boot made will be lost). You can also use -n to tell U-Boot to
138 ignore any problems with missing state. This is useful when first running
139 since the state file will be empty.
140
141 The device tree file has one node for each driver - the driver can store
142 whatever properties it likes in there. See 'Writing Sandbox Drivers' below
143 for more details on how to get drivers to read and write their state.
144
145
146 Running and Booting
147 -------------------
148
149 Since there is no machine architecture, sandbox U-Boot cannot actually boot
150 a kernel, but it does support the bootm command. Filesystems, memory
151 commands, hashing, FIT images, verified boot and many other features are
152 supported.
153
154 When 'bootm' runs a kernel, sandbox will exit, as U-Boot does on a real
155 machine. Of course in this case, no kernel is run.
156
157 It is also possible to tell U-Boot that it has jumped from a temporary
158 previous U-Boot binary, with the -j option. That binary is automatically
159 removed by the U-Boot that gets the -j option. This allows you to write
160 tests which emulate the action of chain-loading U-Boot, typically used in
161 a situation where a second 'updatable' U-Boot is stored on your board. It
162 is very risky to overwrite or upgrade the only U-Boot on a board, since a
163 power or other failure will brick the board and require return to the
164 manufacturer in the case of a consumer device.
165
166
167 Supported Drivers
168 -----------------
169
170 U-Boot sandbox supports these emulations:
171
172 - Block devices
173 - Chrome OS EC
174 - GPIO
175 - Host filesystem (access files on the host from within U-Boot)
176 - Keyboard (Chrome OS)
177 - LCD
178 - Serial (for console only)
179 - Sound (incomplete - see sandbox_sdl_sound_init() for details)
180 - SPI
181 - SPI flash
182 - TPM (Trusted Platform Module)
183
184 Notable omissions are networking and I2C.
185
186 A wide range of commands is implemented. Filesystems which use a block
187 device are supported.
188
189 Also sandbox uses generic board (CONFIG_SYS_GENERIC_BOARD) and supports
190 driver model (CONFIG_DM) and associated commands.
191
192
34 SPI Emulation 193 SPI Emulation
35 ------------- 194 -------------
36 195
37 Sandbox supports SPI and SPI flash emulation. 196 Sandbox supports SPI and SPI flash emulation.
38 197
39 This is controlled by the spi_sf argument, the format of which is: 198 This is controlled by the spi_sf argument, the format of which is:
40 199
41 bus:cs:device:file 200 bus:cs:device:file
42 201
43 bus - SPI bus number 202 bus - SPI bus number
44 cs - SPI chip select number 203 cs - SPI chip select number
45 device - SPI device emulation name 204 device - SPI device emulation name
46 file - File on disk containing the data 205 file - File on disk containing the data
47 206
48 For example: 207 For example:
49 208
50 dd if=/dev/zero of=spi.bin bs=1M count=4 209 dd if=/dev/zero of=spi.bin bs=1M count=4
51 ./u-boot --spi_sf 0:0:M25P16:spi.bin 210 ./u-boot --spi_sf 0:0:M25P16:spi.bin
52 211
53 With this setup you can issue SPI flash commands as normal: 212 With this setup you can issue SPI flash commands as normal:
54 213
55 =>sf probe 214 =>sf probe
56 SF: Detected M25P16 with page size 64 KiB, total 2 MiB 215 SF: Detected M25P16 with page size 64 KiB, total 2 MiB
57 =>sf read 0 0 10000 216 =>sf read 0 0 10000
58 SF: 65536 bytes @ 0x0 Read: OK 217 SF: 65536 bytes @ 0x0 Read: OK
59 => 218 =>
60 219
61 Since this is a full SPI emulation (rather than just flash), you can 220 Since this is a full SPI emulation (rather than just flash), you can
62 also use low-level SPI commands: 221 also use low-level SPI commands:
63 222
64 =>sspi 0:0 32 9f 223 =>sspi 0:0 32 9f
65 FF202015 224 FF202015
66 225
67 This is issuing a READ_ID command and getting back 20 (ST Micro) part 226 This is issuing a READ_ID command and getting back 20 (ST Micro) part
68 0x2015 (the M25P16). 227 0x2015 (the M25P16).
69 228
70 Drivers are connected to a particular bus/cs using sandbox's state 229 Drivers are connected to a particular bus/cs using sandbox's state
71 structure (see the 'spi' member). A set of operations must be provided 230 structure (see the 'spi' member). A set of operations must be provided
72 for each driver. 231 for each driver.
73 232
74 233
75 Configuration settings for the curious are: 234 Configuration settings for the curious are:
76 235
77 CONFIG_SANDBOX_SPI_MAX_BUS 236 CONFIG_SANDBOX_SPI_MAX_BUS
78 The maximum number of SPI buses supported by the driver (default 1). 237 The maximum number of SPI buses supported by the driver (default 1).
79 238
80 CONFIG_SANDBOX_SPI_MAX_CS 239 CONFIG_SANDBOX_SPI_MAX_CS
81 The maximum number of chip selects supported by the driver 240 The maximum number of chip selects supported by the driver
82 (default 10). 241 (default 10).
83 242
84 CONFIG_SPI_IDLE_VAL 243 CONFIG_SPI_IDLE_VAL
85 The idle value on the SPI bus 244 The idle value on the SPI bus
86 245
87 246
88 Tests 247 Writing Sandbox Drivers
89 ----- 248 -----------------------
90 249
91 So far we have no tests, but when we do these will be documented here. 250 Generally you should put your driver in a file containing the word 'sandbox'
251 and put it in the same directory as other drivers of its type. You can then
252 implement the same hooks as the other drivers.
253
254 To access U-Boot's emulated memory, use map_sysmem() as mentioned above.
255
256 If your driver needs to store configuration or state (such as SPI flash
257 contents or emulated chip registers), you can use the device tree as
258 described above. Define handlers for this with the SANDBOX_STATE_IO macro.
259 See arch/sandbox/include/asm/state.h for documentation. In short you provide
260 a node name, compatible string and functions to read and write the state.
261 Since writing the state can expand the device tree, you may need to use
262 state_setprop() which does this automatically and avoids running out of
263 space. See existing code for examples.
264
265
266 Testing
267 -------
268
269 U-Boot sandbox can be used to run various tests, mostly in the test/
270 directory. These include:
271
272 command_ut
273 - Unit tests for command parsing and handling
274 compression
275 - Unit tests for U-Boot's compression algorithms, useful for
276 security checking. It supports gzip, bzip2, lzma and lzo.
277 driver model
278 - test/dm/test-dm.sh to run these.
279 image
280 - Unit tests for images:
281 test/image/test-imagetools.sh - multi-file images
282 test/image/test-fit.py - FIT images
283 tracing
284 - test/trace/test-trace.sh tests the tracing system (see README.trace)
285 verified boot
286 - See test/vboot/vboot_test.sh for this
287
288 If you change or enhance any of the above subsystems, you shold write or
289 expand a test and include it with your patch series submission. Test
290 coverage in U-Boot is limited, as we need to work to improve it.
291
292 Note that many of these tests are implemented as commands which you can
293 run natively on your board if desired (and enabled).
294
295 It would be useful to have a central script to run all of these.
296
297 --