* Patch by Pierre Aubert, 11 Mar 2004:
[oweals/u-boot.git] / README
diff --git a/README b/README
index 41e99e329f8dc6aa4090149f67b87ead68f8dd4d..1df1ef0639e1d7a18ac162b261ed4adee413b1b4 100644 (file)
--- a/README
+++ b/README
@@ -122,135 +122,45 @@ 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
+  - arm720t    Files specific to ARM 720 CPUs
+  - arm920t    Files specific to ARM 920 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
+  - 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
+  - nios       Files specific to Altera NIOS CPUs
+  - ppc4xx     Files specific to IBM PowerPC 4xx CPUs
+  - pxa                Files specific to Intel XScale PXA CPUs
+  - s3c44b0    Files specific to Samsung S3C44B0 CPUs
+  - sa1100     Files specific to Intel StrongARM SA1100 CPUs
 - disk         Code for disk drive partition handling
 - doc          Documentation (don't expect too much)
 - drivers      Commonly used device drivers
 - dtt          Digital Thermometer and Thermostat drivers
 - examples     Example code for standalone applications, etc.
 - include      Header Files
-- disk         Harddisk interface code
+- lib_arm      Files generic to ARM     architecture
+- lib_generic  Files generic to all     architectures
+- lib_i386     Files generic to i386    architecture
+- lib_m68k     Files generic to m68k    architecture
+- lib_mips     Files generic to MIPS    architecture
+- lib_nios     Files generic to NIOS    architecture
+- lib_ppc      Files generic to PowerPC architecture
 - net          Networking code
-- ppc          Files generic to PowerPC architecture
 - post         Power On Self Test
-- post/arch            Symlink to architecture specific Power On Self Test
-- post/arch-ppc                PowerPC architecture specific Power On Self Test
-- post/cpu/mpc8260     MPC8260 CPU specific Power On Self Test
-- post/cpu/mpc8xx      MPC8xx CPU specific Power On Self Test
 - rtc          Real Time Clock drivers
 - tools                Tools to build S-Record or U-Boot images, etc.
 
-- cpu/74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs
-- cpu/arm925t  Files specific to ARM      925     CPUs
-- cpu/arm926ejs Files specific to ARM  926     CPUs
-- cpu/mpc5xx   Files specific to Motorola MPC5xx  CPUs
-- cpu/mpc8xx   Files specific to Motorola MPC8xx  CPUs
-- cpu/mpc824x  Files specific to Motorola MPC824x CPUs
-- cpu/mpc8260  Files specific to Motorola MPC8260 CPU
-- cpu/mpc85xx  Files specific to Motorola MPC85xx CPUs
-- cpu/ppc4xx   Files specific to IBM      4xx     CPUs
-
-
-- board/LEOX/  Files specific to boards manufactured by The LEOX team
-- board/LEOX/elpt860   Files specific to ELPT860 boards
-- board/RPXClassic
-               Files specific to RPXClassic boards
-- board/RPXlite Files specific to RPXlite    boards
-- board/at91rm9200dk Files specific to AT91RM9200DK boards
-- board/c2mon  Files specific to c2mon      boards
-- board/cmi    Files specific to cmi        boards
-- board/cogent Files specific to Cogent     boards
-               (need further configuration)
-               Files specific to CPCIISER4  boards
-- board/cpu86  Files specific to CPU86      boards
-- board/cray/  Files specific to boards manufactured by Cray
-- board/cray/L1                Files specific to L1         boards
-- board/cu824  Files specific to CU824      boards
-- board/ebony  Files specific to IBM Ebony board
-- board/eric   Files specific to ERIC       boards
-- board/esd/   Files specific to boards manufactured by ESD
-- board/esd/adciop     Files specific to ADCIOP     boards
-- board/esd/ar405      Files specific to AR405      boards
-- board/esd/canbt      Files specific to CANBT      boards
-- board/esd/cpci405    Files specific to CPCI405    boards
-- board/esd/cpciiser4  Files specific to CPCIISER4  boards
-- board/esd/common     Common files for ESD boards
-- board/esd/dasa_sim   Files specific to DASA_SIM   boards
-- board/esd/du405      Files specific to DU405      boards
-- board/esd/ocrtc      Files specific to OCRTC      boards
-- board/esd/pci405     Files specific to PCI405     boards
-- board/esteem192e
-               Files specific to ESTEEM192E boards
-- board/etx094 Files specific to ETX_094    boards
-- board/evb64260
-               Files specific to EVB64260   boards
-- board/fads   Files specific to FADS       boards
-- board/flagadm Files specific to FLAGADM    boards
-- board/gen860t Files specific to GEN860T and GEN860T_SC    boards
-- board/genietv Files specific to GENIETV    boards
-- board/gth    Files specific to GTH        boards
-- board/hermes Files specific to HERMES     boards
-- board/hymod  Files specific to HYMOD      boards
-- board/icu862 Files specific to ICU862     boards
-- board/ip860  Files specific to IP860      boards
-- board/iphase4539
-               Files specific to Interphase4539 boards
-- board/ivm    Files specific to IVMS8/IVML24 boards
-- board/lantec Files specific to LANTEC     boards
-- board/lwmon  Files specific to LWMON      boards
-- board/Marvell Files specific to Marvell development boards
-- board/Marvell/db64360 Files specific to db64360 board
-- board/Marvell/db64460 Files specific to db64460 board
-- board/mbx8xx Files specific to MBX        boards
-- board/mpc8260ads
-               Files specific to MPC826xADS and PQ2FADS-ZU/VR boards
-- board/mpc8540ads
-               Files specific to MPC8540ADS boards
-- board/mpc8560ads
-               Files specific to MPC8560ADS boards
-- board/mpl/   Files specific to boards manufactured by MPL
-- board/mpl/common     Common files for MPL boards
-- board/mpl/pip405     Files specific to PIP405     boards
-- board/mpl/mip405     Files specific to MIP405     boards
-- board/mpl/vcma9      Files specific to VCMA9      boards
-- board/musenki Files specific to MUSEKNI    boards
-- board/mvs1   Files specific to MVS1       boards
-- board/nx823  Files specific to NX823      boards
-- board/oxc    Files specific to OXC        boards
-- board/omap1510inn
-               Files specific to OMAP 1510 Innovator boards
-- board/omap1610inn
-               Files specific to OMAP 1610 Innovator boards
-- board/pcippc2 Files specific to PCIPPC2/PCIPPC6 boards
-- board/pm826  Files specific to PM826      boards
-- board/ppmc8260
-               Files specific to PPMC8260   boards
-- board/snmc/qs850     Files specific to QS850/823  boards
-- board/snmc/qs860t    Files specific to QS860T     boards
-- board/rpxsuper
-               Files specific to RPXsuper   boards
-- board/rsdproto
-               Files specific to RSDproto   boards
-- board/sandpoint
-               Files specific to Sandpoint  boards
-- board/sbc8260 Files specific to SBC8260    boards
-- board/sacsng Files specific to SACSng     boards
-- board/siemens Files specific to boards manufactured by Siemens AG
-- board/siemens/CCM    Files specific to CCM        boards
-- board/siemens/IAD210 Files specific to IAD210     boards
-- board/siemens/SCM    Files specific to SCM        boards
-- board/siemens/pcu_e  Files specific to PCU_E      boards
-- board/sixnet Files specific to SIXNET     boards
-- board/spd8xx Files specific to SPD8xxTS   boards
-- board/tqm8260 Files specific to TQM8260    boards
-- board/tqm8xx Files specific to TQM8xxL    boards
-- board/w7o    Files specific to W7O        boards
-- board/walnut405
-               Files specific to Walnut405  boards
-- board/westel/ Files specific to boards manufactured by Westel Wireless
-- board/westel/amx860  Files specific to AMX860     boards
-- board/utx8245 Files specific to UTX8245   boards
-- board/zpc1900 Files specific to Zephyr Engineering ZPC.1900 board
-
 Software Configuration:
 =======================
 
@@ -375,11 +285,12 @@ The following options need to be configured:
                ARM based boards:
                -----------------
 
-               CONFIG_HHP_CRADLE,  CONFIG_DNP1110,    CONFIG_EP7312,
-               CONFIG_IMPA7,       CONFIG_LART,       CONFIG_LUBBOCK,
-               CONFIG_INNOVATOROMAP1510,       CONFIG_INNOVATOROMAP1610
-               CONFIG_SHANNON,     CONFIG_SMDK2400,   CONFIG_SMDK2410,
-               CONFIG_TRAB,        CONFIG_VCMA9,      CONFIG_AT91RM9200DK
+               CONFIG_HHP_CRADLE,  CONFIG_DNP1110,     CONFIG_EP7312,
+               CONFIG_IMPA7,       CONFIG_LART,        CONFIG_LUBBOCK,
+               CONFIG_INNOVATOROMAP1510,      CONFIG_INNOVATOROMAP1610,
+               CONFIG_H2_OMAP1610, CONFIG_SHANNON,     CONFIG_SMDK2400,
+               CONFIG_SMDK2410,    CONFIG_TRAB,        CONFIG_VCMA9,
+               CONFIG_AT91RM9200DK
 
 
 - CPU Module Type: (if CONFIG_COGENT is defined)
@@ -644,6 +555,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_JFFS2   * JFFS2 Support
                CFG_CMD_KGDB    * kgdb
                CFG_CMD_LOADB     loadb
@@ -748,16 +660,31 @@ The following options need to be configured:
                one partition type as well.
 
 - IDE Reset method:
-               CONFIG_IDE_RESET_ROUTINE
+               CONFIG_IDE_RESET_ROUTINE - this is defined in several
+               board configurations files but used nowhere!
 
-               Set this to define that instead of a reset Pin, the
-               routine ide_set_reset(int idereset) will be used.
+               CONFIG_IDE_RESET - is this is defined, IDE Reset will
+               be performed by calling the function
+                       ide_set_reset(int reset)
+               which has to be defined in a board specific file
 
 - ATAPI Support:
                CONFIG_ATAPI
 
                Set this to enable ATAPI support.
 
+- LBA48 Support
+               CONFIG_LBA48
+
+               Set this to enable support for disks larger than 137GB
+               Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
+               Whithout these , LBA48 support uses 32bit variables and will 'only'
+               support disks up to 2.1TB.
+
+               CFG_64BIT_LBA:
+                       When enabled, makes the IDE subsystem use 64bit sector addresses.
+                       Default is 32bit.
+
 - SCSI Support:
                At the moment only there is only support for the
                SYM53C8XX SCSI controller; define
@@ -804,7 +731,7 @@ The following options need to be configured:
 
 - USB Support:
                At the moment only the UHCI host controller is
-               supported (PIP405, MIP405); define
+               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
@@ -812,6 +739,13 @@ The following options need to be configured:
                Note:
                Supported are USB Keyboards and USB Floppy drives
                (TEAC FD-05PUB).
+               MPC5200 USB requires additional defines:
+                       CONFIG_USB_CLOCK
+                               for 528 MHz Clock: 0x0001bbbb
+                       CONFIG_USB_CONFIG
+                               for differential drivers: 0x00001000
+                               for single ended drivers: 0x00005000
+
 
 - MMC Support:
                The MMC controller on the Intel PXA is supported. To
@@ -1151,60 +1085,6 @@ The following options need to be configured:
                SPI configuration items (port pins to use, etc). For
                an example, see include/configs/sacsng.h.
 
-- FPGA Support: CONFIG_FPGA_COUNT
-
-               Specify the number of FPGA devices to support.
-
-               CONFIG_FPGA
-
-               Used to specify the types of FPGA devices. For
-               example,
-               #define CONFIG_FPGA  CFG_XILINX_VIRTEX2
-
-               CFG_FPGA_PROG_FEEDBACK
-
-               Enable printing of hash marks during FPGA
-               configuration.
-
-               CFG_FPGA_CHECK_BUSY
-
-               Enable checks on FPGA configuration interface busy
-               status by the configuration function. This option
-               will require a board or device specific function to
-               be written.
-
-               CONFIG_FPGA_DELAY
-
-               If defined, a function that provides delays in the
-               FPGA configuration driver.
-
-               CFG_FPGA_CHECK_CTRLC
-
-               Allow Control-C to interrupt FPGA configuration
-
-               CFG_FPGA_CHECK_ERROR
-
-               Check for configuration errors during FPGA bitfile
-               loading. For example, abort during Virtex II
-               configuration if the INIT_B line goes low (which
-               indicated a CRC error).
-
-               CFG_FPGA_WAIT_INIT
-
-               Maximum time to wait for the INIT_B line to deassert
-               after PROB_B has been deasserted during a Virtex II
-               FPGA configuration sequence. The default time is 500 mS.
-
-               CFG_FPGA_WAIT_BUSY
-
-               Maximum time to wait for BUSY to deassert during
-               Virtex II FPGA configuration. The default is 5 mS.
-
-               CFG_FPGA_WAIT_CONFIG
-
-               Time to wait after FPGA configuration. The default is
-               200 mS.
-
 - FPGA Support: CONFIG_FPGA_COUNT
 
                Specify the number of FPGA devices to support.
@@ -1464,6 +1344,10 @@ The following options need to be configured:
    14  common/cmd_bootm.c      No initial ramdisk, no multifile, continue.
    15  common/cmd_bootm.c      All preparation done, transferring control to OS
 
+  -30  lib_ppc/board.c         Fatal error, hang the system
+  -31  post/post.c             POST test failed, detected by post_output_backlog()
+  -32  post/post.c             POST test failed, detected by post_run_single()
+
    -1  common/cmd_doc.c        Bad usage of "doc" command
    -1  common/cmd_doc.c        No boot device
    -1  common/cmd_doc.c        Unknown Chip ID on boot device
@@ -1851,6 +1735,13 @@ use the "saveenv" command to store a valid environment.
 - CFG_FAULT_MII_ADDR:
                MII address of the PHY to check for the Ethernet link state.
 
+- CFG_64BIT_VSPRINTF:
+               Makes vsprintf (and all *printf functions) support printing
+               of 64bit values by using the L quantifier
+
+- CFG_64BIT_STRTOUL:
+               Adds simple_strtoull that returns a 64bit value
+
 Low Level (hardware related) configuration options:
 ---------------------------------------------------
 
@@ -2038,7 +1929,7 @@ configurations; the following names are supported:
     at91rm9200dk_config          omap1510inn_config    MPC8260ADS_config
     omap1610inn_config   ZPC1900_config        MPC8540ADS_config
     MPC8560ADS_config    QS850_config          QS823_config
-    QS860T_config        DUET_ADS_config
+    QS860T_config        DUET_ADS_config       omap1610h2_config
 
 Note: for some board special configuration names may exist; check  if
       additional  information is available from the board vendor; for