]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - README
Patches by David Snowdon, 07 Sep 2004:
[karo-tx-uboot.git] / README
diff --git a/README b/README
index b197b1d57c1c9e5b0e10292c4a980321e109a6e8..32341f42b92df21dc57e1000bb7ccb7bbb45834c 100644 (file)
--- a/README
+++ b/README
@@ -25,9 +25,10 @@ Summary:
 ========
 
 This directory contains the source code for U-Boot, a boot loader for
-Embedded boards based on PowerPC and ARM processors, which can be
-installed in a boot ROM and used to initialize and test the hardware
-or to download and run application code.
+Embedded boards based on PowerPC, ARM, MIPS and several other
+processors, which can be installed in a boot ROM and used to
+initialize and test the hardware or to download and run application
+code.
 
 The development of U-Boot is closely related to Linux: some parts of
 the source code originate in the Linux source tree, we have some
@@ -122,23 +123,27 @@ Directory Hierarchy:
 - board                Board dependent files
 - common       Misc architecture independent functions
 - cpu          CPU specific files
-  - 74xx_7xx   Files specific to Motorola MPC74xx and 7xx CPUs
+  - 74xx_7xx   Files specific to Freescale MPC74xx and 7xx CPUs
   - arm720t    Files specific to ARM 720 CPUs
   - arm920t    Files specific to ARM 920 CPUs
+    - imx      Files specific to Freescale MC9328 i.MX CPUs
+    - s3c24x0  Files specific to Samsung S3C24X0 CPUs
   - arm925t    Files specific to ARM 925 CPUs
   - arm926ejs  Files specific to ARM 926 CPUs
   - at91rm9200 Files specific to Atmel AT91RM9200 CPUs
   - i386       Files specific to i386 CPUs
   - ixp                Files specific to Intel XScale IXP CPUs
-  - mcf52x2    Files specific to Motorola ColdFire MCF52x2 CPUs
+  - mcf52x2    Files specific to Freescale ColdFire MCF52x2 CPUs
   - mips       Files specific to MIPS CPUs
-  - mpc5xx     Files specific to Motorola MPC5xx  CPUs
-  - mpc5xxx    Files specific to Motorola MPC5xxx CPUs
-  - mpc8xx     Files specific to Motorola MPC8xx  CPUs
-  - mpc824x    Files specific to Motorola MPC824x CPUs
-  - mpc8260    Files specific to Motorola MPC8260 CPUs
-  - mpc85xx    Files specific to Motorola MPC85xx CPUs
+  - mpc5xx     Files specific to Freescale MPC5xx  CPUs
+  - mpc5xxx    Files specific to Freescale MPC5xxx CPUs
+  - mpc8xx     Files specific to Freescale MPC8xx  CPUs
+  - mpc8220    Files specific to Freescale MPC8220 CPUs
+  - mpc824x    Files specific to Freescale MPC824x CPUs
+  - mpc8260    Files specific to Freescale MPC8260 CPUs
+  - mpc85xx    Files specific to Freescale MPC85xx CPUs
   - nios       Files specific to Altera NIOS CPUs
+  - nios2      Files specific to Altera Nios-II CPUs
   - ppc4xx     Files specific to IBM PowerPC 4xx CPUs
   - pxa                Files specific to Intel XScale PXA CPUs
   - s3c44b0    Files specific to Samsung S3C44B0 CPUs
@@ -225,6 +230,7 @@ The following options need to be configured:
                -------------------
                CONFIG_MPC823,  CONFIG_MPC850,  CONFIG_MPC855,  CONFIG_MPC860
        or      CONFIG_MPC5xx
+       or      CONFIG_MPC8220
        or      CONFIG_MPC824X, CONFIG_MPC8260
        or      CONFIG_MPC85xx
        or      CONFIG_IOP480
@@ -242,7 +248,11 @@ The following options need to be configured:
 
                MicroBlaze based CPUs:
                ----------------------
-               CONFIG_MICROBLZE
+               CONFIG_MICROBLAZE
+
+               Nios-2 based CPUs:
+               ----------------------
+               CONFIG_NIOS2
 
 
 - Board Type:  Define exactly one of
@@ -269,40 +279,46 @@ The following options need to be configured:
                CONFIG_CSB272           CONFIG_JSE              CONFIG_Sandpoint8240
                CONFIG_CU824            CONFIG_LANTEC           CONFIG_Sandpoint8245
                CONFIG_DASA_SIM         CONFIG_lwmon            CONFIG_sbc8260
