CPCI440 board update
[pandora-u-boot.git] / README
diff --git a/README b/README
index 0d6eac9..bb4c90a 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
@@ -244,6 +250,10 @@ The following options need to be configured:
                ----------------------
                CONFIG_MICROBLAZE
 
+               Nios-2 based CPUs:
+               ----------------------
+               CONFIG_NIOS2
+
 
 - Board Type:  Define exactly one of
 
@@ -304,6 +314,11 @@ The following options need to be configured:
 
                CONFIG_SUZAKU
 
+               Nios-2 based boards:
+               ------------------------
+
+               CONFIG_PCI5441 CONFIG_PK1C20
+
 
 - CPU Module Type: (if CONFIG_COGENT is defined)
                Define exactly one of
@@ -339,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
@@ -358,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
@@ -380,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,
@@ -541,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
@@ -567,7 +605,7 @@ 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
@@ -575,8 +613,8 @@ The following options need to be configured:
                CFG_CMD_MEMORY    md, mm, nm, mw, cp, cmp, crc, base,
                                  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
@@ -585,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)
@@ -762,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
@@ -783,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
 
@@ -1921,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:
 
@@ -2086,6 +2142,7 @@ 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
@@ -2107,6 +2164,7 @@ configurations; the following names are supported:
        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