Patch by Tom Guilliams, 20 Jun 2003:
[platform/kernel/u-boot.git] / README
1 #
2 # (C) Copyright 2000 - 2002
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 #
5 # See file CREDITS for list of people who contributed to this
6 # project.
7 #
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; either version 2 of
11 # the License, or (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 # MA 02111-1307 USA
22 #
23
24 Summary:
25 ========
26
27 This directory contains the source code for U-Boot, a boot loader for
28 Embedded boards based on PowerPC and ARM processors, which can be
29 installed in a boot ROM and used to initialize and test the hardware
30 or to download and run application code.
31
32 The development of U-Boot is closely related to Linux: some parts of
33 the source code originate in the Linux source tree, we have some
34 header files in common, and special provision has been made to
35 support booting of Linux images.
36
37 Some attention has been paid to make this software easily
38 configurable and extendable. For instance, all monitor commands are
39 implemented with the same call interface, so that it's very easy to
40 add new commands. Also, instead of permanently adding rarely used
41 code (for instance hardware test utilities) to the monitor, you can
42 load and run it dynamically.
43
44
45 Status:
46 =======
47
48 In general, all boards for which a configuration option exists in the
49 Makefile have been tested to some extent and can be considered
50 "working". In fact, many of them are used in production systems.
51
52 In case of problems see the CHANGELOG and CREDITS files to find out
53 who contributed the specific port.
54
55
56 Where to get help:
57 ==================
58
59 In case you have questions about, problems with or contributions for
60 U-Boot you should send a message to the U-Boot mailing list at
61 <u-boot-users@lists.sourceforge.net>. There is also an archive of
62 previous traffic on the mailing list - please search the archive
63 before asking FAQ's. Please see
64 http://lists.sourceforge.net/lists/listinfo/u-boot-users/
65
66
67 Where we come from:
68 ===================
69
70 - start from 8xxrom sources
71 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
72 - clean up code
73 - make it easier to add custom boards
74 - make it possible to add other [PowerPC] CPUs
75 - extend functions, especially:
76   * Provide extended interface to Linux boot loader
77   * S-Record download
78   * network boot
79   * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
80 - create ARMBoot project (http://sourceforge.net/projects/armboot)
81 - add other CPU families (starting with ARM)
82 - create U-Boot project (http://sourceforge.net/projects/u-boot)
83
84
85 Names and Spelling:
86 ===================
87
88 The "official" name of this project is "Das U-Boot". The spelling
89 "U-Boot" shall be used in all written text (documentation, comments
90 in source files etc.). Example:
91
92         This is the README file for the U-Boot project.
93
94 File names etc. shall be based on the string "u-boot". Examples:
95
96         include/asm-ppc/u-boot.h
97
98         #include <asm/u-boot.h>
99
100 Variable names, preprocessor constants etc. shall be either based on
101 the string "u_boot" or on "U_BOOT". Example:
102
103         U_BOOT_VERSION          u_boot_logo
104         IH_OS_U_BOOT            u_boot_hush_start
105
106
107 Versioning:
108 ===========
109
110 U-Boot uses a 3 level version number containing a version, a
111 sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
112 sub-version "34", and patchlevel "4".
113
114 The patchlevel is used to indicate certain stages of development
115 between released versions, i. e. officially released versions of
116 U-Boot will always have a patchlevel of "0".
117
118
119 Directory Hierarchy:
120 ====================
121
122 - board         Board dependend files
123 - common        Misc architecture independend functions
124 - cpu           CPU specific files
125 - disk          Code for disk drive partition handling
126 - doc           Documentation (don't expect too much)
127 - drivers       Common used device drivers
128 - dtt           Digital Thermometer and Thermostat drivers
129 - examples      Example code for standalone applications, etc.
130 - include       Header Files
131 - disk          Harddisk interface code
132 - net           Networking code
133 - ppc           Files generic to PowerPC architecture
134 - post          Power On Self Test
135 - post/arch             Symlink to architecture specific Power On Self Test
136 - post/arch-ppc         PowerPC architecture specific Power On Self Test
137 - post/cpu/mpc8260      MPC8260 CPU specific Power On Self Test
138 - post/cpu/mpc8xx       MPC8xx CPU specific Power On Self Test
139 - rtc           Real Time Clock drivers
140 - tools         Tools to build S-Record or U-Boot images, etc.
141
142 - cpu/74xx_7xx  Files specific to Motorola MPC74xx and 7xx CPUs
143 - cpu/mpc5xx    Files specific to Motorola MPC5xx  CPUs
144 - cpu/mpc8xx    Files specific to Motorola MPC8xx  CPUs
145 - cpu/mpc824x   Files specific to Motorola MPC824x CPUs
146 - cpu/mpc8260   Files specific to Motorola MPC8260 CPU
147 - cpu/ppc4xx    Files specific to IBM      4xx     CPUs
148
149 - board/LEOX/   Files specific to boards manufactured by The LEOX team
150 - board/LEOX/elpt860    Files specific to ELPT860 boards
151 - board/RPXClassic
152                 Files specific to RPXClassic boards
153 - board/RPXlite Files specific to RPXlite    boards
154 - board/at91rm9200dk Files specific to AT91RM9200DK boards
155 - board/c2mon   Files specific to c2mon      boards
156 - board/cmi     Files specific to cmi        boards
157 - board/cogent  Files specific to Cogent     boards
158                 (need further configuration)
159                 Files specific to CPCIISER4  boards
160 - board/cpu86   Files specific to CPU86      boards
161 - board/cray/   Files specific to boards manufactured by Cray
162 - board/cray/L1         Files specific to L1         boards
163 - board/cu824   Files specific to CU824      boards
164 - board/ebony   Files specific to IBM Ebony board
165 - board/eric    Files specific to ERIC       boards
166 - board/esd/    Files specific to boards manufactured by ESD
167 - board/esd/adciop      Files specific to ADCIOP     boards
168 - board/esd/ar405       Files specific to AR405      boards
169 - board/esd/canbt       Files specific to CANBT      boards
170 - board/esd/cpci405     Files specific to CPCI405    boards
171 - board/esd/cpciiser4   Files specific to CPCIISER4  boards
172 - board/esd/common      Common files for ESD boards
173 - board/esd/dasa_sim    Files specific to DASA_SIM   boards
174 - board/esd/du405       Files specific to DU405      boards
175 - board/esd/ocrtc       Files specific to OCRTC      boards
176 - board/esd/pci405      Files specific to PCI405     boards
177 - board/esteem192e
178                 Files specific to ESTEEM192E boards
179 - board/etx094  Files specific to ETX_094    boards
180 - board/evb64260
181                 Files specific to EVB64260   boards
182 - board/fads    Files specific to FADS       boards
183 - board/flagadm Files specific to FLAGADM    boards
184 - board/gen860t Files specific to GEN860T and GEN860T_SC    boards
185 - board/genietv Files specific to GENIETV    boards
186 - board/gth     Files specific to GTH        boards
187 - board/hermes  Files specific to HERMES     boards
188 - board/hymod   Files specific to HYMOD      boards
189 - board/icu862  Files specific to ICU862     boards
190 - board/ip860   Files specific to IP860      boards
191 - board/iphase4539
192                 Files specific to Interphase4539 boards
193 - board/ivm     Files specific to IVMS8/IVML24 boards
194 - board/lantec  Files specific to LANTEC     boards
195 - board/lwmon   Files specific to LWMON      boards
196 - board/mbx8xx  Files specific to MBX        boards
197 - board/mpc8260ads
198                 Files specific to MMPC8260ADS boards
199 - board/mpl/    Files specific to boards manufactured by MPL
200 - board/mpl/common      Common files for MPL boards
201 - board/mpl/pip405      Files specific to PIP405     boards
202 - board/mpl/mip405      Files specific to MIP405     boards
203 - board/musenki Files specific to MUSEKNI    boards
204 - board/mvs1    Files specific to MVS1       boards
205 - board/nx823   Files specific to NX823      boards
206 - board/oxc     Files specific to OXC        boards
207 - board/pcippc2 Files specific to PCIPPC2/PCIPPC6 boards
208 - board/pm826   Files specific to PM826      boards
209 - board/ppmc8260
210                 Files specific to PPMC8260   boards
211 - board/rpxsuper
212                 Files specific to RPXsuper   boards
213 - board/rsdproto
214                 Files specific to RSDproto   boards
215 - board/sandpoint
216                 Files specific to Sandpoint  boards
217 - board/sbc8260 Files specific to SBC8260    boards
218 - board/sacsng  Files specific to SACSng     boards
219 - board/siemens Files specific to boards manufactured by Siemens AG
220 - board/siemens/CCM     Files specific to CCM        boards
221 - board/siemens/IAD210  Files specific to IAD210     boards
222 - board/siemens/SCM     Files specific to SCM        boards
223 - board/siemens/pcu_e   Files specific to PCU_E      boards
224 - board/sixnet  Files specific to SIXNET     boards
225 - board/spd8xx  Files specific to SPD8xxTS   boards
226 - board/tqm8260 Files specific to TQM8260    boards
227 - board/tqm8xx  Files specific to TQM8xxL    boards
228 - board/w7o     Files specific to W7O        boards
229 - board/walnut405
230                 Files specific to Walnut405  boards
231 - board/westel/ Files specific to boards manufactured by Westel Wireless
232 - board/westel/amx860   Files specific to AMX860     boards
233 - board/utx8245 Files specific to UTX8245   boards
234
235 Software Configuration:
236 =======================
237
238 Configuration is usually done using C preprocessor defines; the
239 rationale behind that is to avoid dead code whenever possible.
240
241 There are two classes of configuration variables:
242
243 * Configuration _OPTIONS_:
244   These are selectable by the user and have names beginning with
245   "CONFIG_".
246
247 * Configuration _SETTINGS_:
248   These depend on the hardware etc. and should not be meddled with if
249   you don't know what you're doing; they have names beginning with
250   "CFG_".
251
252 Later we will add a configuration tool - probably similar to or even
253 identical to what's used for the Linux kernel. Right now, we have to
254 do the configuration by hand, which means creating some symbolic
255 links and editing some configuration files. We use the TQM8xxL boards
256 as an example here.
257
258
259 Selection of Processor Architecture and Board Type:
260 ---------------------------------------------------
261
262 For all supported boards there are ready-to-use default
263 configurations available; just type "make <board_name>_config".
264
265 Example: For a TQM823L module type:
266
267         cd u-boot
268         make TQM823L_config
269
270 For the Cogent platform, you need to specify the cpu type as well;
271 e.g. "make cogent_mpc8xx_config". And also configure the cogent
272 directory according to the instructions in cogent/README.
273
274
275 Configuration Options:
276 ----------------------
277
278 Configuration depends on the combination of board and CPU type; all
279 such information is kept in a configuration file
280 "include/configs/<board_name>.h".
281
282 Example: For a TQM823L module, all configuration settings are in
283 "include/configs/TQM823L.h".
284
285
286 Many of the options are named exactly as the corresponding Linux
287 kernel configuration options. The intention is to make it easier to
288 build a config tool - later.
289
290
291 The following options need to be configured:
292
293 - CPU Type:     Define exactly one of
294
295                 PowerPC based CPUs:
296                 -------------------
297                 CONFIG_MPC823,  CONFIG_MPC850,  CONFIG_MPC855,  CONFIG_MPC860
298         or      CONFIG_MPC5xx
299         or      CONFIG_MPC824X, CONFIG_MPC8260
300         or      CONFIG_IOP480
301         or      CONFIG_405GP
302         or      CONFIG_440
303         or      CONFIG_MPC74xx
304         or      CONFIG_750FX
305
306                 ARM based CPUs:
307                 ---------------
308                 CONFIG_SA1110
309                 CONFIG_ARM7
310                 CONFIG_PXA250
311
312
313 - Board Type:   Define exactly one of
314
315                 PowerPC based boards:
316                 ---------------------
317
318                 CONFIG_ADCIOP,     CONFIG_ICU862      CONFIG_RPXsuper,
319                 CONFIG_ADS860,     CONFIG_IP860,      CONFIG_SM850,
320                 CONFIG_AMX860,     CONFIG_IPHASE4539, CONFIG_SPD823TS,
321                 CONFIG_AR405,      CONFIG_IVML24,     CONFIG_SXNI855T,
322                 CONFIG_BAB7xx,     CONFIG_IVML24_128, CONFIG_Sandpoint8240,
323                 CONFIG_CANBT,      CONFIG_IVML24_256, CONFIG_Sandpoint8245,
324                 CONFIG_CCM,        CONFIG_IVMS8,      CONFIG_TQM823L,
325                 CONFIG_CPCI405,    CONFIG_IVMS8_128,  CONFIG_TQM850L,
326                 CONFIG_CPCI4052,   CONFIG_IVMS8_256,  CONFIG_TQM855L,
327                 CONFIG_CPCIISER4,  CONFIG_LANTEC,     CONFIG_TQM860L,
328                 CONFIG_CPU86,      CONFIG_MBX,        CONFIG_TQM8260,
329                 CONFIG_CRAYL1,     CONFIG_MBX860T,    CONFIG_TTTech,
330                 CONFIG_CU824,      CONFIG_MHPC,       CONFIG_UTX8245,
331                 CONFIG_DASA_SIM,   CONFIG_MIP405,     CONFIG_W7OLMC,
332                 CONFIG_DU405,      CONFIG_MOUSSE,     CONFIG_W7OLMG,
333                 CONFIG_ELPPC,      CONFIG_MPC8260ADS, CONFIG_WALNUT405,
334                 CONFIG_ERIC,       CONFIG_MUSENKI,    CONFIG_ZUMA,
335                 CONFIG_ESTEEM192E, CONFIG_MVS1,       CONFIG_c2mon,
336                 CONFIG_ETX094,     CONFIG_NX823,      CONFIG_cogent_mpc8260,
337                 CONFIG_EVB64260,   CONFIG_OCRTC,      CONFIG_cogent_mpc8xx,
338                 CONFIG_FADS823,    CONFIG_ORSG,       CONFIG_ep8260,
339                 CONFIG_FADS850SAR, CONFIG_OXC,        CONFIG_gw8260,
340                 CONFIG_FADS860T,   CONFIG_PCI405,     CONFIG_hermes,
341                 CONFIG_FLAGADM,    CONFIG_PCIPPC2,    CONFIG_hymod,
342                 CONFIG_FPS850L,    CONFIG_PCIPPC6,    CONFIG_lwmon,
343                 CONFIG_GEN860T,    CONFIG_PIP405,     CONFIG_pcu_e,
344                 CONFIG_GENIETV,    CONFIG_PM826,      CONFIG_ppmc8260,
345                 CONFIG_GTH,        CONFIG_RPXClassic, CONFIG_rsdproto,
346                 CONFIG_IAD210,     CONFIG_RPXlite,    CONFIG_sbc8260,
347                 CONFIG_EBONY,      CONFIG_sacsng,     CONFIG_FPS860L,
348                 CONFIG_V37,        CONFIG_ELPT860,    CONFIG_CMI,
349                 CONFIG_NETVIA,     CONFIG_RBC823
350
351                 ARM based boards:
352                 -----------------
353
354                 CONFIG_HHP_CRADLE,  CONFIG_DNP1110,    CONFIG_EP7312,
355                 CONFIG_IMPA7,       CONFIG_LART,       CONFIG_LUBBOCK,
356                 CONFIG_SHANNON,     CONFIG_SMDK2400,   CONFIG_SMDK2410,
357                 CONFIG_TRAB,        CONFIG_AT91RM9200DK
358
359
360 - CPU Module Type: (if CONFIG_COGENT is defined)
361                 Define exactly one of
362                 CONFIG_CMA286_60_OLD
363 --- FIXME --- not tested yet:
364                 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
365                 CONFIG_CMA287_23, CONFIG_CMA287_50
366
367 - Motherboard Type: (if CONFIG_COGENT is defined)
368                 Define exactly one of
369                 CONFIG_CMA101, CONFIG_CMA102
370
371 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
372                 Define one or more of
373                 CONFIG_CMA302
374
375 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
376                 Define one or more of
377                 CONFIG_LCD_HEARTBEAT    - update a character position on
378                                           the lcd display every second with
379                                           a "rotator" |\-/|\-/
380
381 - MPC824X Family Member (if CONFIG_MPC824X is defined)
382         Define exactly one of
383         CONFIG_MPC8240, CONFIG_MPC8245
384
385 - 8xx CPU Options: (if using an 8xx cpu)
386                 Define one or more of
387                 CONFIG_8xx_GCLK_FREQ    - if get_gclk_freq() can not work e.g.
388                                           no 32KHz reference PIT/RTC clock
389
390 - Clock Interface:
391                 CONFIG_CLOCKS_IN_MHZ
392
393                 U-Boot stores all clock information in Hz
394                 internally. For binary compatibility with older Linux
395                 kernels (which expect the clocks passed in the
396                 bd_info data to be in MHz) the environment variable
397                 "clocks_in_mhz" can be defined so that U-Boot
398                 converts clock data to MHZ before passing it to the
399                 Linux kernel.
400
401                 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
402                 "clocks_in_mhz=1" is  automatically  included  in  the
403                 default environment.
404
405 - Console Interface:
406                 Depending on board, define exactly one serial port
407                 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
408                 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
409                 console by defining CONFIG_8xx_CONS_NONE
410
411                 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
412                 port routines must be defined elsewhere
413                 (i.e. serial_init(), serial_getc(), ...)
414
415                 CONFIG_CFB_CONSOLE
416                 Enables console device for a color framebuffer. Needs following
417                 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
418                         VIDEO_FB_LITTLE_ENDIAN  graphic memory organisation
419                                                 (default big endian)
420                         VIDEO_HW_RECTFILL       graphic chip supports
421                                                 rectangle fill
422                                                 (cf. smiLynxEM)
423                         VIDEO_HW_BITBLT         graphic chip supports
424                                                 bit-blit (cf. smiLynxEM)
425                         VIDEO_VISIBLE_COLS      visible pixel columns
426                                                 (cols=pitch)
427                         VIDEO_VISIBLE_ROWS      visible pixel rows
428                         VIDEO_PIXEL_SIZE        bytes per pixel
429                         VIDEO_DATA_FORMAT       graphic data format
430                                                 (0-5, cf. cfb_console.c)
431                         VIDEO_FB_ADRS           framebuffer address
432                         VIDEO_KBD_INIT_FCT      keyboard int fct
433                                                 (i.e. i8042_kbd_init())
434                         VIDEO_TSTC_FCT          test char fct
435                                                 (i.e. i8042_tstc)
436                         VIDEO_GETC_FCT          get char fct
437                                                 (i.e. i8042_getc)
438                         CONFIG_CONSOLE_CURSOR   cursor drawing on/off
439                                                 (requires blink timer
440                                                 cf. i8042.c)
441                         CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
442                         CONFIG_CONSOLE_TIME     display time/date info in
443                                                 upper right corner
444                                                 (requires CFG_CMD_DATE)
445                         CONFIG_VIDEO_LOGO       display Linux logo in
446                                                 upper left corner
447                         CONFIG_VIDEO_BMP_LOGO   use bmp_logo.h instead of
448                                                 linux_logo.h for logo.
449                                                 Requires CONFIG_VIDEO_LOGO
450                         CONFIG_CONSOLE_EXTRA_INFO
451                                                 addional board info beside
452                                                 the logo
453
454                 When CONFIG_CFB_CONSOLE is defined, video console is
455                 default i/o. Serial console can be forced with
456                 environment 'console=serial'.
457
458 - Console Baudrate:
459                 CONFIG_BAUDRATE - in bps
460                 Select one of the baudrates listed in
461                 CFG_BAUDRATE_TABLE, see below.
462
463 - Interrupt driven serial port input:
464                 CONFIG_SERIAL_SOFTWARE_FIFO
465
466                 PPC405GP only.
467                 Use an interrupt handler for receiving data on the
468                 serial port. It also enables using hardware handshake
469                 (RTS/CTS) and UART's built-in FIFO. Set the number of
470                 bytes the interrupt driven input buffer should have.
471
472                 Set to 0 to disable this feature (this is the default).
473                 This will also disable hardware handshake.
474
475 - Console UART Number:
476                 CONFIG_UART1_CONSOLE
477
478                 IBM PPC4xx only.
479                 If defined internal UART1 (and not UART0) is used
480                 as default U-Boot console.
481
482 - Boot Delay:   CONFIG_BOOTDELAY - in seconds
483                 Delay before automatically booting the default image;
484                 set to -1 to disable autoboot.
485
486                 See doc/README.autoboot for these options that
487                 work with CONFIG_BOOTDELAY. None are required.
488                 CONFIG_BOOT_RETRY_TIME
489                 CONFIG_BOOT_RETRY_MIN
490                 CONFIG_AUTOBOOT_KEYED
491                 CONFIG_AUTOBOOT_PROMPT
492                 CONFIG_AUTOBOOT_DELAY_STR
493                 CONFIG_AUTOBOOT_STOP_STR
494                 CONFIG_AUTOBOOT_DELAY_STR2
495                 CONFIG_AUTOBOOT_STOP_STR2
496                 CONFIG_ZERO_BOOTDELAY_CHECK
497                 CONFIG_RESET_TO_RETRY
498
499 - Autoboot Command:
500                 CONFIG_BOOTCOMMAND
501                 Only needed when CONFIG_BOOTDELAY is enabled;
502                 define a command string that is automatically executed
503                 when no character is read on the console interface
504                 within "Boot Delay" after reset.
505
506                 CONFIG_BOOTARGS
507                 This can be used to pass arguments to the bootm
508                 command. The value of CONFIG_BOOTARGS goes into the
509                 environment value "bootargs".
510
511                 CONFIG_RAMBOOT and CONFIG_NFSBOOT
512                 The value of these goes into the environment as
513                 "ramboot" and "nfsboot" respectively, and can be used
514                 as a convenience, when switching between booting from
515                 ram and nfs.
516
517 - Pre-Boot Commands:
518                 CONFIG_PREBOOT
519
520                 When this option is #defined, the existence of the
521                 environment variable "preboot" will be checked
522                 immediately before starting the CONFIG_BOOTDELAY
523                 countdown and/or running the auto-boot command resp.
524                 entering interactive mode.
525
526                 This feature is especially useful when "preboot" is
527                 automatically generated or modified. For an example
528                 see the LWMON board specific code: here "preboot" is
529                 modified when the user holds down a certain
530                 combination of keys on the (special) keyboard when
531                 booting the systems
532
533 - Serial Download Echo Mode:
534                 CONFIG_LOADS_ECHO
535                 If defined to 1, all characters received during a
536                 serial download (using the "loads" command) are
537                 echoed back. This might be needed by some terminal
538                 emulations (like "cu"), but may as well just take
539                 time on others. This setting #define's the initial
540                 value of the "loads_echo" environment variable.
541
542 - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
543                 CONFIG_KGDB_BAUDRATE
544                 Select one of the baudrates listed in
545                 CFG_BAUDRATE_TABLE, see below.
546
547 - Monitor Functions:
548                 CONFIG_COMMANDS
549                 Most monitor functions can be selected (or
550                 de-selected) by adjusting the definition of
551                 CONFIG_COMMANDS; to select individual functions,
552                 #define CONFIG_COMMANDS by "OR"ing any of the
553                 following values:
554
555                 #define enables commands:
556                 -------------------------
557                 CFG_CMD_ASKENV  * ask for env variable
558                 CFG_CMD_BDI       bdinfo
559                 CFG_CMD_BEDBUG    Include BedBug Debugger
560                 CFG_CMD_BOOTD     bootd
561                 CFG_CMD_CACHE     icache, dcache
562                 CFG_CMD_CONSOLE   coninfo
563                 CFG_CMD_DATE    * support for RTC, date/time...
564                 CFG_CMD_DHCP      DHCP support
565                 CFG_CMD_ECHO    * echo arguments
566                 CFG_CMD_EEPROM  * EEPROM read/write support
567                 CFG_CMD_ELF       bootelf, bootvx
568                 CFG_CMD_ENV       saveenv
569                 CFG_CMD_FDC     * Floppy Disk Support
570                 CFG_CMD_FAT       FAT partition support
571                 CFG_CMD_FDOS    * Dos diskette Support
572                 CFG_CMD_FLASH     flinfo, erase, protect
573                 CFG_CMD_FPGA      FPGA device initialization support
574                 CFG_CMD_I2C     * I2C serial bus support
575                 CFG_CMD_IDE     * IDE harddisk support
576                 CFG_CMD_IMI       iminfo
577                 CFG_CMD_IMMAP   * IMMR dump support
578                 CFG_CMD_IRQ     * irqinfo
579                 CFG_CMD_KGDB    * kgdb
580                 CFG_CMD_LOADB     loadb
581                 CFG_CMD_LOADS     loads
582                 CFG_CMD_MEMORY    md, mm, nm, mw, cp, cmp, crc, base,
583                                   loop, mtest
584                 CFG_CMD_MMC       MMC memory mapped support
585                 CFG_CMD_MII       MII utility commands
586                 CFG_CMD_NET       bootp, tftpboot, rarpboot
587                 CFG_CMD_PCI     * pciinfo
588                 CFG_CMD_PCMCIA  * PCMCIA support
589                 CFG_CMD_REGINFO * Register dump
590                 CFG_CMD_RUN       run command in env variable
591                 CFG_CMD_SCSI    * SCSI Support
592                 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
593                 CFG_CMD_SPI     * SPI serial bus support
594                 CFG_CMD_USB     * USB support
595                 CFG_CMD_BSP     * Board SPecific functions
596                 -----------------------------------------------
597                 CFG_CMD_ALL     all
598
599                 CFG_CMD_DFL     Default configuration; at the moment
600                                 this is includes all commands, except
601                                 the ones marked with "*" in the list
602                                 above.
603
604                 If you don't define CONFIG_COMMANDS it defaults to
605                 CFG_CMD_DFL in include/cmd_confdefs.h. A board can
606                 override the default settings in the respective
607                 include file.
608
609                 EXAMPLE: If you want all functions except of network
610                 support you can write:
611
612                 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
613
614
615         Note:   Don't enable the "icache" and "dcache" commands
616                 (configuration option CFG_CMD_CACHE) unless you know
617                 what you (and your U-Boot users) are doing. Data
618                 cache cannot be enabled on systems like the 8xx or
619                 8260 (where accesses to the IMMR region must be
620                 uncached), and it cannot be disabled on all other
621                 systems where we (mis-) use the data cache to hold an
622                 initial stack and some data.
623
624
625                 XXX - this list needs to get updated!
626
627 - Watchdog:
628                 CONFIG_WATCHDOG
629                 If this variable is defined, it enables watchdog
630                 support. There must support in the platform specific
631                 code for a watchdog. For the 8xx and 8260 CPUs, the
632                 SIU Watchdog feature is enabled in the SYPCR
633                 register.
634
635 - U-Boot Version:
636                 CONFIG_VERSION_VARIABLE
637                 If this variable is defined, an environment variable
638                 named "ver" is created by U-Boot showing the U-Boot
639                 version as printed by the "version" command.
640                 This variable is readonly.
641
642 - Real-Time Clock:
643
644                 When CFG_CMD_DATE is selected, the type of the RTC
645                 has to be selected, too. Define exactly one of the
646                 following options:
647
648                 CONFIG_RTC_MPC8xx       - use internal RTC of MPC8xx
649                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
650                 CONFIG_RTC_MC146818     - use MC146818 RTC
651                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
652                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
653                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
654                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
655
656 - Timestamp Support:
657
658                 When CONFIG_TIMESTAMP is selected, the timestamp
659                 (date and time) of an image is printed by image
660                 commands like bootm or iminfo. This option is
661                 automatically enabled when you select CFG_CMD_DATE .
662
663 - Partition Support:
664                 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
665                 and/or CONFIG_ISO_PARTITION
666
667                 If IDE or SCSI support  is  enabled  (CFG_CMD_IDE  or
668                 CFG_CMD_SCSI) you must configure support for at least
669                 one partition type as well.
670
671 - IDE Reset method:
672                 CONFIG_IDE_RESET_ROUTINE
673
674                 Set this to define that instead of a reset Pin, the
675                 routine ide_set_reset(int idereset) will be used.
676
677 - ATAPI Support:
678                 CONFIG_ATAPI
679
680                 Set this to enable ATAPI support.
681
682 - SCSI Support:
683                 At the moment only there is only support for the
684                 SYM53C8XX SCSI controller; define
685                 CONFIG_SCSI_SYM53C8XX to enable it.
686
687                 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
688                 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
689                 CFG_SCSI_MAX_LUN] can be adjusted to define the
690                 maximum numbers of LUNs, SCSI ID's and target
691                 devices.
692                 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
693
694 - NETWORK Support (PCI):
695                 CONFIG_E1000
696                 Support for Intel 8254x gigabit chips.
697
698                 CONFIG_EEPRO100
699                 Support for Intel 82557/82559/82559ER chips.
700                 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
701                 write routine for first time initialisation.
702
703                 CONFIG_TULIP
704                 Support for Digital 2114x chips.
705                 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
706                 modem chip initialisation (KS8761/QS6611).
707
708                 CONFIG_NATSEMI
709                 Support for National dp83815 chips.
710
711                 CONFIG_NS8382X
712                 Support for National dp8382[01] gigabit chips.
713
714 - NETWORK Support (other):
715
716                 CONFIG_DRIVER_LAN91C96
717                 Support for SMSC's LAN91C96 chips.
718
719                         CONFIG_LAN91C96_BASE
720                         Define this to hold the physical address
721                         of the LAN91C96's I/O space
722
723                         CONFIG_LAN91C96_USE_32_BIT
724                         Define this to enable 32 bit addressing
725
726 - USB Support:
727                 At the moment only the UHCI host controller is
728                 supported (PIP405, MIP405); define
729                 CONFIG_USB_UHCI to enable it.
730                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
731                 end define CONFIG_USB_STORAGE to enable the USB
732                 storage devices.
733                 Note:
734                 Supported are USB Keyboards and USB Floppy drives
735                 (TEAC FD-05PUB).
736
737 - MMC Support:
738                 The MMC controller on the Intel PXA is supported. To
739                 enable this define CONFIG_MMC. The MMC can be 
740                 accessed from the boot prompt by mapping the device 
741                 to physical memory similar to flash. Command line is
742                 enabled with CFG_CMD_MMC. The MMC driver also works with
743                 the FAT fs. This is enabled with CFG_CMD_FAT. 
744
745 - Keyboard Support:
746                 CONFIG_ISA_KEYBOARD
747
748                 Define this to enable standard (PC-Style) keyboard
749                 support
750
751                 CONFIG_I8042_KBD
752                 Standard PC keyboard driver with US (is default) and
753                 GERMAN key layout (switch via environment 'keymap=de') support.
754                 Export function i8042_kbd_init, i8042_tstc and i8042_getc
755                 for cfb_console. Supports cursor blinking.
756
757 - Video support:
758                 CONFIG_VIDEO
759
760                 Define this to enable video support (for output to
761                 video).
762
763                 CONFIG_VIDEO_CT69000
764
765                 Enable Chips & Technologies 69000 Video chip
766
767                 CONFIG_VIDEO_SMI_LYNXEM
768                 Enable Silicon Motion SMI 712/710/810 Video chip
769                 Videomode are selected via environment 'videomode' with
770                 standard LiLo mode numbers.
771                 Following modes are supported  (* is default):
772
773                             800x600  1024x768  1280x1024
774               256  (8bit)     303*      305       307
775             65536 (16bit)     314       317       31a
776         16,7 Mill (24bit)     315       318       31b
777                 (i.e. setenv videomode 317; saveenv; reset;)
778
779                 CONFIG_VIDEO_SED13806
780                 Enable Epson SED13806 driver. This driver supports 8bpp
781                 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
782                 or CONFIG_VIDEO_SED13806_16BPP
783
784 - Keyboard Support:
785                 CONFIG_KEYBOARD
786
787                 Define this to enable a custom keyboard support.
788                 This simply calls drv_keyboard_init() which must be
789                 defined in your board-specific files.
790                 The only board using this so far is RBC823.
791
792 - LCD Support:  CONFIG_LCD
793
794                 Define this to enable LCD support (for output to LCD
795                 display); also select one of the supported displays
796                 by defining one of these:
797
798                 CONFIG_NEC_NL6648AC33:
799
800                         NEC NL6648AC33-18. Active, color, single scan.
801
802                 CONFIG_NEC_NL6648BC20
803
804                         NEC NL6648BC20-08. 6.5", 640x480.
805                         Active, color, single scan.
806
807                 CONFIG_SHARP_16x9
808
809                         Sharp 320x240. Active, color, single scan.
810                         It isn't 16x9, and I am not sure what it is.
811
812                 CONFIG_SHARP_LQ64D341
813
814                         Sharp LQ64D341 display, 640x480.
815                         Active, color, single scan.
816
817                 CONFIG_HLD1045
818
819                         HLD1045 display, 640x480.
820                         Active, color, single scan.
821
822                 CONFIG_OPTREX_BW
823
824                         Optrex   CBL50840-2 NF-FW 99 22 M5
825                         or
826                         Hitachi  LMG6912RPFC-00T
827                         or
828                         Hitachi  SP14Q002
829
830                         320x240. Black & white.
831
832                 Normally display is black on white background; define
833                 CFG_WHITE_ON_BLACK to get it inverted.
834
835 - Spash Screen Support: CONFIG_SPLASH_SCREEN
836
837                 If this option is set, the environment is checked for
838                 a variable "splashimage". If found, the usual display
839                 of logo, copyright and system information on the LCD
840                 is supressed and the BMP image at the address
841                 specified in "splashimage" is loaded instead. The
842                 console is redirected to the "nulldev", too. This
843                 allows for a "silent" boot where a splash screen is
844                 loaded very quickly after power-on.
845
846
847 - Ethernet address:
848                 CONFIG_ETHADDR
849                 CONFIG_ETH2ADDR
850                 CONFIG_ETH3ADDR
851
852                 Define a default value for ethernet address to use
853                 for the respective ethernet interface, in case this
854                 is not determined automatically.
855
856 - IP address:
857                 CONFIG_IPADDR
858
859                 Define a default value for the IP address to use for
860                 the default ethernet interface, in case this is not
861                 determined through e.g. bootp.
862
863 - Server IP address:
864                 CONFIG_SERVERIP
865
866                 Defines a default value for theIP address of a TFTP
867                 server to contact when using the "tftboot" command.
868
869 - BOOTP Recovery Mode:
870                 CONFIG_BOOTP_RANDOM_DELAY
871
872                 If you have many targets in a network that try to
873                 boot using BOOTP, you may want to avoid that all
874                 systems send out BOOTP requests at precisely the same
875                 moment (which would happen for instance at recovery
876                 from a power failure, when all systems will try to
877                 boot, thus flooding the BOOTP server. Defining
878                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
879                 inserted before sending out BOOTP requests. The
880                 following delays are insterted then:
881
882                 1st BOOTP request:      delay 0 ... 1 sec
883                 2nd BOOTP request:      delay 0 ... 2 sec
884                 3rd BOOTP request:      delay 0 ... 4 sec
885                 4th and following
886                 BOOTP requests:         delay 0 ... 8 sec
887
888 - Status LED:   CONFIG_STATUS_LED
889
890                 Several configurations allow to display the current
891                 status using a LED. For instance, the LED will blink
892                 fast while running U-Boot code, stop blinking as
893                 soon as a reply to a BOOTP request was received, and
894                 start blinking slow once the Linux kernel is running
895                 (supported by a status LED driver in the Linux
896                 kernel). Defining CONFIG_STATUS_LED enables this
897                 feature in U-Boot.
898
899 - CAN Support:  CONFIG_CAN_DRIVER
900
901                 Defining CONFIG_CAN_DRIVER enables CAN driver support
902                 on those systems that support this (optional)
903                 feature, like the TQM8xxL modules.
904
905 - I2C Support:  CONFIG_HARD_I2C | CONFIG_SOFT_I2C
906
907                 Enables I2C serial bus commands.  If this is selected,
908                 either CONFIG_HARD_I2C or CONFIG_SOFT_I2C must be defined
909                 to include the appropriate I2C driver.
910
911                 See also: common/cmd_i2c.c for a description of the
912                 command line interface.
913
914
915                 CONFIG_HARD_I2C
916
917                 Selects the CPM hardware driver for I2C.
918
919                 CONFIG_SOFT_I2C
920
921                 Use software (aka bit-banging) driver instead of CPM
922                 or similar hardware support for I2C.  This is configured
923                 via the following defines.
924
925                 I2C_INIT
926
927                 (Optional). Any commands necessary to enable I2C
928                 controller or configure ports.
929
930                 I2C_PORT
931
932                 (Only for MPC8260 CPU). The I/O port to use (the code
933                 assumes both bits are on the same port). Valid values
934                 are 0..3 for ports A..D.
935
936                 I2C_ACTIVE
937
938                 The code necessary to make the I2C data line active
939                 (driven).  If the data line is open collector, this
940                 define can be null.
941
942                 I2C_TRISTATE
943
944                 The code necessary to make the I2C data line tri-stated
945                 (inactive).  If the data line is open collector, this
946                 define can be null.
947
948                 I2C_READ
949
950                 Code that returns TRUE if the I2C data line is high,
951                 FALSE if it is low.
952
953                 I2C_SDA(bit)
954
955                 If <bit> is TRUE, sets the I2C data line high. If it
956                 is FALSE, it clears it (low).
957
958                 I2C_SCL(bit)
959
960                 If <bit> is TRUE, sets the I2C clock line high. If it
961                 is FALSE, it clears it (low).
962
963                 I2C_DELAY
964
965                 This delay is invoked four times per clock cycle so this
966                 controls the rate of data transfer.  The data rate thus
967                 is 1 / (I2C_DELAY * 4).
968
969                 CFG_I2C_INIT_BOARD
970
971                 When a board is reset during an i2c bus transfer
972                 chips might think that the current transfer is still
973                 in progress. On some boards it is possible to access
974                 the i2c SCLK line directly, either by using the
975                 processor pin as a GPIO or by having a second pin
976                 connected to the bus. If this option is defined a
977                 custom i2c_init_board() routine in boards/xxx/board.c
978                 is run early in the boot sequence.
979
980 - SPI Support:  CONFIG_SPI
981
982                 Enables SPI driver (so far only tested with
983                 SPI EEPROM, also an instance works with Crystal A/D and
984                 D/As on the SACSng board)
985
986                 CONFIG_SPI_X
987
988                 Enables extended (16-bit) SPI EEPROM addressing.
989                 (symmetrical to CONFIG_I2C_X)
990
991                 CONFIG_SOFT_SPI
992
993                 Enables a software (bit-bang) SPI driver rather than
994                 using hardware support. This is a general purpose
995                 driver that only requires three general I/O port pins
996                 (two outputs, one input) to function. If this is
997                 defined, the board configuration must define several
998                 SPI configuration items (port pins to use, etc). For
999                 an example, see include/configs/sacsng.h.
1000
1001 - FPGA Support: CONFIG_FPGA_COUNT
1002
1003                 Specify the number of FPGA devices to support.
1004
1005                 CONFIG_FPGA
1006
1007                 Used to specify the types of FPGA devices. For
1008                 example,
1009                 #define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1010
1011                 CFG_FPGA_PROG_FEEDBACK
1012
1013                 Enable printing of hash marks during FPGA
1014                 configuration.
1015
1016                 CFG_FPGA_CHECK_BUSY
1017
1018                 Enable checks on FPGA configuration interface busy
1019                 status by the configuration function. This option
1020                 will require a board or device specific function to
1021                 be written.
1022
1023                 CONFIG_FPGA_DELAY
1024
1025                 If defined, a function that provides delays in the
1026                 FPGA configuration driver.
1027
1028                 CFG_FPGA_CHECK_CTRLC
1029
1030                 Allow Control-C to interrupt FPGA configuration
1031
1032                 CFG_FPGA_CHECK_ERROR
1033
1034                 Check for configuration errors during FPGA bitfile
1035                 loading. For example, abort during Virtex II
1036                 configuration if the INIT_B line goes low (which
1037                 indicated a CRC error).
1038
1039                 CFG_FPGA_WAIT_INIT
1040
1041                 Maximum time to wait for the INIT_B line to deassert
1042                 after PROB_B has been deasserted during a Virtex II
1043                 FPGA configuration sequence. The default time is 500 mS.
1044
1045                 CFG_FPGA_WAIT_BUSY
1046
1047                 Maximum time to wait for BUSY to deassert during
1048                 Virtex II FPGA configuration. The default is 5 mS.
1049
1050                 CFG_FPGA_WAIT_CONFIG
1051
1052                 Time to wait after FPGA configuration. The default is
1053                 200 mS.
1054
1055 - FPGA Support: CONFIG_FPGA_COUNT
1056
1057                 Specify the number of FPGA devices to support.
1058
1059                 CONFIG_FPGA
1060
1061                 Used to specify the types of FPGA devices.  For example,
1062                 #define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1063
1064                 CFG_FPGA_PROG_FEEDBACK
1065
1066                 Enable printing of hash marks during FPGA configuration.
1067
1068                 CFG_FPGA_CHECK_BUSY
1069
1070                 Enable checks on FPGA configuration interface busy
1071                 status by the configuration function. This option
1072                 will require a board or device specific function to
1073                 be written.
1074
1075                 CONFIG_FPGA_DELAY
1076
1077                 If defined, a function that provides delays in the FPGA
1078                 configuration driver.
1079
1080                 CFG_FPGA_CHECK_CTRLC
1081                 Allow Control-C to interrupt FPGA configuration
1082
1083                 CFG_FPGA_CHECK_ERROR
1084
1085                 Check for configuration errors during FPGA bitfile
1086                 loading. For example, abort during Virtex II
1087                 configuration if the INIT_B line goes low (which
1088                 indicated a CRC error).
1089
1090                 CFG_FPGA_WAIT_INIT
1091
1092                 Maximum time to wait for the INIT_B line to deassert
1093                 after PROB_B has been deasserted during a Virtex II
1094                 FPGA configuration sequence. The default time is 500
1095                 mS.
1096
1097                 CFG_FPGA_WAIT_BUSY
1098
1099                 Maximum time to wait for BUSY to deassert during
1100                 Virtex II FPGA configuration. The default is 5 mS.
1101
1102                 CFG_FPGA_WAIT_CONFIG
1103
1104                 Time to wait after FPGA configuration. The default is
1105                 200 mS.
1106
1107 - Configuration Management:
1108                 CONFIG_IDENT_STRING
1109
1110                 If defined, this string will be added to the U-Boot
1111                 version information (U_BOOT_VERSION)
1112
1113 - Vendor Parameter Protection:
1114
1115                 U-Boot considers the values of the environment
1116                 variables "serial#" (Board Serial Number) and
1117                 "ethaddr" (Ethernet Address) to bb parameters that
1118                 are set once by the board vendor / manufacturer, and
1119                 protects these variables from casual modification by
1120                 the user. Once set, these variables are read-only,
1121                 and write or delete attempts are rejected. You can
1122                 change this behviour:
1123
1124                 If CONFIG_ENV_OVERWRITE is #defined in your config
1125                 file, the write protection for vendor parameters is
1126                 completely disabled. Anybody can change or delete
1127                 these parameters.
1128
1129                 Alternatively, if you #define _both_ CONFIG_ETHADDR
1130                 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1131                 ethernet address is installed in the environment,
1132                 which can be changed exactly ONCE by the user. [The
1133                 serial# is unaffected by this, i. e. it remains
1134                 read-only.]
1135
1136 - Protected RAM:
1137                 CONFIG_PRAM
1138
1139                 Define this variable to enable the reservation of
1140                 "protected RAM", i. e. RAM which is not overwritten
1141                 by U-Boot. Define CONFIG_PRAM to hold the number of
1142                 kB you want to reserve for pRAM. You can overwrite
1143                 this default value by defining an environment
1144                 variable "pram" to the number of kB you want to
1145                 reserve. Note that the board info structure will
1146                 still show the full amount of RAM. If pRAM is
1147                 reserved, a new environment variable "mem" will
1148                 automatically be defined to hold the amount of
1149                 remaining RAM in a form that can be passed as boot
1150                 argument to Linux, for instance like that:
1151
1152                         setenv bootargs ... mem=\$(mem)
1153                         saveenv
1154
1155                 This way you can tell Linux not to use this memory,
1156                 either, which results in a memory region that will
1157                 not be affected by reboots.
1158
1159                 *WARNING* If your board configuration uses automatic
1160                 detection of the RAM size, you must make sure that
1161                 this memory test is non-destructive. So far, the
1162                 following board configurations are known to be
1163                 "pRAM-clean":
1164
1165                         ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1166                         HERMES, IP860, RPXlite, LWMON, LANTEC,
1167                         PCU_E, FLAGADM, TQM8260
1168
1169 - Error Recovery:
1170                 CONFIG_PANIC_HANG
1171
1172                 Define this variable to stop the system in case of a
1173                 fatal error, so that you have to reset it manually.
1174                 This is probably NOT a good idea for an embedded
1175                 system where you want to system to reboot
1176                 automatically as fast as possible, but it may be
1177                 useful during development since you can try to debug
1178                 the conditions that lead to the situation.
1179
1180                 CONFIG_NET_RETRY_COUNT
1181
1182                 This variable defines the number of retries for
1183                 network operations like ARP, RARP, TFTP, or BOOTP
1184                 before giving up the operation. If not defined, a
1185                 default value of 5 is used.
1186
1187 - Command Interpreter:
1188                 CFG_HUSH_PARSER
1189
1190                 Define this variable to enable the "hush" shell (from
1191                 Busybox) as command line interpreter, thus enabling
1192                 powerful command line syntax like
1193                 if...then...else...fi conditionals or `&&' and '||'
1194                 constructs ("shell scripts").
1195
1196                 If undefined, you get the old, much simpler behaviour
1197                 with a somewhat smaller memory footprint.
1198
1199
1200                 CFG_PROMPT_HUSH_PS2
1201
1202                 This defines the secondary prompt string, which is
1203                 printed when the command interpreter needs more input
1204                 to complete a command. Usually "> ".
1205
1206         Note:
1207
1208                 In the current implementation, the local variables
1209                 space and global environment variables space are
1210                 separated. Local variables are those you define by
1211                 simply typing `name=value'. To access a local
1212                 variable later on, you have write `$name' or
1213                 `${name}'; to execute the contents of a variable
1214                 directly type `$name' at the command prompt.
1215
1216                 Global environment variables are those you use
1217                 setenv/printenv to work with. To run a command stored
1218                 in such a variable, you need to use the run command,
1219                 and you must not use the '$' sign to access them.
1220
1221                 To store commands and special characters in a
1222                 variable, please use double quotation marks
1223                 surrounding the whole text of the variable, instead
1224                 of the backslashes before semicolons and special
1225                 symbols.
1226
1227 - Default Environment
1228                 CONFIG_EXTRA_ENV_SETTINGS
1229
1230                 Define this to contain any number of null terminated
1231                 strings (variable = value pairs) that will be part of
1232                 the default enviroment compiled into the boot image.
1233
1234                 For example, place something like this in your
1235                 board's config file:
1236
1237                 #define CONFIG_EXTRA_ENV_SETTINGS \
1238                         "myvar1=value1\0" \
1239                         "myvar2=value2\0"
1240
1241                 Warning: This method is based on knowledge about the
1242                 internal format how the environment is stored by the
1243                 U-Boot code. This is NOT an official, exported
1244                 interface! Although it is unlikely that this format
1245                 will change soon, but there is no guarantee either.
1246                 You better know what you are doing here.
1247
1248                 Note: overly (ab)use of the default environment is
1249                 discouraged. Make sure to check other ways to preset
1250                 the environment like the autoscript function or the
1251                 boot command first.
1252
1253 - DataFlash Support
1254                 CONFIG_HAS_DATAFLASH
1255
1256                 Defining this option enables DataFlash features and
1257                 allows to read/write in Dataflash via the standard
1258                 commands cp, md...
1259
1260 - Show boot progress
1261                 CONFIG_SHOW_BOOT_PROGRESS
1262
1263                 Defining this option allows to add some board-
1264                 specific code (calling a user-provided function
1265                 "show_boot_progress(int)") that enables you to show
1266                 the system's boot progress on some display (for
1267                 example, some LED's) on your board. At the moment,
1268                 the following checkpoints are implemented:
1269
1270   Arg   Where                   When
1271     1   common/cmd_bootm.c      before attempting to boot an image
1272    -1   common/cmd_bootm.c      Image header has bad     magic number
1273     2   common/cmd_bootm.c      Image header has correct magic number
1274    -2   common/cmd_bootm.c      Image header has bad     checksum
1275     3   common/cmd_bootm.c      Image header has correct checksum
1276    -3   common/cmd_bootm.c      Image data   has bad     checksum
1277     4   common/cmd_bootm.c      Image data   has correct checksum
1278    -4   common/cmd_bootm.c      Image is for unsupported architecture
1279     5   common/cmd_bootm.c      Architecture check OK
1280    -5   common/cmd_bootm.c      Wrong Image Type (not kernel, multi, standalone)
1281     6   common/cmd_bootm.c      Image Type check OK
1282    -6   common/cmd_bootm.c      gunzip uncompression error
1283    -7   common/cmd_bootm.c      Unimplemented compression type
1284     7   common/cmd_bootm.c      Uncompression OK
1285    -8   common/cmd_bootm.c      Wrong Image Type (not kernel, multi, standalone)
1286     8   common/cmd_bootm.c      Image Type check OK
1287    -9   common/cmd_bootm.c      Unsupported OS (not Linux, BSD, VxWorks, QNX)
1288     9   common/cmd_bootm.c      Start initial ramdisk verification
1289   -10   common/cmd_bootm.c      Ramdisk header has bad     magic number
1290   -11   common/cmd_bootm.c      Ramdisk header has bad     checksum
1291    10   common/cmd_bootm.c      Ramdisk header is OK
1292   -12   common/cmd_bootm.c      Ramdisk data   has bad     checksum
1293    11   common/cmd_bootm.c      Ramdisk data   has correct checksum
1294    12   common/cmd_bootm.c      Ramdisk verification complete, start loading
1295   -13   common/cmd_bootm.c      Wrong Image Type (not PPC Linux Ramdisk)
1296    13   common/cmd_bootm.c      Start multifile image verification
1297    14   common/cmd_bootm.c      No initial ramdisk, no multifile, continue.
1298    15   common/cmd_bootm.c      All preparation done, transferring control to OS
1299
1300    -1   common/cmd_doc.c        Bad usage of "doc" command
1301    -1   common/cmd_doc.c        No boot device
1302    -1   common/cmd_doc.c        Unknown Chip ID on boot device
1303    -1   common/cmd_doc.c        Read Error on boot device
1304    -1   common/cmd_doc.c        Image header has bad magic number
1305
1306    -1   common/cmd_ide.c        Bad usage of "ide" command
1307    -1   common/cmd_ide.c        No boot device
1308    -1   common/cmd_ide.c        Unknown boot device
1309    -1   common/cmd_ide.c        Unknown partition table
1310    -1   common/cmd_ide.c        Invalid partition type
1311    -1   common/cmd_ide.c        Read Error on boot device
1312    -1   common/cmd_ide.c        Image header has bad magic number
1313
1314    -1   common/cmd_nvedit.c     Environment not changable, but has bad CRC
1315
1316
1317 Modem Support:
1318 --------------
1319
1320 [so far only for SMDK2400 and TRAB boards]
1321
1322 - Modem support endable:
1323                 CONFIG_MODEM_SUPPORT
1324
1325 - RTS/CTS Flow control enable:
1326                 CONFIG_HWFLOW
1327
1328 - Modem debug support:
1329                 CONFIG_MODEM_SUPPORT_DEBUG
1330
1331                 Enables debugging stuff (char screen[1024], dbg())
1332                 for modem support. Useful only with BDI2000.
1333
1334 - General:
1335
1336                 In the target system modem support is enabled when a
1337                 specific key (key combination) is pressed during
1338                 power-on. Otherwise U-Boot will boot normally
1339                 (autoboot). The key_pressed() fuction is called from
1340                 board_init(). Currently key_pressed() is a dummy
1341                 function, returning 1 and thus enabling modem
1342                 initialization.
1343
1344                 If there are no modem init strings in the
1345                 environment, U-Boot proceed to autoboot; the
1346                 previous output (banner, info printfs) will be
1347                 supressed, though.
1348
1349                 See also: doc/README.Modem
1350
1351
1352
1353
1354 Configuration Settings:
1355 -----------------------
1356
1357 - CFG_LONGHELP: Defined when you want long help messages included;
1358                 undefine this when you're short of memory.
1359
1360 - CFG_PROMPT:   This is what U-Boot prints on the console to
1361                 prompt for user input.
1362
1363 - CFG_CBSIZE:   Buffer size for input from the Console
1364
1365 - CFG_PBSIZE:   Buffer size for Console output
1366
1367 - CFG_MAXARGS:  max. Number of arguments accepted for monitor commands
1368
1369 - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1370                 the application (usually a Linux kernel) when it is
1371                 booted
1372
1373 - CFG_BAUDRATE_TABLE:
1374                 List of legal baudrate settings for this board.
1375
1376 - CFG_CONSOLE_INFO_QUIET
1377                 Suppress display of console information at boot.
1378
1379 - CFG_CONSOLE_IS_IN_ENV
1380                 If the board specific function
1381                         extern int overwrite_console (void);
1382                 returns 1, the stdin, stderr and stdout are switched to the
1383                 serial port, else the settings in the environment are used.
1384
1385 - CFG_CONSOLE_OVERWRITE_ROUTINE
1386                 Enable the call to overwrite_console().
1387
1388 - CFG_CONSOLE_ENV_OVERWRITE
1389                 Enable overwrite of previous console environment settings.
1390
1391 - CFG_MEMTEST_START, CFG_MEMTEST_END:
1392                 Begin and End addresses of the area used by the
1393                 simple memory test.
1394
1395 - CFG_ALT_MEMTEST:
1396                 Enable an alternate, more extensive memory test.
1397
1398 - CFG_TFTP_LOADADDR:
1399                 Default load address for network file downloads
1400
1401 - CFG_LOADS_BAUD_CHANGE:
1402                 Enable temporary baudrate change while serial download
1403
1404 - CFG_SDRAM_BASE:
1405                 Physical start address of SDRAM. _Must_ be 0 here.
1406
1407 - CFG_MBIO_BASE:
1408                 Physical start address of Motherboard I/O (if using a
1409                 Cogent motherboard)
1410
1411 - CFG_FLASH_BASE:
1412                 Physical start address of Flash memory.
1413
1414 - CFG_MONITOR_BASE:
1415                 Physical start address of boot monitor code (set by
1416                 make config files to be same as the text base address
1417                 (TEXT_BASE) used when linking) - same as
1418                 CFG_FLASH_BASE when booting from flash.
1419
1420 - CFG_MONITOR_LEN:
1421                 Size of memory reserved for monitor code, used to
1422                 determine _at_compile_time_ (!) if the environment is
1423                 embedded within the U-Boot image, or in a separate
1424                 flash sector.
1425
1426 - CFG_MALLOC_LEN:
1427                 Size of DRAM reserved for malloc() use.
1428
1429 - CFG_BOOTMAPSZ:
1430                 Maximum size of memory mapped by the startup code of
1431                 the Linux kernel; all data that must be processed by
1432                 the Linux kernel (bd_info, boot arguments, eventually
1433                 initrd image) must be put below this limit.
1434
1435 - CFG_MAX_FLASH_BANKS:
1436                 Max number of Flash memory banks
1437
1438 - CFG_MAX_FLASH_SECT:
1439                 Max number of sectors on a Flash chip
1440
1441 - CFG_FLASH_ERASE_TOUT:
1442                 Timeout for Flash erase operations (in ms)
1443
1444 - CFG_FLASH_WRITE_TOUT:
1445                 Timeout for Flash write operations (in ms)
1446
1447 - CFG_DIRECT_FLASH_TFTP:
1448
1449                 Enable TFTP transfers directly to flash memory;
1450                 without this option such a download has to be
1451                 performed in two steps: (1) download to RAM, and (2)
1452                 copy from RAM to flash.
1453
1454                 The two-step approach is usually more reliable, since
1455                 you can check if the download worked before you erase
1456                 the flash, but in some situations (when sytem RAM is
1457                 too limited to allow for a tempory copy of the
1458                 downloaded image) this option may be very useful.
1459
1460 - CFG_FLASH_CFI:
1461                 Define if the flash driver uses extra elements in the
1462                 common flash structure for storing flash geometry
1463
1464 - CFG_RX_ETH_BUFFER:
1465                 Defines the number of ethernet receive buffers. On some
1466                 ethernet controllers it is recommended to set this value
1467                 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1468                 buffers can be full shortly after enabling the interface
1469                 on high ethernet traffic.
1470                 Defaults to 4 if not defined.
1471
1472 The following definitions that deal with the placement and management
1473 of environment data (variable area); in general, we support the
1474 following configurations:
1475
1476 - CFG_ENV_IS_IN_FLASH:
1477
1478         Define this if the environment is in flash memory.
1479
1480         a) The environment occupies one whole flash sector, which is
1481            "embedded" in the text segment with the U-Boot code. This
1482            happens usually with "bottom boot sector" or "top boot
1483            sector" type flash chips, which have several smaller
1484            sectors at the start or the end. For instance, such a
1485            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1486            such a case you would place the environment in one of the
1487            4 kB sectors - with U-Boot code before and after it. With
1488            "top boot sector" type flash chips, you would put the
1489            environment in one of the last sectors, leaving a gap
1490            between U-Boot and the environment.
1491
1492         - CFG_ENV_OFFSET:
1493
1494            Offset of environment data (variable area) to the
1495            beginning of flash memory; for instance, with bottom boot
1496            type flash chips the second sector can be used: the offset
1497            for this sector is given here.
1498
1499            CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1500
1501         - CFG_ENV_ADDR:
1502
1503            This is just another way to specify the start address of
1504            the flash sector containing the environment (instead of
1505            CFG_ENV_OFFSET).
1506
1507         - CFG_ENV_SECT_SIZE:
1508
1509            Size of the sector containing the environment.
1510
1511
1512         b) Sometimes flash chips have few, equal sized, BIG sectors.
1513            In such a case you don't want to spend a whole sector for
1514            the environment.
1515
1516         - CFG_ENV_SIZE:
1517
1518            If you use this in combination with CFG_ENV_IS_IN_FLASH
1519            and CFG_ENV_SECT_SIZE, you can specify to use only a part
1520            of this flash sector for the environment. This saves
1521            memory for the RAM copy of the environment.
1522
1523            It may also save flash memory if you decide to use this
1524            when your environment is "embedded" within U-Boot code,
1525            since then the remainder of the flash sector could be used
1526            for U-Boot code. It should be pointed out that this is
1527            STRONGLY DISCOURAGED from a robustness point of view:
1528            updating the environment in flash makes it always
1529            necessary to erase the WHOLE sector. If something goes
1530            wrong before the contents has been restored from a copy in
1531            RAM, your target system will be dead.
1532
1533         - CFG_ENV_ADDR_REDUND
1534           CFG_ENV_SIZE_REDUND
1535
1536            These settings describe a second storage area used to hold
1537            a redundand copy of the environment data, so that there is
1538            a valid backup copy in case there is a power failure during
1539            a "saveenv" operation.
1540
1541 BE CAREFUL! Any changes to the flash layout, and some changes to the
1542 source code will make it necessary to adapt <board>/u-boot.lds*
1543 accordingly!
1544
1545
1546 - CFG_ENV_IS_IN_NVRAM:
1547
1548         Define this if you have some non-volatile memory device
1549         (NVRAM, battery buffered SRAM) which you want to use for the
1550         environment.
1551
1552         - CFG_ENV_ADDR:
1553         - CFG_ENV_SIZE:
1554
1555           These two #defines are used to determin the memory area you
1556           want to use for environment. It is assumed that this memory
1557           can just be read and written to, without any special
1558           provision.
1559
1560 BE CAREFUL! The first access to the environment happens quite early
1561 in U-Boot initalization (when we try to get the setting of for the
1562 console baudrate). You *MUST* have mappend your NVRAM area then, or
1563 U-Boot will hang.
1564
1565 Please note that even with NVRAM we still use a copy of the
1566 environment in RAM: we could work on NVRAM directly, but we want to
1567 keep settings there always unmodified except somebody uses "saveenv"
1568 to save the current settings.
1569
1570
1571 - CFG_ENV_IS_IN_EEPROM:
1572
1573         Use this if you have an EEPROM or similar serial access
1574         device and a driver for it.
1575
1576         - CFG_ENV_OFFSET:
1577         - CFG_ENV_SIZE:
1578
1579           These two #defines specify the offset and size of the
1580           environment area within the total memory of your EEPROM.
1581
1582         - CFG_I2C_EEPROM_ADDR:
1583           If defined, specified the chip address of the EEPROM device.
1584           The default address is zero.
1585
1586         - CFG_EEPROM_PAGE_WRITE_BITS:
1587           If defined, the number of bits used to address bytes in a
1588           single page in the EEPROM device.  A 64 byte page, for example
1589           would require six bits.
1590
1591         - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1592           If defined, the number of milliseconds to delay between
1593           page writes.  The default is zero milliseconds.
1594
1595         - CFG_I2C_EEPROM_ADDR_LEN:
1596           The length in bytes of the EEPROM memory array address.  Note
1597           that this is NOT the chip address length!
1598
1599         - CFG_EEPROM_SIZE:
1600           The size in bytes of the EEPROM device.
1601
1602
1603 - CFG_SPI_INIT_OFFSET
1604
1605         Defines offset to the initial SPI buffer area in DPRAM. The
1606         area is used at an early stage (ROM part) if the environment
1607         is configured to reside in the SPI EEPROM: We need a 520 byte
1608         scratch DPRAM area. It is used between the two initialization
1609         calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1610         to be a good choice since it makes it far enough from the
1611         start of the data area as well as from the stack pointer.
1612
1613 Please note that the environment is read-only as long as the monitor
1614 has been relocated to RAM and a RAM copy of the environment has been
1615 created; also, when using EEPROM you will have to use getenv_r()
1616 until then to read environment variables.
1617
1618 The environment is protected by a CRC32 checksum. Before the monitor
1619 is relocated into RAM, as a result of a bad CRC you will be working
1620 with the compiled-in default environment - *silently*!!! [This is
1621 necessary, because the first environment variable we need is the
1622 "baudrate" setting for the console - if we have a bad CRC, we don't
1623 have any device yet where we could complain.]
1624
1625 Note: once the monitor has been relocated, then it will complain if
1626 the default environment is used; a new CRC is computed as soon as you
1627 use the "saveenv" command to store a valid environment.
1628
1629
1630 Low Level (hardware related) configuration options:
1631 ---------------------------------------------------
1632
1633 - CFG_CACHELINE_SIZE:
1634                 Cache Line Size of the CPU.
1635
1636 - CFG_DEFAULT_IMMR:
1637                 Default address of the IMMR after system reset.
1638                 Needed on some 8260 systems (MPC8260ADS and RPXsuper)
1639                 to be able to adjust the position of the IMMR
1640                 register after a reset.
1641
1642 - Floppy Disk Support:
1643                 CFG_FDC_DRIVE_NUMBER
1644
1645                 the default drive number (default value 0)
1646
1647                 CFG_ISA_IO_STRIDE
1648
1649                 defines the spacing between fdc chipset registers
1650                 (default value 1)
1651
1652                 CFG_ISA_IO_OFFSET
1653
1654                 defines the offset of register from address. It
1655                 depends on which part of the data bus is connected to
1656                 the fdc chipset. (default value 0)
1657
1658                 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
1659                 CFG_FDC_DRIVE_NUMBER are undefined, they take their
1660                 default value.
1661
1662                 if CFG_FDC_HW_INIT is defined, then the function
1663                 fdc_hw_init() is called at the beginning of the FDC
1664                 setup. fdc_hw_init() must be provided by the board
1665                 source code. It is used to make hardware dependant
1666                 initializations.
1667
1668 - CFG_IMMR:     Physical address of the Internal Memory Mapped
1669                 Register; DO NOT CHANGE! (11-4)
1670                 [MPC8xx systems only]
1671
1672 - CFG_INIT_RAM_ADDR:
1673
1674                 Start address of memory area tha can be used for
1675                 initial data and stack; please note that this must be
1676                 writable memory that is working WITHOUT special
1677                 initialization, i. e. you CANNOT use normal RAM which
1678                 will become available only after programming the
1679                 memory controller and running certain initialization
1680                 sequences.
1681
1682                 U-Boot uses the following memory types:
1683                 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1684                 - MPC824X: data cache
1685                 - PPC4xx:  data cache
1686
1687 - CFG_GBL_DATA_OFFSET:
1688
1689                 Offset of the initial data structure in the memory
1690                 area defined by CFG_INIT_RAM_ADDR. Usually
1691                 CFG_GBL_DATA_OFFSET is chosen such that the initial
1692                 data is located at the end of the available space
1693                 (sometimes written as (CFG_INIT_RAM_END -
1694                 CFG_INIT_DATA_SIZE), and the initial stack is just
1695                 below that area (growing from (CFG_INIT_RAM_ADDR +
1696                 CFG_GBL_DATA_OFFSET) downward.
1697
1698         Note:
1699                 On the MPC824X (or other systems that use the data
1700                 cache for initial memory) the address chosen for
1701                 CFG_INIT_RAM_ADDR is basically arbitrary - it must
1702                 point to an otherwise UNUSED address space between
1703                 the top of RAM and the start of the PCI space.
1704
1705 - CFG_SIUMCR:   SIU Module Configuration (11-6)
1706
1707 - CFG_SYPCR:    System Protection Control (11-9)
1708
1709 - CFG_TBSCR:    Time Base Status and Control (11-26)
1710
1711 - CFG_PISCR:    Periodic Interrupt Status and Control (11-31)
1712
1713 - CFG_PLPRCR:   PLL, Low-Power, and Reset Control Register (15-30)
1714
1715 - CFG_SCCR:     System Clock and reset Control Register (15-27)
1716
1717 - CFG_OR_TIMING_SDRAM:
1718                 SDRAM timing
1719
1720 - CFG_MAMR_PTA:
1721                 periodic timer for refresh
1722
1723 - CFG_DER:      Debug Event Register (37-47)
1724
1725 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
1726   CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
1727   CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
1728   CFG_BR1_PRELIM:
1729                 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
1730
1731 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
1732   CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
1733   CFG_OR3_PRELIM, CFG_BR3_PRELIM:
1734                 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
1735
1736 - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
1737   CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
1738                 Machine Mode Register and Memory Periodic Timer
1739                 Prescaler definitions (SDRAM timing)
1740
1741 - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
1742                 enable I2C microcode relocation patch (MPC8xx);
1743                 define relocation offset in DPRAM [DSP2]
1744
1745 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
1746                 enable SPI microcode relocation patch (MPC8xx);
1747                 define relocation offset in DPRAM [SCC4]
1748
1749 - CFG_USE_OSCCLK:
1750                 Use OSCM clock mode on MBX8xx board. Be careful,
1751                 wrong setting might damage your board. Read
1752                 doc/README.MBX before setting this variable!
1753
1754 - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
1755                 Offset of the bootmode word in DPRAM used by post
1756                 (Power On Self Tests). This definition overrides
1757                 #define'd default value in commproc.h resp.
1758                 cpm_8260.h.
1759
1760 - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
1761   CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
1762   CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
1763   CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
1764   CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
1765   CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
1766   CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
1767   CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
1768                 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
1769
1770 Building the Software:
1771 ======================
1772
1773 Building U-Boot has been tested in native PPC environments (on a
1774 PowerBook G3 running LinuxPPC 2000) and in cross environments
1775 (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
1776 NetBSD 1.5 on x86).
1777
1778 If you are not using a native PPC environment, it is assumed that you
1779 have the GNU cross compiling tools available in your path and named
1780 with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
1781 you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
1782 the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
1783 change it to:
1784
1785         CROSS_COMPILE = ppc_4xx-
1786
1787
1788 U-Boot is intended to be  simple  to  build.  After  installing  the
1789 sources  you must configure U-Boot for one specific board type. This
1790 is done by typing:
1791
1792         make NAME_config
1793
1794 where "NAME_config" is the name of one of the existing
1795 configurations; the following names are supported:
1796
1797     ADCIOP_config         GTH_config            TQM850L_config
1798     ADS860_config         IP860_config          TQM855L_config
1799     AR405_config          IVML24_config         TQM860L_config
1800     CANBT_config          IVMS8_config          WALNUT405_config
1801     CPCI405_config        LANTEC_config         cogent_common_config
1802     CPCIISER4_config      MBX_config            cogent_mpc8260_config
1803     CU824_config          MBX860T_config        cogent_mpc8xx_config
1804     ESTEEM192E_config     RPXlite_config        hermes_config
1805     ETX094_config         RPXsuper_config       hymod_config
1806     FADS823_config        SM850_config          lwmon_config
1807     FADS850SAR_config     SPD823TS_config       pcu_e_config
1808     FADS860T_config       SXNI855T_config       rsdproto_config
1809     FPS850L_config        Sandpoint8240_config  sbc8260_config
1810     GENIETV_config        TQM823L_config        PIP405_config
1811     GEN860T_config        EBONY_config          FPS860L_config
1812     ELPT860_config        cmi_mpc5xx_config     NETVIA_config
1813     at91rm9200dk_config
1814
1815 Note: for some board special configuration names may exist; check  if
1816       additional  information is available from the board vendor; for
1817       instance, the TQM8xxL systems run normally at 50 MHz and use  a
1818       SCC  for  10baseT  ethernet; there are also systems with 80 MHz
1819       CPU clock, and an optional Fast Ethernet  module  is  available
1820       for  CPU's  with FEC. You can select such additional "features"
1821       when chosing the configuration, i. e.
1822
1823       make TQM860L_config
1824         - will configure for a plain TQM860L, i. e. 50MHz, no FEC
1825
1826       make TQM860L_FEC_config
1827         - will configure for a TQM860L at 50MHz with FEC for ethernet
1828
1829       make TQM860L_80MHz_config
1830         - will configure for a TQM860L at 80 MHz, with normal 10baseT
1831           interface
1832
1833       make TQM860L_FEC_80MHz_config
1834         - will configure for a TQM860L at 80 MHz with FEC for ethernet
1835
1836       make TQM823L_LCD_config
1837         - will configure for a TQM823L with U-Boot console on LCD
1838
1839       make TQM823L_LCD_80MHz_config
1840         - will configure for a TQM823L at 80 MHz with U-Boot console on LCD
1841
1842       etc.
1843
1844
1845
1846 Finally, type "make all", and you should get some working U-Boot
1847 images ready for downlod to / installation on your system:
1848
1849 - "u-boot.bin" is a raw binary image
1850 - "u-boot" is an image in ELF binary format
1851 - "u-boot.srec" is in Motorola S-Record format
1852
1853
1854 Please be aware that the Makefiles assume you are using GNU make, so
1855 for instance on NetBSD you might need to use "gmake" instead of
1856 native "make".
1857
1858
1859 If the system board that you have is not listed, then you will need
1860 to port U-Boot to your hardware platform. To do this, follow these
1861 steps:
1862
1863 1.  Add a new configuration option for your board to the toplevel
1864     "Makefile" and to the "MAKEALL" script, using the existing
1865     entries as examples. Note that here and at many other places
1866     boards and other names are listed alphabetically sorted. Please
1867     keep this order.
1868 2.  Create a new directory to hold your board specific code. Add any
1869     files you need. In your board directory, you will need at least
1870     the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
1871 3.  Create a new configuration file "include/configs/<board>.h" for
1872     your board
1873 3.  If you're porting U-Boot to a new CPU, then also create a new
1874     directory to hold your CPU specific code. Add any files you need.
1875 4.  Run "make <board>_config" with your new name.
1876 5.  Type "make", and you should get a working "u-boot.srec" file
1877     to be installed on your target system.
1878 6.  Debug and solve any problems that might arise.
1879     [Of course, this last step is much harder than it sounds.]
1880
1881
1882 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
1883 ==============================================================
1884
1885 If you have modified U-Boot sources (for instance added a new   board
1886 or  support  for  new  devices,  a new CPU, etc.) you are expected to
1887 provide feedback to the other developers. The feedback normally takes
1888 the form of a "patch", i. e. a context diff against a certain (latest
1889 official or latest in CVS) version of U-Boot sources.
1890
1891 But before you submit such a patch, please verify that  your  modifi-
1892 cation  did not break existing code. At least make sure that *ALL* of
1893 the supported boards compile WITHOUT ANY compiler warnings. To do so,
1894 just run the "MAKEALL" script, which will configure and build U-Boot
1895 for ALL supported system. Be warned, this will take a while. You  can
1896 select  which  (cross)  compiler  to use py passing a `CROSS_COMPILE'
1897 environment variable to the script, i. e. to use the cross tools from
1898 MontaVista's Hard Hat Linux you can type
1899
1900         CROSS_COMPILE=ppc_8xx- MAKEALL
1901
1902 or to build on a native PowerPC system you can type
1903
1904         CROSS_COMPILE=' ' MAKEALL
1905
1906 See also "U-Boot Porting Guide" below.
1907
1908
1909
1910 Monitor Commands - Overview:
1911 ============================
1912
1913 go      - start application at address 'addr'
1914 run     - run commands in an environment variable
1915 bootm   - boot application image from memory
1916 bootp   - boot image via network using BootP/TFTP protocol
1917 tftpboot- boot image via network using TFTP protocol
1918                and env variables "ipaddr" and "serverip"
1919                (and eventually "gatewayip")
1920 rarpboot- boot image via network using RARP/TFTP protocol
1921 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
1922 loads   - load S-Record file over serial line
1923 loadb   - load binary file over serial line (kermit mode)
1924 md      - memory display
1925 mm      - memory modify (auto-incrementing)
1926 nm      - memory modify (constant address)
1927 mw      - memory write (fill)
1928 cp      - memory copy
1929 cmp     - memory compare
1930 crc32   - checksum calculation
1931 imd     - i2c memory display
1932 imm     - i2c memory modify (auto-incrementing)
1933 inm     - i2c memory modify (constant address)
1934 imw     - i2c memory write (fill)
1935 icrc32  - i2c checksum calculation
1936 iprobe  - probe to discover valid I2C chip addresses
1937 iloop   - infinite loop on address range
1938 isdram  - print SDRAM configuration information
1939 sspi    - SPI utility commands
1940 base    - print or set address offset
1941 printenv- print environment variables
1942 setenv  - set environment variables
1943 saveenv - save environment variables to persistent storage
1944 protect - enable or disable FLASH write protection
1945 erase   - erase FLASH memory
1946 flinfo  - print FLASH memory information
1947 bdinfo  - print Board Info structure
1948 iminfo  - print header information for application image
1949 coninfo - print console devices and informations
1950 ide     - IDE sub-system
1951 loop    - infinite loop on address range
1952 mtest   - simple RAM test
1953 icache  - enable or disable instruction cache
1954 dcache  - enable or disable data cache
1955 reset   - Perform RESET of the CPU
1956 echo    - echo args to console
1957 version - print monitor version
1958 help    - print online help
1959 ?       - alias for 'help'
1960
1961
1962 Monitor Commands - Detailed Description:
1963 ========================================
1964
1965 TODO.
1966
1967 For now: just type "help <command>".
1968
1969
1970 Environment Variables:
1971 ======================
1972
1973 U-Boot supports user configuration using Environment Variables which
1974 can be made persistent by saving to Flash memory.
1975
1976 Environment Variables are set using "setenv", printed using
1977 "printenv", and saved to Flash using "saveenv". Using "setenv"
1978 without a value can be used to delete a variable from the
1979 environment. As long as you don't save the environment you are
1980 working with an in-memory copy. In case the Flash area containing the
1981 environment is erased by accident, a default environment is provided.
1982
1983 Some configuration options can be set using Environment Variables:
1984
1985   baudrate      - see CONFIG_BAUDRATE
1986
1987   bootdelay     - see CONFIG_BOOTDELAY
1988
1989   bootcmd       - see CONFIG_BOOTCOMMAND
1990
1991   bootargs      - Boot arguments when booting an RTOS image
1992
1993   bootfile      - Name of the image to load with TFTP
1994
1995   autoload      - if set to "no" (any string beginning with 'n'),
1996                   "bootp" will just load perform a lookup of the
1997                   configuration from the BOOTP server, but not try to
1998                   load any image using TFTP
1999
2000   autostart     - if set to "yes", an image loaded using the "bootp",
2001                   "rarpboot", "tftpboot" or "diskboot" commands will
2002                   be automatically started (by internally calling
2003                   "bootm")
2004
2005                   If set to "no", a standalone image passed to the
2006                   "bootm" command will be copied to the load address
2007                   (and eventually uncompressed), but NOT be started.
2008                   This can be used to load and uncompress arbitrary
2009                   data.
2010
2011   initrd_high   - restrict positioning of initrd images:
2012                   If this variable is not set, initrd images will be
2013                   copied to the highest possible address in RAM; this
2014                   is usually what you want since it allows for
2015                   maximum initrd size. If for some reason you want to
2016                   make sure that the initrd image is loaded below the
2017                   CFG_BOOTMAPSZ limit, you can set this environment
2018                   variable to a value of "no" or "off" or "0".
2019                   Alternatively, you can set it to a maximum upper
2020                   address to use (U-Boot will still check that it
2021                   does not overwrite the U-Boot stack and data).
2022
2023                   For instance, when you have a system with 16 MB
2024                   RAM, and want to reseve 4 MB from use by Linux,
2025                   you can do this by adding "mem=12M" to the value of
2026                   the "bootargs" variable. However, now you must make
2027                   sure, that the initrd image is placed in the first
2028                   12 MB as well - this can be done with
2029
2030                   setenv initrd_high 00c00000
2031
2032                   If you set initrd_high to 0xFFFFFFFF, this is an
2033                   indication to U-Boot that all addresses are legal
2034                   for the Linux kernel, including addresses in flash
2035                   memory. In this case U-Boot will NOT COPY the
2036                   ramdisk at all. This may be useful to reduce the
2037                   boot time on your system, but requires that this
2038                   feature is supported by your Linux kernel.
2039
2040   ipaddr        - IP address; needed for tftpboot command
2041
2042   loadaddr      - Default load address for commands like "bootp",
2043                   "rarpboot", "tftpboot", "loadb" or "diskboot"
2044
2045   loads_echo    - see CONFIG_LOADS_ECHO
2046
2047   serverip      - TFTP server IP address; needed for tftpboot command
2048
2049   bootretry     - see CONFIG_BOOT_RETRY_TIME
2050
2051   bootdelaykey  - see CONFIG_AUTOBOOT_DELAY_STR
2052
2053   bootstopkey   - see CONFIG_AUTOBOOT_STOP_STR
2054
2055
2056 The following environment variables may be used and automatically
2057 updated by the network boot commands ("bootp" and "rarpboot"),
2058 depending the information provided by your boot server:
2059
2060   bootfile      - see above
2061   dnsip         - IP address of your Domain Name Server
2062   gatewayip     - IP address of the Gateway (Router) to use
2063   hostname      - Target hostname
2064   ipaddr        - see above
2065   netmask       - Subnet Mask
2066   rootpath      - Pathname of the root filesystem on the NFS server
2067   serverip      - see above
2068
2069
2070 There are two special Environment Variables:
2071
2072   serial#       - contains hardware identification information such
2073                   as type string and/or serial number
2074   ethaddr       - Ethernet address
2075
2076 These variables can be set only once (usually during manufacturing of
2077 the board). U-Boot refuses to delete or overwrite these variables
2078 once they have been set once.
2079
2080
2081 Further special Environment Variables:
2082
2083   ver           - Contains the U-Boot version string as printed
2084                   with the "version" command. This variable is
2085                   readonly (see CONFIG_VERSION_VARIABLE).
2086
2087
2088 Please note that changes to some configuration parameters may take
2089 only effect after the next boot (yes, that's just like Windoze :-).
2090
2091
2092 Command Line Parsing:
2093 =====================
2094
2095 There are two different command line parsers available  with  U-Boot:
2096 the old "simple" one, and the much more pwerful "hush" shell:
2097
2098 Old, simple command line parser:
2099 --------------------------------
2100
2101 - supports environment variables (through setenv / saveenv commands)
2102 - several commands on one line, separated by ';'
2103 - variable substitution using "... $(name) ..." syntax
2104 - special characters ('$', ';') can be escaped by prefixing with '\',
2105   for example:
2106         setenv bootcmd bootm \$(address)
2107 - You can also escape text by enclosing in single apostrophes, for example:
2108         setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2109
2110 Hush shell:
2111 -----------
2112
2113 - similar to Bourne shell, with control structures like
2114   if...then...else...fi, for...do...done; while...do...done,
2115   until...do...done, ...
2116 - supports environment ("global") variables (through setenv / saveenv
2117   commands) and local shell variables (through standard shell syntax
2118   "name=value"); only environment variables can be used with "run"
2119   command
2120
2121 General rules:
2122 --------------
2123
2124 (1) If a command line (or an environment variable executed by a "run"
2125     command) contains several commands separated by semicolon, and
2126     one of these commands fails, then the remaining commands will be
2127     executed anyway.
2128
2129 (2) If you execute several variables with one call to run (i. e.
2130     calling run with a list af variables as arguments), any failing
2131     command will cause "run" to terminate, i. e. the remaining
2132     variables are not executed.
2133
2134 Note for Redundant Ethernet Interfaces:
2135 =======================================
2136
2137 Some boards come with redundand ethernet interfaces; U-Boot supports
2138 such configurations and is capable of automatic selection of a
2139 "working" interface when needed. MAC assignemnt works as follows:
2140
2141 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2142 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2143 "eth1addr" (=>eth1), "eth2addr", ...
2144
2145 If the network interface stores some valid MAC address (for instance
2146 in SROM), this is used as default address if there is NO correspon-
2147 ding setting in the environment; if the corresponding environment
2148 variable is set, this overrides the settings in the card; that means:
2149
2150 o If the SROM has a valid MAC address, and there is no address in the
2151   environment, the SROM's address is used.
2152
2153 o If there is no valid address in the SROM, and a definition in the
2154   environment exists, then the value from the environment variable is
2155   used.
2156
2157 o If both the SROM and the environment contain a MAC address, and
2158   both addresses are the same, this MAC address is used.
2159
2160 o If both the SROM and the environment contain a MAC address, and the
2161   addresses differ, the value from the environment is used and a
2162   warning is printed.
2163
2164 o If neither SROM nor the environment contain a MAC address, an error
2165   is raised.
2166
2167
2168
2169 Image Formats:
2170 ==============
2171
2172 The "boot" commands of this monitor operate on "image" files which
2173 can be basicly anything, preceeded by a special header; see the
2174 definitions in include/image.h for details; basicly, the header
2175 defines the following image properties:
2176
2177 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2178   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2179   LynxOS, pSOS, QNX, RTEMS, ARTOS;
2180   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS).
2181 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2182   IA64, MIPS, MIPS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2183   Currently supported: PowerPC).
2184 * Compression Type (Provisions for uncompressed, gzip, bzip2;
2185   Currently supported: uncompressed, gzip).
2186 * Load Address
2187 * Entry Point
2188 * Image Name
2189 * Image Timestamp
2190
2191 The header is marked by a special Magic Number, and both the header
2192 and the data portions of the image are secured against corruption by
2193 CRC32 checksums.
2194
2195
2196 Linux Support:
2197 ==============
2198
2199 Although U-Boot should support any OS or standalone application
2200 easily, Linux has always been in the focus during the design of
2201 U-Boot.
2202
2203 U-Boot includes many features that so far have been part of some
2204 special "boot loader" code within the Linux kernel. Also, any
2205 "initrd" images to be used are no longer part of one big Linux image;
2206 instead, kernel and "initrd" are separate images. This implementation
2207 serves serveral purposes:
2208
2209 - the same features can be used for other OS or standalone
2210   applications (for instance: using compressed images to reduce the
2211   Flash memory footprint)
2212
2213 - it becomes much easier to port new Linux kernel versions because
2214   lots of low-level, hardware dependend stuff are done by U-Boot
2215
2216 - the same Linux kernel image can now be used with different "initrd"
2217   images; of course this also means that different kernel images can
2218   be run with the same "initrd". This makes testing easier (you don't
2219   have to build a new "zImage.initrd" Linux image when you just
2220   change a file in your "initrd"). Also, a field-upgrade of the
2221   software is easier now.
2222
2223
2224 Linux HOWTO:
2225 ============
2226
2227 Porting Linux to U-Boot based systems:
2228 ---------------------------------------
2229
2230 U-Boot cannot save you from doing all the necessary modifications to
2231 configure the Linux device drivers for use with your target hardware
2232 (no, we don't intend to provide a full virtual machine interface to
2233 Linux :-).
2234
2235 But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2236
2237 Just make sure your machine specific header file (for instance
2238 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2239 Information structure as we define in include/u-boot.h, and make
2240 sure that your definition of IMAP_ADDR uses the same value as your
2241 U-Boot configuration in CFG_IMMR.
2242
2243
2244 Configuring the Linux kernel:
2245 -----------------------------
2246
2247 No specific requirements for U-Boot. Make sure you have some root
2248 device (initial ramdisk, NFS) for your target system.
2249
2250
2251 Building a Linux Image:
2252 -----------------------
2253
2254 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2255 not used. If you use recent kernel source, a new build target
2256 "uImage" will exist which automatically builds an image usable by
2257 U-Boot. Most older kernels also have support for a "pImage" target,
2258 which was introduced for our predecessor project PPCBoot and uses a
2259 100% compatible format.
2260
2261 Example:
2262
2263         make TQM850L_config
2264         make oldconfig
2265         make dep
2266         make uImage
2267
2268 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2269 encapsulate a compressed Linux kernel image with header  information,
2270 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2271
2272 * build a standard "vmlinux" kernel image (in ELF binary format):
2273
2274 * convert the kernel into a raw binary image:
2275
2276         ${CROSS_COMPILE}-objcopy -O binary \
2277                                  -R .note -R .comment \
2278                                  -S vmlinux linux.bin
2279
2280 * compress the binary image:
2281
2282         gzip -9 linux.bin
2283
2284 * package compressed binary image for U-Boot:
2285
2286         mkimage -A ppc -O linux -T kernel -C gzip \
2287                 -a 0 -e 0 -n "Linux Kernel Image" \
2288                 -d linux.bin.gz uImage
2289
2290
2291 The "mkimage" tool can also be used to create ramdisk images for use
2292 with U-Boot, either separated from the Linux kernel image, or
2293 combined into one file. "mkimage" encapsulates the images with a 64
2294 byte header containing information about target architecture,
2295 operating system, image type, compression method, entry points, time
2296 stamp, CRC32 checksums, etc.
2297
2298 "mkimage" can be called in two ways: to verify existing images and
2299 print the header information, or to build new images.
2300
2301 In the first form (with "-l" option) mkimage lists the information
2302 contained in the header of an existing U-Boot image; this includes
2303 checksum verification:
2304
2305         tools/mkimage -l image
2306           -l ==> list image header information
2307
2308 The second form (with "-d" option) is used to build a U-Boot image
2309 from a "data file" which is used as image payload:
2310
2311         tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2312                       -n name -d data_file image
2313           -A ==> set architecture to 'arch'
2314           -O ==> set operating system to 'os'
2315           -T ==> set image type to 'type'
2316           -C ==> set compression type 'comp'
2317           -a ==> set load address to 'addr' (hex)
2318           -e ==> set entry point to 'ep' (hex)
2319           -n ==> set image name to 'name'
2320           -d ==> use image data from 'datafile'
2321
2322 Right now, all Linux kernels use the same load address  (0x00000000),
2323 but the entry point address depends on the kernel version:
2324
2325 - 2.2.x kernels have the entry point at 0x0000000C,
2326 - 2.3.x and later kernels have the entry point at 0x00000000.
2327
2328 So a typical call to build a U-Boot image would read:
2329
2330         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2331         > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2332         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2333         > examples/uImage.TQM850L
2334         Image Name:   2.4.4 kernel for TQM850L
2335         Created:      Wed Jul 19 02:34:59 2000
2336         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2337         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2338         Load Address: 0x00000000
2339         Entry Point:  0x00000000
2340
2341 To verify the contents of the image (or check for corruption):
2342
2343         -> tools/mkimage -l examples/uImage.TQM850L
2344         Image Name:   2.4.4 kernel for TQM850L
2345         Created:      Wed Jul 19 02:34:59 2000
2346         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2347         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2348         Load Address: 0x00000000
2349         Entry Point:  0x00000000
2350
2351 NOTE: for embedded systems where boot time is critical you can trade
2352 speed for memory and install an UNCOMPRESSED image instead: this
2353 needs more space in Flash, but boots much faster since it does not
2354 need to be uncompressed:
2355
2356         -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2357         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2358         > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2359         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2360         > examples/uImage.TQM850L-uncompressed
2361         Image Name:   2.4.4 kernel for TQM850L
2362         Created:      Wed Jul 19 02:34:59 2000
2363         Image Type:   PowerPC Linux Kernel Image (uncompressed)
2364         Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2365         Load Address: 0x00000000
2366         Entry Point:  0x00000000
2367
2368
2369 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2370 when your kernel is intended to use an initial ramdisk:
2371
2372         -> tools/mkimage -n 'Simple Ramdisk Image' \
2373         > -A ppc -O linux -T ramdisk -C gzip \
2374         > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2375         Image Name:   Simple Ramdisk Image
2376         Created:      Wed Jan 12 14:01:50 2000
2377         Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2378         Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2379         Load Address: 0x00000000
2380         Entry Point:  0x00000000
2381
2382
2383 Installing a Linux Image:
2384 -------------------------
2385
2386 To downloading a U-Boot image over the serial (console) interface,
2387 you must convert the image to S-Record format:
2388
2389         objcopy -I binary -O srec examples/image examples/image.srec
2390
2391 The 'objcopy' does not understand the information in the U-Boot
2392 image header, so the resulting S-Record file will be relative to
2393 address 0x00000000. To load it to a given address, you need to
2394 specify the target address as 'offset' parameter with the 'loads'
2395 command.
2396
2397 Example: install the image to address 0x40100000 (which on the
2398 TQM8xxL is in the first Flash bank):
2399
2400         => erase 40100000 401FFFFF
2401
2402         .......... done
2403         Erased 8 sectors
2404
2405         => loads 40100000
2406         ## Ready for S-Record download ...
2407         ~>examples/image.srec
2408         1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2409         ...
2410         15989 15990 15991 15992
2411         [file transfer complete]
2412         [connected]
2413         ## Start Addr = 0x00000000
2414
2415
2416 You can check the success of the download using the 'iminfo' command;
2417 this includes a checksum verification so you  can  be  sure  no  data
2418 corruption happened:
2419
2420         => imi 40100000
2421
2422         ## Checking Image at 40100000 ...
2423            Image Name:   2.2.13 for initrd on TQM850L
2424            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2425            Data Size:    335725 Bytes = 327 kB = 0 MB
2426            Load Address: 00000000
2427            Entry Point:  0000000c
2428            Verifying Checksum ... OK
2429
2430
2431
2432 Boot Linux:
2433 -----------
2434
2435 The "bootm" command is used to boot an application that is stored in
2436 memory (RAM or Flash). In case of a Linux kernel image, the contents
2437 of the "bootargs" environment variable is passed to the kernel as
2438 parameters. You can check and modify this variable using the
2439 "printenv" and "setenv" commands:
2440
2441
2442         => printenv bootargs
2443         bootargs=root=/dev/ram
2444
2445         => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2446
2447         => printenv bootargs
2448         bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2449
2450         => bootm 40020000
2451         ## Booting Linux kernel at 40020000 ...
2452            Image Name:   2.2.13 for NFS on TQM850L
2453            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2454            Data Size:    381681 Bytes = 372 kB = 0 MB
2455            Load Address: 00000000
2456            Entry Point:  0000000c
2457            Verifying Checksum ... OK
2458            Uncompressing Kernel Image ... OK
2459         Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
2460         Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2461         time_init: decrementer frequency = 187500000/60
2462         Calibrating delay loop... 49.77 BogoMIPS
2463         Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2464         ...
2465
2466 If you want to boot a Linux kernel with initial ram disk, you pass
2467 the memory addreses of both the kernel and the initrd image (PPBCOOT
2468 format!) to the "bootm" command:
2469
2470         => imi 40100000 40200000
2471
2472         ## Checking Image at 40100000 ...
2473            Image Name:   2.2.13 for initrd on TQM850L
2474            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2475            Data Size:    335725 Bytes = 327 kB = 0 MB
2476            Load Address: 00000000
2477            Entry Point:  0000000c
2478            Verifying Checksum ... OK
2479
2480         ## Checking Image at 40200000 ...
2481            Image Name:   Simple Ramdisk Image
2482            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2483            Data Size:    566530 Bytes = 553 kB = 0 MB
2484            Load Address: 00000000
2485            Entry Point:  00000000
2486            Verifying Checksum ... OK
2487
2488         => bootm 40100000 40200000
2489         ## Booting Linux kernel at 40100000 ...
2490            Image Name:   2.2.13 for initrd on TQM850L
2491            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2492            Data Size:    335725 Bytes = 327 kB = 0 MB
2493            Load Address: 00000000
2494            Entry Point:  0000000c
2495            Verifying Checksum ... OK
2496            Uncompressing Kernel Image ... OK
2497         ## Loading RAMDisk Image at 40200000 ...
2498            Image Name:   Simple Ramdisk Image
2499            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2500            Data Size:    566530 Bytes = 553 kB = 0 MB
2501            Load Address: 00000000
2502            Entry Point:  00000000
2503            Verifying Checksum ... OK
2504            Loading Ramdisk ... OK
2505         Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
2506         Boot arguments: root=/dev/ram
2507         time_init: decrementer frequency = 187500000/60
2508         Calibrating delay loop... 49.77 BogoMIPS
2509         ...
2510         RAMDISK: Compressed image found at block 0
2511         VFS: Mounted root (ext2 filesystem).
2512
2513         bash#
2514
2515 More About U-Boot Image Types:
2516 ------------------------------
2517
2518 U-Boot supports the following image types:
2519
2520    "Standalone Programs" are directly runnable in the environment
2521         provided by U-Boot; it is expected that (if they behave
2522         well) you can continue to work in U-Boot after return from
2523         the Standalone Program.
2524    "OS Kernel Images" are usually images of some Embedded OS which
2525         will take over control completely. Usually these programs
2526         will install their own set of exception handlers, device
2527         drivers, set up the MMU, etc. - this means, that you cannot
2528         expect to re-enter U-Boot except by resetting the CPU.
2529    "RAMDisk Images" are more or less just data blocks, and their
2530         parameters (address, size) are passed to an OS kernel that is
2531         being started.
2532    "Multi-File Images" contain several images, typically an OS
2533         (Linux) kernel image and one or more data images like
2534         RAMDisks. This construct is useful for instance when you want
2535         to boot over the network using BOOTP etc., where the boot
2536         server provides just a single image file, but you want to get
2537         for instance an OS kernel and a RAMDisk image.
2538
2539         "Multi-File Images" start with a list of image sizes, each
2540         image size (in bytes) specified by an "uint32_t" in network
2541         byte order. This list is terminated by an "(uint32_t)0".
2542         Immediately after the terminating 0 follow the images, one by
2543         one, all aligned on "uint32_t" boundaries (size rounded up to
2544         a multiple of 4 bytes).
2545
2546    "Firmware Images" are binary images containing firmware (like
2547         U-Boot or FPGA images) which usually will be programmed to
2548         flash memory.
2549
2550    "Script files" are command sequences that will be executed by
2551         U-Boot's command interpreter; this feature is especially
2552         useful when you configure U-Boot to use a real shell (hush)
2553         as command interpreter.
2554
2555
2556 Standalone HOWTO:
2557 =================
2558
2559 One of the features of U-Boot is that you can dynamically load and
2560 run "standalone" applications, which can use some resources of
2561 U-Boot like console I/O functions or interrupt services.
2562
2563 Two simple examples are included with the sources:
2564
2565 "Hello World" Demo:
2566 -------------------
2567
2568 'examples/hello_world.c' contains a small "Hello World" Demo
2569 application; it is automatically compiled when you build U-Boot.
2570 It's configured to run at address 0x00040004, so you can play with it
2571 like that:
2572
2573         => loads
2574         ## Ready for S-Record download ...
2575         ~>examples/hello_world.srec
2576         1 2 3 4 5 6 7 8 9 10 11 ...
2577         [file transfer complete]
2578         [connected]
2579         ## Start Addr = 0x00040004
2580
2581         => go 40004 Hello World! This is a test.
2582         ## Starting application at 0x00040004 ...
2583         Hello World
2584         argc = 7
2585         argv[0] = "40004"
2586         argv[1] = "Hello"
2587         argv[2] = "World!"
2588         argv[3] = "This"
2589         argv[4] = "is"
2590         argv[5] = "a"
2591         argv[6] = "test."
2592         argv[7] = "<NULL>"
2593         Hit any key to exit ...
2594
2595         ## Application terminated, rc = 0x0
2596
2597 Another example, which demonstrates how to register a CPM interrupt
2598 handler with the U-Boot code, can be found in 'examples/timer.c'.
2599 Here, a CPM timer is set up to generate an interrupt every second.
2600 The interrupt service routine is trivial, just printing a '.'
2601 character, but this is just a demo program. The application can be
2602 controlled by the following keys:
2603
2604         ? - print current values og the CPM Timer registers
2605         b - enable interrupts and start timer
2606         e - stop timer and disable interrupts
2607         q - quit application
2608
2609         => loads
2610         ## Ready for S-Record download ...
2611         ~>examples/timer.srec
2612         1 2 3 4 5 6 7 8 9 10 11 ...
2613         [file transfer complete]
2614         [connected]
2615         ## Start Addr = 0x00040004
2616
2617         => go 40004
2618         ## Starting application at 0x00040004 ...
2619         TIMERS=0xfff00980
2620         Using timer 1
2621           tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
2622
2623 Hit 'b':
2624         [q, b, e, ?] Set interval 1000000 us
2625         Enabling timer
2626 Hit '?':
2627         [q, b, e, ?] ........
2628         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2629 Hit '?':
2630         [q, b, e, ?] .
2631         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2632 Hit '?':
2633         [q, b, e, ?] .
2634         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2635 Hit '?':
2636         [q, b, e, ?] .
2637         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2638 Hit 'e':
2639         [q, b, e, ?] ...Stopping timer
2640 Hit 'q':
2641         [q, b, e, ?] ## Application terminated, rc = 0x0
2642
2643
2644
2645 Minicom warning:
2646 ================
2647
2648 Over time, many people have reported problems when trying to used the
2649 "minicom" terminal emulation program for serial download. I (wd)
2650 consider minicom to be broken, and recommend not to use it. Under
2651 Unix, I recommend to use C-Kermit for general purpose use (and
2652 especially for kermit binary protocol download ("loadb" command), and
2653 use "cu" for S-Record download ("loads" command).
2654
2655 Nevertheless, if you absolutely want to use it try adding this
2656 configuration to your "File transfer protocols" section:
2657
2658            Name    Program                      Name U/D FullScr IO-Red. Multi
2659         X  kermit  /usr/bin/kermit -i -l %l -s   Y    U    Y       N      N
2660         Y  kermit  /usr/bin/kermit -i -l %l -r   N    D    Y       N      N
2661
2662
2663 NetBSD Notes:
2664 =============
2665
2666 Starting at version 0.9.2, U-Boot supports NetBSD both as host
2667 (build U-Boot) and target system (boots NetBSD/mpc8xx).
2668
2669 Building requires a cross environment; it is known to work on
2670 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
2671 need gmake since the Makefiles are not compatible with BSD make).
2672 Note that the cross-powerpc package does not install include files;
2673 attempting to build U-Boot will fail because <machine/ansi.h> is
2674 missing.  This file has to be installed and patched manually:
2675
2676         # cd /usr/pkg/cross/powerpc-netbsd/include
2677         # mkdir powerpc
2678         # ln -s powerpc machine
2679         # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
2680         # ${EDIT} powerpc/ansi.h        ## must remove __va_list, _BSD_VA_LIST
2681
2682 Native builds *don't* work due to incompatibilities between native
2683 and U-Boot include files.
2684
2685 Booting assumes that (the first part of) the image booted is a
2686 stage-2 loader which in turn loads and then invokes the kernel
2687 proper. Loader sources will eventually appear in the NetBSD source
2688 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2689 meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
2690 details.
2691
2692
2693 Implementation Internals:
2694 =========================
2695
2696 The following is not intended to be a complete description of every
2697 implementation detail. However, it should help to understand the
2698 inner workings of U-Boot and make it easier to port it to custom
2699 hardware.
2700
2701
2702 Initial Stack, Global Data:
2703 ---------------------------
2704
2705 The implementation of U-Boot is complicated by the fact that U-Boot
2706 starts running out of ROM (flash memory), usually without access to
2707 system RAM (because the memory controller is not initialized yet).
2708 This means that we don't have writable Data or BSS segments, and BSS
2709 is not initialized as zero. To be able to get a C environment working
2710 at all, we have to allocate at least a minimal stack. Implementation
2711 options for this are defined and restricted by the CPU used: Some CPU
2712 models provide on-chip memory (like the IMMR area on MPC8xx and
2713 MPC826x processors), on others (parts of) the data cache can be
2714 locked as (mis-) used as memory, etc.
2715
2716         Chris Hallinan posted a good summy of  these  issues  to  the
2717         u-boot-users mailing list:
2718
2719         Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
2720         From: "Chris Hallinan" <clh@net1plus.com>
2721         Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
2722         ...
2723
2724         Correct me if I'm wrong, folks, but the way I understand it
2725         is this: Using DCACHE as initial RAM for Stack, etc, does not
2726         require any physical RAM backing up the cache. The cleverness
2727         is that the cache is being used as a temporary supply of
2728         necessary storage before the SDRAM controller is setup. It's
2729         beyond the scope of this list to expain the details, but you
2730         can see how this works by studying the cache architecture and
2731         operation in the architecture and processor-specific manuals.
2732
2733         OCM is On Chip Memory, which I believe the 405GP has 4K. It
2734         is another option for the system designer to use as an
2735         initial stack/ram area prior to SDRAM being available. Either
2736         option should work for you. Using CS 4 should be fine if your
2737         board designers haven't used it for something that would
2738         cause you grief during the initial boot! It is frequently not
2739         used.
2740
2741         CFG_INIT_RAM_ADDR should be somewhere that won't interfere
2742         with your processor/board/system design. The default value
2743         you will find in any recent u-boot distribution in
2744         Walnut405.h should work for you. I'd set it to a value larger
2745         than your SDRAM module. If you have a 64MB SDRAM module, set
2746         it above 400_0000. Just make sure your board has no resources
2747         that are supposed to respond to that address! That code in
2748         start.S has been around a while and should work as is when
2749         you get the config right.
2750
2751         -Chris Hallinan
2752         DS4.COM, Inc.
2753
2754 It is essential to remember this, since it has some impact on the C
2755 code for the initialization procedures:
2756
2757 * Initialized global data (data segment) is read-only. Do not attempt
2758   to write it.
2759
2760 * Do not use any unitialized global data (or implicitely initialized
2761   as zero data - BSS segment) at all - this is undefined, initiali-
2762   zation is performed later (when relocationg to RAM).
2763
2764 * Stack space is very limited. Avoid big data buffers or things  like
2765   that.
2766
2767 Having only the stack as writable memory limits means we cannot use
2768 normal global data to share information beween the code. But it
2769 turned out that the implementation of U-Boot can be greatly
2770 simplified by making a global data structure (gd_t) available to all
2771 functions. We could pass a pointer to this data as argument to _all_
2772 functions, but this would bloat the code. Instead we use a feature of
2773 the GCC compiler (Global Register Variables) to share the data: we
2774 place a pointer (gd) to the global data into a register which we
2775 reserve for this purpose.
2776
2777 When chosing a register for such a purpose we are restricted  by  the
2778 relevant  (E)ABI  specifications for the current architecture, and by
2779 GCC's implementation.
2780
2781 For PowerPC, the following registers have specific use:
2782         R1:     stack pointer
2783         R2:     TOC pointer
2784         R3-R4:  parameter passing and return values
2785         R5-R10: parameter passing
2786         R13:    small data area pointer
2787         R30:    GOT pointer
2788         R31:    frame pointer
2789
2790         (U-Boot also uses R14 as internal GOT pointer.)
2791
2792     ==> U-Boot will use R29 to hold a pointer to the global data
2793
2794     Note: on PPC, we could use a static initializer (since the
2795     address of the global data structure is known at compile time),
2796     but it turned out that reserving a register results in somewhat
2797     smaller code - although the code savings are not that big (on
2798     average for all boards 752 bytes for the whole U-Boot image,
2799     624 text + 127 data).
2800
2801 On ARM, the following registers are used:
2802
2803         R0:     function argument word/integer result
2804         R1-R3:  function argument word
2805         R9:     GOT pointer
2806         R10:    stack limit (used only if stack checking if enabled)
2807         R11:    argument (frame) pointer
2808         R12:    temporary workspace
2809         R13:    stack pointer
2810         R14:    link register
2811         R15:    program counter
2812
2813     ==> U-Boot will use R8 to hold a pointer to the global data
2814
2815
2816
2817 Memory Management:
2818 ------------------
2819
2820 U-Boot runs in system state and uses physical addresses, i.e. the
2821 MMU is not used either for address mapping nor for memory protection.
2822
2823 The available memory is mapped to fixed addresses using the memory
2824 controller. In this process, a contiguous block is formed for each
2825 memory type (Flash, SDRAM, SRAM), even when it consists of several
2826 physical memory banks.
2827
2828 U-Boot is installed in the first 128 kB of the first Flash bank (on
2829 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
2830 booting and sizing and initializing DRAM, the code relocates itself
2831 to the upper end of DRAM. Immediately below the U-Boot code some
2832 memory is reserved for use by malloc() [see CFG_MALLOC_LEN
2833 configuration setting]. Below that, a structure with global Board
2834 Info data is placed, followed by the stack (growing downward).
2835
2836 Additionally, some exception handler code is copied to the low 8 kB
2837 of DRAM (0x00000000 ... 0x00001FFF).
2838
2839 So a typical memory configuration with 16 MB of DRAM could look like
2840 this:
2841
2842         0x0000 0000     Exception Vector code
2843               :
2844         0x0000 1FFF
2845         0x0000 2000     Free for Application Use
2846               :
2847               :
2848
2849               :
2850               :
2851         0x00FB FF20     Monitor Stack (Growing downward)
2852         0x00FB FFAC     Board Info Data and permanent copy of global data
2853         0x00FC 0000     Malloc Arena
2854               :
2855         0x00FD FFFF
2856         0x00FE 0000     RAM Copy of Monitor Code
2857         ...             eventually: LCD or video framebuffer
2858         ...             eventually: pRAM (Protected RAM - unchanged by reset)
2859         0x00FF FFFF     [End of RAM]
2860
2861
2862 System Initialization:
2863 ----------------------
2864
2865 In the reset configuration, U-Boot starts at the reset entry point
2866 (on most PowerPC systens at address 0x00000100). Because of the reset
2867 configuration for CS0# this is a mirror of the onboard Flash memory.
2868 To be able to re-map memory U-Boot then jumps to it's link address.
2869 To be able to implement the initialization code in C, a (small!)
2870 initial stack is set up in the internal Dual Ported RAM (in case CPUs
2871 which provide such a feature like MPC8xx or MPC8260), or in a locked
2872 part of the data cache. After that, U-Boot initializes the CPU core,
2873 the caches and the SIU.
2874
2875 Next, all (potentially) available memory banks are mapped using a
2876 preliminary mapping. For example, we put them on 512 MB boundaries
2877 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
2878 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
2879 programmed for SDRAM access. Using the temporary configuration, a
2880 simple memory test is run that determines the size of the SDRAM
2881 banks.
2882
2883 When there is more than one SDRAM bank, and the banks are of
2884 different size, the larger is mapped first. For equal size, the first
2885 bank (CS2#) is mapped first. The first mapping is always for address
2886 0x00000000, with any additional banks following immediately to create
2887 contiguous memory starting from 0.
2888
2889 Then, the monitor installs itself at the upper end of the SDRAM area
2890 and allocates memory for use by malloc() and for the global Board
2891 Info data; also, the exception vector code is copied to the low RAM
2892 pages, and the final stack is set up.
2893
2894 Only after this relocation will you have a "normal" C environment;
2895 until that you are restricted in several ways, mostly because you are
2896 running from ROM, and because the code will have to be relocated to a
2897 new address in RAM.
2898
2899
2900 U-Boot Porting Guide:
2901 ----------------------
2902
2903 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
2904 list, October 2002]
2905
2906
2907 int main (int argc, char *argv[])
2908 {
2909         sighandler_t no_more_time;
2910
2911         signal (SIGALRM, no_more_time);
2912         alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
2913
2914         if (available_money > available_manpower) {
2915                 pay consultant to port U-Boot;
2916                 return 0;
2917         }
2918
2919         Download latest U-Boot source;
2920
2921         Subscribe to u-boot-users mailing list;
2922
2923         if (clueless) {
2924                 email ("Hi, I am new to U-Boot, how do I get started?");
2925         }
2926
2927         while (learning) {
2928                 Read the README file in the top level directory;
2929                 Read http://www.denx.de/re/DPLG.html
2930                 Read the source, Luke;
2931         }
2932
2933         if (available_money > toLocalCurrency ($2500)) {
2934                 Buy a BDI2000;
2935         } else {
2936                 Add a lot of aggravation and time;
2937         }
2938
2939         Create your own board support subdirectory;
2940
2941         Create your own board config file;
2942
2943         while (!running) {
2944                 do {
2945                         Add / modify source code;
2946                 } until (compiles);
2947                 Debug;
2948                 if (clueless)
2949                         email ("Hi, I am having problems...");
2950         }
2951         Send patch file to Wolfgang;
2952
2953         return 0;
2954 }
2955
2956 void no_more_time (int sig)
2957 {
2958       hire_a_guru();
2959 }
2960
2961
2962
2963 Coding Standards:
2964 -----------------
2965
2966 All contributions to U-Boot should conform to the Linux kernel
2967 coding style; see the file "Documentation/CodingStyle" in your Linux
2968 kernel source directory.
2969
2970 Please note that U-Boot is implemented in C (and to some small parts
2971 in Assembler); no C++ is used, so please do not use C++ style
2972 comments (//) in your code.
2973
2974 Submissions which do not conform to the standards may be returned
2975 with a request to reformat the changes.
2976
2977
2978 Submitting Patches:
2979 -------------------
2980
2981 Since the number of patches for U-Boot is growing, we need to
2982 establish some rules. Submissions which do not conform to these rules
2983 may be rejected, even when they contain important and valuable stuff.
2984
2985
2986 When you send a patch, please include the following information with
2987 it:
2988
2989 * For bug fixes: a description of the bug and how your patch fixes
2990   this bug. Please try to include a way of demonstrating that the
2991   patch actually fixes something.
2992
2993 * For new features: a description of the feature and your
2994   implementation.
2995
2996 * A CHANGELOG entry as plaintext (separate from the patch)
2997
2998 * For major contributions, your entry to the CREDITS file
2999
3000 * When you add support for a new board, don't forget to add this
3001   board to the MAKEALL script, too.
3002
3003 * If your patch adds new configuration options, don't forget to
3004   document these in the README file.
3005
3006 * The patch itself. If you are accessing the CVS repository use "cvs
3007   update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3008   version of diff does not support these options, then get the latest
3009   version of GNU diff.
3010
3011   We accept patches as plain text, MIME attachments or as uuencoded
3012   gzipped text.
3013
3014 * If one logical set of modifications affects or creates several
3015   files, all these changes shall be submitted in a SINGLE patch file.
3016
3017 * Changesets that contain different, unrelated modifications shall be
3018   submitted as SEPARATE patches, one patch per changeset.
3019   
3020
3021 Notes:
3022
3023 * Before sending the patch, run the MAKEALL script on your patched
3024   source tree and make sure that no errors or warnings are reported
3025   for any of the boards.
3026
3027 * Keep your modifications to the necessary minimum: A patch
3028   containing several unrelated changes or arbitrary reformats will be
3029   returned with a request to re-formatting / split it.
3030
3031 * If you modify existing code, make sure that your new code does not
3032   add to the memory footprint of the code ;-) Small is beautiful!
3033   When adding new features, these should compile conditionally only
3034   (using #ifdef), and the resulting code with the new feature
3035   disabled must not need more memory than the old code without your
3036   modification.