-               CONFIG_DB64360          CONFIG_MBX              CONFIG_SM850
-               CONFIG_DB64460          CONFIG_MBX860T          CONFIG_SPD823TS
-               CONFIG_DU405            CONFIG_MHPC             CONFIG_STXGP3
-               CONFIG_DUET_ADS         CONFIG_MIP405           CONFIG_SXNI855T
-               CONFIG_EBONY            CONFIG_MOUSSE           CONFIG_TQM823L
-               CONFIG_ELPPC            CONFIG_MPC8260ADS       CONFIG_TQM8260
-               CONFIG_ELPT860          CONFIG_MPC8540ADS       CONFIG_TQM850L
-               CONFIG_ep8260           CONFIG_MPC8560ADS       CONFIG_TQM855L
-               CONFIG_ERIC             CONFIG_MUSENKI          CONFIG_TQM860L
-               CONFIG_ESTEEM192E       CONFIG_MVS1             CONFIG_TTTech
-               CONFIG_ETX094           CONFIG_NETPHONE         CONFIG_UTX8245
-               CONFIG_EVB64260         CONFIG_NETTA            CONFIG_V37
-               CONFIG_FADS823          CONFIG_NETVIA           CONFIG_W7OLMC
-               CONFIG_FADS850SAR       CONFIG_NX823            CONFIG_W7OLMG
-               CONFIG_FADS860T         CONFIG_OCRTC            CONFIG_WALNUT405
-               CONFIG_FLAGADM          CONFIG_ORSG             CONFIG_ZPC1900
-               CONFIG_FPS850L          CONFIG_OXC              CONFIG_ZUMA
-               CONFIG_FPS860L
+               CONFIG_DB64360          CONFIG_MBX              CONFIG_sbc8560
+               CONFIG_DB64460          CONFIG_MBX860T          CONFIG_SM850
+               CONFIG_DU405            CONFIG_MHPC             CONFIG_SPD823TS
+               CONFIG_DUET_ADS         CONFIG_MIP405           CONFIG_STXGP3
+               CONFIG_EBONY            CONFIG_MOUSSE           CONFIG_SXNI855T
+               CONFIG_ELPPC            CONFIG_MPC8260ADS       CONFIG_TQM823L
+               CONFIG_ELPT860          CONFIG_MPC8540ADS       CONFIG_TQM8260
+               CONFIG_ep8260           CONFIG_MPC8560ADS       CONFIG_TQM850L
+               CONFIG_ERIC             CONFIG_MUSENKI          CONFIG_TQM855L
+               CONFIG_ESTEEM192E       CONFIG_MVS1             CONFIG_TQM860L
+               CONFIG_ETX094           CONFIG_NETPHONE         CONFIG_TTTech
+               CONFIG_EVB64260         CONFIG_NETTA            CONFIG_UTX8245
+               CONFIG_FADS823          CONFIG_NETVIA           CONFIG_V37
+               CONFIG_FADS850SAR       CONFIG_NX823            CONFIG_W7OLMC
+               CONFIG_FADS860T         CONFIG_OCRTC            CONFIG_W7OLMG
+               CONFIG_FLAGADM          CONFIG_ORSG             CONFIG_WALNUT405
+               CONFIG_FPS850L          CONFIG_OXC              CONFIG_ZPC1900
+               CONFIG_FPS860L                                  CONFIG_ZUMA
 
                ARM based boards:
                -----------------
 
-               CONFIG_AT91RM9200DK,            CONFIG_DNP1110,         CONFIG_EP7312,
-               CONFIG_H2_OMAP1610,             CONFIG_HHP_CRADLE,      CONFIG_IMPA7,
-               CONFIG_INNOVATOROMAP1510,   CONFIG_INNOVATOROMAP1610,   CONFIG_LART,
-               CONFIG_LPD7A400                 CONFIG_LUBBOCK,         CONFIG_OSK_OMAP5912,
-               CONFIG_SHANNON,                 CONFIG_P2_OMAP730,      CONFIG_SMDK2400,
-               CONFIG_SMDK2410,                CONFIG_TRAB,            CONFIG_VCMA9
+               CONFIG_AT91RM9200DK,            CONFIG_CERF250,         CONFIG_DNP1110,
+               CONFIG_EP7312,                  CONFIG_H2_OMAP1610,     CONFIG_HHP_CRADLE,
+               CONFIG_IMPA7,           CONFIG_INNOVATOROMAP1510,       CONFIG_INNOVATOROMAP1610,
+               CONFIG_LART,                    CONFIG_LPD7A400         CONFIG_LUBBOCK,
+               CONFIG_OSK_OMAP5912,            CONFIG_SHANNON,         CONFIG_P2_OMAP730,
+               CONFIG_SMDK2400,                CONFIG_SMDK2410,        CONFIG_TRAB,
+               CONFIG_VCMA9
 
                MicroBlaze based boards:
                ------------------------
 
                CONFIG_SUZAKU
 
