]>
Commit | Line | Data |
---|---|---|
c609719b | 1 | # |
151ab83a | 2 | # (C) Copyright 2000 - 2005 |
c609719b WD |
3 | # Wolfgang Denk, DENX Software Engineering, [email protected]. |
4 | # | |
5 | # See file CREDITS for list of people who contributed to this | |
6 | # project. | |
7 | # | |
8 | # This program is free software; you can redistribute it and/or | |
9 | # modify it under the terms of the GNU General Public License as | |
10 | # published by the Free Software Foundation; either version 2 of | |
11 | # the License, or (at your option) any later version. | |
12 | # | |
13 | # This program is distributed in the hope that it will be useful, | |
14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | # GNU General Public License for more details. | |
17 | # | |
18 | # You should have received a copy of the GNU General Public License | |
19 | # along with this program; if not, write to the Free Software | |
20 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, | |
21 | # MA 02111-1307 USA | |
22 | # | |
23 | ||
24 | Summary: | |
25 | ======== | |
26 | ||
24ee89b9 | 27 | This directory contains the source code for U-Boot, a boot loader for |
e86e5a07 WD |
28 | Embedded boards based on PowerPC, ARM, MIPS and several other |
29 | processors, which can be installed in a boot ROM and used to | |
30 | initialize and test the hardware or to download and run application | |
31 | code. | |
c609719b WD |
32 | |
33 | The development of U-Boot is closely related to Linux: some parts of | |
24ee89b9 WD |
34 | the source code originate in the Linux source tree, we have some |
35 | header files in common, and special provision has been made to | |
c609719b WD |
36 | support booting of Linux images. |
37 | ||
38 | Some attention has been paid to make this software easily | |
39 | configurable and extendable. For instance, all monitor commands are | |
40 | implemented with the same call interface, so that it's very easy to | |
41 | add new commands. Also, instead of permanently adding rarely used | |
42 | code (for instance hardware test utilities) to the monitor, you can | |
43 | load and run it dynamically. | |
44 | ||
45 | ||
46 | Status: | |
47 | ======= | |
48 | ||
49 | In general, all boards for which a configuration option exists in the | |
24ee89b9 | 50 | Makefile have been tested to some extent and can be considered |
c609719b WD |
51 | "working". In fact, many of them are used in production systems. |
52 | ||
24ee89b9 | 53 | In case of problems see the CHANGELOG and CREDITS files to find out |
c609719b WD |
54 | who contributed the specific port. |
55 | ||
c609719b WD |
56 | |
57 | Where to get help: | |
58 | ================== | |
59 | ||
24ee89b9 WD |
60 | In case you have questions about, problems with or contributions for |
61 | U-Boot you should send a message to the U-Boot mailing list at | |
62 | <[email protected]>. There is also an archive of | |
63 | previous traffic on the mailing list - please search the archive | |
c609719b WD |
64 | before asking FAQ's. Please see |
65 | http://lists.sourceforge.net/lists/listinfo/u-boot-users/ | |
66 | ||
67 | ||
68 | Where we come from: | |
69 | =================== | |
70 | ||
71 | - start from 8xxrom sources | |
24ee89b9 | 72 | - create PPCBoot project (http://sourceforge.net/projects/ppcboot) |
c609719b WD |
73 | - clean up code |
74 | - make it easier to add custom boards | |
75 | - make it possible to add other [PowerPC] CPUs | |
76 | - extend functions, especially: | |
77 | * Provide extended interface to Linux boot loader | |
78 | * S-Record download | |
79 | * network boot | |
80 | * PCMCIA / CompactFLash / ATA disk / SCSI ... boot | |
24ee89b9 | 81 | - create ARMBoot project (http://sourceforge.net/projects/armboot) |
c609719b | 82 | - add other CPU families (starting with ARM) |
24ee89b9 WD |
83 | - create U-Boot project (http://sourceforge.net/projects/u-boot) |
84 | ||
85 | ||
86 | Names and Spelling: | |
87 | =================== | |
88 | ||
89 | The "official" name of this project is "Das U-Boot". The spelling | |
90 | "U-Boot" shall be used in all written text (documentation, comments | |
91 | in source files etc.). Example: | |
92 | ||
93 | This is the README file for the U-Boot project. | |
94 | ||
95 | File names etc. shall be based on the string "u-boot". Examples: | |
96 | ||
97 | include/asm-ppc/u-boot.h | |
98 | ||
99 | #include <asm/u-boot.h> | |
100 | ||
101 | Variable names, preprocessor constants etc. shall be either based on | |
102 | the string "u_boot" or on "U_BOOT". Example: | |
103 | ||
104 | U_BOOT_VERSION u_boot_logo | |
105 | IH_OS_U_BOOT u_boot_hush_start | |
c609719b WD |
106 | |
107 | ||
93f19cc0 WD |
108 | Versioning: |
109 | =========== | |
110 | ||
111 | U-Boot uses a 3 level version number containing a version, a | |
112 | sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2", | |
113 | sub-version "34", and patchlevel "4". | |
114 | ||
115 | The patchlevel is used to indicate certain stages of development | |
116 | between released versions, i. e. officially released versions of | |
117 | U-Boot will always have a patchlevel of "0". | |
118 | ||
119 | ||
c609719b WD |
120 | Directory Hierarchy: |
121 | ==================== | |
122 | ||
7152b1d0 WD |
123 | - board Board dependent files |
124 | - common Misc architecture independent functions | |
c609719b | 125 | - cpu CPU specific files |
983fda83 | 126 | - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs |
11dadd54 WD |
127 | - arm720t Files specific to ARM 720 CPUs |
128 | - arm920t Files specific to ARM 920 CPUs | |
a85f9f21 | 129 | - at91rm9200 Files specific to Atmel AT91RM9200 CPU |
983fda83 | 130 | - imx Files specific to Freescale MC9328 i.MX CPUs |
1d9f4105 | 131 | - s3c24x0 Files specific to Samsung S3C24X0 CPUs |
11dadd54 WD |
132 | - arm925t Files specific to ARM 925 CPUs |
133 | - arm926ejs Files specific to ARM 926 CPUs | |
8ed96046 | 134 | - arm1136 Files specific to ARM 1136 CPUs |
72a087e0 | 135 | - at32ap Files specific to Atmel AVR32 AP CPUs |
11dadd54 WD |
136 | - i386 Files specific to i386 CPUs |
137 | - ixp Files specific to Intel XScale IXP CPUs | |
983fda83 | 138 | - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs |
11dadd54 | 139 | - mips Files specific to MIPS CPUs |
983fda83 WD |
140 | - mpc5xx Files specific to Freescale MPC5xx CPUs |
141 | - mpc5xxx Files specific to Freescale MPC5xxx CPUs | |
142 | - mpc8xx Files specific to Freescale MPC8xx CPUs | |
143 | - mpc8220 Files specific to Freescale MPC8220 CPUs | |
144 | - mpc824x Files specific to Freescale MPC824x CPUs | |
145 | - mpc8260 Files specific to Freescale MPC8260 CPUs | |
146 | - mpc85xx Files specific to Freescale MPC85xx CPUs | |
11dadd54 | 147 | - nios Files specific to Altera NIOS CPUs |
5c952cf0 | 148 | - nios2 Files specific to Altera Nios-II CPUs |
0c8721a4 | 149 | - ppc4xx Files specific to AMCC PowerPC 4xx CPUs |
11dadd54 WD |
150 | - pxa Files specific to Intel XScale PXA CPUs |
151 | - s3c44b0 Files specific to Samsung S3C44B0 CPUs | |
152 | - sa1100 Files specific to Intel StrongARM SA1100 CPUs | |
c609719b WD |
153 | - disk Code for disk drive partition handling |
154 | - doc Documentation (don't expect too much) | |
7152b1d0 | 155 | - drivers Commonly used device drivers |
c609719b WD |
156 | - dtt Digital Thermometer and Thermostat drivers |
157 | - examples Example code for standalone applications, etc. | |
158 | - include Header Files | |
11dadd54 | 159 | - lib_arm Files generic to ARM architecture |
7b64fef3 | 160 | - lib_avr32 Files generic to AVR32 architecture |
11dadd54 WD |
161 | - lib_generic Files generic to all architectures |
162 | - lib_i386 Files generic to i386 architecture | |
163 | - lib_m68k Files generic to m68k architecture | |
164 | - lib_mips Files generic to MIPS architecture | |
165 | - lib_nios Files generic to NIOS architecture | |
166 | - lib_ppc Files generic to PowerPC architecture | |
c609719b | 167 | - net Networking code |
c609719b | 168 | - post Power On Self Test |
c609719b WD |
169 | - rtc Real Time Clock drivers |
170 | - tools Tools to build S-Record or U-Boot images, etc. | |
171 | ||
c609719b WD |
172 | Software Configuration: |
173 | ======================= | |
174 | ||
175 | Configuration is usually done using C preprocessor defines; the | |
176 | rationale behind that is to avoid dead code whenever possible. | |
177 | ||
178 | There are two classes of configuration variables: | |
179 | ||
180 | * Configuration _OPTIONS_: | |
181 | These are selectable by the user and have names beginning with | |
182 | "CONFIG_". | |
183 | ||
184 | * Configuration _SETTINGS_: | |
185 | These depend on the hardware etc. and should not be meddled with if | |
186 | you don't know what you're doing; they have names beginning with | |
187 | "CFG_". | |
188 | ||
189 | Later we will add a configuration tool - probably similar to or even | |
190 | identical to what's used for the Linux kernel. Right now, we have to | |
191 | do the configuration by hand, which means creating some symbolic | |
192 | links and editing some configuration files. We use the TQM8xxL boards | |
193 | as an example here. | |
194 | ||
195 | ||
196 | Selection of Processor Architecture and Board Type: | |
197 | --------------------------------------------------- | |
198 | ||
199 | For all supported boards there are ready-to-use default | |
200 | configurations available; just type "make <board_name>_config". | |
201 | ||
202 | Example: For a TQM823L module type: | |
203 | ||
204 | cd u-boot | |
205 | make TQM823L_config | |
206 | ||
207 | For the Cogent platform, you need to specify the cpu type as well; | |
208 | e.g. "make cogent_mpc8xx_config". And also configure the cogent | |
209 | directory according to the instructions in cogent/README. | |
210 | ||
211 | ||
212 | Configuration Options: | |
213 | ---------------------- | |
214 | ||
215 | Configuration depends on the combination of board and CPU type; all | |
216 | such information is kept in a configuration file | |
217 | "include/configs/<board_name>.h". | |
218 | ||
219 | Example: For a TQM823L module, all configuration settings are in | |
220 | "include/configs/TQM823L.h". | |
221 | ||
222 | ||
7f6c2cbc WD |
223 | Many of the options are named exactly as the corresponding Linux |
224 | kernel configuration options. The intention is to make it easier to | |
225 | build a config tool - later. | |
226 | ||
227 | ||
c609719b WD |
228 | The following options need to be configured: |
229 | ||
230 | - CPU Type: Define exactly one of | |
231 | ||
232 | PowerPC based CPUs: | |
233 | ------------------- | |
234 | CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860 | |
0db5bca8 | 235 | or CONFIG_MPC5xx |
983fda83 | 236 | or CONFIG_MPC8220 |
c609719b | 237 | or CONFIG_MPC824X, CONFIG_MPC8260 |
42d1f039 | 238 | or CONFIG_MPC85xx |
c609719b WD |
239 | or CONFIG_IOP480 |
240 | or CONFIG_405GP | |
12f34241 | 241 | or CONFIG_405EP |
c609719b WD |
242 | or CONFIG_440 |
243 | or CONFIG_MPC74xx | |
72755c71 | 244 | or CONFIG_750FX |
c609719b WD |
245 | |
246 | ARM based CPUs: | |
247 | --------------- | |
248 | CONFIG_SA1110 | |
249 | CONFIG_ARM7 | |
250 | CONFIG_PXA250 | |
0b953ffc | 251 | CONFIG_CPU_MONAHANS |
c609719b | 252 | |
507bbe3e WD |
253 | MicroBlaze based CPUs: |
254 | ---------------------- | |
857cad37 | 255 | CONFIG_MICROBLAZE |
507bbe3e | 256 | |
5c952cf0 WD |
257 | Nios-2 based CPUs: |
258 | ---------------------- | |
259 | CONFIG_NIOS2 | |
260 | ||
72a087e0 WD |
261 | AVR32 based CPUs: |
262 | ---------------------- | |
263 | CONFIG_AT32AP | |
c609719b WD |
264 | |
265 | - Board Type: Define exactly one of | |
266 | ||
267 | PowerPC based boards: | |
268 | --------------------- | |
269 | ||
76544f80 DZ |
270 | CONFIG_ADCIOP CONFIG_FPS860L CONFIG_OXC |
271 | CONFIG_ADS860 CONFIG_GEN860T CONFIG_PCI405 | |
272 | CONFIG_AMX860 CONFIG_GENIETV CONFIG_PCIPPC2 | |
273 | CONFIG_AP1000 CONFIG_GTH CONFIG_PCIPPC6 | |
274 | CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e | |
275 | CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405 | |
276 | CONFIG_BC3450 CONFIG_hymod CONFIG_PM826 | |
09e4b0c5 WD |
277 | CONFIG_c2mon CONFIG_IAD210 CONFIG_ppmc8260 |
278 | CONFIG_CANBT CONFIG_ICU862 CONFIG_QS823 | |
279 | CONFIG_CCM CONFIG_IP860 CONFIG_QS850 | |
280 | CONFIG_CMI CONFIG_IPHASE4539 CONFIG_QS860T | |
281 | CONFIG_cogent_mpc8260 CONFIG_IVML24 CONFIG_RBC823 | |
282 | CONFIG_cogent_mpc8xx CONFIG_IVML24_128 CONFIG_RPXClassic | |
283 | CONFIG_CPCI405 CONFIG_IVML24_256 CONFIG_RPXlite | |
284 | CONFIG_CPCI4052 CONFIG_IVMS8 CONFIG_RPXsuper | |
285 | CONFIG_CPCIISER4 CONFIG_IVMS8_128 CONFIG_rsdproto | |
286 | CONFIG_CPU86 CONFIG_IVMS8_256 CONFIG_sacsng | |
287 | CONFIG_CRAYL1 CONFIG_JSE CONFIG_Sandpoint8240 | |
288 | CONFIG_CSB272 CONFIG_LANTEC CONFIG_Sandpoint8245 | |
289 | CONFIG_CU824 CONFIG_LITE5200B CONFIG_sbc8260 | |
290 | CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8560 | |
291 | CONFIG_DB64360 CONFIG_MBX CONFIG_SM850 | |
292 | CONFIG_DB64460 CONFIG_MBX860T CONFIG_SPD823TS | |
293 | CONFIG_DU405 CONFIG_MHPC CONFIG_STXGP3 | |
294 | CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_SXNI855T | |
295 | CONFIG_EBONY CONFIG_MOUSSE CONFIG_TQM823L | |
296 | CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM8260 | |
297 | CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM850L | |
298 | CONFIG_ep8260 CONFIG_MPC8540EVAL CONFIG_TQM855L | |
299 | CONFIG_ERIC CONFIG_MPC8560ADS CONFIG_TQM860L | |
300 | CONFIG_ESTEEM192E CONFIG_MUSENKI CONFIG_TTTech | |
301 | CONFIG_ETX094 CONFIG_MVS1 CONFIG_UTX8245 | |
302 | CONFIG_EVB64260 CONFIG_NETPHONE CONFIG_V37 | |
303 | CONFIG_FADS823 CONFIG_NETTA CONFIG_W7OLMC | |
304 | CONFIG_FADS850SAR CONFIG_NETVIA CONFIG_W7OLMG | |
305 | CONFIG_FADS860T CONFIG_NX823 CONFIG_WALNUT | |
306 | CONFIG_FLAGADM CONFIG_OCRTC CONFIG_ZPC1900 | |
307 | CONFIG_FPS850L CONFIG_ORSG CONFIG_ZUMA | |
3df5bea0 | 308 | |
c609719b WD |
309 | ARM based boards: |
310 | ----------------- | |
311 | ||
c570b2fd | 312 | CONFIG_ARMADILLO, CONFIG_AT91RM9200DK, CONFIG_CERF250, |
0b953ffc | 313 | CONFIG_CSB637, CONFIG_DELTA, CONFIG_DNP1110, |
b9365a26 | 314 | CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE, |
cf48eb9a | 315 | CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610, |
0b953ffc MK |
316 | CONFIG_KB9202, CONFIG_LART, CONFIG_LPD7A400, |
317 | CONFIG_LUBBOCK, CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4, | |
5720df78 HS |
318 | CONFIG_PLEB2, CONFIG_SHANNON, CONFIG_P2_OMAP730, |
319 | CONFIG_SMDK2400, CONFIG_SMDK2410, CONFIG_TRAB, | |
320 | CONFIG_VCMA9 | |
c609719b | 321 | |
507bbe3e WD |
322 | MicroBlaze based boards: |
323 | ------------------------ | |
324 | ||
325 | CONFIG_SUZAKU | |
326 | ||
5c952cf0 WD |
327 | Nios-2 based boards: |
328 | ------------------------ | |
329 | ||
330 | CONFIG_PCI5441 CONFIG_PK1C20 | |
9cc83378 | 331 | CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40 |
5c952cf0 | 332 | |
6ccec449 WD |
333 | AVR32 based boards: |
334 | ------------------- | |
335 | ||
336 | CONFIG_ATSTK1000 | |
337 | ||
338 | - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) | |
339 | Define exactly one of | |
340 | CONFIG_ATSTK1002 | |
341 | ||
c609719b WD |
342 | |
343 | - CPU Module Type: (if CONFIG_COGENT is defined) | |
344 | Define exactly one of | |
345 | CONFIG_CMA286_60_OLD | |
346 | --- FIXME --- not tested yet: | |
347 | CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, | |
348 | CONFIG_CMA287_23, CONFIG_CMA287_50 | |
349 | ||
350 | - Motherboard Type: (if CONFIG_COGENT is defined) | |
351 | Define exactly one of | |
352 | CONFIG_CMA101, CONFIG_CMA102 | |
353 | ||
354 | - Motherboard I/O Modules: (if CONFIG_COGENT is defined) | |
355 | Define one or more of | |
356 | CONFIG_CMA302 | |
357 | ||
358 | - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) | |
359 | Define one or more of | |
360 | CONFIG_LCD_HEARTBEAT - update a character position on | |
361 | the lcd display every second with | |
362 | a "rotator" |\-/|\-/ | |
363 | ||
2535d602 WD |
364 | - Board flavour: (if CONFIG_MPC8260ADS is defined) |
365 | CONFIG_ADSTYPE | |
366 | Possible values are: | |
367 | CFG_8260ADS - original MPC8260ADS | |
180d3f74 | 368 | CFG_8266ADS - MPC8266ADS |
54387ac9 | 369 | CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR |
04a85b3b | 370 | CFG_8272ADS - MPC8272ADS |
2535d602 | 371 | |
c609719b | 372 | - MPC824X Family Member (if CONFIG_MPC824X is defined) |
5da627a4 WD |
373 | Define exactly one of |
374 | CONFIG_MPC8240, CONFIG_MPC8245 | |
c609719b | 375 | |
75d1ea7f | 376 | - 8xx CPU Options: (if using an MPC8xx cpu) |
66ca92a5 WD |
377 | CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if |
378 | get_gclk_freq() cannot work | |
5da627a4 WD |
379 | e.g. if there is no 32KHz |
380 | reference PIT/RTC clock | |
66ca92a5 WD |
381 | CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK |
382 | or XTAL/EXTAL) | |
c609719b | 383 | |
66ca92a5 WD |
384 | - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): |
385 | CFG_8xx_CPUCLK_MIN | |
386 | CFG_8xx_CPUCLK_MAX | |
387 | CONFIG_8xx_CPUCLK_DEFAULT | |
75d1ea7f WD |
388 | See doc/README.MPC866 |
389 | ||
390 | CFG_MEASURE_CPUCLK | |
391 | ||
ba56f625 WD |
392 | Define this to measure the actual CPU clock instead |
393 | of relying on the correctness of the configured | |
394 | values. Mostly useful for board bringup to make sure | |
395 | the PLL is locked at the intended frequency. Note | |
396 | that this requires a (stable) reference clock (32 kHz | |
66ca92a5 | 397 | RTC clock or CFG_8XX_XIN) |
75d1ea7f | 398 | |
0b953ffc MK |
399 | - Intel Monahans options: |
400 | CFG_MONAHANS_RUN_MODE_OSC_RATIO | |
401 | ||
402 | Defines the Monahans run mode to oscillator | |
403 | ratio. Valid values are 8, 16, 24, 31. The core | |
404 | frequency is this value multiplied by 13 MHz. | |
405 | ||
406 | CFG_MONAHANS_TURBO_RUN_MODE_RATIO | |
cf48eb9a | 407 | |
0b953ffc MK |
408 | Defines the Monahans turbo mode to oscillator |
409 | ratio. Valid values are 1 (default if undefined) and | |
cf48eb9a | 410 | 2. The core frequency as calculated above is multiplied |
0b953ffc | 411 | by this value. |
cf48eb9a | 412 | |
5da627a4 | 413 | - Linux Kernel Interface: |
c609719b WD |
414 | CONFIG_CLOCKS_IN_MHZ |
415 | ||
416 | U-Boot stores all clock information in Hz | |
417 | internally. For binary compatibility with older Linux | |
418 | kernels (which expect the clocks passed in the | |
419 | bd_info data to be in MHz) the environment variable | |
420 | "clocks_in_mhz" can be defined so that U-Boot | |
421 | converts clock data to MHZ before passing it to the | |
422 | Linux kernel. | |
c609719b WD |
423 | When CONFIG_CLOCKS_IN_MHZ is defined, a definition of |
424 | "clocks_in_mhz=1" is automatically included in the | |
425 | default environment. | |
426 | ||
5da627a4 WD |
427 | CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] |
428 | ||
429 | When transfering memsize parameter to linux, some versions | |
430 | expect it to be in bytes, others in MB. | |
431 | Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. | |
432 | ||
f57f70aa WD |
433 | CONFIG_OF_FLAT_TREE |
434 | ||
435 | New kernel versions are expecting firmware settings to be | |
436 | passed using flat open firmware trees. | |
437 | The environment variable "disable_of", when set, disables this | |
438 | functionality. | |
439 | ||
440 | CONFIG_OF_FLAT_TREE_MAX_SIZE | |
441 | ||
442 | The maximum size of the constructed OF tree. | |
443 | ||
444 | OF_CPU - The proper name of the cpus node. | |
c2871f03 | 445 | OF_SOC - The proper name of the soc node. |
f57f70aa | 446 | OF_TBCLK - The timebase frequency. |
c2871f03 | 447 | OF_STDOUT_PATH - The path to the console device |
f57f70aa | 448 | |
e4f880ed KG |
449 | CONFIG_OF_HAS_BD_T |
450 | ||
451 | The resulting flat device tree will have a copy of the bd_t. | |
452 | Space should be pre-allocated in the dts for the bd_t. | |
453 | ||
454 | CONFIG_OF_HAS_UBOOT_ENV | |
15940c9a | 455 | |
e4f880ed KG |
456 | The resulting flat device tree will have a copy of u-boot's |
457 | environment variables | |
458 | ||
4e253137 KG |
459 | CONFIG_OF_BOARD_SETUP |
460 | ||
461 | Board code has addition modification that it wants to make | |
462 | to the flat device tree before handing it off to the kernel | |
f57f70aa | 463 | |
0267768e MM |
464 | CONFIG_OF_BOOT_CPU |
465 | ||
466 | This define fills in the correct boot cpu in the boot | |
467 | param header, the default value is zero if undefined. | |
468 | ||
6705d81e WD |
469 | - Serial Ports: |
470 | CFG_PL010_SERIAL | |
471 | ||
472 | Define this if you want support for Amba PrimeCell PL010 UARTs. | |
473 | ||
474 | CFG_PL011_SERIAL | |
475 | ||
476 | Define this if you want support for Amba PrimeCell PL011 UARTs. | |
477 | ||
478 | CONFIG_PL011_CLOCK | |
479 | ||
480 | If you have Amba PrimeCell PL011 UARTs, set this variable to | |
481 | the clock speed of the UARTs. | |
482 | ||
483 | CONFIG_PL01x_PORTS | |
484 | ||
485 | If you have Amba PrimeCell PL010 or PL011 UARTs on your board, | |
486 | define this to a list of base addresses for each (supported) | |
487 | port. See e.g. include/configs/versatile.h | |
488 | ||
489 | ||
c609719b | 490 | - Console Interface: |
43d9616c WD |
491 | Depending on board, define exactly one serial port |
492 | (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, | |
493 | CONFIG_8xx_CONS_SCC1, ...), or switch off the serial | |
494 | console by defining CONFIG_8xx_CONS_NONE | |
c609719b WD |
495 | |
496 | Note: if CONFIG_8xx_CONS_NONE is defined, the serial | |
497 | port routines must be defined elsewhere | |
498 | (i.e. serial_init(), serial_getc(), ...) | |
499 | ||
500 | CONFIG_CFB_CONSOLE | |
501 | Enables console device for a color framebuffer. Needs following | |
502 | defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) | |
503 | VIDEO_FB_LITTLE_ENDIAN graphic memory organisation | |
504 | (default big endian) | |
505 | VIDEO_HW_RECTFILL graphic chip supports | |
506 | rectangle fill | |
507 | (cf. smiLynxEM) | |
508 | VIDEO_HW_BITBLT graphic chip supports | |
509 | bit-blit (cf. smiLynxEM) | |
510 | VIDEO_VISIBLE_COLS visible pixel columns | |
511 | (cols=pitch) | |
ba56f625 WD |
512 | VIDEO_VISIBLE_ROWS visible pixel rows |
513 | VIDEO_PIXEL_SIZE bytes per pixel | |
c609719b WD |
514 | VIDEO_DATA_FORMAT graphic data format |
515 | (0-5, cf. cfb_console.c) | |
ba56f625 | 516 | VIDEO_FB_ADRS framebuffer address |
c609719b WD |
517 | VIDEO_KBD_INIT_FCT keyboard int fct |
518 | (i.e. i8042_kbd_init()) | |
519 | VIDEO_TSTC_FCT test char fct | |
520 | (i.e. i8042_tstc) | |
521 | VIDEO_GETC_FCT get char fct | |
522 | (i.e. i8042_getc) | |
523 | CONFIG_CONSOLE_CURSOR cursor drawing on/off | |
524 | (requires blink timer | |
525 | cf. i8042.c) | |
526 | CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) | |
527 | CONFIG_CONSOLE_TIME display time/date info in | |
528 | upper right corner | |
529 | (requires CFG_CMD_DATE) | |
530 | CONFIG_VIDEO_LOGO display Linux logo in | |
531 | upper left corner | |
a6c7ad2f WD |
532 | CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of |
533 | linux_logo.h for logo. | |
534 | Requires CONFIG_VIDEO_LOGO | |
c609719b WD |
535 | CONFIG_CONSOLE_EXTRA_INFO |
536 | addional board info beside | |
537 | the logo | |
538 | ||
43d9616c WD |
539 | When CONFIG_CFB_CONSOLE is defined, video console is |
540 | default i/o. Serial console can be forced with | |
541 | environment 'console=serial'. | |
c609719b | 542 | |
d4ca31c4 WD |
543 | When CONFIG_SILENT_CONSOLE is defined, all console |
544 | messages (by U-Boot and Linux!) can be silenced with | |
545 | the "silent" environment variable. See | |
546 | doc/README.silent for more information. | |
a3ad8e26 | 547 | |
c609719b WD |
548 | - Console Baudrate: |
549 | CONFIG_BAUDRATE - in bps | |
550 | Select one of the baudrates listed in | |
551 | CFG_BAUDRATE_TABLE, see below. | |
3bbc899f | 552 | CFG_BRGCLK_PRESCALE, baudrate prescale |
c609719b WD |
553 | |
554 | - Interrupt driven serial port input: | |
555 | CONFIG_SERIAL_SOFTWARE_FIFO | |
556 | ||
557 | PPC405GP only. | |
558 | Use an interrupt handler for receiving data on the | |
559 | serial port. It also enables using hardware handshake | |
560 | (RTS/CTS) and UART's built-in FIFO. Set the number of | |
561 | bytes the interrupt driven input buffer should have. | |
562 | ||
109c0e3a WD |
563 | Leave undefined to disable this feature, including |
564 | disable the buffer and hardware handshake. | |
c609719b | 565 | |
1d49b1f3 SR |
566 | - Console UART Number: |
567 | CONFIG_UART1_CONSOLE | |
568 | ||
0c8721a4 | 569 | AMCC PPC4xx only. |
1d49b1f3 SR |
570 | If defined internal UART1 (and not UART0) is used |
571 | as default U-Boot console. | |
572 | ||
c609719b WD |
573 | - Boot Delay: CONFIG_BOOTDELAY - in seconds |
574 | Delay before automatically booting the default image; | |
575 | set to -1 to disable autoboot. | |
576 | ||
577 | See doc/README.autoboot for these options that | |
578 | work with CONFIG_BOOTDELAY. None are required. | |
579 | CONFIG_BOOT_RETRY_TIME | |
580 | CONFIG_BOOT_RETRY_MIN | |
581 | CONFIG_AUTOBOOT_KEYED | |
582 | CONFIG_AUTOBOOT_PROMPT | |
583 | CONFIG_AUTOBOOT_DELAY_STR | |
584 | CONFIG_AUTOBOOT_STOP_STR | |
585 | CONFIG_AUTOBOOT_DELAY_STR2 | |
586 | CONFIG_AUTOBOOT_STOP_STR2 | |
587 | CONFIG_ZERO_BOOTDELAY_CHECK | |
588 | CONFIG_RESET_TO_RETRY | |
589 | ||
590 | - Autoboot Command: | |
591 | CONFIG_BOOTCOMMAND | |
592 | Only needed when CONFIG_BOOTDELAY is enabled; | |
593 | define a command string that is automatically executed | |
594 | when no character is read on the console interface | |
595 | within "Boot Delay" after reset. | |
596 | ||
597 | CONFIG_BOOTARGS | |
43d9616c WD |
598 | This can be used to pass arguments to the bootm |
599 | command. The value of CONFIG_BOOTARGS goes into the | |
600 | environment value "bootargs". | |
c609719b WD |
601 | |
602 | CONFIG_RAMBOOT and CONFIG_NFSBOOT | |
43d9616c WD |
603 | The value of these goes into the environment as |
604 | "ramboot" and "nfsboot" respectively, and can be used | |
605 | as a convenience, when switching between booting from | |
606 | ram and nfs. | |
c609719b WD |
607 | |
608 | - Pre-Boot Commands: | |
609 | CONFIG_PREBOOT | |
610 | ||
611 | When this option is #defined, the existence of the | |
612 | environment variable "preboot" will be checked | |
613 | immediately before starting the CONFIG_BOOTDELAY | |
614 | countdown and/or running the auto-boot command resp. | |
615 | entering interactive mode. | |
616 | ||
617 | This feature is especially useful when "preboot" is | |
618 | automatically generated or modified. For an example | |
619 | see the LWMON board specific code: here "preboot" is | |
620 | modified when the user holds down a certain | |
621 | combination of keys on the (special) keyboard when | |
622 | booting the systems | |
623 | ||
624 | - Serial Download Echo Mode: | |
625 | CONFIG_LOADS_ECHO | |
626 | If defined to 1, all characters received during a | |
627 | serial download (using the "loads" command) are | |
628 | echoed back. This might be needed by some terminal | |
629 | emulations (like "cu"), but may as well just take | |
630 | time on others. This setting #define's the initial | |
631 | value of the "loads_echo" environment variable. | |
632 | ||
633 | - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined) | |
634 | CONFIG_KGDB_BAUDRATE | |
635 | Select one of the baudrates listed in | |
636 | CFG_BAUDRATE_TABLE, see below. | |
637 | ||
638 | - Monitor Functions: | |
639 | CONFIG_COMMANDS | |
640 | Most monitor functions can be selected (or | |
641 | de-selected) by adjusting the definition of | |
642 | CONFIG_COMMANDS; to select individual functions, | |
643 | #define CONFIG_COMMANDS by "OR"ing any of the | |
644 | following values: | |
645 | ||
646 | #define enables commands: | |
647 | ------------------------- | |
648 | CFG_CMD_ASKENV * ask for env variable | |
78137c3c | 649 | CFG_CMD_AUTOSCRIPT Autoscript Support |
c609719b | 650 | CFG_CMD_BDI bdinfo |
6705d81e | 651 | CFG_CMD_BEDBUG * Include BedBug Debugger |
ba56f625 | 652 | CFG_CMD_BMP * BMP support |
6705d81e | 653 | CFG_CMD_BSP * Board specific commands |
c609719b | 654 | CFG_CMD_BOOTD bootd |
6705d81e | 655 | CFG_CMD_CACHE * icache, dcache |
c609719b WD |
656 | CFG_CMD_CONSOLE coninfo |
657 | CFG_CMD_DATE * support for RTC, date/time... | |
6705d81e | 658 | CFG_CMD_DHCP * DHCP support |
ba56f625 WD |
659 | CFG_CMD_DIAG * Diagnostics |
660 | CFG_CMD_DOC * Disk-On-Chip Support | |
6705d81e | 661 | CFG_CMD_DTT * Digital Therm and Thermostat |
953c5b6f | 662 | CFG_CMD_ECHO echo arguments |
c609719b | 663 | CFG_CMD_EEPROM * EEPROM read/write support |
6705d81e | 664 | CFG_CMD_ELF * bootelf, bootvx |
c609719b WD |
665 | CFG_CMD_ENV saveenv |
666 | CFG_CMD_FDC * Floppy Disk Support | |
6705d81e | 667 | CFG_CMD_FAT * FAT partition support |
2262cfee | 668 | CFG_CMD_FDOS * Dos diskette Support |
c609719b WD |
669 | CFG_CMD_FLASH flinfo, erase, protect |
670 | CFG_CMD_FPGA FPGA device initialization support | |
ba56f625 | 671 | CFG_CMD_HWFLOW * RTS/CTS hw flow control |
c609719b WD |
672 | CFG_CMD_I2C * I2C serial bus support |
673 | CFG_CMD_IDE * IDE harddisk support | |
674 | CFG_CMD_IMI iminfo | |
ba56f625 | 675 | CFG_CMD_IMLS List all found images |
c609719b WD |
676 | CFG_CMD_IMMAP * IMMR dump support |
677 | CFG_CMD_IRQ * irqinfo | |
6705d81e | 678 | CFG_CMD_ITEST Integer/string test of 2 values |
ba56f625 | 679 | CFG_CMD_JFFS2 * JFFS2 Support |
c609719b WD |
680 | CFG_CMD_KGDB * kgdb |
681 | CFG_CMD_LOADB loadb | |
682 | CFG_CMD_LOADS loads | |
683 | CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, | |
56523f12 | 684 | loop, loopw, mtest |
ba56f625 | 685 | CFG_CMD_MISC Misc functions like sleep etc |
6705d81e WD |
686 | CFG_CMD_MMC * MMC memory mapped support |
687 | CFG_CMD_MII * MII utility commands | |
ba56f625 | 688 | CFG_CMD_NAND * NAND support |
c609719b WD |
689 | CFG_CMD_NET bootp, tftpboot, rarpboot |
690 | CFG_CMD_PCI * pciinfo | |
691 | CFG_CMD_PCMCIA * PCMCIA support | |
ba56f625 WD |
692 | CFG_CMD_PING * send ICMP ECHO_REQUEST to network host |
693 | CFG_CMD_PORTIO * Port I/O | |
c609719b WD |
694 | CFG_CMD_REGINFO * Register dump |
695 | CFG_CMD_RUN run command in env variable | |
6705d81e | 696 | CFG_CMD_SAVES * save S record dump |
c609719b | 697 | CFG_CMD_SCSI * SCSI Support |
ba56f625 | 698 | CFG_CMD_SDRAM * print SDRAM configuration information |
b1bf6f2c | 699 | (requires CFG_CMD_I2C) |
c609719b WD |
700 | CFG_CMD_SETGETDCR Support for DCR Register access (4xx only) |
701 | CFG_CMD_SPI * SPI serial bus support | |
702 | CFG_CMD_USB * USB support | |
ba56f625 | 703 | CFG_CMD_VFD * VFD support (TRAB) |
c609719b | 704 | CFG_CMD_BSP * Board SPecific functions |
a3d991bd | 705 | CFG_CMD_CDP * Cisco Discover Protocol support |
c609719b WD |
706 | ----------------------------------------------- |
707 | CFG_CMD_ALL all | |
708 | ||
81050926 | 709 | CONFIG_CMD_DFL Default configuration; at the moment |
c609719b WD |
710 | this is includes all commands, except |
711 | the ones marked with "*" in the list | |
712 | above. | |
713 | ||
714 | If you don't define CONFIG_COMMANDS it defaults to | |
81050926 | 715 | CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can |
c609719b WD |
716 | override the default settings in the respective |
717 | include file. | |
718 | ||
719 | EXAMPLE: If you want all functions except of network | |
720 | support you can write: | |
721 | ||
722 | #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET) | |
723 | ||
724 | ||
725 | Note: Don't enable the "icache" and "dcache" commands | |
43d9616c WD |
726 | (configuration option CFG_CMD_CACHE) unless you know |
727 | what you (and your U-Boot users) are doing. Data | |
728 | cache cannot be enabled on systems like the 8xx or | |
729 | 8260 (where accesses to the IMMR region must be | |
730 | uncached), and it cannot be disabled on all other | |
731 | systems where we (mis-) use the data cache to hold an | |
732 | initial stack and some data. | |
c609719b WD |
733 | |
734 | ||
735 | XXX - this list needs to get updated! | |
736 | ||
737 | - Watchdog: | |
738 | CONFIG_WATCHDOG | |
739 | If this variable is defined, it enables watchdog | |
7152b1d0 | 740 | support. There must be support in the platform specific |
c609719b WD |
741 | code for a watchdog. For the 8xx and 8260 CPUs, the |
742 | SIU Watchdog feature is enabled in the SYPCR | |
743 | register. | |
744 | ||
c1551ea8 SR |
745 | - U-Boot Version: |
746 | CONFIG_VERSION_VARIABLE | |
747 | If this variable is defined, an environment variable | |
748 | named "ver" is created by U-Boot showing the U-Boot | |
749 | version as printed by the "version" command. | |
750 | This variable is readonly. | |
751 | ||
c609719b WD |
752 | - Real-Time Clock: |
753 | ||
754 | When CFG_CMD_DATE is selected, the type of the RTC | |
755 | has to be selected, too. Define exactly one of the | |
756 | following options: | |
757 | ||
758 | CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx | |
759 | CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC | |
760 | CONFIG_RTC_MC146818 - use MC146818 RTC | |
1cb8e980 | 761 | CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC |
c609719b | 762 | CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC |
7f70e853 | 763 | CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC |
3bac3513 | 764 | CONFIG_RTC_DS164x - use Dallas DS164x RTC |
4c0d4c3b | 765 | CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC |
c609719b | 766 | |
b37c7e5e WD |
767 | Note that if the RTC uses I2C, then the I2C interface |
768 | must also be configured. See I2C Support, below. | |
769 | ||
c609719b WD |
770 | - Timestamp Support: |
771 | ||
43d9616c WD |
772 | When CONFIG_TIMESTAMP is selected, the timestamp |
773 | (date and time) of an image is printed by image | |
774 | commands like bootm or iminfo. This option is | |
775 | automatically enabled when you select CFG_CMD_DATE . | |
c609719b WD |
776 | |
777 | - Partition Support: | |
778 | CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION | |
779 | and/or CONFIG_ISO_PARTITION | |
780 | ||
781 | If IDE or SCSI support is enabled (CFG_CMD_IDE or | |
782 | CFG_CMD_SCSI) you must configure support for at least | |
783 | one partition type as well. | |
784 | ||
785 | - IDE Reset method: | |
4d13cbad WD |
786 | CONFIG_IDE_RESET_ROUTINE - this is defined in several |
787 | board configurations files but used nowhere! | |
c609719b | 788 | |
4d13cbad WD |
789 | CONFIG_IDE_RESET - is this is defined, IDE Reset will |
790 | be performed by calling the function | |
791 | ide_set_reset(int reset) | |
792 | which has to be defined in a board specific file | |
c609719b WD |
793 | |
794 | - ATAPI Support: | |
795 | CONFIG_ATAPI | |
796 | ||
797 | Set this to enable ATAPI support. | |
798 | ||
c40b2956 WD |
799 | - LBA48 Support |
800 | CONFIG_LBA48 | |
801 | ||
802 | Set this to enable support for disks larger than 137GB | |
803 | Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL | |
804 | Whithout these , LBA48 support uses 32bit variables and will 'only' | |
805 | support disks up to 2.1TB. | |
806 | ||
807 | CFG_64BIT_LBA: | |
808 | When enabled, makes the IDE subsystem use 64bit sector addresses. | |
809 | Default is 32bit. | |
810 | ||
c609719b WD |
811 | - SCSI Support: |
812 | At the moment only there is only support for the | |
813 | SYM53C8XX SCSI controller; define | |
814 | CONFIG_SCSI_SYM53C8XX to enable it. | |
815 | ||
816 | CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and | |
817 | CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID * | |
818 | CFG_SCSI_MAX_LUN] can be adjusted to define the | |
819 | maximum numbers of LUNs, SCSI ID's and target | |
820 | devices. | |
821 | CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) | |
822 | ||
823 | - NETWORK Support (PCI): | |
682011ff WD |
824 | CONFIG_E1000 |
825 | Support for Intel 8254x gigabit chips. | |
53cf9435 | 826 | |
c609719b WD |
827 | CONFIG_EEPRO100 |
828 | Support for Intel 82557/82559/82559ER chips. | |
829 | Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom | |
830 | write routine for first time initialisation. | |
831 | ||
832 | CONFIG_TULIP | |
833 | Support for Digital 2114x chips. | |
834 | Optional CONFIG_TULIP_SELECT_MEDIA for board specific | |
835 | modem chip initialisation (KS8761/QS6611). | |
836 | ||
837 | CONFIG_NATSEMI | |
838 | Support for National dp83815 chips. | |
839 | ||
840 | CONFIG_NS8382X | |
841 | Support for National dp8382[01] gigabit chips. | |
842 | ||
45219c46 WD |
843 | - NETWORK Support (other): |
844 | ||
845 | CONFIG_DRIVER_LAN91C96 | |
846 | Support for SMSC's LAN91C96 chips. | |
847 | ||
848 | CONFIG_LAN91C96_BASE | |
849 | Define this to hold the physical address | |
850 | of the LAN91C96's I/O space | |
851 | ||
852 | CONFIG_LAN91C96_USE_32_BIT | |
853 | Define this to enable 32 bit addressing | |
854 | ||
f39748ae WD |
855 | CONFIG_DRIVER_SMC91111 |
856 | Support for SMSC's LAN91C111 chip | |
857 | ||
858 | CONFIG_SMC91111_BASE | |
859 | Define this to hold the physical address | |
860 | of the device (I/O space) | |
861 | ||
862 | CONFIG_SMC_USE_32_BIT | |
863 | Define this if data bus is 32 bits | |
864 | ||
865 | CONFIG_SMC_USE_IOFUNCS | |
866 | Define this to use i/o functions instead of macros | |
867 | (some hardware wont work with macros) | |
868 | ||
c609719b WD |
869 | - USB Support: |
870 | At the moment only the UHCI host controller is | |
4d13cbad | 871 | supported (PIP405, MIP405, MPC5200); define |
c609719b WD |
872 | CONFIG_USB_UHCI to enable it. |
873 | define CONFIG_USB_KEYBOARD to enable the USB Keyboard | |
30d56fae | 874 | and define CONFIG_USB_STORAGE to enable the USB |
c609719b WD |
875 | storage devices. |
876 | Note: | |
877 | Supported are USB Keyboards and USB Floppy drives | |
878 | (TEAC FD-05PUB). | |
4d13cbad WD |
879 | MPC5200 USB requires additional defines: |
880 | CONFIG_USB_CLOCK | |
881 | for 528 MHz Clock: 0x0001bbbb | |
882 | CONFIG_USB_CONFIG | |
883 | for differential drivers: 0x00001000 | |
884 | for single ended drivers: 0x00005000 | |
885 | ||
c609719b | 886 | |
71f95118 | 887 | - MMC Support: |
8bde7f77 WD |
888 | The MMC controller on the Intel PXA is supported. To |
889 | enable this define CONFIG_MMC. The MMC can be | |
890 | accessed from the boot prompt by mapping the device | |
71f95118 WD |
891 | to physical memory similar to flash. Command line is |
892 | enabled with CFG_CMD_MMC. The MMC driver also works with | |
8bde7f77 | 893 | the FAT fs. This is enabled with CFG_CMD_FAT. |
71f95118 | 894 | |
6705d81e WD |
895 | - Journaling Flash filesystem support: |
896 | CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, | |
897 | CONFIG_JFFS2_NAND_DEV | |
898 | Define these for a default partition on a NAND device | |
899 | ||
900 | CFG_JFFS2_FIRST_SECTOR, | |
901 | CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS | |
902 | Define these for a default partition on a NOR device | |
903 | ||
904 | CFG_JFFS_CUSTOM_PART | |
905 | Define this to create an own partition. You have to provide a | |
906 | function struct part_info* jffs2_part_info(int part_num) | |
907 | ||
908 | If you define only one JFFS2 partition you may also want to | |
efe2a4d5 | 909 | #define CFG_JFFS_SINGLE_PART 1 |
6705d81e WD |
910 | to disable the command chpart. This is the default when you |
911 | have not defined a custom partition | |
912 | ||
c609719b WD |
913 | - Keyboard Support: |
914 | CONFIG_ISA_KEYBOARD | |
915 | ||
916 | Define this to enable standard (PC-Style) keyboard | |
917 | support | |
918 | ||
919 | CONFIG_I8042_KBD | |
920 | Standard PC keyboard driver with US (is default) and | |
921 | GERMAN key layout (switch via environment 'keymap=de') support. | |
922 | Export function i8042_kbd_init, i8042_tstc and i8042_getc | |
923 | for cfb_console. Supports cursor blinking. | |
924 | ||
925 | - Video support: | |
926 | CONFIG_VIDEO | |
927 | ||
928 | Define this to enable video support (for output to | |
929 | video). | |
930 | ||
931 | CONFIG_VIDEO_CT69000 | |
932 | ||
933 | Enable Chips & Technologies 69000 Video chip | |
934 | ||
935 | CONFIG_VIDEO_SMI_LYNXEM | |
b79a11cc | 936 | Enable Silicon Motion SMI 712/710/810 Video chip. The |
eeb1b77b WD |
937 | video output is selected via environment 'videoout' |
938 | (1 = LCD and 2 = CRT). If videoout is undefined, CRT is | |
939 | assumed. | |
940 | ||
b79a11cc WD |
941 | For the CT69000 and SMI_LYNXEM drivers, videomode is |
942 | selected via environment 'videomode'. Two diferent ways | |
eeb1b77b WD |
943 | are possible: |
944 | - "videomode=num" 'num' is a standard LiLo mode numbers. | |
6e592385 | 945 | Following standard modes are supported (* is default): |
eeb1b77b WD |
946 | |
947 | Colors 640x480 800x600 1024x768 1152x864 1280x1024 | |
948 | -------------+--------------------------------------------- | |
949 | 8 bits | 0x301* 0x303 0x305 0x161 0x307 | |
950 | 15 bits | 0x310 0x313 0x316 0x162 0x319 | |
951 | 16 bits | 0x311 0x314 0x317 0x163 0x31A | |
952 | 24 bits | 0x312 0x315 0x318 ? 0x31B | |
953 | -------------+--------------------------------------------- | |
c609719b WD |
954 | (i.e. setenv videomode 317; saveenv; reset;) |
955 | ||
b79a11cc | 956 | - "videomode=bootargs" all the video parameters are parsed |
eeb1b77b WD |
957 | from the bootargs. (See drivers/videomodes.c) |
958 | ||
959 | ||
c1551ea8 | 960 | CONFIG_VIDEO_SED13806 |
43d9616c | 961 | Enable Epson SED13806 driver. This driver supports 8bpp |
a6c7ad2f WD |
962 | and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP |
963 | or CONFIG_VIDEO_SED13806_16BPP | |
964 | ||
682011ff | 965 | - Keyboard Support: |
8bde7f77 | 966 | CONFIG_KEYBOARD |
682011ff | 967 | |
8bde7f77 WD |
968 | Define this to enable a custom keyboard support. |
969 | This simply calls drv_keyboard_init() which must be | |
970 | defined in your board-specific files. | |
971 | The only board using this so far is RBC823. | |
a6c7ad2f | 972 | |
c609719b WD |
973 | - LCD Support: CONFIG_LCD |
974 | ||
975 | Define this to enable LCD support (for output to LCD | |
976 | display); also select one of the supported displays | |
977 | by defining one of these: | |
978 | ||
fd3103bb | 979 | CONFIG_NEC_NL6448AC33: |
c609719b | 980 | |
fd3103bb | 981 | NEC NL6448AC33-18. Active, color, single scan. |
c609719b | 982 | |
fd3103bb | 983 | CONFIG_NEC_NL6448BC20 |
c609719b | 984 | |
fd3103bb WD |
985 | NEC NL6448BC20-08. 6.5", 640x480. |
986 | Active, color, single scan. | |
987 | ||
988 | CONFIG_NEC_NL6448BC33_54 | |
989 | ||
990 | NEC NL6448BC33-54. 10.4", 640x480. | |
c609719b WD |
991 | Active, color, single scan. |
992 | ||
993 | CONFIG_SHARP_16x9 | |
994 | ||
995 | Sharp 320x240. Active, color, single scan. | |
996 | It isn't 16x9, and I am not sure what it is. | |
997 | ||
998 | CONFIG_SHARP_LQ64D341 | |
999 | ||
1000 | Sharp LQ64D341 display, 640x480. | |
1001 | Active, color, single scan. | |
1002 | ||
1003 | CONFIG_HLD1045 | |
1004 | ||
1005 | HLD1045 display, 640x480. | |
1006 | Active, color, single scan. | |
1007 | ||
1008 | CONFIG_OPTREX_BW | |
1009 | ||
1010 | Optrex CBL50840-2 NF-FW 99 22 M5 | |
1011 | or | |
1012 | Hitachi LMG6912RPFC-00T | |
1013 | or | |
1014 | Hitachi SP14Q002 | |
1015 | ||
1016 | 320x240. Black & white. | |
1017 | ||
1018 | Normally display is black on white background; define | |
1019 | CFG_WHITE_ON_BLACK to get it inverted. | |
1020 | ||
7152b1d0 | 1021 | - Splash Screen Support: CONFIG_SPLASH_SCREEN |
d791b1dc | 1022 | |
8bde7f77 WD |
1023 | If this option is set, the environment is checked for |
1024 | a variable "splashimage". If found, the usual display | |
1025 | of logo, copyright and system information on the LCD | |
e94d2cd9 | 1026 | is suppressed and the BMP image at the address |
8bde7f77 WD |
1027 | specified in "splashimage" is loaded instead. The |
1028 | console is redirected to the "nulldev", too. This | |
1029 | allows for a "silent" boot where a splash screen is | |
1030 | loaded very quickly after power-on. | |
d791b1dc | 1031 | |
98f4a3df SR |
1032 | - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP |
1033 | ||
1034 | If this option is set, additionally to standard BMP | |
1035 | images, gzipped BMP images can be displayed via the | |
1036 | splashscreen support or the bmp command. | |
1037 | ||
c29fdfc1 WD |
1038 | - Compression support: |
1039 | CONFIG_BZIP2 | |
1040 | ||
1041 | If this option is set, support for bzip2 compressed | |
1042 | images is included. If not, only uncompressed and gzip | |
1043 | compressed images are supported. | |
1044 | ||
42d1f039 WD |
1045 | NOTE: the bzip2 algorithm requires a lot of RAM, so |
1046 | the malloc area (as defined by CFG_MALLOC_LEN) should | |
1047 | be at least 4MB. | |
d791b1dc | 1048 | |
17ea1177 WD |
1049 | - MII/PHY support: |
1050 | CONFIG_PHY_ADDR | |
1051 | ||
1052 | The address of PHY on MII bus. | |
1053 | ||
1054 | CONFIG_PHY_CLOCK_FREQ (ppc4xx) | |
1055 | ||
1056 | The clock frequency of the MII bus | |
1057 | ||
1058 | CONFIG_PHY_GIGE | |
1059 | ||
1060 | If this option is set, support for speed/duplex | |
1061 | detection of Gigabit PHY is included. | |
1062 | ||
1063 | CONFIG_PHY_RESET_DELAY | |
1064 | ||
1065 | Some PHY like Intel LXT971A need extra delay after | |
1066 | reset before any MII register access is possible. | |
1067 | For such PHY, set this option to the usec delay | |
1068 | required. (minimum 300usec for LXT971A) | |
1069 | ||
1070 | CONFIG_PHY_CMD_DELAY (ppc4xx) | |
1071 | ||
1072 | Some PHY like Intel LXT971A need extra delay after | |
1073 | command issued before MII status register can be read | |
1074 | ||
c609719b WD |
1075 | - Ethernet address: |
1076 | CONFIG_ETHADDR | |
1077 | CONFIG_ETH2ADDR | |
1078 | CONFIG_ETH3ADDR | |
1079 | ||
1080 | Define a default value for ethernet address to use | |
1081 | for the respective ethernet interface, in case this | |
1082 | is not determined automatically. | |
1083 | ||
1084 | - IP address: | |
1085 | CONFIG_IPADDR | |
1086 | ||
1087 | Define a default value for the IP address to use for | |
1088 | the default ethernet interface, in case this is not | |
1089 | determined through e.g. bootp. | |
1090 | ||
1091 | - Server IP address: | |
1092 | CONFIG_SERVERIP | |
1093 | ||
1094 | Defines a default value for theIP address of a TFTP | |
1095 | server to contact when using the "tftboot" command. | |
1096 | ||
1097 | - BOOTP Recovery Mode: | |
1098 | CONFIG_BOOTP_RANDOM_DELAY | |
1099 | ||
1100 | If you have many targets in a network that try to | |
1101 | boot using BOOTP, you may want to avoid that all | |
1102 | systems send out BOOTP requests at precisely the same | |
1103 | moment (which would happen for instance at recovery | |
1104 | from a power failure, when all systems will try to | |
1105 | boot, thus flooding the BOOTP server. Defining | |
1106 | CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be | |
1107 | inserted before sending out BOOTP requests. The | |
1108 | following delays are insterted then: | |
1109 | ||
1110 | 1st BOOTP request: delay 0 ... 1 sec | |
1111 | 2nd BOOTP request: delay 0 ... 2 sec | |
1112 | 3rd BOOTP request: delay 0 ... 4 sec | |
1113 | 4th and following | |
1114 | BOOTP requests: delay 0 ... 8 sec | |
1115 | ||
fe389a82 SR |
1116 | - DHCP Advanced Options: |
1117 | CONFIG_BOOTP_MASK | |
1118 | ||
1119 | You can fine tune the DHCP functionality by adding | |
1120 | these flags to the CONFIG_BOOTP_MASK define: | |
1121 | ||
1122 | CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS | |
1123 | serverip from a DHCP server, it is possible that more | |
1124 | than one DNS serverip is offered to the client. | |
1125 | If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS | |
1126 | serverip will be stored in the additional environment | |
1127 | variable "dnsip2". The first DNS serverip is always | |
1128 | stored in the variable "dnsip", when CONFIG_BOOTP_DNS | |
1129 | is added to the CONFIG_BOOTP_MASK. | |
1130 | ||
1131 | CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable | |
1132 | to do a dynamic update of a DNS server. To do this, they | |
1133 | need the hostname of the DHCP requester. | |
1134 | If CONFIG_BOOP_SEND_HOSTNAME is added to the | |
1135 | CONFIG_BOOTP_MASK, the content of the "hostname" | |
1136 | environment variable is passed as option 12 to | |
1137 | the DHCP server. | |
1138 | ||
a3d991bd | 1139 | - CDP Options: |
6e592385 | 1140 | CONFIG_CDP_DEVICE_ID |
a3d991bd WD |
1141 | |
1142 | The device id used in CDP trigger frames. | |
1143 | ||
1144 | CONFIG_CDP_DEVICE_ID_PREFIX | |
1145 | ||
1146 | A two character string which is prefixed to the MAC address | |
1147 | of the device. | |
1148 | ||
1149 | CONFIG_CDP_PORT_ID | |
1150 | ||
1151 | A printf format string which contains the ascii name of | |
1152 | the port. Normally is set to "eth%d" which sets | |
1153 | eth0 for the first ethernet, eth1 for the second etc. | |
1154 | ||
1155 | CONFIG_CDP_CAPABILITIES | |
1156 | ||
1157 | A 32bit integer which indicates the device capabilities; | |
1158 | 0x00000010 for a normal host which does not forwards. | |
1159 | ||
1160 | CONFIG_CDP_VERSION | |
1161 | ||
1162 | An ascii string containing the version of the software. | |
1163 | ||
1164 | CONFIG_CDP_PLATFORM | |
1165 | ||
1166 | An ascii string containing the name of the platform. | |
1167 | ||
1168 | CONFIG_CDP_TRIGGER | |
1169 | ||
1170 | A 32bit integer sent on the trigger. | |
1171 | ||
1172 | CONFIG_CDP_POWER_CONSUMPTION | |
1173 | ||
1174 | A 16bit integer containing the power consumption of the | |
1175 | device in .1 of milliwatts. | |
1176 | ||
1177 | CONFIG_CDP_APPLIANCE_VLAN_TYPE | |
1178 | ||
1179 | A byte containing the id of the VLAN. | |
1180 | ||
c609719b WD |
1181 | - Status LED: CONFIG_STATUS_LED |
1182 | ||
1183 | Several configurations allow to display the current | |
1184 | status using a LED. For instance, the LED will blink | |
1185 | fast while running U-Boot code, stop blinking as | |
1186 | soon as a reply to a BOOTP request was received, and | |
1187 | start blinking slow once the Linux kernel is running | |
1188 | (supported by a status LED driver in the Linux | |
1189 | kernel). Defining CONFIG_STATUS_LED enables this | |
1190 | feature in U-Boot. | |
1191 | ||
1192 | - CAN Support: CONFIG_CAN_DRIVER | |
1193 | ||
1194 | Defining CONFIG_CAN_DRIVER enables CAN driver support | |
1195 | on those systems that support this (optional) | |
1196 | feature, like the TQM8xxL modules. | |
1197 | ||
1198 | - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C | |
1199 | ||
b37c7e5e | 1200 | These enable I2C serial bus commands. Defining either of |
945af8d7 WD |
1201 | (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will |
1202 | include the appropriate I2C driver for the selected cpu. | |
c609719b | 1203 | |
945af8d7 WD |
1204 | This will allow you to use i2c commands at the u-boot |
1205 | command line (as long as you set CFG_CMD_I2C in | |
b37c7e5e WD |
1206 | CONFIG_COMMANDS) and communicate with i2c based realtime |
1207 | clock chips. See common/cmd_i2c.c for a description of the | |
43d9616c | 1208 | command line interface. |
c609719b | 1209 | |
ba56f625 | 1210 | CONFIG_HARD_I2C selects the CPM hardware driver for I2C. |
b37c7e5e | 1211 | |
945af8d7 | 1212 | CONFIG_SOFT_I2C configures u-boot to use a software (aka |
b37c7e5e WD |
1213 | bit-banging) driver instead of CPM or similar hardware |
1214 | support for I2C. | |
c609719b | 1215 | |
945af8d7 | 1216 | There are several other quantities that must also be |
b37c7e5e | 1217 | defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. |
c609719b | 1218 | |
b37c7e5e | 1219 | In both cases you will need to define CFG_I2C_SPEED |
945af8d7 WD |
1220 | to be the frequency (in Hz) at which you wish your i2c bus |
1221 | to run and CFG_I2C_SLAVE to be the address of this node (ie | |
1222 | the cpu's i2c node address). | |
1223 | ||
b37c7e5e WD |
1224 | Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c) |
1225 | sets the cpu up as a master node and so its address should | |
1226 | therefore be cleared to 0 (See, eg, MPC823e User's Manual | |
945af8d7 | 1227 | p.16-473). So, set CFG_I2C_SLAVE to 0. |
c609719b | 1228 | |
945af8d7 | 1229 | That's all that's required for CONFIG_HARD_I2C. |
c609719b | 1230 | |
b37c7e5e WD |
1231 | If you use the software i2c interface (CONFIG_SOFT_I2C) |
1232 | then the following macros need to be defined (examples are | |
1233 | from include/configs/lwmon.h): | |
c609719b WD |
1234 | |
1235 | I2C_INIT | |
1236 | ||
b37c7e5e | 1237 | (Optional). Any commands necessary to enable the I2C |
43d9616c | 1238 | controller or configure ports. |
c609719b | 1239 | |
ba56f625 | 1240 | eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) |
b37c7e5e | 1241 | |
c609719b WD |
1242 | I2C_PORT |
1243 | ||
43d9616c WD |
1244 | (Only for MPC8260 CPU). The I/O port to use (the code |
1245 | assumes both bits are on the same port). Valid values | |
1246 | are 0..3 for ports A..D. | |
c609719b WD |
1247 | |
1248 | I2C_ACTIVE | |
1249 | ||
1250 | The code necessary to make the I2C data line active | |
1251 | (driven). If the data line is open collector, this | |
1252 | define can be null. | |
1253 | ||
b37c7e5e WD |
1254 | eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) |
1255 | ||
c609719b WD |
1256 | I2C_TRISTATE |
1257 | ||
1258 | The code necessary to make the I2C data line tri-stated | |
1259 | (inactive). If the data line is open collector, this | |
1260 | define can be null. | |
1261 | ||
b37c7e5e WD |
1262 | eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) |
1263 | ||
c609719b WD |
1264 | I2C_READ |
1265 | ||
1266 | Code that returns TRUE if the I2C data line is high, | |
1267 | FALSE if it is low. | |
1268 | ||
b37c7e5e WD |
1269 | eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) |
1270 | ||
c609719b WD |
1271 | I2C_SDA(bit) |
1272 | ||
1273 | If <bit> is TRUE, sets the I2C data line high. If it | |
1274 | is FALSE, it clears it (low). | |
1275 | ||
b37c7e5e | 1276 | eg: #define I2C_SDA(bit) \ |
2535d602 | 1277 | if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ |
ba56f625 | 1278 | else immr->im_cpm.cp_pbdat &= ~PB_SDA |
b37c7e5e | 1279 | |
c609719b WD |
1280 | I2C_SCL(bit) |
1281 | ||
1282 | If <bit> is TRUE, sets the I2C clock line high. If it | |
1283 | is FALSE, it clears it (low). | |
1284 | ||
b37c7e5e | 1285 | eg: #define I2C_SCL(bit) \ |
2535d602 | 1286 | if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ |
ba56f625 | 1287 | else immr->im_cpm.cp_pbdat &= ~PB_SCL |
b37c7e5e | 1288 | |
c609719b WD |
1289 | I2C_DELAY |
1290 | ||
1291 | This delay is invoked four times per clock cycle so this | |
1292 | controls the rate of data transfer. The data rate thus | |
b37c7e5e | 1293 | is 1 / (I2C_DELAY * 4). Often defined to be something |
945af8d7 WD |
1294 | like: |
1295 | ||
b37c7e5e | 1296 | #define I2C_DELAY udelay(2) |
c609719b | 1297 | |
47cd00fa WD |
1298 | CFG_I2C_INIT_BOARD |
1299 | ||
8bde7f77 WD |
1300 | When a board is reset during an i2c bus transfer |
1301 | chips might think that the current transfer is still | |
1302 | in progress. On some boards it is possible to access | |
1303 | the i2c SCLK line directly, either by using the | |
1304 | processor pin as a GPIO or by having a second pin | |
1305 | connected to the bus. If this option is defined a | |
1306 | custom i2c_init_board() routine in boards/xxx/board.c | |
1307 | is run early in the boot sequence. | |
47cd00fa | 1308 | |
17ea1177 WD |
1309 | CONFIG_I2CFAST (PPC405GP|PPC405EP only) |
1310 | ||
1311 | This option enables configuration of bi_iic_fast[] flags | |
1312 | in u-boot bd_info structure based on u-boot environment | |
1313 | variable "i2cfast". (see also i2cfast) | |
1314 | ||
c609719b WD |
1315 | - SPI Support: CONFIG_SPI |
1316 | ||
1317 | Enables SPI driver (so far only tested with | |
1318 | SPI EEPROM, also an instance works with Crystal A/D and | |
1319 | D/As on the SACSng board) | |
1320 | ||
1321 | CONFIG_SPI_X | |
1322 | ||
1323 | Enables extended (16-bit) SPI EEPROM addressing. | |
1324 | (symmetrical to CONFIG_I2C_X) | |
1325 | ||
1326 | CONFIG_SOFT_SPI | |
1327 | ||
43d9616c WD |
1328 | Enables a software (bit-bang) SPI driver rather than |
1329 | using hardware support. This is a general purpose | |
1330 | driver that only requires three general I/O port pins | |
1331 | (two outputs, one input) to function. If this is | |
1332 | defined, the board configuration must define several | |
1333 | SPI configuration items (port pins to use, etc). For | |
1334 | an example, see include/configs/sacsng.h. | |
c609719b | 1335 | |
ba56f625 | 1336 | - FPGA Support: CONFIG_FPGA_COUNT |
c609719b | 1337 | |
8bde7f77 | 1338 | Specify the number of FPGA devices to support. |
c609719b | 1339 | |
8bde7f77 | 1340 | CONFIG_FPGA |
c609719b | 1341 | |
8bde7f77 WD |
1342 | Used to specify the types of FPGA devices. For example, |
1343 | #define CONFIG_FPGA CFG_XILINX_VIRTEX2 | |
c609719b | 1344 | |
8bde7f77 | 1345 | CFG_FPGA_PROG_FEEDBACK |
c609719b | 1346 | |
8bde7f77 | 1347 | Enable printing of hash marks during FPGA configuration. |
c609719b WD |
1348 | |
1349 | CFG_FPGA_CHECK_BUSY | |
1350 | ||
43d9616c WD |
1351 | Enable checks on FPGA configuration interface busy |
1352 | status by the configuration function. This option | |
1353 | will require a board or device specific function to | |
1354 | be written. | |
c609719b WD |
1355 | |
1356 | CONFIG_FPGA_DELAY | |
1357 | ||
1358 | If defined, a function that provides delays in the FPGA | |
1359 | configuration driver. | |
1360 | ||
1361 | CFG_FPGA_CHECK_CTRLC | |
1362 | Allow Control-C to interrupt FPGA configuration | |
1363 | ||
1364 | CFG_FPGA_CHECK_ERROR | |
1365 | ||
43d9616c WD |
1366 | Check for configuration errors during FPGA bitfile |
1367 | loading. For example, abort during Virtex II | |
1368 | configuration if the INIT_B line goes low (which | |
1369 | indicated a CRC error). | |
c609719b WD |
1370 | |
1371 | CFG_FPGA_WAIT_INIT | |
1372 | ||
43d9616c WD |
1373 | Maximum time to wait for the INIT_B line to deassert |
1374 | after PROB_B has been deasserted during a Virtex II | |
1375 | FPGA configuration sequence. The default time is 500 | |
1376 | mS. | |
c609719b WD |
1377 | |
1378 | CFG_FPGA_WAIT_BUSY | |
1379 | ||
43d9616c WD |
1380 | Maximum time to wait for BUSY to deassert during |
1381 | Virtex II FPGA configuration. The default is 5 mS. | |
c609719b WD |
1382 | |
1383 | CFG_FPGA_WAIT_CONFIG | |
1384 | ||
43d9616c WD |
1385 | Time to wait after FPGA configuration. The default is |
1386 | 200 mS. | |
c609719b WD |
1387 | |
1388 | - Configuration Management: | |
1389 | CONFIG_IDENT_STRING | |
1390 | ||
43d9616c WD |
1391 | If defined, this string will be added to the U-Boot |
1392 | version information (U_BOOT_VERSION) | |
c609719b WD |
1393 | |
1394 | - Vendor Parameter Protection: | |
1395 | ||
43d9616c WD |
1396 | U-Boot considers the values of the environment |
1397 | variables "serial#" (Board Serial Number) and | |
7152b1d0 | 1398 | "ethaddr" (Ethernet Address) to be parameters that |
43d9616c WD |
1399 | are set once by the board vendor / manufacturer, and |
1400 | protects these variables from casual modification by | |
1401 | the user. Once set, these variables are read-only, | |
1402 | and write or delete attempts are rejected. You can | |
1403 | change this behviour: | |
c609719b WD |
1404 | |
1405 | If CONFIG_ENV_OVERWRITE is #defined in your config | |
1406 | file, the write protection for vendor parameters is | |
47cd00fa | 1407 | completely disabled. Anybody can change or delete |
c609719b WD |
1408 | these parameters. |
1409 | ||
1410 | Alternatively, if you #define _both_ CONFIG_ETHADDR | |
1411 | _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default | |
1412 | ethernet address is installed in the environment, | |
1413 | which can be changed exactly ONCE by the user. [The | |
1414 | serial# is unaffected by this, i. e. it remains | |
1415 | read-only.] | |
1416 | ||
1417 | - Protected RAM: | |
1418 | CONFIG_PRAM | |
1419 | ||
1420 | Define this variable to enable the reservation of | |
1421 | "protected RAM", i. e. RAM which is not overwritten | |
1422 | by U-Boot. Define CONFIG_PRAM to hold the number of | |
1423 | kB you want to reserve for pRAM. You can overwrite | |
1424 | this default value by defining an environment | |
1425 | variable "pram" to the number of kB you want to | |
1426 | reserve. Note that the board info structure will | |
1427 | still show the full amount of RAM. If pRAM is | |
1428 | reserved, a new environment variable "mem" will | |
1429 | automatically be defined to hold the amount of | |
1430 | remaining RAM in a form that can be passed as boot | |
1431 | argument to Linux, for instance like that: | |
1432 | ||
fe126d8b | 1433 | setenv bootargs ... mem=\${mem} |
c609719b WD |
1434 | saveenv |
1435 | ||
1436 | This way you can tell Linux not to use this memory, | |
1437 | either, which results in a memory region that will | |
1438 | not be affected by reboots. | |
1439 | ||
1440 | *WARNING* If your board configuration uses automatic | |
1441 | detection of the RAM size, you must make sure that | |
1442 | this memory test is non-destructive. So far, the | |
1443 | following board configurations are known to be | |
1444 | "pRAM-clean": | |
1445 | ||
1446 | ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, | |
1447 | HERMES, IP860, RPXlite, LWMON, LANTEC, | |
1448 | PCU_E, FLAGADM, TQM8260 | |
1449 | ||
1450 | - Error Recovery: | |
1451 | CONFIG_PANIC_HANG | |
1452 | ||
1453 | Define this variable to stop the system in case of a | |
1454 | fatal error, so that you have to reset it manually. | |
1455 | This is probably NOT a good idea for an embedded | |
1456 | system where you want to system to reboot | |
1457 | automatically as fast as possible, but it may be | |
1458 | useful during development since you can try to debug | |
1459 | the conditions that lead to the situation. | |
1460 | ||
1461 | CONFIG_NET_RETRY_COUNT | |
1462 | ||
43d9616c WD |
1463 | This variable defines the number of retries for |
1464 | network operations like ARP, RARP, TFTP, or BOOTP | |
1465 | before giving up the operation. If not defined, a | |
1466 | default value of 5 is used. | |
c609719b WD |
1467 | |
1468 | - Command Interpreter: | |
04a85b3b WD |
1469 | CFG_AUTO_COMPLETE |
1470 | ||
1471 | Enable auto completion of commands using TAB. | |
1472 | ||
c609719b WD |
1473 | CFG_HUSH_PARSER |
1474 | ||
1475 | Define this variable to enable the "hush" shell (from | |
1476 | Busybox) as command line interpreter, thus enabling | |
1477 | powerful command line syntax like | |
1478 | if...then...else...fi conditionals or `&&' and '||' | |
1479 | constructs ("shell scripts"). | |
1480 | ||
1481 | If undefined, you get the old, much simpler behaviour | |
1482 | with a somewhat smaller memory footprint. | |
1483 | ||
1484 | ||
1485 | CFG_PROMPT_HUSH_PS2 | |
1486 | ||
1487 | This defines the secondary prompt string, which is | |
1488 | printed when the command interpreter needs more input | |
1489 | to complete a command. Usually "> ". | |
1490 | ||
1491 | Note: | |
1492 | ||
8bde7f77 WD |
1493 | In the current implementation, the local variables |
1494 | space and global environment variables space are | |
1495 | separated. Local variables are those you define by | |
1496 | simply typing `name=value'. To access a local | |
1497 | variable later on, you have write `$name' or | |
1498 | `${name}'; to execute the contents of a variable | |
1499 | directly type `$name' at the command prompt. | |
c609719b | 1500 | |
43d9616c WD |
1501 | Global environment variables are those you use |
1502 | setenv/printenv to work with. To run a command stored | |
1503 | in such a variable, you need to use the run command, | |
1504 | and you must not use the '$' sign to access them. | |
c609719b WD |
1505 | |
1506 | To store commands and special characters in a | |
1507 | variable, please use double quotation marks | |
1508 | surrounding the whole text of the variable, instead | |
1509 | of the backslashes before semicolons and special | |
1510 | symbols. | |
1511 | ||
aa0c71ac WD |
1512 | - Commandline Editing and History: |
1513 | CONFIG_CMDLINE_EDITING | |
1514 | ||
b9365a26 WD |
1515 | Enable editiong and History functions for interactive |
1516 | commandline input operations | |
aa0c71ac | 1517 | |
a8c7c708 | 1518 | - Default Environment: |
c609719b WD |
1519 | CONFIG_EXTRA_ENV_SETTINGS |
1520 | ||
43d9616c WD |
1521 | Define this to contain any number of null terminated |
1522 | strings (variable = value pairs) that will be part of | |
7152b1d0 | 1523 | the default environment compiled into the boot image. |
2262cfee | 1524 | |
43d9616c WD |
1525 | For example, place something like this in your |
1526 | board's config file: | |
c609719b WD |
1527 | |
1528 | #define CONFIG_EXTRA_ENV_SETTINGS \ | |
1529 | "myvar1=value1\0" \ | |
1530 | "myvar2=value2\0" | |
1531 | ||
43d9616c WD |
1532 | Warning: This method is based on knowledge about the |
1533 | internal format how the environment is stored by the | |
1534 | U-Boot code. This is NOT an official, exported | |
1535 | interface! Although it is unlikely that this format | |
7152b1d0 | 1536 | will change soon, there is no guarantee either. |
c609719b WD |
1537 | You better know what you are doing here. |
1538 | ||
43d9616c WD |
1539 | Note: overly (ab)use of the default environment is |
1540 | discouraged. Make sure to check other ways to preset | |
1541 | the environment like the autoscript function or the | |
1542 | boot command first. | |
c609719b | 1543 | |
a8c7c708 | 1544 | - DataFlash Support: |
2abbe075 WD |
1545 | CONFIG_HAS_DATAFLASH |
1546 | ||
8bde7f77 WD |
1547 | Defining this option enables DataFlash features and |
1548 | allows to read/write in Dataflash via the standard | |
1549 | commands cp, md... | |
2abbe075 | 1550 | |
3f85ce27 WD |
1551 | - SystemACE Support: |
1552 | CONFIG_SYSTEMACE | |
1553 | ||
1554 | Adding this option adds support for Xilinx SystemACE | |
1555 | chips attached via some sort of local bus. The address | |
1556 | of the chip must alsh be defined in the | |
1557 | CFG_SYSTEMACE_BASE macro. For example: | |
1558 | ||
1559 | #define CONFIG_SYSTEMACE | |
1560 | #define CFG_SYSTEMACE_BASE 0xf0000000 | |
1561 | ||
1562 | When SystemACE support is added, the "ace" device type | |
1563 | becomes available to the fat commands, i.e. fatls. | |
1564 | ||
ecb0ccd9 WD |
1565 | - TFTP Fixed UDP Port: |
1566 | CONFIG_TFTP_PORT | |
1567 | ||
28cb9375 | 1568 | If this is defined, the environment variable tftpsrcp |
ecb0ccd9 | 1569 | is used to supply the TFTP UDP source port value. |
28cb9375 | 1570 | If tftpsrcp isn't defined, the normal pseudo-random port |
ecb0ccd9 WD |
1571 | number generator is used. |
1572 | ||
28cb9375 WD |
1573 | Also, the environment variable tftpdstp is used to supply |
1574 | the TFTP UDP destination port value. If tftpdstp isn't | |
1575 | defined, the normal port 69 is used. | |
1576 | ||
1577 | The purpose for tftpsrcp is to allow a TFTP server to | |
ecb0ccd9 WD |
1578 | blindly start the TFTP transfer using the pre-configured |
1579 | target IP address and UDP port. This has the effect of | |
1580 | "punching through" the (Windows XP) firewall, allowing | |
1581 | the remainder of the TFTP transfer to proceed normally. | |
1582 | A better solution is to properly configure the firewall, | |
1583 | but sometimes that is not allowed. | |
1584 | ||
a8c7c708 | 1585 | - Show boot progress: |
c609719b WD |
1586 | CONFIG_SHOW_BOOT_PROGRESS |
1587 | ||
43d9616c WD |
1588 | Defining this option allows to add some board- |
1589 | specific code (calling a user-provided function | |
1590 | "show_boot_progress(int)") that enables you to show | |
1591 | the system's boot progress on some display (for | |
1592 | example, some LED's) on your board. At the moment, | |
1593 | the following checkpoints are implemented: | |
c609719b WD |
1594 | |
1595 | Arg Where When | |
1596 | 1 common/cmd_bootm.c before attempting to boot an image | |
ba56f625 | 1597 | -1 common/cmd_bootm.c Image header has bad magic number |
c609719b | 1598 | 2 common/cmd_bootm.c Image header has correct magic number |
ba56f625 | 1599 | -2 common/cmd_bootm.c Image header has bad checksum |
c609719b | 1600 | 3 common/cmd_bootm.c Image header has correct checksum |
ba56f625 | 1601 | -3 common/cmd_bootm.c Image data has bad checksum |
c609719b WD |
1602 | 4 common/cmd_bootm.c Image data has correct checksum |
1603 | -4 common/cmd_bootm.c Image is for unsupported architecture | |
1604 | 5 common/cmd_bootm.c Architecture check OK | |
1605 | -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) | |
1606 | 6 common/cmd_bootm.c Image Type check OK | |
1607 | -6 common/cmd_bootm.c gunzip uncompression error | |
1608 | -7 common/cmd_bootm.c Unimplemented compression type | |
1609 | 7 common/cmd_bootm.c Uncompression OK | |
1610 | -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) | |
1611 | 8 common/cmd_bootm.c Image Type check OK | |
1612 | -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) | |
1613 | 9 common/cmd_bootm.c Start initial ramdisk verification | |
ba56f625 WD |
1614 | -10 common/cmd_bootm.c Ramdisk header has bad magic number |
1615 | -11 common/cmd_bootm.c Ramdisk header has bad checksum | |
c609719b | 1616 | 10 common/cmd_bootm.c Ramdisk header is OK |
ba56f625 | 1617 | -12 common/cmd_bootm.c Ramdisk data has bad checksum |
c609719b WD |
1618 | 11 common/cmd_bootm.c Ramdisk data has correct checksum |
1619 | 12 common/cmd_bootm.c Ramdisk verification complete, start loading | |
1620 | -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk) | |
1621 | 13 common/cmd_bootm.c Start multifile image verification | |
1622 | 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue. | |
1623 | 15 common/cmd_bootm.c All preparation done, transferring control to OS | |
1624 | ||
11dadd54 WD |
1625 | -30 lib_ppc/board.c Fatal error, hang the system |
1626 | -31 post/post.c POST test failed, detected by post_output_backlog() | |
1627 | -32 post/post.c POST test failed, detected by post_run_single() | |
63e73c9a | 1628 | |
c609719b WD |
1629 | -1 common/cmd_doc.c Bad usage of "doc" command |
1630 | -1 common/cmd_doc.c No boot device | |
1631 | -1 common/cmd_doc.c Unknown Chip ID on boot device | |
1632 | -1 common/cmd_doc.c Read Error on boot device | |
1633 | -1 common/cmd_doc.c Image header has bad magic number | |
1634 | ||
1635 | -1 common/cmd_ide.c Bad usage of "ide" command | |
1636 | -1 common/cmd_ide.c No boot device | |
1637 | -1 common/cmd_ide.c Unknown boot device | |
1638 | -1 common/cmd_ide.c Unknown partition table | |
1639 | -1 common/cmd_ide.c Invalid partition type | |
1640 | -1 common/cmd_ide.c Read Error on boot device | |
1641 | -1 common/cmd_ide.c Image header has bad magic number | |
1642 | ||
206c60cb WD |
1643 | -1 common/cmd_nand.c Bad usage of "nand" command |
1644 | -1 common/cmd_nand.c No boot device | |
1645 | -1 common/cmd_nand.c Unknown Chip ID on boot device | |
1646 | -1 common/cmd_nand.c Read Error on boot device | |
1647 | -1 common/cmd_nand.c Image header has bad magic number | |
1648 | ||
ba56f625 | 1649 | -1 common/env_common.c Environment has a bad CRC, using default |
c609719b WD |
1650 | |
1651 | ||
1652 | Modem Support: | |
1653 | -------------- | |
1654 | ||
85ec0bcc | 1655 | [so far only for SMDK2400 and TRAB boards] |
c609719b WD |
1656 | |
1657 | - Modem support endable: | |
1658 | CONFIG_MODEM_SUPPORT | |
1659 | ||
1660 | - RTS/CTS Flow control enable: | |
1661 | CONFIG_HWFLOW | |
1662 | ||
1663 | - Modem debug support: | |
1664 | CONFIG_MODEM_SUPPORT_DEBUG | |
1665 | ||
43d9616c WD |
1666 | Enables debugging stuff (char screen[1024], dbg()) |
1667 | for modem support. Useful only with BDI2000. | |
c609719b | 1668 | |
a8c7c708 WD |
1669 | - Interrupt support (PPC): |
1670 | ||
d4ca31c4 WD |
1671 | There are common interrupt_init() and timer_interrupt() |
1672 | for all PPC archs. interrupt_init() calls interrupt_init_cpu() | |
1673 | for cpu specific initialization. interrupt_init_cpu() | |
1674 | should set decrementer_count to appropriate value. If | |
1675 | cpu resets decrementer automatically after interrupt | |
1676 | (ppc4xx) it should set decrementer_count to zero. | |
1677 | timer_interrupt() calls timer_interrupt_cpu() for cpu | |
1678 | specific handling. If board has watchdog / status_led | |
1679 | / other_activity_monitor it works automatically from | |
1680 | general timer_interrupt(). | |
a8c7c708 | 1681 | |
c609719b WD |
1682 | - General: |
1683 | ||
43d9616c WD |
1684 | In the target system modem support is enabled when a |
1685 | specific key (key combination) is pressed during | |
1686 | power-on. Otherwise U-Boot will boot normally | |
1687 | (autoboot). The key_pressed() fuction is called from | |
1688 | board_init(). Currently key_pressed() is a dummy | |
1689 | function, returning 1 and thus enabling modem | |
1690 | initialization. | |
c609719b | 1691 | |
43d9616c WD |
1692 | If there are no modem init strings in the |
1693 | environment, U-Boot proceed to autoboot; the | |
1694 | previous output (banner, info printfs) will be | |
1695 | supressed, though. | |
c609719b WD |
1696 | |
1697 | See also: doc/README.Modem | |
1698 | ||
1699 | ||
c609719b WD |
1700 | Configuration Settings: |
1701 | ----------------------- | |
1702 | ||
1703 | - CFG_LONGHELP: Defined when you want long help messages included; | |
1704 | undefine this when you're short of memory. | |
1705 | ||
1706 | - CFG_PROMPT: This is what U-Boot prints on the console to | |
1707 | prompt for user input. | |
1708 | ||
1709 | - CFG_CBSIZE: Buffer size for input from the Console | |
1710 | ||
1711 | - CFG_PBSIZE: Buffer size for Console output | |
1712 | ||
1713 | - CFG_MAXARGS: max. Number of arguments accepted for monitor commands | |
1714 | ||
1715 | - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to | |
1716 | the application (usually a Linux kernel) when it is | |
1717 | booted | |
1718 | ||
1719 | - CFG_BAUDRATE_TABLE: | |
1720 | List of legal baudrate settings for this board. | |
1721 | ||
1722 | - CFG_CONSOLE_INFO_QUIET | |
8bde7f77 | 1723 | Suppress display of console information at boot. |
c609719b WD |
1724 | |
1725 | - CFG_CONSOLE_IS_IN_ENV | |
8bde7f77 WD |
1726 | If the board specific function |
1727 | extern int overwrite_console (void); | |
1728 | returns 1, the stdin, stderr and stdout are switched to the | |
c609719b WD |
1729 | serial port, else the settings in the environment are used. |
1730 | ||
1731 | - CFG_CONSOLE_OVERWRITE_ROUTINE | |
8bde7f77 | 1732 | Enable the call to overwrite_console(). |
c609719b WD |
1733 | |
1734 | - CFG_CONSOLE_ENV_OVERWRITE | |
1735 | Enable overwrite of previous console environment settings. | |
1736 | ||
1737 | - CFG_MEMTEST_START, CFG_MEMTEST_END: | |
1738 | Begin and End addresses of the area used by the | |
1739 | simple memory test. | |
1740 | ||
1741 | - CFG_ALT_MEMTEST: | |
8bde7f77 | 1742 | Enable an alternate, more extensive memory test. |
c609719b | 1743 | |
5f535fe1 WD |
1744 | - CFG_MEMTEST_SCRATCH: |
1745 | Scratch address used by the alternate memory test | |
1746 | You only need to set this if address zero isn't writeable | |
1747 | ||
c609719b WD |
1748 | - CFG_TFTP_LOADADDR: |
1749 | Default load address for network file downloads | |
1750 | ||
1751 | - CFG_LOADS_BAUD_CHANGE: | |
1752 | Enable temporary baudrate change while serial download | |
1753 | ||
1754 | - CFG_SDRAM_BASE: | |
1755 | Physical start address of SDRAM. _Must_ be 0 here. | |
1756 | ||
1757 | - CFG_MBIO_BASE: | |
1758 | Physical start address of Motherboard I/O (if using a | |
1759 | Cogent motherboard) | |
1760 | ||
1761 | - CFG_FLASH_BASE: | |
1762 | Physical start address of Flash memory. | |
1763 | ||
1764 | - CFG_MONITOR_BASE: | |
1765 | Physical start address of boot monitor code (set by | |
1766 | make config files to be same as the text base address | |
1767 | (TEXT_BASE) used when linking) - same as | |
1768 | CFG_FLASH_BASE when booting from flash. | |
1769 | ||
1770 | - CFG_MONITOR_LEN: | |
8bde7f77 WD |
1771 | Size of memory reserved for monitor code, used to |
1772 | determine _at_compile_time_ (!) if the environment is | |
1773 | embedded within the U-Boot image, or in a separate | |
1774 | flash sector. | |
c609719b WD |
1775 | |
1776 | - CFG_MALLOC_LEN: | |
1777 | Size of DRAM reserved for malloc() use. | |
1778 | ||
15940c9a SR |
1779 | - CFG_BOOTM_LEN: |
1780 | Normally compressed uImages are limited to an | |
1781 | uncompressed size of 8 MBytes. If this is not enough, | |
1782 | you can define CFG_BOOTM_LEN in your board config file | |
1783 | to adjust this setting to your needs. | |
1784 | ||
c609719b WD |
1785 | - CFG_BOOTMAPSZ: |
1786 | Maximum size of memory mapped by the startup code of | |
1787 | the Linux kernel; all data that must be processed by | |
1788 | the Linux kernel (bd_info, boot arguments, eventually | |
1789 | initrd image) must be put below this limit. | |
1790 | ||
1791 | - CFG_MAX_FLASH_BANKS: | |
1792 | Max number of Flash memory banks | |
1793 | ||
1794 | - CFG_MAX_FLASH_SECT: | |
1795 | Max number of sectors on a Flash chip | |
1796 | ||
1797 | - CFG_FLASH_ERASE_TOUT: | |
1798 | Timeout for Flash erase operations (in ms) | |
1799 | ||
1800 | - CFG_FLASH_WRITE_TOUT: | |
1801 | Timeout for Flash write operations (in ms) | |
1802 | ||
8564acf9 WD |
1803 | - CFG_FLASH_LOCK_TOUT |
1804 | Timeout for Flash set sector lock bit operation (in ms) | |
1805 | ||
1806 | - CFG_FLASH_UNLOCK_TOUT | |
1807 | Timeout for Flash clear lock bits operation (in ms) | |
1808 | ||
1809 | - CFG_FLASH_PROTECTION | |
1810 | If defined, hardware flash sectors protection is used | |
1811 | instead of U-Boot software protection. | |
1812 | ||
c609719b WD |
1813 | - CFG_DIRECT_FLASH_TFTP: |
1814 | ||
1815 | Enable TFTP transfers directly to flash memory; | |
1816 | without this option such a download has to be | |
1817 | performed in two steps: (1) download to RAM, and (2) | |
1818 | copy from RAM to flash. | |
1819 | ||
1820 | The two-step approach is usually more reliable, since | |
1821 | you can check if the download worked before you erase | |
1822 | the flash, but in some situations (when sytem RAM is | |
1823 | too limited to allow for a tempory copy of the | |
1824 | downloaded image) this option may be very useful. | |
1825 | ||
1826 | - CFG_FLASH_CFI: | |
43d9616c | 1827 | Define if the flash driver uses extra elements in the |
5653fc33 WD |
1828 | common flash structure for storing flash geometry. |
1829 | ||
1830 | - CFG_FLASH_CFI_DRIVER | |
1831 | This option also enables the building of the cfi_flash driver | |
1832 | in the drivers directory | |
c609719b | 1833 | |
5568e613 SR |
1834 | - CFG_FLASH_QUIET_TEST |
1835 | If this option is defined, the common CFI flash doesn't | |
1836 | print it's warning upon not recognized FLASH banks. This | |
1837 | is useful, if some of the configured banks are only | |
1838 | optionally available. | |
1839 | ||
53cf9435 SR |
1840 | - CFG_RX_ETH_BUFFER: |
1841 | Defines the number of ethernet receive buffers. On some | |
1842 | ethernet controllers it is recommended to set this value | |
1843 | to 8 or even higher (EEPRO100 or 405 EMAC), since all | |
1844 | buffers can be full shortly after enabling the interface | |
1845 | on high ethernet traffic. | |
1846 | Defaults to 4 if not defined. | |
1847 | ||
c609719b WD |
1848 | The following definitions that deal with the placement and management |
1849 | of environment data (variable area); in general, we support the | |
1850 | following configurations: | |
1851 | ||
1852 | - CFG_ENV_IS_IN_FLASH: | |
1853 | ||
1854 | Define this if the environment is in flash memory. | |
1855 | ||
1856 | a) The environment occupies one whole flash sector, which is | |
1857 | "embedded" in the text segment with the U-Boot code. This | |
1858 | happens usually with "bottom boot sector" or "top boot | |
1859 | sector" type flash chips, which have several smaller | |
1860 | sectors at the start or the end. For instance, such a | |
1861 | layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In | |
1862 | such a case you would place the environment in one of the | |
1863 | 4 kB sectors - with U-Boot code before and after it. With | |
1864 | "top boot sector" type flash chips, you would put the | |
1865 | environment in one of the last sectors, leaving a gap | |
1866 | between U-Boot and the environment. | |
1867 | ||
1868 | - CFG_ENV_OFFSET: | |
1869 | ||
1870 | Offset of environment data (variable area) to the | |
1871 | beginning of flash memory; for instance, with bottom boot | |
1872 | type flash chips the second sector can be used: the offset | |
1873 | for this sector is given here. | |
1874 | ||
1875 | CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE. | |
1876 | ||
1877 | - CFG_ENV_ADDR: | |
1878 | ||
1879 | This is just another way to specify the start address of | |
1880 | the flash sector containing the environment (instead of | |
1881 | CFG_ENV_OFFSET). | |
1882 | ||
1883 | - CFG_ENV_SECT_SIZE: | |
1884 | ||
1885 | Size of the sector containing the environment. | |
1886 | ||
1887 | ||
1888 | b) Sometimes flash chips have few, equal sized, BIG sectors. | |
1889 | In such a case you don't want to spend a whole sector for | |
1890 | the environment. | |
1891 | ||
1892 | - CFG_ENV_SIZE: | |
1893 | ||
1894 | If you use this in combination with CFG_ENV_IS_IN_FLASH | |
1895 | and CFG_ENV_SECT_SIZE, you can specify to use only a part | |
1896 | of this flash sector for the environment. This saves | |
1897 | memory for the RAM copy of the environment. | |
1898 | ||
1899 | It may also save flash memory if you decide to use this | |
1900 | when your environment is "embedded" within U-Boot code, | |
1901 | since then the remainder of the flash sector could be used | |
1902 | for U-Boot code. It should be pointed out that this is | |
1903 | STRONGLY DISCOURAGED from a robustness point of view: | |
1904 | updating the environment in flash makes it always | |
1905 | necessary to erase the WHOLE sector. If something goes | |
1906 | wrong before the contents has been restored from a copy in | |
1907 | RAM, your target system will be dead. | |
1908 | ||
1909 | - CFG_ENV_ADDR_REDUND | |
1910 | CFG_ENV_SIZE_REDUND | |
1911 | ||
43d9616c WD |
1912 | These settings describe a second storage area used to hold |
1913 | a redundand copy of the environment data, so that there is | |
3e38691e | 1914 | a valid backup copy in case there is a power failure during |
43d9616c | 1915 | a "saveenv" operation. |
c609719b WD |
1916 | |
1917 | BE CAREFUL! Any changes to the flash layout, and some changes to the | |
1918 | source code will make it necessary to adapt <board>/u-boot.lds* | |
1919 | accordingly! | |
1920 | ||
1921 | ||
1922 | - CFG_ENV_IS_IN_NVRAM: | |
1923 | ||
1924 | Define this if you have some non-volatile memory device | |
1925 | (NVRAM, battery buffered SRAM) which you want to use for the | |
1926 | environment. | |
1927 | ||
1928 | - CFG_ENV_ADDR: | |
1929 | - CFG_ENV_SIZE: | |
1930 | ||
1931 | These two #defines are used to determin the memory area you | |
1932 | want to use for environment. It is assumed that this memory | |
1933 | can just be read and written to, without any special | |
1934 | provision. | |
1935 | ||
1936 | BE CAREFUL! The first access to the environment happens quite early | |
1937 | in U-Boot initalization (when we try to get the setting of for the | |
1938 | console baudrate). You *MUST* have mappend your NVRAM area then, or | |
1939 | U-Boot will hang. | |
1940 | ||
1941 | Please note that even with NVRAM we still use a copy of the | |
1942 | environment in RAM: we could work on NVRAM directly, but we want to | |
1943 | keep settings there always unmodified except somebody uses "saveenv" | |
1944 | to save the current settings. | |
1945 | ||
1946 | ||
1947 | - CFG_ENV_IS_IN_EEPROM: | |
1948 | ||
1949 | Use this if you have an EEPROM or similar serial access | |
1950 | device and a driver for it. | |
1951 | ||
1952 | - CFG_ENV_OFFSET: | |
1953 | - CFG_ENV_SIZE: | |
1954 | ||
1955 | These two #defines specify the offset and size of the | |
1956 | environment area within the total memory of your EEPROM. | |
1957 | ||
1958 | - CFG_I2C_EEPROM_ADDR: | |
1959 | If defined, specified the chip address of the EEPROM device. | |
1960 | The default address is zero. | |
1961 | ||
1962 | - CFG_EEPROM_PAGE_WRITE_BITS: | |
1963 | If defined, the number of bits used to address bytes in a | |
1964 | single page in the EEPROM device. A 64 byte page, for example | |
1965 | would require six bits. | |
1966 | ||
1967 | - CFG_EEPROM_PAGE_WRITE_DELAY_MS: | |
1968 | If defined, the number of milliseconds to delay between | |
ba56f625 | 1969 | page writes. The default is zero milliseconds. |
c609719b WD |
1970 | |
1971 | - CFG_I2C_EEPROM_ADDR_LEN: | |
1972 | The length in bytes of the EEPROM memory array address. Note | |
1973 | that this is NOT the chip address length! | |
1974 | ||
5cf91d6b WD |
1975 | - CFG_I2C_EEPROM_ADDR_OVERFLOW: |
1976 | EEPROM chips that implement "address overflow" are ones | |
1977 | like Catalyst 24WC04/08/16 which has 9/10/11 bits of | |
1978 | address and the extra bits end up in the "chip address" bit | |
1979 | slots. This makes a 24WC08 (1Kbyte) chip look like four 256 | |
1980 | byte chips. | |
1981 | ||
1982 | Note that we consider the length of the address field to | |
1983 | still be one byte because the extra address bits are hidden | |
1984 | in the chip address. | |
1985 | ||
c609719b WD |
1986 | - CFG_EEPROM_SIZE: |
1987 | The size in bytes of the EEPROM device. | |
1988 | ||
c609719b | 1989 | |
5779d8d9 WD |
1990 | - CFG_ENV_IS_IN_DATAFLASH: |
1991 | ||
d4ca31c4 | 1992 | Define this if you have a DataFlash memory device which you |
5779d8d9 WD |
1993 | want to use for the environment. |
1994 | ||
1995 | - CFG_ENV_OFFSET: | |
1996 | - CFG_ENV_ADDR: | |
1997 | - CFG_ENV_SIZE: | |
1998 | ||
1999 | These three #defines specify the offset and size of the | |
2000 | environment area within the total memory of your DataFlash placed | |
2001 | at the specified address. | |
2002 | ||
13a5695b WD |
2003 | - CFG_ENV_IS_IN_NAND: |
2004 | ||
2005 | Define this if you have a NAND device which you want to use | |
2006 | for the environment. | |
2007 | ||
2008 | - CFG_ENV_OFFSET: | |
2009 | - CFG_ENV_SIZE: | |
2010 | ||
2011 | These two #defines specify the offset and size of the environment | |
2012 | area within the first NAND device. | |
5779d8d9 | 2013 | |
e443c944 MK |
2014 | - CFG_ENV_OFFSET_REDUND |
2015 | ||
2016 | This setting describes a second storage area of CFG_ENV_SIZE | |
2017 | size used to hold a redundant copy of the environment data, | |
2018 | so that there is a valid backup copy in case there is a | |
2019 | power failure during a "saveenv" operation. | |
2020 | ||
2021 | Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned | |
2022 | to a block boundary, and CFG_ENV_SIZE must be a multiple of | |
2023 | the NAND devices block size. | |
2024 | ||
c609719b WD |
2025 | - CFG_SPI_INIT_OFFSET |
2026 | ||
2027 | Defines offset to the initial SPI buffer area in DPRAM. The | |
2028 | area is used at an early stage (ROM part) if the environment | |
2029 | is configured to reside in the SPI EEPROM: We need a 520 byte | |
2030 | scratch DPRAM area. It is used between the two initialization | |
2031 | calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems | |
2032 | to be a good choice since it makes it far enough from the | |
2033 | start of the data area as well as from the stack pointer. | |
2034 | ||
2035 | Please note that the environment is read-only as long as the monitor | |
2036 | has been relocated to RAM and a RAM copy of the environment has been | |
2037 | created; also, when using EEPROM you will have to use getenv_r() | |
2038 | until then to read environment variables. | |
2039 | ||
85ec0bcc WD |
2040 | The environment is protected by a CRC32 checksum. Before the monitor |
2041 | is relocated into RAM, as a result of a bad CRC you will be working | |
2042 | with the compiled-in default environment - *silently*!!! [This is | |
2043 | necessary, because the first environment variable we need is the | |
2044 | "baudrate" setting for the console - if we have a bad CRC, we don't | |
2045 | have any device yet where we could complain.] | |
c609719b WD |
2046 | |
2047 | Note: once the monitor has been relocated, then it will complain if | |
2048 | the default environment is used; a new CRC is computed as soon as you | |
85ec0bcc | 2049 | use the "saveenv" command to store a valid environment. |
c609719b | 2050 | |
fc3e2165 | 2051 | - CFG_FAULT_ECHO_LINK_DOWN: |
42d1f039 | 2052 | Echo the inverted Ethernet link state to the fault LED. |
fc3e2165 WD |
2053 | |
2054 | Note: If this option is active, then CFG_FAULT_MII_ADDR | |
2055 | also needs to be defined. | |
2056 | ||
2057 | - CFG_FAULT_MII_ADDR: | |
42d1f039 | 2058 | MII address of the PHY to check for the Ethernet link state. |
c609719b | 2059 | |
c40b2956 WD |
2060 | - CFG_64BIT_VSPRINTF: |
2061 | Makes vsprintf (and all *printf functions) support printing | |
2062 | of 64bit values by using the L quantifier | |
2063 | ||
2064 | - CFG_64BIT_STRTOUL: | |
2065 | Adds simple_strtoull that returns a 64bit value | |
2066 | ||
c609719b | 2067 | Low Level (hardware related) configuration options: |
dc7c9a1a | 2068 | --------------------------------------------------- |
c609719b WD |
2069 | |
2070 | - CFG_CACHELINE_SIZE: | |
2071 | Cache Line Size of the CPU. | |
2072 | ||
2073 | - CFG_DEFAULT_IMMR: | |
2074 | Default address of the IMMR after system reset. | |
2535d602 | 2075 | |
42d1f039 WD |
2076 | Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, |
2077 | and RPXsuper) to be able to adjust the position of | |
2078 | the IMMR register after a reset. | |
c609719b | 2079 | |
7f6c2cbc WD |
2080 | - Floppy Disk Support: |
2081 | CFG_FDC_DRIVE_NUMBER | |
2082 | ||
2083 | the default drive number (default value 0) | |
2084 | ||
2085 | CFG_ISA_IO_STRIDE | |
2086 | ||
2087 | defines the spacing between fdc chipset registers | |
2088 | (default value 1) | |
2089 | ||
2090 | CFG_ISA_IO_OFFSET | |
2091 | ||
43d9616c WD |
2092 | defines the offset of register from address. It |
2093 | depends on which part of the data bus is connected to | |
2094 | the fdc chipset. (default value 0) | |
7f6c2cbc | 2095 | |
43d9616c WD |
2096 | If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and |
2097 | CFG_FDC_DRIVE_NUMBER are undefined, they take their | |
2098 | default value. | |
7f6c2cbc | 2099 | |
43d9616c WD |
2100 | if CFG_FDC_HW_INIT is defined, then the function |
2101 | fdc_hw_init() is called at the beginning of the FDC | |
2102 | setup. fdc_hw_init() must be provided by the board | |
2103 | source code. It is used to make hardware dependant | |
2104 | initializations. | |
7f6c2cbc | 2105 | |
25d6712a | 2106 | - CFG_IMMR: Physical address of the Internal Memory. |
efe2a4d5 | 2107 | DO NOT CHANGE unless you know exactly what you're |
25d6712a | 2108 | doing! (11-4) [MPC8xx/82xx systems only] |
c609719b WD |
2109 | |
2110 | - CFG_INIT_RAM_ADDR: | |
2111 | ||
7152b1d0 | 2112 | Start address of memory area that can be used for |
c609719b WD |
2113 | initial data and stack; please note that this must be |
2114 | writable memory that is working WITHOUT special | |
2115 | initialization, i. e. you CANNOT use normal RAM which | |
2116 | will become available only after programming the | |
2117 | memory controller and running certain initialization | |
2118 | sequences. | |
2119 | ||
2120 | U-Boot uses the following memory types: | |
2121 | - MPC8xx and MPC8260: IMMR (internal memory of the CPU) | |
2122 | - MPC824X: data cache | |
2123 | - PPC4xx: data cache | |
2124 | ||
85ec0bcc | 2125 | - CFG_GBL_DATA_OFFSET: |
c609719b WD |
2126 | |
2127 | Offset of the initial data structure in the memory | |
2128 | area defined by CFG_INIT_RAM_ADDR. Usually | |
85ec0bcc | 2129 | CFG_GBL_DATA_OFFSET is chosen such that the initial |
c609719b WD |
2130 | data is located at the end of the available space |
2131 | (sometimes written as (CFG_INIT_RAM_END - | |
2132 | CFG_INIT_DATA_SIZE), and the initial stack is just | |
2133 | below that area (growing from (CFG_INIT_RAM_ADDR + | |
85ec0bcc | 2134 | CFG_GBL_DATA_OFFSET) downward. |
c609719b WD |
2135 | |
2136 | Note: | |
2137 | On the MPC824X (or other systems that use the data | |
2138 | cache for initial memory) the address chosen for | |
2139 | CFG_INIT_RAM_ADDR is basically arbitrary - it must | |
2140 | point to an otherwise UNUSED address space between | |
2141 | the top of RAM and the start of the PCI space. | |
2142 | ||
2143 | - CFG_SIUMCR: SIU Module Configuration (11-6) | |
2144 | ||
2145 | - CFG_SYPCR: System Protection Control (11-9) | |
2146 | ||
2147 | - CFG_TBSCR: Time Base Status and Control (11-26) | |
2148 | ||
2149 | - CFG_PISCR: Periodic Interrupt Status and Control (11-31) | |
2150 | ||
2151 | - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) | |
2152 | ||
2153 | - CFG_SCCR: System Clock and reset Control Register (15-27) | |
2154 | ||
2155 | - CFG_OR_TIMING_SDRAM: | |
2156 | SDRAM timing | |
2157 | ||
2158 | - CFG_MAMR_PTA: | |
2159 | periodic timer for refresh | |
2160 | ||
2161 | - CFG_DER: Debug Event Register (37-47) | |
2162 | ||
2163 | - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM, | |
2164 | CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP, | |
2165 | CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM, | |
2166 | CFG_BR1_PRELIM: | |
2167 | Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) | |
2168 | ||
2169 | - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, | |
2170 | CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM, | |
2171 | CFG_OR3_PRELIM, CFG_BR3_PRELIM: | |
2172 | Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) | |
2173 | ||
2174 | - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K, | |
2175 | CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL: | |
2176 | Machine Mode Register and Memory Periodic Timer | |
2177 | Prescaler definitions (SDRAM timing) | |
2178 | ||
2179 | - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]: | |
2180 | enable I2C microcode relocation patch (MPC8xx); | |
2181 | define relocation offset in DPRAM [DSP2] | |
2182 | ||
2183 | - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]: | |
2184 | enable SPI microcode relocation patch (MPC8xx); | |
2185 | define relocation offset in DPRAM [SCC4] | |
2186 | ||
2187 | - CFG_USE_OSCCLK: | |
2188 | Use OSCM clock mode on MBX8xx board. Be careful, | |
2189 | wrong setting might damage your board. Read | |
2190 | doc/README.MBX before setting this variable! | |
2191 | ||
ea909b76 | 2192 | - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) |
43d9616c WD |
2193 | Offset of the bootmode word in DPRAM used by post |
2194 | (Power On Self Tests). This definition overrides | |
2195 | #define'd default value in commproc.h resp. | |
2196 | cpm_8260.h. | |
ea909b76 | 2197 | |
1d49b1f3 SR |
2198 | - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB, |
2199 | CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL, | |
2200 | CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS, | |
2201 | CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB, | |
2202 | CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, | |
2203 | CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL, | |
2204 | CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE, | |
5d232d0e WD |
2205 | CFG_POCMR2_MASK_ATTRIB: (MPC826x only) |
2206 | Overrides the default PCI memory map in cpu/mpc8260/pci.c if set. | |
2207 | ||
c26e454d WD |
2208 | - CONFIG_ETHER_ON_FEC[12] |
2209 | Define to enable FEC[12] on a 8xx series processor. | |
2210 | ||
2211 | - CONFIG_FEC[12]_PHY | |
2212 | Define to the hardcoded PHY address which corresponds | |
6e592385 WD |
2213 | to the given FEC; i. e. |
2214 | #define CONFIG_FEC1_PHY 4 | |
c26e454d WD |
2215 | means that the PHY with address 4 is connected to FEC1 |
2216 | ||
2217 | When set to -1, means to probe for first available. | |
2218 | ||
2219 | - CONFIG_FEC[12]_PHY_NORXERR | |
2220 | The PHY does not have a RXERR line (RMII only). | |
2221 | (so program the FEC to ignore it). | |
2222 | ||
2223 | - CONFIG_RMII | |
2224 | Enable RMII mode for all FECs. | |
2225 | Note that this is a global option, we can't | |
2226 | have one FEC in standard MII mode and another in RMII mode. | |
2227 | ||
5cf91d6b WD |
2228 | - CONFIG_CRC32_VERIFY |
2229 | Add a verify option to the crc32 command. | |
2230 | The syntax is: | |
2231 | ||
2232 | => crc32 -v <address> <count> <crc32> | |
2233 | ||
2234 | Where address/count indicate a memory area | |
2235 | and crc32 is the correct crc32 which the | |
2236 | area should have. | |
2237 | ||
56523f12 WD |
2238 | - CONFIG_LOOPW |
2239 | Add the "loopw" memory command. This only takes effect if | |
2240 | the memory commands are activated globally (CFG_CMD_MEM). | |
2241 | ||
7b466641 SR |
2242 | - CONFIG_MX_CYCLIC |
2243 | Add the "mdc" and "mwc" memory commands. These are cyclic | |
2244 | "md/mw" commands. | |
2245 | Examples: | |
2246 | ||
efe2a4d5 | 2247 | => mdc.b 10 4 500 |
7b466641 SR |
2248 | This command will print 4 bytes (10,11,12,13) each 500 ms. |
2249 | ||
efe2a4d5 | 2250 | => mwc.l 100 12345678 10 |
7b466641 SR |
2251 | This command will write 12345678 to address 100 all 10 ms. |
2252 | ||
efe2a4d5 | 2253 | This only takes effect if the memory commands are activated |
7b466641 SR |
2254 | globally (CFG_CMD_MEM). |
2255 | ||
8aa1a2d1 WD |
2256 | - CONFIG_SKIP_LOWLEVEL_INIT |
2257 | - CONFIG_SKIP_RELOCATE_UBOOT | |
2258 | ||
3c2b3d45 WD |
2259 | [ARM only] If these variables are defined, then |
2260 | certain low level initializations (like setting up | |
2261 | the memory controller) are omitted and/or U-Boot does | |
2262 | not relocate itself into RAM. | |
2263 | Normally these variables MUST NOT be defined. The | |
2264 | only exception is when U-Boot is loaded (to RAM) by | |
2265 | some other boot loader or by a debugger which | |
2266 | performs these intializations itself. | |
8aa1a2d1 | 2267 | |
400558b5 | 2268 | |
c609719b WD |
2269 | Building the Software: |
2270 | ====================== | |
2271 | ||
2272 | Building U-Boot has been tested in native PPC environments (on a | |
2273 | PowerBook G3 running LinuxPPC 2000) and in cross environments | |
2274 | (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and | |
2275 | NetBSD 1.5 on x86). | |
2276 | ||
2277 | If you are not using a native PPC environment, it is assumed that you | |
2278 | have the GNU cross compiling tools available in your path and named | |
2279 | with a prefix of "powerpc-linux-". If this is not the case, (e.g. if | |
2280 | you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change | |
2281 | the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU, | |
2282 | change it to: | |
2283 | ||
2284 | CROSS_COMPILE = ppc_4xx- | |
2285 | ||
2286 | ||
ba56f625 | 2287 | U-Boot is intended to be simple to build. After installing the |
c609719b WD |
2288 | sources you must configure U-Boot for one specific board type. This |
2289 | is done by typing: | |
2290 | ||
2291 | make NAME_config | |
2292 | ||
2293 | where "NAME_config" is the name of one of the existing | |
2294 | configurations; the following names are supported: | |
2295 | ||
1eaeb58e WD |
2296 | ADCIOP_config FPS860L_config omap730p2_config |
2297 | ADS860_config GEN860T_config pcu_e_config | |
983fda83 | 2298 | Alaska8220_config |
1eaeb58e WD |
2299 | AR405_config GENIETV_config PIP405_config |
2300 | at91rm9200dk_config GTH_config QS823_config | |
2301 | CANBT_config hermes_config QS850_config | |
2302 | cmi_mpc5xx_config hymod_config QS860T_config | |
2303 | cogent_common_config IP860_config RPXlite_config | |
e63c8ee3 WD |
2304 | cogent_mpc8260_config IVML24_config RPXlite_DW_config |
2305 | cogent_mpc8xx_config IVMS8_config RPXsuper_config | |
2306 | CPCI405_config JSE_config rsdproto_config | |
2307 | CPCIISER4_config LANTEC_config Sandpoint8240_config | |
2308 | csb272_config lwmon_config sbc8260_config | |
466b7410 WD |
2309 | CU824_config MBX860T_config sbc8560_33_config |
2310 | DUET_ADS_config MBX_config sbc8560_66_config | |
8b07a110 WD |
2311 | EBONY_config MPC8260ADS_config SM850_config |
2312 | ELPT860_config MPC8540ADS_config SPD823TS_config | |
b0e32949 LW |
2313 | ESTEEM192E_config MPC8540EVAL_config stxgp3_config |
2314 | ETX094_config MPC8560ADS_config SXNI855T_config | |
2315 | FADS823_config NETVIA_config TQM823L_config | |
2316 | FADS850SAR_config omap1510inn_config TQM850L_config | |
2317 | FADS860T_config omap1610h2_config TQM855L_config | |
2318 | FPS850L_config omap1610inn_config TQM860L_config | |
4b1d95d9 | 2319 | omap5912osk_config walnut_config |
b0e32949 | 2320 | omap2420h4_config Yukon8220_config |
8b07a110 | 2321 | ZPC1900_config |
db01a2ea | 2322 | |
2729af9d WD |
2323 | Note: for some board special configuration names may exist; check if |
2324 | additional information is available from the board vendor; for | |
2325 | instance, the TQM823L systems are available without (standard) | |
2326 | or with LCD support. You can select such additional "features" | |
2327 | when chosing the configuration, i. e. | |
2328 | ||
2329 | make TQM823L_config | |
2330 | - will configure for a plain TQM823L, i. e. no LCD support | |
2331 | ||
2332 | make TQM823L_LCD_config | |
2333 | - will configure for a TQM823L with U-Boot console on LCD | |
2334 | ||
2335 | etc. | |
2336 | ||
2337 | ||
2338 | Finally, type "make all", and you should get some working U-Boot | |
2339 | images ready for download to / installation on your system: | |
2340 | ||
2341 | - "u-boot.bin" is a raw binary image | |
2342 | - "u-boot" is an image in ELF binary format | |
2343 | - "u-boot.srec" is in Motorola S-Record format | |
2344 | ||
baf31249 MB |
2345 | By default the build is performed locally and the objects are saved |
2346 | in the source directory. One of the two methods can be used to change | |
2347 | this behavior and build U-Boot to some external directory: | |
2348 | ||
2349 | 1. Add O= to the make command line invocations: | |
2350 | ||
2351 | make O=/tmp/build distclean | |
2352 | make O=/tmp/build NAME_config | |
2353 | make O=/tmp/build all | |
2354 | ||
2355 | 2. Set environment variable BUILD_DIR to point to the desired location: | |
2356 | ||
2357 | export BUILD_DIR=/tmp/build | |
2358 | make distclean | |
2359 | make NAME_config | |
2360 | make all | |
2361 | ||
2362 | Note that the command line "O=" setting overrides the BUILD_DIR environment | |
2363 | variable. | |
2364 | ||
2729af9d WD |
2365 | |
2366 | Please be aware that the Makefiles assume you are using GNU make, so | |
2367 | for instance on NetBSD you might need to use "gmake" instead of | |
2368 | native "make". | |
2369 | ||
2370 | ||
2371 | If the system board that you have is not listed, then you will need | |
2372 | to port U-Boot to your hardware platform. To do this, follow these | |
2373 | steps: | |
2374 | ||
2375 | 1. Add a new configuration option for your board to the toplevel | |
2376 | "Makefile" and to the "MAKEALL" script, using the existing | |
2377 | entries as examples. Note that here and at many other places | |
2378 | boards and other names are listed in alphabetical sort order. Please | |
2379 | keep this order. | |
2380 | 2. Create a new directory to hold your board specific code. Add any | |
2381 | files you need. In your board directory, you will need at least | |
2382 | the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". | |
2383 | 3. Create a new configuration file "include/configs/<board>.h" for | |
2384 | your board | |
2385 | 3. If you're porting U-Boot to a new CPU, then also create a new | |
2386 | directory to hold your CPU specific code. Add any files you need. | |
2387 | 4. Run "make <board>_config" with your new name. | |
2388 | 5. Type "make", and you should get a working "u-boot.srec" file | |
2389 | to be installed on your target system. | |
2390 | 6. Debug and solve any problems that might arise. | |
2391 | [Of course, this last step is much harder than it sounds.] | |
2392 | ||
2393 | ||
2394 | Testing of U-Boot Modifications, Ports to New Hardware, etc.: | |
2395 | ============================================================== | |
2396 | ||
2397 | If you have modified U-Boot sources (for instance added a new board | |
2398 | or support for new devices, a new CPU, etc.) you are expected to | |
2399 | provide feedback to the other developers. The feedback normally takes | |
2400 | the form of a "patch", i. e. a context diff against a certain (latest | |
2401 | official or latest in CVS) version of U-Boot sources. | |
2402 | ||
2403 | But before you submit such a patch, please verify that your modifi- | |
2404 | cation did not break existing code. At least make sure that *ALL* of | |
2405 | the supported boards compile WITHOUT ANY compiler warnings. To do so, | |
2406 | just run the "MAKEALL" script, which will configure and build U-Boot | |
2407 | for ALL supported system. Be warned, this will take a while. You can | |
2408 | select which (cross) compiler to use by passing a `CROSS_COMPILE' | |
2409 | environment variable to the script, i. e. to use the cross tools from | |
2410 | MontaVista's Hard Hat Linux you can type | |
2411 | ||
2412 | CROSS_COMPILE=ppc_8xx- MAKEALL | |
2413 | ||
2414 | or to build on a native PowerPC system you can type | |
2415 | ||
2416 | CROSS_COMPILE=' ' MAKEALL | |
2417 | ||
baf31249 MB |
2418 | When using the MAKEALL script, the default behaviour is to build U-Boot |
2419 | in the source directory. This location can be changed by setting the | |
2420 | BUILD_DIR environment variable. Also, for each target built, the MAKEALL | |
2421 | script saves two log files (<target>.ERR and <target>.MAKEALL) in the | |
2422 | <source dir>/LOG directory. This default location can be changed by | |
2423 | setting the MAKEALL_LOGDIR environment variable. For example: | |
2424 | ||
2425 | export BUILD_DIR=/tmp/build | |
2426 | export MAKEALL_LOGDIR=/tmp/log | |
2427 | CROSS_COMPILE=ppc_8xx- MAKEALL | |
2428 | ||
2429 | With the above settings build objects are saved in the /tmp/build, log | |
2430 | files are saved in the /tmp/log and the source tree remains clean during | |
2431 | the whole build process. | |
2432 | ||
2433 | ||
2729af9d WD |
2434 | See also "U-Boot Porting Guide" below. |
2435 | ||
2436 | ||
2437 | Monitor Commands - Overview: | |
2438 | ============================ | |
2439 | ||
2440 | go - start application at address 'addr' | |
2441 | run - run commands in an environment variable | |
2442 | bootm - boot application image from memory | |
2443 | bootp - boot image via network using BootP/TFTP protocol | |
2444 | tftpboot- boot image via network using TFTP protocol | |
2445 | and env variables "ipaddr" and "serverip" | |
2446 | (and eventually "gatewayip") | |
2447 | rarpboot- boot image via network using RARP/TFTP protocol | |
2448 | diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' | |
2449 | loads - load S-Record file over serial line | |
2450 | loadb - load binary file over serial line (kermit mode) | |
2451 | md - memory display | |
2452 | mm - memory modify (auto-incrementing) | |
2453 | nm - memory modify (constant address) | |
2454 | mw - memory write (fill) | |
2455 | cp - memory copy | |
2456 | cmp - memory compare | |
2457 | crc32 - checksum calculation | |
2458 | imd - i2c memory display | |
2459 | imm - i2c memory modify (auto-incrementing) | |
2460 | inm - i2c memory modify (constant address) | |
2461 | imw - i2c memory write (fill) | |
2462 | icrc32 - i2c checksum calculation | |
2463 | iprobe - probe to discover valid I2C chip addresses | |
2464 | iloop - infinite loop on address range | |
2465 | isdram - print SDRAM configuration information | |
2466 | sspi - SPI utility commands | |
2467 | base - print or set address offset | |
2468 | printenv- print environment variables | |
2469 | setenv - set environment variables | |
2470 | saveenv - save environment variables to persistent storage | |
2471 | protect - enable or disable FLASH write protection | |
2472 | erase - erase FLASH memory | |
2473 | flinfo - print FLASH memory information | |
2474 | bdinfo - print Board Info structure | |
2475 | iminfo - print header information for application image | |
2476 | coninfo - print console devices and informations | |
2477 | ide - IDE sub-system | |
2478 | loop - infinite loop on address range | |
56523f12 | 2479 | loopw - infinite write loop on address range |
2729af9d WD |
2480 | mtest - simple RAM test |
2481 | icache - enable or disable instruction cache | |
2482 | dcache - enable or disable data cache | |
2483 | reset - Perform RESET of the CPU | |
2484 | echo - echo args to console | |
2485 | version - print monitor version | |
2486 | help - print online help | |
2487 | ? - alias for 'help' | |
2488 | ||
2489 | ||
2490 | Monitor Commands - Detailed Description: | |
2491 | ======================================== | |
2492 | ||
2493 | TODO. | |
2494 | ||
2495 | For now: just type "help <command>". | |
2496 | ||
2497 | ||
2498 | Environment Variables: | |
2499 | ====================== | |
2500 | ||
2501 | U-Boot supports user configuration using Environment Variables which | |
2502 | can be made persistent by saving to Flash memory. | |
c609719b | 2503 | |
2729af9d WD |
2504 | Environment Variables are set using "setenv", printed using |
2505 | "printenv", and saved to Flash using "saveenv". Using "setenv" | |
2506 | without a value can be used to delete a variable from the | |
2507 | environment. As long as you don't save the environment you are | |
2508 | working with an in-memory copy. In case the Flash area containing the | |
2509 | environment is erased by accident, a default environment is provided. | |
c609719b | 2510 | |
2729af9d | 2511 | Some configuration options can be set using Environment Variables: |
c609719b | 2512 | |
2729af9d | 2513 | baudrate - see CONFIG_BAUDRATE |
c609719b | 2514 | |
2729af9d | 2515 | bootdelay - see CONFIG_BOOTDELAY |
c609719b | 2516 | |
2729af9d | 2517 | bootcmd - see CONFIG_BOOTCOMMAND |
4a6fd34b | 2518 | |
2729af9d | 2519 | bootargs - Boot arguments when booting an RTOS image |
c609719b | 2520 | |
2729af9d | 2521 | bootfile - Name of the image to load with TFTP |
c609719b | 2522 | |
2729af9d WD |
2523 | autoload - if set to "no" (any string beginning with 'n'), |
2524 | "bootp" will just load perform a lookup of the | |
2525 | configuration from the BOOTP server, but not try to | |
2526 | load any image using TFTP | |
c609719b | 2527 | |
2729af9d WD |
2528 | autostart - if set to "yes", an image loaded using the "bootp", |
2529 | "rarpboot", "tftpboot" or "diskboot" commands will | |
2530 | be automatically started (by internally calling | |
2531 | "bootm") | |
38b99261 | 2532 | |
2729af9d WD |
2533 | If set to "no", a standalone image passed to the |
2534 | "bootm" command will be copied to the load address | |
2535 | (and eventually uncompressed), but NOT be started. | |
2536 | This can be used to load and uncompress arbitrary | |
2537 | data. | |
c609719b | 2538 | |
17ea1177 WD |
2539 | i2cfast - (PPC405GP|PPC405EP only) |
2540 | if set to 'y' configures Linux I2C driver for fast | |
2541 | mode (400kHZ). This environment variable is used in | |
2542 | initialization code. So, for changes to be effective | |
2543 | it must be saved and board must be reset. | |
2544 | ||
2729af9d WD |
2545 | initrd_high - restrict positioning of initrd images: |
2546 | If this variable is not set, initrd images will be | |
2547 | copied to the highest possible address in RAM; this | |
2548 | is usually what you want since it allows for | |
2549 | maximum initrd size. If for some reason you want to | |
2550 | make sure that the initrd image is loaded below the | |
2551 | CFG_BOOTMAPSZ limit, you can set this environment | |
2552 | variable to a value of "no" or "off" or "0". | |
2553 | Alternatively, you can set it to a maximum upper | |
2554 | address to use (U-Boot will still check that it | |
2555 | does not overwrite the U-Boot stack and data). | |
c609719b | 2556 | |
2729af9d WD |
2557 | For instance, when you have a system with 16 MB |
2558 | RAM, and want to reserve 4 MB from use by Linux, | |
2559 | you can do this by adding "mem=12M" to the value of | |
2560 | the "bootargs" variable. However, now you must make | |
2561 | sure that the initrd image is placed in the first | |
2562 | 12 MB as well - this can be done with | |
c609719b | 2563 | |
2729af9d | 2564 | setenv initrd_high 00c00000 |
c609719b | 2565 | |
2729af9d WD |
2566 | If you set initrd_high to 0xFFFFFFFF, this is an |
2567 | indication to U-Boot that all addresses are legal | |
2568 | for the Linux kernel, including addresses in flash | |
2569 | memory. In this case U-Boot will NOT COPY the | |
2570 | ramdisk at all. This may be useful to reduce the | |
2571 | boot time on your system, but requires that this | |
2572 | feature is supported by your Linux kernel. | |
c609719b | 2573 | |
2729af9d | 2574 | ipaddr - IP address; needed for tftpboot command |
c609719b | 2575 | |
2729af9d WD |
2576 | loadaddr - Default load address for commands like "bootp", |
2577 | "rarpboot", "tftpboot", "loadb" or "diskboot" | |
c609719b | 2578 | |
2729af9d | 2579 | loads_echo - see CONFIG_LOADS_ECHO |
a3d991bd | 2580 | |
2729af9d | 2581 | serverip - TFTP server IP address; needed for tftpboot command |
a3d991bd | 2582 | |
2729af9d | 2583 | bootretry - see CONFIG_BOOT_RETRY_TIME |
a3d991bd | 2584 | |
2729af9d | 2585 | bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR |
a3d991bd | 2586 | |
2729af9d | 2587 | bootstopkey - see CONFIG_AUTOBOOT_STOP_STR |
c609719b | 2588 | |
2729af9d WD |
2589 | ethprime - When CONFIG_NET_MULTI is enabled controls which |
2590 | interface is used first. | |
c609719b | 2591 | |
2729af9d WD |
2592 | ethact - When CONFIG_NET_MULTI is enabled controls which |
2593 | interface is currently active. For example you | |
2594 | can do the following | |
c609719b | 2595 | |
2729af9d WD |
2596 | => setenv ethact FEC ETHERNET |
2597 | => ping 192.168.0.1 # traffic sent on FEC ETHERNET | |
2598 | => setenv ethact SCC ETHERNET | |
2599 | => ping 10.0.0.1 # traffic sent on SCC ETHERNET | |
c609719b | 2600 | |
2729af9d WD |
2601 | netretry - When set to "no" each network operation will |
2602 | either succeed or fail without retrying. | |
2603 | When set to "once" the network operation will | |
2604 | fail when all the available network interfaces | |
2605 | are tried once without success. | |
2606 | Useful on scripts which control the retry operation | |
2607 | themselves. | |
c609719b | 2608 | |
28cb9375 | 2609 | tftpsrcport - If this is set, the value is used for TFTP's |
ecb0ccd9 WD |
2610 | UDP source port. |
2611 | ||
28cb9375 WD |
2612 | tftpdstport - If this is set, the value is used for TFTP's UDP |
2613 | destination port instead of the Well Know Port 69. | |
2614 | ||
2729af9d WD |
2615 | vlan - When set to a value < 4095 the traffic over |
2616 | ethernet is encapsulated/received over 802.1q | |
2617 | VLAN tagged frames. | |
c609719b | 2618 | |
2729af9d WD |
2619 | The following environment variables may be used and automatically |
2620 | updated by the network boot commands ("bootp" and "rarpboot"), | |
2621 | depending the information provided by your boot server: | |
c609719b | 2622 | |
2729af9d WD |
2623 | bootfile - see above |
2624 | dnsip - IP address of your Domain Name Server | |
2625 | dnsip2 - IP address of your secondary Domain Name Server | |
2626 | gatewayip - IP address of the Gateway (Router) to use | |
2627 | hostname - Target hostname | |
2628 | ipaddr - see above | |
2629 | netmask - Subnet Mask | |
2630 | rootpath - Pathname of the root filesystem on the NFS server | |
2631 | serverip - see above | |
c1551ea8 | 2632 | |
c1551ea8 | 2633 | |
2729af9d | 2634 | There are two special Environment Variables: |
c1551ea8 | 2635 | |
2729af9d WD |
2636 | serial# - contains hardware identification information such |
2637 | as type string and/or serial number | |
2638 | ethaddr - Ethernet address | |
c609719b | 2639 | |
2729af9d WD |
2640 | These variables can be set only once (usually during manufacturing of |
2641 | the board). U-Boot refuses to delete or overwrite these variables | |
2642 | once they have been set once. | |
c609719b | 2643 | |
f07771cc | 2644 | |
2729af9d | 2645 | Further special Environment Variables: |
f07771cc | 2646 | |
2729af9d WD |
2647 | ver - Contains the U-Boot version string as printed |
2648 | with the "version" command. This variable is | |
2649 | readonly (see CONFIG_VERSION_VARIABLE). | |
f07771cc | 2650 | |
f07771cc | 2651 | |
2729af9d WD |
2652 | Please note that changes to some configuration parameters may take |
2653 | only effect after the next boot (yes, that's just like Windoze :-). | |
f07771cc | 2654 | |
f07771cc | 2655 | |
2729af9d WD |
2656 | Command Line Parsing: |
2657 | ===================== | |
f07771cc | 2658 | |
2729af9d WD |
2659 | There are two different command line parsers available with U-Boot: |
2660 | the old "simple" one, and the much more powerful "hush" shell: | |
c609719b | 2661 | |
2729af9d WD |
2662 | Old, simple command line parser: |
2663 | -------------------------------- | |
c609719b | 2664 | |
2729af9d WD |
2665 | - supports environment variables (through setenv / saveenv commands) |
2666 | - several commands on one line, separated by ';' | |
fe126d8b | 2667 | - variable substitution using "... ${name} ..." syntax |
2729af9d WD |
2668 | - special characters ('$', ';') can be escaped by prefixing with '\', |
2669 | for example: | |
fe126d8b | 2670 | setenv bootcmd bootm \${address} |
2729af9d WD |
2671 | - You can also escape text by enclosing in single apostrophes, for example: |
2672 | setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' | |
c609719b | 2673 | |
2729af9d WD |
2674 | Hush shell: |
2675 | ----------- | |
c609719b | 2676 | |
2729af9d WD |
2677 | - similar to Bourne shell, with control structures like |
2678 | if...then...else...fi, for...do...done; while...do...done, | |
2679 | until...do...done, ... | |
2680 | - supports environment ("global") variables (through setenv / saveenv | |
2681 | commands) and local shell variables (through standard shell syntax | |
2682 | "name=value"); only environment variables can be used with "run" | |
2683 | command | |
2684 | ||
2685 | General rules: | |
2686 | -------------- | |
c609719b | 2687 | |
2729af9d WD |
2688 | (1) If a command line (or an environment variable executed by a "run" |
2689 | command) contains several commands separated by semicolon, and | |
2690 | one of these commands fails, then the remaining commands will be | |
2691 | executed anyway. | |
c609719b | 2692 | |
2729af9d WD |
2693 | (2) If you execute several variables with one call to run (i. e. |
2694 | calling run with a list af variables as arguments), any failing | |
2695 | command will cause "run" to terminate, i. e. the remaining | |
2696 | variables are not executed. | |
c609719b | 2697 | |
2729af9d WD |
2698 | Note for Redundant Ethernet Interfaces: |
2699 | ======================================= | |
c609719b | 2700 | |
2729af9d WD |
2701 | Some boards come with redundant ethernet interfaces; U-Boot supports |
2702 | such configurations and is capable of automatic selection of a | |
2703 | "working" interface when needed. MAC assignment works as follows: | |
c609719b | 2704 | |
2729af9d WD |
2705 | Network interfaces are numbered eth0, eth1, eth2, ... Corresponding |
2706 | MAC addresses can be stored in the environment as "ethaddr" (=>eth0), | |
2707 | "eth1addr" (=>eth1), "eth2addr", ... | |
c609719b | 2708 | |
2729af9d WD |
2709 | If the network interface stores some valid MAC address (for instance |
2710 | in SROM), this is used as default address if there is NO correspon- | |
2711 | ding setting in the environment; if the corresponding environment | |
2712 | variable is set, this overrides the settings in the card; that means: | |
c609719b | 2713 | |
2729af9d WD |
2714 | o If the SROM has a valid MAC address, and there is no address in the |
2715 | environment, the SROM's address is used. | |
c609719b | 2716 | |
2729af9d WD |
2717 | o If there is no valid address in the SROM, and a definition in the |
2718 | environment exists, then the value from the environment variable is | |
2719 | used. | |
c609719b | 2720 | |
2729af9d WD |
2721 | o If both the SROM and the environment contain a MAC address, and |
2722 | both addresses are the same, this MAC address is used. | |
c609719b | 2723 | |
2729af9d WD |
2724 | o If both the SROM and the environment contain a MAC address, and the |
2725 | addresses differ, the value from the environment is used and a | |
2726 | warning is printed. | |
c609719b | 2727 | |
2729af9d WD |
2728 | o If neither SROM nor the environment contain a MAC address, an error |
2729 | is raised. | |
c609719b | 2730 | |
c609719b | 2731 | |
2729af9d WD |
2732 | Image Formats: |
2733 | ============== | |
c609719b | 2734 | |
2729af9d WD |
2735 | The "boot" commands of this monitor operate on "image" files which |
2736 | can be basicly anything, preceeded by a special header; see the | |
2737 | definitions in include/image.h for details; basicly, the header | |
2738 | defines the following image properties: | |
c609719b | 2739 | |
2729af9d WD |
2740 | * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, |
2741 | 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, | |
2742 | LynxOS, pSOS, QNX, RTEMS, ARTOS; | |
2743 | Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS). | |
7b64fef3 | 2744 | * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, |
2729af9d | 2745 | IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; |
7b64fef3 | 2746 | Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC). |
2729af9d WD |
2747 | * Compression Type (uncompressed, gzip, bzip2) |
2748 | * Load Address | |
2749 | * Entry Point | |
2750 | * Image Name | |
2751 | * Image Timestamp | |
c609719b | 2752 | |
2729af9d WD |
2753 | The header is marked by a special Magic Number, and both the header |
2754 | and the data portions of the image are secured against corruption by | |
2755 | CRC32 checksums. | |
c609719b WD |
2756 | |
2757 | ||
2729af9d WD |
2758 | Linux Support: |
2759 | ============== | |
c609719b | 2760 | |
2729af9d WD |
2761 | Although U-Boot should support any OS or standalone application |
2762 | easily, the main focus has always been on Linux during the design of | |
2763 | U-Boot. | |
c609719b | 2764 | |
2729af9d WD |
2765 | U-Boot includes many features that so far have been part of some |
2766 | special "boot loader" code within the Linux kernel. Also, any | |
2767 | "initrd" images to be used are no longer part of one big Linux image; | |
2768 | instead, kernel and "initrd" are separate images. This implementation | |
2769 | serves several purposes: | |
c609719b | 2770 | |
2729af9d WD |
2771 | - the same features can be used for other OS or standalone |
2772 | applications (for instance: using compressed images to reduce the | |
2773 | Flash memory footprint) | |
c609719b | 2774 | |
2729af9d WD |
2775 | - it becomes much easier to port new Linux kernel versions because |
2776 | lots of low-level, hardware dependent stuff are done by U-Boot | |
c609719b | 2777 | |
2729af9d WD |
2778 | - the same Linux kernel image can now be used with different "initrd" |
2779 | images; of course this also means that different kernel images can | |
2780 | be run with the same "initrd". This makes testing easier (you don't | |
2781 | have to build a new "zImage.initrd" Linux image when you just | |
2782 | change a file in your "initrd"). Also, a field-upgrade of the | |
2783 | software is easier now. | |
c609719b | 2784 | |
c609719b | 2785 | |
2729af9d WD |
2786 | Linux HOWTO: |
2787 | ============ | |
c609719b | 2788 | |
2729af9d WD |
2789 | Porting Linux to U-Boot based systems: |
2790 | --------------------------------------- | |
c609719b | 2791 | |
2729af9d WD |
2792 | U-Boot cannot save you from doing all the necessary modifications to |
2793 | configure the Linux device drivers for use with your target hardware | |
2794 | (no, we don't intend to provide a full virtual machine interface to | |
2795 | Linux :-). | |
c609719b | 2796 | |
2729af9d | 2797 | But now you can ignore ALL boot loader code (in arch/ppc/mbxboot). |
24ee89b9 | 2798 | |
2729af9d WD |
2799 | Just make sure your machine specific header file (for instance |
2800 | include/asm-ppc/tqm8xx.h) includes the same definition of the Board | |
2801 | Information structure as we define in include/u-boot.h, and make | |
2802 | sure that your definition of IMAP_ADDR uses the same value as your | |
2803 | U-Boot configuration in CFG_IMMR. | |
24ee89b9 | 2804 | |
c609719b | 2805 | |
2729af9d WD |
2806 | Configuring the Linux kernel: |
2807 | ----------------------------- | |
c609719b | 2808 | |
2729af9d WD |
2809 | No specific requirements for U-Boot. Make sure you have some root |
2810 | device (initial ramdisk, NFS) for your target system. | |
2811 | ||
2812 | ||
2813 | Building a Linux Image: | |
2814 | ----------------------- | |
c609719b | 2815 | |
2729af9d WD |
2816 | With U-Boot, "normal" build targets like "zImage" or "bzImage" are |
2817 | not used. If you use recent kernel source, a new build target | |
2818 | "uImage" will exist which automatically builds an image usable by | |
2819 | U-Boot. Most older kernels also have support for a "pImage" target, | |
2820 | which was introduced for our predecessor project PPCBoot and uses a | |
2821 | 100% compatible format. | |
2822 | ||
2823 | Example: | |
2824 | ||
2825 | make TQM850L_config | |
2826 | make oldconfig | |
2827 | make dep | |
2828 | make uImage | |
2829 | ||
2830 | The "uImage" build target uses a special tool (in 'tools/mkimage') to | |
2831 | encapsulate a compressed Linux kernel image with header information, | |
2832 | CRC32 checksum etc. for use with U-Boot. This is what we are doing: | |
2833 | ||
2834 | * build a standard "vmlinux" kernel image (in ELF binary format): | |
2835 | ||
2836 | * convert the kernel into a raw binary image: | |
2837 | ||
2838 | ${CROSS_COMPILE}-objcopy -O binary \ | |
2839 | -R .note -R .comment \ | |
2840 | -S vmlinux linux.bin | |
2841 | ||
2842 | * compress the binary image: | |
2843 | ||
2844 | gzip -9 linux.bin | |
2845 | ||
2846 | * package compressed binary image for U-Boot: | |
2847 | ||
2848 | mkimage -A ppc -O linux -T kernel -C gzip \ | |
2849 | -a 0 -e 0 -n "Linux Kernel Image" \ | |
2850 | -d linux.bin.gz uImage | |
c609719b | 2851 | |
c609719b | 2852 | |
2729af9d WD |
2853 | The "mkimage" tool can also be used to create ramdisk images for use |
2854 | with U-Boot, either separated from the Linux kernel image, or | |
2855 | combined into one file. "mkimage" encapsulates the images with a 64 | |
2856 | byte header containing information about target architecture, | |
2857 | operating system, image type, compression method, entry points, time | |
2858 | stamp, CRC32 checksums, etc. | |
2859 | ||
2860 | "mkimage" can be called in two ways: to verify existing images and | |
2861 | print the header information, or to build new images. | |
2862 | ||
2863 | In the first form (with "-l" option) mkimage lists the information | |
2864 | contained in the header of an existing U-Boot image; this includes | |
2865 | checksum verification: | |
c609719b | 2866 | |
2729af9d WD |
2867 | tools/mkimage -l image |
2868 | -l ==> list image header information | |
2869 | ||
2870 | The second form (with "-d" option) is used to build a U-Boot image | |
2871 | from a "data file" which is used as image payload: | |
2872 | ||
2873 | tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ | |
2874 | -n name -d data_file image | |
2875 | -A ==> set architecture to 'arch' | |
2876 | -O ==> set operating system to 'os' | |
2877 | -T ==> set image type to 'type' | |
2878 | -C ==> set compression type 'comp' | |
2879 | -a ==> set load address to 'addr' (hex) | |
2880 | -e ==> set entry point to 'ep' (hex) | |
2881 | -n ==> set image name to 'name' | |
2882 | -d ==> use image data from 'datafile' | |
2883 | ||
69459791 WD |
2884 | Right now, all Linux kernels for PowerPC systems use the same load |
2885 | address (0x00000000), but the entry point address depends on the | |
2886 | kernel version: | |
2729af9d WD |
2887 | |
2888 | - 2.2.x kernels have the entry point at 0x0000000C, | |
2889 | - 2.3.x and later kernels have the entry point at 0x00000000. | |
2890 | ||
2891 | So a typical call to build a U-Boot image would read: | |
2892 | ||
2893 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ | |
2894 | > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ | |
2895 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ | |
2896 | > examples/uImage.TQM850L | |
2897 | Image Name: 2.4.4 kernel for TQM850L | |
2898 | Created: Wed Jul 19 02:34:59 2000 | |
2899 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2900 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB | |
2901 | Load Address: 0x00000000 | |
2902 | Entry Point: 0x00000000 | |
2903 | ||
2904 | To verify the contents of the image (or check for corruption): | |
2905 | ||
2906 | -> tools/mkimage -l examples/uImage.TQM850L | |
2907 | Image Name: 2.4.4 kernel for TQM850L | |
2908 | Created: Wed Jul 19 02:34:59 2000 | |
2909 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2910 | Data Size: 335725 Bytes = 327.86 kB = 0.32 MB | |
2911 | Load Address: 0x00000000 | |
2912 | Entry Point: 0x00000000 | |
2913 | ||
2914 | NOTE: for embedded systems where boot time is critical you can trade | |
2915 | speed for memory and install an UNCOMPRESSED image instead: this | |
2916 | needs more space in Flash, but boots much faster since it does not | |
2917 | need to be uncompressed: | |
2918 | ||
2919 | -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz | |
2920 | -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ | |
2921 | > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ | |
2922 | > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ | |
2923 | > examples/uImage.TQM850L-uncompressed | |
2924 | Image Name: 2.4.4 kernel for TQM850L | |
2925 | Created: Wed Jul 19 02:34:59 2000 | |
2926 | Image Type: PowerPC Linux Kernel Image (uncompressed) | |
2927 | Data Size: 792160 Bytes = 773.59 kB = 0.76 MB | |
2928 | Load Address: 0x00000000 | |
2929 | Entry Point: 0x00000000 | |
2930 | ||
2931 | ||
2932 | Similar you can build U-Boot images from a 'ramdisk.image.gz' file | |
2933 | when your kernel is intended to use an initial ramdisk: | |
2934 | ||
2935 | -> tools/mkimage -n 'Simple Ramdisk Image' \ | |
2936 | > -A ppc -O linux -T ramdisk -C gzip \ | |
2937 | > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd | |
2938 | Image Name: Simple Ramdisk Image | |
2939 | Created: Wed Jan 12 14:01:50 2000 | |
2940 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
2941 | Data Size: 566530 Bytes = 553.25 kB = 0.54 MB | |
2942 | Load Address: 0x00000000 | |
2943 | Entry Point: 0x00000000 | |
2944 | ||
2945 | ||
2946 | Installing a Linux Image: | |
2947 | ------------------------- | |
2948 | ||
2949 | To downloading a U-Boot image over the serial (console) interface, | |
2950 | you must convert the image to S-Record format: | |
2951 | ||
2952 | objcopy -I binary -O srec examples/image examples/image.srec | |
2953 | ||
2954 | The 'objcopy' does not understand the information in the U-Boot | |
2955 | image header, so the resulting S-Record file will be relative to | |
2956 | address 0x00000000. To load it to a given address, you need to | |
2957 | specify the target address as 'offset' parameter with the 'loads' | |
2958 | command. | |
2959 | ||
2960 | Example: install the image to address 0x40100000 (which on the | |
2961 | TQM8xxL is in the first Flash bank): | |
2962 | ||
2963 | => erase 40100000 401FFFFF | |
2964 | ||
2965 | .......... done | |
2966 | Erased 8 sectors | |
2967 | ||
2968 | => loads 40100000 | |
2969 | ## Ready for S-Record download ... | |
2970 | ~>examples/image.srec | |
2971 | 1 2 3 4 5 6 7 8 9 10 11 12 13 ... | |
2972 | ... | |
2973 | 15989 15990 15991 15992 | |
2974 | [file transfer complete] | |
2975 | [connected] | |
2976 | ## Start Addr = 0x00000000 | |
2977 | ||
2978 | ||
2979 | You can check the success of the download using the 'iminfo' command; | |
2980 | this includes a checksum verification so you can be sure no data | |
2981 | corruption happened: | |
2982 | ||
2983 | => imi 40100000 | |
2984 | ||
2985 | ## Checking Image at 40100000 ... | |
2986 | Image Name: 2.2.13 for initrd on TQM850L | |
2987 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
2988 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
2989 | Load Address: 00000000 | |
2990 | Entry Point: 0000000c | |
2991 | Verifying Checksum ... OK | |
2992 | ||
2993 | ||
2994 | Boot Linux: | |
2995 | ----------- | |
2996 | ||
2997 | The "bootm" command is used to boot an application that is stored in | |
2998 | memory (RAM or Flash). In case of a Linux kernel image, the contents | |
2999 | of the "bootargs" environment variable is passed to the kernel as | |
3000 | parameters. You can check and modify this variable using the | |
3001 | "printenv" and "setenv" commands: | |
3002 | ||
3003 | ||
3004 | => printenv bootargs | |
3005 | bootargs=root=/dev/ram | |
3006 | ||
3007 | => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
3008 | ||
3009 | => printenv bootargs | |
3010 | bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
3011 | ||
3012 | => bootm 40020000 | |
3013 | ## Booting Linux kernel at 40020000 ... | |
3014 | Image Name: 2.2.13 for NFS on TQM850L | |
3015 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
3016 | Data Size: 381681 Bytes = 372 kB = 0 MB | |
3017 | Load Address: 00000000 | |
3018 | Entry Point: 0000000c | |
3019 | Verifying Checksum ... OK | |
3020 | Uncompressing Kernel Image ... OK | |
3021 | Linux version 2.2.13 ([email protected]) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000 | |
3022 | Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 | |
3023 | time_init: decrementer frequency = 187500000/60 | |
3024 | Calibrating delay loop... 49.77 BogoMIPS | |
3025 | Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] | |
3026 | ... | |
3027 | ||
3028 | If you want to boot a Linux kernel with initial ram disk, you pass | |
3029 | the memory addresses of both the kernel and the initrd image (PPBCOOT | |
3030 | format!) to the "bootm" command: | |
3031 | ||
3032 | => imi 40100000 40200000 | |
3033 | ||
3034 | ## Checking Image at 40100000 ... | |
3035 | Image Name: 2.2.13 for initrd on TQM850L | |
3036 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
3037 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
3038 | Load Address: 00000000 | |
3039 | Entry Point: 0000000c | |
3040 | Verifying Checksum ... OK | |
3041 | ||
3042 | ## Checking Image at 40200000 ... | |
3043 | Image Name: Simple Ramdisk Image | |
3044 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
3045 | Data Size: 566530 Bytes = 553 kB = 0 MB | |
3046 | Load Address: 00000000 | |
3047 | Entry Point: 00000000 | |
3048 | Verifying Checksum ... OK | |
3049 | ||
3050 | => bootm 40100000 40200000 | |
3051 | ## Booting Linux kernel at 40100000 ... | |
3052 | Image Name: 2.2.13 for initrd on TQM850L | |
3053 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
3054 | Data Size: 335725 Bytes = 327 kB = 0 MB | |
3055 | Load Address: 00000000 | |
3056 | Entry Point: 0000000c | |
3057 | Verifying Checksum ... OK | |
3058 | Uncompressing Kernel Image ... OK | |
3059 | ## Loading RAMDisk Image at 40200000 ... | |
3060 | Image Name: Simple Ramdisk Image | |
3061 | Image Type: PowerPC Linux RAMDisk Image (gzip compressed) | |
3062 | Data Size: 566530 Bytes = 553 kB = 0 MB | |
3063 | Load Address: 00000000 | |
3064 | Entry Point: 00000000 | |
3065 | Verifying Checksum ... OK | |
3066 | Loading Ramdisk ... OK | |
3067 | Linux version 2.2.13 ([email protected]) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000 | |
3068 | Boot arguments: root=/dev/ram | |
3069 | time_init: decrementer frequency = 187500000/60 | |
3070 | Calibrating delay loop... 49.77 BogoMIPS | |
3071 | ... | |
3072 | RAMDISK: Compressed image found at block 0 | |
3073 | VFS: Mounted root (ext2 filesystem). | |
3074 | ||
3075 | bash# | |
3076 | ||
0267768e MM |
3077 | Boot Linux and pass a flat device tree: |
3078 | ----------- | |
3079 | ||
3080 | First, U-Boot must be compiled with the appropriate defines. See the section | |
3081 | titled "Linux Kernel Interface" above for a more in depth explanation. The | |
3082 | following is an example of how to start a kernel and pass an updated | |
3083 | flat device tree: | |
3084 | ||
3085 | => print oftaddr | |
3086 | oftaddr=0x300000 | |
3087 | => print oft | |
3088 | oft=oftrees/mpc8540ads.dtb | |
3089 | => tftp $oftaddr $oft | |
3090 | Speed: 1000, full duplex | |
3091 | Using TSEC0 device | |
3092 | TFTP from server 192.168.1.1; our IP address is 192.168.1.101 | |
3093 | Filename 'oftrees/mpc8540ads.dtb'. | |
3094 | Load address: 0x300000 | |
3095 | Loading: # | |
3096 | done | |
3097 | Bytes transferred = 4106 (100a hex) | |
3098 | => tftp $loadaddr $bootfile | |
3099 | Speed: 1000, full duplex | |
3100 | Using TSEC0 device | |
3101 | TFTP from server 192.168.1.1; our IP address is 192.168.1.2 | |
3102 | Filename 'uImage'. | |
3103 | Load address: 0x200000 | |
3104 | Loading:############ | |
3105 | done | |
3106 | Bytes transferred = 1029407 (fb51f hex) | |
3107 | => print loadaddr | |
3108 | loadaddr=200000 | |
3109 | => print oftaddr | |
3110 | oftaddr=0x300000 | |
3111 | => bootm $loadaddr - $oftaddr | |
3112 | ## Booting image at 00200000 ... | |
3113 | Image Name: Linux-2.6.17-dirty | |
3114 | Image Type: PowerPC Linux Kernel Image (gzip compressed) | |
3115 | Data Size: 1029343 Bytes = 1005.2 kB | |
3116 | Load Address: 00000000 | |
3117 | Entry Point: 00000000 | |
3118 | Verifying Checksum ... OK | |
3119 | Uncompressing Kernel Image ... OK | |
3120 | Booting using flat device tree at 0x300000 | |
3121 | Using MPC85xx ADS machine description | |
3122 | Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb | |
3123 | [snip] | |
3124 | ||
3125 | ||
2729af9d WD |
3126 | More About U-Boot Image Types: |
3127 | ------------------------------ | |
3128 | ||
3129 | U-Boot supports the following image types: | |
3130 | ||
3131 | "Standalone Programs" are directly runnable in the environment | |
3132 | provided by U-Boot; it is expected that (if they behave | |
3133 | well) you can continue to work in U-Boot after return from | |
3134 | the Standalone Program. | |
3135 | "OS Kernel Images" are usually images of some Embedded OS which | |
3136 | will take over control completely. Usually these programs | |
3137 | will install their own set of exception handlers, device | |
3138 | drivers, set up the MMU, etc. - this means, that you cannot | |
3139 | expect to re-enter U-Boot except by resetting the CPU. | |
3140 | "RAMDisk Images" are more or less just data blocks, and their | |
3141 | parameters (address, size) are passed to an OS kernel that is | |
3142 | being started. | |
3143 | "Multi-File Images" contain several images, typically an OS | |
3144 | (Linux) kernel image and one or more data images like | |
3145 | RAMDisks. This construct is useful for instance when you want | |
3146 | to boot over the network using BOOTP etc., where the boot | |
3147 | server provides just a single image file, but you want to get | |
3148 | for instance an OS kernel and a RAMDisk image. | |
3149 | ||
3150 | "Multi-File Images" start with a list of image sizes, each | |
3151 | image size (in bytes) specified by an "uint32_t" in network | |
3152 | byte order. This list is terminated by an "(uint32_t)0". | |
3153 | Immediately after the terminating 0 follow the images, one by | |
3154 | one, all aligned on "uint32_t" boundaries (size rounded up to | |
3155 | a multiple of 4 bytes). | |
3156 | ||
3157 | "Firmware Images" are binary images containing firmware (like | |
3158 | U-Boot or FPGA images) which usually will be programmed to | |
3159 | flash memory. | |
3160 | ||
3161 | "Script files" are command sequences that will be executed by | |
3162 | U-Boot's command interpreter; this feature is especially | |
3163 | useful when you configure U-Boot to use a real shell (hush) | |
3164 | as command interpreter. | |
3165 | ||
3166 | ||
3167 | Standalone HOWTO: | |
3168 | ================= | |
3169 | ||
3170 | One of the features of U-Boot is that you can dynamically load and | |
3171 | run "standalone" applications, which can use some resources of | |
3172 | U-Boot like console I/O functions or interrupt services. | |
3173 | ||
3174 | Two simple examples are included with the sources: | |
3175 | ||
3176 | "Hello World" Demo: | |
3177 | ------------------- | |
3178 | ||
3179 | 'examples/hello_world.c' contains a small "Hello World" Demo | |
3180 | application; it is automatically compiled when you build U-Boot. | |
3181 | It's configured to run at address 0x00040004, so you can play with it | |
3182 | like that: | |
3183 | ||
3184 | => loads | |
3185 | ## Ready for S-Record download ... | |
3186 | ~>examples/hello_world.srec | |
3187 | 1 2 3 4 5 6 7 8 9 10 11 ... | |
3188 | [file transfer complete] | |
3189 | [connected] | |
3190 | ## Start Addr = 0x00040004 | |
3191 | ||
3192 | => go 40004 Hello World! This is a test. | |
3193 | ## Starting application at 0x00040004 ... | |
3194 | Hello World | |
3195 | argc = 7 | |
3196 | argv[0] = "40004" | |
3197 | argv[1] = "Hello" | |
3198 | argv[2] = "World!" | |
3199 | argv[3] = "This" | |
3200 | argv[4] = "is" | |
3201 | argv[5] = "a" | |
3202 | argv[6] = "test." | |
3203 | argv[7] = "<NULL>" | |
3204 | Hit any key to exit ... | |
3205 | ||
3206 | ## Application terminated, rc = 0x0 | |
3207 | ||
3208 | Another example, which demonstrates how to register a CPM interrupt | |
3209 | handler with the U-Boot code, can be found in 'examples/timer.c'. | |
3210 | Here, a CPM timer is set up to generate an interrupt every second. | |
3211 | The interrupt service routine is trivial, just printing a '.' | |
3212 | character, but this is just a demo program. The application can be | |
3213 | controlled by the following keys: | |
3214 | ||
3215 | ? - print current values og the CPM Timer registers | |
3216 | b - enable interrupts and start timer | |
3217 | e - stop timer and disable interrupts | |
3218 | q - quit application | |
3219 | ||
3220 | => loads | |
3221 | ## Ready for S-Record download ... | |
3222 | ~>examples/timer.srec | |
3223 | 1 2 3 4 5 6 7 8 9 10 11 ... | |
3224 | [file transfer complete] | |
3225 | [connected] | |
3226 | ## Start Addr = 0x00040004 | |
3227 | ||
3228 | => go 40004 | |
3229 | ## Starting application at 0x00040004 ... | |
3230 | TIMERS=0xfff00980 | |
3231 | Using timer 1 | |
3232 | tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 | |
3233 | ||
3234 | Hit 'b': | |
3235 | [q, b, e, ?] Set interval 1000000 us | |
3236 | Enabling timer | |
3237 | Hit '?': | |
3238 | [q, b, e, ?] ........ | |
3239 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 | |
3240 | Hit '?': | |
3241 | [q, b, e, ?] . | |
3242 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 | |
3243 | Hit '?': | |
3244 | [q, b, e, ?] . | |
3245 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 | |
3246 | Hit '?': | |
3247 | [q, b, e, ?] . | |
3248 | tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 | |
3249 | Hit 'e': | |
3250 | [q, b, e, ?] ...Stopping timer | |
3251 | Hit 'q': | |
3252 | [q, b, e, ?] ## Application terminated, rc = 0x0 | |
3253 | ||
3254 | ||
3255 | Minicom warning: | |
3256 | ================ | |
3257 | ||
3258 | Over time, many people have reported problems when trying to use the | |
3259 | "minicom" terminal emulation program for serial download. I (wd) | |
3260 | consider minicom to be broken, and recommend not to use it. Under | |
3261 | Unix, I recommend to use C-Kermit for general purpose use (and | |
3262 | especially for kermit binary protocol download ("loadb" command), and | |
3263 | use "cu" for S-Record download ("loads" command). | |
3264 | ||
3265 | Nevertheless, if you absolutely want to use it try adding this | |
3266 | configuration to your "File transfer protocols" section: | |
3267 | ||
3268 | Name Program Name U/D FullScr IO-Red. Multi | |
3269 | X kermit /usr/bin/kermit -i -l %l -s Y U Y N N | |
3270 | Y kermit /usr/bin/kermit -i -l %l -r N D Y N N | |
3271 | ||
3272 | ||
3273 | NetBSD Notes: | |
3274 | ============= | |
3275 | ||
3276 | Starting at version 0.9.2, U-Boot supports NetBSD both as host | |
3277 | (build U-Boot) and target system (boots NetBSD/mpc8xx). | |
3278 | ||
3279 | Building requires a cross environment; it is known to work on | |
3280 | NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also | |
3281 | need gmake since the Makefiles are not compatible with BSD make). | |
3282 | Note that the cross-powerpc package does not install include files; | |
3283 | attempting to build U-Boot will fail because <machine/ansi.h> is | |
3284 | missing. This file has to be installed and patched manually: | |
3285 | ||
3286 | # cd /usr/pkg/cross/powerpc-netbsd/include | |
3287 | # mkdir powerpc | |
3288 | # ln -s powerpc machine | |
3289 | # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h | |
3290 | # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST | |
3291 | ||
3292 | Native builds *don't* work due to incompatibilities between native | |
3293 | and U-Boot include files. | |
3294 | ||
3295 | Booting assumes that (the first part of) the image booted is a | |
3296 | stage-2 loader which in turn loads and then invokes the kernel | |
3297 | proper. Loader sources will eventually appear in the NetBSD source | |
3298 | tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the | |
2a8af187 | 3299 | meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz |
2729af9d WD |
3300 | |
3301 | ||
3302 | Implementation Internals: | |
3303 | ========================= | |
3304 | ||
3305 | The following is not intended to be a complete description of every | |
3306 | implementation detail. However, it should help to understand the | |
3307 | inner workings of U-Boot and make it easier to port it to custom | |
3308 | hardware. | |
3309 | ||
3310 | ||
3311 | Initial Stack, Global Data: | |
3312 | --------------------------- | |
3313 | ||
3314 | The implementation of U-Boot is complicated by the fact that U-Boot | |
3315 | starts running out of ROM (flash memory), usually without access to | |
3316 | system RAM (because the memory controller is not initialized yet). | |
3317 | This means that we don't have writable Data or BSS segments, and BSS | |
3318 | is not initialized as zero. To be able to get a C environment working | |
3319 | at all, we have to allocate at least a minimal stack. Implementation | |
3320 | options for this are defined and restricted by the CPU used: Some CPU | |
3321 | models provide on-chip memory (like the IMMR area on MPC8xx and | |
3322 | MPC826x processors), on others (parts of) the data cache can be | |
3323 | locked as (mis-) used as memory, etc. | |
3324 | ||
3325 | Chris Hallinan posted a good summary of these issues to the | |
3326 | u-boot-users mailing list: | |
3327 | ||
3328 | Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? | |
3329 | From: "Chris Hallinan" <[email protected]> | |
3330 | Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) | |
3331 | ... | |
3332 | ||
3333 | Correct me if I'm wrong, folks, but the way I understand it | |
3334 | is this: Using DCACHE as initial RAM for Stack, etc, does not | |
3335 | require any physical RAM backing up the cache. The cleverness | |
3336 | is that the cache is being used as a temporary supply of | |
3337 | necessary storage before the SDRAM controller is setup. It's | |
3338 | beyond the scope of this list to expain the details, but you | |
3339 | can see how this works by studying the cache architecture and | |
3340 | operation in the architecture and processor-specific manuals. | |
3341 | ||
3342 | OCM is On Chip Memory, which I believe the 405GP has 4K. It | |
3343 | is another option for the system designer to use as an | |
3344 | initial stack/ram area prior to SDRAM being available. Either | |
3345 | option should work for you. Using CS 4 should be fine if your | |
3346 | board designers haven't used it for something that would | |
3347 | cause you grief during the initial boot! It is frequently not | |
3348 | used. | |
3349 | ||
3350 | CFG_INIT_RAM_ADDR should be somewhere that won't interfere | |
3351 | with your processor/board/system design. The default value | |
3352 | you will find in any recent u-boot distribution in | |
8a316c9b | 3353 | walnut.h should work for you. I'd set it to a value larger |
2729af9d WD |
3354 | than your SDRAM module. If you have a 64MB SDRAM module, set |
3355 | it above 400_0000. Just make sure your board has no resources | |
3356 | that are supposed to respond to that address! That code in | |
3357 | start.S has been around a while and should work as is when | |
3358 | you get the config right. | |
3359 | ||
3360 | -Chris Hallinan | |
3361 | DS4.COM, Inc. | |
3362 | ||
3363 | It is essential to remember this, since it has some impact on the C | |
3364 | code for the initialization procedures: | |
3365 | ||
3366 | * Initialized global data (data segment) is read-only. Do not attempt | |
3367 | to write it. | |
3368 | ||
3369 | * Do not use any unitialized global data (or implicitely initialized | |
3370 | as zero data - BSS segment) at all - this is undefined, initiali- | |
3371 | zation is performed later (when relocating to RAM). | |
3372 | ||
3373 | * Stack space is very limited. Avoid big data buffers or things like | |
3374 | that. | |
3375 | ||
3376 | Having only the stack as writable memory limits means we cannot use | |
3377 | normal global data to share information beween the code. But it | |
3378 | turned out that the implementation of U-Boot can be greatly | |
3379 | simplified by making a global data structure (gd_t) available to all | |
3380 | functions. We could pass a pointer to this data as argument to _all_ | |
3381 | functions, but this would bloat the code. Instead we use a feature of | |
3382 | the GCC compiler (Global Register Variables) to share the data: we | |
3383 | place a pointer (gd) to the global data into a register which we | |
3384 | reserve for this purpose. | |
3385 | ||
3386 | When choosing a register for such a purpose we are restricted by the | |
3387 | relevant (E)ABI specifications for the current architecture, and by | |
3388 | GCC's implementation. | |
3389 | ||
3390 | For PowerPC, the following registers have specific use: | |
3391 | R1: stack pointer | |
3392 | R2: TOC pointer | |
3393 | R3-R4: parameter passing and return values | |
3394 | R5-R10: parameter passing | |
3395 | R13: small data area pointer | |
3396 | R30: GOT pointer | |
3397 | R31: frame pointer | |
3398 | ||
3399 | (U-Boot also uses R14 as internal GOT pointer.) | |
3400 | ||
3401 | ==> U-Boot will use R29 to hold a pointer to the global data | |
3402 | ||
3403 | Note: on PPC, we could use a static initializer (since the | |
3404 | address of the global data structure is known at compile time), | |
3405 | but it turned out that reserving a register results in somewhat | |
3406 | smaller code - although the code savings are not that big (on | |
3407 | average for all boards 752 bytes for the whole U-Boot image, | |
3408 | 624 text + 127 data). | |
3409 | ||
3410 | On ARM, the following registers are used: | |
3411 | ||
3412 | R0: function argument word/integer result | |
3413 | R1-R3: function argument word | |
3414 | R9: GOT pointer | |
3415 | R10: stack limit (used only if stack checking if enabled) | |
3416 | R11: argument (frame) pointer | |
3417 | R12: temporary workspace | |
3418 | R13: stack pointer | |
3419 | R14: link register | |
3420 | R15: program counter | |
3421 | ||
3422 | ==> U-Boot will use R8 to hold a pointer to the global data | |
3423 | ||
d87080b7 WD |
3424 | NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, |
3425 | or current versions of GCC may "optimize" the code too much. | |
2729af9d WD |
3426 | |
3427 | Memory Management: | |
3428 | ------------------ | |
3429 | ||
3430 | U-Boot runs in system state and uses physical addresses, i.e. the | |
3431 | MMU is not used either for address mapping nor for memory protection. | |
3432 | ||
3433 | The available memory is mapped to fixed addresses using the memory | |
3434 | controller. In this process, a contiguous block is formed for each | |
3435 | memory type (Flash, SDRAM, SRAM), even when it consists of several | |
3436 | physical memory banks. | |
3437 | ||
3438 | U-Boot is installed in the first 128 kB of the first Flash bank (on | |
3439 | TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After | |
3440 | booting and sizing and initializing DRAM, the code relocates itself | |
3441 | to the upper end of DRAM. Immediately below the U-Boot code some | |
3442 | memory is reserved for use by malloc() [see CFG_MALLOC_LEN | |
3443 | configuration setting]. Below that, a structure with global Board | |
3444 | Info data is placed, followed by the stack (growing downward). | |
3445 | ||
3446 | Additionally, some exception handler code is copied to the low 8 kB | |
3447 | of DRAM (0x00000000 ... 0x00001FFF). | |
3448 | ||
3449 | So a typical memory configuration with 16 MB of DRAM could look like | |
3450 | this: | |
3451 | ||
3452 | 0x0000 0000 Exception Vector code | |
3453 | : | |
3454 | 0x0000 1FFF | |
3455 | 0x0000 2000 Free for Application Use | |
3456 | : | |
3457 | : | |
3458 | ||
3459 | : | |
3460 | : | |
3461 | 0x00FB FF20 Monitor Stack (Growing downward) | |
3462 | 0x00FB FFAC Board Info Data and permanent copy of global data | |
3463 | 0x00FC 0000 Malloc Arena | |
3464 | : | |
3465 | 0x00FD FFFF | |
3466 | 0x00FE 0000 RAM Copy of Monitor Code | |
3467 | ... eventually: LCD or video framebuffer | |
3468 | ... eventually: pRAM (Protected RAM - unchanged by reset) | |
3469 | 0x00FF FFFF [End of RAM] | |
3470 | ||
3471 | ||
3472 | System Initialization: | |
3473 | ---------------------- | |
c609719b | 3474 | |
2729af9d WD |
3475 | In the reset configuration, U-Boot starts at the reset entry point |
3476 | (on most PowerPC systens at address 0x00000100). Because of the reset | |
3477 | configuration for CS0# this is a mirror of the onboard Flash memory. | |
3478 | To be able to re-map memory U-Boot then jumps to its link address. | |
3479 | To be able to implement the initialization code in C, a (small!) | |
3480 | initial stack is set up in the internal Dual Ported RAM (in case CPUs | |
3481 | which provide such a feature like MPC8xx or MPC8260), or in a locked | |
3482 | part of the data cache. After that, U-Boot initializes the CPU core, | |
3483 | the caches and the SIU. | |
3484 | ||
3485 | Next, all (potentially) available memory banks are mapped using a | |
3486 | preliminary mapping. For example, we put them on 512 MB boundaries | |
3487 | (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash | |
3488 | on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is | |
3489 | programmed for SDRAM access. Using the temporary configuration, a | |
3490 | simple memory test is run that determines the size of the SDRAM | |
3491 | banks. | |
3492 | ||
3493 | When there is more than one SDRAM bank, and the banks are of | |
3494 | different size, the largest is mapped first. For equal size, the first | |
3495 | bank (CS2#) is mapped first. The first mapping is always for address | |
3496 | 0x00000000, with any additional banks following immediately to create | |
3497 | contiguous memory starting from 0. | |
3498 | ||
3499 | Then, the monitor installs itself at the upper end of the SDRAM area | |
3500 | and allocates memory for use by malloc() and for the global Board | |
3501 | Info data; also, the exception vector code is copied to the low RAM | |
3502 | pages, and the final stack is set up. | |
3503 | ||
3504 | Only after this relocation will you have a "normal" C environment; | |
3505 | until that you are restricted in several ways, mostly because you are | |
3506 | running from ROM, and because the code will have to be relocated to a | |
3507 | new address in RAM. | |
3508 | ||
3509 | ||
3510 | U-Boot Porting Guide: | |
3511 | ---------------------- | |
c609719b | 3512 | |
2729af9d WD |
3513 | [Based on messages by Jerry Van Baren in the U-Boot-Users mailing |
3514 | list, October 2002] | |
c609719b WD |
3515 | |
3516 | ||
2729af9d WD |
3517 | int main (int argc, char *argv[]) |
3518 | { | |
3519 | sighandler_t no_more_time; | |
c609719b | 3520 | |
2729af9d WD |
3521 | signal (SIGALRM, no_more_time); |
3522 | alarm (PROJECT_DEADLINE - toSec (3 * WEEK)); | |
c609719b | 3523 | |
2729af9d WD |
3524 | if (available_money > available_manpower) { |
3525 | pay consultant to port U-Boot; | |
c609719b WD |
3526 | return 0; |
3527 | } | |
3528 | ||
2729af9d WD |
3529 | Download latest U-Boot source; |
3530 | ||
3531 | Subscribe to u-boot-users mailing list; | |
3532 | ||
3533 | if (clueless) { | |
3534 | email ("Hi, I am new to U-Boot, how do I get started?"); | |
3535 | } | |
3536 | ||
3537 | while (learning) { | |
3538 | Read the README file in the top level directory; | |
3539 | Read http://www.denx.de/twiki/bin/view/DULG/Manual ; | |
3540 | Read the source, Luke; | |
3541 | } | |
3542 | ||
3543 | if (available_money > toLocalCurrency ($2500)) { | |
3544 | Buy a BDI2000; | |
3545 | } else { | |
3546 | Add a lot of aggravation and time; | |
c609719b WD |
3547 | } |
3548 | ||
2729af9d WD |
3549 | Create your own board support subdirectory; |
3550 | ||
3551 | Create your own board config file; | |
3552 | ||
3553 | while (!running) { | |
3554 | do { | |
3555 | Add / modify source code; | |
3556 | } until (compiles); | |
3557 | Debug; | |
3558 | if (clueless) | |
3559 | email ("Hi, I am having problems..."); | |
3560 | } | |
3561 | Send patch file to Wolfgang; | |
3562 | ||
3563 | return 0; | |
3564 | } | |
3565 | ||
3566 | void no_more_time (int sig) | |
3567 | { | |
3568 | hire_a_guru(); | |
3569 | } | |
3570 | ||
c609719b | 3571 | |
2729af9d WD |
3572 | Coding Standards: |
3573 | ----------------- | |
c609719b | 3574 | |
2729af9d | 3575 | All contributions to U-Boot should conform to the Linux kernel |
2c051651 DZ |
3576 | coding style; see the file "Documentation/CodingStyle" and the script |
3577 | "scripts/Lindent" in your Linux kernel source directory. In sources | |
3578 | originating from U-Boot a style corresponding to "Lindent -pcs" (adding | |
3579 | spaces before parameters to function calls) is actually used. | |
3580 | ||
3581 | Source files originating from a different project (for example the | |
3582 | MTD subsystem) are generally exempt from these guidelines and are not | |
3583 | reformated to ease subsequent migration to newer versions of those | |
3584 | sources. | |
3585 | ||
3586 | Please note that U-Boot is implemented in C (and to some small parts in | |
3587 | Assembler); no C++ is used, so please do not use C++ style comments (//) | |
3588 | in your code. | |
c609719b | 3589 | |
2729af9d WD |
3590 | Please also stick to the following formatting rules: |
3591 | - remove any trailing white space | |
3592 | - use TAB characters for indentation, not spaces | |
3593 | - make sure NOT to use DOS '\r\n' line feeds | |
3594 | - do not add more than 2 empty lines to source files | |
3595 | - do not add trailing empty lines to source files | |
180d3f74 | 3596 | |
2729af9d WD |
3597 | Submissions which do not conform to the standards may be returned |
3598 | with a request to reformat the changes. | |
c609719b WD |
3599 | |
3600 | ||
2729af9d WD |
3601 | Submitting Patches: |
3602 | ------------------- | |
c609719b | 3603 | |
2729af9d WD |
3604 | Since the number of patches for U-Boot is growing, we need to |
3605 | establish some rules. Submissions which do not conform to these rules | |
3606 | may be rejected, even when they contain important and valuable stuff. | |
c609719b | 3607 | |
90dc6704 | 3608 | Patches shall be sent to the u-boot-users mailing list. |
c609719b | 3609 | |
2729af9d WD |
3610 | When you send a patch, please include the following information with |
3611 | it: | |
c609719b | 3612 | |
2729af9d WD |
3613 | * For bug fixes: a description of the bug and how your patch fixes |
3614 | this bug. Please try to include a way of demonstrating that the | |
3615 | patch actually fixes something. | |
c609719b | 3616 | |
2729af9d WD |
3617 | * For new features: a description of the feature and your |
3618 | implementation. | |
c609719b | 3619 | |
2729af9d | 3620 | * A CHANGELOG entry as plaintext (separate from the patch) |
c609719b | 3621 | |
2729af9d | 3622 | * For major contributions, your entry to the CREDITS file |
c609719b | 3623 | |
2729af9d WD |
3624 | * When you add support for a new board, don't forget to add this |
3625 | board to the MAKEALL script, too. | |
c609719b | 3626 | |
2729af9d WD |
3627 | * If your patch adds new configuration options, don't forget to |
3628 | document these in the README file. | |
c609719b | 3629 | |
2729af9d WD |
3630 | * The patch itself. If you are accessing the CVS repository use "cvs |
3631 | update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your | |
3632 | version of diff does not support these options, then get the latest | |
3633 | version of GNU diff. | |
c609719b | 3634 | |
2729af9d WD |
3635 | The current directory when running this command shall be the top |
3636 | level directory of the U-Boot source tree, or it's parent directory | |
3637 | (i. e. please make sure that your patch includes sufficient | |
3638 | directory information for the affected files). | |
6dff5529 | 3639 | |
2729af9d WD |
3640 | We accept patches as plain text, MIME attachments or as uuencoded |
3641 | gzipped text. | |
c609719b | 3642 | |
2729af9d WD |
3643 | * If one logical set of modifications affects or creates several |
3644 | files, all these changes shall be submitted in a SINGLE patch file. | |
52f52c14 | 3645 | |
2729af9d WD |
3646 | * Changesets that contain different, unrelated modifications shall be |
3647 | submitted as SEPARATE patches, one patch per changeset. | |
8bde7f77 | 3648 | |
52f52c14 | 3649 | |
2729af9d | 3650 | Notes: |
c609719b | 3651 | |
2729af9d WD |
3652 | * Before sending the patch, run the MAKEALL script on your patched |
3653 | source tree and make sure that no errors or warnings are reported | |
3654 | for any of the boards. | |
c609719b | 3655 | |
2729af9d WD |
3656 | * Keep your modifications to the necessary minimum: A patch |
3657 | containing several unrelated changes or arbitrary reformats will be | |
3658 | returned with a request to re-formatting / split it. | |
c609719b | 3659 | |
2729af9d WD |
3660 | * If you modify existing code, make sure that your new code does not |
3661 | add to the memory footprint of the code ;-) Small is beautiful! | |
3662 | When adding new features, these should compile conditionally only | |
3663 | (using #ifdef), and the resulting code with the new feature | |
3664 | disabled must not need more memory than the old code without your | |
3665 | modification. | |
90dc6704 WD |
3666 | |
3667 | * Remember that there is a size limit of 40 kB per message on the | |
3668 | u-boot-users mailing list. Compression may help. |