+               Nios-2 based boards:
+               ------------------------
+
+               CONFIG_PCI5441 CONFIG_PK1C20
+
 
 - CPU Module Type: (if CONFIG_COGENT is defined)
                Define exactly one of
@@ -338,16 +354,17 @@ The following options need to be configured:
                CONFIG_MPC8240, CONFIG_MPC8245
 
 - 8xx CPU Options: (if using an MPC8xx cpu)
-               Define one or more of
-               CONFIG_8xx_GCLK_FREQ    - if get_gclk_freq() cannot work
+               CONFIG_8xx_GCLK_FREQ    - deprecated: CPU clock if
+                                         get_gclk_freq() cannot work
                                          e.g. if there is no 32KHz
                                          reference PIT/RTC clock
+               CONFIG_8xx_OSCLK        - PLL input clock (either EXTCLK
+                                         or XTAL/EXTAL)
 
-- 859/866 CPU options: (if using a MPC859 or MPC866 CPU):
-               CFG_866_OSCCLK
-               CFG_866_CPUCLK_MIN
-               CFG_866_CPUCLK_MAX
-               CFG_866_CPUCLK_DEFAULT
+- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
+               CFG_8xx_CPUCLK_MIN
+               CFG_8xx_CPUCLK_MAX
+               CONFIG_8xx_CPUCLK_DEFAULT
                        See doc/README.MPC866
 
                CFG_MEASURE_CPUCLK
@@ -357,7 +374,7 @@ The following options need to be configured:
                values. Mostly useful for board bringup to make sure
                the PLL is locked at the intended frequency. Note
                that this requires a (stable) reference clock (32 kHz
-               RTC clock),
+               RTC clock or CFG_8XX_XIN)
 
 - Linux Kernel Interface:
                CONFIG_CLOCKS_IN_MHZ
@@ -379,6 +396,27 @@ The following options need to be configured:
                expect it to be in bytes, others in MB.
                Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
 
+- Serial Ports:
+               CFG_PL010_SERIAL
+
+               Define this if you want support for Amba PrimeCell PL010 UARTs.
+
+               CFG_PL011_SERIAL
+
+               Define this if you want support for Amba PrimeCell PL011 UARTs.
+
+               CONFIG_PL011_CLOCK
+
+               If you have Amba PrimeCell PL011 UARTs, set this variable to
+               the clock speed of the UARTs.
+
+               CONFIG_PL01x_PORTS
+
+               If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
+               define this to a list of base addresses for each (supported)
+               port. See e.g. include/configs/versatile.h
+
+
 - Console Interface:
                Depending on board, define exactly one serial port
                (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
@@ -540,22 +578,23 @@ The following options need to be configured:
                CFG_CMD_ASKENV  * ask for env variable
                CFG_CMD_AUTOSCRIPT Autoscript Support
                CFG_CMD_BDI       bdinfo
-               CFG_CMD_BEDBUG    Include BedBug Debugger
+               CFG_CMD_BEDBUG  * Include BedBug Debugger
                CFG_CMD_BMP     * BMP support
+               CFG_CMD_BSP     * Board specific commands
                CFG_CMD_BOOTD     bootd
-               CFG_CMD_CACHE     icache, dcache
+               CFG_CMD_CACHE   * icache, dcache
                CFG_CMD_CONSOLE   coninfo
                CFG_CMD_DATE    * support for RTC, date/time...
-               CFG_CMD_DHCP      DHCP support
+               CFG_CMD_DHCP    * DHCP support
                CFG_CMD_DIAG    * Diagnostics
                CFG_CMD_DOC     * Disk-On-Chip Support
-               CFG_CMD_DTT       Digital Therm and Thermostat
+               CFG_CMD_DTT     * Digital Therm and Thermostat
                CFG_CMD_ECHO    * echo arguments
                CFG_CMD_EEPROM  * EEPROM read/write support
-               CFG_CMD_ELF       bootelf, bootvx
+               CFG_CMD_ELF     * bootelf, bootvx
                CFG_CMD_ENV       saveenv
                CFG_CMD_FDC     * Floppy Disk Support
-               CFG_CMD_FAT       FAT partition support
+               CFG_CMD_FAT     * FAT partition support
                CFG_CMD_FDOS    * Dos diskette Support
                CFG_CMD_FLASH     flinfo, erase, protect
                CFG_CMD_FPGA      FPGA device initialization support
@@ -566,16 +605,16 @@ The following options need to be configured:
                CFG_CMD_IMLS      List all found images
                CFG_CMD_IMMAP   * IMMR dump support
                CFG_CMD_IRQ     * irqinfo
-               CFG_CMD_ITEST   * Integer/string test of 2 values
+               CFG_CMD_ITEST     Integer/string test of 2 values
                CFG_CMD_JFFS2   * JFFS2 Support
                CFG_CMD_KGDB    * kgdb
                CFG_CMD_LOADB     loadb
                CFG_CMD_LOADS     loads
                CFG_CMD_MEMORY    md, mm, nm, mw, cp, cmp, crc, base,
-                                 loop, mtest
+                                 loop, loopw, mtest
                CFG_CMD_MISC      Misc functions like sleep etc
-               CFG_CMD_MMC       MMC memory mapped support
-               CFG_CMD_MII       MII utility commands
+               CFG_CMD_MMC     * MMC memory mapped support
+               CFG_CMD_MII     * MII utility commands
                CFG_CMD_NAND    * NAND support
                CFG_CMD_NET       bootp, tftpboot, rarpboot
                CFG_CMD_PCI     * pciinfo
@@ -584,7 +623,7 @@ The following options need to be configured:
                CFG_CMD_PORTIO  * Port I/O
                CFG_CMD_REGINFO * Register dump
                CFG_CMD_RUN       run command in env variable
-               CFG_CMD_SAVES     save S record dump
+               CFG_CMD_SAVES   * save S record dump
                CFG_CMD_SCSI    * SCSI Support
                CFG_CMD_SDRAM   * print SDRAM configuration information
                CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
@@ -596,13 +635,13 @@ The following options need to be configured:
                -----------------------------------------------
                CFG_CMD_ALL     all
 
-               CFG_CMD_DFL     Default configuration; at the moment
+               CONFIG_CMD_DFL  Default configuration; at the moment
                                this is includes all commands, except
                                the ones marked with "*" in the list
                                above.
 
                If you don't define CONFIG_COMMANDS it defaults to
-               CFG_CMD_DFL in include/cmd_confdefs.h. A board can
+               CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
                override the default settings in the respective
                include file.
 
@@ -652,6 +691,7 @@ The following options need to be configured:
                CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
                CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
                CONFIG_RTC_DS164x       - use Dallas DS164x RTC
+               CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
 
                Note that if the RTC uses I2C, then the I2C interface
                must also be configured. See I2C Support, below.
@@ -760,7 +800,7 @@ The following options need to be configured:
                supported (PIP405, MIP405, MPC5200); define
                CONFIG_USB_UHCI to enable it.
                define CONFIG_USB_KEYBOARD to enable the USB Keyboard
-               end define CONFIG_USB_STORAGE to enable the USB
+               and define CONFIG_USB_STORAGE to enable the USB
                storage devices.
                Note:
                Supported are USB Keyboards and USB Floppy drives
@@ -781,6 +821,24 @@ The following options need to be configured:
                enabled with CFG_CMD_MMC. The MMC driver also works with
                the FAT fs. This is enabled with CFG_CMD_FAT.
 
+- Journaling Flash filesystem support:
+               CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
+               CONFIG_JFFS2_NAND_DEV
+               Define these for a default partition on a NAND device
+
+               CFG_JFFS2_FIRST_SECTOR,
+               CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
+               Define these for a default partition on a NOR device
+
+               CFG_JFFS_CUSTOM_PART
+               Define this to create an own partition. You have to provide a
+               function struct part_info* jffs2_part_info(int part_num)
+
+               If you define only one JFFS2 partition you may also want to
+               #define CFG_JFFS_SINGLE_PART    1
+               to disable the command chpart. This is the default when you
+               have not defined a custom partition
+
 - Keyboard Support:
                CONFIG_ISA_KEYBOARD
 
@@ -894,7 +952,7 @@ The following options need to be configured:
                If this option is set, the environment is checked for
                a variable "splashimage". If found, the usual display
                of logo, copyright and system information on the LCD
-               is supressed and the BMP image at the address
+               is suppressed and the BMP image at the address
                specified in "splashimage" is loaded instead. The
                console is redirected to the "nulldev", too. This
                allows for a "silent" boot where a splash screen is
@@ -1919,9 +1977,9 @@ Low Level (hardware related) configuration options:
                source code. It is used to make hardware dependant
                initializations.
 
-- CFG_IMMR:    Physical address of the Internal Memory Mapped
-               Register; DO NOT CHANGE! (11-4)
-               [MPC8xx systems only]
+- CFG_IMMR:    Physical address of the Internal Memory.
+               DO NOT CHANGE unless you know exactly what you're
+               doing! (11-4) [MPC8xx/82xx systems only]
 
 - CFG_INIT_RAM_ADDR:
 
@@ -2051,6 +2109,24 @@ Low Level (hardware related) configuration options:
                and crc32 is the correct crc32 which the
                area should have.
 
+- CONFIG_LOOPW
+               Add the "loopw" memory command. This only takes effect if
+               the memory commands are activated globally (CFG_CMD_MEM).
+
+- CONFIG_MX_CYCLIC
+               Add the "mdc" and "mwc" memory commands. These are cyclic
+               "md/mw" commands.
+               Examples:
+
+               => mdc.b 10 4 500
+               This command will print 4 bytes (10,11,12,13) each 500 ms.
+
+               => mwc.l 100 12345678 10
+               This command will write 12345678 to address 100 all 10 ms.
+
+               This only takes effect if the memory commands are activated
+               globally (CFG_CMD_MEM).
+
 Building the Software:
 ======================
 
@@ -2080,26 +2156,30 @@ configurations; the following names are supported:
 
        ADCIOP_config           FPS860L_config          omap730p2_config
        ADS860_config           GEN860T_config          pcu_e_config
+       Alaska8220_config
        AR405_config            GENIETV_config          PIP405_config
        at91rm9200dk_config     GTH_config              QS823_config
        CANBT_config            hermes_config           QS850_config
        cmi_mpc5xx_config       hymod_config            QS860T_config
        cogent_common_config    IP860_config            RPXlite_config
-       cogent_mpc8260_config   IVML24_config           RPXsuper_config
-       cogent_mpc8xx_config    IVMS8_config            rsdproto_config
-       CPCI405_config          JSE_config              Sandpoint8240_config
-       CPCIISER4_config        LANTEC_config           sbc8260_config
-       csb272_config           lwmon_config            SM850_config
-       CU824_config            MBX860T_config          SPD823TS_config
-       DUET_ADS_config         MBX_config              stxgp3_config
-       EBONY_config            MPC8260ADS_config       SXNI855T_config
-       ELPT860_config          MPC8540ADS_config       TQM823L_config
-       ESTEEM192E_config       MPC8560ADS_config       TQM850L_config
-       ETX094_config           NETVIA_config           TQM855L_config
-       FADS823_config          omap1510inn_config      TQM860L_config
-       FADS850SAR_config       omap1610h2_config       WALNUT405_config
-       FADS860T_config         omap1610inn_config      ZPC1900_config
-       FPS850L_config          omap5912osk_config
+       cogent_mpc8260_config   IVML24_config           RPXlite_DW_config
+       cogent_mpc8xx_config    IVMS8_config            RPXsuper_config
+       CPCI405_config          JSE_config              rsdproto_config
+       CPCIISER4_config        LANTEC_config           Sandpoint8240_config
+       csb272_config           lwmon_config            sbc8260_config
+       CU824_config            MBX860T_config          sbc8560_33_config
+       DUET_ADS_config         MBX_config              sbc8560_66_config
+       EBONY_config            MPC8260ADS_config       SM850_config
+       ELPT860_config          MPC8540ADS_config       SPD823TS_config
+       ESTEEM192E_config       MPC8560ADS_config       stxgp3_config
+       ETX094_config           NETVIA_config           SXNI855T_config
+       FADS823_config          omap1510inn_config      TQM823L_config
+       FADS850SAR_config       omap1610h2_config       TQM850L_config
+       FADS860T_config         omap1610inn_config      TQM855L_config
+       FPS850L_config          omap5912osk_config      TQM860L_config
+                                                       WALNUT405_config
+                                                       Yukon8220_config
+                                                       ZPC1900_config
 
 Note: for some board special configuration names may exist; check if
       additional information is available from the board vendor; for
@@ -2221,6 +2301,7 @@ iminfo    - print header information for application image
 coninfo - print console devices and informations
 ide    - IDE sub-system
 loop   - infinite loop on address range
+loopw  - infinite write loop on address range
 mtest  - simple RAM test
 icache - enable or disable instruction cache
 dcache - enable or disable data cache